Mercurial > hg > xemacs-beta
annotate src/event-stream.c @ 5117:3742ea8250b5 ben-lisp-object ben-lisp-object-final-ws-year-2005
Checking in final CVS version of workspace 'ben-lisp-object'
author | Ben Wing <ben@xemacs.org> |
---|---|
date | Sat, 26 Dec 2009 00:20:27 -0600 |
parents | facf3239ba30 |
children | e0db3c197671 |
rev | line source |
---|---|
428 | 1 /* The portable interface to event streams. |
2 Copyright (C) 1991, 1992, 1993, 1994, 1995 Free Software Foundation, Inc. | |
3 Copyright (C) 1995 Board of Trustees, University of Illinois. | |
4 Copyright (C) 1995 Sun Microsystems, Inc. | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
5 Copyright (C) 1995, 1996, 2001, 2002, 2003, 2005 Ben Wing. |
428 | 6 |
7 This file is part of XEmacs. | |
8 | |
9 XEmacs is free software; you can redistribute it and/or modify it | |
10 under the terms of the GNU General Public License as published by the | |
11 Free Software Foundation; either version 2, or (at your option) any | |
12 later version. | |
13 | |
14 XEmacs is distributed in the hope that it will be useful, but WITHOUT | |
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or | |
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License | |
17 for more details. | |
18 | |
19 You should have received a copy of the GNU General Public License | |
20 along with XEmacs; see the file COPYING. If not, write to | |
21 the Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
22 Boston, MA 02111-1307, USA. */ | |
23 | |
24 /* Synched up with: Not in FSF. */ | |
25 | |
442 | 26 /* Authorship: |
27 | |
28 Created 1991 by Jamie Zawinski. | |
29 A great deal of work over the ages by Ben Wing (Mule-ization for 19.12, | |
30 device abstraction for 19.12/19.13, async timers for 19.14, | |
31 rewriting of focus code for 19.12, pre-idle hook for 19.12, | |
32 redoing of signal and quit handling for 19.9 and 19.12, | |
33 misc-user events to clean up menu/scrollbar handling for 19.11, | |
34 function-key-map/key-translation-map/keyboard-translate-table for | |
35 19.13/19.14, open-dribble-file for 19.13, much other cleanup). | |
36 focus-follows-mouse from Chuck Thompson, 1995. | |
37 XIM stuff by Martin Buchholz, c. 1996?. | |
38 */ | |
39 | |
428 | 40 /* This file has been Mule-ized. */ |
41 | |
42 /* | |
43 * DANGER!! | |
44 * | |
45 * If you ever change ANYTHING in this file, you MUST run the | |
46 * testcases at the end to make sure that you haven't changed | |
47 * the semantics of recent-keys, last-input-char, or keyboard | |
48 * macros. You'd be surprised how easy it is to break this. | |
49 * | |
50 */ | |
51 | |
52 /* TODO: | |
1204 | 53 [This stuff is way too hard to maintain - needs rework.] |
54 I don't think it's that bad in the main. I've done a fair amount of | |
55 cleanup work over the ages; the only stuff that's probably still somewhat | |
56 messy is the command-builder handling, which is that way because it's | |
57 trying to be "compatible" with pseudo-standards established by Emacs | |
58 v18. | |
428 | 59 |
60 The command builder should deal only with key and button events. | |
61 Other command events should be able to come in the MIDDLE of a key | |
62 sequence, without disturbing the key sequence composition, or the | |
63 command builder structure representing it. | |
64 | |
65 Someone should rethink universal-argument and figure out how an | |
66 arbitrary command can influence the next command (universal-argument | |
67 or universal-coding-system-argument) or the next key (hyperify). | |
68 | |
69 Both C-h and Help in the middle of a key sequence should trigger | |
70 prefix-help-command. help-char is stupid. Maybe we need | |
71 keymap-of-last-resort? | |
72 | |
73 After prefix-help is run, one should be able to CONTINUE TYPING, | |
74 instead of RETYPING, the key sequence. | |
75 */ | |
76 | |
77 #include <config.h> | |
78 #include "lisp.h" | |
79 | |
80 #include "blocktype.h" | |
81 #include "buffer.h" | |
82 #include "commands.h" | |
872 | 83 #include "device-impl.h" |
428 | 84 #include "elhash.h" |
85 #include "events.h" | |
872 | 86 #include "frame-impl.h" |
428 | 87 #include "insdel.h" /* for buffer_reset_changes */ |
88 #include "keymap.h" | |
89 #include "lstream.h" | |
90 #include "macros.h" /* for defining_keyboard_macro */ | |
442 | 91 #include "menubar.h" /* #### for evil kludges. */ |
428 | 92 #include "process.h" |
1292 | 93 #include "profile.h" |
872 | 94 #include "window-impl.h" |
428 | 95 |
96 #include "sysdep.h" /* init_poll_for_quit() */ | |
97 #include "syssignal.h" /* SIGCHLD, etc. */ | |
98 #include "sysfile.h" | |
99 #include "systime.h" /* to set Vlast_input_time */ | |
100 | |
101 #include "file-coding.h" | |
102 | |
103 #include <errno.h> | |
104 | |
105 /* The number of keystrokes between auto-saves. */ | |
458 | 106 static Fixnum auto_save_interval; |
428 | 107 |
108 Lisp_Object Qundefined_keystroke_sequence; | |
563 | 109 Lisp_Object Qinvalid_key_binding; |
428 | 110 |
111 Lisp_Object Qcommand_event_p; | |
112 | |
113 /* Hooks to run before and after each command. */ | |
114 Lisp_Object Vpre_command_hook, Vpost_command_hook; | |
115 Lisp_Object Qpre_command_hook, Qpost_command_hook; | |
116 | |
442 | 117 /* See simple.el */ |
118 Lisp_Object Qhandle_pre_motion_command, Qhandle_post_motion_command; | |
119 | |
428 | 120 /* Hook run when XEmacs is about to be idle. */ |
121 Lisp_Object Qpre_idle_hook, Vpre_idle_hook; | |
122 | |
123 /* Control gratuitous keyboard focus throwing. */ | |
124 int focus_follows_mouse; | |
125 | |
444 | 126 /* When true, modifier keys are sticky. */ |
442 | 127 int modifier_keys_are_sticky; |
444 | 128 /* Modifier keys are sticky for this many milliseconds. */ |
129 Lisp_Object Vmodifier_keys_sticky_time; | |
130 | |
2828 | 131 /* If true, "Russian C-x processing" is enabled. */ |
132 int try_alternate_layouts_for_commands; | |
133 | |
444 | 134 /* Here FSF Emacs 20.7 defines Vpost_command_idle_hook, |
135 post_command_idle_delay, Vdeferred_action_list, and | |
136 Vdeferred_action_function, but we don't because that stuff is crap, | |
1315 | 137 and we're smarter than them, and their mommas are fat. */ |
444 | 138 |
139 /* FSF Emacs 20.7 also defines Vinput_method_function, | |
140 Qinput_method_exit_on_first_char and Qinput_method_use_echo_area. | |
1315 | 141 I don't know whether this should be imported or not. */ |
428 | 142 |
143 /* Non-nil disable property on a command means | |
144 do not execute it; call disabled-command-hook's value instead. */ | |
733 | 145 Lisp_Object Qdisabled; |
428 | 146 |
147 /* Last keyboard or mouse input event read as a command. */ | |
148 Lisp_Object Vlast_command_event; | |
149 | |
150 /* The nearest ASCII equivalent of the above. */ | |
151 Lisp_Object Vlast_command_char; | |
152 | |
153 /* Last keyboard or mouse event read for any purpose. */ | |
154 Lisp_Object Vlast_input_event; | |
155 | |
156 /* The nearest ASCII equivalent of the above. */ | |
157 Lisp_Object Vlast_input_char; | |
158 | |
159 Lisp_Object Vcurrent_mouse_event; | |
160 | |
161 /* This is fbound in cmdloop.el, see the commentary there */ | |
162 Lisp_Object Qcancel_mode_internal; | |
163 | |
164 /* If not Qnil, event objects to be read as the next command input */ | |
165 Lisp_Object Vunread_command_events; | |
166 Lisp_Object Vunread_command_event; /* obsoleteness support */ | |
167 | |
168 static Lisp_Object Qunread_command_events, Qunread_command_event; | |
169 | |
170 /* Previous command, represented by a Lisp object. | |
442 | 171 Does not include prefix commands and arg setting commands. */ |
428 | 172 Lisp_Object Vlast_command; |
173 | |
442 | 174 /* Contents of this-command-properties for the last command. */ |
175 Lisp_Object Vlast_command_properties; | |
176 | |
428 | 177 /* If a command sets this, the value goes into |
442 | 178 last-command for the next command. */ |
428 | 179 Lisp_Object Vthis_command; |
180 | |
442 | 181 /* If a command sets this, the value goes into |
182 last-command-properties for the next command. */ | |
183 Lisp_Object Vthis_command_properties; | |
184 | |
428 | 185 /* The value of point when the last command was executed. */ |
665 | 186 Charbpos last_point_position; |
428 | 187 |
188 /* The frame that was current when the last command was started. */ | |
189 Lisp_Object Vlast_selected_frame; | |
190 | |
191 /* The buffer that was current when the last command was started. */ | |
192 Lisp_Object last_point_position_buffer; | |
193 | |
194 /* A (16bit . 16bit) representation of the time of the last-command-event. */ | |
195 Lisp_Object Vlast_input_time; | |
196 | |
197 /* A (16bit 16bit usec) representation of the time | |
198 of the last-command-event. */ | |
199 Lisp_Object Vlast_command_event_time; | |
200 | |
201 /* Character to recognize as the help char. */ | |
202 Lisp_Object Vhelp_char; | |
203 | |
204 /* Form to execute when help char is typed. */ | |
205 Lisp_Object Vhelp_form; | |
206 | |
207 /* Command to run when the help character follows a prefix key. */ | |
208 Lisp_Object Vprefix_help_command; | |
209 | |
210 /* Flag to tell QUIT that some interesting occurrence (e.g. a keypress) | |
211 may have happened. */ | |
212 volatile int something_happened; | |
213 | |
214 /* Hash table to translate keysyms through */ | |
215 Lisp_Object Vkeyboard_translate_table; | |
216 | |
217 /* If control-meta-super-shift-X is undefined, try control-meta-super-x */ | |
218 Lisp_Object Vretry_undefined_key_binding_unshifted; | |
219 Lisp_Object Qretry_undefined_key_binding_unshifted; | |
220 | |
221 /* Console that corresponds to our controlling terminal */ | |
222 Lisp_Object Vcontrolling_terminal; | |
223 | |
224 /* An event (actually an event chain linked through event_next) or Qnil. | |
225 */ | |
226 Lisp_Object Vthis_command_keys; | |
227 Lisp_Object Vthis_command_keys_tail; | |
228 | |
229 /* #### kludge! */ | |
230 Lisp_Object Qauto_show_make_point_visible; | |
231 | |
232 /* File in which we write all commands we read; an lstream */ | |
233 static Lisp_Object Vdribble_file; | |
234 | |
235 /* Recent keys ring location; a vector of events or nil-s */ | |
236 Lisp_Object Vrecent_keys_ring; | |
237 int recent_keys_ring_size; | |
238 int recent_keys_ring_index; | |
239 | |
240 /* Boolean specifying whether keystrokes should be added to | |
241 recent-keys. */ | |
242 int inhibit_input_event_recording; | |
243 | |
430 | 244 Lisp_Object Qself_insert_defer_undo; |
245 | |
1268 | 246 int in_modal_loop; |
247 | |
248 /* the number of keyboard characters read. callint.c wants this. */ | |
249 Charcount num_input_chars; | |
428 | 250 |
1292 | 251 static Lisp_Object Qnext_event, Qdispatch_event, QSnext_event_internal; |
252 static Lisp_Object QSexecute_internal_event; | |
253 | |
428 | 254 #ifdef DEBUG_XEMACS |
458 | 255 Fixnum debug_emacs_events; |
428 | 256 |
257 static void | |
258 external_debugging_print_event (char *event_description, Lisp_Object event) | |
259 { | |
826 | 260 write_c_string (Qexternal_debugging_output, "("); |
261 write_c_string (Qexternal_debugging_output, event_description); | |
262 write_c_string (Qexternal_debugging_output, ") "); | |
428 | 263 print_internal (event, Qexternal_debugging_output, 1); |
826 | 264 write_c_string (Qexternal_debugging_output, "\n"); |
428 | 265 } |
266 #define DEBUG_PRINT_EMACS_EVENT(event_description, event) do { \ | |
267 if (debug_emacs_events) \ | |
268 external_debugging_print_event (event_description, event); \ | |
269 } while (0) | |
270 #else | |
271 #define DEBUG_PRINT_EMACS_EVENT(string, event) | |
272 #endif | |
273 | |
274 | |
275 /* The callback routines for the window system or terminal driver */ | |
276 struct event_stream *event_stream; | |
277 | |
2367 | 278 |
279 /* | |
280 | |
281 See also | |
282 | |
283 (Info-goto-node "(internals)Event Stream Callback Routines") | |
284 */ | |
1204 | 285 |
428 | 286 static Lisp_Object command_event_queue; |
287 static Lisp_Object command_event_queue_tail; | |
288 | |
1204 | 289 Lisp_Object dispatch_event_queue; |
290 static Lisp_Object dispatch_event_queue_tail; | |
291 | |
428 | 292 /* Nonzero means echo unfinished commands after this many seconds of pause. */ |
293 static Lisp_Object Vecho_keystrokes; | |
294 | |
295 /* The number of keystrokes since the last auto-save. */ | |
296 static int keystrokes_since_auto_save; | |
297 | |
298 /* Used by the C-g signal handler so that it will never "hard quit" | |
299 when waiting for an event. Otherwise holding down C-g could | |
300 cause a suspension back to the shell, which is generally | |
301 undesirable. (#### This doesn't fully work.) */ | |
302 | |
303 int emacs_is_blocking; | |
304 | |
305 /* Handlers which run during sit-for, sleep-for and accept-process-output | |
306 are not allowed to recursively call these routines. We record here | |
307 if we are in that situation. */ | |
308 | |
1268 | 309 static int recursive_sit_for; |
310 | |
311 static void pre_command_hook (void); | |
312 static void post_command_hook (void); | |
313 static void maybe_kbd_translate (Lisp_Object event); | |
314 static void push_this_command_keys (Lisp_Object event); | |
315 static void push_recent_keys (Lisp_Object event); | |
316 static void dribble_out_event (Lisp_Object event); | |
317 static void execute_internal_event (Lisp_Object event); | |
318 static int is_scrollbar_event (Lisp_Object event); | |
428 | 319 |
320 | |
321 /**********************************************************************/ | |
322 /* Command-builder object */ | |
323 /**********************************************************************/ | |
324 | |
325 #define XCOMMAND_BUILDER(x) \ | |
326 XRECORD (x, command_builder, struct command_builder) | |
771 | 327 #define wrap_command_builder(p) wrap_record (p, command_builder) |
428 | 328 #define COMMAND_BUILDERP(x) RECORDP (x, command_builder) |
329 #define CHECK_COMMAND_BUILDER(x) CHECK_RECORD (x, command_builder) | |
771 | 330 #define CONCHECK_COMMAND_BUILDER(x) CONCHECK_RECORD (x, command_builder) |
331 | |
1204 | 332 static const struct memory_description command_builder_description [] = { |
934 | 333 { XD_LISP_OBJECT, offsetof (struct command_builder, current_events) }, |
334 { XD_LISP_OBJECT, offsetof (struct command_builder, most_current_event) }, | |
335 { XD_LISP_OBJECT, offsetof (struct command_builder, last_non_munged_event) }, | |
336 { XD_LISP_OBJECT, offsetof (struct command_builder, console) }, | |
1204 | 337 { XD_LISP_OBJECT_ARRAY, offsetof (struct command_builder, first_mungeable_event), 2 }, |
934 | 338 { XD_END } |
339 }; | |
340 | |
428 | 341 static Lisp_Object |
342 mark_command_builder (Lisp_Object obj) | |
343 { | |
344 struct command_builder *builder = XCOMMAND_BUILDER (obj); | |
345 mark_object (builder->current_events); | |
346 mark_object (builder->most_current_event); | |
347 mark_object (builder->last_non_munged_event); | |
1204 | 348 mark_object (builder->first_mungeable_event[0]); |
349 mark_object (builder->first_mungeable_event[1]); | |
428 | 350 return builder->console; |
351 } | |
352 | |
353 static void | |
354 finalize_command_builder (void *header, int for_disksave) | |
355 { | |
356 if (!for_disksave) | |
357 { | |
771 | 358 struct command_builder *b = (struct command_builder *) header; |
359 if (b->echo_buf) | |
360 { | |
1726 | 361 xfree (b->echo_buf, Ibyte *); |
771 | 362 b->echo_buf = 0; |
363 } | |
428 | 364 } |
365 } | |
366 | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
367 DEFINE_NONDUMPABLE_LISP_OBJECT ("command-builder", command_builder, |
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
368 mark_command_builder, |
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
369 0, |
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
370 finalize_command_builder, 0, 0, |
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
371 command_builder_description, |
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
372 struct command_builder); |
771 | 373 |
428 | 374 static void |
375 reset_command_builder_event_chain (struct command_builder *builder) | |
376 { | |
377 builder->current_events = Qnil; | |
378 builder->most_current_event = Qnil; | |
379 builder->last_non_munged_event = Qnil; | |
1204 | 380 builder->first_mungeable_event[0] = Qnil; |
381 builder->first_mungeable_event[1] = Qnil; | |
428 | 382 } |
383 | |
384 Lisp_Object | |
771 | 385 allocate_command_builder (Lisp_Object console, int with_echo_buf) |
428 | 386 { |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
387 Lisp_Object builder_obj = ALLOC_LISP_OBJECT (command_builder); |
771 | 388 struct command_builder *builder = XCOMMAND_BUILDER (builder_obj); |
428 | 389 |
390 builder->console = console; | |
391 reset_command_builder_event_chain (builder); | |
771 | 392 if (with_echo_buf) |
393 { | |
394 /* #### This badly needs to be turned into a Dynarr */ | |
395 builder->echo_buf_length = 300; /* #### Kludge */ | |
867 | 396 builder->echo_buf = xnew_array (Ibyte, builder->echo_buf_length); |
771 | 397 builder->echo_buf[0] = 0; |
398 } | |
399 else | |
400 { | |
401 builder->echo_buf_length = 0; | |
402 builder->echo_buf = NULL; | |
403 } | |
428 | 404 builder->echo_buf_index = -1; |
405 builder->self_insert_countdown = 0; | |
406 | |
407 return builder_obj; | |
408 } | |
409 | |
771 | 410 /* Copy or clone COLLAPSING (copy to NEW_BUILDINGS if non-zero, |
411 otherwise clone); but don't copy the echo-buf stuff. (The calling | |
412 routines don't need it and will reset it, and we would rather avoid | |
413 malloc.) */ | |
414 | |
415 static Lisp_Object | |
416 copy_command_builder (struct command_builder *collapsing, | |
417 struct command_builder *new_buildings) | |
418 { | |
419 if (!new_buildings) | |
420 new_buildings = XCOMMAND_BUILDER (allocate_command_builder (Qnil, 0)); | |
421 | |
422 new_buildings->self_insert_countdown = collapsing->self_insert_countdown; | |
423 | |
424 deallocate_event_chain (new_buildings->current_events); | |
425 new_buildings->current_events = | |
426 copy_event_chain (collapsing->current_events); | |
427 | |
428 new_buildings->most_current_event = | |
429 transfer_event_chain_pointer (collapsing->most_current_event, | |
430 collapsing->current_events, | |
431 new_buildings->current_events); | |
432 new_buildings->last_non_munged_event = | |
433 transfer_event_chain_pointer (collapsing->last_non_munged_event, | |
434 collapsing->current_events, | |
435 new_buildings->current_events); | |
1204 | 436 new_buildings->first_mungeable_event[0] = |
437 transfer_event_chain_pointer (collapsing->first_mungeable_event[0], | |
771 | 438 collapsing->current_events, |
439 new_buildings->current_events); | |
1204 | 440 new_buildings->first_mungeable_event[1] = |
441 transfer_event_chain_pointer (collapsing->first_mungeable_event[1], | |
771 | 442 collapsing->current_events, |
443 new_buildings->current_events); | |
444 | |
445 return wrap_command_builder (new_buildings); | |
446 } | |
447 | |
448 static void | |
449 free_command_builder (struct command_builder *builder) | |
450 { | |
451 if (builder->echo_buf) | |
452 { | |
1726 | 453 xfree (builder->echo_buf, Ibyte *); |
771 | 454 builder->echo_buf = NULL; |
455 } | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
456 FREE_LCRECORD (wrap_command_builder (builder)); |
771 | 457 } |
458 | |
428 | 459 static void |
460 command_builder_append_event (struct command_builder *builder, | |
461 Lisp_Object event) | |
462 { | |
463 assert (EVENTP (event)); | |
464 | |
771 | 465 event = Fcopy_event (event, Qnil); |
428 | 466 if (EVENTP (builder->most_current_event)) |
467 XSET_EVENT_NEXT (builder->most_current_event, event); | |
468 else | |
469 builder->current_events = event; | |
470 | |
471 builder->most_current_event = event; | |
1204 | 472 if (NILP (builder->first_mungeable_event[0])) |
473 builder->first_mungeable_event[0] = event; | |
474 if (NILP (builder->first_mungeable_event[1])) | |
475 builder->first_mungeable_event[1] = event; | |
428 | 476 } |
477 | |
478 | |
479 /**********************************************************************/ | |
480 /* Low-level interfaces onto event methods */ | |
481 /**********************************************************************/ | |
482 | |
483 static void | |
1268 | 484 check_event_stream_ok (void) |
428 | 485 { |
486 if (!event_stream && noninteractive) | |
814 | 487 /* See comment in init_event_stream() */ |
488 init_event_stream (); | |
489 else assert (event_stream); | |
428 | 490 } |
491 | |
492 void | |
440 | 493 event_stream_handle_magic_event (Lisp_Event *event) |
428 | 494 { |
1268 | 495 check_event_stream_ok (); |
428 | 496 event_stream->handle_magic_event_cb (event); |
497 } | |
498 | |
788 | 499 void |
500 event_stream_format_magic_event (Lisp_Event *event, Lisp_Object pstream) | |
501 { | |
1268 | 502 check_event_stream_ok (); |
788 | 503 event_stream->format_magic_event_cb (event, pstream); |
504 } | |
505 | |
506 int | |
507 event_stream_compare_magic_event (Lisp_Event *e1, Lisp_Event *e2) | |
508 { | |
1268 | 509 check_event_stream_ok (); |
788 | 510 return event_stream->compare_magic_event_cb (e1, e2); |
511 } | |
512 | |
513 Hashcode | |
514 event_stream_hash_magic_event (Lisp_Event *e) | |
515 { | |
1268 | 516 check_event_stream_ok (); |
788 | 517 return event_stream->hash_magic_event_cb (e); |
518 } | |
519 | |
428 | 520 static int |
521 event_stream_add_timeout (EMACS_TIME timeout) | |
522 { | |
1268 | 523 check_event_stream_ok (); |
428 | 524 return event_stream->add_timeout_cb (timeout); |
525 } | |
526 | |
527 static void | |
528 event_stream_remove_timeout (int id) | |
529 { | |
1268 | 530 check_event_stream_ok (); |
428 | 531 event_stream->remove_timeout_cb (id); |
532 } | |
533 | |
534 void | |
535 event_stream_select_console (struct console *con) | |
536 { | |
1268 | 537 check_event_stream_ok (); |
428 | 538 if (!con->input_enabled) |
539 { | |
540 event_stream->select_console_cb (con); | |
541 con->input_enabled = 1; | |
542 } | |
543 } | |
544 | |
545 void | |
546 event_stream_unselect_console (struct console *con) | |
547 { | |
1268 | 548 check_event_stream_ok (); |
428 | 549 if (con->input_enabled) |
550 { | |
551 event_stream->unselect_console_cb (con); | |
552 con->input_enabled = 0; | |
553 } | |
554 } | |
555 | |
556 void | |
853 | 557 event_stream_select_process (Lisp_Process *proc, int doin, int doerr) |
428 | 558 { |
853 | 559 int cur_in, cur_err; |
560 | |
1268 | 561 check_event_stream_ok (); |
853 | 562 |
563 cur_in = get_process_selected_p (proc, 0); | |
564 if (cur_in) | |
565 doin = 0; | |
566 | |
567 if (!process_has_separate_stderr (wrap_process (proc))) | |
428 | 568 { |
853 | 569 doerr = 0; |
570 cur_err = 0; | |
571 } | |
572 else | |
573 { | |
574 cur_err = get_process_selected_p (proc, 1); | |
575 if (cur_err) | |
576 doerr = 0; | |
577 } | |
578 | |
579 if (doin || doerr) | |
580 { | |
581 event_stream->select_process_cb (proc, doin, doerr); | |
582 set_process_selected_p (proc, cur_in || doin, cur_err || doerr); | |
428 | 583 } |
584 } | |
585 | |
586 void | |
853 | 587 event_stream_unselect_process (Lisp_Process *proc, int doin, int doerr) |
428 | 588 { |
853 | 589 int cur_in, cur_err; |
590 | |
1268 | 591 check_event_stream_ok (); |
853 | 592 |
593 cur_in = get_process_selected_p (proc, 0); | |
594 if (!cur_in) | |
595 doin = 0; | |
596 | |
597 if (!process_has_separate_stderr (wrap_process (proc))) | |
428 | 598 { |
853 | 599 doerr = 0; |
600 cur_err = 0; | |
601 } | |
602 else | |
603 { | |
604 cur_err = get_process_selected_p (proc, 1); | |
605 if (!cur_err) | |
606 doerr = 0; | |
607 } | |
608 | |
609 if (doin || doerr) | |
610 { | |
611 event_stream->unselect_process_cb (proc, doin, doerr); | |
612 set_process_selected_p (proc, cur_in && !doin, cur_err && !doerr); | |
428 | 613 } |
614 } | |
615 | |
853 | 616 void |
617 event_stream_create_io_streams (void *inhandle, void *outhandle, | |
618 void *errhandle, Lisp_Object *instream, | |
619 Lisp_Object *outstream, | |
620 Lisp_Object *errstream, | |
621 USID *in_usid, | |
622 USID *err_usid, | |
623 int flags) | |
428 | 624 { |
1268 | 625 check_event_stream_ok (); |
853 | 626 event_stream->create_io_streams_cb |
627 (inhandle, outhandle, errhandle, instream, outstream, errstream, | |
628 in_usid, err_usid, flags); | |
428 | 629 } |
630 | |
853 | 631 void |
632 event_stream_delete_io_streams (Lisp_Object instream, | |
633 Lisp_Object outstream, | |
634 Lisp_Object errstream, | |
635 USID *in_usid, | |
636 USID *err_usid) | |
428 | 637 { |
1268 | 638 check_event_stream_ok (); |
853 | 639 event_stream->delete_io_streams_cb (instream, outstream, errstream, |
640 in_usid, err_usid); | |
428 | 641 } |
642 | |
442 | 643 static int |
644 event_stream_current_event_timestamp (struct console *c) | |
645 { | |
646 if (event_stream && event_stream->current_event_timestamp_cb) | |
647 return event_stream->current_event_timestamp_cb (c); | |
648 else | |
649 return 0; | |
650 } | |
428 | 651 |
652 | |
653 /**********************************************************************/ | |
654 /* Character prompting */ | |
655 /**********************************************************************/ | |
656 | |
657 static void | |
658 echo_key_event (struct command_builder *command_builder, | |
659 Lisp_Object event) | |
660 { | |
661 /* This function can GC */ | |
793 | 662 DECLARE_EISTRING_MALLOC (buf); |
428 | 663 Bytecount buf_index = command_builder->echo_buf_index; |
867 | 664 Ibyte *e; |
428 | 665 Bytecount len; |
666 | |
667 if (buf_index < 0) | |
668 { | |
669 buf_index = 0; /* We're echoing now */ | |
670 clear_echo_area (selected_frame (), Qnil, 0); | |
671 } | |
672 | |
934 | 673 format_event_object (buf, event, 1); |
793 | 674 len = eilen (buf); |
428 | 675 |
676 if (len + buf_index + 4 > command_builder->echo_buf_length) | |
793 | 677 { |
678 eifree (buf); | |
679 return; | |
680 } | |
428 | 681 e = command_builder->echo_buf + buf_index; |
793 | 682 memcpy (e, eidata (buf), len); |
428 | 683 e += len; |
793 | 684 eifree (buf); |
428 | 685 |
686 e[0] = ' '; | |
687 e[1] = '-'; | |
688 e[2] = ' '; | |
689 e[3] = 0; | |
690 | |
691 command_builder->echo_buf_index = buf_index + len + 1; | |
692 } | |
693 | |
694 static void | |
695 regenerate_echo_keys_from_this_command_keys (struct command_builder * | |
696 builder) | |
697 { | |
698 Lisp_Object event; | |
699 | |
700 builder->echo_buf_index = 0; | |
701 | |
702 EVENT_CHAIN_LOOP (event, Vthis_command_keys) | |
703 echo_key_event (builder, event); | |
704 } | |
705 | |
706 static void | |
707 maybe_echo_keys (struct command_builder *command_builder, int no_snooze) | |
708 { | |
709 /* This function can GC */ | |
710 double echo_keystrokes; | |
711 struct frame *f = selected_frame (); | |
853 | 712 int depth = begin_dont_check_for_quit (); |
713 | |
428 | 714 /* Message turns off echoing unless more keystrokes turn it on again. */ |
715 if (echo_area_active (f) && !EQ (Qcommand, echo_area_status (f))) | |
853 | 716 goto done; |
428 | 717 |
718 if (INTP (Vecho_keystrokes) || FLOATP (Vecho_keystrokes)) | |
719 echo_keystrokes = extract_float (Vecho_keystrokes); | |
720 else | |
721 echo_keystrokes = 0; | |
722 | |
723 if (minibuf_level == 0 | |
724 && echo_keystrokes > 0.0 | |
442 | 725 #if defined (HAVE_X_WINDOWS) && defined (LWLIB_MENUBARS_LUCID) |
726 && !x_kludge_lw_menu_active () | |
727 #endif | |
728 ) | |
428 | 729 { |
730 if (!no_snooze) | |
731 { | |
732 if (NILP (Fsit_for (Vecho_keystrokes, Qnil))) | |
733 /* input came in, so don't echo. */ | |
853 | 734 goto done; |
428 | 735 } |
736 | |
737 echo_area_message (f, command_builder->echo_buf, Qnil, 0, | |
738 /* not echo_buf_index. That doesn't include | |
739 the terminating " - ". */ | |
740 strlen ((char *) command_builder->echo_buf), | |
741 Qcommand); | |
742 } | |
853 | 743 |
744 done: | |
745 Vquit_flag = Qnil; /* see begin_dont_check_for_quit() */ | |
746 unbind_to (depth); | |
428 | 747 } |
748 | |
749 static void | |
750 reset_key_echo (struct command_builder *command_builder, | |
751 int remove_echo_area_echo) | |
752 { | |
753 /* This function can GC */ | |
754 struct frame *f = selected_frame (); | |
755 | |
757 | 756 if (command_builder) |
757 command_builder->echo_buf_index = -1; | |
428 | 758 |
759 if (remove_echo_area_echo) | |
760 clear_echo_area (f, Qcommand, 0); | |
761 } | |
762 | |
763 | |
764 /**********************************************************************/ | |
765 /* random junk */ | |
766 /**********************************************************************/ | |
767 | |
768 /* NB: The following auto-save stuff is in keyboard.c in FSFmacs, and | |
769 keystrokes_since_auto_save is equivalent to the difference between | |
770 num_nonmacro_input_chars and last_auto_save. */ | |
771 | |
444 | 772 /* When an auto-save happens, record the number of keystrokes, and |
773 don't do again soon. */ | |
428 | 774 |
775 void | |
776 record_auto_save (void) | |
777 { | |
778 keystrokes_since_auto_save = 0; | |
779 } | |
780 | |
781 /* Make an auto save happen as soon as possible at command level. */ | |
782 | |
783 void | |
784 force_auto_save_soon (void) | |
785 { | |
786 keystrokes_since_auto_save = 1 + max (auto_save_interval, 20); | |
787 } | |
788 | |
789 static void | |
790 maybe_do_auto_save (void) | |
791 { | |
792 /* This function can call lisp */ | |
793 keystrokes_since_auto_save++; | |
794 if (auto_save_interval > 0 && | |
795 keystrokes_since_auto_save > max (auto_save_interval, 20) && | |
1268 | 796 !detect_input_pending (1)) |
428 | 797 { |
798 Fdo_auto_save (Qnil, Qnil); | |
799 record_auto_save (); | |
800 } | |
801 } | |
802 | |
803 static Lisp_Object | |
804 print_help (Lisp_Object object) | |
805 { | |
806 Fprinc (object, Qnil); | |
807 return Qnil; | |
808 } | |
809 | |
810 static void | |
811 execute_help_form (struct command_builder *command_builder, | |
812 Lisp_Object event) | |
813 { | |
814 /* This function can GC */ | |
815 Lisp_Object help = Qnil; | |
816 int speccount = specpdl_depth (); | |
817 Bytecount buf_index = command_builder->echo_buf_index; | |
818 Lisp_Object echo = ((buf_index <= 0) | |
819 ? Qnil | |
820 : make_string (command_builder->echo_buf, | |
821 buf_index)); | |
822 struct gcpro gcpro1, gcpro2; | |
823 GCPRO2 (echo, help); | |
824 | |
825 record_unwind_protect (save_window_excursion_unwind, | |
1149 | 826 call1 (Qcurrent_window_configuration, Qnil)); |
428 | 827 reset_key_echo (command_builder, 1); |
828 | |
829 help = Feval (Vhelp_form); | |
830 if (STRINGP (help)) | |
831 internal_with_output_to_temp_buffer (build_string ("*Help*"), | |
832 print_help, help, Qnil); | |
833 Fnext_command_event (event, Qnil); | |
834 /* Remove the help from the frame */ | |
771 | 835 unbind_to (speccount); |
428 | 836 /* Hmmmm. Tricky. The unbind restores an old window configuration, |
837 apparently bypassing any setting of windows_structure_changed. | |
838 So we need to set it so that things get redrawn properly. */ | |
839 /* #### This is massive overkill. Look at doing it better once the | |
840 new redisplay is fully in place. */ | |
841 { | |
842 Lisp_Object frmcons, devcons, concons; | |
843 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons) | |
844 { | |
845 struct frame *f = XFRAME (XCAR (frmcons)); | |
846 MARK_FRAME_WINDOWS_STRUCTURE_CHANGED (f); | |
847 } | |
848 } | |
849 | |
850 redisplay (); | |
1204 | 851 if (event_matches_key_specifier_p (event, make_char (' '))) |
428 | 852 { |
853 /* Discard next key if it is a space */ | |
854 reset_key_echo (command_builder, 1); | |
855 Fnext_command_event (event, Qnil); | |
856 } | |
857 | |
858 command_builder->echo_buf_index = buf_index; | |
859 if (buf_index > 0) | |
860 memcpy (command_builder->echo_buf, | |
861 XSTRING_DATA (echo), buf_index + 1); /* terminating 0 */ | |
862 UNGCPRO; | |
863 } | |
864 | |
865 | |
866 /**********************************************************************/ | |
867 /* timeouts */ | |
868 /**********************************************************************/ | |
869 | |
593 | 870 /* NOTE: "Low-level" or "interval" timeouts are one-shot timeouts that |
871 measure single intervals. "High-level timeouts" or "wakeups" are | |
872 the objects generated by `add-timeout' or `add-async-timout' -- | |
873 they can fire repeatedly (and in fact can have a different initial | |
874 time and resignal time). Given the nature of both setitimer() and | |
875 select() -- i.e. all we get is a single one-shot timer -- we have | |
876 to decompose all high-level timeouts into a series of intervals or | |
877 low-level timeouts. | |
878 | |
879 Low-level timeouts are of two varieties: synchronous and asynchronous. | |
880 The former are handled at the window-system level, the latter in | |
881 signal.c. | |
882 */ | |
883 | |
884 /**** Low-level timeout helper functions. **** | |
428 | 885 |
886 These functions maintain a sorted list of one-shot timeouts (where | |
593 | 887 the timeouts are in absolute time so we never lose any time as a |
888 result of the delay between noting an interval and firing the next | |
889 one). They are intended for use by functions that need to convert | |
890 a list of absolute timeouts into a series of intervals to wait | |
891 for. */ | |
428 | 892 |
893 /* We ensure that 0 is never a valid ID, so that a value of 0 can be | |
894 used to indicate an absence of a timer. */ | |
895 static int low_level_timeout_id_tick; | |
896 | |
897 static struct low_level_timeout_blocktype | |
898 { | |
899 Blocktype_declare (struct low_level_timeout); | |
900 } *the_low_level_timeout_blocktype; | |
901 | |
902 /* Add a one-shot timeout at time TIME to TIMEOUT_LIST. Return | |
903 a unique ID identifying the timeout. */ | |
904 | |
905 int | |
906 add_low_level_timeout (struct low_level_timeout **timeout_list, | |
907 EMACS_TIME thyme) | |
908 { | |
909 struct low_level_timeout *tm; | |
910 struct low_level_timeout *t, **tt; | |
911 | |
912 /* Allocate a new time struct. */ | |
913 | |
914 tm = Blocktype_alloc (the_low_level_timeout_blocktype); | |
915 tm->next = NULL; | |
593 | 916 /* Don't just use ++low_level_timeout_id_tick, for the (admittedly |
917 rare) case in which numbers wrap around. */ | |
428 | 918 if (low_level_timeout_id_tick == 0) |
919 low_level_timeout_id_tick++; | |
920 tm->id = low_level_timeout_id_tick++; | |
921 tm->time = thyme; | |
922 | |
923 /* Add it to the queue. */ | |
924 | |
925 tt = timeout_list; | |
926 t = *tt; | |
927 while (t && EMACS_TIME_EQUAL_OR_GREATER (tm->time, t->time)) | |
928 { | |
929 tt = &t->next; | |
930 t = *tt; | |
931 } | |
932 tm->next = t; | |
933 *tt = tm; | |
934 | |
935 return tm->id; | |
936 } | |
937 | |
938 /* Remove the low-level timeout identified by ID from TIMEOUT_LIST. | |
939 If the timeout is not there, do nothing. */ | |
940 | |
941 void | |
942 remove_low_level_timeout (struct low_level_timeout **timeout_list, int id) | |
943 { | |
944 struct low_level_timeout *t, *prev; | |
945 | |
946 /* find it */ | |
947 | |
948 for (t = *timeout_list, prev = NULL; t && t->id != id; t = t->next) | |
949 prev = t; | |
950 | |
951 if (!t) | |
952 return; /* couldn't find it */ | |
953 | |
954 if (!prev) | |
955 *timeout_list = t->next; | |
956 else prev->next = t->next; | |
957 | |
958 Blocktype_free (the_low_level_timeout_blocktype, t); | |
959 } | |
960 | |
961 /* If there are timeouts on TIMEOUT_LIST, store the relative time | |
962 interval to the first timeout on the list into INTERVAL and | |
963 return 1. Otherwise, return 0. */ | |
964 | |
965 int | |
966 get_low_level_timeout_interval (struct low_level_timeout *timeout_list, | |
967 EMACS_TIME *interval) | |
968 { | |
969 if (!timeout_list) /* no timer events; block indefinitely */ | |
970 return 0; | |
971 else | |
972 { | |
973 EMACS_TIME current_time; | |
974 | |
975 /* The time to block is the difference between the first | |
976 (earliest) timer on the queue and the current time. | |
977 If that is negative, then the timer will fire immediately | |
978 but we still have to call select(), with a zero-valued | |
979 timeout: user events must have precedence over timer events. */ | |
980 EMACS_GET_TIME (current_time); | |
981 if (EMACS_TIME_GREATER (timeout_list->time, current_time)) | |
982 EMACS_SUB_TIME (*interval, timeout_list->time, | |
983 current_time); | |
984 else | |
985 EMACS_SET_SECS_USECS (*interval, 0, 0); | |
986 return 1; | |
987 } | |
988 } | |
989 | |
990 /* Pop the first (i.e. soonest) timeout off of TIMEOUT_LIST and return | |
991 its ID. Also, if TIME_OUT is not 0, store the absolute time of the | |
992 timeout into TIME_OUT. */ | |
993 | |
994 int | |
995 pop_low_level_timeout (struct low_level_timeout **timeout_list, | |
996 EMACS_TIME *time_out) | |
997 { | |
998 struct low_level_timeout *tm = *timeout_list; | |
999 int id; | |
1000 | |
1001 assert (tm); | |
1002 id = tm->id; | |
1003 if (time_out) | |
1004 *time_out = tm->time; | |
1005 *timeout_list = tm->next; | |
1006 Blocktype_free (the_low_level_timeout_blocktype, tm); | |
1007 return id; | |
1008 } | |
1009 | |
1010 | |
593 | 1011 /**** High-level timeout functions. **** */ |
1012 | |
1013 /* We ensure that 0 is never a valid ID, so that a value of 0 can be | |
1014 used to indicate an absence of a timer. */ | |
428 | 1015 static int timeout_id_tick; |
1016 | |
1017 static Lisp_Object pending_timeout_list, pending_async_timeout_list; | |
1018 | |
1019 static Lisp_Object | |
1020 mark_timeout (Lisp_Object obj) | |
1021 { | |
440 | 1022 Lisp_Timeout *tm = XTIMEOUT (obj); |
428 | 1023 mark_object (tm->function); |
1024 return tm->object; | |
1025 } | |
1026 | |
1204 | 1027 static const struct memory_description timeout_description[] = { |
440 | 1028 { XD_LISP_OBJECT, offsetof (Lisp_Timeout, function) }, |
1029 { XD_LISP_OBJECT, offsetof (Lisp_Timeout, object) }, | |
428 | 1030 { XD_END } |
1031 }; | |
1032 | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
1033 DEFINE_INTERNAL_LISP_OBJECT ("timeout", timeout, Lisp_Timeout, |
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
1034 timeout_description, mark_timeout); |
428 | 1035 |
1036 /* Generate a timeout and return its ID. */ | |
1037 | |
1038 int | |
1039 event_stream_generate_wakeup (unsigned int milliseconds, | |
1040 unsigned int vanilliseconds, | |
1041 Lisp_Object function, Lisp_Object object, | |
1042 int async_p) | |
1043 { | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
1044 Lisp_Object op = ALLOC_LISP_OBJECT (timeout); |
440 | 1045 Lisp_Timeout *timeout = XTIMEOUT (op); |
428 | 1046 EMACS_TIME current_time; |
1047 EMACS_TIME interval; | |
1048 | |
593 | 1049 /* Don't just use ++timeout_id_tick, for the (admittedly rare) case |
1050 in which numbers wrap around. */ | |
1051 if (timeout_id_tick == 0) | |
1052 timeout_id_tick++; | |
428 | 1053 timeout->id = timeout_id_tick++; |
1054 timeout->resignal_msecs = vanilliseconds; | |
1055 timeout->function = function; | |
1056 timeout->object = object; | |
1057 | |
1058 EMACS_GET_TIME (current_time); | |
1059 EMACS_SET_SECS_USECS (interval, milliseconds / 1000, | |
1060 1000 * (milliseconds % 1000)); | |
1061 EMACS_ADD_TIME (timeout->next_signal_time, current_time, interval); | |
1062 | |
1063 if (async_p) | |
1064 { | |
1065 timeout->interval_id = | |
593 | 1066 signal_add_async_interval_timeout (timeout->next_signal_time); |
1067 pending_async_timeout_list = | |
1068 noseeum_cons (op, pending_async_timeout_list); | |
428 | 1069 } |
1070 else | |
1071 { | |
1072 timeout->interval_id = | |
1073 event_stream_add_timeout (timeout->next_signal_time); | |
1074 pending_timeout_list = noseeum_cons (op, pending_timeout_list); | |
1075 } | |
1076 return timeout->id; | |
1077 } | |
1078 | |
1079 /* Given the INTERVAL-ID of a timeout just signalled, resignal the timeout | |
1080 as necessary and return the timeout's ID and function and object slots. | |
1081 | |
1082 This should be called as a result of receiving notice that a timeout | |
1083 has fired. INTERVAL-ID is *not* the timeout's ID, but is the ID that | |
1084 identifies this particular firing of the timeout. INTERVAL-ID's and | |
1085 timeout ID's are in separate number spaces and bear no relation to | |
1086 each other. The INTERVAL-ID is all that the event callback routines | |
1087 work with: they work only with one-shot intervals, not with timeouts | |
1088 that may fire repeatedly. | |
1089 | |
1090 NOTE: The returned FUNCTION and OBJECT are *not* GC-protected at all. | |
1091 */ | |
1092 | |
593 | 1093 int |
428 | 1094 event_stream_resignal_wakeup (int interval_id, int async_p, |
1095 Lisp_Object *function, Lisp_Object *object) | |
1096 { | |
1097 Lisp_Object op = Qnil, rest; | |
440 | 1098 Lisp_Timeout *timeout; |
428 | 1099 Lisp_Object *timeout_list; |
1100 struct gcpro gcpro1; | |
1101 int id; | |
1102 | |
1103 GCPRO1 (op); /* just in case ... because it's removed from the list | |
1104 for awhile. */ | |
1105 | |
1106 timeout_list = async_p ? &pending_async_timeout_list : &pending_timeout_list; | |
1107 | |
1108 /* Find the timeout on the list of pending ones. */ | |
1109 LIST_LOOP (rest, *timeout_list) | |
1110 { | |
1111 timeout = XTIMEOUT (XCAR (rest)); | |
1112 if (timeout->interval_id == interval_id) | |
1113 break; | |
1114 } | |
1115 | |
1116 assert (!NILP (rest)); | |
1117 op = XCAR (rest); | |
1118 timeout = XTIMEOUT (op); | |
1119 /* We make sure to snarf the data out of the timeout object before | |
1120 we free it with free_managed_lcrecord(). */ | |
1121 id = timeout->id; | |
1122 *function = timeout->function; | |
1123 *object = timeout->object; | |
1124 | |
1125 /* Remove this one from the list of pending timeouts */ | |
1126 *timeout_list = delq_no_quit_and_free_cons (op, *timeout_list); | |
1127 | |
1128 /* If this timeout wants to be resignalled, do it now. */ | |
1129 if (timeout->resignal_msecs) | |
1130 { | |
1131 EMACS_TIME current_time; | |
1132 EMACS_TIME interval; | |
1133 | |
1134 /* Determine the time that the next resignalling should occur. | |
1135 We do that by adding the interval time to the last signalled | |
1136 time until we get a time that's current. | |
1137 | |
1138 (This way, it doesn't matter if the timeout was signalled | |
1139 exactly when we asked for it, or at some time later.) | |
1140 */ | |
1141 EMACS_GET_TIME (current_time); | |
1142 EMACS_SET_SECS_USECS (interval, timeout->resignal_msecs / 1000, | |
1143 1000 * (timeout->resignal_msecs % 1000)); | |
1144 do | |
1145 { | |
1146 EMACS_ADD_TIME (timeout->next_signal_time, timeout->next_signal_time, | |
1147 interval); | |
1148 } while (EMACS_TIME_GREATER (current_time, timeout->next_signal_time)); | |
1149 | |
1150 if (async_p) | |
1151 timeout->interval_id = | |
593 | 1152 signal_add_async_interval_timeout (timeout->next_signal_time); |
428 | 1153 else |
1154 timeout->interval_id = | |
1155 event_stream_add_timeout (timeout->next_signal_time); | |
1156 /* Add back onto the list. Note that the effect of this | |
1157 is to move frequently-hit timeouts to the front of the | |
1158 list, which is a good thing. */ | |
1159 *timeout_list = noseeum_cons (op, *timeout_list); | |
1160 } | |
1161 else | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
1162 FREE_LCRECORD (op); |
428 | 1163 |
1164 UNGCPRO; | |
1165 return id; | |
1166 } | |
1167 | |
1168 void | |
1169 event_stream_disable_wakeup (int id, int async_p) | |
1170 { | |
440 | 1171 Lisp_Timeout *timeout = 0; |
428 | 1172 Lisp_Object rest; |
1173 Lisp_Object *timeout_list; | |
1174 | |
1175 if (async_p) | |
1176 timeout_list = &pending_async_timeout_list; | |
1177 else | |
1178 timeout_list = &pending_timeout_list; | |
1179 | |
1180 /* Find the timeout on the list of pending ones, if it's still there. */ | |
1181 LIST_LOOP (rest, *timeout_list) | |
1182 { | |
1183 timeout = XTIMEOUT (XCAR (rest)); | |
1184 if (timeout->id == id) | |
1185 break; | |
1186 } | |
1187 | |
1188 /* If we found it, remove it from the list and disable the pending | |
1189 one-shot. */ | |
1190 if (!NILP (rest)) | |
1191 { | |
1192 Lisp_Object op = XCAR (rest); | |
1193 *timeout_list = | |
1194 delq_no_quit_and_free_cons (op, *timeout_list); | |
1195 if (async_p) | |
593 | 1196 signal_remove_async_interval_timeout (timeout->interval_id); |
428 | 1197 else |
1198 event_stream_remove_timeout (timeout->interval_id); | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
1199 FREE_LCRECORD (op); |
428 | 1200 } |
1201 } | |
1202 | |
1203 static int | |
1204 event_stream_wakeup_pending_p (int id, int async_p) | |
1205 { | |
440 | 1206 Lisp_Timeout *timeout; |
428 | 1207 Lisp_Object rest; |
1208 Lisp_Object timeout_list; | |
1209 int found = 0; | |
1210 | |
1211 | |
1212 if (async_p) | |
1213 timeout_list = pending_async_timeout_list; | |
1214 else | |
1215 timeout_list = pending_timeout_list; | |
1216 | |
1217 /* Find the element on the list of pending ones, if it's still there. */ | |
1218 LIST_LOOP (rest, timeout_list) | |
1219 { | |
1220 timeout = XTIMEOUT (XCAR (rest)); | |
1221 if (timeout->id == id) | |
1222 { | |
1223 found = 1; | |
1224 break; | |
1225 } | |
1226 } | |
1227 | |
1228 return found; | |
1229 } | |
1230 | |
1231 | |
1232 /**** Lisp-level timeout functions. ****/ | |
1233 | |
1234 static unsigned long | |
1235 lisp_number_to_milliseconds (Lisp_Object secs, int allow_0) | |
1236 { | |
1237 double fsecs; | |
1238 CHECK_INT_OR_FLOAT (secs); | |
1239 fsecs = XFLOATINT (secs); | |
1240 if (fsecs < 0) | |
563 | 1241 invalid_argument ("timeout is negative", secs); |
428 | 1242 if (!allow_0 && fsecs == 0) |
563 | 1243 invalid_argument ("timeout is non-positive", secs); |
428 | 1244 if (fsecs >= (((unsigned int) 0xFFFFFFFF) / 1000)) |
563 | 1245 invalid_argument |
428 | 1246 ("timeout would exceed 32 bits when represented in milliseconds", secs); |
1247 | |
1248 return (unsigned long) (1000 * fsecs); | |
1249 } | |
1250 | |
1251 DEFUN ("add-timeout", Fadd_timeout, 3, 4, 0, /* | |
1252 Add a timeout, to be signaled after the timeout period has elapsed. | |
1253 SECS is a number of seconds, expressed as an integer or a float. | |
1254 FUNCTION will be called after that many seconds have elapsed, with one | |
1255 argument, the given OBJECT. If the optional RESIGNAL argument is provided, | |
1256 then after this timeout expires, `add-timeout' will automatically be called | |
1257 again with RESIGNAL as the first argument. | |
1258 | |
1259 This function returns an object which is the id number of this particular | |
1260 timeout. You can pass that object to `disable-timeout' to turn off the | |
1261 timeout before it has been signalled. | |
1262 | |
1263 NOTE: Id numbers as returned by this function are in a distinct namespace | |
1264 from those returned by `add-async-timeout'. This means that the same id | |
1265 number could refer to a pending synchronous timeout and a different pending | |
1266 asynchronous timeout, and that you cannot pass an id from `add-timeout' | |
1267 to `disable-async-timeout', or vice-versa. | |
1268 | |
1269 The number of seconds may be expressed as a floating-point number, in which | |
1270 case some fractional part of a second will be used. Caveat: the usable | |
1271 timeout granularity will vary from system to system. | |
1272 | |
1273 Adding a timeout causes a timeout event to be returned by `next-event', and | |
1274 the function will be invoked by `dispatch-event,' so if emacs is in a tight | |
1275 loop, the function will not be invoked until the next call to sit-for or | |
1276 until the return to top-level (the same is true of process filters). | |
1277 | |
1278 If you need to have a timeout executed even when XEmacs is in the midst of | |
1279 running Lisp code, use `add-async-timeout'. | |
1280 | |
1281 WARNING: if you are thinking of calling add-timeout from inside of a | |
1282 callback function as a way of resignalling a timeout, think again. There | |
1283 is a race condition. That's why the RESIGNAL argument exists. | |
1284 */ | |
1285 (secs, function, object, resignal)) | |
1286 { | |
1287 unsigned long msecs = lisp_number_to_milliseconds (secs, 0); | |
1288 unsigned long msecs2 = (NILP (resignal) ? 0 : | |
1289 lisp_number_to_milliseconds (resignal, 0)); | |
1290 int id; | |
1291 Lisp_Object lid; | |
1292 id = event_stream_generate_wakeup (msecs, msecs2, function, object, 0); | |
1293 lid = make_int (id); | |
2500 | 1294 if (id != XINT (lid)) ABORT (); |
428 | 1295 return lid; |
1296 } | |
1297 | |
1298 DEFUN ("disable-timeout", Fdisable_timeout, 1, 1, 0, /* | |
1299 Disable a timeout from signalling any more. | |
1300 ID should be a timeout id number as returned by `add-timeout'. If ID | |
1301 corresponds to a one-shot timeout that has already signalled, nothing | |
1302 will happen. | |
1303 | |
1304 It will not work to call this function on an id number returned by | |
1305 `add-async-timeout'. Use `disable-async-timeout' for that. | |
1306 */ | |
1307 (id)) | |
1308 { | |
1309 CHECK_INT (id); | |
1310 event_stream_disable_wakeup (XINT (id), 0); | |
1311 return Qnil; | |
1312 } | |
1313 | |
1314 DEFUN ("add-async-timeout", Fadd_async_timeout, 3, 4, 0, /* | |
1315 Add an asynchronous timeout, to be signaled after an interval has elapsed. | |
1316 SECS is a number of seconds, expressed as an integer or a float. | |
1317 FUNCTION will be called after that many seconds have elapsed, with one | |
1318 argument, the given OBJECT. If the optional RESIGNAL argument is provided, | |
1319 then after this timeout expires, `add-async-timeout' will automatically be | |
1320 called again with RESIGNAL as the first argument. | |
1321 | |
1322 This function returns an object which is the id number of this particular | |
1323 timeout. You can pass that object to `disable-async-timeout' to turn off | |
1324 the timeout before it has been signalled. | |
1325 | |
1326 NOTE: Id numbers as returned by this function are in a distinct namespace | |
1327 from those returned by `add-timeout'. This means that the same id number | |
1328 could refer to a pending synchronous timeout and a different pending | |
1329 asynchronous timeout, and that you cannot pass an id from | |
1330 `add-async-timeout' to `disable-timeout', or vice-versa. | |
1331 | |
1332 The number of seconds may be expressed as a floating-point number, in which | |
1333 case some fractional part of a second will be used. Caveat: the usable | |
1334 timeout granularity will vary from system to system. | |
1335 | |
1336 Adding an asynchronous timeout causes the function to be invoked as soon | |
1337 as the timeout occurs, even if XEmacs is in the midst of executing some | |
1338 other code. (This is unlike the synchronous timeouts added with | |
1339 `add-timeout', where the timeout will only be signalled when XEmacs is | |
1340 waiting for events, i.e. the next return to top-level or invocation of | |
1341 `sit-for' or related functions.) This means that the function that is | |
1342 called *must* not signal an error or change any global state (e.g. switch | |
1343 buffers or windows) except when locking code is in place to make sure | |
1344 that race conditions don't occur in the interaction between the | |
1345 asynchronous timeout function and other code. | |
1346 | |
1347 Under most circumstances, you should use `add-timeout' instead, as it is | |
1348 much safer. Asynchronous timeouts should only be used when such behavior | |
1349 is really necessary. | |
1350 | |
1351 Asynchronous timeouts are blocked and will not occur when `inhibit-quit' | |
1352 is non-nil. As soon as `inhibit-quit' becomes nil again, any pending | |
1353 asynchronous timeouts will get called immediately. (Multiple occurrences | |
1354 of the same asynchronous timeout are not queued, however.) While the | |
1355 callback function of an asynchronous timeout is invoked, `inhibit-quit' | |
1356 is automatically bound to non-nil, and thus other asynchronous timeouts | |
1357 will be blocked unless the callback function explicitly sets `inhibit-quit' | |
1358 to nil. | |
1359 | |
1360 WARNING: if you are thinking of calling `add-async-timeout' from inside of a | |
1361 callback function as a way of resignalling a timeout, think again. There | |
1362 is a race condition. That's why the RESIGNAL argument exists. | |
1363 */ | |
1364 (secs, function, object, resignal)) | |
1365 { | |
1366 unsigned long msecs = lisp_number_to_milliseconds (secs, 0); | |
1367 unsigned long msecs2 = (NILP (resignal) ? 0 : | |
1368 lisp_number_to_milliseconds (resignal, 0)); | |
1369 int id; | |
1370 Lisp_Object lid; | |
1371 id = event_stream_generate_wakeup (msecs, msecs2, function, object, 1); | |
1372 lid = make_int (id); | |
2500 | 1373 if (id != XINT (lid)) ABORT (); |
428 | 1374 return lid; |
1375 } | |
1376 | |
1377 DEFUN ("disable-async-timeout", Fdisable_async_timeout, 1, 1, 0, /* | |
1378 Disable an asynchronous timeout from signalling any more. | |
1379 ID should be a timeout id number as returned by `add-async-timeout'. If ID | |
1380 corresponds to a one-shot timeout that has already signalled, nothing | |
1381 will happen. | |
1382 | |
1383 It will not work to call this function on an id number returned by | |
1384 `add-timeout'. Use `disable-timeout' for that. | |
1385 */ | |
1386 (id)) | |
1387 { | |
1388 CHECK_INT (id); | |
1389 event_stream_disable_wakeup (XINT (id), 1); | |
1390 return Qnil; | |
1391 } | |
1392 | |
1393 | |
1394 /**********************************************************************/ | |
1395 /* enqueuing and dequeuing events */ | |
1396 /**********************************************************************/ | |
1397 | |
1398 /* Add an event to the back of the command-event queue: it will be the next | |
1399 event read after all pending events. This only works on keyboard, | |
1400 mouse-click, misc-user, and eval events. | |
1401 */ | |
1402 static void | |
1403 enqueue_command_event (Lisp_Object event) | |
1404 { | |
1405 enqueue_event (event, &command_event_queue, &command_event_queue_tail); | |
1406 } | |
1407 | |
1408 static Lisp_Object | |
1409 dequeue_command_event (void) | |
1410 { | |
1411 return dequeue_event (&command_event_queue, &command_event_queue_tail); | |
1412 } | |
1413 | |
1204 | 1414 void |
1415 enqueue_dispatch_event (Lisp_Object event) | |
1416 { | |
1417 enqueue_event (event, &dispatch_event_queue, &dispatch_event_queue_tail); | |
1418 } | |
1419 | |
1420 Lisp_Object | |
1421 dequeue_dispatch_event (void) | |
1422 { | |
1423 return dequeue_event (&dispatch_event_queue, &dispatch_event_queue_tail); | |
1424 } | |
1425 | |
428 | 1426 static void |
1427 enqueue_command_event_1 (Lisp_Object event_to_copy) | |
1428 { | |
853 | 1429 enqueue_command_event (Fcopy_event (event_to_copy, Qnil)); |
428 | 1430 } |
1431 | |
1432 void | |
1433 enqueue_magic_eval_event (void (*fun) (Lisp_Object), Lisp_Object object) | |
1434 { | |
1435 Lisp_Object event = Fmake_event (Qnil, Qnil); | |
934 | 1436 XSET_EVENT_TYPE (event, magic_eval_event); |
1437 /* channel for magic_eval events is nil */ | |
1204 | 1438 XSET_EVENT_MAGIC_EVAL_INTERNAL_FUNCTION (event, fun); |
1439 XSET_EVENT_MAGIC_EVAL_OBJECT (event, object); | |
428 | 1440 enqueue_command_event (event); |
1441 } | |
1442 | |
1443 DEFUN ("enqueue-eval-event", Fenqueue_eval_event, 2, 2, 0, /* | |
1444 Add an eval event to the back of the eval event queue. | |
1445 When this event is dispatched, FUNCTION (which should be a function | |
1446 of one argument) will be called with OBJECT as its argument. | |
1447 See `next-event' for a description of event types and how events | |
1448 are received. | |
1449 */ | |
1450 (function, object)) | |
1451 { | |
1452 Lisp_Object event = Fmake_event (Qnil, Qnil); | |
1453 | |
934 | 1454 XSET_EVENT_TYPE (event, eval_event); |
1455 /* channel for eval events is nil */ | |
1204 | 1456 XSET_EVENT_EVAL_FUNCTION (event, function); |
1457 XSET_EVENT_EVAL_OBJECT (event, object); | |
428 | 1458 enqueue_command_event (event); |
1459 | |
1460 return event; | |
1461 } | |
1462 | |
1463 Lisp_Object | |
1464 enqueue_misc_user_event (Lisp_Object channel, Lisp_Object function, | |
1465 Lisp_Object object) | |
1466 { | |
1467 Lisp_Object event = Fmake_event (Qnil, Qnil); | |
934 | 1468 XSET_EVENT_TYPE (event, misc_user_event); |
1469 XSET_EVENT_CHANNEL (event, channel); | |
1204 | 1470 XSET_EVENT_MISC_USER_FUNCTION (event, function); |
1471 XSET_EVENT_MISC_USER_OBJECT (event, object); | |
1472 XSET_EVENT_MISC_USER_BUTTON (event, 0); | |
1473 XSET_EVENT_MISC_USER_MODIFIERS (event, 0); | |
1474 XSET_EVENT_MISC_USER_X (event, -1); | |
1475 XSET_EVENT_MISC_USER_Y (event, -1); | |
428 | 1476 enqueue_command_event (event); |
1477 | |
1478 return event; | |
1479 } | |
1480 | |
1481 Lisp_Object | |
1482 enqueue_misc_user_event_pos (Lisp_Object channel, Lisp_Object function, | |
1483 Lisp_Object object, | |
1484 int button, int modifiers, int x, int y) | |
1485 { | |
1486 Lisp_Object event = Fmake_event (Qnil, Qnil); | |
1487 | |
934 | 1488 XSET_EVENT_TYPE (event, misc_user_event); |
1489 XSET_EVENT_CHANNEL (event, channel); | |
1204 | 1490 XSET_EVENT_MISC_USER_FUNCTION (event, function); |
1491 XSET_EVENT_MISC_USER_OBJECT (event, object); | |
1492 XSET_EVENT_MISC_USER_BUTTON (event, button); | |
1493 XSET_EVENT_MISC_USER_MODIFIERS (event, modifiers); | |
1494 XSET_EVENT_MISC_USER_X (event, x); | |
1495 XSET_EVENT_MISC_USER_Y (event, y); | |
428 | 1496 enqueue_command_event (event); |
1497 | |
1498 return event; | |
1499 } | |
1500 | |
1501 | |
1502 /**********************************************************************/ | |
1503 /* focus-event handling */ | |
1504 /**********************************************************************/ | |
1505 | |
1506 /* | |
1507 | |
2367 | 1508 See also |
1509 | |
1510 (Info-goto-node "(internals)Focus Handling") | |
428 | 1511 */ |
1512 | |
2367 | 1513 |
428 | 1514 static void |
1515 run_select_frame_hook (void) | |
1516 { | |
1517 run_hook (Qselect_frame_hook); | |
1518 } | |
1519 | |
1520 static void | |
1521 run_deselect_frame_hook (void) | |
1522 { | |
1523 run_hook (Qdeselect_frame_hook); | |
1524 } | |
1525 | |
1526 /* When select-frame is called and focus_follows_mouse is false, we want | |
1527 to tell the window system that the focus should be changed to point to | |
1528 the new frame. However, | |
1529 sometimes Lisp functions will temporarily change the selected frame | |
1530 (e.g. to call a function that operates on the selected frame), | |
1531 and it's annoying if this focus-change happens exactly when | |
1532 select-frame is called, because then you get some flickering of the | |
1533 window-manager border and perhaps other undesirable results. We | |
1534 really only want to change the focus when we're about to retrieve | |
1535 an event from the user. To do this, we keep track of the frame | |
1536 where the window-manager focus lies on, and just before waiting | |
1537 for user events, check the currently selected frame and change | |
1538 the focus as necessary. | |
1539 | |
1540 On the other hand, if focus_follows_mouse is true, we need to switch the | |
1541 selected frame back to the frame with window manager focus just before we | |
1542 execute the next command in Fcommand_loop_1, just as the selected buffer is | |
1543 reverted after a set-buffer. | |
1544 | |
1545 Both cases are handled by this function. It must be called as appropriate | |
1546 from these two places, depending on the value of focus_follows_mouse. */ | |
1547 | |
1548 void | |
1549 investigate_frame_change (void) | |
1550 { | |
1551 Lisp_Object devcons, concons; | |
1552 | |
1553 /* if the selected frame was changed, change the window-system | |
1554 focus to the new frame. We don't do it when select-frame was | |
1555 called, to avoid flickering and other unwanted side effects when | |
1556 the frame is just changed temporarily. */ | |
1557 DEVICE_LOOP_NO_BREAK (devcons, concons) | |
1558 { | |
1559 struct device *d = XDEVICE (XCAR (devcons)); | |
1560 Lisp_Object sel_frame = DEVICE_SELECTED_FRAME (d); | |
1561 | |
1562 /* You'd think that maybe we should use FRAME_WITH_FOCUS_REAL, | |
1563 but that can cause us to end up in an infinite loop focusing | |
1564 between two frames. It seems that since the call to `select-frame' | |
1565 in emacs_handle_focus_change_final() is based on the _FOR_HOOKS | |
1566 value, we need to do so too. */ | |
1567 if (!NILP (sel_frame) && | |
1568 !EQ (DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d), sel_frame) && | |
1569 !NILP (DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d)) && | |
1570 !EQ (DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d), sel_frame)) | |
1571 { | |
1572 /* At this point, we know that the frame has been changed. Now, if | |
1573 * focus_follows_mouse is not set, we finish off the frame change, | |
1574 * so that user events will now come from the new frame. Otherwise, | |
1575 * if focus_follows_mouse is set, no gratuitous frame changing | |
1576 * should take place. Set the focus back to the frame which was | |
1577 * originally selected for user input. | |
1578 */ | |
1579 if (!focus_follows_mouse) | |
1580 { | |
1581 /* prevent us from issuing the same request more than once */ | |
1582 DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d) = sel_frame; | |
1583 MAYBE_DEVMETH (d, focus_on_frame, (XFRAME (sel_frame))); | |
1584 } | |
1585 else | |
1586 { | |
1587 Lisp_Object old_frame = Qnil; | |
1588 | |
1589 /* #### Do we really want to check OUGHT ?? | |
1590 * It seems to make sense, though I have never seen us | |
1591 * get here and have it be non-nil. | |
1592 */ | |
1593 if (FRAMEP (DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d))) | |
1594 old_frame = DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d); | |
1595 else if (FRAMEP (DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d))) | |
1596 old_frame = DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d); | |
1597 | |
1598 /* #### Can old_frame ever be NIL? play it safe.. */ | |
1599 if (!NILP (old_frame)) | |
1600 { | |
1601 /* Fselect_frame is not really the right thing: it frobs the | |
1602 * buffer stack. But there's no easy way to do the right | |
1603 * thing, and this code already had this problem anyway. | |
1604 */ | |
1605 Fselect_frame (old_frame); | |
1606 } | |
1607 } | |
1608 } | |
1609 } | |
1610 } | |
1611 | |
1612 static Lisp_Object | |
1613 cleanup_after_missed_defocusing (Lisp_Object frame) | |
1614 { | |
1615 if (FRAMEP (frame) && FRAME_LIVE_P (XFRAME (frame))) | |
1616 Fselect_frame (frame); | |
1617 return Qnil; | |
1618 } | |
1619 | |
1620 void | |
1621 emacs_handle_focus_change_preliminary (Lisp_Object frame_inp_and_dev) | |
1622 { | |
1623 Lisp_Object frame = Fcar (frame_inp_and_dev); | |
1624 Lisp_Object device = Fcar (Fcdr (frame_inp_and_dev)); | |
1625 int in_p = !NILP (Fcdr (Fcdr (frame_inp_and_dev))); | |
1626 struct device *d; | |
1627 | |
1628 if (!DEVICE_LIVE_P (XDEVICE (device))) | |
1629 return; | |
1630 else | |
1631 d = XDEVICE (device); | |
1632 | |
1633 /* Any received focus-change notifications render invalid any | |
1634 pending focus-change requests. */ | |
1635 DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d) = Qnil; | |
1636 if (in_p) | |
1637 { | |
1638 Lisp_Object focus_frame; | |
1639 | |
1640 if (!FRAME_LIVE_P (XFRAME (frame))) | |
1641 return; | |
1642 else | |
1643 focus_frame = DEVICE_FRAME_WITH_FOCUS_REAL (d); | |
1644 | |
1645 /* Mark the minibuffer as changed to make sure it gets updated | |
1646 properly if the echo area is active. */ | |
1647 { | |
1648 struct window *w = XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame))); | |
1649 MARK_WINDOWS_CHANGED (w); | |
1650 } | |
1651 | |
452 | 1652 if (FRAMEP (focus_frame) && FRAME_LIVE_P (XFRAME (focus_frame)) |
1653 && !EQ (frame, focus_frame)) | |
428 | 1654 { |
1655 /* Oops, we missed a focus-out event. */ | |
1656 DEVICE_FRAME_WITH_FOCUS_REAL (d) = Qnil; | |
1657 redisplay_redraw_cursor (XFRAME (focus_frame), 1); | |
1658 } | |
1659 DEVICE_FRAME_WITH_FOCUS_REAL (d) = frame; | |
1660 if (!EQ (frame, focus_frame)) | |
1661 { | |
1662 redisplay_redraw_cursor (XFRAME (frame), 1); | |
1663 } | |
1664 } | |
1665 else | |
1666 { | |
1667 /* We ignore the frame reported in the event. If it's different | |
1668 from where we think the focus was, oh well -- we messed up. | |
1669 Nonetheless, we pretend we were right, for sensible behavior. */ | |
1670 frame = DEVICE_FRAME_WITH_FOCUS_REAL (d); | |
1671 if (!NILP (frame)) | |
1672 { | |
1673 DEVICE_FRAME_WITH_FOCUS_REAL (d) = Qnil; | |
1674 | |
1675 if (FRAME_LIVE_P (XFRAME (frame))) | |
1676 redisplay_redraw_cursor (XFRAME (frame), 1); | |
1677 } | |
1678 } | |
1679 } | |
1680 | |
1681 /* Called from the window-system-specific code when we receive a | |
1682 notification that the focus lies on a particular frame. | |
1683 Argument is a cons: (frame . (device . in-p)) where in-p is non-nil | |
1684 for focus-in. | |
1685 */ | |
1686 void | |
1687 emacs_handle_focus_change_final (Lisp_Object frame_inp_and_dev) | |
1688 { | |
1689 Lisp_Object frame = Fcar (frame_inp_and_dev); | |
1690 Lisp_Object device = Fcar (Fcdr (frame_inp_and_dev)); | |
1691 int in_p = !NILP (Fcdr (Fcdr (frame_inp_and_dev))); | |
1692 struct device *d; | |
1693 int count; | |
1694 | |
1695 if (!DEVICE_LIVE_P (XDEVICE (device))) | |
1696 return; | |
1697 else | |
1698 d = XDEVICE (device); | |
1699 | |
1700 if (in_p) | |
1701 { | |
1702 Lisp_Object focus_frame; | |
1703 | |
1704 if (!FRAME_LIVE_P (XFRAME (frame))) | |
1705 return; | |
1706 else | |
1707 focus_frame = DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d); | |
1708 | |
1709 DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d) = frame; | |
1710 if (FRAMEP (focus_frame) && !EQ (frame, focus_frame)) | |
1711 { | |
1712 /* Oops, we missed a focus-out event. */ | |
1713 Fselect_frame (focus_frame); | |
1714 /* Do an unwind-protect in case an error occurs in | |
1715 the deselect-frame-hook */ | |
1716 count = specpdl_depth (); | |
1717 record_unwind_protect (cleanup_after_missed_defocusing, frame); | |
1718 run_deselect_frame_hook (); | |
771 | 1719 unbind_to (count); |
428 | 1720 /* the cleanup method changed the focus frame to nil, so |
1721 we need to reflect this */ | |
1722 focus_frame = Qnil; | |
1723 } | |
1724 else | |
1725 Fselect_frame (frame); | |
1726 if (!EQ (frame, focus_frame)) | |
1727 run_select_frame_hook (); | |
1728 } | |
1729 else | |
1730 { | |
1731 /* We ignore the frame reported in the event. If it's different | |
1732 from where we think the focus was, oh well -- we messed up. | |
1733 Nonetheless, we pretend we were right, for sensible behavior. */ | |
1734 frame = DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d); | |
1735 if (!NILP (frame)) | |
1736 { | |
1737 DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d) = Qnil; | |
1738 run_deselect_frame_hook (); | |
1739 } | |
1740 } | |
1741 } | |
1742 | |
1743 | |
1744 /**********************************************************************/ | |
1268 | 1745 /* input pending/quit checking */ |
1746 /**********************************************************************/ | |
1747 | |
1748 /* If HOW_MANY is 0, return true if there are any user or non-user events | |
1749 pending. If HOW_MANY is > 0, return true if there are that many *user* | |
1750 events pending, irrespective of non-user events. */ | |
1751 | |
1752 static int | |
1753 event_stream_event_pending_p (int how_many) | |
1754 { | |
1755 /* #### Hmmm ... There may be some duplication in "drain queue" and | |
1756 "event pending". Couldn't we just drain the queue and see what's in | |
1757 it, and not maybe need a separate event method for this? Would this | |
1758 work when HOW_MANY is 0? Maybe this would be slow? */ | |
1759 return event_stream && event_stream->event_pending_p (how_many); | |
1760 } | |
1761 | |
1762 static void | |
1763 event_stream_force_event_pending (struct frame *f) | |
1764 { | |
1765 if (event_stream->force_event_pending_cb) | |
1766 event_stream->force_event_pending_cb (f); | |
1767 } | |
1768 | |
1769 void | |
1770 event_stream_drain_queue (void) | |
1771 { | |
1318 | 1772 /* This can call Lisp */ |
1268 | 1773 if (event_stream && event_stream->drain_queue_cb) |
1774 event_stream->drain_queue_cb (); | |
1775 } | |
1776 | |
1777 /* Return non-zero if at least HOW_MANY user events are pending. */ | |
1778 int | |
1779 detect_input_pending (int how_many) | |
1780 { | |
1318 | 1781 /* This can call Lisp */ |
1268 | 1782 Lisp_Object event; |
1783 | |
1784 if (!NILP (Vunread_command_event)) | |
1785 how_many--; | |
1786 | |
1787 how_many -= XINT (Fsafe_length (Vunread_command_events)); | |
1788 | |
1789 if (how_many <= 0) | |
1790 return 1; | |
1791 | |
1792 EVENT_CHAIN_LOOP (event, command_event_queue) | |
1793 { | |
1794 if (XEVENT_TYPE (event) != eval_event | |
1795 && XEVENT_TYPE (event) != magic_eval_event) | |
1796 { | |
1797 how_many--; | |
1798 if (how_many <= 0) | |
1799 return 1; | |
1800 } | |
1801 } | |
1802 | |
1803 return event_stream_event_pending_p (how_many); | |
1804 } | |
1805 | |
1806 DEFUN ("input-pending-p", Finput_pending_p, 0, 0, 0, /* | |
1807 Return t if command input is currently available with no waiting. | |
1808 Actually, the value is nil only if we can be sure that no input is available. | |
1809 */ | |
1810 ()) | |
1811 { | |
1318 | 1812 /* This can call Lisp */ |
1268 | 1813 return detect_input_pending (1) ? Qt : Qnil; |
1814 } | |
1815 | |
1816 static int | |
1817 maybe_read_quit_event (Lisp_Event *event) | |
1818 { | |
1819 /* A C-g that came from `sigint_happened' will always come from the | |
1820 controlling terminal. If that doesn't exist, however, then the | |
1821 user manually sent us a SIGINT, and we pretend the C-g came from | |
1822 the selected console. */ | |
1823 struct console *con; | |
1824 | |
1825 if (CONSOLEP (Vcontrolling_terminal) && | |
1826 CONSOLE_LIVE_P (XCONSOLE (Vcontrolling_terminal))) | |
1827 con = XCONSOLE (Vcontrolling_terminal); | |
1828 else | |
1829 con = XCONSOLE (Fselected_console ()); | |
1830 | |
1831 if (sigint_happened) | |
1832 { | |
1833 sigint_happened = 0; | |
1834 Vquit_flag = Qnil; | |
1835 Fcopy_event (CONSOLE_QUIT_EVENT (con), wrap_event (event)); | |
1836 return 1; | |
1837 } | |
1838 return 0; | |
1839 } | |
1840 | |
1841 struct remove_quit_p_data | |
1842 { | |
1843 int critical; | |
1844 }; | |
1845 | |
1846 static int | |
1847 remove_quit_p_event (Lisp_Object ev, void *the_data) | |
1848 { | |
1849 struct remove_quit_p_data *data = (struct remove_quit_p_data *) the_data; | |
1850 struct console *con = event_console_or_selected (ev); | |
1851 | |
1852 if (XEVENT_TYPE (ev) == key_press_event) | |
1853 { | |
1854 if (event_matches_key_specifier_p (ev, CONSOLE_QUIT_EVENT (con))) | |
1855 return 1; | |
1856 if (event_matches_key_specifier_p (ev, | |
1857 CONSOLE_CRITICAL_QUIT_EVENT (con))) | |
1858 { | |
1859 data->critical = 1; | |
1860 return 1; | |
1861 } | |
1862 } | |
1863 | |
1864 return 0; | |
1865 } | |
1866 | |
1867 void | |
1868 event_stream_quit_p (void) | |
1869 { | |
1318 | 1870 /* This can call Lisp */ |
1268 | 1871 struct remove_quit_p_data data; |
1872 | |
1873 /* Quit checking cannot happen in modal loop. Because it attempts to | |
1874 retrieve and dispatch events, it will cause lots of problems if we try | |
1875 to do this when already in the process of doing this -- deadlocking | |
1876 under Windows, crashes in lwlib etc. under X due to non-reentrant | |
1877 code. This is automatically caught, however, in | |
1878 event_stream_drain_queue() (checks for in_modal_loop in the | |
1879 event-specific code). */ | |
1880 | |
1881 /* Drain queue so we can check for pending C-g events. */ | |
1882 event_stream_drain_queue (); | |
1883 data.critical = 0; | |
1884 | |
1885 if (map_event_chain_remove (remove_quit_p_event, | |
1886 &dispatch_event_queue, | |
1887 &dispatch_event_queue_tail, | |
1888 &data, MECR_DEALLOCATE_EVENT)) | |
1889 Vquit_flag = data.critical ? Qcritical : Qt; | |
1890 } | |
1891 | |
1892 Lisp_Object | |
1893 event_stream_protect_modal_loop (const char *error_string, | |
1894 Lisp_Object (*bfun) (void *barg), | |
1895 void *barg, int flags) | |
1896 { | |
1897 Lisp_Object tmp; | |
1898 | |
1899 ++in_modal_loop; | |
1900 tmp = call_trapping_problems (Qevent, error_string, flags, 0, bfun, barg); | |
1901 --in_modal_loop; | |
1902 | |
1903 return tmp; | |
1904 } | |
1905 | |
1906 | |
1907 /**********************************************************************/ | |
428 | 1908 /* retrieving the next event */ |
1909 /**********************************************************************/ | |
1910 | |
1911 static int in_single_console; | |
1912 | |
1913 /* #### These functions don't currently do anything. */ | |
1914 void | |
1915 single_console_state (void) | |
1916 { | |
1917 in_single_console = 1; | |
1918 } | |
1919 | |
1920 void | |
1921 any_console_state (void) | |
1922 { | |
1923 in_single_console = 0; | |
1924 } | |
1925 | |
1926 int | |
1927 in_single_console_state (void) | |
1928 { | |
1929 return in_single_console; | |
1930 } | |
1931 | |
1268 | 1932 static void |
1933 event_stream_next_event (Lisp_Event *event) | |
1934 { | |
1935 Lisp_Object event_obj; | |
1936 | |
1937 check_event_stream_ok (); | |
1938 | |
1939 event_obj = wrap_event (event); | |
1940 zero_event (event); | |
1941 /* SIGINT occurs when C-g was pressed on a TTY. (SIGINT might have | |
1942 been sent manually by the user, but we don't care; we treat it | |
1943 the same.) | |
1944 | |
1945 The SIGINT signal handler sets Vquit_flag as well as sigint_happened | |
1946 and write a byte on our "fake pipe", which unblocks us when we are | |
1947 waiting for an event. */ | |
1948 | |
1949 /* If SIGINT was received after we disabled quit checking (because | |
1950 we want to read C-g's as characters), but before we got a chance | |
1951 to start reading, notice it now and treat it as a character to be | |
1952 read. If above callers wanted this to be QUIT, they can | |
1953 determine this by comparing the event against quit-char. */ | |
1954 | |
1955 if (maybe_read_quit_event (event)) | |
1956 { | |
1957 DEBUG_PRINT_EMACS_EVENT ("SIGINT", event_obj); | |
1958 return; | |
1959 } | |
1960 | |
1961 /* If a longjmp() happens in the callback, we're screwed. | |
1962 Let's hope it doesn't. I think the code here is fairly | |
1963 clean and doesn't do this. */ | |
1964 emacs_is_blocking = 1; | |
1965 event_stream->next_event_cb (event); | |
1966 emacs_is_blocking = 0; | |
1967 | |
1968 /* Now check to see if C-g was pressed while we were blocking. | |
1969 We treat it as an event, just like above. */ | |
1970 if (maybe_read_quit_event (event)) | |
1971 { | |
1972 DEBUG_PRINT_EMACS_EVENT ("SIGINT", event_obj); | |
1973 return; | |
1974 } | |
1975 | |
1976 #ifdef DEBUG_XEMACS | |
1977 /* timeout events have more info set later, so | |
1978 print the event out in next_event_internal(). */ | |
1979 if (event->event_type != timeout_event) | |
1980 DEBUG_PRINT_EMACS_EVENT ("real", event_obj); | |
1981 #endif | |
1982 maybe_kbd_translate (event_obj); | |
1983 } | |
428 | 1984 |
853 | 1985 /* Read an event from the window system (or tty). If ALLOW_QUEUED is |
1986 non-zero, read from the command-event queue first. | |
1987 | |
1988 If C-g was pressed, this function will attempt to QUIT. If you want | |
1989 to read C-g as an event, wrap this function with a call to | |
1990 begin_dont_check_for_quit(), and set Vquit_flag to Qnil just before | |
1991 you unbind. In this case, TARGET_EVENT will contain a C-g. | |
1992 | |
1993 Note that even if you are interested in C-g doing QUIT, a caller of you | |
1994 might not be. | |
1995 */ | |
1996 | |
428 | 1997 static void |
1998 next_event_internal (Lisp_Object target_event, int allow_queued) | |
1999 { | |
2000 struct gcpro gcpro1; | |
1292 | 2001 PROFILE_DECLARE (); |
2002 | |
853 | 2003 QUIT; |
428 | 2004 |
1292 | 2005 PROFILE_RECORD_ENTERING_SECTION (QSnext_event_internal); |
2006 | |
428 | 2007 assert (NILP (XEVENT_NEXT (target_event))); |
2008 | |
2009 GCPRO1 (target_event); | |
2010 | |
2011 /* When focus_follows_mouse is nil, if a frame change took place, we need | |
2012 * to actually switch window manager focus to the selected window now. | |
2013 */ | |
2014 if (!focus_follows_mouse) | |
2015 investigate_frame_change (); | |
2016 | |
2017 if (allow_queued && !NILP (command_event_queue)) | |
2018 { | |
2019 Lisp_Object event = dequeue_command_event (); | |
2020 Fcopy_event (event, target_event); | |
2021 Fdeallocate_event (event); | |
2022 DEBUG_PRINT_EMACS_EVENT ("command event queue", target_event); | |
2023 } | |
2024 else | |
2025 { | |
440 | 2026 Lisp_Event *e = XEVENT (target_event); |
428 | 2027 |
2028 /* The command_event_queue was empty. Wait for an event. */ | |
2029 event_stream_next_event (e); | |
2030 /* If this was a timeout, then we need to extract some data | |
2031 out of the returned closure and might need to resignal | |
2032 it. */ | |
934 | 2033 if (EVENT_TYPE (e) == timeout_event) |
428 | 2034 { |
2035 Lisp_Object tristan, isolde; | |
2036 | |
1204 | 2037 SET_EVENT_TIMEOUT_ID_NUMBER (e, |
2038 event_stream_resignal_wakeup (EVENT_TIMEOUT_INTERVAL_ID (e), 0, &tristan, &isolde)); | |
2039 | |
2040 SET_EVENT_TIMEOUT_FUNCTION (e, tristan); | |
2041 SET_EVENT_TIMEOUT_OBJECT (e, isolde); | |
934 | 2042 /* next_event_internal() doesn't print out timeout events |
2043 because of the extra info we just set. */ | |
428 | 2044 DEBUG_PRINT_EMACS_EVENT ("real, timeout", target_event); |
2045 } | |
2046 | |
853 | 2047 /* If we read a ^G, then set quit-flag and try to QUIT. |
2048 This may be blocked (see above). | |
428 | 2049 */ |
934 | 2050 if (EVENT_TYPE (e) == key_press_event && |
428 | 2051 event_matches_key_specifier_p |
1204 | 2052 (target_event, CONSOLE_QUIT_EVENT (XCONSOLE (EVENT_CHANNEL (e))))) |
428 | 2053 { |
2054 Vquit_flag = Qt; | |
853 | 2055 QUIT; |
428 | 2056 } |
2057 } | |
2058 | |
2059 UNGCPRO; | |
1292 | 2060 |
2061 PROFILE_RECORD_EXITING_SECTION (QSnext_event_internal); | |
428 | 2062 } |
2063 | |
853 | 2064 void |
428 | 2065 run_pre_idle_hook (void) |
2066 { | |
1318 | 2067 /* This can call Lisp */ |
428 | 2068 if (!NILP (Vpre_idle_hook) |
1268 | 2069 && !detect_input_pending (1)) |
853 | 2070 safe_run_hook_trapping_problems |
1333 | 2071 (Qredisplay, Qpre_idle_hook, |
1268 | 2072 /* Quit is inhibited as a result of being within next-event so |
2073 we need to fix that. */ | |
2074 INHIBIT_EXISTING_PERMANENT_DISPLAY_OBJECT_DELETION | UNINHIBIT_QUIT); | |
428 | 2075 } |
2076 | |
2077 DEFUN ("next-event", Fnext_event, 0, 2, 0, /* | |
2078 Return the next available event. | |
2079 Pass this object to `dispatch-event' to handle it. | |
2080 In most cases, you will want to use `next-command-event', which returns | |
2081 the next available "user" event (i.e. keypress, button-press, | |
2082 button-release, or menu selection) instead of this function. | |
2083 | |
2084 If EVENT is non-nil, it should be an event object and will be filled in | |
2085 and returned; otherwise a new event object will be created and returned. | |
2086 If PROMPT is non-nil, it should be a string and will be displayed in the | |
2087 echo area while this function is waiting for an event. | |
2088 | |
2089 The next available event will be | |
2090 | |
2091 -- any events in `unread-command-events' or `unread-command-event'; else | |
2092 -- the next event in the currently executing keyboard macro, if any; else | |
442 | 2093 -- an event queued by `enqueue-eval-event', if any, or any similar event |
2094 queued internally, such as a misc-user event. (For example, when an item | |
2095 is selected from a menu or from a `question'-type dialog box, the item's | |
2096 callback is not immediately executed, but instead a misc-user event | |
2097 is generated and placed onto this queue; when it is dispatched, the | |
2098 callback is executed.) Else | |
428 | 2099 -- the next available event from the window system or terminal driver. |
2100 | |
2101 In the last case, this function will block until an event is available. | |
2102 | |
2103 The returned event will be one of the following types: | |
2104 | |
2105 -- a key-press event. | |
2106 -- a button-press or button-release event. | |
2107 -- a misc-user-event, meaning the user selected an item on a menu or used | |
2108 the scrollbar. | |
2109 -- a process event, meaning that output from a subprocess is available. | |
2110 -- a timeout event, meaning that a timeout has elapsed. | |
2111 -- an eval event, which simply causes a function to be executed when the | |
2112 event is dispatched. Eval events are generated by `enqueue-eval-event' | |
2113 or by certain other conditions happening. | |
2114 -- a magic event, indicating that some window-system-specific event | |
2115 happened (such as a focus-change notification) that must be handled | |
2116 synchronously with other events. `dispatch-event' knows what to do with | |
2117 these events. | |
2118 */ | |
2119 (event, prompt)) | |
2120 { | |
2121 /* This function can call lisp */ | |
2122 /* #### We start out using the selected console before an event | |
2123 is received, for echoing the partially completed command. | |
2124 This is most definitely wrong -- there needs to be a separate | |
2125 echo area for each console! */ | |
2126 struct console *con = XCONSOLE (Vselected_console); | |
2127 struct command_builder *command_builder = | |
2128 XCOMMAND_BUILDER (con->command_builder); | |
2129 int store_this_key = 0; | |
2130 struct gcpro gcpro1; | |
853 | 2131 int depth; |
1292 | 2132 PROFILE_DECLARE (); |
428 | 2133 |
2134 GCPRO1 (event); | |
853 | 2135 |
1268 | 2136 /* This is not strictly necessary. Trying to retrieve an event inside of |
2137 a modal loop can cause major problems (see event_stream_quit_p()), but | |
2138 the event-specific code knows about this and will make sure we don't | |
2139 do anything dangerous. However, if we've gotten here, it's highly | |
2140 likely that some code is trying to fetch user events (e.g. in custom | |
2141 dialog-box code), and will almost certainly deadlock, so it's probably | |
2142 best to error out. #### This could cause problems because there are | |
2143 (potentially, at least) legitimate reasons for calling next-event | |
2144 inside of a modal loop, in particular if the code is trying to search | |
2145 for a timeout event, which will still get retrieved in such a case. | |
2146 However, the code to error in such a case has already been present for | |
2147 a long time without obvious problems so leaving it in isn't so | |
1279 | 2148 bad. |
2149 | |
2150 #### I used to conditionalize on in_modal_loop but that fails utterly | |
2151 because event-msw.c specifically calls Fnext_event() inside of a modal | |
2152 loop to clear the dispatch queue. --ben */ | |
1315 | 2153 #ifdef HAVE_MENUBARS |
1279 | 2154 if (in_menu_callback) |
2155 invalid_operation ("Attempt to call next-event inside menu callback", | |
1268 | 2156 Qunbound); |
1315 | 2157 #endif /* HAVE_MENUBARS */ |
1268 | 2158 |
1292 | 2159 PROFILE_RECORD_ENTERING_SECTION (Qnext_event); |
2160 | |
853 | 2161 depth = begin_dont_check_for_quit (); |
428 | 2162 |
2163 if (NILP (event)) | |
2164 event = Fmake_event (Qnil, Qnil); | |
2165 else | |
2166 CHECK_LIVE_EVENT (event); | |
2167 | |
2168 if (!NILP (prompt)) | |
2169 { | |
2170 Bytecount len; | |
2171 CHECK_STRING (prompt); | |
2172 | |
2173 len = XSTRING_LENGTH (prompt); | |
2174 if (command_builder->echo_buf_length < len) | |
2175 len = command_builder->echo_buf_length - 1; | |
2176 memcpy (command_builder->echo_buf, XSTRING_DATA (prompt), len); | |
2177 command_builder->echo_buf[len] = 0; | |
2178 command_builder->echo_buf_index = len; | |
2179 echo_area_message (XFRAME (CONSOLE_SELECTED_FRAME (con)), | |
2180 command_builder->echo_buf, | |
2181 Qnil, 0, | |
2182 command_builder->echo_buf_index, | |
2183 Qcommand); | |
2184 } | |
2185 | |
2186 start_over_and_avoid_hosage: | |
2187 | |
2188 /* If there is something in unread-command-events, simply return it. | |
2189 But do some error checking to make sure the user hasn't put something | |
2190 in the unread-command-events that they shouldn't have. | |
2191 This does not update this-command-keys and recent-keys. | |
2192 */ | |
2193 if (!NILP (Vunread_command_events)) | |
2194 { | |
2195 if (!CONSP (Vunread_command_events)) | |
2196 { | |
2197 Vunread_command_events = Qnil; | |
563 | 2198 signal_error_1 (Qwrong_type_argument, |
428 | 2199 list3 (Qconsp, Vunread_command_events, |
2200 Qunread_command_events)); | |
2201 } | |
2202 else | |
2203 { | |
2204 Lisp_Object e = XCAR (Vunread_command_events); | |
2205 Vunread_command_events = XCDR (Vunread_command_events); | |
2206 if (!EVENTP (e) || !command_event_p (e)) | |
563 | 2207 signal_error_1 (Qwrong_type_argument, |
428 | 2208 list3 (Qcommand_event_p, e, Qunread_command_events)); |
853 | 2209 redisplay_no_pre_idle_hook (); |
428 | 2210 if (!EQ (e, event)) |
2211 Fcopy_event (e, event); | |
2212 DEBUG_PRINT_EMACS_EVENT ("unread-command-events", event); | |
2213 } | |
2214 } | |
2215 | |
2216 /* Do similar for unread-command-event (obsoleteness support). */ | |
2217 else if (!NILP (Vunread_command_event)) | |
2218 { | |
2219 Lisp_Object e = Vunread_command_event; | |
2220 Vunread_command_event = Qnil; | |
2221 | |
2222 if (!EVENTP (e) || !command_event_p (e)) | |
2223 { | |
563 | 2224 signal_error_1 (Qwrong_type_argument, |
428 | 2225 list3 (Qeventp, e, Qunread_command_event)); |
2226 } | |
2227 if (!EQ (e, event)) | |
2228 Fcopy_event (e, event); | |
853 | 2229 redisplay_no_pre_idle_hook (); |
428 | 2230 DEBUG_PRINT_EMACS_EVENT ("unread-command-event", event); |
2231 } | |
2232 | |
2233 /* If we're executing a keyboard macro, take the next event from that, | |
2234 and update this-command-keys and recent-keys. | |
2235 Note that the unread-command-events take precedence over kbd macros. | |
2236 */ | |
2237 else | |
2238 { | |
2239 if (!NILP (Vexecuting_macro)) | |
2240 { | |
853 | 2241 redisplay_no_pre_idle_hook (); |
428 | 2242 pop_kbd_macro_event (event); /* This throws past us at |
2243 end-of-macro. */ | |
2244 store_this_key = 1; | |
2245 DEBUG_PRINT_EMACS_EVENT ("keyboard macro", event); | |
2246 } | |
2247 /* Otherwise, read a real event, possibly from the | |
2248 command_event_queue, and update this-command-keys and | |
2249 recent-keys. */ | |
2250 else | |
2251 { | |
2252 redisplay (); | |
2253 next_event_internal (event, 1); | |
2254 store_this_key = 1; | |
2255 } | |
2256 } | |
2257 | |
853 | 2258 /* temporarily reenable quit checking here, because arbitrary lisp |
2259 is executed */ | |
2260 Vquit_flag = Qnil; /* see begin_dont_check_for_quit() */ | |
2261 unbind_to (depth); | |
428 | 2262 status_notify (); /* Notice process change */ |
853 | 2263 depth = begin_dont_check_for_quit (); |
428 | 2264 |
2265 /* Since we can free the most stuff here | |
2266 * (since this is typically called from | |
2267 * the command-loop top-level). */ | |
851 | 2268 if (need_to_check_c_alloca) |
2269 xemacs_c_alloca (0); /* Cause a garbage collection now */ | |
428 | 2270 |
2271 if (object_dead_p (XEVENT (event)->channel)) | |
2272 /* event_console_or_selected may crash if the channel is dead. | |
2273 Best just to eat it and get the next event. */ | |
2274 goto start_over_and_avoid_hosage; | |
2275 | |
2276 /* OK, now we can stop the selected-console kludge and use the | |
2277 actual console from the event. */ | |
2278 con = event_console_or_selected (event); | |
2279 command_builder = XCOMMAND_BUILDER (con->command_builder); | |
2280 | |
2281 switch (XEVENT_TYPE (event)) | |
2282 { | |
2283 case button_release_event: | |
2284 case misc_user_event: | |
2285 /* don't echo menu accelerator keys */ | |
2286 reset_key_echo (command_builder, 1); | |
2287 goto EXECUTE_KEY; | |
2288 case button_press_event: /* key or mouse input can trigger prompting */ | |
2289 goto STORE_AND_EXECUTE_KEY; | |
2290 case key_press_event: /* any key input can trigger autosave */ | |
2291 break; | |
898 | 2292 default: |
2293 goto RETURN; | |
428 | 2294 } |
2295 | |
853 | 2296 /* temporarily reenable quit checking here, because we could get stuck */ |
2297 Vquit_flag = Qnil; /* see begin_dont_check_for_quit() */ | |
2298 unbind_to (depth); | |
428 | 2299 maybe_do_auto_save (); |
853 | 2300 depth = begin_dont_check_for_quit (); |
2301 | |
428 | 2302 num_input_chars++; |
2303 STORE_AND_EXECUTE_KEY: | |
2304 if (store_this_key) | |
2305 { | |
2306 echo_key_event (command_builder, event); | |
2307 } | |
2308 | |
2309 EXECUTE_KEY: | |
2310 /* Store the last-input-event. The semantics of this is that it is | |
2311 the thing most recently returned by next-command-event. It need | |
2312 not have come from the keyboard or a keyboard macro, it may have | |
2313 come from unread-command-events. It's always a command-event (a | |
2314 key, click, or menu selection), never a motion or process event. | |
2315 */ | |
2316 if (!EVENTP (Vlast_input_event)) | |
2317 Vlast_input_event = Fmake_event (Qnil, Qnil); | |
2318 if (XEVENT_TYPE (Vlast_input_event) == dead_event) | |
2319 { | |
2320 Vlast_input_event = Fmake_event (Qnil, Qnil); | |
563 | 2321 invalid_state ("Someone deallocated last-input-event!", Qunbound); |
428 | 2322 } |
2323 if (! EQ (event, Vlast_input_event)) | |
2324 Fcopy_event (event, Vlast_input_event); | |
2325 | |
2326 /* last-input-char and last-input-time are derived from | |
2327 last-input-event. | |
2328 Note that last-input-char will never have its high-bit set, in an | |
2329 effort to sidestep the ambiguity between M-x and oslash. | |
2330 */ | |
2862 | 2331 Vlast_input_char = Fevent_to_character (Vlast_input_event, Qnil, Qnil, Qnil); |
428 | 2332 { |
2333 EMACS_TIME t; | |
2334 EMACS_GET_TIME (t); | |
2335 if (!CONSP (Vlast_input_time)) | |
2336 Vlast_input_time = Fcons (Qnil, Qnil); | |
2337 XCAR (Vlast_input_time) = make_int ((EMACS_SECS (t) >> 16) & 0xffff); | |
2338 XCDR (Vlast_input_time) = make_int ((EMACS_SECS (t) >> 0) & 0xffff); | |
2339 if (!CONSP (Vlast_command_event_time)) | |
2340 Vlast_command_event_time = list3 (Qnil, Qnil, Qnil); | |
2341 XCAR (Vlast_command_event_time) = | |
2342 make_int ((EMACS_SECS (t) >> 16) & 0xffff); | |
2343 XCAR (XCDR (Vlast_command_event_time)) = | |
2344 make_int ((EMACS_SECS (t) >> 0) & 0xffff); | |
2345 XCAR (XCDR (XCDR (Vlast_command_event_time))) | |
2346 = make_int (EMACS_USECS (t)); | |
2347 } | |
2348 /* If this key came from the keyboard or from a keyboard macro, then | |
2349 it goes into the recent-keys and this-command-keys vectors. | |
2350 If this key came from the keyboard, and we're defining a keyboard | |
2351 macro, then it goes into the macro. | |
2352 */ | |
2353 if (store_this_key) | |
2354 { | |
479 | 2355 if (!is_scrollbar_event (event)) /* #### not quite right, see |
2356 comment in execute_command_event */ | |
2357 push_this_command_keys (event); | |
428 | 2358 if (!inhibit_input_event_recording) |
2359 push_recent_keys (event); | |
2360 dribble_out_event (event); | |
2361 if (!NILP (con->defining_kbd_macro) && NILP (Vexecuting_macro)) | |
2362 { | |
2363 if (!EVENTP (command_builder->current_events)) | |
2364 finalize_kbd_macro_chars (con); | |
2365 store_kbd_macro_event (event); | |
2366 } | |
2367 } | |
853 | 2368 /* If this is the help char and there is a help form, then execute |
2369 the help form and swallow this character. Note that | |
2370 execute_help_form() calls Fnext_command_event(), which calls this | |
2371 function, as well as Fdispatch_event. */ | |
428 | 2372 if (!NILP (Vhelp_form) && |
1204 | 2373 event_matches_key_specifier_p (event, Vhelp_char)) |
853 | 2374 { |
2375 /* temporarily reenable quit checking here, because we could get stuck */ | |
2376 Vquit_flag = Qnil; /* see begin_dont_check_for_quit() */ | |
2377 unbind_to (depth); | |
2378 execute_help_form (command_builder, event); | |
2379 depth = begin_dont_check_for_quit (); | |
2380 } | |
428 | 2381 |
2382 RETURN: | |
853 | 2383 Vquit_flag = Qnil; /* see begin_dont_check_for_quit() */ |
2384 unbind_to (depth); | |
2385 | |
1292 | 2386 PROFILE_RECORD_EXITING_SECTION (Qnext_event); |
2387 | |
428 | 2388 UNGCPRO; |
853 | 2389 |
428 | 2390 return event; |
2391 } | |
2392 | |
2393 DEFUN ("next-command-event", Fnext_command_event, 0, 2, 0, /* | |
2394 Return the next available "user" event. | |
2395 Pass this object to `dispatch-event' to handle it. | |
2396 | |
2397 If EVENT is non-nil, it should be an event object and will be filled in | |
2398 and returned; otherwise a new event object will be created and returned. | |
2399 If PROMPT is non-nil, it should be a string and will be displayed in the | |
2400 echo area while this function is waiting for an event. | |
2401 | |
2402 The event returned will be a keyboard, mouse press, or mouse release event. | |
2403 If there are non-command events available (mouse motion, sub-process output, | |
2404 etc) then these will be executed (with `dispatch-event') and discarded. This | |
2405 function is provided as a convenience; it is roughly equivalent to the lisp code | |
2406 | |
2407 (while (progn | |
2408 (next-event event prompt) | |
2409 (not (or (key-press-event-p event) | |
2410 (button-press-event-p event) | |
2411 (button-release-event-p event) | |
2412 (misc-user-event-p event)))) | |
2413 (dispatch-event event)) | |
2414 | |
2415 but it also makes a provision for displaying keystrokes in the echo area. | |
2416 */ | |
2417 (event, prompt)) | |
2418 { | |
2419 /* This function can GC */ | |
2420 struct gcpro gcpro1; | |
2421 GCPRO1 (event); | |
934 | 2422 |
428 | 2423 maybe_echo_keys (XCOMMAND_BUILDER |
2424 (XCONSOLE (Vselected_console)-> | |
2425 command_builder), 0); /* #### This sucks bigtime */ | |
853 | 2426 |
428 | 2427 for (;;) |
2428 { | |
2429 event = Fnext_event (event, prompt); | |
2430 if (command_event_p (event)) | |
2431 break; | |
2432 else | |
2433 execute_internal_event (event); | |
2434 } | |
2435 UNGCPRO; | |
2436 return event; | |
2437 } | |
2438 | |
442 | 2439 DEFUN ("dispatch-non-command-events", Fdispatch_non_command_events, 0, 0, 0, /* |
2440 Dispatch any pending "magic" events. | |
2441 | |
2442 This function is useful for forcing the redisplay of native | |
2443 widgets. Normally these are redisplayed through a native window-system | |
2444 event encoded as magic event, rather than by the redisplay code. This | |
2445 function does not call redisplay or do any of the other things that | |
2446 `next-event' does. | |
2447 */ | |
2448 ()) | |
2449 { | |
2450 /* This function can GC */ | |
2451 Lisp_Object event = Qnil; | |
2452 struct gcpro gcpro1; | |
2453 GCPRO1 (event); | |
2454 event = Fmake_event (Qnil, Qnil); | |
2455 | |
2456 /* Make sure that there will be something in the native event queue | |
2457 so that externally managed things (e.g. widgets) get some CPU | |
2458 time. */ | |
2459 event_stream_force_event_pending (selected_frame ()); | |
2460 | |
2461 while (event_stream_event_pending_p (0)) | |
2462 { | |
2463 /* We're a generator of the command_event_queue, so we can't be a | |
2464 consumer as well. Also, we have no reason to consult the | |
2465 command_event_queue; there are only user and eval-events there, | |
2466 and we'd just have to put them back anyway. | |
2467 */ | |
2468 next_event_internal (event, 0); /* blocks */ | |
2469 if (XEVENT_TYPE (event) == magic_event || | |
2470 XEVENT_TYPE (event) == timeout_event || | |
2471 XEVENT_TYPE (event) == process_event || | |
2472 XEVENT_TYPE (event) == pointer_motion_event) | |
2473 execute_internal_event (event); | |
2474 else | |
2475 { | |
2476 enqueue_command_event_1 (event); | |
2477 break; | |
2478 } | |
2479 } | |
2480 | |
2481 Fdeallocate_event (event); | |
2482 UNGCPRO; | |
2483 return Qnil; | |
2484 } | |
2485 | |
428 | 2486 static void |
2487 reset_current_events (struct command_builder *command_builder) | |
2488 { | |
2489 Lisp_Object event = command_builder->current_events; | |
2490 reset_command_builder_event_chain (command_builder); | |
2491 if (EVENTP (event)) | |
2492 deallocate_event_chain (event); | |
2493 } | |
2494 | |
1268 | 2495 static int |
2286 | 2496 command_event_p_cb (Lisp_Object ev, void *UNUSED (the_data)) |
1268 | 2497 { |
2498 return command_event_p (ev); | |
2499 } | |
2500 | |
428 | 2501 DEFUN ("discard-input", Fdiscard_input, 0, 0, 0, /* |
2502 Discard any pending "user" events. | |
2503 Also cancel any kbd macro being defined. | |
2504 A user event is a key press, button press, button release, or | |
2505 "misc-user" event (menu selection or scrollbar action). | |
2506 */ | |
2507 ()) | |
2508 { | |
1318 | 2509 /* This can call Lisp */ |
1268 | 2510 Lisp_Object concons; |
2511 | |
2512 CONSOLE_LOOP (concons) | |
428 | 2513 { |
1268 | 2514 struct console *con = XCONSOLE (XCAR (concons)); |
2515 | |
2516 /* If a macro was being defined then we have to mark the modeline | |
2517 has changed to ensure that it gets updated correctly. */ | |
2518 if (!NILP (con->defining_kbd_macro)) | |
2519 MARK_MODELINE_CHANGED; | |
2520 con->defining_kbd_macro = Qnil; | |
2521 reset_current_events (XCOMMAND_BUILDER (con->command_builder)); | |
428 | 2522 } |
2523 | |
1268 | 2524 /* This function used to be a lot more complicated. Now, we just |
2525 drain the pending queue and discard all user events from the | |
2526 command and dispatch queues. */ | |
2527 event_stream_drain_queue (); | |
2528 | |
2529 map_event_chain_remove (command_event_p_cb, | |
2530 &dispatch_event_queue, &dispatch_event_queue_tail, | |
2531 0, MECR_DEALLOCATE_EVENT); | |
2532 map_event_chain_remove (command_event_p_cb, | |
2533 &command_event_queue, &command_event_queue_tail, | |
2534 0, MECR_DEALLOCATE_EVENT); | |
428 | 2535 |
2536 return Qnil; | |
2537 } | |
2538 | |
2539 | |
2540 /**********************************************************************/ | |
2541 /* pausing until an action occurs */ | |
2542 /**********************************************************************/ | |
2543 | |
2544 /* This is used in accept-process-output, sleep-for and sit-for. | |
2545 Before running any process_events in these routines, we set | |
1268 | 2546 recursive_sit_for to 1, and use this unwind protect to reset it to |
2547 Qnil upon exit. When recursive_sit_for is 1, calling sit-for will | |
428 | 2548 cause it to return immediately. |
2549 | |
2550 All of these routines install timeouts, so we clear the installed | |
2551 timeout as well. | |
2552 | |
2553 Note: It's very easy to break the desired behaviors of these | |
2554 3 routines. If you make any changes to anything in this area, run | |
2555 the regression tests at the bottom of the file. -- dmoore */ | |
2556 | |
2557 | |
2558 static Lisp_Object | |
2559 sit_for_unwind (Lisp_Object timeout_id) | |
2560 { | |
2561 if (!NILP(timeout_id)) | |
2562 Fdisable_timeout (timeout_id); | |
2563 | |
1268 | 2564 recursive_sit_for = 0; |
428 | 2565 return Qnil; |
2566 } | |
2567 | |
2568 /* #### Is (accept-process-output nil 3) supposed to be like (sleep-for 3)? | |
2569 */ | |
2570 | |
2571 DEFUN ("accept-process-output", Faccept_process_output, 0, 3, 0, /* | |
2572 Allow any pending output from subprocesses to be read by Emacs. | |
2573 It is read into the process' buffers or given to their filter functions. | |
2574 Non-nil arg PROCESS means do not return until some output has been received | |
2575 from PROCESS. Nil arg PROCESS means do not return until some output has | |
2576 been received from any process. | |
2577 If the second arg is non-nil, it is the maximum number of seconds to wait: | |
2578 this function will return after that much time even if no input has arrived | |
2579 from PROCESS. This argument may be a float, meaning wait some fractional | |
2580 part of a second. | |
2581 If the third arg is non-nil, it is a number of milliseconds that is added | |
2582 to the second arg. (This exists only for compatibility.) | |
2583 Return non-nil iff we received any output before the timeout expired. | |
2584 */ | |
2585 (process, timeout_secs, timeout_msecs)) | |
2586 { | |
2587 /* This function can GC */ | |
2588 struct gcpro gcpro1, gcpro2; | |
2589 Lisp_Object event = Qnil; | |
2590 Lisp_Object result = Qnil; | |
2591 int timeout_id = -1; | |
2592 int timeout_enabled = 0; | |
2593 int done = 0; | |
2594 struct buffer *old_buffer = current_buffer; | |
2595 int count; | |
2596 | |
2597 /* We preserve the current buffer but nothing else. If a focus | |
2598 change alters the selected window then the top level event loop | |
2599 will eventually alter current_buffer to match. In the mean time | |
2600 we don't want to mess up whatever called this function. */ | |
2601 | |
2602 if (!NILP (process)) | |
2603 CHECK_PROCESS (process); | |
2604 | |
2605 GCPRO2 (event, process); | |
2606 | |
2607 if (!NILP (timeout_secs) || !NILP (timeout_msecs)) | |
2608 { | |
2609 unsigned long msecs = 0; | |
2610 if (!NILP (timeout_secs)) | |
2611 msecs = lisp_number_to_milliseconds (timeout_secs, 1); | |
2612 if (!NILP (timeout_msecs)) | |
2613 { | |
2614 CHECK_NATNUM (timeout_msecs); | |
2615 msecs += XINT (timeout_msecs); | |
2616 } | |
2617 if (msecs) | |
2618 { | |
2619 timeout_id = event_stream_generate_wakeup (msecs, 0, Qnil, Qnil, 0); | |
2620 timeout_enabled = 1; | |
2621 } | |
2622 } | |
2623 | |
2624 event = Fmake_event (Qnil, Qnil); | |
2625 | |
2626 count = specpdl_depth (); | |
2627 record_unwind_protect (sit_for_unwind, | |
2628 timeout_enabled ? make_int (timeout_id) : Qnil); | |
1268 | 2629 recursive_sit_for = 1; |
428 | 2630 |
2631 while (!done && | |
2632 ((NILP (process) && timeout_enabled) || | |
2633 (NILP (process) && event_stream_event_pending_p (0)) || | |
2634 (!NILP (process)))) | |
2635 /* Calling detect_input_pending() is the wrong thing here, because | |
2636 that considers the Vunread_command_events and command_event_queue. | |
2637 We don't need to look at the command_event_queue because we are | |
2638 only interested in process events, which don't go on that. In | |
2639 fact, we can't read from it anyway, because we put stuff on it. | |
2640 | |
2641 Note that event_stream->event_pending_p must be called in such | |
2642 a way that it says whether any events *of any kind* are ready, | |
2643 not just user events, or (accept-process-output nil) will fail | |
2644 to dispatch any process events that may be on the queue. It is | |
2645 not clear to me that this is important, because the top-level | |
2646 loop will process it, and I don't think that there is ever a | |
2647 time when one calls accept-process-output with a nil argument | |
2648 and really need the processes to be handled. */ | |
2649 { | |
2650 /* If our timeout has arrived, we move along. */ | |
2651 if (timeout_enabled && !event_stream_wakeup_pending_p (timeout_id, 0)) | |
2652 { | |
2653 timeout_enabled = 0; | |
2654 done = 1; /* We're done. */ | |
2655 continue; /* Don't call next_event_internal */ | |
2656 } | |
2657 | |
2658 next_event_internal (event, 0); | |
2659 switch (XEVENT_TYPE (event)) | |
2660 { | |
2661 case process_event: | |
2662 { | |
2663 if (NILP (process) || | |
1204 | 2664 EQ (XEVENT_PROCESS_PROCESS (event), process)) |
428 | 2665 { |
2666 done = 1; | |
2667 /* RMS's version always returns nil when proc is nil, | |
2668 and only returns t if input ever arrived on proc. */ | |
2669 result = Qt; | |
2670 } | |
2671 | |
2672 execute_internal_event (event); | |
2673 break; | |
2674 } | |
2675 case timeout_event: | |
2676 /* We execute the event even if it's ours, and notice that it's | |
2677 happened above. */ | |
2678 case pointer_motion_event: | |
2679 case magic_event: | |
2680 { | |
2681 execute_internal_event (event); | |
2682 break; | |
2683 } | |
2684 default: | |
2685 { | |
2686 enqueue_command_event_1 (event); | |
2687 break; | |
2688 } | |
2689 } | |
2690 } | |
2691 | |
771 | 2692 unbind_to_1 (count, timeout_enabled ? make_int (timeout_id) : Qnil); |
428 | 2693 |
2694 Fdeallocate_event (event); | |
853 | 2695 |
2696 status_notify (); | |
2697 | |
428 | 2698 UNGCPRO; |
2699 current_buffer = old_buffer; | |
2700 return result; | |
2701 } | |
2702 | |
2703 DEFUN ("sleep-for", Fsleep_for, 1, 1, 0, /* | |
444 | 2704 Pause, without updating display, for SECONDS seconds. |
2705 SECONDS may be a float, allowing pauses for fractional parts of a second. | |
428 | 2706 |
2707 It is recommended that you never call sleep-for from inside of a process | |
444 | 2708 filter function or timer event (either synchronous or asynchronous). |
428 | 2709 */ |
2710 (seconds)) | |
2711 { | |
2712 /* This function can GC */ | |
2713 unsigned long msecs = lisp_number_to_milliseconds (seconds, 1); | |
2714 int id; | |
2715 Lisp_Object event = Qnil; | |
2716 int count; | |
2717 struct gcpro gcpro1; | |
2718 | |
2719 GCPRO1 (event); | |
2720 | |
2721 id = event_stream_generate_wakeup (msecs, 0, Qnil, Qnil, 0); | |
2722 event = Fmake_event (Qnil, Qnil); | |
2723 | |
2724 count = specpdl_depth (); | |
2725 record_unwind_protect (sit_for_unwind, make_int (id)); | |
1268 | 2726 recursive_sit_for = 1; |
428 | 2727 |
2728 while (1) | |
2729 { | |
2730 /* If our timeout has arrived, we move along. */ | |
2731 if (!event_stream_wakeup_pending_p (id, 0)) | |
2732 goto DONE_LABEL; | |
2733 | |
2734 /* We're a generator of the command_event_queue, so we can't be a | |
2735 consumer as well. We don't care about command and eval-events | |
2736 anyway. | |
2737 */ | |
2738 next_event_internal (event, 0); /* blocks */ | |
2739 switch (XEVENT_TYPE (event)) | |
2740 { | |
2741 case timeout_event: | |
2742 /* We execute the event even if it's ours, and notice that it's | |
2743 happened above. */ | |
2744 case process_event: | |
2745 case pointer_motion_event: | |
2746 case magic_event: | |
2747 { | |
2748 execute_internal_event (event); | |
2749 break; | |
2750 } | |
2751 default: | |
2752 { | |
2753 enqueue_command_event_1 (event); | |
2754 break; | |
2755 } | |
2756 } | |
2757 } | |
2758 DONE_LABEL: | |
771 | 2759 unbind_to_1 (count, make_int (id)); |
428 | 2760 Fdeallocate_event (event); |
2761 UNGCPRO; | |
2762 return Qnil; | |
2763 } | |
2764 | |
2765 DEFUN ("sit-for", Fsit_for, 1, 2, 0, /* | |
444 | 2766 Perform redisplay, then wait SECONDS seconds or until user input is available. |
2767 SECONDS may be a float, meaning a fractional part of a second. | |
2768 Optional second arg NODISPLAY non-nil means don't redisplay; just wait. | |
428 | 2769 Redisplay is preempted as always if user input arrives, and does not |
2770 happen if input is available before it starts. | |
2771 Value is t if waited the full time with no input arriving. | |
2772 | |
2773 If sit-for is called from within a process filter function or timer | |
2774 event (either synchronous or asynchronous) it will return immediately. | |
2775 */ | |
2776 (seconds, nodisplay)) | |
2777 { | |
2778 /* This function can GC */ | |
2779 unsigned long msecs = lisp_number_to_milliseconds (seconds, 1); | |
2780 Lisp_Object event, result; | |
2781 struct gcpro gcpro1; | |
2782 int id; | |
2783 int count; | |
2784 | |
2785 /* The unread-command-events count as pending input */ | |
2786 if (!NILP (Vunread_command_events) || !NILP (Vunread_command_event)) | |
2787 return Qnil; | |
2788 | |
2789 /* If the command-builder already has user-input on it (not eval events) | |
2790 then that means we're done too. | |
2791 */ | |
2792 if (!NILP (command_event_queue)) | |
2793 { | |
2794 EVENT_CHAIN_LOOP (event, command_event_queue) | |
2795 { | |
2796 if (command_event_p (event)) | |
2797 return Qnil; | |
2798 } | |
2799 } | |
2800 | |
2801 /* If we're in a macro, or noninteractive, or early in temacs, then | |
2802 don't wait. */ | |
2803 if (noninteractive || !NILP (Vexecuting_macro)) | |
2804 return Qnil; | |
2805 | |
2806 /* Recursive call from a filter function or timeout handler. */ | |
1268 | 2807 if (recursive_sit_for) |
428 | 2808 { |
2809 if (!event_stream_event_pending_p (1) && NILP (nodisplay)) | |
2810 redisplay (); | |
2811 return Qnil; | |
2812 } | |
2813 | |
2814 | |
2815 /* Otherwise, start reading events from the event_stream. | |
2816 Do this loop at least once even if (sit-for 0) so that we | |
2817 redisplay when no input pending. | |
2818 */ | |
2819 GCPRO1 (event); | |
2820 event = Fmake_event (Qnil, Qnil); | |
2821 | |
2822 /* Generate the wakeup even if MSECS is 0, so that existing timeout/etc. | |
2823 events get processed. The old (pre-19.12) code special-cased this | |
2824 and didn't generate a wakeup, but the resulting behavior was less than | |
2825 ideal; viz. the occurrence of (sit-for 0.001) scattered throughout | |
2826 the E-Lisp universe. */ | |
2827 | |
2828 id = event_stream_generate_wakeup (msecs, 0, Qnil, Qnil, 0); | |
2829 | |
2830 count = specpdl_depth (); | |
2831 record_unwind_protect (sit_for_unwind, make_int (id)); | |
1268 | 2832 recursive_sit_for = 1; |
428 | 2833 |
2834 while (1) | |
2835 { | |
2836 /* If there is no user input pending, then redisplay. | |
2837 */ | |
2838 if (!event_stream_event_pending_p (1) && NILP (nodisplay)) | |
2839 redisplay (); | |
2840 | |
2841 /* If our timeout has arrived, we move along. */ | |
2842 if (!event_stream_wakeup_pending_p (id, 0)) | |
2843 { | |
2844 result = Qt; | |
2845 goto DONE_LABEL; | |
2846 } | |
2847 | |
2848 /* We're a generator of the command_event_queue, so we can't be a | |
2849 consumer as well. In fact, we know there's nothing on the | |
2850 command_event_queue that we didn't just put there. | |
2851 */ | |
2852 next_event_internal (event, 0); /* blocks */ | |
2853 | |
2854 if (command_event_p (event)) | |
2855 { | |
2856 result = Qnil; | |
2857 goto DONE_LABEL; | |
2858 } | |
2859 switch (XEVENT_TYPE (event)) | |
2860 { | |
2861 case eval_event: | |
2862 { | |
2863 /* eval-events get delayed until later. */ | |
2864 enqueue_command_event (Fcopy_event (event, Qnil)); | |
2865 break; | |
2866 } | |
2867 | |
2868 case timeout_event: | |
2869 /* We execute the event even if it's ours, and notice that it's | |
2870 happened above. */ | |
2871 default: | |
2872 { | |
2873 execute_internal_event (event); | |
2874 break; | |
2875 } | |
2876 } | |
2877 } | |
2878 | |
2879 DONE_LABEL: | |
771 | 2880 unbind_to_1 (count, make_int (id)); |
428 | 2881 |
2882 /* Put back the event (if any) that made Fsit_for() exit before the | |
2883 timeout. Note that it is being added to the back of the queue, which | |
2884 would be inappropriate if there were any user events on the queue | |
2885 already: we would be misordering them. But we know that there are | |
2886 no user-events on the queue, or else we would not have reached this | |
2887 point at all. | |
2888 */ | |
2889 if (NILP (result)) | |
2890 enqueue_command_event (event); | |
2891 else | |
2892 Fdeallocate_event (event); | |
2893 | |
2894 UNGCPRO; | |
2895 return result; | |
2896 } | |
2897 | |
442 | 2898 /* This handy little function is used by select-x.c to wait for replies |
2899 from processes that aren't really processes (e.g. the X server) */ | |
428 | 2900 void |
2901 wait_delaying_user_input (int (*predicate) (void *arg), void *predicate_arg) | |
2902 { | |
2903 /* This function can GC */ | |
2904 Lisp_Object event = Fmake_event (Qnil, Qnil); | |
2905 struct gcpro gcpro1; | |
2906 GCPRO1 (event); | |
2907 | |
2908 while (!(*predicate) (predicate_arg)) | |
2909 { | |
2910 /* We're a generator of the command_event_queue, so we can't be a | |
2911 consumer as well. Also, we have no reason to consult the | |
2912 command_event_queue; there are only user and eval-events there, | |
2913 and we'd just have to put them back anyway. | |
2914 */ | |
2915 next_event_internal (event, 0); | |
2916 if (command_event_p (event) | |
2917 || (XEVENT_TYPE (event) == eval_event) | |
2918 || (XEVENT_TYPE (event) == magic_eval_event)) | |
2919 enqueue_command_event_1 (event); | |
2920 else | |
2921 execute_internal_event (event); | |
2922 } | |
2923 UNGCPRO; | |
2924 } | |
2925 | |
2926 | |
2927 /**********************************************************************/ | |
2928 /* dispatching events; command builder */ | |
2929 /**********************************************************************/ | |
2930 | |
2931 static void | |
2932 execute_internal_event (Lisp_Object event) | |
2933 { | |
1292 | 2934 PROFILE_DECLARE (); |
2935 | |
428 | 2936 /* events on dead channels get silently eaten */ |
2937 if (object_dead_p (XEVENT (event)->channel)) | |
2938 return; | |
2939 | |
1292 | 2940 PROFILE_RECORD_ENTERING_SECTION (QSexecute_internal_event); |
2941 | |
428 | 2942 /* This function can GC */ |
2943 switch (XEVENT_TYPE (event)) | |
2944 { | |
2945 case empty_event: | |
1292 | 2946 goto done; |
428 | 2947 |
2948 case eval_event: | |
2949 { | |
1204 | 2950 call1 (XEVENT_EVAL_FUNCTION (event), |
2951 XEVENT_EVAL_OBJECT (event)); | |
1292 | 2952 goto done; |
428 | 2953 } |
2954 | |
2955 case magic_eval_event: | |
2956 { | |
1204 | 2957 XEVENT_MAGIC_EVAL_INTERNAL_FUNCTION (event) |
2958 XEVENT_MAGIC_EVAL_OBJECT (event); | |
1292 | 2959 goto done; |
428 | 2960 } |
2961 | |
2962 case pointer_motion_event: | |
2963 { | |
2964 if (!NILP (Vmouse_motion_handler)) | |
2965 call1 (Vmouse_motion_handler, event); | |
1292 | 2966 goto done; |
428 | 2967 } |
2968 | |
2969 case process_event: | |
2970 { | |
1204 | 2971 Lisp_Object p = XEVENT_PROCESS_PROCESS (event); |
428 | 2972 Charcount readstatus; |
853 | 2973 int iter; |
2974 | |
2975 assert (PROCESSP (p)); | |
2976 for (iter = 0; iter < 2; iter++) | |
2977 { | |
2978 if (iter == 1 && !process_has_separate_stderr (p)) | |
2979 break; | |
2980 while ((readstatus = read_process_output (p, iter)) > 0) | |
2981 ; | |
2982 if (readstatus > 0) | |
2983 ; /* this clauses never gets executed but | |
2984 allows the #ifdefs to work cleanly. */ | |
428 | 2985 #ifdef EWOULDBLOCK |
853 | 2986 else if (readstatus == -1 && errno == EWOULDBLOCK) |
2987 ; | |
428 | 2988 #endif /* EWOULDBLOCK */ |
2989 #ifdef EAGAIN | |
853 | 2990 else if (readstatus == -1 && errno == EAGAIN) |
2991 ; | |
428 | 2992 #endif /* EAGAIN */ |
853 | 2993 else if ((readstatus == 0 && |
2994 /* Note that we cannot distinguish between no input | |
2995 available now and a closed pipe. | |
2996 With luck, a closed pipe will be accompanied by | |
2997 subprocess termination and SIGCHLD. */ | |
2998 (!network_connection_p (p) || | |
2999 /* | |
3000 When connected to ToolTalk (i.e. | |
3001 connected_via_filedesc_p()), it's not possible to | |
3002 reliably determine whether there is a message | |
3003 waiting for ToolTalk to receive. ToolTalk expects | |
3004 to have tt_message_receive() called exactly once | |
3005 every time the file descriptor becomes active, so | |
3006 the filter function forces this by returning 0. | |
3007 Emacs must not interpret this as a closed pipe. */ | |
3008 connected_via_filedesc_p (XPROCESS (p)))) | |
3009 | |
3010 /* On some OSs with ptys, when the process on one end of | |
3011 a pty exits, the other end gets an error reading with | |
3012 errno = EIO instead of getting an EOF (0 bytes read). | |
3013 Therefore, if we get an error reading and errno = | |
3014 EIO, just continue, because the child process has | |
3015 exited and should clean itself up soon (e.g. when we | |
3016 get a SIGCHLD). */ | |
535 | 3017 #ifdef EIO |
853 | 3018 || (readstatus == -1 && errno == EIO) |
428 | 3019 #endif |
535 | 3020 |
853 | 3021 ) |
3022 { | |
3023 /* Currently, we rely on SIGCHLD to indicate that the | |
3024 process has terminated. Unfortunately, on some systems | |
3025 the SIGCHLD gets missed some of the time. So we put an | |
3026 additional check in status_notify() to see whether a | |
3027 process has terminated. We must tell status_notify() | |
3028 to enable that check, and we do so now. */ | |
3029 kick_status_notify (); | |
3030 } | |
898 | 3031 else |
3032 { | |
3033 /* Deactivate network connection */ | |
3034 Lisp_Object status = Fprocess_status (p); | |
3035 if (EQ (status, Qopen) | |
3036 /* In case somebody changes the theory of whether to | |
3037 return open as opposed to run for network connection | |
3038 "processes"... */ | |
3039 || EQ (status, Qrun)) | |
3040 update_process_status (p, Qexit, 256, 0); | |
3041 deactivate_process (p); | |
3042 status_notify (); | |
3043 } | |
853 | 3044 |
3045 /* We must call status_notify here to allow the | |
3046 event_stream->unselect_process_cb to be run if appropriate. | |
3047 Otherwise, dead fds may be selected for, and we will get a | |
3048 continuous stream of process events for them. Since we don't | |
3049 return until all process events have been flushed, we would | |
3050 get stuck here, processing events on a process whose status | |
3025 | 3051 was `exit'. Call this after dispatch-event, or the fds will |
853 | 3052 have been closed before we read the last data from them. |
3053 It's safe for the filter to signal an error because | |
3054 status_notify() will be called on return to top-level. | |
3055 */ | |
3056 status_notify (); | |
428 | 3057 } |
1292 | 3058 goto done; |
428 | 3059 } |
3060 | |
3061 case timeout_event: | |
3062 { | |
440 | 3063 Lisp_Event *e = XEVENT (event); |
934 | 3064 |
1204 | 3065 if (!NILP (EVENT_TIMEOUT_FUNCTION (e))) |
3066 call1 (EVENT_TIMEOUT_FUNCTION (e), | |
3067 EVENT_TIMEOUT_OBJECT (e)); | |
1292 | 3068 goto done; |
428 | 3069 } |
3070 case magic_event: | |
3071 event_stream_handle_magic_event (XEVENT (event)); | |
1292 | 3072 goto done; |
428 | 3073 default: |
2500 | 3074 ABORT (); |
428 | 3075 } |
1292 | 3076 |
3077 done: | |
3078 PROFILE_RECORD_EXITING_SECTION (QSexecute_internal_event); | |
428 | 3079 } |
3080 | |
3081 | |
3082 | |
3083 static void | |
3084 this_command_keys_replace_suffix (Lisp_Object suffix, Lisp_Object chain) | |
3085 { | |
3086 Lisp_Object first_before_suffix = | |
3087 event_chain_find_previous (Vthis_command_keys, suffix); | |
3088 | |
3089 if (NILP (first_before_suffix)) | |
3090 Vthis_command_keys = chain; | |
3091 else | |
3092 XSET_EVENT_NEXT (first_before_suffix, chain); | |
3093 deallocate_event_chain (suffix); | |
3094 Vthis_command_keys_tail = event_chain_tail (chain); | |
3095 } | |
3096 | |
3097 static void | |
3098 command_builder_replace_suffix (struct command_builder *builder, | |
3099 Lisp_Object suffix, Lisp_Object chain) | |
3100 { | |
3101 Lisp_Object first_before_suffix = | |
3102 event_chain_find_previous (builder->current_events, suffix); | |
3103 | |
3104 if (NILP (first_before_suffix)) | |
3105 builder->current_events = chain; | |
3106 else | |
3107 XSET_EVENT_NEXT (first_before_suffix, chain); | |
3108 deallocate_event_chain (suffix); | |
3109 builder->most_current_event = event_chain_tail (chain); | |
3110 } | |
3111 | |
3112 static Lisp_Object | |
3113 command_builder_find_leaf_1 (struct command_builder *builder) | |
3114 { | |
3115 Lisp_Object event0 = builder->current_events; | |
3116 | |
3117 if (NILP (event0)) | |
3118 return Qnil; | |
3119 | |
3120 return event_binding (event0, 1); | |
3121 } | |
3122 | |
1268 | 3123 static void |
3124 maybe_kbd_translate (Lisp_Object event) | |
3125 { | |
3126 Ichar c; | |
3127 int did_translate = 0; | |
3128 | |
3129 if (XEVENT_TYPE (event) != key_press_event) | |
3130 return; | |
3131 if (!HASH_TABLEP (Vkeyboard_translate_table)) | |
3132 return; | |
3133 if (EQ (Fhash_table_count (Vkeyboard_translate_table), Qzero)) | |
3134 return; | |
3135 | |
2828 | 3136 c = event_to_character (event, 0, 0); |
1268 | 3137 if (c != -1) |
3138 { | |
3139 Lisp_Object traduit = Fgethash (make_char (c), Vkeyboard_translate_table, | |
3140 Qnil); | |
3141 if (!NILP (traduit) && SYMBOLP (traduit)) | |
3142 { | |
3143 XSET_EVENT_KEY_KEYSYM (event, traduit); | |
3144 XSET_EVENT_KEY_MODIFIERS (event, 0); | |
3145 did_translate = 1; | |
3146 } | |
3147 else if (CHARP (traduit)) | |
3148 { | |
3149 /* This used to call Fcharacter_to_event() directly into EVENT, | |
3150 but that can eradicate timestamps and other such stuff. | |
3151 This way is safer. */ | |
3152 Lisp_Object ev2 = Fmake_event (Qnil, Qnil); | |
3153 | |
3154 character_to_event (XCHAR (traduit), XEVENT (ev2), | |
3155 XCONSOLE (XEVENT_CHANNEL (event)), 0, 1); | |
3156 XSET_EVENT_KEY_KEYSYM (event, XEVENT_KEY_KEYSYM (ev2)); | |
3157 XSET_EVENT_KEY_MODIFIERS (event, XEVENT_KEY_MODIFIERS (ev2)); | |
3158 Fdeallocate_event (ev2); | |
3159 did_translate = 1; | |
3160 } | |
3161 } | |
3162 | |
3163 if (!did_translate) | |
3164 { | |
3165 Lisp_Object traduit = Fgethash (XEVENT_KEY_KEYSYM (event), | |
3166 Vkeyboard_translate_table, Qnil); | |
3167 if (!NILP (traduit) && SYMBOLP (traduit)) | |
3168 { | |
3169 XSET_EVENT_KEY_KEYSYM (event, traduit); | |
3170 did_translate = 1; | |
3171 } | |
3172 else if (CHARP (traduit)) | |
3173 { | |
3174 /* This used to call Fcharacter_to_event() directly into EVENT, | |
3175 but that can eradicate timestamps and other such stuff. | |
3176 This way is safer. */ | |
3177 Lisp_Object ev2 = Fmake_event (Qnil, Qnil); | |
3178 | |
3179 character_to_event (XCHAR (traduit), XEVENT (ev2), | |
3180 XCONSOLE (XEVENT_CHANNEL (event)), 0, 1); | |
3181 XSET_EVENT_KEY_KEYSYM (event, XEVENT_KEY_KEYSYM (ev2)); | |
3182 XSET_EVENT_KEY_MODIFIERS (event, | |
3183 XEVENT_KEY_MODIFIERS (event) | | |
3184 XEVENT_KEY_MODIFIERS (ev2)); | |
3185 | |
3186 Fdeallocate_event (ev2); | |
3187 did_translate = 1; | |
3188 } | |
3189 } | |
3190 | |
3191 #ifdef DEBUG_XEMACS | |
3192 if (did_translate) | |
3193 DEBUG_PRINT_EMACS_EVENT ("->keyboard-translate-table", event); | |
3194 #endif | |
3195 } | |
3196 | |
428 | 3197 /* See if we can do function-key-map or key-translation-map translation |
3198 on the current events in the command builder. If so, do this, and | |
771 | 3199 return the resulting binding, if any. |
3200 | |
3201 DID_MUNGE must be initialized before calling this function. If munging | |
3202 happened, DID_MUNGE will be non-zero; otherwise, it will be left alone. | |
3203 */ | |
428 | 3204 |
3205 static Lisp_Object | |
3206 munge_keymap_translate (struct command_builder *builder, | |
3207 enum munge_me_out_the_door munge, | |
771 | 3208 int has_normal_binding_p, int *did_munge) |
428 | 3209 { |
3210 Lisp_Object suffix; | |
3211 | |
1204 | 3212 EVENT_CHAIN_LOOP (suffix, builder->first_mungeable_event[munge]) |
428 | 3213 { |
3214 Lisp_Object result = munging_key_map_event_binding (suffix, munge); | |
3215 | |
3216 if (NILP (result)) | |
3217 continue; | |
3218 | |
3219 if (KEYMAPP (result)) | |
3220 { | |
3221 if (NILP (builder->last_non_munged_event) | |
3222 && !has_normal_binding_p) | |
3223 builder->last_non_munged_event = builder->most_current_event; | |
3224 } | |
3225 else | |
3226 builder->last_non_munged_event = Qnil; | |
3227 | |
3228 if (!KEYMAPP (result) && | |
3229 !VECTORP (result) && | |
3230 !STRINGP (result)) | |
3231 { | |
3232 struct gcpro gcpro1; | |
3233 GCPRO1 (suffix); | |
3234 result = call1 (result, Qnil); | |
3235 UNGCPRO; | |
3236 if (NILP (result)) | |
3237 return Qnil; | |
3238 } | |
3239 | |
3240 if (KEYMAPP (result)) | |
3241 return result; | |
3242 | |
3243 if (VECTORP (result) || STRINGP (result)) | |
3244 { | |
3245 Lisp_Object new_chain = key_sequence_to_event_chain (result); | |
3246 Lisp_Object tempev; | |
3247 | |
3248 /* If the first_mungeable_event of the other munger is | |
3249 within the events we're munging, then it will point to | |
3250 deallocated events afterwards, which is bad -- so make it | |
3251 point at the beginning of the munged events. */ | |
3252 EVENT_CHAIN_LOOP (tempev, suffix) | |
3253 { | |
3254 Lisp_Object *mungeable_event = | |
1204 | 3255 &builder->first_mungeable_event[1 - munge]; |
428 | 3256 if (EQ (tempev, *mungeable_event)) |
3257 { | |
3258 *mungeable_event = new_chain; | |
3259 break; | |
3260 } | |
3261 } | |
3262 | |
771 | 3263 /* Now munge the current event chain in the command builder. */ |
428 | 3264 command_builder_replace_suffix (builder, suffix, new_chain); |
1204 | 3265 builder->first_mungeable_event[munge] = Qnil; |
771 | 3266 |
3267 *did_munge = 1; | |
428 | 3268 |
793 | 3269 return command_builder_find_leaf_1 (builder); |
428 | 3270 } |
3271 | |
563 | 3272 signal_error (Qinvalid_key_binding, |
3273 (munge == MUNGE_ME_FUNCTION_KEY ? | |
3274 "Invalid binding in function-key-map" : | |
3275 "Invalid binding in key-translation-map"), | |
3276 result); | |
428 | 3277 } |
3278 | |
3279 return Qnil; | |
3280 } | |
3281 | |
2828 | 3282 /* Same as command_builder_find_leaf() below, but without offering the |
3283 platform-specific event code the opportunity to give a default binding of | |
3284 an unseen keysym to self-insert-command, and without the fallback to | |
3285 other keymaps for lookups that allows someone with a Cyrillic keyboard | |
3286 to pretend it's Qwerty for C-x C-f, for example. */ | |
771 | 3287 |
428 | 3288 static Lisp_Object |
2828 | 3289 command_builder_find_leaf_no_jit_binding (struct command_builder *builder, |
771 | 3290 int allow_misc_user_events_p, |
3291 int *did_munge) | |
428 | 3292 { |
3293 /* This function can GC */ | |
3294 Lisp_Object result; | |
3295 Lisp_Object evee = builder->current_events; | |
3296 | |
3297 if (XEVENT_TYPE (evee) == misc_user_event) | |
3298 { | |
3299 if (allow_misc_user_events_p && (NILP (XEVENT_NEXT (evee)))) | |
1204 | 3300 return list2 (XEVENT_EVAL_FUNCTION (evee), |
3301 XEVENT_EVAL_OBJECT (evee)); | |
428 | 3302 else |
3303 return Qnil; | |
3304 } | |
3305 | |
442 | 3306 /* if we're currently in a menu accelerator, check there for further |
3307 events */ | |
3308 /* #### fuck me! who wrote this crap? think "abstraction", baby. */ | |
771 | 3309 /* #### this horribly-written crap can mess with global state, which |
3310 this function should not do. i'm not fixing it now. someone | |
3311 needs to go and rewrite that shit correctly. --ben */ | |
1268 | 3312 #if defined (HAVE_X_WINDOWS) && defined (LWLIB_MENUBARS_LUCID) |
442 | 3313 if (x_kludge_lw_menu_active ()) |
428 | 3314 { |
3315 return command_builder_operate_menu_accelerator (builder); | |
3316 } | |
3317 else | |
3318 { | |
3319 result = Qnil; | |
3320 if (EQ (Vmenu_accelerator_enabled, Qmenu_force)) | |
3321 result = command_builder_find_menu_accelerator (builder); | |
3322 if (NILP (result)) | |
3323 #endif | |
3324 result = command_builder_find_leaf_1 (builder); | |
1268 | 3325 #if defined (HAVE_X_WINDOWS) && defined (LWLIB_MENUBARS_LUCID) |
428 | 3326 if (NILP (result) |
3327 && EQ (Vmenu_accelerator_enabled, Qmenu_fallback)) | |
3328 result = command_builder_find_menu_accelerator (builder); | |
3329 } | |
3330 #endif | |
3331 | |
3332 /* Check to see if we have a potential function-key-map match. */ | |
3333 if (NILP (result)) | |
771 | 3334 result = munge_keymap_translate (builder, MUNGE_ME_FUNCTION_KEY, 0, |
3335 did_munge); | |
3336 | |
428 | 3337 /* Check to see if we have a potential key-translation-map match. */ |
3338 { | |
3339 Lisp_Object key_translate_result = | |
3340 munge_keymap_translate (builder, MUNGE_ME_KEY_TRANSLATION, | |
771 | 3341 !NILP (result), did_munge); |
428 | 3342 if (!NILP (key_translate_result)) |
771 | 3343 result = key_translate_result; |
428 | 3344 } |
3345 | |
3346 if (!NILP (result)) | |
3347 return result; | |
3348 | |
3349 /* If key-sequence wasn't bound, we'll try some fallbacks. */ | |
3350 | |
3351 /* If we didn't find a binding, and the last event in the sequence is | |
3352 a shifted character, then try again with the lowercase version. */ | |
3353 | |
3354 if (XEVENT_TYPE (builder->most_current_event) == key_press_event | |
3355 && !NILP (Vretry_undefined_key_binding_unshifted)) | |
3356 { | |
1204 | 3357 if (event_upshifted_p (builder->most_current_event)) |
428 | 3358 { |
771 | 3359 Lisp_Object neubauten = copy_command_builder (builder, 0); |
3360 struct command_builder *neub = XCOMMAND_BUILDER (neubauten); | |
3361 struct gcpro gcpro1; | |
3362 | |
3363 GCPRO1 (neubauten); | |
1204 | 3364 downshift_event (event_chain_tail (neub->current_events)); |
771 | 3365 result = |
2828 | 3366 command_builder_find_leaf_no_jit_binding |
771 | 3367 (neub, allow_misc_user_events_p, did_munge); |
3368 | |
428 | 3369 if (!NILP (result)) |
771 | 3370 { |
3371 copy_command_builder (neub, builder); | |
3372 *did_munge = 1; | |
3373 } | |
3374 free_command_builder (neub); | |
3375 UNGCPRO; | |
3376 if (!NILP (result)) | |
428 | 3377 return result; |
3378 } | |
3379 } | |
3380 | |
3381 /* help-char is `auto-bound' in every keymap */ | |
3382 if (!NILP (Vprefix_help_command) && | |
1204 | 3383 event_matches_key_specifier_p (builder->most_current_event, Vhelp_char)) |
428 | 3384 return Vprefix_help_command; |
3385 | |
771 | 3386 return Qnil; |
3387 } | |
3388 | |
3389 /* Compare the current state of the command builder against the local and | |
3390 global keymaps, and return the binding. If there is no match, try again, | |
3391 case-insensitively. The return value will be one of: | |
3392 -- nil (there is no binding) | |
3393 -- a keymap (part of a command has been specified) | |
3394 -- a command (anything that satisfies `commandp'; this includes | |
3395 some symbols, lists, subrs, strings, vectors, and | |
3396 compiled-function objects) | |
3397 | |
3398 This may "munge" the current event chain in the command builder; | |
3399 i.e. the sequence might be mutated into a different sequence, | |
3400 which we then pretend is what the user actually typed instead of | |
3401 the passed-in sequence. This happens as a result of: | |
3402 | |
3403 -- key-translation-map changes | |
3404 -- function-key-map changes | |
3405 -- retry-undefined-key-binding-unshifted (q.v.) | |
3406 -- "Russian C-x problem" changes (see definition of struct key_data, | |
3407 events.h) | |
3408 | |
3409 DID_MUNGE must be initialized before calling this function. If munging | |
3410 happened, DID_MUNGE will be non-zero; otherwise, it will be left alone. | |
2828 | 3411 |
3412 (The above was Ben, I think.) | |
3413 | |
3414 It might be nice to have lookup-key call this function, directly or | |
3415 indirectly. Though it is arguably the right thing if lookup-key fails on | |
3416 a keysym that the X11 event code hasn't seen. There's no way to know if | |
3417 that keysym is generatable by the keyboard until it's generated, | |
3418 therefore there's no reasonable expectation that it be bound before it's | |
3419 generated--all the other default bindings depend on our knowing the | |
3420 keyboard layout and relying on it. And describe-key works without it, so | |
3421 I think we're fine. | |
3422 | |
3423 Some weirdness with this code--try this on a keyboard where X11 will | |
3424 produce ediaeresis with dead-diaeresis and e, but it's not produced by | |
3425 any other combination of keys on the keyboard; | |
3426 | |
3427 (defun ding-command () | |
3428 (interactive) | |
3429 (ding)) | |
3430 | |
3431 (define-key global-map 'ediaeresis 'ding-command) | |
3432 | |
3433 Now, pressing dead-diaeresis and then e will ding. Next; | |
3434 | |
3435 (define-key global-map 'ediaeresis 'self-insert-command) | |
3436 | |
3437 and press dead-diaeresis and then e. It'll give you "Invalid argument: | |
3438 typed key has no ASCII equivalent" Then; | |
3439 | |
3440 (define-key global-map 'ediaeresis nil) | |
3441 | |
3442 and press the combination again; it'll self-insert. The moral of the | |
3443 story is, if you want to suppress all bindings to a non-ASCII X11 key, | |
3444 bind it to a trivial no-op command, because the automatic mapping to | |
3445 self-insert-command will happen if there's no existing binding for the | |
3446 symbol. I can't see a way around this. -- Aidan Kehoe, 2005-05-14 */ | |
771 | 3447 |
3448 static Lisp_Object | |
3449 command_builder_find_leaf (struct command_builder *builder, | |
3450 int allow_misc_user_events_p, | |
3451 int *did_munge) | |
3452 { | |
3453 Lisp_Object result = | |
2828 | 3454 command_builder_find_leaf_no_jit_binding |
771 | 3455 (builder, allow_misc_user_events_p, did_munge); |
2828 | 3456 Lisp_Object event, console, channel, lookup_res; |
3457 int redolookup = 0, i; | |
771 | 3458 |
3459 if (!NILP (result)) | |
3460 return result; | |
3461 | |
2828 | 3462 /* If some of the events are keyboard events, and this is the first time |
3463 the platform event code has seen their keysyms--which will be the case | |
3464 the first time we see a composed keysym on X11, for example--offer it | |
3465 the chance to define them as a self-insert-command, and do the lookup | |
3466 again. | |
3467 | |
3468 This isn't Mule-specific; in a world where x-iso8859-1.el is gone, it's | |
3469 needed for non-Mule too. | |
3470 | |
3471 Probably this can just be limited to the checking the last | |
3472 keypress. */ | |
3473 | |
3474 EVENT_CHAIN_LOOP (event, builder->current_events) | |
3475 { | |
3476 /* We can ignore key release events because the preceding presses will | |
3477 have initiated the mapping. */ | |
3478 if (key_press_event != XEVENT_TYPE (event)) | |
3479 continue; | |
3480 | |
3481 channel = XEVENT_CHANNEL (event); | |
3482 if (object_dead_p (channel)) | |
3483 continue; | |
3484 | |
3485 console = CDFW_CONSOLE (channel); | |
3486 if (NILP (console)) | |
3487 console = Vselected_console; | |
3488 | |
3489 if (CONSOLE_LIVE_P(XCONSOLE(console))) | |
3490 { | |
3491 lookup_res = MAYBE_LISP_CONMETH(XCONSOLE(console), | |
3492 perhaps_init_unseen_key_defaults, | |
3493 (XCONSOLE(console), | |
3494 XEVENT_KEY_KEYSYM(event))); | |
3495 if (EQ(lookup_res, Qt)) | |
3496 { | |
3497 redolookup += 1; | |
3498 } | |
3499 } | |
3500 } | |
3501 | |
3502 if (redolookup) | |
428 | 3503 { |
2828 | 3504 result = command_builder_find_leaf_no_jit_binding |
3505 (builder, allow_misc_user_events_p, did_munge); | |
3506 if (!NILP (result)) | |
3507 { | |
3508 return result; | |
3509 } | |
3510 } | |
3511 | |
3512 /* The old composed-character-default-binding handling that used to be | |
3513 here was wrong--if a user wants to bind a given key to something other | |
3514 than self-insert-command, then they should go ahead and do it, we won't | |
3515 override it, and the sane thing to do with any key that has a known | |
3516 character correspondence is _always_ to default it to | |
3517 self-insert-command, nothing else. | |
3518 | |
3519 I'm adding the variable to control whether "Russian C-x processing" is | |
3520 used because I have a feeling that it's not always the most appropriate | |
3521 thing to do--in cases where people are using a non-Qwerty | |
3522 Roman-alphabet layout, do they really want C-x with some random letter | |
3523 to call `switch-to-buffer'? I can imagine that being very confusing, | |
3524 certainly for new users, and it might be that defaulting the value for | |
3525 `try-alternate-layouts-for-commands' as part of the language | |
3526 environment is the right thing to do, only defaulting to `t' for those | |
3527 languages that don't use the Roman alphabet. | |
3528 | |
3529 Much of that reasoning is tentative on my part, and feel free to change | |
3530 this code if you have more experience with the problem and an intuition | |
3531 that differs from mine. (Aidan Kehoe, 2005-05-29)*/ | |
3532 | |
3533 if (!try_alternate_layouts_for_commands) | |
3534 { | |
3535 return Qnil; | |
428 | 3536 } |
2828 | 3537 |
3538 if (key_press_event == XEVENT_TYPE (builder->most_current_event)) | |
3539 { | |
3540 Lisp_Object ev = builder->most_current_event, newbuilder; | |
3541 Ichar this_alternative; | |
3542 | |
3543 struct command_builder *newb; | |
3544 struct gcpro gcpro1; | |
3545 | |
3546 /* Ignore the value for CURRENT_LANGENV, because we've checked it | |
3547 already, above. */ | |
3548 for (i = KEYCHAR_CURRENT_LANGENV, ++i; i < KEYCHAR_LAST; ++i) | |
3549 { | |
3550 this_alternative = XEVENT_KEY_ALT_KEYCHARS(ev, i); | |
3551 | |
3552 if (0 == this_alternative) | |
3553 continue; | |
3554 | |
3555 newbuilder = copy_command_builder(builder, 0); | |
3556 GCPRO1(newbuilder); | |
3557 | |
3558 newb = XCOMMAND_BUILDER(newbuilder); | |
3559 | |
2830 | 3560 XSET_EVENT_KEY_KEYSYM(event_chain_tail |
3561 (XCOMMAND_BUILDER(newbuilder)->current_events), | |
2828 | 3562 make_char(this_alternative)); |
3563 | |
3564 result = command_builder_find_leaf_no_jit_binding | |
3565 (newb, allow_misc_user_events_p, did_munge); | |
3566 | |
3567 if (!NILP (result)) | |
3568 { | |
3569 copy_command_builder (newb, builder); | |
3570 *did_munge = 1; | |
3571 } | |
2830 | 3572 else if (event_upshifted_p |
3573 (XCOMMAND_BUILDER(newbuilder)->most_current_event) && | |
2828 | 3574 !NILP (Vretry_undefined_key_binding_unshifted) |
3575 && isascii(this_alternative)) | |
3576 { | |
2830 | 3577 downshift_event (event_chain_tail |
3578 (XCOMMAND_BUILDER(newbuilder)->current_events)); | |
3579 XSET_EVENT_KEY_KEYSYM(event_chain_tail | |
3580 (newb->current_events), | |
2828 | 3581 make_char(tolower(this_alternative))); |
3582 result = command_builder_find_leaf_no_jit_binding | |
3583 (newb, allow_misc_user_events_p, did_munge); | |
3584 } | |
3585 | |
3586 free_command_builder (newb); | |
3587 UNGCPRO; | |
3588 | |
3589 if (!NILP (result)) | |
3590 return result; | |
3591 } | |
3592 } | |
428 | 3593 |
3594 return Qnil; | |
3595 } | |
3596 | |
771 | 3597 /* Like command_builder_find_leaf but update this-command-keys and the |
3598 echo area as necessary when the current event chain was munged. */ | |
3599 | |
3600 static Lisp_Object | |
3601 command_builder_find_leaf_and_update_global_state (struct command_builder * | |
3602 builder, | |
3603 int | |
3604 allow_misc_user_events_p) | |
3605 { | |
3606 int did_munge = 0; | |
3607 int orig_length = event_chain_count (builder->current_events); | |
3608 Lisp_Object result = command_builder_find_leaf (builder, | |
3609 allow_misc_user_events_p, | |
3610 &did_munge); | |
3611 | |
3612 if (did_munge) | |
3613 { | |
3614 int tck_length = event_chain_count (Vthis_command_keys); | |
3615 | |
3616 /* We just assume that the events we just replaced are | |
3617 sitting in copied form at the end of this-command-keys. | |
3618 If the user did weird things with `dispatch-event' this | |
3619 may not be the case, but at least we make sure we won't | |
3620 crash. */ | |
3621 | |
3622 if (tck_length >= orig_length) | |
3623 { | |
3624 Lisp_Object new_chain = | |
3625 copy_event_chain (builder->current_events); | |
3626 this_command_keys_replace_suffix | |
3627 (event_chain_nth (Vthis_command_keys, tck_length - orig_length), | |
3628 new_chain); | |
3629 | |
3630 regenerate_echo_keys_from_this_command_keys (builder); | |
3631 } | |
3632 } | |
3633 | |
3634 if (NILP (result)) | |
3635 { | |
3636 /* If we read extra events attempting to match a function key but end | |
3637 up failing, then we release those events back to the command loop | |
3638 and fail on the original lookup. The released events will then be | |
3639 reprocessed in the context of the first part having failed. */ | |
3640 if (!NILP (builder->last_non_munged_event)) | |
3641 { | |
3642 Lisp_Object event0 = builder->last_non_munged_event; | |
3643 | |
3644 /* Put the commands back on the event queue. */ | |
3645 enqueue_event_chain (XEVENT_NEXT (event0), | |
3646 &command_event_queue, | |
3647 &command_event_queue_tail); | |
3648 | |
3649 /* Then remove them from the command builder. */ | |
3650 XSET_EVENT_NEXT (event0, Qnil); | |
3651 builder->most_current_event = event0; | |
3652 builder->last_non_munged_event = Qnil; | |
3653 } | |
3654 } | |
3655 | |
3656 return result; | |
3657 } | |
428 | 3658 |
3659 /* Every time a command-event (a key, button, or menu selection) is read by | |
3660 Fnext_event(), it is stored in the recent_keys_ring, in Vlast_input_event, | |
3661 and in Vthis_command_keys. (Eval-events are not stored there.) | |
3662 | |
3663 Every time a command is invoked, Vlast_command_event is set to the last | |
3664 event in the sequence. | |
3665 | |
3666 This means that Vthis_command_keys is really about "input read since the | |
3667 last command was executed" rather than about "what keys invoked this | |
3668 command." This is a little counterintuitive, but that's the way it | |
3669 has always worked. | |
3670 | |
3671 As an extra kink, the function read-key-sequence resets/updates the | |
3672 last-command-event and this-command-keys. It doesn't append to the | |
3673 command-keys as read-char does. Such are the pitfalls of having to | |
3674 maintain compatibility with a program for which the only specification | |
3675 is the code itself. | |
3676 | |
3677 (We could implement recent_keys_ring and Vthis_command_keys as the same | |
3678 data structure.) | |
3679 */ | |
3680 | |
3681 DEFUN ("recent-keys", Frecent_keys, 0, 1, 0, /* | |
3682 Return a vector of recent keyboard or mouse button events read. | |
3683 If NUMBER is non-nil, not more than NUMBER events will be returned. | |
3684 Change number of events stored using `set-recent-keys-ring-size'. | |
3685 | |
3686 This copies the event objects into a new vector; it is safe to keep and | |
3687 modify them. | |
3688 */ | |
3689 (number)) | |
3690 { | |
3691 struct gcpro gcpro1; | |
3692 Lisp_Object val = Qnil; | |
3693 int nwanted; | |
3694 int start, nkeys, i, j; | |
3695 GCPRO1 (val); | |
3696 | |
3697 if (NILP (number)) | |
3698 nwanted = recent_keys_ring_size; | |
3699 else | |
3700 { | |
3701 CHECK_NATNUM (number); | |
3702 nwanted = XINT (number); | |
3703 } | |
3704 | |
3705 /* Create the keys ring vector, if none present. */ | |
3706 if (NILP (Vrecent_keys_ring)) | |
3707 { | |
3708 Vrecent_keys_ring = make_vector (recent_keys_ring_size, Qnil); | |
3709 /* And return nothing in particular. */ | |
446 | 3710 RETURN_UNGCPRO (make_vector (0, Qnil)); |
428 | 3711 } |
3712 | |
3713 if (NILP (XVECTOR_DATA (Vrecent_keys_ring)[recent_keys_ring_index])) | |
3714 /* This means the vector has not yet wrapped */ | |
3715 { | |
3716 nkeys = recent_keys_ring_index; | |
3717 start = 0; | |
3718 } | |
3719 else | |
3720 { | |
3721 nkeys = recent_keys_ring_size; | |
3722 start = ((recent_keys_ring_index == nkeys) ? 0 : recent_keys_ring_index); | |
3723 } | |
3724 | |
3725 if (nwanted < nkeys) | |
3726 { | |
3727 start += nkeys - nwanted; | |
3728 if (start >= recent_keys_ring_size) | |
3729 start -= recent_keys_ring_size; | |
3730 nkeys = nwanted; | |
3731 } | |
3732 else | |
3733 nwanted = nkeys; | |
3734 | |
3735 val = make_vector (nwanted, Qnil); | |
3736 | |
3737 for (i = 0, j = start; i < nkeys; i++) | |
3738 { | |
3739 Lisp_Object e = XVECTOR_DATA (Vrecent_keys_ring)[j]; | |
3740 | |
3741 if (NILP (e)) | |
2500 | 3742 ABORT (); |
428 | 3743 XVECTOR_DATA (val)[i] = Fcopy_event (e, Qnil); |
3744 if (++j >= recent_keys_ring_size) | |
3745 j = 0; | |
3746 } | |
3747 UNGCPRO; | |
3748 return val; | |
3749 } | |
3750 | |
3751 | |
3752 DEFUN ("recent-keys-ring-size", Frecent_keys_ring_size, 0, 0, 0, /* | |
3753 The maximum number of events `recent-keys' can return. | |
3754 */ | |
3755 ()) | |
3756 { | |
3757 return make_int (recent_keys_ring_size); | |
3758 } | |
3759 | |
3760 DEFUN ("set-recent-keys-ring-size", Fset_recent_keys_ring_size, 1, 1, 0, /* | |
3761 Set the maximum number of events to be stored internally. | |
3762 */ | |
3763 (size)) | |
3764 { | |
3765 Lisp_Object new_vector = Qnil; | |
3766 int i, j, nkeys, start, min; | |
3767 struct gcpro gcpro1; | |
3768 | |
3769 CHECK_INT (size); | |
3770 if (XINT (size) <= 0) | |
563 | 3771 invalid_argument ("Recent keys ring size must be positive", size); |
428 | 3772 if (XINT (size) == recent_keys_ring_size) |
3773 return size; | |
3774 | |
446 | 3775 GCPRO1 (new_vector); |
428 | 3776 new_vector = make_vector (XINT (size), Qnil); |
3777 | |
3778 if (NILP (Vrecent_keys_ring)) | |
3779 { | |
3780 Vrecent_keys_ring = new_vector; | |
446 | 3781 RETURN_UNGCPRO (size); |
428 | 3782 } |
3783 | |
3784 if (NILP (XVECTOR_DATA (Vrecent_keys_ring)[recent_keys_ring_index])) | |
3785 /* This means the vector has not yet wrapped */ | |
3786 { | |
3787 nkeys = recent_keys_ring_index; | |
3788 start = 0; | |
3789 } | |
3790 else | |
3791 { | |
3792 nkeys = recent_keys_ring_size; | |
3793 start = ((recent_keys_ring_index == nkeys) ? 0 : recent_keys_ring_index); | |
3794 } | |
3795 | |
3796 if (XINT (size) > nkeys) | |
3797 min = nkeys; | |
3798 else | |
3799 min = XINT (size); | |
3800 | |
3801 for (i = 0, j = start; i < min; i++) | |
3802 { | |
3803 XVECTOR_DATA (new_vector)[i] = XVECTOR_DATA (Vrecent_keys_ring)[j]; | |
3804 if (++j >= recent_keys_ring_size) | |
3805 j = 0; | |
3806 } | |
3807 recent_keys_ring_size = XINT (size); | |
3808 recent_keys_ring_index = (i < recent_keys_ring_size) ? i : 0; | |
3809 | |
3810 Vrecent_keys_ring = new_vector; | |
3811 | |
3812 UNGCPRO; | |
3813 return size; | |
3814 } | |
3815 | |
3816 /* Vthis_command_keys having value Qnil means that the next time | |
3817 push_this_command_keys is called, it should start over. | |
3818 The times at which the command-keys are reset | |
3819 (instead of merely being augmented) are pretty counterintuitive. | |
3820 (More specifically: | |
3821 | |
3822 -- We do not reset this-command-keys when we finish reading a | |
3823 command. This is because some commands (e.g. C-u) act | |
3824 like command prefixes; they signal this by setting prefix-arg | |
3825 to non-nil. | |
3826 -- Therefore, we reset this-command-keys when we finish | |
3827 executing a command, unless prefix-arg is set. | |
3828 -- However, if we ever do a non-local exit out of a command | |
3829 loop (e.g. an error in a command), we need to reset | |
3830 this-command-keys. We do this by calling reset_this_command_keys() | |
3831 from cmdloop.c, whenever an error causes an invocation of the | |
3832 default error handler, and whenever there's a throw to top-level.) | |
3833 */ | |
3834 | |
3835 void | |
3836 reset_this_command_keys (Lisp_Object console, int clear_echo_area_p) | |
3837 { | |
757 | 3838 if (!NILP (console)) |
3839 { | |
3840 /* console is nil if we just deleted the console as a result of C-x 5 | |
3841 0. Unfortunately things are currently in a messy situation where | |
3842 some stuff is console-local and other stuff isn't, so we need to | |
3843 do everything that's not console-local. */ | |
3844 struct command_builder *command_builder = | |
3845 XCOMMAND_BUILDER (XCONSOLE (console)->command_builder); | |
3846 | |
3847 reset_key_echo (command_builder, clear_echo_area_p); | |
3848 reset_current_events (command_builder); | |
3849 } | |
3850 else | |
3851 reset_key_echo (0, clear_echo_area_p); | |
428 | 3852 |
3853 deallocate_event_chain (Vthis_command_keys); | |
3854 Vthis_command_keys = Qnil; | |
3855 Vthis_command_keys_tail = Qnil; | |
3856 } | |
3857 | |
3858 static void | |
3859 push_this_command_keys (Lisp_Object event) | |
3860 { | |
3025 | 3861 Lisp_Object new_ = Fmake_event (Qnil, Qnil); |
3862 | |
3863 Fcopy_event (event, new_); | |
3864 enqueue_event (new_, &Vthis_command_keys, &Vthis_command_keys_tail); | |
428 | 3865 } |
3866 | |
3867 /* The following two functions are used in call-interactively, | |
3868 for the @ and e specifications. We used to just use | |
3869 `current-mouse-event' (i.e. the last mouse event in this-command-keys), | |
3870 but FSF does it more generally so we follow their lead. */ | |
3871 | |
3872 Lisp_Object | |
3873 extract_this_command_keys_nth_mouse_event (int n) | |
3874 { | |
3875 Lisp_Object event; | |
3876 | |
3877 EVENT_CHAIN_LOOP (event, Vthis_command_keys) | |
3878 { | |
3879 if (EVENTP (event) | |
3880 && (XEVENT_TYPE (event) == button_press_event | |
3881 || XEVENT_TYPE (event) == button_release_event | |
3882 || XEVENT_TYPE (event) == misc_user_event)) | |
3883 { | |
3884 if (!n) | |
3885 { | |
2500 | 3886 /* must copy to avoid an ABORT() in next_event_internal() */ |
428 | 3887 if (!NILP (XEVENT_NEXT (event))) |
3888 return Fcopy_event (event, Qnil); | |
3889 else | |
3890 return event; | |
3891 } | |
3892 n--; | |
3893 } | |
3894 } | |
3895 | |
3896 return Qnil; | |
3897 } | |
3898 | |
3899 Lisp_Object | |
3900 extract_vector_nth_mouse_event (Lisp_Object vector, int n) | |
3901 { | |
3902 int i; | |
3903 int len = XVECTOR_LENGTH (vector); | |
3904 | |
3905 for (i = 0; i < len; i++) | |
3906 { | |
3907 Lisp_Object event = XVECTOR_DATA (vector)[i]; | |
3908 if (EVENTP (event)) | |
3909 switch (XEVENT_TYPE (event)) | |
3910 { | |
3911 case button_press_event : | |
3912 case button_release_event : | |
3913 case misc_user_event : | |
3914 if (n == 0) | |
3915 return event; | |
3916 n--; | |
3917 break; | |
3918 default: | |
3919 continue; | |
3920 } | |
3921 } | |
3922 | |
3923 return Qnil; | |
3924 } | |
3925 | |
3926 static void | |
3927 push_recent_keys (Lisp_Object event) | |
3928 { | |
3929 Lisp_Object e; | |
3930 | |
3931 if (NILP (Vrecent_keys_ring)) | |
3932 Vrecent_keys_ring = make_vector (recent_keys_ring_size, Qnil); | |
3933 | |
3934 e = XVECTOR_DATA (Vrecent_keys_ring) [recent_keys_ring_index]; | |
3935 | |
3936 if (NILP (e)) | |
3937 { | |
3938 e = Fmake_event (Qnil, Qnil); | |
3939 XVECTOR_DATA (Vrecent_keys_ring) [recent_keys_ring_index] = e; | |
3940 } | |
3941 Fcopy_event (event, e); | |
3942 if (++recent_keys_ring_index == recent_keys_ring_size) | |
3943 recent_keys_ring_index = 0; | |
3944 } | |
3945 | |
3946 | |
3947 static Lisp_Object | |
3948 current_events_into_vector (struct command_builder *command_builder) | |
3949 { | |
3950 Lisp_Object vector; | |
3951 Lisp_Object event; | |
3952 int n = event_chain_count (command_builder->current_events); | |
3953 | |
3954 /* Copy the vector and the events in it. */ | |
3955 /* No need to copy the events, since they're already copies, and | |
3956 nobody other than the command-builder has pointers to them */ | |
3957 vector = make_vector (n, Qnil); | |
3958 n = 0; | |
3959 EVENT_CHAIN_LOOP (event, command_builder->current_events) | |
3960 XVECTOR_DATA (vector)[n++] = event; | |
3961 reset_command_builder_event_chain (command_builder); | |
3962 return vector; | |
3963 } | |
3964 | |
3965 | |
3966 /* | |
3967 Given the current state of the command builder and a new command event | |
3968 that has just been dispatched: | |
3969 | |
3970 -- add the event to the event chain forming the current command | |
3971 (doing meta-translation as necessary) | |
3972 -- return the binding of this event chain; this will be one of: | |
3973 -- nil (there is no binding) | |
3974 -- a keymap (part of a command has been specified) | |
3975 -- a command (anything that satisfies `commandp'; this includes | |
3976 some symbols, lists, subrs, strings, vectors, and | |
3977 compiled-function objects) | |
3978 */ | |
3979 static Lisp_Object | |
3980 lookup_command_event (struct command_builder *command_builder, | |
3981 Lisp_Object event, int allow_misc_user_events_p) | |
3982 { | |
3983 /* This function can GC */ | |
3984 struct frame *f = selected_frame (); | |
3985 /* Clear output from previous command execution */ | |
3986 if (!EQ (Qcommand, echo_area_status (f)) | |
3987 /* but don't let mouse-up clear what mouse-down just printed */ | |
3988 && (XEVENT (event)->event_type != button_release_event)) | |
3989 clear_echo_area (f, Qnil, 0); | |
3990 | |
3991 /* Add the given event to the command builder. | |
3992 Extra hack: this also updates the recent_keys_ring and Vthis_command_keys | |
3993 vectors to translate "ESC x" to "M-x" (for any "x" of course). | |
3994 */ | |
3995 { | |
3996 Lisp_Object recent = command_builder->most_current_event; | |
3997 | |
3998 if (EVENTP (recent) | |
1204 | 3999 && event_matches_key_specifier_p (recent, Vmeta_prefix_char)) |
428 | 4000 { |
440 | 4001 Lisp_Event *e; |
428 | 4002 /* When we see a sequence like "ESC x", pretend we really saw "M-x". |
4003 DoubleThink the recent-keys and this-command-keys as well. */ | |
4004 | |
4005 /* Modify the previous most-recently-pushed event on the command | |
4006 builder to be a copy of this one with the meta-bit set instead of | |
4007 pushing a new event. | |
4008 */ | |
4009 Fcopy_event (event, recent); | |
4010 e = XEVENT (recent); | |
934 | 4011 if (EVENT_TYPE (e) == key_press_event) |
1204 | 4012 SET_EVENT_KEY_MODIFIERS (e, EVENT_KEY_MODIFIERS (e) | |
4013 XEMACS_MOD_META); | |
934 | 4014 else if (EVENT_TYPE (e) == button_press_event |
4015 || EVENT_TYPE (e) == button_release_event) | |
1204 | 4016 SET_EVENT_BUTTON_MODIFIERS (e, EVENT_BUTTON_MODIFIERS (e) | |
4017 XEMACS_MOD_META); | |
428 | 4018 else |
2500 | 4019 ABORT (); |
428 | 4020 |
4021 { | |
4022 int tckn = event_chain_count (Vthis_command_keys); | |
4023 if (tckn >= 2) | |
4024 /* ??? very strange if it's < 2. */ | |
4025 this_command_keys_replace_suffix | |
4026 (event_chain_nth (Vthis_command_keys, tckn - 2), | |
4027 Fcopy_event (recent, Qnil)); | |
4028 } | |
4029 | |
4030 regenerate_echo_keys_from_this_command_keys (command_builder); | |
4031 } | |
4032 else | |
771 | 4033 command_builder_append_event (command_builder, event); |
428 | 4034 } |
4035 | |
4036 { | |
771 | 4037 Lisp_Object leaf = |
4038 command_builder_find_leaf_and_update_global_state | |
4039 (command_builder, | |
4040 allow_misc_user_events_p); | |
428 | 4041 struct gcpro gcpro1; |
4042 GCPRO1 (leaf); | |
4043 | |
4044 if (KEYMAPP (leaf)) | |
4045 { | |
442 | 4046 #if defined (HAVE_X_WINDOWS) && defined (LWLIB_MENUBARS_LUCID) |
4047 if (!x_kludge_lw_menu_active ()) | |
4048 #else | |
4049 if (1) | |
4050 #endif | |
428 | 4051 { |
4052 Lisp_Object prompt = Fkeymap_prompt (leaf, Qt); | |
4053 if (STRINGP (prompt)) | |
4054 { | |
4055 /* Append keymap prompt to key echo buffer */ | |
4056 int buf_index = command_builder->echo_buf_index; | |
4057 Bytecount len = XSTRING_LENGTH (prompt); | |
4058 | |
4059 if (len + buf_index + 1 <= command_builder->echo_buf_length) | |
4060 { | |
867 | 4061 Ibyte *echo = command_builder->echo_buf + buf_index; |
428 | 4062 memcpy (echo, XSTRING_DATA (prompt), len); |
4063 echo[len] = 0; | |
4064 } | |
4065 maybe_echo_keys (command_builder, 1); | |
4066 } | |
4067 else | |
4068 maybe_echo_keys (command_builder, 0); | |
4069 } | |
853 | 4070 /* #### i don't trust this at all. --ben */ |
4071 #if 0 | |
442 | 4072 else if (!NILP (Vquit_flag)) |
4073 { | |
4074 /* if quit happened during menu acceleration, pretend we read it */ | |
4075 struct console *con = XCONSOLE (Fselected_console ()); | |
1204 | 4076 |
4077 enqueue_command_event (Fcopy_event (CONSOLE_QUIT_EVENT (con), | |
4078 Qnil)); | |
442 | 4079 Vquit_flag = Qnil; |
4080 } | |
853 | 4081 #endif |
428 | 4082 } |
4083 else if (!NILP (leaf)) | |
4084 { | |
4085 if (EQ (Qcommand, echo_area_status (f)) | |
4086 && command_builder->echo_buf_index > 0) | |
4087 { | |
4088 /* If we had been echoing keys, echo the last one (without | |
4089 the trailing dash) and redisplay before executing the | |
4090 command. */ | |
4091 command_builder->echo_buf[command_builder->echo_buf_index] = 0; | |
4092 maybe_echo_keys (command_builder, 1); | |
4093 Fsit_for (Qzero, Qt); | |
4094 } | |
4095 } | |
4096 RETURN_UNGCPRO (leaf); | |
4097 } | |
4098 } | |
4099 | |
479 | 4100 static int |
4101 is_scrollbar_event (Lisp_Object event) | |
4102 { | |
516 | 4103 #ifdef HAVE_SCROLLBARS |
479 | 4104 Lisp_Object fun; |
4105 | |
934 | 4106 if (XEVENT_TYPE (event) != misc_user_event) |
4107 return 0; | |
1204 | 4108 fun = XEVENT_MISC_USER_FUNCTION (event); |
479 | 4109 |
4110 return (EQ (fun, Qscrollbar_line_up) || | |
4111 EQ (fun, Qscrollbar_line_down) || | |
4112 EQ (fun, Qscrollbar_page_up) || | |
4113 EQ (fun, Qscrollbar_page_down) || | |
4114 EQ (fun, Qscrollbar_to_top) || | |
4115 EQ (fun, Qscrollbar_to_bottom) || | |
4116 EQ (fun, Qscrollbar_vertical_drag) || | |
4117 EQ (fun, Qscrollbar_char_left) || | |
4118 EQ (fun, Qscrollbar_char_right) || | |
4119 EQ (fun, Qscrollbar_page_left) || | |
4120 EQ (fun, Qscrollbar_page_right) || | |
4121 EQ (fun, Qscrollbar_to_left) || | |
4122 EQ (fun, Qscrollbar_to_right) || | |
4123 EQ (fun, Qscrollbar_horizontal_drag)); | |
516 | 4124 #else |
4125 return 0; | |
4126 #endif /* HAVE_SCROLLBARS */ | |
479 | 4127 } |
4128 | |
428 | 4129 static void |
4130 execute_command_event (struct command_builder *command_builder, | |
4131 Lisp_Object event) | |
4132 { | |
4133 /* This function can GC */ | |
4134 struct console *con = XCONSOLE (command_builder->console); | |
4135 struct gcpro gcpro1; | |
4136 | |
4137 GCPRO1 (event); /* event may be freshly created */ | |
444 | 4138 |
479 | 4139 /* #### This call to is_scrollbar_event() isn't quite right, but |
4140 fixing properly it requires more work than can go into 21.4. | |
4141 (We really need to split out menu, scrollbar, dialog, and other | |
4142 types of events from misc-user, and put the remaining ones in a | |
4143 new `user-eval' type that behaves like an eval event but is a | |
4144 user event and thus has all of its semantics -- e.g. being | |
4145 delayed during `accept-process-output' and similar wait states.) | |
4146 | |
4147 The real issue here is that "user events" and "command events" | |
4148 are not the same thing, but are very much confused in | |
4149 event-stream.c. User events are, essentially, any event that | |
4150 should be delayed by accept-process-output, should terminate a | |
4151 sit-for, etc. -- basically, any event that needs to be processed | |
4152 synchronously with key and mouse events. Command events are | |
4153 those that participate in command building; scrollbar events | |
4154 clearly don't belong because they should be transparent in a | |
4155 sequence like C-x @ h <scrollbar-drag> x, which used to cause a | |
4156 crash before checks similar to the is_scrollbar_event() call were | |
4157 added. Do other events belong with scrollbar events? I'm not | |
4158 sure; we need to categorize all misc-user events and see what | |
4159 their semantics are. | |
4160 | |
4161 (You might ask, why do scrollbar events need to be user events? | |
4162 That's a good question. The answer seems to be that they can | |
4163 change point, and having this happen asynchronously would be a | |
4164 very bad idea. According to the "proper" functioning of | |
4165 scrollbars, this should not happen, but XEmacs does not allow | |
4166 point to go outside of the window.) | |
4167 | |
4168 Scrollbar events and similar non-command events should obviously | |
4169 not be recorded in this-command-keys, so we need to check for | |
4170 this in next-event. | |
4171 | |
4172 #### We call reset_current_events() twice in this function -- | |
4173 #### here, and later as a result of reset_this_command_keys(). | |
4174 #### This is almost certainly wrong; need to figure out what's | |
4175 #### correct. | |
4176 | |
4177 #### We need to figure out what's really correct w.r.t. scrollbar | |
4178 #### events. With these new fixes in, it actually works to do | |
4179 #### C-x <scrollbar-drag> 5 2, but the key echo gets messed up | |
4180 #### (starts over at 5). We really need to be special-casing | |
4181 #### scrollbar events at a lower level, and not really passing | |
4182 #### them through the command builder at all. (e.g. do scrollbar | |
4183 #### events belong in macros??? doubtful; probably only the | |
4184 #### point movement, if any, belongs, special-cased as a | |
4185 #### pseudo-issued M-x goto-char command). #### Need more work | |
4186 #### here. Do this when separating out scrollbar events. | |
4187 */ | |
4188 | |
4189 if (!is_scrollbar_event (event)) | |
444 | 4190 reset_current_events (command_builder); |
428 | 4191 |
4192 switch (XEVENT (event)->event_type) | |
4193 { | |
4194 case key_press_event: | |
4195 Vcurrent_mouse_event = Qnil; | |
4196 break; | |
4197 case button_press_event: | |
4198 case button_release_event: | |
4199 case misc_user_event: | |
4200 Vcurrent_mouse_event = Fcopy_event (event, Qnil); | |
4201 break; | |
4202 default: break; | |
4203 } | |
4204 | |
4205 /* Store the last-command-event. The semantics of this is that it | |
4206 is the last event most recently involved in command-lookup. */ | |
4207 if (!EVENTP (Vlast_command_event)) | |
4208 Vlast_command_event = Fmake_event (Qnil, Qnil); | |
4209 if (XEVENT (Vlast_command_event)->event_type == dead_event) | |
4210 { | |
4211 Vlast_command_event = Fmake_event (Qnil, Qnil); | |
563 | 4212 invalid_state ("Someone deallocated the last-command-event!", Qunbound); |
428 | 4213 } |
4214 | |
4215 if (! EQ (event, Vlast_command_event)) | |
4216 Fcopy_event (event, Vlast_command_event); | |
4217 | |
4218 /* Note that last-command-char will never have its high-bit set, in | |
4219 an effort to sidestep the ambiguity between M-x and oslash. */ | |
4220 Vlast_command_char = Fevent_to_character (Vlast_command_event, | |
2862 | 4221 Qnil, Qnil, Qnil); |
428 | 4222 |
4223 /* Actually call the command, with all sorts of hair to preserve or clear | |
4224 the echo-area and region as appropriate and call the pre- and post- | |
4225 command-hooks. */ | |
4226 { | |
4227 int old_kbd_macro = con->kbd_macro_end; | |
4228 struct window *w = XWINDOW (Fselected_window (Qnil)); | |
4229 | |
4230 /* We're executing a new command, so the old value is irrelevant. */ | |
4231 zmacs_region_stays = 0; | |
4232 | |
4233 /* If the previous command tried to force a specific window-start, | |
4234 reset the flag in case this command moves point far away from | |
4235 that position. Also, reset the window's buffer's change | |
4236 information so that we don't trigger an incremental update. */ | |
4237 if (w->force_start) | |
4238 { | |
4239 w->force_start = 0; | |
4240 buffer_reset_changes (XBUFFER (w->buffer)); | |
4241 } | |
4242 | |
4243 pre_command_hook (); | |
4244 | |
934 | 4245 if (XEVENT_TYPE (event) == misc_user_event) |
4246 { | |
1204 | 4247 call1 (XEVENT_MISC_USER_FUNCTION (event), |
4248 XEVENT_MISC_USER_OBJECT (event)); | |
934 | 4249 } |
428 | 4250 else |
4251 { | |
4252 Fcommand_execute (Vthis_command, Qnil, Qnil); | |
4253 } | |
4254 | |
4255 post_command_hook (); | |
4256 | |
757 | 4257 /* Console might have been deleted by command */ |
4258 if (CONSOLE_LIVE_P (con) && !NILP (con->prefix_arg)) | |
428 | 4259 { |
4260 /* Commands that set the prefix arg don't update last-command, don't | |
4261 reset the echoing state, and don't go into keyboard macros unless | |
444 | 4262 followed by another command. Also don't quit here. */ |
4263 int speccount = specpdl_depth (); | |
4264 specbind (Qinhibit_quit, Qt); | |
428 | 4265 maybe_echo_keys (command_builder, 0); |
771 | 4266 unbind_to (speccount); |
428 | 4267 |
4268 /* If we're recording a keyboard macro, and the last command | |
4269 executed set a prefix argument, then decrement the pointer to | |
4270 the "last character really in the macro" to be just before this | |
4271 command. This is so that the ^U in "^U ^X )" doesn't go onto | |
4272 the end of macro. */ | |
4273 if (!NILP (con->defining_kbd_macro)) | |
4274 con->kbd_macro_end = old_kbd_macro; | |
4275 } | |
4276 else | |
4277 { | |
4278 /* Start a new command next time */ | |
4279 Vlast_command = Vthis_command; | |
442 | 4280 Vlast_command_properties = Vthis_command_properties; |
4281 Vthis_command_properties = Qnil; | |
4282 | |
428 | 4283 /* Emacs 18 doesn't unconditionally clear the echoed keystrokes, |
4284 so we don't either */ | |
479 | 4285 |
4286 if (!is_scrollbar_event (event)) | |
771 | 4287 reset_this_command_keys (CONSOLE_LIVE_P (con) ? wrap_console (con) |
757 | 4288 : Qnil, 0); |
428 | 4289 } |
4290 } | |
4291 | |
4292 UNGCPRO; | |
4293 } | |
4294 | |
4295 /* Run the pre command hook. */ | |
4296 | |
4297 static void | |
4298 pre_command_hook (void) | |
4299 { | |
4300 last_point_position = BUF_PT (current_buffer); | |
793 | 4301 last_point_position_buffer = wrap_buffer (current_buffer); |
428 | 4302 /* This function can GC */ |
853 | 4303 safe_run_hook_trapping_problems |
1333 | 4304 (Qcommand, Qpre_command_hook, |
4305 INHIBIT_EXISTING_PERMANENT_DISPLAY_OBJECT_DELETION); | |
442 | 4306 |
4307 /* This is a kludge, but necessary; see simple.el */ | |
4308 call0 (Qhandle_pre_motion_command); | |
428 | 4309 } |
4310 | |
4311 /* Run the post command hook. */ | |
4312 | |
4313 static void | |
4314 post_command_hook (void) | |
4315 { | |
4316 /* This function can GC */ | |
4317 /* Turn off region highlighting unless this command requested that | |
4318 it be left on, or we're in the minibuffer. We don't turn it off | |
4319 when we're in the minibuffer so that things like M-x write-region | |
4320 still work! | |
4321 | |
4322 This could be done via a function on the post-command-hook, but | |
4323 we don't want the user to accidentally remove it. | |
4324 */ | |
4325 | |
4326 Lisp_Object win = Fselected_window (Qnil); | |
4327 | |
4328 /* If the last command deleted the frame, `win' might be nil. | |
4329 It seems safest to do nothing in this case. */ | |
442 | 4330 /* Note: Someone added the following comment and put #if 0's around |
4331 this code, not realizing that doing this invites a crash in the | |
4332 line after. */ | |
440 | 4333 /* #### This doesn't really fix the problem, |
428 | 4334 if delete-frame is called by some hook */ |
4335 if (NILP (win)) | |
4336 return; | |
442 | 4337 |
4338 /* This is a kludge, but necessary; see simple.el */ | |
4339 call0 (Qhandle_post_motion_command); | |
428 | 4340 |
4341 if (! zmacs_region_stays | |
4342 && (!MINI_WINDOW_P (XWINDOW (win)) | |
4343 || EQ (zmacs_region_buffer (), WINDOW_BUFFER (XWINDOW (win))))) | |
4344 zmacs_deactivate_region (); | |
4345 else | |
4346 zmacs_update_region (); | |
4347 | |
853 | 4348 safe_run_hook_trapping_problems |
1333 | 4349 (Qcommand, Qpost_command_hook, |
853 | 4350 INHIBIT_EXISTING_PERMANENT_DISPLAY_OBJECT_DELETION); |
4351 | |
4352 #if 0 /* FSF Emacs */ | |
4353 if (!NILP (current_buffer->mark_active)) | |
4354 { | |
4355 if (!NILP (Vdeactivate_mark) && !NILP (Vtransient_mark_mode)) | |
4356 { | |
4357 current_buffer->mark_active = Qnil; | |
4358 run_hook (intern ("deactivate-mark-hook")); | |
4359 } | |
4360 else if (current_buffer != prev_buffer || | |
4361 BUF_MODIFF (current_buffer) != prev_modiff) | |
4362 run_hook (intern ("activate-mark-hook")); | |
4363 } | |
4364 #endif /* FSF Emacs */ | |
428 | 4365 |
4366 /* #### Kludge!!! This is necessary to make sure that things | |
4367 are properly positioned even if post-command-hook moves point. | |
4368 #### There should be a cleaner way of handling this. */ | |
4369 call0 (Qauto_show_make_point_visible); | |
4370 } | |
4371 | |
4372 | |
4373 DEFUN ("dispatch-event", Fdispatch_event, 1, 1, 0, /* | |
444 | 4374 Given an event object EVENT as returned by `next-event', execute it. |
428 | 4375 |
4376 Key-press, button-press, and button-release events get accumulated | |
4377 until a complete key sequence (see `read-key-sequence') is reached, | |
4378 at which point the sequence is looked up in the current keymaps and | |
4379 acted upon. | |
4380 | |
4381 Mouse motion events cause the low-level handling function stored in | |
4382 `mouse-motion-handler' to be called. (There are very few circumstances | |
4383 under which you should change this handler. Use `mode-motion-hook' | |
4384 instead.) | |
4385 | |
4386 Menu, timeout, and eval events cause the associated function or handler | |
4387 to be called. | |
4388 | |
4389 Process events cause the subprocess's output to be read and acted upon | |
4390 appropriately (see `start-process'). | |
4391 | |
4392 Magic events are handled as necessary. | |
4393 */ | |
4394 (event)) | |
4395 { | |
4396 /* This function can GC */ | |
4397 struct command_builder *command_builder; | |
440 | 4398 Lisp_Event *ev; |
428 | 4399 Lisp_Object console; |
4400 Lisp_Object channel; | |
1292 | 4401 PROFILE_DECLARE (); |
428 | 4402 |
4403 CHECK_LIVE_EVENT (event); | |
4404 ev = XEVENT (event); | |
4405 | |
4406 /* events on dead channels get silently eaten */ | |
4407 channel = EVENT_CHANNEL (ev); | |
4408 if (object_dead_p (channel)) | |
4409 return Qnil; | |
4410 | |
1292 | 4411 PROFILE_RECORD_ENTERING_SECTION (Qdispatch_event); |
4412 | |
428 | 4413 /* Some events don't have channels (e.g. eval events). */ |
4414 console = CDFW_CONSOLE (channel); | |
4415 if (NILP (console)) | |
4416 console = Vselected_console; | |
4417 else if (!EQ (console, Vselected_console)) | |
4418 Fselect_console (console); | |
4419 | |
4420 command_builder = XCOMMAND_BUILDER (XCONSOLE (console)->command_builder); | |
934 | 4421 switch (XEVENT_TYPE (event)) |
428 | 4422 { |
4423 case button_press_event: | |
4424 case button_release_event: | |
4425 case key_press_event: | |
4426 { | |
4427 Lisp_Object leaf = lookup_command_event (command_builder, event, 1); | |
4428 | |
4429 if (KEYMAPP (leaf)) | |
4430 /* Incomplete key sequence */ | |
4431 break; | |
4432 if (NILP (leaf)) | |
4433 { | |
4434 /* At this point, we know that the sequence is not bound to a | |
4435 command. Normally, we beep and print a message informing the | |
4436 user of this. But we do not beep or print a message when: | |
4437 | |
4438 o the last event in this sequence is a mouse-up event; or | |
4439 o the last event in this sequence is a mouse-down event and | |
4440 there is a binding for the mouse-up version. | |
4441 | |
4442 That is, if the sequence ``C-x button1'' is typed, and is not | |
4443 bound to a command, but the sequence ``C-x button1up'' is bound | |
4444 to a command, we do not complain about the ``C-x button1'' | |
4445 sequence. If neither ``C-x button1'' nor ``C-x button1up'' is | |
4446 bound to a command, then we complain about the ``C-x button1'' | |
4447 sequence, but later will *not* complain about the | |
4448 ``C-x button1up'' sequence, which would be redundant. | |
4449 | |
4450 This is pretty hairy, but I think it's the most intuitive | |
4451 behavior. | |
4452 */ | |
4453 Lisp_Object terminal = command_builder->most_current_event; | |
4454 | |
4455 if (XEVENT_TYPE (terminal) == button_press_event) | |
4456 { | |
4457 int no_bitching; | |
4458 /* Temporarily pretend the last event was an "up" instead of a | |
4459 "down", and look up its binding. */ | |
4460 XEVENT_TYPE (terminal) = button_release_event; | |
4461 /* If the "up" version is bound, don't complain. */ | |
4462 no_bitching | |
771 | 4463 = !NILP (command_builder_find_leaf_and_update_global_state |
4464 (command_builder, 0)); | |
428 | 4465 /* Undo the temporary changes we just made. */ |
4466 XEVENT_TYPE (terminal) = button_press_event; | |
4467 if (no_bitching) | |
4468 { | |
4469 /* Pretend this press was not seen (treat as a prefix) */ | |
4470 if (EQ (command_builder->current_events, terminal)) | |
4471 { | |
4472 reset_current_events (command_builder); | |
4473 } | |
4474 else | |
4475 { | |
4476 Lisp_Object eve; | |
4477 | |
4478 EVENT_CHAIN_LOOP (eve, command_builder->current_events) | |
4479 if (EQ (XEVENT_NEXT (eve), terminal)) | |
4480 break; | |
4481 | |
4482 Fdeallocate_event (command_builder-> | |
4483 most_current_event); | |
4484 XSET_EVENT_NEXT (eve, Qnil); | |
4485 command_builder->most_current_event = eve; | |
4486 } | |
4487 maybe_echo_keys (command_builder, 1); | |
4488 break; | |
4489 } | |
4490 } | |
4491 | |
4492 /* Complain that the typed sequence is not defined, if this is the | |
4493 kind of sequence that warrants a complaint. */ | |
4494 XCONSOLE (console)->defining_kbd_macro = Qnil; | |
4495 XCONSOLE (console)->prefix_arg = Qnil; | |
4496 /* Don't complain about undefined button-release events */ | |
4497 if (XEVENT_TYPE (terminal) != button_release_event) | |
4498 { | |
4499 Lisp_Object keys = current_events_into_vector (command_builder); | |
4500 struct gcpro gcpro1; | |
4501 | |
4502 /* Run the pre-command-hook before barfing about an undefined | |
4503 key. */ | |
4504 Vthis_command = Qnil; | |
4505 GCPRO1 (keys); | |
4506 pre_command_hook (); | |
4507 UNGCPRO; | |
4508 /* The post-command-hook doesn't run. */ | |
4509 Fsignal (Qundefined_keystroke_sequence, list1 (keys)); | |
4510 } | |
4511 /* Reset the command builder for reading the next sequence. */ | |
4512 reset_this_command_keys (console, 1); | |
4513 } | |
4514 else /* key sequence is bound to a command */ | |
4515 { | |
430 | 4516 int magic_undo = 0; |
4517 int magic_undo_count = 20; | |
4518 | |
428 | 4519 Vthis_command = leaf; |
430 | 4520 |
428 | 4521 /* Don't push an undo boundary if the command set the prefix arg, |
4522 or if we are executing a keyboard macro, or if in the | |
4523 minibuffer. If the command we are about to execute is | |
4524 self-insert, it's tricky: up to 20 consecutive self-inserts may | |
4525 be done without an undo boundary. This counter is reset as | |
4526 soon as a command other than self-insert-command is executed. | |
430 | 4527 |
442 | 4528 Programmers can also use the `self-insert-defer-undo' |
4529 property to install that behavior on functions other | |
430 | 4530 than `self-insert-command', or to change the magic |
442 | 4531 number 20 to something else. #### DOCUMENT THIS! */ |
430 | 4532 |
4533 if (SYMBOLP (leaf)) | |
4534 { | |
4535 Lisp_Object prop = Fget (leaf, Qself_insert_defer_undo, Qnil); | |
4536 if (NATNUMP (prop)) | |
4537 magic_undo = 1, magic_undo_count = XINT (prop); | |
4538 else if (!NILP (prop)) | |
4539 magic_undo = 1; | |
4540 else if (EQ (leaf, Qself_insert_command)) | |
4541 magic_undo = 1; | |
4542 } | |
4543 | |
4544 if (!magic_undo) | |
428 | 4545 command_builder->self_insert_countdown = 0; |
4546 if (NILP (XCONSOLE (console)->prefix_arg) | |
4547 && NILP (Vexecuting_macro) | |
4548 && command_builder->self_insert_countdown == 0) | |
4549 Fundo_boundary (); | |
4550 | |
430 | 4551 if (magic_undo) |
428 | 4552 { |
4553 if (--command_builder->self_insert_countdown < 0) | |
430 | 4554 command_builder->self_insert_countdown = magic_undo_count; |
428 | 4555 } |
4556 execute_command_event | |
4557 (command_builder, | |
444 | 4558 internal_equal (event, command_builder->most_current_event, 0) |
428 | 4559 ? event |
4560 /* Use the translated event that was most recently seen. | |
4561 This way, last-command-event becomes f1 instead of | |
4562 the P from ESC O P. But we must copy it, else we'll | |
4563 lose when the command-builder events are deallocated. */ | |
444 | 4564 : Fcopy_event (command_builder->most_current_event, Qnil)); |
428 | 4565 } |
4566 break; | |
4567 } | |
4568 case misc_user_event: | |
4569 { | |
4570 /* Jamie said: | |
4571 | |
4572 We could just always use the menu item entry, whatever it is, but | |
4573 this might break some Lisp code that expects `this-command' to | |
4574 always contain a symbol. So only store it if this is a simple | |
4575 `call-interactively' sort of menu item. | |
4576 | |
4577 But this is bogus. `this-command' could be a string or vector | |
4578 anyway (for keyboard macros). There's even one instance | |
4579 (in pending-del.el) of `this-command' getting set to a cons | |
4580 (a lambda expression). So in the `eval' case I'll just | |
4581 convert it into a lambda expression. | |
4582 */ | |
1204 | 4583 if (EQ (XEVENT_MISC_USER_FUNCTION (event), Qcall_interactively) |
4584 && SYMBOLP (XEVENT_MISC_USER_OBJECT (event))) | |
4585 Vthis_command = XEVENT_MISC_USER_OBJECT (event); | |
4586 else if (EQ (XEVENT_MISC_USER_FUNCTION (event), Qeval)) | |
934 | 4587 Vthis_command = |
1204 | 4588 Fcons (Qlambda, Fcons (Qnil, XEVENT_MISC_USER_OBJECT (event))); |
4589 else if (SYMBOLP (XEVENT_MISC_USER_FUNCTION (event))) | |
934 | 4590 /* A scrollbar command or the like. */ |
1204 | 4591 Vthis_command = XEVENT_MISC_USER_FUNCTION (event); |
428 | 4592 else |
4593 /* Huh? */ | |
4594 Vthis_command = Qnil; | |
4595 | |
4596 /* clear the echo area */ | |
4597 reset_key_echo (command_builder, 1); | |
4598 | |
4599 command_builder->self_insert_countdown = 0; | |
4600 if (NILP (XCONSOLE (console)->prefix_arg) | |
4601 && NILP (Vexecuting_macro) | |
4602 && !EQ (minibuf_window, Fselected_window (Qnil))) | |
4603 Fundo_boundary (); | |
4604 execute_command_event (command_builder, event); | |
4605 break; | |
4606 } | |
4607 default: | |
4608 execute_internal_event (event); | |
4609 break; | |
4610 } | |
1292 | 4611 |
4612 PROFILE_RECORD_EXITING_SECTION (Qdispatch_event); | |
428 | 4613 return Qnil; |
4614 } | |
4615 | |
4616 DEFUN ("read-key-sequence", Fread_key_sequence, 1, 3, 0, /* | |
4617 Read a sequence of keystrokes or mouse clicks. | |
4618 Returns a vector of the event objects read. The vector and the event | |
444 | 4619 objects it contains are freshly created (and so will not be side-effected |
428 | 4620 by subsequent calls to this function). |
4621 | |
4622 The sequence read is sufficient to specify a non-prefix command starting | |
4623 from the current local and global keymaps. A C-g typed while in this | |
4624 function is treated like any other character, and `quit-flag' is not set. | |
4625 | |
4626 First arg PROMPT is a prompt string. If nil, do not prompt specially. | |
444 | 4627 |
4628 Second optional arg CONTINUE-ECHO non-nil means this key echoes as a | |
4629 continuation of the previous key. | |
4630 | |
4631 Third optional arg DONT-DOWNCASE-LAST non-nil means do not convert the | |
4632 last event to lower case. (Normally any upper case event is converted | |
4633 to lower case if the original event is undefined and the lower case | |
4634 equivalent is defined.) This argument is provided mostly for FSF | |
4635 compatibility; the equivalent effect can be achieved more generally by | |
4636 binding `retry-undefined-key-binding-unshifted' to nil around the call | |
4637 to `read-key-sequence'. | |
428 | 4638 |
4639 If the user selects a menu item while we are prompting for a key-sequence, | |
4640 the returned value will be a vector of a single menu-selection event. | |
4641 An error will be signalled if you pass this value to `lookup-key' or a | |
4642 related function. | |
4643 | |
4644 `read-key-sequence' checks `function-key-map' for function key | |
444 | 4645 sequences, where they wouldn't conflict with ordinary bindings. |
4646 See `function-key-map' for more details. | |
428 | 4647 */ |
4648 (prompt, continue_echo, dont_downcase_last)) | |
4649 { | |
4650 /* This function can GC */ | |
4651 struct console *con = XCONSOLE (Vselected_console); /* #### correct? | |
4652 Probably not -- see | |
4653 comment in | |
4654 next-event */ | |
4655 struct command_builder *command_builder = | |
4656 XCOMMAND_BUILDER (con->command_builder); | |
4657 Lisp_Object result; | |
4658 Lisp_Object event = Fmake_event (Qnil, Qnil); | |
4659 int speccount = specpdl_depth (); | |
4660 struct gcpro gcpro1; | |
4661 GCPRO1 (event); | |
4662 | |
707 | 4663 record_unwind_protect (Fset_buffer, Fcurrent_buffer ()); |
428 | 4664 if (!NILP (prompt)) |
4665 CHECK_STRING (prompt); | |
4666 /* else prompt = Fkeymap_prompt (current_buffer->keymap); may GC */ | |
4667 QUIT; | |
4668 | |
4669 if (NILP (continue_echo)) | |
771 | 4670 reset_this_command_keys (wrap_console (con), 1); |
428 | 4671 |
4672 if (!NILP (dont_downcase_last)) | |
4673 specbind (Qretry_undefined_key_binding_unshifted, Qnil); | |
4674 | |
4675 for (;;) | |
4676 { | |
4677 Fnext_event (event, prompt); | |
4678 /* restore the selected-console damage */ | |
4679 con = event_console_or_selected (event); | |
4680 command_builder = XCOMMAND_BUILDER (con->command_builder); | |
4681 if (! command_event_p (event)) | |
4682 execute_internal_event (event); | |
4683 else | |
4684 { | |
934 | 4685 if (XEVENT_TYPE (event) == misc_user_event) |
428 | 4686 reset_current_events (command_builder); |
4687 result = lookup_command_event (command_builder, event, 1); | |
4688 if (!KEYMAPP (result)) | |
4689 { | |
4690 result = current_events_into_vector (command_builder); | |
4691 reset_key_echo (command_builder, 0); | |
4692 break; | |
4693 } | |
4694 prompt = Qnil; | |
4695 } | |
4696 } | |
4697 | |
4698 Fdeallocate_event (event); | |
771 | 4699 RETURN_UNGCPRO (unbind_to_1 (speccount, result)); |
428 | 4700 } |
4701 | |
4702 DEFUN ("this-command-keys", Fthis_command_keys, 0, 0, 0, /* | |
4703 Return a vector of the keyboard or mouse button events that were used | |
4704 to invoke this command. This copies the vector and the events; it is safe | |
4705 to keep and modify them. | |
4706 */ | |
4707 ()) | |
4708 { | |
4709 Lisp_Object event; | |
4710 Lisp_Object result; | |
4711 int len; | |
4712 | |
4713 if (NILP (Vthis_command_keys)) | |
4714 return make_vector (0, Qnil); | |
4715 | |
4716 len = event_chain_count (Vthis_command_keys); | |
4717 | |
4718 result = make_vector (len, Qnil); | |
4719 len = 0; | |
4720 EVENT_CHAIN_LOOP (event, Vthis_command_keys) | |
4721 XVECTOR_DATA (result)[len++] = Fcopy_event (event, Qnil); | |
4722 return result; | |
4723 } | |
4724 | |
4725 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths, 0, 0, 0, /* | |
4726 Used for complicated reasons in `universal-argument-other-key'. | |
4727 | |
4728 `universal-argument-other-key' rereads the event just typed. | |
4729 It then gets translated through `function-key-map'. | |
4730 The translated event gets included in the echo area and in | |
4731 the value of `this-command-keys' in addition to the raw original event. | |
4732 That is not right. | |
4733 | |
4734 Calling this function directs the translated event to replace | |
4735 the original event, so that only one version of the event actually | |
430 | 4736 appears in the echo area and in the value of `this-command-keys'. |
428 | 4737 */ |
4738 ()) | |
4739 { | |
4740 /* #### I don't understand this at all, so currently it does nothing. | |
4741 If there is ever a problem, maybe someone should investigate. */ | |
4742 return Qnil; | |
4743 } | |
4744 | |
4745 | |
4746 static void | |
4747 dribble_out_event (Lisp_Object event) | |
4748 { | |
4749 if (NILP (Vdribble_file)) | |
4750 return; | |
4751 | |
934 | 4752 if (XEVENT_TYPE (event) == key_press_event && |
1204 | 4753 !XEVENT_KEY_MODIFIERS (event)) |
934 | 4754 { |
1204 | 4755 Lisp_Object keysym = XEVENT_KEY_KEYSYM (event); |
4756 if (CHARP (XEVENT_KEY_KEYSYM (event))) | |
428 | 4757 { |
867 | 4758 Ichar ch = XCHAR (keysym); |
4759 Ibyte str[MAX_ICHAR_LEN]; | |
4760 Bytecount len = set_itext_ichar (str, ch); | |
428 | 4761 Lstream_write (XLSTREAM (Vdribble_file), str, len); |
4762 } | |
826 | 4763 else if (string_char_length (XSYMBOL (keysym)->name) == 1) |
428 | 4764 /* one-char key events are printed with just the key name */ |
4765 Fprinc (keysym, Vdribble_file); | |
4766 else if (EQ (keysym, Qreturn)) | |
4767 Lstream_putc (XLSTREAM (Vdribble_file), '\n'); | |
4768 else if (EQ (keysym, Qspace)) | |
4769 Lstream_putc (XLSTREAM (Vdribble_file), ' '); | |
4770 else | |
4771 Fprinc (event, Vdribble_file); | |
4772 } | |
4773 else | |
4774 Fprinc (event, Vdribble_file); | |
4775 Lstream_flush (XLSTREAM (Vdribble_file)); | |
4776 } | |
4777 | |
4778 DEFUN ("open-dribble-file", Fopen_dribble_file, 1, 1, | |
4779 "FOpen dribble file: ", /* | |
444 | 4780 Start writing all keyboard characters to a dribble file called FILENAME. |
4781 If FILENAME is nil, close any open dribble file. | |
428 | 4782 */ |
444 | 4783 (filename)) |
428 | 4784 { |
4785 /* This function can GC */ | |
4786 /* XEmacs change: always close existing dribble file. */ | |
4787 /* FSFmacs uses FILE *'s here. With lstreams, that's unnecessary. */ | |
4788 if (!NILP (Vdribble_file)) | |
4789 { | |
4790 Lstream_close (XLSTREAM (Vdribble_file)); | |
4791 Vdribble_file = Qnil; | |
4792 } | |
444 | 4793 if (!NILP (filename)) |
428 | 4794 { |
4795 int fd; | |
4796 | |
444 | 4797 filename = Fexpand_file_name (filename, Qnil); |
771 | 4798 fd = qxe_open (XSTRING_DATA (filename), |
4799 O_WRONLY | O_TRUNC | O_CREAT | OPEN_BINARY, | |
4800 CREAT_MODE); | |
428 | 4801 if (fd < 0) |
563 | 4802 report_file_error ("Unable to create dribble file", filename); |
428 | 4803 Vdribble_file = make_filedesc_output_stream (fd, 0, 0, LSTR_CLOSING); |
4804 #ifdef MULE | |
4805 Vdribble_file = | |
771 | 4806 make_coding_output_stream |
4807 (XLSTREAM (Vdribble_file), | |
800 | 4808 Qescape_quoted, CODING_ENCODE, 0); |
428 | 4809 #endif |
4810 } | |
4811 return Qnil; | |
4812 } | |
4813 | |
4814 | |
442 | 4815 |
4816 DEFUN ("current-event-timestamp", Fcurrent_event_timestamp, 0, 1, 0, /* | |
4817 Return the current event timestamp of the window system associated with CONSOLE. | |
4818 CONSOLE defaults to the selected console if omitted. | |
4819 */ | |
4820 (console)) | |
4821 { | |
4822 struct console *c = decode_console (console); | |
4823 int tiempo = event_stream_current_event_timestamp (c); | |
4824 | |
4825 /* This junk is so that timestamps don't get to be negative, but contain | |
4826 as many bits as this particular emacs will allow. | |
4827 */ | |
2039 | 4828 return make_int (EMACS_INT_MAX & tiempo); |
442 | 4829 } |
4830 | |
4831 | |
428 | 4832 /************************************************************************/ |
4833 /* initialization */ | |
4834 /************************************************************************/ | |
4835 | |
4836 void | |
4837 syms_of_event_stream (void) | |
4838 { | |
5117
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
4839 INIT_LISP_OBJECT (command_builder); |
3742ea8250b5
Checking in final CVS version of workspace 'ben-lisp-object'
Ben Wing <ben@xemacs.org>
parents:
3025
diff
changeset
|
4840 INIT_LISP_OBJECT (timeout); |
442 | 4841 |
563 | 4842 DEFSYMBOL (Qdisabled); |
4843 DEFSYMBOL (Qcommand_event_p); | |
4844 | |
4845 DEFERROR_STANDARD (Qundefined_keystroke_sequence, Qsyntax_error); | |
4846 DEFERROR_STANDARD (Qinvalid_key_binding, Qinvalid_state); | |
428 | 4847 |
4848 DEFSUBR (Frecent_keys); | |
4849 DEFSUBR (Frecent_keys_ring_size); | |
4850 DEFSUBR (Fset_recent_keys_ring_size); | |
4851 DEFSUBR (Finput_pending_p); | |
4852 DEFSUBR (Fenqueue_eval_event); | |
4853 DEFSUBR (Fnext_event); | |
4854 DEFSUBR (Fnext_command_event); | |
4855 DEFSUBR (Fdiscard_input); | |
4856 DEFSUBR (Fsit_for); | |
4857 DEFSUBR (Fsleep_for); | |
4858 DEFSUBR (Faccept_process_output); | |
4859 DEFSUBR (Fadd_timeout); | |
4860 DEFSUBR (Fdisable_timeout); | |
4861 DEFSUBR (Fadd_async_timeout); | |
4862 DEFSUBR (Fdisable_async_timeout); | |
4863 DEFSUBR (Fdispatch_event); | |
442 | 4864 DEFSUBR (Fdispatch_non_command_events); |
428 | 4865 DEFSUBR (Fread_key_sequence); |
4866 DEFSUBR (Fthis_command_keys); | |
4867 DEFSUBR (Freset_this_command_lengths); | |
4868 DEFSUBR (Fopen_dribble_file); | |
442 | 4869 DEFSUBR (Fcurrent_event_timestamp); |
428 | 4870 |
563 | 4871 DEFSYMBOL (Qpre_command_hook); |
4872 DEFSYMBOL (Qpost_command_hook); | |
4873 DEFSYMBOL (Qunread_command_events); | |
4874 DEFSYMBOL (Qunread_command_event); | |
4875 DEFSYMBOL (Qpre_idle_hook); | |
4876 DEFSYMBOL (Qhandle_pre_motion_command); | |
4877 DEFSYMBOL (Qhandle_post_motion_command); | |
4878 DEFSYMBOL (Qretry_undefined_key_binding_unshifted); | |
4879 DEFSYMBOL (Qauto_show_make_point_visible); | |
4880 | |
4881 DEFSYMBOL (Qself_insert_defer_undo); | |
4882 DEFSYMBOL (Qcancel_mode_internal); | |
1292 | 4883 |
4884 DEFSYMBOL (Qnext_event); | |
4885 DEFSYMBOL (Qdispatch_event); | |
428 | 4886 } |
4887 | |
4888 void | |
4889 reinit_vars_of_event_stream (void) | |
4890 { | |
4891 recent_keys_ring_index = 0; | |
4892 recent_keys_ring_size = 100; | |
4893 num_input_chars = 0; | |
4894 the_low_level_timeout_blocktype = | |
4895 Blocktype_new (struct low_level_timeout_blocktype); | |
4896 something_happened = 0; | |
1268 | 4897 recursive_sit_for = 0; |
4898 in_modal_loop = 0; | |
428 | 4899 } |
4900 | |
4901 void | |
4902 vars_of_event_stream (void) | |
4903 { | |
4904 Vrecent_keys_ring = Qnil; | |
4905 staticpro (&Vrecent_keys_ring); | |
4906 | |
4907 Vthis_command_keys = Qnil; | |
4908 staticpro (&Vthis_command_keys); | |
4909 Vthis_command_keys_tail = Qnil; | |
1204 | 4910 dump_add_root_lisp_object (&Vthis_command_keys_tail); |
428 | 4911 |
4912 command_event_queue = Qnil; | |
4913 staticpro (&command_event_queue); | |
4914 command_event_queue_tail = Qnil; | |
1204 | 4915 dump_add_root_lisp_object (&command_event_queue_tail); |
4916 | |
4917 dispatch_event_queue = Qnil; | |
4918 staticpro (&dispatch_event_queue); | |
4919 dispatch_event_queue_tail = Qnil; | |
4920 dump_add_root_lisp_object (&dispatch_event_queue_tail); | |
428 | 4921 |
4922 Vlast_selected_frame = Qnil; | |
4923 staticpro (&Vlast_selected_frame); | |
4924 | |
4925 pending_timeout_list = Qnil; | |
4926 staticpro (&pending_timeout_list); | |
4927 | |
4928 pending_async_timeout_list = Qnil; | |
4929 staticpro (&pending_async_timeout_list); | |
4930 | |
4931 last_point_position_buffer = Qnil; | |
4932 staticpro (&last_point_position_buffer); | |
4933 | |
1292 | 4934 QSnext_event_internal = build_string ("next_event_internal()"); |
4935 staticpro (&QSnext_event_internal); | |
4936 QSexecute_internal_event = build_string ("execute_internal_event()"); | |
4937 staticpro (&QSexecute_internal_event); | |
4938 | |
428 | 4939 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes /* |
4940 *Nonzero means echo unfinished commands after this many seconds of pause. | |
4941 */ ); | |
4942 Vecho_keystrokes = make_int (1); | |
4943 | |
4944 DEFVAR_INT ("auto-save-interval", &auto_save_interval /* | |
4945 *Number of keyboard input characters between auto-saves. | |
4946 Zero means disable autosaving due to number of characters typed. | |
4947 See also the variable `auto-save-timeout'. | |
4948 */ ); | |
4949 auto_save_interval = 300; | |
4950 | |
4951 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook /* | |
4952 Function or functions to run before every command. | |
4953 This may examine the `this-command' variable to find out what command | |
4954 is about to be run, or may change it to cause a different command to run. | |
853 | 4955 Errors while running the hook are caught and turned into warnings. |
428 | 4956 */ ); |
4957 Vpre_command_hook = Qnil; | |
4958 | |
4959 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook /* | |
4960 Function or functions to run after every command. | |
4961 This may examine the `this-command' variable to find out what command | |
4962 was just executed. | |
4963 */ ); | |
4964 Vpost_command_hook = Qnil; | |
4965 | |
4966 DEFVAR_LISP ("pre-idle-hook", &Vpre_idle_hook /* | |
4967 Normal hook run when XEmacs it about to be idle. | |
4968 This occurs whenever it is going to block, waiting for an event. | |
4969 This generally happens as a result of a call to `next-event', | |
4970 `next-command-event', `sit-for', `sleep-for', `accept-process-output', | |
853 | 4971 or `get-selection'. Errors while running the hook are caught and |
4972 turned into warnings. | |
428 | 4973 */ ); |
4974 Vpre_idle_hook = Qnil; | |
4975 | |
4976 DEFVAR_BOOL ("focus-follows-mouse", &focus_follows_mouse /* | |
4977 *Variable to control XEmacs behavior with respect to focus changing. | |
4978 If this variable is set to t, then XEmacs will not gratuitously change | |
4979 the keyboard focus. XEmacs cannot in general detect when this mode is | |
4980 used by the window manager, so it is up to the user to set it. | |
4981 */ ); | |
4982 focus_follows_mouse = 0; | |
4983 | |
4984 DEFVAR_LISP ("last-command-event", &Vlast_command_event /* | |
4985 Last keyboard or mouse button event that was part of a command. This | |
4986 variable is off limits: you may not set its value or modify the event that | |
4987 is its value, as it is destructively modified by `read-key-sequence'. If | |
4988 you want to keep a pointer to this value, you must use `copy-event'. | |
4989 */ ); | |
4990 Vlast_command_event = Qnil; | |
4991 | |
4992 DEFVAR_LISP ("last-command-char", &Vlast_command_char /* | |
4993 If the value of `last-command-event' is a keyboard event, then | |
4994 this is the nearest ASCII equivalent to it. This is the value that | |
4995 `self-insert-command' will put in the buffer. Remember that there is | |
4996 NOT a 1:1 mapping between keyboard events and ASCII characters: the set | |
4997 of keyboard events is much larger, so writing code that examines this | |
4998 variable to determine what key has been typed is bad practice, unless | |
4999 you are certain that it will be one of a small set of characters. | |
5000 */ ); | |
5001 Vlast_command_char = Qnil; | |
5002 | |
5003 DEFVAR_LISP ("last-input-event", &Vlast_input_event /* | |
5004 Last keyboard or mouse button event received. This variable is off | |
5005 limits: you may not set its value or modify the event that is its value, as | |
5006 it is destructively modified by `next-event'. If you want to keep a pointer | |
5007 to this value, you must use `copy-event'. | |
5008 */ ); | |
5009 Vlast_input_event = Qnil; | |
5010 | |
5011 DEFVAR_LISP ("current-mouse-event", &Vcurrent_mouse_event /* | |
5012 The mouse-button event which invoked this command, or nil. | |
5013 This is usually what `(interactive "e")' returns. | |
5014 */ ); | |
5015 Vcurrent_mouse_event = Qnil; | |
5016 | |
5017 DEFVAR_LISP ("last-input-char", &Vlast_input_char /* | |
5018 If the value of `last-input-event' is a keyboard event, then | |
5019 this is the nearest ASCII equivalent to it. Remember that there is | |
5020 NOT a 1:1 mapping between keyboard events and ASCII characters: the set | |
5021 of keyboard events is much larger, so writing code that examines this | |
5022 variable to determine what key has been typed is bad practice, unless | |
5023 you are certain that it will be one of a small set of characters. | |
5024 */ ); | |
5025 Vlast_input_char = Qnil; | |
5026 | |
5027 DEFVAR_LISP ("last-input-time", &Vlast_input_time /* | |
5028 The time (in seconds since Jan 1, 1970) of the last-command-event, | |
5029 represented as a cons of two 16-bit integers. This is destructively | |
5030 modified, so copy it if you want to keep it. | |
5031 */ ); | |
5032 Vlast_input_time = Qnil; | |
5033 | |
5034 DEFVAR_LISP ("last-command-event-time", &Vlast_command_event_time /* | |
5035 The time (in seconds since Jan 1, 1970) of the last-command-event, | |
5036 represented as a list of three integers. The first integer contains | |
5037 the most significant 16 bits of the number of seconds, and the second | |
5038 integer contains the least significant 16 bits. The third integer | |
5039 contains the remainder number of microseconds, if the current system | |
5040 supports microsecond clock resolution. This list is destructively | |
5041 modified, so copy it if you want to keep it. | |
5042 */ ); | |
5043 Vlast_command_event_time = Qnil; | |
5044 | |
5045 DEFVAR_LISP ("unread-command-events", &Vunread_command_events /* | |
5046 List of event objects to be read as next command input events. | |
5047 This can be used to simulate the receipt of events from the user. | |
5048 Normally this is nil. | |
5049 Events are removed from the front of this list. | |
5050 */ ); | |
5051 Vunread_command_events = Qnil; | |
5052 | |
5053 DEFVAR_LISP ("unread-command-event", &Vunread_command_event /* | |
5054 Obsolete. Use `unread-command-events' instead. | |
5055 */ ); | |
5056 Vunread_command_event = Qnil; | |
5057 | |
5058 DEFVAR_LISP ("last-command", &Vlast_command /* | |
5059 The last command executed. Normally a symbol with a function definition, | |
5060 but can be whatever was found in the keymap, or whatever the variable | |
5061 `this-command' was set to by that command. | |
5062 */ ); | |
5063 Vlast_command = Qnil; | |
5064 | |
5065 DEFVAR_LISP ("this-command", &Vthis_command /* | |
5066 The command now being executed. | |
5067 The command can set this variable; whatever is put here | |
5068 will be in `last-command' during the following command. | |
5069 */ ); | |
5070 Vthis_command = Qnil; | |
5071 | |
442 | 5072 DEFVAR_LISP ("last-command-properties", &Vlast_command_properties /* |
5073 Value of `this-command-properties' for the last command. | |
5074 Used by commands to help synchronize consecutive commands, in preference | |
5075 to looking at `last-command' directly. | |
5076 */ ); | |
5077 Vlast_command_properties = Qnil; | |
5078 | |
5079 DEFVAR_LISP ("this-command-properties", &Vthis_command_properties /* | |
5080 Properties set by the current command. | |
5081 At the beginning of each command, the current value of this variable is | |
5082 copied to `last-command-properties', and then it is set to nil. Use `putf' | |
5083 to add properties to this variable. Commands should use this to communicate | |
5084 with pre/post-command hooks, subsequent commands, wrapping commands, etc. | |
5085 in preference to looking at and/or setting `this-command'. | |
5086 */ ); | |
5087 Vthis_command_properties = Qnil; | |
5088 | |
428 | 5089 DEFVAR_LISP ("help-char", &Vhelp_char /* |
5090 Character to recognize as meaning Help. | |
5091 When it is read, do `(eval help-form)', and display result if it's a string. | |
5092 If the value of `help-form' is nil, this char can be read normally. | |
5093 This can be any form recognized as a single key specifier. | |
5094 The help-char cannot be a negative number in XEmacs. | |
5095 */ ); | |
5096 Vhelp_char = make_char (8); /* C-h */ | |
5097 | |
5098 DEFVAR_LISP ("help-form", &Vhelp_form /* | |
5099 Form to execute when character help-char is read. | |
5100 If the form returns a string, that string is displayed. | |
5101 If `help-form' is nil, the help char is not recognized. | |
5102 */ ); | |
5103 Vhelp_form = Qnil; | |
5104 | |
5105 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command /* | |
5106 Command to run when `help-char' character follows a prefix key. | |
5107 This command is used only when there is no actual binding | |
5108 for that character after that prefix key. | |
5109 */ ); | |
5110 Vprefix_help_command = Qnil; | |
5111 | |
5112 DEFVAR_CONST_LISP ("keyboard-translate-table", &Vkeyboard_translate_table /* | |
5113 Hash table used as translate table for keyboard input. | |
5114 Use `keyboard-translate' to portably add entries to this table. | |
5115 Each key-press event is looked up in this table as follows: | |
5116 | |
5117 -- If an entry maps a symbol to a symbol, then a key-press event whose | |
5118 keysym is the former symbol (with any modifiers at all) gets its | |
5119 keysym changed and its modifiers left alone. This is useful for | |
5120 dealing with non-standard X keyboards, such as the grievous damage | |
5121 that Sun has inflicted upon the world. | |
442 | 5122 -- If an entry maps a symbol to a character, then a key-press event |
5123 whose keysym is the former symbol (with any modifiers at all) gets | |
5124 changed into a key-press event matching the latter character, and the | |
5125 resulting modifiers are the union of the original and new modifiers. | |
428 | 5126 -- If an entry maps a character to a character, then a key-press event |
5127 matching the former character gets converted to a key-press event | |
5128 matching the latter character. This is useful on ASCII terminals | |
5129 for (e.g.) making C-\\ look like C-s, to get around flow-control | |
5130 problems. | |
5131 -- If an entry maps a character to a symbol, then a key-press event | |
5132 matching the character gets converted to a key-press event whose | |
5133 keysym is the given symbol and which has no modifiers. | |
442 | 5134 |
5135 Here's an example: This makes typing parens and braces easier by rerouting | |
5136 their positions to eliminate the need to use the Shift key. | |
5137 | |
5138 (keyboard-translate ?[ ?() | |
5139 (keyboard-translate ?] ?)) | |
5140 (keyboard-translate ?{ ?[) | |
5141 (keyboard-translate ?} ?]) | |
5142 (keyboard-translate 'f11 ?{) | |
5143 (keyboard-translate 'f12 ?}) | |
428 | 5144 */ ); |
5145 | |
5146 DEFVAR_LISP ("retry-undefined-key-binding-unshifted", | |
5147 &Vretry_undefined_key_binding_unshifted /* | |
5148 If a key-sequence which ends with a shifted keystroke is undefined | |
5149 and this variable is non-nil then the command lookup is retried again | |
5150 with the last key unshifted. (e.g. C-X C-F would be retried as C-X C-f.) | |
5151 If lookup still fails, a normal error is signalled. In general, | |
5152 you should *bind* this, not set it. | |
5153 */ ); | |
5154 Vretry_undefined_key_binding_unshifted = Qt; | |
5155 | |
442 | 5156 DEFVAR_BOOL ("modifier-keys-are-sticky", &modifier_keys_are_sticky /* |
5157 *Non-nil makes modifier keys sticky. | |
5158 This means that you can release the modifier key before pressing down | |
5159 the key that you wish to be modified. Although this is non-standard | |
5160 behavior, it is recommended because it reduces the strain on your hand, | |
5161 thus reducing the incidence of the dreaded Emacs-pinky syndrome. | |
444 | 5162 |
5163 Modifier keys are sticky within the inverval specified by | |
5164 `modifier-keys-sticky-time'. | |
442 | 5165 */ ); |
5166 modifier_keys_are_sticky = 0; | |
5167 | |
444 | 5168 DEFVAR_LISP ("modifier-keys-sticky-time", &Vmodifier_keys_sticky_time /* |
5169 *Modifier keys are sticky within this many milliseconds. | |
5170 If you don't want modifier keys sticking to be bounded, set this to | |
5171 non-integer value. | |
5172 | |
5173 This variable has no effect when `modifier-keys-are-sticky' is nil. | |
5174 Currently only implemented under X Window System. | |
5175 */ ); | |
5176 Vmodifier_keys_sticky_time = make_int (500); | |
5177 | |
428 | 5178 Vcontrolling_terminal = Qnil; |
5179 staticpro (&Vcontrolling_terminal); | |
5180 | |
5181 Vdribble_file = Qnil; | |
5182 staticpro (&Vdribble_file); | |
5183 | |
5184 #ifdef DEBUG_XEMACS | |
5185 DEFVAR_INT ("debug-emacs-events", &debug_emacs_events /* | |
5186 If non-zero, display debug information about Emacs events that XEmacs sees. | |
5187 Information is displayed on stderr. | |
5188 | |
5189 Before the event, the source of the event is displayed in parentheses, | |
5190 and is one of the following: | |
5191 | |
5192 \(real) A real event from the window system or | |
5193 terminal driver, as far as XEmacs can tell. | |
5194 | |
5195 \(keyboard macro) An event generated from a keyboard macro. | |
5196 | |
5197 \(unread-command-events) An event taken from `unread-command-events'. | |
5198 | |
5199 \(unread-command-event) An event taken from `unread-command-event'. | |
5200 | |
5201 \(command event queue) An event taken from an internal queue. | |
5202 Events end up on this queue when | |
5203 `enqueue-eval-event' is called or when | |
5204 user or eval events are received while | |
5205 XEmacs is blocking (e.g. in `sit-for', | |
5206 `sleep-for', or `accept-process-output', | |
5207 or while waiting for the reply to an | |
5208 X selection). | |
5209 | |
5210 \(->keyboard-translate-table) The result of an event translated through | |
5211 keyboard-translate-table. Note that in | |
5212 this case, two events are printed even | |
5213 though only one is really generated. | |
5214 | |
5215 \(SIGINT) A faked C-g resulting when XEmacs receives | |
5216 a SIGINT (e.g. C-c was pressed in XEmacs' | |
5217 controlling terminal or the signal was | |
5218 explicitly sent to the XEmacs process). | |
5219 */ ); | |
5220 debug_emacs_events = 0; | |
5221 #endif | |
5222 | |
2828 | 5223 DEFVAR_BOOL ("inhibit-input-event-recording", |
5224 &inhibit_input_event_recording /* | |
428 | 5225 Non-nil inhibits recording of input-events to recent-keys ring. |
5226 */ ); | |
5227 inhibit_input_event_recording = 0; | |
771 | 5228 |
428 | 5229 Vkeyboard_translate_table = |
5230 make_lisp_hash_table (100, HASH_TABLE_NON_WEAK, HASH_TABLE_EQ); | |
2828 | 5231 |
5232 DEFVAR_BOOL ("try-alternate-layouts-for-commands", | |
5233 &try_alternate_layouts_for_commands /* | |
5234 Non-nil means that if looking up a command from a sequence of keys typed by | |
5235 the user would otherwise fail, try it again with some other keyboard | |
5236 layout. On X11, the only alternative to the default mapping is American | |
5237 QWERTY; on Windows, other mappings may be available, depending on things | |
5238 like the default language environment for the current user, for the system, | |
5239 &c. | |
5240 | |
5241 With a Russian keyboard layout on X11, for example, this means that | |
5242 C-Cyrillic_che C-Cyrillic_a, if you haven't given that sequence a binding | |
5243 yourself, will invoke `find-file.' This is because `Cyrillic_che' is | |
5244 physically where `x' is, and `Cyrillic_a' is where `f' is, on an American | |
5245 Qwerty layout, and, of course, C-x C-f is a default emacs binding for that | |
5246 command. | |
5247 */ ); | |
5248 try_alternate_layouts_for_commands = 1; | |
428 | 5249 } |
5250 | |
5251 void | |
5252 init_event_stream (void) | |
5253 { | |
814 | 5254 /* Normally we don't initialize the event stream when running a bare |
5255 temacs (the check for initialized) because it may do various things | |
5256 (e.g. under Xt) that we don't want any traces of in a dumped xemacs. | |
5257 However, sometimes we need to process events in a bare temacs (in | |
5258 particular, when make-docfile.el is executed); so we initialize as | |
5259 necessary in check_event_stream_ok(). */ | |
428 | 5260 if (initialized) |
5261 { | |
5262 #ifdef HAVE_UNIXOID_EVENT_LOOP | |
5263 init_event_unixoid (); | |
5264 #endif | |
5265 #ifdef HAVE_X_WINDOWS | |
5266 if (!strcmp (display_use, "x")) | |
5267 init_event_Xt_late (); | |
5268 else | |
5269 #endif | |
462 | 5270 #ifdef HAVE_GTK |
5271 if (!strcmp (display_use, "gtk")) | |
5272 init_event_gtk_late (); | |
5273 else | |
5274 #endif | |
428 | 5275 #ifdef HAVE_MS_WINDOWS |
5276 if (!strcmp (display_use, "mswindows")) | |
5277 init_event_mswindows_late (); | |
5278 else | |
5279 #endif | |
5280 { | |
5281 /* For TTY's, use the Xt event loop if we can; it allows | |
5282 us to later open an X connection. */ | |
5283 #if defined (HAVE_MS_WINDOWS) && (!defined (HAVE_TTY) \ | |
5284 || (defined (HAVE_MSG_SELECT) \ | |
5285 && !defined (DEBUG_TTY_EVENT_STREAM))) | |
5286 init_event_mswindows_late (); | |
5287 #elif defined (HAVE_X_WINDOWS) && !defined (DEBUG_TTY_EVENT_STREAM) | |
5288 init_event_Xt_late (); | |
5289 #elif defined (HAVE_TTY) | |
5290 init_event_tty_late (); | |
5291 #endif | |
5292 } | |
5293 init_interrupts_late (); | |
5294 } | |
5295 } | |
5296 | |
5297 | |
5298 /* | |
853 | 5299 #### this comment is at least 8 years old and some may no longer apply. |
5300 | |
428 | 5301 useful testcases for v18/v19 compatibility: |
5302 | |
5303 (defun foo () | |
5304 (interactive) | |
5305 (setq unread-command-event (character-to-event ?A (allocate-event))) | |
5306 (setq x (list (read-char) | |
5307 ; (read-key-sequence "") ; try it with and without this | |
5308 last-command-char last-input-char | |
5309 (recent-keys) (this-command-keys)))) | |
5310 (global-set-key "\^Q" 'foo) | |
5311 | |
5312 without the read-key-sequence: | |
444 | 5313 ^Q ==> (?A ?\^Q ?A [... ^Q] [^Q]) |
5314 ^U^U^Q ==> (?A ?\^Q ?A [... ^U ^U ^Q] [^U ^U ^Q]) | |
5315 ^U^U^U^G^Q ==> (?A ?\^Q ?A [... ^U ^U ^U ^G ^Q] [^Q]) | |
428 | 5316 |
5317 with the read-key-sequence: | |
444 | 5318 ^Qb ==> (?A [b] ?\^Q ?b [... ^Q b] [b]) |
5319 ^U^U^Qb ==> (?A [b] ?\^Q ?b [... ^U ^U ^Q b] [b]) | |
5320 ^U^U^U^G^Qb ==> (?A [b] ?\^Q ?b [... ^U ^U ^U ^G ^Q b] [b]) | |
428 | 5321 |
5322 ;the evi-mode command "4dlj.j.j.j.j.j." is also a good testcase (gag) | |
5323 | |
5324 ;(setq x (list (read-char) quit-flag))^J^G | |
5325 ;(let ((inhibit-quit t)) (setq x (list (read-char) quit-flag)))^J^G | |
5326 ;for BOTH, x should get set to (7 t), but no result should be printed. | |
444 | 5327 ;; #### According to the doc of quit-flag, second test should return |
5328 ;; (?\^G nil). Accidentaly XEmacs returns correct value. However, | |
5329 ;; XEmacs 21.1.12 and 21.2.36 both fails on first test. | |
428 | 5330 |
5331 ;also do this: make two frames, one viewing "*scratch*", the other "foo". | |
5332 ;in *scratch*, type (sit-for 20)^J | |
5333 ;wait a couple of seconds, move cursor to foo, type "a" | |
5334 ;a should be inserted in foo. Cursor highlighting should not change in | |
5335 ;the meantime. | |
5336 | |
5337 ;do it with sleep-for. move cursor into foo, then back into *scratch* | |
5338 ;before typing. | |
5339 ;repeat also with (accept-process-output nil 20) | |
5340 | |
5341 ;make sure ^G aborts sit-for, sleep-for and accept-process-output: | |
5342 | |
5343 (defun tst () | |
5344 (list (condition-case c | |
5345 (sleep-for 20) | |
5346 (quit c)) | |
5347 (read-char))) | |
5348 | |
444 | 5349 (tst)^Ja^G ==> ((quit) ?a) with no signal |
5350 (tst)^J^Ga ==> ((quit) ?a) with no signal | |
5351 (tst)^Jabc^G ==> ((quit) ?a) with no signal, and "bc" inserted in buffer | |
428 | 5352 |
5353 ; with sit-for only do the 2nd test. | |
5354 ; Do all 3 tests with (accept-process-output nil 20) | |
5355 | |
5356 Do this: | |
5357 (setq enable-recursive-minibuffers t | |
5358 minibuffer-max-depth nil) | |
5359 ESC ESC ESC ESC - there are now two minibuffers active | |
5360 C-g C-g C-g - there should be active 0, not 1 | |
5361 Similarly: | |
5362 C-x C-f ~ / ? - wait for "Making completion list..." to display | |
5363 C-g - wait for "Quit" to display | |
5364 C-g - minibuffer should not be active | |
5365 however C-g before "Quit" is displayed should leave minibuffer active. | |
5366 | |
5367 ;do it all in both v18 and v19 and make sure all results are the same. | |
5368 ;all of these cases matter a lot, but some in quite subtle ways. | |
5369 */ | |
5370 | |
5371 /* | |
5372 Additional test cases for accept-process-output, sleep-for, sit-for. | |
5373 Be sure you do all of the above checking for C-g and focus, too! | |
5374 | |
5375 ; Make sure that timer handlers are run during, not after sit-for: | |
5376 (defun timer-check () | |
5377 (add-timeout 2 '(lambda (ignore) (message "timer ran")) nil) | |
5378 (sit-for 5) | |
5379 (message "after sit-for")) | |
5380 | |
5381 ; The first message should appear after 2 seconds, and the final message | |
5382 ; 3 seconds after that. | |
5383 ; repeat above test with (sleep-for 5) and (accept-process-output nil 5) | |
5384 | |
5385 | |
5386 | |
5387 ; Make sure that process filters are run during, not after sit-for. | |
5388 (defun fubar () | |
5389 (message "sit-for = %s" (sit-for 30))) | |
5390 (add-hook 'post-command-hook 'fubar) | |
5391 | |
5392 ; Now type M-x shell RET | |
5393 ; wait for the shell prompt then send: ls RET | |
5394 ; the output of ls should fill immediately, and not wait 30 seconds. | |
5395 | |
5396 ; repeat above test with (sleep-for 30) and (accept-process-output nil 30) | |
5397 | |
5398 | |
5399 | |
5400 ; Make sure that recursive invocations return immediately: | |
5401 (defmacro test-diff-time (start end) | |
5402 `(+ (* (- (car ,end) (car ,start)) 65536.0) | |
5403 (- (cadr ,end) (cadr ,start)) | |
5404 (/ (- (caddr ,end) (caddr ,start)) 1000000.0))) | |
5405 | |
5406 (defun testee (ignore) | |
5407 (sit-for 10)) | |
5408 | |
5409 (defun test-them () | |
5410 (let ((start (current-time)) | |
5411 end) | |
5412 (add-timeout 2 'testee nil) | |
5413 (sit-for 5) | |
5414 (add-timeout 2 'testee nil) | |
5415 (sleep-for 5) | |
5416 (add-timeout 2 'testee nil) | |
5417 (accept-process-output nil 5) | |
5418 (setq end (current-time)) | |
5419 (test-diff-time start end))) | |
5420 | |
5421 (test-them) should sit for 15 seconds. | |
5422 Repeat with testee set to sleep-for and accept-process-output. | |
5423 These should each delay 36 seconds. | |
5424 | |
5425 */ |