1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2016 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
30 #include "termhooks.h"
35 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #if defined USABLE_FIONREAD && defined USG5_4
58 # include <sys/filio.h>
61 #include "syssignal.h"
63 #include <sys/types.h>
67 #include <ignore-value.h>
69 #ifdef HAVE_WINDOW_SYSTEM
71 #endif /* HAVE_WINDOW_SYSTEM */
73 /* Variables for blockinput.h: */
75 /* Positive if interrupt input is blocked right now. */
76 volatile int interrupt_input_blocked
;
78 /* True means an input interrupt or alarm signal has arrived.
79 The QUIT macro checks this. */
80 volatile bool pending_signals
;
82 #define KBD_BUFFER_SIZE 4096
84 KBOARD
*initial_kboard
;
85 KBOARD
*current_kboard
;
86 static KBOARD
*all_kboards
;
88 /* True in the single-kboard state, false in the any-kboard state. */
89 static bool single_kboard
;
91 #define NUM_RECENT_KEYS (300)
93 /* Index for storing next element into recent_keys. */
94 static int recent_keys_index
;
96 /* Total number of elements stored into recent_keys. */
97 static int total_keys
;
99 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
100 static Lisp_Object recent_keys
;
102 /* Vector holding the key sequence that invoked the current command.
103 It is reused for each command, and it may be longer than the current
104 sequence; this_command_key_count indicates how many elements
105 actually mean something.
106 It's easier to staticpro a single Lisp_Object than an array. */
107 Lisp_Object this_command_keys
;
108 ptrdiff_t this_command_key_count
;
110 /* This vector is used as a buffer to record the events that were actually read
111 by read_key_sequence. */
112 static Lisp_Object raw_keybuf
;
113 static int raw_keybuf_count
;
115 #define GROW_RAW_KEYBUF \
116 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
117 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
119 /* Number of elements of this_command_keys
120 that precede this key sequence. */
121 static ptrdiff_t this_single_command_key_start
;
123 #ifdef HAVE_STACK_OVERFLOW_HANDLING
125 /* For longjmp to recover from C stack overflow. */
126 sigjmp_buf return_to_command_loop
;
128 /* Message displayed by Vtop_level when recovering from C stack overflow. */
129 static Lisp_Object recover_top_level_message
;
131 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
133 /* Message normally displayed by Vtop_level. */
134 static Lisp_Object regular_top_level_message
;
136 /* For longjmp to where kbd input is being done. */
138 static sys_jmp_buf getcjmp
;
140 /* True while doing kbd input. */
141 bool waiting_for_input
;
143 /* True while displaying for echoing. Delays C-g throwing. */
147 /* Non-null means we can start echoing at the next input pause even
148 though there is something in the echo area. */
150 static struct kboard
*ok_to_echo_at_next_pause
;
152 /* The kboard last echoing, or null for none. Reset to 0 in
153 cancel_echoing. If non-null, and a current echo area message
154 exists, and echo_message_buffer is eq to the current message
155 buffer, we know that the message comes from echo_kboard. */
157 struct kboard
*echo_kboard
;
159 /* The buffer used for echoing. Set in echo_now, reset in
162 Lisp_Object echo_message_buffer
;
164 /* True means C-g should cause immediate error-signal. */
167 /* Character that causes a quit. Normally C-g.
169 If we are running on an ordinary terminal, this must be an ordinary
170 ASCII char, since we want to make it our interrupt character.
172 If we are not running on an ordinary terminal, it still needs to be
173 an ordinary ASCII char. This character needs to be recognized in
174 the input interrupt handler. At this point, the keystroke is
175 represented as a struct input_event, while the desired quit
176 character is specified as a lispy event. The mapping from struct
177 input_events to lispy events cannot run in an interrupt handler,
178 and the reverse mapping is difficult for anything but ASCII
181 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
185 /* Current depth in recursive edits. */
186 EMACS_INT command_loop_level
;
188 /* If not Qnil, this is a switch-frame event which we decided to put
189 off until the end of a key sequence. This should be read as the
190 next command input, after any unread_command_events.
192 read_key_sequence uses this to delay switch-frame events until the
193 end of the key sequence; Fread_char uses it to put off switch-frame
194 events until a non-ASCII event is acceptable as input. */
195 Lisp_Object unread_switch_frame
;
197 /* Last size recorded for a current buffer which is not a minibuffer. */
198 static ptrdiff_t last_non_minibuf_size
;
200 uintmax_t num_input_events
;
201 ptrdiff_t point_before_last_command_or_undo
;
202 struct buffer
*buffer_before_last_command_or_undo
;
204 /* Value of num_nonmacro_input_events as of last auto save. */
206 static EMACS_INT last_auto_save
;
208 /* The value of point when the last command was started. */
209 static ptrdiff_t last_point_position
;
211 /* The frame in which the last input event occurred, or Qmacro if the
212 last event came from a macro. We use this to determine when to
213 generate switch-frame events. This may be cleared by functions
214 like Fselect_frame, to make sure that a switch-frame event is
215 generated by the next character.
217 FIXME: This is modified by a signal handler so it should be volatile.
218 It's exported to Lisp, though, so it can't simply be marked
220 Lisp_Object internal_last_event_frame
;
222 /* `read_key_sequence' stores here the command definition of the
223 key sequence that it reads. */
224 static Lisp_Object read_key_sequence_cmd
;
225 static Lisp_Object read_key_sequence_remapped
;
227 /* File in which we write all commands we read. */
228 static FILE *dribble
;
230 /* True if input is available. */
233 /* True if more input was available last time we read an event.
235 Since redisplay can take a significant amount of time and is not
236 indispensable to perform the user's commands, when input arrives
237 "too fast", Emacs skips redisplay. More specifically, if the next
238 command has already been input when we finish the previous command,
239 we skip the intermediate redisplay.
241 This is useful to try and make sure Emacs keeps up with fast input
242 rates, such as auto-repeating keys. But in some cases, this proves
243 too conservative: we may end up disabling redisplay for the whole
244 duration of a key repetition, even though we could afford to
245 redisplay every once in a while.
247 So we "sample" the input_pending flag before running a command and
248 use *that* value after running the command to decide whether to
249 skip redisplay or not. This way, we only skip redisplay if we
250 really can't keep up with the repeat rate.
252 This only makes a difference if the next input arrives while running the
253 command, which is very unlikely if the command is executed quickly.
254 IOW this tends to avoid skipping redisplay after a long running command
255 (which is a case where skipping redisplay is not very useful since the
256 redisplay time is small compared to the time it took to run the command).
258 A typical use case is when scrolling. Scrolling time can be split into:
259 - Time to do jit-lock on the newly displayed portion of buffer.
260 - Time to run the actual scroll command.
261 - Time to perform the redisplay.
262 Jit-lock can happen either during the command or during the redisplay.
263 In the most painful cases, the jit-lock time is the one that dominates.
264 Also jit-lock can be tweaked (via jit-lock-defer) to delay its job, at the
265 cost of temporary inaccuracy in display and scrolling.
266 So without input_was_pending, what typically happens is the following:
267 - when the command starts, there's no pending input (yet).
268 - the scroll command triggers jit-lock.
269 - during the long jit-lock time the next input arrives.
270 - at the end of the command, we check input_pending and hence decide to
272 - we read the next input and start over.
273 End result: all the hard work of jit-locking is "wasted" since redisplay
274 doesn't actually happens (at least not before the input rate slows down).
275 With input_was_pending redisplay is still skipped if Emacs can't keep up
276 with the input rate, but if it can keep up just enough that there's no
277 input_pending when we begin the command, then redisplay is not skipped
278 which results in better feedback to the user. */
279 static bool input_was_pending
;
281 /* Circular buffer for pre-read keyboard input. */
283 static union buffered_input_event kbd_buffer
[KBD_BUFFER_SIZE
];
285 /* Pointer to next available character in kbd_buffer.
286 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
287 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
288 next available char is in kbd_buffer[0]. */
289 static union buffered_input_event
*kbd_fetch_ptr
;
291 /* Pointer to next place to store character in kbd_buffer. This
292 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
293 character should go in kbd_buffer[0]. */
294 static union buffered_input_event
*volatile kbd_store_ptr
;
296 /* The above pair of variables forms a "queue empty" flag. When we
297 enqueue a non-hook event, we increment kbd_store_ptr. When we
298 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
299 there is input available if the two pointers are not equal.
301 Why not just have a flag set and cleared by the enqueuing and
302 dequeuing functions? Such a flag could be screwed up by interrupts
303 at inopportune times. */
305 static void recursive_edit_unwind (Lisp_Object buffer
);
306 static Lisp_Object
command_loop (void);
308 static void echo_now (void);
309 static ptrdiff_t echo_length (void);
311 /* Incremented whenever a timer is run. */
314 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
316 struct timespec
*input_available_clear_time
;
318 /* True means use SIGIO interrupts; false means use CBREAK mode.
319 Default is true if INTERRUPT_INPUT is defined. */
320 bool interrupt_input
;
322 /* Nonzero while interrupts are temporarily deferred during redisplay. */
323 bool interrupts_deferred
;
325 /* The time when Emacs started being idle. */
327 static struct timespec timer_idleness_start_time
;
329 /* After Emacs stops being idle, this saves the last value
330 of timer_idleness_start_time from when it was idle. */
332 static struct timespec timer_last_idleness_start_time
;
335 /* Global variable declarations. */
337 /* Flags for readable_events. */
338 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
339 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
340 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
342 /* Function for init_keyboard to call with no args (if nonzero). */
343 static void (*keyboard_init_hook
) (void);
345 static bool get_input_pending (int);
346 static bool readable_events (int);
347 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
348 Lisp_Object
, bool *);
349 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
350 static Lisp_Object
make_lispy_event (struct input_event
*);
351 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
352 enum scroll_bar_part
,
353 Lisp_Object
, Lisp_Object
,
355 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
356 Lisp_Object
, const char *const *,
357 Lisp_Object
*, ptrdiff_t);
358 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
359 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
360 #ifdef HAVE_WINDOW_SYSTEM
361 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
362 #endif /* HAVE_WINDOW_SYSTEM */
363 static bool help_char_p (Lisp_Object
);
364 static void save_getcjmp (sys_jmp_buf
);
365 static void restore_getcjmp (sys_jmp_buf
);
366 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
367 static void restore_kboard_configuration (int);
368 static void handle_interrupt (bool);
369 static _Noreturn
void quit_throw_to_read_char (bool);
370 static void timer_start_idle (void);
371 static void timer_stop_idle (void);
372 static void timer_resume_idle (void);
373 static void deliver_user_signal (int);
374 static char *find_user_signal_name (int);
375 static void store_user_signal_events (void);
377 /* These setters are used only in this file, so they can be private. */
379 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
381 kb
->echo_string_
= val
;
384 kset_echo_prompt (struct kboard
*kb
, Lisp_Object val
)
386 kb
->echo_prompt_
= val
;
389 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
391 kb
->kbd_queue_
= val
;
394 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
396 kb
->Vkeyboard_translate_table_
= val
;
399 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
401 kb
->Vlast_prefix_arg_
= val
;
404 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
406 kb
->Vlast_repeatable_command_
= val
;
409 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
411 kb
->Vlocal_function_key_map_
= val
;
414 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
416 kb
->Voverriding_terminal_local_map_
= val
;
419 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
421 kb
->Vreal_last_command_
= val
;
424 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
426 kb
->system_key_syms_
= val
;
431 echo_keystrokes_p (void)
433 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
434 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0
438 /* Add C to the echo string, without echoing it immediately. C can be
439 a character, which is pretty-printed, or a symbol, whose name is
443 echo_add_key (Lisp_Object c
)
445 char initbuf
[KEY_DESCRIPTION_SIZE
+ 100];
446 ptrdiff_t size
= sizeof initbuf
;
447 char *buffer
= initbuf
;
449 Lisp_Object echo_string
= KVAR (current_kboard
, echo_string
);
452 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
453 /* Add a space at the end as a separator between keys. */
456 /* If someone has passed us a composite event, use its head symbol. */
460 ptr
= push_key_description (XINT (c
), ptr
);
461 else if (SYMBOLP (c
))
463 Lisp_Object name
= SYMBOL_NAME (c
);
464 ptrdiff_t nbytes
= SBYTES (name
);
466 if (size
- (ptr
- buffer
) < nbytes
)
468 ptrdiff_t offset
= ptr
- buffer
;
469 size
= max (2 * size
, size
+ nbytes
);
470 buffer
= SAFE_ALLOCA (size
);
471 ptr
= buffer
+ offset
;
474 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
475 STRING_MULTIBYTE (name
), 1);
478 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
481 static const char text
[] = " (Type ? for further options)";
482 int len
= sizeof text
- 1;
484 if (size
- (ptr
- buffer
) < len
)
486 ptrdiff_t offset
= ptr
- buffer
;
488 buffer
= SAFE_ALLOCA (size
);
489 ptr
= buffer
+ offset
;
492 memcpy (ptr
, text
, len
);
498 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
502 /* Temporarily add a dash to the end of the echo string if it's not
503 empty, so that it serves as a mini-prompt for the very next
509 /* Do nothing if not echoing at all. */
510 if (NILP (KVAR (current_kboard
, echo_string
)))
513 if (!current_kboard
->immediate_echo
514 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
517 /* Do nothing if we just printed a prompt. */
518 if (STRINGP (KVAR (current_kboard
, echo_prompt
))
519 && (SCHARS (KVAR (current_kboard
, echo_prompt
))
520 == SCHARS (KVAR (current_kboard
, echo_string
))))
523 /* Do nothing if we have already put a dash at the end. */
524 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
526 Lisp_Object last_char
, prev_char
, idx
;
528 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
529 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
531 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
532 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
534 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
538 /* Put a dash at the end of the buffer temporarily,
539 but make it go away when the next character is added. */
540 AUTO_STRING (dash
, "-");
541 kset_echo_string (current_kboard
,
542 concat2 (KVAR (current_kboard
, echo_string
), dash
));
549 if (current_kboard
->immediate_echo
)
552 Lisp_Object prompt
= KVAR (current_kboard
, echo_prompt
);
553 Lisp_Object prefix
= call0 (Qinternal_echo_keystrokes_prefix
);
554 kset_echo_string (current_kboard
,
555 NILP (prompt
) ? prefix
556 : NILP (prefix
) ? prompt
557 : concat2 (prompt
, prefix
));
559 for (i
= 0; i
< this_command_key_count
; i
++)
563 c
= AREF (this_command_keys
, i
);
564 if (! (EVENT_HAS_PARAMETERS (c
)
565 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
573 /* Display the current echo string, and begin echoing if not already
579 if (!current_kboard
->immediate_echo
580 /* This test breaks calls that use `echo_now' to display the echo_prompt.
581 && echo_keystrokes_p () */)
583 current_kboard
->immediate_echo
= true;
585 /* Put a dash at the end to invite the user to type more. */
590 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
591 message3_nolog (KVAR (current_kboard
, echo_string
));
594 /* Record in what buffer we echoed, and from which kboard. */
595 echo_message_buffer
= echo_area_buffer
[0];
596 echo_kboard
= current_kboard
;
598 if (waiting_for_input
&& !NILP (Vquit_flag
))
599 quit_throw_to_read_char (0);
602 /* Turn off echoing, for the start of a new command. */
605 cancel_echoing (void)
607 current_kboard
->immediate_echo
= false;
608 kset_echo_prompt (current_kboard
, Qnil
);
609 kset_echo_string (current_kboard
, Qnil
);
610 ok_to_echo_at_next_pause
= NULL
;
612 echo_message_buffer
= Qnil
;
615 /* Return the length of the current echo string. */
620 return (STRINGP (KVAR (current_kboard
, echo_string
))
621 ? SCHARS (KVAR (current_kboard
, echo_string
))
625 /* Truncate the current echo message to its first LEN chars.
626 This and echo_char get used by read_key_sequence when the user
627 switches frames while entering a key sequence. */
630 echo_truncate (ptrdiff_t nchars
)
632 if (STRINGP (KVAR (current_kboard
, echo_string
)))
633 kset_echo_string (current_kboard
,
634 Fsubstring (KVAR (current_kboard
, echo_string
),
635 make_number (0), make_number (nchars
)));
636 truncate_echo_area (nchars
);
640 /* Functions for manipulating this_command_keys. */
642 add_command_key (Lisp_Object key
)
644 if (this_command_key_count
>= ASIZE (this_command_keys
))
645 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
647 ASET (this_command_keys
, this_command_key_count
, key
);
648 ++this_command_key_count
;
653 recursive_edit_1 (void)
655 ptrdiff_t count
= SPECPDL_INDEX ();
658 if (command_loop_level
> 0)
660 specbind (Qstandard_output
, Qt
);
661 specbind (Qstandard_input
, Qt
);
664 #ifdef HAVE_WINDOW_SYSTEM
665 /* The command loop has started an hourglass timer, so we have to
666 cancel it here, otherwise it will fire because the recursive edit
667 can take some time. Do not check for display_hourglass_p here,
668 because it could already be nil. */
672 /* This function may have been called from a debugger called from
673 within redisplay, for instance by Edebugging a function called
674 from fontification-functions. We want to allow redisplay in
675 the debugging session.
677 The recursive edit is left with a `(throw exit ...)'. The `exit'
678 tag is not caught anywhere in redisplay, i.e. when we leave the
679 recursive edit, the original redisplay leading to the recursive
680 edit will be unwound. The outcome should therefore be safe. */
681 specbind (Qinhibit_redisplay
, Qnil
);
684 val
= command_loop ();
686 Fsignal (Qquit
, Qnil
);
687 /* Handle throw from read_minibuf when using minibuffer
688 while it's active but we're in another window. */
690 xsignal1 (Qerror
, val
);
692 return unbind_to (count
, Qnil
);
695 /* When an auto-save happens, record the "time", and don't do again soon. */
698 record_auto_save (void)
700 last_auto_save
= num_nonmacro_input_events
;
703 /* Make an auto save happen as soon as possible at command level. */
707 force_auto_save_soon (void)
709 last_auto_save
= - auto_save_interval
- 1;
711 record_asynch_buffer_change ();
715 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
716 doc
: /* Invoke the editor command loop recursively.
717 To get out of the recursive edit, a command can throw to `exit' -- for
718 instance (throw \\='exit nil).
719 If you throw a value other than t, `recursive-edit' returns normally
720 to the function that called it. Throwing a t value causes
721 `recursive-edit' to quit, so that control returns to the command loop
724 This function is called by the editor initialization to begin editing. */)
727 ptrdiff_t count
= SPECPDL_INDEX ();
730 /* If we enter while input is blocked, don't lock up here.
731 This may happen through the debugger during redisplay. */
732 if (input_blocked_p ())
735 if (command_loop_level
>= 0
736 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
737 buffer
= Fcurrent_buffer ();
741 /* Don't do anything interesting between the increment and the
742 record_unwind_protect! Otherwise, we could get distracted and
743 never decrement the counter again. */
744 command_loop_level
++;
745 update_mode_lines
= 17;
746 record_unwind_protect (recursive_edit_unwind
, buffer
);
748 /* If we leave recursive_edit_1 below with a `throw' for instance,
749 like it is done in the splash screen display, we have to
750 make sure that we restore single_kboard as command_loop_1
751 would have done if it were left normally. */
752 if (command_loop_level
> 0)
753 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
756 return unbind_to (count
, Qnil
);
760 recursive_edit_unwind (Lisp_Object buffer
)
762 if (BUFFERP (buffer
))
763 Fset_buffer (buffer
);
765 command_loop_level
--;
766 update_mode_lines
= 18;
770 #if 0 /* These two functions are now replaced with
771 temporarily_switch_to_single_kboard. */
775 #if 0 /* Theory: if there's anything in Vunread_command_events,
776 it will right away be read by read_key_sequence,
777 and then if we do switch KBOARDS, it will go into the side
778 queue then. So we don't need to do anything special here -- rms. */
779 if (CONSP (Vunread_command_events
))
781 current_kboard
->kbd_queue
782 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
783 current_kboard
->kbd_queue_has_data
= true;
785 Vunread_command_events
= Qnil
;
787 single_kboard
= false;
790 /* Switch to the single-kboard state, making current_kboard
791 the only KBOARD from which further input is accepted. */
794 single_kboard_state ()
796 single_kboard
= true;
800 /* If we're in single_kboard state for kboard KBOARD,
804 not_single_kboard_state (KBOARD
*kboard
)
806 if (kboard
== current_kboard
)
807 single_kboard
= false;
810 /* Maintain a stack of kboards, so other parts of Emacs
811 can switch temporarily to the kboard of a given frame
812 and then revert to the previous status. */
817 struct kboard_stack
*next
;
820 static struct kboard_stack
*kboard_stack
;
823 push_kboard (struct kboard
*k
)
825 struct kboard_stack
*p
= xmalloc (sizeof *p
);
827 p
->next
= kboard_stack
;
828 p
->kboard
= current_kboard
;
838 struct kboard_stack
*p
= kboard_stack
;
840 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
842 if (t
->kboard
== p
->kboard
)
844 current_kboard
= p
->kboard
;
851 /* The terminal we remembered has been deleted. */
852 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
853 single_kboard
= false;
855 kboard_stack
= p
->next
;
859 /* Switch to single_kboard mode, making current_kboard the only KBOARD
860 from which further input is accepted. If F is non-nil, set its
861 KBOARD as the current keyboard.
863 This function uses record_unwind_protect_int to return to the previous
866 If Emacs is already in single_kboard mode, and F's keyboard is
867 locked, then this function will throw an error. */
870 temporarily_switch_to_single_kboard (struct frame
*f
)
872 bool was_locked
= single_kboard
;
875 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
876 /* We can not switch keyboards while in single_kboard mode.
877 In rare cases, Lisp code may call `recursive-edit' (or
878 `read-minibuffer' or `y-or-n-p') after it switched to a
879 locked frame. For example, this is likely to happen
880 when server.el connects to a new terminal while Emacs is in
881 single_kboard mode. It is best to throw an error instead
882 of presenting the user with a frozen screen. */
883 error ("Terminal %d is locked, cannot read from it",
884 FRAME_TERMINAL (f
)->id
);
886 /* This call is unnecessary, but helps
887 `restore_kboard_configuration' discover if somebody changed
888 `current_kboard' behind our back. */
889 push_kboard (current_kboard
);
892 current_kboard
= FRAME_KBOARD (f
);
893 single_kboard
= true;
894 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
897 #if 0 /* This function is not needed anymore. */
899 record_single_kboard_state ()
902 push_kboard (current_kboard
);
903 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
908 restore_kboard_configuration (int was_locked
)
910 single_kboard
= was_locked
;
913 struct kboard
*prev
= current_kboard
;
915 /* The pop should not change the kboard. */
916 if (single_kboard
&& current_kboard
!= prev
)
922 /* Handle errors that are not handled at inner levels
923 by printing an error message and returning to the editor command loop. */
926 cmd_error (Lisp_Object data
)
928 Lisp_Object old_level
, old_length
;
929 char macroerror
[sizeof "After..kbd macro iterations: "
930 + INT_STRLEN_BOUND (EMACS_INT
)];
932 #ifdef HAVE_WINDOW_SYSTEM
933 if (display_hourglass_p
)
937 if (!NILP (executing_kbd_macro
))
939 if (executing_kbd_macro_iterations
== 1)
940 sprintf (macroerror
, "After 1 kbd macro iteration: ");
942 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
943 executing_kbd_macro_iterations
);
948 Vstandard_output
= Qt
;
949 Vstandard_input
= Qt
;
950 Vexecuting_kbd_macro
= Qnil
;
951 executing_kbd_macro
= Qnil
;
952 kset_prefix_arg (current_kboard
, Qnil
);
953 kset_last_prefix_arg (current_kboard
, Qnil
);
956 /* Avoid unquittable loop if data contains a circular list. */
957 old_level
= Vprint_level
;
958 old_length
= Vprint_length
;
959 XSETFASTINT (Vprint_level
, 10);
960 XSETFASTINT (Vprint_length
, 10);
961 cmd_error_internal (data
, macroerror
);
962 Vprint_level
= old_level
;
963 Vprint_length
= old_length
;
966 Vinhibit_quit
= Qnil
;
968 return make_number (0);
971 /* Take actions on handling an error. DATA is the data that describes
974 CONTEXT is a C-string containing ASCII characters only which
975 describes the context in which the error happened. If we need to
976 generalize CONTEXT to allow multibyte characters, make it a Lisp
980 cmd_error_internal (Lisp_Object data
, const char *context
)
982 /* The immediate context is not interesting for Quits,
983 since they are asynchronous. */
984 if (EQ (XCAR (data
), Qquit
))
985 Vsignaling_function
= Qnil
;
990 /* Use user's specified output function if any. */
991 if (!NILP (Vcommand_error_function
))
992 call3 (Vcommand_error_function
, data
,
993 context
? build_string (context
) : empty_unibyte_string
,
994 Vsignaling_function
);
996 Vsignaling_function
= Qnil
;
999 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1000 Scommand_error_default_function
, 3, 3, 0,
1001 doc
: /* Produce default output for unhandled error message.
1002 Default value of `command-error-function'. */)
1003 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1005 struct frame
*sf
= SELECTED_FRAME ();
1007 CHECK_STRING (context
);
1009 /* If the window system or terminal frame hasn't been initialized
1010 yet, or we're not interactive, write the message to stderr and exit. */
1011 if (!sf
->glyphs_initialized_p
1012 /* The initial frame is a special non-displaying frame. It
1013 will be current in daemon mode when there are no frames
1014 to display, and in non-daemon mode before the real frame
1015 has finished initializing. If an error is thrown in the
1016 latter case while creating the frame, then the frame
1017 will never be displayed, so the safest thing to do is
1018 write to stderr and quit. In daemon mode, there are
1019 many other potential errors that do not prevent frames
1020 from being created, so continuing as normal is better in
1022 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1025 print_error_message (data
, Qexternal_debugging_output
,
1026 SSDATA (context
), signal
);
1027 Fterpri (Qexternal_debugging_output
, Qnil
);
1028 Fkill_emacs (make_number (-1));
1032 clear_message (1, 0);
1034 message_log_maybe_newline ();
1037 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1042 static Lisp_Object
command_loop_2 (Lisp_Object
);
1043 static Lisp_Object
top_level_1 (Lisp_Object
);
1045 /* Entry to editor-command-loop.
1046 This level has the catches for exiting/returning to editor command loop.
1047 It returns nil to exit recursive edit, t to abort it. */
1052 #ifdef HAVE_STACK_OVERFLOW_HANDLING
1053 /* At least on GNU/Linux, saving signal mask is important here. */
1054 if (sigsetjmp (return_to_command_loop
, 1) != 0)
1056 /* Comes here from handle_sigsegv (see sysdep.c) and
1057 stack_overflow_handler (see w32fns.c). */
1059 w32_reset_stack_overflow_guard ();
1062 Vinternal__top_level_message
= recover_top_level_message
;
1065 Vinternal__top_level_message
= regular_top_level_message
;
1066 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
1067 if (command_loop_level
> 0 || minibuf_level
> 0)
1070 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1071 executing_kbd_macro
= Qnil
;
1077 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1078 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1079 executing_kbd_macro
= Qnil
;
1081 /* End of file in -batch run causes exit here. */
1087 /* Here we catch errors in execution of commands within the
1088 editing loop, and reenter the editing loop.
1089 When there is an error, cmd_error runs and returns a non-nil
1090 value to us. A value of nil means that command_loop_1 itself
1091 returned due to end of file (or end of kbd macro). */
1094 command_loop_2 (Lisp_Object ignore
)
1096 register Lisp_Object val
;
1099 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1100 while (!NILP (val
));
1108 return Feval (Vtop_level
, Qnil
);
1112 top_level_1 (Lisp_Object ignore
)
1114 /* On entry to the outer level, run the startup file. */
1115 if (!NILP (Vtop_level
))
1116 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1117 else if (!NILP (Vpurify_flag
))
1118 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1120 message1 ("Bare Emacs (standard Lisp code not loaded)");
1124 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1125 doc
: /* Exit all recursive editing levels.
1126 This also exits all active minibuffers. */
1127 attributes
: noreturn
)
1130 #ifdef HAVE_WINDOW_SYSTEM
1131 if (display_hourglass_p
)
1132 cancel_hourglass ();
1135 /* Unblock input if we enter with input blocked. This may happen if
1136 redisplay traps e.g. during tool-bar update with input blocked. */
1137 totally_unblock_input ();
1139 Fthrow (Qtop_level
, Qnil
);
1142 static _Noreturn
void
1143 user_error (const char *msg
)
1145 xsignal1 (Quser_error
, build_string (msg
));
1148 /* _Noreturn will be added to prototype by make-docfile. */
1149 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1150 doc
: /* Exit from the innermost recursive edit or minibuffer. */
1151 attributes
: noreturn
)
1154 if (command_loop_level
> 0 || minibuf_level
> 0)
1155 Fthrow (Qexit
, Qnil
);
1157 user_error ("No recursive edit is in progress");
1160 /* _Noreturn will be added to prototype by make-docfile. */
1161 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1162 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */
1163 attributes
: noreturn
)
1166 if (command_loop_level
> 0 || minibuf_level
> 0)
1169 user_error ("No recursive edit is in progress");
1172 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1173 of this function. */
1176 tracking_off (Lisp_Object old_value
)
1178 do_mouse_tracking
= old_value
;
1179 if (NILP (old_value
))
1181 /* Redisplay may have been preempted because there was input
1182 available, and it assumes it will be called again after the
1183 input has been processed. If the only input available was
1184 the sort that we have just disabled, then we need to call
1186 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1188 redisplay_preserve_echo_area (6);
1189 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1194 DEFUN ("internal--track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1195 doc
: /* Call BODYFUN with mouse movement events enabled. */)
1196 (Lisp_Object bodyfun
)
1198 ptrdiff_t count
= SPECPDL_INDEX ();
1201 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1203 do_mouse_tracking
= Qt
;
1205 val
= call0 (bodyfun
);
1206 return unbind_to (count
, val
);
1209 /* If mouse has moved on some frame, return one of those frames.
1213 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1214 after resizing the tool-bar window. */
1216 bool ignore_mouse_drag_p
;
1218 static struct frame
*
1219 some_mouse_moved (void)
1221 Lisp_Object tail
, frame
;
1223 if (ignore_mouse_drag_p
)
1225 /* ignore_mouse_drag_p = 0; */
1229 FOR_EACH_FRAME (tail
, frame
)
1231 if (XFRAME (frame
)->mouse_moved
)
1232 return XFRAME (frame
);
1239 /* This is the actual command reading loop,
1240 sans error-handling encapsulation. */
1242 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1243 bool, bool, bool, bool);
1244 static void adjust_point_for_property (ptrdiff_t, bool);
1247 command_loop_1 (void)
1249 EMACS_INT prev_modiff
= 0;
1250 struct buffer
*prev_buffer
= NULL
;
1251 bool already_adjusted
= 0;
1253 kset_prefix_arg (current_kboard
, Qnil
);
1254 kset_last_prefix_arg (current_kboard
, Qnil
);
1255 Vdeactivate_mark
= Qnil
;
1256 waiting_for_input
= false;
1259 this_command_key_count
= 0;
1260 this_single_command_key_start
= 0;
1262 if (NILP (Vmemory_full
))
1264 /* Make sure this hook runs after commands that get errors and
1265 throw to top level. */
1266 /* Note that the value cell will never directly contain nil
1267 if the symbol is a local variable. */
1268 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1269 safe_run_hooks (Qpost_command_hook
);
1271 /* If displaying a message, resize the echo area window to fit
1272 that message's size exactly. */
1273 if (!NILP (echo_area_buffer
[0]))
1274 resize_echo_area_exactly ();
1276 /* If there are warnings waiting, process them. */
1277 if (!NILP (Vdelayed_warnings_list
))
1278 safe_run_hooks (Qdelayed_warnings_hook
);
1280 if (!NILP (Vdeferred_action_list
))
1281 safe_run_hooks (Qdeferred_action_function
);
1284 /* Do this after running Vpost_command_hook, for consistency. */
1285 kset_last_command (current_kboard
, Vthis_command
);
1286 kset_real_last_command (current_kboard
, Vreal_this_command
);
1287 if (!CONSP (last_command_event
))
1288 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1293 Lisp_Object keybuf
[30];
1296 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1299 /* Make sure the current window's buffer is selected. */
1300 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1302 /* Display any malloc warning that just came out. Use while because
1303 displaying one warning can cause another. */
1305 while (pending_malloc_warning
)
1306 display_malloc_warning ();
1308 Vdeactivate_mark
= Qnil
;
1310 /* Don't ignore mouse movements for more than a single command
1311 loop. (This flag is set in xdisp.c whenever the tool bar is
1312 resized, because the resize moves text up or down, and would
1313 generate false mouse drag events if we don't ignore them.) */
1314 ignore_mouse_drag_p
= 0;
1316 /* If minibuffer on and echo area in use,
1317 wait a short time and redraw minibuffer. */
1320 && !NILP (echo_area_buffer
[0])
1321 && EQ (minibuf_window
, echo_area_window
)
1322 && NUMBERP (Vminibuffer_message_timeout
))
1324 /* Bind inhibit-quit to t so that C-g gets read in
1325 rather than quitting back to the minibuffer. */
1326 ptrdiff_t count
= SPECPDL_INDEX ();
1327 specbind (Qinhibit_quit
, Qt
);
1329 sit_for (Vminibuffer_message_timeout
, 0, 2);
1331 /* Clear the echo area. */
1333 safe_run_hooks (Qecho_area_clear_hook
);
1335 unbind_to (count
, Qnil
);
1337 /* If a C-g came in before, treat it as input now. */
1338 if (!NILP (Vquit_flag
))
1341 Vunread_command_events
= list1 (make_number (quit_char
));
1345 /* If it has changed current-menubar from previous value,
1346 really recompute the menubar from the value. */
1347 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1348 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1349 call0 (Qrecompute_lucid_menubar
);
1351 Vthis_command
= Qnil
;
1352 Vreal_this_command
= Qnil
;
1353 Vthis_original_command
= Qnil
;
1354 Vthis_command_keys_shift_translated
= Qnil
;
1356 /* Read next key sequence; i gets its length. */
1357 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1360 /* A filter may have run while we were reading the input. */
1361 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1363 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1367 /* Now we have read a key sequence of length I,
1368 or else I is 0 and we found end of file. */
1370 if (i
== 0) /* End of file -- happens only in */
1371 return Qnil
; /* a kbd macro, at the end. */
1372 /* -1 means read_key_sequence got a menu that was rejected.
1373 Just loop around and read another command. */
1377 this_command_key_count
= 0;
1378 this_single_command_key_start
= 0;
1382 last_command_event
= keybuf
[i
- 1];
1384 /* If the previous command tried to force a specific window-start,
1385 forget about that, in case this command moves point far away
1386 from that position. But also throw away beg_unchanged and
1387 end_unchanged information in that case, so that redisplay will
1388 update the whole window properly. */
1389 if (XWINDOW (selected_window
)->force_start
)
1392 XWINDOW (selected_window
)->force_start
= 0;
1393 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1394 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1397 cmd
= read_key_sequence_cmd
;
1398 if (!NILP (Vexecuting_kbd_macro
))
1400 if (!NILP (Vquit_flag
))
1402 Vexecuting_kbd_macro
= Qt
;
1403 QUIT
; /* Make some noise. */
1404 /* Will return since macro now empty. */
1408 /* Do redisplay processing after this command except in special
1409 cases identified below. */
1410 prev_buffer
= current_buffer
;
1411 prev_modiff
= MODIFF
;
1412 last_point_position
= PT
;
1414 /* By default, we adjust point to a boundary of a region that
1415 has such a property that should be treated intangible
1416 (e.g. composition, display). But, some commands will set
1417 this variable differently. */
1418 Vdisable_point_adjustment
= Qnil
;
1420 /* Process filters and timers may have messed with deactivate-mark.
1421 reset it before we execute the command. */
1422 Vdeactivate_mark
= Qnil
;
1424 /* Remap command through active keymaps. */
1425 Vthis_original_command
= cmd
;
1426 if (!NILP (read_key_sequence_remapped
))
1427 cmd
= read_key_sequence_remapped
;
1429 /* Execute the command. */
1432 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
1433 ASET (recent_keys
, recent_keys_index
,
1435 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1436 recent_keys_index
= 0;
1438 Vthis_command
= cmd
;
1439 Vreal_this_command
= cmd
;
1440 safe_run_hooks (Qpre_command_hook
);
1442 already_adjusted
= 0;
1444 if (NILP (Vthis_command
))
1445 /* nil means key is undefined. */
1449 /* Here for a command that isn't executed directly. */
1451 #ifdef HAVE_WINDOW_SYSTEM
1452 ptrdiff_t scount
= SPECPDL_INDEX ();
1454 if (display_hourglass_p
1455 && NILP (Vexecuting_kbd_macro
))
1457 record_unwind_protect_void (cancel_hourglass
);
1462 /* Ensure that we have added appropriate undo-boundaries as a
1463 result of changes from the last command. */
1464 call0 (Qundo_auto__add_boundary
);
1466 /* Record point and buffer, so we can put point into the undo
1467 information if necessary. */
1468 point_before_last_command_or_undo
= PT
;
1469 buffer_before_last_command_or_undo
= current_buffer
;
1471 call1 (Qcommand_execute
, Vthis_command
);
1473 #ifdef HAVE_WINDOW_SYSTEM
1474 /* Do not check display_hourglass_p here, because
1475 `command-execute' could change it, but we should cancel
1476 hourglass cursor anyway.
1477 But don't cancel the hourglass within a macro
1478 just because a command in the macro finishes. */
1479 if (NILP (Vexecuting_kbd_macro
))
1480 unbind_to (scount
, Qnil
);
1483 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1485 safe_run_hooks (Qpost_command_hook
);
1487 /* If displaying a message, resize the echo area window to fit
1488 that message's size exactly. */
1489 if (!NILP (echo_area_buffer
[0]))
1490 resize_echo_area_exactly ();
1492 /* If there are warnings waiting, process them. */
1493 if (!NILP (Vdelayed_warnings_list
))
1494 safe_run_hooks (Qdelayed_warnings_hook
);
1496 safe_run_hooks (Qdeferred_action_function
);
1498 kset_last_command (current_kboard
, Vthis_command
);
1499 kset_real_last_command (current_kboard
, Vreal_this_command
);
1500 if (!CONSP (last_command_event
))
1501 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1503 this_command_key_count
= 0;
1504 this_single_command_key_start
= 0;
1506 if (current_kboard
->immediate_echo
1507 && !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
1509 current_kboard
->immediate_echo
= false;
1510 /* Refresh the echo message. */
1516 if (!NILP (BVAR (current_buffer
, mark_active
))
1517 && !NILP (Vrun_hooks
))
1519 /* In Emacs 22, setting transient-mark-mode to `only' was a
1520 way of turning it on for just one command. This usage is
1521 obsolete, but support it anyway. */
1522 if (EQ (Vtransient_mark_mode
, Qidentity
))
1523 Vtransient_mark_mode
= Qnil
;
1524 else if (EQ (Vtransient_mark_mode
, Qonly
))
1525 Vtransient_mark_mode
= Qidentity
;
1527 if (!NILP (Vdeactivate_mark
))
1528 /* If `select-active-regions' is non-nil, this call to
1529 `deactivate-mark' also sets the PRIMARY selection. */
1530 call0 (Qdeactivate_mark
);
1533 /* Even if not deactivating the mark, set PRIMARY if
1534 `select-active-regions' is non-nil. */
1535 if (!NILP (Fwindow_system (Qnil
))
1536 /* Even if mark_active is non-nil, the actual buffer
1537 marker may not have been set yet (Bug#7044). */
1538 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1539 && (EQ (Vselect_active_regions
, Qonly
)
1540 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1541 : (!NILP (Vselect_active_regions
)
1542 && !NILP (Vtransient_mark_mode
)))
1543 && NILP (Fmemq (Vthis_command
,
1544 Vselection_inhibit_update_commands
)))
1547 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1548 if (XINT (Flength (txt
)) > 0)
1549 /* Don't set empty selections. */
1550 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1553 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1554 run_hook (intern ("activate-mark-hook"));
1557 Vsaved_region_selection
= Qnil
;
1562 if (current_buffer
== prev_buffer
1563 && XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
1564 && last_point_position
!= PT
1565 && NILP (Vdisable_point_adjustment
)
1566 && NILP (Vglobal_disable_point_adjustment
))
1568 if (last_point_position
> BEGV
1569 && last_point_position
< ZV
1570 && (composition_adjust_point (last_point_position
,
1571 last_point_position
)
1572 != last_point_position
))
1573 /* The last point was temporarily set within a grapheme
1574 cluster to prevent automatic composition. To recover
1575 the automatic composition, we must update the
1577 windows_or_buffers_changed
= 21;
1578 if (!already_adjusted
)
1579 adjust_point_for_property (last_point_position
,
1580 MODIFF
!= prev_modiff
);
1583 /* Install chars successfully executed in kbd macro. */
1585 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1586 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1587 finalize_kbd_macro_chars ();
1592 read_menu_command (void)
1594 Lisp_Object keybuf
[30];
1595 ptrdiff_t count
= SPECPDL_INDEX ();
1598 /* We don't want to echo the keystrokes while navigating the
1600 specbind (Qecho_keystrokes
, make_number (0));
1602 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1605 unbind_to (count
, Qnil
);
1607 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1609 if (i
== 0 || i
== -1)
1612 return read_key_sequence_cmd
;
1615 /* Adjust point to a boundary of a region that has such a property
1616 that should be treated intangible. For the moment, we check
1617 `composition', `display' and `invisible' properties.
1618 LAST_PT is the last position of point. */
1621 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1624 Lisp_Object val
, overlay
, tmp
;
1625 /* When called after buffer modification, we should temporarily
1626 suppress the point adjustment for automatic composition so that a
1627 user can keep inserting another character at point or keep
1628 deleting characters around point. */
1629 bool check_composition
= ! modified
;
1630 bool check_display
= true, check_invisible
= true;
1631 ptrdiff_t orig_pt
= PT
;
1633 eassert (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
);
1635 /* FIXME: cycling is probably not necessary because these properties
1636 can't be usefully combined anyway. */
1637 while (check_composition
|| check_display
|| check_invisible
)
1639 /* FIXME: check `intangible'. */
1640 if (check_composition
1641 && PT
> BEGV
&& PT
< ZV
1642 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1645 check_display
= check_invisible
= true;
1647 check_composition
= false;
1649 && PT
> BEGV
&& PT
< ZV
1650 && !NILP (val
= get_char_property_and_overlay
1651 (make_number (PT
), Qdisplay
, selected_window
,
1653 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1654 && (!OVERLAYP (overlay
)
1655 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1656 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1657 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1658 && (beg
< PT
/* && end > PT <- It's always the case. */
1659 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1662 SET_PT (PT
< last_pt
1663 ? (STRINGP (val
) && SCHARS (val
) == 0
1664 ? max (beg
- 1, BEGV
)
1667 check_composition
= check_invisible
= true;
1669 check_display
= false;
1670 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1673 bool ellipsis
= false;
1676 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1679 /* FIXME: We should stop if we find a spot between
1680 two runs of `invisible' where inserted text would
1681 be visible. This is important when we have two
1682 invisible boundaries that enclose an area: if the
1683 area is empty, we need this test in order to make
1684 it possible to place point in the middle rather
1685 than skip both boundaries. However, this code
1686 also stops anywhere in a non-sticky text-property,
1687 which breaks (e.g.) Org mode. */
1688 && (val
= Fget_pos_property (make_number (end
),
1690 TEXT_PROP_MEANS_INVISIBLE (val
))
1692 && !NILP (val
= get_char_property_and_overlay
1693 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1694 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1696 ellipsis
= ellipsis
|| inv
> 1
1697 || (OVERLAYP (overlay
)
1698 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1699 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1700 tmp
= Fnext_single_char_property_change
1701 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1702 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1706 && (val
= Fget_pos_property (make_number (beg
),
1708 TEXT_PROP_MEANS_INVISIBLE (val
))
1710 && !NILP (val
= get_char_property_and_overlay
1711 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1712 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1714 ellipsis
= ellipsis
|| inv
> 1
1715 || (OVERLAYP (overlay
)
1716 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1717 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1718 tmp
= Fprevious_single_char_property_change
1719 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1720 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1723 /* Move away from the inside area. */
1724 if (beg
< PT
&& end
> PT
)
1726 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1727 /* We haven't moved yet (so we don't need to fear
1728 infinite-looping) and we were outside the range
1729 before (so either end of the range still corresponds
1730 to a move in the right direction): pretend we moved
1731 less than we actually did, so that we still have
1732 more freedom below in choosing which end of the range
1734 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1735 /* We either have moved already or the last point
1736 was already in the range: we don't get to choose
1737 which end of the range we have to go to. */
1738 : (PT
< last_pt
? beg
: end
));
1739 check_composition
= check_display
= true;
1741 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1742 the point to something other than its argument, due to
1743 point-motion hooks, intangibility, etc. */
1744 eassert (PT
== beg
|| PT
== end
);
1747 /* Pretend the area doesn't exist if the buffer is not
1749 if (!modified
&& !ellipsis
&& beg
< end
)
1751 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1752 (check_composition
= check_display
= true, SET_PT (end
+ 1));
1753 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1754 (check_composition
= check_display
= true, SET_PT (beg
- 1));
1755 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1756 /* We've already moved as far as we can. Trying to go
1757 to the other end would mean moving backwards and thus
1758 could lead to an infinite loop. */
1760 else if (val
= Fget_pos_property (make_number (PT
),
1762 TEXT_PROP_MEANS_INVISIBLE (val
)
1763 && (val
= (Fget_pos_property
1764 (make_number (PT
== beg
? end
: beg
),
1766 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1767 (check_composition
= check_display
= true,
1768 SET_PT (PT
== beg
? end
: beg
));
1771 check_invisible
= false;
1775 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1778 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1780 eassert (nargs
== 2);
1781 return call0 (args
[1]);
1784 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1788 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1790 eassert (nargs
== 2);
1791 AUTO_STRING (format
, "Error in %s (%S): %S");
1792 Lisp_Object hook
= args
[0];
1793 Lisp_Object fun
= args
[1];
1794 CALLN (Fmessage
, format
, hook
, fun
, error
);
1800 Lisp_Object newval
= Qnil
;
1801 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1802 if (EQ (fun
, XCAR (val
)))
1805 newval
= Fcons (XCAR (val
), newval
);
1807 return Fset (hook
, Fnreverse (newval
));
1808 /* Not found in the local part of the hook. Let's look at the global
1811 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1812 : Fdefault_value (hook
));
1813 CONSP (val
); val
= XCDR (val
))
1814 if (EQ (fun
, XCAR (val
)))
1817 newval
= Fcons (XCAR (val
), newval
);
1819 return Fset_default (hook
, Fnreverse (newval
));
1825 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1827 eassert (nargs
== 2);
1828 /* Yes, run_hook_with_args works with args in the other order. */
1829 internal_condition_case_n (safe_run_hooks_1
,
1830 2, ((Lisp_Object
[]) {args
[1], args
[0]}),
1831 Qt
, safe_run_hooks_error
);
1835 /* If we get an error while running the hook, cause the hook variable
1836 to be nil. Also inhibit quits, so that C-g won't cause the hook
1837 to mysteriously evaporate. */
1840 safe_run_hooks (Lisp_Object hook
)
1842 ptrdiff_t count
= SPECPDL_INDEX ();
1844 specbind (Qinhibit_quit
, Qt
);
1845 run_hook_with_args (2, ((Lisp_Object
[]) {hook
, hook
}), safe_run_hook_funcall
);
1846 unbind_to (count
, Qnil
);
1850 /* Nonzero means polling for input is temporarily suppressed. */
1852 int poll_suppress_count
;
1855 #ifdef POLL_FOR_INPUT
1857 /* Asynchronous timer for polling. */
1859 static struct atimer
*poll_timer
;
1861 /* Poll for input, so that we catch a C-g if it comes in. */
1863 poll_for_input_1 (void)
1865 if (! input_blocked_p ()
1866 && !waiting_for_input
)
1870 /* Timer callback function for poll_timer. TIMER is equal to
1874 poll_for_input (struct atimer
*timer
)
1876 if (poll_suppress_count
== 0)
1877 pending_signals
= true;
1880 #endif /* POLL_FOR_INPUT */
1882 /* Begin signals to poll for input, if they are appropriate.
1883 This function is called unconditionally from various places. */
1886 start_polling (void)
1888 #ifdef POLL_FOR_INPUT
1889 /* XXX This condition was (read_socket_hook && !interrupt_input),
1890 but read_socket_hook is not global anymore. Let's pretend that
1892 if (!interrupt_input
)
1894 /* Turn alarm handling on unconditionally. It might have
1895 been turned off in process.c. */
1896 turn_on_atimers (1);
1898 /* If poll timer doesn't exist, or we need one with
1899 a different interval, start a new one. */
1900 if (poll_timer
== NULL
1901 || poll_timer
->interval
.tv_sec
!= polling_period
)
1903 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1904 struct timespec interval
= make_timespec (period
, 0);
1907 cancel_atimer (poll_timer
);
1909 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1910 poll_for_input
, NULL
);
1913 /* Let the timer's callback function poll for input
1914 if this becomes zero. */
1915 --poll_suppress_count
;
1920 /* True if we are using polling to handle input asynchronously. */
1923 input_polling_used (void)
1925 #ifdef POLL_FOR_INPUT
1926 /* XXX This condition was (read_socket_hook && !interrupt_input),
1927 but read_socket_hook is not global anymore. Let's pretend that
1929 return !interrupt_input
;
1935 /* Turn off polling. */
1940 #ifdef POLL_FOR_INPUT
1941 /* XXX This condition was (read_socket_hook && !interrupt_input),
1942 but read_socket_hook is not global anymore. Let's pretend that
1944 if (!interrupt_input
)
1945 ++poll_suppress_count
;
1949 /* Set the value of poll_suppress_count to COUNT
1950 and start or stop polling accordingly. */
1953 set_poll_suppress_count (int count
)
1955 #ifdef POLL_FOR_INPUT
1956 if (count
== 0 && poll_suppress_count
!= 0)
1958 poll_suppress_count
= 1;
1961 else if (count
!= 0 && poll_suppress_count
== 0)
1965 poll_suppress_count
= count
;
1969 /* Bind polling_period to a value at least N.
1970 But don't decrease it. */
1973 bind_polling_period (int n
)
1975 #ifdef POLL_FOR_INPUT
1976 EMACS_INT
new = polling_period
;
1981 stop_other_atimers (poll_timer
);
1983 specbind (Qpolling_period
, make_number (new));
1984 /* Start a new alarm with the new period. */
1989 /* Apply the control modifier to CHARACTER. */
1992 make_ctrl_char (int c
)
1994 /* Save the upper bits here. */
1995 int upper
= c
& ~0177;
1997 if (! ASCII_CHAR_P (c
))
1998 return c
|= ctrl_modifier
;
2002 /* Everything in the columns containing the upper-case letters
2003 denotes a control character. */
2004 if (c
>= 0100 && c
< 0140)
2008 /* Set the shift modifier for a control char
2009 made from a shifted letter. But only for letters! */
2010 if (oc
>= 'A' && oc
<= 'Z')
2011 c
|= shift_modifier
;
2014 /* The lower-case letters denote control characters too. */
2015 else if (c
>= 'a' && c
<= 'z')
2018 /* Include the bits for control and shift
2019 only if the basic ASCII code can't indicate them. */
2023 /* Replace the high bits. */
2024 c
|= (upper
& ~ctrl_modifier
);
2029 /* Display the help-echo property of the character after the mouse pointer.
2030 Either show it in the echo area, or call show-help-function to display
2031 it by other means (maybe in a tooltip).
2033 If HELP is nil, that means clear the previous help echo.
2035 If HELP is a string, display that string. If HELP is a function,
2036 call it with OBJECT and POS as arguments; the function should
2037 return a help string or nil for none. For all other types of HELP,
2038 evaluate it to obtain a string.
2040 WINDOW is the window in which the help was generated, if any.
2041 It is nil if not in a window.
2043 If OBJECT is a buffer, POS is the position in the buffer where the
2044 `help-echo' text property was found.
2046 If OBJECT is an overlay, that overlay has a `help-echo' property,
2047 and POS is the position in the overlay's buffer under the mouse.
2049 If OBJECT is a string (an overlay string or a string displayed with
2050 the `display' property). POS is the position in that string under
2053 Note: this function may only be called with HELP nil or a string
2054 from X code running asynchronously. */
2057 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2060 if (!NILP (help
) && !STRINGP (help
))
2062 if (FUNCTIONP (help
))
2063 help
= safe_call (4, help
, window
, object
, pos
);
2065 help
= safe_eval (help
);
2067 if (!STRINGP (help
))
2071 if (!noninteractive
&& STRINGP (help
))
2073 /* The mouse-fixup-help-message Lisp function can call
2074 mouse_position_hook, which resets the mouse_moved flags.
2075 This causes trouble if we are trying to read a mouse motion
2076 event (i.e., if we are inside a `track-mouse' form), so we
2077 restore the mouse_moved flag. */
2078 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2079 help
= call1 (Qmouse_fixup_help_message
, help
);
2081 f
->mouse_moved
= true;
2084 if (STRINGP (help
) || NILP (help
))
2086 if (!NILP (Vshow_help_function
))
2087 call1 (Vshow_help_function
, Fsubstitute_command_keys (help
));
2088 help_echo_showing_p
= STRINGP (help
);
2094 /* Input of single characters from keyboard. */
2096 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2097 struct timespec
*end_time
);
2098 static void record_char (Lisp_Object c
);
2100 static Lisp_Object help_form_saved_window_configs
;
2102 read_char_help_form_unwind (void)
2104 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2105 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2106 if (!NILP (window_config
))
2107 Fset_window_configuration (window_config
);
2110 #define STOP_POLLING \
2111 do { if (! polling_stopped_here) stop_polling (); \
2112 polling_stopped_here = true; } while (0)
2114 #define RESUME_POLLING \
2115 do { if (polling_stopped_here) start_polling (); \
2116 polling_stopped_here = false; } while (0)
2119 read_event_from_main_queue (struct timespec
*end_time
,
2120 sys_jmp_buf local_getcjmp
,
2121 bool *used_mouse_menu
)
2123 Lisp_Object c
= Qnil
;
2124 sys_jmp_buf save_jump
;
2129 /* Read from the main queue, and if that gives us something we can't use yet,
2130 we put it on the appropriate side queue and try again. */
2132 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2135 /* Actually read a character, waiting if necessary. */
2136 save_getcjmp (save_jump
);
2137 restore_getcjmp (local_getcjmp
);
2139 timer_start_idle ();
2140 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2141 restore_getcjmp (save_jump
);
2143 if (! NILP (c
) && (kb
!= current_kboard
))
2145 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2148 while (CONSP (XCDR (last
)))
2150 if (!NILP (XCDR (last
)))
2154 kset_kbd_queue (kb
, list1 (c
));
2156 XSETCDR (last
, list1 (c
));
2157 kb
->kbd_queue_has_data
= true;
2161 current_kboard
= kb
;
2162 return make_number (-2);
2165 /* Terminate Emacs in batch mode if at eof. */
2166 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2167 Fkill_emacs (make_number (1));
2171 /* Add in any extra modifiers, where appropriate. */
2172 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2173 || ((extra_keyboard_modifiers
& 0177) < ' '
2174 && (extra_keyboard_modifiers
& 0177) != 0))
2175 XSETINT (c
, make_ctrl_char (XINT (c
)));
2177 /* Transfer any other modifier bits directly from
2178 extra_keyboard_modifiers to c. Ignore the actual character code
2179 in the low 16 bits of extra_keyboard_modifiers. */
2180 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2188 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2191 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2192 sys_jmp_buf local_getcjmp
,
2193 Lisp_Object prev_event
,
2194 bool *used_mouse_menu
)
2197 #define MAX_ENCODED_BYTES 16
2198 Lisp_Object events
[MAX_ENCODED_BYTES
];
2204 = read_event_from_main_queue (end_time
, local_getcjmp
,
2207 /* w32_console already returns decoded events. It either reads
2208 Unicode characters from the Windows keyboard input, or
2209 converts characters encoded in the current codepage into
2210 Unicode. See w32inevt.c:key_event, near its end. */
2213 struct frame
*frame
= XFRAME (selected_frame
);
2214 struct terminal
*terminal
= frame
->terminal
;
2215 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2216 /* Don't apply decoding if we're just reading a raw event
2217 (e.g. reading bytes sent by the xterm to specify the position
2218 of a mouse click). */
2219 && (!EQ (prev_event
, Qt
))
2220 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2221 & CODING_REQUIRE_DECODING_MASK
)))
2222 return nextevt
; /* No decoding needed. */
2225 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2226 eassert (n
< MAX_ENCODED_BYTES
);
2227 events
[n
++] = nextevt
;
2228 if (NATNUMP (nextevt
)
2229 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2230 { /* An encoded byte sequence, let's try to decode it. */
2231 struct coding_system
*coding
2232 = TERMINAL_KEYBOARD_CODING (terminal
);
2234 if (raw_text_coding_system_p (coding
))
2238 for (i
= 0; i
< n
; i
++)
2239 events
[i
] = make_number (XINT (events
[i
]) & ~0x80);
2243 unsigned char src
[MAX_ENCODED_BYTES
];
2244 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2246 for (i
= 0; i
< n
; i
++)
2247 src
[i
] = XINT (events
[i
]);
2249 for (i
= 0; i
< n
; i
++)
2251 coding
->destination
= dest
;
2252 coding
->dst_bytes
= sizeof dest
;
2253 decode_coding_c_string (coding
, src
, n
, Qnil
);
2254 eassert (coding
->produced_char
<= n
);
2255 if (coding
->produced_char
== 0)
2256 { /* The encoded sequence is incomplete. */
2257 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2258 continue; /* Read on! */
2262 const unsigned char *p
= coding
->destination
;
2263 eassert (coding
->carryover_bytes
== 0);
2265 while (n
< coding
->produced_char
)
2266 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2270 /* Now `events' should hold decoded events.
2271 Normally, n should be equal to 1, but better not rely on it.
2272 We can only return one event here, so return the first we
2273 had and keep the others (if any) for later. */
2275 Vunread_command_events
2276 = Fcons (events
[--n
], Vunread_command_events
);
2283 /* Read a character from the keyboard; call the redisplay if needed. */
2284 /* commandflag 0 means do not autosave, but do redisplay.
2285 -1 means do not redisplay, but do autosave.
2286 -2 means do neither.
2289 The argument MAP is a keymap for menu prompting.
2291 PREV_EVENT is the previous input event, or nil if we are reading
2292 the first event of a key sequence (or not reading a key sequence).
2293 If PREV_EVENT is t, that is a "magic" value that says
2294 not to run input methods, but in other respects to act as if
2295 not reading a key sequence.
2297 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2298 if we used a mouse menu to read the input, or false otherwise. If
2299 USED_MOUSE_MENU is null, don't dereference it.
2301 Value is -2 when we find input on another keyboard. A second call
2302 to read_char will read it.
2304 If END_TIME is non-null, it is a pointer to a struct timespec
2305 specifying the maximum time to wait until. If no input arrives by
2306 that time, stop waiting and return nil.
2308 Value is t if we showed a menu and the user rejected it. */
2311 read_char (int commandflag
, Lisp_Object map
,
2312 Lisp_Object prev_event
,
2313 bool *used_mouse_menu
, struct timespec
*end_time
)
2315 Lisp_Object NONVOLATILE c
;
2317 sys_jmp_buf local_getcjmp
;
2318 sys_jmp_buf save_jump
;
2319 Lisp_Object tem
, save
;
2320 volatile Lisp_Object previous_echo_area_message
;
2321 volatile Lisp_Object also_record
;
2322 volatile bool reread
, recorded
;
2323 bool volatile polling_stopped_here
= false;
2324 struct kboard
*orig_kboard
= current_kboard
;
2329 previous_echo_area_message
= Qnil
;
2335 if (CONSP (Vunread_post_input_method_events
))
2337 c
= XCAR (Vunread_post_input_method_events
);
2338 Vunread_post_input_method_events
2339 = XCDR (Vunread_post_input_method_events
);
2341 /* Undo what read_char_x_menu_prompt did when it unread
2342 additional keys returned by Fx_popup_menu. */
2344 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2355 if (CONSP (Vunread_command_events
))
2357 bool was_disabled
= false;
2359 c
= XCAR (Vunread_command_events
);
2360 Vunread_command_events
= XCDR (Vunread_command_events
);
2362 /* Undo what sit-for did when it unread additional keys
2363 inside universal-argument. */
2365 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2370 /* Undo what read_char_x_menu_prompt did when it unread
2371 additional keys returned by Fx_popup_menu. */
2373 && EQ (XCDR (c
), Qdisabled
)
2374 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2376 was_disabled
= true;
2380 /* If the queued event is something that used the mouse,
2381 set used_mouse_menu accordingly. */
2383 /* Also check was_disabled so last-nonmenu-event won't return
2384 a bad value when submenus are involved. (Bug#447) */
2385 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2386 *used_mouse_menu
= true;
2388 goto reread_for_input_method
;
2391 if (CONSP (Vunread_input_method_events
))
2393 c
= XCAR (Vunread_input_method_events
);
2394 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2396 /* Undo what read_char_x_menu_prompt did when it unread
2397 additional keys returned by Fx_popup_menu. */
2399 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2403 goto reread_for_input_method
;
2406 if (!NILP (Vexecuting_kbd_macro
))
2408 /* We set this to Qmacro; since that's not a frame, nobody will
2409 try to switch frames on us, and the selected window will
2412 Since this event came from a macro, it would be misleading to
2413 leave internal_last_event_frame set to wherever the last
2414 real event came from. Normally, a switch-frame event selects
2415 internal_last_event_frame after each command is read, but
2416 events read from a macro should never cause a new frame to be
2418 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2420 /* Exit the macro if we are at the end.
2421 Also, some things replace the macro with t
2422 to force an early exit. */
2423 if (EQ (Vexecuting_kbd_macro
, Qt
)
2424 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2430 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2431 if (STRINGP (Vexecuting_kbd_macro
)
2432 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2433 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2435 executing_kbd_macro_index
++;
2440 if (!NILP (unread_switch_frame
))
2442 c
= unread_switch_frame
;
2443 unread_switch_frame
= Qnil
;
2445 /* This event should make it into this_command_keys, and get echoed
2446 again, so we do not set `reread'. */
2450 /* If redisplay was requested. */
2451 if (commandflag
>= 0)
2453 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2455 /* If there is pending input, process any events which are not
2456 user-visible, such as X selection_request events. */
2458 || detect_input_pending_run_timers (0))
2459 swallow_events (false); /* May clear input_pending. */
2461 /* Redisplay if no pending input. */
2462 while (!(input_pending
2463 && (input_was_pending
|| !redisplay_dont_pause
)))
2465 input_was_pending
= input_pending
;
2466 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2467 redisplay_preserve_echo_area (5);
2472 /* Normal case: no input arrived during redisplay. */
2475 /* Input arrived and pre-empted redisplay.
2476 Process any events which are not user-visible. */
2477 swallow_events (false);
2478 /* If that cleared input_pending, try again to redisplay. */
2481 /* Prevent the redisplay we just did
2482 from messing up echoing of the input after the prompt. */
2483 if (commandflag
== 0 && echo_current
)
2484 echo_message_buffer
= echo_area_buffer
[0];
2488 /* Message turns off echoing unless more keystrokes turn it on again.
2490 The code in 20.x for the condition was
2492 1. echo_area_glyphs && *echo_area_glyphs
2493 2. && echo_area_glyphs != current_kboard->echobuf
2494 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2496 (1) means there's a current message displayed
2498 (2) means it's not the message from echoing from the current
2501 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2502 is set to a non-null value. This is done in read_char and it is
2503 set to echo_area_glyphs. That means
2504 ok_to_echo_at_next_pause is either null or
2505 current_kboard->echobuf with the appropriate current_kboard at
2508 So, condition (3) means in clear text ok_to_echo_at_next_pause
2509 must be either null, or the current message isn't from echoing at
2510 all, or it's from echoing from a different kboard than the
2513 if (/* There currently is something in the echo area. */
2514 !NILP (echo_area_buffer
[0])
2515 && (/* It's an echo from a different kboard. */
2516 echo_kboard
!= current_kboard
2517 /* Or we explicitly allow overwriting whatever there is. */
2518 || ok_to_echo_at_next_pause
== NULL
))
2523 /* Try reading a character via menu prompting in the minibuf.
2524 Try this before the sit-for, because the sit-for
2525 would do the wrong thing if we are supposed to do
2526 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2527 after a mouse event so don't try a minibuf menu. */
2529 if (KEYMAPP (map
) && INTERACTIVE
2530 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2531 /* Don't bring up a menu if we already have another event. */
2532 && !CONSP (Vunread_command_events
)
2533 && !detect_input_pending_run_timers (0))
2535 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2537 if (INTEGERP (c
) && XINT (c
) == -2)
2538 return c
; /* wrong_kboard_jmpbuf */
2544 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2545 We will do that below, temporarily for short sections of code,
2546 when appropriate. local_getcjmp must be in effect
2547 around any call to sit_for or kbd_buffer_get_event;
2548 it *must not* be in effect when we call redisplay. */
2550 jmpcount
= SPECPDL_INDEX ();
2551 if (sys_setjmp (local_getcjmp
))
2553 /* Handle quits while reading the keyboard. */
2554 /* We must have saved the outer value of getcjmp here,
2555 so restore it now. */
2556 restore_getcjmp (save_jump
);
2557 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2558 unbind_to (jmpcount
, Qnil
);
2559 XSETINT (c
, quit_char
);
2560 internal_last_event_frame
= selected_frame
;
2561 Vlast_event_frame
= internal_last_event_frame
;
2562 /* If we report the quit char as an event,
2563 don't do so more than once. */
2564 if (!NILP (Vinhibit_quit
))
2568 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2569 if (kb
!= current_kboard
)
2571 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2572 /* We shouldn't get here if we were in single-kboard mode! */
2577 while (CONSP (XCDR (last
)))
2579 if (!NILP (XCDR (last
)))
2583 kset_kbd_queue (kb
, list1 (c
));
2585 XSETCDR (last
, list1 (c
));
2586 kb
->kbd_queue_has_data
= true;
2587 current_kboard
= kb
;
2588 return make_number (-2); /* wrong_kboard_jmpbuf */
2594 /* Start idle timers if no time limit is supplied. We don't do it
2595 if a time limit is supplied to avoid an infinite recursion in the
2596 situation where an idle timer calls `sit-for'. */
2599 timer_start_idle ();
2601 /* If in middle of key sequence and minibuffer not active,
2602 start echoing if enough time elapses. */
2604 if (minibuf_level
== 0
2606 && !current_kboard
->immediate_echo
2607 && (this_command_key_count
> 0
2608 || !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
2610 && echo_keystrokes_p ()
2611 && (/* No message. */
2612 NILP (echo_area_buffer
[0])
2613 /* Or empty message. */
2614 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2615 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2616 /* Or already echoing from same kboard. */
2617 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2618 /* Or not echoing before and echoing allowed. */
2619 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2621 /* After a mouse event, start echoing right away.
2622 This is because we are probably about to display a menu,
2623 and we don't want to delay before doing so. */
2624 if (EVENT_HAS_PARAMETERS (prev_event
))
2630 save_getcjmp (save_jump
);
2631 restore_getcjmp (local_getcjmp
);
2632 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2633 restore_getcjmp (save_jump
);
2635 && ! CONSP (Vunread_command_events
))
2640 /* Maybe auto save due to number of keystrokes. */
2642 if (commandflag
!= 0 && commandflag
!= -2
2643 && auto_save_interval
> 0
2644 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2645 && !detect_input_pending_run_timers (0))
2647 Fdo_auto_save (Qnil
, Qnil
);
2648 /* Hooks can actually change some buffers in auto save. */
2652 /* Try reading using an X menu.
2653 This is never confused with reading using the minibuf
2654 because the recursive call of read_char in read_char_minibuf_menu_prompt
2655 does not pass on any keymaps. */
2657 if (KEYMAPP (map
) && INTERACTIVE
2658 && !NILP (prev_event
)
2659 && EVENT_HAS_PARAMETERS (prev_event
)
2660 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2661 && !EQ (XCAR (prev_event
), Qtool_bar
)
2662 /* Don't bring up a menu if we already have another event. */
2663 && !CONSP (Vunread_command_events
))
2665 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2667 /* Now that we have read an event, Emacs is not idle. */
2674 /* Maybe autosave and/or garbage collect due to idleness. */
2676 if (INTERACTIVE
&& NILP (c
))
2679 ptrdiff_t buffer_size
;
2681 /* Slow down auto saves logarithmically in size of current buffer,
2682 and garbage collect while we're at it. */
2683 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2684 last_non_minibuf_size
= Z
- BEG
;
2685 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2687 while (buffer_size
> 64)
2688 delay_level
++, buffer_size
-= buffer_size
>> 2;
2689 if (delay_level
< 4) delay_level
= 4;
2690 /* delay_level is 4 for files under around 50k, 7 at 100k,
2691 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2693 /* Auto save if enough time goes by without input. */
2694 if (commandflag
!= 0 && commandflag
!= -2
2695 && num_nonmacro_input_events
> last_auto_save
2696 && INTEGERP (Vauto_save_timeout
)
2697 && XINT (Vauto_save_timeout
) > 0)
2700 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2702 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2703 timeout
= delay_level
* timeout
/ 4;
2704 save_getcjmp (save_jump
);
2705 restore_getcjmp (local_getcjmp
);
2706 tem0
= sit_for (make_number (timeout
), 1, 1);
2707 restore_getcjmp (save_jump
);
2710 && ! CONSP (Vunread_command_events
))
2712 Fdo_auto_save (Qnil
, Qnil
);
2717 /* If there is still no input available, ask for GC. */
2718 if (!detect_input_pending_run_timers (0))
2722 /* Notify the caller if an autosave hook, or a timer, sentinel or
2723 filter in the sit_for calls above have changed the current
2724 kboard. This could happen if they use the minibuffer or start a
2725 recursive edit, like the fancy splash screen in server.el's
2726 filter. If this longjmp wasn't here, read_key_sequence would
2727 interpret the next key sequence using the wrong translation
2728 tables and function keymaps. */
2729 if (NILP (c
) && current_kboard
!= orig_kboard
)
2730 return make_number (-2); /* wrong_kboard_jmpbuf */
2732 /* If this has become non-nil here, it has been set by a timer
2733 or sentinel or filter. */
2734 if (CONSP (Vunread_command_events
))
2736 c
= XCAR (Vunread_command_events
);
2737 Vunread_command_events
= XCDR (Vunread_command_events
);
2739 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2745 /* Read something from current KBOARD's side queue, if possible. */
2749 if (current_kboard
->kbd_queue_has_data
)
2751 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2753 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2754 kset_kbd_queue (current_kboard
,
2755 XCDR (KVAR (current_kboard
, kbd_queue
)));
2756 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2757 current_kboard
->kbd_queue_has_data
= false;
2758 input_pending
= readable_events (0);
2759 if (EVENT_HAS_PARAMETERS (c
)
2760 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2761 internal_last_event_frame
= XCAR (XCDR (c
));
2762 Vlast_event_frame
= internal_last_event_frame
;
2766 /* If current_kboard's side queue is empty check the other kboards.
2767 If one of them has data that we have not yet seen here,
2768 switch to it and process the data waiting for it.
2770 Note: if the events queued up for another kboard
2771 have already been seen here, and therefore are not a complete command,
2772 the kbd_queue_has_data field is 0, so we skip that kboard here.
2773 That's to avoid an infinite loop switching between kboards here. */
2774 if (NILP (c
) && !single_kboard
)
2777 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2778 if (kb
->kbd_queue_has_data
)
2780 current_kboard
= kb
;
2781 return make_number (-2); /* wrong_kboard_jmpbuf */
2791 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2792 prev_event
, used_mouse_menu
);
2793 if (NILP (c
) && end_time
2794 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2799 if (EQ (c
, make_number (-2)))
2811 if (commandflag
>= 0
2812 && !input_pending
&& !detect_input_pending_run_timers (0))
2818 /* Buffer switch events are only for internal wakeups
2819 so don't show them to the user.
2820 Also, don't record a key if we already did. */
2824 /* Process special events within read_char
2825 and loop around to read another event. */
2828 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2833 struct buffer
*prev_buffer
= current_buffer
;
2834 last_input_event
= c
;
2835 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2838 && (EQ (XCAR (c
), Qselect_window
)
2840 || EQ (XCAR (c
), Qdbus_event
)
2842 #ifdef USE_FILE_NOTIFY
2843 || EQ (XCAR (c
), Qfile_notify
)
2845 || EQ (XCAR (c
), Qconfig_changed_event
))
2847 /* We stopped being idle for this event; undo that. This
2848 prevents automatic window selection (under
2849 mouse-autoselect-window) from acting as a real input event, for
2850 example banishing the mouse under mouse-avoidance-mode. */
2851 timer_resume_idle ();
2853 if (current_buffer
!= prev_buffer
)
2855 /* The command may have changed the keymaps. Pretend there
2856 is input in another keyboard and return. This will
2857 recalculate keymaps. */
2858 c
= make_number (-2);
2865 /* Handle things that only apply to characters. */
2868 /* If kbd_buffer_get_event gave us an EOF, return that. */
2872 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2873 && UNSIGNED_CMP (XFASTINT (c
), <,
2874 SCHARS (KVAR (current_kboard
,
2875 Vkeyboard_translate_table
))))
2876 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2877 && UNSIGNED_CMP (XFASTINT (c
), <,
2878 ASIZE (KVAR (current_kboard
,
2879 Vkeyboard_translate_table
))))
2880 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2884 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2885 /* nil in keyboard-translate-table means no translation. */
2891 /* If this event is a mouse click in the menu bar,
2892 return just menu-bar for now. Modify the mouse click event
2893 so we won't do this twice, then queue it up. */
2894 if (EVENT_HAS_PARAMETERS (c
)
2896 && CONSP (EVENT_START (c
))
2897 && CONSP (XCDR (EVENT_START (c
))))
2901 posn
= POSN_POSN (EVENT_START (c
));
2902 /* Handle menu-bar events:
2903 insert the dummy prefix event `menu-bar'. */
2904 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2906 /* Change menu-bar to (menu-bar) as the event "position". */
2907 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2910 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2915 /* Store these characters into recent_keys, the dribble file if any,
2916 and the keyboard macro being defined, if any. */
2919 if (! NILP (also_record
))
2920 record_char (also_record
);
2922 /* Wipe the echo area.
2923 But first, if we are about to use an input method,
2924 save the echo area contents for it to refer to. */
2926 && ! NILP (Vinput_method_function
)
2927 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2929 previous_echo_area_message
= Fcurrent_message ();
2930 Vinput_method_previous_message
= previous_echo_area_message
;
2933 /* Now wipe the echo area, except for help events which do their
2934 own stuff with the echo area. */
2936 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2937 && !(EQ (Qswitch_frame
, XCAR (c
)))
2938 /* Don't wipe echo area for select window events: These might
2939 get delayed via `mouse-autoselect-window' (Bug#11304). */
2940 && !(EQ (Qselect_window
, XCAR (c
)))))
2942 if (!NILP (echo_area_buffer
[0]))
2944 safe_run_hooks (Qecho_area_clear_hook
);
2945 clear_message (1, 0);
2949 reread_for_input_method
:
2951 /* Pass this to the input method, if appropriate. */
2953 && ! NILP (Vinput_method_function
)
2954 /* Don't run the input method within a key sequence,
2955 after the first event of the key sequence. */
2956 && NILP (prev_event
)
2957 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2960 ptrdiff_t key_count
;
2961 ptrdiff_t command_key_start
;
2962 ptrdiff_t count
= SPECPDL_INDEX ();
2964 /* Save the echo status. */
2965 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2966 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2967 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2968 Lisp_Object saved_echo_prompt
= KVAR (current_kboard
, echo_prompt
);
2970 /* Save the this_command_keys status. */
2971 key_count
= this_command_key_count
;
2972 command_key_start
= this_single_command_key_start
;
2975 keys
= Fcopy_sequence (this_command_keys
);
2979 /* Clear out this_command_keys. */
2980 this_command_key_count
= 0;
2981 this_single_command_key_start
= 0;
2983 /* Now wipe the echo area. */
2984 if (!NILP (echo_area_buffer
[0]))
2985 safe_run_hooks (Qecho_area_clear_hook
);
2986 clear_message (1, 0);
2989 /* If we are not reading a key sequence,
2990 never use the echo area. */
2993 specbind (Qinput_method_use_echo_area
, Qt
);
2996 /* Call the input method. */
2997 tem
= call1 (Vinput_method_function
, c
);
2999 tem
= unbind_to (count
, tem
);
3001 /* Restore the saved echoing state
3002 and this_command_keys state. */
3003 this_command_key_count
= key_count
;
3004 this_single_command_key_start
= command_key_start
;
3006 this_command_keys
= keys
;
3009 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3010 kset_echo_string (current_kboard
, saved_echo_string
);
3011 kset_echo_prompt (current_kboard
, saved_echo_prompt
);
3012 if (saved_immediate_echo
)
3015 /* The input method can return no events. */
3018 /* Bring back the previous message, if any. */
3019 if (! NILP (previous_echo_area_message
))
3020 message_with_string ("%s", previous_echo_area_message
, 0);
3023 /* It returned one event or more. */
3025 Vunread_post_input_method_events
3026 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3028 /* When we consume events from the various unread-*-events lists, we
3029 bypass the code that records input, so record these events now if
3030 they were not recorded already. */
3039 /* Display help if not echoing. */
3040 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3042 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3043 Lisp_Object help
, object
, position
, window
, htem
;
3045 htem
= Fcdr (XCDR (c
));
3048 window
= Fcar (htem
);
3050 object
= Fcar (htem
);
3052 position
= Fcar (htem
);
3054 show_help_echo (help
, window
, object
, position
);
3056 /* We stopped being idle for this event; undo that. */
3058 timer_resume_idle ();
3062 if ((! reread
|| this_command_key_count
== 0)
3066 /* Don't echo mouse motion events. */
3067 if (! (EVENT_HAS_PARAMETERS (c
)
3068 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3069 /* Once we reread a character, echoing can happen
3070 the next time we pause to read a new one. */
3071 ok_to_echo_at_next_pause
= current_kboard
;
3073 /* Record this character as part of the current key. */
3074 add_command_key (c
);
3075 if (! NILP (also_record
))
3076 add_command_key (also_record
);
3081 last_input_event
= c
;
3084 /* Process the help character specially if enabled. */
3085 if (!NILP (Vhelp_form
) && help_char_p (c
))
3087 ptrdiff_t count
= SPECPDL_INDEX ();
3089 help_form_saved_window_configs
3090 = Fcons (Fcurrent_window_configuration (Qnil
),
3091 help_form_saved_window_configs
);
3092 record_unwind_protect_void (read_char_help_form_unwind
);
3093 call0 (Qhelp_form_show
);
3098 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3099 if (EVENT_HAS_PARAMETERS (c
)
3100 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3101 XSETCAR (help_form_saved_window_configs
, Qnil
);
3103 while (BUFFERP (c
));
3104 /* Remove the help from the frame. */
3105 unbind_to (count
, Qnil
);
3108 if (EQ (c
, make_number (040)))
3112 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3113 while (BUFFERP (c
));
3119 input_was_pending
= input_pending
;
3123 /* Record a key that came from a mouse menu.
3124 Record it for echoing, for this-command-keys, and so on. */
3127 record_menu_key (Lisp_Object c
)
3129 /* Wipe the echo area. */
3130 clear_message (1, 0);
3134 /* Once we reread a character, echoing can happen
3135 the next time we pause to read a new one. */
3136 ok_to_echo_at_next_pause
= NULL
;
3138 /* Record this character as part of the current key. */
3139 add_command_key (c
);
3142 /* Re-reading in the middle of a command. */
3143 last_input_event
= c
;
3147 /* Return true if should recognize C as "the help character". */
3150 help_char_p (Lisp_Object c
)
3154 if (EQ (c
, Vhelp_char
))
3156 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3157 if (EQ (c
, XCAR (tail
)))
3162 /* Record the input event C in various ways. */
3165 record_char (Lisp_Object c
)
3169 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3171 /* To avoid filling recent_keys with help-echo and mouse-movement
3172 events, we filter out repeated help-echo events, only store the
3173 first and last in a series of mouse-movement events, and don't
3174 store repeated help-echo events which are only separated by
3175 mouse-movement events. */
3177 Lisp_Object ev1
, ev2
, ev3
;
3180 if ((ix1
= recent_keys_index
- 1) < 0)
3181 ix1
= NUM_RECENT_KEYS
- 1;
3182 ev1
= AREF (recent_keys
, ix1
);
3184 if ((ix2
= ix1
- 1) < 0)
3185 ix2
= NUM_RECENT_KEYS
- 1;
3186 ev2
= AREF (recent_keys
, ix2
);
3188 if ((ix3
= ix2
- 1) < 0)
3189 ix3
= NUM_RECENT_KEYS
- 1;
3190 ev3
= AREF (recent_keys
, ix3
);
3192 if (EQ (XCAR (c
), Qhelp_echo
))
3194 /* Don't record `help-echo' in recent_keys unless it shows some help
3195 message, and a different help than the previously recorded
3197 Lisp_Object help
, last_help
;
3199 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3200 if (!STRINGP (help
))
3202 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3203 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3205 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3206 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3207 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3209 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3210 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3211 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3212 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3215 else if (EQ (XCAR (c
), Qmouse_movement
))
3217 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3218 So additional mouse movement events replace the last element. */
3219 Lisp_Object last_window
, window
;
3221 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3222 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3223 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3224 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3225 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3227 ASET (recent_keys
, ix1
, c
);
3233 store_kbd_macro_char (c
);
3235 /* recent_keys should not include events from keyboard macros. */
3236 if (NILP (Vexecuting_kbd_macro
))
3240 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3241 ASET (recent_keys
, recent_keys_index
, c
);
3242 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3243 recent_keys_index
= 0;
3245 else if (recorded
< 0)
3247 /* We need to remove one or two events from recent_keys.
3248 To do this, we simply put nil at those events and move the
3249 recent_keys_index backwards over those events. Usually,
3250 users will never see those nil events, as they will be
3251 overwritten by the command keys entered to see recent_keys
3254 while (recorded
++ < 0 && total_keys
> 0)
3256 if (total_keys
< NUM_RECENT_KEYS
)
3258 if (--recent_keys_index
< 0)
3259 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3260 ASET (recent_keys
, recent_keys_index
, Qnil
);
3264 num_nonmacro_input_events
++;
3267 /* Write c to the dribble file. If c is a lispy event, write
3268 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3269 If you, dear reader, have a better idea, you've got the source. :-) */
3275 if (XUINT (c
) < 0x100)
3276 putc (XUINT (c
), dribble
);
3278 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3282 Lisp_Object dribblee
;
3284 /* If it's a structured event, take the event header. */
3285 dribblee
= EVENT_HEAD (c
);
3287 if (SYMBOLP (dribblee
))
3289 putc ('<', dribble
);
3290 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3291 SBYTES (SYMBOL_NAME (dribblee
)),
3293 putc ('>', dribble
);
3302 /* Copy out or in the info on where C-g should throw to.
3303 This is used when running Lisp code from within get_char,
3304 in case get_char is called recursively.
3305 See read_process_output. */
3308 save_getcjmp (sys_jmp_buf temp
)
3310 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3314 restore_getcjmp (sys_jmp_buf temp
)
3316 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3319 /* Low level keyboard/mouse input.
3320 kbd_buffer_store_event places events in kbd_buffer, and
3321 kbd_buffer_get_event retrieves them. */
3323 /* Return true if there are any events in the queue that read-char
3324 would return. If this returns false, a read-char would block. */
3326 readable_events (int flags
)
3328 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3331 /* If the buffer contains only FOCUS_IN_EVENT events, and
3332 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3333 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3335 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3336 #ifdef USE_TOOLKIT_SCROLL_BARS
3337 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3341 union buffered_input_event
*event
= kbd_fetch_ptr
;
3345 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3348 #ifdef USE_TOOLKIT_SCROLL_BARS
3349 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3351 event
->kind
== FOCUS_IN_EVENT
)
3352 #ifdef USE_TOOLKIT_SCROLL_BARS
3353 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3354 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3355 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3356 && event
->ie
.part
== scroll_bar_handle
3357 && event
->ie
.modifiers
== 0)
3359 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3360 && event
->kind
== BUFFER_SWITCH_EVENT
))
3364 while (event
!= kbd_store_ptr
);
3370 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3371 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3375 if (current_kboard
->kbd_queue_has_data
)
3381 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3382 if (kb
->kbd_queue_has_data
)
3388 /* Set this for debugging, to have a way to get out */
3389 int stop_character EXTERNALLY_VISIBLE
;
3392 event_to_kboard (struct input_event
*event
)
3394 /* Not applicable for these special events. */
3395 if (event
->kind
== SELECTION_REQUEST_EVENT
3396 || event
->kind
== SELECTION_CLEAR_EVENT
)
3400 Lisp_Object obj
= event
->frame_or_window
;
3401 /* There are some events that set this field to nil or string. */
3403 obj
= WINDOW_FRAME (XWINDOW (obj
));
3404 /* Also ignore dead frames here. */
3405 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3406 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3411 /* Return the number of slots occupied in kbd_buffer. */
3414 kbd_buffer_nr_stored (void)
3416 return kbd_fetch_ptr
== kbd_store_ptr
3418 : (kbd_fetch_ptr
< kbd_store_ptr
3419 ? kbd_store_ptr
- kbd_fetch_ptr
3420 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3421 + (kbd_store_ptr
- kbd_buffer
)));
3423 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3426 kbd_buffer_store_event (register struct input_event
*event
)
3428 kbd_buffer_store_event_hold (event
, 0);
3431 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3433 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3434 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3435 Else, if EVENT is a quit event, store the quit event
3436 in HOLD_QUIT, and return (thus ignoring further events).
3438 This is used to postpone the processing of the quit event until all
3439 subsequent input events have been parsed (and discarded). */
3442 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3443 struct input_event
*hold_quit
)
3445 if (event
->kind
== NO_EVENT
)
3448 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3451 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3453 int c
= event
->ie
.code
& 0377;
3455 if (event
->ie
.modifiers
& ctrl_modifier
)
3456 c
= make_ctrl_char (c
);
3458 c
|= (event
->ie
.modifiers
3459 & (meta_modifier
| alt_modifier
3460 | hyper_modifier
| super_modifier
));
3464 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3466 if (single_kboard
&& kb
!= current_kboard
)
3469 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3471 kb
->kbd_queue_has_data
= true;
3472 union buffered_input_event
*sp
;
3473 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3475 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3478 if (event_to_kboard (&sp
->ie
) == kb
)
3480 sp
->ie
.kind
= NO_EVENT
;
3481 sp
->ie
.frame_or_window
= Qnil
;
3490 *hold_quit
= event
->ie
;
3494 /* If this results in a quit_char being returned to Emacs as
3495 input, set Vlast_event_frame properly. If this doesn't
3496 get returned to Emacs as an event, the next event read
3497 will set Vlast_event_frame again, so this is safe to do. */
3501 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3503 focus
= event
->ie
.frame_or_window
;
3504 internal_last_event_frame
= focus
;
3505 Vlast_event_frame
= focus
;
3508 handle_interrupt (0);
3512 if (c
&& c
== stop_character
)
3518 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3519 Just ignore the second one. */
3520 else if (event
->kind
== BUFFER_SWITCH_EVENT
3521 && kbd_fetch_ptr
!= kbd_store_ptr
3522 && ((kbd_store_ptr
== kbd_buffer
3523 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3524 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3527 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3528 kbd_store_ptr
= kbd_buffer
;
3530 /* Don't let the very last slot in the buffer become full,
3531 since that would make the two pointers equal,
3532 and that is indistinguishable from an empty buffer.
3533 Discard the event if it would fill the last slot. */
3534 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3536 *kbd_store_ptr
= *event
;
3539 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3540 && ! kbd_on_hold_p ())
3542 /* Don't read keyboard input until we have processed kbd_buffer.
3543 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3544 hold_keyboard_input ();
3548 #endif /* subprocesses */
3551 /* If we're inside while-no-input, and this event qualifies
3552 as input, set quit-flag to cause an interrupt. */
3553 if (!NILP (Vthrow_on_input
)
3554 && event
->kind
!= FOCUS_IN_EVENT
3555 && event
->kind
!= FOCUS_OUT_EVENT
3556 && event
->kind
!= HELP_EVENT
3557 && event
->kind
!= ICONIFY_EVENT
3558 && event
->kind
!= DEICONIFY_EVENT
)
3560 Vquit_flag
= Vthrow_on_input
;
3561 /* If we're inside a function that wants immediate quits,
3563 if (immediate_quit
&& NILP (Vinhibit_quit
))
3565 immediate_quit
= false;
3574 /* Put a selection input event back in the head of the event queue. */
3577 kbd_buffer_unget_event (struct selection_input_event
*event
)
3579 if (kbd_fetch_ptr
== kbd_buffer
)
3580 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3582 /* Don't let the very last slot in the buffer become full, */
3583 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3584 if (kp
!= kbd_store_ptr
)
3593 /* Limit help event positions to this range, to avoid overflow problems. */
3594 #define INPUT_EVENT_POS_MAX \
3595 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3596 MOST_POSITIVE_FIXNUM)))
3597 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3599 /* Return a Time that encodes position POS. POS must be in range. */
3602 position_to_Time (ptrdiff_t pos
)
3604 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3608 /* Return the position that ENCODED_POS encodes.
3609 Avoid signed integer overflow. */
3612 Time_to_position (Time encoded_pos
)
3614 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3616 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3617 eassert (encoded_pos_min
<= encoded_pos
);
3618 ptrdiff_t notpos
= -1 - encoded_pos
;
3622 /* Generate a HELP_EVENT input_event and store it in the keyboard
3625 HELP is the help form.
3627 FRAME and WINDOW are the frame and window where the help is
3628 generated. OBJECT is the Lisp object where the help was found (a
3629 buffer, a string, an overlay, or nil if neither from a string nor
3630 from a buffer). POS is the position within OBJECT where the help
3634 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3635 Lisp_Object object
, ptrdiff_t pos
)
3637 struct input_event event
;
3639 event
.kind
= HELP_EVENT
;
3640 event
.frame_or_window
= frame
;
3642 event
.x
= WINDOWP (window
) ? window
: frame
;
3644 event
.timestamp
= position_to_Time (pos
);
3645 kbd_buffer_store_event (&event
);
3649 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3652 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3654 struct input_event event
;
3656 event
.kind
= HELP_EVENT
;
3657 event
.frame_or_window
= frame
;
3661 event
.timestamp
= 0;
3662 kbd_buffer_store_event (&event
);
3666 /* Discard any mouse events in the event buffer by setting them to
3669 discard_mouse_events (void)
3671 union buffered_input_event
*sp
;
3672 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3674 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3677 if (sp
->kind
== MOUSE_CLICK_EVENT
3678 || sp
->kind
== WHEEL_EVENT
3679 || sp
->kind
== HORIZ_WHEEL_EVENT
3681 || sp
->kind
== GPM_CLICK_EVENT
3683 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3684 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3686 sp
->kind
= NO_EVENT
;
3692 /* Return true if there are any real events waiting in the event
3693 buffer, not counting `NO_EVENT's.
3695 Discard NO_EVENT events at the front of the input queue, possibly
3696 leaving the input queue empty if there are no real input events. */
3699 kbd_buffer_events_waiting (void)
3701 union buffered_input_event
*sp
;
3703 for (sp
= kbd_fetch_ptr
;
3704 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3707 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3712 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3716 /* Clear input event EVENT. */
3719 clear_event (union buffered_input_event
*event
)
3721 event
->kind
= NO_EVENT
;
3725 /* Read one event from the event buffer, waiting if necessary.
3726 The value is a Lisp object representing the event.
3727 The value is nil for an event that should be ignored,
3728 or that was handled here.
3729 We always read and discard one event. */
3732 kbd_buffer_get_event (KBOARD
**kbp
,
3733 bool *used_mouse_menu
,
3734 struct timespec
*end_time
)
3739 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3741 /* Start reading input again because we have processed enough to
3742 be able to accept new events again. */
3743 unhold_keyboard_input ();
3747 #endif /* subprocesses */
3749 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3751 /* In case we are running as a daemon, only do this before
3752 detaching from the terminal. */
3753 || (IS_DAEMON
&& DAEMON_RUNNING
))
3757 *kbp
= current_kboard
;
3760 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3762 /* Wait until there is input available. */
3765 /* Break loop if there's an unread command event. Needed in
3766 moused window autoselection which uses a timer to insert such
3768 if (CONSP (Vunread_command_events
))
3771 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3773 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3776 /* If the quit flag is set, then read_char will return
3777 quit_char, so that counts as "available input." */
3778 if (!NILP (Vquit_flag
))
3779 quit_throw_to_read_char (0);
3781 /* One way or another, wait until input is available; then, if
3782 interrupt handlers have not read it, read it now. */
3787 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3789 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3793 struct timespec now
= current_timespec ();
3794 if (timespec_cmp (*end_time
, now
) <= 0)
3795 return Qnil
; /* Finished waiting. */
3798 struct timespec duration
= timespec_sub (*end_time
, now
);
3799 wait_reading_process_output (min (duration
.tv_sec
,
3802 -1, 1, Qnil
, NULL
, 0);
3807 bool do_display
= true;
3809 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3811 struct tty_display_info
*tty
= CURTTY ();
3813 /* When this TTY is displaying a menu, we must prevent
3814 any redisplay, because we modify the frame's glyph
3815 matrix behind the back of the display engine. */
3816 if (tty
->showing_menu
)
3820 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3823 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3827 if (CONSP (Vunread_command_events
))
3830 first
= XCAR (Vunread_command_events
);
3831 Vunread_command_events
= XCDR (Vunread_command_events
);
3832 *kbp
= current_kboard
;
3836 /* At this point, we know that there is a readable event available
3837 somewhere. If the event queue is empty, then there must be a
3838 mouse movement enabled and available. */
3839 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3841 union buffered_input_event
*event
;
3843 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3847 *kbp
= event_to_kboard (&event
->ie
);
3849 *kbp
= current_kboard
; /* Better than returning null ptr? */
3853 /* These two kinds of events get special handling
3854 and don't actually appear to the command loop.
3855 We return nil for them. */
3856 if (event
->kind
== SELECTION_REQUEST_EVENT
3857 || event
->kind
== SELECTION_CLEAR_EVENT
)
3860 /* Remove it from the buffer before processing it,
3861 since otherwise swallow_events will see it
3862 and process it again. */
3863 struct selection_input_event copy
= event
->sie
;
3864 kbd_fetch_ptr
= event
+ 1;
3865 input_pending
= readable_events (0);
3866 x_handle_selection_event (©
);
3868 /* We're getting selection request events, but we don't have
3874 #if defined (HAVE_NS)
3875 else if (event
->kind
== NS_TEXT_EVENT
)
3877 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3878 obj
= list1 (intern ("ns-put-working-text"));
3880 obj
= list1 (intern ("ns-unput-working-text"));
3881 kbd_fetch_ptr
= event
+ 1;
3882 if (used_mouse_menu
)
3883 *used_mouse_menu
= true;
3887 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3888 || defined (HAVE_NS)
3889 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3891 /* Make an event (delete-frame (FRAME)). */
3892 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
3893 kbd_fetch_ptr
= event
+ 1;
3898 else if (event
->kind
== END_SESSION_EVENT
)
3900 /* Make an event (end-session). */
3901 obj
= list1 (Qend_session
);
3902 kbd_fetch_ptr
= event
+ 1;
3906 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3907 || defined (HAVE_NS)
3908 else if (event
->kind
== ICONIFY_EVENT
)
3910 /* Make an event (iconify-frame (FRAME)). */
3911 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
3912 kbd_fetch_ptr
= event
+ 1;
3914 else if (event
->kind
== DEICONIFY_EVENT
)
3916 /* Make an event (make-frame-visible (FRAME)). */
3917 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
3918 kbd_fetch_ptr
= event
+ 1;
3921 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3923 /* The value doesn't matter here; only the type is tested. */
3924 XSETBUFFER (obj
, current_buffer
);
3925 kbd_fetch_ptr
= event
+ 1;
3927 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3928 || defined (HAVE_NS) || defined (USE_GTK)
3929 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3931 kbd_fetch_ptr
= event
+ 1;
3932 input_pending
= readable_events (0);
3933 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
3934 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
3938 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3940 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3941 obj
= list4 (Qlanguage_change
,
3942 event
->ie
.frame_or_window
,
3943 make_number (event
->ie
.code
),
3944 make_number (event
->ie
.modifiers
));
3945 kbd_fetch_ptr
= event
+ 1;
3948 #ifdef USE_FILE_NOTIFY
3949 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3951 #ifdef HAVE_W32NOTIFY
3952 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3953 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
3955 obj
= make_lispy_event (&event
->ie
);
3957 kbd_fetch_ptr
= event
+ 1;
3959 #endif /* USE_FILE_NOTIFY */
3960 else if (event
->kind
== SAVE_SESSION_EVENT
)
3962 obj
= list2 (Qsave_session
, event
->ie
.arg
);
3963 kbd_fetch_ptr
= event
+ 1;
3965 /* Just discard these, by returning nil.
3966 With MULTI_KBOARD, these events are used as placeholders
3967 when we need to randomly delete events from the queue.
3968 (They shouldn't otherwise be found in the buffer,
3969 but on some machines it appears they do show up
3970 even without MULTI_KBOARD.) */
3971 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3972 mouse events during a popup-menu call. */
3973 else if (event
->kind
== NO_EVENT
)
3974 kbd_fetch_ptr
= event
+ 1;
3975 else if (event
->kind
== HELP_EVENT
)
3977 Lisp_Object object
, position
, help
, frame
, window
;
3979 frame
= event
->ie
.frame_or_window
;
3980 object
= event
->ie
.arg
;
3981 position
= make_number (Time_to_position (event
->ie
.timestamp
));
3982 window
= event
->ie
.x
;
3984 clear_event (event
);
3986 kbd_fetch_ptr
= event
+ 1;
3987 if (!WINDOWP (window
))
3989 obj
= Fcons (Qhelp_echo
,
3990 list5 (frame
, help
, window
, object
, position
));
3992 else if (event
->kind
== FOCUS_IN_EVENT
)
3994 /* Notification of a FocusIn event. The frame receiving the
3995 focus is in event->frame_or_window. Generate a
3996 switch-frame event if necessary. */
3997 Lisp_Object frame
, focus
;
3999 frame
= event
->ie
.frame_or_window
;
4000 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4006 ! NILP (event
->ie
.arg
)
4009 !EQ (frame
, internal_last_event_frame
)
4010 && !EQ (frame
, selected_frame
))
4011 obj
= make_lispy_switch_frame (frame
);
4013 obj
= make_lispy_focus_in (frame
);
4015 internal_last_event_frame
= frame
;
4016 kbd_fetch_ptr
= event
+ 1;
4018 else if (event
->kind
== FOCUS_OUT_EVENT
)
4020 #ifdef HAVE_WINDOW_SYSTEM
4023 Lisp_Object frame
= event
->ie
.frame_or_window
;
4024 bool focused
= false;
4026 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4027 focused
= di
->x_highlight_frame
!= 0;
4030 obj
= make_lispy_focus_out (frame
);
4032 #endif /* HAVE_WINDOW_SYSTEM */
4034 kbd_fetch_ptr
= event
+ 1;
4037 else if (event
->kind
== DBUS_EVENT
)
4039 obj
= make_lispy_event (&event
->ie
);
4040 kbd_fetch_ptr
= event
+ 1;
4043 #ifdef HAVE_XWIDGETS
4044 else if (event
->kind
== XWIDGET_EVENT
)
4046 obj
= make_lispy_event (&event
->ie
);
4047 kbd_fetch_ptr
= event
+ 1;
4050 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4052 obj
= make_lispy_event (&event
->ie
);
4053 kbd_fetch_ptr
= event
+ 1;
4057 /* If this event is on a different frame, return a switch-frame this
4058 time, and leave the event in the queue for next time. */
4062 frame
= event
->ie
.frame_or_window
;
4064 frame
= XCAR (frame
);
4065 else if (WINDOWP (frame
))
4066 frame
= WINDOW_FRAME (XWINDOW (frame
));
4068 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4072 if (! EQ (frame
, internal_last_event_frame
)
4073 && !EQ (frame
, selected_frame
))
4074 obj
= make_lispy_switch_frame (frame
);
4075 internal_last_event_frame
= frame
;
4077 /* If we didn't decide to make a switch-frame event, go ahead
4078 and build a real event from the queue entry. */
4082 obj
= make_lispy_event (&event
->ie
);
4084 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4085 || defined (HAVE_NS) || defined (USE_GTK)
4086 /* If this was a menu selection, then set the flag to inhibit
4087 writing to last_nonmenu_event. Don't do this if the event
4088 we're returning is (menu-bar), though; that indicates the
4089 beginning of the menu sequence, and we might as well leave
4090 that as the `event with parameters' for this selection. */
4092 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4093 && (event
->kind
== MENU_BAR_EVENT
4094 || event
->kind
== TOOL_BAR_EVENT
))
4095 *used_mouse_menu
= true;
4098 /* Certain system events are non-key events. */
4100 && event
->kind
== NS_NONKEY_EVENT
)
4101 *used_mouse_menu
= true;
4104 /* Wipe out this event, to catch bugs. */
4105 clear_event (event
);
4106 kbd_fetch_ptr
= event
+ 1;
4110 /* Try generating a mouse motion event. */
4111 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4113 struct frame
*f
= some_mouse_moved ();
4114 Lisp_Object bar_window
;
4115 enum scroll_bar_part part
;
4119 *kbp
= current_kboard
;
4120 /* Note that this uses F to determine which terminal to look at.
4121 If there is no valid info, it does not store anything
4122 so x remains nil. */
4125 /* XXX Can f or mouse_position_hook be NULL here? */
4126 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4127 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4132 /* Decide if we should generate a switch-frame event. Don't
4133 generate switch-frame events for motion outside of all Emacs
4139 frame
= FRAME_FOCUS_FRAME (f
);
4141 XSETFRAME (frame
, f
);
4143 if (! EQ (frame
, internal_last_event_frame
)
4144 && !EQ (frame
, selected_frame
))
4145 obj
= make_lispy_switch_frame (frame
);
4146 internal_last_event_frame
= frame
;
4149 /* If we didn't decide to make a switch-frame event, go ahead and
4150 return a mouse-motion event. */
4151 if (!NILP (x
) && NILP (obj
))
4152 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4155 /* We were promised by the above while loop that there was
4156 something for us to read! */
4159 input_pending
= readable_events (0);
4161 Vlast_event_frame
= internal_last_event_frame
;
4166 /* Process any non-user-visible events (currently X selection events),
4167 without reading any user-visible events. */
4170 process_special_events (void)
4172 union buffered_input_event
*event
;
4174 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4176 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4179 if (event
== kbd_store_ptr
)
4183 /* If we find a stored X selection request, handle it now. */
4184 if (event
->kind
== SELECTION_REQUEST_EVENT
4185 || event
->kind
== SELECTION_CLEAR_EVENT
)
4189 /* Remove the event from the fifo buffer before processing;
4190 otherwise swallow_events called recursively could see it
4191 and process it again. To do this, we move the events
4192 between kbd_fetch_ptr and EVENT one slot to the right,
4195 struct selection_input_event copy
= event
->sie
;
4196 union buffered_input_event
*beg
4197 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4198 ? kbd_buffer
: kbd_fetch_ptr
;
4201 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4202 else if (event
< beg
)
4204 if (event
> kbd_buffer
)
4205 memmove (kbd_buffer
+ 1, kbd_buffer
,
4206 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4207 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4208 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4209 memmove (beg
+ 1, beg
,
4210 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4213 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4214 kbd_fetch_ptr
= kbd_buffer
+ 1;
4218 input_pending
= readable_events (0);
4219 x_handle_selection_event (©
);
4221 /* We're getting selection request events, but we don't have
4229 /* Process any events that are not user-visible, run timer events that
4230 are ripe, and return, without reading any user-visible events. */
4233 swallow_events (bool do_display
)
4235 unsigned old_timers_run
;
4237 process_special_events ();
4239 old_timers_run
= timers_run
;
4240 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4242 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4243 redisplay_preserve_echo_area (7);
4246 /* Record the start of when Emacs is idle,
4247 for the sake of running idle-time timers. */
4250 timer_start_idle (void)
4252 /* If we are already in the idle state, do nothing. */
4253 if (timespec_valid_p (timer_idleness_start_time
))
4256 timer_idleness_start_time
= current_timespec ();
4257 timer_last_idleness_start_time
= timer_idleness_start_time
;
4259 /* Mark all idle-time timers as once again candidates for running. */
4260 call0 (intern ("internal-timer-start-idle"));
4263 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4266 timer_stop_idle (void)
4268 timer_idleness_start_time
= invalid_timespec ();
4271 /* Resume idle timer from last idle start time. */
4274 timer_resume_idle (void)
4276 if (timespec_valid_p (timer_idleness_start_time
))
4279 timer_idleness_start_time
= timer_last_idleness_start_time
;
4282 /* List of elisp functions to call, delayed because they were generated in
4283 a context where Elisp could not be safely run (e.g. redisplay, signal,
4284 ...). Each element has the form (FUN . ARGS). */
4285 Lisp_Object pending_funcalls
;
4287 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4289 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4293 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4295 vec
= XVECTOR (timer
)->contents
;
4296 if (! NILP (vec
[0]))
4298 if (! INTEGERP (vec
[2]))
4302 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4304 *result
= lisp_to_timespec (t
);
4305 return timespec_valid_p (*result
);
4309 /* Check whether a timer has fired. To prevent larger problems we simply
4310 disregard elements that are not proper timers. Do not make a circular
4311 timer list for the time being.
4313 Returns the time to wait until the next timer fires. If a
4314 timer is triggering now, return zero.
4315 If no timer is active, return -1.
4317 If a timer is ripe, we run it, with quitting turned off.
4318 In that case we return 0 to indicate that a new timer_check_2 call
4321 static struct timespec
4322 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4324 struct timespec nexttime
;
4325 struct timespec now
;
4326 struct timespec idleness_now
;
4327 Lisp_Object chosen_timer
;
4329 nexttime
= invalid_timespec ();
4331 chosen_timer
= Qnil
;
4333 /* First run the code that was delayed. */
4334 while (CONSP (pending_funcalls
))
4336 Lisp_Object funcall
= XCAR (pending_funcalls
);
4337 pending_funcalls
= XCDR (pending_funcalls
);
4338 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4341 if (CONSP (timers
) || CONSP (idle_timers
))
4343 now
= current_timespec ();
4344 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4345 ? timespec_sub (now
, timer_idleness_start_time
)
4346 : make_timespec (0, 0));
4349 while (CONSP (timers
) || CONSP (idle_timers
))
4351 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4352 struct timespec timer_time
, idle_timer_time
;
4353 struct timespec difference
;
4354 struct timespec timer_difference
= invalid_timespec ();
4355 struct timespec idle_timer_difference
= invalid_timespec ();
4356 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4358 /* Set TIMER and TIMER_DIFFERENCE
4359 based on the next ordinary timer.
4360 TIMER_DIFFERENCE is the distance in time from NOW to when
4361 this timer becomes ripe.
4362 Skip past invalid timers and timers already handled. */
4365 timer
= XCAR (timers
);
4366 if (! decode_timer (timer
, &timer_time
))
4368 timers
= XCDR (timers
);
4372 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4373 timer_difference
= (timer_ripe
4374 ? timespec_sub (now
, timer_time
)
4375 : timespec_sub (timer_time
, now
));
4378 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4379 based on the next idle timer. */
4380 if (CONSP (idle_timers
))
4382 idle_timer
= XCAR (idle_timers
);
4383 if (! decode_timer (idle_timer
, &idle_timer_time
))
4385 idle_timers
= XCDR (idle_timers
);
4389 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4390 idle_timer_difference
4392 ? timespec_sub (idleness_now
, idle_timer_time
)
4393 : timespec_sub (idle_timer_time
, idleness_now
));
4396 /* Decide which timer is the next timer,
4397 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4398 Also step down the list where we found that timer. */
4400 if (timespec_valid_p (timer_difference
)
4401 && (! timespec_valid_p (idle_timer_difference
)
4402 || idle_timer_ripe
< timer_ripe
4403 || (idle_timer_ripe
== timer_ripe
4405 ? timespec_cmp (idle_timer_difference
,
4407 : timespec_cmp (timer_difference
,
4408 idle_timer_difference
))
4411 chosen_timer
= timer
;
4412 timers
= XCDR (timers
);
4413 difference
= timer_difference
;
4418 chosen_timer
= idle_timer
;
4419 idle_timers
= XCDR (idle_timers
);
4420 difference
= idle_timer_difference
;
4421 ripe
= idle_timer_ripe
;
4424 /* If timer is ripe, run it if it hasn't been run. */
4427 if (NILP (AREF (chosen_timer
, 0)))
4429 ptrdiff_t count
= SPECPDL_INDEX ();
4430 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4432 /* Mark the timer as triggered to prevent problems if the lisp
4433 code fails to reschedule it right. */
4434 ASET (chosen_timer
, 0, Qt
);
4436 specbind (Qinhibit_quit
, Qt
);
4438 call1 (Qtimer_event_handler
, chosen_timer
);
4439 Vdeactivate_mark
= old_deactivate_mark
;
4441 unbind_to (count
, Qnil
);
4443 /* Since we have handled the event,
4444 we don't need to tell the caller to wake up and do it. */
4445 /* But the caller must still wait for the next timer, so
4446 return 0 to indicate that. */
4449 nexttime
= make_timespec (0, 0);
4453 /* When we encounter a timer that is still waiting,
4454 return the amount of time to wait before it is ripe. */
4460 /* No timers are pending in the future. */
4461 /* Return 0 if we generated an event, and -1 if not. */
4466 /* Check whether a timer has fired. To prevent larger problems we simply
4467 disregard elements that are not proper timers. Do not make a circular
4468 timer list for the time being.
4470 Returns the time to wait until the next timer fires.
4471 If no timer is active, return an invalid value.
4473 As long as any timer is ripe, we run it. */
4478 struct timespec nexttime
;
4479 Lisp_Object timers
, idle_timers
;
4481 Lisp_Object tem
= Vinhibit_quit
;
4484 /* We use copies of the timers' lists to allow a timer to add itself
4485 again, without locking up Emacs if the newly added timer is
4486 already ripe when added. */
4488 /* Always consider the ordinary timers. */
4489 timers
= Fcopy_sequence (Vtimer_list
);
4490 /* Consider the idle timers only if Emacs is idle. */
4491 if (timespec_valid_p (timer_idleness_start_time
))
4492 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4496 Vinhibit_quit
= tem
;
4500 nexttime
= timer_check_2 (timers
, idle_timers
);
4502 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4507 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4508 doc
: /* Return the current length of Emacs idleness, or nil.
4509 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4510 in the same style as (current-time).
4512 The value when Emacs is not idle is nil.
4514 PSEC is a multiple of the system clock resolution. */)
4517 if (timespec_valid_p (timer_idleness_start_time
))
4518 return make_lisp_time (timespec_sub (current_timespec (),
4519 timer_idleness_start_time
));
4524 /* Caches for modify_event_symbol. */
4525 static Lisp_Object accent_key_syms
;
4526 static Lisp_Object func_key_syms
;
4527 static Lisp_Object mouse_syms
;
4528 static Lisp_Object wheel_syms
;
4529 static Lisp_Object drag_n_drop_syms
;
4531 /* This is a list of keysym codes for special "accent" characters.
4532 It parallels lispy_accent_keys. */
4534 static const int lispy_accent_codes
[] =
4536 #ifdef XK_dead_circumflex
4541 #ifdef XK_dead_grave
4546 #ifdef XK_dead_tilde
4551 #ifdef XK_dead_diaeresis
4556 #ifdef XK_dead_macron
4561 #ifdef XK_dead_degree
4566 #ifdef XK_dead_acute
4571 #ifdef XK_dead_cedilla
4576 #ifdef XK_dead_breve
4581 #ifdef XK_dead_ogonek
4586 #ifdef XK_dead_caron
4591 #ifdef XK_dead_doubleacute
4592 XK_dead_doubleacute
,
4596 #ifdef XK_dead_abovedot
4601 #ifdef XK_dead_abovering
4611 #ifdef XK_dead_belowdot
4616 #ifdef XK_dead_voiced_sound
4617 XK_dead_voiced_sound
,
4621 #ifdef XK_dead_semivoiced_sound
4622 XK_dead_semivoiced_sound
,
4638 /* This is a list of Lisp names for special "accent" characters.
4639 It parallels lispy_accent_codes. */
4641 static const char *const lispy_accent_keys
[] =
4659 "dead-voiced-sound",
4660 "dead-semivoiced-sound",
4666 #define FUNCTION_KEY_OFFSET 0x0
4668 const char *const lispy_function_keys
[] =
4672 0, /* VK_LBUTTON 0x01 */
4673 0, /* VK_RBUTTON 0x02 */
4674 "cancel", /* VK_CANCEL 0x03 */
4675 0, /* VK_MBUTTON 0x04 */
4677 0, 0, 0, /* 0x05 .. 0x07 */
4679 "backspace", /* VK_BACK 0x08 */
4680 "tab", /* VK_TAB 0x09 */
4682 0, 0, /* 0x0A .. 0x0B */
4684 "clear", /* VK_CLEAR 0x0C */
4685 "return", /* VK_RETURN 0x0D */
4687 0, 0, /* 0x0E .. 0x0F */
4689 0, /* VK_SHIFT 0x10 */
4690 0, /* VK_CONTROL 0x11 */
4691 0, /* VK_MENU 0x12 */
4692 "pause", /* VK_PAUSE 0x13 */
4693 "capslock", /* VK_CAPITAL 0x14 */
4694 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4696 "junja", /* VK_JUNJA 0x17 */
4697 "final", /* VK_FINAL 0x18 */
4698 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4700 "escape", /* VK_ESCAPE 0x1B */
4701 "convert", /* VK_CONVERT 0x1C */
4702 "non-convert", /* VK_NONCONVERT 0x1D */
4703 "accept", /* VK_ACCEPT 0x1E */
4704 "mode-change", /* VK_MODECHANGE 0x1F */
4705 0, /* VK_SPACE 0x20 */
4706 "prior", /* VK_PRIOR 0x21 */
4707 "next", /* VK_NEXT 0x22 */
4708 "end", /* VK_END 0x23 */
4709 "home", /* VK_HOME 0x24 */
4710 "left", /* VK_LEFT 0x25 */
4711 "up", /* VK_UP 0x26 */
4712 "right", /* VK_RIGHT 0x27 */
4713 "down", /* VK_DOWN 0x28 */
4714 "select", /* VK_SELECT 0x29 */
4715 "print", /* VK_PRINT 0x2A */
4716 "execute", /* VK_EXECUTE 0x2B */
4717 "snapshot", /* VK_SNAPSHOT 0x2C */
4718 "insert", /* VK_INSERT 0x2D */
4719 "delete", /* VK_DELETE 0x2E */
4720 "help", /* VK_HELP 0x2F */
4722 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4724 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4726 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4728 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4730 0, 0, 0, 0, 0, 0, 0, 0, 0,
4731 0, 0, 0, 0, 0, 0, 0, 0, 0,
4732 0, 0, 0, 0, 0, 0, 0, 0,
4734 "lwindow", /* VK_LWIN 0x5B */
4735 "rwindow", /* VK_RWIN 0x5C */
4736 "apps", /* VK_APPS 0x5D */
4739 "kp-0", /* VK_NUMPAD0 0x60 */
4740 "kp-1", /* VK_NUMPAD1 0x61 */
4741 "kp-2", /* VK_NUMPAD2 0x62 */
4742 "kp-3", /* VK_NUMPAD3 0x63 */
4743 "kp-4", /* VK_NUMPAD4 0x64 */
4744 "kp-5", /* VK_NUMPAD5 0x65 */
4745 "kp-6", /* VK_NUMPAD6 0x66 */
4746 "kp-7", /* VK_NUMPAD7 0x67 */
4747 "kp-8", /* VK_NUMPAD8 0x68 */
4748 "kp-9", /* VK_NUMPAD9 0x69 */
4749 "kp-multiply", /* VK_MULTIPLY 0x6A */
4750 "kp-add", /* VK_ADD 0x6B */
4751 "kp-separator", /* VK_SEPARATOR 0x6C */
4752 "kp-subtract", /* VK_SUBTRACT 0x6D */
4753 "kp-decimal", /* VK_DECIMAL 0x6E */
4754 "kp-divide", /* VK_DIVIDE 0x6F */
4755 "f1", /* VK_F1 0x70 */
4756 "f2", /* VK_F2 0x71 */
4757 "f3", /* VK_F3 0x72 */
4758 "f4", /* VK_F4 0x73 */
4759 "f5", /* VK_F5 0x74 */
4760 "f6", /* VK_F6 0x75 */
4761 "f7", /* VK_F7 0x76 */
4762 "f8", /* VK_F8 0x77 */
4763 "f9", /* VK_F9 0x78 */
4764 "f10", /* VK_F10 0x79 */
4765 "f11", /* VK_F11 0x7A */
4766 "f12", /* VK_F12 0x7B */
4767 "f13", /* VK_F13 0x7C */
4768 "f14", /* VK_F14 0x7D */
4769 "f15", /* VK_F15 0x7E */
4770 "f16", /* VK_F16 0x7F */
4771 "f17", /* VK_F17 0x80 */
4772 "f18", /* VK_F18 0x81 */
4773 "f19", /* VK_F19 0x82 */
4774 "f20", /* VK_F20 0x83 */
4775 "f21", /* VK_F21 0x84 */
4776 "f22", /* VK_F22 0x85 */
4777 "f23", /* VK_F23 0x86 */
4778 "f24", /* VK_F24 0x87 */
4780 0, 0, 0, 0, /* 0x88 .. 0x8B */
4781 0, 0, 0, 0, /* 0x8C .. 0x8F */
4783 "kp-numlock", /* VK_NUMLOCK 0x90 */
4784 "scroll", /* VK_SCROLL 0x91 */
4785 /* Not sure where the following block comes from.
4786 Windows headers have NEC and Fujitsu specific keys in
4787 this block, but nothing generic. */
4788 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4789 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4790 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4791 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4792 "kp-end", /* VK_NUMPAD_END 0x96 */
4793 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4794 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4795 "kp-up", /* VK_NUMPAD_UP 0x99 */
4796 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4797 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4798 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4799 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4801 0, 0, /* 0x9E .. 0x9F */
4804 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4805 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4806 * No other API or message will distinguish left and right keys this way.
4811 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4812 to enable them selectively, and gives access to a few more functions.
4813 See lispy_multimedia_keys below. */
4814 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4815 0, 0, 0, /* 0xAD .. 0xAF Volume */
4816 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4817 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4819 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4820 0, 0, 0, 0, 0, 0, 0, 0, 0,
4822 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4823 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4824 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4827 "ax", /* VK_OEM_AX 0xE1 */
4828 0, /* VK_OEM_102 0xE2 */
4829 "ico-help", /* VK_ICO_HELP 0xE3 */
4830 "ico-00", /* VK_ICO_00 0xE4 */
4831 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4832 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4833 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4835 "reset", /* VK_OEM_RESET 0xE9 */
4836 "jump", /* VK_OEM_JUMP 0xEA */
4837 "oem-pa1", /* VK_OEM_PA1 0xEB */
4838 "oem-pa2", /* VK_OEM_PA2 0xEC */
4839 "oem-pa3", /* VK_OEM_PA3 0xED */
4840 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4841 "cusel", /* VK_OEM_CUSEL 0xEF */
4842 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4843 "finish", /* VK_OEM_FINISH 0xF1 */
4844 "copy", /* VK_OEM_COPY 0xF2 */
4845 "auto", /* VK_OEM_AUTO 0xF3 */
4846 "enlw", /* VK_OEM_ENLW 0xF4 */
4847 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4848 "attn", /* VK_ATTN 0xF6 */
4849 "crsel", /* VK_CRSEL 0xF7 */
4850 "exsel", /* VK_EXSEL 0xF8 */
4851 "ereof", /* VK_EREOF 0xF9 */
4852 "play", /* VK_PLAY 0xFA */
4853 "zoom", /* VK_ZOOM 0xFB */
4854 "noname", /* VK_NONAME 0xFC */
4855 "pa1", /* VK_PA1 0xFD */
4856 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4860 /* Some of these duplicate the "Media keys" on newer keyboards,
4861 but they are delivered to the application in a different way. */
4862 static const char *const lispy_multimedia_keys
[] =
4870 "browser-favorites",
4907 "toggle-dictate-command",
4913 "media-fast-forward",
4916 "media-channel-down"
4919 #else /* not HAVE_NTGUI */
4921 /* This should be dealt with in XTread_socket now, and that doesn't
4922 depend on the client system having the Kana syms defined. See also
4923 the XK_kana_A case below. */
4926 static const char *const lispy_kana_keys
[] =
4928 /* X Keysym value */
4929 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4930 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4931 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4932 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4933 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4934 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4935 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4936 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4937 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4938 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4939 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4940 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4941 "kana-i", "kana-u", "kana-e", "kana-o",
4942 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4943 "prolongedsound", "kana-A", "kana-I", "kana-U",
4944 "kana-E", "kana-O", "kana-KA", "kana-KI",
4945 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4946 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4947 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4948 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4949 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4950 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4951 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4952 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4953 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4954 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4955 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4956 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4958 #endif /* XK_kana_A */
4961 #define FUNCTION_KEY_OFFSET 0xff00
4963 /* You'll notice that this table is arranged to be conveniently
4964 indexed by X Windows keysym values. */
4965 static const char *const lispy_function_keys
[] =
4967 /* X Keysym value */
4969 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4970 "backspace", "tab", "linefeed", "clear",
4972 0, 0, 0, "pause", /* 0xff10...1f */
4973 0, 0, 0, 0, 0, 0, 0, "escape",
4975 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4976 "romaji", "hiragana", "katakana", "hiragana-katakana",
4977 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4978 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4979 "eisu-toggle", /* 0xff30...3f */
4980 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4981 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4983 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4984 "down", "prior", "next", "end",
4985 "begin", 0, 0, 0, 0, 0, 0, 0,
4986 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4997 "break", /* 0xff6b */
5000 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5001 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5002 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5003 0, 0, 0, 0, 0, 0, 0, 0,
5004 "kp-tab", /* 0xff89 */
5006 "kp-enter", /* 0xff8d */
5008 "kp-f1", /* 0xff91 */
5012 "kp-home", /* 0xff95 */
5017 "kp-prior", /* kp-page-up */
5018 "kp-next", /* kp-page-down */
5024 0, 0, 0, 0, 0, 0, 0, 0, 0,
5025 "kp-multiply", /* 0xffaa */
5030 "kp-divide", /* 0xffaf */
5031 "kp-0", /* 0xffb0 */
5032 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5035 "kp-equal", /* 0xffbd */
5036 "f1", /* 0xffbe */ /* IsFunctionKey */
5038 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5039 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5040 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5041 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5042 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5043 0, 0, 0, 0, 0, 0, 0, 0,
5044 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5045 0, 0, 0, 0, 0, 0, 0, "delete"
5048 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5049 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5051 static const char *const iso_lispy_function_keys
[] =
5053 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5054 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5055 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5056 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5057 "iso-lefttab", /* 0xfe20 */
5058 "iso-move-line-up", "iso-move-line-down",
5059 "iso-partial-line-up", "iso-partial-line-down",
5060 "iso-partial-space-left", "iso-partial-space-right",
5061 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5062 "iso-release-margin-left", "iso-release-margin-right",
5063 "iso-release-both-margins",
5064 "iso-fast-cursor-left", "iso-fast-cursor-right",
5065 "iso-fast-cursor-up", "iso-fast-cursor-down",
5066 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5067 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5070 #endif /* not HAVE_NTGUI */
5072 static Lisp_Object Vlispy_mouse_stem
;
5074 static const char *const lispy_wheel_names
[] =
5076 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5079 /* drag-n-drop events are generated when a set of selected files are
5080 dragged from another application and dropped onto an Emacs window. */
5081 static const char *const lispy_drag_n_drop_names
[] =
5086 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5087 scroll_bar_part value. Note that Qnil corresponds to
5088 scroll_bar_nowhere and should not appear in Lisp events. */
5089 static short const scroll_bar_parts
[] = {
5090 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5091 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5092 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5093 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5094 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5095 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5096 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5099 /* A vector, indexed by button number, giving the down-going location
5100 of currently depressed buttons, both scroll bar and non-scroll bar.
5102 The elements have the form
5103 (BUTTON-NUMBER MODIFIER-MASK . REST)
5104 where REST is the cdr of a position as it would be reported in the event.
5106 The make_lispy_event function stores positions here to tell the
5107 difference between click and drag events, and to store the starting
5108 location to be included in drag events. */
5110 static Lisp_Object button_down_location
;
5112 /* Information about the most recent up-going button event: Which
5113 button, what location, and what time. */
5115 static int last_mouse_button
;
5116 static int last_mouse_x
;
5117 static int last_mouse_y
;
5118 static Time button_down_time
;
5120 /* The number of clicks in this multiple-click. */
5122 static int double_click_count
;
5124 /* X and Y are frame-relative coordinates for a click or wheel event.
5125 Return a Lisp-style event list. */
5128 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5131 enum window_part part
;
5132 Lisp_Object posn
= Qnil
;
5133 Lisp_Object extra_info
= Qnil
;
5134 /* Coordinate pixel positions to return. */
5135 int xret
= 0, yret
= 0;
5136 /* The window under frame pixel coordinates (x,y) */
5137 Lisp_Object window
= f
5138 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5141 if (WINDOWP (window
))
5143 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5144 struct window
*w
= XWINDOW (window
);
5145 Lisp_Object string_info
= Qnil
;
5146 ptrdiff_t textpos
= 0;
5147 int col
= -1, row
= -1;
5148 int dx
= -1, dy
= -1;
5149 int width
= -1, height
= -1;
5150 Lisp_Object object
= Qnil
;
5152 /* Pixel coordinates relative to the window corner. */
5153 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5154 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5156 /* For text area clicks, return X, Y relative to the corner of
5157 this text area. Note that dX, dY etc are set below, by
5158 buffer_posn_from_coords. */
5159 if (part
== ON_TEXT
)
5161 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5162 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5164 /* For mode line and header line clicks, return X, Y relative to
5165 the left window edge. Use mode_line_string to look for a
5166 string on the click position. */
5167 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5172 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5173 /* Note that mode_line_string takes COL, ROW as pixels and
5174 converts them to characters. */
5177 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5178 &object
, &dx
, &dy
, &width
, &height
);
5179 if (STRINGP (string
))
5180 string_info
= Fcons (string
, make_number (charpos
));
5186 /* For fringes and margins, Y is relative to the area's (and the
5187 window's) top edge, while X is meaningless. */
5188 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5193 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5196 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5197 &object
, &dx
, &dy
, &width
, &height
);
5198 if (STRINGP (string
))
5199 string_info
= Fcons (string
, make_number (charpos
));
5201 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5203 else if (part
== ON_LEFT_FRINGE
)
5205 posn
= Qleft_fringe
;
5209 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5210 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5211 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5213 else if (part
== ON_RIGHT_FRINGE
)
5215 posn
= Qright_fringe
;
5219 - window_box_width (w
, LEFT_MARGIN_AREA
)
5220 - window_box_width (w
, TEXT_AREA
)
5221 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5222 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5224 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5226 else if (part
== ON_VERTICAL_BORDER
)
5228 posn
= Qvertical_line
;
5234 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5236 posn
= Qvertical_scroll_bar
;
5237 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5241 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5243 posn
= Qhorizontal_scroll_bar
;
5244 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5248 else if (part
== ON_RIGHT_DIVIDER
)
5250 posn
= Qright_divider
;
5251 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5255 else if (part
== ON_BOTTOM_DIVIDER
)
5257 posn
= Qbottom_divider
;
5258 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5263 /* For clicks in the text area, fringes, margins, or vertical
5264 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5265 the buffer position nearest to the click. */
5268 Lisp_Object string2
, object2
= Qnil
;
5269 struct display_pos p
;
5271 int width2
, height2
;
5272 /* The pixel X coordinate passed to buffer_posn_from_coords
5273 is the X coordinate relative to the text area for clicks
5274 in text-area, right-margin/fringe and right-side vertical
5275 scroll bar, zero otherwise. */
5277 = (part
== ON_TEXT
) ? xret
5278 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5279 || (part
== ON_VERTICAL_SCROLL_BAR
5280 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5281 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5285 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5286 &object2
, &dx2
, &dy2
,
5288 textpos
= CHARPOS (p
.pos
);
5289 if (col
< 0) col
= x2
;
5290 if (row
< 0) row
= y2
;
5291 if (dx
< 0) dx
= dx2
;
5292 if (dy
< 0) dy
= dy2
;
5293 if (width
< 0) width
= width2
;
5294 if (height
< 0) height
= height2
;
5298 posn
= make_number (textpos
);
5299 if (STRINGP (string2
))
5300 string_info
= Fcons (string2
,
5301 make_number (CHARPOS (p
.string_pos
)));
5307 #ifdef HAVE_WINDOW_SYSTEM
5308 if (IMAGEP (object
))
5310 Lisp_Object image_map
, hotspot
;
5311 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5313 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5315 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5316 posn
= XCAR (hotspot
);
5323 Fcons (make_number (dx
), make_number (dy
)),
5324 Fcons (make_number (width
), make_number (height
)));
5327 extra_info
= Fcons (string_info
,
5328 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5329 Fcons (Fcons (make_number (col
),
5335 /* Return mouse pixel coordinates here. */
5336 XSETFRAME (window
, f
);
5343 return Fcons (window
,
5345 Fcons (Fcons (make_number (xret
),
5346 make_number (yret
)),
5347 Fcons (make_number (t
),
5351 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5352 menu bar. This really means that Emacs draws and manages the menu
5353 bar as part of its normal display, and therefore can compute its
5356 toolkit_menubar_in_use (struct frame
*f
)
5358 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5359 return !(!FRAME_WINDOW_P (f
));
5365 /* Build the part of Lisp event which represents scroll bar state from
5366 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5369 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5371 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5372 make_number (ev
->timestamp
),
5373 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5376 /* Given a struct input_event, build the lisp event which represents
5377 it. If EVENT is 0, build a mouse movement event from the mouse
5378 movement buffer, which should have a movement event in it.
5380 Note that events must be passed to this function in the order they
5381 are received; this function stores the location of button presses
5382 in order to build drag events when the button is released. */
5385 make_lispy_event (struct input_event
*event
)
5389 switch (event
->kind
)
5391 /* A simple keystroke. */
5392 case ASCII_KEYSTROKE_EVENT
:
5393 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5395 Lisp_Object lispy_c
;
5396 EMACS_INT c
= event
->code
;
5397 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5400 eassert (c
== event
->code
);
5401 /* Turn ASCII characters into control characters
5403 if (event
->modifiers
& ctrl_modifier
)
5405 c
= make_ctrl_char (c
);
5406 event
->modifiers
&= ~ctrl_modifier
;
5410 /* Add in the other modifier bits. The shift key was taken care
5411 of by the X code. */
5412 c
|= (event
->modifiers
5413 & (meta_modifier
| alt_modifier
5414 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5415 /* Distinguish Shift-SPC from SPC. */
5416 if ((event
->code
) == 040
5417 && event
->modifiers
& shift_modifier
)
5418 c
|= shift_modifier
;
5419 button_down_time
= 0;
5420 XSETFASTINT (lispy_c
, c
);
5425 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5426 except that they are non-key events (last-nonmenu-event is nil). */
5427 case NS_NONKEY_EVENT
:
5430 /* A function key. The symbol may need to have modifier prefixes
5432 case NON_ASCII_KEYSTROKE_EVENT
:
5433 button_down_time
= 0;
5435 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5436 if (event
->code
== lispy_accent_codes
[i
])
5437 return modify_event_symbol (i
,
5439 Qfunction_key
, Qnil
,
5440 lispy_accent_keys
, &accent_key_syms
,
5441 ARRAYELTS (lispy_accent_keys
));
5445 if (event
->code
>= 0x400 && event
->code
< 0x500)
5446 return modify_event_symbol (event
->code
- 0x400,
5447 event
->modifiers
& ~shift_modifier
,
5448 Qfunction_key
, Qnil
,
5449 lispy_kana_keys
, &func_key_syms
,
5450 ARRAYELTS (lispy_kana_keys
));
5451 #endif /* XK_kana_A */
5454 #ifdef ISO_FUNCTION_KEY_OFFSET
5455 if (event
->code
< FUNCTION_KEY_OFFSET
5456 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5457 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5459 Qfunction_key
, Qnil
,
5460 iso_lispy_function_keys
, &func_key_syms
,
5461 ARRAYELTS (iso_lispy_function_keys
));
5464 if ((FUNCTION_KEY_OFFSET
<= event
->code
5466 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5467 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5468 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5470 Qfunction_key
, Qnil
,
5471 lispy_function_keys
, &func_key_syms
,
5472 ARRAYELTS (lispy_function_keys
));
5474 /* Handle system-specific or unknown keysyms.
5475 We need to use an alist rather than a vector as the cache
5476 since we can't make a vector long enough. */
5477 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5478 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5479 return modify_event_symbol (event
->code
,
5482 KVAR (current_kboard
, Vsystem_key_alist
),
5483 0, &KVAR (current_kboard
, system_key_syms
),
5487 case MULTIMEDIA_KEY_EVENT
:
5488 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5489 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5491 return modify_event_symbol (event
->code
, event
->modifiers
,
5492 Qfunction_key
, Qnil
,
5493 lispy_multimedia_keys
, &func_key_syms
,
5494 ARRAYELTS (lispy_multimedia_keys
));
5499 /* A mouse click. Figure out where it is, decide whether it's
5500 a press, click or drag, and build the appropriate structure. */
5501 case MOUSE_CLICK_EVENT
:
5503 case GPM_CLICK_EVENT
:
5505 #ifndef USE_TOOLKIT_SCROLL_BARS
5506 case SCROLL_BAR_CLICK_EVENT
:
5507 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5510 int button
= event
->code
;
5512 Lisp_Object position
;
5513 Lisp_Object
*start_pos_ptr
;
5514 Lisp_Object start_pos
;
5518 /* Build the position as appropriate for this mouse click. */
5519 if (event
->kind
== MOUSE_CLICK_EVENT
5521 || event
->kind
== GPM_CLICK_EVENT
5525 struct frame
*f
= XFRAME (event
->frame_or_window
);
5528 /* Ignore mouse events that were made on frame that
5529 have been deleted. */
5530 if (! FRAME_LIVE_P (f
))
5533 /* EVENT->x and EVENT->y are frame-relative pixel
5534 coordinates at this place. Under old redisplay, COLUMN
5535 and ROW are set to frame relative glyph coordinates
5536 which are then used to determine whether this click is
5537 in a menu (non-toolkit version). */
5538 if (!toolkit_menubar_in_use (f
))
5540 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5541 &column
, &row
, NULL
, 1);
5543 /* In the non-toolkit version, clicks on the menu bar
5544 are ordinary button events in the event buffer.
5545 Distinguish them, and invoke the menu.
5547 (In the toolkit version, the toolkit handles the
5548 menu bar and Emacs doesn't know about it until
5549 after the user makes a selection.) */
5550 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5551 && (event
->modifiers
& down_modifier
))
5553 Lisp_Object items
, item
;
5555 /* Find the menu bar item under `column'. */
5557 items
= FRAME_MENU_BAR_ITEMS (f
);
5558 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5560 Lisp_Object pos
, string
;
5561 string
= AREF (items
, i
+ 1);
5562 pos
= AREF (items
, i
+ 3);
5565 if (column
>= XINT (pos
)
5566 && column
< XINT (pos
) + SCHARS (string
))
5568 item
= AREF (items
, i
);
5573 /* ELisp manual 2.4b says (x y) are window
5574 relative but code says they are
5576 position
= list4 (event
->frame_or_window
,
5578 Fcons (event
->x
, event
->y
),
5579 make_number (event
->timestamp
));
5581 return list2 (item
, position
);
5585 position
= make_lispy_position (f
, event
->x
, event
->y
,
5588 #ifndef USE_TOOLKIT_SCROLL_BARS
5590 /* It's a scrollbar click. */
5591 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5592 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5594 if (button
>= ASIZE (button_down_location
))
5596 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5597 button_down_location
= larger_vector (button_down_location
,
5599 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5602 start_pos_ptr
= aref_addr (button_down_location
, button
);
5603 start_pos
= *start_pos_ptr
;
5604 *start_pos_ptr
= Qnil
;
5607 /* On window-system frames, use the value of
5608 double-click-fuzz as is. On other frames, interpret it
5609 as a multiple of 1/8 characters. */
5613 if (WINDOWP (event
->frame_or_window
))
5614 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5615 else if (FRAMEP (event
->frame_or_window
))
5616 f
= XFRAME (event
->frame_or_window
);
5620 if (FRAME_WINDOW_P (f
))
5621 fuzz
= double_click_fuzz
;
5623 fuzz
= double_click_fuzz
/ 8;
5625 is_double
= (button
== last_mouse_button
5626 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5627 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5628 && button_down_time
!= 0
5629 && (EQ (Vdouble_click_time
, Qt
)
5630 || (NATNUMP (Vdouble_click_time
)
5631 && (event
->timestamp
- button_down_time
5632 < XFASTINT (Vdouble_click_time
)))));
5635 last_mouse_button
= button
;
5636 last_mouse_x
= XINT (event
->x
);
5637 last_mouse_y
= XINT (event
->y
);
5639 /* If this is a button press, squirrel away the location, so
5640 we can decide later whether it was a click or a drag. */
5641 if (event
->modifiers
& down_modifier
)
5645 double_click_count
++;
5646 event
->modifiers
|= ((double_click_count
> 2)
5651 double_click_count
= 1;
5652 button_down_time
= event
->timestamp
;
5653 *start_pos_ptr
= Fcopy_alist (position
);
5654 ignore_mouse_drag_p
= 0;
5657 /* Now we're releasing a button - check the co-ordinates to
5658 see if this was a click or a drag. */
5659 else if (event
->modifiers
& up_modifier
)
5661 /* If we did not see a down before this up, ignore the up.
5662 Probably this happened because the down event chose a
5663 menu item. It would be an annoyance to treat the
5664 release of the button that chose the menu item as a
5667 if (!CONSP (start_pos
))
5670 event
->modifiers
&= ~up_modifier
;
5673 Lisp_Object new_down
, down
;
5674 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5676 /* The third element of every position
5677 should be the (x,y) pair. */
5678 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5679 new_down
= Fcar (Fcdr (Fcdr (position
)));
5682 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5684 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5685 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5688 if (ignore_mouse_drag_p
)
5690 event
->modifiers
|= click_modifier
;
5691 ignore_mouse_drag_p
= 0;
5693 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5694 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5695 /* Maybe the mouse has moved a lot, caused scrolling, and
5696 eventually ended up at the same screen position (but
5697 not buffer position) in which case it is a drag, not
5699 /* FIXME: OTOH if the buffer position has changed
5700 because of a timer or process filter rather than
5701 because of mouse movement, it should be considered as
5702 a click. But mouse-drag-region completely ignores
5703 this case and it hasn't caused any real problem, so
5704 it's probably OK to ignore it as well. */
5705 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5706 /* Mouse hasn't moved (much). */
5707 event
->modifiers
|= click_modifier
;
5710 button_down_time
= 0;
5711 event
->modifiers
|= drag_modifier
;
5714 /* Don't check is_double; treat this as multiple
5715 if the down-event was multiple. */
5716 if (double_click_count
> 1)
5717 event
->modifiers
|= ((double_click_count
> 2)
5723 /* Every mouse event should either have the down_modifier or
5724 the up_modifier set. */
5728 /* Get the symbol we should use for the mouse click. */
5731 head
= modify_event_symbol (button
,
5733 Qmouse_click
, Vlispy_mouse_stem
,
5736 ASIZE (mouse_syms
));
5737 if (event
->modifiers
& drag_modifier
)
5738 return list3 (head
, start_pos
, position
);
5739 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5740 return list3 (head
, position
, make_number (double_click_count
));
5742 return list2 (head
, position
);
5747 case HORIZ_WHEEL_EVENT
:
5749 Lisp_Object position
;
5752 /* Build the position as appropriate for this mouse click. */
5753 struct frame
*f
= XFRAME (event
->frame_or_window
);
5755 /* Ignore wheel events that were made on frame that have been
5757 if (! FRAME_LIVE_P (f
))
5760 position
= make_lispy_position (f
, event
->x
, event
->y
,
5763 /* Set double or triple modifiers to indicate the wheel speed. */
5765 /* On window-system frames, use the value of
5766 double-click-fuzz as is. On other frames, interpret it
5767 as a multiple of 1/8 characters. */
5773 if (WINDOWP (event
->frame_or_window
))
5774 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5775 else if (FRAMEP (event
->frame_or_window
))
5776 fr
= XFRAME (event
->frame_or_window
);
5780 fuzz
= FRAME_WINDOW_P (fr
)
5781 ? double_click_fuzz
: double_click_fuzz
/ 8;
5783 if (event
->modifiers
& up_modifier
)
5785 /* Emit a wheel-up event. */
5786 event
->modifiers
&= ~up_modifier
;
5789 else if (event
->modifiers
& down_modifier
)
5791 /* Emit a wheel-down event. */
5792 event
->modifiers
&= ~down_modifier
;
5796 /* Every wheel event should either have the down_modifier or
5797 the up_modifier set. */
5800 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5803 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5804 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5805 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5806 && button_down_time
!= 0
5807 && (EQ (Vdouble_click_time
, Qt
)
5808 || (NATNUMP (Vdouble_click_time
)
5809 && (event
->timestamp
- button_down_time
5810 < XFASTINT (Vdouble_click_time
)))));
5813 double_click_count
++;
5814 event
->modifiers
|= ((double_click_count
> 2)
5820 double_click_count
= 1;
5821 event
->modifiers
|= click_modifier
;
5824 button_down_time
= event
->timestamp
;
5825 /* Use a negative value to distinguish wheel from mouse button. */
5826 last_mouse_button
= - (1 + symbol_num
);
5827 last_mouse_x
= XINT (event
->x
);
5828 last_mouse_y
= XINT (event
->y
);
5830 /* Get the symbol we should use for the wheel event. */
5831 head
= modify_event_symbol (symbol_num
,
5837 ASIZE (wheel_syms
));
5840 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5841 return list3 (head
, position
, make_number (double_click_count
));
5843 return list2 (head
, position
);
5847 #ifdef USE_TOOLKIT_SCROLL_BARS
5849 /* We don't have down and up events if using toolkit scroll bars,
5850 so make this always a click event. Store in the `part' of
5851 the Lisp event a symbol which maps to the following actions:
5853 `above_handle' page up
5854 `below_handle' page down
5858 `bottom' bottom of buffer
5859 `handle' thumb has been dragged.
5860 `end-scroll' end of interaction with scroll bar
5862 The incoming input_event contains in its `part' member an
5863 index of type `enum scroll_bar_part' which we can use as an
5864 index in scroll_bar_parts to get the appropriate symbol. */
5866 case SCROLL_BAR_CLICK_EVENT
:
5868 Lisp_Object position
, head
;
5870 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5872 /* Always treat scroll bar events as clicks. */
5873 event
->modifiers
|= click_modifier
;
5874 event
->modifiers
&= ~up_modifier
;
5876 if (event
->code
>= ASIZE (mouse_syms
))
5877 mouse_syms
= larger_vector (mouse_syms
,
5878 event
->code
- ASIZE (mouse_syms
) + 1,
5881 /* Get the symbol we should use for the mouse click. */
5882 head
= modify_event_symbol (event
->code
,
5887 ASIZE (mouse_syms
));
5888 return list2 (head
, position
);
5891 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5893 Lisp_Object position
, head
;
5895 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5897 /* Always treat scroll bar events as clicks. */
5898 event
->modifiers
|= click_modifier
;
5899 event
->modifiers
&= ~up_modifier
;
5901 if (event
->code
>= ASIZE (mouse_syms
))
5902 mouse_syms
= larger_vector (mouse_syms
,
5903 event
->code
- ASIZE (mouse_syms
) + 1,
5906 /* Get the symbol we should use for the mouse click. */
5907 head
= modify_event_symbol (event
->code
,
5912 ASIZE (mouse_syms
));
5913 return list2 (head
, position
);
5916 #endif /* USE_TOOLKIT_SCROLL_BARS */
5918 case DRAG_N_DROP_EVENT
:
5921 Lisp_Object head
, position
;
5924 f
= XFRAME (event
->frame_or_window
);
5927 /* Ignore mouse events that were made on frames that
5928 have been deleted. */
5929 if (! FRAME_LIVE_P (f
))
5932 position
= make_lispy_position (f
, event
->x
, event
->y
,
5935 head
= modify_event_symbol (0, event
->modifiers
,
5937 lispy_drag_n_drop_names
,
5938 &drag_n_drop_syms
, 1);
5939 return list3 (head
, position
, files
);
5942 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5943 || defined (HAVE_NS) || defined (USE_GTK)
5944 case MENU_BAR_EVENT
:
5945 if (EQ (event
->arg
, event
->frame_or_window
))
5946 /* This is the prefix key. We translate this to
5947 `(menu_bar)' because the code in keyboard.c for menu
5948 events, which we use, relies on this. */
5949 return list1 (Qmenu_bar
);
5953 case SELECT_WINDOW_EVENT
:
5954 /* Make an event (select-window (WINDOW)). */
5955 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5957 case TOOL_BAR_EVENT
:
5958 if (EQ (event
->arg
, event
->frame_or_window
))
5959 /* This is the prefix key. We translate this to
5960 `(tool_bar)' because the code in keyboard.c for tool bar
5961 events, which we use, relies on this. */
5962 return list1 (Qtool_bar
);
5963 else if (SYMBOLP (event
->arg
))
5964 return apply_modifiers (event
->modifiers
, event
->arg
);
5967 case USER_SIGNAL_EVENT
:
5968 /* A user signal. */
5970 char *name
= find_user_signal_name (event
->code
);
5973 return intern (name
);
5976 case SAVE_SESSION_EVENT
:
5977 return Qsave_session
;
5982 return Fcons (Qdbus_event
, event
->arg
);
5984 #endif /* HAVE_DBUS */
5986 #ifdef HAVE_XWIDGETS
5989 return Fcons (Qxwidget_event
, event
->arg
);
5993 #if defined HAVE_INOTIFY || defined HAVE_KQUEUE || defined HAVE_GFILENOTIFY
5994 case FILE_NOTIFY_EVENT
:
5996 return Fcons (Qfile_notify
, event
->arg
);
5998 #endif /* HAVE_INOTIFY || HAVE_KQUEUE || HAVE_GFILENOTIFY */
6000 case CONFIG_CHANGED_EVENT
:
6001 return list3 (Qconfig_changed_event
,
6002 event
->arg
, event
->frame_or_window
);
6004 /* The 'kind' field of the event is something we don't recognize. */
6011 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6012 Lisp_Object x
, Lisp_Object y
, Time t
)
6014 /* Is it a scroll bar movement? */
6015 if (frame
&& ! NILP (bar_window
))
6017 Lisp_Object part_sym
;
6019 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6020 return list2 (Qscroll_bar_movement
,
6022 Qvertical_scroll_bar
,
6027 /* Or is it an ordinary mouse movement? */
6030 Lisp_Object position
;
6031 position
= make_lispy_position (frame
, x
, y
, t
);
6032 return list2 (Qmouse_movement
, position
);
6036 /* Construct a switch frame event. */
6038 make_lispy_switch_frame (Lisp_Object frame
)
6040 return list2 (Qswitch_frame
, frame
);
6044 make_lispy_focus_in (Lisp_Object frame
)
6046 return list2 (Qfocus_in
, frame
);
6049 #ifdef HAVE_WINDOW_SYSTEM
6052 make_lispy_focus_out (Lisp_Object frame
)
6054 return list2 (Qfocus_out
, frame
);
6057 #endif /* HAVE_WINDOW_SYSTEM */
6059 /* Manipulating modifiers. */
6061 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6063 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6064 SYMBOL's name of the end of the modifiers; the string from this
6065 position is the unmodified symbol name.
6067 This doesn't use any caches. */
6070 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6076 CHECK_SYMBOL (symbol
);
6079 name
= SYMBOL_NAME (symbol
);
6081 for (i
= 0; i
< SBYTES (name
) - 1; )
6083 ptrdiff_t this_mod_end
= 0;
6086 /* See if the name continues with a modifier word.
6087 Check that the word appears, but don't check what follows it.
6088 Set this_mod and this_mod_end to record what we find. */
6090 switch (SREF (name
, i
))
6092 #define SINGLE_LETTER_MOD(BIT) \
6093 (this_mod_end = i + 1, this_mod = BIT)
6096 SINGLE_LETTER_MOD (alt_modifier
);
6100 SINGLE_LETTER_MOD (ctrl_modifier
);
6104 SINGLE_LETTER_MOD (hyper_modifier
);
6108 SINGLE_LETTER_MOD (meta_modifier
);
6112 SINGLE_LETTER_MOD (shift_modifier
);
6116 SINGLE_LETTER_MOD (super_modifier
);
6119 #undef SINGLE_LETTER_MOD
6121 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6122 if (i + LEN + 1 <= SBYTES (name) \
6123 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6125 this_mod_end = i + LEN; \
6130 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6131 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6132 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6136 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6140 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6142 #undef MULTI_LETTER_MOD
6146 /* If we found no modifier, stop looking for them. */
6147 if (this_mod_end
== 0)
6150 /* Check there is a dash after the modifier, so that it
6151 really is a modifier. */
6152 if (this_mod_end
>= SBYTES (name
)
6153 || SREF (name
, this_mod_end
) != '-')
6156 /* This modifier is real; look for another. */
6157 modifiers
|= this_mod
;
6158 i
= this_mod_end
+ 1;
6161 /* Should we include the `click' modifier? */
6162 if (! (modifiers
& (down_modifier
| drag_modifier
6163 | double_modifier
| triple_modifier
))
6164 && i
+ 7 == SBYTES (name
)
6165 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6166 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6167 modifiers
|= click_modifier
;
6169 if (! (modifiers
& (double_modifier
| triple_modifier
))
6170 && i
+ 6 < SBYTES (name
)
6171 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6172 modifiers
|= click_modifier
;
6180 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6181 prepended to the string BASE[0..BASE_LEN-1].
6182 This doesn't use any caches. */
6184 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6186 /* Since BASE could contain nulls, we can't use intern here; we have
6187 to use Fintern, which expects a genuine Lisp_String, and keeps a
6189 char new_mods
[sizeof "A-C-H-M-S-s-up-down-drag-double-triple-"];
6195 /* Mouse events should not exhibit the `up' modifier once they
6196 leave the event queue only accessible to C code; `up' will
6197 always be turned into a click or drag event before being
6198 presented to lisp code. But since lisp events can be
6199 synthesized bypassing the event queue and pushed into
6200 `unread-command-events' or its companions, it's better to just
6201 deal with unexpected modifier combinations. */
6203 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6204 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6205 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6206 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6207 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6208 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6209 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6210 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6211 if (modifiers
& up_modifier
) p
= stpcpy (p
, "up-");
6212 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6213 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6214 /* The click modifier is denoted by the absence of other modifiers. */
6218 mod_len
= p
- new_mods
;
6222 Lisp_Object new_name
;
6224 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6225 mod_len
+ base_len_byte
);
6226 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6227 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6229 return Fintern (new_name
, Qnil
);
6234 static const char *const modifier_names
[] =
6236 "up", "down", "drag", "click", "double", "triple", 0, 0,
6237 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6238 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6240 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6242 static Lisp_Object modifier_symbols
;
6244 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6246 lispy_modifier_list (int modifiers
)
6248 Lisp_Object modifier_list
;
6251 modifier_list
= Qnil
;
6252 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6253 if (modifiers
& (1<<i
))
6254 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6257 return modifier_list
;
6261 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6262 where UNMODIFIED is the unmodified form of SYMBOL,
6263 MASK is the set of modifiers present in SYMBOL's name.
6264 This is similar to parse_modifiers_uncached, but uses the cache in
6265 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6266 Qevent_symbol_elements property. */
6268 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6271 parse_modifiers (Lisp_Object symbol
)
6273 Lisp_Object elements
;
6275 if (INTEGERP (symbol
))
6276 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6277 else if (!SYMBOLP (symbol
))
6280 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6281 if (CONSP (elements
))
6286 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6287 Lisp_Object unmodified
;
6290 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6291 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6294 if (modifiers
& ~INTMASK
)
6296 XSETFASTINT (mask
, modifiers
);
6297 elements
= list2 (unmodified
, mask
);
6299 /* Cache the parsing results on SYMBOL. */
6300 Fput (symbol
, Qevent_symbol_element_mask
,
6302 Fput (symbol
, Qevent_symbol_elements
,
6303 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6305 /* Since we know that SYMBOL is modifiers applied to unmodified,
6306 it would be nice to put that in unmodified's cache.
6307 But we can't, since we're not sure that parse_modifiers is
6314 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6315 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6316 doc
: /* Parse the event symbol. For internal use. */)
6317 (Lisp_Object symbol
)
6319 /* Fill the cache if needed. */
6320 parse_modifiers (symbol
);
6321 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6322 and use the Lispier representation stored on Qevent_symbol_elements
6324 return Fget (symbol
, Qevent_symbol_elements
);
6327 /* Apply the modifiers MODIFIERS to the symbol BASE.
6328 BASE must be unmodified.
6330 This is like apply_modifiers_uncached, but uses BASE's
6331 Qmodifier_cache property, if present.
6333 apply_modifiers copies the value of BASE's Qevent_kind property to
6334 the modified symbol. */
6336 apply_modifiers (int modifiers
, Lisp_Object base
)
6338 Lisp_Object cache
, idx
, entry
, new_symbol
;
6340 /* Mask out upper bits. We don't know where this value's been. */
6341 modifiers
&= INTMASK
;
6343 if (INTEGERP (base
))
6344 return make_number (XINT (base
) | modifiers
);
6346 /* The click modifier never figures into cache indices. */
6347 cache
= Fget (base
, Qmodifier_cache
);
6348 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6349 entry
= assq_no_quit (idx
, cache
);
6352 new_symbol
= XCDR (entry
);
6355 /* We have to create the symbol ourselves. */
6356 new_symbol
= apply_modifiers_uncached (modifiers
,
6357 SSDATA (SYMBOL_NAME (base
)),
6358 SCHARS (SYMBOL_NAME (base
)),
6359 SBYTES (SYMBOL_NAME (base
)));
6361 /* Add the new symbol to the base's cache. */
6362 entry
= Fcons (idx
, new_symbol
);
6363 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6365 /* We have the parsing info now for free, so we could add it to
6367 XSETFASTINT (idx, modifiers);
6368 Fput (new_symbol, Qevent_symbol_element_mask,
6370 Fput (new_symbol, Qevent_symbol_elements,
6371 Fcons (base, lispy_modifier_list (modifiers)));
6372 Sadly, this is only correct if `base' is indeed a base event,
6373 which is not necessarily the case. -stef */
6376 /* Make sure this symbol is of the same kind as BASE.
6378 You'd think we could just set this once and for all when we
6379 intern the symbol above, but reorder_modifiers may call us when
6380 BASE's property isn't set right; we can't assume that just
6381 because it has a Qmodifier_cache property it must have its
6382 Qevent_kind set right as well. */
6383 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6387 kind
= Fget (base
, Qevent_kind
);
6389 Fput (new_symbol
, Qevent_kind
, kind
);
6396 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6397 return a symbol with the modifiers placed in the canonical order.
6398 Canonical order is alphabetical, except for down and drag, which
6399 always come last. The 'click' modifier is never written out.
6401 Fdefine_key calls this to make sure that (for example) C-M-foo
6402 and M-C-foo end up being equivalent in the keymap. */
6405 reorder_modifiers (Lisp_Object symbol
)
6407 /* It's hopefully okay to write the code this way, since everything
6408 will soon be in caches, and no consing will be done at all. */
6411 parsed
= parse_modifiers (symbol
);
6412 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6417 /* For handling events, we often want to produce a symbol whose name
6418 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6419 to some base, like the name of a function key or mouse button.
6420 modify_event_symbol produces symbols of this sort.
6422 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6423 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6426 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6427 into symbol names, or a string specifying a name stem used to
6428 construct a symbol name or the form `STEM-N', where N is the decimal
6429 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6430 non-nil; otherwise NAME_TABLE is used.
6432 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6433 persist between calls to modify_event_symbol that it can use to
6434 store a cache of the symbols it's generated for this NAME_TABLE
6435 before. The object stored there may be a vector or an alist.
6437 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6439 MODIFIERS is a set of modifier bits (as given in struct input_events)
6440 whose prefixes should be applied to the symbol name.
6442 SYMBOL_KIND is the value to be placed in the event_kind property of
6443 the returned symbol.
6445 The symbols we create are supposed to have an
6446 `event-symbol-elements' property, which lists the modifiers present
6447 in the symbol's name. */
6450 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6451 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6452 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6455 Lisp_Object symbol_int
;
6457 /* Get rid of the "vendor-specific" bit here. */
6458 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6460 /* Is this a request for a valid symbol? */
6461 if (symbol_num
< 0 || symbol_num
>= table_size
)
6464 if (CONSP (*symbol_table
))
6465 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6467 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6468 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6469 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6470 we've never used that symbol before. */
6473 if (! VECTORP (*symbol_table
)
6474 || ASIZE (*symbol_table
) != table_size
)
6478 XSETFASTINT (size
, table_size
);
6479 *symbol_table
= Fmake_vector (size
, Qnil
);
6482 value
= AREF (*symbol_table
, symbol_num
);
6485 /* Have we already used this symbol before? */
6488 /* No; let's create it. */
6489 if (CONSP (name_alist_or_stem
))
6490 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6491 else if (STRINGP (name_alist_or_stem
))
6494 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6495 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6497 buf
= SAFE_ALLOCA (len
);
6498 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6499 XINT (symbol_int
) + 1);
6500 value
= intern (buf
);
6503 else if (name_table
!= 0 && name_table
[symbol_num
])
6504 value
= intern (name_table
[symbol_num
]);
6506 #ifdef HAVE_WINDOW_SYSTEM
6509 char *name
= x_get_keysym_name (symbol_num
);
6511 value
= intern (name
);
6517 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6518 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6519 value
= intern (buf
);
6522 if (CONSP (*symbol_table
))
6523 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6525 ASET (*symbol_table
, symbol_num
, value
);
6527 /* Fill in the cache entries for this symbol; this also
6528 builds the Qevent_symbol_elements property, which the user
6530 apply_modifiers (modifiers
& click_modifier
, value
);
6531 Fput (value
, Qevent_kind
, symbol_kind
);
6534 /* Apply modifiers to that symbol. */
6535 return apply_modifiers (modifiers
, value
);
6538 /* Convert a list that represents an event type,
6539 such as (ctrl meta backspace), into the usual representation of that
6540 event type as a number or a symbol. */
6542 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6543 doc
: /* Convert the event description list EVENT-DESC to an event type.
6544 EVENT-DESC should contain one base event type (a character or symbol)
6545 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6546 drag, down, double or triple). The base must be last.
6547 The return value is an event type (a character or symbol) which
6548 has the same base event type and all the specified modifiers. */)
6549 (Lisp_Object event_desc
)
6557 while (CONSP (rest
))
6565 /* Given a symbol, see if it is a modifier name. */
6566 if (SYMBOLP (elt
) && CONSP (rest
))
6567 this = parse_solitary_modifier (elt
);
6571 else if (!NILP (base
))
6572 error ("Two bases given in one event");
6578 /* Let the symbol A refer to the character A. */
6579 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6580 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6582 if (INTEGERP (base
))
6584 /* Turn (shift a) into A. */
6585 if ((modifiers
& shift_modifier
) != 0
6586 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6588 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6589 modifiers
&= ~shift_modifier
;
6592 /* Turn (control a) into C-a. */
6593 if (modifiers
& ctrl_modifier
)
6594 return make_number ((modifiers
& ~ctrl_modifier
)
6595 | make_ctrl_char (XINT (base
)));
6597 return make_number (modifiers
| XINT (base
));
6599 else if (SYMBOLP (base
))
6600 return apply_modifiers (modifiers
, base
);
6602 error ("Invalid base event");
6605 /* Try to recognize SYMBOL as a modifier name.
6606 Return the modifier flag bit, or 0 if not recognized. */
6609 parse_solitary_modifier (Lisp_Object symbol
)
6611 Lisp_Object name
= SYMBOL_NAME (symbol
);
6613 switch (SREF (name
, 0))
6615 #define SINGLE_LETTER_MOD(BIT) \
6616 if (SBYTES (name) == 1) \
6619 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6620 if (LEN == SBYTES (name) \
6621 && ! memcmp (SDATA (name), NAME, LEN)) \
6625 SINGLE_LETTER_MOD (alt_modifier
);
6629 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6633 SINGLE_LETTER_MOD (ctrl_modifier
);
6637 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6638 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6642 SINGLE_LETTER_MOD (hyper_modifier
);
6646 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6650 SINGLE_LETTER_MOD (meta_modifier
);
6654 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6658 SINGLE_LETTER_MOD (shift_modifier
);
6662 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6663 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6664 SINGLE_LETTER_MOD (super_modifier
);
6668 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6669 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6670 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6674 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6678 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6681 #undef SINGLE_LETTER_MOD
6682 #undef MULTI_LETTER_MOD
6688 /* Return true if EVENT is a list whose elements are all integers or symbols.
6689 Such a list is not valid as an event,
6690 but it can be a Lucid-style event type list. */
6693 lucid_event_type_list_p (Lisp_Object object
)
6697 if (! CONSP (object
))
6700 if (EQ (XCAR (object
), Qhelp_echo
)
6701 || EQ (XCAR (object
), Qvertical_line
)
6702 || EQ (XCAR (object
), Qmode_line
)
6703 || EQ (XCAR (object
), Qheader_line
))
6706 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6710 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6717 /* Return true if terminal input chars are available.
6718 Also, store the return value into INPUT_PENDING.
6720 Serves the purpose of ioctl (0, FIONREAD, ...)
6721 but works even if FIONREAD does not exist.
6722 (In fact, this may actually read some input.)
6724 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6725 timer events that are ripe.
6726 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6727 events (FOCUS_IN_EVENT).
6728 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6729 movements and toolkit scroll bar thumb drags. */
6732 get_input_pending (int flags
)
6734 /* First of all, have we already counted some input? */
6735 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6737 /* If input is being read as it arrives, and we have none, there is none. */
6738 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6740 /* Try to read some input and see how much we get. */
6742 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6745 return input_pending
;
6748 /* Put a BUFFER_SWITCH_EVENT in the buffer
6749 so that read_key_sequence will notice the new current buffer. */
6752 record_asynch_buffer_change (void)
6754 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6755 The purpose of the event is to make read_key_sequence look up the
6756 keymaps again. If we aren't in read_key_sequence, we don't need one,
6757 and the event could cause trouble by messing up (input-pending-p).
6758 Note: Fwaiting_for_user_input_p always returns nil when async
6759 subprocesses aren't supported. */
6760 if (!NILP (Fwaiting_for_user_input_p ()))
6762 struct input_event event
;
6765 event
.kind
= BUFFER_SWITCH_EVENT
;
6766 event
.frame_or_window
= Qnil
;
6769 /* Make sure no interrupt happens while storing the event. */
6771 if (interrupt_input
)
6772 kbd_buffer_store_event (&event
);
6777 kbd_buffer_store_event (&event
);
6783 /* Read any terminal input already buffered up by the system
6784 into the kbd_buffer, but do not wait.
6786 Return the number of keyboard chars read, or -1 meaning
6787 this is a bad time to try to read input. */
6796 /* Store pending user signal events, if any. */
6797 store_user_signal_events ();
6799 /* Loop through the available terminals, and call their input hooks. */
6803 struct terminal
*next
= t
->next_terminal
;
6805 if (t
->read_socket_hook
)
6808 struct input_event hold_quit
;
6810 if (input_blocked_p ())
6812 pending_signals
= true;
6816 EVENT_INIT (hold_quit
);
6817 hold_quit
.kind
= NO_EVENT
;
6819 /* No need for FIONREAD or fcntl; just say don't wait. */
6820 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6823 if (nr
== -1) /* Not OK to read input now. */
6827 else if (nr
== -2) /* Non-transient error. */
6829 /* The terminal device terminated; it should be closed. */
6831 /* Kill Emacs if this was our last terminal. */
6832 if (!terminal_list
->next_terminal
)
6833 /* Formerly simply reported no input, but that
6834 sometimes led to a failure of Emacs to terminate.
6835 SIGHUP seems appropriate if we can't reach the
6837 /* ??? Is it really right to send the signal just to
6838 this process rather than to the whole process
6839 group? Perhaps on systems with FIONREAD Emacs is
6840 alone in its group. */
6841 terminate_due_to_signal (SIGHUP
, 10);
6843 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6846 XSETTERMINAL (tmp
, t
);
6847 Fdelete_terminal (tmp
, Qnoelisp
);
6851 /* If there was no error, make sure the pointer
6852 is visible for all frames on this terminal. */
6855 Lisp_Object tail
, frame
;
6857 FOR_EACH_FRAME (tail
, frame
)
6859 struct frame
*f
= XFRAME (frame
);
6860 if (FRAME_TERMINAL (f
) == t
)
6861 frame_make_pointer_visible (f
);
6865 if (hold_quit
.kind
!= NO_EVENT
)
6866 kbd_buffer_store_event (&hold_quit
);
6878 /* This is the tty way of reading available input.
6880 Note that each terminal device has its own `struct terminal' object,
6881 and so this function is called once for each individual termcap
6882 terminal. The first parameter indicates which terminal to read from. */
6885 tty_read_avail_input (struct terminal
*terminal
,
6886 struct input_event
*hold_quit
)
6888 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6889 the kbd_buffer can really hold. That may prevent loss
6890 of characters on some systems when input is stuffed at us. */
6891 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6896 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6899 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6901 if (kbd_on_hold_p () || buffer_free
<= 0)
6903 #endif /* subprocesses */
6905 if (!terminal
->name
) /* Don't read from a dead terminal. */
6908 if (terminal
->type
!= output_termcap
6909 && terminal
->type
!= output_msdos_raw
)
6912 /* XXX I think the following code should be moved to separate hook
6913 functions in system-dependent files. */
6915 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6916 code sets read_socket_hook to w32_console_read_socket instead! */
6918 #else /* not WINDOWSNT */
6919 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6923 return 0; /* The terminal is suspended. */
6926 n_to_read
= dos_keysns ();
6930 cbuf
[0] = dos_keyread ();
6933 #else /* not MSDOS */
6938 struct input_event gpm_hold_quit
;
6939 int gpm
, fd
= gpm_fd
;
6941 EVENT_INIT (gpm_hold_quit
);
6942 gpm_hold_quit
.kind
= NO_EVENT
;
6944 /* gpm==1 if event received.
6945 gpm==0 if the GPM daemon has closed the connection, in which case
6946 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6947 we save it in `fd' so close_gpm can remove it from the
6949 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6950 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6951 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6954 /* Presumably the GPM daemon has closed the connection. */
6956 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6957 kbd_buffer_store_event (&gpm_hold_quit
);
6961 #endif /* HAVE_GPM */
6963 /* Determine how many characters we should *try* to read. */
6964 #ifdef USABLE_FIONREAD
6965 /* Find out how much input is available. */
6966 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6968 if (! noninteractive
)
6969 return -2; /* Close this terminal. */
6975 if (n_to_read
> sizeof cbuf
)
6976 n_to_read
= sizeof cbuf
;
6977 #elif defined USG || defined CYGWIN
6978 /* Read some input if available, but don't wait. */
6979 n_to_read
= sizeof cbuf
;
6980 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6982 # error "Cannot read without possibly delaying"
6986 /* Don't read more than we can store. */
6987 if (n_to_read
> buffer_free
)
6988 n_to_read
= buffer_free
;
6989 #endif /* subprocesses */
6991 /* Now read; for one reason or another, this will not block.
6992 NREAD is set to the number of chars read. */
6995 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6996 /* POSIX infers that processes which are not in the session leader's
6997 process group won't get SIGHUPs at logout time. BSDI adheres to
6998 this part standard and returns -1 from read (0) with errno==EIO
6999 when the control tty is taken away.
7000 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7001 if (nread
== -1 && errno
== EIO
)
7002 return -2; /* Close this terminal. */
7003 #if defined (AIX) && defined (_BSD)
7004 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7005 This looks incorrect, but it isn't, because _BSD causes
7006 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7007 and that causes a value other than 0 when there is no input. */
7009 return -2; /* Close this terminal. */
7013 /* We used to retry the read if it was interrupted.
7014 But this does the wrong thing when O_NONBLOCK causes
7015 an EAGAIN error. Does anybody know of a situation
7016 where a retry is actually needed? */
7018 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7028 #ifndef USABLE_FIONREAD
7029 #if defined (USG) || defined (CYGWIN)
7030 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7031 #endif /* USG or CYGWIN */
7032 #endif /* no FIONREAD */
7037 #endif /* not MSDOS */
7038 #endif /* not WINDOWSNT */
7040 for (i
= 0; i
< nread
; i
++)
7042 struct input_event buf
;
7044 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7046 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7047 buf
.modifiers
= meta_modifier
;
7048 if (tty
->meta_key
!= 2)
7052 /* Set the frame corresponding to the active tty. Note that the
7053 value of selected_frame is not reliable here, redisplay tends
7054 to temporarily change it. */
7055 buf
.frame_or_window
= tty
->top_frame
;
7058 kbd_buffer_store_event (&buf
);
7059 /* Don't look at input that follows a C-g too closely.
7060 This reduces lossage due to autorepeat on C-g. */
7061 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7062 && buf
.code
== quit_char
)
7070 handle_async_input (void)
7075 int nread
= gobble_input ();
7076 /* -1 means it's not ok to read the input now.
7077 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7078 0 means there was no keyboard input available. */
7086 process_pending_signals (void)
7088 pending_signals
= false;
7089 handle_async_input ();
7090 do_pending_atimers ();
7093 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7094 and reinvoke any pending signal if the level is now 0 and
7095 a fatal error is not already in progress. */
7098 unblock_input_to (int level
)
7100 interrupt_input_blocked
= level
;
7103 if (pending_signals
&& !fatal_error_in_progress
)
7104 process_pending_signals ();
7110 /* End critical section.
7112 If doing signal-driven input, and a signal came in when input was
7113 blocked, reinvoke the signal handler now to deal with it.
7115 It will also process queued input, if it was not read before.
7116 When a longer code sequence does not use block/unblock input
7117 at all, the whole input gathered up to the next call to
7118 unblock_input will be processed inside that call. */
7121 unblock_input (void)
7123 unblock_input_to (interrupt_input_blocked
- 1);
7126 /* Undo any number of BLOCK_INPUT calls,
7127 and also reinvoke any pending signal. */
7130 totally_unblock_input (void)
7132 unblock_input_to (0);
7138 handle_input_available_signal (int sig
)
7140 pending_signals
= true;
7142 if (input_available_clear_time
)
7143 *input_available_clear_time
= make_timespec (0, 0);
7147 deliver_input_available_signal (int sig
)
7149 deliver_process_signal (sig
, handle_input_available_signal
);
7151 #endif /* USABLE_SIGIO */
7154 /* User signal events. */
7156 struct user_signal_info
7158 /* Signal number. */
7161 /* Name of the signal. */
7164 /* Number of pending signals. */
7167 struct user_signal_info
*next
;
7170 /* List of user signals. */
7171 static struct user_signal_info
*user_signals
= NULL
;
7174 add_user_signal (int sig
, const char *name
)
7176 struct sigaction action
;
7177 struct user_signal_info
*p
;
7179 for (p
= user_signals
; p
; p
= p
->next
)
7181 /* Already added. */
7184 p
= xmalloc (sizeof *p
);
7186 p
->name
= xstrdup (name
);
7188 p
->next
= user_signals
;
7191 emacs_sigaction_init (&action
, deliver_user_signal
);
7192 sigaction (sig
, &action
, 0);
7196 handle_user_signal (int sig
)
7198 struct user_signal_info
*p
;
7199 const char *special_event_name
= NULL
;
7201 if (SYMBOLP (Vdebug_on_event
))
7202 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7204 for (p
= user_signals
; p
; p
= p
->next
)
7207 if (special_event_name
7208 && strcmp (special_event_name
, p
->name
) == 0)
7210 /* Enter the debugger in many ways. */
7211 debug_on_next_call
= true;
7212 debug_on_quit
= true;
7214 Vinhibit_quit
= Qnil
;
7216 /* Eat the event. */
7222 if (interrupt_input
)
7223 handle_input_available_signal (sig
);
7227 /* Tell wait_reading_process_output that it needs to wake
7228 up and look around. */
7229 if (input_available_clear_time
)
7230 *input_available_clear_time
= make_timespec (0, 0);
7237 deliver_user_signal (int sig
)
7239 deliver_process_signal (sig
, handle_user_signal
);
7243 find_user_signal_name (int sig
)
7245 struct user_signal_info
*p
;
7247 for (p
= user_signals
; p
; p
= p
->next
)
7255 store_user_signal_events (void)
7257 struct user_signal_info
*p
;
7258 struct input_event buf
;
7259 bool buf_initialized
= false;
7261 for (p
= user_signals
; p
; p
= p
->next
)
7262 if (p
->npending
> 0)
7264 if (! buf_initialized
)
7266 memset (&buf
, 0, sizeof buf
);
7267 buf
.kind
= USER_SIGNAL_EVENT
;
7268 buf
.frame_or_window
= selected_frame
;
7269 buf_initialized
= true;
7275 kbd_buffer_store_event (&buf
);
7278 while (p
->npending
> 0);
7283 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7284 static Lisp_Object menu_bar_one_keymap_changed_items
;
7286 /* These variables hold the vector under construction within
7287 menu_bar_items and its subroutines, and the current index
7288 for storing into that vector. */
7289 static Lisp_Object menu_bar_items_vector
;
7290 static int menu_bar_items_index
;
7293 static const char *separator_names
[] = {
7298 "single-dashed-line",
7299 "double-dashed-line",
7301 "shadow-etched-out",
7302 "shadow-etched-in-dash",
7303 "shadow-etched-out-dash",
7304 "shadow-double-etched-in",
7305 "shadow-double-etched-out",
7306 "shadow-double-etched-in-dash",
7307 "shadow-double-etched-out-dash",
7311 /* Return true if LABEL specifies a separator. */
7314 menu_separator_name_p (const char *label
)
7318 else if (strlen (label
) > 3
7319 && memcmp (label
, "--", 2) == 0
7324 for (i
= 0; separator_names
[i
]; ++i
)
7325 if (strcmp (label
, separator_names
[i
]) == 0)
7330 /* It's a separator if it contains only dashes. */
7331 while (*label
== '-')
7333 return (*label
== 0);
7340 /* Return a vector of menu items for a menu bar, appropriate
7341 to the current buffer. Each item has three elements in the vector:
7344 OLD is an old vector we can optionally reuse, or nil. */
7347 menu_bar_items (Lisp_Object old
)
7349 /* The number of keymaps we're scanning right now, and the number of
7350 keymaps we have allocated space for. */
7353 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7354 in the current keymaps, or nil where it is not a prefix. */
7357 Lisp_Object mapsbuf
[3];
7358 Lisp_Object def
, tail
;
7365 /* In order to build the menus, we need to call the keymap
7366 accessors. They all call QUIT. But this function is called
7367 during redisplay, during which a quit is fatal. So inhibit
7368 quitting while building the menus.
7369 We do this instead of specbind because (1) errors will clear it anyway
7370 and (2) this avoids risk of specpdl overflow. */
7371 oquit
= Vinhibit_quit
;
7375 menu_bar_items_vector
= old
;
7377 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7378 menu_bar_items_index
= 0;
7380 /* Build our list of keymaps.
7381 If we recognize a function key and replace its escape sequence in
7382 keybuf with its symbol, or if the sequence starts with a mouse
7383 click and we need to switch buffers, we jump back here to rebuild
7384 the initial keymaps from the current buffer. */
7388 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7389 if (!NILP (Voverriding_local_map_menu_flag
)
7390 && !NILP (Voverriding_local_map
))
7392 /* Yes, use them (if non-nil) as well as the global map. */
7395 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7396 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7397 if (!NILP (Voverriding_local_map
))
7398 maps
[nmaps
++] = Voverriding_local_map
;
7402 /* No, so use major and minor mode keymaps and keymap property.
7403 Note that menu-bar bindings in the local-map and keymap
7404 properties may not work reliable, as they are only
7405 recognized when the menu-bar (or mode-line) is updated,
7406 which does not normally happen after every command. */
7407 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7408 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7410 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7411 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7412 maps
[nmaps
++] = tem
;
7413 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7414 maps
[nmaps
++] = tem
;
7417 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7420 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7422 maps
[nmaps
++] = current_global_map
;
7425 /* Look up in each map the dummy prefix key `menu-bar'. */
7427 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7428 if (!NILP (maps
[mapno
]))
7430 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7434 menu_bar_one_keymap_changed_items
= Qnil
;
7435 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7439 /* Move to the end those items that should be at the end. */
7441 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7444 int end
= menu_bar_items_index
;
7446 for (i
= 0; i
< end
; i
+= 4)
7447 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7449 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7450 /* Move the item at index I to the end,
7451 shifting all the others forward. */
7452 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7453 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7454 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7455 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7457 memmove (aref_addr (menu_bar_items_vector
, i
),
7458 aref_addr (menu_bar_items_vector
, i
+ 4),
7459 (end
- i
- 4) * word_size
);
7460 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7461 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7462 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7463 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7468 /* Add nil, nil, nil, nil at the end. */
7470 int i
= menu_bar_items_index
;
7471 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7472 menu_bar_items_vector
7473 = larger_vector (menu_bar_items_vector
, 4, -1);
7474 /* Add this item. */
7475 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7476 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7477 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7478 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7479 menu_bar_items_index
= i
;
7482 Vinhibit_quit
= oquit
;
7484 return menu_bar_items_vector
;
7487 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7488 If there's already an item for KEY, add this DEF to it. */
7490 Lisp_Object item_properties
;
7493 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7499 if (EQ (item
, Qundefined
))
7501 /* If a map has an explicit `undefined' as definition,
7502 discard any previously made menu bar item. */
7504 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7505 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7507 if (menu_bar_items_index
> i
+ 4)
7508 memmove (aref_addr (menu_bar_items_vector
, i
),
7509 aref_addr (menu_bar_items_vector
, i
+ 4),
7510 (menu_bar_items_index
- i
- 4) * word_size
);
7511 menu_bar_items_index
-= 4;
7515 /* If this keymap has already contributed to this KEY,
7516 don't contribute to it a second time. */
7517 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7518 if (!NILP (tem
) || NILP (item
))
7521 menu_bar_one_keymap_changed_items
7522 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7524 /* We add to menu_bar_one_keymap_changed_items before doing the
7525 parse_menu_item, so that if it turns out it wasn't a menu item,
7526 it still correctly hides any further menu item. */
7527 parsed
= parse_menu_item (item
, 1);
7531 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7533 /* Find any existing item for this KEY. */
7534 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7535 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7538 /* If we did not find this KEY, add it at the end. */
7539 if (i
== menu_bar_items_index
)
7541 /* If vector is too small, get a bigger one. */
7542 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7543 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7544 /* Add this item. */
7545 ASET (menu_bar_items_vector
, i
, key
); i
++;
7546 ASET (menu_bar_items_vector
, i
,
7547 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7548 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7549 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7550 menu_bar_items_index
= i
;
7552 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7556 old
= AREF (menu_bar_items_vector
, i
+ 2);
7557 /* If the new and the old items are not both keymaps,
7558 the lookup will only find `item'. */
7559 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7560 ASET (menu_bar_items_vector
, i
+ 2, item
);
7564 /* This is used as the handler when calling menu_item_eval_property. */
7566 menu_item_eval_property_1 (Lisp_Object arg
)
7568 /* If we got a quit from within the menu computation,
7569 quit all the way out of it. This takes care of C-] in the debugger. */
7570 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7571 Fsignal (Qquit
, Qnil
);
7577 eval_dyn (Lisp_Object form
)
7579 return Feval (form
, Qnil
);
7582 /* Evaluate an expression and return the result (or nil if something
7583 went wrong). Used to evaluate dynamic parts of menu items. */
7585 menu_item_eval_property (Lisp_Object sexpr
)
7587 ptrdiff_t count
= SPECPDL_INDEX ();
7589 specbind (Qinhibit_redisplay
, Qt
);
7590 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7591 menu_item_eval_property_1
);
7592 return unbind_to (count
, val
);
7595 /* This function parses a menu item and leaves the result in the
7596 vector item_properties.
7597 ITEM is a key binding, a possible menu item.
7598 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7600 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7601 parse_menu_item returns true if the item is a menu item and false
7605 parse_menu_item (Lisp_Object item
, int inmenubar
)
7607 Lisp_Object def
, tem
, item_string
, start
;
7609 Lisp_Object keyhint
;
7618 /* Create item_properties vector if necessary. */
7619 if (NILP (item_properties
))
7621 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7623 /* Initialize optional entries. */
7624 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7625 ASET (item_properties
, i
, Qnil
);
7626 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7628 /* Save the item here to protect it from GC. */
7629 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7631 item_string
= XCAR (item
);
7635 if (STRINGP (item_string
))
7637 /* Old format menu item. */
7638 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7640 /* Maybe help string. */
7641 if (CONSP (item
) && STRINGP (XCAR (item
)))
7643 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7644 Fsubstitute_command_keys (XCAR (item
)));
7649 /* Maybe an obsolete key binding cache. */
7650 if (CONSP (item
) && CONSP (XCAR (item
))
7651 && (NILP (XCAR (XCAR (item
)))
7652 || VECTORP (XCAR (XCAR (item
)))))
7655 /* This is the real definition--the function to run. */
7656 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7658 /* Get enable property, if any. */
7661 tem
= Fget (item
, Qmenu_enable
);
7662 if (!NILP (Venable_disabled_menus_and_buttons
))
7663 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7664 else if (!NILP (tem
))
7665 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7668 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7670 /* New format menu item. */
7671 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7672 start
= XCDR (item
);
7675 /* We have a real binding. */
7676 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7678 item
= XCDR (start
);
7679 /* Is there an obsolete cache list with key equivalences. */
7680 if (CONSP (item
) && CONSP (XCAR (item
)))
7683 /* Parse properties. */
7684 while (CONSP (item
) && CONSP (XCDR (item
)))
7689 if (EQ (tem
, QCenable
))
7691 if (!NILP (Venable_disabled_menus_and_buttons
))
7692 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7694 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7696 else if (EQ (tem
, QCvisible
))
7698 /* If got a visible property and that evaluates to nil
7699 then ignore this item. */
7700 tem
= menu_item_eval_property (XCAR (item
));
7704 else if (EQ (tem
, QChelp
))
7706 Lisp_Object help
= XCAR (item
);
7708 help
= Fsubstitute_command_keys (help
);
7709 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7711 else if (EQ (tem
, QCfilter
))
7713 else if (EQ (tem
, QCkey_sequence
))
7716 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7717 /* Be GC protected. Set keyhint to item instead of tem. */
7720 else if (EQ (tem
, QCkeys
))
7723 if (CONSP (tem
) || STRINGP (tem
))
7724 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7726 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7731 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7733 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7735 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7741 else if (inmenubar
|| !NILP (start
))
7745 return 0; /* not a menu item */
7747 /* If item string is not a string, evaluate it to get string.
7748 If we don't get a string, skip this item. */
7749 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7750 if (!(STRINGP (item_string
)))
7752 item_string
= menu_item_eval_property (item_string
);
7753 if (!STRINGP (item_string
))
7755 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7758 /* If got a filter apply it on definition. */
7759 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7762 def
= menu_item_eval_property (list2 (XCAR (filter
),
7763 list2 (Qquote
, def
)));
7765 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7768 /* Enable or disable selection of item. */
7769 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7772 tem
= menu_item_eval_property (tem
);
7773 if (inmenubar
&& NILP (tem
))
7774 return 0; /* Ignore disabled items in menu bar. */
7775 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7778 /* If we got no definition, this item is just unselectable text which
7779 is OK in a submenu but not in the menubar. */
7781 return (!inmenubar
);
7783 /* See if this is a separate pane or a submenu. */
7784 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7785 tem
= get_keymap (def
, 0, 1);
7786 /* For a subkeymap, just record its details and exit. */
7789 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7790 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7794 /* At the top level in the menu bar, do likewise for commands also.
7795 The menu bar does not display equivalent key bindings anyway.
7796 ITEM_PROPERTY_DEF is already set up properly. */
7800 { /* This is a command. See if there is an equivalent key binding. */
7801 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7802 AUTO_STRING (space_space
, " ");
7804 /* The previous code preferred :key-sequence to :keys, so we
7805 preserve this behavior. */
7806 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7807 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7810 Lisp_Object prefix
= keyeq
;
7811 Lisp_Object keys
= Qnil
;
7815 def
= XCAR (prefix
);
7816 prefix
= XCDR (prefix
);
7819 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7821 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7823 keys
= XCAR (keyhint
);
7824 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7826 /* We have a suggested key. Is it bound to the command? */
7829 /* If the command is an alias for another
7830 (such as lmenu.el set it up), check if the
7831 original command matches the cached command. */
7833 && EQ (tem
, XSYMBOL (def
)->function
))))
7838 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7842 tem
= Fkey_description (keys
, Qnil
);
7845 if (STRINGP (XCAR (prefix
)))
7846 tem
= concat2 (XCAR (prefix
), tem
);
7847 if (STRINGP (XCDR (prefix
)))
7848 tem
= concat2 (tem
, XCDR (prefix
));
7850 keyeq
= concat2 (space_space
, tem
);
7856 /* If we have an equivalent key binding, use that. */
7857 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7860 /* Include this when menu help is implemented.
7861 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7862 if (!(NILP (tem) || STRINGP (tem)))
7864 tem = menu_item_eval_property (tem);
7867 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7871 /* Handle radio buttons or toggle boxes. */
7872 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7874 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7875 menu_item_eval_property (tem
));
7882 /***********************************************************************
7884 ***********************************************************************/
7886 /* A vector holding tool bar items while they are parsed in function
7887 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7890 static Lisp_Object tool_bar_items_vector
;
7892 /* A vector holding the result of parse_tool_bar_item. Layout is like
7893 the one for a single item in tool_bar_items_vector. */
7895 static Lisp_Object tool_bar_item_properties
;
7897 /* Next free index in tool_bar_items_vector. */
7899 static int ntool_bar_items
;
7901 /* Function prototypes. */
7903 static void init_tool_bar_items (Lisp_Object
);
7904 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7906 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7907 static void append_tool_bar_item (void);
7910 /* Return a vector of tool bar items for keymaps currently in effect.
7911 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7912 tool bar items found. */
7915 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7918 Lisp_Object mapsbuf
[3];
7926 /* In order to build the menus, we need to call the keymap
7927 accessors. They all call QUIT. But this function is called
7928 during redisplay, during which a quit is fatal. So inhibit
7929 quitting while building the menus. We do this instead of
7930 specbind because (1) errors will clear it anyway and (2) this
7931 avoids risk of specpdl overflow. */
7932 oquit
= Vinhibit_quit
;
7935 /* Initialize tool_bar_items_vector and protect it from GC. */
7936 init_tool_bar_items (reuse
);
7938 /* Build list of keymaps in maps. Set nmaps to the number of maps
7941 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7942 if (!NILP (Voverriding_local_map_menu_flag
)
7943 && !NILP (Voverriding_local_map
))
7945 /* Yes, use them (if non-nil) as well as the global map. */
7948 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7949 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7950 if (!NILP (Voverriding_local_map
))
7951 maps
[nmaps
++] = Voverriding_local_map
;
7955 /* No, so use major and minor mode keymaps and keymap property.
7956 Note that tool-bar bindings in the local-map and keymap
7957 properties may not work reliable, as they are only
7958 recognized when the tool-bar (or mode-line) is updated,
7959 which does not normally happen after every command. */
7960 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7961 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7963 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7964 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7965 maps
[nmaps
++] = tem
;
7966 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7967 maps
[nmaps
++] = tem
;
7970 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7973 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7976 /* Add global keymap at the end. */
7977 maps
[nmaps
++] = current_global_map
;
7979 /* Process maps in reverse order and look up in each map the prefix
7981 for (i
= nmaps
- 1; i
>= 0; --i
)
7982 if (!NILP (maps
[i
]))
7986 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7988 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7991 Vinhibit_quit
= oquit
;
7992 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7994 return tool_bar_items_vector
;
7998 /* Process the definition of KEY which is DEF. */
8001 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8005 if (EQ (def
, Qundefined
))
8007 /* If a map has an explicit `undefined' as definition,
8008 discard any previously made item. */
8009 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8011 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8013 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8015 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8016 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8017 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8019 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8024 else if (parse_tool_bar_item (key
, def
))
8025 /* Append a new tool bar item to tool_bar_items_vector. Accept
8026 more than one definition for the same key. */
8027 append_tool_bar_item ();
8030 /* Access slot with index IDX of vector tool_bar_item_properties. */
8031 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8033 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8035 ASET (tool_bar_item_properties
, idx
, val
);
8039 /* Parse a tool bar item specification ITEM for key KEY and return the
8040 result in tool_bar_item_properties. Value is false if ITEM is
8043 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8045 CAPTION is the caption of the item, If it's not a string, it is
8046 evaluated to get a string.
8048 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8049 as binding are currently ignored.
8051 The following properties are recognized:
8055 FORM is evaluated and specifies whether the tool bar item is
8056 enabled or disabled.
8060 FORM is evaluated and specifies whether the tool bar item is visible.
8062 - `:filter FUNCTION'
8064 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8065 result is stored as the new binding.
8067 - `:button (TYPE SELECTED)'
8069 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8070 and specifies whether the button is selected (pressed) or not.
8074 IMAGES is either a single image specification or a vector of four
8075 image specifications. See enum tool_bar_item_images.
8077 - `:help HELP-STRING'.
8079 Gives a help string to display for the tool bar item.
8081 - `:label LABEL-STRING'.
8083 A text label to show with the tool bar button if labels are enabled. */
8086 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8088 Lisp_Object filter
= Qnil
;
8089 Lisp_Object caption
;
8091 bool have_label
= false;
8093 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8094 Rule out items that aren't lists, don't start with
8095 `menu-item' or whose rest following `tool-bar-item' is not a
8100 /* As an exception, allow old-style menu separators. */
8101 if (STRINGP (XCAR (item
)))
8102 item
= list1 (XCAR (item
));
8103 else if (!EQ (XCAR (item
), Qmenu_item
)
8104 || (item
= XCDR (item
), !CONSP (item
)))
8107 /* Create tool_bar_item_properties vector if necessary. Reset it to
8109 if (VECTORP (tool_bar_item_properties
))
8111 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8115 tool_bar_item_properties
8116 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8119 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8120 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8122 /* Get the caption of the item. If the caption is not a string,
8123 evaluate it to get a string. If we don't get a string, skip this
8125 caption
= XCAR (item
);
8126 if (!STRINGP (caption
))
8128 caption
= menu_item_eval_property (caption
);
8129 if (!STRINGP (caption
))
8132 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8134 /* If the rest following the caption is not a list, the menu item is
8135 either a separator, or invalid. */
8139 if (menu_separator_name_p (SSDATA (caption
)))
8141 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8142 #if !defined (USE_GTK) && !defined (HAVE_NS)
8143 /* If we use build_desired_tool_bar_string to render the
8144 tool bar, the separator is rendered as an image. */
8145 set_prop (TOOL_BAR_ITEM_IMAGES
,
8146 (menu_item_eval_property
8147 (Vtool_bar_separator_image_expression
)));
8148 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8149 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8150 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8157 /* Store the binding. */
8158 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8161 /* Ignore cached key binding, if any. */
8162 if (CONSP (item
) && CONSP (XCAR (item
)))
8165 /* Process the rest of the properties. */
8166 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8168 Lisp_Object ikey
, value
;
8171 value
= XCAR (XCDR (item
));
8173 if (EQ (ikey
, QCenable
))
8175 /* `:enable FORM'. */
8176 if (!NILP (Venable_disabled_menus_and_buttons
))
8177 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8179 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8181 else if (EQ (ikey
, QCvisible
))
8183 /* `:visible FORM'. If got a visible property and that
8184 evaluates to nil then ignore this item. */
8185 if (NILP (menu_item_eval_property (value
)))
8188 else if (EQ (ikey
, QChelp
))
8189 /* `:help HELP-STRING'. */
8190 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8191 else if (EQ (ikey
, QCvert_only
))
8192 /* `:vert-only t/nil'. */
8193 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8194 else if (EQ (ikey
, QClabel
))
8196 const char *bad_label
= "!!?GARBLED ITEM?!!";
8197 /* `:label LABEL-STRING'. */
8198 set_prop (TOOL_BAR_ITEM_LABEL
,
8199 STRINGP (value
) ? value
: build_string (bad_label
));
8202 else if (EQ (ikey
, QCfilter
))
8203 /* ':filter FORM'. */
8205 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8207 /* `:button (TYPE . SELECTED)'. */
8208 Lisp_Object type
, selected
;
8210 type
= XCAR (value
);
8211 selected
= XCDR (value
);
8212 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8214 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8215 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8218 else if (EQ (ikey
, QCimage
)
8220 || (VECTORP (value
) && ASIZE (value
) == 4)))
8221 /* Value is either a single image specification or a vector
8222 of 4 such specifications for the different button states. */
8223 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8224 else if (EQ (ikey
, QCrtl
))
8226 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8232 /* Try to make one from caption and key. */
8233 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8234 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8235 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8236 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8238 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8239 char *buf
= xmalloc (max_lbl
+ 1);
8240 Lisp_Object new_lbl
;
8241 ptrdiff_t caption_len
= strlen (capt
);
8243 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8246 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8248 buf
[caption_len
] = '\0';
8252 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8256 strcpy (buf
, label
);
8258 for (j
= 0; buf
[j
] != '\0'; ++j
)
8266 new_lbl
= Fupcase_initials (build_string (label
));
8267 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8268 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8270 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8274 /* If got a filter apply it on binding. */
8276 set_prop (TOOL_BAR_ITEM_BINDING
,
8277 (menu_item_eval_property
8280 PROP (TOOL_BAR_ITEM_BINDING
))))));
8282 /* See if the binding is a keymap. Give up if it is. */
8283 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8286 /* Enable or disable selection of item. */
8287 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8288 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8289 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8291 /* Handle radio buttons or toggle boxes. */
8292 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8293 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8294 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8302 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8303 that can be reused. */
8306 init_tool_bar_items (Lisp_Object reuse
)
8308 if (VECTORP (reuse
))
8309 tool_bar_items_vector
= reuse
;
8311 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8312 ntool_bar_items
= 0;
8316 /* Append parsed tool bar item properties from
8317 tool_bar_item_properties */
8320 append_tool_bar_item (void)
8324 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8326 /* Enlarge tool_bar_items_vector if necessary. */
8328 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8330 /* Append entries from tool_bar_item_properties to the end of
8331 tool_bar_items_vector. */
8332 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8333 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8334 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8341 /* Read a character using menus based on the keymap MAP.
8342 Return nil if there are no menus in the maps.
8343 Return t if we displayed a menu but the user rejected it.
8345 PREV_EVENT is the previous input event, or nil if we are reading
8346 the first event of a key sequence.
8348 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8349 if we used a mouse menu to read the input, or false otherwise. If
8350 USED_MOUSE_MENU is null, don't dereference it.
8352 The prompting is done based on the prompt-string of the map
8353 and the strings associated with various map elements.
8355 This can be done with X menus or with menus put in the minibuf.
8356 These are done in different ways, depending on how the input will be read.
8357 Menus using X are done after auto-saving in read-char, getting the input
8358 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8359 and do auto-saving in the inner call of read_char. */
8362 read_char_x_menu_prompt (Lisp_Object map
,
8363 Lisp_Object prev_event
, bool *used_mouse_menu
)
8365 if (used_mouse_menu
)
8366 *used_mouse_menu
= false;
8368 /* Use local over global Menu maps. */
8370 if (! menu_prompting
)
8373 /* If we got to this point via a mouse click,
8374 use a real menu for mouse selection. */
8375 if (EVENT_HAS_PARAMETERS (prev_event
)
8376 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8377 && !EQ (XCAR (prev_event
), Qtool_bar
))
8379 /* Display the menu and get the selection. */
8382 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8387 record_menu_key (XCAR (value
));
8389 /* If we got multiple events, unread all but
8391 There is no way to prevent those unread events
8392 from showing up later in last_nonmenu_event.
8393 So turn symbol and integer events into lists,
8394 to indicate that they came from a mouse menu,
8395 so that when present in last_nonmenu_event
8396 they won't confuse things. */
8397 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8399 record_menu_key (XCAR (tem
));
8400 if (SYMBOLP (XCAR (tem
))
8401 || INTEGERP (XCAR (tem
)))
8402 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8405 /* If we got more than one event, put all but the first
8406 onto this list to be read later.
8407 Return just the first event now. */
8408 Vunread_command_events
8409 = nconc2 (XCDR (value
), Vunread_command_events
);
8410 value
= XCAR (value
);
8412 else if (NILP (value
))
8414 if (used_mouse_menu
)
8415 *used_mouse_menu
= true;
8422 read_char_minibuf_menu_prompt (int commandflag
,
8427 /* FIXME: Use the minibuffer's frame width. */
8428 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8430 bool nobindings
= true;
8431 Lisp_Object rest
, vector
;
8432 Lisp_Object prompt_strings
= Qnil
;
8436 if (! menu_prompting
)
8439 map
= get_keymap (map
, 0, 1);
8440 name
= Fkeymap_prompt (map
);
8442 /* If we don't have any menus, just read a character normally. */
8443 if (!STRINGP (name
))
8446 #define PUSH_C_STR(str, listvar) \
8447 listvar = Fcons (build_unibyte_string (str), listvar)
8449 /* Prompt string always starts with map's prompt, and a space. */
8450 prompt_strings
= Fcons (name
, prompt_strings
);
8451 PUSH_C_STR (": ", prompt_strings
);
8452 nlength
= SCHARS (name
) + 2;
8456 /* Present the documented bindings, a line at a time. */
8459 bool notfirst
= false;
8460 Lisp_Object menu_strings
= prompt_strings
;
8461 ptrdiff_t i
= nlength
;
8463 Lisp_Object orig_defn_macro
;
8465 /* Loop over elements of map. */
8470 /* FIXME: Use map_keymap to handle new keymap formats. */
8472 /* At end of map, wrap around if just starting,
8473 or end this line if already have something on it. */
8476 if (notfirst
|| nobindings
)
8482 /* Look at the next element of the map. */
8484 elt
= AREF (vector
, idx
);
8486 elt
= Fcar_safe (rest
);
8488 if (idx
< 0 && VECTORP (elt
))
8490 /* If we found a dense table in the keymap,
8491 advanced past it, but start scanning its contents. */
8492 rest
= Fcdr_safe (rest
);
8498 /* An ordinary element. */
8499 Lisp_Object event
, tem
;
8503 event
= Fcar_safe (elt
); /* alist */
8504 elt
= Fcdr_safe (elt
);
8508 XSETINT (event
, idx
); /* vector */
8511 /* Ignore the element if it has no prompt string. */
8512 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8514 /* True if the char to type matches the string. */
8516 Lisp_Object upcased_event
, downcased_event
;
8517 Lisp_Object desc
= Qnil
;
8519 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8521 upcased_event
= Fupcase (event
);
8522 downcased_event
= Fdowncase (event
);
8523 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8524 || XINT (downcased_event
) == SREF (s
, 0));
8526 desc
= Fsingle_key_description (event
, Qnil
);
8528 #if 0 /* It is redundant to list the equivalent key bindings because
8529 the prefix is what the user has already typed. */
8531 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8533 /* Insert equivalent keybinding. */
8534 s
= concat2 (s
, tem
);
8537 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8538 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8540 /* Insert button prefix. */
8541 Lisp_Object selected
8542 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8543 AUTO_STRING (radio_yes
, "(*) ");
8544 AUTO_STRING (radio_no
, "( ) ");
8545 AUTO_STRING (check_yes
, "[X] ");
8546 AUTO_STRING (check_no
, "[ ] ");
8547 if (EQ (tem
, QCradio
))
8548 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8550 tem
= NILP (selected
) ? check_yes
: check_no
;
8551 s
= concat2 (tem
, s
);
8555 /* If we have room for the prompt string, add it to this line.
8556 If this is the first on the line, always add it. */
8557 if ((SCHARS (s
) + i
+ 2
8558 + (char_matches
? 0 : SCHARS (desc
) + 3))
8562 ptrdiff_t thiswidth
;
8564 /* Punctuate between strings. */
8567 PUSH_C_STR (", ", menu_strings
);
8573 /* If the char to type doesn't match the string's
8574 first char, explicitly show what char to type. */
8577 /* Add as much of string as fits. */
8578 thiswidth
= min (SCHARS (desc
), width
- i
);
8580 = Fcons (Fsubstring (desc
, make_number (0),
8581 make_number (thiswidth
)),
8584 PUSH_C_STR (" = ", menu_strings
);
8588 /* Add as much of string as fits. */
8589 thiswidth
= min (SCHARS (s
), width
- i
);
8591 = Fcons (Fsubstring (s
, make_number (0),
8592 make_number (thiswidth
)),
8598 /* If this element does not fit, end the line now,
8599 and save the element for the next line. */
8600 PUSH_C_STR ("...", menu_strings
);
8605 /* Move past this element. */
8606 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8607 /* Handle reaching end of dense table. */
8612 rest
= Fcdr_safe (rest
);
8616 /* Prompt with that and read response. */
8617 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8619 /* Make believe it's not a keyboard macro in case the help char
8620 is pressed. Help characters are not recorded because menu prompting
8621 is not used on replay. */
8622 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8623 kset_defining_kbd_macro (current_kboard
, Qnil
);
8625 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8626 while (BUFFERP (obj
));
8627 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8629 if (!INTEGERP (obj
) || XINT (obj
) == -2
8630 || (! EQ (obj
, menu_prompt_more_char
)
8631 && (!INTEGERP (menu_prompt_more_char
)
8632 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8634 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8635 store_kbd_macro_char (obj
);
8638 /* Help char - go round again. */
8642 /* Reading key sequences. */
8645 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8647 return access_keymap (get_keymap (keymap
, 0, 1),
8652 active_maps (Lisp_Object first_event
)
8654 Lisp_Object position
8655 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8656 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8659 /* Structure used to keep track of partial application of key remapping
8660 such as Vfunction_key_map and Vkey_translation_map. */
8661 typedef struct keyremap
8663 /* This is the map originally specified for this use. */
8665 /* This is a submap reached by looking up, in PARENT,
8666 the events from START to END. */
8668 /* Positions [START, END) in the key sequence buffer
8669 are the key that we have scanned so far.
8670 Those events are the ones that we will replace
8671 if PARENT maps them into a key sequence. */
8675 /* Lookup KEY in MAP.
8676 MAP is a keymap mapping keys to key vectors or functions.
8677 If the mapping is a function and DO_FUNCALL is true,
8678 the function is called with PROMPT as parameter and its return
8679 value is used as the return value of this function (after checking
8680 that it is indeed a vector). */
8683 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8688 next
= access_keymap (map
, key
, 1, 0, 1);
8690 /* Handle a symbol whose function definition is a keymap
8692 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8693 && (ARRAYP (XSYMBOL (next
)->function
)
8694 || KEYMAPP (XSYMBOL (next
)->function
)))
8695 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8697 /* If the keymap gives a function, not an
8698 array, then call the function with one arg and use
8699 its value instead. */
8700 if (do_funcall
&& FUNCTIONP (next
))
8705 next
= call1 (next
, prompt
);
8706 /* If the function returned something invalid,
8707 barf--don't ignore it. */
8708 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8709 error ("Function %s returns invalid key sequence",
8710 SSDATA (SYMBOL_NAME (tem
)));
8715 /* Do one step of the key remapping used for function-key-map and
8716 key-translation-map:
8717 KEYBUF is the buffer holding the input events.
8718 BUFSIZE is its maximum size.
8719 FKEY is a pointer to the keyremap structure to use.
8720 INPUT is the index of the last element in KEYBUF.
8721 DOIT if true says that the remapping can actually take place.
8722 DIFF is used to return the number of keys added/removed by the remapping.
8723 PARENT is the root of the keymap.
8724 PROMPT is the prompt to use if the remapping happens through a function.
8725 Return true if the remapping actually took place. */
8728 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8729 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8731 Lisp_Object next
, key
;
8733 key
= keybuf
[fkey
->end
++];
8735 if (KEYMAPP (fkey
->parent
))
8736 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8740 /* If keybuf[fkey->start..fkey->end] is bound in the
8741 map and we're in a position to do the key remapping, replace it with
8742 the binding and restart with fkey->start at the end. */
8743 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8745 int len
= XFASTINT (Flength (next
));
8748 *diff
= len
- (fkey
->end
- fkey
->start
);
8750 if (bufsize
- input
<= *diff
)
8751 error ("Key sequence too long");
8753 /* Shift the keys that follow fkey->end. */
8755 for (i
= fkey
->end
; i
< input
; i
++)
8756 keybuf
[i
+ *diff
] = keybuf
[i
];
8758 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8759 keybuf
[i
+ *diff
] = keybuf
[i
];
8760 /* Overwrite the old keys with the new ones. */
8761 for (i
= 0; i
< len
; i
++)
8762 keybuf
[fkey
->start
+ i
]
8763 = Faref (next
, make_number (i
));
8765 fkey
->start
= fkey
->end
+= *diff
;
8766 fkey
->map
= fkey
->parent
;
8771 fkey
->map
= get_keymap (next
, 0, 1);
8773 /* If we no longer have a bound suffix, try a new position for
8775 if (!CONSP (fkey
->map
))
8777 fkey
->end
= ++fkey
->start
;
8778 fkey
->map
= fkey
->parent
;
8784 test_undefined (Lisp_Object binding
)
8786 return (NILP (binding
)
8787 || EQ (binding
, Qundefined
)
8788 || (SYMBOLP (binding
)
8789 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8792 /* Read a sequence of keys that ends with a non prefix character,
8793 storing it in KEYBUF, a buffer of size BUFSIZE.
8795 Return the length of the key sequence stored.
8796 Return -1 if the user rejected a command menu.
8798 Echo starting immediately unless `prompt' is 0.
8800 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8801 read_char with a suitable COMMANDFLAG argument.
8803 Where a key sequence ends depends on the currently active keymaps.
8804 These include any minor mode keymaps active in the current buffer,
8805 the current buffer's local map, and the global map.
8807 If a key sequence has no other bindings, we check Vfunction_key_map
8808 to see if some trailing subsequence might be the beginning of a
8809 function key's sequence. If so, we try to read the whole function
8810 key, and substitute its symbolic name into the key sequence.
8812 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8813 `double-' events into similar click events, if that would make them
8814 bound. We try to turn `triple-' events first into `double-' events,
8817 If we get a mouse click in a mode line, vertical divider, or other
8818 non-text area, we treat the click as if it were prefixed by the
8819 symbol denoting that area - `mode-line', `vertical-line', or
8822 If the sequence starts with a mouse click, we read the key sequence
8823 with respect to the buffer clicked on, not the current buffer.
8825 If the user switches frames in the midst of a key sequence, we put
8826 off the switch-frame event until later; the next call to
8827 read_char will return it.
8829 If FIX_CURRENT_BUFFER, we restore current_buffer
8830 from the selected window's buffer. */
8833 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8834 bool dont_downcase_last
, bool can_return_switch_frame
,
8835 bool fix_current_buffer
, bool prevent_redisplay
)
8837 ptrdiff_t count
= SPECPDL_INDEX ();
8839 /* How many keys there are in the current key sequence. */
8842 /* The length of the echo buffer when we started reading, and
8843 the length of this_command_keys when we started reading. */
8844 ptrdiff_t echo_start UNINIT
;
8845 ptrdiff_t keys_start
;
8847 Lisp_Object current_binding
= Qnil
;
8848 Lisp_Object first_event
= Qnil
;
8850 /* Index of the first key that has no binding.
8851 It is useless to try fkey.start larger than that. */
8854 /* If t < mock_input, then KEYBUF[t] should be read as the next
8857 We use this to recover after recognizing a function key. Once we
8858 realize that a suffix of the current key sequence is actually a
8859 function key's escape sequence, we replace the suffix with the
8860 function key's binding from Vfunction_key_map. Now keybuf
8861 contains a new and different key sequence, so the echo area,
8862 this_command_keys, and the submaps and defs arrays are wrong. In
8863 this situation, we set mock_input to t, set t to 0, and jump to
8864 restart_sequence; the loop will read keys from keybuf up until
8865 mock_input, thus rebuilding the state; and then it will resume
8866 reading characters from the keyboard. */
8869 /* If the sequence is unbound in submaps[], then
8870 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8871 and fkey.map is its binding.
8873 These might be > t, indicating that all function key scanning
8874 should hold off until t reaches them. We do this when we've just
8875 recognized a function key, to avoid searching for the function
8876 key's again in Vfunction_key_map. */
8879 /* Likewise, for key_translation_map and input-decode-map. */
8880 keyremap keytran
, indec
;
8882 /* True if we are trying to map a key by changing an upper-case
8883 letter to lower case, or a shifted function key to an unshifted
8885 bool shift_translated
= false;
8887 /* If we receive a `switch-frame' or `select-window' event in the middle of
8888 a key sequence, we put it off for later.
8889 While we're reading, we keep the event here. */
8890 Lisp_Object delayed_switch_frame
;
8892 Lisp_Object original_uppercase UNINIT
;
8893 int original_uppercase_position
= -1;
8895 /* Gets around Microsoft compiler limitations. */
8896 bool dummyflag
= false;
8898 struct buffer
*starting_buffer
;
8900 /* List of events for which a fake prefix key has been generated. */
8901 Lisp_Object fake_prefixed_keys
= Qnil
;
8903 raw_keybuf_count
= 0;
8905 last_nonmenu_event
= Qnil
;
8907 delayed_switch_frame
= Qnil
;
8913 /* Install the string PROMPT as the beginning of the string
8914 of echoing, so that it serves as a prompt for the next
8916 kset_echo_prompt (current_kboard
, prompt
);
8917 /* FIXME: This use of echo_now doesn't look quite right and is ugly
8918 since it forces us to fiddle with current_kboard->immediate_echo
8919 before and after. */
8920 current_kboard
->immediate_echo
= false;
8922 if (!echo_keystrokes_p ())
8923 current_kboard
->immediate_echo
= false;
8925 else if (cursor_in_echo_area
/* FIXME: Not sure why we test this here,
8926 maybe we should just drop this test. */
8927 && echo_keystrokes_p ())
8928 /* This doesn't put in a dash if the echo buffer is empty, so
8929 you don't always see a dash hanging out in the minibuffer. */
8933 /* Record the initial state of the echo area and this_command_keys;
8934 we will need to restore them if we replay a key sequence. */
8936 echo_start
= echo_length ();
8937 keys_start
= this_command_key_count
;
8938 this_single_command_key_start
= keys_start
;
8940 /* We jump here when we need to reinitialize fkey and keytran; this
8941 happens if we switch keyboards between rescans. */
8942 replay_entire_sequence
:
8944 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8945 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8946 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8947 indec
.start
= indec
.end
= 0;
8948 fkey
.start
= fkey
.end
= 0;
8949 keytran
.start
= keytran
.end
= 0;
8951 /* We jump here when the key sequence has been thoroughly changed, and
8952 we need to rescan it starting from the beginning. When we jump here,
8953 keybuf[0..mock_input] holds the sequence we should reread. */
8956 starting_buffer
= current_buffer
;
8957 first_unbound
= bufsize
+ 1;
8959 /* Build our list of keymaps.
8960 If we recognize a function key and replace its escape sequence in
8961 keybuf with its symbol, or if the sequence starts with a mouse
8962 click and we need to switch buffers, we jump back here to rebuild
8963 the initial keymaps from the current buffer. */
8964 current_binding
= active_maps (first_event
);
8966 /* Start from the beginning in keybuf. */
8969 /* These are no-ops the first time through, but if we restart, they
8970 revert the echo area and this_command_keys to their original state. */
8971 this_command_key_count
= keys_start
;
8972 if (INTERACTIVE
&& t
< mock_input
)
8973 echo_truncate (echo_start
);
8975 /* If the best binding for the current key sequence is a keymap, or
8976 we may be looking at a function key's escape sequence, keep on
8978 while (!NILP (current_binding
)
8979 /* Keep reading as long as there's a prefix binding. */
8980 ? KEYMAPP (current_binding
)
8981 /* Don't return in the middle of a possible function key sequence,
8982 if the only bindings we found were via case conversion.
8983 Thus, if ESC O a has a function-key-map translation
8984 and ESC o has a binding, don't return after ESC O,
8985 so that we can translate ESC O plus the next character. */
8986 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8989 bool used_mouse_menu
= false;
8991 /* Where the last real key started. If we need to throw away a
8992 key that has expanded into more than one element of keybuf
8993 (say, a mouse click on the mode line which is being treated
8994 as [mode-line (mouse-...)], then we backtrack to this point
8996 int last_real_key_start
;
8998 /* These variables are analogous to echo_start and keys_start;
8999 while those allow us to restart the entire key sequence,
9000 echo_local_start and keys_local_start allow us to throw away
9002 ptrdiff_t echo_local_start UNINIT
;
9003 int keys_local_start
;
9004 Lisp_Object new_binding
;
9006 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9007 eassert (indec
.start
<= indec
.end
);
9008 eassert (fkey
.start
<= fkey
.end
);
9009 eassert (keytran
.start
<= keytran
.end
);
9010 /* key-translation-map is applied *after* function-key-map
9011 which is itself applied *after* input-decode-map. */
9012 eassert (fkey
.end
<= indec
.start
);
9013 eassert (keytran
.end
<= fkey
.start
);
9015 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9016 first_unbound
< keytran
.start
)
9017 { /* The prefix upto first_unbound has no binding and has
9018 no translation left to do either, so we know it's unbound.
9019 If we don't stop now, we risk staying here indefinitely
9020 (if the user keeps entering fkey or keytran prefixes
9021 like C-c ESC ESC ESC ESC ...) */
9023 for (i
= first_unbound
+ 1; i
< t
; i
++)
9024 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9025 mock_input
= t
- first_unbound
- 1;
9026 indec
.end
= indec
.start
-= first_unbound
+ 1;
9027 indec
.map
= indec
.parent
;
9028 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9029 fkey
.map
= fkey
.parent
;
9030 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9031 keytran
.map
= keytran
.parent
;
9032 goto replay_sequence
;
9036 error ("Key sequence too long");
9039 echo_local_start
= echo_length ();
9040 keys_local_start
= this_command_key_count
;
9043 /* These are no-ops, unless we throw away a keystroke below and
9044 jumped back up to replay_key; in that case, these restore the
9045 variables to their original state, allowing us to replay the
9047 if (INTERACTIVE
&& t
< mock_input
)
9048 echo_truncate (echo_local_start
);
9049 this_command_key_count
= keys_local_start
;
9051 /* By default, assume each event is "real". */
9052 last_real_key_start
= t
;
9054 /* Does mock_input indicate that we are re-reading a key sequence? */
9058 add_command_key (key
);
9059 if (current_kboard
->immediate_echo
)
9061 /* Set immediate_echo to false so as to force echo_now to
9062 redisplay (it will set immediate_echo right back to true). */
9063 current_kboard
->immediate_echo
= false;
9068 /* If not, we should actually read a character. */
9072 KBOARD
*interrupted_kboard
= current_kboard
;
9073 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9074 /* Calling read_char with COMMANDFLAG = -2 avoids
9075 redisplay in read_char and its subroutines. */
9076 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9077 current_binding
, last_nonmenu_event
,
9078 &used_mouse_menu
, NULL
);
9079 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9080 /* When switching to a new tty (with a new keyboard),
9081 read_char returns the new buffer, rather than -2
9082 (Bug#5095). This is because `terminal-init-xterm'
9083 calls read-char, which eats the wrong_kboard_jmpbuf
9084 return. Any better way to fix this? -- cyd */
9085 || (interrupted_kboard
!= current_kboard
))
9090 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9091 if (k
== interrupted_kboard
)
9096 /* Don't touch interrupted_kboard when it's been
9098 delayed_switch_frame
= Qnil
;
9099 goto replay_entire_sequence
;
9102 if (!NILP (delayed_switch_frame
))
9105 (interrupted_kboard
,
9106 Fcons (delayed_switch_frame
,
9107 KVAR (interrupted_kboard
, kbd_queue
)));
9108 delayed_switch_frame
= Qnil
;
9113 (interrupted_kboard
,
9114 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9116 /* If the side queue is non-empty, ensure it begins with a
9117 switch-frame, so we'll replay it in the right context. */
9118 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9119 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9120 !(EVENT_HAS_PARAMETERS (key
)
9121 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9125 XSETFRAME (frame
, interrupted_frame
);
9127 (interrupted_kboard
,
9128 Fcons (make_lispy_switch_frame (frame
),
9129 KVAR (interrupted_kboard
, kbd_queue
)));
9132 goto replay_entire_sequence
;
9136 /* read_char returns t when it shows a menu and the user rejects it.
9140 unbind_to (count
, Qnil
);
9144 /* read_char returns -1 at the end of a macro.
9145 Emacs 18 handles this by returning immediately with a
9146 zero, so that's what we'll do. */
9147 if (INTEGERP (key
) && XINT (key
) == -1)
9150 /* The Microsoft C compiler can't handle the goto that
9156 /* If the current buffer has been changed from under us, the
9157 keymap may have changed, so replay the sequence. */
9160 timer_resume_idle ();
9163 /* Reset the current buffer from the selected window
9164 in case something changed the former and not the latter.
9165 This is to be more consistent with the behavior
9166 of the command_loop_1. */
9167 if (fix_current_buffer
)
9169 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9171 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9173 Fset_buffer (XWINDOW (selected_window
)->contents
);
9176 goto replay_sequence
;
9179 /* If we have a quit that was typed in another frame, and
9180 quit_throw_to_read_char switched buffers,
9181 replay to get the right keymap. */
9183 && XINT (key
) == quit_char
9184 && current_buffer
!= starting_buffer
)
9187 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9192 goto replay_sequence
;
9197 if (EVENT_HAS_PARAMETERS (key
)
9198 /* Either a `switch-frame' or a `select-window' event. */
9199 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9201 /* If we're at the beginning of a key sequence, and the caller
9202 says it's okay, go ahead and return this event. If we're
9203 in the midst of a key sequence, delay it until the end. */
9204 if (t
> 0 || !can_return_switch_frame
)
9206 delayed_switch_frame
= key
;
9211 if (NILP (first_event
))
9214 /* Even if first_event does not specify a particular
9215 window/position, it's important to recompute the maps here
9216 since a long time might have passed since we entered
9217 read_key_sequence, and a timer (or process-filter or
9218 special-event-map, ...) might have switched the current buffer
9219 or the selected window from under us in the mean time. */
9220 if (fix_current_buffer
9221 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9223 Fset_buffer (XWINDOW (selected_window
)->contents
);
9224 current_binding
= active_maps (first_event
);
9228 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9232 /* Clicks in non-text areas get prefixed by the symbol
9233 in their CHAR-ADDRESS field. For example, a click on
9234 the mode line is prefixed by the symbol `mode-line'.
9236 Furthermore, key sequences beginning with mouse clicks
9237 are read using the keymaps of the buffer clicked on, not
9238 the current buffer. So we may have to switch the buffer
9241 When we turn one event into two events, we must make sure
9242 that neither of the two looks like the original--so that,
9243 if we replay the events, they won't be expanded again.
9244 If not for this, such reexpansion could happen either here
9245 or when user programs play with this-command-keys. */
9246 if (EVENT_HAS_PARAMETERS (key
))
9248 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9249 if (EQ (kind
, Qmouse_click
))
9251 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9252 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9255 || (!NILP (fake_prefixed_keys
)
9256 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9258 /* We're looking a second time at an event for which
9259 we generated a fake prefix key. Set
9260 last_real_key_start appropriately. */
9262 last_real_key_start
= t
- 1;
9265 if (last_real_key_start
== 0)
9267 /* Key sequences beginning with mouse clicks are
9268 read using the keymaps in the buffer clicked on,
9269 not the current buffer. If we're at the
9270 beginning of a key sequence, switch buffers. */
9271 if (WINDOWP (window
)
9272 && BUFFERP (XWINDOW (window
)->contents
)
9273 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9275 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9280 /* Arrange to go back to the original buffer once we're
9281 done reading the key sequence. Note that we can't
9282 use save_excursion_{save,restore} here, because they
9283 save point as well as the current buffer; we don't
9284 want to save point, because redisplay may change it,
9285 to accommodate a Fset_window_start or something. We
9286 don't want to do this at the top of the function,
9287 because we may get input from a subprocess which
9288 wants to change the selected window and stuff (say,
9290 record_unwind_current_buffer ();
9292 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9294 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9295 goto replay_sequence
;
9299 /* Expand mode-line and scroll-bar events into two events:
9300 use posn as a fake prefix key. */
9302 && (NILP (fake_prefixed_keys
)
9303 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9305 if (bufsize
- t
<= 1)
9306 error ("Key sequence too long");
9309 keybuf
[t
+ 1] = key
;
9312 /* Record that a fake prefix key has been generated
9313 for KEY. Don't modify the event; this would
9314 prevent proper action when the event is pushed
9315 back into unread-command-events. */
9316 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9320 else if (CONSP (XCDR (key
))
9321 && CONSP (EVENT_START (key
))
9322 && CONSP (XCDR (EVENT_START (key
))))
9326 posn
= POSN_POSN (EVENT_START (key
));
9327 /* Handle menu-bar events:
9328 insert the dummy prefix event `menu-bar'. */
9329 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9331 if (bufsize
- t
<= 1)
9332 error ("Key sequence too long");
9334 keybuf
[t
+ 1] = key
;
9336 /* Zap the position in key, so we know that we've
9337 expanded it, and don't try to do so again. */
9338 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9341 goto replay_sequence
;
9343 else if (CONSP (posn
))
9345 /* We're looking at the second event of a
9346 sequence which we expanded before. Set
9347 last_real_key_start appropriately. */
9348 if (last_real_key_start
== t
&& t
> 0)
9349 last_real_key_start
= t
- 1;
9354 /* We have finally decided that KEY is something we might want
9356 new_binding
= follow_key (current_binding
, key
);
9358 /* If KEY wasn't bound, we'll try some fallbacks. */
9359 if (!NILP (new_binding
))
9360 /* This is needed for the following scenario:
9361 event 0: a down-event that gets dropped by calling replay_key.
9362 event 1: some normal prefix like C-h.
9363 After event 0, first_unbound is 0, after event 1 indec.start,
9364 fkey.start, and keytran.start are all 1, so when we see that
9365 C-h is bound, we need to update first_unbound. */
9366 first_unbound
= max (t
+ 1, first_unbound
);
9371 /* Remember the position to put an upper bound on indec.start. */
9372 first_unbound
= min (t
, first_unbound
);
9374 head
= EVENT_HEAD (key
);
9378 Lisp_Object breakdown
;
9381 breakdown
= parse_modifiers (head
);
9382 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9383 /* Attempt to reduce an unbound mouse event to a simpler
9384 event that is bound:
9385 Drags reduce to clicks.
9386 Double-clicks reduce to clicks.
9387 Triple-clicks reduce to double-clicks, then to clicks.
9388 Up/Down-clicks are eliminated.
9389 Double-downs reduce to downs, then are eliminated.
9390 Triple-downs reduce to double-downs, then to downs,
9391 then are eliminated. */
9392 if (modifiers
& (up_modifier
| down_modifier
9394 | double_modifier
| triple_modifier
))
9396 while (modifiers
& (up_modifier
| down_modifier
9398 | double_modifier
| triple_modifier
))
9400 Lisp_Object new_head
, new_click
;
9401 if (modifiers
& triple_modifier
)
9402 modifiers
^= (double_modifier
| triple_modifier
);
9403 else if (modifiers
& double_modifier
)
9404 modifiers
&= ~double_modifier
;
9405 else if (modifiers
& drag_modifier
)
9406 modifiers
&= ~drag_modifier
;
9409 /* Dispose of this `up/down' event by simply jumping
9410 back to replay_key, to get another event.
9412 Note that if this event came from mock input,
9413 then just jumping back to replay_key will just
9414 hand it to us again. So we have to wipe out any
9417 We could delete keybuf[t] and shift everything
9418 after that to the left by one spot, but we'd also
9419 have to fix up any variable that points into
9420 keybuf, and shifting isn't really necessary
9423 Adding prefixes for non-textual mouse clicks
9424 creates two characters of mock input, and both
9425 must be thrown away. If we're only looking at
9426 the prefix now, we can just jump back to
9427 replay_key. On the other hand, if we've already
9428 processed the prefix, and now the actual click
9429 itself is giving us trouble, then we've lost the
9430 state of the keymaps we want to backtrack to, and
9431 we need to replay the whole sequence to rebuild
9434 Beyond that, only function key expansion could
9435 create more than two keys, but that should never
9436 generate mouse events, so it's okay to zero
9437 mock_input in that case too.
9439 FIXME: The above paragraph seems just plain
9440 wrong, if you consider things like
9441 xterm-mouse-mode. -stef
9443 Isn't this just the most wonderful code ever? */
9445 /* If mock_input > t + 1, the above simplification
9446 will actually end up dropping keys on the floor.
9447 This is probably OK for now, but even
9448 if mock_input <= t + 1, we need to adjust indec,
9450 Typical case [header-line down-mouse-N]:
9451 mock_input = 2, t = 1, fkey.end = 1,
9452 last_real_key_start = 0. */
9453 if (indec
.end
> last_real_key_start
)
9455 indec
.end
= indec
.start
9456 = min (last_real_key_start
, indec
.start
);
9457 indec
.map
= indec
.parent
;
9458 if (fkey
.end
> last_real_key_start
)
9460 fkey
.end
= fkey
.start
9461 = min (last_real_key_start
, fkey
.start
);
9462 fkey
.map
= fkey
.parent
;
9463 if (keytran
.end
> last_real_key_start
)
9465 keytran
.end
= keytran
.start
9466 = min (last_real_key_start
, keytran
.start
);
9467 keytran
.map
= keytran
.parent
;
9471 if (t
== last_real_key_start
)
9478 mock_input
= last_real_key_start
;
9479 goto replay_sequence
;
9484 = apply_modifiers (modifiers
, XCAR (breakdown
));
9485 new_click
= list2 (new_head
, EVENT_START (key
));
9487 /* Look for a binding for this new key. */
9488 new_binding
= follow_key (current_binding
, new_click
);
9490 /* If that click is bound, go for it. */
9491 if (!NILP (new_binding
))
9493 current_binding
= new_binding
;
9497 /* Otherwise, we'll leave key set to the drag event. */
9502 current_binding
= new_binding
;
9505 /* Normally, last_nonmenu_event gets the previous key we read.
9506 But when a mouse popup menu is being used,
9507 we don't update last_nonmenu_event; it continues to hold the mouse
9508 event that preceded the first level of menu. */
9509 if (!used_mouse_menu
)
9510 last_nonmenu_event
= key
;
9512 /* Record what part of this_command_keys is the current key sequence. */
9513 this_single_command_key_start
= this_command_key_count
- t
;
9514 /* When 'input-method-function' called above causes events to be
9515 put on 'unread-post-input-method-events', and as result
9516 'reread' is set to 'true', the value of 't' can become larger
9517 than 'this_command_key_count', because 'add_command_key' is
9518 not called to update 'this_command_key_count'. If this
9519 happens, 'this_single_command_key_start' will become negative
9520 above, and any call to 'this-single-command-keys' will return
9521 a garbled vector. See bug #20223 for one such situation.
9522 Here we force 'this_single_command_key_start' to never become
9523 negative, to avoid that. */
9524 if (this_single_command_key_start
< 0)
9525 this_single_command_key_start
= 0;
9527 /* Look for this sequence in input-decode-map.
9528 Scan from indec.end until we find a bound suffix. */
9529 while (indec
.end
< t
)
9534 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9538 mock_input
= diff
+ max (t
, mock_input
);
9539 goto replay_sequence
;
9543 if (!KEYMAPP (current_binding
)
9544 && !test_undefined (current_binding
)
9545 && indec
.start
>= t
)
9546 /* There is a binding and it's not a prefix.
9547 (and it doesn't have any input-decode-map translation pending).
9548 There is thus no function-key in this sequence.
9549 Moving fkey.start is important in this case to allow keytran.start
9550 to go over the sequence before we return (since we keep the
9551 invariant that keytran.end <= fkey.start). */
9554 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9557 /* If the sequence is unbound, see if we can hang a function key
9558 off the end of it. */
9559 /* Continue scan from fkey.end until we find a bound suffix. */
9560 while (fkey
.end
< indec
.start
)
9565 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9566 max (t
, mock_input
),
9567 /* If there's a binding (i.e.
9568 first_binding >= nmaps) we don't want
9569 to apply this function-key-mapping. */
9571 && (test_undefined (current_binding
)),
9575 mock_input
= diff
+ max (t
, mock_input
);
9576 /* Adjust the input-decode-map counters. */
9578 indec
.start
+= diff
;
9580 goto replay_sequence
;
9584 /* Look for this sequence in key-translation-map.
9585 Scan from keytran.end until we find a bound suffix. */
9586 while (keytran
.end
< fkey
.start
)
9591 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9595 mock_input
= diff
+ max (t
, mock_input
);
9596 /* Adjust the function-key-map and input-decode-map counters. */
9598 indec
.start
+= diff
;
9602 goto replay_sequence
;
9606 /* If KEY is not defined in any of the keymaps,
9607 and cannot be part of a function key or translation,
9608 and is an upper case letter
9609 use the corresponding lower-case letter instead. */
9610 if (NILP (current_binding
)
9611 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9613 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9614 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9615 || (XINT (key
) & shift_modifier
)))
9617 Lisp_Object new_key
;
9619 original_uppercase
= key
;
9620 original_uppercase_position
= t
- 1;
9622 if (XINT (key
) & shift_modifier
)
9623 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9625 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9626 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9628 /* We have to do this unconditionally, regardless of whether
9629 the lower-case char is defined in the keymaps, because they
9630 might get translated through function-key-map. */
9631 keybuf
[t
- 1] = new_key
;
9632 mock_input
= max (t
, mock_input
);
9633 shift_translated
= true;
9635 goto replay_sequence
;
9638 if (NILP (current_binding
)
9639 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9641 read_key_sequence_cmd
= Vprefix_help_command
;
9642 /* The Microsoft C compiler can't handle the goto that
9648 /* If KEY is not defined in any of the keymaps,
9649 and cannot be part of a function key or translation,
9650 and is a shifted function key,
9651 use the corresponding unshifted function key instead. */
9652 if (NILP (current_binding
)
9653 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9655 Lisp_Object breakdown
= parse_modifiers (key
);
9657 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9659 if (modifiers
& shift_modifier
9660 /* Treat uppercase keys as shifted. */
9662 && (KEY_TO_CHAR (key
)
9663 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9664 && uppercasep (KEY_TO_CHAR (key
))))
9667 = (modifiers
& shift_modifier
9668 ? apply_modifiers (modifiers
& ~shift_modifier
,
9670 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9672 original_uppercase
= key
;
9673 original_uppercase_position
= t
- 1;
9675 /* We have to do this unconditionally, regardless of whether
9676 the lower-case char is defined in the keymaps, because they
9677 might get translated through function-key-map. */
9678 keybuf
[t
- 1] = new_key
;
9679 mock_input
= max (t
, mock_input
);
9680 /* Reset fkey (and consequently keytran) to apply
9681 function-key-map on the result, so that S-backspace is
9682 correctly mapped to DEL (via backspace). OTOH,
9683 input-decode-map doesn't need to go through it again. */
9684 fkey
.start
= fkey
.end
= 0;
9685 keytran
.start
= keytran
.end
= 0;
9686 shift_translated
= true;
9688 goto replay_sequence
;
9693 read_key_sequence_cmd
= current_binding
;
9694 read_key_sequence_remapped
9695 /* Remap command through active keymaps.
9696 Do the remapping here, before the unbind_to so it uses the keymaps
9697 of the appropriate buffer. */
9698 = SYMBOLP (read_key_sequence_cmd
)
9699 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9702 unread_switch_frame
= delayed_switch_frame
;
9703 unbind_to (count
, Qnil
);
9705 /* Don't downcase the last character if the caller says don't.
9706 Don't downcase it if the result is undefined, either. */
9707 if ((dont_downcase_last
|| NILP (current_binding
))
9709 && t
- 1 == original_uppercase_position
)
9711 keybuf
[t
- 1] = original_uppercase
;
9712 shift_translated
= false;
9715 if (shift_translated
)
9716 Vthis_command_keys_shift_translated
= Qt
;
9718 /* Occasionally we fabricate events, perhaps by expanding something
9719 according to function-key-map, or by adding a prefix symbol to a
9720 mouse click in the scroll bar or modeline. In this cases, return
9721 the entire generated key sequence, even if we hit an unbound
9722 prefix or a definition before the end. This means that you will
9723 be able to push back the event properly, and also means that
9724 read-key-sequence will always return a logical unit.
9727 for (; t
< mock_input
; t
++)
9728 add_command_key (keybuf
[t
]);
9735 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9736 Lisp_Object dont_downcase_last
,
9737 Lisp_Object can_return_switch_frame
,
9738 Lisp_Object cmd_loop
, bool allow_string
)
9740 Lisp_Object keybuf
[30];
9742 ptrdiff_t count
= SPECPDL_INDEX ();
9745 CHECK_STRING (prompt
);
9748 specbind (Qinput_method_exit_on_first_char
,
9749 (NILP (cmd_loop
) ? Qt
: Qnil
));
9750 specbind (Qinput_method_use_echo_area
,
9751 (NILP (cmd_loop
) ? Qt
: Qnil
));
9753 if (NILP (continue_echo
))
9755 this_command_key_count
= 0;
9756 this_single_command_key_start
= 0;
9759 #ifdef HAVE_WINDOW_SYSTEM
9760 if (display_hourglass_p
)
9761 cancel_hourglass ();
9764 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9765 prompt
, ! NILP (dont_downcase_last
),
9766 ! NILP (can_return_switch_frame
), 0, 0);
9768 #if 0 /* The following is fine for code reading a key sequence and
9769 then proceeding with a lengthy computation, but it's not good
9770 for code reading keys in a loop, like an input method. */
9771 #ifdef HAVE_WINDOW_SYSTEM
9772 if (display_hourglass_p
)
9783 return unbind_to (count
,
9784 ((allow_string
? make_event_array
: Fvector
)
9788 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9789 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9790 The sequence is sufficient to specify a non-prefix command in the
9791 current local and global maps.
9793 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9794 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9795 as a continuation of the previous key.
9797 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9798 convert the last event to lower case. (Normally any upper case event
9799 is converted to lower case if the original event is undefined and the lower
9800 case equivalent is defined.) A non-nil value is appropriate for reading
9801 a key sequence to be defined.
9803 A C-g typed while in this function is treated like any other character,
9804 and `quit-flag' is not set.
9806 If the key sequence starts with a mouse click, then the sequence is read
9807 using the keymaps of the buffer of the window clicked in, not the buffer
9808 of the selected window as normal.
9810 `read-key-sequence' drops unbound button-down events, since you normally
9811 only care about the click or drag events which follow them. If a drag
9812 or multi-click event is unbound, but the corresponding click event would
9813 be bound, `read-key-sequence' turns the event into a click event at the
9814 drag's starting position. This means that you don't have to distinguish
9815 between click and drag, double, or triple events unless you want to.
9817 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9818 lines separating windows, and scroll bars with imaginary keys
9819 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9821 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9822 function will process a switch-frame event if the user switches frames
9823 before typing anything. If the user switches frames in the middle of a
9824 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9825 is nil, then the event will be put off until after the current key sequence.
9827 `read-key-sequence' checks `function-key-map' for function key
9828 sequences, where they wouldn't conflict with ordinary bindings. See
9829 `function-key-map' for more details.
9831 The optional fifth argument CMD-LOOP, if non-nil, means
9832 that this key sequence is being read by something that will
9833 read commands one after another. It should be nil if the caller
9834 will read just one key sequence. */)
9835 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9837 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9838 can_return_switch_frame
, cmd_loop
, true);
9841 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9842 Sread_key_sequence_vector
, 1, 5, 0,
9843 doc
: /* Like `read-key-sequence' but always return a vector. */)
9844 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9846 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9847 can_return_switch_frame
, cmd_loop
, false);
9850 /* Return true if input events are pending. */
9853 detect_input_pending (void)
9855 return input_pending
|| get_input_pending (0);
9858 /* Return true if input events other than mouse movements are
9862 detect_input_pending_ignore_squeezables (void)
9864 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9867 /* Return true if input events are pending, and run any pending timers. */
9870 detect_input_pending_run_timers (bool do_display
)
9872 unsigned old_timers_run
= timers_run
;
9875 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9877 if (old_timers_run
!= timers_run
&& do_display
)
9878 redisplay_preserve_echo_area (8);
9880 return input_pending
;
9883 /* This is called in some cases before a possible quit.
9884 It cases the next call to detect_input_pending to recompute input_pending.
9885 So calling this function unnecessarily can't do any harm. */
9888 clear_input_pending (void)
9890 input_pending
= false;
9893 /* Return true if there are pending requeued events.
9894 This isn't used yet. The hope is to make wait_reading_process_output
9895 call it, and return if it runs Lisp code that unreads something.
9896 The problem is, kbd_buffer_get_event needs to be fixed to know what
9897 to do in that case. It isn't trivial. */
9900 requeued_events_pending_p (void)
9902 return (CONSP (Vunread_command_events
));
9905 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9906 doc
: /* Return t if command input is currently available with no wait.
9907 Actually, the value is nil only if we can be sure that no input is available;
9908 if there is a doubt, the value is t.
9910 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9911 (Lisp_Object check_timers
)
9913 if (CONSP (Vunread_command_events
)
9914 || !NILP (Vunread_post_input_method_events
)
9915 || !NILP (Vunread_input_method_events
))
9918 /* Process non-user-visible events (Bug#10195). */
9919 process_special_events ();
9921 return (get_input_pending ((NILP (check_timers
)
9922 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9923 | READABLE_EVENTS_FILTER_EVENTS
)
9927 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
9928 doc
: /* Return vector of last few events, not counting those from keyboard macros.
9929 If INCLUDE-CMDS is non-nil, include the commands that were run,
9930 represented as events of the form (nil . COMMAND). */)
9931 (Lisp_Object include_cmds
)
9933 bool cmds
= !NILP (include_cmds
);
9936 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
9937 return Fvector (total_keys
,
9938 XVECTOR (recent_keys
)->contents
);
9941 Lisp_Object es
= Qnil
;
9942 int i
= (total_keys
< NUM_RECENT_KEYS
9943 ? 0 : recent_keys_index
);
9944 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
9947 Lisp_Object e
= AREF (recent_keys
, i
);
9948 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
9950 if (++i
>= NUM_RECENT_KEYS
)
9952 } while (i
!= recent_keys_index
);
9953 es
= Fnreverse (es
);
9954 return Fvconcat (1, &es
);
9958 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9959 doc
: /* Return the key sequence that invoked this command.
9960 However, if the command has called `read-key-sequence', it returns
9961 the last key sequence that has been read.
9962 The value is a string or a vector.
9964 See also `this-command-keys-vector'. */)
9967 return make_event_array (this_command_key_count
,
9968 XVECTOR (this_command_keys
)->contents
);
9971 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9972 doc
: /* Return the key sequence that invoked this command, as a vector.
9973 However, if the command has called `read-key-sequence', it returns
9974 the last key sequence that has been read.
9976 See also `this-command-keys'. */)
9979 return Fvector (this_command_key_count
,
9980 XVECTOR (this_command_keys
)->contents
);
9983 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9984 Sthis_single_command_keys
, 0, 0, 0,
9985 doc
: /* Return the key sequence that invoked this command.
9986 More generally, it returns the last key sequence read, either by
9987 the command loop or by `read-key-sequence'.
9988 Unlike `this-command-keys', this function's value
9989 does not include prefix arguments.
9990 The value is always a vector. */)
9993 return Fvector (this_command_key_count
9994 - this_single_command_key_start
,
9995 (XVECTOR (this_command_keys
)->contents
9996 + this_single_command_key_start
));
9999 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10000 Sthis_single_command_raw_keys
, 0, 0, 0,
10001 doc
: /* Return the raw events that were read for this command.
10002 More generally, it returns the last key sequence read, either by
10003 the command loop or by `read-key-sequence'.
10004 Unlike `this-single-command-keys', this function's value
10005 shows the events before all translations (except for input methods).
10006 The value is always a vector. */)
10009 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10012 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10013 Sclear_this_command_keys
, 0, 1, 0,
10014 doc
: /* Clear out the vector that `this-command-keys' returns.
10015 Also clear the record of the last 100 events, unless optional arg
10016 KEEP-RECORD is non-nil. */)
10017 (Lisp_Object keep_record
)
10021 this_command_key_count
= 0;
10023 if (NILP (keep_record
))
10025 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10026 ASET (recent_keys
, i
, Qnil
);
10028 recent_keys_index
= 0;
10033 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10034 doc
: /* Return the current depth in recursive edits. */)
10038 /* Wrap around reliably on integer overflow. */
10039 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10040 XSETINT (temp
, sum
);
10044 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10045 "FOpen dribble file: ",
10046 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10047 If FILE is nil, close any open dribble file.
10048 The file will be closed when Emacs exits.
10050 Be aware that this records ALL characters you type!
10051 This may include sensitive information such as passwords. */)
10064 Lisp_Object encfile
;
10066 file
= Fexpand_file_name (file
, Qnil
);
10067 encfile
= ENCODE_FILE (file
);
10068 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10069 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10070 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10071 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10073 report_file_error ("Opening dribble", file
);
10078 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10079 doc
: /* Discard the contents of the terminal input buffer.
10080 Also end any kbd macro being defined. */)
10083 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10085 /* Discard the last command from the macro. */
10086 Fcancel_kbd_macro_events ();
10090 Vunread_command_events
= Qnil
;
10092 discard_tty_input ();
10094 kbd_fetch_ptr
= kbd_store_ptr
;
10095 input_pending
= false;
10100 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10101 doc
: /* Stop Emacs and return to superior process. You can resume later.
10102 If `cannot-suspend' is non-nil, or if the system doesn't support job
10103 control, run a subshell instead.
10105 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10106 to be read as terminal input by Emacs's parent, after suspension.
10108 Before suspending, run the normal hook `suspend-hook'.
10109 After resumption run the normal hook `suspend-resume-hook'.
10111 Some operating systems cannot stop the Emacs process and resume it later.
10112 On such systems, Emacs starts a subshell instead of suspending. */)
10113 (Lisp_Object stuffstring
)
10115 ptrdiff_t count
= SPECPDL_INDEX ();
10116 int old_height
, old_width
;
10119 if (tty_list
&& tty_list
->next
)
10120 error ("There are other tty frames open; close them before suspending Emacs");
10122 if (!NILP (stuffstring
))
10123 CHECK_STRING (stuffstring
);
10125 run_hook (intern ("suspend-hook"));
10127 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10128 reset_all_sys_modes ();
10129 /* sys_suspend can get an error if it tries to fork a subshell
10130 and the system resources aren't available for that. */
10131 record_unwind_protect_void (init_all_sys_modes
);
10132 stuff_buffered_input (stuffstring
);
10133 if (cannot_suspend
)
10137 unbind_to (count
, Qnil
);
10139 /* Check if terminal/window size has changed.
10140 Note that this is not useful when we are running directly
10141 with a window system; but suspend should be disabled in that case. */
10142 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10143 if (width
!= old_width
|| height
!= old_height
)
10144 change_frame_size (SELECTED_FRAME (), width
,
10145 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10148 run_hook (intern ("suspend-resume-hook"));
10153 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10154 Then in any case stuff anything Emacs has read ahead and not used. */
10157 stuff_buffered_input (Lisp_Object stuffstring
)
10159 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10160 register unsigned char *p
;
10162 if (STRINGP (stuffstring
))
10164 register ptrdiff_t count
;
10166 p
= SDATA (stuffstring
);
10167 count
= SBYTES (stuffstring
);
10168 while (count
-- > 0)
10173 /* Anything we have read ahead, put back for the shell to read. */
10174 /* ?? What should this do when we have multiple keyboards??
10175 Should we ignore anything that was typed in at the "wrong" kboard?
10177 rms: we should stuff everything back into the kboard
10179 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10182 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10183 kbd_fetch_ptr
= kbd_buffer
;
10184 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10185 stuff_char (kbd_fetch_ptr
->ie
.code
);
10187 clear_event (kbd_fetch_ptr
);
10190 input_pending
= false;
10191 #endif /* SIGTSTP */
10195 set_waiting_for_input (struct timespec
*time_to_clear
)
10197 input_available_clear_time
= time_to_clear
;
10199 /* Tell handle_interrupt to throw back to read_char, */
10200 waiting_for_input
= true;
10202 /* If handle_interrupt was called before and buffered a C-g,
10203 make it run again now, to avoid timing error. */
10204 if (!NILP (Vquit_flag
))
10205 quit_throw_to_read_char (0);
10209 clear_waiting_for_input (void)
10211 /* Tell handle_interrupt not to throw back to read_char, */
10212 waiting_for_input
= false;
10213 input_available_clear_time
= 0;
10216 /* The SIGINT handler.
10218 If we have a frame on the controlling tty, we assume that the
10219 SIGINT was generated by C-g, so we call handle_interrupt.
10220 Otherwise, tell QUIT to kill Emacs. */
10223 handle_interrupt_signal (int sig
)
10225 /* See if we have an active terminal on our controlling tty. */
10226 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10229 /* If there are no frames there, let's pretend that we are a
10230 well-behaving UN*X program and quit. We must not call Lisp
10231 in a signal handler, so tell QUIT to exit when it is
10233 Vquit_flag
= Qkill_emacs
;
10237 /* Otherwise, the SIGINT was probably generated by C-g. */
10239 /* Set internal_last_event_frame to the top frame of the
10240 controlling tty, if we have a frame there. We disable the
10241 interrupt key on secondary ttys, so the SIGINT must have come
10242 from the controlling tty. */
10243 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10245 handle_interrupt (1);
10250 deliver_interrupt_signal (int sig
)
10252 deliver_process_signal (sig
, handle_interrupt_signal
);
10255 /* Output MSG directly to standard output, without buffering. Ignore
10256 failures. This is safe in a signal handler. */
10258 write_stdout (char const *msg
)
10260 ignore_value (write (STDOUT_FILENO
, msg
, strlen (msg
)));
10263 /* Read a byte from stdin, without buffering. Safe in signal handlers. */
10268 return read (STDIN_FILENO
, &c
, 1) == 1 ? c
: EOF
;
10271 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10272 of the number of times C-g has been requested. If C-g is pressed
10273 enough times, then quit anyway. See bug#6585. */
10274 static int volatile force_quit_count
;
10276 /* This routine is called at interrupt level in response to C-g.
10278 It is called from the SIGINT handler or kbd_buffer_store_event.
10280 If `waiting_for_input' is non zero, then unless `echoing' is
10281 nonzero, immediately throw back to read_char.
10283 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10284 eval to throw, when it gets a chance. If quit-flag is already
10285 non-nil, it stops the job right away. */
10288 handle_interrupt (bool in_signal_handler
)
10294 /* XXX This code needs to be revised for multi-tty support. */
10295 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10297 if (! in_signal_handler
)
10299 /* If SIGINT isn't blocked, don't let us be interrupted by
10300 a SIGINT. It might be harmful due to non-reentrancy
10301 in I/O functions. */
10303 sigemptyset (&blocked
);
10304 sigaddset (&blocked
, SIGINT
);
10305 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10309 reset_all_sys_modes ();
10313 * On systems which can suspend the current process and return to the original
10314 * shell, this command causes the user to end up back at the shell.
10315 * The "Auto-save" and "Abort" questions are not asked until
10316 * the user elects to return to emacs, at which point he can save the current
10317 * job and either dump core or continue.
10321 /* Perhaps should really fork an inferior shell?
10322 But that would not provide any way to get back
10323 to the original shell, ever. */
10324 write_stdout ("No support for stopping a process"
10325 " on this operating system;\n"
10326 "you can continue or abort.\n");
10327 #endif /* not SIGTSTP */
10329 /* We must remain inside the screen area when the internal terminal
10330 is used. Note that [Enter] is not echoed by dos. */
10331 cursor_to (SELECTED_FRAME (), 0, 0);
10334 write_stdout ("Emacs is resuming after an emergency escape.\n");
10336 /* It doesn't work to autosave while GC is in progress;
10337 the code used for auto-saving doesn't cope with the mark bit. */
10338 if (!gc_in_progress
)
10340 write_stdout ("Auto-save? (y or n) ");
10342 if (c
== 'y' || c
== 'Y')
10344 Fdo_auto_save (Qt
, Qnil
);
10346 write_stdout ("\r\nAuto-save done");
10348 write_stdout ("Auto-save done\n");
10356 /* During GC, it must be safe to reenable quitting again. */
10357 Vinhibit_quit
= Qnil
;
10363 "Garbage collection in progress; cannot auto-save now\r\n"
10364 "but will instead do a real quit"
10365 " after garbage collection ends\r\n");
10369 write_stdout ("\r\nAbort? (y or n) ");
10371 write_stdout ("Abort (and dump core)? (y or n) ");
10374 if (c
== 'y' || c
== 'Y')
10379 write_stdout ("\r\nContinuing...\r\n");
10380 #else /* not MSDOS */
10381 write_stdout ("Continuing...\n");
10382 #endif /* not MSDOS */
10383 init_all_sys_modes ();
10387 /* If executing a function that wants to be interrupted out of
10388 and the user has not deferred quitting by binding `inhibit-quit'
10389 then quit right away. */
10390 if (immediate_quit
&& NILP (Vinhibit_quit
))
10392 struct gl_state_s saved
;
10394 immediate_quit
= false;
10395 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10397 Fsignal (Qquit
, Qnil
);
10401 { /* Else request quit when it's safe. */
10402 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10403 force_quit_count
= count
;
10406 immediate_quit
= true;
10407 Vinhibit_quit
= Qnil
;
10413 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10415 /* TODO: The longjmp in this call throws the NS event loop integration off,
10416 and it seems to do fine without this. Probably some attention
10417 needs to be paid to the setting of waiting_for_input in
10418 wait_reading_process_output() under HAVE_NS because of the call
10419 to ns_select there (needed because otherwise events aren't picked up
10420 outside of polling since we don't get SIGIO like X and we don't have a
10421 separate event loop thread like W32. */
10423 if (waiting_for_input
&& !echoing
)
10424 quit_throw_to_read_char (in_signal_handler
);
10428 /* Handle a C-g by making read_char return C-g. */
10431 quit_throw_to_read_char (bool from_signal
)
10433 /* When not called from a signal handler it is safe to call
10435 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10436 Fkill_emacs (Qnil
);
10438 /* Prevent another signal from doing this before we finish. */
10439 clear_waiting_for_input ();
10440 input_pending
= false;
10442 Vunread_command_events
= Qnil
;
10444 if (FRAMEP (internal_last_event_frame
)
10445 && !EQ (internal_last_event_frame
, selected_frame
))
10446 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10449 sys_longjmp (getcjmp
, 1);
10452 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10453 Sset_input_interrupt_mode
, 1, 1, 0,
10454 doc
: /* Set interrupt mode of reading keyboard input.
10455 If INTERRUPT is non-nil, Emacs will use input interrupts;
10456 otherwise Emacs uses CBREAK mode.
10458 See also `current-input-mode'. */)
10459 (Lisp_Object interrupt
)
10461 bool new_interrupt_input
;
10462 #ifdef USABLE_SIGIO
10463 #ifdef HAVE_X_WINDOWS
10464 if (x_display_list
!= NULL
)
10466 /* When using X, don't give the user a real choice,
10467 because we haven't implemented the mechanisms to support it. */
10468 new_interrupt_input
= true;
10471 #endif /* HAVE_X_WINDOWS */
10472 new_interrupt_input
= !NILP (interrupt
);
10473 #else /* not USABLE_SIGIO */
10474 new_interrupt_input
= false;
10475 #endif /* not USABLE_SIGIO */
10477 if (new_interrupt_input
!= interrupt_input
)
10479 #ifdef POLL_FOR_INPUT
10483 /* this causes startup screen to be restored and messes with the mouse */
10484 reset_all_sys_modes ();
10485 interrupt_input
= new_interrupt_input
;
10486 init_all_sys_modes ();
10488 interrupt_input
= new_interrupt_input
;
10491 #ifdef POLL_FOR_INPUT
10492 poll_suppress_count
= 1;
10499 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10500 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10501 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10502 C-q in key sequences.
10504 This setting only has an effect on tty terminals and only when
10505 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10507 See also `current-input-mode'. */)
10508 (Lisp_Object flow
, Lisp_Object terminal
)
10510 struct terminal
*t
= decode_tty_terminal (terminal
);
10511 struct tty_display_info
*tty
;
10515 tty
= t
->display_info
.tty
;
10517 if (tty
->flow_control
!= !NILP (flow
))
10520 /* This causes startup screen to be restored and messes with the mouse. */
10521 reset_sys_modes (tty
);
10524 tty
->flow_control
= !NILP (flow
);
10527 init_sys_modes (tty
);
10533 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10534 doc
: /* Enable or disable 8-bit input on TERMINAL.
10535 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10536 bit as the Meta modifier.
10538 If META is nil, Emacs will ignore the top bit, on the assumption it is
10541 Otherwise, Emacs will accept and pass through 8-bit input without
10542 specially interpreting the top bit.
10544 This setting only has an effect on tty terminal devices.
10546 Optional parameter TERMINAL specifies the tty terminal device to use.
10547 It may be a terminal object, a frame, or nil for the terminal used by
10548 the currently selected frame.
10550 See also `current-input-mode'. */)
10551 (Lisp_Object meta
, Lisp_Object terminal
)
10553 struct terminal
*t
= decode_tty_terminal (terminal
);
10554 struct tty_display_info
*tty
;
10559 tty
= t
->display_info
.tty
;
10563 else if (EQ (meta
, Qt
))
10568 if (tty
->meta_key
!= new_meta
)
10571 /* this causes startup screen to be restored and messes with the mouse */
10572 reset_sys_modes (tty
);
10575 tty
->meta_key
= new_meta
;
10578 init_sys_modes (tty
);
10584 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10585 doc
: /* Specify character used for quitting.
10586 QUIT must be an ASCII character.
10588 This function only has an effect on the controlling tty of the Emacs
10591 See also `current-input-mode'. */)
10594 struct terminal
*t
= get_named_terminal ("/dev/tty");
10595 struct tty_display_info
*tty
;
10599 tty
= t
->display_info
.tty
;
10601 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10602 error ("QUIT must be an ASCII character");
10605 /* this causes startup screen to be restored and messes with the mouse */
10606 reset_sys_modes (tty
);
10609 /* Don't let this value be out of range. */
10610 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10613 init_sys_modes (tty
);
10619 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10620 doc
: /* Set mode of reading keyboard input.
10621 First arg INTERRUPT non-nil means use input interrupts;
10622 nil means use CBREAK mode.
10623 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10624 (no effect except in CBREAK mode).
10625 Third arg META t means accept 8-bit input (for a Meta key).
10626 META nil means ignore the top bit, on the assumption it is parity.
10627 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10628 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10629 See also `current-input-mode'. */)
10630 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10632 Fset_input_interrupt_mode (interrupt
);
10633 Fset_output_flow_control (flow
, Qnil
);
10634 Fset_input_meta_mode (meta
, Qnil
);
10636 Fset_quit_char (quit
);
10640 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10641 doc
: /* Return information about the way Emacs currently reads keyboard input.
10642 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10643 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10644 nil, Emacs is using CBREAK mode.
10645 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10646 terminal; this does not apply if Emacs uses interrupt-driven input.
10647 META is t if accepting 8-bit input with 8th bit as Meta flag.
10648 META nil means ignoring the top bit, on the assumption it is parity.
10649 META is neither t nor nil if accepting 8-bit input and using
10650 all 8 bits as the character code.
10651 QUIT is the character Emacs currently uses to quit.
10652 The elements of this list correspond to the arguments of
10653 `set-input-mode'. */)
10656 struct frame
*sf
= XFRAME (selected_frame
);
10658 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10659 Lisp_Object flow
, meta
;
10660 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10662 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10663 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10665 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10672 Lisp_Object quit
= make_number (quit_char
);
10674 return list4 (interrupt
, flow
, meta
, quit
);
10677 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10678 doc
: /* Return position information for pixel coordinates X and Y.
10679 By default, X and Y are relative to text area of the selected window.
10680 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10681 If optional fourth arg WHOLE is non-nil, X is relative to the left
10682 edge of the window.
10684 The return value is similar to a mouse click position:
10685 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10686 IMAGE (DX . DY) (WIDTH . HEIGHT))
10687 The `posn-' functions access elements of such lists. */)
10688 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10691 /* We allow X of -1, for the newline in a R2L line that overflowed
10692 into the left fringe. */
10693 if (XINT (x
) != -1)
10697 if (NILP (frame_or_window
))
10698 frame_or_window
= selected_window
;
10700 if (WINDOWP (frame_or_window
))
10702 struct window
*w
= decode_live_window (frame_or_window
);
10704 XSETINT (x
, (XINT (x
)
10705 + WINDOW_LEFT_EDGE_X (w
)
10707 ? window_box_left_offset (w
, TEXT_AREA
)
10709 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10710 frame_or_window
= w
->frame
;
10713 CHECK_LIVE_FRAME (frame_or_window
);
10715 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10718 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10719 doc
: /* Return position information for buffer POS in WINDOW.
10720 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10722 Return nil if position is not visible in window. Otherwise,
10723 the return value is similar to that returned by `event-start' for
10724 a mouse click at the upper left corner of the glyph corresponding
10725 to the given buffer position:
10726 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10727 IMAGE (DX . DY) (WIDTH . HEIGHT))
10728 The `posn-' functions access elements of such lists. */)
10729 (Lisp_Object pos
, Lisp_Object window
)
10734 window
= selected_window
;
10736 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10739 Lisp_Object x
= XCAR (tem
);
10740 Lisp_Object y
= XCAR (XCDR (tem
));
10742 /* Point invisible due to hscrolling? X can be -1 when a
10743 newline in a R2L line overflows into the left fringe. */
10746 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10752 /* Set up a new kboard object with reasonable initial values.
10753 TYPE is a window system for which this keyboard is used. */
10756 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10758 kset_overriding_terminal_local_map (kb
, Qnil
);
10759 kset_last_command (kb
, Qnil
);
10760 kset_real_last_command (kb
, Qnil
);
10761 kset_keyboard_translate_table (kb
, Qnil
);
10762 kset_last_repeatable_command (kb
, Qnil
);
10763 kset_prefix_arg (kb
, Qnil
);
10764 kset_last_prefix_arg (kb
, Qnil
);
10765 kset_kbd_queue (kb
, Qnil
);
10766 kb
->kbd_queue_has_data
= false;
10767 kb
->immediate_echo
= false;
10768 kset_echo_string (kb
, Qnil
);
10769 kset_echo_prompt (kb
, Qnil
);
10770 kb
->kbd_macro_buffer
= 0;
10771 kb
->kbd_macro_bufsize
= 0;
10772 kset_defining_kbd_macro (kb
, Qnil
);
10773 kset_last_kbd_macro (kb
, Qnil
);
10774 kb
->reference_count
= 0;
10775 kset_system_key_alist (kb
, Qnil
);
10776 kset_system_key_syms (kb
, Qnil
);
10777 kset_window_system (kb
, type
);
10778 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10779 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10780 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10781 kset_default_minibuffer_frame (kb
, Qnil
);
10784 /* Allocate and basically initialize keyboard
10785 object to use with window system TYPE. */
10788 allocate_kboard (Lisp_Object type
)
10790 KBOARD
*kb
= xmalloc (sizeof *kb
);
10792 init_kboard (kb
, type
);
10793 kb
->next_kboard
= all_kboards
;
10799 * Destroy the contents of a kboard object, but not the object itself.
10800 * We use this just before deleting it, or if we're going to initialize
10801 * it a second time.
10804 wipe_kboard (KBOARD
*kb
)
10806 xfree (kb
->kbd_macro_buffer
);
10809 /* Free KB and memory referenced from it. */
10812 delete_kboard (KBOARD
*kb
)
10816 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10819 *kbp
= kb
->next_kboard
;
10821 /* Prevent a dangling reference to KB. */
10822 if (kb
== current_kboard
10823 && FRAMEP (selected_frame
)
10824 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10826 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10827 single_kboard
= false;
10828 if (current_kboard
== kb
)
10837 init_keyboard (void)
10839 /* This is correct before outermost invocation of the editor loop. */
10840 command_loop_level
= -1;
10841 immediate_quit
= false;
10842 quit_char
= Ctl ('g');
10843 Vunread_command_events
= Qnil
;
10844 timer_idleness_start_time
= invalid_timespec ();
10846 recent_keys_index
= 0;
10847 kbd_fetch_ptr
= kbd_buffer
;
10848 kbd_store_ptr
= kbd_buffer
;
10849 do_mouse_tracking
= Qnil
;
10850 input_pending
= false;
10851 interrupt_input_blocked
= 0;
10852 pending_signals
= false;
10854 /* This means that command_loop_1 won't try to select anything the first
10856 internal_last_event_frame
= Qnil
;
10857 Vlast_event_frame
= internal_last_event_frame
;
10859 current_kboard
= initial_kboard
;
10860 /* Re-initialize the keyboard again. */
10861 wipe_kboard (current_kboard
);
10862 /* A value of nil for Vwindow_system normally means a tty, but we also use
10863 it for the initial terminal since there is no window system there. */
10864 init_kboard (current_kboard
, Qnil
);
10866 if (!noninteractive
)
10868 /* Before multi-tty support, these handlers used to be installed
10869 only if the current session was a tty session. Now an Emacs
10870 session may have multiple display types, so we always handle
10871 SIGINT. There is special code in handle_interrupt_signal to exit
10872 Emacs on SIGINT when there are no termcap frames on the
10873 controlling terminal. */
10874 struct sigaction action
;
10875 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10876 sigaction (SIGINT
, &action
, 0);
10878 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10879 SIGQUIT and we can't tell which one it will give us. */
10880 sigaction (SIGQUIT
, &action
, 0);
10881 #endif /* not DOS_NT */
10883 #ifdef USABLE_SIGIO
10884 if (!noninteractive
)
10886 struct sigaction action
;
10887 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10888 sigaction (SIGIO
, &action
, 0);
10892 /* Use interrupt input by default, if it works and noninterrupt input
10893 has deficiencies. */
10895 #ifdef INTERRUPT_INPUT
10896 interrupt_input
= 1;
10898 interrupt_input
= 0;
10901 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10904 if (keyboard_init_hook
)
10905 (*keyboard_init_hook
) ();
10907 #ifdef POLL_FOR_INPUT
10909 poll_suppress_count
= 1;
10914 /* This type's only use is in syms_of_keyboard, to put properties on the
10915 event header symbols. */
10922 static const struct event_head head_table
[] = {
10923 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10924 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10926 /* Some of the event heads. */
10927 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
10929 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
10930 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
10931 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
10932 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
10933 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
10934 /* `select-window' should be handled just like `switch-frame'
10935 in read_key_sequence. */
10936 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
10940 syms_of_keyboard (void)
10942 pending_funcalls
= Qnil
;
10943 staticpro (&pending_funcalls
);
10945 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10946 staticpro (&Vlispy_mouse_stem
);
10948 regular_top_level_message
= build_pure_c_string ("Back to top level");
10949 #ifdef HAVE_STACK_OVERFLOW_HANDLING
10950 recover_top_level_message
10951 = build_pure_c_string ("Re-entering top level after C stack overflow");
10953 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
10954 doc
: /* Message displayed by `normal-top-level'. */);
10955 Vinternal__top_level_message
= regular_top_level_message
;
10958 DEFSYM (QCimage
, ":image");
10959 DEFSYM (Qhelp_echo
, "help-echo");
10960 DEFSYM (QCrtl
, ":rtl");
10962 staticpro (&item_properties
);
10963 item_properties
= Qnil
;
10965 staticpro (&tool_bar_item_properties
);
10966 tool_bar_item_properties
= Qnil
;
10967 staticpro (&tool_bar_items_vector
);
10968 tool_bar_items_vector
= Qnil
;
10970 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10972 /* Non-nil disable property on a command means do not execute it;
10973 call disabled-command-function's value instead. */
10974 DEFSYM (Qdisabled
, "disabled");
10976 DEFSYM (Qundefined
, "undefined");
10978 /* Hooks to run before and after each command. */
10979 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10980 DEFSYM (Qpost_command_hook
, "post-command-hook");
10982 DEFSYM (Qundo_auto__add_boundary
, "undo-auto--add-boundary");
10984 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10985 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10986 DEFSYM (Qfunction_key
, "function-key");
10988 /* The values of Qevent_kind properties. */
10989 DEFSYM (Qmouse_click
, "mouse-click");
10991 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10992 DEFSYM (Qsave_session
, "save-session");
10993 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10995 /* Menu and tool bar item parts. */
10996 DEFSYM (Qmenu_enable
, "menu-enable");
10999 DEFSYM (Qlanguage_change
, "language-change");
11000 DEFSYM (Qend_session
, "end-session");
11004 DEFSYM (Qdbus_event
, "dbus-event");
11007 #ifdef HAVE_XWIDGETS
11008 DEFSYM (Qxwidget_event
, "xwidget-event");
11011 #ifdef USE_FILE_NOTIFY
11012 DEFSYM (Qfile_notify
, "file-notify");
11013 #endif /* USE_FILE_NOTIFY */
11015 /* Menu and tool bar item parts. */
11016 DEFSYM (QCenable
, ":enable");
11017 DEFSYM (QCvisible
, ":visible");
11018 DEFSYM (QChelp
, ":help");
11019 DEFSYM (QCfilter
, ":filter");
11020 DEFSYM (QCbutton
, ":button");
11021 DEFSYM (QCkeys
, ":keys");
11022 DEFSYM (QCkey_sequence
, ":key-sequence");
11024 /* Non-nil disable property on a command means
11025 do not execute it; call disabled-command-function's value instead. */
11026 DEFSYM (QCtoggle
, ":toggle");
11027 DEFSYM (QCradio
, ":radio");
11028 DEFSYM (QClabel
, ":label");
11029 DEFSYM (QCvert_only
, ":vert-only");
11031 /* Symbols to use for parts of windows. */
11032 DEFSYM (Qvertical_line
, "vertical-line");
11033 DEFSYM (Qright_divider
, "right-divider");
11034 DEFSYM (Qbottom_divider
, "bottom-divider");
11036 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11038 DEFSYM (Qabove_handle
, "above-handle");
11039 DEFSYM (Qhandle
, "handle");
11040 DEFSYM (Qbelow_handle
, "below-handle");
11041 DEFSYM (Qup
, "up");
11042 DEFSYM (Qdown
, "down");
11043 DEFSYM (Qtop
, "top");
11044 DEFSYM (Qbottom
, "bottom");
11045 DEFSYM (Qend_scroll
, "end-scroll");
11046 DEFSYM (Qratio
, "ratio");
11047 DEFSYM (Qbefore_handle
, "before-handle");
11048 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11049 DEFSYM (Qafter_handle
, "after-handle");
11050 DEFSYM (Qleft
, "left");
11051 DEFSYM (Qright
, "right");
11052 DEFSYM (Qleftmost
, "leftmost");
11053 DEFSYM (Qrightmost
, "rightmost");
11055 /* Properties of event headers. */
11056 DEFSYM (Qevent_kind
, "event-kind");
11057 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11059 /* An event header symbol HEAD may have a property named
11060 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11061 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11062 mask of modifiers applied to it. If present, this is used to help
11063 speed up parse_modifiers. */
11064 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11066 /* An unmodified event header BASE may have a property named
11067 Qmodifier_cache, which is an alist mapping modifier masks onto
11068 modified versions of BASE. If present, this helps speed up
11069 apply_modifiers. */
11070 DEFSYM (Qmodifier_cache
, "modifier-cache");
11072 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11073 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11075 DEFSYM (Qpolling_period
, "polling-period");
11077 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11079 /* The primary selection. */
11080 DEFSYM (QPRIMARY
, "PRIMARY");
11082 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11083 DEFSYM (Qhandle_select_window
, "handle-select-window");
11085 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11086 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11088 DEFSYM (Qhelp_form_show
, "help-form-show");
11090 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11092 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11093 Fset (Qinput_method_use_echo_area
, Qnil
);
11095 /* Symbols to head events. */
11096 DEFSYM (Qmouse_movement
, "mouse-movement");
11097 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11098 DEFSYM (Qswitch_frame
, "switch-frame");
11099 DEFSYM (Qfocus_in
, "focus-in");
11100 DEFSYM (Qfocus_out
, "focus-out");
11101 DEFSYM (Qdelete_frame
, "delete-frame");
11102 DEFSYM (Qiconify_frame
, "iconify-frame");
11103 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11104 DEFSYM (Qselect_window
, "select-window");
11108 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11110 const struct event_head
*p
= &head_table
[i
];
11111 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11112 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11113 Fput (var
, Qevent_kind
, kind
);
11114 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11118 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11119 staticpro (&button_down_location
);
11120 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11121 staticpro (&mouse_syms
);
11122 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11124 staticpro (&wheel_syms
);
11128 int len
= ARRAYELTS (modifier_names
);
11130 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11131 for (i
= 0; i
< len
; i
++)
11132 if (modifier_names
[i
])
11133 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11134 staticpro (&modifier_symbols
);
11137 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11138 staticpro (&recent_keys
);
11140 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11141 staticpro (&this_command_keys
);
11143 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11144 staticpro (&raw_keybuf
);
11146 DEFSYM (Qcommand_execute
, "command-execute");
11147 DEFSYM (Qinternal_echo_keystrokes_prefix
, "internal-echo-keystrokes-prefix");
11149 accent_key_syms
= Qnil
;
11150 staticpro (&accent_key_syms
);
11152 func_key_syms
= Qnil
;
11153 staticpro (&func_key_syms
);
11155 drag_n_drop_syms
= Qnil
;
11156 staticpro (&drag_n_drop_syms
);
11158 unread_switch_frame
= Qnil
;
11159 staticpro (&unread_switch_frame
);
11161 internal_last_event_frame
= Qnil
;
11162 staticpro (&internal_last_event_frame
);
11164 read_key_sequence_cmd
= Qnil
;
11165 staticpro (&read_key_sequence_cmd
);
11166 read_key_sequence_remapped
= Qnil
;
11167 staticpro (&read_key_sequence_remapped
);
11169 menu_bar_one_keymap_changed_items
= Qnil
;
11170 staticpro (&menu_bar_one_keymap_changed_items
);
11172 menu_bar_items_vector
= Qnil
;
11173 staticpro (&menu_bar_items_vector
);
11175 help_form_saved_window_configs
= Qnil
;
11176 staticpro (&help_form_saved_window_configs
);
11178 defsubr (&Scurrent_idle_time
);
11179 defsubr (&Sevent_symbol_parse_modifiers
);
11180 defsubr (&Sevent_convert_list
);
11181 defsubr (&Sread_key_sequence
);
11182 defsubr (&Sread_key_sequence_vector
);
11183 defsubr (&Srecursive_edit
);
11184 defsubr (&Strack_mouse
);
11185 defsubr (&Sinput_pending_p
);
11186 defsubr (&Srecent_keys
);
11187 defsubr (&Sthis_command_keys
);
11188 defsubr (&Sthis_command_keys_vector
);
11189 defsubr (&Sthis_single_command_keys
);
11190 defsubr (&Sthis_single_command_raw_keys
);
11191 defsubr (&Sclear_this_command_keys
);
11192 defsubr (&Ssuspend_emacs
);
11193 defsubr (&Sabort_recursive_edit
);
11194 defsubr (&Sexit_recursive_edit
);
11195 defsubr (&Srecursion_depth
);
11196 defsubr (&Scommand_error_default_function
);
11197 defsubr (&Stop_level
);
11198 defsubr (&Sdiscard_input
);
11199 defsubr (&Sopen_dribble_file
);
11200 defsubr (&Sset_input_interrupt_mode
);
11201 defsubr (&Sset_output_flow_control
);
11202 defsubr (&Sset_input_meta_mode
);
11203 defsubr (&Sset_quit_char
);
11204 defsubr (&Sset_input_mode
);
11205 defsubr (&Scurrent_input_mode
);
11206 defsubr (&Sposn_at_point
);
11207 defsubr (&Sposn_at_x_y
);
11209 DEFVAR_LISP ("last-command-event", last_command_event
,
11210 doc
: /* Last input event that was part of a command. */);
11212 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11213 doc
: /* Last input event in a command, except for mouse menu events.
11214 Mouse menus give back keys that don't look like mouse events;
11215 this variable holds the actual mouse event that led to the menu,
11216 so that you can determine whether the command was run by mouse or not. */);
11218 DEFVAR_LISP ("last-input-event", last_input_event
,
11219 doc
: /* Last input event. */);
11221 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11222 doc
: /* List of events to be read as the command input.
11223 These events are processed first, before actual keyboard input.
11224 Events read from this list are not normally added to `this-command-keys',
11225 as they will already have been added once as they were read for the first time.
11226 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11227 Vunread_command_events
= Qnil
;
11229 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11230 doc
: /* List of events to be processed as input by input methods.
11231 These events are processed before `unread-command-events'
11232 and actual keyboard input, but are not given to `input-method-function'. */);
11233 Vunread_post_input_method_events
= Qnil
;
11235 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11236 doc
: /* List of events to be processed as input by input methods.
11237 These events are processed after `unread-command-events', but
11238 before actual keyboard input.
11239 If there's an active input method, the events are given to
11240 `input-method-function'. */);
11241 Vunread_input_method_events
= Qnil
;
11243 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11244 doc
: /* Meta-prefix character code.
11245 Meta-foo as command input turns into this character followed by foo. */);
11246 XSETINT (meta_prefix_char
, 033);
11248 DEFVAR_KBOARD ("last-command", Vlast_command
,
11249 doc
: /* The last command executed.
11250 Normally a symbol with a function definition, but can be whatever was found
11251 in the keymap, or whatever the variable `this-command' was set to by that
11254 The value `mode-exit' is special; it means that the previous command
11255 read an event that told it to exit, and it did so and unread that event.
11256 In other words, the present command is the event that made the previous
11259 The value `kill-region' is special; it means that the previous command
11260 was a kill command.
11262 `last-command' has a separate binding for each terminal device.
11263 See Info node `(elisp)Multiple Terminals'. */);
11265 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11266 doc
: /* Same as `last-command', but never altered by Lisp code.
11267 Taken from the previous value of `real-this-command'. */);
11269 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11270 doc
: /* Last command that may be repeated.
11271 The last command executed that was not bound to an input event.
11272 This is the command `repeat' will try to repeat.
11273 Taken from a previous value of `real-this-command'. */);
11275 DEFVAR_LISP ("this-command", Vthis_command
,
11276 doc
: /* The command now being executed.
11277 The command can set this variable; whatever is put here
11278 will be in `last-command' during the following command. */);
11279 Vthis_command
= Qnil
;
11281 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11282 doc
: /* This is like `this-command', except that commands should never modify it. */);
11283 Vreal_this_command
= Qnil
;
11285 DEFVAR_LISP ("this-command-keys-shift-translated",
11286 Vthis_command_keys_shift_translated
,
11287 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11288 Shift-translation occurs when there is no binding for the key sequence
11289 as entered, but a binding was found by changing an upper-case letter
11290 to lower-case, or a shifted function key to an unshifted one. */);
11291 Vthis_command_keys_shift_translated
= Qnil
;
11293 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11294 doc
: /* The command bound to the current key sequence before remapping.
11295 It equals `this-command' if the original command was not remapped through
11296 any of the active keymaps. Otherwise, the value of `this-command' is the
11297 result of looking up the original command in the active keymaps. */);
11298 Vthis_original_command
= Qnil
;
11300 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11301 doc
: /* Number of input events between auto-saves.
11302 Zero means disable autosaving due to number of characters typed. */);
11303 auto_save_interval
= 300;
11305 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11306 doc
: /* Number of seconds idle time before auto-save.
11307 Zero or nil means disable auto-saving due to idleness.
11308 After auto-saving due to this many seconds of idle time,
11309 Emacs also does a garbage collection if that seems to be warranted. */);
11310 XSETFASTINT (Vauto_save_timeout
, 30);
11312 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11313 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11314 The value may be integer or floating point.
11315 If the value is zero, don't echo at all. */);
11316 Vecho_keystrokes
= make_number (1);
11318 DEFVAR_INT ("polling-period", polling_period
,
11319 doc
: /* Interval between polling for input during Lisp execution.
11320 The reason for polling is to make C-g work to stop a running program.
11321 Polling is needed only when using X windows and SIGIO does not work.
11322 Polling is automatically disabled in all other cases. */);
11323 polling_period
= 2;
11325 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11326 doc
: /* Maximum time between mouse clicks to make a double-click.
11327 Measured in milliseconds. The value nil means disable double-click
11328 recognition; t means double-clicks have no time limit and are detected
11329 by position only. */);
11330 Vdouble_click_time
= make_number (500);
11332 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11333 doc
: /* Maximum mouse movement between clicks to make a double-click.
11334 On window-system frames, value is the number of pixels the mouse may have
11335 moved horizontally or vertically between two clicks to make a double-click.
11336 On non window-system frames, value is interpreted in units of 1/8 characters
11339 This variable is also the threshold for motion of the mouse
11340 to count as a drag. */);
11341 double_click_fuzz
= 3;
11343 DEFVAR_INT ("num-input-keys", num_input_keys
,
11344 doc
: /* Number of complete key sequences read as input so far.
11345 This includes key sequences read from keyboard macros.
11346 The number is effectively the number of interactive command invocations. */);
11347 num_input_keys
= 0;
11349 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11350 doc
: /* Number of input events read from the keyboard so far.
11351 This does not include events generated by keyboard macros. */);
11352 num_nonmacro_input_events
= 0;
11354 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11355 doc
: /* The frame in which the most recently read event occurred.
11356 If the last event came from a keyboard macro, this is set to `macro'. */);
11357 Vlast_event_frame
= Qnil
;
11359 /* This variable is set up in sysdep.c. */
11360 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11361 doc
: /* The ERASE character as set by the user with stty. */);
11363 DEFVAR_LISP ("help-char", Vhelp_char
,
11364 doc
: /* Character to recognize as meaning Help.
11365 When it is read, do `(eval help-form)', and display result if it's a string.
11366 If the value of `help-form' is nil, this char can be read normally. */);
11367 XSETINT (Vhelp_char
, Ctl ('H'));
11369 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11370 doc
: /* List of input events to recognize as meaning Help.
11371 These work just like the value of `help-char' (see that). */);
11372 Vhelp_event_list
= Qnil
;
11374 DEFVAR_LISP ("help-form", Vhelp_form
,
11375 doc
: /* Form to execute when character `help-char' is read.
11376 If the form returns a string, that string is displayed.
11377 If `help-form' is nil, the help char is not recognized. */);
11380 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11381 doc
: /* Command to run when `help-char' character follows a prefix key.
11382 This command is used only when there is no actual binding
11383 for that character after that prefix key. */);
11384 Vprefix_help_command
= Qnil
;
11386 DEFVAR_LISP ("top-level", Vtop_level
,
11387 doc
: /* Form to evaluate when Emacs starts up.
11388 Useful to set before you dump a modified Emacs. */);
11390 XSYMBOL (Qtop_level
)->declared_special
= false;
11392 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11393 doc
: /* Translate table for local keyboard input, or nil.
11394 If non-nil, the value should be a char-table. Each character read
11395 from the keyboard is looked up in this char-table. If the value found
11396 there is non-nil, then it is used instead of the actual input character.
11398 The value can also be a string or vector, but this is considered obsolete.
11399 If it is a string or vector of length N, character codes N and up are left
11400 untranslated. In a vector, an element which is nil means "no translation".
11402 This is applied to the characters supplied to input methods, not their
11403 output. See also `translation-table-for-input'.
11405 This variable has a separate binding for each terminal.
11406 See Info node `(elisp)Multiple Terminals'. */);
11408 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11409 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11410 \(Even if the operating system has support for stopping a process.) */);
11411 cannot_suspend
= false;
11413 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11414 doc
: /* Non-nil means prompt with menus when appropriate.
11415 This is done when reading from a keymap that has a prompt string,
11416 for elements that have prompt strings.
11417 The menu is displayed on the screen
11418 if X menus were enabled at configuration
11419 time and the previous event was a mouse click prefix key.
11420 Otherwise, menu prompting uses the echo area. */);
11421 menu_prompting
= true;
11423 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11424 doc
: /* Character to see next line of menu prompt.
11425 Type this character while in a menu prompt to rotate around the lines of it. */);
11426 XSETINT (menu_prompt_more_char
, ' ');
11428 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11429 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11430 Emacs applies the modifiers of the character stored here to each keyboard
11431 character it reads. For example, after evaluating the expression
11432 (setq extra-keyboard-modifiers ?\\C-x)
11433 all input characters will have the control modifier applied to them.
11435 Note that the character ?\\C-@, equivalent to the integer zero, does
11436 not count as a control character; rather, it counts as a character
11437 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11438 cancels any modification. */);
11439 extra_keyboard_modifiers
= 0;
11441 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11442 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11443 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11444 The command loop sets this to nil before each command,
11445 and tests the value when the command returns.
11446 Buffer modification stores t in this variable. */);
11447 Vdeactivate_mark
= Qnil
;
11448 Fmake_variable_buffer_local (Qdeactivate_mark
);
11450 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11451 doc
: /* Normal hook run before each command is executed.
11452 If an unhandled error happens in running this hook,
11453 the function in which the error occurred is unconditionally removed, since
11454 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11456 See also `post-command-hook'. */);
11457 Vpre_command_hook
= Qnil
;
11459 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11460 doc
: /* Normal hook run after each command is executed.
11461 If an unhandled error happens in running this hook,
11462 the function in which the error occurred is unconditionally removed, since
11463 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11465 It is a bad idea to use this hook for expensive processing. If
11466 unavoidable, wrap your code in `(while-no-input (redisplay) CODE)' to
11467 avoid making Emacs unresponsive while the user types.
11469 See also `pre-command-hook'. */);
11470 Vpost_command_hook
= Qnil
;
11473 DEFVAR_LISP ("echo-area-clear-hook", ...,
11474 doc
: /* Normal hook run when clearing the echo area. */);
11476 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11477 Fset (Qecho_area_clear_hook
, Qnil
);
11479 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11480 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11481 Vlucid_menu_bar_dirty_flag
= Qnil
;
11483 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11484 doc
: /* List of menu bar items to move to the end of the menu bar.
11485 The elements of the list are event types that may have menu bar bindings. */);
11486 Vmenu_bar_final_items
= Qnil
;
11488 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11489 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11490 This is used internally by graphical displays that do not render
11491 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11492 Vtool_bar_separator_image_expression
= Qnil
;
11494 DEFVAR_KBOARD ("overriding-terminal-local-map",
11495 Voverriding_terminal_local_map
,
11496 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11497 This variable is intended to let commands such as `universal-argument'
11498 set up a different keymap for reading the next command.
11500 `overriding-terminal-local-map' has a separate binding for each
11501 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11503 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11504 doc
: /* Keymap that replaces (overrides) local keymaps.
11505 If this variable is non-nil, Emacs looks up key bindings in this
11506 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11507 buffer's local map. Hence, the only active keymaps would be
11508 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11509 order of precedence. */);
11510 Voverriding_local_map
= Qnil
;
11512 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11513 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11514 Otherwise, the menu bar continues to reflect the buffer's local map
11515 and the minor mode maps regardless of `overriding-local-map'. */);
11516 Voverriding_local_map_menu_flag
= Qnil
;
11518 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11519 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11520 Vspecial_event_map
= list1 (Qkeymap
);
11522 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11523 doc
: /* Non-nil means generate motion events for mouse motion. */);
11525 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11526 doc
: /* Alist of system-specific X windows key symbols.
11527 Each element should have the form (N . SYMBOL) where N is the
11528 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11529 and SYMBOL is its name.
11531 `system-key-alist' has a separate binding for each terminal device.
11532 See Info node `(elisp)Multiple Terminals'. */);
11534 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11535 doc
: /* Keymap that translates key sequences to key sequences during input.
11536 This is used mainly for mapping key sequences into some preferred
11537 key events (symbols).
11539 The `read-key-sequence' function replaces any subsequence bound by
11540 `local-function-key-map' with its binding. More precisely, when the
11541 active keymaps have no binding for the current key sequence but
11542 `local-function-key-map' binds a suffix of the sequence to a vector or
11543 string, `read-key-sequence' replaces the matching suffix with its
11544 binding, and continues with the new sequence.
11546 If the binding is a function, it is called with one argument (the prompt)
11547 and its return value (a key sequence) is used.
11549 The events that come from bindings in `local-function-key-map' are not
11550 themselves looked up in `local-function-key-map'.
11552 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11553 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11554 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11555 typing `ESC O P x' would return [f1 x].
11557 `local-function-key-map' has a separate binding for each terminal
11558 device. See Info node `(elisp)Multiple Terminals'. If you need to
11559 define a binding on all terminals, change `function-key-map'
11560 instead. Initially, `local-function-key-map' is an empty keymap that
11561 has `function-key-map' as its parent on all terminal devices. */);
11563 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11564 doc
: /* Keymap that decodes input escape sequences.
11565 This is used mainly for mapping ASCII function key sequences into
11566 real Emacs function key events (symbols).
11568 The `read-key-sequence' function replaces any subsequence bound by
11569 `input-decode-map' with its binding. Contrary to `function-key-map',
11570 this map applies its rebinding regardless of the presence of an ordinary
11571 binding. So it is more like `key-translation-map' except that it applies
11572 before `function-key-map' rather than after.
11574 If the binding is a function, it is called with one argument (the prompt)
11575 and its return value (a key sequence) is used.
11577 The events that come from bindings in `input-decode-map' are not
11578 themselves looked up in `input-decode-map'. */);
11580 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11581 doc
: /* The parent keymap of all `local-function-key-map' instances.
11582 Function key definitions that apply to all terminal devices should go
11583 here. If a mapping is defined in both the current
11584 `local-function-key-map' binding and this variable, then the local
11585 definition will take precedence. */);
11586 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11588 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11589 doc
: /* Keymap of key translations that can override keymaps.
11590 This keymap works like `input-decode-map', but comes after `function-key-map'.
11591 Another difference is that it is global rather than terminal-local. */);
11592 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11594 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11595 doc
: /* List of deferred actions to be performed at a later time.
11596 The precise format isn't relevant here; we just check whether it is nil. */);
11597 Vdeferred_action_list
= Qnil
;
11599 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11600 doc
: /* Function to call to handle deferred actions, after each command.
11601 This function is called with no arguments after each command
11602 whenever `deferred-action-list' is non-nil. */);
11603 Vdeferred_action_function
= Qnil
;
11605 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11606 doc
: /* List of warnings to be displayed after this command.
11607 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11608 as per the args of `display-warning' (which see).
11609 If this variable is non-nil, `delayed-warnings-hook' will be run
11610 immediately after running `post-command-hook'. */);
11611 Vdelayed_warnings_list
= Qnil
;
11613 DEFVAR_LISP ("timer-list", Vtimer_list
,
11614 doc
: /* List of active absolute time timers in order of increasing time. */);
11615 Vtimer_list
= Qnil
;
11617 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11618 doc
: /* List of active idle-time timers in order of increasing time. */);
11619 Vtimer_idle_list
= Qnil
;
11621 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11622 doc
: /* If non-nil, the function that implements the current input method.
11623 It's called with one argument, a printing character that was just read.
11624 \(That means a character with code 040...0176.)
11625 Typically this function uses `read-event' to read additional events.
11626 When it does so, it should first bind `input-method-function' to nil
11627 so it will not be called recursively.
11629 The function should return a list of zero or more events
11630 to be used as input. If it wants to put back some events
11631 to be reconsidered, separately, by the input method,
11632 it can add them to the beginning of `unread-command-events'.
11634 The input method function can find in `input-method-previous-message'
11635 the previous echo area message.
11637 The input method function should refer to the variables
11638 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11639 for guidance on what to do. */);
11640 Vinput_method_function
= Qlist
;
11642 DEFVAR_LISP ("input-method-previous-message",
11643 Vinput_method_previous_message
,
11644 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11645 This variable exists because `read-event' clears the echo area
11646 before running the input method. It is nil if there was no message. */);
11647 Vinput_method_previous_message
= Qnil
;
11649 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11650 doc
: /* If non-nil, the function that implements the display of help.
11651 It's called with one argument, the help string to display. */);
11652 Vshow_help_function
= Qnil
;
11654 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11655 doc
: /* If non-nil, suppress point adjustment after executing a command.
11657 After a command is executed, if point moved into a region that has
11658 special properties (e.g. composition, display), Emacs adjusts point to
11659 the boundary of the region. But when a command leaves this variable at
11660 a non-nil value (e.g., with a setq), this point adjustment is suppressed.
11662 This variable is set to nil before reading a command, and is checked
11663 just after executing the command. */);
11664 Vdisable_point_adjustment
= Qnil
;
11666 DEFVAR_LISP ("global-disable-point-adjustment",
11667 Vglobal_disable_point_adjustment
,
11668 doc
: /* If non-nil, always suppress point adjustments.
11670 The default value is nil, in which case point adjustments are
11671 suppressed only after special commands that leave
11672 `disable-point-adjustment' (which see) at a non-nil value. */);
11673 Vglobal_disable_point_adjustment
= Qnil
;
11675 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11676 doc
: /* How long to display an echo-area message when the minibuffer is active.
11677 If the value is not a number, such messages don't time out. */);
11678 Vminibuffer_message_timeout
= make_number (2);
11680 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11681 doc
: /* If non-nil, any keyboard input throws to this symbol.
11682 The value of that variable is passed to `quit-flag' and later causes a
11683 peculiar kind of quitting. */);
11684 Vthrow_on_input
= Qnil
;
11686 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11687 doc
: /* Function to output error messages.
11688 Called with three arguments:
11689 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11690 such as what `condition-case' would bind its variable to,
11691 - the context (a string which normally goes at the start of the message),
11692 - the Lisp function within which the error was signaled. */);
11693 Vcommand_error_function
= intern ("command-error-default-function");
11695 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11696 Venable_disabled_menus_and_buttons
,
11697 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11699 Help functions bind this to allow help on disabled menu items
11700 and tool-bar buttons. */);
11701 Venable_disabled_menus_and_buttons
= Qnil
;
11703 DEFVAR_LISP ("select-active-regions",
11704 Vselect_active_regions
,
11705 doc
: /* If non-nil, an active region automatically sets the primary selection.
11706 If the value is `only', only temporarily active regions (usually made
11707 by mouse-dragging or shift-selection) set the window selection.
11709 This takes effect only when Transient Mark mode is enabled. */);
11710 Vselect_active_regions
= Qt
;
11712 DEFVAR_LISP ("saved-region-selection",
11713 Vsaved_region_selection
,
11714 doc
: /* Contents of active region prior to buffer modification.
11715 If `select-active-regions' is non-nil, Emacs sets this to the
11716 text in the region before modifying the buffer. The next call to
11717 the function `deactivate-mark' uses this to set the window selection. */);
11718 Vsaved_region_selection
= Qnil
;
11720 DEFVAR_LISP ("selection-inhibit-update-commands",
11721 Vselection_inhibit_update_commands
,
11722 doc
: /* List of commands which should not update the selection.
11723 Normally, if `select-active-regions' is non-nil and the mark remains
11724 active after a command (i.e. the mark was not deactivated), the Emacs
11725 command loop sets the selection to the text in the region. However,
11726 if the command is in this list, the selection is not updated. */);
11727 Vselection_inhibit_update_commands
11728 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11730 DEFVAR_LISP ("debug-on-event",
11732 doc
: /* Enter debugger on this event. When Emacs
11733 receives the special event specified by this variable, it will try to
11734 break into the debugger as soon as possible instead of processing the
11735 event normally through `special-event-map'.
11737 Currently, the only supported values for this
11738 variable are `sigusr1' and `sigusr2'. */);
11739 Vdebug_on_event
= intern_c_string ("sigusr2");
11741 DEFVAR_BOOL ("attempt-stack-overflow-recovery",
11742 attempt_stack_overflow_recovery
,
11743 doc
: /* If non-nil, attempt to recover from C stack
11744 overflow. This recovery is unsafe and may lead to deadlocks or data
11745 corruption, but it usually works and may preserve modified buffers
11746 that would otherwise be lost. If nil, treat stack overflow like any
11747 other kind of crash. */);
11748 attempt_stack_overflow_recovery
= true;
11750 DEFVAR_BOOL ("attempt-orderly-shutdown-on-fatal-signal",
11751 attempt_orderly_shutdown_on_fatal_signal
,
11752 doc
: /* If non-nil, attempt to perform an orderly
11753 shutdown when Emacs receives a fatal signal (e.g., a crash).
11754 This cleanup is unsafe and may lead to deadlocks or data corruption,
11755 but it usually works and may preserve modified buffers that would
11756 otherwise be lost. If nil, crash immediately in response to fatal
11758 attempt_orderly_shutdown_on_fatal_signal
= true;
11760 /* Create the initial keyboard. Qt means 'unset'. */
11761 initial_kboard
= allocate_kboard (Qt
);
11765 keys_of_keyboard (void)
11767 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11768 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11769 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11770 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11771 initial_define_key (meta_map
, 'x', "execute-extended-command");
11773 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11774 "handle-delete-frame");
11776 initial_define_lispy_key (Vspecial_event_map
, "end-session",
11779 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11780 "ns-put-working-text");
11781 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11782 "ns-unput-working-text");
11783 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11784 current-prefix-arg, as is done in `handle-switch-frame'.
11785 But `handle-switch-frame is not run from the special-map.
11786 Commands from that map are run in a special way that automatically
11787 preserves the prefix-arg. Restoring the prefix arg here is not just
11788 redundant but harmful:
11790 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11791 - after the first prompt, the exit-minibuffer-hook is run which may
11792 iconify a frame and thus push a `iconify-frame' event.
11793 - after running exit-minibuffer-hook, current-prefix-arg is
11794 restored to the non-nil value it had before the prompt.
11795 - we enter the second prompt.
11796 current-prefix-arg is non-nil, prefix-arg is nil.
11797 - before running the first real event, we run the special iconify-frame
11798 event, but we pass the `special' arg to command-execute so
11799 current-prefix-arg and prefix-arg are left untouched.
11800 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11801 - the next key event will have a spuriously non-nil current-prefix-arg. */
11802 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11804 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11806 /* Handling it at such a low-level causes read_key_sequence to get
11807 * confused because it doesn't realize that the current_buffer was
11808 * changed by read_char.
11810 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11811 * "handle-select-window"); */
11812 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11813 "handle-save-session");
11816 /* Define a special event which is raised for dbus callback
11818 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11819 "dbus-handle-event");
11822 #ifdef USE_FILE_NOTIFY
11823 /* Define a special event which is raised for notification callback
11825 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11826 "file-notify-handle-event");
11827 #endif /* USE_FILE_NOTIFY */
11829 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11831 #if defined (WINDOWSNT)
11832 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11835 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11836 "handle-focus-in");
11837 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11838 "handle-focus-out");
11841 /* Mark the pointers in the kboard objects.
11842 Called by Fgarbage_collect. */
11844 mark_kboards (void)
11848 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11850 if (kb
->kbd_macro_buffer
)
11851 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11853 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11854 mark_object (KVAR (kb
, Vlast_command
));
11855 mark_object (KVAR (kb
, Vreal_last_command
));
11856 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11857 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11858 mark_object (KVAR (kb
, Vprefix_arg
));
11859 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11860 mark_object (KVAR (kb
, kbd_queue
));
11861 mark_object (KVAR (kb
, defining_kbd_macro
));
11862 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11863 mark_object (KVAR (kb
, Vsystem_key_alist
));
11864 mark_object (KVAR (kb
, system_key_syms
));
11865 mark_object (KVAR (kb
, Vwindow_system
));
11866 mark_object (KVAR (kb
, Vinput_decode_map
));
11867 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11868 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11869 mark_object (KVAR (kb
, echo_string
));
11870 mark_object (KVAR (kb
, echo_prompt
));
11873 union buffered_input_event
*event
;
11874 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11876 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11877 event
= kbd_buffer
;
11878 /* These two special event types has no Lisp_Objects to mark. */
11879 if (event
->kind
!= SELECTION_REQUEST_EVENT
11880 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11882 mark_object (event
->ie
.x
);
11883 mark_object (event
->ie
.y
);
11884 mark_object (event
->ie
.frame_or_window
);
11885 mark_object (event
->ie
.arg
);