1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2014 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include "termhooks.h"
34 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #if defined USABLE_FIONREAD && defined USG5_4
59 # include <sys/filio.h>
62 #include "syssignal.h"
64 #include <sys/types.h>
68 #ifdef HAVE_WINDOW_SYSTEM
70 #endif /* HAVE_WINDOW_SYSTEM */
72 /* Variables for blockinput.h: */
74 /* Positive if interrupt input is blocked right now. */
75 volatile int interrupt_input_blocked
;
77 /* True means an input interrupt or alarm signal has arrived.
78 The QUIT macro checks this. */
79 volatile bool pending_signals
;
81 #define KBD_BUFFER_SIZE 4096
83 KBOARD
*initial_kboard
;
84 KBOARD
*current_kboard
;
85 static KBOARD
*all_kboards
;
87 /* True in the single-kboard state, false in the any-kboard state. */
88 static bool single_kboard
;
90 /* Non-nil disable property on a command means
91 do not execute it; call disabled-command-function's value instead. */
92 Lisp_Object Qdisabled
;
93 static Lisp_Object Qdisabled_command_function
;
95 #define NUM_RECENT_KEYS (300)
97 /* Index for storing next element into recent_keys. */
98 static int recent_keys_index
;
100 /* Total number of elements stored into recent_keys. */
101 static int total_keys
;
103 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
104 static Lisp_Object recent_keys
;
106 /* Vector holding the key sequence that invoked the current command.
107 It is reused for each command, and it may be longer than the current
108 sequence; this_command_key_count indicates how many elements
109 actually mean something.
110 It's easier to staticpro a single Lisp_Object than an array. */
111 Lisp_Object this_command_keys
;
112 ptrdiff_t this_command_key_count
;
114 /* True after calling Freset_this_command_lengths.
115 Usually it is false. */
116 static bool this_command_key_count_reset
;
118 /* This vector is used as a buffer to record the events that were actually read
119 by read_key_sequence. */
120 static Lisp_Object raw_keybuf
;
121 static int raw_keybuf_count
;
123 #define GROW_RAW_KEYBUF \
124 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
125 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
127 /* Number of elements of this_command_keys
128 that precede this key sequence. */
129 static ptrdiff_t this_single_command_key_start
;
131 /* Record values of this_command_key_count and echo_length ()
132 before this command was read. */
133 static ptrdiff_t before_command_key_count
;
134 static ptrdiff_t before_command_echo_length
;
136 #ifdef HAVE_STACK_OVERFLOW_HANDLING
138 /* For longjmp to recover from C stack overflow. */
139 sigjmp_buf return_to_command_loop
;
141 /* Message displayed by Vtop_level when recovering from C stack overflow. */
142 static Lisp_Object recover_top_level_message
;
144 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
146 /* Message normally displayed by Vtop_level. */
147 static Lisp_Object regular_top_level_message
;
149 /* For longjmp to where kbd input is being done. */
151 static sys_jmp_buf getcjmp
;
153 /* True while doing kbd input. */
154 bool waiting_for_input
;
156 /* True while displaying for echoing. Delays C-g throwing. */
160 /* Non-null means we can start echoing at the next input pause even
161 though there is something in the echo area. */
163 static struct kboard
*ok_to_echo_at_next_pause
;
165 /* The kboard last echoing, or null for none. Reset to 0 in
166 cancel_echoing. If non-null, and a current echo area message
167 exists, and echo_message_buffer is eq to the current message
168 buffer, we know that the message comes from echo_kboard. */
170 struct kboard
*echo_kboard
;
172 /* The buffer used for echoing. Set in echo_now, reset in
175 Lisp_Object echo_message_buffer
;
177 /* True means C-g should cause immediate error-signal. */
180 /* Character that causes a quit. Normally C-g.
182 If we are running on an ordinary terminal, this must be an ordinary
183 ASCII char, since we want to make it our interrupt character.
185 If we are not running on an ordinary terminal, it still needs to be
186 an ordinary ASCII char. This character needs to be recognized in
187 the input interrupt handler. At this point, the keystroke is
188 represented as a struct input_event, while the desired quit
189 character is specified as a lispy event. The mapping from struct
190 input_events to lispy events cannot run in an interrupt handler,
191 and the reverse mapping is difficult for anything but ASCII
194 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
198 /* Current depth in recursive edits. */
199 EMACS_INT command_loop_level
;
201 /* If not Qnil, this is a switch-frame event which we decided to put
202 off until the end of a key sequence. This should be read as the
203 next command input, after any unread_command_events.
205 read_key_sequence uses this to delay switch-frame events until the
206 end of the key sequence; Fread_char uses it to put off switch-frame
207 events until a non-ASCII event is acceptable as input. */
208 Lisp_Object unread_switch_frame
;
210 /* Last size recorded for a current buffer which is not a minibuffer. */
211 static ptrdiff_t last_non_minibuf_size
;
213 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
214 uintmax_t num_input_events
;
216 /* Value of num_nonmacro_input_events as of last auto save. */
218 static EMACS_INT last_auto_save
;
220 /* The value of point when the last command was started. */
221 static ptrdiff_t last_point_position
;
223 /* The frame in which the last input event occurred, or Qmacro if the
224 last event came from a macro. We use this to determine when to
225 generate switch-frame events. This may be cleared by functions
226 like Fselect_frame, to make sure that a switch-frame event is
227 generated by the next character.
229 FIXME: This is modified by a signal handler so it should be volatile.
230 It's exported to Lisp, though, so it can't simply be marked
232 Lisp_Object internal_last_event_frame
;
234 static Lisp_Object Qgui_set_selection
, Qhandle_switch_frame
;
235 static Lisp_Object Qhandle_select_window
;
236 Lisp_Object QPRIMARY
;
238 static Lisp_Object Qself_insert_command
;
239 static Lisp_Object Qforward_char
;
240 static Lisp_Object Qbackward_char
;
241 Lisp_Object Qundefined
;
242 static Lisp_Object Qtimer_event_handler
;
244 /* `read_key_sequence' stores here the command definition of the
245 key sequence that it reads. */
246 static Lisp_Object read_key_sequence_cmd
;
247 static Lisp_Object read_key_sequence_remapped
;
249 static Lisp_Object Qinput_method_function
;
251 static Lisp_Object Qdeactivate_mark
;
253 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
255 static Lisp_Object Qecho_area_clear_hook
;
257 /* Hooks to run before and after each command. */
258 static Lisp_Object Qpre_command_hook
;
259 static Lisp_Object Qpost_command_hook
;
261 static Lisp_Object Qdeferred_action_function
;
263 static Lisp_Object Qdelayed_warnings_hook
;
265 static Lisp_Object Qinput_method_exit_on_first_char
;
266 static Lisp_Object Qinput_method_use_echo_area
;
268 static Lisp_Object Qhelp_form_show
;
270 /* File in which we write all commands we read. */
271 static FILE *dribble
;
273 /* Nonzero if input is available. */
276 /* Circular buffer for pre-read keyboard input. */
278 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
280 /* Pointer to next available character in kbd_buffer.
281 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
282 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
283 next available char is in kbd_buffer[0]. */
284 static struct input_event
*kbd_fetch_ptr
;
286 /* Pointer to next place to store character in kbd_buffer. This
287 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
288 character should go in kbd_buffer[0]. */
289 static struct input_event
* volatile kbd_store_ptr
;
291 /* The above pair of variables forms a "queue empty" flag. When we
292 enqueue a non-hook event, we increment kbd_store_ptr. When we
293 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
294 there is input available if the two pointers are not equal.
296 Why not just have a flag set and cleared by the enqueuing and
297 dequeuing functions? Such a flag could be screwed up by interrupts
298 at inopportune times. */
300 /* Symbols to head events. */
301 static Lisp_Object Qmouse_movement
;
302 static Lisp_Object Qscroll_bar_movement
;
303 Lisp_Object Qswitch_frame
;
304 static Lisp_Object Qfocus_in
, Qfocus_out
;
305 static Lisp_Object Qdelete_frame
;
306 static Lisp_Object Qiconify_frame
;
307 static Lisp_Object Qmake_frame_visible
;
308 static Lisp_Object Qselect_window
;
309 Lisp_Object Qhelp_echo
;
311 static Lisp_Object Qmouse_fixup_help_message
;
313 /* Symbols to denote kinds of events. */
314 static Lisp_Object Qfunction_key
;
315 Lisp_Object Qmouse_click
;
317 Lisp_Object Qlanguage_change
;
319 static Lisp_Object Qdrag_n_drop
;
320 static Lisp_Object Qsave_session
;
322 static Lisp_Object Qdbus_event
;
324 #ifdef USE_FILE_NOTIFY
325 static Lisp_Object Qfile_notify
;
326 #endif /* USE_FILE_NOTIFY */
327 static Lisp_Object Qconfig_changed_event
;
329 /* Lisp_Object Qmouse_movement; - also an event header */
331 /* Properties of event headers. */
332 Lisp_Object Qevent_kind
;
333 static Lisp_Object Qevent_symbol_elements
;
335 /* Menu and tool bar item parts. */
336 static Lisp_Object Qmenu_enable
;
337 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
338 Lisp_Object QCfilter
;
340 /* Non-nil disable property on a command means
341 do not execute it; call disabled-command-function's value instead. */
342 Lisp_Object QCtoggle
, QCradio
;
343 static Lisp_Object QCbutton
, QClabel
;
345 static Lisp_Object QCvert_only
;
347 /* An event header symbol HEAD may have a property named
348 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
349 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
350 mask of modifiers applied to it. If present, this is used to help
351 speed up parse_modifiers. */
352 Lisp_Object Qevent_symbol_element_mask
;
354 /* An unmodified event header BASE may have a property named
355 Qmodifier_cache, which is an alist mapping modifier masks onto
356 modified versions of BASE. If present, this helps speed up
358 static Lisp_Object Qmodifier_cache
;
360 /* Symbols to use for parts of windows. */
361 Lisp_Object Qmode_line
;
362 Lisp_Object Qvertical_line
;
363 Lisp_Object Qright_divider
, Qbottom_divider
;
364 Lisp_Object Qmenu_bar
;
366 static Lisp_Object Qecho_keystrokes
;
368 static void recursive_edit_unwind (Lisp_Object buffer
);
369 static Lisp_Object
command_loop (void);
370 static Lisp_Object Qcommand_execute
;
372 static void echo_now (void);
373 static ptrdiff_t echo_length (void);
375 static Lisp_Object Qpolling_period
;
377 /* Incremented whenever a timer is run. */
380 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
382 struct timespec
*input_available_clear_time
;
384 /* True means use SIGIO interrupts; false means use CBREAK mode.
385 Default is true if INTERRUPT_INPUT is defined. */
386 bool interrupt_input
;
388 /* Nonzero while interrupts are temporarily deferred during redisplay. */
389 bool interrupts_deferred
;
391 /* The time when Emacs started being idle. */
393 static struct timespec timer_idleness_start_time
;
395 /* After Emacs stops being idle, this saves the last value
396 of timer_idleness_start_time from when it was idle. */
398 static struct timespec timer_last_idleness_start_time
;
401 /* Global variable declarations. */
403 /* Flags for readable_events. */
404 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
405 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
406 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
408 /* Function for init_keyboard to call with no args (if nonzero). */
409 static void (*keyboard_init_hook
) (void);
411 static bool get_input_pending (int);
412 static bool readable_events (int);
413 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
414 Lisp_Object
, bool *);
415 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
416 static Lisp_Object
make_lispy_event (struct input_event
*);
417 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
418 enum scroll_bar_part
,
419 Lisp_Object
, Lisp_Object
,
421 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
422 Lisp_Object
, const char *const *,
423 Lisp_Object
*, ptrdiff_t);
424 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
425 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
426 #ifdef HAVE_WINDOW_SYSTEM
427 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
428 #endif /* HAVE_WINDOW_SYSTEM */
429 static bool help_char_p (Lisp_Object
);
430 static void save_getcjmp (sys_jmp_buf
);
431 static void restore_getcjmp (sys_jmp_buf
);
432 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
433 static void clear_event (struct input_event
*);
434 static void restore_kboard_configuration (int);
436 static void deliver_input_available_signal (int signo
);
438 static void handle_interrupt (bool);
439 static _Noreturn
void quit_throw_to_read_char (bool);
440 static void process_special_events (void);
441 static void timer_start_idle (void);
442 static void timer_stop_idle (void);
443 static void timer_resume_idle (void);
444 static void deliver_user_signal (int);
445 static char *find_user_signal_name (int);
446 static void store_user_signal_events (void);
448 /* These setters are used only in this file, so they can be private. */
450 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
452 kb
->INTERNAL_FIELD (echo_string
) = val
;
455 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
457 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
460 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
462 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
465 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
467 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
470 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
472 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
475 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
477 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
480 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
482 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
485 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
487 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
490 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
492 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
496 /* Add C to the echo string, without echoing it immediately. C can be
497 a character, which is pretty-printed, or a symbol, whose name is
501 echo_add_key (Lisp_Object c
)
503 char initbuf
[KEY_DESCRIPTION_SIZE
+ 100];
504 ptrdiff_t size
= sizeof initbuf
;
505 char *buffer
= initbuf
;
507 Lisp_Object echo_string
;
510 echo_string
= KVAR (current_kboard
, echo_string
);
512 /* If someone has passed us a composite event, use its head symbol. */
516 ptr
= push_key_description (XINT (c
), ptr
);
517 else if (SYMBOLP (c
))
519 Lisp_Object name
= SYMBOL_NAME (c
);
520 ptrdiff_t nbytes
= SBYTES (name
);
522 if (size
- (ptr
- buffer
) < nbytes
)
524 ptrdiff_t offset
= ptr
- buffer
;
525 size
= max (2 * size
, size
+ nbytes
);
526 buffer
= SAFE_ALLOCA (size
);
527 ptr
= buffer
+ offset
;
530 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
531 STRING_MULTIBYTE (name
), 1);
534 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
537 static const char text
[] = " (Type ? for further options)";
538 int len
= sizeof text
- 1;
540 if (size
- (ptr
- buffer
) < len
)
542 ptrdiff_t offset
= ptr
- buffer
;
544 buffer
= SAFE_ALLOCA (size
);
545 ptr
= buffer
+ offset
;
548 memcpy (ptr
, text
, len
);
552 /* Replace a dash from echo_dash with a space, otherwise add a space
553 at the end as a separator between keys. */
554 AUTO_STRING (space
, " ");
555 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
557 Lisp_Object last_char
, prev_char
, idx
;
559 idx
= make_number (SCHARS (echo_string
) - 2);
560 prev_char
= Faref (echo_string
, idx
);
562 idx
= make_number (SCHARS (echo_string
) - 1);
563 last_char
= Faref (echo_string
, idx
);
565 /* We test PREV_CHAR to make sure this isn't the echoing of a
567 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
568 Faset (echo_string
, idx
, make_number (' '));
570 echo_string
= concat2 (echo_string
, space
);
572 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
573 echo_string
= concat2 (echo_string
, space
);
577 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
581 /* Add C to the echo string, if echoing is going on. C can be a
582 character or a symbol. */
585 echo_char (Lisp_Object c
)
587 if (current_kboard
->immediate_echo
)
594 /* Temporarily add a dash to the end of the echo string if it's not
595 empty, so that it serves as a mini-prompt for the very next
601 /* Do nothing if not echoing at all. */
602 if (NILP (KVAR (current_kboard
, echo_string
)))
605 if (this_command_key_count
== 0)
608 if (!current_kboard
->immediate_echo
609 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
612 /* Do nothing if we just printed a prompt. */
613 if (current_kboard
->echo_after_prompt
614 == SCHARS (KVAR (current_kboard
, echo_string
)))
617 /* Do nothing if we have already put a dash at the end. */
618 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
620 Lisp_Object last_char
, prev_char
, idx
;
622 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
623 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
625 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
626 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
628 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
632 /* Put a dash at the end of the buffer temporarily,
633 but make it go away when the next character is added. */
634 AUTO_STRING (dash
, "-");
635 kset_echo_string (current_kboard
,
636 concat2 (KVAR (current_kboard
, echo_string
), dash
));
640 /* Display the current echo string, and begin echoing if not already
646 if (!current_kboard
->immediate_echo
)
649 current_kboard
->immediate_echo
= 1;
651 for (i
= 0; i
< this_command_key_count
; i
++)
655 /* Set before_command_echo_length to the value that would
656 have been saved before the start of this subcommand in
657 command_loop_1, if we had already been echoing then. */
658 if (i
== this_single_command_key_start
)
659 before_command_echo_length
= echo_length ();
661 c
= AREF (this_command_keys
, i
);
662 if (! (EVENT_HAS_PARAMETERS (c
)
663 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
667 /* Set before_command_echo_length to the value that would
668 have been saved before the start of this subcommand in
669 command_loop_1, if we had already been echoing then. */
670 if (this_command_key_count
== this_single_command_key_start
)
671 before_command_echo_length
= echo_length ();
673 /* Put a dash at the end to invite the user to type more. */
678 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
679 message3_nolog (KVAR (current_kboard
, echo_string
));
682 /* Record in what buffer we echoed, and from which kboard. */
683 echo_message_buffer
= echo_area_buffer
[0];
684 echo_kboard
= current_kboard
;
686 if (waiting_for_input
&& !NILP (Vquit_flag
))
687 quit_throw_to_read_char (0);
690 /* Turn off echoing, for the start of a new command. */
693 cancel_echoing (void)
695 current_kboard
->immediate_echo
= 0;
696 current_kboard
->echo_after_prompt
= -1;
697 kset_echo_string (current_kboard
, Qnil
);
698 ok_to_echo_at_next_pause
= NULL
;
700 echo_message_buffer
= Qnil
;
703 /* Return the length of the current echo string. */
708 return (STRINGP (KVAR (current_kboard
, echo_string
))
709 ? SCHARS (KVAR (current_kboard
, echo_string
))
713 /* Truncate the current echo message to its first LEN chars.
714 This and echo_char get used by read_key_sequence when the user
715 switches frames while entering a key sequence. */
718 echo_truncate (ptrdiff_t nchars
)
720 if (STRINGP (KVAR (current_kboard
, echo_string
)))
721 kset_echo_string (current_kboard
,
722 Fsubstring (KVAR (current_kboard
, echo_string
),
723 make_number (0), make_number (nchars
)));
724 truncate_echo_area (nchars
);
728 /* Functions for manipulating this_command_keys. */
730 add_command_key (Lisp_Object key
)
732 #if 0 /* Not needed after we made Freset_this_command_lengths
733 do the job immediately. */
734 /* If reset-this-command-length was called recently, obey it now.
735 See the doc string of that function for an explanation of why. */
736 if (before_command_restore_flag
)
738 this_command_key_count
= before_command_key_count_1
;
739 if (this_command_key_count
< this_single_command_key_start
)
740 this_single_command_key_start
= this_command_key_count
;
741 echo_truncate (before_command_echo_length_1
);
742 before_command_restore_flag
= 0;
746 if (this_command_key_count
>= ASIZE (this_command_keys
))
747 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
749 ASET (this_command_keys
, this_command_key_count
, key
);
750 ++this_command_key_count
;
755 recursive_edit_1 (void)
757 ptrdiff_t count
= SPECPDL_INDEX ();
760 if (command_loop_level
> 0)
762 specbind (Qstandard_output
, Qt
);
763 specbind (Qstandard_input
, Qt
);
766 #ifdef HAVE_WINDOW_SYSTEM
767 /* The command loop has started an hourglass timer, so we have to
768 cancel it here, otherwise it will fire because the recursive edit
769 can take some time. Do not check for display_hourglass_p here,
770 because it could already be nil. */
774 /* This function may have been called from a debugger called from
775 within redisplay, for instance by Edebugging a function called
776 from fontification-functions. We want to allow redisplay in
777 the debugging session.
779 The recursive edit is left with a `(throw exit ...)'. The `exit'
780 tag is not caught anywhere in redisplay, i.e. when we leave the
781 recursive edit, the original redisplay leading to the recursive
782 edit will be unwound. The outcome should therefore be safe. */
783 specbind (Qinhibit_redisplay
, Qnil
);
786 val
= command_loop ();
788 Fsignal (Qquit
, Qnil
);
789 /* Handle throw from read_minibuf when using minibuffer
790 while it's active but we're in another window. */
792 xsignal1 (Qerror
, val
);
794 return unbind_to (count
, Qnil
);
797 /* When an auto-save happens, record the "time", and don't do again soon. */
800 record_auto_save (void)
802 last_auto_save
= num_nonmacro_input_events
;
805 /* Make an auto save happen as soon as possible at command level. */
809 force_auto_save_soon (void)
811 last_auto_save
= - auto_save_interval
- 1;
813 record_asynch_buffer_change ();
817 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
818 doc
: /* Invoke the editor command loop recursively.
819 To get out of the recursive edit, a command can throw to `exit' -- for
820 instance `(throw 'exit nil)'.
821 If you throw a value other than t, `recursive-edit' returns normally
822 to the function that called it. Throwing a t value causes
823 `recursive-edit' to quit, so that control returns to the command loop
826 This function is called by the editor initialization to begin editing. */)
829 ptrdiff_t count
= SPECPDL_INDEX ();
832 /* If we enter while input is blocked, don't lock up here.
833 This may happen through the debugger during redisplay. */
834 if (input_blocked_p ())
837 if (command_loop_level
>= 0
838 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
839 buffer
= Fcurrent_buffer ();
843 /* Don't do anything interesting between the increment and the
844 record_unwind_protect! Otherwise, we could get distracted and
845 never decrement the counter again. */
846 command_loop_level
++;
847 update_mode_lines
= 17;
848 record_unwind_protect (recursive_edit_unwind
, buffer
);
850 /* If we leave recursive_edit_1 below with a `throw' for instance,
851 like it is done in the splash screen display, we have to
852 make sure that we restore single_kboard as command_loop_1
853 would have done if it were left normally. */
854 if (command_loop_level
> 0)
855 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
858 return unbind_to (count
, Qnil
);
862 recursive_edit_unwind (Lisp_Object buffer
)
864 if (BUFFERP (buffer
))
865 Fset_buffer (buffer
);
867 command_loop_level
--;
868 update_mode_lines
= 18;
872 #if 0 /* These two functions are now replaced with
873 temporarily_switch_to_single_kboard. */
877 #if 0 /* Theory: if there's anything in Vunread_command_events,
878 it will right away be read by read_key_sequence,
879 and then if we do switch KBOARDS, it will go into the side
880 queue then. So we don't need to do anything special here -- rms. */
881 if (CONSP (Vunread_command_events
))
883 current_kboard
->kbd_queue
884 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
885 current_kboard
->kbd_queue_has_data
= 1;
887 Vunread_command_events
= Qnil
;
892 /* Switch to the single-kboard state, making current_kboard
893 the only KBOARD from which further input is accepted. */
896 single_kboard_state ()
902 /* If we're in single_kboard state for kboard KBOARD,
906 not_single_kboard_state (KBOARD
*kboard
)
908 if (kboard
== current_kboard
)
912 /* Maintain a stack of kboards, so other parts of Emacs
913 can switch temporarily to the kboard of a given frame
914 and then revert to the previous status. */
919 struct kboard_stack
*next
;
922 static struct kboard_stack
*kboard_stack
;
925 push_kboard (struct kboard
*k
)
927 struct kboard_stack
*p
= xmalloc (sizeof *p
);
929 p
->next
= kboard_stack
;
930 p
->kboard
= current_kboard
;
940 struct kboard_stack
*p
= kboard_stack
;
942 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
944 if (t
->kboard
== p
->kboard
)
946 current_kboard
= p
->kboard
;
953 /* The terminal we remembered has been deleted. */
954 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
957 kboard_stack
= p
->next
;
961 /* Switch to single_kboard mode, making current_kboard the only KBOARD
962 from which further input is accepted. If F is non-nil, set its
963 KBOARD as the current keyboard.
965 This function uses record_unwind_protect_int to return to the previous
968 If Emacs is already in single_kboard mode, and F's keyboard is
969 locked, then this function will throw an error. */
972 temporarily_switch_to_single_kboard (struct frame
*f
)
974 bool was_locked
= single_kboard
;
977 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
978 /* We can not switch keyboards while in single_kboard mode.
979 In rare cases, Lisp code may call `recursive-edit' (or
980 `read-minibuffer' or `y-or-n-p') after it switched to a
981 locked frame. For example, this is likely to happen
982 when server.el connects to a new terminal while Emacs is in
983 single_kboard mode. It is best to throw an error instead
984 of presenting the user with a frozen screen. */
985 error ("Terminal %d is locked, cannot read from it",
986 FRAME_TERMINAL (f
)->id
);
988 /* This call is unnecessary, but helps
989 `restore_kboard_configuration' discover if somebody changed
990 `current_kboard' behind our back. */
991 push_kboard (current_kboard
);
994 current_kboard
= FRAME_KBOARD (f
);
996 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
999 #if 0 /* This function is not needed anymore. */
1001 record_single_kboard_state ()
1004 push_kboard (current_kboard
);
1005 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
1010 restore_kboard_configuration (int was_locked
)
1012 single_kboard
= was_locked
;
1015 struct kboard
*prev
= current_kboard
;
1017 /* The pop should not change the kboard. */
1018 if (single_kboard
&& current_kboard
!= prev
)
1024 /* Handle errors that are not handled at inner levels
1025 by printing an error message and returning to the editor command loop. */
1028 cmd_error (Lisp_Object data
)
1030 Lisp_Object old_level
, old_length
;
1031 char macroerror
[sizeof "After..kbd macro iterations: "
1032 + INT_STRLEN_BOUND (EMACS_INT
)];
1034 #ifdef HAVE_WINDOW_SYSTEM
1035 if (display_hourglass_p
)
1036 cancel_hourglass ();
1039 if (!NILP (executing_kbd_macro
))
1041 if (executing_kbd_macro_iterations
== 1)
1042 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1044 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1045 executing_kbd_macro_iterations
);
1050 Vstandard_output
= Qt
;
1051 Vstandard_input
= Qt
;
1052 Vexecuting_kbd_macro
= Qnil
;
1053 executing_kbd_macro
= Qnil
;
1054 kset_prefix_arg (current_kboard
, Qnil
);
1055 kset_last_prefix_arg (current_kboard
, Qnil
);
1058 /* Avoid unquittable loop if data contains a circular list. */
1059 old_level
= Vprint_level
;
1060 old_length
= Vprint_length
;
1061 XSETFASTINT (Vprint_level
, 10);
1062 XSETFASTINT (Vprint_length
, 10);
1063 cmd_error_internal (data
, macroerror
);
1064 Vprint_level
= old_level
;
1065 Vprint_length
= old_length
;
1068 Vinhibit_quit
= Qnil
;
1070 return make_number (0);
1073 /* Take actions on handling an error. DATA is the data that describes
1076 CONTEXT is a C-string containing ASCII characters only which
1077 describes the context in which the error happened. If we need to
1078 generalize CONTEXT to allow multibyte characters, make it a Lisp
1082 cmd_error_internal (Lisp_Object data
, const char *context
)
1084 /* The immediate context is not interesting for Quits,
1085 since they are asynchronous. */
1086 if (EQ (XCAR (data
), Qquit
))
1087 Vsignaling_function
= Qnil
;
1092 /* Use user's specified output function if any. */
1093 if (!NILP (Vcommand_error_function
))
1094 call3 (Vcommand_error_function
, data
,
1095 context
? build_string (context
) : empty_unibyte_string
,
1096 Vsignaling_function
);
1098 Vsignaling_function
= Qnil
;
1101 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1102 Scommand_error_default_function
, 3, 3, 0,
1103 doc
: /* Produce default output for unhandled error message.
1104 Default value of `command-error-function'. */)
1105 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1107 struct frame
*sf
= SELECTED_FRAME ();
1109 CHECK_STRING (context
);
1111 /* If the window system or terminal frame hasn't been initialized
1112 yet, or we're not interactive, write the message to stderr and exit. */
1113 if (!sf
->glyphs_initialized_p
1114 /* The initial frame is a special non-displaying frame. It
1115 will be current in daemon mode when there are no frames
1116 to display, and in non-daemon mode before the real frame
1117 has finished initializing. If an error is thrown in the
1118 latter case while creating the frame, then the frame
1119 will never be displayed, so the safest thing to do is
1120 write to stderr and quit. In daemon mode, there are
1121 many other potential errors that do not prevent frames
1122 from being created, so continuing as normal is better in
1124 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1127 print_error_message (data
, Qexternal_debugging_output
,
1128 SSDATA (context
), signal
);
1129 Fterpri (Qexternal_debugging_output
, Qnil
);
1130 Fkill_emacs (make_number (-1));
1134 clear_message (1, 0);
1136 message_log_maybe_newline ();
1139 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1144 static Lisp_Object
command_loop_2 (Lisp_Object
);
1145 static Lisp_Object
top_level_1 (Lisp_Object
);
1147 /* Entry to editor-command-loop.
1148 This level has the catches for exiting/returning to editor command loop.
1149 It returns nil to exit recursive edit, t to abort it. */
1154 #ifdef HAVE_STACK_OVERFLOW_HANDLING
1155 /* At least on GNU/Linux, saving signal mask is important here. */
1156 if (sigsetjmp (return_to_command_loop
, 1) != 0)
1158 /* Comes here from handle_sigsegv, see sysdep.c. */
1160 Vinternal__top_level_message
= recover_top_level_message
;
1163 Vinternal__top_level_message
= regular_top_level_message
;
1164 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
1165 if (command_loop_level
> 0 || minibuf_level
> 0)
1168 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1169 executing_kbd_macro
= Qnil
;
1175 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1176 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1177 executing_kbd_macro
= Qnil
;
1179 /* End of file in -batch run causes exit here. */
1185 /* Here we catch errors in execution of commands within the
1186 editing loop, and reenter the editing loop.
1187 When there is an error, cmd_error runs and returns a non-nil
1188 value to us. A value of nil means that command_loop_1 itself
1189 returned due to end of file (or end of kbd macro). */
1192 command_loop_2 (Lisp_Object ignore
)
1194 register Lisp_Object val
;
1197 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1198 while (!NILP (val
));
1206 return Feval (Vtop_level
, Qnil
);
1210 top_level_1 (Lisp_Object ignore
)
1212 /* On entry to the outer level, run the startup file. */
1213 if (!NILP (Vtop_level
))
1214 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1215 else if (!NILP (Vpurify_flag
))
1216 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1218 message1 ("Bare Emacs (standard Lisp code not loaded)");
1222 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1223 doc
: /* Exit all recursive editing levels.
1224 This also exits all active minibuffers. */)
1227 #ifdef HAVE_WINDOW_SYSTEM
1228 if (display_hourglass_p
)
1229 cancel_hourglass ();
1232 /* Unblock input if we enter with input blocked. This may happen if
1233 redisplay traps e.g. during tool-bar update with input blocked. */
1234 totally_unblock_input ();
1236 Fthrow (Qtop_level
, Qnil
);
1239 static _Noreturn
void
1240 user_error (const char *msg
)
1242 xsignal1 (Quser_error
, build_string (msg
));
1245 /* _Noreturn will be added to prototype by make-docfile. */
1246 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1247 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1250 if (command_loop_level
> 0 || minibuf_level
> 0)
1251 Fthrow (Qexit
, Qnil
);
1253 user_error ("No recursive edit is in progress");
1256 /* _Noreturn will be added to prototype by make-docfile. */
1257 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1258 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1261 if (command_loop_level
> 0 || minibuf_level
> 0)
1264 user_error ("No recursive edit is in progress");
1267 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1268 of this function. */
1271 tracking_off (Lisp_Object old_value
)
1273 do_mouse_tracking
= old_value
;
1274 if (NILP (old_value
))
1276 /* Redisplay may have been preempted because there was input
1277 available, and it assumes it will be called again after the
1278 input has been processed. If the only input available was
1279 the sort that we have just disabled, then we need to call
1281 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1283 redisplay_preserve_echo_area (6);
1284 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1289 DEFUN ("internal--track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1290 doc
: /* Call BODYFUN with mouse movement events enabled. */)
1291 (Lisp_Object bodyfun
)
1293 ptrdiff_t count
= SPECPDL_INDEX ();
1296 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1298 do_mouse_tracking
= Qt
;
1300 val
= call0 (bodyfun
);
1301 return unbind_to (count
, val
);
1304 /* If mouse has moved on some frame, return one of those frames.
1308 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1309 after resizing the tool-bar window. */
1311 bool ignore_mouse_drag_p
;
1313 static struct frame
*
1314 some_mouse_moved (void)
1316 Lisp_Object tail
, frame
;
1318 if (ignore_mouse_drag_p
)
1320 /* ignore_mouse_drag_p = 0; */
1324 FOR_EACH_FRAME (tail
, frame
)
1326 if (XFRAME (frame
)->mouse_moved
)
1327 return XFRAME (frame
);
1334 /* This is the actual command reading loop,
1335 sans error-handling encapsulation. */
1337 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1338 bool, bool, bool, bool);
1339 static void adjust_point_for_property (ptrdiff_t, bool);
1341 /* The last boundary auto-added to buffer-undo-list. */
1342 Lisp_Object last_undo_boundary
;
1344 /* FIXME: This is wrong rather than test window-system, we should call
1345 a new set-selection, which will then dispatch to x-set-selection, or
1346 tty-set-selection, or w32-set-selection, ... */
1349 command_loop_1 (void)
1352 Lisp_Object keybuf
[30];
1354 EMACS_INT prev_modiff
= 0;
1355 struct buffer
*prev_buffer
= NULL
;
1356 bool already_adjusted
= 0;
1358 kset_prefix_arg (current_kboard
, Qnil
);
1359 kset_last_prefix_arg (current_kboard
, Qnil
);
1360 Vdeactivate_mark
= Qnil
;
1361 waiting_for_input
= 0;
1364 this_command_key_count
= 0;
1365 this_command_key_count_reset
= 0;
1366 this_single_command_key_start
= 0;
1368 if (NILP (Vmemory_full
))
1370 /* Make sure this hook runs after commands that get errors and
1371 throw to top level. */
1372 /* Note that the value cell will never directly contain nil
1373 if the symbol is a local variable. */
1374 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1375 safe_run_hooks (Qpost_command_hook
);
1377 /* If displaying a message, resize the echo area window to fit
1378 that message's size exactly. */
1379 if (!NILP (echo_area_buffer
[0]))
1380 resize_echo_area_exactly ();
1382 /* If there are warnings waiting, process them. */
1383 if (!NILP (Vdelayed_warnings_list
))
1384 safe_run_hooks (Qdelayed_warnings_hook
);
1386 if (!NILP (Vdeferred_action_list
))
1387 safe_run_hooks (Qdeferred_action_function
);
1390 /* Do this after running Vpost_command_hook, for consistency. */
1391 kset_last_command (current_kboard
, Vthis_command
);
1392 kset_real_last_command (current_kboard
, Vreal_this_command
);
1393 if (!CONSP (last_command_event
))
1394 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1398 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1401 /* Make sure the current window's buffer is selected. */
1402 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1404 /* Display any malloc warning that just came out. Use while because
1405 displaying one warning can cause another. */
1407 while (pending_malloc_warning
)
1408 display_malloc_warning ();
1410 Vdeactivate_mark
= Qnil
;
1412 /* Don't ignore mouse movements for more than a single command
1413 loop. (This flag is set in xdisp.c whenever the tool bar is
1414 resized, because the resize moves text up or down, and would
1415 generate false mouse drag events if we don't ignore them.) */
1416 ignore_mouse_drag_p
= 0;
1418 /* If minibuffer on and echo area in use,
1419 wait a short time and redraw minibuffer. */
1422 && !NILP (echo_area_buffer
[0])
1423 && EQ (minibuf_window
, echo_area_window
)
1424 && NUMBERP (Vminibuffer_message_timeout
))
1426 /* Bind inhibit-quit to t so that C-g gets read in
1427 rather than quitting back to the minibuffer. */
1428 ptrdiff_t count
= SPECPDL_INDEX ();
1429 specbind (Qinhibit_quit
, Qt
);
1431 sit_for (Vminibuffer_message_timeout
, 0, 2);
1433 /* Clear the echo area. */
1435 safe_run_hooks (Qecho_area_clear_hook
);
1437 unbind_to (count
, Qnil
);
1439 /* If a C-g came in before, treat it as input now. */
1440 if (!NILP (Vquit_flag
))
1443 Vunread_command_events
= list1 (make_number (quit_char
));
1447 /* If it has changed current-menubar from previous value,
1448 really recompute the menubar from the value. */
1449 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1450 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1451 call0 (Qrecompute_lucid_menubar
);
1453 before_command_key_count
= this_command_key_count
;
1454 before_command_echo_length
= echo_length ();
1456 Vthis_command
= Qnil
;
1457 Vreal_this_command
= Qnil
;
1458 Vthis_original_command
= Qnil
;
1459 Vthis_command_keys_shift_translated
= Qnil
;
1461 /* Read next key sequence; i gets its length. */
1462 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1465 /* A filter may have run while we were reading the input. */
1466 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1468 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1472 /* Now we have read a key sequence of length I,
1473 or else I is 0 and we found end of file. */
1475 if (i
== 0) /* End of file -- happens only in */
1476 return Qnil
; /* a kbd macro, at the end. */
1477 /* -1 means read_key_sequence got a menu that was rejected.
1478 Just loop around and read another command. */
1482 this_command_key_count
= 0;
1483 this_command_key_count_reset
= 0;
1484 this_single_command_key_start
= 0;
1488 last_command_event
= keybuf
[i
- 1];
1490 /* If the previous command tried to force a specific window-start,
1491 forget about that, in case this command moves point far away
1492 from that position. But also throw away beg_unchanged and
1493 end_unchanged information in that case, so that redisplay will
1494 update the whole window properly. */
1495 if (XWINDOW (selected_window
)->force_start
)
1498 XWINDOW (selected_window
)->force_start
= 0;
1499 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1500 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1503 cmd
= read_key_sequence_cmd
;
1504 if (!NILP (Vexecuting_kbd_macro
))
1506 if (!NILP (Vquit_flag
))
1508 Vexecuting_kbd_macro
= Qt
;
1509 QUIT
; /* Make some noise. */
1510 /* Will return since macro now empty. */
1514 /* Do redisplay processing after this command except in special
1515 cases identified below. */
1516 prev_buffer
= current_buffer
;
1517 prev_modiff
= MODIFF
;
1518 last_point_position
= PT
;
1520 /* By default, we adjust point to a boundary of a region that
1521 has such a property that should be treated intangible
1522 (e.g. composition, display). But, some commands will set
1523 this variable differently. */
1524 Vdisable_point_adjustment
= Qnil
;
1526 /* Process filters and timers may have messed with deactivate-mark.
1527 reset it before we execute the command. */
1528 Vdeactivate_mark
= Qnil
;
1530 /* Remap command through active keymaps. */
1531 Vthis_original_command
= cmd
;
1532 if (!NILP (read_key_sequence_remapped
))
1533 cmd
= read_key_sequence_remapped
;
1535 /* Execute the command. */
1537 Vthis_command
= cmd
;
1538 Vreal_this_command
= cmd
;
1539 safe_run_hooks (Qpre_command_hook
);
1541 already_adjusted
= 0;
1543 if (NILP (Vthis_command
))
1544 /* nil means key is undefined. */
1548 /* Here for a command that isn't executed directly. */
1550 #ifdef HAVE_WINDOW_SYSTEM
1551 ptrdiff_t scount
= SPECPDL_INDEX ();
1553 if (display_hourglass_p
1554 && NILP (Vexecuting_kbd_macro
))
1556 record_unwind_protect_void (cancel_hourglass
);
1561 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1563 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1566 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1567 ? Qnil
: BVAR (current_buffer
, undo_list
));
1569 call1 (Qcommand_execute
, Vthis_command
);
1571 #ifdef HAVE_WINDOW_SYSTEM
1572 /* Do not check display_hourglass_p here, because
1573 `command-execute' could change it, but we should cancel
1574 hourglass cursor anyway.
1575 But don't cancel the hourglass within a macro
1576 just because a command in the macro finishes. */
1577 if (NILP (Vexecuting_kbd_macro
))
1578 unbind_to (scount
, Qnil
);
1581 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1583 safe_run_hooks (Qpost_command_hook
);
1585 /* If displaying a message, resize the echo area window to fit
1586 that message's size exactly. */
1587 if (!NILP (echo_area_buffer
[0]))
1588 resize_echo_area_exactly ();
1590 /* If there are warnings waiting, process them. */
1591 if (!NILP (Vdelayed_warnings_list
))
1592 safe_run_hooks (Qdelayed_warnings_hook
);
1594 safe_run_hooks (Qdeferred_action_function
);
1596 /* If there is a prefix argument,
1597 1) We don't want Vlast_command to be ``universal-argument''
1598 (that would be dumb), so don't set Vlast_command,
1599 2) we want to leave echoing on so that the prefix will be
1600 echoed as part of this key sequence, so don't call
1602 3) we want to leave this_command_key_count non-zero, so that
1603 read_char will realize that it is re-reading a character, and
1604 not echo it a second time.
1606 If the command didn't actually create a prefix arg,
1607 but is merely a frame event that is transparent to prefix args,
1608 then the above doesn't apply. */
1609 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1610 || CONSP (last_command_event
))
1612 kset_last_command (current_kboard
, Vthis_command
);
1613 kset_real_last_command (current_kboard
, Vreal_this_command
);
1614 if (!CONSP (last_command_event
))
1615 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1617 this_command_key_count
= 0;
1618 this_command_key_count_reset
= 0;
1619 this_single_command_key_start
= 0;
1622 if (!NILP (BVAR (current_buffer
, mark_active
))
1623 && !NILP (Vrun_hooks
))
1625 /* In Emacs 22, setting transient-mark-mode to `only' was a
1626 way of turning it on for just one command. This usage is
1627 obsolete, but support it anyway. */
1628 if (EQ (Vtransient_mark_mode
, Qidentity
))
1629 Vtransient_mark_mode
= Qnil
;
1630 else if (EQ (Vtransient_mark_mode
, Qonly
))
1631 Vtransient_mark_mode
= Qidentity
;
1633 if (!NILP (Vdeactivate_mark
))
1634 /* If `select-active-regions' is non-nil, this call to
1635 `deactivate-mark' also sets the PRIMARY selection. */
1636 call0 (Qdeactivate_mark
);
1639 /* Even if not deactivating the mark, set PRIMARY if
1640 `select-active-regions' is non-nil. */
1641 if (!NILP (Fwindow_system (Qnil
))
1642 /* Even if mark_active is non-nil, the actual buffer
1643 marker may not have been set yet (Bug#7044). */
1644 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1645 && (EQ (Vselect_active_regions
, Qonly
)
1646 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1647 : (!NILP (Vselect_active_regions
)
1648 && !NILP (Vtransient_mark_mode
)))
1649 && NILP (Fmemq (Vthis_command
,
1650 Vselection_inhibit_update_commands
)))
1653 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1654 if (XINT (Flength (txt
)) > 0)
1655 /* Don't set empty selections. */
1656 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1659 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1661 Lisp_Object hook
= intern ("activate-mark-hook");
1662 Frun_hooks (1, &hook
);
1666 Vsaved_region_selection
= Qnil
;
1671 if (current_buffer
== prev_buffer
1672 && last_point_position
!= PT
1673 && NILP (Vdisable_point_adjustment
)
1674 && NILP (Vglobal_disable_point_adjustment
))
1676 if (last_point_position
> BEGV
1677 && last_point_position
< ZV
1678 && (composition_adjust_point (last_point_position
,
1679 last_point_position
)
1680 != last_point_position
))
1681 /* The last point was temporarily set within a grapheme
1682 cluster to prevent automatic composition. To recover
1683 the automatic composition, we must update the
1685 windows_or_buffers_changed
= 21;
1686 if (!already_adjusted
)
1687 adjust_point_for_property (last_point_position
,
1688 MODIFF
!= prev_modiff
);
1691 /* Install chars successfully executed in kbd macro. */
1693 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1694 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1695 finalize_kbd_macro_chars ();
1700 read_menu_command (void)
1702 Lisp_Object keybuf
[30];
1703 ptrdiff_t count
= SPECPDL_INDEX ();
1706 /* We don't want to echo the keystrokes while navigating the
1708 specbind (Qecho_keystrokes
, make_number (0));
1710 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1713 unbind_to (count
, Qnil
);
1715 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1717 if (i
== 0 || i
== -1)
1720 return read_key_sequence_cmd
;
1723 /* Adjust point to a boundary of a region that has such a property
1724 that should be treated intangible. For the moment, we check
1725 `composition', `display' and `invisible' properties.
1726 LAST_PT is the last position of point. */
1729 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1732 Lisp_Object val
, overlay
, tmp
;
1733 /* When called after buffer modification, we should temporarily
1734 suppress the point adjustment for automatic composition so that a
1735 user can keep inserting another character at point or keep
1736 deleting characters around point. */
1737 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1738 ptrdiff_t orig_pt
= PT
;
1740 /* FIXME: cycling is probably not necessary because these properties
1741 can't be usefully combined anyway. */
1742 while (check_composition
|| check_display
|| check_invisible
)
1744 /* FIXME: check `intangible'. */
1745 if (check_composition
1746 && PT
> BEGV
&& PT
< ZV
1747 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1750 check_display
= check_invisible
= 1;
1752 check_composition
= 0;
1754 && PT
> BEGV
&& PT
< ZV
1755 && !NILP (val
= get_char_property_and_overlay
1756 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1757 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1758 && (!OVERLAYP (overlay
)
1759 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1760 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1761 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1762 && (beg
< PT
/* && end > PT <- It's always the case. */
1763 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1766 SET_PT (PT
< last_pt
1767 ? (STRINGP (val
) && SCHARS (val
) == 0
1768 ? max (beg
- 1, BEGV
)
1771 check_composition
= check_invisible
= 1;
1774 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1780 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1783 /* FIXME: We should stop if we find a spot between
1784 two runs of `invisible' where inserted text would
1785 be visible. This is important when we have two
1786 invisible boundaries that enclose an area: if the
1787 area is empty, we need this test in order to make
1788 it possible to place point in the middle rather
1789 than skip both boundaries. However, this code
1790 also stops anywhere in a non-sticky text-property,
1791 which breaks (e.g.) Org mode. */
1792 && (val
= Fget_pos_property (make_number (end
),
1794 TEXT_PROP_MEANS_INVISIBLE (val
))
1796 && !NILP (val
= get_char_property_and_overlay
1797 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1798 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1800 ellipsis
= ellipsis
|| inv
> 1
1801 || (OVERLAYP (overlay
)
1802 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1803 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1804 tmp
= Fnext_single_char_property_change
1805 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1806 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1810 && (val
= Fget_pos_property (make_number (beg
),
1812 TEXT_PROP_MEANS_INVISIBLE (val
))
1814 && !NILP (val
= get_char_property_and_overlay
1815 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1816 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1818 ellipsis
= ellipsis
|| inv
> 1
1819 || (OVERLAYP (overlay
)
1820 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1821 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1822 tmp
= Fprevious_single_char_property_change
1823 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1824 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1827 /* Move away from the inside area. */
1828 if (beg
< PT
&& end
> PT
)
1830 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1831 /* We haven't moved yet (so we don't need to fear
1832 infinite-looping) and we were outside the range
1833 before (so either end of the range still corresponds
1834 to a move in the right direction): pretend we moved
1835 less than we actually did, so that we still have
1836 more freedom below in choosing which end of the range
1838 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1839 /* We either have moved already or the last point
1840 was already in the range: we don't get to choose
1841 which end of the range we have to go to. */
1842 : (PT
< last_pt
? beg
: end
));
1843 check_composition
= check_display
= 1;
1845 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1846 the point to something other than its argument, due to
1847 point-motion hooks, intangibility, etc. */
1848 eassert (PT
== beg
|| PT
== end
);
1851 /* Pretend the area doesn't exist if the buffer is not
1853 if (!modified
&& !ellipsis
&& beg
< end
)
1855 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1856 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1857 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1858 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1859 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1860 /* We've already moved as far as we can. Trying to go
1861 to the other end would mean moving backwards and thus
1862 could lead to an infinite loop. */
1864 else if (val
= Fget_pos_property (make_number (PT
),
1866 TEXT_PROP_MEANS_INVISIBLE (val
)
1867 && (val
= (Fget_pos_property
1868 (make_number (PT
== beg
? end
: beg
),
1870 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1871 (check_composition
= check_display
= 1,
1872 SET_PT (PT
== beg
? end
: beg
));
1875 check_invisible
= 0;
1879 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1882 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1884 eassert (nargs
== 2);
1885 return call0 (args
[1]);
1888 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1892 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1894 eassert (nargs
== 2);
1895 AUTO_STRING (format
, "Error in %s (%S): %S");
1896 Lisp_Object hook
= args
[0];
1897 Lisp_Object fun
= args
[1];
1898 Fmessage (4, (Lisp_Object
[]) {format
, hook
, fun
, error
});
1904 Lisp_Object newval
= Qnil
;
1905 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1906 if (EQ (fun
, XCAR (val
)))
1909 newval
= Fcons (XCAR (val
), newval
);
1911 return Fset (hook
, Fnreverse (newval
));
1912 /* Not found in the local part of the hook. Let's look at the global
1915 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1916 : Fdefault_value (hook
));
1917 CONSP (val
); val
= XCDR (val
))
1918 if (EQ (fun
, XCAR (val
)))
1921 newval
= Fcons (XCAR (val
), newval
);
1923 return Fset_default (hook
, Fnreverse (newval
));
1929 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1931 Lisp_Object iargs
[2];
1933 eassert (nargs
== 2);
1934 /* Yes, run_hook_with_args works this way. */
1937 internal_condition_case_n (safe_run_hooks_1
, 2, iargs
,
1938 Qt
, safe_run_hooks_error
);
1942 /* If we get an error while running the hook, cause the hook variable
1943 to be nil. Also inhibit quits, so that C-g won't cause the hook
1944 to mysteriously evaporate. */
1947 safe_run_hooks (Lisp_Object hook
)
1949 Lisp_Object args
[2];
1950 struct gcpro gcpro1
;
1951 ptrdiff_t count
= SPECPDL_INDEX ();
1957 specbind (Qinhibit_quit
, Qt
);
1958 run_hook_with_args (2, args
, safe_run_hook_funcall
);
1959 unbind_to (count
, Qnil
);
1964 /* Nonzero means polling for input is temporarily suppressed. */
1966 int poll_suppress_count
;
1969 #ifdef POLL_FOR_INPUT
1971 /* Asynchronous timer for polling. */
1973 static struct atimer
*poll_timer
;
1975 /* Poll for input, so that we catch a C-g if it comes in. */
1977 poll_for_input_1 (void)
1979 if (! input_blocked_p ()
1980 && !waiting_for_input
)
1984 /* Timer callback function for poll_timer. TIMER is equal to
1988 poll_for_input (struct atimer
*timer
)
1990 if (poll_suppress_count
== 0)
1991 pending_signals
= 1;
1994 #endif /* POLL_FOR_INPUT */
1996 /* Begin signals to poll for input, if they are appropriate.
1997 This function is called unconditionally from various places. */
2000 start_polling (void)
2002 #ifdef POLL_FOR_INPUT
2003 /* XXX This condition was (read_socket_hook && !interrupt_input),
2004 but read_socket_hook is not global anymore. Let's pretend that
2006 if (!interrupt_input
)
2008 /* Turn alarm handling on unconditionally. It might have
2009 been turned off in process.c. */
2010 turn_on_atimers (1);
2012 /* If poll timer doesn't exist, or we need one with
2013 a different interval, start a new one. */
2014 if (poll_timer
== NULL
2015 || poll_timer
->interval
.tv_sec
!= polling_period
)
2017 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2018 struct timespec interval
= make_timespec (period
, 0);
2021 cancel_atimer (poll_timer
);
2023 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2024 poll_for_input
, NULL
);
2027 /* Let the timer's callback function poll for input
2028 if this becomes zero. */
2029 --poll_suppress_count
;
2034 /* True if we are using polling to handle input asynchronously. */
2037 input_polling_used (void)
2039 #ifdef POLL_FOR_INPUT
2040 /* XXX This condition was (read_socket_hook && !interrupt_input),
2041 but read_socket_hook is not global anymore. Let's pretend that
2043 return !interrupt_input
;
2049 /* Turn off polling. */
2054 #ifdef POLL_FOR_INPUT
2055 /* XXX This condition was (read_socket_hook && !interrupt_input),
2056 but read_socket_hook is not global anymore. Let's pretend that
2058 if (!interrupt_input
)
2059 ++poll_suppress_count
;
2063 /* Set the value of poll_suppress_count to COUNT
2064 and start or stop polling accordingly. */
2067 set_poll_suppress_count (int count
)
2069 #ifdef POLL_FOR_INPUT
2070 if (count
== 0 && poll_suppress_count
!= 0)
2072 poll_suppress_count
= 1;
2075 else if (count
!= 0 && poll_suppress_count
== 0)
2079 poll_suppress_count
= count
;
2083 /* Bind polling_period to a value at least N.
2084 But don't decrease it. */
2087 bind_polling_period (int n
)
2089 #ifdef POLL_FOR_INPUT
2090 EMACS_INT
new = polling_period
;
2095 stop_other_atimers (poll_timer
);
2097 specbind (Qpolling_period
, make_number (new));
2098 /* Start a new alarm with the new period. */
2103 /* Apply the control modifier to CHARACTER. */
2106 make_ctrl_char (int c
)
2108 /* Save the upper bits here. */
2109 int upper
= c
& ~0177;
2111 if (! ASCII_CHAR_P (c
))
2112 return c
|= ctrl_modifier
;
2116 /* Everything in the columns containing the upper-case letters
2117 denotes a control character. */
2118 if (c
>= 0100 && c
< 0140)
2122 /* Set the shift modifier for a control char
2123 made from a shifted letter. But only for letters! */
2124 if (oc
>= 'A' && oc
<= 'Z')
2125 c
|= shift_modifier
;
2128 /* The lower-case letters denote control characters too. */
2129 else if (c
>= 'a' && c
<= 'z')
2132 /* Include the bits for control and shift
2133 only if the basic ASCII code can't indicate them. */
2137 /* Replace the high bits. */
2138 c
|= (upper
& ~ctrl_modifier
);
2143 /* Display the help-echo property of the character after the mouse pointer.
2144 Either show it in the echo area, or call show-help-function to display
2145 it by other means (maybe in a tooltip).
2147 If HELP is nil, that means clear the previous help echo.
2149 If HELP is a string, display that string. If HELP is a function,
2150 call it with OBJECT and POS as arguments; the function should
2151 return a help string or nil for none. For all other types of HELP,
2152 evaluate it to obtain a string.
2154 WINDOW is the window in which the help was generated, if any.
2155 It is nil if not in a window.
2157 If OBJECT is a buffer, POS is the position in the buffer where the
2158 `help-echo' text property was found.
2160 If OBJECT is an overlay, that overlay has a `help-echo' property,
2161 and POS is the position in the overlay's buffer under the mouse.
2163 If OBJECT is a string (an overlay string or a string displayed with
2164 the `display' property). POS is the position in that string under
2167 Note: this function may only be called with HELP nil or a string
2168 from X code running asynchronously. */
2171 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2174 if (!NILP (help
) && !STRINGP (help
))
2176 if (FUNCTIONP (help
))
2177 help
= safe_call (4, help
, window
, object
, pos
);
2179 help
= safe_eval (help
);
2181 if (!STRINGP (help
))
2185 if (!noninteractive
&& STRINGP (help
))
2187 /* The mouse-fixup-help-message Lisp function can call
2188 mouse_position_hook, which resets the mouse_moved flags.
2189 This causes trouble if we are trying to read a mouse motion
2190 event (i.e., if we are inside a `track-mouse' form), so we
2191 restore the mouse_moved flag. */
2192 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2193 help
= call1 (Qmouse_fixup_help_message
, help
);
2198 if (STRINGP (help
) || NILP (help
))
2200 if (!NILP (Vshow_help_function
))
2201 call1 (Vshow_help_function
, help
);
2202 help_echo_showing_p
= STRINGP (help
);
2208 /* Input of single characters from keyboard. */
2210 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2211 struct timespec
*end_time
);
2212 static void record_char (Lisp_Object c
);
2214 static Lisp_Object help_form_saved_window_configs
;
2216 read_char_help_form_unwind (void)
2218 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2219 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2220 if (!NILP (window_config
))
2221 Fset_window_configuration (window_config
);
2224 #define STOP_POLLING \
2225 do { if (! polling_stopped_here) stop_polling (); \
2226 polling_stopped_here = 1; } while (0)
2228 #define RESUME_POLLING \
2229 do { if (polling_stopped_here) start_polling (); \
2230 polling_stopped_here = 0; } while (0)
2233 read_event_from_main_queue (struct timespec
*end_time
,
2234 sys_jmp_buf local_getcjmp
,
2235 bool *used_mouse_menu
)
2237 Lisp_Object c
= Qnil
;
2238 sys_jmp_buf save_jump
;
2239 KBOARD
*kb
IF_LINT (= NULL
);
2243 /* Read from the main queue, and if that gives us something we can't use yet,
2244 we put it on the appropriate side queue and try again. */
2246 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2249 /* Actually read a character, waiting if necessary. */
2250 save_getcjmp (save_jump
);
2251 restore_getcjmp (local_getcjmp
);
2253 timer_start_idle ();
2254 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2255 restore_getcjmp (save_jump
);
2257 if (! NILP (c
) && (kb
!= current_kboard
))
2259 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2262 while (CONSP (XCDR (last
)))
2264 if (!NILP (XCDR (last
)))
2268 kset_kbd_queue (kb
, list1 (c
));
2270 XSETCDR (last
, list1 (c
));
2271 kb
->kbd_queue_has_data
= 1;
2275 current_kboard
= kb
;
2276 /* This is going to exit from read_char
2277 so we had better get rid of this frame's stuff. */
2278 return make_number (-2);
2281 /* Terminate Emacs in batch mode if at eof. */
2282 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2283 Fkill_emacs (make_number (1));
2287 /* Add in any extra modifiers, where appropriate. */
2288 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2289 || ((extra_keyboard_modifiers
& 0177) < ' '
2290 && (extra_keyboard_modifiers
& 0177) != 0))
2291 XSETINT (c
, make_ctrl_char (XINT (c
)));
2293 /* Transfer any other modifier bits directly from
2294 extra_keyboard_modifiers to c. Ignore the actual character code
2295 in the low 16 bits of extra_keyboard_modifiers. */
2296 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2304 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2307 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2308 sys_jmp_buf local_getcjmp
,
2309 Lisp_Object prev_event
,
2310 bool *used_mouse_menu
)
2312 #define MAX_ENCODED_BYTES 16
2314 Lisp_Object events
[MAX_ENCODED_BYTES
];
2320 = read_event_from_main_queue (end_time
, local_getcjmp
,
2323 /* w32_console already returns decoded events. It either reads
2324 Unicode characters from the Windows keyboard input, or
2325 converts characters encoded in the current codepage into
2326 Unicode. See w32inevt.c:key_event, near its end. */
2329 struct frame
*frame
= XFRAME (selected_frame
);
2330 struct terminal
*terminal
= frame
->terminal
;
2331 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2332 /* Don't apply decoding if we're just reading a raw event
2333 (e.g. reading bytes sent by the xterm to specify the position
2334 of a mouse click). */
2335 && (!EQ (prev_event
, Qt
))
2336 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2337 & CODING_REQUIRE_DECODING_MASK
)))
2338 return nextevt
; /* No decoding needed. */
2341 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2342 eassert (n
< MAX_ENCODED_BYTES
);
2343 events
[n
++] = nextevt
;
2344 if (NATNUMP (nextevt
)
2345 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2346 { /* An encoded byte sequence, let's try to decode it. */
2347 struct coding_system
*coding
2348 = TERMINAL_KEYBOARD_CODING (terminal
);
2349 unsigned char src
[MAX_ENCODED_BYTES
];
2350 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2352 for (i
= 0; i
< n
; i
++)
2353 src
[i
] = XINT (events
[i
]);
2355 for (i
= 0; i
< n
; i
++)
2357 coding
->destination
= dest
;
2358 coding
->dst_bytes
= sizeof dest
;
2359 decode_coding_c_string (coding
, src
, n
, Qnil
);
2360 eassert (coding
->produced_char
<= n
);
2361 if (coding
->produced_char
== 0)
2362 { /* The encoded sequence is incomplete. */
2363 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2364 continue; /* Read on! */
2368 const unsigned char *p
= coding
->destination
;
2369 eassert (coding
->carryover_bytes
== 0);
2371 while (n
< coding
->produced_char
)
2372 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2375 /* Now `events' should hold decoded events.
2376 Normally, n should be equal to 1, but better not rely on it.
2377 We can only return one event here, so return the first we
2378 had and keep the others (if any) for later. */
2380 Vunread_command_events
2381 = Fcons (events
[--n
], Vunread_command_events
);
2389 echo_keystrokes_p (void)
2391 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2392 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2395 /* Read a character from the keyboard; call the redisplay if needed. */
2396 /* commandflag 0 means do not autosave, but do redisplay.
2397 -1 means do not redisplay, but do autosave.
2398 -2 means do neither.
2401 /* The argument MAP is a keymap for menu prompting.
2403 PREV_EVENT is the previous input event, or nil if we are reading
2404 the first event of a key sequence (or not reading a key sequence).
2405 If PREV_EVENT is t, that is a "magic" value that says
2406 not to run input methods, but in other respects to act as if
2407 not reading a key sequence.
2409 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2410 if we used a mouse menu to read the input, or false otherwise. If
2411 USED_MOUSE_MENU is null, don't dereference it.
2413 Value is -2 when we find input on another keyboard. A second call
2414 to read_char will read it.
2416 If END_TIME is non-null, it is a pointer to a struct timespec
2417 specifying the maximum time to wait until. If no input arrives by
2418 that time, stop waiting and return nil.
2420 Value is t if we showed a menu and the user rejected it. */
2423 read_char (int commandflag
, Lisp_Object map
,
2424 Lisp_Object prev_event
,
2425 bool *used_mouse_menu
, struct timespec
*end_time
)
2429 sys_jmp_buf local_getcjmp
;
2430 sys_jmp_buf save_jump
;
2431 Lisp_Object tem
, save
;
2432 volatile Lisp_Object previous_echo_area_message
;
2433 volatile Lisp_Object also_record
;
2434 volatile bool reread
;
2435 struct gcpro gcpro1
, gcpro2
;
2436 bool volatile polling_stopped_here
= 0;
2437 struct kboard
*orig_kboard
= current_kboard
;
2441 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2442 before_command_key_count
= this_command_key_count
;
2443 before_command_echo_length
= echo_length ();
2446 previous_echo_area_message
= Qnil
;
2448 GCPRO2 (c
, previous_echo_area_message
);
2452 if (CONSP (Vunread_post_input_method_events
))
2454 c
= XCAR (Vunread_post_input_method_events
);
2455 Vunread_post_input_method_events
2456 = XCDR (Vunread_post_input_method_events
);
2458 /* Undo what read_char_x_menu_prompt did when it unread
2459 additional keys returned by Fx_popup_menu. */
2461 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2472 if (CONSP (Vunread_command_events
))
2474 bool was_disabled
= 0;
2476 c
= XCAR (Vunread_command_events
);
2477 Vunread_command_events
= XCDR (Vunread_command_events
);
2479 /* Undo what sit-for did when it unread additional keys
2480 inside universal-argument. */
2482 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2487 /* Undo what read_char_x_menu_prompt did when it unread
2488 additional keys returned by Fx_popup_menu. */
2490 && EQ (XCDR (c
), Qdisabled
)
2491 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2497 /* If the queued event is something that used the mouse,
2498 set used_mouse_menu accordingly. */
2500 /* Also check was_disabled so last-nonmenu-event won't return
2501 a bad value when submenus are involved. (Bug#447) */
2502 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2503 *used_mouse_menu
= 1;
2505 goto reread_for_input_method
;
2508 if (CONSP (Vunread_input_method_events
))
2510 c
= XCAR (Vunread_input_method_events
);
2511 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2513 /* Undo what read_char_x_menu_prompt did when it unread
2514 additional keys returned by Fx_popup_menu. */
2516 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2520 goto reread_for_input_method
;
2523 this_command_key_count_reset
= 0;
2525 if (!NILP (Vexecuting_kbd_macro
))
2527 /* We set this to Qmacro; since that's not a frame, nobody will
2528 try to switch frames on us, and the selected window will
2531 Since this event came from a macro, it would be misleading to
2532 leave internal_last_event_frame set to wherever the last
2533 real event came from. Normally, a switch-frame event selects
2534 internal_last_event_frame after each command is read, but
2535 events read from a macro should never cause a new frame to be
2537 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2539 /* Exit the macro if we are at the end.
2540 Also, some things replace the macro with t
2541 to force an early exit. */
2542 if (EQ (Vexecuting_kbd_macro
, Qt
)
2543 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2549 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2550 if (STRINGP (Vexecuting_kbd_macro
)
2551 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2552 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2554 executing_kbd_macro_index
++;
2559 if (!NILP (unread_switch_frame
))
2561 c
= unread_switch_frame
;
2562 unread_switch_frame
= Qnil
;
2564 /* This event should make it into this_command_keys, and get echoed
2565 again, so we do not set `reread'. */
2569 /* If redisplay was requested. */
2570 if (commandflag
>= 0)
2572 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2574 /* If there is pending input, process any events which are not
2575 user-visible, such as X selection_request events. */
2577 || detect_input_pending_run_timers (0))
2578 swallow_events (0); /* May clear input_pending. */
2580 /* Redisplay if no pending input. */
2581 while (!input_pending
)
2583 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2584 redisplay_preserve_echo_area (5);
2589 /* Normal case: no input arrived during redisplay. */
2592 /* Input arrived and pre-empted redisplay.
2593 Process any events which are not user-visible. */
2595 /* If that cleared input_pending, try again to redisplay. */
2598 /* Prevent the redisplay we just did
2599 from messing up echoing of the input after the prompt. */
2600 if (commandflag
== 0 && echo_current
)
2601 echo_message_buffer
= echo_area_buffer
[0];
2605 /* Message turns off echoing unless more keystrokes turn it on again.
2607 The code in 20.x for the condition was
2609 1. echo_area_glyphs && *echo_area_glyphs
2610 2. && echo_area_glyphs != current_kboard->echobuf
2611 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2613 (1) means there's a current message displayed
2615 (2) means it's not the message from echoing from the current
2618 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2619 is set to a non-null value. This is done in read_char and it is
2620 set to echo_area_glyphs after a call to echo_char. That means
2621 ok_to_echo_at_next_pause is either null or
2622 current_kboard->echobuf with the appropriate current_kboard at
2625 So, condition (3) means in clear text ok_to_echo_at_next_pause
2626 must be either null, or the current message isn't from echoing at
2627 all, or it's from echoing from a different kboard than the
2630 if (/* There currently is something in the echo area. */
2631 !NILP (echo_area_buffer
[0])
2632 && (/* It's an echo from a different kboard. */
2633 echo_kboard
!= current_kboard
2634 /* Or we explicitly allow overwriting whatever there is. */
2635 || ok_to_echo_at_next_pause
== NULL
))
2640 /* Try reading a character via menu prompting in the minibuf.
2641 Try this before the sit-for, because the sit-for
2642 would do the wrong thing if we are supposed to do
2643 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2644 after a mouse event so don't try a minibuf menu. */
2646 if (KEYMAPP (map
) && INTERACTIVE
2647 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2648 /* Don't bring up a menu if we already have another event. */
2649 && NILP (Vunread_command_events
)
2650 && !detect_input_pending_run_timers (0))
2652 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2654 if (INTEGERP (c
) && XINT (c
) == -2)
2655 return c
; /* wrong_kboard_jmpbuf */
2661 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2662 We will do that below, temporarily for short sections of code,
2663 when appropriate. local_getcjmp must be in effect
2664 around any call to sit_for or kbd_buffer_get_event;
2665 it *must not* be in effect when we call redisplay. */
2667 jmpcount
= SPECPDL_INDEX ();
2668 if (sys_setjmp (local_getcjmp
))
2670 /* Handle quits while reading the keyboard. */
2671 /* We must have saved the outer value of getcjmp here,
2672 so restore it now. */
2673 restore_getcjmp (save_jump
);
2674 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2675 unbind_to (jmpcount
, Qnil
);
2676 XSETINT (c
, quit_char
);
2677 internal_last_event_frame
= selected_frame
;
2678 Vlast_event_frame
= internal_last_event_frame
;
2679 /* If we report the quit char as an event,
2680 don't do so more than once. */
2681 if (!NILP (Vinhibit_quit
))
2685 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2686 if (kb
!= current_kboard
)
2688 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2689 /* We shouldn't get here if we were in single-kboard mode! */
2694 while (CONSP (XCDR (last
)))
2696 if (!NILP (XCDR (last
)))
2700 kset_kbd_queue (kb
, list1 (c
));
2702 XSETCDR (last
, list1 (c
));
2703 kb
->kbd_queue_has_data
= 1;
2704 current_kboard
= kb
;
2705 /* This is going to exit from read_char
2706 so we had better get rid of this frame's stuff. */
2708 return make_number (-2); /* wrong_kboard_jmpbuf */
2714 /* Start idle timers if no time limit is supplied. We don't do it
2715 if a time limit is supplied to avoid an infinite recursion in the
2716 situation where an idle timer calls `sit-for'. */
2719 timer_start_idle ();
2721 /* If in middle of key sequence and minibuffer not active,
2722 start echoing if enough time elapses. */
2724 if (minibuf_level
== 0
2726 && !current_kboard
->immediate_echo
2727 && this_command_key_count
> 0
2729 && echo_keystrokes_p ()
2730 && (/* No message. */
2731 NILP (echo_area_buffer
[0])
2732 /* Or empty message. */
2733 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2734 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2735 /* Or already echoing from same kboard. */
2736 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2737 /* Or not echoing before and echoing allowed. */
2738 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2740 /* After a mouse event, start echoing right away.
2741 This is because we are probably about to display a menu,
2742 and we don't want to delay before doing so. */
2743 if (EVENT_HAS_PARAMETERS (prev_event
))
2749 save_getcjmp (save_jump
);
2750 restore_getcjmp (local_getcjmp
);
2751 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2752 restore_getcjmp (save_jump
);
2754 && ! CONSP (Vunread_command_events
))
2759 /* Maybe auto save due to number of keystrokes. */
2761 if (commandflag
!= 0 && commandflag
!= -2
2762 && auto_save_interval
> 0
2763 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2764 && !detect_input_pending_run_timers (0))
2766 Fdo_auto_save (Qnil
, Qnil
);
2767 /* Hooks can actually change some buffers in auto save. */
2771 /* Try reading using an X menu.
2772 This is never confused with reading using the minibuf
2773 because the recursive call of read_char in read_char_minibuf_menu_prompt
2774 does not pass on any keymaps. */
2776 if (KEYMAPP (map
) && INTERACTIVE
2777 && !NILP (prev_event
)
2778 && EVENT_HAS_PARAMETERS (prev_event
)
2779 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2780 && !EQ (XCAR (prev_event
), Qtool_bar
)
2781 /* Don't bring up a menu if we already have another event. */
2782 && NILP (Vunread_command_events
))
2784 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2786 /* Now that we have read an event, Emacs is not idle. */
2793 /* Maybe autosave and/or garbage collect due to idleness. */
2795 if (INTERACTIVE
&& NILP (c
))
2798 ptrdiff_t buffer_size
;
2800 /* Slow down auto saves logarithmically in size of current buffer,
2801 and garbage collect while we're at it. */
2802 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2803 last_non_minibuf_size
= Z
- BEG
;
2804 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2806 while (buffer_size
> 64)
2807 delay_level
++, buffer_size
-= buffer_size
>> 2;
2808 if (delay_level
< 4) delay_level
= 4;
2809 /* delay_level is 4 for files under around 50k, 7 at 100k,
2810 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2812 /* Auto save if enough time goes by without input. */
2813 if (commandflag
!= 0 && commandflag
!= -2
2814 && num_nonmacro_input_events
> last_auto_save
2815 && INTEGERP (Vauto_save_timeout
)
2816 && XINT (Vauto_save_timeout
) > 0)
2819 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2821 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2822 timeout
= delay_level
* timeout
/ 4;
2823 save_getcjmp (save_jump
);
2824 restore_getcjmp (local_getcjmp
);
2825 tem0
= sit_for (make_number (timeout
), 1, 1);
2826 restore_getcjmp (save_jump
);
2829 && ! CONSP (Vunread_command_events
))
2831 Fdo_auto_save (Qnil
, Qnil
);
2836 /* If there is still no input available, ask for GC. */
2837 if (!detect_input_pending_run_timers (0))
2841 /* Notify the caller if an autosave hook, or a timer, sentinel or
2842 filter in the sit_for calls above have changed the current
2843 kboard. This could happen if they use the minibuffer or start a
2844 recursive edit, like the fancy splash screen in server.el's
2845 filter. If this longjmp wasn't here, read_key_sequence would
2846 interpret the next key sequence using the wrong translation
2847 tables and function keymaps. */
2848 if (NILP (c
) && current_kboard
!= orig_kboard
)
2851 return make_number (-2); /* wrong_kboard_jmpbuf */
2854 /* If this has become non-nil here, it has been set by a timer
2855 or sentinel or filter. */
2856 if (CONSP (Vunread_command_events
))
2858 c
= XCAR (Vunread_command_events
);
2859 Vunread_command_events
= XCDR (Vunread_command_events
);
2861 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2867 /* Read something from current KBOARD's side queue, if possible. */
2871 if (current_kboard
->kbd_queue_has_data
)
2873 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2875 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2876 kset_kbd_queue (current_kboard
,
2877 XCDR (KVAR (current_kboard
, kbd_queue
)));
2878 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2879 current_kboard
->kbd_queue_has_data
= 0;
2880 input_pending
= readable_events (0);
2881 if (EVENT_HAS_PARAMETERS (c
)
2882 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2883 internal_last_event_frame
= XCAR (XCDR (c
));
2884 Vlast_event_frame
= internal_last_event_frame
;
2888 /* If current_kboard's side queue is empty check the other kboards.
2889 If one of them has data that we have not yet seen here,
2890 switch to it and process the data waiting for it.
2892 Note: if the events queued up for another kboard
2893 have already been seen here, and therefore are not a complete command,
2894 the kbd_queue_has_data field is 0, so we skip that kboard here.
2895 That's to avoid an infinite loop switching between kboards here. */
2896 if (NILP (c
) && !single_kboard
)
2899 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2900 if (kb
->kbd_queue_has_data
)
2902 current_kboard
= kb
;
2903 /* This is going to exit from read_char
2904 so we had better get rid of this frame's stuff. */
2906 return make_number (-2); /* wrong_kboard_jmpbuf */
2916 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2917 prev_event
, used_mouse_menu
);
2918 if (NILP (c
) && end_time
2919 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2924 if (EQ (c
, make_number (-2)))
2926 /* This is going to exit from read_char
2927 so we had better get rid of this frame's stuff. */
2941 if (commandflag
>= 0
2942 && !input_pending
&& !detect_input_pending_run_timers (0))
2948 /* Buffer switch events are only for internal wakeups
2949 so don't show them to the user.
2950 Also, don't record a key if we already did. */
2954 /* Process special events within read_char
2955 and loop around to read another event. */
2958 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2963 struct buffer
*prev_buffer
= current_buffer
;
2964 last_input_event
= c
;
2965 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2967 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2968 /* We stopped being idle for this event; undo that. This
2969 prevents automatic window selection (under
2970 mouse_autoselect_window from acting as a real input event, for
2971 example banishing the mouse under mouse-avoidance-mode. */
2972 timer_resume_idle ();
2974 if (current_buffer
!= prev_buffer
)
2976 /* The command may have changed the keymaps. Pretend there
2977 is input in another keyboard and return. This will
2978 recalculate keymaps. */
2979 c
= make_number (-2);
2986 /* Handle things that only apply to characters. */
2989 /* If kbd_buffer_get_event gave us an EOF, return that. */
2993 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2994 && UNSIGNED_CMP (XFASTINT (c
), <,
2995 SCHARS (KVAR (current_kboard
,
2996 Vkeyboard_translate_table
))))
2997 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2998 && UNSIGNED_CMP (XFASTINT (c
), <,
2999 ASIZE (KVAR (current_kboard
,
3000 Vkeyboard_translate_table
))))
3001 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
3005 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
3006 /* nil in keyboard-translate-table means no translation. */
3012 /* If this event is a mouse click in the menu bar,
3013 return just menu-bar for now. Modify the mouse click event
3014 so we won't do this twice, then queue it up. */
3015 if (EVENT_HAS_PARAMETERS (c
)
3017 && CONSP (EVENT_START (c
))
3018 && CONSP (XCDR (EVENT_START (c
))))
3022 posn
= POSN_POSN (EVENT_START (c
));
3023 /* Handle menu-bar events:
3024 insert the dummy prefix event `menu-bar'. */
3025 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3027 /* Change menu-bar to (menu-bar) as the event "position". */
3028 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3031 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3036 /* Store these characters into recent_keys, the dribble file if any,
3037 and the keyboard macro being defined, if any. */
3039 if (! NILP (also_record
))
3040 record_char (also_record
);
3042 /* Wipe the echo area.
3043 But first, if we are about to use an input method,
3044 save the echo area contents for it to refer to. */
3046 && ! NILP (Vinput_method_function
)
3047 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3049 previous_echo_area_message
= Fcurrent_message ();
3050 Vinput_method_previous_message
= previous_echo_area_message
;
3053 /* Now wipe the echo area, except for help events which do their
3054 own stuff with the echo area. */
3056 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3057 && !(EQ (Qswitch_frame
, XCAR (c
)))
3058 /* Don't wipe echo area for select window events: These might
3059 get delayed via `mouse-autoselect-window' (Bug#11304). */
3060 && !(EQ (Qselect_window
, XCAR (c
)))))
3062 if (!NILP (echo_area_buffer
[0]))
3064 safe_run_hooks (Qecho_area_clear_hook
);
3065 clear_message (1, 0);
3069 reread_for_input_method
:
3071 /* Pass this to the input method, if appropriate. */
3073 && ! NILP (Vinput_method_function
)
3074 /* Don't run the input method within a key sequence,
3075 after the first event of the key sequence. */
3076 && NILP (prev_event
)
3077 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3080 ptrdiff_t key_count
;
3081 bool key_count_reset
;
3082 struct gcpro gcpro1
;
3083 ptrdiff_t count
= SPECPDL_INDEX ();
3085 /* Save the echo status. */
3086 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3087 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3088 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3089 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3092 if (before_command_restore_flag
)
3094 this_command_key_count
= before_command_key_count_1
;
3095 if (this_command_key_count
< this_single_command_key_start
)
3096 this_single_command_key_start
= this_command_key_count
;
3097 echo_truncate (before_command_echo_length_1
);
3098 before_command_restore_flag
= 0;
3102 /* Save the this_command_keys status. */
3103 key_count
= this_command_key_count
;
3104 key_count_reset
= this_command_key_count_reset
;
3107 keys
= Fcopy_sequence (this_command_keys
);
3112 /* Clear out this_command_keys. */
3113 this_command_key_count
= 0;
3114 this_command_key_count_reset
= 0;
3116 /* Now wipe the echo area. */
3117 if (!NILP (echo_area_buffer
[0]))
3118 safe_run_hooks (Qecho_area_clear_hook
);
3119 clear_message (1, 0);
3122 /* If we are not reading a key sequence,
3123 never use the echo area. */
3126 specbind (Qinput_method_use_echo_area
, Qt
);
3129 /* Call the input method. */
3130 tem
= call1 (Vinput_method_function
, c
);
3132 tem
= unbind_to (count
, tem
);
3134 /* Restore the saved echoing state
3135 and this_command_keys state. */
3136 this_command_key_count
= key_count
;
3137 this_command_key_count_reset
= key_count_reset
;
3139 this_command_keys
= keys
;
3142 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3143 kset_echo_string (current_kboard
, saved_echo_string
);
3144 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3145 if (saved_immediate_echo
)
3150 /* The input method can return no events. */
3153 /* Bring back the previous message, if any. */
3154 if (! NILP (previous_echo_area_message
))
3155 message_with_string ("%s", previous_echo_area_message
, 0);
3158 /* It returned one event or more. */
3160 Vunread_post_input_method_events
3161 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3166 /* Display help if not echoing. */
3167 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3169 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3170 Lisp_Object help
, object
, position
, window
, htem
;
3172 htem
= Fcdr (XCDR (c
));
3175 window
= Fcar (htem
);
3177 object
= Fcar (htem
);
3179 position
= Fcar (htem
);
3181 show_help_echo (help
, window
, object
, position
);
3183 /* We stopped being idle for this event; undo that. */
3185 timer_resume_idle ();
3189 if ((! reread
|| this_command_key_count
== 0
3190 || this_command_key_count_reset
)
3194 /* Don't echo mouse motion events. */
3195 if (echo_keystrokes_p ()
3196 && ! (EVENT_HAS_PARAMETERS (c
)
3197 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3200 if (! NILP (also_record
))
3201 echo_char (also_record
);
3202 /* Once we reread a character, echoing can happen
3203 the next time we pause to read a new one. */
3204 ok_to_echo_at_next_pause
= current_kboard
;
3207 /* Record this character as part of the current key. */
3208 add_command_key (c
);
3209 if (! NILP (also_record
))
3210 add_command_key (also_record
);
3213 last_input_event
= c
;
3216 /* Process the help character specially if enabled. */
3217 if (!NILP (Vhelp_form
) && help_char_p (c
))
3219 ptrdiff_t count
= SPECPDL_INDEX ();
3221 help_form_saved_window_configs
3222 = Fcons (Fcurrent_window_configuration (Qnil
),
3223 help_form_saved_window_configs
);
3224 record_unwind_protect_void (read_char_help_form_unwind
);
3225 call0 (Qhelp_form_show
);
3230 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3231 if (EVENT_HAS_PARAMETERS (c
)
3232 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3233 XSETCAR (help_form_saved_window_configs
, Qnil
);
3235 while (BUFFERP (c
));
3236 /* Remove the help from the frame. */
3237 unbind_to (count
, Qnil
);
3240 if (EQ (c
, make_number (040)))
3244 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3245 while (BUFFERP (c
));
3254 /* Record a key that came from a mouse menu.
3255 Record it for echoing, for this-command-keys, and so on. */
3258 record_menu_key (Lisp_Object c
)
3260 /* Wipe the echo area. */
3261 clear_message (1, 0);
3266 before_command_key_count
= this_command_key_count
;
3267 before_command_echo_length
= echo_length ();
3270 /* Don't echo mouse motion events. */
3271 if (echo_keystrokes_p ())
3275 /* Once we reread a character, echoing can happen
3276 the next time we pause to read a new one. */
3277 ok_to_echo_at_next_pause
= 0;
3280 /* Record this character as part of the current key. */
3281 add_command_key (c
);
3283 /* Re-reading in the middle of a command. */
3284 last_input_event
= c
;
3288 /* Return true if should recognize C as "the help character". */
3291 help_char_p (Lisp_Object c
)
3295 if (EQ (c
, Vhelp_char
))
3297 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3298 if (EQ (c
, XCAR (tail
)))
3303 /* Record the input event C in various ways. */
3306 record_char (Lisp_Object c
)
3310 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3312 /* To avoid filling recent_keys with help-echo and mouse-movement
3313 events, we filter out repeated help-echo events, only store the
3314 first and last in a series of mouse-movement events, and don't
3315 store repeated help-echo events which are only separated by
3316 mouse-movement events. */
3318 Lisp_Object ev1
, ev2
, ev3
;
3321 if ((ix1
= recent_keys_index
- 1) < 0)
3322 ix1
= NUM_RECENT_KEYS
- 1;
3323 ev1
= AREF (recent_keys
, ix1
);
3325 if ((ix2
= ix1
- 1) < 0)
3326 ix2
= NUM_RECENT_KEYS
- 1;
3327 ev2
= AREF (recent_keys
, ix2
);
3329 if ((ix3
= ix2
- 1) < 0)
3330 ix3
= NUM_RECENT_KEYS
- 1;
3331 ev3
= AREF (recent_keys
, ix3
);
3333 if (EQ (XCAR (c
), Qhelp_echo
))
3335 /* Don't record `help-echo' in recent_keys unless it shows some help
3336 message, and a different help than the previously recorded
3338 Lisp_Object help
, last_help
;
3340 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3341 if (!STRINGP (help
))
3343 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3344 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3346 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3347 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3348 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3350 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3351 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3352 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3353 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3356 else if (EQ (XCAR (c
), Qmouse_movement
))
3358 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3359 So additional mouse movement events replace the last element. */
3360 Lisp_Object last_window
, window
;
3362 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3363 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3364 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3365 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3366 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3368 ASET (recent_keys
, ix1
, c
);
3374 store_kbd_macro_char (c
);
3378 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3379 ASET (recent_keys
, recent_keys_index
, c
);
3380 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3381 recent_keys_index
= 0;
3383 else if (recorded
< 0)
3385 /* We need to remove one or two events from recent_keys.
3386 To do this, we simply put nil at those events and move the
3387 recent_keys_index backwards over those events. Usually,
3388 users will never see those nil events, as they will be
3389 overwritten by the command keys entered to see recent_keys
3392 while (recorded
++ < 0 && total_keys
> 0)
3394 if (total_keys
< NUM_RECENT_KEYS
)
3396 if (--recent_keys_index
< 0)
3397 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3398 ASET (recent_keys
, recent_keys_index
, Qnil
);
3402 num_nonmacro_input_events
++;
3404 /* Write c to the dribble file. If c is a lispy event, write
3405 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3406 If you, dear reader, have a better idea, you've got the source. :-) */
3412 if (XUINT (c
) < 0x100)
3413 putc (XUINT (c
), dribble
);
3415 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3419 Lisp_Object dribblee
;
3421 /* If it's a structured event, take the event header. */
3422 dribblee
= EVENT_HEAD (c
);
3424 if (SYMBOLP (dribblee
))
3426 putc ('<', dribble
);
3427 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3428 SBYTES (SYMBOL_NAME (dribblee
)),
3430 putc ('>', dribble
);
3439 /* Copy out or in the info on where C-g should throw to.
3440 This is used when running Lisp code from within get_char,
3441 in case get_char is called recursively.
3442 See read_process_output. */
3445 save_getcjmp (sys_jmp_buf temp
)
3447 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3451 restore_getcjmp (sys_jmp_buf temp
)
3453 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3456 /* Low level keyboard/mouse input.
3457 kbd_buffer_store_event places events in kbd_buffer, and
3458 kbd_buffer_get_event retrieves them. */
3460 /* Return true if there are any events in the queue that read-char
3461 would return. If this returns false, a read-char would block. */
3463 readable_events (int flags
)
3465 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3468 /* If the buffer contains only FOCUS_IN_EVENT events, and
3469 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3470 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3472 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3473 #ifdef USE_TOOLKIT_SCROLL_BARS
3474 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3478 struct input_event
*event
;
3480 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3487 #ifdef USE_TOOLKIT_SCROLL_BARS
3488 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3490 event
->kind
== FOCUS_IN_EVENT
)
3491 #ifdef USE_TOOLKIT_SCROLL_BARS
3492 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3493 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3494 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3495 && event
->part
== scroll_bar_handle
3496 && event
->modifiers
== 0)
3498 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3499 && event
->kind
== BUFFER_SWITCH_EVENT
))
3502 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3505 while (event
!= kbd_store_ptr
);
3511 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3512 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3516 if (current_kboard
->kbd_queue_has_data
)
3522 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3523 if (kb
->kbd_queue_has_data
)
3529 /* Set this for debugging, to have a way to get out */
3530 int stop_character EXTERNALLY_VISIBLE
;
3533 event_to_kboard (struct input_event
*event
)
3535 /* Not applicable for these special events. */
3536 if (event
->kind
== SELECTION_REQUEST_EVENT
3537 || event
->kind
== SELECTION_CLEAR_EVENT
)
3541 Lisp_Object obj
= event
->frame_or_window
;
3542 /* There are some events that set this field to nil or string. */
3544 obj
= WINDOW_FRAME (XWINDOW (obj
));
3545 /* Also ignore dead frames here. */
3546 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3547 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3552 /* Return the number of slots occupied in kbd_buffer. */
3555 kbd_buffer_nr_stored (void)
3557 return kbd_fetch_ptr
== kbd_store_ptr
3559 : (kbd_fetch_ptr
< kbd_store_ptr
3560 ? kbd_store_ptr
- kbd_fetch_ptr
3561 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3562 + (kbd_store_ptr
- kbd_buffer
)));
3564 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3567 kbd_buffer_store_event (register struct input_event
*event
)
3569 kbd_buffer_store_event_hold (event
, 0);
3572 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3574 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3575 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3576 Else, if EVENT is a quit event, store the quit event
3577 in HOLD_QUIT, and return (thus ignoring further events).
3579 This is used to postpone the processing of the quit event until all
3580 subsequent input events have been parsed (and discarded). */
3583 kbd_buffer_store_event_hold (register struct input_event
*event
,
3584 struct input_event
*hold_quit
)
3586 if (event
->kind
== NO_EVENT
)
3589 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3592 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3594 register int c
= event
->code
& 0377;
3596 if (event
->modifiers
& ctrl_modifier
)
3597 c
= make_ctrl_char (c
);
3599 c
|= (event
->modifiers
3600 & (meta_modifier
| alt_modifier
3601 | hyper_modifier
| super_modifier
));
3605 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3606 struct input_event
*sp
;
3608 if (single_kboard
&& kb
!= current_kboard
)
3611 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3613 kb
->kbd_queue_has_data
= 1;
3614 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3616 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3619 if (event_to_kboard (sp
) == kb
)
3621 sp
->kind
= NO_EVENT
;
3622 sp
->frame_or_window
= Qnil
;
3631 *hold_quit
= *event
;
3635 /* If this results in a quit_char being returned to Emacs as
3636 input, set Vlast_event_frame properly. If this doesn't
3637 get returned to Emacs as an event, the next event read
3638 will set Vlast_event_frame again, so this is safe to do. */
3642 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3644 focus
= event
->frame_or_window
;
3645 internal_last_event_frame
= focus
;
3646 Vlast_event_frame
= focus
;
3649 handle_interrupt (0);
3653 if (c
&& c
== stop_character
)
3659 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3660 Just ignore the second one. */
3661 else if (event
->kind
== BUFFER_SWITCH_EVENT
3662 && kbd_fetch_ptr
!= kbd_store_ptr
3663 && ((kbd_store_ptr
== kbd_buffer
3664 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3665 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3668 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3669 kbd_store_ptr
= kbd_buffer
;
3671 /* Don't let the very last slot in the buffer become full,
3672 since that would make the two pointers equal,
3673 and that is indistinguishable from an empty buffer.
3674 Discard the event if it would fill the last slot. */
3675 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3677 *kbd_store_ptr
= *event
;
3680 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3681 && ! kbd_on_hold_p ())
3683 /* Don't read keyboard input until we have processed kbd_buffer.
3684 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3685 hold_keyboard_input ();
3686 if (!noninteractive
)
3690 #endif /* subprocesses */
3693 /* If we're inside while-no-input, and this event qualifies
3694 as input, set quit-flag to cause an interrupt. */
3695 if (!NILP (Vthrow_on_input
)
3696 && event
->kind
!= FOCUS_IN_EVENT
3697 && event
->kind
!= HELP_EVENT
3698 && event
->kind
!= DEICONIFY_EVENT
)
3700 Vquit_flag
= Vthrow_on_input
;
3701 /* If we're inside a function that wants immediate quits,
3703 if (immediate_quit
&& NILP (Vinhibit_quit
))
3712 /* Put an input event back in the head of the event queue. */
3715 kbd_buffer_unget_event (register struct input_event
*event
)
3717 if (kbd_fetch_ptr
== kbd_buffer
)
3718 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3720 /* Don't let the very last slot in the buffer become full, */
3721 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3724 *kbd_fetch_ptr
= *event
;
3728 /* Limit help event positions to this range, to avoid overflow problems. */
3729 #define INPUT_EVENT_POS_MAX \
3730 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3731 MOST_POSITIVE_FIXNUM)))
3732 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3734 /* Return a Time that encodes position POS. POS must be in range. */
3737 position_to_Time (ptrdiff_t pos
)
3739 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3743 /* Return the position that ENCODED_POS encodes.
3744 Avoid signed integer overflow. */
3747 Time_to_position (Time encoded_pos
)
3749 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3751 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3752 eassert (encoded_pos_min
<= encoded_pos
);
3753 ptrdiff_t notpos
= -1 - encoded_pos
;
3757 /* Generate a HELP_EVENT input_event and store it in the keyboard
3760 HELP is the help form.
3762 FRAME and WINDOW are the frame and window where the help is
3763 generated. OBJECT is the Lisp object where the help was found (a
3764 buffer, a string, an overlay, or nil if neither from a string nor
3765 from a buffer). POS is the position within OBJECT where the help
3769 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3770 Lisp_Object object
, ptrdiff_t pos
)
3772 struct input_event event
;
3774 event
.kind
= HELP_EVENT
;
3775 event
.frame_or_window
= frame
;
3777 event
.x
= WINDOWP (window
) ? window
: frame
;
3779 event
.timestamp
= position_to_Time (pos
);
3780 kbd_buffer_store_event (&event
);
3784 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3787 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3789 struct input_event event
;
3791 event
.kind
= HELP_EVENT
;
3792 event
.frame_or_window
= frame
;
3796 event
.timestamp
= 0;
3797 kbd_buffer_store_event (&event
);
3801 /* Discard any mouse events in the event buffer by setting them to
3804 discard_mouse_events (void)
3806 struct input_event
*sp
;
3807 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3809 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3812 if (sp
->kind
== MOUSE_CLICK_EVENT
3813 || sp
->kind
== WHEEL_EVENT
3814 || sp
->kind
== HORIZ_WHEEL_EVENT
3816 || sp
->kind
== GPM_CLICK_EVENT
3818 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3819 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3821 sp
->kind
= NO_EVENT
;
3827 /* Return true if there are any real events waiting in the event
3828 buffer, not counting `NO_EVENT's.
3830 Discard NO_EVENT events at the front of the input queue, possibly
3831 leaving the input queue empty if there are no real input events. */
3834 kbd_buffer_events_waiting (void)
3836 struct input_event
*sp
;
3838 for (sp
= kbd_fetch_ptr
;
3839 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3842 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3847 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3851 /* Clear input event EVENT. */
3854 clear_event (struct input_event
*event
)
3856 event
->kind
= NO_EVENT
;
3860 /* Read one event from the event buffer, waiting if necessary.
3861 The value is a Lisp object representing the event.
3862 The value is nil for an event that should be ignored,
3863 or that was handled here.
3864 We always read and discard one event. */
3867 kbd_buffer_get_event (KBOARD
**kbp
,
3868 bool *used_mouse_menu
,
3869 struct timespec
*end_time
)
3874 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3876 /* Start reading input again because we have processed enough to
3877 be able to accept new events again. */
3878 unhold_keyboard_input ();
3881 #endif /* subprocesses */
3883 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3885 /* In case we are running as a daemon, only do this before
3886 detaching from the terminal. */
3887 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3891 *kbp
= current_kboard
;
3894 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3896 /* Wait until there is input available. */
3899 /* Break loop if there's an unread command event. Needed in
3900 moused window autoselection which uses a timer to insert such
3902 if (CONSP (Vunread_command_events
))
3905 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3907 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3910 /* If the quit flag is set, then read_char will return
3911 quit_char, so that counts as "available input." */
3912 if (!NILP (Vquit_flag
))
3913 quit_throw_to_read_char (0);
3915 /* One way or another, wait until input is available; then, if
3916 interrupt handlers have not read it, read it now. */
3921 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3923 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3927 struct timespec now
= current_timespec ();
3928 if (timespec_cmp (*end_time
, now
) <= 0)
3929 return Qnil
; /* Finished waiting. */
3932 struct timespec duration
= timespec_sub (*end_time
, now
);
3933 wait_reading_process_output (min (duration
.tv_sec
,
3936 -1, 1, Qnil
, NULL
, 0);
3941 bool do_display
= true;
3943 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3945 struct tty_display_info
*tty
= CURTTY ();
3947 /* When this TTY is displaying a menu, we must prevent
3948 any redisplay, because we modify the frame's glyph
3949 matrix behind the back of the display engine. */
3950 if (tty
->showing_menu
)
3954 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3957 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3961 if (CONSP (Vunread_command_events
))
3964 first
= XCAR (Vunread_command_events
);
3965 Vunread_command_events
= XCDR (Vunread_command_events
);
3966 *kbp
= current_kboard
;
3970 /* At this point, we know that there is a readable event available
3971 somewhere. If the event queue is empty, then there must be a
3972 mouse movement enabled and available. */
3973 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3975 struct input_event
*event
;
3977 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3981 *kbp
= event_to_kboard (event
);
3983 *kbp
= current_kboard
; /* Better than returning null ptr? */
3987 /* These two kinds of events get special handling
3988 and don't actually appear to the command loop.
3989 We return nil for them. */
3990 if (event
->kind
== SELECTION_REQUEST_EVENT
3991 || event
->kind
== SELECTION_CLEAR_EVENT
)
3994 struct input_event copy
;
3996 /* Remove it from the buffer before processing it,
3997 since otherwise swallow_events will see it
3998 and process it again. */
4000 kbd_fetch_ptr
= event
+ 1;
4001 input_pending
= readable_events (0);
4002 x_handle_selection_event (©
);
4004 /* We're getting selection request events, but we don't have
4010 #if defined (HAVE_NS)
4011 else if (event
->kind
== NS_TEXT_EVENT
)
4013 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
4014 obj
= list1 (intern ("ns-put-working-text"));
4016 obj
= list1 (intern ("ns-unput-working-text"));
4017 kbd_fetch_ptr
= event
+ 1;
4018 if (used_mouse_menu
)
4019 *used_mouse_menu
= 1;
4023 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4024 || defined (HAVE_NS)
4025 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4027 /* Make an event (delete-frame (FRAME)). */
4028 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
4029 kbd_fetch_ptr
= event
+ 1;
4032 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4033 || defined (HAVE_NS)
4034 else if (event
->kind
== ICONIFY_EVENT
)
4036 /* Make an event (iconify-frame (FRAME)). */
4037 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
4038 kbd_fetch_ptr
= event
+ 1;
4040 else if (event
->kind
== DEICONIFY_EVENT
)
4042 /* Make an event (make-frame-visible (FRAME)). */
4043 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
4044 kbd_fetch_ptr
= event
+ 1;
4047 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4049 /* The value doesn't matter here; only the type is tested. */
4050 XSETBUFFER (obj
, current_buffer
);
4051 kbd_fetch_ptr
= event
+ 1;
4053 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4054 || defined (HAVE_NS) || defined (USE_GTK)
4055 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4057 kbd_fetch_ptr
= event
+ 1;
4058 input_pending
= readable_events (0);
4059 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4060 x_activate_menubar (XFRAME (event
->frame_or_window
));
4064 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4066 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4067 obj
= list4 (Qlanguage_change
,
4068 event
->frame_or_window
,
4069 make_number (event
->code
),
4070 make_number (event
->modifiers
));
4071 kbd_fetch_ptr
= event
+ 1;
4074 #ifdef USE_FILE_NOTIFY
4075 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4077 #ifdef HAVE_W32NOTIFY
4078 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4079 obj
= list3 (Qfile_notify
,
4080 list3 (make_number (event
->code
),
4083 event
->frame_or_window
);
4085 obj
= make_lispy_event (event
);
4087 kbd_fetch_ptr
= event
+ 1;
4089 #endif /* USE_FILE_NOTIFY */
4090 else if (event
->kind
== SAVE_SESSION_EVENT
)
4092 obj
= list2 (Qsave_session
, event
->arg
);
4093 kbd_fetch_ptr
= event
+ 1;
4095 /* Just discard these, by returning nil.
4096 With MULTI_KBOARD, these events are used as placeholders
4097 when we need to randomly delete events from the queue.
4098 (They shouldn't otherwise be found in the buffer,
4099 but on some machines it appears they do show up
4100 even without MULTI_KBOARD.) */
4101 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4102 mouse events during a popup-menu call. */
4103 else if (event
->kind
== NO_EVENT
)
4104 kbd_fetch_ptr
= event
+ 1;
4105 else if (event
->kind
== HELP_EVENT
)
4107 Lisp_Object object
, position
, help
, frame
, window
;
4109 frame
= event
->frame_or_window
;
4110 object
= event
->arg
;
4111 position
= make_number (Time_to_position (event
->timestamp
));
4114 clear_event (event
);
4116 kbd_fetch_ptr
= event
+ 1;
4117 if (!WINDOWP (window
))
4119 obj
= Fcons (Qhelp_echo
,
4120 list5 (frame
, help
, window
, object
, position
));
4122 else if (event
->kind
== FOCUS_IN_EVENT
)
4124 /* Notification of a FocusIn event. The frame receiving the
4125 focus is in event->frame_or_window. Generate a
4126 switch-frame event if necessary. */
4127 Lisp_Object frame
, focus
;
4129 frame
= event
->frame_or_window
;
4130 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4139 !EQ (frame
, internal_last_event_frame
)
4140 && !EQ (frame
, selected_frame
))
4141 obj
= make_lispy_switch_frame (frame
);
4143 obj
= make_lispy_focus_in (frame
);
4145 internal_last_event_frame
= frame
;
4146 kbd_fetch_ptr
= event
+ 1;
4148 else if (event
->kind
== FOCUS_OUT_EVENT
)
4150 #ifdef HAVE_WINDOW_SYSTEM
4153 Lisp_Object frame
= event
->frame_or_window
;
4154 bool focused
= false;
4156 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4157 focused
= di
->x_highlight_frame
!= 0;
4160 obj
= make_lispy_focus_out (frame
);
4162 #endif /* HAVE_WINDOW_SYSTEM */
4164 kbd_fetch_ptr
= event
+ 1;
4167 else if (event
->kind
== DBUS_EVENT
)
4169 obj
= make_lispy_event (event
);
4170 kbd_fetch_ptr
= event
+ 1;
4173 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4175 obj
= make_lispy_event (event
);
4176 kbd_fetch_ptr
= event
+ 1;
4180 /* If this event is on a different frame, return a switch-frame this
4181 time, and leave the event in the queue for next time. */
4185 frame
= event
->frame_or_window
;
4187 frame
= XCAR (frame
);
4188 else if (WINDOWP (frame
))
4189 frame
= WINDOW_FRAME (XWINDOW (frame
));
4191 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4195 if (! EQ (frame
, internal_last_event_frame
)
4196 && !EQ (frame
, selected_frame
))
4197 obj
= make_lispy_switch_frame (frame
);
4198 internal_last_event_frame
= frame
;
4200 /* If we didn't decide to make a switch-frame event, go ahead
4201 and build a real event from the queue entry. */
4205 obj
= make_lispy_event (event
);
4207 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4208 || defined (HAVE_NS) || defined (USE_GTK)
4209 /* If this was a menu selection, then set the flag to inhibit
4210 writing to last_nonmenu_event. Don't do this if the event
4211 we're returning is (menu-bar), though; that indicates the
4212 beginning of the menu sequence, and we might as well leave
4213 that as the `event with parameters' for this selection. */
4215 && !EQ (event
->frame_or_window
, event
->arg
)
4216 && (event
->kind
== MENU_BAR_EVENT
4217 || event
->kind
== TOOL_BAR_EVENT
))
4218 *used_mouse_menu
= 1;
4221 /* Certain system events are non-key events. */
4223 && event
->kind
== NS_NONKEY_EVENT
)
4224 *used_mouse_menu
= 1;
4227 /* Wipe out this event, to catch bugs. */
4228 clear_event (event
);
4229 kbd_fetch_ptr
= event
+ 1;
4233 /* Try generating a mouse motion event. */
4234 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4236 struct frame
*f
= some_mouse_moved ();
4237 Lisp_Object bar_window
;
4238 enum scroll_bar_part part
;
4242 *kbp
= current_kboard
;
4243 /* Note that this uses F to determine which terminal to look at.
4244 If there is no valid info, it does not store anything
4245 so x remains nil. */
4248 /* XXX Can f or mouse_position_hook be NULL here? */
4249 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4250 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4255 /* Decide if we should generate a switch-frame event. Don't
4256 generate switch-frame events for motion outside of all Emacs
4262 frame
= FRAME_FOCUS_FRAME (f
);
4264 XSETFRAME (frame
, f
);
4266 if (! EQ (frame
, internal_last_event_frame
)
4267 && !EQ (frame
, selected_frame
))
4268 obj
= make_lispy_switch_frame (frame
);
4269 internal_last_event_frame
= frame
;
4272 /* If we didn't decide to make a switch-frame event, go ahead and
4273 return a mouse-motion event. */
4274 if (!NILP (x
) && NILP (obj
))
4275 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4278 /* We were promised by the above while loop that there was
4279 something for us to read! */
4282 input_pending
= readable_events (0);
4284 Vlast_event_frame
= internal_last_event_frame
;
4289 /* Process any non-user-visible events (currently X selection events),
4290 without reading any user-visible events. */
4293 process_special_events (void)
4295 struct input_event
*event
;
4297 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4299 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4302 if (event
== kbd_store_ptr
)
4306 /* If we find a stored X selection request, handle it now. */
4307 if (event
->kind
== SELECTION_REQUEST_EVENT
4308 || event
->kind
== SELECTION_CLEAR_EVENT
)
4312 /* Remove the event from the fifo buffer before processing;
4313 otherwise swallow_events called recursively could see it
4314 and process it again. To do this, we move the events
4315 between kbd_fetch_ptr and EVENT one slot to the right,
4318 struct input_event copy
= *event
;
4319 struct input_event
*beg
4320 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4321 ? kbd_buffer
: kbd_fetch_ptr
;
4324 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4325 else if (event
< beg
)
4327 if (event
> kbd_buffer
)
4328 memmove (kbd_buffer
+ 1, kbd_buffer
,
4329 (event
- kbd_buffer
) * sizeof (struct input_event
));
4330 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4331 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4332 memmove (beg
+ 1, beg
,
4333 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4334 * sizeof (struct input_event
));
4337 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4338 kbd_fetch_ptr
= kbd_buffer
+ 1;
4342 input_pending
= readable_events (0);
4343 x_handle_selection_event (©
);
4345 /* We're getting selection request events, but we don't have
4353 /* Process any events that are not user-visible, run timer events that
4354 are ripe, and return, without reading any user-visible events. */
4357 swallow_events (bool do_display
)
4359 unsigned old_timers_run
;
4361 process_special_events ();
4363 old_timers_run
= timers_run
;
4364 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4366 if (timers_run
!= old_timers_run
&& do_display
)
4367 redisplay_preserve_echo_area (7);
4370 /* Record the start of when Emacs is idle,
4371 for the sake of running idle-time timers. */
4374 timer_start_idle (void)
4376 /* If we are already in the idle state, do nothing. */
4377 if (timespec_valid_p (timer_idleness_start_time
))
4380 timer_idleness_start_time
= current_timespec ();
4381 timer_last_idleness_start_time
= timer_idleness_start_time
;
4383 /* Mark all idle-time timers as once again candidates for running. */
4384 call0 (intern ("internal-timer-start-idle"));
4387 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4390 timer_stop_idle (void)
4392 timer_idleness_start_time
= invalid_timespec ();
4395 /* Resume idle timer from last idle start time. */
4398 timer_resume_idle (void)
4400 if (timespec_valid_p (timer_idleness_start_time
))
4403 timer_idleness_start_time
= timer_last_idleness_start_time
;
4406 /* This is only for debugging. */
4407 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4409 /* List of elisp functions to call, delayed because they were generated in
4410 a context where Elisp could not be safely run (e.g. redisplay, signal,
4411 ...). Each element has the form (FUN . ARGS). */
4412 Lisp_Object pending_funcalls
;
4414 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4416 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4418 Lisp_Object
*vector
;
4420 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4422 vector
= XVECTOR (timer
)->contents
;
4423 if (! NILP (vector
[0]))
4426 return (decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4428 && timespec_valid_p (*result
));
4432 /* Check whether a timer has fired. To prevent larger problems we simply
4433 disregard elements that are not proper timers. Do not make a circular
4434 timer list for the time being.
4436 Returns the time to wait until the next timer fires. If a
4437 timer is triggering now, return zero.
4438 If no timer is active, return -1.
4440 If a timer is ripe, we run it, with quitting turned off.
4441 In that case we return 0 to indicate that a new timer_check_2 call
4444 static struct timespec
4445 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4447 struct timespec nexttime
;
4448 struct timespec now
;
4449 struct timespec idleness_now
;
4450 Lisp_Object chosen_timer
;
4451 struct gcpro gcpro1
;
4453 nexttime
= invalid_timespec ();
4455 chosen_timer
= Qnil
;
4456 GCPRO1 (chosen_timer
);
4458 /* First run the code that was delayed. */
4459 while (CONSP (pending_funcalls
))
4461 Lisp_Object funcall
= XCAR (pending_funcalls
);
4462 pending_funcalls
= XCDR (pending_funcalls
);
4463 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4466 if (CONSP (timers
) || CONSP (idle_timers
))
4468 now
= current_timespec ();
4469 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4470 ? timespec_sub (now
, timer_idleness_start_time
)
4471 : make_timespec (0, 0));
4474 while (CONSP (timers
) || CONSP (idle_timers
))
4476 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4477 struct timespec timer_time
, idle_timer_time
;
4478 struct timespec difference
;
4479 struct timespec timer_difference
= invalid_timespec ();
4480 struct timespec idle_timer_difference
= invalid_timespec ();
4481 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4483 /* Set TIMER and TIMER_DIFFERENCE
4484 based on the next ordinary timer.
4485 TIMER_DIFFERENCE is the distance in time from NOW to when
4486 this timer becomes ripe (negative if it's already ripe).
4487 Skip past invalid timers and timers already handled. */
4490 timer
= XCAR (timers
);
4491 if (! decode_timer (timer
, &timer_time
))
4493 timers
= XCDR (timers
);
4497 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4498 timer_difference
= (timer_ripe
4499 ? timespec_sub (now
, timer_time
)
4500 : timespec_sub (timer_time
, now
));
4503 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4504 based on the next idle timer. */
4505 if (CONSP (idle_timers
))
4507 idle_timer
= XCAR (idle_timers
);
4508 if (! decode_timer (idle_timer
, &idle_timer_time
))
4510 idle_timers
= XCDR (idle_timers
);
4514 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4515 idle_timer_difference
4517 ? timespec_sub (idleness_now
, idle_timer_time
)
4518 : timespec_sub (idle_timer_time
, idleness_now
));
4521 /* Decide which timer is the next timer,
4522 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4523 Also step down the list where we found that timer. */
4525 if (timespec_valid_p (timer_difference
)
4526 && (! timespec_valid_p (idle_timer_difference
)
4527 || idle_timer_ripe
< timer_ripe
4528 || (idle_timer_ripe
== timer_ripe
4530 ? timespec_cmp (idle_timer_difference
,
4532 : timespec_cmp (timer_difference
,
4533 idle_timer_difference
))
4536 chosen_timer
= timer
;
4537 timers
= XCDR (timers
);
4538 difference
= timer_difference
;
4543 chosen_timer
= idle_timer
;
4544 idle_timers
= XCDR (idle_timers
);
4545 difference
= idle_timer_difference
;
4546 ripe
= idle_timer_ripe
;
4549 /* If timer is ripe, run it if it hasn't been run. */
4552 if (NILP (AREF (chosen_timer
, 0)))
4554 ptrdiff_t count
= SPECPDL_INDEX ();
4555 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4557 /* Mark the timer as triggered to prevent problems if the lisp
4558 code fails to reschedule it right. */
4559 ASET (chosen_timer
, 0, Qt
);
4561 specbind (Qinhibit_quit
, Qt
);
4563 call1 (Qtimer_event_handler
, chosen_timer
);
4564 Vdeactivate_mark
= old_deactivate_mark
;
4566 unbind_to (count
, Qnil
);
4568 /* Since we have handled the event,
4569 we don't need to tell the caller to wake up and do it. */
4570 /* But the caller must still wait for the next timer, so
4571 return 0 to indicate that. */
4574 nexttime
= make_timespec (0, 0);
4578 /* When we encounter a timer that is still waiting,
4579 return the amount of time to wait before it is ripe. */
4586 /* No timers are pending in the future. */
4587 /* Return 0 if we generated an event, and -1 if not. */
4593 /* Check whether a timer has fired. To prevent larger problems we simply
4594 disregard elements that are not proper timers. Do not make a circular
4595 timer list for the time being.
4597 Returns the time to wait until the next timer fires.
4598 If no timer is active, return an invalid value.
4600 As long as any timer is ripe, we run it. */
4605 struct timespec nexttime
;
4606 Lisp_Object timers
, idle_timers
;
4607 struct gcpro gcpro1
, gcpro2
;
4609 Lisp_Object tem
= Vinhibit_quit
;
4612 /* We use copies of the timers' lists to allow a timer to add itself
4613 again, without locking up Emacs if the newly added timer is
4614 already ripe when added. */
4616 /* Always consider the ordinary timers. */
4617 timers
= Fcopy_sequence (Vtimer_list
);
4618 /* Consider the idle timers only if Emacs is idle. */
4619 if (timespec_valid_p (timer_idleness_start_time
))
4620 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4624 Vinhibit_quit
= tem
;
4626 GCPRO2 (timers
, idle_timers
);
4630 nexttime
= timer_check_2 (timers
, idle_timers
);
4632 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4638 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4639 doc
: /* Return the current length of Emacs idleness, or nil.
4640 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4641 in the same style as (current-time).
4643 The value when Emacs is not idle is nil.
4645 PSEC is a multiple of the system clock resolution. */)
4648 if (timespec_valid_p (timer_idleness_start_time
))
4649 return make_lisp_time (timespec_sub (current_timespec (),
4650 timer_idleness_start_time
));
4655 /* Caches for modify_event_symbol. */
4656 static Lisp_Object accent_key_syms
;
4657 static Lisp_Object func_key_syms
;
4658 static Lisp_Object mouse_syms
;
4659 static Lisp_Object wheel_syms
;
4660 static Lisp_Object drag_n_drop_syms
;
4662 /* This is a list of keysym codes for special "accent" characters.
4663 It parallels lispy_accent_keys. */
4665 static const int lispy_accent_codes
[] =
4667 #ifdef XK_dead_circumflex
4672 #ifdef XK_dead_grave
4677 #ifdef XK_dead_tilde
4682 #ifdef XK_dead_diaeresis
4687 #ifdef XK_dead_macron
4692 #ifdef XK_dead_degree
4697 #ifdef XK_dead_acute
4702 #ifdef XK_dead_cedilla
4707 #ifdef XK_dead_breve
4712 #ifdef XK_dead_ogonek
4717 #ifdef XK_dead_caron
4722 #ifdef XK_dead_doubleacute
4723 XK_dead_doubleacute
,
4727 #ifdef XK_dead_abovedot
4732 #ifdef XK_dead_abovering
4742 #ifdef XK_dead_belowdot
4747 #ifdef XK_dead_voiced_sound
4748 XK_dead_voiced_sound
,
4752 #ifdef XK_dead_semivoiced_sound
4753 XK_dead_semivoiced_sound
,
4769 /* This is a list of Lisp names for special "accent" characters.
4770 It parallels lispy_accent_codes. */
4772 static const char *const lispy_accent_keys
[] =
4790 "dead-voiced-sound",
4791 "dead-semivoiced-sound",
4797 #define FUNCTION_KEY_OFFSET 0x0
4799 const char *const lispy_function_keys
[] =
4803 0, /* VK_LBUTTON 0x01 */
4804 0, /* VK_RBUTTON 0x02 */
4805 "cancel", /* VK_CANCEL 0x03 */
4806 0, /* VK_MBUTTON 0x04 */
4808 0, 0, 0, /* 0x05 .. 0x07 */
4810 "backspace", /* VK_BACK 0x08 */
4811 "tab", /* VK_TAB 0x09 */
4813 0, 0, /* 0x0A .. 0x0B */
4815 "clear", /* VK_CLEAR 0x0C */
4816 "return", /* VK_RETURN 0x0D */
4818 0, 0, /* 0x0E .. 0x0F */
4820 0, /* VK_SHIFT 0x10 */
4821 0, /* VK_CONTROL 0x11 */
4822 0, /* VK_MENU 0x12 */
4823 "pause", /* VK_PAUSE 0x13 */
4824 "capslock", /* VK_CAPITAL 0x14 */
4825 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4827 "junja", /* VK_JUNJA 0x17 */
4828 "final", /* VK_FINAL 0x18 */
4829 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4831 "escape", /* VK_ESCAPE 0x1B */
4832 "convert", /* VK_CONVERT 0x1C */
4833 "non-convert", /* VK_NONCONVERT 0x1D */
4834 "accept", /* VK_ACCEPT 0x1E */
4835 "mode-change", /* VK_MODECHANGE 0x1F */
4836 0, /* VK_SPACE 0x20 */
4837 "prior", /* VK_PRIOR 0x21 */
4838 "next", /* VK_NEXT 0x22 */
4839 "end", /* VK_END 0x23 */
4840 "home", /* VK_HOME 0x24 */
4841 "left", /* VK_LEFT 0x25 */
4842 "up", /* VK_UP 0x26 */
4843 "right", /* VK_RIGHT 0x27 */
4844 "down", /* VK_DOWN 0x28 */
4845 "select", /* VK_SELECT 0x29 */
4846 "print", /* VK_PRINT 0x2A */
4847 "execute", /* VK_EXECUTE 0x2B */
4848 "snapshot", /* VK_SNAPSHOT 0x2C */
4849 "insert", /* VK_INSERT 0x2D */
4850 "delete", /* VK_DELETE 0x2E */
4851 "help", /* VK_HELP 0x2F */
4853 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4855 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4857 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4859 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4861 0, 0, 0, 0, 0, 0, 0, 0, 0,
4862 0, 0, 0, 0, 0, 0, 0, 0, 0,
4863 0, 0, 0, 0, 0, 0, 0, 0,
4865 "lwindow", /* VK_LWIN 0x5B */
4866 "rwindow", /* VK_RWIN 0x5C */
4867 "apps", /* VK_APPS 0x5D */
4870 "kp-0", /* VK_NUMPAD0 0x60 */
4871 "kp-1", /* VK_NUMPAD1 0x61 */
4872 "kp-2", /* VK_NUMPAD2 0x62 */
4873 "kp-3", /* VK_NUMPAD3 0x63 */
4874 "kp-4", /* VK_NUMPAD4 0x64 */
4875 "kp-5", /* VK_NUMPAD5 0x65 */
4876 "kp-6", /* VK_NUMPAD6 0x66 */
4877 "kp-7", /* VK_NUMPAD7 0x67 */
4878 "kp-8", /* VK_NUMPAD8 0x68 */
4879 "kp-9", /* VK_NUMPAD9 0x69 */
4880 "kp-multiply", /* VK_MULTIPLY 0x6A */
4881 "kp-add", /* VK_ADD 0x6B */
4882 "kp-separator", /* VK_SEPARATOR 0x6C */
4883 "kp-subtract", /* VK_SUBTRACT 0x6D */
4884 "kp-decimal", /* VK_DECIMAL 0x6E */
4885 "kp-divide", /* VK_DIVIDE 0x6F */
4886 "f1", /* VK_F1 0x70 */
4887 "f2", /* VK_F2 0x71 */
4888 "f3", /* VK_F3 0x72 */
4889 "f4", /* VK_F4 0x73 */
4890 "f5", /* VK_F5 0x74 */
4891 "f6", /* VK_F6 0x75 */
4892 "f7", /* VK_F7 0x76 */
4893 "f8", /* VK_F8 0x77 */
4894 "f9", /* VK_F9 0x78 */
4895 "f10", /* VK_F10 0x79 */
4896 "f11", /* VK_F11 0x7A */
4897 "f12", /* VK_F12 0x7B */
4898 "f13", /* VK_F13 0x7C */
4899 "f14", /* VK_F14 0x7D */
4900 "f15", /* VK_F15 0x7E */
4901 "f16", /* VK_F16 0x7F */
4902 "f17", /* VK_F17 0x80 */
4903 "f18", /* VK_F18 0x81 */
4904 "f19", /* VK_F19 0x82 */
4905 "f20", /* VK_F20 0x83 */
4906 "f21", /* VK_F21 0x84 */
4907 "f22", /* VK_F22 0x85 */
4908 "f23", /* VK_F23 0x86 */
4909 "f24", /* VK_F24 0x87 */
4911 0, 0, 0, 0, /* 0x88 .. 0x8B */
4912 0, 0, 0, 0, /* 0x8C .. 0x8F */
4914 "kp-numlock", /* VK_NUMLOCK 0x90 */
4915 "scroll", /* VK_SCROLL 0x91 */
4916 /* Not sure where the following block comes from.
4917 Windows headers have NEC and Fujitsu specific keys in
4918 this block, but nothing generic. */
4919 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4920 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4921 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4922 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4923 "kp-end", /* VK_NUMPAD_END 0x96 */
4924 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4925 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4926 "kp-up", /* VK_NUMPAD_UP 0x99 */
4927 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4928 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4929 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4930 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4932 0, 0, /* 0x9E .. 0x9F */
4935 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4936 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4937 * No other API or message will distinguish left and right keys this way.
4942 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4943 to enable them selectively, and gives access to a few more functions.
4944 See lispy_multimedia_keys below. */
4945 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4946 0, 0, 0, /* 0xAD .. 0xAF Volume */
4947 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4948 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4950 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4951 0, 0, 0, 0, 0, 0, 0, 0, 0,
4953 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4954 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4955 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4958 "ax", /* VK_OEM_AX 0xE1 */
4959 0, /* VK_OEM_102 0xE2 */
4960 "ico-help", /* VK_ICO_HELP 0xE3 */
4961 "ico-00", /* VK_ICO_00 0xE4 */
4962 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4963 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4964 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4966 "reset", /* VK_OEM_RESET 0xE9 */
4967 "jump", /* VK_OEM_JUMP 0xEA */
4968 "oem-pa1", /* VK_OEM_PA1 0xEB */
4969 "oem-pa2", /* VK_OEM_PA2 0xEC */
4970 "oem-pa3", /* VK_OEM_PA3 0xED */
4971 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4972 "cusel", /* VK_OEM_CUSEL 0xEF */
4973 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4974 "finish", /* VK_OEM_FINISH 0xF1 */
4975 "copy", /* VK_OEM_COPY 0xF2 */
4976 "auto", /* VK_OEM_AUTO 0xF3 */
4977 "enlw", /* VK_OEM_ENLW 0xF4 */
4978 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4979 "attn", /* VK_ATTN 0xF6 */
4980 "crsel", /* VK_CRSEL 0xF7 */
4981 "exsel", /* VK_EXSEL 0xF8 */
4982 "ereof", /* VK_EREOF 0xF9 */
4983 "play", /* VK_PLAY 0xFA */
4984 "zoom", /* VK_ZOOM 0xFB */
4985 "noname", /* VK_NONAME 0xFC */
4986 "pa1", /* VK_PA1 0xFD */
4987 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4991 /* Some of these duplicate the "Media keys" on newer keyboards,
4992 but they are delivered to the application in a different way. */
4993 static const char *const lispy_multimedia_keys
[] =
5001 "browser-favorites",
5038 "toggle-dictate-command",
5044 "media-fast-forward",
5047 "media-channel-down"
5050 #else /* not HAVE_NTGUI */
5052 /* This should be dealt with in XTread_socket now, and that doesn't
5053 depend on the client system having the Kana syms defined. See also
5054 the XK_kana_A case below. */
5057 static const char *const lispy_kana_keys
[] =
5059 /* X Keysym value */
5060 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5061 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5062 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5063 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5064 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5065 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5066 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5067 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5068 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5069 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5070 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5071 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5072 "kana-i", "kana-u", "kana-e", "kana-o",
5073 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5074 "prolongedsound", "kana-A", "kana-I", "kana-U",
5075 "kana-E", "kana-O", "kana-KA", "kana-KI",
5076 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5077 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5078 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5079 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5080 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5081 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5082 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5083 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5084 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5085 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5086 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5087 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5089 #endif /* XK_kana_A */
5092 #define FUNCTION_KEY_OFFSET 0xff00
5094 /* You'll notice that this table is arranged to be conveniently
5095 indexed by X Windows keysym values. */
5096 static const char *const lispy_function_keys
[] =
5098 /* X Keysym value */
5100 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5101 "backspace", "tab", "linefeed", "clear",
5103 0, 0, 0, "pause", /* 0xff10...1f */
5104 0, 0, 0, 0, 0, 0, 0, "escape",
5106 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5107 "romaji", "hiragana", "katakana", "hiragana-katakana",
5108 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5109 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5110 "eisu-toggle", /* 0xff30...3f */
5111 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5112 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5114 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5115 "down", "prior", "next", "end",
5116 "begin", 0, 0, 0, 0, 0, 0, 0,
5117 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5128 "break", /* 0xff6b */
5131 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5132 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5133 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5134 0, 0, 0, 0, 0, 0, 0, 0,
5135 "kp-tab", /* 0xff89 */
5137 "kp-enter", /* 0xff8d */
5139 "kp-f1", /* 0xff91 */
5143 "kp-home", /* 0xff95 */
5148 "kp-prior", /* kp-page-up */
5149 "kp-next", /* kp-page-down */
5155 0, 0, 0, 0, 0, 0, 0, 0, 0,
5156 "kp-multiply", /* 0xffaa */
5161 "kp-divide", /* 0xffaf */
5162 "kp-0", /* 0xffb0 */
5163 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5166 "kp-equal", /* 0xffbd */
5167 "f1", /* 0xffbe */ /* IsFunctionKey */
5169 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5170 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5171 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5172 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5173 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5174 0, 0, 0, 0, 0, 0, 0, 0,
5175 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5176 0, 0, 0, 0, 0, 0, 0, "delete"
5179 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5180 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5182 static const char *const iso_lispy_function_keys
[] =
5184 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5185 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5186 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5187 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5188 "iso-lefttab", /* 0xfe20 */
5189 "iso-move-line-up", "iso-move-line-down",
5190 "iso-partial-line-up", "iso-partial-line-down",
5191 "iso-partial-space-left", "iso-partial-space-right",
5192 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5193 "iso-release-margin-left", "iso-release-margin-right",
5194 "iso-release-both-margins",
5195 "iso-fast-cursor-left", "iso-fast-cursor-right",
5196 "iso-fast-cursor-up", "iso-fast-cursor-down",
5197 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5198 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5201 #endif /* not HAVE_NTGUI */
5203 static Lisp_Object Vlispy_mouse_stem
;
5205 static const char *const lispy_wheel_names
[] =
5207 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5210 /* drag-n-drop events are generated when a set of selected files are
5211 dragged from another application and dropped onto an Emacs window. */
5212 static const char *const lispy_drag_n_drop_names
[] =
5217 /* Scroll bar parts. */
5218 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5219 static Lisp_Object Qbefore_handle
, Qhorizontal_handle
, Qafter_handle
;
5220 Lisp_Object Qup
, Qdown
, Qtop
, Qbottom
;
5221 static Lisp_Object Qleftmost
, Qrightmost
;
5222 static Lisp_Object Qend_scroll
;
5223 static Lisp_Object Qratio
;
5225 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value.
5226 Note that Qnil corresponds to scroll_bar_nowhere and should not appear
5228 static Lisp_Object
*const scroll_bar_parts
[] = {
5229 &Qnil
, &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5230 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
,
5231 &Qbefore_handle
, &Qhorizontal_handle
, &Qafter_handle
,
5232 &Qleft
, &Qright
, &Qleftmost
, &Qrightmost
, &Qend_scroll
, &Qratio
5235 /* A vector, indexed by button number, giving the down-going location
5236 of currently depressed buttons, both scroll bar and non-scroll bar.
5238 The elements have the form
5239 (BUTTON-NUMBER MODIFIER-MASK . REST)
5240 where REST is the cdr of a position as it would be reported in the event.
5242 The make_lispy_event function stores positions here to tell the
5243 difference between click and drag events, and to store the starting
5244 location to be included in drag events. */
5246 static Lisp_Object button_down_location
;
5248 /* Information about the most recent up-going button event: Which
5249 button, what location, and what time. */
5251 static int last_mouse_button
;
5252 static int last_mouse_x
;
5253 static int last_mouse_y
;
5254 static Time button_down_time
;
5256 /* The number of clicks in this multiple-click. */
5258 static int double_click_count
;
5260 /* X and Y are frame-relative coordinates for a click or wheel event.
5261 Return a Lisp-style event list. */
5264 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5267 enum window_part part
;
5268 Lisp_Object posn
= Qnil
;
5269 Lisp_Object extra_info
= Qnil
;
5270 /* Coordinate pixel positions to return. */
5271 int xret
= 0, yret
= 0;
5272 /* The window under frame pixel coordinates (x,y) */
5273 Lisp_Object window
= f
5274 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5277 if (WINDOWP (window
))
5279 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5280 struct window
*w
= XWINDOW (window
);
5281 Lisp_Object string_info
= Qnil
;
5282 ptrdiff_t textpos
= 0;
5283 int col
= -1, row
= -1;
5284 int dx
= -1, dy
= -1;
5285 int width
= -1, height
= -1;
5286 Lisp_Object object
= Qnil
;
5288 /* Pixel coordinates relative to the window corner. */
5289 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5290 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5292 /* For text area clicks, return X, Y relative to the corner of
5293 this text area. Note that dX, dY etc are set below, by
5294 buffer_posn_from_coords. */
5295 if (part
== ON_TEXT
)
5297 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5298 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5300 /* For mode line and header line clicks, return X, Y relative to
5301 the left window edge. Use mode_line_string to look for a
5302 string on the click position. */
5303 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5308 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5309 /* Note that mode_line_string takes COL, ROW as pixels and
5310 converts them to characters. */
5313 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5314 &object
, &dx
, &dy
, &width
, &height
);
5315 if (STRINGP (string
))
5316 string_info
= Fcons (string
, make_number (charpos
));
5322 /* For fringes and margins, Y is relative to the area's (and the
5323 window's) top edge, while X is meaningless. */
5324 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5329 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5332 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5333 &object
, &dx
, &dy
, &width
, &height
);
5334 if (STRINGP (string
))
5335 string_info
= Fcons (string
, make_number (charpos
));
5337 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5339 else if (part
== ON_LEFT_FRINGE
)
5341 posn
= Qleft_fringe
;
5345 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5346 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5347 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5349 else if (part
== ON_RIGHT_FRINGE
)
5351 posn
= Qright_fringe
;
5355 - window_box_width (w
, LEFT_MARGIN_AREA
)
5356 - window_box_width (w
, TEXT_AREA
)
5357 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5358 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5360 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5362 else if (part
== ON_VERTICAL_BORDER
)
5364 posn
= Qvertical_line
;
5370 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5372 posn
= Qvertical_scroll_bar
;
5373 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5377 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5379 posn
= Qhorizontal_scroll_bar
;
5380 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5384 else if (part
== ON_RIGHT_DIVIDER
)
5386 posn
= Qright_divider
;
5387 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5391 else if (part
== ON_BOTTOM_DIVIDER
)
5393 posn
= Qbottom_divider
;
5394 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5399 /* For clicks in the text area, fringes, or margins, call
5400 buffer_posn_from_coords to extract TEXTPOS, the buffer
5401 position nearest to the click. */
5404 Lisp_Object string2
, object2
= Qnil
;
5405 struct display_pos p
;
5407 int width2
, height2
;
5408 /* The pixel X coordinate passed to buffer_posn_from_coords
5409 is the X coordinate relative to the text area for
5410 text-area and right-margin clicks, zero otherwise. */
5412 = (part
== ON_TEXT
) ? xret
5413 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5414 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5418 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5419 &object2
, &dx2
, &dy2
,
5421 textpos
= CHARPOS (p
.pos
);
5422 if (col
< 0) col
= x2
;
5423 if (row
< 0) row
= y2
;
5424 if (dx
< 0) dx
= dx2
;
5425 if (dy
< 0) dy
= dy2
;
5426 if (width
< 0) width
= width2
;
5427 if (height
< 0) height
= height2
;
5431 posn
= make_number (textpos
);
5432 if (STRINGP (string2
))
5433 string_info
= Fcons (string2
,
5434 make_number (CHARPOS (p
.string_pos
)));
5440 #ifdef HAVE_WINDOW_SYSTEM
5441 if (IMAGEP (object
))
5443 Lisp_Object image_map
, hotspot
;
5444 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5446 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5448 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5449 posn
= XCAR (hotspot
);
5456 Fcons (make_number (dx
), make_number (dy
)),
5457 Fcons (make_number (width
), make_number (height
)));
5460 extra_info
= Fcons (string_info
,
5461 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5462 Fcons (Fcons (make_number (col
),
5468 /* Return mouse pixel coordinates here. */
5469 XSETFRAME (window
, f
);
5476 return Fcons (window
,
5478 Fcons (Fcons (make_number (xret
),
5479 make_number (yret
)),
5480 Fcons (make_number (t
),
5484 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5485 menu bar. This really means that Emacs draws and manages the menu
5486 bar as part of its normal display, and therefore can compute its
5489 toolkit_menubar_in_use (struct frame
*f
)
5491 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5492 return !(!FRAME_WINDOW_P (f
));
5498 /* Build the part of Lisp event which represents scroll bar state from
5499 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5502 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5504 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5505 make_number (ev
->timestamp
), *scroll_bar_parts
[ev
->part
]);
5508 /* Given a struct input_event, build the lisp event which represents
5509 it. If EVENT is 0, build a mouse movement event from the mouse
5510 movement buffer, which should have a movement event in it.
5512 Note that events must be passed to this function in the order they
5513 are received; this function stores the location of button presses
5514 in order to build drag events when the button is released. */
5517 make_lispy_event (struct input_event
*event
)
5521 switch (event
->kind
)
5523 /* A simple keystroke. */
5524 case ASCII_KEYSTROKE_EVENT
:
5525 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5527 Lisp_Object lispy_c
;
5528 EMACS_INT c
= event
->code
;
5529 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5532 eassert (c
== event
->code
);
5533 /* Turn ASCII characters into control characters
5535 if (event
->modifiers
& ctrl_modifier
)
5537 c
= make_ctrl_char (c
);
5538 event
->modifiers
&= ~ctrl_modifier
;
5542 /* Add in the other modifier bits. The shift key was taken care
5543 of by the X code. */
5544 c
|= (event
->modifiers
5545 & (meta_modifier
| alt_modifier
5546 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5547 /* Distinguish Shift-SPC from SPC. */
5548 if ((event
->code
) == 040
5549 && event
->modifiers
& shift_modifier
)
5550 c
|= shift_modifier
;
5551 button_down_time
= 0;
5552 XSETFASTINT (lispy_c
, c
);
5557 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5558 except that they are non-key events (last-nonmenu-event is nil). */
5559 case NS_NONKEY_EVENT
:
5562 /* A function key. The symbol may need to have modifier prefixes
5564 case NON_ASCII_KEYSTROKE_EVENT
:
5565 button_down_time
= 0;
5567 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5568 if (event
->code
== lispy_accent_codes
[i
])
5569 return modify_event_symbol (i
,
5571 Qfunction_key
, Qnil
,
5572 lispy_accent_keys
, &accent_key_syms
,
5573 ARRAYELTS (lispy_accent_keys
));
5577 if (event
->code
>= 0x400 && event
->code
< 0x500)
5578 return modify_event_symbol (event
->code
- 0x400,
5579 event
->modifiers
& ~shift_modifier
,
5580 Qfunction_key
, Qnil
,
5581 lispy_kana_keys
, &func_key_syms
,
5582 ARRAYELTS (lispy_kana_keys
));
5583 #endif /* XK_kana_A */
5586 #ifdef ISO_FUNCTION_KEY_OFFSET
5587 if (event
->code
< FUNCTION_KEY_OFFSET
5588 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5589 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5591 Qfunction_key
, Qnil
,
5592 iso_lispy_function_keys
, &func_key_syms
,
5593 ARRAYELTS (iso_lispy_function_keys
));
5596 if ((FUNCTION_KEY_OFFSET
<= event
->code
5598 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5599 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5600 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5602 Qfunction_key
, Qnil
,
5603 lispy_function_keys
, &func_key_syms
,
5604 ARRAYELTS (lispy_function_keys
));
5606 /* Handle system-specific or unknown keysyms.
5607 We need to use an alist rather than a vector as the cache
5608 since we can't make a vector long enough. */
5609 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5610 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5611 return modify_event_symbol (event
->code
,
5614 KVAR (current_kboard
, Vsystem_key_alist
),
5615 0, &KVAR (current_kboard
, system_key_syms
),
5619 case MULTIMEDIA_KEY_EVENT
:
5620 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5621 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5623 return modify_event_symbol (event
->code
, event
->modifiers
,
5624 Qfunction_key
, Qnil
,
5625 lispy_multimedia_keys
, &func_key_syms
,
5626 ARRAYELTS (lispy_multimedia_keys
));
5631 /* A mouse click. Figure out where it is, decide whether it's
5632 a press, click or drag, and build the appropriate structure. */
5633 case MOUSE_CLICK_EVENT
:
5635 case GPM_CLICK_EVENT
:
5637 #ifndef USE_TOOLKIT_SCROLL_BARS
5638 case SCROLL_BAR_CLICK_EVENT
:
5639 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5642 int button
= event
->code
;
5644 Lisp_Object position
;
5645 Lisp_Object
*start_pos_ptr
;
5646 Lisp_Object start_pos
;
5650 /* Build the position as appropriate for this mouse click. */
5651 if (event
->kind
== MOUSE_CLICK_EVENT
5653 || event
->kind
== GPM_CLICK_EVENT
5657 struct frame
*f
= XFRAME (event
->frame_or_window
);
5660 /* Ignore mouse events that were made on frame that
5661 have been deleted. */
5662 if (! FRAME_LIVE_P (f
))
5665 /* EVENT->x and EVENT->y are frame-relative pixel
5666 coordinates at this place. Under old redisplay, COLUMN
5667 and ROW are set to frame relative glyph coordinates
5668 which are then used to determine whether this click is
5669 in a menu (non-toolkit version). */
5670 if (!toolkit_menubar_in_use (f
))
5672 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5673 &column
, &row
, NULL
, 1);
5675 /* In the non-toolkit version, clicks on the menu bar
5676 are ordinary button events in the event buffer.
5677 Distinguish them, and invoke the menu.
5679 (In the toolkit version, the toolkit handles the
5680 menu bar and Emacs doesn't know about it until
5681 after the user makes a selection.) */
5682 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5683 && (event
->modifiers
& down_modifier
))
5685 Lisp_Object items
, item
;
5687 /* Find the menu bar item under `column'. */
5689 items
= FRAME_MENU_BAR_ITEMS (f
);
5690 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5692 Lisp_Object pos
, string
;
5693 string
= AREF (items
, i
+ 1);
5694 pos
= AREF (items
, i
+ 3);
5697 if (column
>= XINT (pos
)
5698 && column
< XINT (pos
) + SCHARS (string
))
5700 item
= AREF (items
, i
);
5705 /* ELisp manual 2.4b says (x y) are window
5706 relative but code says they are
5708 position
= list4 (event
->frame_or_window
,
5710 Fcons (event
->x
, event
->y
),
5711 make_number (event
->timestamp
));
5713 return list2 (item
, position
);
5717 position
= make_lispy_position (f
, event
->x
, event
->y
,
5720 #ifndef USE_TOOLKIT_SCROLL_BARS
5722 /* It's a scrollbar click. */
5723 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5724 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5726 if (button
>= ASIZE (button_down_location
))
5728 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5729 button_down_location
= larger_vector (button_down_location
,
5731 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5734 start_pos_ptr
= aref_addr (button_down_location
, button
);
5735 start_pos
= *start_pos_ptr
;
5736 *start_pos_ptr
= Qnil
;
5739 /* On window-system frames, use the value of
5740 double-click-fuzz as is. On other frames, interpret it
5741 as a multiple of 1/8 characters. */
5745 if (WINDOWP (event
->frame_or_window
))
5746 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5747 else if (FRAMEP (event
->frame_or_window
))
5748 f
= XFRAME (event
->frame_or_window
);
5752 if (FRAME_WINDOW_P (f
))
5753 fuzz
= double_click_fuzz
;
5755 fuzz
= double_click_fuzz
/ 8;
5757 is_double
= (button
== last_mouse_button
5758 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5759 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5760 && button_down_time
!= 0
5761 && (EQ (Vdouble_click_time
, Qt
)
5762 || (NATNUMP (Vdouble_click_time
)
5763 && (event
->timestamp
- button_down_time
5764 < XFASTINT (Vdouble_click_time
)))));
5767 last_mouse_button
= button
;
5768 last_mouse_x
= XINT (event
->x
);
5769 last_mouse_y
= XINT (event
->y
);
5771 /* If this is a button press, squirrel away the location, so
5772 we can decide later whether it was a click or a drag. */
5773 if (event
->modifiers
& down_modifier
)
5777 double_click_count
++;
5778 event
->modifiers
|= ((double_click_count
> 2)
5783 double_click_count
= 1;
5784 button_down_time
= event
->timestamp
;
5785 *start_pos_ptr
= Fcopy_alist (position
);
5786 ignore_mouse_drag_p
= 0;
5789 /* Now we're releasing a button - check the co-ordinates to
5790 see if this was a click or a drag. */
5791 else if (event
->modifiers
& up_modifier
)
5793 /* If we did not see a down before this up, ignore the up.
5794 Probably this happened because the down event chose a
5795 menu item. It would be an annoyance to treat the
5796 release of the button that chose the menu item as a
5799 if (!CONSP (start_pos
))
5802 event
->modifiers
&= ~up_modifier
;
5805 Lisp_Object new_down
, down
;
5806 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5808 /* The third element of every position
5809 should be the (x,y) pair. */
5810 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5811 new_down
= Fcar (Fcdr (Fcdr (position
)));
5814 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5816 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5817 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5820 if (ignore_mouse_drag_p
)
5822 event
->modifiers
|= click_modifier
;
5823 ignore_mouse_drag_p
= 0;
5825 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5826 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5827 /* Maybe the mouse has moved a lot, caused scrolling, and
5828 eventually ended up at the same screen position (but
5829 not buffer position) in which case it is a drag, not
5831 /* FIXME: OTOH if the buffer position has changed
5832 because of a timer or process filter rather than
5833 because of mouse movement, it should be considered as
5834 a click. But mouse-drag-region completely ignores
5835 this case and it hasn't caused any real problem, so
5836 it's probably OK to ignore it as well. */
5837 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5838 /* Mouse hasn't moved (much). */
5839 event
->modifiers
|= click_modifier
;
5842 button_down_time
= 0;
5843 event
->modifiers
|= drag_modifier
;
5846 /* Don't check is_double; treat this as multiple
5847 if the down-event was multiple. */
5848 if (double_click_count
> 1)
5849 event
->modifiers
|= ((double_click_count
> 2)
5855 /* Every mouse event should either have the down_modifier or
5856 the up_modifier set. */
5860 /* Get the symbol we should use for the mouse click. */
5863 head
= modify_event_symbol (button
,
5865 Qmouse_click
, Vlispy_mouse_stem
,
5868 ASIZE (mouse_syms
));
5869 if (event
->modifiers
& drag_modifier
)
5870 return list3 (head
, start_pos
, position
);
5871 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5872 return list3 (head
, position
, make_number (double_click_count
));
5874 return list2 (head
, position
);
5879 case HORIZ_WHEEL_EVENT
:
5881 Lisp_Object position
;
5884 /* Build the position as appropriate for this mouse click. */
5885 struct frame
*f
= XFRAME (event
->frame_or_window
);
5887 /* Ignore wheel events that were made on frame that have been
5889 if (! FRAME_LIVE_P (f
))
5892 position
= make_lispy_position (f
, event
->x
, event
->y
,
5895 /* Set double or triple modifiers to indicate the wheel speed. */
5897 /* On window-system frames, use the value of
5898 double-click-fuzz as is. On other frames, interpret it
5899 as a multiple of 1/8 characters. */
5905 if (WINDOWP (event
->frame_or_window
))
5906 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5907 else if (FRAMEP (event
->frame_or_window
))
5908 fr
= XFRAME (event
->frame_or_window
);
5912 fuzz
= FRAME_WINDOW_P (fr
)
5913 ? double_click_fuzz
: double_click_fuzz
/ 8;
5915 if (event
->modifiers
& up_modifier
)
5917 /* Emit a wheel-up event. */
5918 event
->modifiers
&= ~up_modifier
;
5921 else if (event
->modifiers
& down_modifier
)
5923 /* Emit a wheel-down event. */
5924 event
->modifiers
&= ~down_modifier
;
5928 /* Every wheel event should either have the down_modifier or
5929 the up_modifier set. */
5932 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5935 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5936 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5937 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5938 && button_down_time
!= 0
5939 && (EQ (Vdouble_click_time
, Qt
)
5940 || (NATNUMP (Vdouble_click_time
)
5941 && (event
->timestamp
- button_down_time
5942 < XFASTINT (Vdouble_click_time
)))));
5945 double_click_count
++;
5946 event
->modifiers
|= ((double_click_count
> 2)
5952 double_click_count
= 1;
5953 event
->modifiers
|= click_modifier
;
5956 button_down_time
= event
->timestamp
;
5957 /* Use a negative value to distinguish wheel from mouse button. */
5958 last_mouse_button
= - (1 + symbol_num
);
5959 last_mouse_x
= XINT (event
->x
);
5960 last_mouse_y
= XINT (event
->y
);
5962 /* Get the symbol we should use for the wheel event. */
5963 head
= modify_event_symbol (symbol_num
,
5969 ASIZE (wheel_syms
));
5972 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5973 return list3 (head
, position
, make_number (double_click_count
));
5975 return list2 (head
, position
);
5979 #ifdef USE_TOOLKIT_SCROLL_BARS
5981 /* We don't have down and up events if using toolkit scroll bars,
5982 so make this always a click event. Store in the `part' of
5983 the Lisp event a symbol which maps to the following actions:
5985 `above_handle' page up
5986 `below_handle' page down
5990 `bottom' bottom of buffer
5991 `handle' thumb has been dragged.
5992 `end-scroll' end of interaction with scroll bar
5994 The incoming input_event contains in its `part' member an
5995 index of type `enum scroll_bar_part' which we can use as an
5996 index in scroll_bar_parts to get the appropriate symbol. */
5998 case SCROLL_BAR_CLICK_EVENT
:
6000 Lisp_Object position
, head
;
6002 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
6004 /* Always treat scroll bar events as clicks. */
6005 event
->modifiers
|= click_modifier
;
6006 event
->modifiers
&= ~up_modifier
;
6008 if (event
->code
>= ASIZE (mouse_syms
))
6009 mouse_syms
= larger_vector (mouse_syms
,
6010 event
->code
- ASIZE (mouse_syms
) + 1,
6013 /* Get the symbol we should use for the mouse click. */
6014 head
= modify_event_symbol (event
->code
,
6019 ASIZE (mouse_syms
));
6020 return list2 (head
, position
);
6023 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
6025 Lisp_Object position
, head
;
6027 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
6029 /* Always treat scroll bar events as clicks. */
6030 event
->modifiers
|= click_modifier
;
6031 event
->modifiers
&= ~up_modifier
;
6033 if (event
->code
>= ASIZE (mouse_syms
))
6034 mouse_syms
= larger_vector (mouse_syms
,
6035 event
->code
- ASIZE (mouse_syms
) + 1,
6038 /* Get the symbol we should use for the mouse click. */
6039 head
= modify_event_symbol (event
->code
,
6044 ASIZE (mouse_syms
));
6045 return list2 (head
, position
);
6048 #endif /* USE_TOOLKIT_SCROLL_BARS */
6050 case DRAG_N_DROP_EVENT
:
6053 Lisp_Object head
, position
;
6056 f
= XFRAME (event
->frame_or_window
);
6059 /* Ignore mouse events that were made on frames that
6060 have been deleted. */
6061 if (! FRAME_LIVE_P (f
))
6064 position
= make_lispy_position (f
, event
->x
, event
->y
,
6067 head
= modify_event_symbol (0, event
->modifiers
,
6069 lispy_drag_n_drop_names
,
6070 &drag_n_drop_syms
, 1);
6071 return list3 (head
, position
, files
);
6074 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6075 || defined (HAVE_NS) || defined (USE_GTK)
6076 case MENU_BAR_EVENT
:
6077 if (EQ (event
->arg
, event
->frame_or_window
))
6078 /* This is the prefix key. We translate this to
6079 `(menu_bar)' because the code in keyboard.c for menu
6080 events, which we use, relies on this. */
6081 return list1 (Qmenu_bar
);
6085 case SELECT_WINDOW_EVENT
:
6086 /* Make an event (select-window (WINDOW)). */
6087 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6089 case TOOL_BAR_EVENT
:
6090 if (EQ (event
->arg
, event
->frame_or_window
))
6091 /* This is the prefix key. We translate this to
6092 `(tool_bar)' because the code in keyboard.c for tool bar
6093 events, which we use, relies on this. */
6094 return list1 (Qtool_bar
);
6095 else if (SYMBOLP (event
->arg
))
6096 return apply_modifiers (event
->modifiers
, event
->arg
);
6099 case USER_SIGNAL_EVENT
:
6100 /* A user signal. */
6102 char *name
= find_user_signal_name (event
->code
);
6105 return intern (name
);
6108 case SAVE_SESSION_EVENT
:
6109 return Qsave_session
;
6114 return Fcons (Qdbus_event
, event
->arg
);
6116 #endif /* HAVE_DBUS */
6118 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6119 case FILE_NOTIFY_EVENT
:
6121 return Fcons (Qfile_notify
, event
->arg
);
6123 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6125 case CONFIG_CHANGED_EVENT
:
6126 return list3 (Qconfig_changed_event
,
6127 event
->arg
, event
->frame_or_window
);
6129 /* The 'kind' field of the event is something we don't recognize. */
6136 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6137 Lisp_Object x
, Lisp_Object y
, Time t
)
6139 /* Is it a scroll bar movement? */
6140 if (frame
&& ! NILP (bar_window
))
6142 Lisp_Object part_sym
;
6144 part_sym
= *scroll_bar_parts
[(int) part
];
6145 return list2 (Qscroll_bar_movement
,
6147 Qvertical_scroll_bar
,
6152 /* Or is it an ordinary mouse movement? */
6155 Lisp_Object position
;
6156 position
= make_lispy_position (frame
, x
, y
, t
);
6157 return list2 (Qmouse_movement
, position
);
6161 /* Construct a switch frame event. */
6163 make_lispy_switch_frame (Lisp_Object frame
)
6165 return list2 (Qswitch_frame
, frame
);
6169 make_lispy_focus_in (Lisp_Object frame
)
6171 return list2 (Qfocus_in
, frame
);
6174 #ifdef HAVE_WINDOW_SYSTEM
6177 make_lispy_focus_out (Lisp_Object frame
)
6179 return list2 (Qfocus_out
, frame
);
6182 #endif /* HAVE_WINDOW_SYSTEM */
6184 /* Manipulating modifiers. */
6186 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6188 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6189 SYMBOL's name of the end of the modifiers; the string from this
6190 position is the unmodified symbol name.
6192 This doesn't use any caches. */
6195 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6201 CHECK_SYMBOL (symbol
);
6204 name
= SYMBOL_NAME (symbol
);
6206 for (i
= 0; i
< SBYTES (name
) - 1; )
6208 ptrdiff_t this_mod_end
= 0;
6211 /* See if the name continues with a modifier word.
6212 Check that the word appears, but don't check what follows it.
6213 Set this_mod and this_mod_end to record what we find. */
6215 switch (SREF (name
, i
))
6217 #define SINGLE_LETTER_MOD(BIT) \
6218 (this_mod_end = i + 1, this_mod = BIT)
6221 SINGLE_LETTER_MOD (alt_modifier
);
6225 SINGLE_LETTER_MOD (ctrl_modifier
);
6229 SINGLE_LETTER_MOD (hyper_modifier
);
6233 SINGLE_LETTER_MOD (meta_modifier
);
6237 SINGLE_LETTER_MOD (shift_modifier
);
6241 SINGLE_LETTER_MOD (super_modifier
);
6244 #undef SINGLE_LETTER_MOD
6246 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6247 if (i + LEN + 1 <= SBYTES (name) \
6248 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6250 this_mod_end = i + LEN; \
6255 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6256 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6257 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6261 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6263 #undef MULTI_LETTER_MOD
6267 /* If we found no modifier, stop looking for them. */
6268 if (this_mod_end
== 0)
6271 /* Check there is a dash after the modifier, so that it
6272 really is a modifier. */
6273 if (this_mod_end
>= SBYTES (name
)
6274 || SREF (name
, this_mod_end
) != '-')
6277 /* This modifier is real; look for another. */
6278 modifiers
|= this_mod
;
6279 i
= this_mod_end
+ 1;
6282 /* Should we include the `click' modifier? */
6283 if (! (modifiers
& (down_modifier
| drag_modifier
6284 | double_modifier
| triple_modifier
))
6285 && i
+ 7 == SBYTES (name
)
6286 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6287 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6288 modifiers
|= click_modifier
;
6290 if (! (modifiers
& (double_modifier
| triple_modifier
))
6291 && i
+ 6 < SBYTES (name
)
6292 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6293 modifiers
|= click_modifier
;
6301 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6302 prepended to the string BASE[0..BASE_LEN-1].
6303 This doesn't use any caches. */
6305 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6307 /* Since BASE could contain nulls, we can't use intern here; we have
6308 to use Fintern, which expects a genuine Lisp_String, and keeps a
6310 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6316 /* Only the event queue may use the `up' modifier; it should always
6317 be turned into a click or drag event before presented to lisp code. */
6318 if (modifiers
& up_modifier
)
6321 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6322 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6323 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6324 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6325 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6326 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6327 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6328 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6329 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6330 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6331 /* The click modifier is denoted by the absence of other modifiers. */
6335 mod_len
= p
- new_mods
;
6339 Lisp_Object new_name
;
6341 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6342 mod_len
+ base_len_byte
);
6343 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6344 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6346 return Fintern (new_name
, Qnil
);
6351 static const char *const modifier_names
[] =
6353 "up", "down", "drag", "click", "double", "triple", 0, 0,
6354 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6355 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6357 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6359 static Lisp_Object modifier_symbols
;
6361 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6363 lispy_modifier_list (int modifiers
)
6365 Lisp_Object modifier_list
;
6368 modifier_list
= Qnil
;
6369 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6370 if (modifiers
& (1<<i
))
6371 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6374 return modifier_list
;
6378 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6379 where UNMODIFIED is the unmodified form of SYMBOL,
6380 MASK is the set of modifiers present in SYMBOL's name.
6381 This is similar to parse_modifiers_uncached, but uses the cache in
6382 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6383 Qevent_symbol_elements property. */
6385 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6388 parse_modifiers (Lisp_Object symbol
)
6390 Lisp_Object elements
;
6392 if (INTEGERP (symbol
))
6393 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6394 else if (!SYMBOLP (symbol
))
6397 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6398 if (CONSP (elements
))
6403 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6404 Lisp_Object unmodified
;
6407 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6408 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6411 if (modifiers
& ~INTMASK
)
6413 XSETFASTINT (mask
, modifiers
);
6414 elements
= list2 (unmodified
, mask
);
6416 /* Cache the parsing results on SYMBOL. */
6417 Fput (symbol
, Qevent_symbol_element_mask
,
6419 Fput (symbol
, Qevent_symbol_elements
,
6420 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6422 /* Since we know that SYMBOL is modifiers applied to unmodified,
6423 it would be nice to put that in unmodified's cache.
6424 But we can't, since we're not sure that parse_modifiers is
6431 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6432 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6433 doc
: /* Parse the event symbol. For internal use. */)
6434 (Lisp_Object symbol
)
6436 /* Fill the cache if needed. */
6437 parse_modifiers (symbol
);
6438 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6439 and use the Lispier representation stored on Qevent_symbol_elements
6441 return Fget (symbol
, Qevent_symbol_elements
);
6444 /* Apply the modifiers MODIFIERS to the symbol BASE.
6445 BASE must be unmodified.
6447 This is like apply_modifiers_uncached, but uses BASE's
6448 Qmodifier_cache property, if present. It also builds
6449 Qevent_symbol_elements properties, since it has that info anyway.
6451 apply_modifiers copies the value of BASE's Qevent_kind property to
6452 the modified symbol. */
6454 apply_modifiers (int modifiers
, Lisp_Object base
)
6456 Lisp_Object cache
, idx
, entry
, new_symbol
;
6458 /* Mask out upper bits. We don't know where this value's been. */
6459 modifiers
&= INTMASK
;
6461 if (INTEGERP (base
))
6462 return make_number (XINT (base
) | modifiers
);
6464 /* The click modifier never figures into cache indices. */
6465 cache
= Fget (base
, Qmodifier_cache
);
6466 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6467 entry
= assq_no_quit (idx
, cache
);
6470 new_symbol
= XCDR (entry
);
6473 /* We have to create the symbol ourselves. */
6474 new_symbol
= apply_modifiers_uncached (modifiers
,
6475 SSDATA (SYMBOL_NAME (base
)),
6476 SCHARS (SYMBOL_NAME (base
)),
6477 SBYTES (SYMBOL_NAME (base
)));
6479 /* Add the new symbol to the base's cache. */
6480 entry
= Fcons (idx
, new_symbol
);
6481 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6483 /* We have the parsing info now for free, so we could add it to
6485 XSETFASTINT (idx, modifiers);
6486 Fput (new_symbol, Qevent_symbol_element_mask,
6488 Fput (new_symbol, Qevent_symbol_elements,
6489 Fcons (base, lispy_modifier_list (modifiers)));
6490 Sadly, this is only correct if `base' is indeed a base event,
6491 which is not necessarily the case. -stef */
6494 /* Make sure this symbol is of the same kind as BASE.
6496 You'd think we could just set this once and for all when we
6497 intern the symbol above, but reorder_modifiers may call us when
6498 BASE's property isn't set right; we can't assume that just
6499 because it has a Qmodifier_cache property it must have its
6500 Qevent_kind set right as well. */
6501 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6505 kind
= Fget (base
, Qevent_kind
);
6507 Fput (new_symbol
, Qevent_kind
, kind
);
6514 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6515 return a symbol with the modifiers placed in the canonical order.
6516 Canonical order is alphabetical, except for down and drag, which
6517 always come last. The 'click' modifier is never written out.
6519 Fdefine_key calls this to make sure that (for example) C-M-foo
6520 and M-C-foo end up being equivalent in the keymap. */
6523 reorder_modifiers (Lisp_Object symbol
)
6525 /* It's hopefully okay to write the code this way, since everything
6526 will soon be in caches, and no consing will be done at all. */
6529 parsed
= parse_modifiers (symbol
);
6530 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6535 /* For handling events, we often want to produce a symbol whose name
6536 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6537 to some base, like the name of a function key or mouse button.
6538 modify_event_symbol produces symbols of this sort.
6540 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6541 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6544 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6545 into symbol names, or a string specifying a name stem used to
6546 construct a symbol name or the form `STEM-N', where N is the decimal
6547 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6548 non-nil; otherwise NAME_TABLE is used.
6550 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6551 persist between calls to modify_event_symbol that it can use to
6552 store a cache of the symbols it's generated for this NAME_TABLE
6553 before. The object stored there may be a vector or an alist.
6555 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6557 MODIFIERS is a set of modifier bits (as given in struct input_events)
6558 whose prefixes should be applied to the symbol name.
6560 SYMBOL_KIND is the value to be placed in the event_kind property of
6561 the returned symbol.
6563 The symbols we create are supposed to have an
6564 `event-symbol-elements' property, which lists the modifiers present
6565 in the symbol's name. */
6568 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6569 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6570 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6573 Lisp_Object symbol_int
;
6575 /* Get rid of the "vendor-specific" bit here. */
6576 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6578 /* Is this a request for a valid symbol? */
6579 if (symbol_num
< 0 || symbol_num
>= table_size
)
6582 if (CONSP (*symbol_table
))
6583 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6585 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6586 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6587 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6588 we've never used that symbol before. */
6591 if (! VECTORP (*symbol_table
)
6592 || ASIZE (*symbol_table
) != table_size
)
6596 XSETFASTINT (size
, table_size
);
6597 *symbol_table
= Fmake_vector (size
, Qnil
);
6600 value
= AREF (*symbol_table
, symbol_num
);
6603 /* Have we already used this symbol before? */
6606 /* No; let's create it. */
6607 if (CONSP (name_alist_or_stem
))
6608 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6609 else if (STRINGP (name_alist_or_stem
))
6612 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6613 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6615 buf
= SAFE_ALLOCA (len
);
6616 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6617 XINT (symbol_int
) + 1);
6618 value
= intern (buf
);
6621 else if (name_table
!= 0 && name_table
[symbol_num
])
6622 value
= intern (name_table
[symbol_num
]);
6624 #ifdef HAVE_WINDOW_SYSTEM
6627 char *name
= x_get_keysym_name (symbol_num
);
6629 value
= intern (name
);
6635 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6636 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6637 value
= intern (buf
);
6640 if (CONSP (*symbol_table
))
6641 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6643 ASET (*symbol_table
, symbol_num
, value
);
6645 /* Fill in the cache entries for this symbol; this also
6646 builds the Qevent_symbol_elements property, which the user
6648 apply_modifiers (modifiers
& click_modifier
, value
);
6649 Fput (value
, Qevent_kind
, symbol_kind
);
6652 /* Apply modifiers to that symbol. */
6653 return apply_modifiers (modifiers
, value
);
6656 /* Convert a list that represents an event type,
6657 such as (ctrl meta backspace), into the usual representation of that
6658 event type as a number or a symbol. */
6660 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6661 doc
: /* Convert the event description list EVENT-DESC to an event type.
6662 EVENT-DESC should contain one base event type (a character or symbol)
6663 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6664 drag, down, double or triple). The base must be last.
6665 The return value is an event type (a character or symbol) which
6666 has the same base event type and all the specified modifiers. */)
6667 (Lisp_Object event_desc
)
6675 while (CONSP (rest
))
6683 /* Given a symbol, see if it is a modifier name. */
6684 if (SYMBOLP (elt
) && CONSP (rest
))
6685 this = parse_solitary_modifier (elt
);
6689 else if (!NILP (base
))
6690 error ("Two bases given in one event");
6696 /* Let the symbol A refer to the character A. */
6697 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6698 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6700 if (INTEGERP (base
))
6702 /* Turn (shift a) into A. */
6703 if ((modifiers
& shift_modifier
) != 0
6704 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6706 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6707 modifiers
&= ~shift_modifier
;
6710 /* Turn (control a) into C-a. */
6711 if (modifiers
& ctrl_modifier
)
6712 return make_number ((modifiers
& ~ctrl_modifier
)
6713 | make_ctrl_char (XINT (base
)));
6715 return make_number (modifiers
| XINT (base
));
6717 else if (SYMBOLP (base
))
6718 return apply_modifiers (modifiers
, base
);
6720 error ("Invalid base event");
6723 /* Try to recognize SYMBOL as a modifier name.
6724 Return the modifier flag bit, or 0 if not recognized. */
6727 parse_solitary_modifier (Lisp_Object symbol
)
6729 Lisp_Object name
= SYMBOL_NAME (symbol
);
6731 switch (SREF (name
, 0))
6733 #define SINGLE_LETTER_MOD(BIT) \
6734 if (SBYTES (name) == 1) \
6737 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6738 if (LEN == SBYTES (name) \
6739 && ! memcmp (SDATA (name), NAME, LEN)) \
6743 SINGLE_LETTER_MOD (alt_modifier
);
6747 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6751 SINGLE_LETTER_MOD (ctrl_modifier
);
6755 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6756 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6760 SINGLE_LETTER_MOD (hyper_modifier
);
6764 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6768 SINGLE_LETTER_MOD (meta_modifier
);
6772 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6776 SINGLE_LETTER_MOD (shift_modifier
);
6780 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6781 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6782 SINGLE_LETTER_MOD (super_modifier
);
6786 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6787 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6788 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6792 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6795 #undef SINGLE_LETTER_MOD
6796 #undef MULTI_LETTER_MOD
6802 /* Return true if EVENT is a list whose elements are all integers or symbols.
6803 Such a list is not valid as an event,
6804 but it can be a Lucid-style event type list. */
6807 lucid_event_type_list_p (Lisp_Object object
)
6811 if (! CONSP (object
))
6814 if (EQ (XCAR (object
), Qhelp_echo
)
6815 || EQ (XCAR (object
), Qvertical_line
)
6816 || EQ (XCAR (object
), Qmode_line
)
6817 || EQ (XCAR (object
), Qheader_line
))
6820 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6824 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6831 /* Return true if terminal input chars are available.
6832 Also, store the return value into INPUT_PENDING.
6834 Serves the purpose of ioctl (0, FIONREAD, ...)
6835 but works even if FIONREAD does not exist.
6836 (In fact, this may actually read some input.)
6838 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6839 timer events that are ripe.
6840 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6841 events (FOCUS_IN_EVENT).
6842 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6843 movements and toolkit scroll bar thumb drags. */
6846 get_input_pending (int flags
)
6848 /* First of all, have we already counted some input? */
6849 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6851 /* If input is being read as it arrives, and we have none, there is none. */
6852 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6854 /* Try to read some input and see how much we get. */
6856 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6859 return input_pending
;
6862 /* Put a BUFFER_SWITCH_EVENT in the buffer
6863 so that read_key_sequence will notice the new current buffer. */
6866 record_asynch_buffer_change (void)
6868 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6869 The purpose of the event is to make read_key_sequence look up the
6870 keymaps again. If we aren't in read_key_sequence, we don't need one,
6871 and the event could cause trouble by messing up (input-pending-p).
6872 Note: Fwaiting_for_user_input_p always returns nil when async
6873 subprocesses aren't supported. */
6874 if (!NILP (Fwaiting_for_user_input_p ()))
6876 struct input_event event
;
6879 event
.kind
= BUFFER_SWITCH_EVENT
;
6880 event
.frame_or_window
= Qnil
;
6883 /* Make sure no interrupt happens while storing the event. */
6885 if (interrupt_input
)
6886 kbd_buffer_store_event (&event
);
6891 kbd_buffer_store_event (&event
);
6897 /* Read any terminal input already buffered up by the system
6898 into the kbd_buffer, but do not wait.
6900 Return the number of keyboard chars read, or -1 meaning
6901 this is a bad time to try to read input. */
6910 /* Store pending user signal events, if any. */
6911 store_user_signal_events ();
6913 /* Loop through the available terminals, and call their input hooks. */
6917 struct terminal
*next
= t
->next_terminal
;
6919 if (t
->read_socket_hook
)
6922 struct input_event hold_quit
;
6924 if (input_blocked_p ())
6926 pending_signals
= 1;
6930 EVENT_INIT (hold_quit
);
6931 hold_quit
.kind
= NO_EVENT
;
6933 /* No need for FIONREAD or fcntl; just say don't wait. */
6934 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6937 if (nr
== -1) /* Not OK to read input now. */
6941 else if (nr
== -2) /* Non-transient error. */
6943 /* The terminal device terminated; it should be closed. */
6945 /* Kill Emacs if this was our last terminal. */
6946 if (!terminal_list
->next_terminal
)
6947 /* Formerly simply reported no input, but that
6948 sometimes led to a failure of Emacs to terminate.
6949 SIGHUP seems appropriate if we can't reach the
6951 /* ??? Is it really right to send the signal just to
6952 this process rather than to the whole process
6953 group? Perhaps on systems with FIONREAD Emacs is
6954 alone in its group. */
6955 terminate_due_to_signal (SIGHUP
, 10);
6957 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6960 XSETTERMINAL (tmp
, t
);
6961 Fdelete_terminal (tmp
, Qnoelisp
);
6965 /* If there was no error, make sure the pointer
6966 is visible for all frames on this terminal. */
6969 Lisp_Object tail
, frame
;
6971 FOR_EACH_FRAME (tail
, frame
)
6973 struct frame
*f
= XFRAME (frame
);
6974 if (FRAME_TERMINAL (f
) == t
)
6975 frame_make_pointer_visible (f
);
6979 if (hold_quit
.kind
!= NO_EVENT
)
6980 kbd_buffer_store_event (&hold_quit
);
6992 /* This is the tty way of reading available input.
6994 Note that each terminal device has its own `struct terminal' object,
6995 and so this function is called once for each individual termcap
6996 terminal. The first parameter indicates which terminal to read from. */
6999 tty_read_avail_input (struct terminal
*terminal
,
7000 struct input_event
*hold_quit
)
7002 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
7003 the kbd_buffer can really hold. That may prevent loss
7004 of characters on some systems when input is stuffed at us. */
7005 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
7007 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
7010 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
7012 if (kbd_on_hold_p () || buffer_free
<= 0)
7014 #endif /* subprocesses */
7016 if (!terminal
->name
) /* Don't read from a dead terminal. */
7019 if (terminal
->type
!= output_termcap
7020 && terminal
->type
!= output_msdos_raw
)
7023 /* XXX I think the following code should be moved to separate hook
7024 functions in system-dependent files. */
7026 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
7027 code sets read_socket_hook to w32_console_read_socket instead! */
7029 #else /* not WINDOWSNT */
7030 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7034 return 0; /* The terminal is suspended. */
7037 n_to_read
= dos_keysns ();
7041 cbuf
[0] = dos_keyread ();
7044 #else /* not MSDOS */
7049 struct input_event gpm_hold_quit
;
7050 int gpm
, fd
= gpm_fd
;
7052 EVENT_INIT (gpm_hold_quit
);
7053 gpm_hold_quit
.kind
= NO_EVENT
;
7055 /* gpm==1 if event received.
7056 gpm==0 if the GPM daemon has closed the connection, in which case
7057 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7058 we save it in `fd' so close_gpm can remove it from the
7060 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7061 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7062 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7065 /* Presumably the GPM daemon has closed the connection. */
7067 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7068 kbd_buffer_store_event (&gpm_hold_quit
);
7072 #endif /* HAVE_GPM */
7074 /* Determine how many characters we should *try* to read. */
7075 #ifdef USABLE_FIONREAD
7076 /* Find out how much input is available. */
7077 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7079 if (! noninteractive
)
7080 return -2; /* Close this terminal. */
7086 if (n_to_read
> sizeof cbuf
)
7087 n_to_read
= sizeof cbuf
;
7088 #elif defined USG || defined CYGWIN
7089 /* Read some input if available, but don't wait. */
7090 n_to_read
= sizeof cbuf
;
7091 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7093 # error "Cannot read without possibly delaying"
7097 /* Don't read more than we can store. */
7098 if (n_to_read
> buffer_free
)
7099 n_to_read
= buffer_free
;
7100 #endif /* subprocesses */
7102 /* Now read; for one reason or another, this will not block.
7103 NREAD is set to the number of chars read. */
7106 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7107 /* POSIX infers that processes which are not in the session leader's
7108 process group won't get SIGHUPs at logout time. BSDI adheres to
7109 this part standard and returns -1 from read (0) with errno==EIO
7110 when the control tty is taken away.
7111 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7112 if (nread
== -1 && errno
== EIO
)
7113 return -2; /* Close this terminal. */
7114 #if defined (AIX) && defined (_BSD)
7115 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7116 This looks incorrect, but it isn't, because _BSD causes
7117 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7118 and that causes a value other than 0 when there is no input. */
7120 return -2; /* Close this terminal. */
7124 /* We used to retry the read if it was interrupted.
7125 But this does the wrong thing when O_NONBLOCK causes
7126 an EAGAIN error. Does anybody know of a situation
7127 where a retry is actually needed? */
7129 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7139 #ifndef USABLE_FIONREAD
7140 #if defined (USG) || defined (CYGWIN)
7141 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7142 #endif /* USG or CYGWIN */
7143 #endif /* no FIONREAD */
7148 #endif /* not MSDOS */
7149 #endif /* not WINDOWSNT */
7151 for (i
= 0; i
< nread
; i
++)
7153 struct input_event buf
;
7155 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7157 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7158 buf
.modifiers
= meta_modifier
;
7159 if (tty
->meta_key
!= 2)
7163 /* Set the frame corresponding to the active tty. Note that the
7164 value of selected_frame is not reliable here, redisplay tends
7165 to temporarily change it. */
7166 buf
.frame_or_window
= tty
->top_frame
;
7169 kbd_buffer_store_event (&buf
);
7170 /* Don't look at input that follows a C-g too closely.
7171 This reduces lossage due to autorepeat on C-g. */
7172 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7173 && buf
.code
== quit_char
)
7181 handle_async_input (void)
7186 int nread
= gobble_input ();
7187 /* -1 means it's not ok to read the input now.
7188 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7189 0 means there was no keyboard input available. */
7197 process_pending_signals (void)
7199 pending_signals
= 0;
7200 handle_async_input ();
7201 do_pending_atimers ();
7204 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7205 and reinvoke any pending signal if the level is now 0 and
7206 a fatal error is not already in progress. */
7209 unblock_input_to (int level
)
7211 interrupt_input_blocked
= level
;
7214 if (pending_signals
&& !fatal_error_in_progress
)
7215 process_pending_signals ();
7221 /* End critical section.
7223 If doing signal-driven input, and a signal came in when input was
7224 blocked, reinvoke the signal handler now to deal with it.
7226 It will also process queued input, if it was not read before.
7227 When a longer code sequence does not use block/unblock input
7228 at all, the whole input gathered up to the next call to
7229 unblock_input will be processed inside that call. */
7232 unblock_input (void)
7234 unblock_input_to (interrupt_input_blocked
- 1);
7237 /* Undo any number of BLOCK_INPUT calls,
7238 and also reinvoke any pending signal. */
7241 totally_unblock_input (void)
7243 unblock_input_to (0);
7249 handle_input_available_signal (int sig
)
7251 pending_signals
= 1;
7253 if (input_available_clear_time
)
7254 *input_available_clear_time
= make_timespec (0, 0);
7258 deliver_input_available_signal (int sig
)
7260 deliver_process_signal (sig
, handle_input_available_signal
);
7262 #endif /* USABLE_SIGIO */
7265 /* User signal events. */
7267 struct user_signal_info
7269 /* Signal number. */
7272 /* Name of the signal. */
7275 /* Number of pending signals. */
7278 struct user_signal_info
*next
;
7281 /* List of user signals. */
7282 static struct user_signal_info
*user_signals
= NULL
;
7285 add_user_signal (int sig
, const char *name
)
7287 struct sigaction action
;
7288 struct user_signal_info
*p
;
7290 for (p
= user_signals
; p
; p
= p
->next
)
7292 /* Already added. */
7295 p
= xmalloc (sizeof *p
);
7297 p
->name
= xstrdup (name
);
7299 p
->next
= user_signals
;
7302 emacs_sigaction_init (&action
, deliver_user_signal
);
7303 sigaction (sig
, &action
, 0);
7307 handle_user_signal (int sig
)
7309 struct user_signal_info
*p
;
7310 const char *special_event_name
= NULL
;
7312 if (SYMBOLP (Vdebug_on_event
))
7313 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7315 for (p
= user_signals
; p
; p
= p
->next
)
7318 if (special_event_name
7319 && strcmp (special_event_name
, p
->name
) == 0)
7321 /* Enter the debugger in many ways. */
7322 debug_on_next_call
= 1;
7325 Vinhibit_quit
= Qnil
;
7327 /* Eat the event. */
7333 if (interrupt_input
)
7334 handle_input_available_signal (sig
);
7338 /* Tell wait_reading_process_output that it needs to wake
7339 up and look around. */
7340 if (input_available_clear_time
)
7341 *input_available_clear_time
= make_timespec (0, 0);
7348 deliver_user_signal (int sig
)
7350 deliver_process_signal (sig
, handle_user_signal
);
7354 find_user_signal_name (int sig
)
7356 struct user_signal_info
*p
;
7358 for (p
= user_signals
; p
; p
= p
->next
)
7366 store_user_signal_events (void)
7368 struct user_signal_info
*p
;
7369 struct input_event buf
;
7370 bool buf_initialized
= 0;
7372 for (p
= user_signals
; p
; p
= p
->next
)
7373 if (p
->npending
> 0)
7375 if (! buf_initialized
)
7377 memset (&buf
, 0, sizeof buf
);
7378 buf
.kind
= USER_SIGNAL_EVENT
;
7379 buf
.frame_or_window
= selected_frame
;
7380 buf_initialized
= 1;
7386 kbd_buffer_store_event (&buf
);
7389 while (p
->npending
> 0);
7394 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7395 static Lisp_Object menu_bar_one_keymap_changed_items
;
7397 /* These variables hold the vector under construction within
7398 menu_bar_items and its subroutines, and the current index
7399 for storing into that vector. */
7400 static Lisp_Object menu_bar_items_vector
;
7401 static int menu_bar_items_index
;
7404 static const char *separator_names
[] = {
7409 "single-dashed-line",
7410 "double-dashed-line",
7412 "shadow-etched-out",
7413 "shadow-etched-in-dash",
7414 "shadow-etched-out-dash",
7415 "shadow-double-etched-in",
7416 "shadow-double-etched-out",
7417 "shadow-double-etched-in-dash",
7418 "shadow-double-etched-out-dash",
7422 /* Return true if LABEL specifies a separator. */
7425 menu_separator_name_p (const char *label
)
7429 else if (strlen (label
) > 3
7430 && memcmp (label
, "--", 2) == 0
7435 for (i
= 0; separator_names
[i
]; ++i
)
7436 if (strcmp (label
, separator_names
[i
]) == 0)
7441 /* It's a separator if it contains only dashes. */
7442 while (*label
== '-')
7444 return (*label
== 0);
7451 /* Return a vector of menu items for a menu bar, appropriate
7452 to the current buffer. Each item has three elements in the vector:
7455 OLD is an old vector we can optionally reuse, or nil. */
7458 menu_bar_items (Lisp_Object old
)
7460 /* The number of keymaps we're scanning right now, and the number of
7461 keymaps we have allocated space for. */
7464 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7465 in the current keymaps, or nil where it is not a prefix. */
7468 Lisp_Object mapsbuf
[3];
7469 Lisp_Object def
, tail
;
7476 /* In order to build the menus, we need to call the keymap
7477 accessors. They all call QUIT. But this function is called
7478 during redisplay, during which a quit is fatal. So inhibit
7479 quitting while building the menus.
7480 We do this instead of specbind because (1) errors will clear it anyway
7481 and (2) this avoids risk of specpdl overflow. */
7482 oquit
= Vinhibit_quit
;
7486 menu_bar_items_vector
= old
;
7488 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7489 menu_bar_items_index
= 0;
7491 /* Build our list of keymaps.
7492 If we recognize a function key and replace its escape sequence in
7493 keybuf with its symbol, or if the sequence starts with a mouse
7494 click and we need to switch buffers, we jump back here to rebuild
7495 the initial keymaps from the current buffer. */
7499 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7500 if (!NILP (Voverriding_local_map_menu_flag
)
7501 && !NILP (Voverriding_local_map
))
7503 /* Yes, use them (if non-nil) as well as the global map. */
7506 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7507 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7508 if (!NILP (Voverriding_local_map
))
7509 maps
[nmaps
++] = Voverriding_local_map
;
7513 /* No, so use major and minor mode keymaps and keymap property.
7514 Note that menu-bar bindings in the local-map and keymap
7515 properties may not work reliable, as they are only
7516 recognized when the menu-bar (or mode-line) is updated,
7517 which does not normally happen after every command. */
7520 nminor
= current_minor_maps (NULL
, &tmaps
);
7521 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7523 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7524 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7525 maps
[nmaps
++] = tem
;
7526 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7527 maps
[nmaps
++] = tem
;
7528 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7530 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7532 maps
[nmaps
++] = current_global_map
;
7535 /* Look up in each map the dummy prefix key `menu-bar'. */
7537 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7538 if (!NILP (maps
[mapno
]))
7540 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7544 menu_bar_one_keymap_changed_items
= Qnil
;
7545 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7549 /* Move to the end those items that should be at the end. */
7551 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7554 int end
= menu_bar_items_index
;
7556 for (i
= 0; i
< end
; i
+= 4)
7557 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7559 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7560 /* Move the item at index I to the end,
7561 shifting all the others forward. */
7562 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7563 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7564 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7565 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7567 memmove (aref_addr (menu_bar_items_vector
, i
),
7568 aref_addr (menu_bar_items_vector
, i
+ 4),
7569 (end
- i
- 4) * word_size
);
7570 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7571 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7572 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7573 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7578 /* Add nil, nil, nil, nil at the end. */
7580 int i
= menu_bar_items_index
;
7581 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7582 menu_bar_items_vector
7583 = larger_vector (menu_bar_items_vector
, 4, -1);
7584 /* Add this item. */
7585 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7586 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7587 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7588 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7589 menu_bar_items_index
= i
;
7592 Vinhibit_quit
= oquit
;
7594 return menu_bar_items_vector
;
7597 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7598 If there's already an item for KEY, add this DEF to it. */
7600 Lisp_Object item_properties
;
7603 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7605 struct gcpro gcpro1
;
7610 if (EQ (item
, Qundefined
))
7612 /* If a map has an explicit `undefined' as definition,
7613 discard any previously made menu bar item. */
7615 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7616 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7618 if (menu_bar_items_index
> i
+ 4)
7619 memmove (aref_addr (menu_bar_items_vector
, i
),
7620 aref_addr (menu_bar_items_vector
, i
+ 4),
7621 (menu_bar_items_index
- i
- 4) * word_size
);
7622 menu_bar_items_index
-= 4;
7626 /* If this keymap has already contributed to this KEY,
7627 don't contribute to it a second time. */
7628 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7629 if (!NILP (tem
) || NILP (item
))
7632 menu_bar_one_keymap_changed_items
7633 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7635 /* We add to menu_bar_one_keymap_changed_items before doing the
7636 parse_menu_item, so that if it turns out it wasn't a menu item,
7637 it still correctly hides any further menu item. */
7639 parsed
= parse_menu_item (item
, 1);
7644 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7646 /* Find any existing item for this KEY. */
7647 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7648 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7651 /* If we did not find this KEY, add it at the end. */
7652 if (i
== menu_bar_items_index
)
7654 /* If vector is too small, get a bigger one. */
7655 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7656 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7657 /* Add this item. */
7658 ASET (menu_bar_items_vector
, i
, key
); i
++;
7659 ASET (menu_bar_items_vector
, i
,
7660 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7661 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7662 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7663 menu_bar_items_index
= i
;
7665 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7669 old
= AREF (menu_bar_items_vector
, i
+ 2);
7670 /* If the new and the old items are not both keymaps,
7671 the lookup will only find `item'. */
7672 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7673 ASET (menu_bar_items_vector
, i
+ 2, item
);
7677 /* This is used as the handler when calling menu_item_eval_property. */
7679 menu_item_eval_property_1 (Lisp_Object arg
)
7681 /* If we got a quit from within the menu computation,
7682 quit all the way out of it. This takes care of C-] in the debugger. */
7683 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7684 Fsignal (Qquit
, Qnil
);
7690 eval_dyn (Lisp_Object form
)
7692 return Feval (form
, Qnil
);
7695 /* Evaluate an expression and return the result (or nil if something
7696 went wrong). Used to evaluate dynamic parts of menu items. */
7698 menu_item_eval_property (Lisp_Object sexpr
)
7700 ptrdiff_t count
= SPECPDL_INDEX ();
7702 specbind (Qinhibit_redisplay
, Qt
);
7703 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7704 menu_item_eval_property_1
);
7705 return unbind_to (count
, val
);
7708 /* This function parses a menu item and leaves the result in the
7709 vector item_properties.
7710 ITEM is a key binding, a possible menu item.
7711 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7713 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7714 parse_menu_item returns true if the item is a menu item and false
7718 parse_menu_item (Lisp_Object item
, int inmenubar
)
7720 Lisp_Object def
, tem
, item_string
, start
;
7722 Lisp_Object keyhint
;
7731 /* Create item_properties vector if necessary. */
7732 if (NILP (item_properties
))
7734 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7736 /* Initialize optional entries. */
7737 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7738 ASET (item_properties
, i
, Qnil
);
7739 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7741 /* Save the item here to protect it from GC. */
7742 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7744 item_string
= XCAR (item
);
7748 if (STRINGP (item_string
))
7750 /* Old format menu item. */
7751 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7753 /* Maybe help string. */
7754 if (CONSP (item
) && STRINGP (XCAR (item
)))
7756 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7761 /* Maybe an obsolete key binding cache. */
7762 if (CONSP (item
) && CONSP (XCAR (item
))
7763 && (NILP (XCAR (XCAR (item
)))
7764 || VECTORP (XCAR (XCAR (item
)))))
7767 /* This is the real definition--the function to run. */
7768 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7770 /* Get enable property, if any. */
7773 tem
= Fget (item
, Qmenu_enable
);
7774 if (!NILP (Venable_disabled_menus_and_buttons
))
7775 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7776 else if (!NILP (tem
))
7777 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7780 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7782 /* New format menu item. */
7783 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7784 start
= XCDR (item
);
7787 /* We have a real binding. */
7788 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7790 item
= XCDR (start
);
7791 /* Is there an obsolete cache list with key equivalences. */
7792 if (CONSP (item
) && CONSP (XCAR (item
)))
7795 /* Parse properties. */
7796 while (CONSP (item
) && CONSP (XCDR (item
)))
7801 if (EQ (tem
, QCenable
))
7803 if (!NILP (Venable_disabled_menus_and_buttons
))
7804 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7806 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7808 else if (EQ (tem
, QCvisible
))
7810 /* If got a visible property and that evaluates to nil
7811 then ignore this item. */
7812 tem
= menu_item_eval_property (XCAR (item
));
7816 else if (EQ (tem
, QChelp
))
7817 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7818 else if (EQ (tem
, QCfilter
))
7820 else if (EQ (tem
, QCkey_sequence
))
7823 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7824 /* Be GC protected. Set keyhint to item instead of tem. */
7827 else if (EQ (tem
, QCkeys
))
7830 if (CONSP (tem
) || STRINGP (tem
))
7831 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7833 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7838 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7840 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7842 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7848 else if (inmenubar
|| !NILP (start
))
7852 return 0; /* not a menu item */
7854 /* If item string is not a string, evaluate it to get string.
7855 If we don't get a string, skip this item. */
7856 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7857 if (!(STRINGP (item_string
)))
7859 item_string
= menu_item_eval_property (item_string
);
7860 if (!STRINGP (item_string
))
7862 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7865 /* If got a filter apply it on definition. */
7866 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7869 def
= menu_item_eval_property (list2 (XCAR (filter
),
7870 list2 (Qquote
, def
)));
7872 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7875 /* Enable or disable selection of item. */
7876 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7879 tem
= menu_item_eval_property (tem
);
7880 if (inmenubar
&& NILP (tem
))
7881 return 0; /* Ignore disabled items in menu bar. */
7882 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7885 /* If we got no definition, this item is just unselectable text which
7886 is OK in a submenu but not in the menubar. */
7888 return (!inmenubar
);
7890 /* See if this is a separate pane or a submenu. */
7891 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7892 tem
= get_keymap (def
, 0, 1);
7893 /* For a subkeymap, just record its details and exit. */
7896 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7897 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7901 /* At the top level in the menu bar, do likewise for commands also.
7902 The menu bar does not display equivalent key bindings anyway.
7903 ITEM_PROPERTY_DEF is already set up properly. */
7907 { /* This is a command. See if there is an equivalent key binding. */
7908 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7909 AUTO_STRING (space_space
, " ");
7911 /* The previous code preferred :key-sequence to :keys, so we
7912 preserve this behavior. */
7913 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7914 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7917 Lisp_Object prefix
= keyeq
;
7918 Lisp_Object keys
= Qnil
;
7922 def
= XCAR (prefix
);
7923 prefix
= XCDR (prefix
);
7926 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7928 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7930 keys
= XCAR (keyhint
);
7931 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7933 /* We have a suggested key. Is it bound to the command? */
7936 /* If the command is an alias for another
7937 (such as lmenu.el set it up), check if the
7938 original command matches the cached command. */
7940 && EQ (tem
, XSYMBOL (def
)->function
))))
7945 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7949 tem
= Fkey_description (keys
, Qnil
);
7952 if (STRINGP (XCAR (prefix
)))
7953 tem
= concat2 (XCAR (prefix
), tem
);
7954 if (STRINGP (XCDR (prefix
)))
7955 tem
= concat2 (tem
, XCDR (prefix
));
7957 keyeq
= concat2 (space_space
, tem
);
7963 /* If we have an equivalent key binding, use that. */
7964 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7967 /* Include this when menu help is implemented.
7968 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7969 if (!(NILP (tem) || STRINGP (tem)))
7971 tem = menu_item_eval_property (tem);
7974 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7978 /* Handle radio buttons or toggle boxes. */
7979 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7981 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7982 menu_item_eval_property (tem
));
7989 /***********************************************************************
7991 ***********************************************************************/
7993 /* A vector holding tool bar items while they are parsed in function
7994 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7997 static Lisp_Object tool_bar_items_vector
;
7999 /* A vector holding the result of parse_tool_bar_item. Layout is like
8000 the one for a single item in tool_bar_items_vector. */
8002 static Lisp_Object tool_bar_item_properties
;
8004 /* Next free index in tool_bar_items_vector. */
8006 static int ntool_bar_items
;
8008 /* The symbols `:image' and `:rtl'. */
8010 static Lisp_Object QCimage
;
8011 static Lisp_Object QCrtl
;
8013 /* Function prototypes. */
8015 static void init_tool_bar_items (Lisp_Object
);
8016 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
8018 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
8019 static void append_tool_bar_item (void);
8022 /* Return a vector of tool bar items for keymaps currently in effect.
8023 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
8024 tool bar items found. */
8027 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8030 Lisp_Object mapsbuf
[3];
8038 /* In order to build the menus, we need to call the keymap
8039 accessors. They all call QUIT. But this function is called
8040 during redisplay, during which a quit is fatal. So inhibit
8041 quitting while building the menus. We do this instead of
8042 specbind because (1) errors will clear it anyway and (2) this
8043 avoids risk of specpdl overflow. */
8044 oquit
= Vinhibit_quit
;
8047 /* Initialize tool_bar_items_vector and protect it from GC. */
8048 init_tool_bar_items (reuse
);
8050 /* Build list of keymaps in maps. Set nmaps to the number of maps
8053 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8054 if (!NILP (Voverriding_local_map_menu_flag
)
8055 && !NILP (Voverriding_local_map
))
8057 /* Yes, use them (if non-nil) as well as the global map. */
8060 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8061 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8062 if (!NILP (Voverriding_local_map
))
8063 maps
[nmaps
++] = Voverriding_local_map
;
8067 /* No, so use major and minor mode keymaps and keymap property.
8068 Note that tool-bar bindings in the local-map and keymap
8069 properties may not work reliable, as they are only
8070 recognized when the tool-bar (or mode-line) is updated,
8071 which does not normally happen after every command. */
8074 nminor
= current_minor_maps (NULL
, &tmaps
);
8075 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
8077 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8078 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8079 maps
[nmaps
++] = tem
;
8080 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8081 maps
[nmaps
++] = tem
;
8082 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8084 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8087 /* Add global keymap at the end. */
8088 maps
[nmaps
++] = current_global_map
;
8090 /* Process maps in reverse order and look up in each map the prefix
8092 for (i
= nmaps
- 1; i
>= 0; --i
)
8093 if (!NILP (maps
[i
]))
8097 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8099 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8102 Vinhibit_quit
= oquit
;
8103 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8105 return tool_bar_items_vector
;
8109 /* Process the definition of KEY which is DEF. */
8112 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8115 struct gcpro gcpro1
, gcpro2
;
8117 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8121 if (EQ (def
, Qundefined
))
8123 /* If a map has an explicit `undefined' as definition,
8124 discard any previously made item. */
8125 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8127 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8129 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8131 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8132 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8133 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8135 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8140 else if (parse_tool_bar_item (key
, def
))
8141 /* Append a new tool bar item to tool_bar_items_vector. Accept
8142 more than one definition for the same key. */
8143 append_tool_bar_item ();
8148 /* Access slot with index IDX of vector tool_bar_item_properties. */
8149 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8151 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8153 ASET (tool_bar_item_properties
, idx
, val
);
8157 /* Parse a tool bar item specification ITEM for key KEY and return the
8158 result in tool_bar_item_properties. Value is false if ITEM is
8161 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8163 CAPTION is the caption of the item, If it's not a string, it is
8164 evaluated to get a string.
8166 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8167 as binding are currently ignored.
8169 The following properties are recognized:
8173 FORM is evaluated and specifies whether the tool bar item is
8174 enabled or disabled.
8178 FORM is evaluated and specifies whether the tool bar item is visible.
8180 - `:filter FUNCTION'
8182 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8183 result is stored as the new binding.
8185 - `:button (TYPE SELECTED)'
8187 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8188 and specifies whether the button is selected (pressed) or not.
8192 IMAGES is either a single image specification or a vector of four
8193 image specifications. See enum tool_bar_item_images.
8195 - `:help HELP-STRING'.
8197 Gives a help string to display for the tool bar item.
8199 - `:label LABEL-STRING'.
8201 A text label to show with the tool bar button if labels are enabled. */
8204 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8206 Lisp_Object filter
= Qnil
;
8207 Lisp_Object caption
;
8209 bool have_label
= 0;
8211 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8212 Rule out items that aren't lists, don't start with
8213 `menu-item' or whose rest following `tool-bar-item' is not a
8218 /* As an exception, allow old-style menu separators. */
8219 if (STRINGP (XCAR (item
)))
8220 item
= list1 (XCAR (item
));
8221 else if (!EQ (XCAR (item
), Qmenu_item
)
8222 || (item
= XCDR (item
), !CONSP (item
)))
8225 /* Create tool_bar_item_properties vector if necessary. Reset it to
8227 if (VECTORP (tool_bar_item_properties
))
8229 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8233 tool_bar_item_properties
8234 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8237 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8238 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8240 /* Get the caption of the item. If the caption is not a string,
8241 evaluate it to get a string. If we don't get a string, skip this
8243 caption
= XCAR (item
);
8244 if (!STRINGP (caption
))
8246 caption
= menu_item_eval_property (caption
);
8247 if (!STRINGP (caption
))
8250 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8252 /* If the rest following the caption is not a list, the menu item is
8253 either a separator, or invalid. */
8257 if (menu_separator_name_p (SSDATA (caption
)))
8259 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8260 #if !defined (USE_GTK) && !defined (HAVE_NS)
8261 /* If we use build_desired_tool_bar_string to render the
8262 tool bar, the separator is rendered as an image. */
8263 set_prop (TOOL_BAR_ITEM_IMAGES
,
8264 (menu_item_eval_property
8265 (Vtool_bar_separator_image_expression
)));
8266 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8267 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8268 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8275 /* Store the binding. */
8276 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8279 /* Ignore cached key binding, if any. */
8280 if (CONSP (item
) && CONSP (XCAR (item
)))
8283 /* Process the rest of the properties. */
8284 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8286 Lisp_Object ikey
, value
;
8289 value
= XCAR (XCDR (item
));
8291 if (EQ (ikey
, QCenable
))
8293 /* `:enable FORM'. */
8294 if (!NILP (Venable_disabled_menus_and_buttons
))
8295 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8297 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8299 else if (EQ (ikey
, QCvisible
))
8301 /* `:visible FORM'. If got a visible property and that
8302 evaluates to nil then ignore this item. */
8303 if (NILP (menu_item_eval_property (value
)))
8306 else if (EQ (ikey
, QChelp
))
8307 /* `:help HELP-STRING'. */
8308 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8309 else if (EQ (ikey
, QCvert_only
))
8310 /* `:vert-only t/nil'. */
8311 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8312 else if (EQ (ikey
, QClabel
))
8314 const char *bad_label
= "!!?GARBLED ITEM?!!";
8315 /* `:label LABEL-STRING'. */
8316 set_prop (TOOL_BAR_ITEM_LABEL
,
8317 STRINGP (value
) ? value
: build_string (bad_label
));
8320 else if (EQ (ikey
, QCfilter
))
8321 /* ':filter FORM'. */
8323 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8325 /* `:button (TYPE . SELECTED)'. */
8326 Lisp_Object type
, selected
;
8328 type
= XCAR (value
);
8329 selected
= XCDR (value
);
8330 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8332 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8333 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8336 else if (EQ (ikey
, QCimage
)
8338 || (VECTORP (value
) && ASIZE (value
) == 4)))
8339 /* Value is either a single image specification or a vector
8340 of 4 such specifications for the different button states. */
8341 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8342 else if (EQ (ikey
, QCrtl
))
8344 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8350 /* Try to make one from caption and key. */
8351 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8352 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8353 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8354 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8356 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8357 char *buf
= xmalloc (max_lbl
+ 1);
8358 Lisp_Object new_lbl
;
8359 ptrdiff_t caption_len
= strlen (capt
);
8361 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8364 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8366 buf
[caption_len
] = '\0';
8370 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8374 strcpy (buf
, label
);
8376 for (j
= 0; buf
[j
] != '\0'; ++j
)
8384 new_lbl
= Fupcase_initials (build_string (label
));
8385 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8386 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8388 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8392 /* If got a filter apply it on binding. */
8394 set_prop (TOOL_BAR_ITEM_BINDING
,
8395 (menu_item_eval_property
8398 PROP (TOOL_BAR_ITEM_BINDING
))))));
8400 /* See if the binding is a keymap. Give up if it is. */
8401 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8404 /* Enable or disable selection of item. */
8405 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8406 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8407 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8409 /* Handle radio buttons or toggle boxes. */
8410 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8411 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8412 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8420 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8421 that can be reused. */
8424 init_tool_bar_items (Lisp_Object reuse
)
8426 if (VECTORP (reuse
))
8427 tool_bar_items_vector
= reuse
;
8429 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8430 ntool_bar_items
= 0;
8434 /* Append parsed tool bar item properties from
8435 tool_bar_item_properties */
8438 append_tool_bar_item (void)
8442 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8444 /* Enlarge tool_bar_items_vector if necessary. */
8446 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8448 /* Append entries from tool_bar_item_properties to the end of
8449 tool_bar_items_vector. */
8450 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8451 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8452 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8459 /* Read a character using menus based on the keymap MAP.
8460 Return nil if there are no menus in the maps.
8461 Return t if we displayed a menu but the user rejected it.
8463 PREV_EVENT is the previous input event, or nil if we are reading
8464 the first event of a key sequence.
8466 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8467 if we used a mouse menu to read the input, or false otherwise. If
8468 USED_MOUSE_MENU is null, don't dereference it.
8470 The prompting is done based on the prompt-string of the map
8471 and the strings associated with various map elements.
8473 This can be done with X menus or with menus put in the minibuf.
8474 These are done in different ways, depending on how the input will be read.
8475 Menus using X are done after auto-saving in read-char, getting the input
8476 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8477 and do auto-saving in the inner call of read_char. */
8480 read_char_x_menu_prompt (Lisp_Object map
,
8481 Lisp_Object prev_event
, bool *used_mouse_menu
)
8483 if (used_mouse_menu
)
8484 *used_mouse_menu
= 0;
8486 /* Use local over global Menu maps. */
8488 if (! menu_prompting
)
8491 /* If we got to this point via a mouse click,
8492 use a real menu for mouse selection. */
8493 if (EVENT_HAS_PARAMETERS (prev_event
)
8494 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8495 && !EQ (XCAR (prev_event
), Qtool_bar
))
8497 /* Display the menu and get the selection. */
8500 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8505 record_menu_key (XCAR (value
));
8507 /* If we got multiple events, unread all but
8509 There is no way to prevent those unread events
8510 from showing up later in last_nonmenu_event.
8511 So turn symbol and integer events into lists,
8512 to indicate that they came from a mouse menu,
8513 so that when present in last_nonmenu_event
8514 they won't confuse things. */
8515 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8517 record_menu_key (XCAR (tem
));
8518 if (SYMBOLP (XCAR (tem
))
8519 || INTEGERP (XCAR (tem
)))
8520 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8523 /* If we got more than one event, put all but the first
8524 onto this list to be read later.
8525 Return just the first event now. */
8526 Vunread_command_events
8527 = nconc2 (XCDR (value
), Vunread_command_events
);
8528 value
= XCAR (value
);
8530 else if (NILP (value
))
8532 if (used_mouse_menu
)
8533 *used_mouse_menu
= 1;
8540 read_char_minibuf_menu_prompt (int commandflag
,
8545 /* FIXME: Use the minibuffer's frame width. */
8546 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8548 bool nobindings
= 1;
8549 Lisp_Object rest
, vector
;
8550 Lisp_Object prompt_strings
= Qnil
;
8554 if (! menu_prompting
)
8557 map
= get_keymap (map
, 0, 1);
8558 name
= Fkeymap_prompt (map
);
8560 /* If we don't have any menus, just read a character normally. */
8561 if (!STRINGP (name
))
8564 #define PUSH_C_STR(str, listvar) \
8565 listvar = Fcons (build_unibyte_string (str), listvar)
8567 /* Prompt string always starts with map's prompt, and a space. */
8568 prompt_strings
= Fcons (name
, prompt_strings
);
8569 PUSH_C_STR (": ", prompt_strings
);
8570 nlength
= SCHARS (name
) + 2;
8574 /* Present the documented bindings, a line at a time. */
8578 Lisp_Object menu_strings
= prompt_strings
;
8579 ptrdiff_t i
= nlength
;
8581 Lisp_Object orig_defn_macro
;
8583 /* Loop over elements of map. */
8588 /* FIXME: Use map_keymap to handle new keymap formats. */
8590 /* At end of map, wrap around if just starting,
8591 or end this line if already have something on it. */
8594 if (notfirst
|| nobindings
)
8600 /* Look at the next element of the map. */
8602 elt
= AREF (vector
, idx
);
8604 elt
= Fcar_safe (rest
);
8606 if (idx
< 0 && VECTORP (elt
))
8608 /* If we found a dense table in the keymap,
8609 advanced past it, but start scanning its contents. */
8610 rest
= Fcdr_safe (rest
);
8616 /* An ordinary element. */
8617 Lisp_Object event
, tem
;
8621 event
= Fcar_safe (elt
); /* alist */
8622 elt
= Fcdr_safe (elt
);
8626 XSETINT (event
, idx
); /* vector */
8629 /* Ignore the element if it has no prompt string. */
8630 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8632 /* True if the char to type matches the string. */
8634 Lisp_Object upcased_event
, downcased_event
;
8635 Lisp_Object desc
= Qnil
;
8637 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8639 upcased_event
= Fupcase (event
);
8640 downcased_event
= Fdowncase (event
);
8641 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8642 || XINT (downcased_event
) == SREF (s
, 0));
8644 desc
= Fsingle_key_description (event
, Qnil
);
8646 #if 0 /* It is redundant to list the equivalent key bindings because
8647 the prefix is what the user has already typed. */
8649 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8651 /* Insert equivalent keybinding. */
8652 s
= concat2 (s
, tem
);
8655 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8656 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8658 /* Insert button prefix. */
8659 Lisp_Object selected
8660 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8661 AUTO_STRING (radio_yes
, "(*) ");
8662 AUTO_STRING (radio_no
, "( ) ");
8663 AUTO_STRING (check_yes
, "[X] ");
8664 AUTO_STRING (check_no
, "[ ] ");
8665 if (EQ (tem
, QCradio
))
8666 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8668 tem
= NILP (selected
) ? check_yes
: check_no
;
8669 s
= concat2 (tem
, s
);
8673 /* If we have room for the prompt string, add it to this line.
8674 If this is the first on the line, always add it. */
8675 if ((SCHARS (s
) + i
+ 2
8676 + (char_matches
? 0 : SCHARS (desc
) + 3))
8680 ptrdiff_t thiswidth
;
8682 /* Punctuate between strings. */
8685 PUSH_C_STR (", ", menu_strings
);
8691 /* If the char to type doesn't match the string's
8692 first char, explicitly show what char to type. */
8695 /* Add as much of string as fits. */
8696 thiswidth
= min (SCHARS (desc
), width
- i
);
8698 = Fcons (Fsubstring (desc
, make_number (0),
8699 make_number (thiswidth
)),
8702 PUSH_C_STR (" = ", menu_strings
);
8706 /* Add as much of string as fits. */
8707 thiswidth
= min (SCHARS (s
), width
- i
);
8709 = Fcons (Fsubstring (s
, make_number (0),
8710 make_number (thiswidth
)),
8716 /* If this element does not fit, end the line now,
8717 and save the element for the next line. */
8718 PUSH_C_STR ("...", menu_strings
);
8723 /* Move past this element. */
8724 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8725 /* Handle reaching end of dense table. */
8730 rest
= Fcdr_safe (rest
);
8734 /* Prompt with that and read response. */
8735 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8737 /* Make believe it's not a keyboard macro in case the help char
8738 is pressed. Help characters are not recorded because menu prompting
8739 is not used on replay. */
8740 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8741 kset_defining_kbd_macro (current_kboard
, Qnil
);
8743 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8744 while (BUFFERP (obj
));
8745 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8747 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8750 if (! EQ (obj
, menu_prompt_more_char
)
8751 && (!INTEGERP (menu_prompt_more_char
)
8752 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8754 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8755 store_kbd_macro_char (obj
);
8758 /* Help char - go round again. */
8762 /* Reading key sequences. */
8765 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8767 return access_keymap (get_keymap (keymap
, 0, 1),
8772 active_maps (Lisp_Object first_event
)
8774 Lisp_Object position
8775 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8776 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8779 /* Structure used to keep track of partial application of key remapping
8780 such as Vfunction_key_map and Vkey_translation_map. */
8781 typedef struct keyremap
8783 /* This is the map originally specified for this use. */
8785 /* This is a submap reached by looking up, in PARENT,
8786 the events from START to END. */
8788 /* Positions [START, END) in the key sequence buffer
8789 are the key that we have scanned so far.
8790 Those events are the ones that we will replace
8791 if PARENT maps them into a key sequence. */
8795 /* Lookup KEY in MAP.
8796 MAP is a keymap mapping keys to key vectors or functions.
8797 If the mapping is a function and DO_FUNCALL is true,
8798 the function is called with PROMPT as parameter and its return
8799 value is used as the return value of this function (after checking
8800 that it is indeed a vector). */
8803 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8808 next
= access_keymap (map
, key
, 1, 0, 1);
8810 /* Handle a symbol whose function definition is a keymap
8812 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8813 && (ARRAYP (XSYMBOL (next
)->function
)
8814 || KEYMAPP (XSYMBOL (next
)->function
)))
8815 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8817 /* If the keymap gives a function, not an
8818 array, then call the function with one arg and use
8819 its value instead. */
8820 if (do_funcall
&& FUNCTIONP (next
))
8825 next
= call1 (next
, prompt
);
8826 /* If the function returned something invalid,
8827 barf--don't ignore it.
8828 (To ignore it safely, we would need to gcpro a bunch of
8829 other variables.) */
8830 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8831 error ("Function %s returns invalid key sequence",
8832 SSDATA (SYMBOL_NAME (tem
)));
8837 /* Do one step of the key remapping used for function-key-map and
8838 key-translation-map:
8839 KEYBUF is the buffer holding the input events.
8840 BUFSIZE is its maximum size.
8841 FKEY is a pointer to the keyremap structure to use.
8842 INPUT is the index of the last element in KEYBUF.
8843 DOIT if true says that the remapping can actually take place.
8844 DIFF is used to return the number of keys added/removed by the remapping.
8845 PARENT is the root of the keymap.
8846 PROMPT is the prompt to use if the remapping happens through a function.
8847 Return true if the remapping actually took place. */
8850 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8851 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8853 Lisp_Object next
, key
;
8855 key
= keybuf
[fkey
->end
++];
8857 if (KEYMAPP (fkey
->parent
))
8858 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8862 /* If keybuf[fkey->start..fkey->end] is bound in the
8863 map and we're in a position to do the key remapping, replace it with
8864 the binding and restart with fkey->start at the end. */
8865 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8867 int len
= XFASTINT (Flength (next
));
8870 *diff
= len
- (fkey
->end
- fkey
->start
);
8872 if (bufsize
- input
<= *diff
)
8873 error ("Key sequence too long");
8875 /* Shift the keys that follow fkey->end. */
8877 for (i
= fkey
->end
; i
< input
; i
++)
8878 keybuf
[i
+ *diff
] = keybuf
[i
];
8880 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8881 keybuf
[i
+ *diff
] = keybuf
[i
];
8882 /* Overwrite the old keys with the new ones. */
8883 for (i
= 0; i
< len
; i
++)
8884 keybuf
[fkey
->start
+ i
]
8885 = Faref (next
, make_number (i
));
8887 fkey
->start
= fkey
->end
+= *diff
;
8888 fkey
->map
= fkey
->parent
;
8893 fkey
->map
= get_keymap (next
, 0, 1);
8895 /* If we no longer have a bound suffix, try a new position for
8897 if (!CONSP (fkey
->map
))
8899 fkey
->end
= ++fkey
->start
;
8900 fkey
->map
= fkey
->parent
;
8906 test_undefined (Lisp_Object binding
)
8908 return (NILP (binding
)
8909 || EQ (binding
, Qundefined
)
8910 || (SYMBOLP (binding
)
8911 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8914 /* Read a sequence of keys that ends with a non prefix character,
8915 storing it in KEYBUF, a buffer of size BUFSIZE.
8917 Return the length of the key sequence stored.
8918 Return -1 if the user rejected a command menu.
8920 Echo starting immediately unless `prompt' is 0.
8922 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8923 read_char with a suitable COMMANDFLAG argument.
8925 Where a key sequence ends depends on the currently active keymaps.
8926 These include any minor mode keymaps active in the current buffer,
8927 the current buffer's local map, and the global map.
8929 If a key sequence has no other bindings, we check Vfunction_key_map
8930 to see if some trailing subsequence might be the beginning of a
8931 function key's sequence. If so, we try to read the whole function
8932 key, and substitute its symbolic name into the key sequence.
8934 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8935 `double-' events into similar click events, if that would make them
8936 bound. We try to turn `triple-' events first into `double-' events,
8939 If we get a mouse click in a mode line, vertical divider, or other
8940 non-text area, we treat the click as if it were prefixed by the
8941 symbol denoting that area - `mode-line', `vertical-line', or
8944 If the sequence starts with a mouse click, we read the key sequence
8945 with respect to the buffer clicked on, not the current buffer.
8947 If the user switches frames in the midst of a key sequence, we put
8948 off the switch-frame event until later; the next call to
8949 read_char will return it.
8951 If FIX_CURRENT_BUFFER, we restore current_buffer
8952 from the selected window's buffer. */
8955 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8956 bool dont_downcase_last
, bool can_return_switch_frame
,
8957 bool fix_current_buffer
, bool prevent_redisplay
)
8959 ptrdiff_t count
= SPECPDL_INDEX ();
8961 /* How many keys there are in the current key sequence. */
8964 /* The length of the echo buffer when we started reading, and
8965 the length of this_command_keys when we started reading. */
8966 ptrdiff_t echo_start
IF_LINT (= 0);
8967 ptrdiff_t keys_start
;
8969 Lisp_Object current_binding
= Qnil
;
8970 Lisp_Object first_event
= Qnil
;
8972 /* Index of the first key that has no binding.
8973 It is useless to try fkey.start larger than that. */
8976 /* If t < mock_input, then KEYBUF[t] should be read as the next
8979 We use this to recover after recognizing a function key. Once we
8980 realize that a suffix of the current key sequence is actually a
8981 function key's escape sequence, we replace the suffix with the
8982 function key's binding from Vfunction_key_map. Now keybuf
8983 contains a new and different key sequence, so the echo area,
8984 this_command_keys, and the submaps and defs arrays are wrong. In
8985 this situation, we set mock_input to t, set t to 0, and jump to
8986 restart_sequence; the loop will read keys from keybuf up until
8987 mock_input, thus rebuilding the state; and then it will resume
8988 reading characters from the keyboard. */
8991 /* If the sequence is unbound in submaps[], then
8992 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8993 and fkey.map is its binding.
8995 These might be > t, indicating that all function key scanning
8996 should hold off until t reaches them. We do this when we've just
8997 recognized a function key, to avoid searching for the function
8998 key's again in Vfunction_key_map. */
9001 /* Likewise, for key_translation_map and input-decode-map. */
9002 keyremap keytran
, indec
;
9004 /* True if we are trying to map a key by changing an upper-case
9005 letter to lower case, or a shifted function key to an unshifted
9007 bool shift_translated
= 0;
9009 /* If we receive a `switch-frame' or `select-window' event in the middle of
9010 a key sequence, we put it off for later.
9011 While we're reading, we keep the event here. */
9012 Lisp_Object delayed_switch_frame
;
9014 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
9015 int original_uppercase_position
= -1;
9017 /* Gets around Microsoft compiler limitations. */
9020 struct buffer
*starting_buffer
;
9022 /* List of events for which a fake prefix key has been generated. */
9023 Lisp_Object fake_prefixed_keys
= Qnil
;
9025 struct gcpro gcpro1
;
9027 GCPRO1 (fake_prefixed_keys
);
9028 raw_keybuf_count
= 0;
9030 last_nonmenu_event
= Qnil
;
9032 delayed_switch_frame
= Qnil
;
9038 /* Install the string PROMPT as the beginning of the string
9039 of echoing, so that it serves as a prompt for the next
9041 kset_echo_string (current_kboard
, prompt
);
9042 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9045 else if (cursor_in_echo_area
9046 && echo_keystrokes_p ())
9047 /* This doesn't put in a dash if the echo buffer is empty, so
9048 you don't always see a dash hanging out in the minibuffer. */
9052 /* Record the initial state of the echo area and this_command_keys;
9053 we will need to restore them if we replay a key sequence. */
9055 echo_start
= echo_length ();
9056 keys_start
= this_command_key_count
;
9057 this_single_command_key_start
= keys_start
;
9059 /* We jump here when we need to reinitialize fkey and keytran; this
9060 happens if we switch keyboards between rescans. */
9061 replay_entire_sequence
:
9063 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9064 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9065 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9066 indec
.start
= indec
.end
= 0;
9067 fkey
.start
= fkey
.end
= 0;
9068 keytran
.start
= keytran
.end
= 0;
9070 /* We jump here when the key sequence has been thoroughly changed, and
9071 we need to rescan it starting from the beginning. When we jump here,
9072 keybuf[0..mock_input] holds the sequence we should reread. */
9075 starting_buffer
= current_buffer
;
9076 first_unbound
= bufsize
+ 1;
9078 /* Build our list of keymaps.
9079 If we recognize a function key and replace its escape sequence in
9080 keybuf with its symbol, or if the sequence starts with a mouse
9081 click and we need to switch buffers, we jump back here to rebuild
9082 the initial keymaps from the current buffer. */
9083 current_binding
= active_maps (first_event
);
9085 /* Start from the beginning in keybuf. */
9088 /* These are no-ops the first time through, but if we restart, they
9089 revert the echo area and this_command_keys to their original state. */
9090 this_command_key_count
= keys_start
;
9091 if (INTERACTIVE
&& t
< mock_input
)
9092 echo_truncate (echo_start
);
9094 /* If the best binding for the current key sequence is a keymap, or
9095 we may be looking at a function key's escape sequence, keep on
9097 while (!NILP (current_binding
)
9098 /* Keep reading as long as there's a prefix binding. */
9099 ? KEYMAPP (current_binding
)
9100 /* Don't return in the middle of a possible function key sequence,
9101 if the only bindings we found were via case conversion.
9102 Thus, if ESC O a has a function-key-map translation
9103 and ESC o has a binding, don't return after ESC O,
9104 so that we can translate ESC O plus the next character. */
9105 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9108 bool used_mouse_menu
= 0;
9110 /* Where the last real key started. If we need to throw away a
9111 key that has expanded into more than one element of keybuf
9112 (say, a mouse click on the mode line which is being treated
9113 as [mode-line (mouse-...)], then we backtrack to this point
9115 int last_real_key_start
;
9117 /* These variables are analogous to echo_start and keys_start;
9118 while those allow us to restart the entire key sequence,
9119 echo_local_start and keys_local_start allow us to throw away
9121 ptrdiff_t echo_local_start
IF_LINT (= 0);
9122 int keys_local_start
;
9123 Lisp_Object new_binding
;
9125 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9126 eassert (indec
.start
<= indec
.end
);
9127 eassert (fkey
.start
<= fkey
.end
);
9128 eassert (keytran
.start
<= keytran
.end
);
9129 /* key-translation-map is applied *after* function-key-map
9130 which is itself applied *after* input-decode-map. */
9131 eassert (fkey
.end
<= indec
.start
);
9132 eassert (keytran
.end
<= fkey
.start
);
9134 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9135 first_unbound
< keytran
.start
)
9136 { /* The prefix upto first_unbound has no binding and has
9137 no translation left to do either, so we know it's unbound.
9138 If we don't stop now, we risk staying here indefinitely
9139 (if the user keeps entering fkey or keytran prefixes
9140 like C-c ESC ESC ESC ESC ...) */
9142 for (i
= first_unbound
+ 1; i
< t
; i
++)
9143 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9144 mock_input
= t
- first_unbound
- 1;
9145 indec
.end
= indec
.start
-= first_unbound
+ 1;
9146 indec
.map
= indec
.parent
;
9147 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9148 fkey
.map
= fkey
.parent
;
9149 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9150 keytran
.map
= keytran
.parent
;
9151 goto replay_sequence
;
9155 error ("Key sequence too long");
9158 echo_local_start
= echo_length ();
9159 keys_local_start
= this_command_key_count
;
9162 /* These are no-ops, unless we throw away a keystroke below and
9163 jumped back up to replay_key; in that case, these restore the
9164 variables to their original state, allowing us to replay the
9166 if (INTERACTIVE
&& t
< mock_input
)
9167 echo_truncate (echo_local_start
);
9168 this_command_key_count
= keys_local_start
;
9170 /* By default, assume each event is "real". */
9171 last_real_key_start
= t
;
9173 /* Does mock_input indicate that we are re-reading a key sequence? */
9177 add_command_key (key
);
9178 if (echo_keystrokes_p ()
9179 && current_kboard
->immediate_echo
)
9186 /* If not, we should actually read a character. */
9190 KBOARD
*interrupted_kboard
= current_kboard
;
9191 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9192 /* Calling read_char with COMMANDFLAG = -2 avoids
9193 redisplay in read_char and its subroutines. */
9194 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9195 current_binding
, last_nonmenu_event
,
9196 &used_mouse_menu
, NULL
);
9197 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9198 /* When switching to a new tty (with a new keyboard),
9199 read_char returns the new buffer, rather than -2
9200 (Bug#5095). This is because `terminal-init-xterm'
9201 calls read-char, which eats the wrong_kboard_jmpbuf
9202 return. Any better way to fix this? -- cyd */
9203 || (interrupted_kboard
!= current_kboard
))
9208 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9209 if (k
== interrupted_kboard
)
9214 /* Don't touch interrupted_kboard when it's been
9216 delayed_switch_frame
= Qnil
;
9217 goto replay_entire_sequence
;
9220 if (!NILP (delayed_switch_frame
))
9223 (interrupted_kboard
,
9224 Fcons (delayed_switch_frame
,
9225 KVAR (interrupted_kboard
, kbd_queue
)));
9226 delayed_switch_frame
= Qnil
;
9231 (interrupted_kboard
,
9232 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9234 /* If the side queue is non-empty, ensure it begins with a
9235 switch-frame, so we'll replay it in the right context. */
9236 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9237 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9238 !(EVENT_HAS_PARAMETERS (key
)
9239 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9243 XSETFRAME (frame
, interrupted_frame
);
9245 (interrupted_kboard
,
9246 Fcons (make_lispy_switch_frame (frame
),
9247 KVAR (interrupted_kboard
, kbd_queue
)));
9250 goto replay_entire_sequence
;
9254 /* read_char returns t when it shows a menu and the user rejects it.
9258 unbind_to (count
, Qnil
);
9263 /* read_char returns -1 at the end of a macro.
9264 Emacs 18 handles this by returning immediately with a
9265 zero, so that's what we'll do. */
9266 if (INTEGERP (key
) && XINT (key
) == -1)
9269 /* The Microsoft C compiler can't handle the goto that
9275 /* If the current buffer has been changed from under us, the
9276 keymap may have changed, so replay the sequence. */
9279 timer_resume_idle ();
9282 /* Reset the current buffer from the selected window
9283 in case something changed the former and not the latter.
9284 This is to be more consistent with the behavior
9285 of the command_loop_1. */
9286 if (fix_current_buffer
)
9288 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9290 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9292 Fset_buffer (XWINDOW (selected_window
)->contents
);
9295 goto replay_sequence
;
9298 /* If we have a quit that was typed in another frame, and
9299 quit_throw_to_read_char switched buffers,
9300 replay to get the right keymap. */
9302 && XINT (key
) == quit_char
9303 && current_buffer
!= starting_buffer
)
9306 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9311 goto replay_sequence
;
9316 if (EVENT_HAS_PARAMETERS (key
)
9317 /* Either a `switch-frame' or a `select-window' event. */
9318 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9320 /* If we're at the beginning of a key sequence, and the caller
9321 says it's okay, go ahead and return this event. If we're
9322 in the midst of a key sequence, delay it until the end. */
9323 if (t
> 0 || !can_return_switch_frame
)
9325 delayed_switch_frame
= key
;
9330 if (NILP (first_event
))
9333 /* Even if first_event does not specify a particular
9334 window/position, it's important to recompute the maps here
9335 since a long time might have passed since we entered
9336 read_key_sequence, and a timer (or process-filter or
9337 special-event-map, ...) might have switched the current buffer
9338 or the selected window from under us in the mean time. */
9339 if (fix_current_buffer
9340 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9342 Fset_buffer (XWINDOW (selected_window
)->contents
);
9343 current_binding
= active_maps (first_event
);
9347 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9351 /* Clicks in non-text areas get prefixed by the symbol
9352 in their CHAR-ADDRESS field. For example, a click on
9353 the mode line is prefixed by the symbol `mode-line'.
9355 Furthermore, key sequences beginning with mouse clicks
9356 are read using the keymaps of the buffer clicked on, not
9357 the current buffer. So we may have to switch the buffer
9360 When we turn one event into two events, we must make sure
9361 that neither of the two looks like the original--so that,
9362 if we replay the events, they won't be expanded again.
9363 If not for this, such reexpansion could happen either here
9364 or when user programs play with this-command-keys. */
9365 if (EVENT_HAS_PARAMETERS (key
))
9367 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9368 if (EQ (kind
, Qmouse_click
))
9370 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9371 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9374 || (!NILP (fake_prefixed_keys
)
9375 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9377 /* We're looking a second time at an event for which
9378 we generated a fake prefix key. Set
9379 last_real_key_start appropriately. */
9381 last_real_key_start
= t
- 1;
9384 if (last_real_key_start
== 0)
9386 /* Key sequences beginning with mouse clicks are
9387 read using the keymaps in the buffer clicked on,
9388 not the current buffer. If we're at the
9389 beginning of a key sequence, switch buffers. */
9390 if (WINDOWP (window
)
9391 && BUFFERP (XWINDOW (window
)->contents
)
9392 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9394 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9399 /* Arrange to go back to the original buffer once we're
9400 done reading the key sequence. Note that we can't
9401 use save_excursion_{save,restore} here, because they
9402 save point as well as the current buffer; we don't
9403 want to save point, because redisplay may change it,
9404 to accommodate a Fset_window_start or something. We
9405 don't want to do this at the top of the function,
9406 because we may get input from a subprocess which
9407 wants to change the selected window and stuff (say,
9409 record_unwind_current_buffer ();
9411 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9413 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9414 goto replay_sequence
;
9418 /* Expand mode-line and scroll-bar events into two events:
9419 use posn as a fake prefix key. */
9421 && (NILP (fake_prefixed_keys
)
9422 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9424 if (bufsize
- t
<= 1)
9425 error ("Key sequence too long");
9428 keybuf
[t
+ 1] = key
;
9431 /* Record that a fake prefix key has been generated
9432 for KEY. Don't modify the event; this would
9433 prevent proper action when the event is pushed
9434 back into unread-command-events. */
9435 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9439 else if (CONSP (XCDR (key
))
9440 && CONSP (EVENT_START (key
))
9441 && CONSP (XCDR (EVENT_START (key
))))
9445 posn
= POSN_POSN (EVENT_START (key
));
9446 /* Handle menu-bar events:
9447 insert the dummy prefix event `menu-bar'. */
9448 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9450 if (bufsize
- t
<= 1)
9451 error ("Key sequence too long");
9453 keybuf
[t
+ 1] = key
;
9455 /* Zap the position in key, so we know that we've
9456 expanded it, and don't try to do so again. */
9457 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9460 goto replay_sequence
;
9462 else if (CONSP (posn
))
9464 /* We're looking at the second event of a
9465 sequence which we expanded before. Set
9466 last_real_key_start appropriately. */
9467 if (last_real_key_start
== t
&& t
> 0)
9468 last_real_key_start
= t
- 1;
9473 /* We have finally decided that KEY is something we might want
9475 new_binding
= follow_key (current_binding
, key
);
9477 /* If KEY wasn't bound, we'll try some fallbacks. */
9478 if (!NILP (new_binding
))
9479 /* This is needed for the following scenario:
9480 event 0: a down-event that gets dropped by calling replay_key.
9481 event 1: some normal prefix like C-h.
9482 After event 0, first_unbound is 0, after event 1 indec.start,
9483 fkey.start, and keytran.start are all 1, so when we see that
9484 C-h is bound, we need to update first_unbound. */
9485 first_unbound
= max (t
+ 1, first_unbound
);
9490 /* Remember the position to put an upper bound on indec.start. */
9491 first_unbound
= min (t
, first_unbound
);
9493 head
= EVENT_HEAD (key
);
9497 Lisp_Object breakdown
;
9500 breakdown
= parse_modifiers (head
);
9501 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9502 /* Attempt to reduce an unbound mouse event to a simpler
9503 event that is bound:
9504 Drags reduce to clicks.
9505 Double-clicks reduce to clicks.
9506 Triple-clicks reduce to double-clicks, then to clicks.
9507 Down-clicks are eliminated.
9508 Double-downs reduce to downs, then are eliminated.
9509 Triple-downs reduce to double-downs, then to downs,
9510 then are eliminated. */
9511 if (modifiers
& (down_modifier
| drag_modifier
9512 | double_modifier
| triple_modifier
))
9514 while (modifiers
& (down_modifier
| drag_modifier
9515 | double_modifier
| triple_modifier
))
9517 Lisp_Object new_head
, new_click
;
9518 if (modifiers
& triple_modifier
)
9519 modifiers
^= (double_modifier
| triple_modifier
);
9520 else if (modifiers
& double_modifier
)
9521 modifiers
&= ~double_modifier
;
9522 else if (modifiers
& drag_modifier
)
9523 modifiers
&= ~drag_modifier
;
9526 /* Dispose of this `down' event by simply jumping
9527 back to replay_key, to get another event.
9529 Note that if this event came from mock input,
9530 then just jumping back to replay_key will just
9531 hand it to us again. So we have to wipe out any
9534 We could delete keybuf[t] and shift everything
9535 after that to the left by one spot, but we'd also
9536 have to fix up any variable that points into
9537 keybuf, and shifting isn't really necessary
9540 Adding prefixes for non-textual mouse clicks
9541 creates two characters of mock input, and both
9542 must be thrown away. If we're only looking at
9543 the prefix now, we can just jump back to
9544 replay_key. On the other hand, if we've already
9545 processed the prefix, and now the actual click
9546 itself is giving us trouble, then we've lost the
9547 state of the keymaps we want to backtrack to, and
9548 we need to replay the whole sequence to rebuild
9551 Beyond that, only function key expansion could
9552 create more than two keys, but that should never
9553 generate mouse events, so it's okay to zero
9554 mock_input in that case too.
9556 FIXME: The above paragraph seems just plain
9557 wrong, if you consider things like
9558 xterm-mouse-mode. -stef
9560 Isn't this just the most wonderful code ever? */
9562 /* If mock_input > t + 1, the above simplification
9563 will actually end up dropping keys on the floor.
9564 This is probably OK for now, but even
9565 if mock_input <= t + 1, we need to adjust indec,
9567 Typical case [header-line down-mouse-N]:
9568 mock_input = 2, t = 1, fkey.end = 1,
9569 last_real_key_start = 0. */
9570 if (indec
.end
> last_real_key_start
)
9572 indec
.end
= indec
.start
9573 = min (last_real_key_start
, indec
.start
);
9574 indec
.map
= indec
.parent
;
9575 if (fkey
.end
> last_real_key_start
)
9577 fkey
.end
= fkey
.start
9578 = min (last_real_key_start
, fkey
.start
);
9579 fkey
.map
= fkey
.parent
;
9580 if (keytran
.end
> last_real_key_start
)
9582 keytran
.end
= keytran
.start
9583 = min (last_real_key_start
, keytran
.start
);
9584 keytran
.map
= keytran
.parent
;
9588 if (t
== last_real_key_start
)
9595 mock_input
= last_real_key_start
;
9596 goto replay_sequence
;
9601 = apply_modifiers (modifiers
, XCAR (breakdown
));
9602 new_click
= list2 (new_head
, EVENT_START (key
));
9604 /* Look for a binding for this new key. */
9605 new_binding
= follow_key (current_binding
, new_click
);
9607 /* If that click is bound, go for it. */
9608 if (!NILP (new_binding
))
9610 current_binding
= new_binding
;
9614 /* Otherwise, we'll leave key set to the drag event. */
9619 current_binding
= new_binding
;
9622 /* Normally, last_nonmenu_event gets the previous key we read.
9623 But when a mouse popup menu is being used,
9624 we don't update last_nonmenu_event; it continues to hold the mouse
9625 event that preceded the first level of menu. */
9626 if (!used_mouse_menu
)
9627 last_nonmenu_event
= key
;
9629 /* Record what part of this_command_keys is the current key sequence. */
9630 this_single_command_key_start
= this_command_key_count
- t
;
9632 /* Look for this sequence in input-decode-map.
9633 Scan from indec.end until we find a bound suffix. */
9634 while (indec
.end
< t
)
9636 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9640 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9641 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9646 mock_input
= diff
+ max (t
, mock_input
);
9647 goto replay_sequence
;
9651 if (!KEYMAPP (current_binding
)
9652 && !test_undefined (current_binding
)
9653 && indec
.start
>= t
)
9654 /* There is a binding and it's not a prefix.
9655 (and it doesn't have any input-decode-map translation pending).
9656 There is thus no function-key in this sequence.
9657 Moving fkey.start is important in this case to allow keytran.start
9658 to go over the sequence before we return (since we keep the
9659 invariant that keytran.end <= fkey.start). */
9662 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9665 /* If the sequence is unbound, see if we can hang a function key
9666 off the end of it. */
9667 /* Continue scan from fkey.end until we find a bound suffix. */
9668 while (fkey
.end
< indec
.start
)
9670 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9674 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9675 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9676 max (t
, mock_input
),
9677 /* If there's a binding (i.e.
9678 first_binding >= nmaps) we don't want
9679 to apply this function-key-mapping. */
9681 && (test_undefined (current_binding
)),
9686 mock_input
= diff
+ max (t
, mock_input
);
9687 /* Adjust the input-decode-map counters. */
9689 indec
.start
+= diff
;
9691 goto replay_sequence
;
9695 /* Look for this sequence in key-translation-map.
9696 Scan from keytran.end until we find a bound suffix. */
9697 while (keytran
.end
< fkey
.start
)
9699 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9703 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9704 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9709 mock_input
= diff
+ max (t
, mock_input
);
9710 /* Adjust the function-key-map and input-decode-map counters. */
9712 indec
.start
+= diff
;
9716 goto replay_sequence
;
9720 /* If KEY is not defined in any of the keymaps,
9721 and cannot be part of a function key or translation,
9722 and is an upper case letter
9723 use the corresponding lower-case letter instead. */
9724 if (NILP (current_binding
)
9725 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9727 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9728 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9729 || (XINT (key
) & shift_modifier
)))
9731 Lisp_Object new_key
;
9733 original_uppercase
= key
;
9734 original_uppercase_position
= t
- 1;
9736 if (XINT (key
) & shift_modifier
)
9737 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9739 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9740 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9742 /* We have to do this unconditionally, regardless of whether
9743 the lower-case char is defined in the keymaps, because they
9744 might get translated through function-key-map. */
9745 keybuf
[t
- 1] = new_key
;
9746 mock_input
= max (t
, mock_input
);
9747 shift_translated
= 1;
9749 goto replay_sequence
;
9752 if (NILP (current_binding
)
9753 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9755 read_key_sequence_cmd
= Vprefix_help_command
;
9756 /* The Microsoft C compiler can't handle the goto that
9762 /* If KEY is not defined in any of the keymaps,
9763 and cannot be part of a function key or translation,
9764 and is a shifted function key,
9765 use the corresponding unshifted function key instead. */
9766 if (NILP (current_binding
)
9767 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9769 Lisp_Object breakdown
= parse_modifiers (key
);
9771 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9773 if (modifiers
& shift_modifier
9774 /* Treat uppercase keys as shifted. */
9776 && (KEY_TO_CHAR (key
)
9777 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9778 && uppercasep (KEY_TO_CHAR (key
))))
9781 = (modifiers
& shift_modifier
9782 ? apply_modifiers (modifiers
& ~shift_modifier
,
9784 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9786 original_uppercase
= key
;
9787 original_uppercase_position
= t
- 1;
9789 /* We have to do this unconditionally, regardless of whether
9790 the lower-case char is defined in the keymaps, because they
9791 might get translated through function-key-map. */
9792 keybuf
[t
- 1] = new_key
;
9793 mock_input
= max (t
, mock_input
);
9794 /* Reset fkey (and consequently keytran) to apply
9795 function-key-map on the result, so that S-backspace is
9796 correctly mapped to DEL (via backspace). OTOH,
9797 input-decode-map doesn't need to go through it again. */
9798 fkey
.start
= fkey
.end
= 0;
9799 keytran
.start
= keytran
.end
= 0;
9800 shift_translated
= 1;
9802 goto replay_sequence
;
9807 read_key_sequence_cmd
= current_binding
;
9808 read_key_sequence_remapped
9809 /* Remap command through active keymaps.
9810 Do the remapping here, before the unbind_to so it uses the keymaps
9811 of the appropriate buffer. */
9812 = SYMBOLP (read_key_sequence_cmd
)
9813 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9816 unread_switch_frame
= delayed_switch_frame
;
9817 unbind_to (count
, Qnil
);
9819 /* Don't downcase the last character if the caller says don't.
9820 Don't downcase it if the result is undefined, either. */
9821 if ((dont_downcase_last
|| NILP (current_binding
))
9823 && t
- 1 == original_uppercase_position
)
9825 keybuf
[t
- 1] = original_uppercase
;
9826 shift_translated
= 0;
9829 if (shift_translated
)
9830 Vthis_command_keys_shift_translated
= Qt
;
9832 /* Occasionally we fabricate events, perhaps by expanding something
9833 according to function-key-map, or by adding a prefix symbol to a
9834 mouse click in the scroll bar or modeline. In this cases, return
9835 the entire generated key sequence, even if we hit an unbound
9836 prefix or a definition before the end. This means that you will
9837 be able to push back the event properly, and also means that
9838 read-key-sequence will always return a logical unit.
9841 for (; t
< mock_input
; t
++)
9843 if (echo_keystrokes_p ())
9844 echo_char (keybuf
[t
]);
9845 add_command_key (keybuf
[t
]);
9853 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9854 Lisp_Object dont_downcase_last
,
9855 Lisp_Object can_return_switch_frame
,
9856 Lisp_Object cmd_loop
, bool allow_string
)
9858 Lisp_Object keybuf
[30];
9860 struct gcpro gcpro1
;
9861 ptrdiff_t count
= SPECPDL_INDEX ();
9864 CHECK_STRING (prompt
);
9867 specbind (Qinput_method_exit_on_first_char
,
9868 (NILP (cmd_loop
) ? Qt
: Qnil
));
9869 specbind (Qinput_method_use_echo_area
,
9870 (NILP (cmd_loop
) ? Qt
: Qnil
));
9872 memset (keybuf
, 0, sizeof keybuf
);
9874 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9876 if (NILP (continue_echo
))
9878 this_command_key_count
= 0;
9879 this_command_key_count_reset
= 0;
9880 this_single_command_key_start
= 0;
9883 #ifdef HAVE_WINDOW_SYSTEM
9884 if (display_hourglass_p
)
9885 cancel_hourglass ();
9888 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9889 prompt
, ! NILP (dont_downcase_last
),
9890 ! NILP (can_return_switch_frame
), 0, 0);
9892 #if 0 /* The following is fine for code reading a key sequence and
9893 then proceeding with a lengthy computation, but it's not good
9894 for code reading keys in a loop, like an input method. */
9895 #ifdef HAVE_WINDOW_SYSTEM
9896 if (display_hourglass_p
)
9907 return unbind_to (count
,
9908 ((allow_string
? make_event_array
: Fvector
)
9912 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9913 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9914 The sequence is sufficient to specify a non-prefix command in the
9915 current local and global maps.
9917 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9918 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9919 as a continuation of the previous key.
9921 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9922 convert the last event to lower case. (Normally any upper case event
9923 is converted to lower case if the original event is undefined and the lower
9924 case equivalent is defined.) A non-nil value is appropriate for reading
9925 a key sequence to be defined.
9927 A C-g typed while in this function is treated like any other character,
9928 and `quit-flag' is not set.
9930 If the key sequence starts with a mouse click, then the sequence is read
9931 using the keymaps of the buffer of the window clicked in, not the buffer
9932 of the selected window as normal.
9934 `read-key-sequence' drops unbound button-down events, since you normally
9935 only care about the click or drag events which follow them. If a drag
9936 or multi-click event is unbound, but the corresponding click event would
9937 be bound, `read-key-sequence' turns the event into a click event at the
9938 drag's starting position. This means that you don't have to distinguish
9939 between click and drag, double, or triple events unless you want to.
9941 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9942 lines separating windows, and scroll bars with imaginary keys
9943 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9945 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9946 function will process a switch-frame event if the user switches frames
9947 before typing anything. If the user switches frames in the middle of a
9948 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9949 is nil, then the event will be put off until after the current key sequence.
9951 `read-key-sequence' checks `function-key-map' for function key
9952 sequences, where they wouldn't conflict with ordinary bindings. See
9953 `function-key-map' for more details.
9955 The optional fifth argument CMD-LOOP, if non-nil, means
9956 that this key sequence is being read by something that will
9957 read commands one after another. It should be nil if the caller
9958 will read just one key sequence. */)
9959 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9961 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9962 can_return_switch_frame
, cmd_loop
, true);
9965 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9966 Sread_key_sequence_vector
, 1, 5, 0,
9967 doc
: /* Like `read-key-sequence' but always return a vector. */)
9968 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9970 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9971 can_return_switch_frame
, cmd_loop
, false);
9974 /* Return true if input events are pending. */
9977 detect_input_pending (void)
9979 return input_pending
|| get_input_pending (0);
9982 /* Return true if input events other than mouse movements are
9986 detect_input_pending_ignore_squeezables (void)
9988 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9991 /* Return true if input events are pending, and run any pending timers. */
9994 detect_input_pending_run_timers (bool do_display
)
9996 unsigned old_timers_run
= timers_run
;
9999 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
10001 if (old_timers_run
!= timers_run
&& do_display
)
10002 redisplay_preserve_echo_area (8);
10004 return input_pending
;
10007 /* This is called in some cases before a possible quit.
10008 It cases the next call to detect_input_pending to recompute input_pending.
10009 So calling this function unnecessarily can't do any harm. */
10012 clear_input_pending (void)
10017 /* Return true if there are pending requeued events.
10018 This isn't used yet. The hope is to make wait_reading_process_output
10019 call it, and return if it runs Lisp code that unreads something.
10020 The problem is, kbd_buffer_get_event needs to be fixed to know what
10021 to do in that case. It isn't trivial. */
10024 requeued_events_pending_p (void)
10026 return (!NILP (Vunread_command_events
));
10029 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
10030 doc
: /* Return t if command input is currently available with no wait.
10031 Actually, the value is nil only if we can be sure that no input is available;
10032 if there is a doubt, the value is t.
10034 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
10035 (Lisp_Object check_timers
)
10037 if (!NILP (Vunread_command_events
)
10038 || !NILP (Vunread_post_input_method_events
)
10039 || !NILP (Vunread_input_method_events
))
10042 /* Process non-user-visible events (Bug#10195). */
10043 process_special_events ();
10045 return (get_input_pending ((NILP (check_timers
)
10046 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
10047 | READABLE_EVENTS_FILTER_EVENTS
)
10051 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10052 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10055 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10058 if (total_keys
< NUM_RECENT_KEYS
)
10059 return Fvector (total_keys
, keys
);
10062 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10063 vcopy (val
, 0, keys
+ recent_keys_index
,
10064 NUM_RECENT_KEYS
- recent_keys_index
);
10065 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10066 keys
, recent_keys_index
);
10071 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10072 doc
: /* Return the key sequence that invoked this command.
10073 However, if the command has called `read-key-sequence', it returns
10074 the last key sequence that has been read.
10075 The value is a string or a vector.
10077 See also `this-command-keys-vector'. */)
10080 return make_event_array (this_command_key_count
,
10081 XVECTOR (this_command_keys
)->contents
);
10084 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10085 doc
: /* Return the key sequence that invoked this command, as a vector.
10086 However, if the command has called `read-key-sequence', it returns
10087 the last key sequence that has been read.
10089 See also `this-command-keys'. */)
10092 return Fvector (this_command_key_count
,
10093 XVECTOR (this_command_keys
)->contents
);
10096 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10097 Sthis_single_command_keys
, 0, 0, 0,
10098 doc
: /* Return the key sequence that invoked this command.
10099 More generally, it returns the last key sequence read, either by
10100 the command loop or by `read-key-sequence'.
10101 Unlike `this-command-keys', this function's value
10102 does not include prefix arguments.
10103 The value is always a vector. */)
10106 return Fvector (this_command_key_count
10107 - this_single_command_key_start
,
10108 (XVECTOR (this_command_keys
)->contents
10109 + this_single_command_key_start
));
10112 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10113 Sthis_single_command_raw_keys
, 0, 0, 0,
10114 doc
: /* Return the raw events that were read for this command.
10115 More generally, it returns the last key sequence read, either by
10116 the command loop or by `read-key-sequence'.
10117 Unlike `this-single-command-keys', this function's value
10118 shows the events before all translations (except for input methods).
10119 The value is always a vector. */)
10122 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10125 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10126 Sreset_this_command_lengths
, 0, 0, 0,
10127 doc
: /* Make the unread events replace the last command and echo.
10128 Used in `universal-argument-other-key'.
10130 `universal-argument-other-key' rereads the event just typed.
10131 It then gets translated through `function-key-map'.
10132 The translated event has to replace the real events,
10133 both in the value of (this-command-keys) and in echoing.
10134 To achieve this, `universal-argument-other-key' calls
10135 `reset-this-command-lengths', which discards the record of reading
10136 these events the first time. */)
10139 this_command_key_count
= before_command_key_count
;
10140 if (this_command_key_count
< this_single_command_key_start
)
10141 this_single_command_key_start
= this_command_key_count
;
10143 echo_truncate (before_command_echo_length
);
10145 /* Cause whatever we put into unread-command-events
10146 to echo as if it were being freshly read from the keyboard. */
10147 this_command_key_count_reset
= 1;
10152 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10153 Sclear_this_command_keys
, 0, 1, 0,
10154 doc
: /* Clear out the vector that `this-command-keys' returns.
10155 Also clear the record of the last 100 events, unless optional arg
10156 KEEP-RECORD is non-nil. */)
10157 (Lisp_Object keep_record
)
10161 this_command_key_count
= 0;
10162 this_command_key_count_reset
= 0;
10164 if (NILP (keep_record
))
10166 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10167 ASET (recent_keys
, i
, Qnil
);
10169 recent_keys_index
= 0;
10174 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10175 doc
: /* Return the current depth in recursive edits. */)
10179 /* Wrap around reliably on integer overflow. */
10180 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10181 XSETINT (temp
, sum
);
10185 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10186 "FOpen dribble file: ",
10187 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10188 If FILE is nil, close any open dribble file.
10189 The file will be closed when Emacs exits.
10191 Be aware that this records ALL characters you type!
10192 This may include sensitive information such as passwords. */)
10205 Lisp_Object encfile
;
10207 file
= Fexpand_file_name (file
, Qnil
);
10208 encfile
= ENCODE_FILE (file
);
10209 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10210 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10211 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10212 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10214 report_file_error ("Opening dribble", file
);
10219 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10220 doc
: /* Discard the contents of the terminal input buffer.
10221 Also end any kbd macro being defined. */)
10224 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10226 /* Discard the last command from the macro. */
10227 Fcancel_kbd_macro_events ();
10231 Vunread_command_events
= Qnil
;
10233 discard_tty_input ();
10235 kbd_fetch_ptr
= kbd_store_ptr
;
10241 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10242 doc
: /* Stop Emacs and return to superior process. You can resume later.
10243 If `cannot-suspend' is non-nil, or if the system doesn't support job
10244 control, run a subshell instead.
10246 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10247 to be read as terminal input by Emacs's parent, after suspension.
10249 Before suspending, run the normal hook `suspend-hook'.
10250 After resumption run the normal hook `suspend-resume-hook'.
10252 Some operating systems cannot stop the Emacs process and resume it later.
10253 On such systems, Emacs starts a subshell instead of suspending. */)
10254 (Lisp_Object stuffstring
)
10256 ptrdiff_t count
= SPECPDL_INDEX ();
10257 int old_height
, old_width
;
10259 struct gcpro gcpro1
;
10262 if (tty_list
&& tty_list
->next
)
10263 error ("There are other tty frames open; close them before suspending Emacs");
10265 if (!NILP (stuffstring
))
10266 CHECK_STRING (stuffstring
);
10268 /* Run the functions in suspend-hook. */
10269 hook
= intern ("suspend-hook");
10270 Frun_hooks (1, &hook
);
10272 GCPRO1 (stuffstring
);
10273 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10274 reset_all_sys_modes ();
10275 /* sys_suspend can get an error if it tries to fork a subshell
10276 and the system resources aren't available for that. */
10277 record_unwind_protect_void (init_all_sys_modes
);
10278 stuff_buffered_input (stuffstring
);
10279 if (cannot_suspend
)
10283 unbind_to (count
, Qnil
);
10285 /* Check if terminal/window size has changed.
10286 Note that this is not useful when we are running directly
10287 with a window system; but suspend should be disabled in that case. */
10288 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10289 if (width
!= old_width
|| height
!= old_height
)
10290 change_frame_size (SELECTED_FRAME (), width
,
10291 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10294 /* Run suspend-resume-hook. */
10295 hook
= intern ("suspend-resume-hook");
10296 Frun_hooks (1, &hook
);
10302 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10303 Then in any case stuff anything Emacs has read ahead and not used. */
10306 stuff_buffered_input (Lisp_Object stuffstring
)
10308 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10309 register unsigned char *p
;
10311 if (STRINGP (stuffstring
))
10313 register ptrdiff_t count
;
10315 p
= SDATA (stuffstring
);
10316 count
= SBYTES (stuffstring
);
10317 while (count
-- > 0)
10322 /* Anything we have read ahead, put back for the shell to read. */
10323 /* ?? What should this do when we have multiple keyboards??
10324 Should we ignore anything that was typed in at the "wrong" kboard?
10326 rms: we should stuff everything back into the kboard
10328 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10331 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10332 kbd_fetch_ptr
= kbd_buffer
;
10333 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10334 stuff_char (kbd_fetch_ptr
->code
);
10336 clear_event (kbd_fetch_ptr
);
10340 #endif /* SIGTSTP */
10344 set_waiting_for_input (struct timespec
*time_to_clear
)
10346 input_available_clear_time
= time_to_clear
;
10348 /* Tell handle_interrupt to throw back to read_char, */
10349 waiting_for_input
= 1;
10351 /* If handle_interrupt was called before and buffered a C-g,
10352 make it run again now, to avoid timing error. */
10353 if (!NILP (Vquit_flag
))
10354 quit_throw_to_read_char (0);
10358 clear_waiting_for_input (void)
10360 /* Tell handle_interrupt not to throw back to read_char, */
10361 waiting_for_input
= 0;
10362 input_available_clear_time
= 0;
10365 /* The SIGINT handler.
10367 If we have a frame on the controlling tty, we assume that the
10368 SIGINT was generated by C-g, so we call handle_interrupt.
10369 Otherwise, tell QUIT to kill Emacs. */
10372 handle_interrupt_signal (int sig
)
10374 /* See if we have an active terminal on our controlling tty. */
10375 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10378 /* If there are no frames there, let's pretend that we are a
10379 well-behaving UN*X program and quit. We must not call Lisp
10380 in a signal handler, so tell QUIT to exit when it is
10382 Vquit_flag
= Qkill_emacs
;
10386 /* Otherwise, the SIGINT was probably generated by C-g. */
10388 /* Set internal_last_event_frame to the top frame of the
10389 controlling tty, if we have a frame there. We disable the
10390 interrupt key on secondary ttys, so the SIGINT must have come
10391 from the controlling tty. */
10392 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10394 handle_interrupt (1);
10399 deliver_interrupt_signal (int sig
)
10401 deliver_process_signal (sig
, handle_interrupt_signal
);
10405 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10406 of the number of times C-g has been requested. If C-g is pressed
10407 enough times, then quit anyway. See bug#6585. */
10408 static int volatile force_quit_count
;
10410 /* This routine is called at interrupt level in response to C-g.
10412 It is called from the SIGINT handler or kbd_buffer_store_event.
10414 If `waiting_for_input' is non zero, then unless `echoing' is
10415 nonzero, immediately throw back to read_char.
10417 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10418 eval to throw, when it gets a chance. If quit-flag is already
10419 non-nil, it stops the job right away. */
10422 handle_interrupt (bool in_signal_handler
)
10428 /* XXX This code needs to be revised for multi-tty support. */
10429 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10431 if (! in_signal_handler
)
10433 /* If SIGINT isn't blocked, don't let us be interrupted by
10434 a SIGINT. It might be harmful due to non-reentrancy
10435 in I/O functions. */
10437 sigemptyset (&blocked
);
10438 sigaddset (&blocked
, SIGINT
);
10439 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10443 reset_all_sys_modes ();
10447 * On systems which can suspend the current process and return to the original
10448 * shell, this command causes the user to end up back at the shell.
10449 * The "Auto-save" and "Abort" questions are not asked until
10450 * the user elects to return to emacs, at which point he can save the current
10451 * job and either dump core or continue.
10455 /* Perhaps should really fork an inferior shell?
10456 But that would not provide any way to get back
10457 to the original shell, ever. */
10458 printf ("No support for stopping a process on this operating system;\n");
10459 printf ("you can continue or abort.\n");
10460 #endif /* not SIGTSTP */
10462 /* We must remain inside the screen area when the internal terminal
10463 is used. Note that [Enter] is not echoed by dos. */
10464 cursor_to (SELECTED_FRAME (), 0, 0);
10466 /* It doesn't work to autosave while GC is in progress;
10467 the code used for auto-saving doesn't cope with the mark bit. */
10468 if (!gc_in_progress
)
10470 printf ("Auto-save? (y or n) ");
10472 if (((c
= getchar ()) & ~040) == 'Y')
10474 Fdo_auto_save (Qt
, Qnil
);
10476 printf ("\r\nAuto-save done");
10477 #else /* not MSDOS */
10478 printf ("Auto-save done\n");
10479 #endif /* not MSDOS */
10481 while (c
!= '\n') c
= getchar ();
10485 /* During GC, it must be safe to reenable quitting again. */
10486 Vinhibit_quit
= Qnil
;
10489 #endif /* not MSDOS */
10490 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10491 printf ("but will instead do a real quit after garbage collection ends\r\n");
10496 printf ("\r\nAbort? (y or n) ");
10497 #else /* not MSDOS */
10498 printf ("Abort (and dump core)? (y or n) ");
10499 #endif /* not MSDOS */
10501 if (((c
= getchar ()) & ~040) == 'Y')
10503 while (c
!= '\n') c
= getchar ();
10505 printf ("\r\nContinuing...\r\n");
10506 #else /* not MSDOS */
10507 printf ("Continuing...\n");
10508 #endif /* not MSDOS */
10510 init_all_sys_modes ();
10514 /* If executing a function that wants to be interrupted out of
10515 and the user has not deferred quitting by binding `inhibit-quit'
10516 then quit right away. */
10517 if (immediate_quit
&& NILP (Vinhibit_quit
))
10519 struct gl_state_s saved
;
10520 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10522 immediate_quit
= 0;
10523 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10525 GCPRO4 (saved
.object
, saved
.global_code
,
10526 saved
.current_syntax_table
, saved
.old_prop
);
10527 Fsignal (Qquit
, Qnil
);
10532 { /* Else request quit when it's safe. */
10533 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10534 force_quit_count
= count
;
10537 immediate_quit
= 1;
10538 Vinhibit_quit
= Qnil
;
10544 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10546 /* TODO: The longjmp in this call throws the NS event loop integration off,
10547 and it seems to do fine without this. Probably some attention
10548 needs to be paid to the setting of waiting_for_input in
10549 wait_reading_process_output() under HAVE_NS because of the call
10550 to ns_select there (needed because otherwise events aren't picked up
10551 outside of polling since we don't get SIGIO like X and we don't have a
10552 separate event loop thread like W32. */
10554 if (waiting_for_input
&& !echoing
)
10555 quit_throw_to_read_char (in_signal_handler
);
10559 /* Handle a C-g by making read_char return C-g. */
10562 quit_throw_to_read_char (bool from_signal
)
10564 /* When not called from a signal handler it is safe to call
10566 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10567 Fkill_emacs (Qnil
);
10569 /* Prevent another signal from doing this before we finish. */
10570 clear_waiting_for_input ();
10573 Vunread_command_events
= Qnil
;
10575 if (FRAMEP (internal_last_event_frame
)
10576 && !EQ (internal_last_event_frame
, selected_frame
))
10577 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10580 sys_longjmp (getcjmp
, 1);
10583 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10584 Sset_input_interrupt_mode
, 1, 1, 0,
10585 doc
: /* Set interrupt mode of reading keyboard input.
10586 If INTERRUPT is non-nil, Emacs will use input interrupts;
10587 otherwise Emacs uses CBREAK mode.
10589 See also `current-input-mode'. */)
10590 (Lisp_Object interrupt
)
10592 bool new_interrupt_input
;
10593 #ifdef USABLE_SIGIO
10594 #ifdef HAVE_X_WINDOWS
10595 if (x_display_list
!= NULL
)
10597 /* When using X, don't give the user a real choice,
10598 because we haven't implemented the mechanisms to support it. */
10599 new_interrupt_input
= 1;
10602 #endif /* HAVE_X_WINDOWS */
10603 new_interrupt_input
= !NILP (interrupt
);
10604 #else /* not USABLE_SIGIO */
10605 new_interrupt_input
= 0;
10606 #endif /* not USABLE_SIGIO */
10608 if (new_interrupt_input
!= interrupt_input
)
10610 #ifdef POLL_FOR_INPUT
10614 /* this causes startup screen to be restored and messes with the mouse */
10615 reset_all_sys_modes ();
10616 interrupt_input
= new_interrupt_input
;
10617 init_all_sys_modes ();
10619 interrupt_input
= new_interrupt_input
;
10622 #ifdef POLL_FOR_INPUT
10623 poll_suppress_count
= 1;
10630 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10631 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10632 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10633 C-q in key sequences.
10635 This setting only has an effect on tty terminals and only when
10636 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10638 See also `current-input-mode'. */)
10639 (Lisp_Object flow
, Lisp_Object terminal
)
10641 struct terminal
*t
= decode_tty_terminal (terminal
);
10642 struct tty_display_info
*tty
;
10646 tty
= t
->display_info
.tty
;
10648 if (tty
->flow_control
!= !NILP (flow
))
10651 /* This causes startup screen to be restored and messes with the mouse. */
10652 reset_sys_modes (tty
);
10655 tty
->flow_control
= !NILP (flow
);
10658 init_sys_modes (tty
);
10664 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10665 doc
: /* Enable or disable 8-bit input on TERMINAL.
10666 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10667 bit as the Meta modifier.
10669 If META is nil, Emacs will ignore the top bit, on the assumption it is
10672 Otherwise, Emacs will accept and pass through 8-bit input without
10673 specially interpreting the top bit.
10675 This setting only has an effect on tty terminal devices.
10677 Optional parameter TERMINAL specifies the tty terminal device to use.
10678 It may be a terminal object, a frame, or nil for the terminal used by
10679 the currently selected frame.
10681 See also `current-input-mode'. */)
10682 (Lisp_Object meta
, Lisp_Object terminal
)
10684 struct terminal
*t
= decode_tty_terminal (terminal
);
10685 struct tty_display_info
*tty
;
10690 tty
= t
->display_info
.tty
;
10694 else if (EQ (meta
, Qt
))
10699 if (tty
->meta_key
!= new_meta
)
10702 /* this causes startup screen to be restored and messes with the mouse */
10703 reset_sys_modes (tty
);
10706 tty
->meta_key
= new_meta
;
10709 init_sys_modes (tty
);
10715 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10716 doc
: /* Specify character used for quitting.
10717 QUIT must be an ASCII character.
10719 This function only has an effect on the controlling tty of the Emacs
10722 See also `current-input-mode'. */)
10725 struct terminal
*t
= get_named_terminal ("/dev/tty");
10726 struct tty_display_info
*tty
;
10730 tty
= t
->display_info
.tty
;
10732 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10733 error ("QUIT must be an ASCII character");
10736 /* this causes startup screen to be restored and messes with the mouse */
10737 reset_sys_modes (tty
);
10740 /* Don't let this value be out of range. */
10741 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10744 init_sys_modes (tty
);
10750 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10751 doc
: /* Set mode of reading keyboard input.
10752 First arg INTERRUPT non-nil means use input interrupts;
10753 nil means use CBREAK mode.
10754 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10755 (no effect except in CBREAK mode).
10756 Third arg META t means accept 8-bit input (for a Meta key).
10757 META nil means ignore the top bit, on the assumption it is parity.
10758 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10759 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10760 See also `current-input-mode'. */)
10761 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10763 Fset_input_interrupt_mode (interrupt
);
10764 Fset_output_flow_control (flow
, Qnil
);
10765 Fset_input_meta_mode (meta
, Qnil
);
10767 Fset_quit_char (quit
);
10771 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10772 doc
: /* Return information about the way Emacs currently reads keyboard input.
10773 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10774 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10775 nil, Emacs is using CBREAK mode.
10776 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10777 terminal; this does not apply if Emacs uses interrupt-driven input.
10778 META is t if accepting 8-bit input with 8th bit as Meta flag.
10779 META nil means ignoring the top bit, on the assumption it is parity.
10780 META is neither t nor nil if accepting 8-bit input and using
10781 all 8 bits as the character code.
10782 QUIT is the character Emacs currently uses to quit.
10783 The elements of this list correspond to the arguments of
10784 `set-input-mode'. */)
10787 Lisp_Object val
[4];
10788 struct frame
*sf
= XFRAME (selected_frame
);
10790 val
[0] = interrupt_input
? Qt
: Qnil
;
10791 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10793 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10794 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10796 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10803 XSETFASTINT (val
[3], quit_char
);
10805 return Flist (ARRAYELTS (val
), val
);
10808 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10809 doc
: /* Return position information for pixel coordinates X and Y.
10810 By default, X and Y are relative to text area of the selected window.
10811 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10812 If optional fourth arg WHOLE is non-nil, X is relative to the left
10813 edge of the window.
10815 The return value is similar to a mouse click position:
10816 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10817 IMAGE (DX . DY) (WIDTH . HEIGHT))
10818 The `posn-' functions access elements of such lists. */)
10819 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10824 if (NILP (frame_or_window
))
10825 frame_or_window
= selected_window
;
10827 if (WINDOWP (frame_or_window
))
10829 struct window
*w
= decode_live_window (frame_or_window
);
10831 XSETINT (x
, (XINT (x
)
10832 + WINDOW_LEFT_EDGE_X (w
)
10834 ? window_box_left_offset (w
, TEXT_AREA
)
10836 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10837 frame_or_window
= w
->frame
;
10840 CHECK_LIVE_FRAME (frame_or_window
);
10842 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10845 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10846 doc
: /* Return position information for buffer POS in WINDOW.
10847 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10849 Return nil if position is not visible in window. Otherwise,
10850 the return value is similar to that returned by `event-start' for
10851 a mouse click at the upper left corner of the glyph corresponding
10852 to the given buffer position:
10853 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10854 IMAGE (DX . DY) (WIDTH . HEIGHT))
10855 The `posn-' functions access elements of such lists. */)
10856 (Lisp_Object pos
, Lisp_Object window
)
10861 window
= selected_window
;
10863 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10866 Lisp_Object x
= XCAR (tem
);
10867 Lisp_Object y
= XCAR (XCDR (tem
));
10869 /* Point invisible due to hscrolling? */
10872 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10878 /* Set up a new kboard object with reasonable initial values.
10879 TYPE is a window system for which this keyboard is used. */
10882 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10884 kset_overriding_terminal_local_map (kb
, Qnil
);
10885 kset_last_command (kb
, Qnil
);
10886 kset_real_last_command (kb
, Qnil
);
10887 kset_keyboard_translate_table (kb
, Qnil
);
10888 kset_last_repeatable_command (kb
, Qnil
);
10889 kset_prefix_arg (kb
, Qnil
);
10890 kset_last_prefix_arg (kb
, Qnil
);
10891 kset_kbd_queue (kb
, Qnil
);
10892 kb
->kbd_queue_has_data
= 0;
10893 kb
->immediate_echo
= 0;
10894 kset_echo_string (kb
, Qnil
);
10895 kb
->echo_after_prompt
= -1;
10896 kb
->kbd_macro_buffer
= 0;
10897 kb
->kbd_macro_bufsize
= 0;
10898 kset_defining_kbd_macro (kb
, Qnil
);
10899 kset_last_kbd_macro (kb
, Qnil
);
10900 kb
->reference_count
= 0;
10901 kset_system_key_alist (kb
, Qnil
);
10902 kset_system_key_syms (kb
, Qnil
);
10903 kset_window_system (kb
, type
);
10904 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10905 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10906 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10907 kset_default_minibuffer_frame (kb
, Qnil
);
10910 /* Allocate and basically initialize keyboard
10911 object to use with window system TYPE. */
10914 allocate_kboard (Lisp_Object type
)
10916 KBOARD
*kb
= xmalloc (sizeof *kb
);
10918 init_kboard (kb
, type
);
10919 kb
->next_kboard
= all_kboards
;
10925 * Destroy the contents of a kboard object, but not the object itself.
10926 * We use this just before deleting it, or if we're going to initialize
10927 * it a second time.
10930 wipe_kboard (KBOARD
*kb
)
10932 xfree (kb
->kbd_macro_buffer
);
10935 /* Free KB and memory referenced from it. */
10938 delete_kboard (KBOARD
*kb
)
10942 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10945 *kbp
= kb
->next_kboard
;
10947 /* Prevent a dangling reference to KB. */
10948 if (kb
== current_kboard
10949 && FRAMEP (selected_frame
)
10950 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10952 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10954 if (current_kboard
== kb
)
10963 init_keyboard (void)
10965 /* This is correct before outermost invocation of the editor loop. */
10966 command_loop_level
= -1;
10967 immediate_quit
= 0;
10968 quit_char
= Ctl ('g');
10969 Vunread_command_events
= Qnil
;
10970 timer_idleness_start_time
= invalid_timespec ();
10972 recent_keys_index
= 0;
10973 kbd_fetch_ptr
= kbd_buffer
;
10974 kbd_store_ptr
= kbd_buffer
;
10975 do_mouse_tracking
= Qnil
;
10977 interrupt_input_blocked
= 0;
10978 pending_signals
= 0;
10980 /* This means that command_loop_1 won't try to select anything the first
10982 internal_last_event_frame
= Qnil
;
10983 Vlast_event_frame
= internal_last_event_frame
;
10985 current_kboard
= initial_kboard
;
10986 /* Re-initialize the keyboard again. */
10987 wipe_kboard (current_kboard
);
10988 /* A value of nil for Vwindow_system normally means a tty, but we also use
10989 it for the initial terminal since there is no window system there. */
10990 init_kboard (current_kboard
, Qnil
);
10992 if (!noninteractive
)
10994 /* Before multi-tty support, these handlers used to be installed
10995 only if the current session was a tty session. Now an Emacs
10996 session may have multiple display types, so we always handle
10997 SIGINT. There is special code in handle_interrupt_signal to exit
10998 Emacs on SIGINT when there are no termcap frames on the
10999 controlling terminal. */
11000 struct sigaction action
;
11001 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
11002 sigaction (SIGINT
, &action
, 0);
11004 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
11005 SIGQUIT and we can't tell which one it will give us. */
11006 sigaction (SIGQUIT
, &action
, 0);
11007 #endif /* not DOS_NT */
11009 #ifdef USABLE_SIGIO
11010 if (!noninteractive
)
11012 struct sigaction action
;
11013 emacs_sigaction_init (&action
, deliver_input_available_signal
);
11014 sigaction (SIGIO
, &action
, 0);
11018 /* Use interrupt input by default, if it works and noninterrupt input
11019 has deficiencies. */
11021 #ifdef INTERRUPT_INPUT
11022 interrupt_input
= 1;
11024 interrupt_input
= 0;
11027 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11030 if (keyboard_init_hook
)
11031 (*keyboard_init_hook
) ();
11033 #ifdef POLL_FOR_INPUT
11035 poll_suppress_count
= 1;
11040 /* This type's only use is in syms_of_keyboard, to initialize the
11041 event header symbols and put properties on them. */
11042 struct event_head
{
11048 static const struct event_head head_table
[] = {
11049 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11050 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11051 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11052 {&Qfocus_in
, "focus-in", &Qfocus_in
},
11053 {&Qfocus_out
, "focus-out", &Qfocus_out
},
11054 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11055 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11056 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11057 /* `select-window' should be handled just like `switch-frame'
11058 in read_key_sequence. */
11059 {&Qselect_window
, "select-window", &Qswitch_frame
}
11063 syms_of_keyboard (void)
11065 pending_funcalls
= Qnil
;
11066 staticpro (&pending_funcalls
);
11068 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11069 staticpro (&Vlispy_mouse_stem
);
11071 regular_top_level_message
= build_pure_c_string ("Back to top level");
11072 #ifdef HAVE_STACK_OVERFLOW_HANDLING
11073 recover_top_level_message
11074 = build_pure_c_string ("Re-entering top level after C stack overflow");
11076 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
11077 doc
: /* Message displayed by `normal-top-level'. */);
11078 Vinternal__top_level_message
= regular_top_level_message
;
11081 DEFSYM (QCimage
, ":image");
11082 DEFSYM (Qhelp_echo
, "help-echo");
11083 DEFSYM (QCrtl
, ":rtl");
11085 staticpro (&item_properties
);
11086 item_properties
= Qnil
;
11088 staticpro (&tool_bar_item_properties
);
11089 tool_bar_item_properties
= Qnil
;
11090 staticpro (&tool_bar_items_vector
);
11091 tool_bar_items_vector
= Qnil
;
11093 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11094 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11095 DEFSYM (Qself_insert_command
, "self-insert-command");
11096 DEFSYM (Qforward_char
, "forward-char");
11097 DEFSYM (Qbackward_char
, "backward-char");
11098 DEFSYM (Qdisabled
, "disabled");
11099 DEFSYM (Qundefined
, "undefined");
11100 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11101 DEFSYM (Qpost_command_hook
, "post-command-hook");
11102 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11103 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11104 DEFSYM (Qfunction_key
, "function-key");
11105 DEFSYM (Qmouse_click
, "mouse-click");
11106 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11107 DEFSYM (Qsave_session
, "save-session");
11108 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11109 DEFSYM (Qmenu_enable
, "menu-enable");
11112 DEFSYM (Qlanguage_change
, "language-change");
11116 DEFSYM (Qdbus_event
, "dbus-event");
11119 #ifdef USE_FILE_NOTIFY
11120 DEFSYM (Qfile_notify
, "file-notify");
11121 #endif /* USE_FILE_NOTIFY */
11123 DEFSYM (QCenable
, ":enable");
11124 DEFSYM (QCvisible
, ":visible");
11125 DEFSYM (QChelp
, ":help");
11126 DEFSYM (QCfilter
, ":filter");
11127 DEFSYM (QCbutton
, ":button");
11128 DEFSYM (QCkeys
, ":keys");
11129 DEFSYM (QCkey_sequence
, ":key-sequence");
11130 DEFSYM (QCtoggle
, ":toggle");
11131 DEFSYM (QCradio
, ":radio");
11132 DEFSYM (QClabel
, ":label");
11133 DEFSYM (QCvert_only
, ":vert-only");
11135 DEFSYM (Qmode_line
, "mode-line");
11136 DEFSYM (Qvertical_line
, "vertical-line");
11137 DEFSYM (Qmenu_bar
, "menu-bar");
11138 DEFSYM (Qright_divider
, "right-divider");
11139 DEFSYM (Qbottom_divider
, "bottom-divider");
11141 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11143 DEFSYM (Qabove_handle
, "above-handle");
11144 DEFSYM (Qhandle
, "handle");
11145 DEFSYM (Qbelow_handle
, "below-handle");
11146 DEFSYM (Qup
, "up");
11147 DEFSYM (Qdown
, "down");
11148 DEFSYM (Qtop
, "top");
11149 DEFSYM (Qbottom
, "bottom");
11150 DEFSYM (Qend_scroll
, "end-scroll");
11151 DEFSYM (Qratio
, "ratio");
11152 DEFSYM (Qbefore_handle
, "before-handle");
11153 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11154 DEFSYM (Qafter_handle
, "after-handle");
11155 DEFSYM (Qleft
, "left");
11156 DEFSYM (Qright
, "right");
11157 DEFSYM (Qleftmost
, "leftmost");
11158 DEFSYM (Qrightmost
, "rightmost");
11160 DEFSYM (Qevent_kind
, "event-kind");
11161 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11162 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11163 DEFSYM (Qmodifier_cache
, "modifier-cache");
11165 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11166 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11168 DEFSYM (Qpolling_period
, "polling-period");
11170 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11171 DEFSYM (QPRIMARY
, "PRIMARY");
11172 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11173 DEFSYM (Qhandle_select_window
, "handle-select-window");
11175 DEFSYM (Qinput_method_function
, "input-method-function");
11176 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11177 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11179 DEFSYM (Qhelp_form_show
, "help-form-show");
11181 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11183 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11184 Fset (Qinput_method_use_echo_area
, Qnil
);
11188 int len
= ARRAYELTS (head_table
);
11190 for (i
= 0; i
< len
; i
++)
11192 const struct event_head
*p
= &head_table
[i
];
11193 *p
->var
= intern_c_string (p
->name
);
11194 staticpro (p
->var
);
11195 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11196 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11200 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11201 staticpro (&button_down_location
);
11202 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11203 staticpro (&mouse_syms
);
11204 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11206 staticpro (&wheel_syms
);
11210 int len
= ARRAYELTS (modifier_names
);
11212 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11213 for (i
= 0; i
< len
; i
++)
11214 if (modifier_names
[i
])
11215 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11216 staticpro (&modifier_symbols
);
11219 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11220 staticpro (&recent_keys
);
11222 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11223 staticpro (&this_command_keys
);
11225 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11226 staticpro (&raw_keybuf
);
11228 DEFSYM (Qcommand_execute
, "command-execute");
11230 accent_key_syms
= Qnil
;
11231 staticpro (&accent_key_syms
);
11233 func_key_syms
= Qnil
;
11234 staticpro (&func_key_syms
);
11236 drag_n_drop_syms
= Qnil
;
11237 staticpro (&drag_n_drop_syms
);
11239 unread_switch_frame
= Qnil
;
11240 staticpro (&unread_switch_frame
);
11242 internal_last_event_frame
= Qnil
;
11243 staticpro (&internal_last_event_frame
);
11245 read_key_sequence_cmd
= Qnil
;
11246 staticpro (&read_key_sequence_cmd
);
11247 read_key_sequence_remapped
= Qnil
;
11248 staticpro (&read_key_sequence_remapped
);
11250 menu_bar_one_keymap_changed_items
= Qnil
;
11251 staticpro (&menu_bar_one_keymap_changed_items
);
11253 menu_bar_items_vector
= Qnil
;
11254 staticpro (&menu_bar_items_vector
);
11256 help_form_saved_window_configs
= Qnil
;
11257 staticpro (&help_form_saved_window_configs
);
11259 defsubr (&Scurrent_idle_time
);
11260 defsubr (&Sevent_symbol_parse_modifiers
);
11261 defsubr (&Sevent_convert_list
);
11262 defsubr (&Sread_key_sequence
);
11263 defsubr (&Sread_key_sequence_vector
);
11264 defsubr (&Srecursive_edit
);
11265 defsubr (&Strack_mouse
);
11266 defsubr (&Sinput_pending_p
);
11267 defsubr (&Srecent_keys
);
11268 defsubr (&Sthis_command_keys
);
11269 defsubr (&Sthis_command_keys_vector
);
11270 defsubr (&Sthis_single_command_keys
);
11271 defsubr (&Sthis_single_command_raw_keys
);
11272 defsubr (&Sreset_this_command_lengths
);
11273 defsubr (&Sclear_this_command_keys
);
11274 defsubr (&Ssuspend_emacs
);
11275 defsubr (&Sabort_recursive_edit
);
11276 defsubr (&Sexit_recursive_edit
);
11277 defsubr (&Srecursion_depth
);
11278 defsubr (&Scommand_error_default_function
);
11279 defsubr (&Stop_level
);
11280 defsubr (&Sdiscard_input
);
11281 defsubr (&Sopen_dribble_file
);
11282 defsubr (&Sset_input_interrupt_mode
);
11283 defsubr (&Sset_output_flow_control
);
11284 defsubr (&Sset_input_meta_mode
);
11285 defsubr (&Sset_quit_char
);
11286 defsubr (&Sset_input_mode
);
11287 defsubr (&Scurrent_input_mode
);
11288 defsubr (&Sposn_at_point
);
11289 defsubr (&Sposn_at_x_y
);
11291 DEFVAR_LISP ("last-command-event", last_command_event
,
11292 doc
: /* Last input event that was part of a command. */);
11294 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11295 doc
: /* Last input event in a command, except for mouse menu events.
11296 Mouse menus give back keys that don't look like mouse events;
11297 this variable holds the actual mouse event that led to the menu,
11298 so that you can determine whether the command was run by mouse or not. */);
11300 DEFVAR_LISP ("last-input-event", last_input_event
,
11301 doc
: /* Last input event. */);
11303 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11304 doc
: /* List of events to be read as the command input.
11305 These events are processed first, before actual keyboard input.
11306 Events read from this list are not normally added to `this-command-keys',
11307 as they will already have been added once as they were read for the first time.
11308 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11309 Vunread_command_events
= Qnil
;
11311 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11312 doc
: /* List of events to be processed as input by input methods.
11313 These events are processed before `unread-command-events'
11314 and actual keyboard input, but are not given to `input-method-function'. */);
11315 Vunread_post_input_method_events
= Qnil
;
11317 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11318 doc
: /* List of events to be processed as input by input methods.
11319 These events are processed after `unread-command-events', but
11320 before actual keyboard input.
11321 If there's an active input method, the events are given to
11322 `input-method-function'. */);
11323 Vunread_input_method_events
= Qnil
;
11325 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11326 doc
: /* Meta-prefix character code.
11327 Meta-foo as command input turns into this character followed by foo. */);
11328 XSETINT (meta_prefix_char
, 033);
11330 DEFVAR_KBOARD ("last-command", Vlast_command
,
11331 doc
: /* The last command executed.
11332 Normally a symbol with a function definition, but can be whatever was found
11333 in the keymap, or whatever the variable `this-command' was set to by that
11336 The value `mode-exit' is special; it means that the previous command
11337 read an event that told it to exit, and it did so and unread that event.
11338 In other words, the present command is the event that made the previous
11341 The value `kill-region' is special; it means that the previous command
11342 was a kill command.
11344 `last-command' has a separate binding for each terminal device.
11345 See Info node `(elisp)Multiple Terminals'. */);
11347 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11348 doc
: /* Same as `last-command', but never altered by Lisp code.
11349 Taken from the previous value of `real-this-command'. */);
11351 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11352 doc
: /* Last command that may be repeated.
11353 The last command executed that was not bound to an input event.
11354 This is the command `repeat' will try to repeat.
11355 Taken from a previous value of `real-this-command'. */);
11357 DEFVAR_LISP ("this-command", Vthis_command
,
11358 doc
: /* The command now being executed.
11359 The command can set this variable; whatever is put here
11360 will be in `last-command' during the following command. */);
11361 Vthis_command
= Qnil
;
11363 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11364 doc
: /* This is like `this-command', except that commands should never modify it. */);
11365 Vreal_this_command
= Qnil
;
11367 DEFVAR_LISP ("this-command-keys-shift-translated",
11368 Vthis_command_keys_shift_translated
,
11369 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11370 Shift-translation occurs when there is no binding for the key sequence
11371 as entered, but a binding was found by changing an upper-case letter
11372 to lower-case, or a shifted function key to an unshifted one. */);
11373 Vthis_command_keys_shift_translated
= Qnil
;
11375 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11376 doc
: /* The command bound to the current key sequence before remapping.
11377 It equals `this-command' if the original command was not remapped through
11378 any of the active keymaps. Otherwise, the value of `this-command' is the
11379 result of looking up the original command in the active keymaps. */);
11380 Vthis_original_command
= Qnil
;
11382 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11383 doc
: /* Number of input events between auto-saves.
11384 Zero means disable autosaving due to number of characters typed. */);
11385 auto_save_interval
= 300;
11387 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11388 doc
: /* Number of seconds idle time before auto-save.
11389 Zero or nil means disable auto-saving due to idleness.
11390 After auto-saving due to this many seconds of idle time,
11391 Emacs also does a garbage collection if that seems to be warranted. */);
11392 XSETFASTINT (Vauto_save_timeout
, 30);
11394 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11395 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11396 The value may be integer or floating point.
11397 If the value is zero, don't echo at all. */);
11398 Vecho_keystrokes
= make_number (1);
11400 DEFVAR_INT ("polling-period", polling_period
,
11401 doc
: /* Interval between polling for input during Lisp execution.
11402 The reason for polling is to make C-g work to stop a running program.
11403 Polling is needed only when using X windows and SIGIO does not work.
11404 Polling is automatically disabled in all other cases. */);
11405 polling_period
= 2;
11407 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11408 doc
: /* Maximum time between mouse clicks to make a double-click.
11409 Measured in milliseconds. The value nil means disable double-click
11410 recognition; t means double-clicks have no time limit and are detected
11411 by position only. */);
11412 Vdouble_click_time
= make_number (500);
11414 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11415 doc
: /* Maximum mouse movement between clicks to make a double-click.
11416 On window-system frames, value is the number of pixels the mouse may have
11417 moved horizontally or vertically between two clicks to make a double-click.
11418 On non window-system frames, value is interpreted in units of 1/8 characters
11421 This variable is also the threshold for motion of the mouse
11422 to count as a drag. */);
11423 double_click_fuzz
= 3;
11425 DEFVAR_INT ("num-input-keys", num_input_keys
,
11426 doc
: /* Number of complete key sequences read as input so far.
11427 This includes key sequences read from keyboard macros.
11428 The number is effectively the number of interactive command invocations. */);
11429 num_input_keys
= 0;
11431 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11432 doc
: /* Number of input events read from the keyboard so far.
11433 This does not include events generated by keyboard macros. */);
11434 num_nonmacro_input_events
= 0;
11436 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11437 doc
: /* The frame in which the most recently read event occurred.
11438 If the last event came from a keyboard macro, this is set to `macro'. */);
11439 Vlast_event_frame
= Qnil
;
11441 /* This variable is set up in sysdep.c. */
11442 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11443 doc
: /* The ERASE character as set by the user with stty. */);
11445 DEFVAR_LISP ("help-char", Vhelp_char
,
11446 doc
: /* Character to recognize as meaning Help.
11447 When it is read, do `(eval help-form)', and display result if it's a string.
11448 If the value of `help-form' is nil, this char can be read normally. */);
11449 XSETINT (Vhelp_char
, Ctl ('H'));
11451 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11452 doc
: /* List of input events to recognize as meaning Help.
11453 These work just like the value of `help-char' (see that). */);
11454 Vhelp_event_list
= Qnil
;
11456 DEFVAR_LISP ("help-form", Vhelp_form
,
11457 doc
: /* Form to execute when character `help-char' is read.
11458 If the form returns a string, that string is displayed.
11459 If `help-form' is nil, the help char is not recognized. */);
11462 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11463 doc
: /* Command to run when `help-char' character follows a prefix key.
11464 This command is used only when there is no actual binding
11465 for that character after that prefix key. */);
11466 Vprefix_help_command
= Qnil
;
11468 DEFVAR_LISP ("top-level", Vtop_level
,
11469 doc
: /* Form to evaluate when Emacs starts up.
11470 Useful to set before you dump a modified Emacs. */);
11473 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11474 doc
: /* Translate table for local keyboard input, or nil.
11475 If non-nil, the value should be a char-table. Each character read
11476 from the keyboard is looked up in this char-table. If the value found
11477 there is non-nil, then it is used instead of the actual input character.
11479 The value can also be a string or vector, but this is considered obsolete.
11480 If it is a string or vector of length N, character codes N and up are left
11481 untranslated. In a vector, an element which is nil means "no translation".
11483 This is applied to the characters supplied to input methods, not their
11484 output. See also `translation-table-for-input'.
11486 This variable has a separate binding for each terminal.
11487 See Info node `(elisp)Multiple Terminals'. */);
11489 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11490 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11491 \(Even if the operating system has support for stopping a process.\) */);
11492 cannot_suspend
= 0;
11494 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11495 doc
: /* Non-nil means prompt with menus when appropriate.
11496 This is done when reading from a keymap that has a prompt string,
11497 for elements that have prompt strings.
11498 The menu is displayed on the screen
11499 if X menus were enabled at configuration
11500 time and the previous event was a mouse click prefix key.
11501 Otherwise, menu prompting uses the echo area. */);
11502 menu_prompting
= 1;
11504 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11505 doc
: /* Character to see next line of menu prompt.
11506 Type this character while in a menu prompt to rotate around the lines of it. */);
11507 XSETINT (menu_prompt_more_char
, ' ');
11509 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11510 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11511 Emacs applies the modifiers of the character stored here to each keyboard
11512 character it reads. For example, after evaluating the expression
11513 (setq extra-keyboard-modifiers ?\\C-x)
11514 all input characters will have the control modifier applied to them.
11516 Note that the character ?\\C-@, equivalent to the integer zero, does
11517 not count as a control character; rather, it counts as a character
11518 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11519 cancels any modification. */);
11520 extra_keyboard_modifiers
= 0;
11522 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11523 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11524 The command loop sets this to nil before each command,
11525 and tests the value when the command returns.
11526 Buffer modification stores t in this variable. */);
11527 Vdeactivate_mark
= Qnil
;
11528 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11529 Fmake_variable_buffer_local (Qdeactivate_mark
);
11531 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11532 doc
: /* Normal hook run before each command is executed.
11533 If an unhandled error happens in running this hook,
11534 the function in which the error occurred is unconditionally removed, since
11535 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11536 Vpre_command_hook
= Qnil
;
11538 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11539 doc
: /* Normal hook run after each command is executed.
11540 If an unhandled error happens in running this hook,
11541 the function in which the error occurred is unconditionally removed, since
11542 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11543 Vpost_command_hook
= Qnil
;
11546 DEFVAR_LISP ("echo-area-clear-hook", ...,
11547 doc
: /* Normal hook run when clearing the echo area. */);
11549 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11550 Fset (Qecho_area_clear_hook
, Qnil
);
11552 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11553 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11554 Vlucid_menu_bar_dirty_flag
= Qnil
;
11556 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11557 doc
: /* List of menu bar items to move to the end of the menu bar.
11558 The elements of the list are event types that may have menu bar bindings. */);
11559 Vmenu_bar_final_items
= Qnil
;
11561 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11562 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11563 This is used internally by graphical displays that do not render
11564 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11565 Vtool_bar_separator_image_expression
= Qnil
;
11567 DEFVAR_KBOARD ("overriding-terminal-local-map",
11568 Voverriding_terminal_local_map
,
11569 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11570 This variable is intended to let commands such as `universal-argument'
11571 set up a different keymap for reading the next command.
11573 `overriding-terminal-local-map' has a separate binding for each
11574 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11576 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11577 doc
: /* Keymap that replaces (overrides) local keymaps.
11578 If this variable is non-nil, Emacs looks up key bindings in this
11579 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11580 buffer's local map. Hence, the only active keymaps would be
11581 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11582 order of precedence. */);
11583 Voverriding_local_map
= Qnil
;
11585 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11586 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11587 Otherwise, the menu bar continues to reflect the buffer's local map
11588 and the minor mode maps regardless of `overriding-local-map'. */);
11589 Voverriding_local_map_menu_flag
= Qnil
;
11591 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11592 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11593 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11595 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11596 doc
: /* Non-nil means generate motion events for mouse motion. */);
11598 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11599 doc
: /* Alist of system-specific X windows key symbols.
11600 Each element should have the form (N . SYMBOL) where N is the
11601 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11602 and SYMBOL is its name.
11604 `system-key-alist' has a separate binding for each terminal device.
11605 See Info node `(elisp)Multiple Terminals'. */);
11607 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11608 doc
: /* Keymap that translates key sequences to key sequences during input.
11609 This is used mainly for mapping key sequences into some preferred
11610 key events (symbols).
11612 The `read-key-sequence' function replaces any subsequence bound by
11613 `local-function-key-map' with its binding. More precisely, when the
11614 active keymaps have no binding for the current key sequence but
11615 `local-function-key-map' binds a suffix of the sequence to a vector or
11616 string, `read-key-sequence' replaces the matching suffix with its
11617 binding, and continues with the new sequence.
11619 If the binding is a function, it is called with one argument (the prompt)
11620 and its return value (a key sequence) is used.
11622 The events that come from bindings in `local-function-key-map' are not
11623 themselves looked up in `local-function-key-map'.
11625 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11626 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11627 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11628 typing `ESC O P x' would return [f1 x].
11630 `local-function-key-map' has a separate binding for each terminal
11631 device. See Info node `(elisp)Multiple Terminals'. If you need to
11632 define a binding on all terminals, change `function-key-map'
11633 instead. Initially, `local-function-key-map' is an empty keymap that
11634 has `function-key-map' as its parent on all terminal devices. */);
11636 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11637 doc
: /* Keymap that decodes input escape sequences.
11638 This is used mainly for mapping ASCII function key sequences into
11639 real Emacs function key events (symbols).
11641 The `read-key-sequence' function replaces any subsequence bound by
11642 `input-decode-map' with its binding. Contrary to `function-key-map',
11643 this map applies its rebinding regardless of the presence of an ordinary
11644 binding. So it is more like `key-translation-map' except that it applies
11645 before `function-key-map' rather than after.
11647 If the binding is a function, it is called with one argument (the prompt)
11648 and its return value (a key sequence) is used.
11650 The events that come from bindings in `input-decode-map' are not
11651 themselves looked up in `input-decode-map'. */);
11653 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11654 doc
: /* The parent keymap of all `local-function-key-map' instances.
11655 Function key definitions that apply to all terminal devices should go
11656 here. If a mapping is defined in both the current
11657 `local-function-key-map' binding and this variable, then the local
11658 definition will take precedence. */);
11659 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11661 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11662 doc
: /* Keymap of key translations that can override keymaps.
11663 This keymap works like `input-decode-map', but comes after `function-key-map'.
11664 Another difference is that it is global rather than terminal-local. */);
11665 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11667 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11668 doc
: /* List of deferred actions to be performed at a later time.
11669 The precise format isn't relevant here; we just check whether it is nil. */);
11670 Vdeferred_action_list
= Qnil
;
11672 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11673 doc
: /* Function to call to handle deferred actions, after each command.
11674 This function is called with no arguments after each command
11675 whenever `deferred-action-list' is non-nil. */);
11676 Vdeferred_action_function
= Qnil
;
11678 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11679 doc
: /* List of warnings to be displayed after this command.
11680 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11681 as per the args of `display-warning' (which see).
11682 If this variable is non-nil, `delayed-warnings-hook' will be run
11683 immediately after running `post-command-hook'. */);
11684 Vdelayed_warnings_list
= Qnil
;
11686 DEFVAR_LISP ("timer-list", Vtimer_list
,
11687 doc
: /* List of active absolute time timers in order of increasing time. */);
11688 Vtimer_list
= Qnil
;
11690 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11691 doc
: /* List of active idle-time timers in order of increasing time. */);
11692 Vtimer_idle_list
= Qnil
;
11694 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11695 doc
: /* If non-nil, the function that implements the current input method.
11696 It's called with one argument, a printing character that was just read.
11697 \(That means a character with code 040...0176.)
11698 Typically this function uses `read-event' to read additional events.
11699 When it does so, it should first bind `input-method-function' to nil
11700 so it will not be called recursively.
11702 The function should return a list of zero or more events
11703 to be used as input. If it wants to put back some events
11704 to be reconsidered, separately, by the input method,
11705 it can add them to the beginning of `unread-command-events'.
11707 The input method function can find in `input-method-previous-message'
11708 the previous echo area message.
11710 The input method function should refer to the variables
11711 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11712 for guidance on what to do. */);
11713 Vinput_method_function
= Qnil
;
11715 DEFVAR_LISP ("input-method-previous-message",
11716 Vinput_method_previous_message
,
11717 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11718 This variable exists because `read-event' clears the echo area
11719 before running the input method. It is nil if there was no message. */);
11720 Vinput_method_previous_message
= Qnil
;
11722 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11723 doc
: /* If non-nil, the function that implements the display of help.
11724 It's called with one argument, the help string to display. */);
11725 Vshow_help_function
= Qnil
;
11727 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11728 doc
: /* If non-nil, suppress point adjustment after executing a command.
11730 After a command is executed, if point is moved into a region that has
11731 special properties (e.g. composition, display), we adjust point to
11732 the boundary of the region. But, when a command sets this variable to
11733 non-nil, we suppress the point adjustment.
11735 This variable is set to nil before reading a command, and is checked
11736 just after executing the command. */);
11737 Vdisable_point_adjustment
= Qnil
;
11739 DEFVAR_LISP ("global-disable-point-adjustment",
11740 Vglobal_disable_point_adjustment
,
11741 doc
: /* If non-nil, always suppress point adjustment.
11743 The default value is nil, in which case, point adjustment are
11744 suppressed only after special commands that set
11745 `disable-point-adjustment' (which see) to non-nil. */);
11746 Vglobal_disable_point_adjustment
= Qnil
;
11748 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11749 doc
: /* How long to display an echo-area message when the minibuffer is active.
11750 If the value is not a number, such messages don't time out. */);
11751 Vminibuffer_message_timeout
= make_number (2);
11753 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11754 doc
: /* If non-nil, any keyboard input throws to this symbol.
11755 The value of that variable is passed to `quit-flag' and later causes a
11756 peculiar kind of quitting. */);
11757 Vthrow_on_input
= Qnil
;
11759 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11760 doc
: /* Function to output error messages.
11761 Called with three arguments:
11762 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11763 such as what `condition-case' would bind its variable to,
11764 - the context (a string which normally goes at the start of the message),
11765 - the Lisp function within which the error was signaled. */);
11766 Vcommand_error_function
= intern ("command-error-default-function");
11768 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11769 Venable_disabled_menus_and_buttons
,
11770 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11772 Help functions bind this to allow help on disabled menu items
11773 and tool-bar buttons. */);
11774 Venable_disabled_menus_and_buttons
= Qnil
;
11776 DEFVAR_LISP ("select-active-regions",
11777 Vselect_active_regions
,
11778 doc
: /* If non-nil, an active region automatically sets the primary selection.
11779 If the value is `only', only temporarily active regions (usually made
11780 by mouse-dragging or shift-selection) set the window selection.
11782 This takes effect only when Transient Mark mode is enabled. */);
11783 Vselect_active_regions
= Qt
;
11785 DEFVAR_LISP ("saved-region-selection",
11786 Vsaved_region_selection
,
11787 doc
: /* Contents of active region prior to buffer modification.
11788 If `select-active-regions' is non-nil, Emacs sets this to the
11789 text in the region before modifying the buffer. The next call to
11790 the function `deactivate-mark' uses this to set the window selection. */);
11791 Vsaved_region_selection
= Qnil
;
11793 DEFVAR_LISP ("selection-inhibit-update-commands",
11794 Vselection_inhibit_update_commands
,
11795 doc
: /* List of commands which should not update the selection.
11796 Normally, if `select-active-regions' is non-nil and the mark remains
11797 active after a command (i.e. the mark was not deactivated), the Emacs
11798 command loop sets the selection to the text in the region. However,
11799 if the command is in this list, the selection is not updated. */);
11800 Vselection_inhibit_update_commands
11801 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11803 DEFVAR_LISP ("debug-on-event",
11805 doc
: /* Enter debugger on this event. When Emacs
11806 receives the special event specified by this variable, it will try to
11807 break into the debugger as soon as possible instead of processing the
11808 event normally through `special-event-map'.
11810 Currently, the only supported values for this
11811 variable are `sigusr1' and `sigusr2'. */);
11812 Vdebug_on_event
= intern_c_string ("sigusr2");
11814 /* Create the initial keyboard. Qt means 'unset'. */
11815 initial_kboard
= allocate_kboard (Qt
);
11819 keys_of_keyboard (void)
11821 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11822 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11823 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11824 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11825 initial_define_key (meta_map
, 'x', "execute-extended-command");
11827 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11828 "handle-delete-frame");
11829 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11830 "ns-put-working-text");
11831 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11832 "ns-unput-working-text");
11833 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11834 current-prefix-arg, as is done in `handle-switch-frame'.
11835 But `handle-switch-frame is not run from the special-map.
11836 Commands from that map are run in a special way that automatically
11837 preserves the prefix-arg. Restoring the prefix arg here is not just
11838 redundant but harmful:
11840 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11841 - after the first prompt, the exit-minibuffer-hook is run which may
11842 iconify a frame and thus push a `iconify-frame' event.
11843 - after running exit-minibuffer-hook, current-prefix-arg is
11844 restored to the non-nil value it had before the prompt.
11845 - we enter the second prompt.
11846 current-prefix-arg is non-nil, prefix-arg is nil.
11847 - before running the first real event, we run the special iconify-frame
11848 event, but we pass the `special' arg to execute-command so
11849 current-prefix-arg and prefix-arg are left untouched.
11850 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11851 - the next key event will have a spuriously non-nil current-prefix-arg. */
11852 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11854 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11856 /* Handling it at such a low-level causes read_key_sequence to get
11857 * confused because it doesn't realize that the current_buffer was
11858 * changed by read_char.
11860 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11861 * "handle-select-window"); */
11862 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11863 "handle-save-session");
11866 /* Define a special event which is raised for dbus callback
11868 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11869 "dbus-handle-event");
11872 #ifdef USE_FILE_NOTIFY
11873 /* Define a special event which is raised for notification callback
11875 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11876 "file-notify-handle-event");
11877 #endif /* USE_FILE_NOTIFY */
11879 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11881 #if defined (WINDOWSNT)
11882 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11885 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11886 "handle-focus-in");
11887 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11888 "handle-focus-out");
11891 /* Mark the pointers in the kboard objects.
11892 Called by Fgarbage_collect. */
11894 mark_kboards (void)
11898 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11900 if (kb
->kbd_macro_buffer
)
11901 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11903 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11904 mark_object (KVAR (kb
, Vlast_command
));
11905 mark_object (KVAR (kb
, Vreal_last_command
));
11906 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11907 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11908 mark_object (KVAR (kb
, Vprefix_arg
));
11909 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11910 mark_object (KVAR (kb
, kbd_queue
));
11911 mark_object (KVAR (kb
, defining_kbd_macro
));
11912 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11913 mark_object (KVAR (kb
, Vsystem_key_alist
));
11914 mark_object (KVAR (kb
, system_key_syms
));
11915 mark_object (KVAR (kb
, Vwindow_system
));
11916 mark_object (KVAR (kb
, Vinput_decode_map
));
11917 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11918 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11919 mark_object (KVAR (kb
, echo_string
));
11922 struct input_event
*event
;
11923 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11925 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11926 event
= kbd_buffer
;
11927 /* These two special event types has no Lisp_Objects to mark. */
11928 if (event
->kind
!= SELECTION_REQUEST_EVENT
11929 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11931 mark_object (event
->x
);
11932 mark_object (event
->y
);
11933 mark_object (event
->frame_or_window
);
11934 mark_object (event
->arg
);