Mercurial > hg > xemacs-beta
annotate src/macros.c @ 5521:3310f36295a0
Correct a couple of comments, remove a superfluous gcpro1, fns.c
2011-06-19 Aidan Kehoe <kehoea@parhasard.net>
* fns.c:
* fns.c (list_delete_duplicates_from_end):
Correct a couple of comments in this file.
* fns.c (sublis):
Remove a superfluous gcpro1.
| author | Aidan Kehoe <kehoea@parhasard.net> |
|---|---|
| date | Sun, 19 Jun 2011 16:53:03 +0100 |
| parents | 308d34e9f07d |
| children | 56144c8593a8 |
| rev | line source |
|---|---|
| 428 | 1 /* Keyboard macros. |
| 2 Copyright (C) 1985, 1986, 1992, 1993, 1994 Free Software Foundation, Inc. | |
|
5050
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
3 Copyright (C) 2010 Ben Wing. |
| 428 | 4 |
| 5 This file is part of XEmacs. | |
| 6 | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5050
diff
changeset
|
7 XEmacs is free software: you can redistribute it and/or modify it |
| 428 | 8 under the terms of the GNU General Public License as published by the |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5050
diff
changeset
|
9 Free Software Foundation, either version 3 of the License, or (at your |
|
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5050
diff
changeset
|
10 option) any later version. |
| 428 | 11 |
| 12 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
| 13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
| 14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
| 15 for more details. | |
| 16 | |
| 17 You should have received a copy of the GNU General Public License | |
|
5402
308d34e9f07d
Changed bulk of GPLv2 or later files identified by script
Mats Lidell <matsl@xemacs.org>
parents:
5050
diff
changeset
|
18 along with XEmacs. If not, see <http://www.gnu.org/licenses/>. */ |
| 428 | 19 |
| 20 /* Synched up with: FSF 19.30. */ | |
| 21 | |
| 22 /* A keyboard macro is a string of ASCII characters, or a vector of event | |
| 23 objects. Only key-press, mouse-press, mouse-release, and menu-selection | |
| 24 events ever get into a keyboard macro. | |
| 25 | |
| 26 When interactively defining a keyboard macro, it will always be a vector | |
| 27 of events; strings may be executed for backwards compatibility. | |
| 28 */ | |
| 29 | |
| 30 #include <config.h> | |
| 31 #include "lisp.h" | |
| 800 | 32 |
| 33 #include "buffer.h" | |
| 428 | 34 #include "commands.h" |
| 872 | 35 #include "console-impl.h" |
| 800 | 36 #include "device.h" |
| 37 #include "events.h" | |
| 428 | 38 #include "frame.h" |
| 39 #include "keymap.h" | |
| 800 | 40 #include "macros.h" |
| 41 #include "window.h" | |
| 428 | 42 |
| 43 Lisp_Object Qexecute_kbd_macro; | |
| 44 | |
| 45 /* The current macro and our position in it. When executing nested kbd | |
| 46 macros, previous values for these are wound through the execution stack | |
| 47 with unwind-protect. | |
| 48 */ | |
| 49 Lisp_Object Vexecuting_macro; | |
| 50 int executing_macro_index; | |
| 51 | |
| 52 | |
| 53 DEFUN ("start-kbd-macro", Fstart_kbd_macro, 1, 1, "P", /* | |
| 54 Record subsequent keyboard and menu input, defining a keyboard macro. | |
| 55 The commands are recorded even as they are executed. | |
| 56 Use \\[end-kbd-macro] to finish recording and make the macro available. | |
| 57 Use \\[name-last-kbd-macro] to give it a permanent name. | |
| 58 Non-nil arg (prefix arg) means append to last macro defined; | |
| 59 This begins by re-executing that macro as if you typed it again. | |
| 60 */ | |
| 61 (append)) | |
| 62 { | |
| 63 /* This function can GC */ | |
| 64 struct console *con = XCONSOLE (Vselected_console); | |
| 65 if (!NILP (con->defining_kbd_macro)) | |
| 563 | 66 invalid_operation ("Already defining kbd macro", Qunbound); |
| 428 | 67 |
| 68 if (NILP (con->kbd_macro_builder)) | |
| 69 con->kbd_macro_builder = make_vector (30, Qnil); | |
| 70 | |
| 71 zmacs_region_stays = 1; /* set this before calling Fexecute_kbd_macro() | |
| 72 so that functions there can override */ | |
| 73 MARK_MODELINE_CHANGED; | |
| 74 if (NILP (append)) | |
| 75 { | |
| 76 con->kbd_macro_ptr = 0; | |
| 77 con->kbd_macro_end = 0; | |
| 78 message ("Defining kbd macro..."); | |
| 79 } | |
| 80 else | |
| 81 { | |
| 82 message ("Appending to kbd macro..."); | |
| 83 con->kbd_macro_ptr = con->kbd_macro_end; | |
| 84 Fexecute_kbd_macro (con->last_kbd_macro, make_int (1)); | |
| 85 } | |
| 86 con->defining_kbd_macro = Qt; | |
| 87 | |
| 88 return Qnil; | |
| 89 } | |
| 90 | |
| 91 DEFUN ("end-kbd-macro", Fend_kbd_macro, 0, 1, "P", /* | |
| 92 Finish defining a keyboard macro. | |
| 93 The definition was started by \\[start-kbd-macro]. | |
| 94 The macro is now available for use via \\[call-last-kbd-macro], | |
| 95 or it can be given a name with \\[name-last-kbd-macro] and then invoked | |
| 96 under that name. | |
| 97 | |
| 98 With numeric arg, repeat macro now that many times, | |
| 99 counting the definition just completed as the first repetition. | |
| 100 An argument of zero means repeat until error. | |
| 101 */ | |
| 102 (arg)) | |
| 103 { | |
| 104 /* This function can GC */ | |
| 105 struct console *con = XCONSOLE (Vselected_console); | |
| 106 int repeat; | |
| 107 | |
| 108 if (NILP (con->defining_kbd_macro)) | |
| 563 | 109 invalid_operation ("Not defining kbd macro", Qunbound); |
| 428 | 110 |
| 111 if (NILP (arg)) | |
| 112 repeat = -1; | |
| 113 else | |
| 114 repeat = XINT (Fprefix_numeric_value (arg)); | |
| 115 | |
| 116 if (!NILP (con->defining_kbd_macro)) | |
| 117 { | |
| 118 int i; | |
| 119 int size = con->kbd_macro_end; | |
| 120 | |
| 121 if (size < 0) | |
| 122 size = 0; | |
| 123 con->last_kbd_macro = make_vector (size, Qnil); | |
| 124 for (i = 0; i < size; i++) | |
| 125 XVECTOR_DATA (con->last_kbd_macro) [i] = | |
| 126 XVECTOR_DATA (con->kbd_macro_builder) [i]; | |
| 127 con->defining_kbd_macro = Qnil; | |
| 128 MARK_MODELINE_CHANGED; | |
| 129 message ("Keyboard macro defined"); | |
| 130 } | |
| 131 | |
| 132 zmacs_region_stays = 1; /* set this before calling Fexecute_kbd_macro() | |
| 133 so that functions there can override */ | |
| 134 if (repeat < 0) | |
| 135 return Qnil; | |
| 136 else if (repeat == 0) | |
| 137 return Fexecute_kbd_macro (con->last_kbd_macro, Qzero); | |
| 138 else | |
| 139 return Fexecute_kbd_macro (con->last_kbd_macro, | |
| 140 make_int (repeat - 1)); | |
| 141 } | |
| 142 | |
| 143 /* #### Read the comment in modeline.el to see why this ugliness is | |
| 144 needed. #### Try to avoid it, somehow! */ | |
| 145 DEFUN ("zap-last-kbd-macro-event", Fzap_last_kbd_macro_event, 0, 0, 0, /* | |
| 146 Don't look at this lest you vomit or spontaneously combust. | |
| 147 */ | |
| 148 ()) | |
| 149 { | |
| 150 struct console *con = XCONSOLE (Vselected_console); | |
| 151 if (con->kbd_macro_end) | |
| 152 --con->kbd_macro_end; | |
| 153 return Qnil; | |
| 154 } | |
| 155 | |
| 156 /* Store event into kbd macro being defined | |
| 157 */ | |
| 158 void | |
| 159 store_kbd_macro_event (Lisp_Object event) | |
| 160 { | |
| 161 struct console *con = event_console_or_selected (event); | |
| 162 | |
| 163 if (con->kbd_macro_ptr == XVECTOR_LENGTH (con->kbd_macro_builder)) | |
| 164 { | |
| 165 int i; | |
| 166 int old_size = XVECTOR_LENGTH (con->kbd_macro_builder); | |
| 167 int new_size = old_size * 2; | |
| 3025 | 168 Lisp_Object new_ = make_vector (new_size, Qnil); |
| 428 | 169 for (i = 0; i < old_size; i++) |
| 3025 | 170 XVECTOR_DATA (new_) [i] = XVECTOR_DATA (con->kbd_macro_builder) [i]; |
| 171 con->kbd_macro_builder = new_; | |
| 428 | 172 } |
| 173 XVECTOR_DATA (con->kbd_macro_builder) [con->kbd_macro_ptr++] = | |
| 174 Fcopy_event (event, Qnil); | |
| 175 } | |
| 176 | |
| 177 /* Extract the next kbd-macro element into the given event. | |
| 178 If we're done, throws to the catch in Fexecute_kbd_macro(). | |
| 179 */ | |
| 180 void | |
| 181 pop_kbd_macro_event (Lisp_Object event) | |
| 182 { | |
|
5050
6f2158fa75ed
Fix quick-build, use asserts() in place of ABORT()
Ben Wing <ben@xemacs.org>
parents:
4677
diff
changeset
|
183 assert (!NILP (Vexecuting_macro)); |
| 428 | 184 |
| 185 if (STRINGP (Vexecuting_macro) || VECTORP (Vexecuting_macro)) | |
| 186 { | |
| 187 if (executing_macro_index < XINT (Flength (Vexecuting_macro))) | |
| 188 { | |
| 189 nth_of_key_sequence_as_event (Vexecuting_macro, | |
| 190 executing_macro_index++, | |
| 191 event); | |
| 192 return; | |
| 193 } | |
| 194 } | |
| 195 else if (!EQ (Vexecuting_macro, Qt)) /* Some things replace the macro | |
| 196 with Qt to force an early exit. */ | |
| 563 | 197 signal_error (Qinvalid_state, "junk in executing-macro", Qunbound); |
| 428 | 198 |
|
4677
8f1ee2d15784
Support full Common Lisp multiple values in C.
Aidan Kehoe <kehoea@parhasard.net>
parents:
3025
diff
changeset
|
199 throw_or_bomb_out (Qexecute_kbd_macro, Qt, 0, Qnil, Qnil); |
| 428 | 200 } |
| 201 | |
| 202 | |
| 203 /* Declare that all chars stored so far in the kbd macro being defined | |
| 204 really belong to it. This is done in between editor commands. */ | |
| 205 | |
| 206 void | |
| 207 finalize_kbd_macro_chars (struct console *con) | |
| 208 { | |
| 209 con->kbd_macro_end = con->kbd_macro_ptr; | |
| 210 } | |
| 211 | |
| 212 DEFUN ("cancel-kbd-macro-events", Fcancel_kbd_macro_events, 0, 0, 0, /* | |
| 213 Cancel the events added to a keyboard macro for this command. | |
| 214 */ | |
| 215 ()) | |
| 216 { | |
| 217 struct console *con = XCONSOLE (Vselected_console); | |
| 218 | |
| 219 con->kbd_macro_ptr = con->kbd_macro_end; | |
| 220 | |
| 221 return Qnil; | |
| 222 } | |
| 223 | |
| 224 DEFUN ("call-last-kbd-macro", Fcall_last_kbd_macro, 0, 1, "p", /* | |
| 225 Call the last keyboard macro that you defined with \\[start-kbd-macro]. | |
| 226 | |
| 227 A prefix argument serves as a repeat count. Zero means repeat until error. | |
| 228 | |
| 229 To make a macro permanent so you can call it even after | |
| 230 defining others, use \\[name-last-kbd-macro]. | |
| 231 */ | |
| 232 (prefix)) | |
| 233 { | |
| 234 /* This function can GC */ | |
| 235 struct console *con = XCONSOLE (Vselected_console); | |
| 236 | |
| 237 if (!NILP (con->defining_kbd_macro)) | |
| 563 | 238 invalid_operation ("Can't execute anonymous macro while defining one", Qunbound); |
| 428 | 239 else if (NILP (con->last_kbd_macro)) |
| 563 | 240 invalid_operation ("No kbd macro has been defined", Qunbound); |
| 428 | 241 else |
| 242 Fexecute_kbd_macro (con->last_kbd_macro, prefix); | |
| 243 return Qnil; | |
| 244 } | |
| 245 | |
| 246 DEFUN ("execute-kbd-macro", Fexecute_kbd_macro, 1, 2, 0, /* | |
| 247 Execute MACRO as string of editor command characters. | |
| 248 If MACRO is a symbol, its function definition is used. | |
| 249 COUNT is a repeat count, or nil for once, or 0 for infinite loop. | |
| 250 */ | |
| 444 | 251 (macro, count)) |
| 428 | 252 { |
| 253 /* This function can GC */ | |
| 254 Lisp_Object final; | |
| 255 int speccount = specpdl_depth (); | |
| 256 int repeat = 1; | |
| 257 struct gcpro gcpro1; | |
| 258 struct console *con = XCONSOLE (Vselected_console); | |
| 259 | |
| 444 | 260 if (!NILP (count)) |
| 428 | 261 { |
| 444 | 262 count = Fprefix_numeric_value (count); |
| 263 repeat = XINT (count); | |
| 428 | 264 } |
| 265 | |
| 266 final = indirect_function (macro, 1); | |
| 267 if (!STRINGP (final) && !VECTORP (final)) | |
| 563 | 268 invalid_argument ("Keyboard macros must be strings or vectors", Qunbound); |
| 428 | 269 |
| 853 | 270 internal_bind_lisp_object (&Vexecuting_macro, Vexecuting_macro); |
| 271 internal_bind_int (&executing_macro_index, executing_macro_index); | |
| 428 | 272 |
| 273 GCPRO1 (final); | |
| 274 do | |
| 275 { | |
| 276 Vexecuting_macro = final; | |
| 277 executing_macro_index = 0; | |
| 278 con->prefix_arg = Qnil; | |
| 279 internal_catch (Qexecute_kbd_macro, call_command_loop, | |
| 2532 | 280 Qnil, 0, 0, 0); |
| 428 | 281 } |
| 282 while (--repeat != 0 | |
| 283 && (STRINGP (Vexecuting_macro) || | |
| 284 VECTORP (Vexecuting_macro))); | |
| 285 | |
| 286 UNGCPRO; | |
| 771 | 287 return unbind_to (speccount); |
| 428 | 288 } |
| 289 | |
| 290 | |
| 291 void | |
| 292 syms_of_macros (void) | |
| 293 { | |
| 294 DEFSUBR (Fstart_kbd_macro); | |
| 295 DEFSUBR (Fend_kbd_macro); | |
| 296 DEFSUBR (Fzap_last_kbd_macro_event); | |
| 297 DEFSUBR (Fcall_last_kbd_macro); | |
| 298 DEFSUBR (Fexecute_kbd_macro); | |
| 299 DEFSUBR (Fcancel_kbd_macro_events); | |
| 563 | 300 DEFSYMBOL (Qexecute_kbd_macro); |
| 428 | 301 } |
| 302 | |
| 303 void | |
| 304 vars_of_macros (void) | |
| 305 { | |
| 306 DEFVAR_LISP ("executing-macro", &Vexecuting_macro /* | |
| 307 Currently executing keyboard macro (a vector of events or string); | |
| 308 nil if none executing. | |
| 309 */ ); | |
| 310 | |
| 311 DEFVAR_LISP ("executing-kbd-macro", &Vexecuting_macro /* | |
| 312 Currently executing keyboard macro (a vector of events or string); | |
| 313 nil if none executing. | |
| 314 */ ); | |
| 315 } | |
| 316 | |
| 317 void | |
| 318 init_macros (void) | |
| 319 { | |
| 320 Vexecuting_macro = Qnil; | |
| 321 } | |
| 322 |