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.
5 Copyright (C) 1995, 1996 Ben Wing.
7 This file is part of XEmacs.
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
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
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. */
24 /* Synched up with: Not in FSF. */
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?.
40 /* This file has been Mule-ized. */
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.
53 This stuff is way too hard to maintain - needs rework.
55 The command builder should deal only with key and button events.
56 Other command events should be able to come in the MIDDLE of a key
57 sequence, without disturbing the key sequence composition, or the
58 command builder structure representing it.
60 Someone should rethink universal-argument and figure out how an
61 arbitrary command can influence the next command (universal-argument
62 or universal-coding-system-argument) or the next key (hyperify).
64 Both C-h and Help in the middle of a key sequence should trigger
65 prefix-help-command. help-char is stupid. Maybe we need
66 keymap-of-last-resort?
68 After prefix-help is run, one should be able to CONTINUE TYPING,
69 instead of RETYPING, the key sequence.
75 #include "blocktype.h"
82 #include "insdel.h" /* for buffer_reset_changes */
85 #include "macros.h" /* for defining_keyboard_macro */
86 #include "menubar.h" /* #### for evil kludges. */
90 #include "sysdep.h" /* init_poll_for_quit() */
91 #include "syssignal.h" /* SIGCHLD, etc. */
93 #include "systime.h" /* to set Vlast_input_time */
95 #include "events-mod.h"
97 #include "file-coding.h"
102 /* The number of keystrokes between auto-saves. */
103 static Fixnum auto_save_interval;
105 Lisp_Object Qundefined_keystroke_sequence;
107 Lisp_Object Qcommand_event_p;
109 /* Hooks to run before and after each command. */
110 Lisp_Object Vpre_command_hook, Vpost_command_hook;
111 Lisp_Object Qpre_command_hook, Qpost_command_hook;
114 Lisp_Object Qhandle_pre_motion_command, Qhandle_post_motion_command;
116 /* Hook run when XEmacs is about to be idle. */
117 Lisp_Object Qpre_idle_hook, Vpre_idle_hook;
119 /* Control gratuitous keyboard focus throwing. */
120 int focus_follows_mouse;
122 /* When true, modifier keys are sticky. */
123 int modifier_keys_are_sticky;
124 /* Modifier keys are sticky for this many milliseconds. */
125 Lisp_Object Vmodifier_keys_sticky_time;
127 /* Here FSF Emacs 20.7 defines Vpost_command_idle_hook,
128 post_command_idle_delay, Vdeferred_action_list, and
129 Vdeferred_action_function, but we don't because that stuff is crap,
130 and we're smarter than them, and their momas are fat. */
132 /* FSF Emacs 20.7 also defines Vinput_method_function,
133 Qinput_method_exit_on_first_char and Qinput_method_use_echo_area.
134 I don't know this should be imported or not. */
136 /* Non-nil disable property on a command means
137 do not execute it; call disabled-command-hook's value instead. */
138 Lisp_Object Qdisabled, Vdisabled_command_hook;
140 EXFUN (Fnext_command_event, 2);
142 static void pre_command_hook (void);
143 static void post_command_hook (void);
145 /* Last keyboard or mouse input event read as a command. */
146 Lisp_Object Vlast_command_event;
148 /* The nearest ASCII equivalent of the above. */
149 Lisp_Object Vlast_command_char;
151 /* Last keyboard or mouse event read for any purpose. */
152 Lisp_Object Vlast_input_event;
154 /* The nearest ASCII equivalent of the above. */
155 Lisp_Object Vlast_input_char;
157 Lisp_Object Vcurrent_mouse_event;
159 /* This is fbound in cmdloop.el, see the commentary there */
160 Lisp_Object Qcancel_mode_internal;
162 /* If not Qnil, event objects to be read as the next command input */
163 Lisp_Object Vunread_command_events;
164 Lisp_Object Vunread_command_event; /* obsoleteness support */
166 static Lisp_Object Qunread_command_events, Qunread_command_event;
168 /* Previous command, represented by a Lisp object.
169 Does not include prefix commands and arg setting commands. */
170 Lisp_Object Vlast_command;
172 /* Contents of this-command-properties for the last command. */
173 Lisp_Object Vlast_command_properties;
175 /* If a command sets this, the value goes into
176 last-command for the next command. */
177 Lisp_Object Vthis_command;
179 /* If a command sets this, the value goes into
180 last-command-properties for the next command. */
181 Lisp_Object Vthis_command_properties;
183 /* The value of point when the last command was executed. */
184 Bufpos last_point_position;
186 /* The frame that was current when the last command was started. */
187 Lisp_Object Vlast_selected_frame;
189 /* The buffer that was current when the last command was started. */
190 Lisp_Object last_point_position_buffer;
192 /* A (16bit . 16bit) representation of the time of the last-command-event. */
193 Lisp_Object Vlast_input_time;
195 /* A (16bit 16bit usec) representation of the time
196 of the last-command-event. */
197 Lisp_Object Vlast_command_event_time;
199 /* Character to recognize as the help char. */
200 Lisp_Object Vhelp_char;
202 /* Form to execute when help char is typed. */
203 Lisp_Object Vhelp_form;
205 /* Command to run when the help character follows a prefix key. */
206 Lisp_Object Vprefix_help_command;
208 /* Flag to tell QUIT that some interesting occurrence (e.g. a keypress)
209 may have happened. */
210 volatile int something_happened;
212 /* Hash table to translate keysyms through */
213 Lisp_Object Vkeyboard_translate_table;
215 /* If control-meta-super-shift-X is undefined, try control-meta-super-x */
216 Lisp_Object Vretry_undefined_key_binding_unshifted;
217 Lisp_Object Qretry_undefined_key_binding_unshifted;
220 /* If composed input is undefined, use self-insert-char */
221 Lisp_Object Vcomposed_character_default_binding;
222 #endif /* HAVE_XIM */
224 /* Console that corresponds to our controlling terminal */
225 Lisp_Object Vcontrolling_terminal;
227 /* An event (actually an event chain linked through event_next) or Qnil.
229 Lisp_Object Vthis_command_keys;
230 Lisp_Object Vthis_command_keys_tail;
233 Lisp_Object Qauto_show_make_point_visible;
235 /* File in which we write all commands we read; an lstream */
236 static Lisp_Object Vdribble_file;
238 /* Recent keys ring location; a vector of events or nil-s */
239 Lisp_Object Vrecent_keys_ring;
240 int recent_keys_ring_size;
241 int recent_keys_ring_index;
243 /* Boolean specifying whether keystrokes should be added to
245 int inhibit_input_event_recording;
247 Lisp_Object Qself_insert_defer_undo;
249 /* this is in keymap.c */
250 extern Lisp_Object Fmake_keymap (Lisp_Object name);
253 Fixnum debug_emacs_events;
256 external_debugging_print_event (char *event_description, Lisp_Object event)
258 write_c_string ("(", Qexternal_debugging_output);
259 write_c_string (event_description, Qexternal_debugging_output);
260 write_c_string (") ", Qexternal_debugging_output);
261 print_internal (event, Qexternal_debugging_output, 1);
262 write_c_string ("\n", Qexternal_debugging_output);
264 #define DEBUG_PRINT_EMACS_EVENT(event_description, event) do { \
265 if (debug_emacs_events) \
266 external_debugging_print_event (event_description, event); \
269 #define DEBUG_PRINT_EMACS_EVENT(string, event)
273 /* The callback routines for the window system or terminal driver */
274 struct event_stream *event_stream;
276 static void echo_key_event (struct command_builder *, Lisp_Object event);
277 static void maybe_kbd_translate (Lisp_Object event);
279 /* This structure is basically a typeahead queue: things like
280 wait-reading-process-output will delay the execution of
281 keyboard and mouse events by pushing them here.
283 Chained through event_next()
284 command_event_queue_tail is a pointer to the last-added element.
286 static Lisp_Object command_event_queue;
287 static Lisp_Object command_event_queue_tail;
289 /* Nonzero means echo unfinished commands after this many seconds of pause. */
290 static Lisp_Object Vecho_keystrokes;
292 /* The number of keystrokes since the last auto-save. */
293 static int keystrokes_since_auto_save;
295 /* Used by the C-g signal handler so that it will never "hard quit"
296 when waiting for an event. Otherwise holding down C-g could
297 cause a suspension back to the shell, which is generally
298 undesirable. (#### This doesn't fully work.) */
300 int emacs_is_blocking;
302 /* Handlers which run during sit-for, sleep-for and accept-process-output
303 are not allowed to recursively call these routines. We record here
304 if we are in that situation. */
306 static Lisp_Object recursive_sit_for;
310 /**********************************************************************/
311 /* Command-builder object */
312 /**********************************************************************/
314 #define XCOMMAND_BUILDER(x) \
315 XRECORD (x, command_builder, struct command_builder)
316 #define XSETCOMMAND_BUILDER(x, p) XSETRECORD (x, p, command_builder)
317 #define COMMAND_BUILDERP(x) RECORDP (x, command_builder)
318 #define CHECK_COMMAND_BUILDER(x) CHECK_RECORD (x, command_builder)
321 mark_command_builder (Lisp_Object obj)
323 struct command_builder *builder = XCOMMAND_BUILDER (obj);
324 mark_object (builder->prefix_events);
325 mark_object (builder->current_events);
326 mark_object (builder->most_current_event);
327 mark_object (builder->last_non_munged_event);
328 mark_object (builder->munge_me[0].first_mungeable_event);
329 mark_object (builder->munge_me[1].first_mungeable_event);
330 return builder->console;
334 finalize_command_builder (void *header, int for_disksave)
338 xfree (((struct command_builder *) header)->echo_buf);
339 ((struct command_builder *) header)->echo_buf = 0;
343 DEFINE_LRECORD_IMPLEMENTATION ("command-builder", command_builder,
344 mark_command_builder, internal_object_printer,
345 finalize_command_builder, 0, 0, 0,
346 struct command_builder);
349 reset_command_builder_event_chain (struct command_builder *builder)
351 builder->prefix_events = Qnil;
352 builder->current_events = Qnil;
353 builder->most_current_event = Qnil;
354 builder->last_non_munged_event = Qnil;
355 builder->munge_me[0].first_mungeable_event = Qnil;
356 builder->munge_me[1].first_mungeable_event = Qnil;
360 allocate_command_builder (Lisp_Object console)
362 Lisp_Object builder_obj;
363 struct command_builder *builder =
364 alloc_lcrecord_type (struct command_builder, &lrecord_command_builder);
366 builder->console = console;
367 reset_command_builder_event_chain (builder);
368 builder->echo_buf_length = 300; /* #### Kludge */
369 builder->echo_buf = xnew_array (Bufbyte, builder->echo_buf_length);
370 builder->echo_buf[0] = 0;
371 builder->echo_buf_index = -1;
372 builder->echo_buf_index = -1;
373 builder->self_insert_countdown = 0;
375 XSETCOMMAND_BUILDER (builder_obj, builder);
380 command_builder_append_event (struct command_builder *builder,
383 assert (EVENTP (event));
385 if (EVENTP (builder->most_current_event))
386 XSET_EVENT_NEXT (builder->most_current_event, event);
388 builder->current_events = event;
390 builder->most_current_event = event;
391 if (NILP (builder->munge_me[0].first_mungeable_event))
392 builder->munge_me[0].first_mungeable_event = event;
393 if (NILP (builder->munge_me[1].first_mungeable_event))
394 builder->munge_me[1].first_mungeable_event = event;
398 /**********************************************************************/
399 /* Low-level interfaces onto event methods */
400 /**********************************************************************/
402 enum event_stream_operation
404 EVENT_STREAM_PROCESS,
405 EVENT_STREAM_TIMEOUT,
406 EVENT_STREAM_CONSOLE,
411 check_event_stream_ok (enum event_stream_operation op)
413 if (!event_stream && noninteractive)
417 case EVENT_STREAM_PROCESS:
418 error ("Can't start subprocesses in -batch mode");
419 case EVENT_STREAM_TIMEOUT:
420 error ("Can't add timeouts in -batch mode");
421 case EVENT_STREAM_CONSOLE:
422 error ("Can't add consoles in -batch mode");
423 case EVENT_STREAM_READ:
424 error ("Can't read events in -batch mode");
429 else if (!event_stream)
431 error ("event-stream callbacks not initialized (internal error?)");
436 event_stream_event_pending_p (int user)
438 return event_stream && event_stream->event_pending_p (user);
442 event_stream_force_event_pending (struct frame* f)
444 if (event_stream->force_event_pending)
445 event_stream->force_event_pending (f);
449 maybe_read_quit_event (Lisp_Event *event)
451 /* A C-g that came from `sigint_happened' will always come from the
452 controlling terminal. If that doesn't exist, however, then the
453 user manually sent us a SIGINT, and we pretend the C-g came from
454 the selected console. */
457 if (CONSOLEP (Vcontrolling_terminal) &&
458 CONSOLE_LIVE_P (XCONSOLE (Vcontrolling_terminal)))
459 con = XCONSOLE (Vcontrolling_terminal);
461 con = XCONSOLE (Fselected_console ());
465 int ch = CONSOLE_QUIT_CHAR (con);
468 character_to_event (ch, event, con, 1, 1);
469 event->channel = make_console (con);
476 event_stream_next_event (Lisp_Event *event)
478 Lisp_Object event_obj;
480 check_event_stream_ok (EVENT_STREAM_READ);
482 XSETEVENT (event_obj, event);
484 /* If C-g was pressed, treat it as a character to be read.
485 Note that if C-g was pressed while we were blocking,
486 the SIGINT signal handler will be called. It will
487 set Vquit_flag and write a byte on our "fake pipe",
488 which will unblock us. */
489 if (maybe_read_quit_event (event))
491 DEBUG_PRINT_EMACS_EVENT ("SIGINT", event_obj);
495 /* If a longjmp() happens in the callback, we're screwed.
496 Let's hope it doesn't. I think the code here is fairly
497 clean and doesn't do this. */
498 emacs_is_blocking = 1;
499 event_stream->next_event_cb (event);
500 emacs_is_blocking = 0;
503 /* timeout events have more info set later, so
504 print the event out in next_event_internal(). */
505 if (event->event_type != timeout_event)
506 DEBUG_PRINT_EMACS_EVENT ("real", event_obj);
508 maybe_kbd_translate (event_obj);
512 event_stream_handle_magic_event (Lisp_Event *event)
514 check_event_stream_ok (EVENT_STREAM_READ);
515 event_stream->handle_magic_event_cb (event);
519 event_stream_add_timeout (EMACS_TIME timeout)
521 check_event_stream_ok (EVENT_STREAM_TIMEOUT);
522 return event_stream->add_timeout_cb (timeout);
526 event_stream_remove_timeout (int id)
528 check_event_stream_ok (EVENT_STREAM_TIMEOUT);
529 event_stream->remove_timeout_cb (id);
533 event_stream_select_console (struct console *con)
535 check_event_stream_ok (EVENT_STREAM_CONSOLE);
536 if (!con->input_enabled)
538 event_stream->select_console_cb (con);
539 con->input_enabled = 1;
544 event_stream_unselect_console (struct console *con)
546 check_event_stream_ok (EVENT_STREAM_CONSOLE);
547 if (con->input_enabled)
549 event_stream->unselect_console_cb (con);
550 con->input_enabled = 0;
555 event_stream_select_process (Lisp_Process *proc)
557 check_event_stream_ok (EVENT_STREAM_PROCESS);
558 if (!get_process_selected_p (proc))
560 event_stream->select_process_cb (proc);
561 set_process_selected_p (proc, 1);
566 event_stream_unselect_process (Lisp_Process *proc)
568 check_event_stream_ok (EVENT_STREAM_PROCESS);
569 if (get_process_selected_p (proc))
571 event_stream->unselect_process_cb (proc);
572 set_process_selected_p (proc, 0);
577 event_stream_create_stream_pair (void* inhandle, void* outhandle,
578 Lisp_Object* instream, Lisp_Object* outstream, int flags)
580 check_event_stream_ok (EVENT_STREAM_PROCESS);
581 return event_stream->create_stream_pair_cb
582 (inhandle, outhandle, instream, outstream, flags);
586 event_stream_delete_stream_pair (Lisp_Object instream, Lisp_Object outstream)
588 check_event_stream_ok (EVENT_STREAM_PROCESS);
589 return event_stream->delete_stream_pair_cb (instream, outstream);
593 event_stream_quit_p (void)
596 event_stream->quit_p_cb ();
600 event_stream_current_event_timestamp (struct console *c)
602 if (event_stream && event_stream->current_event_timestamp_cb)
603 return event_stream->current_event_timestamp_cb (c);
609 /**********************************************************************/
610 /* Character prompting */
611 /**********************************************************************/
614 echo_key_event (struct command_builder *command_builder,
617 /* This function can GC */
619 Bytecount buf_index = command_builder->echo_buf_index;
625 buf_index = 0; /* We're echoing now */
626 clear_echo_area (selected_frame (), Qnil, 0);
629 format_event_object (buf, XEVENT (event), 1);
632 if (len + buf_index + 4 > command_builder->echo_buf_length)
634 e = command_builder->echo_buf + buf_index;
635 memcpy (e, buf, len);
643 command_builder->echo_buf_index = buf_index + len + 1;
647 regenerate_echo_keys_from_this_command_keys (struct command_builder *
652 builder->echo_buf_index = 0;
654 EVENT_CHAIN_LOOP (event, Vthis_command_keys)
655 echo_key_event (builder, event);
659 maybe_echo_keys (struct command_builder *command_builder, int no_snooze)
661 /* This function can GC */
662 double echo_keystrokes;
663 struct frame *f = selected_frame ();
664 /* Message turns off echoing unless more keystrokes turn it on again. */
665 if (echo_area_active (f) && !EQ (Qcommand, echo_area_status (f)))
668 if (INTP (Vecho_keystrokes) || FLOATP (Vecho_keystrokes))
669 echo_keystrokes = extract_float (Vecho_keystrokes);
673 if (minibuf_level == 0
674 && echo_keystrokes > 0.0
675 #if defined (HAVE_X_WINDOWS) && defined (LWLIB_MENUBARS_LUCID)
676 && !x_kludge_lw_menu_active ()
682 /* #### C-g here will cause QUIT. Setting dont_check_for_quit
683 doesn't work. See check_quit. */
684 if (NILP (Fsit_for (Vecho_keystrokes, Qnil)))
685 /* input came in, so don't echo. */
689 echo_area_message (f, command_builder->echo_buf, Qnil, 0,
690 /* not echo_buf_index. That doesn't include
691 the terminating " - ". */
692 strlen ((char *) command_builder->echo_buf),
698 reset_key_echo (struct command_builder *command_builder,
699 int remove_echo_area_echo)
701 /* This function can GC */
702 struct frame *f = selected_frame ();
704 command_builder->echo_buf_index = -1;
706 if (remove_echo_area_echo)
707 clear_echo_area (f, Qcommand, 0);
711 /**********************************************************************/
713 /**********************************************************************/
716 maybe_kbd_translate (Lisp_Object event)
719 int did_translate = 0;
721 if (XEVENT_TYPE (event) != key_press_event)
723 if (!HASH_TABLEP (Vkeyboard_translate_table))
725 if (EQ (Fhash_table_count (Vkeyboard_translate_table), Qzero))
728 c = event_to_character (XEVENT (event), 0, 0, 0);
731 Lisp_Object traduit = Fgethash (make_char (c), Vkeyboard_translate_table,
733 if (!NILP (traduit) && SYMBOLP (traduit))
735 XEVENT (event)->event.key.keysym = traduit;
736 XEVENT (event)->event.key.modifiers = 0;
739 else if (CHARP (traduit))
743 /* This used to call Fcharacter_to_event() directly into EVENT,
744 but that can eradicate timestamps and other such stuff.
745 This way is safer. */
747 character_to_event (XCHAR (traduit), &ev2,
748 XCONSOLE (EVENT_CHANNEL (XEVENT (event))), 1, 1);
749 XEVENT (event)->event.key.keysym = ev2.event.key.keysym;
750 XEVENT (event)->event.key.modifiers = ev2.event.key.modifiers;
757 Lisp_Object traduit = Fgethash (XEVENT (event)->event.key.keysym,
758 Vkeyboard_translate_table, Qnil);
759 if (!NILP (traduit) && SYMBOLP (traduit))
761 XEVENT (event)->event.key.keysym = traduit;
764 else if (CHARP (traduit))
769 character_to_event (XCHAR (traduit), &ev2,
770 XCONSOLE (EVENT_CHANNEL (XEVENT (event))), 1, 1);
771 XEVENT (event)->event.key.keysym = ev2.event.key.keysym;
772 XEVENT (event)->event.key.modifiers |= ev2.event.key.modifiers;
779 DEBUG_PRINT_EMACS_EVENT ("->keyboard-translate-table", event);
783 /* NB: The following auto-save stuff is in keyboard.c in FSFmacs, and
784 keystrokes_since_auto_save is equivalent to the difference between
785 num_nonmacro_input_chars and last_auto_save. */
787 /* When an auto-save happens, record the number of keystrokes, and
788 don't do again soon. */
791 record_auto_save (void)
793 keystrokes_since_auto_save = 0;
796 /* Make an auto save happen as soon as possible at command level. */
799 force_auto_save_soon (void)
801 keystrokes_since_auto_save = 1 + max (auto_save_interval, 20);
805 maybe_do_auto_save (void)
807 /* This function can call lisp */
808 keystrokes_since_auto_save++;
809 if (auto_save_interval > 0 &&
810 keystrokes_since_auto_save > max (auto_save_interval, 20) &&
811 !detect_input_pending ())
813 Fdo_auto_save (Qnil, Qnil);
819 print_help (Lisp_Object object)
821 Fprinc (object, Qnil);
826 execute_help_form (struct command_builder *command_builder,
829 /* This function can GC */
830 Lisp_Object help = Qnil;
831 int speccount = specpdl_depth ();
832 Bytecount buf_index = command_builder->echo_buf_index;
833 Lisp_Object echo = ((buf_index <= 0)
835 : make_string (command_builder->echo_buf,
837 struct gcpro gcpro1, gcpro2;
840 record_unwind_protect (save_window_excursion_unwind,
841 Fcurrent_window_configuration (Qnil));
842 reset_key_echo (command_builder, 1);
844 help = Feval (Vhelp_form);
846 internal_with_output_to_temp_buffer (build_string ("*Help*"),
847 print_help, help, Qnil);
848 Fnext_command_event (event, Qnil);
849 /* Remove the help from the frame */
850 unbind_to (speccount, Qnil);
851 /* Hmmmm. Tricky. The unbind restores an old window configuration,
852 apparently bypassing any setting of windows_structure_changed.
853 So we need to set it so that things get redrawn properly. */
854 /* #### This is massive overkill. Look at doing it better once the
855 new redisplay is fully in place. */
857 Lisp_Object frmcons, devcons, concons;
858 FRAME_LOOP_NO_BREAK (frmcons, devcons, concons)
860 struct frame *f = XFRAME (XCAR (frmcons));
861 MARK_FRAME_WINDOWS_STRUCTURE_CHANGED (f);
866 if (event_matches_key_specifier_p (XEVENT (event), make_char (' ')))
868 /* Discard next key if it is a space */
869 reset_key_echo (command_builder, 1);
870 Fnext_command_event (event, Qnil);
873 command_builder->echo_buf_index = buf_index;
875 memcpy (command_builder->echo_buf,
876 XSTRING_DATA (echo), buf_index + 1); /* terminating 0 */
881 /**********************************************************************/
883 /**********************************************************************/
886 detect_input_pending (void)
888 /* Always call the event_pending_p hook even if there's an unread
889 character, because that might do some needed ^G detection (on
890 systems without SIGIO, for example).
892 if (event_stream_event_pending_p (1))
894 if (!NILP (Vunread_command_events) || !NILP (Vunread_command_event))
896 if (!NILP (command_event_queue))
900 EVENT_CHAIN_LOOP (event, command_event_queue)
902 if (XEVENT_TYPE (event) != eval_event
903 && XEVENT_TYPE (event) != magic_eval_event)
910 DEFUN ("input-pending-p", Finput_pending_p, 0, 0, 0, /*
911 Return t if command input is currently available with no waiting.
912 Actually, the value is nil only if we can be sure that no input is available.
916 return detect_input_pending () ? Qt : Qnil;
920 /**********************************************************************/
922 /**********************************************************************/
924 /**** Low-level timeout functions. ****
926 These functions maintain a sorted list of one-shot timeouts (where
927 the timeouts are in absolute time). They are intended for use by
928 functions that need to convert a list of absolute timeouts into a
929 series of intervals to wait for. */
931 /* We ensure that 0 is never a valid ID, so that a value of 0 can be
932 used to indicate an absence of a timer. */
933 static int low_level_timeout_id_tick;
935 static struct low_level_timeout_blocktype
937 Blocktype_declare (struct low_level_timeout);
938 } *the_low_level_timeout_blocktype;
940 /* Add a one-shot timeout at time TIME to TIMEOUT_LIST. Return
941 a unique ID identifying the timeout. */
944 add_low_level_timeout (struct low_level_timeout **timeout_list,
947 struct low_level_timeout *tm;
948 struct low_level_timeout *t, **tt;
950 /* Allocate a new time struct. */
952 tm = Blocktype_alloc (the_low_level_timeout_blocktype);
954 if (low_level_timeout_id_tick == 0)
955 low_level_timeout_id_tick++;
956 tm->id = low_level_timeout_id_tick++;
959 /* Add it to the queue. */
963 while (t && EMACS_TIME_EQUAL_OR_GREATER (tm->time, t->time))
974 /* Remove the low-level timeout identified by ID from TIMEOUT_LIST.
975 If the timeout is not there, do nothing. */
978 remove_low_level_timeout (struct low_level_timeout **timeout_list, int id)
980 struct low_level_timeout *t, *prev;
984 for (t = *timeout_list, prev = NULL; t && t->id != id; t = t->next)
988 return; /* couldn't find it */
991 *timeout_list = t->next;
992 else prev->next = t->next;
994 Blocktype_free (the_low_level_timeout_blocktype, t);
997 /* If there are timeouts on TIMEOUT_LIST, store the relative time
998 interval to the first timeout on the list into INTERVAL and
999 return 1. Otherwise, return 0. */
1002 get_low_level_timeout_interval (struct low_level_timeout *timeout_list,
1003 EMACS_TIME *interval)
1005 if (!timeout_list) /* no timer events; block indefinitely */
1009 EMACS_TIME current_time;
1011 /* The time to block is the difference between the first
1012 (earliest) timer on the queue and the current time.
1013 If that is negative, then the timer will fire immediately
1014 but we still have to call select(), with a zero-valued
1015 timeout: user events must have precedence over timer events. */
1016 EMACS_GET_TIME (current_time);
1017 if (EMACS_TIME_GREATER (timeout_list->time, current_time))
1018 EMACS_SUB_TIME (*interval, timeout_list->time,
1021 EMACS_SET_SECS_USECS (*interval, 0, 0);
1026 /* Pop the first (i.e. soonest) timeout off of TIMEOUT_LIST and return
1027 its ID. Also, if TIME_OUT is not 0, store the absolute time of the
1028 timeout into TIME_OUT. */
1031 pop_low_level_timeout (struct low_level_timeout **timeout_list,
1032 EMACS_TIME *time_out)
1034 struct low_level_timeout *tm = *timeout_list;
1040 *time_out = tm->time;
1041 *timeout_list = tm->next;
1042 Blocktype_free (the_low_level_timeout_blocktype, tm);
1047 /**** High-level timeout functions. ****/
1049 static int timeout_id_tick;
1051 static Lisp_Object pending_timeout_list, pending_async_timeout_list;
1053 static Lisp_Object Vtimeout_free_list;
1056 mark_timeout (Lisp_Object obj)
1058 Lisp_Timeout *tm = XTIMEOUT (obj);
1059 mark_object (tm->function);
1063 /* Should never, ever be called. (except by an external debugger) */
1065 print_timeout (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
1067 const Lisp_Timeout *t = XTIMEOUT (obj);
1070 sprintf (buf, "#<INTERNAL OBJECT (XEmacs bug?) (timeout) 0x%lx>",
1072 write_c_string (buf, printcharfun);
1075 static const struct lrecord_description timeout_description[] = {
1076 { XD_LISP_OBJECT, offsetof (Lisp_Timeout, function) },
1077 { XD_LISP_OBJECT, offsetof (Lisp_Timeout, object) },
1081 DEFINE_LRECORD_IMPLEMENTATION ("timeout", timeout,
1082 mark_timeout, print_timeout,
1083 0, 0, 0, timeout_description, Lisp_Timeout);
1085 /* Generate a timeout and return its ID. */
1088 event_stream_generate_wakeup (unsigned int milliseconds,
1089 unsigned int vanilliseconds,
1090 Lisp_Object function, Lisp_Object object,
1093 Lisp_Object op = allocate_managed_lcrecord (Vtimeout_free_list);
1094 Lisp_Timeout *timeout = XTIMEOUT (op);
1095 EMACS_TIME current_time;
1096 EMACS_TIME interval;
1098 timeout->id = timeout_id_tick++;
1099 timeout->resignal_msecs = vanilliseconds;
1100 timeout->function = function;
1101 timeout->object = object;
1103 EMACS_GET_TIME (current_time);
1104 EMACS_SET_SECS_USECS (interval, milliseconds / 1000,
1105 1000 * (milliseconds % 1000));
1106 EMACS_ADD_TIME (timeout->next_signal_time, current_time, interval);
1110 timeout->interval_id =
1111 event_stream_add_async_timeout (timeout->next_signal_time);
1112 pending_async_timeout_list = noseeum_cons (op,
1113 pending_async_timeout_list);
1117 timeout->interval_id =
1118 event_stream_add_timeout (timeout->next_signal_time);
1119 pending_timeout_list = noseeum_cons (op, pending_timeout_list);
1124 /* Given the INTERVAL-ID of a timeout just signalled, resignal the timeout
1125 as necessary and return the timeout's ID and function and object slots.
1127 This should be called as a result of receiving notice that a timeout
1128 has fired. INTERVAL-ID is *not* the timeout's ID, but is the ID that
1129 identifies this particular firing of the timeout. INTERVAL-ID's and
1130 timeout ID's are in separate number spaces and bear no relation to
1131 each other. The INTERVAL-ID is all that the event callback routines
1132 work with: they work only with one-shot intervals, not with timeouts
1133 that may fire repeatedly.
1135 NOTE: The returned FUNCTION and OBJECT are *not* GC-protected at all.
1139 event_stream_resignal_wakeup (int interval_id, int async_p,
1140 Lisp_Object *function, Lisp_Object *object)
1142 Lisp_Object op = Qnil, rest;
1143 Lisp_Timeout *timeout;
1144 Lisp_Object *timeout_list;
1145 struct gcpro gcpro1;
1148 GCPRO1 (op); /* just in case ... because it's removed from the list
1151 timeout_list = async_p ? &pending_async_timeout_list : &pending_timeout_list;
1153 /* Find the timeout on the list of pending ones. */
1154 LIST_LOOP (rest, *timeout_list)
1156 timeout = XTIMEOUT (XCAR (rest));
1157 if (timeout->interval_id == interval_id)
1161 assert (!NILP (rest));
1163 timeout = XTIMEOUT (op);
1164 /* We make sure to snarf the data out of the timeout object before
1165 we free it with free_managed_lcrecord(). */
1167 *function = timeout->function;
1168 *object = timeout->object;
1170 /* Remove this one from the list of pending timeouts */
1171 *timeout_list = delq_no_quit_and_free_cons (op, *timeout_list);
1173 /* If this timeout wants to be resignalled, do it now. */
1174 if (timeout->resignal_msecs)
1176 EMACS_TIME current_time;
1177 EMACS_TIME interval;
1179 /* Determine the time that the next resignalling should occur.
1180 We do that by adding the interval time to the last signalled
1181 time until we get a time that's current.
1183 (This way, it doesn't matter if the timeout was signalled
1184 exactly when we asked for it, or at some time later.)
1186 EMACS_GET_TIME (current_time);
1187 EMACS_SET_SECS_USECS (interval, timeout->resignal_msecs / 1000,
1188 1000 * (timeout->resignal_msecs % 1000));
1191 EMACS_ADD_TIME (timeout->next_signal_time, timeout->next_signal_time,
1193 } while (EMACS_TIME_GREATER (current_time, timeout->next_signal_time));
1196 timeout->interval_id =
1197 event_stream_add_async_timeout (timeout->next_signal_time);
1199 timeout->interval_id =
1200 event_stream_add_timeout (timeout->next_signal_time);
1201 /* Add back onto the list. Note that the effect of this
1202 is to move frequently-hit timeouts to the front of the
1203 list, which is a good thing. */
1204 *timeout_list = noseeum_cons (op, *timeout_list);
1207 free_managed_lcrecord (Vtimeout_free_list, op);
1214 event_stream_disable_wakeup (int id, int async_p)
1216 Lisp_Timeout *timeout = 0;
1218 Lisp_Object *timeout_list;
1221 timeout_list = &pending_async_timeout_list;
1223 timeout_list = &pending_timeout_list;
1225 /* Find the timeout on the list of pending ones, if it's still there. */
1226 LIST_LOOP (rest, *timeout_list)
1228 timeout = XTIMEOUT (XCAR (rest));
1229 if (timeout->id == id)
1233 /* If we found it, remove it from the list and disable the pending
1237 Lisp_Object op = XCAR (rest);
1239 delq_no_quit_and_free_cons (op, *timeout_list);
1241 event_stream_remove_async_timeout (timeout->interval_id);
1243 event_stream_remove_timeout (timeout->interval_id);
1244 free_managed_lcrecord (Vtimeout_free_list, op);
1249 event_stream_wakeup_pending_p (int id, int async_p)
1251 Lisp_Timeout *timeout;
1253 Lisp_Object timeout_list;
1258 timeout_list = pending_async_timeout_list;
1260 timeout_list = pending_timeout_list;
1262 /* Find the element on the list of pending ones, if it's still there. */
1263 LIST_LOOP (rest, timeout_list)
1265 timeout = XTIMEOUT (XCAR (rest));
1266 if (timeout->id == id)
1277 /**** Asynch. timeout functions (see also signal.c) ****/
1279 #if !defined (SIGIO) && !defined (DONT_POLL_FOR_QUIT)
1280 extern int poll_for_quit_id;
1283 #if defined(HAVE_UNIX_PROCESSES) && !defined(SIGCHLD)
1284 extern int poll_for_sigchld_id;
1288 event_stream_deal_with_async_timeout (int interval_id)
1290 /* This function can GC */
1291 Lisp_Object humpty, dumpty;
1292 #if ((!defined (SIGIO) && !defined (DONT_POLL_FOR_QUIT)) \
1293 || defined(HAVE_UNIX_PROCESSES) && !defined(SIGCHLD))
1296 event_stream_resignal_wakeup (interval_id, 1, &humpty, &dumpty);
1298 #if !defined (SIGIO) && !defined (DONT_POLL_FOR_QUIT)
1299 if (id == poll_for_quit_id)
1301 quit_check_signal_happened = 1;
1302 quit_check_signal_tick_count++;
1307 #if defined(HAVE_UNIX_PROCESSES) && !defined(SIGCHLD)
1308 if (id == poll_for_sigchld_id)
1310 kick_status_notify ();
1315 /* call1 GC-protects its arguments */
1316 call1_trapping_errors ("Error in asynchronous timeout callback",
1321 /**** Lisp-level timeout functions. ****/
1323 static unsigned long
1324 lisp_number_to_milliseconds (Lisp_Object secs, int allow_0)
1326 #ifdef LISP_FLOAT_TYPE
1328 CHECK_INT_OR_FLOAT (secs);
1329 fsecs = XFLOATINT (secs);
1333 fsecs = XINT (secs);
1336 signal_simple_error ("timeout is negative", secs);
1337 if (!allow_0 && fsecs == 0)
1338 signal_simple_error ("timeout is non-positive", secs);
1339 if (fsecs >= (((unsigned int) 0xFFFFFFFF) / 1000))
1341 ("timeout would exceed 32 bits when represented in milliseconds", secs);
1343 return (unsigned long) (1000 * fsecs);
1346 DEFUN ("add-timeout", Fadd_timeout, 3, 4, 0, /*
1347 Add a timeout, to be signaled after the timeout period has elapsed.
1348 SECS is a number of seconds, expressed as an integer or a float.
1349 FUNCTION will be called after that many seconds have elapsed, with one
1350 argument, the given OBJECT. If the optional RESIGNAL argument is provided,
1351 then after this timeout expires, `add-timeout' will automatically be called
1352 again with RESIGNAL as the first argument.
1354 This function returns an object which is the id number of this particular
1355 timeout. You can pass that object to `disable-timeout' to turn off the
1356 timeout before it has been signalled.
1358 NOTE: Id numbers as returned by this function are in a distinct namespace
1359 from those returned by `add-async-timeout'. This means that the same id
1360 number could refer to a pending synchronous timeout and a different pending
1361 asynchronous timeout, and that you cannot pass an id from `add-timeout'
1362 to `disable-async-timeout', or vice-versa.
1364 The number of seconds may be expressed as a floating-point number, in which
1365 case some fractional part of a second will be used. Caveat: the usable
1366 timeout granularity will vary from system to system.
1368 Adding a timeout causes a timeout event to be returned by `next-event', and
1369 the function will be invoked by `dispatch-event,' so if emacs is in a tight
1370 loop, the function will not be invoked until the next call to sit-for or
1371 until the return to top-level (the same is true of process filters).
1373 If you need to have a timeout executed even when XEmacs is in the midst of
1374 running Lisp code, use `add-async-timeout'.
1376 WARNING: if you are thinking of calling add-timeout from inside of a
1377 callback function as a way of resignalling a timeout, think again. There
1378 is a race condition. That's why the RESIGNAL argument exists.
1380 (secs, function, object, resignal))
1382 unsigned long msecs = lisp_number_to_milliseconds (secs, 0);
1383 unsigned long msecs2 = (NILP (resignal) ? 0 :
1384 lisp_number_to_milliseconds (resignal, 0));
1387 id = event_stream_generate_wakeup (msecs, msecs2, function, object, 0);
1388 lid = make_int (id);
1389 if (id != XINT (lid)) abort ();
1393 DEFUN ("disable-timeout", Fdisable_timeout, 1, 1, 0, /*
1394 Disable a timeout from signalling any more.
1395 ID should be a timeout id number as returned by `add-timeout'. If ID
1396 corresponds to a one-shot timeout that has already signalled, nothing
1399 It will not work to call this function on an id number returned by
1400 `add-async-timeout'. Use `disable-async-timeout' for that.
1405 event_stream_disable_wakeup (XINT (id), 0);
1409 DEFUN ("add-async-timeout", Fadd_async_timeout, 3, 4, 0, /*
1410 Add an asynchronous timeout, to be signaled after an interval has elapsed.
1411 SECS is a number of seconds, expressed as an integer or a float.
1412 FUNCTION will be called after that many seconds have elapsed, with one
1413 argument, the given OBJECT. If the optional RESIGNAL argument is provided,
1414 then after this timeout expires, `add-async-timeout' will automatically be
1415 called again with RESIGNAL as the first argument.
1417 This function returns an object which is the id number of this particular
1418 timeout. You can pass that object to `disable-async-timeout' to turn off
1419 the timeout before it has been signalled.
1421 NOTE: Id numbers as returned by this function are in a distinct namespace
1422 from those returned by `add-timeout'. This means that the same id number
1423 could refer to a pending synchronous timeout and a different pending
1424 asynchronous timeout, and that you cannot pass an id from
1425 `add-async-timeout' to `disable-timeout', or vice-versa.
1427 The number of seconds may be expressed as a floating-point number, in which
1428 case some fractional part of a second will be used. Caveat: the usable
1429 timeout granularity will vary from system to system.
1431 Adding an asynchronous timeout causes the function to be invoked as soon
1432 as the timeout occurs, even if XEmacs is in the midst of executing some
1433 other code. (This is unlike the synchronous timeouts added with
1434 `add-timeout', where the timeout will only be signalled when XEmacs is
1435 waiting for events, i.e. the next return to top-level or invocation of
1436 `sit-for' or related functions.) This means that the function that is
1437 called *must* not signal an error or change any global state (e.g. switch
1438 buffers or windows) except when locking code is in place to make sure
1439 that race conditions don't occur in the interaction between the
1440 asynchronous timeout function and other code.
1442 Under most circumstances, you should use `add-timeout' instead, as it is
1443 much safer. Asynchronous timeouts should only be used when such behavior
1444 is really necessary.
1446 Asynchronous timeouts are blocked and will not occur when `inhibit-quit'
1447 is non-nil. As soon as `inhibit-quit' becomes nil again, any pending
1448 asynchronous timeouts will get called immediately. (Multiple occurrences
1449 of the same asynchronous timeout are not queued, however.) While the
1450 callback function of an asynchronous timeout is invoked, `inhibit-quit'
1451 is automatically bound to non-nil, and thus other asynchronous timeouts
1452 will be blocked unless the callback function explicitly sets `inhibit-quit'
1455 WARNING: if you are thinking of calling `add-async-timeout' from inside of a
1456 callback function as a way of resignalling a timeout, think again. There
1457 is a race condition. That's why the RESIGNAL argument exists.
1459 (secs, function, object, resignal))
1461 unsigned long msecs = lisp_number_to_milliseconds (secs, 0);
1462 unsigned long msecs2 = (NILP (resignal) ? 0 :
1463 lisp_number_to_milliseconds (resignal, 0));
1466 id = event_stream_generate_wakeup (msecs, msecs2, function, object, 1);
1467 lid = make_int (id);
1468 if (id != XINT (lid)) abort ();
1472 DEFUN ("disable-async-timeout", Fdisable_async_timeout, 1, 1, 0, /*
1473 Disable an asynchronous timeout from signalling any more.
1474 ID should be a timeout id number as returned by `add-async-timeout'. If ID
1475 corresponds to a one-shot timeout that has already signalled, nothing
1478 It will not work to call this function on an id number returned by
1479 `add-timeout'. Use `disable-timeout' for that.
1484 event_stream_disable_wakeup (XINT (id), 1);
1489 /**********************************************************************/
1490 /* enqueuing and dequeuing events */
1491 /**********************************************************************/
1493 /* Add an event to the back of the command-event queue: it will be the next
1494 event read after all pending events. This only works on keyboard,
1495 mouse-click, misc-user, and eval events.
1498 enqueue_command_event (Lisp_Object event)
1500 enqueue_event (event, &command_event_queue, &command_event_queue_tail);
1504 dequeue_command_event (void)
1506 return dequeue_event (&command_event_queue, &command_event_queue_tail);
1509 /* put the event on the typeahead queue, unless
1510 the event is the quit char, in which case the `QUIT'
1511 which will occur on the next trip through this loop is
1512 all the processing we should do - leaving it on the queue
1513 would cause the quit to be processed twice.
1516 enqueue_command_event_1 (Lisp_Object event_to_copy)
1518 /* do not call check_quit() here. Vquit_flag was set in
1519 next_event_internal. */
1520 if (NILP (Vquit_flag))
1521 enqueue_command_event (Fcopy_event (event_to_copy, Qnil));
1525 enqueue_magic_eval_event (void (*fun) (Lisp_Object), Lisp_Object object)
1527 Lisp_Object event = Fmake_event (Qnil, Qnil);
1529 XEVENT (event)->event_type = magic_eval_event;
1530 /* channel for magic_eval events is nil */
1531 XEVENT (event)->event.magic_eval.internal_function = fun;
1532 XEVENT (event)->event.magic_eval.object = object;
1533 enqueue_command_event (event);
1536 DEFUN ("enqueue-eval-event", Fenqueue_eval_event, 2, 2, 0, /*
1537 Add an eval event to the back of the eval event queue.
1538 When this event is dispatched, FUNCTION (which should be a function
1539 of one argument) will be called with OBJECT as its argument.
1540 See `next-event' for a description of event types and how events
1545 Lisp_Object event = Fmake_event (Qnil, Qnil);
1547 XEVENT (event)->event_type = eval_event;
1548 /* channel for eval events is nil */
1549 XEVENT (event)->event.eval.function = function;
1550 XEVENT (event)->event.eval.object = object;
1551 enqueue_command_event (event);
1557 enqueue_misc_user_event (Lisp_Object channel, Lisp_Object function,
1560 Lisp_Object event = Fmake_event (Qnil, Qnil);
1562 XEVENT (event)->event_type = misc_user_event;
1563 XEVENT (event)->channel = channel;
1564 XEVENT (event)->event.misc.function = function;
1565 XEVENT (event)->event.misc.object = object;
1566 XEVENT (event)->event.misc.button = 0;
1567 XEVENT (event)->event.misc.modifiers = 0;
1568 XEVENT (event)->event.misc.x = -1;
1569 XEVENT (event)->event.misc.y = -1;
1570 enqueue_command_event (event);
1576 enqueue_misc_user_event_pos (Lisp_Object channel, Lisp_Object function,
1578 int button, int modifiers, int x, int y)
1580 Lisp_Object event = Fmake_event (Qnil, Qnil);
1582 XEVENT (event)->event_type = misc_user_event;
1583 XEVENT (event)->channel = channel;
1584 XEVENT (event)->event.misc.function = function;
1585 XEVENT (event)->event.misc.object = object;
1586 XEVENT (event)->event.misc.button = button;
1587 XEVENT (event)->event.misc.modifiers = modifiers;
1588 XEVENT (event)->event.misc.x = x;
1589 XEVENT (event)->event.misc.y = y;
1590 enqueue_command_event (event);
1596 /**********************************************************************/
1597 /* focus-event handling */
1598 /**********************************************************************/
1602 Ben's capsule lecture on focus:
1604 In FSFmacs `select-frame' never changes the window-manager frame
1605 focus. All it does is change the "selected frame". This is similar
1606 to what happens when we call `select-device' or `select-console'.
1607 Whenever an event comes in (including a keyboard event), its frame is
1608 selected; therefore, evaluating `select-frame' in *scratch* won't
1609 cause any effects because the next received event (in the same frame)
1610 will cause a switch back to the frame displaying *scratch*.
1612 Whenever a focus-change event is received from the window manager, it
1613 generates a `switch-frame' event, which causes the Lisp function
1614 `handle-switch-frame' to get run. This basically just runs
1615 `select-frame' (see below, however).
1617 In FSFmacs, if you want to have an operation run when a frame is
1618 selected, you supply an event binding for `switch-frame' (and then
1619 maybe call `handle-switch-frame', or something ...).
1621 In XEmacs, we *do* change the window-manager frame focus as a result
1622 of `select-frame', but not until the next time an event is received,
1623 so that a function that momentarily changes the selected frame won't
1624 cause WM focus flashing. (#### There's something not quite right here;
1625 this is causing the wrong-cursor-focus problems that you occasionally
1626 see. But the general idea is correct.) This approach is winning for
1627 people who use the explicit-focus model, but is trickier to implement.
1629 We also don't make the `switch-frame' event visible but instead have
1630 `select-frame-hook', which is a better approach.
1632 There is the problem of surrogate minibuffers, where when we enter the
1633 minibuffer, you essentially want to temporarily switch the WM focus to
1634 the frame with the minibuffer, and switch it back when you exit the
1637 FSFmacs solves this with the crockish `redirect-frame-focus', which
1638 says "for keyboard events received from FRAME, act like they're
1639 coming from FOCUS-FRAME". I think what this means is that, when
1640 a keyboard event comes in and the event manager is about to select the
1641 event's frame, if that frame has its focus redirected, the redirected-to
1642 frame is selected instead. That way, if you're in a minibufferless
1643 frame and enter the minibuffer, then all Lisp functions that run see
1644 the selected frame as the minibuffer's frame rather than the minibufferless
1645 frame you came from, so that (e.g.) your typing actually appears in
1646 the minibuffer's frame and things behave sanely.
1648 There's also some weird logic that switches the redirected frame focus
1649 from one frame to another if Lisp code explicitly calls `select-frame'
1650 \(but not if `handle-switch-frame' is called), and saves and restores
1651 the frame focus in window configurations, etc. etc. All of this logic
1652 is heavily #if 0'd, with lots of comments saying "No, this approach
1653 doesn't seem to work, so I'm trying this ... is it reasonable?
1654 Well, I'm not sure ..." that are a red flag indicating crockishness.
1656 Because of our way of doing things, we can avoid all this crock.
1657 Keyboard events never cause a select-frame (who cares what frame
1658 they're associated with? They come from a console, only). We change
1659 the actual WM focus to a surrogate minibuffer frame, so we don't have
1660 to do any internal redirection. In order to get the focus back,
1661 I took the approach in minibuf.el of just checking to see if the
1662 frame we moved to is still the selected frame, and move back to the
1663 old one if so. Conceivably we might have to do the weird "tracking"
1664 that FSFmacs does when `select-frame' is called, but I don't think
1665 so. If the selected frame moved from the minibuffer frame, then
1666 we just leave it there, figuring that someone knows what they're
1667 doing. Because we don't have any redirection recorded anywhere,
1668 it's safe to do this, and we don't end up with unwanted redirection.
1673 run_select_frame_hook (void)
1675 run_hook (Qselect_frame_hook);
1679 run_deselect_frame_hook (void)
1681 run_hook (Qdeselect_frame_hook);
1684 /* When select-frame is called and focus_follows_mouse is false, we want
1685 to tell the window system that the focus should be changed to point to
1686 the new frame. However,
1687 sometimes Lisp functions will temporarily change the selected frame
1688 (e.g. to call a function that operates on the selected frame),
1689 and it's annoying if this focus-change happens exactly when
1690 select-frame is called, because then you get some flickering of the
1691 window-manager border and perhaps other undesirable results. We
1692 really only want to change the focus when we're about to retrieve
1693 an event from the user. To do this, we keep track of the frame
1694 where the window-manager focus lies on, and just before waiting
1695 for user events, check the currently selected frame and change
1696 the focus as necessary.
1698 On the other hand, if focus_follows_mouse is true, we need to switch the
1699 selected frame back to the frame with window manager focus just before we
1700 execute the next command in Fcommand_loop_1, just as the selected buffer is
1701 reverted after a set-buffer.
1703 Both cases are handled by this function. It must be called as appropriate
1704 from these two places, depending on the value of focus_follows_mouse. */
1707 investigate_frame_change (void)
1709 Lisp_Object devcons, concons;
1711 /* if the selected frame was changed, change the window-system
1712 focus to the new frame. We don't do it when select-frame was
1713 called, to avoid flickering and other unwanted side effects when
1714 the frame is just changed temporarily. */
1715 DEVICE_LOOP_NO_BREAK (devcons, concons)
1717 struct device *d = XDEVICE (XCAR (devcons));
1718 Lisp_Object sel_frame = DEVICE_SELECTED_FRAME (d);
1720 /* You'd think that maybe we should use FRAME_WITH_FOCUS_REAL,
1721 but that can cause us to end up in an infinite loop focusing
1722 between two frames. It seems that since the call to `select-frame'
1723 in emacs_handle_focus_change_final() is based on the _FOR_HOOKS
1724 value, we need to do so too. */
1725 if (!NILP (sel_frame) &&
1726 !EQ (DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d), sel_frame) &&
1727 !NILP (DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d)) &&
1728 !EQ (DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d), sel_frame))
1730 /* At this point, we know that the frame has been changed. Now, if
1731 * focus_follows_mouse is not set, we finish off the frame change,
1732 * so that user events will now come from the new frame. Otherwise,
1733 * if focus_follows_mouse is set, no gratuitous frame changing
1734 * should take place. Set the focus back to the frame which was
1735 * originally selected for user input.
1737 if (!focus_follows_mouse)
1739 /* prevent us from issuing the same request more than once */
1740 DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d) = sel_frame;
1741 MAYBE_DEVMETH (d, focus_on_frame, (XFRAME (sel_frame)));
1745 Lisp_Object old_frame = Qnil;
1747 /* #### Do we really want to check OUGHT ??
1748 * It seems to make sense, though I have never seen us
1749 * get here and have it be non-nil.
1751 if (FRAMEP (DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d)))
1752 old_frame = DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d);
1753 else if (FRAMEP (DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d)))
1754 old_frame = DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d);
1756 /* #### Can old_frame ever be NIL? play it safe.. */
1757 if (!NILP (old_frame))
1759 /* Fselect_frame is not really the right thing: it frobs the
1760 * buffer stack. But there's no easy way to do the right
1761 * thing, and this code already had this problem anyway.
1763 Fselect_frame (old_frame);
1771 cleanup_after_missed_defocusing (Lisp_Object frame)
1773 if (FRAMEP (frame) && FRAME_LIVE_P (XFRAME (frame)))
1774 Fselect_frame (frame);
1779 emacs_handle_focus_change_preliminary (Lisp_Object frame_inp_and_dev)
1781 Lisp_Object frame = Fcar (frame_inp_and_dev);
1782 Lisp_Object device = Fcar (Fcdr (frame_inp_and_dev));
1783 int in_p = !NILP (Fcdr (Fcdr (frame_inp_and_dev)));
1786 if (!DEVICE_LIVE_P (XDEVICE (device)))
1789 d = XDEVICE (device);
1791 /* Any received focus-change notifications render invalid any
1792 pending focus-change requests. */
1793 DEVICE_FRAME_THAT_OUGHT_TO_HAVE_FOCUS (d) = Qnil;
1796 Lisp_Object focus_frame;
1798 if (!FRAME_LIVE_P (XFRAME (frame)))
1801 focus_frame = DEVICE_FRAME_WITH_FOCUS_REAL (d);
1803 /* Mark the minibuffer as changed to make sure it gets updated
1804 properly if the echo area is active. */
1806 struct window *w = XWINDOW (FRAME_MINIBUF_WINDOW (XFRAME (frame)));
1807 MARK_WINDOWS_CHANGED (w);
1810 if (FRAMEP (focus_frame) && FRAME_LIVE_P (XFRAME (focus_frame))
1811 && !EQ (frame, focus_frame))
1813 /* Oops, we missed a focus-out event. */
1814 DEVICE_FRAME_WITH_FOCUS_REAL (d) = Qnil;
1815 redisplay_redraw_cursor (XFRAME (focus_frame), 1);
1817 DEVICE_FRAME_WITH_FOCUS_REAL (d) = frame;
1818 if (!EQ (frame, focus_frame))
1820 redisplay_redraw_cursor (XFRAME (frame), 1);
1825 /* We ignore the frame reported in the event. If it's different
1826 from where we think the focus was, oh well -- we messed up.
1827 Nonetheless, we pretend we were right, for sensible behavior. */
1828 frame = DEVICE_FRAME_WITH_FOCUS_REAL (d);
1831 DEVICE_FRAME_WITH_FOCUS_REAL (d) = Qnil;
1833 if (FRAME_LIVE_P (XFRAME (frame)))
1834 redisplay_redraw_cursor (XFRAME (frame), 1);
1839 /* Called from the window-system-specific code when we receive a
1840 notification that the focus lies on a particular frame.
1841 Argument is a cons: (frame . (device . in-p)) where in-p is non-nil
1845 emacs_handle_focus_change_final (Lisp_Object frame_inp_and_dev)
1847 Lisp_Object frame = Fcar (frame_inp_and_dev);
1848 Lisp_Object device = Fcar (Fcdr (frame_inp_and_dev));
1849 int in_p = !NILP (Fcdr (Fcdr (frame_inp_and_dev)));
1853 if (!DEVICE_LIVE_P (XDEVICE (device)))
1856 d = XDEVICE (device);
1860 Lisp_Object focus_frame;
1862 if (!FRAME_LIVE_P (XFRAME (frame)))
1865 focus_frame = DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d);
1867 DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d) = frame;
1868 if (FRAMEP (focus_frame) && !EQ (frame, focus_frame))
1870 /* Oops, we missed a focus-out event. */
1871 Fselect_frame (focus_frame);
1872 /* Do an unwind-protect in case an error occurs in
1873 the deselect-frame-hook */
1874 count = specpdl_depth ();
1875 record_unwind_protect (cleanup_after_missed_defocusing, frame);
1876 run_deselect_frame_hook ();
1877 unbind_to (count, Qnil);
1878 /* the cleanup method changed the focus frame to nil, so
1879 we need to reflect this */
1883 Fselect_frame (frame);
1884 if (!EQ (frame, focus_frame))
1885 run_select_frame_hook ();
1889 /* We ignore the frame reported in the event. If it's different
1890 from where we think the focus was, oh well -- we messed up.
1891 Nonetheless, we pretend we were right, for sensible behavior. */
1892 frame = DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d);
1895 DEVICE_FRAME_WITH_FOCUS_FOR_HOOKS (d) = Qnil;
1896 run_deselect_frame_hook ();
1902 /**********************************************************************/
1903 /* retrieving the next event */
1904 /**********************************************************************/
1906 static int in_single_console;
1908 /* #### These functions don't currently do anything. */
1910 single_console_state (void)
1912 in_single_console = 1;
1916 any_console_state (void)
1918 in_single_console = 0;
1922 in_single_console_state (void)
1924 return in_single_console;
1927 /* the number of keyboard characters read. callint.c wants this. */
1928 Charcount num_input_chars;
1931 next_event_internal (Lisp_Object target_event, int allow_queued)
1933 struct gcpro gcpro1;
1934 /* QUIT; This is incorrect - the caller must do this because some
1935 callers (ie, Fnext_event()) do not want to QUIT. */
1937 assert (NILP (XEVENT_NEXT (target_event)));
1939 GCPRO1 (target_event);
1941 /* When focus_follows_mouse is nil, if a frame change took place, we need
1942 * to actually switch window manager focus to the selected window now.
1944 if (!focus_follows_mouse)
1945 investigate_frame_change ();
1947 if (allow_queued && !NILP (command_event_queue))
1949 Lisp_Object event = dequeue_command_event ();
1950 Fcopy_event (event, target_event);
1951 Fdeallocate_event (event);
1952 DEBUG_PRINT_EMACS_EVENT ("command event queue", target_event);
1956 Lisp_Event *e = XEVENT (target_event);
1958 /* The command_event_queue was empty. Wait for an event. */
1959 event_stream_next_event (e);
1960 /* If this was a timeout, then we need to extract some data
1961 out of the returned closure and might need to resignal
1963 if (e->event_type == timeout_event)
1965 Lisp_Object tristan, isolde;
1967 e->event.timeout.id_number =
1968 event_stream_resignal_wakeup (e->event.timeout.interval_id, 0,
1971 e->event.timeout.function = tristan;
1972 e->event.timeout.object = isolde;
1973 /* next_event_internal() doesn't print out timeout events
1974 because of the extra info we just set. */
1975 DEBUG_PRINT_EMACS_EVENT ("real, timeout", target_event);
1978 /* If we read a ^G, then set quit-flag but do not discard the ^G.
1979 The callers of next_event_internal() will do one of two things:
1981 -- set Vquit_flag to Qnil. (next-event does this.) This will
1982 cause the ^G to be treated as a normal keystroke.
1983 -- not change Vquit_flag but attempt to enqueue the ^G, at
1984 which point it will be discarded. The next time QUIT is
1985 called, it will notice that Vquit_flag was set.
1988 if (e->event_type == key_press_event &&
1989 event_matches_key_specifier_p
1990 (e, make_char (CONSOLE_QUIT_CHAR (XCONSOLE (EVENT_CHANNEL (e))))))
2000 run_pre_idle_hook (void)
2002 if (!NILP (Vpre_idle_hook)
2003 && !detect_input_pending ())
2004 safe_run_hook_trapping_errors
2005 ("Error in `pre-idle-hook' (setting hook to nil)",
2009 static void push_this_command_keys (Lisp_Object event);
2010 static void push_recent_keys (Lisp_Object event);
2011 static void dribble_out_event (Lisp_Object event);
2012 static void execute_internal_event (Lisp_Object event);
2014 DEFUN ("next-event", Fnext_event, 0, 2, 0, /*
2015 Return the next available event.
2016 Pass this object to `dispatch-event' to handle it.
2017 In most cases, you will want to use `next-command-event', which returns
2018 the next available "user" event (i.e. keypress, button-press,
2019 button-release, or menu selection) instead of this function.
2021 If EVENT is non-nil, it should be an event object and will be filled in
2022 and returned; otherwise a new event object will be created and returned.
2023 If PROMPT is non-nil, it should be a string and will be displayed in the
2024 echo area while this function is waiting for an event.
2026 The next available event will be
2028 -- any events in `unread-command-events' or `unread-command-event'; else
2029 -- the next event in the currently executing keyboard macro, if any; else
2030 -- an event queued by `enqueue-eval-event', if any, or any similar event
2031 queued internally, such as a misc-user event. (For example, when an item
2032 is selected from a menu or from a `question'-type dialog box, the item's
2033 callback is not immediately executed, but instead a misc-user event
2034 is generated and placed onto this queue; when it is dispatched, the
2035 callback is executed.) Else
2036 -- the next available event from the window system or terminal driver.
2038 In the last case, this function will block until an event is available.
2040 The returned event will be one of the following types:
2042 -- a key-press event.
2043 -- a button-press or button-release event.
2044 -- a misc-user-event, meaning the user selected an item on a menu or used
2046 -- a process event, meaning that output from a subprocess is available.
2047 -- a timeout event, meaning that a timeout has elapsed.
2048 -- an eval event, which simply causes a function to be executed when the
2049 event is dispatched. Eval events are generated by `enqueue-eval-event'
2050 or by certain other conditions happening.
2051 -- a magic event, indicating that some window-system-specific event
2052 happened (such as a focus-change notification) that must be handled
2053 synchronously with other events. `dispatch-event' knows what to do with
2058 /* This function can call lisp */
2059 /* #### We start out using the selected console before an event
2060 is received, for echoing the partially completed command.
2061 This is most definitely wrong -- there needs to be a separate
2062 echo area for each console! */
2063 struct console *con = XCONSOLE (Vselected_console);
2064 struct command_builder *command_builder =
2065 XCOMMAND_BUILDER (con->command_builder);
2066 int store_this_key = 0;
2067 struct gcpro gcpro1;
2070 /* DO NOT do QUIT anywhere within this function or the functions it calls.
2071 We want to read the ^G as an event. */
2073 #ifdef LWLIB_MENUBARS_LUCID
2075 * #### Fix the menu code so this isn't necessary.
2077 * We cannot allow the lwmenu code to be reentered, because the
2078 * code is not written to be reentrant and will crash. Therefore
2079 * paths from the menu callbacks back into the menu code have to
2080 * be blocked. Fnext_event is the normal path into the menu code,
2081 * so we signal an error here.
2083 if (in_menu_callback)
2084 error ("Attempt to call next-event inside menu callback");
2085 #endif /* LWLIB_MENUBARS_LUCID */
2088 event = Fmake_event (Qnil, Qnil);
2090 CHECK_LIVE_EVENT (event);
2095 CHECK_STRING (prompt);
2097 len = XSTRING_LENGTH (prompt);
2098 if (command_builder->echo_buf_length < len)
2099 len = command_builder->echo_buf_length - 1;
2100 memcpy (command_builder->echo_buf, XSTRING_DATA (prompt), len);
2101 command_builder->echo_buf[len] = 0;
2102 command_builder->echo_buf_index = len;
2103 echo_area_message (XFRAME (CONSOLE_SELECTED_FRAME (con)),
2104 command_builder->echo_buf,
2106 command_builder->echo_buf_index,
2110 start_over_and_avoid_hosage:
2112 /* If there is something in unread-command-events, simply return it.
2113 But do some error checking to make sure the user hasn't put something
2114 in the unread-command-events that they shouldn't have.
2115 This does not update this-command-keys and recent-keys.
2117 if (!NILP (Vunread_command_events))
2119 if (!CONSP (Vunread_command_events))
2121 Vunread_command_events = Qnil;
2122 signal_error (Qwrong_type_argument,
2123 list3 (Qconsp, Vunread_command_events,
2124 Qunread_command_events));
2128 Lisp_Object e = XCAR (Vunread_command_events);
2129 Vunread_command_events = XCDR (Vunread_command_events);
2130 if (!EVENTP (e) || !command_event_p (e))
2131 signal_error (Qwrong_type_argument,
2132 list3 (Qcommand_event_p, e, Qunread_command_events));
2135 Fcopy_event (e, event);
2136 DEBUG_PRINT_EMACS_EVENT ("unread-command-events", event);
2140 /* Do similar for unread-command-event (obsoleteness support). */
2141 else if (!NILP (Vunread_command_event))
2143 Lisp_Object e = Vunread_command_event;
2144 Vunread_command_event = Qnil;
2146 if (!EVENTP (e) || !command_event_p (e))
2148 signal_error (Qwrong_type_argument,
2149 list3 (Qeventp, e, Qunread_command_event));
2152 Fcopy_event (e, event);
2154 DEBUG_PRINT_EMACS_EVENT ("unread-command-event", event);
2157 /* If we're executing a keyboard macro, take the next event from that,
2158 and update this-command-keys and recent-keys.
2159 Note that the unread-command-events take precedence over kbd macros.
2163 if (!NILP (Vexecuting_macro))
2166 pop_kbd_macro_event (event); /* This throws past us at
2169 DEBUG_PRINT_EMACS_EVENT ("keyboard macro", event);
2171 /* Otherwise, read a real event, possibly from the
2172 command_event_queue, and update this-command-keys and
2176 run_pre_idle_hook ();
2178 next_event_internal (event, 1);
2179 Vquit_flag = Qnil; /* Read C-g as an event. */
2184 status_notify (); /* Notice process change */
2187 alloca (0); /* Cause a garbage collection now */
2188 /* Since we can free the most stuff here
2189 * (since this is typically called from
2190 * the command-loop top-level). */
2191 #endif /* C_ALLOCA */
2193 if (object_dead_p (XEVENT (event)->channel))
2194 /* event_console_or_selected may crash if the channel is dead.
2195 Best just to eat it and get the next event. */
2196 goto start_over_and_avoid_hosage;
2198 /* OK, now we can stop the selected-console kludge and use the
2199 actual console from the event. */
2200 con = event_console_or_selected (event);
2201 command_builder = XCOMMAND_BUILDER (con->command_builder);
2203 switch (XEVENT_TYPE (event))
2207 case button_release_event:
2208 case misc_user_event:
2209 /* don't echo menu accelerator keys */
2210 reset_key_echo (command_builder, 1);
2212 case button_press_event: /* key or mouse input can trigger prompting */
2213 goto STORE_AND_EXECUTE_KEY;
2214 case key_press_event: /* any key input can trigger autosave */
2218 maybe_do_auto_save ();
2220 STORE_AND_EXECUTE_KEY:
2223 echo_key_event (command_builder, event);
2227 /* Store the last-input-event. The semantics of this is that it is
2228 the thing most recently returned by next-command-event. It need
2229 not have come from the keyboard or a keyboard macro, it may have
2230 come from unread-command-events. It's always a command-event (a
2231 key, click, or menu selection), never a motion or process event.
2233 if (!EVENTP (Vlast_input_event))
2234 Vlast_input_event = Fmake_event (Qnil, Qnil);
2235 if (XEVENT_TYPE (Vlast_input_event) == dead_event)
2237 Vlast_input_event = Fmake_event (Qnil, Qnil);
2238 error ("Someone deallocated last-input-event!");
2240 if (! EQ (event, Vlast_input_event))
2241 Fcopy_event (event, Vlast_input_event);
2243 /* last-input-char and last-input-time are derived from
2245 Note that last-input-char will never have its high-bit set, in an
2246 effort to sidestep the ambiguity between M-x and oslash.
2248 Vlast_input_char = Fevent_to_character (Vlast_input_event,
2253 if (!CONSP (Vlast_input_time))
2254 Vlast_input_time = Fcons (Qnil, Qnil);
2255 XCAR (Vlast_input_time) = make_int ((EMACS_SECS (t) >> 16) & 0xffff);
2256 XCDR (Vlast_input_time) = make_int ((EMACS_SECS (t) >> 0) & 0xffff);
2257 if (!CONSP (Vlast_command_event_time))
2258 Vlast_command_event_time = list3 (Qnil, Qnil, Qnil);
2259 XCAR (Vlast_command_event_time) =
2260 make_int ((EMACS_SECS (t) >> 16) & 0xffff);
2261 XCAR (XCDR (Vlast_command_event_time)) =
2262 make_int ((EMACS_SECS (t) >> 0) & 0xffff);
2263 XCAR (XCDR (XCDR (Vlast_command_event_time)))
2264 = make_int (EMACS_USECS (t));
2266 /* If this key came from the keyboard or from a keyboard macro, then
2267 it goes into the recent-keys and this-command-keys vectors.
2268 If this key came from the keyboard, and we're defining a keyboard
2269 macro, then it goes into the macro.
2273 push_this_command_keys (event);
2274 if (!inhibit_input_event_recording)
2275 push_recent_keys (event);
2276 dribble_out_event (event);
2277 if (!NILP (con->defining_kbd_macro) && NILP (Vexecuting_macro))
2279 if (!EVENTP (command_builder->current_events))
2280 finalize_kbd_macro_chars (con);
2281 store_kbd_macro_event (event);
2284 /* If this is the help char and there is a help form, then execute the
2285 help form and swallow this character. This is the only place where
2286 calling Fnext_event() can cause arbitrary lisp code to run. Note
2287 that execute_help_form() calls Fnext_command_event(), which calls
2288 this function, as well as Fdispatch_event.
2290 if (!NILP (Vhelp_form) &&
2291 event_matches_key_specifier_p (XEVENT (event), Vhelp_char))
2292 execute_help_form (command_builder, event);
2299 DEFUN ("next-command-event", Fnext_command_event, 0, 2, 0, /*
2300 Return the next available "user" event.
2301 Pass this object to `dispatch-event' to handle it.
2303 If EVENT is non-nil, it should be an event object and will be filled in
2304 and returned; otherwise a new event object will be created and returned.
2305 If PROMPT is non-nil, it should be a string and will be displayed in the
2306 echo area while this function is waiting for an event.
2308 The event returned will be a keyboard, mouse press, or mouse release event.
2309 If there are non-command events available (mouse motion, sub-process output,
2310 etc) then these will be executed (with `dispatch-event') and discarded. This
2311 function is provided as a convenience; it is roughly equivalent to the lisp code
2314 (next-event event prompt)
2315 (not (or (key-press-event-p event)
2316 (button-press-event-p event)
2317 (button-release-event-p event)
2318 (misc-user-event-p event))))
2319 (dispatch-event event))
2321 but it also makes a provision for displaying keystrokes in the echo area.
2325 /* This function can GC */
2326 struct gcpro gcpro1;
2328 maybe_echo_keys (XCOMMAND_BUILDER
2329 (XCONSOLE (Vselected_console)->
2330 command_builder), 0); /* #### This sucks bigtime */
2333 event = Fnext_event (event, prompt);
2334 if (command_event_p (event))
2337 execute_internal_event (event);
2343 DEFUN ("dispatch-non-command-events", Fdispatch_non_command_events, 0, 0, 0, /*
2344 Dispatch any pending "magic" events.
2346 This function is useful for forcing the redisplay of native
2347 widgets. Normally these are redisplayed through a native window-system
2348 event encoded as magic event, rather than by the redisplay code. This
2349 function does not call redisplay or do any of the other things that
2354 /* This function can GC */
2355 Lisp_Object event = Qnil;
2356 struct gcpro gcpro1;
2358 event = Fmake_event (Qnil, Qnil);
2360 /* Make sure that there will be something in the native event queue
2361 so that externally managed things (e.g. widgets) get some CPU
2363 event_stream_force_event_pending (selected_frame ());
2365 while (event_stream_event_pending_p (0))
2367 QUIT; /* next_event_internal() does not QUIT. */
2369 /* We're a generator of the command_event_queue, so we can't be a
2370 consumer as well. Also, we have no reason to consult the
2371 command_event_queue; there are only user and eval-events there,
2372 and we'd just have to put them back anyway.
2374 next_event_internal (event, 0); /* blocks */
2375 /* See the comment in accept-process-output about Vquit_flag */
2376 if (XEVENT_TYPE (event) == magic_event ||
2377 XEVENT_TYPE (event) == timeout_event ||
2378 XEVENT_TYPE (event) == process_event ||
2379 XEVENT_TYPE (event) == pointer_motion_event)
2380 execute_internal_event (event);
2383 enqueue_command_event_1 (event);
2388 Fdeallocate_event (event);
2394 reset_current_events (struct command_builder *command_builder)
2396 Lisp_Object event = command_builder->current_events;
2397 reset_command_builder_event_chain (command_builder);
2399 deallocate_event_chain (event);
2402 DEFUN ("discard-input", Fdiscard_input, 0, 0, 0, /*
2403 Discard any pending "user" events.
2404 Also cancel any kbd macro being defined.
2405 A user event is a key press, button press, button release, or
2406 "misc-user" event (menu selection or scrollbar action).
2410 /* This throws away user-input on the queue, but doesn't process any
2411 events. Calling dispatch_event() here leads to a race condition.
2413 Lisp_Object event = Fmake_event (Qnil, Qnil);
2414 Lisp_Object head = Qnil, tail = Qnil;
2415 Lisp_Object oiq = Vinhibit_quit;
2416 struct gcpro gcpro1, gcpro2;
2417 /* #### not correct here with Vselected_console? Should
2418 discard-input take a console argument, or maybe map over
2420 struct console *con = XCONSOLE (Vselected_console);
2422 /* next_event_internal() can cause arbitrary Lisp code to be evalled */
2423 GCPRO2 (event, oiq);
2425 /* If a macro was being defined then we have to mark the modeline
2426 has changed to ensure that it gets updated correctly. */
2427 if (!NILP (con->defining_kbd_macro))
2428 MARK_MODELINE_CHANGED;
2429 con->defining_kbd_macro = Qnil;
2430 reset_current_events (XCOMMAND_BUILDER (con->command_builder));
2432 while (!NILP (command_event_queue)
2433 || event_stream_event_pending_p (1))
2435 /* This will take stuff off the command_event_queue, or read it
2436 from the event_stream, but it will not block.
2438 next_event_internal (event, 1);
2439 Vquit_flag = Qnil; /* Treat C-g as a user event (ignore it).
2440 It is vitally important that we reset
2441 Vquit_flag here. Otherwise, if we're
2442 reading from a TTY console,
2443 maybe_read_quit_event() will notice
2444 that C-g has been set and send us
2445 another C-g. That will cause us
2446 to get right back here, and read
2447 another C-g, ad infinitum ... */
2449 /* If the event is a user event, ignore it. */
2450 if (!command_event_p (event))
2452 /* Otherwise, chain the event onto our list of events not to ignore,
2453 and keep reading until the queue is empty. This does not mean
2454 that if a subprocess is generating an infinite amount of output,
2455 we will never terminate (*provided* that the behavior of
2456 next_event_cb() is correct -- see the comment in events.h),
2457 because this loop ends as soon as there are no more user events
2458 on the command_event_queue or event_stream.
2460 enqueue_event (Fcopy_event (event, Qnil), &head, &tail);
2464 if (!NILP (command_event_queue) || !NILP (command_event_queue_tail))
2467 /* Now tack our chain of events back on to the front of the queue.
2468 Actually, since the queue is now drained, we can just replace it.
2469 The effect of this will be that we have deleted all user events
2470 from the input stream without changing the relative ordering of
2471 any other events. (Some events may have been taken from the
2472 event_stream and added to the command_event_queue, however.)
2474 At this time, the command_event_queue will contain only eval_events.
2477 command_event_queue = head;
2478 command_event_queue_tail = tail;
2480 Fdeallocate_event (event);
2483 Vinhibit_quit = oiq;
2488 /**********************************************************************/
2489 /* pausing until an action occurs */
2490 /**********************************************************************/
2492 /* This is used in accept-process-output, sleep-for and sit-for.
2493 Before running any process_events in these routines, we set
2494 recursive_sit_for to Qt, and use this unwind protect to reset it to
2495 Qnil upon exit. When recursive_sit_for is Qt, calling sit-for will
2496 cause it to return immediately.
2498 All of these routines install timeouts, so we clear the installed
2501 Note: It's very easy to break the desired behaviors of these
2502 3 routines. If you make any changes to anything in this area, run
2503 the regression tests at the bottom of the file. -- dmoore */
2507 sit_for_unwind (Lisp_Object timeout_id)
2509 if (!NILP(timeout_id))
2510 Fdisable_timeout (timeout_id);
2512 recursive_sit_for = Qnil;
2516 /* #### Is (accept-process-output nil 3) supposed to be like (sleep-for 3)?
2519 DEFUN ("accept-process-output", Faccept_process_output, 0, 3, 0, /*
2520 Allow any pending output from subprocesses to be read by Emacs.
2521 It is read into the process' buffers or given to their filter functions.
2522 Non-nil arg PROCESS means do not return until some output has been received
2523 from PROCESS. Nil arg PROCESS means do not return until some output has
2524 been received from any process.
2525 If the second arg is non-nil, it is the maximum number of seconds to wait:
2526 this function will return after that much time even if no input has arrived
2527 from PROCESS. This argument may be a float, meaning wait some fractional
2529 If the third arg is non-nil, it is a number of milliseconds that is added
2530 to the second arg. (This exists only for compatibility.)
2531 Return non-nil iff we received any output before the timeout expired.
2533 (process, timeout_secs, timeout_msecs))
2535 /* This function can GC */
2536 struct gcpro gcpro1, gcpro2;
2537 Lisp_Object event = Qnil;
2538 Lisp_Object result = Qnil;
2539 int timeout_id = -1;
2540 int timeout_enabled = 0;
2542 struct buffer *old_buffer = current_buffer;
2545 /* We preserve the current buffer but nothing else. If a focus
2546 change alters the selected window then the top level event loop
2547 will eventually alter current_buffer to match. In the mean time
2548 we don't want to mess up whatever called this function. */
2550 if (!NILP (process))
2551 CHECK_PROCESS (process);
2553 GCPRO2 (event, process);
2555 if (!NILP (timeout_secs) || !NILP (timeout_msecs))
2557 unsigned long msecs = 0;
2558 if (!NILP (timeout_secs))
2559 msecs = lisp_number_to_milliseconds (timeout_secs, 1);
2560 if (!NILP (timeout_msecs))
2562 CHECK_NATNUM (timeout_msecs);
2563 msecs += XINT (timeout_msecs);
2567 timeout_id = event_stream_generate_wakeup (msecs, 0, Qnil, Qnil, 0);
2568 timeout_enabled = 1;
2572 event = Fmake_event (Qnil, Qnil);
2574 count = specpdl_depth ();
2575 record_unwind_protect (sit_for_unwind,
2576 timeout_enabled ? make_int (timeout_id) : Qnil);
2577 recursive_sit_for = Qt;
2580 ((NILP (process) && timeout_enabled) ||
2581 (NILP (process) && event_stream_event_pending_p (0)) ||
2583 /* Calling detect_input_pending() is the wrong thing here, because
2584 that considers the Vunread_command_events and command_event_queue.
2585 We don't need to look at the command_event_queue because we are
2586 only interested in process events, which don't go on that. In
2587 fact, we can't read from it anyway, because we put stuff on it.
2589 Note that event_stream->event_pending_p must be called in such
2590 a way that it says whether any events *of any kind* are ready,
2591 not just user events, or (accept-process-output nil) will fail
2592 to dispatch any process events that may be on the queue. It is
2593 not clear to me that this is important, because the top-level
2594 loop will process it, and I don't think that there is ever a
2595 time when one calls accept-process-output with a nil argument
2596 and really need the processes to be handled. */
2598 /* If our timeout has arrived, we move along. */
2599 if (timeout_enabled && !event_stream_wakeup_pending_p (timeout_id, 0))
2601 timeout_enabled = 0;
2602 done = 1; /* We're done. */
2603 continue; /* Don't call next_event_internal */
2606 QUIT; /* next_event_internal() does not QUIT, so check for ^G
2607 before reading output from the process - this makes it
2608 less likely that the filter will actually be aborted.
2611 next_event_internal (event, 0);
2612 /* If C-g was pressed while we were waiting, Vquit_flag got
2613 set and next_event_internal() also returns C-g. When
2614 we enqueue the C-g below, it will get discarded. The
2615 next time through, QUIT will be called and will signal a quit. */
2616 switch (XEVENT_TYPE (event))
2620 if (NILP (process) ||
2621 EQ (XEVENT (event)->event.process.process, process))
2624 /* RMS's version always returns nil when proc is nil,
2625 and only returns t if input ever arrived on proc. */
2629 execute_internal_event (event);
2633 /* We execute the event even if it's ours, and notice that it's
2635 case pointer_motion_event:
2638 execute_internal_event (event);
2643 enqueue_command_event_1 (event);
2649 unbind_to (count, timeout_enabled ? make_int (timeout_id) : Qnil);
2651 Fdeallocate_event (event);
2653 current_buffer = old_buffer;
2657 DEFUN ("sleep-for", Fsleep_for, 1, 1, 0, /*
2658 Pause, without updating display, for SECONDS seconds.
2659 SECONDS may be a float, allowing pauses for fractional parts of a second.
2661 It is recommended that you never call sleep-for from inside of a process
2662 filter function or timer event (either synchronous or asynchronous).
2666 /* This function can GC */
2667 unsigned long msecs = lisp_number_to_milliseconds (seconds, 1);
2669 Lisp_Object event = Qnil;
2671 struct gcpro gcpro1;
2675 id = event_stream_generate_wakeup (msecs, 0, Qnil, Qnil, 0);
2676 event = Fmake_event (Qnil, Qnil);
2678 count = specpdl_depth ();
2679 record_unwind_protect (sit_for_unwind, make_int (id));
2680 recursive_sit_for = Qt;
2684 /* If our timeout has arrived, we move along. */
2685 if (!event_stream_wakeup_pending_p (id, 0))
2688 QUIT; /* next_event_internal() does not QUIT, so check for ^G
2689 before reading output from the process - this makes it
2690 less likely that the filter will actually be aborted.
2692 /* We're a generator of the command_event_queue, so we can't be a
2693 consumer as well. We don't care about command and eval-events
2696 next_event_internal (event, 0); /* blocks */
2697 /* See the comment in accept-process-output about Vquit_flag */
2698 switch (XEVENT_TYPE (event))
2701 /* We execute the event even if it's ours, and notice that it's
2704 case pointer_motion_event:
2707 execute_internal_event (event);
2712 enqueue_command_event_1 (event);
2718 unbind_to (count, make_int (id));
2719 Fdeallocate_event (event);
2724 DEFUN ("sit-for", Fsit_for, 1, 2, 0, /*
2725 Perform redisplay, then wait SECONDS seconds or until user input is available.
2726 SECONDS may be a float, meaning a fractional part of a second.
2727 Optional second arg NODISPLAY non-nil means don't redisplay; just wait.
2728 Redisplay is preempted as always if user input arrives, and does not
2729 happen if input is available before it starts.
2730 Value is t if waited the full time with no input arriving.
2732 If sit-for is called from within a process filter function or timer
2733 event (either synchronous or asynchronous) it will return immediately.
2735 (seconds, nodisplay))
2737 /* This function can GC */
2738 unsigned long msecs = lisp_number_to_milliseconds (seconds, 1);
2739 Lisp_Object event, result;
2740 struct gcpro gcpro1;
2744 /* The unread-command-events count as pending input */
2745 if (!NILP (Vunread_command_events) || !NILP (Vunread_command_event))
2748 /* If the command-builder already has user-input on it (not eval events)
2749 then that means we're done too.
2751 if (!NILP (command_event_queue))
2753 EVENT_CHAIN_LOOP (event, command_event_queue)
2755 if (command_event_p (event))
2760 /* If we're in a macro, or noninteractive, or early in temacs, then
2762 if (noninteractive || !NILP (Vexecuting_macro))
2765 /* Recursive call from a filter function or timeout handler. */
2766 if (!NILP(recursive_sit_for))
2768 if (!event_stream_event_pending_p (1) && NILP (nodisplay))
2770 run_pre_idle_hook ();
2777 /* Otherwise, start reading events from the event_stream.
2778 Do this loop at least once even if (sit-for 0) so that we
2779 redisplay when no input pending.
2782 event = Fmake_event (Qnil, Qnil);
2784 /* Generate the wakeup even if MSECS is 0, so that existing timeout/etc.
2785 events get processed. The old (pre-19.12) code special-cased this
2786 and didn't generate a wakeup, but the resulting behavior was less than
2787 ideal; viz. the occurrence of (sit-for 0.001) scattered throughout
2788 the E-Lisp universe. */
2790 id = event_stream_generate_wakeup (msecs, 0, Qnil, Qnil, 0);
2792 count = specpdl_depth ();
2793 record_unwind_protect (sit_for_unwind, make_int (id));
2794 recursive_sit_for = Qt;
2798 /* If there is no user input pending, then redisplay.
2800 if (!event_stream_event_pending_p (1) && NILP (nodisplay))
2802 run_pre_idle_hook ();
2806 /* If our timeout has arrived, we move along. */
2807 if (!event_stream_wakeup_pending_p (id, 0))
2813 QUIT; /* next_event_internal() does not QUIT, so check for ^G
2814 before reading output from the process - this makes it
2815 less likely that the filter will actually be aborted.
2817 /* We're a generator of the command_event_queue, so we can't be a
2818 consumer as well. In fact, we know there's nothing on the
2819 command_event_queue that we didn't just put there.
2821 next_event_internal (event, 0); /* blocks */
2822 /* See the comment in accept-process-output about Vquit_flag */
2824 if (command_event_p (event))
2826 QUIT; /* If the command was C-g check it here
2827 so that we abort out of the sit-for,
2828 not the next command. sleep-for and
2829 accept-process-output continue looping
2830 so they check QUIT again implicitly.*/
2834 switch (XEVENT_TYPE (event))
2838 /* eval-events get delayed until later. */
2839 enqueue_command_event (Fcopy_event (event, Qnil));
2844 /* We execute the event even if it's ours, and notice that it's
2848 execute_internal_event (event);
2855 unbind_to (count, make_int (id));
2857 /* Put back the event (if any) that made Fsit_for() exit before the
2858 timeout. Note that it is being added to the back of the queue, which
2859 would be inappropriate if there were any user events on the queue
2860 already: we would be misordering them. But we know that there are
2861 no user-events on the queue, or else we would not have reached this
2865 enqueue_command_event (event);
2867 Fdeallocate_event (event);
2873 /* This handy little function is used by select-x.c to wait for replies
2874 from processes that aren't really processes (e.g. the X server) */
2876 wait_delaying_user_input (int (*predicate) (void *arg), void *predicate_arg)
2878 /* This function can GC */
2879 Lisp_Object event = Fmake_event (Qnil, Qnil);
2880 struct gcpro gcpro1;
2883 while (!(*predicate) (predicate_arg))
2885 QUIT; /* next_event_internal() does not QUIT. */
2887 /* We're a generator of the command_event_queue, so we can't be a
2888 consumer as well. Also, we have no reason to consult the
2889 command_event_queue; there are only user and eval-events there,
2890 and we'd just have to put them back anyway.
2892 next_event_internal (event, 0);
2893 /* See the comment in accept-process-output about Vquit_flag */
2894 if (command_event_p (event)
2895 || (XEVENT_TYPE (event) == eval_event)
2896 || (XEVENT_TYPE (event) == magic_eval_event))
2897 enqueue_command_event_1 (event);
2899 execute_internal_event (event);
2905 /**********************************************************************/
2906 /* dispatching events; command builder */
2907 /**********************************************************************/
2910 execute_internal_event (Lisp_Object event)
2912 /* events on dead channels get silently eaten */
2913 if (object_dead_p (XEVENT (event)->channel))
2916 /* This function can GC */
2917 switch (XEVENT_TYPE (event))
2924 call1 (XEVENT (event)->event.eval.function,
2925 XEVENT (event)->event.eval.object);
2929 case magic_eval_event:
2931 (XEVENT (event)->event.magic_eval.internal_function)
2932 (XEVENT (event)->event.magic_eval.object);
2936 case pointer_motion_event:
2938 if (!NILP (Vmouse_motion_handler))
2939 call1 (Vmouse_motion_handler, event);
2945 Lisp_Object p = XEVENT (event)->event.process.process;
2946 Charcount readstatus;
2948 assert (PROCESSP (p));
2949 while ((readstatus = read_process_output (p)) > 0)
2952 ; /* this clauses never gets executed but allows the #ifdefs
2955 else if (readstatus == -1 && errno == EWOULDBLOCK)
2957 #endif /* EWOULDBLOCK */
2959 else if (readstatus == -1 && errno == EAGAIN)
2962 else if ((readstatus == 0 &&
2963 /* Note that we cannot distinguish between no input
2964 available now and a closed pipe.
2965 With luck, a closed pipe will be accompanied by
2966 subprocess termination and SIGCHLD. */
2967 (!network_connection_p (p) ||
2969 When connected to ToolTalk (i.e.
2970 connected_via_filedesc_p()), it's not possible to
2971 reliably determine whether there is a message
2972 waiting for ToolTalk to receive. ToolTalk expects
2973 to have tt_message_receive() called exactly once
2974 every time the file descriptor becomes active, so
2975 the filter function forces this by returning 0.
2976 Emacs must not interpret this as a closed pipe. */
2977 connected_via_filedesc_p (XPROCESS (p))))
2979 /* On some OSs with ptys, when the process on one end of
2980 a pty exits, the other end gets an error reading with
2981 errno = EIO instead of getting an EOF (0 bytes read).
2982 Therefore, if we get an error reading and errno =
2983 EIO, just continue, because the child process has
2984 exited and should clean itself up soon (e.g. when we
2986 || (readstatus == -1 && errno == EIO)
2990 /* Currently, we rely on SIGCHLD to indicate that the
2991 process has terminated. Unfortunately, on some systems
2992 the SIGCHLD gets missed some of the time. So we put an
2993 additional check in status_notify() to see whether a
2994 process has terminated. We must tell status_notify()
2995 to enable that check, and we do so now. */
2996 kick_status_notify ();
3000 /* Deactivate network connection */
3001 Lisp_Object status = Fprocess_status (p);
3002 if (EQ (status, Qopen)
3003 /* In case somebody changes the theory of whether to
3004 return open as opposed to run for network connection
3006 || EQ (status, Qrun))
3007 update_process_status (p, Qexit, 256, 0);
3008 deactivate_process (p);
3011 /* We must call status_notify here to allow the
3012 event_stream->unselect_process_cb to be run if appropriate.
3013 Otherwise, dead fds may be selected for, and we will get a
3014 continuous stream of process events for them. Since we don't
3015 return until all process events have been flushed, we would
3016 get stuck here, processing events on a process whose status
3017 was 'exit. Call this after dispatch-event, or the fds will
3018 have been closed before we read the last data from them.
3019 It's safe for the filter to signal an error because
3020 status_notify() will be called on return to top-level.
3028 Lisp_Event *e = XEVENT (event);
3029 if (!NILP (e->event.timeout.function))
3030 call1 (e->event.timeout.function,
3031 e->event.timeout.object);
3036 event_stream_handle_magic_event (XEVENT (event));
3047 this_command_keys_replace_suffix (Lisp_Object suffix, Lisp_Object chain)
3049 Lisp_Object first_before_suffix =
3050 event_chain_find_previous (Vthis_command_keys, suffix);
3052 if (NILP (first_before_suffix))
3053 Vthis_command_keys = chain;
3055 XSET_EVENT_NEXT (first_before_suffix, chain);
3056 deallocate_event_chain (suffix);
3057 Vthis_command_keys_tail = event_chain_tail (chain);
3061 command_builder_replace_suffix (struct command_builder *builder,
3062 Lisp_Object suffix, Lisp_Object chain)
3064 Lisp_Object first_before_suffix =
3065 event_chain_find_previous (builder->current_events, suffix);
3067 if (NILP (first_before_suffix))
3068 builder->current_events = chain;
3070 XSET_EVENT_NEXT (first_before_suffix, chain);
3071 deallocate_event_chain (suffix);
3072 builder->most_current_event = event_chain_tail (chain);
3076 command_builder_find_leaf_1 (struct command_builder *builder)
3078 Lisp_Object event0 = builder->current_events;
3083 return event_binding (event0, 1);
3086 /* See if we can do function-key-map or key-translation-map translation
3087 on the current events in the command builder. If so, do this, and
3088 return the resulting binding, if any. */
3091 munge_keymap_translate (struct command_builder *builder,
3092 enum munge_me_out_the_door munge,
3093 int has_normal_binding_p)
3097 EVENT_CHAIN_LOOP (suffix, builder->munge_me[munge].first_mungeable_event)
3099 Lisp_Object result = munging_key_map_event_binding (suffix, munge);
3104 if (KEYMAPP (result))
3106 if (NILP (builder->last_non_munged_event)
3107 && !has_normal_binding_p)
3108 builder->last_non_munged_event = builder->most_current_event;
3111 builder->last_non_munged_event = Qnil;
3113 if (!KEYMAPP (result) &&
3114 !VECTORP (result) &&
3117 struct gcpro gcpro1;
3119 result = call1 (result, Qnil);
3125 if (KEYMAPP (result))
3128 if (VECTORP (result) || STRINGP (result))
3130 Lisp_Object new_chain = key_sequence_to_event_chain (result);
3134 /* If the first_mungeable_event of the other munger is
3135 within the events we're munging, then it will point to
3136 deallocated events afterwards, which is bad -- so make it
3137 point at the beginning of the munged events. */
3138 EVENT_CHAIN_LOOP (tempev, suffix)
3140 Lisp_Object *mungeable_event =
3141 &builder->munge_me[1 - munge].first_mungeable_event;
3142 if (EQ (tempev, *mungeable_event))
3144 *mungeable_event = new_chain;
3149 n = event_chain_count (suffix);
3150 command_builder_replace_suffix (builder, suffix, new_chain);
3151 builder->munge_me[munge].first_mungeable_event = Qnil;
3152 /* Now hork this-command-keys as well. */
3154 /* We just assume that the events we just replaced are
3155 sitting in copied form at the end of this-command-keys.
3156 If the user did weird things with `dispatch-event' this
3157 may not be the case, but at least we make sure we won't
3159 new_chain = copy_event_chain (new_chain);
3160 tckn = event_chain_count (Vthis_command_keys);
3163 this_command_keys_replace_suffix
3164 (event_chain_nth (Vthis_command_keys, tckn - n),
3168 result = command_builder_find_leaf_1 (builder);
3172 signal_simple_error ((munge == MUNGE_ME_FUNCTION_KEY ?
3173 "Invalid binding in function-key-map" :
3174 "Invalid binding in key-translation-map"),
3181 /* Compare the current state of the command builder against the local and
3182 global keymaps, and return the binding. If there is no match, try again,
3183 case-insensitively. The return value will be one of:
3184 -- nil (there is no binding)
3185 -- a keymap (part of a command has been specified)
3186 -- a command (anything that satisfies `commandp'; this includes
3187 some symbols, lists, subrs, strings, vectors, and
3188 compiled-function objects)
3191 command_builder_find_leaf (struct command_builder *builder,
3192 int allow_misc_user_events_p)
3194 /* This function can GC */
3196 Lisp_Object evee = builder->current_events;
3198 if (XEVENT_TYPE (evee) == misc_user_event)
3200 if (allow_misc_user_events_p && (NILP (XEVENT_NEXT (evee))))
3201 return list2 (XEVENT (evee)->event.eval.function,
3202 XEVENT (evee)->event.eval.object);
3207 /* if we're currently in a menu accelerator, check there for further
3209 /* #### fuck me! who wrote this crap? think "abstraction", baby. */
3210 #if defined(HAVE_X_WINDOWS) && defined(LWLIB_MENUBARS_LUCID)
3211 if (x_kludge_lw_menu_active ())
3213 return command_builder_operate_menu_accelerator (builder);
3218 if (EQ (Vmenu_accelerator_enabled, Qmenu_force))
3219 result = command_builder_find_menu_accelerator (builder);
3222 result = command_builder_find_leaf_1 (builder);
3223 #if defined(HAVE_X_WINDOWS) && defined(LWLIB_MENUBARS_LUCID)
3225 && EQ (Vmenu_accelerator_enabled, Qmenu_fallback))
3226 result = command_builder_find_menu_accelerator (builder);
3230 /* Check to see if we have a potential function-key-map match. */
3233 result = munge_keymap_translate (builder, MUNGE_ME_FUNCTION_KEY, 0);
3234 regenerate_echo_keys_from_this_command_keys (builder);
3236 /* Check to see if we have a potential key-translation-map match. */
3238 Lisp_Object key_translate_result =
3239 munge_keymap_translate (builder, MUNGE_ME_KEY_TRANSLATION,
3241 if (!NILP (key_translate_result))
3243 result = key_translate_result;
3244 regenerate_echo_keys_from_this_command_keys (builder);
3251 /* If key-sequence wasn't bound, we'll try some fallbacks. */
3253 /* If we didn't find a binding, and the last event in the sequence is
3254 a shifted character, then try again with the lowercase version. */
3256 if (XEVENT_TYPE (builder->most_current_event) == key_press_event
3257 && !NILP (Vretry_undefined_key_binding_unshifted))
3259 Lisp_Object terminal = builder->most_current_event;
3260 struct key_data* key = & XEVENT (terminal)->event.key;
3262 if ((key->modifiers & XEMACS_MOD_SHIFT)
3263 || (CHAR_OR_CHAR_INTP (key->keysym)
3264 && ((c = XCHAR_OR_CHAR_INT (key->keysym)), c >= 'A' && c <= 'Z')))
3266 Lisp_Event terminal_copy = *XEVENT (terminal);
3268 if (key->modifiers & XEMACS_MOD_SHIFT)
3269 key->modifiers &= (~ XEMACS_MOD_SHIFT);
3271 key->keysym = make_char (c + 'a' - 'A');
3273 result = command_builder_find_leaf (builder, allow_misc_user_events_p);
3276 /* If there was no match with the lower-case version either,
3277 then put back the upper-case event for the error
3278 message. But make sure that function-key-map didn't
3279 change things out from under us. */
3280 if (EQ (terminal, builder->most_current_event))
3281 *XEVENT (terminal) = terminal_copy;
3285 /* help-char is `auto-bound' in every keymap */
3286 if (!NILP (Vprefix_help_command) &&
3287 event_matches_key_specifier_p (XEVENT (builder->most_current_event),
3289 return Vprefix_help_command;
3292 /* If keysym is a non-ASCII char, bind it to self-insert-char by default. */
3293 if (XEVENT_TYPE (builder->most_current_event) == key_press_event
3294 && !NILP (Vcomposed_character_default_binding))
3296 Lisp_Object keysym = XEVENT (builder->most_current_event)->event.key.keysym;
3297 if (CHARP (keysym) && !CHAR_ASCII_P (XCHAR (keysym)))
3298 return Vcomposed_character_default_binding;
3300 #endif /* HAVE_XIM */
3302 /* If we read extra events attempting to match a function key but end
3303 up failing, then we release those events back to the command loop
3304 and fail on the original lookup. The released events will then be
3305 reprocessed in the context of the first part having failed. */
3306 if (!NILP (builder->last_non_munged_event))
3308 Lisp_Object event0 = builder->last_non_munged_event;
3310 /* Put the commands back on the event queue. */
3311 enqueue_event_chain (XEVENT_NEXT (event0),
3312 &command_event_queue,
3313 &command_event_queue_tail);
3315 /* Then remove them from the command builder. */
3316 XSET_EVENT_NEXT (event0, Qnil);
3317 builder->most_current_event = event0;
3318 builder->last_non_munged_event = Qnil;
3325 /* Every time a command-event (a key, button, or menu selection) is read by
3326 Fnext_event(), it is stored in the recent_keys_ring, in Vlast_input_event,
3327 and in Vthis_command_keys. (Eval-events are not stored there.)
3329 Every time a command is invoked, Vlast_command_event is set to the last
3330 event in the sequence.
3332 This means that Vthis_command_keys is really about "input read since the
3333 last command was executed" rather than about "what keys invoked this
3334 command." This is a little counterintuitive, but that's the way it
3337 As an extra kink, the function read-key-sequence resets/updates the
3338 last-command-event and this-command-keys. It doesn't append to the
3339 command-keys as read-char does. Such are the pitfalls of having to
3340 maintain compatibility with a program for which the only specification
3343 (We could implement recent_keys_ring and Vthis_command_keys as the same
3347 DEFUN ("recent-keys", Frecent_keys, 0, 1, 0, /*
3348 Return a vector of recent keyboard or mouse button events read.
3349 If NUMBER is non-nil, not more than NUMBER events will be returned.
3350 Change number of events stored using `set-recent-keys-ring-size'.
3352 This copies the event objects into a new vector; it is safe to keep and
3357 struct gcpro gcpro1;
3358 Lisp_Object val = Qnil;
3360 int start, nkeys, i, j;
3364 nwanted = recent_keys_ring_size;
3367 CHECK_NATNUM (number);
3368 nwanted = XINT (number);
3371 /* Create the keys ring vector, if none present. */
3372 if (NILP (Vrecent_keys_ring))
3374 Vrecent_keys_ring = make_vector (recent_keys_ring_size, Qnil);
3375 /* And return nothing in particular. */
3376 RETURN_UNGCPRO (make_vector (0, Qnil));
3379 if (NILP (XVECTOR_DATA (Vrecent_keys_ring)[recent_keys_ring_index]))
3380 /* This means the vector has not yet wrapped */
3382 nkeys = recent_keys_ring_index;
3387 nkeys = recent_keys_ring_size;
3388 start = ((recent_keys_ring_index == nkeys) ? 0 : recent_keys_ring_index);
3391 if (nwanted < nkeys)
3393 start += nkeys - nwanted;
3394 if (start >= recent_keys_ring_size)
3395 start -= recent_keys_ring_size;
3401 val = make_vector (nwanted, Qnil);
3403 for (i = 0, j = start; i < nkeys; i++)
3405 Lisp_Object e = XVECTOR_DATA (Vrecent_keys_ring)[j];
3409 XVECTOR_DATA (val)[i] = Fcopy_event (e, Qnil);
3410 if (++j >= recent_keys_ring_size)
3418 DEFUN ("recent-keys-ring-size", Frecent_keys_ring_size, 0, 0, 0, /*
3419 The maximum number of events `recent-keys' can return.
3423 return make_int (recent_keys_ring_size);
3426 DEFUN ("set-recent-keys-ring-size", Fset_recent_keys_ring_size, 1, 1, 0, /*
3427 Set the maximum number of events to be stored internally.
3431 Lisp_Object new_vector = Qnil;
3432 int i, j, nkeys, start, min;
3433 struct gcpro gcpro1;
3436 if (XINT (size) <= 0)
3437 error ("Recent keys ring size must be positive");
3438 if (XINT (size) == recent_keys_ring_size)
3441 GCPRO1 (new_vector);
3442 new_vector = make_vector (XINT (size), Qnil);
3444 if (NILP (Vrecent_keys_ring))
3446 Vrecent_keys_ring = new_vector;
3447 RETURN_UNGCPRO (size);
3450 if (NILP (XVECTOR_DATA (Vrecent_keys_ring)[recent_keys_ring_index]))
3451 /* This means the vector has not yet wrapped */
3453 nkeys = recent_keys_ring_index;
3458 nkeys = recent_keys_ring_size;
3459 start = ((recent_keys_ring_index == nkeys) ? 0 : recent_keys_ring_index);
3462 if (XINT (size) > nkeys)
3467 for (i = 0, j = start; i < min; i++)
3469 XVECTOR_DATA (new_vector)[i] = XVECTOR_DATA (Vrecent_keys_ring)[j];
3470 if (++j >= recent_keys_ring_size)
3473 recent_keys_ring_size = XINT (size);
3474 recent_keys_ring_index = (i < recent_keys_ring_size) ? i : 0;
3476 Vrecent_keys_ring = new_vector;
3482 /* Vthis_command_keys having value Qnil means that the next time
3483 push_this_command_keys is called, it should start over.
3484 The times at which the command-keys are reset
3485 (instead of merely being augmented) are pretty counterintuitive.
3488 -- We do not reset this-command-keys when we finish reading a
3489 command. This is because some commands (e.g. C-u) act
3490 like command prefixes; they signal this by setting prefix-arg
3492 -- Therefore, we reset this-command-keys when we finish
3493 executing a command, unless prefix-arg is set.
3494 -- However, if we ever do a non-local exit out of a command
3495 loop (e.g. an error in a command), we need to reset
3496 this-command-keys. We do this by calling reset_this_command_keys()
3497 from cmdloop.c, whenever an error causes an invocation of the
3498 default error handler, and whenever there's a throw to top-level.)
3502 reset_this_command_keys (Lisp_Object console, int clear_echo_area_p)
3504 struct command_builder *command_builder =
3505 XCOMMAND_BUILDER (XCONSOLE (console)->command_builder);
3507 reset_key_echo (command_builder, clear_echo_area_p);
3509 deallocate_event_chain (Vthis_command_keys);
3510 Vthis_command_keys = Qnil;
3511 Vthis_command_keys_tail = Qnil;
3513 reset_current_events (command_builder);
3517 push_this_command_keys (Lisp_Object event)
3519 Lisp_Object new = Fmake_event (Qnil, Qnil);
3521 Fcopy_event (event, new);
3522 enqueue_event (new, &Vthis_command_keys, &Vthis_command_keys_tail);
3525 /* The following two functions are used in call-interactively,
3526 for the @ and e specifications. We used to just use
3527 `current-mouse-event' (i.e. the last mouse event in this-command-keys),
3528 but FSF does it more generally so we follow their lead. */
3531 extract_this_command_keys_nth_mouse_event (int n)
3535 EVENT_CHAIN_LOOP (event, Vthis_command_keys)
3538 && (XEVENT_TYPE (event) == button_press_event
3539 || XEVENT_TYPE (event) == button_release_event
3540 || XEVENT_TYPE (event) == misc_user_event))
3544 /* must copy to avoid an abort() in next_event_internal() */
3545 if (!NILP (XEVENT_NEXT (event)))
3546 return Fcopy_event (event, Qnil);
3558 extract_vector_nth_mouse_event (Lisp_Object vector, int n)
3561 int len = XVECTOR_LENGTH (vector);
3563 for (i = 0; i < len; i++)
3565 Lisp_Object event = XVECTOR_DATA (vector)[i];
3567 switch (XEVENT_TYPE (event))
3569 case button_press_event :
3570 case button_release_event :
3571 case misc_user_event :
3585 push_recent_keys (Lisp_Object event)
3589 if (NILP (Vrecent_keys_ring))
3590 Vrecent_keys_ring = make_vector (recent_keys_ring_size, Qnil);
3592 e = XVECTOR_DATA (Vrecent_keys_ring) [recent_keys_ring_index];
3596 e = Fmake_event (Qnil, Qnil);
3597 XVECTOR_DATA (Vrecent_keys_ring) [recent_keys_ring_index] = e;
3599 Fcopy_event (event, e);
3600 if (++recent_keys_ring_index == recent_keys_ring_size)
3601 recent_keys_ring_index = 0;
3606 current_events_into_vector (struct command_builder *command_builder)
3610 int n = event_chain_count (command_builder->current_events);
3612 /* Copy the vector and the events in it. */
3613 /* No need to copy the events, since they're already copies, and
3614 nobody other than the command-builder has pointers to them */
3615 vector = make_vector (n, Qnil);
3617 EVENT_CHAIN_LOOP (event, command_builder->current_events)
3618 XVECTOR_DATA (vector)[n++] = event;
3619 reset_command_builder_event_chain (command_builder);
3625 Given the current state of the command builder and a new command event
3626 that has just been dispatched:
3628 -- add the event to the event chain forming the current command
3629 (doing meta-translation as necessary)
3630 -- return the binding of this event chain; this will be one of:
3631 -- nil (there is no binding)
3632 -- a keymap (part of a command has been specified)
3633 -- a command (anything that satisfies `commandp'; this includes
3634 some symbols, lists, subrs, strings, vectors, and
3635 compiled-function objects)
3638 lookup_command_event (struct command_builder *command_builder,
3639 Lisp_Object event, int allow_misc_user_events_p)
3641 /* This function can GC */
3642 struct frame *f = selected_frame ();
3643 /* Clear output from previous command execution */
3644 if (!EQ (Qcommand, echo_area_status (f))
3645 /* but don't let mouse-up clear what mouse-down just printed */
3646 && (XEVENT (event)->event_type != button_release_event))
3647 clear_echo_area (f, Qnil, 0);
3649 /* Add the given event to the command builder.
3650 Extra hack: this also updates the recent_keys_ring and Vthis_command_keys
3651 vectors to translate "ESC x" to "M-x" (for any "x" of course).
3654 Lisp_Object recent = command_builder->most_current_event;
3657 && event_matches_key_specifier_p (XEVENT (recent), Vmeta_prefix_char))
3660 /* When we see a sequence like "ESC x", pretend we really saw "M-x".
3661 DoubleThink the recent-keys and this-command-keys as well. */
3663 /* Modify the previous most-recently-pushed event on the command
3664 builder to be a copy of this one with the meta-bit set instead of
3665 pushing a new event.
3667 Fcopy_event (event, recent);
3668 e = XEVENT (recent);
3669 if (e->event_type == key_press_event)
3670 e->event.key.modifiers |= XEMACS_MOD_META;
3671 else if (e->event_type == button_press_event
3672 || e->event_type == button_release_event)
3673 e->event.button.modifiers |= XEMACS_MOD_META;
3678 int tckn = event_chain_count (Vthis_command_keys);
3680 /* ??? very strange if it's < 2. */
3681 this_command_keys_replace_suffix
3682 (event_chain_nth (Vthis_command_keys, tckn - 2),
3683 Fcopy_event (recent, Qnil));
3686 regenerate_echo_keys_from_this_command_keys (command_builder);
3690 event = Fcopy_event (event, Fmake_event (Qnil, Qnil));
3692 command_builder_append_event (command_builder, event);
3697 Lisp_Object leaf = command_builder_find_leaf (command_builder,
3698 allow_misc_user_events_p);
3699 struct gcpro gcpro1;
3704 #if defined (HAVE_X_WINDOWS) && defined (LWLIB_MENUBARS_LUCID)
3705 if (!x_kludge_lw_menu_active ())
3710 Lisp_Object prompt = Fkeymap_prompt (leaf, Qt);
3711 if (STRINGP (prompt))
3713 /* Append keymap prompt to key echo buffer */
3714 int buf_index = command_builder->echo_buf_index;
3715 Bytecount len = XSTRING_LENGTH (prompt);
3717 if (len + buf_index + 1 <= command_builder->echo_buf_length)
3719 Bufbyte *echo = command_builder->echo_buf + buf_index;
3720 memcpy (echo, XSTRING_DATA (prompt), len);
3723 maybe_echo_keys (command_builder, 1);
3726 maybe_echo_keys (command_builder, 0);
3728 else if (!NILP (Vquit_flag))
3730 Lisp_Object quit_event = Fmake_event (Qnil, Qnil);
3731 Lisp_Event *e = XEVENT (quit_event);
3732 /* if quit happened during menu acceleration, pretend we read it */
3733 struct console *con = XCONSOLE (Fselected_console ());
3734 int ch = CONSOLE_QUIT_CHAR (con);
3736 character_to_event (ch, e, con, 1, 1);
3737 e->channel = make_console (con);
3739 enqueue_command_event (quit_event);
3743 else if (!NILP (leaf))
3745 if (EQ (Qcommand, echo_area_status (f))
3746 && command_builder->echo_buf_index > 0)
3748 /* If we had been echoing keys, echo the last one (without
3749 the trailing dash) and redisplay before executing the
3751 command_builder->echo_buf[command_builder->echo_buf_index] = 0;
3752 maybe_echo_keys (command_builder, 1);
3753 Fsit_for (Qzero, Qt);
3756 RETURN_UNGCPRO (leaf);
3761 execute_command_event (struct command_builder *command_builder,
3764 /* This function can GC */
3765 struct console *con = XCONSOLE (command_builder->console);
3766 struct gcpro gcpro1;
3768 GCPRO1 (event); /* event may be freshly created */
3770 /* To fix C-x @ h <scrollbar-drag> x crash. */
3771 if (XEVENT (event)->event_type != misc_user_event)
3772 reset_current_events (command_builder);
3774 switch (XEVENT (event)->event_type)
3776 case key_press_event:
3777 Vcurrent_mouse_event = Qnil;
3779 case button_press_event:
3780 case button_release_event:
3781 case misc_user_event:
3782 Vcurrent_mouse_event = Fcopy_event (event, Qnil);
3787 /* Store the last-command-event. The semantics of this is that it
3788 is the last event most recently involved in command-lookup. */
3789 if (!EVENTP (Vlast_command_event))
3790 Vlast_command_event = Fmake_event (Qnil, Qnil);
3791 if (XEVENT (Vlast_command_event)->event_type == dead_event)
3793 Vlast_command_event = Fmake_event (Qnil, Qnil);
3794 error ("Someone deallocated the last-command-event!");
3797 if (! EQ (event, Vlast_command_event))
3798 Fcopy_event (event, Vlast_command_event);
3800 /* Note that last-command-char will never have its high-bit set, in
3801 an effort to sidestep the ambiguity between M-x and oslash. */
3802 Vlast_command_char = Fevent_to_character (Vlast_command_event,
3805 /* Actually call the command, with all sorts of hair to preserve or clear
3806 the echo-area and region as appropriate and call the pre- and post-
3809 int old_kbd_macro = con->kbd_macro_end;
3810 struct window *w = XWINDOW (Fselected_window (Qnil));
3812 /* We're executing a new command, so the old value is irrelevant. */
3813 zmacs_region_stays = 0;
3815 /* If the previous command tried to force a specific window-start,
3816 reset the flag in case this command moves point far away from
3817 that position. Also, reset the window's buffer's change
3818 information so that we don't trigger an incremental update. */
3822 buffer_reset_changes (XBUFFER (w->buffer));
3825 pre_command_hook ();
3827 if (XEVENT (event)->event_type == misc_user_event)
3829 call1 (XEVENT (event)->event.eval.function,
3830 XEVENT (event)->event.eval.object);
3834 Fcommand_execute (Vthis_command, Qnil, Qnil);
3837 post_command_hook ();
3839 if (!NILP (con->prefix_arg))
3841 /* Commands that set the prefix arg don't update last-command, don't
3842 reset the echoing state, and don't go into keyboard macros unless
3843 followed by another command. Also don't quit here. */
3844 int speccount = specpdl_depth ();
3845 specbind (Qinhibit_quit, Qt);
3846 maybe_echo_keys (command_builder, 0);
3847 unbind_to (speccount, Qnil);
3849 /* If we're recording a keyboard macro, and the last command
3850 executed set a prefix argument, then decrement the pointer to
3851 the "last character really in the macro" to be just before this
3852 command. This is so that the ^U in "^U ^X )" doesn't go onto
3853 the end of macro. */
3854 if (!NILP (con->defining_kbd_macro))
3855 con->kbd_macro_end = old_kbd_macro;
3859 /* Start a new command next time */
3860 Vlast_command = Vthis_command;
3861 Vlast_command_properties = Vthis_command_properties;
3862 Vthis_command_properties = Qnil;
3864 /* Emacs 18 doesn't unconditionally clear the echoed keystrokes,
3865 so we don't either */
3866 if (XEVENT (event)->event_type != misc_user_event)
3867 reset_this_command_keys (make_console (con), 0);
3874 /* Run the pre command hook. */
3877 pre_command_hook (void)
3879 last_point_position = BUF_PT (current_buffer);
3880 XSETBUFFER (last_point_position_buffer, current_buffer);
3881 /* This function can GC */
3882 safe_run_hook_trapping_errors
3883 ("Error in `pre-command-hook' (setting hook to nil)",
3884 Qpre_command_hook, 1);
3886 /* This is a kludge, but necessary; see simple.el */
3887 call0 (Qhandle_pre_motion_command);
3890 /* Run the post command hook. */
3893 post_command_hook (void)
3895 /* This function can GC */
3896 /* Turn off region highlighting unless this command requested that
3897 it be left on, or we're in the minibuffer. We don't turn it off
3898 when we're in the minibuffer so that things like M-x write-region
3901 This could be done via a function on the post-command-hook, but
3902 we don't want the user to accidentally remove it.
3905 Lisp_Object win = Fselected_window (Qnil);
3907 /* If the last command deleted the frame, `win' might be nil.
3908 It seems safest to do nothing in this case. */
3909 /* Note: Someone added the following comment and put #if 0's around
3910 this code, not realizing that doing this invites a crash in the
3912 /* #### This doesn't really fix the problem,
3913 if delete-frame is called by some hook */
3917 /* This is a kludge, but necessary; see simple.el */
3918 call0 (Qhandle_post_motion_command);
3920 if (! zmacs_region_stays
3921 && (!MINI_WINDOW_P (XWINDOW (win))
3922 || EQ (zmacs_region_buffer (), WINDOW_BUFFER (XWINDOW (win)))))
3923 zmacs_deactivate_region ();
3925 zmacs_update_region ();
3927 safe_run_hook_trapping_errors
3928 ("Error in `post-command-hook' (setting hook to nil)",
3929 Qpost_command_hook, 1);
3931 /* #### Kludge!!! This is necessary to make sure that things
3932 are properly positioned even if post-command-hook moves point.
3933 #### There should be a cleaner way of handling this. */
3934 call0 (Qauto_show_make_point_visible);
3938 DEFUN ("dispatch-event", Fdispatch_event, 1, 1, 0, /*
3939 Given an event object EVENT as returned by `next-event', execute it.
3941 Key-press, button-press, and button-release events get accumulated
3942 until a complete key sequence (see `read-key-sequence') is reached,
3943 at which point the sequence is looked up in the current keymaps and
3946 Mouse motion events cause the low-level handling function stored in
3947 `mouse-motion-handler' to be called. (There are very few circumstances
3948 under which you should change this handler. Use `mode-motion-hook'
3951 Menu, timeout, and eval events cause the associated function or handler
3954 Process events cause the subprocess's output to be read and acted upon
3955 appropriately (see `start-process').
3957 Magic events are handled as necessary.
3961 /* This function can GC */
3962 struct command_builder *command_builder;
3964 Lisp_Object console;
3965 Lisp_Object channel;
3967 CHECK_LIVE_EVENT (event);
3968 ev = XEVENT (event);
3970 /* events on dead channels get silently eaten */
3971 channel = EVENT_CHANNEL (ev);
3972 if (object_dead_p (channel))
3975 /* Some events don't have channels (e.g. eval events). */
3976 console = CDFW_CONSOLE (channel);
3978 console = Vselected_console;
3979 else if (!EQ (console, Vselected_console))
3980 Fselect_console (console);
3982 command_builder = XCOMMAND_BUILDER (XCONSOLE (console)->command_builder);
3983 switch (XEVENT (event)->event_type)
3985 case button_press_event:
3986 case button_release_event:
3987 case key_press_event:
3989 Lisp_Object leaf = lookup_command_event (command_builder, event, 1);
3992 /* Incomplete key sequence */
3996 /* At this point, we know that the sequence is not bound to a
3997 command. Normally, we beep and print a message informing the
3998 user of this. But we do not beep or print a message when:
4000 o the last event in this sequence is a mouse-up event; or
4001 o the last event in this sequence is a mouse-down event and
4002 there is a binding for the mouse-up version.
4004 That is, if the sequence ``C-x button1'' is typed, and is not
4005 bound to a command, but the sequence ``C-x button1up'' is bound
4006 to a command, we do not complain about the ``C-x button1''
4007 sequence. If neither ``C-x button1'' nor ``C-x button1up'' is
4008 bound to a command, then we complain about the ``C-x button1''
4009 sequence, but later will *not* complain about the
4010 ``C-x button1up'' sequence, which would be redundant.
4012 This is pretty hairy, but I think it's the most intuitive
4015 Lisp_Object terminal = command_builder->most_current_event;
4017 if (XEVENT_TYPE (terminal) == button_press_event)
4020 /* Temporarily pretend the last event was an "up" instead of a
4021 "down", and look up its binding. */
4022 XEVENT_TYPE (terminal) = button_release_event;
4023 /* If the "up" version is bound, don't complain. */
4025 = !NILP (command_builder_find_leaf (command_builder, 0));
4026 /* Undo the temporary changes we just made. */
4027 XEVENT_TYPE (terminal) = button_press_event;
4030 /* Pretend this press was not seen (treat as a prefix) */
4031 if (EQ (command_builder->current_events, terminal))
4033 reset_current_events (command_builder);
4039 EVENT_CHAIN_LOOP (eve, command_builder->current_events)
4040 if (EQ (XEVENT_NEXT (eve), terminal))
4043 Fdeallocate_event (command_builder->
4044 most_current_event);
4045 XSET_EVENT_NEXT (eve, Qnil);
4046 command_builder->most_current_event = eve;
4048 maybe_echo_keys (command_builder, 1);
4053 /* Complain that the typed sequence is not defined, if this is the
4054 kind of sequence that warrants a complaint. */
4055 XCONSOLE (console)->defining_kbd_macro = Qnil;
4056 XCONSOLE (console)->prefix_arg = Qnil;
4057 /* Don't complain about undefined button-release events */
4058 if (XEVENT_TYPE (terminal) != button_release_event)
4060 Lisp_Object keys = current_events_into_vector (command_builder);
4061 struct gcpro gcpro1;
4063 /* Run the pre-command-hook before barfing about an undefined
4065 Vthis_command = Qnil;
4067 pre_command_hook ();
4069 /* The post-command-hook doesn't run. */
4070 Fsignal (Qundefined_keystroke_sequence, list1 (keys));
4072 /* Reset the command builder for reading the next sequence. */
4073 reset_this_command_keys (console, 1);
4075 else /* key sequence is bound to a command */
4078 int magic_undo_count = 20;
4080 Vthis_command = leaf;
4082 /* Don't push an undo boundary if the command set the prefix arg,
4083 or if we are executing a keyboard macro, or if in the
4084 minibuffer. If the command we are about to execute is
4085 self-insert, it's tricky: up to 20 consecutive self-inserts may
4086 be done without an undo boundary. This counter is reset as
4087 soon as a command other than self-insert-command is executed.
4089 Programmers can also use the `self-insert-defer-undo'
4090 property to install that behavior on functions other
4091 than `self-insert-command', or to change the magic
4092 number 20 to something else. #### DOCUMENT THIS! */
4096 Lisp_Object prop = Fget (leaf, Qself_insert_defer_undo, Qnil);
4098 magic_undo = 1, magic_undo_count = XINT (prop);
4099 else if (!NILP (prop))
4101 else if (EQ (leaf, Qself_insert_command))
4106 command_builder->self_insert_countdown = 0;
4107 if (NILP (XCONSOLE (console)->prefix_arg)
4108 && NILP (Vexecuting_macro)
4109 && command_builder->self_insert_countdown == 0)
4114 if (--command_builder->self_insert_countdown < 0)
4115 command_builder->self_insert_countdown = magic_undo_count;
4117 execute_command_event
4119 internal_equal (event, command_builder->most_current_event, 0)
4121 /* Use the translated event that was most recently seen.
4122 This way, last-command-event becomes f1 instead of
4123 the P from ESC O P. But we must copy it, else we'll
4124 lose when the command-builder events are deallocated. */
4125 : Fcopy_event (command_builder->most_current_event, Qnil));
4129 case misc_user_event:
4133 We could just always use the menu item entry, whatever it is, but
4134 this might break some Lisp code that expects `this-command' to
4135 always contain a symbol. So only store it if this is a simple
4136 `call-interactively' sort of menu item.
4138 But this is bogus. `this-command' could be a string or vector
4139 anyway (for keyboard macros). There's even one instance
4140 (in pending-del.el) of `this-command' getting set to a cons
4141 (a lambda expression). So in the `eval' case I'll just
4142 convert it into a lambda expression.
4144 if (EQ (XEVENT (event)->event.eval.function, Qcall_interactively)
4145 && SYMBOLP (XEVENT (event)->event.eval.object))
4146 Vthis_command = XEVENT (event)->event.eval.object;
4147 else if (EQ (XEVENT (event)->event.eval.function, Qeval))
4149 Fcons (Qlambda, Fcons (Qnil, XEVENT (event)->event.eval.object));
4150 else if (SYMBOLP (XEVENT (event)->event.eval.function))
4151 /* A scrollbar command or the like. */
4152 Vthis_command = XEVENT (event)->event.eval.function;
4155 Vthis_command = Qnil;
4157 /* clear the echo area */
4158 reset_key_echo (command_builder, 1);
4160 command_builder->self_insert_countdown = 0;
4161 if (NILP (XCONSOLE (console)->prefix_arg)
4162 && NILP (Vexecuting_macro)
4163 && !EQ (minibuf_window, Fselected_window (Qnil)))
4165 execute_command_event (command_builder, event);
4170 execute_internal_event (event);
4177 DEFUN ("read-key-sequence", Fread_key_sequence, 1, 3, 0, /*
4178 Read a sequence of keystrokes or mouse clicks.
4179 Returns a vector of the event objects read. The vector and the event
4180 objects it contains are freshly created (and so will not be side-effected
4181 by subsequent calls to this function).
4183 The sequence read is sufficient to specify a non-prefix command starting
4184 from the current local and global keymaps. A C-g typed while in this
4185 function is treated like any other character, and `quit-flag' is not set.
4187 First arg PROMPT is a prompt string. If nil, do not prompt specially.
4189 Second optional arg CONTINUE-ECHO non-nil means this key echoes as a
4190 continuation of the previous key.
4192 Third optional arg DONT-DOWNCASE-LAST non-nil means do not convert the
4193 last event to lower case. (Normally any upper case event is converted
4194 to lower case if the original event is undefined and the lower case
4195 equivalent is defined.) This argument is provided mostly for FSF
4196 compatibility; the equivalent effect can be achieved more generally by
4197 binding `retry-undefined-key-binding-unshifted' to nil around the call
4198 to `read-key-sequence'.
4200 If the user selects a menu item while we are prompting for a key-sequence,
4201 the returned value will be a vector of a single menu-selection event.
4202 An error will be signalled if you pass this value to `lookup-key' or a
4205 `read-key-sequence' checks `function-key-map' for function key
4206 sequences, where they wouldn't conflict with ordinary bindings.
4207 See `function-key-map' for more details.
4209 (prompt, continue_echo, dont_downcase_last))
4211 /* This function can GC */
4212 struct console *con = XCONSOLE (Vselected_console); /* #### correct?
4216 struct command_builder *command_builder =
4217 XCOMMAND_BUILDER (con->command_builder);
4219 Lisp_Object event = Fmake_event (Qnil, Qnil);
4220 int speccount = specpdl_depth ();
4221 struct gcpro gcpro1;
4225 CHECK_STRING (prompt);
4226 /* else prompt = Fkeymap_prompt (current_buffer->keymap); may GC */
4229 if (NILP (continue_echo))
4230 reset_this_command_keys (make_console (con), 1);
4232 specbind (Qinhibit_quit, Qt);
4234 if (!NILP (dont_downcase_last))
4235 specbind (Qretry_undefined_key_binding_unshifted, Qnil);
4239 Fnext_event (event, prompt);
4240 /* restore the selected-console damage */
4241 con = event_console_or_selected (event);
4242 command_builder = XCOMMAND_BUILDER (con->command_builder);
4243 if (! command_event_p (event))
4244 execute_internal_event (event);
4247 if (XEVENT (event)->event_type == misc_user_event)
4248 reset_current_events (command_builder);
4249 result = lookup_command_event (command_builder, event, 1);
4250 if (!KEYMAPP (result))
4252 result = current_events_into_vector (command_builder);
4253 reset_key_echo (command_builder, 0);
4260 Vquit_flag = Qnil; /* In case we read a ^G; do not call check_quit() here */
4261 Fdeallocate_event (event);
4262 RETURN_UNGCPRO (unbind_to (speccount, result));
4265 DEFUN ("this-command-keys", Fthis_command_keys, 0, 0, 0, /*
4266 Return a vector of the keyboard or mouse button events that were used
4267 to invoke this command. This copies the vector and the events; it is safe
4268 to keep and modify them.
4276 if (NILP (Vthis_command_keys))
4277 return make_vector (0, Qnil);
4279 len = event_chain_count (Vthis_command_keys);
4281 result = make_vector (len, Qnil);
4283 EVENT_CHAIN_LOOP (event, Vthis_command_keys)
4284 XVECTOR_DATA (result)[len++] = Fcopy_event (event, Qnil);
4288 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths, 0, 0, 0, /*
4289 Used for complicated reasons in `universal-argument-other-key'.
4291 `universal-argument-other-key' rereads the event just typed.
4292 It then gets translated through `function-key-map'.
4293 The translated event gets included in the echo area and in
4294 the value of `this-command-keys' in addition to the raw original event.
4297 Calling this function directs the translated event to replace
4298 the original event, so that only one version of the event actually
4299 appears in the echo area and in the value of `this-command-keys'.
4303 /* #### I don't understand this at all, so currently it does nothing.
4304 If there is ever a problem, maybe someone should investigate. */
4310 dribble_out_event (Lisp_Object event)
4312 if (NILP (Vdribble_file))
4315 if (XEVENT (event)->event_type == key_press_event &&
4316 !XEVENT (event)->event.key.modifiers)
4318 Lisp_Object keysym = XEVENT (event)->event.key.keysym;
4319 if (CHARP (XEVENT (event)->event.key.keysym))
4321 Emchar ch = XCHAR (keysym);
4322 Bufbyte str[MAX_EMCHAR_LEN];
4323 Bytecount len = set_charptr_emchar (str, ch);
4324 Lstream_write (XLSTREAM (Vdribble_file), str, len);
4326 else if (string_char_length (XSYMBOL (keysym)->name) == 1)
4327 /* one-char key events are printed with just the key name */
4328 Fprinc (keysym, Vdribble_file);
4329 else if (EQ (keysym, Qreturn))
4330 Lstream_putc (XLSTREAM (Vdribble_file), '\n');
4331 else if (EQ (keysym, Qspace))
4332 Lstream_putc (XLSTREAM (Vdribble_file), ' ');
4334 Fprinc (event, Vdribble_file);
4337 Fprinc (event, Vdribble_file);
4338 Lstream_flush (XLSTREAM (Vdribble_file));
4341 DEFUN ("open-dribble-file", Fopen_dribble_file, 1, 1,
4342 "FOpen dribble file: ", /*
4343 Start writing all keyboard characters to a dribble file called FILENAME.
4344 If FILENAME is nil, close any open dribble file.
4348 /* This function can GC */
4349 /* XEmacs change: always close existing dribble file. */
4350 /* FSFmacs uses FILE *'s here. With lstreams, that's unnecessary. */
4351 if (!NILP (Vdribble_file))
4353 Lstream_close (XLSTREAM (Vdribble_file));
4354 Vdribble_file = Qnil;
4356 if (!NILP (filename))
4360 filename = Fexpand_file_name (filename, Qnil);
4361 fd = open ((char*) XSTRING_DATA (filename),
4362 O_WRONLY | O_TRUNC | O_CREAT | OPEN_BINARY,
4365 error ("Unable to create dribble file");
4366 Vdribble_file = make_filedesc_output_stream (fd, 0, 0, LSTR_CLOSING);
4369 make_encoding_output_stream (XLSTREAM (Vdribble_file),
4370 Fget_coding_system (Qescape_quoted));
4378 DEFUN ("current-event-timestamp", Fcurrent_event_timestamp, 0, 1, 0, /*
4379 Return the current event timestamp of the window system associated with CONSOLE.
4380 CONSOLE defaults to the selected console if omitted.
4384 struct console *c = decode_console (console);
4385 int tiempo = event_stream_current_event_timestamp (c);
4387 /* This junk is so that timestamps don't get to be negative, but contain
4388 as many bits as this particular emacs will allow.
4390 return make_int (((1L << (VALBITS - 1)) - 1) & tiempo);
4394 /************************************************************************/
4395 /* initialization */
4396 /************************************************************************/
4399 syms_of_event_stream (void)
4401 INIT_LRECORD_IMPLEMENTATION (command_builder);
4402 INIT_LRECORD_IMPLEMENTATION (timeout);
4404 defsymbol (&Qdisabled, "disabled");
4405 defsymbol (&Qcommand_event_p, "command-event-p");
4407 DEFERROR_STANDARD (Qundefined_keystroke_sequence, Qinvalid_argument);
4409 DEFSUBR (Frecent_keys);
4410 DEFSUBR (Frecent_keys_ring_size);
4411 DEFSUBR (Fset_recent_keys_ring_size);
4412 DEFSUBR (Finput_pending_p);
4413 DEFSUBR (Fenqueue_eval_event);
4414 DEFSUBR (Fnext_event);
4415 DEFSUBR (Fnext_command_event);
4416 DEFSUBR (Fdiscard_input);
4418 DEFSUBR (Fsleep_for);
4419 DEFSUBR (Faccept_process_output);
4420 DEFSUBR (Fadd_timeout);
4421 DEFSUBR (Fdisable_timeout);
4422 DEFSUBR (Fadd_async_timeout);
4423 DEFSUBR (Fdisable_async_timeout);
4424 DEFSUBR (Fdispatch_event);
4425 DEFSUBR (Fdispatch_non_command_events);
4426 DEFSUBR (Fread_key_sequence);
4427 DEFSUBR (Fthis_command_keys);
4428 DEFSUBR (Freset_this_command_lengths);
4429 DEFSUBR (Fopen_dribble_file);
4430 DEFSUBR (Fcurrent_event_timestamp);
4432 defsymbol (&Qpre_command_hook, "pre-command-hook");
4433 defsymbol (&Qpost_command_hook, "post-command-hook");
4434 defsymbol (&Qunread_command_events, "unread-command-events");
4435 defsymbol (&Qunread_command_event, "unread-command-event");
4436 defsymbol (&Qpre_idle_hook, "pre-idle-hook");
4437 defsymbol (&Qhandle_pre_motion_command, "handle-pre-motion-command");
4438 defsymbol (&Qhandle_post_motion_command, "handle-post-motion-command");
4439 defsymbol (&Qretry_undefined_key_binding_unshifted,
4440 "retry-undefined-key-binding-unshifted");
4441 defsymbol (&Qauto_show_make_point_visible,
4442 "auto-show-make-point-visible");
4444 defsymbol (&Qself_insert_defer_undo, "self-insert-defer-undo");
4445 defsymbol (&Qcancel_mode_internal, "cancel-mode-internal");
4449 reinit_vars_of_event_stream (void)
4451 recent_keys_ring_index = 0;
4452 recent_keys_ring_size = 100;
4453 num_input_chars = 0;
4454 Vtimeout_free_list = make_lcrecord_list (sizeof (Lisp_Timeout),
4456 staticpro_nodump (&Vtimeout_free_list);
4457 the_low_level_timeout_blocktype =
4458 Blocktype_new (struct low_level_timeout_blocktype);
4459 something_happened = 0;
4460 recursive_sit_for = Qnil;
4464 vars_of_event_stream (void)
4466 reinit_vars_of_event_stream ();
4467 Vrecent_keys_ring = Qnil;
4468 staticpro (&Vrecent_keys_ring);
4470 Vthis_command_keys = Qnil;
4471 staticpro (&Vthis_command_keys);
4472 Vthis_command_keys_tail = Qnil;
4473 dump_add_root_object (&Vthis_command_keys_tail);
4475 command_event_queue = Qnil;
4476 staticpro (&command_event_queue);
4477 command_event_queue_tail = Qnil;
4478 dump_add_root_object (&command_event_queue_tail);
4480 Vlast_selected_frame = Qnil;
4481 staticpro (&Vlast_selected_frame);
4483 pending_timeout_list = Qnil;
4484 staticpro (&pending_timeout_list);
4486 pending_async_timeout_list = Qnil;
4487 staticpro (&pending_async_timeout_list);
4489 last_point_position_buffer = Qnil;
4490 staticpro (&last_point_position_buffer);
4492 DEFVAR_LISP ("echo-keystrokes", &Vecho_keystrokes /*
4493 *Nonzero means echo unfinished commands after this many seconds of pause.
4495 Vecho_keystrokes = make_int (1);
4497 DEFVAR_INT ("auto-save-interval", &auto_save_interval /*
4498 *Number of keyboard input characters between auto-saves.
4499 Zero means disable autosaving due to number of characters typed.
4500 See also the variable `auto-save-timeout'.
4502 auto_save_interval = 300;
4504 DEFVAR_LISP ("pre-command-hook", &Vpre_command_hook /*
4505 Function or functions to run before every command.
4506 This may examine the `this-command' variable to find out what command
4507 is about to be run, or may change it to cause a different command to run.
4508 Function on this hook must be careful to avoid signalling errors!
4510 Vpre_command_hook = Qnil;
4512 DEFVAR_LISP ("post-command-hook", &Vpost_command_hook /*
4513 Function or functions to run after every command.
4514 This may examine the `this-command' variable to find out what command
4517 Vpost_command_hook = Qnil;
4519 DEFVAR_LISP ("pre-idle-hook", &Vpre_idle_hook /*
4520 Normal hook run when XEmacs it about to be idle.
4521 This occurs whenever it is going to block, waiting for an event.
4522 This generally happens as a result of a call to `next-event',
4523 `next-command-event', `sit-for', `sleep-for', `accept-process-output',
4524 or `x-get-selection'.
4525 Errors running the hook are caught and ignored.
4527 Vpre_idle_hook = Qnil;
4529 DEFVAR_BOOL ("focus-follows-mouse", &focus_follows_mouse /*
4530 *Variable to control XEmacs behavior with respect to focus changing.
4531 If this variable is set to t, then XEmacs will not gratuitously change
4532 the keyboard focus. XEmacs cannot in general detect when this mode is
4533 used by the window manager, so it is up to the user to set it.
4535 focus_follows_mouse = 0;
4537 DEFVAR_LISP ("last-command-event", &Vlast_command_event /*
4538 Last keyboard or mouse button event that was part of a command. This
4539 variable is off limits: you may not set its value or modify the event that
4540 is its value, as it is destructively modified by `read-key-sequence'. If
4541 you want to keep a pointer to this value, you must use `copy-event'.
4543 Vlast_command_event = Qnil;
4545 DEFVAR_LISP ("last-command-char", &Vlast_command_char /*
4546 If the value of `last-command-event' is a keyboard event, then
4547 this is the nearest ASCII equivalent to it. This is the value that
4548 `self-insert-command' will put in the buffer. Remember that there is
4549 NOT a 1:1 mapping between keyboard events and ASCII characters: the set
4550 of keyboard events is much larger, so writing code that examines this
4551 variable to determine what key has been typed is bad practice, unless
4552 you are certain that it will be one of a small set of characters.
4554 Vlast_command_char = Qnil;
4556 DEFVAR_LISP ("last-input-event", &Vlast_input_event /*
4557 Last keyboard or mouse button event received. This variable is off
4558 limits: you may not set its value or modify the event that is its value, as
4559 it is destructively modified by `next-event'. If you want to keep a pointer
4560 to this value, you must use `copy-event'.
4562 Vlast_input_event = Qnil;
4564 DEFVAR_LISP ("current-mouse-event", &Vcurrent_mouse_event /*
4565 The mouse-button event which invoked this command, or nil.
4566 This is usually what `(interactive "e")' returns.
4568 Vcurrent_mouse_event = Qnil;
4570 DEFVAR_LISP ("last-input-char", &Vlast_input_char /*
4571 If the value of `last-input-event' is a keyboard event, then
4572 this is the nearest ASCII equivalent to it. Remember that there is
4573 NOT a 1:1 mapping between keyboard events and ASCII characters: the set
4574 of keyboard events is much larger, so writing code that examines this
4575 variable to determine what key has been typed is bad practice, unless
4576 you are certain that it will be one of a small set of characters.
4578 Vlast_input_char = Qnil;
4580 DEFVAR_LISP ("last-input-time", &Vlast_input_time /*
4581 The time (in seconds since Jan 1, 1970) of the last-command-event,
4582 represented as a cons of two 16-bit integers. This is destructively
4583 modified, so copy it if you want to keep it.
4585 Vlast_input_time = Qnil;
4587 DEFVAR_LISP ("last-command-event-time", &Vlast_command_event_time /*
4588 The time (in seconds since Jan 1, 1970) of the last-command-event,
4589 represented as a list of three integers. The first integer contains
4590 the most significant 16 bits of the number of seconds, and the second
4591 integer contains the least significant 16 bits. The third integer
4592 contains the remainder number of microseconds, if the current system
4593 supports microsecond clock resolution. This list is destructively
4594 modified, so copy it if you want to keep it.
4596 Vlast_command_event_time = Qnil;
4598 DEFVAR_LISP ("unread-command-events", &Vunread_command_events /*
4599 List of event objects to be read as next command input events.
4600 This can be used to simulate the receipt of events from the user.
4601 Normally this is nil.
4602 Events are removed from the front of this list.
4604 Vunread_command_events = Qnil;
4606 DEFVAR_LISP ("unread-command-event", &Vunread_command_event /*
4607 Obsolete. Use `unread-command-events' instead.
4609 Vunread_command_event = Qnil;
4611 DEFVAR_LISP ("last-command", &Vlast_command /*
4612 The last command executed. Normally a symbol with a function definition,
4613 but can be whatever was found in the keymap, or whatever the variable
4614 `this-command' was set to by that command.
4616 Vlast_command = Qnil;
4618 DEFVAR_LISP ("this-command", &Vthis_command /*
4619 The command now being executed.
4620 The command can set this variable; whatever is put here
4621 will be in `last-command' during the following command.
4623 Vthis_command = Qnil;
4625 DEFVAR_LISP ("last-command-properties", &Vlast_command_properties /*
4626 Value of `this-command-properties' for the last command.
4627 Used by commands to help synchronize consecutive commands, in preference
4628 to looking at `last-command' directly.
4630 Vlast_command_properties = Qnil;
4632 DEFVAR_LISP ("this-command-properties", &Vthis_command_properties /*
4633 Properties set by the current command.
4634 At the beginning of each command, the current value of this variable is
4635 copied to `last-command-properties', and then it is set to nil. Use `putf'
4636 to add properties to this variable. Commands should use this to communicate
4637 with pre/post-command hooks, subsequent commands, wrapping commands, etc.
4638 in preference to looking at and/or setting `this-command'.
4640 Vthis_command_properties = Qnil;
4642 DEFVAR_LISP ("help-char", &Vhelp_char /*
4643 Character to recognize as meaning Help.
4644 When it is read, do `(eval help-form)', and display result if it's a string.
4645 If the value of `help-form' is nil, this char can be read normally.
4646 This can be any form recognized as a single key specifier.
4647 The help-char cannot be a negative number in XEmacs.
4649 Vhelp_char = make_char (8); /* C-h */
4651 DEFVAR_LISP ("help-form", &Vhelp_form /*
4652 Form to execute when character help-char is read.
4653 If the form returns a string, that string is displayed.
4654 If `help-form' is nil, the help char is not recognized.
4658 DEFVAR_LISP ("prefix-help-command", &Vprefix_help_command /*
4659 Command to run when `help-char' character follows a prefix key.
4660 This command is used only when there is no actual binding
4661 for that character after that prefix key.
4663 Vprefix_help_command = Qnil;
4665 DEFVAR_CONST_LISP ("keyboard-translate-table", &Vkeyboard_translate_table /*
4666 Hash table used as translate table for keyboard input.
4667 Use `keyboard-translate' to portably add entries to this table.
4668 Each key-press event is looked up in this table as follows:
4670 -- If an entry maps a symbol to a symbol, then a key-press event whose
4671 keysym is the former symbol (with any modifiers at all) gets its
4672 keysym changed and its modifiers left alone. This is useful for
4673 dealing with non-standard X keyboards, such as the grievous damage
4674 that Sun has inflicted upon the world.
4675 -- If an entry maps a symbol to a character, then a key-press event
4676 whose keysym is the former symbol (with any modifiers at all) gets
4677 changed into a key-press event matching the latter character, and the
4678 resulting modifiers are the union of the original and new modifiers.
4679 -- If an entry maps a character to a character, then a key-press event
4680 matching the former character gets converted to a key-press event
4681 matching the latter character. This is useful on ASCII terminals
4682 for (e.g.) making C-\\ look like C-s, to get around flow-control
4684 -- If an entry maps a character to a symbol, then a key-press event
4685 matching the character gets converted to a key-press event whose
4686 keysym is the given symbol and which has no modifiers.
4688 Here's an example: This makes typing parens and braces easier by rerouting
4689 their positions to eliminate the need to use the Shift key.
4691 (keyboard-translate ?[ ?()
4692 (keyboard-translate ?] ?))
4693 (keyboard-translate ?{ ?[)
4694 (keyboard-translate ?} ?])
4695 (keyboard-translate 'f11 ?{)
4696 (keyboard-translate 'f12 ?})
4699 DEFVAR_LISP ("retry-undefined-key-binding-unshifted",
4700 &Vretry_undefined_key_binding_unshifted /*
4701 If a key-sequence which ends with a shifted keystroke is undefined
4702 and this variable is non-nil then the command lookup is retried again
4703 with the last key unshifted. (e.g. C-X C-F would be retried as C-X C-f.)
4704 If lookup still fails, a normal error is signalled. In general,
4705 you should *bind* this, not set it.
4707 Vretry_undefined_key_binding_unshifted = Qt;
4709 DEFVAR_BOOL ("modifier-keys-are-sticky", &modifier_keys_are_sticky /*
4710 *Non-nil makes modifier keys sticky.
4711 This means that you can release the modifier key before pressing down
4712 the key that you wish to be modified. Although this is non-standard
4713 behavior, it is recommended because it reduces the strain on your hand,
4714 thus reducing the incidence of the dreaded Emacs-pinky syndrome.
4716 Modifier keys are sticky within the inverval specified by
4717 `modifier-keys-sticky-time'.
4719 modifier_keys_are_sticky = 0;
4721 DEFVAR_LISP ("modifier-keys-sticky-time", &Vmodifier_keys_sticky_time /*
4722 *Modifier keys are sticky within this many milliseconds.
4723 If you don't want modifier keys sticking to be bounded, set this to
4726 This variable has no effect when `modifier-keys-are-sticky' is nil.
4727 Currently only implemented under X Window System.
4729 Vmodifier_keys_sticky_time = make_int (500);
4732 DEFVAR_LISP ("composed-character-default-binding",
4733 &Vcomposed_character_default_binding /*
4734 The default keybinding to use for key events from composed input.
4735 Window systems frequently have ways to allow the user to compose
4736 single characters in a language using multiple keystrokes.
4737 XEmacs sees these as single character keypress events.
4739 Vcomposed_character_default_binding = Qself_insert_command;
4740 #endif /* HAVE_XIM */
4742 Vcontrolling_terminal = Qnil;
4743 staticpro (&Vcontrolling_terminal);
4745 Vdribble_file = Qnil;
4746 staticpro (&Vdribble_file);
4749 DEFVAR_INT ("debug-emacs-events", &debug_emacs_events /*
4750 If non-zero, display debug information about Emacs events that XEmacs sees.
4751 Information is displayed on stderr.
4753 Before the event, the source of the event is displayed in parentheses,
4754 and is one of the following:
4756 \(real) A real event from the window system or
4757 terminal driver, as far as XEmacs can tell.
4759 \(keyboard macro) An event generated from a keyboard macro.
4761 \(unread-command-events) An event taken from `unread-command-events'.
4763 \(unread-command-event) An event taken from `unread-command-event'.
4765 \(command event queue) An event taken from an internal queue.
4766 Events end up on this queue when
4767 `enqueue-eval-event' is called or when
4768 user or eval events are received while
4769 XEmacs is blocking (e.g. in `sit-for',
4770 `sleep-for', or `accept-process-output',
4771 or while waiting for the reply to an
4774 \(->keyboard-translate-table) The result of an event translated through
4775 keyboard-translate-table. Note that in
4776 this case, two events are printed even
4777 though only one is really generated.
4779 \(SIGINT) A faked C-g resulting when XEmacs receives
4780 a SIGINT (e.g. C-c was pressed in XEmacs'
4781 controlling terminal or the signal was
4782 explicitly sent to the XEmacs process).
4784 debug_emacs_events = 0;
4787 DEFVAR_BOOL ("inhibit-input-event-recording", &inhibit_input_event_recording /*
4788 Non-nil inhibits recording of input-events to recent-keys ring.
4790 inhibit_input_event_recording = 0;
4794 complex_vars_of_event_stream (void)
4796 Vkeyboard_translate_table =
4797 make_lisp_hash_table (100, HASH_TABLE_NON_WEAK, HASH_TABLE_EQ);
4801 init_event_stream (void)
4805 #ifdef HAVE_UNIXOID_EVENT_LOOP
4806 init_event_unixoid ();
4808 #ifdef HAVE_X_WINDOWS
4809 if (!strcmp (display_use, "x"))
4810 init_event_Xt_late ();
4813 #ifdef HAVE_MS_WINDOWS
4814 if (!strcmp (display_use, "mswindows"))
4815 init_event_mswindows_late ();
4819 /* For TTY's, use the Xt event loop if we can; it allows
4820 us to later open an X connection. */
4821 #if defined (HAVE_MS_WINDOWS) && (!defined (HAVE_TTY) \
4822 || (defined (HAVE_MSG_SELECT) \
4823 && !defined (DEBUG_TTY_EVENT_STREAM)))
4824 init_event_mswindows_late ();
4825 #elif defined (HAVE_X_WINDOWS) && !defined (DEBUG_TTY_EVENT_STREAM)
4826 init_event_Xt_late ();
4827 #elif defined (HAVE_TTY)
4828 init_event_tty_late ();
4831 init_interrupts_late ();
4837 useful testcases for v18/v19 compatibility:
4841 (setq unread-command-event (character-to-event ?A (allocate-event)))
4842 (setq x (list (read-char)
4843 ; (read-key-sequence "") ; try it with and without this
4844 last-command-char last-input-char
4845 (recent-keys) (this-command-keys))))
4846 (global-set-key "\^Q" 'foo)
4848 without the read-key-sequence:
4849 ^Q ==> (?A ?\^Q ?A [... ^Q] [^Q])
4850 ^U^U^Q ==> (?A ?\^Q ?A [... ^U ^U ^Q] [^U ^U ^Q])
4851 ^U^U^U^G^Q ==> (?A ?\^Q ?A [... ^U ^U ^U ^G ^Q] [^Q])
4853 with the read-key-sequence:
4854 ^Qb ==> (?A [b] ?\^Q ?b [... ^Q b] [b])
4855 ^U^U^Qb ==> (?A [b] ?\^Q ?b [... ^U ^U ^Q b] [b])
4856 ^U^U^U^G^Qb ==> (?A [b] ?\^Q ?b [... ^U ^U ^U ^G ^Q b] [b])
4858 ;the evi-mode command "4dlj.j.j.j.j.j." is also a good testcase (gag)
4860 ;(setq x (list (read-char) quit-flag))^J^G
4861 ;(let ((inhibit-quit t)) (setq x (list (read-char) quit-flag)))^J^G
4862 ;for BOTH, x should get set to (7 t), but no result should be printed.
4863 ;; #### According to the doc of quit-flag, second test should return
4864 ;; (?\^G nil). Accidentaly XEmacs returns correct value. However,
4865 ;; XEmacs 21.1.12 and 21.2.36 both fails on first test.
4867 ;also do this: make two frames, one viewing "*scratch*", the other "foo".
4868 ;in *scratch*, type (sit-for 20)^J
4869 ;wait a couple of seconds, move cursor to foo, type "a"
4870 ;a should be inserted in foo. Cursor highlighting should not change in
4873 ;do it with sleep-for. move cursor into foo, then back into *scratch*
4875 ;repeat also with (accept-process-output nil 20)
4877 ;make sure ^G aborts sit-for, sleep-for and accept-process-output:
4880 (list (condition-case c
4885 (tst)^Ja^G ==> ((quit) ?a) with no signal
4886 (tst)^J^Ga ==> ((quit) ?a) with no signal
4887 (tst)^Jabc^G ==> ((quit) ?a) with no signal, and "bc" inserted in buffer
4889 ; with sit-for only do the 2nd test.
4890 ; Do all 3 tests with (accept-process-output nil 20)
4893 (setq enable-recursive-minibuffers t
4894 minibuffer-max-depth nil)
4895 ESC ESC ESC ESC - there are now two minibuffers active
4896 C-g C-g C-g - there should be active 0, not 1
4898 C-x C-f ~ / ? - wait for "Making completion list..." to display
4899 C-g - wait for "Quit" to display
4900 C-g - minibuffer should not be active
4901 however C-g before "Quit" is displayed should leave minibuffer active.
4903 ;do it all in both v18 and v19 and make sure all results are the same.
4904 ;all of these cases matter a lot, but some in quite subtle ways.
4908 Additional test cases for accept-process-output, sleep-for, sit-for.
4909 Be sure you do all of the above checking for C-g and focus, too!
4911 ; Make sure that timer handlers are run during, not after sit-for:
4912 (defun timer-check ()
4913 (add-timeout 2 '(lambda (ignore) (message "timer ran")) nil)
4915 (message "after sit-for"))
4917 ; The first message should appear after 2 seconds, and the final message
4918 ; 3 seconds after that.
4919 ; repeat above test with (sleep-for 5) and (accept-process-output nil 5)
4923 ; Make sure that process filters are run during, not after sit-for.
4925 (message "sit-for = %s" (sit-for 30)))
4926 (add-hook 'post-command-hook 'fubar)
4928 ; Now type M-x shell RET
4929 ; wait for the shell prompt then send: ls RET
4930 ; the output of ls should fill immediately, and not wait 30 seconds.
4932 ; repeat above test with (sleep-for 30) and (accept-process-output nil 30)
4936 ; Make sure that recursive invocations return immediately:
4937 (defmacro test-diff-time (start end)
4938 `(+ (* (- (car ,end) (car ,start)) 65536.0)
4939 (- (cadr ,end) (cadr ,start))
4940 (/ (- (caddr ,end) (caddr ,start)) 1000000.0)))
4942 (defun testee (ignore)
4946 (let ((start (current-time))
4948 (add-timeout 2 'testee nil)
4950 (add-timeout 2 'testee nil)
4952 (add-timeout 2 'testee nil)
4953 (accept-process-output nil 5)
4954 (setq end (current-time))
4955 (test-diff-time start end)))
4957 (test-them) should sit for 15 seconds.
4958 Repeat with testee set to sleep-for and accept-process-output.
4959 These should each delay 36 seconds.