Mercurial > emacs
annotate src/macros.c @ 13670:15c441f6d41a
(list-sexp-diary-entries): Doc fix.
author | Paul Eggert <eggert@twinsun.com> |
---|---|
date | Thu, 30 Nov 1995 03:25:04 +0000 |
parents | 9ee2045cda62 |
children | 7d50ac085b12 |
rev | line source |
---|---|
246 | 1 /* Keyboard macros. |
2961 | 2 Copyright (C) 1985, 1986, 1993 Free Software Foundation, Inc. |
246 | 3 |
4 This file is part of GNU Emacs. | |
5 | |
6 GNU Emacs is free software; you can redistribute it and/or modify | |
7 it under the terms of the GNU General Public License as published by | |
647 | 8 the Free Software Foundation; either version 2, or (at your option) |
246 | 9 any later version. |
10 | |
11 GNU Emacs is distributed in the hope that it will be useful, | |
12 but WITHOUT ANY WARRANTY; without even the implied warranty of | |
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
14 GNU General Public License for more details. | |
15 | |
16 You should have received a copy of the GNU General Public License | |
17 along with GNU Emacs; see the file COPYING. If not, write to | |
18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */ | |
19 | |
20 | |
4696
1fc792473491
Include <config.h> instead of "config.h".
Roland McGrath <roland@gnu.org>
parents:
2961
diff
changeset
|
21 #include <config.h> |
246 | 22 #include "lisp.h" |
23 #include "macros.h" | |
24 #include "commands.h" | |
25 #include "buffer.h" | |
26 #include "window.h" | |
11341 | 27 #include "keyboard.h" |
246 | 28 |
29 Lisp_Object Qexecute_kbd_macro; | |
30 | |
31 Lisp_Object Vexecuting_macro; | |
32 int executing_macro_index; | |
33 | |
34 Lisp_Object Fexecute_kbd_macro (); | |
35 | |
36 DEFUN ("start-kbd-macro", Fstart_kbd_macro, Sstart_kbd_macro, 1, 1, "P", | |
37 "Record subsequent keyboard input, defining a keyboard macro.\n\ | |
38 The commands are recorded even as they are executed.\n\ | |
39 Use \\[end-kbd-macro] to finish recording and make the macro available.\n\ | |
40 Use \\[name-last-kbd-macro] to give it a permanent name.\n\ | |
41 Non-nil arg (prefix arg) means append to last macro defined;\n\ | |
42 This begins by re-executing that macro as if you typed it again.") | |
43 (append) | |
44 Lisp_Object append; | |
45 { | |
11009 | 46 if (!NILP (current_kboard->defining_kbd_macro)) |
246 | 47 error ("Already defining kbd macro"); |
48 | |
11009 | 49 if (!current_kboard->kbd_macro_buffer) |
10910
b0edc245c9b7
(defining_kbd_macro): Delete; now part of perdisplay. All uses changed.
Karl Heuer <kwzh@gnu.org>
parents:
10856
diff
changeset
|
50 { |
11009 | 51 current_kboard->kbd_macro_bufsize = 30; |
52 current_kboard->kbd_macro_buffer | |
10910
b0edc245c9b7
(defining_kbd_macro): Delete; now part of perdisplay. All uses changed.
Karl Heuer <kwzh@gnu.org>
parents:
10856
diff
changeset
|
53 = (Lisp_Object *)malloc (30 * sizeof (Lisp_Object)); |
b0edc245c9b7
(defining_kbd_macro): Delete; now part of perdisplay. All uses changed.
Karl Heuer <kwzh@gnu.org>
parents:
10856
diff
changeset
|
54 } |
246 | 55 update_mode_lines++; |
485 | 56 if (NILP (append)) |
246 | 57 { |
11009 | 58 current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_buffer; |
59 current_kboard->kbd_macro_end = current_kboard->kbd_macro_buffer; | |
246 | 60 message("Defining kbd macro..."); |
61 } | |
62 else | |
63 { | |
64 message("Appending to kbd macro..."); | |
11009 | 65 current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_end; |
66 Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, | |
10935
73b02c08f17d
(Fstart_kbd_macro): Access Vlast_kbd_macro via perdisplay.
Karl Heuer <kwzh@gnu.org>
parents:
10910
diff
changeset
|
67 make_number (1)); |
246 | 68 } |
11009 | 69 current_kboard->defining_kbd_macro = Qt; |
246 | 70 |
71 return Qnil; | |
72 } | |
73 | |
74 DEFUN ("end-kbd-macro", Fend_kbd_macro, Send_kbd_macro, 0, 1, "p", | |
75 "Finish defining a keyboard macro.\n\ | |
76 The definition was started by \\[start-kbd-macro].\n\ | |
77 The macro is now available for use via \\[call-last-kbd-macro],\n\ | |
78 or it can be given a name with \\[name-last-kbd-macro] and then invoked\n\ | |
79 under that name.\n\ | |
80 \n\ | |
81 With numeric arg, repeat macro now that many times,\n\ | |
82 counting the definition just completed as the first repetition.\n\ | |
83 An argument of zero means repeat until error.") | |
84 (arg) | |
85 Lisp_Object arg; | |
86 { | |
11009 | 87 if (NILP (current_kboard->defining_kbd_macro)) |
88 error ("Not defining kbd macro."); | |
246 | 89 |
485 | 90 if (NILP (arg)) |
9314
2c681685646b
(Fend_kbd_macro, Fexecute_kbd_macro): Don't use XFASTINT as an lvalue.
Karl Heuer <kwzh@gnu.org>
parents:
9122
diff
changeset
|
91 XSETFASTINT (arg, 1); |
246 | 92 else |
93 CHECK_NUMBER (arg, 0); | |
94 | |
11009 | 95 if (!NILP (current_kboard->defining_kbd_macro)) |
246 | 96 { |
11009 | 97 current_kboard->defining_kbd_macro = Qnil; |
246 | 98 update_mode_lines++; |
11009 | 99 current_kboard->Vlast_kbd_macro |
100 = make_event_array ((current_kboard->kbd_macro_end | |
101 - current_kboard->kbd_macro_buffer), | |
102 current_kboard->kbd_macro_buffer); | |
246 | 103 message("Keyboard macro defined"); |
104 } | |
105 | |
106 if (XFASTINT (arg) == 0) | |
11009 | 107 Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, arg); |
246 | 108 else |
109 { | |
1682
af0995b9b142
* macros.c (Fend_kbd_macro): Don't use XFASTINT to check if arg is
Jim Blandy <jimb@redhat.com>
parents:
647
diff
changeset
|
110 XSETINT (arg, XINT (arg)-1); |
af0995b9b142
* macros.c (Fend_kbd_macro): Don't use XFASTINT to check if arg is
Jim Blandy <jimb@redhat.com>
parents:
647
diff
changeset
|
111 if (XINT (arg) > 0) |
11009 | 112 Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, arg); |
246 | 113 } |
114 return Qnil; | |
115 } | |
116 | |
117 /* Store character c into kbd macro being defined */ | |
118 | |
119 store_kbd_macro_char (c) | |
120 Lisp_Object c; | |
121 { | |
11009 | 122 if (!NILP (current_kboard->defining_kbd_macro)) |
246 | 123 { |
11009 | 124 if ((current_kboard->kbd_macro_ptr |
125 - current_kboard->kbd_macro_buffer) | |
126 == current_kboard->kbd_macro_bufsize) | |
246 | 127 { |
10910
b0edc245c9b7
(defining_kbd_macro): Delete; now part of perdisplay. All uses changed.
Karl Heuer <kwzh@gnu.org>
parents:
10856
diff
changeset
|
128 register Lisp_Object *new; |
11009 | 129 current_kboard->kbd_macro_bufsize *= 2; |
130 new = (Lisp_Object *)xrealloc (current_kboard->kbd_macro_buffer, | |
131 (current_kboard->kbd_macro_bufsize | |
10910
b0edc245c9b7
(defining_kbd_macro): Delete; now part of perdisplay. All uses changed.
Karl Heuer <kwzh@gnu.org>
parents:
10856
diff
changeset
|
132 * sizeof (Lisp_Object))); |
11009 | 133 current_kboard->kbd_macro_ptr |
134 += new - current_kboard->kbd_macro_buffer; | |
135 current_kboard->kbd_macro_end | |
136 += new - current_kboard->kbd_macro_buffer; | |
137 current_kboard->kbd_macro_buffer = new; | |
246 | 138 } |
11009 | 139 *current_kboard->kbd_macro_ptr++ = c; |
246 | 140 } |
141 } | |
142 | |
143 /* Declare that all chars stored so far in the kbd macro being defined | |
144 really belong to it. This is done in between editor commands. */ | |
145 | |
146 finalize_kbd_macro_chars () | |
147 { | |
11009 | 148 current_kboard->kbd_macro_end = current_kboard->kbd_macro_ptr; |
246 | 149 } |
12845
9ee2045cda62
(Fcancel_kbd_macro_events): New function.
Richard M. Stallman <rms@gnu.org>
parents:
12119
diff
changeset
|
150 |
9ee2045cda62
(Fcancel_kbd_macro_events): New function.
Richard M. Stallman <rms@gnu.org>
parents:
12119
diff
changeset
|
151 DEFUN ("cancel-kbd-macro-events", Fcancel_kbd_macro_events, |
9ee2045cda62
(Fcancel_kbd_macro_events): New function.
Richard M. Stallman <rms@gnu.org>
parents:
12119
diff
changeset
|
152 Scancel_kbd_macro_events, 0, 0, 0, |
9ee2045cda62
(Fcancel_kbd_macro_events): New function.
Richard M. Stallman <rms@gnu.org>
parents:
12119
diff
changeset
|
153 "Cancel the events added to a keyboard macro for this command.") |
9ee2045cda62
(Fcancel_kbd_macro_events): New function.
Richard M. Stallman <rms@gnu.org>
parents:
12119
diff
changeset
|
154 () |
9ee2045cda62
(Fcancel_kbd_macro_events): New function.
Richard M. Stallman <rms@gnu.org>
parents:
12119
diff
changeset
|
155 { |
9ee2045cda62
(Fcancel_kbd_macro_events): New function.
Richard M. Stallman <rms@gnu.org>
parents:
12119
diff
changeset
|
156 current_kboard->kbd_macro_ptr = current_kboard->kbd_macro_end; |
9ee2045cda62
(Fcancel_kbd_macro_events): New function.
Richard M. Stallman <rms@gnu.org>
parents:
12119
diff
changeset
|
157 } |
246 | 158 |
159 DEFUN ("call-last-kbd-macro", Fcall_last_kbd_macro, Scall_last_kbd_macro, | |
160 0, 1, "p", | |
161 "Call the last keyboard macro that you defined with \\[start-kbd-macro].\n\ | |
162 \n\ | |
163 A prefix argument serves as a repeat count. Zero means repeat until error.\n\ | |
164 \n\ | |
165 To make a macro permanent so you can call it even after\n\ | |
166 defining others, use \\[name-last-kbd-macro].") | |
167 (prefix) | |
168 Lisp_Object prefix; | |
169 { | |
11009 | 170 if (! NILP (current_kboard->defining_kbd_macro)) |
246 | 171 error ("Can't execute anonymous macro while defining one"); |
11009 | 172 else if (NILP (current_kboard->Vlast_kbd_macro)) |
246 | 173 error ("No kbd macro has been defined"); |
174 else | |
11009 | 175 Fexecute_kbd_macro (current_kboard->Vlast_kbd_macro, prefix); |
246 | 176 return Qnil; |
177 } | |
178 | |
179 /* Restore Vexecuting_macro and executing_macro_index - called when | |
180 the unwind-protect in Fexecute_kbd_macro gets invoked. */ | |
181 static Lisp_Object | |
182 pop_kbd_macro (info) | |
183 Lisp_Object info; | |
184 { | |
185 Lisp_Object tem; | |
186 Vexecuting_macro = Fcar (info); | |
187 tem = Fcdr (info); | |
188 executing_macro_index = XINT (tem); | |
189 return Qnil; | |
190 } | |
191 | |
192 DEFUN ("execute-kbd-macro", Fexecute_kbd_macro, Sexecute_kbd_macro, 1, 2, 0, | |
193 "Execute MACRO as string of editor command characters.\n\ | |
194 If MACRO is a symbol, its function definition is used.\n\ | |
195 COUNT is a repeat count, or nil for once, or 0 for infinite loop.") | |
196 (macro, prefixarg) | |
197 Lisp_Object macro, prefixarg; | |
198 { | |
199 Lisp_Object final; | |
200 Lisp_Object tem; | |
201 int count = specpdl_ptr - specpdl; | |
202 int repeat = 1; | |
203 struct gcpro gcpro1; | |
204 | |
485 | 205 if (!NILP (prefixarg)) |
246 | 206 prefixarg = Fprefix_numeric_value (prefixarg), |
207 repeat = XINT (prefixarg); | |
208 | |
647 | 209 final = indirect_function (macro); |
9122
9ba3f17d6631
(Fexecute_kbd_macro): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
4696
diff
changeset
|
210 if (!STRINGP (final) && !VECTORP (final)) |
246 | 211 error ("Keyboard macros must be strings or vectors."); |
212 | |
9314
2c681685646b
(Fend_kbd_macro, Fexecute_kbd_macro): Don't use XFASTINT as an lvalue.
Karl Heuer <kwzh@gnu.org>
parents:
9122
diff
changeset
|
213 XSETFASTINT (tem, executing_macro_index); |
246 | 214 tem = Fcons (Vexecuting_macro, tem); |
215 record_unwind_protect (pop_kbd_macro, tem); | |
216 | |
217 GCPRO1 (final); | |
218 do | |
219 { | |
220 Vexecuting_macro = final; | |
221 executing_macro_index = 0; | |
222 | |
12119
d7b51659a56d
(Fexecute_kbd_macro): Vprefix_arg is now part of kboard.
Karl Heuer <kwzh@gnu.org>
parents:
11341
diff
changeset
|
223 current_kboard->Vprefix_arg = Qnil; |
246 | 224 command_loop_1 (); |
1682
af0995b9b142
* macros.c (Fend_kbd_macro): Don't use XFASTINT to check if arg is
Jim Blandy <jimb@redhat.com>
parents:
647
diff
changeset
|
225 |
af0995b9b142
* macros.c (Fend_kbd_macro): Don't use XFASTINT to check if arg is
Jim Blandy <jimb@redhat.com>
parents:
647
diff
changeset
|
226 QUIT; |
246 | 227 } |
9122
9ba3f17d6631
(Fexecute_kbd_macro): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
4696
diff
changeset
|
228 while (--repeat |
9ba3f17d6631
(Fexecute_kbd_macro): Use type test macros.
Karl Heuer <kwzh@gnu.org>
parents:
4696
diff
changeset
|
229 && (STRINGP (Vexecuting_macro) || VECTORP (Vexecuting_macro))); |
246 | 230 |
231 UNGCPRO; | |
232 return unbind_to (count, Qnil); | |
233 } | |
234 | |
235 init_macros () | |
236 { | |
237 Vexecuting_macro = Qnil; | |
238 } | |
239 | |
240 syms_of_macros () | |
241 { | |
242 Qexecute_kbd_macro = intern ("execute-kbd-macro"); | |
243 staticpro (&Qexecute_kbd_macro); | |
244 | |
245 defsubr (&Sstart_kbd_macro); | |
246 defsubr (&Send_kbd_macro); | |
247 defsubr (&Scall_last_kbd_macro); | |
248 defsubr (&Sexecute_kbd_macro); | |
12845
9ee2045cda62
(Fcancel_kbd_macro_events): New function.
Richard M. Stallman <rms@gnu.org>
parents:
12119
diff
changeset
|
249 defsubr (&Scancel_kbd_macro_events); |
246 | 250 |
11009 | 251 DEFVAR_KBOARD ("defining-kbd-macro", defining_kbd_macro, |
246 | 252 "Non-nil while a keyboard macro is being defined. Don't set this!"); |
253 | |
254 DEFVAR_LISP ("executing-macro", &Vexecuting_macro, | |
10935
73b02c08f17d
(Fstart_kbd_macro): Access Vlast_kbd_macro via perdisplay.
Karl Heuer <kwzh@gnu.org>
parents:
10910
diff
changeset
|
255 "Currently executing keyboard macro (string or vector); nil if none executing."); |
246 | 256 |
257 DEFVAR_LISP_NOPRO ("executing-kbd-macro", &Vexecuting_macro, | |
10935
73b02c08f17d
(Fstart_kbd_macro): Access Vlast_kbd_macro via perdisplay.
Karl Heuer <kwzh@gnu.org>
parents:
10910
diff
changeset
|
258 "Currently executing keyboard macro (string or vector); nil if none executing."); |
246 | 259 |
11009 | 260 DEFVAR_KBOARD ("last-kbd-macro", Vlast_kbd_macro, |
10935
73b02c08f17d
(Fstart_kbd_macro): Access Vlast_kbd_macro via perdisplay.
Karl Heuer <kwzh@gnu.org>
parents:
10910
diff
changeset
|
261 "Last kbd macro defined, as a string or vector; nil if none defined."); |
246 | 262 } |
263 | |
264 keys_of_macros () | |
265 { | |
266 initial_define_key (control_x_map, ('e'), "call-last-kbd-macro"); | |
267 initial_define_key (control_x_map, ('('), "start-kbd-macro"); | |
268 initial_define_key (control_x_map, (')'), "end-kbd-macro"); | |
269 } |