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 /* IF_LINT (volatile) works around GCC bug 54561. */
2316 Lisp_Object
IF_LINT (volatile) c
;
2319 sys_jmp_buf local_getcjmp
;
2320 sys_jmp_buf save_jump
;
2321 Lisp_Object tem
, save
;
2322 volatile Lisp_Object previous_echo_area_message
;
2323 volatile Lisp_Object also_record
;
2324 volatile bool reread
, recorded
;
2325 bool volatile polling_stopped_here
= false;
2326 struct kboard
*orig_kboard
= current_kboard
;
2331 previous_echo_area_message
= Qnil
;
2337 if (CONSP (Vunread_post_input_method_events
))
2339 c
= XCAR (Vunread_post_input_method_events
);
2340 Vunread_post_input_method_events
2341 = XCDR (Vunread_post_input_method_events
);
2343 /* Undo what read_char_x_menu_prompt did when it unread
2344 additional keys returned by Fx_popup_menu. */
2346 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2357 if (CONSP (Vunread_command_events
))
2359 bool was_disabled
= false;
2361 c
= XCAR (Vunread_command_events
);
2362 Vunread_command_events
= XCDR (Vunread_command_events
);
2364 /* Undo what sit-for did when it unread additional keys
2365 inside universal-argument. */
2367 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2372 /* Undo what read_char_x_menu_prompt did when it unread
2373 additional keys returned by Fx_popup_menu. */
2375 && EQ (XCDR (c
), Qdisabled
)
2376 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2378 was_disabled
= true;
2382 /* If the queued event is something that used the mouse,
2383 set used_mouse_menu accordingly. */
2385 /* Also check was_disabled so last-nonmenu-event won't return
2386 a bad value when submenus are involved. (Bug#447) */
2387 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2388 *used_mouse_menu
= true;
2390 goto reread_for_input_method
;
2393 if (CONSP (Vunread_input_method_events
))
2395 c
= XCAR (Vunread_input_method_events
);
2396 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2398 /* Undo what read_char_x_menu_prompt did when it unread
2399 additional keys returned by Fx_popup_menu. */
2401 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2405 goto reread_for_input_method
;
2408 if (!NILP (Vexecuting_kbd_macro
))
2410 /* We set this to Qmacro; since that's not a frame, nobody will
2411 try to switch frames on us, and the selected window will
2414 Since this event came from a macro, it would be misleading to
2415 leave internal_last_event_frame set to wherever the last
2416 real event came from. Normally, a switch-frame event selects
2417 internal_last_event_frame after each command is read, but
2418 events read from a macro should never cause a new frame to be
2420 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2422 /* Exit the macro if we are at the end.
2423 Also, some things replace the macro with t
2424 to force an early exit. */
2425 if (EQ (Vexecuting_kbd_macro
, Qt
)
2426 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2432 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2433 if (STRINGP (Vexecuting_kbd_macro
)
2434 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2435 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2437 executing_kbd_macro_index
++;
2442 if (!NILP (unread_switch_frame
))
2444 c
= unread_switch_frame
;
2445 unread_switch_frame
= Qnil
;
2447 /* This event should make it into this_command_keys, and get echoed
2448 again, so we do not set `reread'. */
2452 /* If redisplay was requested. */
2453 if (commandflag
>= 0)
2455 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2457 /* If there is pending input, process any events which are not
2458 user-visible, such as X selection_request events. */
2460 || detect_input_pending_run_timers (0))
2461 swallow_events (false); /* May clear input_pending. */
2463 /* Redisplay if no pending input. */
2464 while (!(input_pending
2465 && (input_was_pending
|| !redisplay_dont_pause
)))
2467 input_was_pending
= input_pending
;
2468 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2469 redisplay_preserve_echo_area (5);
2474 /* Normal case: no input arrived during redisplay. */
2477 /* Input arrived and pre-empted redisplay.
2478 Process any events which are not user-visible. */
2479 swallow_events (false);
2480 /* If that cleared input_pending, try again to redisplay. */
2483 /* Prevent the redisplay we just did
2484 from messing up echoing of the input after the prompt. */
2485 if (commandflag
== 0 && echo_current
)
2486 echo_message_buffer
= echo_area_buffer
[0];
2490 /* Message turns off echoing unless more keystrokes turn it on again.
2492 The code in 20.x for the condition was
2494 1. echo_area_glyphs && *echo_area_glyphs
2495 2. && echo_area_glyphs != current_kboard->echobuf
2496 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2498 (1) means there's a current message displayed
2500 (2) means it's not the message from echoing from the current
2503 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2504 is set to a non-null value. This is done in read_char and it is
2505 set to echo_area_glyphs. That means
2506 ok_to_echo_at_next_pause is either null or
2507 current_kboard->echobuf with the appropriate current_kboard at
2510 So, condition (3) means in clear text ok_to_echo_at_next_pause
2511 must be either null, or the current message isn't from echoing at
2512 all, or it's from echoing from a different kboard than the
2515 if (/* There currently is something in the echo area. */
2516 !NILP (echo_area_buffer
[0])
2517 && (/* It's an echo from a different kboard. */
2518 echo_kboard
!= current_kboard
2519 /* Or we explicitly allow overwriting whatever there is. */
2520 || ok_to_echo_at_next_pause
== NULL
))
2525 /* Try reading a character via menu prompting in the minibuf.
2526 Try this before the sit-for, because the sit-for
2527 would do the wrong thing if we are supposed to do
2528 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2529 after a mouse event so don't try a minibuf menu. */
2531 if (KEYMAPP (map
) && INTERACTIVE
2532 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2533 /* Don't bring up a menu if we already have another event. */
2534 && !CONSP (Vunread_command_events
)
2535 && !detect_input_pending_run_timers (0))
2537 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2539 if (INTEGERP (c
) && XINT (c
) == -2)
2540 return c
; /* wrong_kboard_jmpbuf */
2546 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2547 We will do that below, temporarily for short sections of code,
2548 when appropriate. local_getcjmp must be in effect
2549 around any call to sit_for or kbd_buffer_get_event;
2550 it *must not* be in effect when we call redisplay. */
2552 jmpcount
= SPECPDL_INDEX ();
2553 if (sys_setjmp (local_getcjmp
))
2555 /* Handle quits while reading the keyboard. */
2556 /* We must have saved the outer value of getcjmp here,
2557 so restore it now. */
2558 restore_getcjmp (save_jump
);
2559 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2560 unbind_to (jmpcount
, Qnil
);
2561 XSETINT (c
, quit_char
);
2562 internal_last_event_frame
= selected_frame
;
2563 Vlast_event_frame
= internal_last_event_frame
;
2564 /* If we report the quit char as an event,
2565 don't do so more than once. */
2566 if (!NILP (Vinhibit_quit
))
2570 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2571 if (kb
!= current_kboard
)
2573 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2574 /* We shouldn't get here if we were in single-kboard mode! */
2579 while (CONSP (XCDR (last
)))
2581 if (!NILP (XCDR (last
)))
2585 kset_kbd_queue (kb
, list1 (c
));
2587 XSETCDR (last
, list1 (c
));
2588 kb
->kbd_queue_has_data
= true;
2589 current_kboard
= kb
;
2590 return make_number (-2); /* wrong_kboard_jmpbuf */
2596 /* Start idle timers if no time limit is supplied. We don't do it
2597 if a time limit is supplied to avoid an infinite recursion in the
2598 situation where an idle timer calls `sit-for'. */
2601 timer_start_idle ();
2603 /* If in middle of key sequence and minibuffer not active,
2604 start echoing if enough time elapses. */
2606 if (minibuf_level
== 0
2608 && !current_kboard
->immediate_echo
2609 && (this_command_key_count
> 0
2610 || !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
2612 && echo_keystrokes_p ()
2613 && (/* No message. */
2614 NILP (echo_area_buffer
[0])
2615 /* Or empty message. */
2616 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2617 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2618 /* Or already echoing from same kboard. */
2619 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2620 /* Or not echoing before and echoing allowed. */
2621 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2623 /* After a mouse event, start echoing right away.
2624 This is because we are probably about to display a menu,
2625 and we don't want to delay before doing so. */
2626 if (EVENT_HAS_PARAMETERS (prev_event
))
2632 save_getcjmp (save_jump
);
2633 restore_getcjmp (local_getcjmp
);
2634 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2635 restore_getcjmp (save_jump
);
2637 && ! CONSP (Vunread_command_events
))
2642 /* Maybe auto save due to number of keystrokes. */
2644 if (commandflag
!= 0 && commandflag
!= -2
2645 && auto_save_interval
> 0
2646 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2647 && !detect_input_pending_run_timers (0))
2649 Fdo_auto_save (Qnil
, Qnil
);
2650 /* Hooks can actually change some buffers in auto save. */
2654 /* Try reading using an X menu.
2655 This is never confused with reading using the minibuf
2656 because the recursive call of read_char in read_char_minibuf_menu_prompt
2657 does not pass on any keymaps. */
2659 if (KEYMAPP (map
) && INTERACTIVE
2660 && !NILP (prev_event
)
2661 && EVENT_HAS_PARAMETERS (prev_event
)
2662 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2663 && !EQ (XCAR (prev_event
), Qtool_bar
)
2664 /* Don't bring up a menu if we already have another event. */
2665 && !CONSP (Vunread_command_events
))
2667 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2669 /* Now that we have read an event, Emacs is not idle. */
2676 /* Maybe autosave and/or garbage collect due to idleness. */
2678 if (INTERACTIVE
&& NILP (c
))
2681 ptrdiff_t buffer_size
;
2683 /* Slow down auto saves logarithmically in size of current buffer,
2684 and garbage collect while we're at it. */
2685 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2686 last_non_minibuf_size
= Z
- BEG
;
2687 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2689 while (buffer_size
> 64)
2690 delay_level
++, buffer_size
-= buffer_size
>> 2;
2691 if (delay_level
< 4) delay_level
= 4;
2692 /* delay_level is 4 for files under around 50k, 7 at 100k,
2693 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2695 /* Auto save if enough time goes by without input. */
2696 if (commandflag
!= 0 && commandflag
!= -2
2697 && num_nonmacro_input_events
> last_auto_save
2698 && INTEGERP (Vauto_save_timeout
)
2699 && XINT (Vauto_save_timeout
) > 0)
2702 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2704 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2705 timeout
= delay_level
* timeout
/ 4;
2706 save_getcjmp (save_jump
);
2707 restore_getcjmp (local_getcjmp
);
2708 tem0
= sit_for (make_number (timeout
), 1, 1);
2709 restore_getcjmp (save_jump
);
2712 && ! CONSP (Vunread_command_events
))
2714 Fdo_auto_save (Qnil
, Qnil
);
2719 /* If there is still no input available, ask for GC. */
2720 if (!detect_input_pending_run_timers (0))
2724 /* Notify the caller if an autosave hook, or a timer, sentinel or
2725 filter in the sit_for calls above have changed the current
2726 kboard. This could happen if they use the minibuffer or start a
2727 recursive edit, like the fancy splash screen in server.el's
2728 filter. If this longjmp wasn't here, read_key_sequence would
2729 interpret the next key sequence using the wrong translation
2730 tables and function keymaps. */
2731 if (NILP (c
) && current_kboard
!= orig_kboard
)
2732 return make_number (-2); /* wrong_kboard_jmpbuf */
2734 /* If this has become non-nil here, it has been set by a timer
2735 or sentinel or filter. */
2736 if (CONSP (Vunread_command_events
))
2738 c
= XCAR (Vunread_command_events
);
2739 Vunread_command_events
= XCDR (Vunread_command_events
);
2741 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2747 /* Read something from current KBOARD's side queue, if possible. */
2751 if (current_kboard
->kbd_queue_has_data
)
2753 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2755 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2756 kset_kbd_queue (current_kboard
,
2757 XCDR (KVAR (current_kboard
, kbd_queue
)));
2758 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2759 current_kboard
->kbd_queue_has_data
= false;
2760 input_pending
= readable_events (0);
2761 if (EVENT_HAS_PARAMETERS (c
)
2762 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2763 internal_last_event_frame
= XCAR (XCDR (c
));
2764 Vlast_event_frame
= internal_last_event_frame
;
2768 /* If current_kboard's side queue is empty check the other kboards.
2769 If one of them has data that we have not yet seen here,
2770 switch to it and process the data waiting for it.
2772 Note: if the events queued up for another kboard
2773 have already been seen here, and therefore are not a complete command,
2774 the kbd_queue_has_data field is 0, so we skip that kboard here.
2775 That's to avoid an infinite loop switching between kboards here. */
2776 if (NILP (c
) && !single_kboard
)
2779 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2780 if (kb
->kbd_queue_has_data
)
2782 current_kboard
= kb
;
2783 return make_number (-2); /* wrong_kboard_jmpbuf */
2793 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2794 prev_event
, used_mouse_menu
);
2795 if (NILP (c
) && end_time
2796 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2801 if (EQ (c
, make_number (-2)))
2813 if (commandflag
>= 0
2814 && !input_pending
&& !detect_input_pending_run_timers (0))
2820 /* Buffer switch events are only for internal wakeups
2821 so don't show them to the user.
2822 Also, don't record a key if we already did. */
2826 /* Process special events within read_char
2827 and loop around to read another event. */
2830 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2835 struct buffer
*prev_buffer
= current_buffer
;
2836 last_input_event
= c
;
2837 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2840 && (EQ (XCAR (c
), Qselect_window
)
2842 || EQ (XCAR (c
), Qdbus_event
)
2844 #ifdef USE_FILE_NOTIFY
2845 || EQ (XCAR (c
), Qfile_notify
)
2847 || EQ (XCAR (c
), Qconfig_changed_event
))
2849 /* We stopped being idle for this event; undo that. This
2850 prevents automatic window selection (under
2851 mouse-autoselect-window) from acting as a real input event, for
2852 example banishing the mouse under mouse-avoidance-mode. */
2853 timer_resume_idle ();
2855 if (current_buffer
!= prev_buffer
)
2857 /* The command may have changed the keymaps. Pretend there
2858 is input in another keyboard and return. This will
2859 recalculate keymaps. */
2860 c
= make_number (-2);
2867 /* Handle things that only apply to characters. */
2870 /* If kbd_buffer_get_event gave us an EOF, return that. */
2874 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2875 && UNSIGNED_CMP (XFASTINT (c
), <,
2876 SCHARS (KVAR (current_kboard
,
2877 Vkeyboard_translate_table
))))
2878 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2879 && UNSIGNED_CMP (XFASTINT (c
), <,
2880 ASIZE (KVAR (current_kboard
,
2881 Vkeyboard_translate_table
))))
2882 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2886 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2887 /* nil in keyboard-translate-table means no translation. */
2893 /* If this event is a mouse click in the menu bar,
2894 return just menu-bar for now. Modify the mouse click event
2895 so we won't do this twice, then queue it up. */
2896 if (EVENT_HAS_PARAMETERS (c
)
2898 && CONSP (EVENT_START (c
))
2899 && CONSP (XCDR (EVENT_START (c
))))
2903 posn
= POSN_POSN (EVENT_START (c
));
2904 /* Handle menu-bar events:
2905 insert the dummy prefix event `menu-bar'. */
2906 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2908 /* Change menu-bar to (menu-bar) as the event "position". */
2909 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2912 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2917 /* Store these characters into recent_keys, the dribble file if any,
2918 and the keyboard macro being defined, if any. */
2921 if (! NILP (also_record
))
2922 record_char (also_record
);
2924 /* Wipe the echo area.
2925 But first, if we are about to use an input method,
2926 save the echo area contents for it to refer to. */
2928 && ! NILP (Vinput_method_function
)
2929 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2931 previous_echo_area_message
= Fcurrent_message ();
2932 Vinput_method_previous_message
= previous_echo_area_message
;
2935 /* Now wipe the echo area, except for help events which do their
2936 own stuff with the echo area. */
2938 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2939 && !(EQ (Qswitch_frame
, XCAR (c
)))
2940 /* Don't wipe echo area for select window events: These might
2941 get delayed via `mouse-autoselect-window' (Bug#11304). */
2942 && !(EQ (Qselect_window
, XCAR (c
)))))
2944 if (!NILP (echo_area_buffer
[0]))
2946 safe_run_hooks (Qecho_area_clear_hook
);
2947 clear_message (1, 0);
2951 reread_for_input_method
:
2953 /* Pass this to the input method, if appropriate. */
2955 && ! NILP (Vinput_method_function
)
2956 /* Don't run the input method within a key sequence,
2957 after the first event of the key sequence. */
2958 && NILP (prev_event
)
2959 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2962 ptrdiff_t key_count
;
2963 ptrdiff_t command_key_start
;
2964 ptrdiff_t count
= SPECPDL_INDEX ();
2966 /* Save the echo status. */
2967 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2968 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2969 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2970 Lisp_Object saved_echo_prompt
= KVAR (current_kboard
, echo_prompt
);
2972 /* Save the this_command_keys status. */
2973 key_count
= this_command_key_count
;
2974 command_key_start
= this_single_command_key_start
;
2977 keys
= Fcopy_sequence (this_command_keys
);
2981 /* Clear out this_command_keys. */
2982 this_command_key_count
= 0;
2983 this_single_command_key_start
= 0;
2985 /* Now wipe the echo area. */
2986 if (!NILP (echo_area_buffer
[0]))
2987 safe_run_hooks (Qecho_area_clear_hook
);
2988 clear_message (1, 0);
2991 /* If we are not reading a key sequence,
2992 never use the echo area. */
2995 specbind (Qinput_method_use_echo_area
, Qt
);
2998 /* Call the input method. */
2999 tem
= call1 (Vinput_method_function
, c
);
3001 tem
= unbind_to (count
, tem
);
3003 /* Restore the saved echoing state
3004 and this_command_keys state. */
3005 this_command_key_count
= key_count
;
3006 this_single_command_key_start
= command_key_start
;
3008 this_command_keys
= keys
;
3011 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3012 kset_echo_string (current_kboard
, saved_echo_string
);
3013 kset_echo_prompt (current_kboard
, saved_echo_prompt
);
3014 if (saved_immediate_echo
)
3017 /* The input method can return no events. */
3020 /* Bring back the previous message, if any. */
3021 if (! NILP (previous_echo_area_message
))
3022 message_with_string ("%s", previous_echo_area_message
, 0);
3025 /* It returned one event or more. */
3027 Vunread_post_input_method_events
3028 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3030 /* When we consume events from the various unread-*-events lists, we
3031 bypass the code that records input, so record these events now if
3032 they were not recorded already. */
3041 /* Display help if not echoing. */
3042 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3044 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3045 Lisp_Object help
, object
, position
, window
, htem
;
3047 htem
= Fcdr (XCDR (c
));
3050 window
= Fcar (htem
);
3052 object
= Fcar (htem
);
3054 position
= Fcar (htem
);
3056 show_help_echo (help
, window
, object
, position
);
3058 /* We stopped being idle for this event; undo that. */
3060 timer_resume_idle ();
3064 if ((! reread
|| this_command_key_count
== 0)
3068 /* Don't echo mouse motion events. */
3069 if (! (EVENT_HAS_PARAMETERS (c
)
3070 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3071 /* Once we reread a character, echoing can happen
3072 the next time we pause to read a new one. */
3073 ok_to_echo_at_next_pause
= current_kboard
;
3075 /* Record this character as part of the current key. */
3076 add_command_key (c
);
3077 if (! NILP (also_record
))
3078 add_command_key (also_record
);
3083 last_input_event
= c
;
3086 /* Process the help character specially if enabled. */
3087 if (!NILP (Vhelp_form
) && help_char_p (c
))
3089 ptrdiff_t count
= SPECPDL_INDEX ();
3091 help_form_saved_window_configs
3092 = Fcons (Fcurrent_window_configuration (Qnil
),
3093 help_form_saved_window_configs
);
3094 record_unwind_protect_void (read_char_help_form_unwind
);
3095 call0 (Qhelp_form_show
);
3100 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3101 if (EVENT_HAS_PARAMETERS (c
)
3102 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3103 XSETCAR (help_form_saved_window_configs
, Qnil
);
3105 while (BUFFERP (c
));
3106 /* Remove the help from the frame. */
3107 unbind_to (count
, Qnil
);
3110 if (EQ (c
, make_number (040)))
3114 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3115 while (BUFFERP (c
));
3121 input_was_pending
= input_pending
;
3125 /* Record a key that came from a mouse menu.
3126 Record it for echoing, for this-command-keys, and so on. */
3129 record_menu_key (Lisp_Object c
)
3131 /* Wipe the echo area. */
3132 clear_message (1, 0);
3136 /* Once we reread a character, echoing can happen
3137 the next time we pause to read a new one. */
3138 ok_to_echo_at_next_pause
= NULL
;
3140 /* Record this character as part of the current key. */
3141 add_command_key (c
);
3144 /* Re-reading in the middle of a command. */
3145 last_input_event
= c
;
3149 /* Return true if should recognize C as "the help character". */
3152 help_char_p (Lisp_Object c
)
3156 if (EQ (c
, Vhelp_char
))
3158 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3159 if (EQ (c
, XCAR (tail
)))
3164 /* Record the input event C in various ways. */
3167 record_char (Lisp_Object c
)
3171 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3173 /* To avoid filling recent_keys with help-echo and mouse-movement
3174 events, we filter out repeated help-echo events, only store the
3175 first and last in a series of mouse-movement events, and don't
3176 store repeated help-echo events which are only separated by
3177 mouse-movement events. */
3179 Lisp_Object ev1
, ev2
, ev3
;
3182 if ((ix1
= recent_keys_index
- 1) < 0)
3183 ix1
= NUM_RECENT_KEYS
- 1;
3184 ev1
= AREF (recent_keys
, ix1
);
3186 if ((ix2
= ix1
- 1) < 0)
3187 ix2
= NUM_RECENT_KEYS
- 1;
3188 ev2
= AREF (recent_keys
, ix2
);
3190 if ((ix3
= ix2
- 1) < 0)
3191 ix3
= NUM_RECENT_KEYS
- 1;
3192 ev3
= AREF (recent_keys
, ix3
);
3194 if (EQ (XCAR (c
), Qhelp_echo
))
3196 /* Don't record `help-echo' in recent_keys unless it shows some help
3197 message, and a different help than the previously recorded
3199 Lisp_Object help
, last_help
;
3201 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3202 if (!STRINGP (help
))
3204 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3205 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3207 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3208 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3209 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3211 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3212 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3213 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3214 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3217 else if (EQ (XCAR (c
), Qmouse_movement
))
3219 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3220 So additional mouse movement events replace the last element. */
3221 Lisp_Object last_window
, window
;
3223 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3224 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3225 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3226 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3227 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3229 ASET (recent_keys
, ix1
, c
);
3235 store_kbd_macro_char (c
);
3237 /* recent_keys should not include events from keyboard macros. */
3238 if (NILP (Vexecuting_kbd_macro
))
3242 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3243 ASET (recent_keys
, recent_keys_index
, c
);
3244 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3245 recent_keys_index
= 0;
3247 else if (recorded
< 0)
3249 /* We need to remove one or two events from recent_keys.
3250 To do this, we simply put nil at those events and move the
3251 recent_keys_index backwards over those events. Usually,
3252 users will never see those nil events, as they will be
3253 overwritten by the command keys entered to see recent_keys
3256 while (recorded
++ < 0 && total_keys
> 0)
3258 if (total_keys
< NUM_RECENT_KEYS
)
3260 if (--recent_keys_index
< 0)
3261 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3262 ASET (recent_keys
, recent_keys_index
, Qnil
);
3266 num_nonmacro_input_events
++;
3269 /* Write c to the dribble file. If c is a lispy event, write
3270 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3271 If you, dear reader, have a better idea, you've got the source. :-) */
3277 if (XUINT (c
) < 0x100)
3278 putc (XUINT (c
), dribble
);
3280 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3284 Lisp_Object dribblee
;
3286 /* If it's a structured event, take the event header. */
3287 dribblee
= EVENT_HEAD (c
);
3289 if (SYMBOLP (dribblee
))
3291 putc ('<', dribble
);
3292 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3293 SBYTES (SYMBOL_NAME (dribblee
)),
3295 putc ('>', dribble
);
3304 /* Copy out or in the info on where C-g should throw to.
3305 This is used when running Lisp code from within get_char,
3306 in case get_char is called recursively.
3307 See read_process_output. */
3310 save_getcjmp (sys_jmp_buf temp
)
3312 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3316 restore_getcjmp (sys_jmp_buf temp
)
3318 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3321 /* Low level keyboard/mouse input.
3322 kbd_buffer_store_event places events in kbd_buffer, and
3323 kbd_buffer_get_event retrieves them. */
3325 /* Return true if there are any events in the queue that read-char
3326 would return. If this returns false, a read-char would block. */
3328 readable_events (int flags
)
3330 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3333 /* If the buffer contains only FOCUS_IN_EVENT events, and
3334 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3335 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3337 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3338 #ifdef USE_TOOLKIT_SCROLL_BARS
3339 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3343 union buffered_input_event
*event
= kbd_fetch_ptr
;
3347 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3350 #ifdef USE_TOOLKIT_SCROLL_BARS
3351 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3353 event
->kind
== FOCUS_IN_EVENT
)
3354 #ifdef USE_TOOLKIT_SCROLL_BARS
3355 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3356 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3357 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3358 && event
->ie
.part
== scroll_bar_handle
3359 && event
->ie
.modifiers
== 0)
3361 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3362 && event
->kind
== BUFFER_SWITCH_EVENT
))
3366 while (event
!= kbd_store_ptr
);
3372 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3373 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3377 if (current_kboard
->kbd_queue_has_data
)
3383 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3384 if (kb
->kbd_queue_has_data
)
3390 /* Set this for debugging, to have a way to get out */
3391 int stop_character EXTERNALLY_VISIBLE
;
3394 event_to_kboard (struct input_event
*event
)
3396 /* Not applicable for these special events. */
3397 if (event
->kind
== SELECTION_REQUEST_EVENT
3398 || event
->kind
== SELECTION_CLEAR_EVENT
)
3402 Lisp_Object obj
= event
->frame_or_window
;
3403 /* There are some events that set this field to nil or string. */
3405 obj
= WINDOW_FRAME (XWINDOW (obj
));
3406 /* Also ignore dead frames here. */
3407 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3408 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3413 /* Return the number of slots occupied in kbd_buffer. */
3416 kbd_buffer_nr_stored (void)
3418 return kbd_fetch_ptr
== kbd_store_ptr
3420 : (kbd_fetch_ptr
< kbd_store_ptr
3421 ? kbd_store_ptr
- kbd_fetch_ptr
3422 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3423 + (kbd_store_ptr
- kbd_buffer
)));
3425 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3428 kbd_buffer_store_event (register struct input_event
*event
)
3430 kbd_buffer_store_event_hold (event
, 0);
3433 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3435 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3436 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3437 Else, if EVENT is a quit event, store the quit event
3438 in HOLD_QUIT, and return (thus ignoring further events).
3440 This is used to postpone the processing of the quit event until all
3441 subsequent input events have been parsed (and discarded). */
3444 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3445 struct input_event
*hold_quit
)
3447 if (event
->kind
== NO_EVENT
)
3450 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3453 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3455 int c
= event
->ie
.code
& 0377;
3457 if (event
->ie
.modifiers
& ctrl_modifier
)
3458 c
= make_ctrl_char (c
);
3460 c
|= (event
->ie
.modifiers
3461 & (meta_modifier
| alt_modifier
3462 | hyper_modifier
| super_modifier
));
3466 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3468 if (single_kboard
&& kb
!= current_kboard
)
3471 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3473 kb
->kbd_queue_has_data
= true;
3474 union buffered_input_event
*sp
;
3475 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3477 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3480 if (event_to_kboard (&sp
->ie
) == kb
)
3482 sp
->ie
.kind
= NO_EVENT
;
3483 sp
->ie
.frame_or_window
= Qnil
;
3492 *hold_quit
= event
->ie
;
3496 /* If this results in a quit_char being returned to Emacs as
3497 input, set Vlast_event_frame properly. If this doesn't
3498 get returned to Emacs as an event, the next event read
3499 will set Vlast_event_frame again, so this is safe to do. */
3503 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3505 focus
= event
->ie
.frame_or_window
;
3506 internal_last_event_frame
= focus
;
3507 Vlast_event_frame
= focus
;
3510 handle_interrupt (0);
3514 if (c
&& c
== stop_character
)
3520 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3521 Just ignore the second one. */
3522 else if (event
->kind
== BUFFER_SWITCH_EVENT
3523 && kbd_fetch_ptr
!= kbd_store_ptr
3524 && ((kbd_store_ptr
== kbd_buffer
3525 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3526 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3529 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3530 kbd_store_ptr
= kbd_buffer
;
3532 /* Don't let the very last slot in the buffer become full,
3533 since that would make the two pointers equal,
3534 and that is indistinguishable from an empty buffer.
3535 Discard the event if it would fill the last slot. */
3536 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3538 *kbd_store_ptr
= *event
;
3541 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3542 && ! kbd_on_hold_p ())
3544 /* Don't read keyboard input until we have processed kbd_buffer.
3545 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3546 hold_keyboard_input ();
3550 #endif /* subprocesses */
3553 /* If we're inside while-no-input, and this event qualifies
3554 as input, set quit-flag to cause an interrupt. */
3555 if (!NILP (Vthrow_on_input
)
3556 && event
->kind
!= FOCUS_IN_EVENT
3557 && event
->kind
!= FOCUS_OUT_EVENT
3558 && event
->kind
!= HELP_EVENT
3559 && event
->kind
!= ICONIFY_EVENT
3560 && event
->kind
!= DEICONIFY_EVENT
)
3562 Vquit_flag
= Vthrow_on_input
;
3563 /* If we're inside a function that wants immediate quits,
3565 if (immediate_quit
&& NILP (Vinhibit_quit
))
3567 immediate_quit
= false;
3576 /* Put a selection input event back in the head of the event queue. */
3579 kbd_buffer_unget_event (struct selection_input_event
*event
)
3581 if (kbd_fetch_ptr
== kbd_buffer
)
3582 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3584 /* Don't let the very last slot in the buffer become full, */
3585 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3586 if (kp
!= kbd_store_ptr
)
3595 /* Limit help event positions to this range, to avoid overflow problems. */
3596 #define INPUT_EVENT_POS_MAX \
3597 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3598 MOST_POSITIVE_FIXNUM)))
3599 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3601 /* Return a Time that encodes position POS. POS must be in range. */
3604 position_to_Time (ptrdiff_t pos
)
3606 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3610 /* Return the position that ENCODED_POS encodes.
3611 Avoid signed integer overflow. */
3614 Time_to_position (Time encoded_pos
)
3616 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3618 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3619 eassert (encoded_pos_min
<= encoded_pos
);
3620 ptrdiff_t notpos
= -1 - encoded_pos
;
3624 /* Generate a HELP_EVENT input_event and store it in the keyboard
3627 HELP is the help form.
3629 FRAME and WINDOW are the frame and window where the help is
3630 generated. OBJECT is the Lisp object where the help was found (a
3631 buffer, a string, an overlay, or nil if neither from a string nor
3632 from a buffer). POS is the position within OBJECT where the help
3636 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3637 Lisp_Object object
, ptrdiff_t pos
)
3639 struct input_event event
;
3641 event
.kind
= HELP_EVENT
;
3642 event
.frame_or_window
= frame
;
3644 event
.x
= WINDOWP (window
) ? window
: frame
;
3646 event
.timestamp
= position_to_Time (pos
);
3647 kbd_buffer_store_event (&event
);
3651 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3654 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3656 struct input_event event
;
3658 event
.kind
= HELP_EVENT
;
3659 event
.frame_or_window
= frame
;
3663 event
.timestamp
= 0;
3664 kbd_buffer_store_event (&event
);
3668 /* Discard any mouse events in the event buffer by setting them to
3671 discard_mouse_events (void)
3673 union buffered_input_event
*sp
;
3674 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3676 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3679 if (sp
->kind
== MOUSE_CLICK_EVENT
3680 || sp
->kind
== WHEEL_EVENT
3681 || sp
->kind
== HORIZ_WHEEL_EVENT
3683 || sp
->kind
== GPM_CLICK_EVENT
3685 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3686 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3688 sp
->kind
= NO_EVENT
;
3694 /* Return true if there are any real events waiting in the event
3695 buffer, not counting `NO_EVENT's.
3697 Discard NO_EVENT events at the front of the input queue, possibly
3698 leaving the input queue empty if there are no real input events. */
3701 kbd_buffer_events_waiting (void)
3703 union buffered_input_event
*sp
;
3705 for (sp
= kbd_fetch_ptr
;
3706 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3709 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3714 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3718 /* Clear input event EVENT. */
3721 clear_event (union buffered_input_event
*event
)
3723 event
->kind
= NO_EVENT
;
3727 /* Read one event from the event buffer, waiting if necessary.
3728 The value is a Lisp object representing the event.
3729 The value is nil for an event that should be ignored,
3730 or that was handled here.
3731 We always read and discard one event. */
3734 kbd_buffer_get_event (KBOARD
**kbp
,
3735 bool *used_mouse_menu
,
3736 struct timespec
*end_time
)
3741 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3743 /* Start reading input again because we have processed enough to
3744 be able to accept new events again. */
3745 unhold_keyboard_input ();
3749 #endif /* subprocesses */
3751 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3753 /* In case we are running as a daemon, only do this before
3754 detaching from the terminal. */
3755 || (IS_DAEMON
&& DAEMON_RUNNING
))
3759 *kbp
= current_kboard
;
3762 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3764 /* Wait until there is input available. */
3767 /* Break loop if there's an unread command event. Needed in
3768 moused window autoselection which uses a timer to insert such
3770 if (CONSP (Vunread_command_events
))
3773 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3775 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3778 /* If the quit flag is set, then read_char will return
3779 quit_char, so that counts as "available input." */
3780 if (!NILP (Vquit_flag
))
3781 quit_throw_to_read_char (0);
3783 /* One way or another, wait until input is available; then, if
3784 interrupt handlers have not read it, read it now. */
3789 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3791 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3795 struct timespec now
= current_timespec ();
3796 if (timespec_cmp (*end_time
, now
) <= 0)
3797 return Qnil
; /* Finished waiting. */
3800 struct timespec duration
= timespec_sub (*end_time
, now
);
3801 wait_reading_process_output (min (duration
.tv_sec
,
3804 -1, 1, Qnil
, NULL
, 0);
3809 bool do_display
= true;
3811 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3813 struct tty_display_info
*tty
= CURTTY ();
3815 /* When this TTY is displaying a menu, we must prevent
3816 any redisplay, because we modify the frame's glyph
3817 matrix behind the back of the display engine. */
3818 if (tty
->showing_menu
)
3822 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3825 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3829 if (CONSP (Vunread_command_events
))
3832 first
= XCAR (Vunread_command_events
);
3833 Vunread_command_events
= XCDR (Vunread_command_events
);
3834 *kbp
= current_kboard
;
3838 /* At this point, we know that there is a readable event available
3839 somewhere. If the event queue is empty, then there must be a
3840 mouse movement enabled and available. */
3841 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3843 union buffered_input_event
*event
;
3845 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3849 *kbp
= event_to_kboard (&event
->ie
);
3851 *kbp
= current_kboard
; /* Better than returning null ptr? */
3855 /* These two kinds of events get special handling
3856 and don't actually appear to the command loop.
3857 We return nil for them. */
3858 if (event
->kind
== SELECTION_REQUEST_EVENT
3859 || event
->kind
== SELECTION_CLEAR_EVENT
)
3862 /* Remove it from the buffer before processing it,
3863 since otherwise swallow_events will see it
3864 and process it again. */
3865 struct selection_input_event copy
= event
->sie
;
3866 kbd_fetch_ptr
= event
+ 1;
3867 input_pending
= readable_events (0);
3868 x_handle_selection_event (©
);
3870 /* We're getting selection request events, but we don't have
3876 #if defined (HAVE_NS)
3877 else if (event
->kind
== NS_TEXT_EVENT
)
3879 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3880 obj
= list1 (intern ("ns-put-working-text"));
3882 obj
= list1 (intern ("ns-unput-working-text"));
3883 kbd_fetch_ptr
= event
+ 1;
3884 if (used_mouse_menu
)
3885 *used_mouse_menu
= true;
3889 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3890 || defined (HAVE_NS)
3891 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3893 /* Make an event (delete-frame (FRAME)). */
3894 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
3895 kbd_fetch_ptr
= event
+ 1;
3900 else if (event
->kind
== END_SESSION_EVENT
)
3902 /* Make an event (end-session). */
3903 obj
= list1 (Qend_session
);
3904 kbd_fetch_ptr
= event
+ 1;
3908 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3909 || defined (HAVE_NS)
3910 else if (event
->kind
== ICONIFY_EVENT
)
3912 /* Make an event (iconify-frame (FRAME)). */
3913 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
3914 kbd_fetch_ptr
= event
+ 1;
3916 else if (event
->kind
== DEICONIFY_EVENT
)
3918 /* Make an event (make-frame-visible (FRAME)). */
3919 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
3920 kbd_fetch_ptr
= event
+ 1;
3923 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3925 /* The value doesn't matter here; only the type is tested. */
3926 XSETBUFFER (obj
, current_buffer
);
3927 kbd_fetch_ptr
= event
+ 1;
3929 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3930 || defined (HAVE_NS) || defined (USE_GTK)
3931 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3933 kbd_fetch_ptr
= event
+ 1;
3934 input_pending
= readable_events (0);
3935 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
3936 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
3940 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3942 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3943 obj
= list4 (Qlanguage_change
,
3944 event
->ie
.frame_or_window
,
3945 make_number (event
->ie
.code
),
3946 make_number (event
->ie
.modifiers
));
3947 kbd_fetch_ptr
= event
+ 1;
3950 #ifdef USE_FILE_NOTIFY
3951 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3953 #ifdef HAVE_W32NOTIFY
3954 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3955 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
3957 obj
= make_lispy_event (&event
->ie
);
3959 kbd_fetch_ptr
= event
+ 1;
3961 #endif /* USE_FILE_NOTIFY */
3962 else if (event
->kind
== SAVE_SESSION_EVENT
)
3964 obj
= list2 (Qsave_session
, event
->ie
.arg
);
3965 kbd_fetch_ptr
= event
+ 1;
3967 /* Just discard these, by returning nil.
3968 With MULTI_KBOARD, these events are used as placeholders
3969 when we need to randomly delete events from the queue.
3970 (They shouldn't otherwise be found in the buffer,
3971 but on some machines it appears they do show up
3972 even without MULTI_KBOARD.) */
3973 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3974 mouse events during a popup-menu call. */
3975 else if (event
->kind
== NO_EVENT
)
3976 kbd_fetch_ptr
= event
+ 1;
3977 else if (event
->kind
== HELP_EVENT
)
3979 Lisp_Object object
, position
, help
, frame
, window
;
3981 frame
= event
->ie
.frame_or_window
;
3982 object
= event
->ie
.arg
;
3983 position
= make_number (Time_to_position (event
->ie
.timestamp
));
3984 window
= event
->ie
.x
;
3986 clear_event (event
);
3988 kbd_fetch_ptr
= event
+ 1;
3989 if (!WINDOWP (window
))
3991 obj
= Fcons (Qhelp_echo
,
3992 list5 (frame
, help
, window
, object
, position
));
3994 else if (event
->kind
== FOCUS_IN_EVENT
)
3996 /* Notification of a FocusIn event. The frame receiving the
3997 focus is in event->frame_or_window. Generate a
3998 switch-frame event if necessary. */
3999 Lisp_Object frame
, focus
;
4001 frame
= event
->ie
.frame_or_window
;
4002 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4008 ! NILP (event
->ie
.arg
)
4011 !EQ (frame
, internal_last_event_frame
)
4012 && !EQ (frame
, selected_frame
))
4013 obj
= make_lispy_switch_frame (frame
);
4015 obj
= make_lispy_focus_in (frame
);
4017 internal_last_event_frame
= frame
;
4018 kbd_fetch_ptr
= event
+ 1;
4020 else if (event
->kind
== FOCUS_OUT_EVENT
)
4022 #ifdef HAVE_WINDOW_SYSTEM
4025 Lisp_Object frame
= event
->ie
.frame_or_window
;
4026 bool focused
= false;
4028 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4029 focused
= di
->x_highlight_frame
!= 0;
4032 obj
= make_lispy_focus_out (frame
);
4034 #endif /* HAVE_WINDOW_SYSTEM */
4036 kbd_fetch_ptr
= event
+ 1;
4039 else if (event
->kind
== DBUS_EVENT
)
4041 obj
= make_lispy_event (&event
->ie
);
4042 kbd_fetch_ptr
= event
+ 1;
4045 #ifdef HAVE_XWIDGETS
4046 else if (event
->kind
== XWIDGET_EVENT
)
4048 obj
= make_lispy_event (&event
->ie
);
4049 kbd_fetch_ptr
= event
+ 1;
4052 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4054 obj
= make_lispy_event (&event
->ie
);
4055 kbd_fetch_ptr
= event
+ 1;
4059 /* If this event is on a different frame, return a switch-frame this
4060 time, and leave the event in the queue for next time. */
4064 frame
= event
->ie
.frame_or_window
;
4066 frame
= XCAR (frame
);
4067 else if (WINDOWP (frame
))
4068 frame
= WINDOW_FRAME (XWINDOW (frame
));
4070 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4074 if (! EQ (frame
, internal_last_event_frame
)
4075 && !EQ (frame
, selected_frame
))
4076 obj
= make_lispy_switch_frame (frame
);
4077 internal_last_event_frame
= frame
;
4079 /* If we didn't decide to make a switch-frame event, go ahead
4080 and build a real event from the queue entry. */
4084 obj
= make_lispy_event (&event
->ie
);
4086 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4087 || defined (HAVE_NS) || defined (USE_GTK)
4088 /* If this was a menu selection, then set the flag to inhibit
4089 writing to last_nonmenu_event. Don't do this if the event
4090 we're returning is (menu-bar), though; that indicates the
4091 beginning of the menu sequence, and we might as well leave
4092 that as the `event with parameters' for this selection. */
4094 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4095 && (event
->kind
== MENU_BAR_EVENT
4096 || event
->kind
== TOOL_BAR_EVENT
))
4097 *used_mouse_menu
= true;
4100 /* Certain system events are non-key events. */
4102 && event
->kind
== NS_NONKEY_EVENT
)
4103 *used_mouse_menu
= true;
4106 /* Wipe out this event, to catch bugs. */
4107 clear_event (event
);
4108 kbd_fetch_ptr
= event
+ 1;
4112 /* Try generating a mouse motion event. */
4113 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4115 struct frame
*f
= some_mouse_moved ();
4116 Lisp_Object bar_window
;
4117 enum scroll_bar_part part
;
4121 *kbp
= current_kboard
;
4122 /* Note that this uses F to determine which terminal to look at.
4123 If there is no valid info, it does not store anything
4124 so x remains nil. */
4127 /* XXX Can f or mouse_position_hook be NULL here? */
4128 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4129 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4134 /* Decide if we should generate a switch-frame event. Don't
4135 generate switch-frame events for motion outside of all Emacs
4141 frame
= FRAME_FOCUS_FRAME (f
);
4143 XSETFRAME (frame
, f
);
4145 if (! EQ (frame
, internal_last_event_frame
)
4146 && !EQ (frame
, selected_frame
))
4147 obj
= make_lispy_switch_frame (frame
);
4148 internal_last_event_frame
= frame
;
4151 /* If we didn't decide to make a switch-frame event, go ahead and
4152 return a mouse-motion event. */
4153 if (!NILP (x
) && NILP (obj
))
4154 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4157 /* We were promised by the above while loop that there was
4158 something for us to read! */
4161 input_pending
= readable_events (0);
4163 Vlast_event_frame
= internal_last_event_frame
;
4168 /* Process any non-user-visible events (currently X selection events),
4169 without reading any user-visible events. */
4172 process_special_events (void)
4174 union buffered_input_event
*event
;
4176 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4178 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4181 if (event
== kbd_store_ptr
)
4185 /* If we find a stored X selection request, handle it now. */
4186 if (event
->kind
== SELECTION_REQUEST_EVENT
4187 || event
->kind
== SELECTION_CLEAR_EVENT
)
4191 /* Remove the event from the fifo buffer before processing;
4192 otherwise swallow_events called recursively could see it
4193 and process it again. To do this, we move the events
4194 between kbd_fetch_ptr and EVENT one slot to the right,
4197 struct selection_input_event copy
= event
->sie
;
4198 union buffered_input_event
*beg
4199 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4200 ? kbd_buffer
: kbd_fetch_ptr
;
4203 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4204 else if (event
< beg
)
4206 if (event
> kbd_buffer
)
4207 memmove (kbd_buffer
+ 1, kbd_buffer
,
4208 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4209 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4210 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4211 memmove (beg
+ 1, beg
,
4212 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4215 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4216 kbd_fetch_ptr
= kbd_buffer
+ 1;
4220 input_pending
= readable_events (0);
4221 x_handle_selection_event (©
);
4223 /* We're getting selection request events, but we don't have
4231 /* Process any events that are not user-visible, run timer events that
4232 are ripe, and return, without reading any user-visible events. */
4235 swallow_events (bool do_display
)
4237 unsigned old_timers_run
;
4239 process_special_events ();
4241 old_timers_run
= timers_run
;
4242 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4244 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4245 redisplay_preserve_echo_area (7);
4248 /* Record the start of when Emacs is idle,
4249 for the sake of running idle-time timers. */
4252 timer_start_idle (void)
4254 /* If we are already in the idle state, do nothing. */
4255 if (timespec_valid_p (timer_idleness_start_time
))
4258 timer_idleness_start_time
= current_timespec ();
4259 timer_last_idleness_start_time
= timer_idleness_start_time
;
4261 /* Mark all idle-time timers as once again candidates for running. */
4262 call0 (intern ("internal-timer-start-idle"));
4265 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4268 timer_stop_idle (void)
4270 timer_idleness_start_time
= invalid_timespec ();
4273 /* Resume idle timer from last idle start time. */
4276 timer_resume_idle (void)
4278 if (timespec_valid_p (timer_idleness_start_time
))
4281 timer_idleness_start_time
= timer_last_idleness_start_time
;
4284 /* List of elisp functions to call, delayed because they were generated in
4285 a context where Elisp could not be safely run (e.g. redisplay, signal,
4286 ...). Each element has the form (FUN . ARGS). */
4287 Lisp_Object pending_funcalls
;
4289 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4291 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4295 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4297 vec
= XVECTOR (timer
)->contents
;
4298 if (! NILP (vec
[0]))
4300 if (! INTEGERP (vec
[2]))
4304 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4306 *result
= lisp_to_timespec (t
);
4307 return timespec_valid_p (*result
);
4311 /* Check whether a timer has fired. To prevent larger problems we simply
4312 disregard elements that are not proper timers. Do not make a circular
4313 timer list for the time being.
4315 Returns the time to wait until the next timer fires. If a
4316 timer is triggering now, return zero.
4317 If no timer is active, return -1.
4319 If a timer is ripe, we run it, with quitting turned off.
4320 In that case we return 0 to indicate that a new timer_check_2 call
4323 static struct timespec
4324 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4326 struct timespec nexttime
;
4327 struct timespec now
;
4328 struct timespec idleness_now
;
4329 Lisp_Object chosen_timer
;
4331 nexttime
= invalid_timespec ();
4333 chosen_timer
= Qnil
;
4335 /* First run the code that was delayed. */
4336 while (CONSP (pending_funcalls
))
4338 Lisp_Object funcall
= XCAR (pending_funcalls
);
4339 pending_funcalls
= XCDR (pending_funcalls
);
4340 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4343 if (CONSP (timers
) || CONSP (idle_timers
))
4345 now
= current_timespec ();
4346 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4347 ? timespec_sub (now
, timer_idleness_start_time
)
4348 : make_timespec (0, 0));
4351 while (CONSP (timers
) || CONSP (idle_timers
))
4353 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4354 struct timespec timer_time
, idle_timer_time
;
4355 struct timespec difference
;
4356 struct timespec timer_difference
= invalid_timespec ();
4357 struct timespec idle_timer_difference
= invalid_timespec ();
4358 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4360 /* Set TIMER and TIMER_DIFFERENCE
4361 based on the next ordinary timer.
4362 TIMER_DIFFERENCE is the distance in time from NOW to when
4363 this timer becomes ripe.
4364 Skip past invalid timers and timers already handled. */
4367 timer
= XCAR (timers
);
4368 if (! decode_timer (timer
, &timer_time
))
4370 timers
= XCDR (timers
);
4374 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4375 timer_difference
= (timer_ripe
4376 ? timespec_sub (now
, timer_time
)
4377 : timespec_sub (timer_time
, now
));
4380 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4381 based on the next idle timer. */
4382 if (CONSP (idle_timers
))
4384 idle_timer
= XCAR (idle_timers
);
4385 if (! decode_timer (idle_timer
, &idle_timer_time
))
4387 idle_timers
= XCDR (idle_timers
);
4391 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4392 idle_timer_difference
4394 ? timespec_sub (idleness_now
, idle_timer_time
)
4395 : timespec_sub (idle_timer_time
, idleness_now
));
4398 /* Decide which timer is the next timer,
4399 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4400 Also step down the list where we found that timer. */
4402 if (timespec_valid_p (timer_difference
)
4403 && (! timespec_valid_p (idle_timer_difference
)
4404 || idle_timer_ripe
< timer_ripe
4405 || (idle_timer_ripe
== timer_ripe
4407 ? timespec_cmp (idle_timer_difference
,
4409 : timespec_cmp (timer_difference
,
4410 idle_timer_difference
))
4413 chosen_timer
= timer
;
4414 timers
= XCDR (timers
);
4415 difference
= timer_difference
;
4420 chosen_timer
= idle_timer
;
4421 idle_timers
= XCDR (idle_timers
);
4422 difference
= idle_timer_difference
;
4423 ripe
= idle_timer_ripe
;
4426 /* If timer is ripe, run it if it hasn't been run. */
4429 if (NILP (AREF (chosen_timer
, 0)))
4431 ptrdiff_t count
= SPECPDL_INDEX ();
4432 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4434 /* Mark the timer as triggered to prevent problems if the lisp
4435 code fails to reschedule it right. */
4436 ASET (chosen_timer
, 0, Qt
);
4438 specbind (Qinhibit_quit
, Qt
);
4440 call1 (Qtimer_event_handler
, chosen_timer
);
4441 Vdeactivate_mark
= old_deactivate_mark
;
4443 unbind_to (count
, Qnil
);
4445 /* Since we have handled the event,
4446 we don't need to tell the caller to wake up and do it. */
4447 /* But the caller must still wait for the next timer, so
4448 return 0 to indicate that. */
4451 nexttime
= make_timespec (0, 0);
4455 /* When we encounter a timer that is still waiting,
4456 return the amount of time to wait before it is ripe. */
4462 /* No timers are pending in the future. */
4463 /* Return 0 if we generated an event, and -1 if not. */
4468 /* Check whether a timer has fired. To prevent larger problems we simply
4469 disregard elements that are not proper timers. Do not make a circular
4470 timer list for the time being.
4472 Returns the time to wait until the next timer fires.
4473 If no timer is active, return an invalid value.
4475 As long as any timer is ripe, we run it. */
4480 struct timespec nexttime
;
4481 Lisp_Object timers
, idle_timers
;
4483 Lisp_Object tem
= Vinhibit_quit
;
4486 /* We use copies of the timers' lists to allow a timer to add itself
4487 again, without locking up Emacs if the newly added timer is
4488 already ripe when added. */
4490 /* Always consider the ordinary timers. */
4491 timers
= Fcopy_sequence (Vtimer_list
);
4492 /* Consider the idle timers only if Emacs is idle. */
4493 if (timespec_valid_p (timer_idleness_start_time
))
4494 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4498 Vinhibit_quit
= tem
;
4502 nexttime
= timer_check_2 (timers
, idle_timers
);
4504 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4509 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4510 doc
: /* Return the current length of Emacs idleness, or nil.
4511 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4512 in the same style as (current-time).
4514 The value when Emacs is not idle is nil.
4516 PSEC is a multiple of the system clock resolution. */)
4519 if (timespec_valid_p (timer_idleness_start_time
))
4520 return make_lisp_time (timespec_sub (current_timespec (),
4521 timer_idleness_start_time
));
4526 /* Caches for modify_event_symbol. */
4527 static Lisp_Object accent_key_syms
;
4528 static Lisp_Object func_key_syms
;
4529 static Lisp_Object mouse_syms
;
4530 static Lisp_Object wheel_syms
;
4531 static Lisp_Object drag_n_drop_syms
;
4533 /* This is a list of keysym codes for special "accent" characters.
4534 It parallels lispy_accent_keys. */
4536 static const int lispy_accent_codes
[] =
4538 #ifdef XK_dead_circumflex
4543 #ifdef XK_dead_grave
4548 #ifdef XK_dead_tilde
4553 #ifdef XK_dead_diaeresis
4558 #ifdef XK_dead_macron
4563 #ifdef XK_dead_degree
4568 #ifdef XK_dead_acute
4573 #ifdef XK_dead_cedilla
4578 #ifdef XK_dead_breve
4583 #ifdef XK_dead_ogonek
4588 #ifdef XK_dead_caron
4593 #ifdef XK_dead_doubleacute
4594 XK_dead_doubleacute
,
4598 #ifdef XK_dead_abovedot
4603 #ifdef XK_dead_abovering
4613 #ifdef XK_dead_belowdot
4618 #ifdef XK_dead_voiced_sound
4619 XK_dead_voiced_sound
,
4623 #ifdef XK_dead_semivoiced_sound
4624 XK_dead_semivoiced_sound
,
4640 /* This is a list of Lisp names for special "accent" characters.
4641 It parallels lispy_accent_codes. */
4643 static const char *const lispy_accent_keys
[] =
4661 "dead-voiced-sound",
4662 "dead-semivoiced-sound",
4668 #define FUNCTION_KEY_OFFSET 0x0
4670 const char *const lispy_function_keys
[] =
4674 0, /* VK_LBUTTON 0x01 */
4675 0, /* VK_RBUTTON 0x02 */
4676 "cancel", /* VK_CANCEL 0x03 */
4677 0, /* VK_MBUTTON 0x04 */
4679 0, 0, 0, /* 0x05 .. 0x07 */
4681 "backspace", /* VK_BACK 0x08 */
4682 "tab", /* VK_TAB 0x09 */
4684 0, 0, /* 0x0A .. 0x0B */
4686 "clear", /* VK_CLEAR 0x0C */
4687 "return", /* VK_RETURN 0x0D */
4689 0, 0, /* 0x0E .. 0x0F */
4691 0, /* VK_SHIFT 0x10 */
4692 0, /* VK_CONTROL 0x11 */
4693 0, /* VK_MENU 0x12 */
4694 "pause", /* VK_PAUSE 0x13 */
4695 "capslock", /* VK_CAPITAL 0x14 */
4696 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4698 "junja", /* VK_JUNJA 0x17 */
4699 "final", /* VK_FINAL 0x18 */
4700 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4702 "escape", /* VK_ESCAPE 0x1B */
4703 "convert", /* VK_CONVERT 0x1C */
4704 "non-convert", /* VK_NONCONVERT 0x1D */
4705 "accept", /* VK_ACCEPT 0x1E */
4706 "mode-change", /* VK_MODECHANGE 0x1F */
4707 0, /* VK_SPACE 0x20 */
4708 "prior", /* VK_PRIOR 0x21 */
4709 "next", /* VK_NEXT 0x22 */
4710 "end", /* VK_END 0x23 */
4711 "home", /* VK_HOME 0x24 */
4712 "left", /* VK_LEFT 0x25 */
4713 "up", /* VK_UP 0x26 */
4714 "right", /* VK_RIGHT 0x27 */
4715 "down", /* VK_DOWN 0x28 */
4716 "select", /* VK_SELECT 0x29 */
4717 "print", /* VK_PRINT 0x2A */
4718 "execute", /* VK_EXECUTE 0x2B */
4719 "snapshot", /* VK_SNAPSHOT 0x2C */
4720 "insert", /* VK_INSERT 0x2D */
4721 "delete", /* VK_DELETE 0x2E */
4722 "help", /* VK_HELP 0x2F */
4724 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4726 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4728 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4730 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4732 0, 0, 0, 0, 0, 0, 0, 0, 0,
4733 0, 0, 0, 0, 0, 0, 0, 0, 0,
4734 0, 0, 0, 0, 0, 0, 0, 0,
4736 "lwindow", /* VK_LWIN 0x5B */
4737 "rwindow", /* VK_RWIN 0x5C */
4738 "apps", /* VK_APPS 0x5D */
4741 "kp-0", /* VK_NUMPAD0 0x60 */
4742 "kp-1", /* VK_NUMPAD1 0x61 */
4743 "kp-2", /* VK_NUMPAD2 0x62 */
4744 "kp-3", /* VK_NUMPAD3 0x63 */
4745 "kp-4", /* VK_NUMPAD4 0x64 */
4746 "kp-5", /* VK_NUMPAD5 0x65 */
4747 "kp-6", /* VK_NUMPAD6 0x66 */
4748 "kp-7", /* VK_NUMPAD7 0x67 */
4749 "kp-8", /* VK_NUMPAD8 0x68 */
4750 "kp-9", /* VK_NUMPAD9 0x69 */
4751 "kp-multiply", /* VK_MULTIPLY 0x6A */
4752 "kp-add", /* VK_ADD 0x6B */
4753 "kp-separator", /* VK_SEPARATOR 0x6C */
4754 "kp-subtract", /* VK_SUBTRACT 0x6D */
4755 "kp-decimal", /* VK_DECIMAL 0x6E */
4756 "kp-divide", /* VK_DIVIDE 0x6F */
4757 "f1", /* VK_F1 0x70 */
4758 "f2", /* VK_F2 0x71 */
4759 "f3", /* VK_F3 0x72 */
4760 "f4", /* VK_F4 0x73 */
4761 "f5", /* VK_F5 0x74 */
4762 "f6", /* VK_F6 0x75 */
4763 "f7", /* VK_F7 0x76 */
4764 "f8", /* VK_F8 0x77 */
4765 "f9", /* VK_F9 0x78 */
4766 "f10", /* VK_F10 0x79 */
4767 "f11", /* VK_F11 0x7A */
4768 "f12", /* VK_F12 0x7B */
4769 "f13", /* VK_F13 0x7C */
4770 "f14", /* VK_F14 0x7D */
4771 "f15", /* VK_F15 0x7E */
4772 "f16", /* VK_F16 0x7F */
4773 "f17", /* VK_F17 0x80 */
4774 "f18", /* VK_F18 0x81 */
4775 "f19", /* VK_F19 0x82 */
4776 "f20", /* VK_F20 0x83 */
4777 "f21", /* VK_F21 0x84 */
4778 "f22", /* VK_F22 0x85 */
4779 "f23", /* VK_F23 0x86 */
4780 "f24", /* VK_F24 0x87 */
4782 0, 0, 0, 0, /* 0x88 .. 0x8B */
4783 0, 0, 0, 0, /* 0x8C .. 0x8F */
4785 "kp-numlock", /* VK_NUMLOCK 0x90 */
4786 "scroll", /* VK_SCROLL 0x91 */
4787 /* Not sure where the following block comes from.
4788 Windows headers have NEC and Fujitsu specific keys in
4789 this block, but nothing generic. */
4790 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4791 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4792 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4793 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4794 "kp-end", /* VK_NUMPAD_END 0x96 */
4795 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4796 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4797 "kp-up", /* VK_NUMPAD_UP 0x99 */
4798 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4799 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4800 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4801 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4803 0, 0, /* 0x9E .. 0x9F */
4806 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4807 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4808 * No other API or message will distinguish left and right keys this way.
4813 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4814 to enable them selectively, and gives access to a few more functions.
4815 See lispy_multimedia_keys below. */
4816 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4817 0, 0, 0, /* 0xAD .. 0xAF Volume */
4818 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4819 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4821 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4822 0, 0, 0, 0, 0, 0, 0, 0, 0,
4824 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4825 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4826 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4829 "ax", /* VK_OEM_AX 0xE1 */
4830 0, /* VK_OEM_102 0xE2 */
4831 "ico-help", /* VK_ICO_HELP 0xE3 */
4832 "ico-00", /* VK_ICO_00 0xE4 */
4833 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4834 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4835 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4837 "reset", /* VK_OEM_RESET 0xE9 */
4838 "jump", /* VK_OEM_JUMP 0xEA */
4839 "oem-pa1", /* VK_OEM_PA1 0xEB */
4840 "oem-pa2", /* VK_OEM_PA2 0xEC */
4841 "oem-pa3", /* VK_OEM_PA3 0xED */
4842 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4843 "cusel", /* VK_OEM_CUSEL 0xEF */
4844 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4845 "finish", /* VK_OEM_FINISH 0xF1 */
4846 "copy", /* VK_OEM_COPY 0xF2 */
4847 "auto", /* VK_OEM_AUTO 0xF3 */
4848 "enlw", /* VK_OEM_ENLW 0xF4 */
4849 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4850 "attn", /* VK_ATTN 0xF6 */
4851 "crsel", /* VK_CRSEL 0xF7 */
4852 "exsel", /* VK_EXSEL 0xF8 */
4853 "ereof", /* VK_EREOF 0xF9 */
4854 "play", /* VK_PLAY 0xFA */
4855 "zoom", /* VK_ZOOM 0xFB */
4856 "noname", /* VK_NONAME 0xFC */
4857 "pa1", /* VK_PA1 0xFD */
4858 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4862 /* Some of these duplicate the "Media keys" on newer keyboards,
4863 but they are delivered to the application in a different way. */
4864 static const char *const lispy_multimedia_keys
[] =
4872 "browser-favorites",
4909 "toggle-dictate-command",
4915 "media-fast-forward",
4918 "media-channel-down"
4921 #else /* not HAVE_NTGUI */
4923 /* This should be dealt with in XTread_socket now, and that doesn't
4924 depend on the client system having the Kana syms defined. See also
4925 the XK_kana_A case below. */
4928 static const char *const lispy_kana_keys
[] =
4930 /* X Keysym value */
4931 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4932 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4933 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4934 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4935 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4936 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4937 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4938 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4939 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4940 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4941 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4942 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4943 "kana-i", "kana-u", "kana-e", "kana-o",
4944 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4945 "prolongedsound", "kana-A", "kana-I", "kana-U",
4946 "kana-E", "kana-O", "kana-KA", "kana-KI",
4947 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4948 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4949 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4950 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4951 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4952 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4953 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4954 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4955 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4956 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4957 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4958 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4960 #endif /* XK_kana_A */
4963 #define FUNCTION_KEY_OFFSET 0xff00
4965 /* You'll notice that this table is arranged to be conveniently
4966 indexed by X Windows keysym values. */
4967 static const char *const lispy_function_keys
[] =
4969 /* X Keysym value */
4971 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4972 "backspace", "tab", "linefeed", "clear",
4974 0, 0, 0, "pause", /* 0xff10...1f */
4975 0, 0, 0, 0, 0, 0, 0, "escape",
4977 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4978 "romaji", "hiragana", "katakana", "hiragana-katakana",
4979 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4980 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4981 "eisu-toggle", /* 0xff30...3f */
4982 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4983 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4985 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4986 "down", "prior", "next", "end",
4987 "begin", 0, 0, 0, 0, 0, 0, 0,
4988 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4999 "break", /* 0xff6b */
5002 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5003 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5004 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5005 0, 0, 0, 0, 0, 0, 0, 0,
5006 "kp-tab", /* 0xff89 */
5008 "kp-enter", /* 0xff8d */
5010 "kp-f1", /* 0xff91 */
5014 "kp-home", /* 0xff95 */
5019 "kp-prior", /* kp-page-up */
5020 "kp-next", /* kp-page-down */
5026 0, 0, 0, 0, 0, 0, 0, 0, 0,
5027 "kp-multiply", /* 0xffaa */
5032 "kp-divide", /* 0xffaf */
5033 "kp-0", /* 0xffb0 */
5034 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5037 "kp-equal", /* 0xffbd */
5038 "f1", /* 0xffbe */ /* IsFunctionKey */
5040 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5041 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5042 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5043 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5044 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5045 0, 0, 0, 0, 0, 0, 0, 0,
5046 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5047 0, 0, 0, 0, 0, 0, 0, "delete"
5050 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5051 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5053 static const char *const iso_lispy_function_keys
[] =
5055 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5056 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5057 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5058 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5059 "iso-lefttab", /* 0xfe20 */
5060 "iso-move-line-up", "iso-move-line-down",
5061 "iso-partial-line-up", "iso-partial-line-down",
5062 "iso-partial-space-left", "iso-partial-space-right",
5063 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5064 "iso-release-margin-left", "iso-release-margin-right",
5065 "iso-release-both-margins",
5066 "iso-fast-cursor-left", "iso-fast-cursor-right",
5067 "iso-fast-cursor-up", "iso-fast-cursor-down",
5068 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5069 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5072 #endif /* not HAVE_NTGUI */
5074 static Lisp_Object Vlispy_mouse_stem
;
5076 static const char *const lispy_wheel_names
[] =
5078 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5081 /* drag-n-drop events are generated when a set of selected files are
5082 dragged from another application and dropped onto an Emacs window. */
5083 static const char *const lispy_drag_n_drop_names
[] =
5088 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5089 scroll_bar_part value. Note that Qnil corresponds to
5090 scroll_bar_nowhere and should not appear in Lisp events. */
5091 static short const scroll_bar_parts
[] = {
5092 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5093 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5094 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5095 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5096 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5097 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5098 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5101 /* A vector, indexed by button number, giving the down-going location
5102 of currently depressed buttons, both scroll bar and non-scroll bar.
5104 The elements have the form
5105 (BUTTON-NUMBER MODIFIER-MASK . REST)
5106 where REST is the cdr of a position as it would be reported in the event.
5108 The make_lispy_event function stores positions here to tell the
5109 difference between click and drag events, and to store the starting
5110 location to be included in drag events. */
5112 static Lisp_Object button_down_location
;
5114 /* Information about the most recent up-going button event: Which
5115 button, what location, and what time. */
5117 static int last_mouse_button
;
5118 static int last_mouse_x
;
5119 static int last_mouse_y
;
5120 static Time button_down_time
;
5122 /* The number of clicks in this multiple-click. */
5124 static int double_click_count
;
5126 /* X and Y are frame-relative coordinates for a click or wheel event.
5127 Return a Lisp-style event list. */
5130 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5133 enum window_part part
;
5134 Lisp_Object posn
= Qnil
;
5135 Lisp_Object extra_info
= Qnil
;
5136 /* Coordinate pixel positions to return. */
5137 int xret
= 0, yret
= 0;
5138 /* The window under frame pixel coordinates (x,y) */
5139 Lisp_Object window
= f
5140 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5143 if (WINDOWP (window
))
5145 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5146 struct window
*w
= XWINDOW (window
);
5147 Lisp_Object string_info
= Qnil
;
5148 ptrdiff_t textpos
= 0;
5149 int col
= -1, row
= -1;
5150 int dx
= -1, dy
= -1;
5151 int width
= -1, height
= -1;
5152 Lisp_Object object
= Qnil
;
5154 /* Pixel coordinates relative to the window corner. */
5155 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5156 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5158 /* For text area clicks, return X, Y relative to the corner of
5159 this text area. Note that dX, dY etc are set below, by
5160 buffer_posn_from_coords. */
5161 if (part
== ON_TEXT
)
5163 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5164 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5166 /* For mode line and header line clicks, return X, Y relative to
5167 the left window edge. Use mode_line_string to look for a
5168 string on the click position. */
5169 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5174 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5175 /* Note that mode_line_string takes COL, ROW as pixels and
5176 converts them to characters. */
5179 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5180 &object
, &dx
, &dy
, &width
, &height
);
5181 if (STRINGP (string
))
5182 string_info
= Fcons (string
, make_number (charpos
));
5188 /* For fringes and margins, Y is relative to the area's (and the
5189 window's) top edge, while X is meaningless. */
5190 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5195 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5198 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5199 &object
, &dx
, &dy
, &width
, &height
);
5200 if (STRINGP (string
))
5201 string_info
= Fcons (string
, make_number (charpos
));
5203 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5205 else if (part
== ON_LEFT_FRINGE
)
5207 posn
= Qleft_fringe
;
5211 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5212 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5213 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5215 else if (part
== ON_RIGHT_FRINGE
)
5217 posn
= Qright_fringe
;
5221 - window_box_width (w
, LEFT_MARGIN_AREA
)
5222 - window_box_width (w
, TEXT_AREA
)
5223 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5224 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5226 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5228 else if (part
== ON_VERTICAL_BORDER
)
5230 posn
= Qvertical_line
;
5236 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5238 posn
= Qvertical_scroll_bar
;
5239 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5243 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5245 posn
= Qhorizontal_scroll_bar
;
5246 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5250 else if (part
== ON_RIGHT_DIVIDER
)
5252 posn
= Qright_divider
;
5253 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5257 else if (part
== ON_BOTTOM_DIVIDER
)
5259 posn
= Qbottom_divider
;
5260 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5265 /* For clicks in the text area, fringes, margins, or vertical
5266 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5267 the buffer position nearest to the click. */
5270 Lisp_Object string2
, object2
= Qnil
;
5271 struct display_pos p
;
5273 int width2
, height2
;
5274 /* The pixel X coordinate passed to buffer_posn_from_coords
5275 is the X coordinate relative to the text area for clicks
5276 in text-area, right-margin/fringe and right-side vertical
5277 scroll bar, zero otherwise. */
5279 = (part
== ON_TEXT
) ? xret
5280 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5281 || (part
== ON_VERTICAL_SCROLL_BAR
5282 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5283 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5287 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5288 &object2
, &dx2
, &dy2
,
5290 textpos
= CHARPOS (p
.pos
);
5291 if (col
< 0) col
= x2
;
5292 if (row
< 0) row
= y2
;
5293 if (dx
< 0) dx
= dx2
;
5294 if (dy
< 0) dy
= dy2
;
5295 if (width
< 0) width
= width2
;
5296 if (height
< 0) height
= height2
;
5300 posn
= make_number (textpos
);
5301 if (STRINGP (string2
))
5302 string_info
= Fcons (string2
,
5303 make_number (CHARPOS (p
.string_pos
)));
5309 #ifdef HAVE_WINDOW_SYSTEM
5310 if (IMAGEP (object
))
5312 Lisp_Object image_map
, hotspot
;
5313 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5315 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5317 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5318 posn
= XCAR (hotspot
);
5325 Fcons (make_number (dx
), make_number (dy
)),
5326 Fcons (make_number (width
), make_number (height
)));
5329 extra_info
= Fcons (string_info
,
5330 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5331 Fcons (Fcons (make_number (col
),
5337 /* Return mouse pixel coordinates here. */
5338 XSETFRAME (window
, f
);
5345 return Fcons (window
,
5347 Fcons (Fcons (make_number (xret
),
5348 make_number (yret
)),
5349 Fcons (make_number (t
),
5353 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5354 menu bar. This really means that Emacs draws and manages the menu
5355 bar as part of its normal display, and therefore can compute its
5358 toolkit_menubar_in_use (struct frame
*f
)
5360 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5361 return !(!FRAME_WINDOW_P (f
));
5367 /* Build the part of Lisp event which represents scroll bar state from
5368 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5371 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5373 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5374 make_number (ev
->timestamp
),
5375 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5378 /* Given a struct input_event, build the lisp event which represents
5379 it. If EVENT is 0, build a mouse movement event from the mouse
5380 movement buffer, which should have a movement event in it.
5382 Note that events must be passed to this function in the order they
5383 are received; this function stores the location of button presses
5384 in order to build drag events when the button is released. */
5387 make_lispy_event (struct input_event
*event
)
5391 switch (event
->kind
)
5393 /* A simple keystroke. */
5394 case ASCII_KEYSTROKE_EVENT
:
5395 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5397 Lisp_Object lispy_c
;
5398 EMACS_INT c
= event
->code
;
5399 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5402 eassert (c
== event
->code
);
5403 /* Turn ASCII characters into control characters
5405 if (event
->modifiers
& ctrl_modifier
)
5407 c
= make_ctrl_char (c
);
5408 event
->modifiers
&= ~ctrl_modifier
;
5412 /* Add in the other modifier bits. The shift key was taken care
5413 of by the X code. */
5414 c
|= (event
->modifiers
5415 & (meta_modifier
| alt_modifier
5416 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5417 /* Distinguish Shift-SPC from SPC. */
5418 if ((event
->code
) == 040
5419 && event
->modifiers
& shift_modifier
)
5420 c
|= shift_modifier
;
5421 button_down_time
= 0;
5422 XSETFASTINT (lispy_c
, c
);
5427 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5428 except that they are non-key events (last-nonmenu-event is nil). */
5429 case NS_NONKEY_EVENT
:
5432 /* A function key. The symbol may need to have modifier prefixes
5434 case NON_ASCII_KEYSTROKE_EVENT
:
5435 button_down_time
= 0;
5437 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5438 if (event
->code
== lispy_accent_codes
[i
])
5439 return modify_event_symbol (i
,
5441 Qfunction_key
, Qnil
,
5442 lispy_accent_keys
, &accent_key_syms
,
5443 ARRAYELTS (lispy_accent_keys
));
5447 if (event
->code
>= 0x400 && event
->code
< 0x500)
5448 return modify_event_symbol (event
->code
- 0x400,
5449 event
->modifiers
& ~shift_modifier
,
5450 Qfunction_key
, Qnil
,
5451 lispy_kana_keys
, &func_key_syms
,
5452 ARRAYELTS (lispy_kana_keys
));
5453 #endif /* XK_kana_A */
5456 #ifdef ISO_FUNCTION_KEY_OFFSET
5457 if (event
->code
< FUNCTION_KEY_OFFSET
5458 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5459 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5461 Qfunction_key
, Qnil
,
5462 iso_lispy_function_keys
, &func_key_syms
,
5463 ARRAYELTS (iso_lispy_function_keys
));
5466 if ((FUNCTION_KEY_OFFSET
<= event
->code
5468 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5469 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5470 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5472 Qfunction_key
, Qnil
,
5473 lispy_function_keys
, &func_key_syms
,
5474 ARRAYELTS (lispy_function_keys
));
5476 /* Handle system-specific or unknown keysyms.
5477 We need to use an alist rather than a vector as the cache
5478 since we can't make a vector long enough. */
5479 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5480 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5481 return modify_event_symbol (event
->code
,
5484 KVAR (current_kboard
, Vsystem_key_alist
),
5485 0, &KVAR (current_kboard
, system_key_syms
),
5489 case MULTIMEDIA_KEY_EVENT
:
5490 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5491 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5493 return modify_event_symbol (event
->code
, event
->modifiers
,
5494 Qfunction_key
, Qnil
,
5495 lispy_multimedia_keys
, &func_key_syms
,
5496 ARRAYELTS (lispy_multimedia_keys
));
5501 /* A mouse click. Figure out where it is, decide whether it's
5502 a press, click or drag, and build the appropriate structure. */
5503 case MOUSE_CLICK_EVENT
:
5505 case GPM_CLICK_EVENT
:
5507 #ifndef USE_TOOLKIT_SCROLL_BARS
5508 case SCROLL_BAR_CLICK_EVENT
:
5509 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5512 int button
= event
->code
;
5514 Lisp_Object position
;
5515 Lisp_Object
*start_pos_ptr
;
5516 Lisp_Object start_pos
;
5520 /* Build the position as appropriate for this mouse click. */
5521 if (event
->kind
== MOUSE_CLICK_EVENT
5523 || event
->kind
== GPM_CLICK_EVENT
5527 struct frame
*f
= XFRAME (event
->frame_or_window
);
5530 /* Ignore mouse events that were made on frame that
5531 have been deleted. */
5532 if (! FRAME_LIVE_P (f
))
5535 /* EVENT->x and EVENT->y are frame-relative pixel
5536 coordinates at this place. Under old redisplay, COLUMN
5537 and ROW are set to frame relative glyph coordinates
5538 which are then used to determine whether this click is
5539 in a menu (non-toolkit version). */
5540 if (!toolkit_menubar_in_use (f
))
5542 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5543 &column
, &row
, NULL
, 1);
5545 /* In the non-toolkit version, clicks on the menu bar
5546 are ordinary button events in the event buffer.
5547 Distinguish them, and invoke the menu.
5549 (In the toolkit version, the toolkit handles the
5550 menu bar and Emacs doesn't know about it until
5551 after the user makes a selection.) */
5552 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5553 && (event
->modifiers
& down_modifier
))
5555 Lisp_Object items
, item
;
5557 /* Find the menu bar item under `column'. */
5559 items
= FRAME_MENU_BAR_ITEMS (f
);
5560 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5562 Lisp_Object pos
, string
;
5563 string
= AREF (items
, i
+ 1);
5564 pos
= AREF (items
, i
+ 3);
5567 if (column
>= XINT (pos
)
5568 && column
< XINT (pos
) + SCHARS (string
))
5570 item
= AREF (items
, i
);
5575 /* ELisp manual 2.4b says (x y) are window
5576 relative but code says they are
5578 position
= list4 (event
->frame_or_window
,
5580 Fcons (event
->x
, event
->y
),
5581 make_number (event
->timestamp
));
5583 return list2 (item
, position
);
5587 position
= make_lispy_position (f
, event
->x
, event
->y
,
5590 #ifndef USE_TOOLKIT_SCROLL_BARS
5592 /* It's a scrollbar click. */
5593 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5594 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5596 if (button
>= ASIZE (button_down_location
))
5598 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5599 button_down_location
= larger_vector (button_down_location
,
5601 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5604 start_pos_ptr
= aref_addr (button_down_location
, button
);
5605 start_pos
= *start_pos_ptr
;
5606 *start_pos_ptr
= Qnil
;
5609 /* On window-system frames, use the value of
5610 double-click-fuzz as is. On other frames, interpret it
5611 as a multiple of 1/8 characters. */
5615 if (WINDOWP (event
->frame_or_window
))
5616 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5617 else if (FRAMEP (event
->frame_or_window
))
5618 f
= XFRAME (event
->frame_or_window
);
5622 if (FRAME_WINDOW_P (f
))
5623 fuzz
= double_click_fuzz
;
5625 fuzz
= double_click_fuzz
/ 8;
5627 is_double
= (button
== last_mouse_button
5628 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5629 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5630 && button_down_time
!= 0
5631 && (EQ (Vdouble_click_time
, Qt
)
5632 || (NATNUMP (Vdouble_click_time
)
5633 && (event
->timestamp
- button_down_time
5634 < XFASTINT (Vdouble_click_time
)))));
5637 last_mouse_button
= button
;
5638 last_mouse_x
= XINT (event
->x
);
5639 last_mouse_y
= XINT (event
->y
);
5641 /* If this is a button press, squirrel away the location, so
5642 we can decide later whether it was a click or a drag. */
5643 if (event
->modifiers
& down_modifier
)
5647 double_click_count
++;
5648 event
->modifiers
|= ((double_click_count
> 2)
5653 double_click_count
= 1;
5654 button_down_time
= event
->timestamp
;
5655 *start_pos_ptr
= Fcopy_alist (position
);
5656 ignore_mouse_drag_p
= 0;
5659 /* Now we're releasing a button - check the co-ordinates to
5660 see if this was a click or a drag. */
5661 else if (event
->modifiers
& up_modifier
)
5663 /* If we did not see a down before this up, ignore the up.
5664 Probably this happened because the down event chose a
5665 menu item. It would be an annoyance to treat the
5666 release of the button that chose the menu item as a
5669 if (!CONSP (start_pos
))
5672 event
->modifiers
&= ~up_modifier
;
5675 Lisp_Object new_down
, down
;
5676 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5678 /* The third element of every position
5679 should be the (x,y) pair. */
5680 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5681 new_down
= Fcar (Fcdr (Fcdr (position
)));
5684 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5686 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5687 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5690 if (ignore_mouse_drag_p
)
5692 event
->modifiers
|= click_modifier
;
5693 ignore_mouse_drag_p
= 0;
5695 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5696 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5697 /* Maybe the mouse has moved a lot, caused scrolling, and
5698 eventually ended up at the same screen position (but
5699 not buffer position) in which case it is a drag, not
5701 /* FIXME: OTOH if the buffer position has changed
5702 because of a timer or process filter rather than
5703 because of mouse movement, it should be considered as
5704 a click. But mouse-drag-region completely ignores
5705 this case and it hasn't caused any real problem, so
5706 it's probably OK to ignore it as well. */
5707 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5708 /* Mouse hasn't moved (much). */
5709 event
->modifiers
|= click_modifier
;
5712 button_down_time
= 0;
5713 event
->modifiers
|= drag_modifier
;
5716 /* Don't check is_double; treat this as multiple
5717 if the down-event was multiple. */
5718 if (double_click_count
> 1)
5719 event
->modifiers
|= ((double_click_count
> 2)
5725 /* Every mouse event should either have the down_modifier or
5726 the up_modifier set. */
5730 /* Get the symbol we should use for the mouse click. */
5733 head
= modify_event_symbol (button
,
5735 Qmouse_click
, Vlispy_mouse_stem
,
5738 ASIZE (mouse_syms
));
5739 if (event
->modifiers
& drag_modifier
)
5740 return list3 (head
, start_pos
, position
);
5741 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5742 return list3 (head
, position
, make_number (double_click_count
));
5744 return list2 (head
, position
);
5749 case HORIZ_WHEEL_EVENT
:
5751 Lisp_Object position
;
5754 /* Build the position as appropriate for this mouse click. */
5755 struct frame
*f
= XFRAME (event
->frame_or_window
);
5757 /* Ignore wheel events that were made on frame that have been
5759 if (! FRAME_LIVE_P (f
))
5762 position
= make_lispy_position (f
, event
->x
, event
->y
,
5765 /* Set double or triple modifiers to indicate the wheel speed. */
5767 /* On window-system frames, use the value of
5768 double-click-fuzz as is. On other frames, interpret it
5769 as a multiple of 1/8 characters. */
5775 if (WINDOWP (event
->frame_or_window
))
5776 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5777 else if (FRAMEP (event
->frame_or_window
))
5778 fr
= XFRAME (event
->frame_or_window
);
5782 fuzz
= FRAME_WINDOW_P (fr
)
5783 ? double_click_fuzz
: double_click_fuzz
/ 8;
5785 if (event
->modifiers
& up_modifier
)
5787 /* Emit a wheel-up event. */
5788 event
->modifiers
&= ~up_modifier
;
5791 else if (event
->modifiers
& down_modifier
)
5793 /* Emit a wheel-down event. */
5794 event
->modifiers
&= ~down_modifier
;
5798 /* Every wheel event should either have the down_modifier or
5799 the up_modifier set. */
5802 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5805 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5806 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5807 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5808 && button_down_time
!= 0
5809 && (EQ (Vdouble_click_time
, Qt
)
5810 || (NATNUMP (Vdouble_click_time
)
5811 && (event
->timestamp
- button_down_time
5812 < XFASTINT (Vdouble_click_time
)))));
5815 double_click_count
++;
5816 event
->modifiers
|= ((double_click_count
> 2)
5822 double_click_count
= 1;
5823 event
->modifiers
|= click_modifier
;
5826 button_down_time
= event
->timestamp
;
5827 /* Use a negative value to distinguish wheel from mouse button. */
5828 last_mouse_button
= - (1 + symbol_num
);
5829 last_mouse_x
= XINT (event
->x
);
5830 last_mouse_y
= XINT (event
->y
);
5832 /* Get the symbol we should use for the wheel event. */
5833 head
= modify_event_symbol (symbol_num
,
5839 ASIZE (wheel_syms
));
5842 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5843 return list3 (head
, position
, make_number (double_click_count
));
5845 return list2 (head
, position
);
5849 #ifdef USE_TOOLKIT_SCROLL_BARS
5851 /* We don't have down and up events if using toolkit scroll bars,
5852 so make this always a click event. Store in the `part' of
5853 the Lisp event a symbol which maps to the following actions:
5855 `above_handle' page up
5856 `below_handle' page down
5860 `bottom' bottom of buffer
5861 `handle' thumb has been dragged.
5862 `end-scroll' end of interaction with scroll bar
5864 The incoming input_event contains in its `part' member an
5865 index of type `enum scroll_bar_part' which we can use as an
5866 index in scroll_bar_parts to get the appropriate symbol. */
5868 case SCROLL_BAR_CLICK_EVENT
:
5870 Lisp_Object position
, head
;
5872 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5874 /* Always treat scroll bar events as clicks. */
5875 event
->modifiers
|= click_modifier
;
5876 event
->modifiers
&= ~up_modifier
;
5878 if (event
->code
>= ASIZE (mouse_syms
))
5879 mouse_syms
= larger_vector (mouse_syms
,
5880 event
->code
- ASIZE (mouse_syms
) + 1,
5883 /* Get the symbol we should use for the mouse click. */
5884 head
= modify_event_symbol (event
->code
,
5889 ASIZE (mouse_syms
));
5890 return list2 (head
, position
);
5893 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5895 Lisp_Object position
, head
;
5897 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5899 /* Always treat scroll bar events as clicks. */
5900 event
->modifiers
|= click_modifier
;
5901 event
->modifiers
&= ~up_modifier
;
5903 if (event
->code
>= ASIZE (mouse_syms
))
5904 mouse_syms
= larger_vector (mouse_syms
,
5905 event
->code
- ASIZE (mouse_syms
) + 1,
5908 /* Get the symbol we should use for the mouse click. */
5909 head
= modify_event_symbol (event
->code
,
5914 ASIZE (mouse_syms
));
5915 return list2 (head
, position
);
5918 #endif /* USE_TOOLKIT_SCROLL_BARS */
5920 case DRAG_N_DROP_EVENT
:
5923 Lisp_Object head
, position
;
5926 f
= XFRAME (event
->frame_or_window
);
5929 /* Ignore mouse events that were made on frames that
5930 have been deleted. */
5931 if (! FRAME_LIVE_P (f
))
5934 position
= make_lispy_position (f
, event
->x
, event
->y
,
5937 head
= modify_event_symbol (0, event
->modifiers
,
5939 lispy_drag_n_drop_names
,
5940 &drag_n_drop_syms
, 1);
5941 return list3 (head
, position
, files
);
5944 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5945 || defined (HAVE_NS) || defined (USE_GTK)
5946 case MENU_BAR_EVENT
:
5947 if (EQ (event
->arg
, event
->frame_or_window
))
5948 /* This is the prefix key. We translate this to
5949 `(menu_bar)' because the code in keyboard.c for menu
5950 events, which we use, relies on this. */
5951 return list1 (Qmenu_bar
);
5955 case SELECT_WINDOW_EVENT
:
5956 /* Make an event (select-window (WINDOW)). */
5957 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5959 case TOOL_BAR_EVENT
:
5960 if (EQ (event
->arg
, event
->frame_or_window
))
5961 /* This is the prefix key. We translate this to
5962 `(tool_bar)' because the code in keyboard.c for tool bar
5963 events, which we use, relies on this. */
5964 return list1 (Qtool_bar
);
5965 else if (SYMBOLP (event
->arg
))
5966 return apply_modifiers (event
->modifiers
, event
->arg
);
5969 case USER_SIGNAL_EVENT
:
5970 /* A user signal. */
5972 char *name
= find_user_signal_name (event
->code
);
5975 return intern (name
);
5978 case SAVE_SESSION_EVENT
:
5979 return Qsave_session
;
5984 return Fcons (Qdbus_event
, event
->arg
);
5986 #endif /* HAVE_DBUS */
5988 #ifdef HAVE_XWIDGETS
5991 return Fcons (Qxwidget_event
, event
->arg
);
5995 #if defined HAVE_INOTIFY || defined HAVE_KQUEUE || defined HAVE_GFILENOTIFY
5996 case FILE_NOTIFY_EVENT
:
5998 return Fcons (Qfile_notify
, event
->arg
);
6000 #endif /* HAVE_INOTIFY || HAVE_KQUEUE || HAVE_GFILENOTIFY */
6002 case CONFIG_CHANGED_EVENT
:
6003 return list3 (Qconfig_changed_event
,
6004 event
->arg
, event
->frame_or_window
);
6006 /* The 'kind' field of the event is something we don't recognize. */
6013 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6014 Lisp_Object x
, Lisp_Object y
, Time t
)
6016 /* Is it a scroll bar movement? */
6017 if (frame
&& ! NILP (bar_window
))
6019 Lisp_Object part_sym
;
6021 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6022 return list2 (Qscroll_bar_movement
,
6024 Qvertical_scroll_bar
,
6029 /* Or is it an ordinary mouse movement? */
6032 Lisp_Object position
;
6033 position
= make_lispy_position (frame
, x
, y
, t
);
6034 return list2 (Qmouse_movement
, position
);
6038 /* Construct a switch frame event. */
6040 make_lispy_switch_frame (Lisp_Object frame
)
6042 return list2 (Qswitch_frame
, frame
);
6046 make_lispy_focus_in (Lisp_Object frame
)
6048 return list2 (Qfocus_in
, frame
);
6051 #ifdef HAVE_WINDOW_SYSTEM
6054 make_lispy_focus_out (Lisp_Object frame
)
6056 return list2 (Qfocus_out
, frame
);
6059 #endif /* HAVE_WINDOW_SYSTEM */
6061 /* Manipulating modifiers. */
6063 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6065 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6066 SYMBOL's name of the end of the modifiers; the string from this
6067 position is the unmodified symbol name.
6069 This doesn't use any caches. */
6072 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6078 CHECK_SYMBOL (symbol
);
6081 name
= SYMBOL_NAME (symbol
);
6083 for (i
= 0; i
< SBYTES (name
) - 1; )
6085 ptrdiff_t this_mod_end
= 0;
6088 /* See if the name continues with a modifier word.
6089 Check that the word appears, but don't check what follows it.
6090 Set this_mod and this_mod_end to record what we find. */
6092 switch (SREF (name
, i
))
6094 #define SINGLE_LETTER_MOD(BIT) \
6095 (this_mod_end = i + 1, this_mod = BIT)
6098 SINGLE_LETTER_MOD (alt_modifier
);
6102 SINGLE_LETTER_MOD (ctrl_modifier
);
6106 SINGLE_LETTER_MOD (hyper_modifier
);
6110 SINGLE_LETTER_MOD (meta_modifier
);
6114 SINGLE_LETTER_MOD (shift_modifier
);
6118 SINGLE_LETTER_MOD (super_modifier
);
6121 #undef SINGLE_LETTER_MOD
6123 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6124 if (i + LEN + 1 <= SBYTES (name) \
6125 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6127 this_mod_end = i + LEN; \
6132 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6133 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6134 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6138 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6142 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6144 #undef MULTI_LETTER_MOD
6148 /* If we found no modifier, stop looking for them. */
6149 if (this_mod_end
== 0)
6152 /* Check there is a dash after the modifier, so that it
6153 really is a modifier. */
6154 if (this_mod_end
>= SBYTES (name
)
6155 || SREF (name
, this_mod_end
) != '-')
6158 /* This modifier is real; look for another. */
6159 modifiers
|= this_mod
;
6160 i
= this_mod_end
+ 1;
6163 /* Should we include the `click' modifier? */
6164 if (! (modifiers
& (down_modifier
| drag_modifier
6165 | double_modifier
| triple_modifier
))
6166 && i
+ 7 == SBYTES (name
)
6167 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6168 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6169 modifiers
|= click_modifier
;
6171 if (! (modifiers
& (double_modifier
| triple_modifier
))
6172 && i
+ 6 < SBYTES (name
)
6173 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6174 modifiers
|= click_modifier
;
6182 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6183 prepended to the string BASE[0..BASE_LEN-1].
6184 This doesn't use any caches. */
6186 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6188 /* Since BASE could contain nulls, we can't use intern here; we have
6189 to use Fintern, which expects a genuine Lisp_String, and keeps a
6191 char new_mods
[sizeof "A-C-H-M-S-s-up-down-drag-double-triple-"];
6197 /* Mouse events should not exhibit the `up' modifier once they
6198 leave the event queue only accessible to C code; `up' will
6199 always be turned into a click or drag event before being
6200 presented to lisp code. But since lisp events can be
6201 synthesized bypassing the event queue and pushed into
6202 `unread-command-events' or its companions, it's better to just
6203 deal with unexpected modifier combinations. */
6205 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6206 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6207 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6208 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6209 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6210 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6211 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6212 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6213 if (modifiers
& up_modifier
) p
= stpcpy (p
, "up-");
6214 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6215 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6216 /* The click modifier is denoted by the absence of other modifiers. */
6220 mod_len
= p
- new_mods
;
6224 Lisp_Object new_name
;
6226 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6227 mod_len
+ base_len_byte
);
6228 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6229 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6231 return Fintern (new_name
, Qnil
);
6236 static const char *const modifier_names
[] =
6238 "up", "down", "drag", "click", "double", "triple", 0, 0,
6239 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6240 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6242 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6244 static Lisp_Object modifier_symbols
;
6246 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6248 lispy_modifier_list (int modifiers
)
6250 Lisp_Object modifier_list
;
6253 modifier_list
= Qnil
;
6254 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6255 if (modifiers
& (1<<i
))
6256 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6259 return modifier_list
;
6263 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6264 where UNMODIFIED is the unmodified form of SYMBOL,
6265 MASK is the set of modifiers present in SYMBOL's name.
6266 This is similar to parse_modifiers_uncached, but uses the cache in
6267 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6268 Qevent_symbol_elements property. */
6270 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6273 parse_modifiers (Lisp_Object symbol
)
6275 Lisp_Object elements
;
6277 if (INTEGERP (symbol
))
6278 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6279 else if (!SYMBOLP (symbol
))
6282 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6283 if (CONSP (elements
))
6288 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6289 Lisp_Object unmodified
;
6292 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6293 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6296 if (modifiers
& ~INTMASK
)
6298 XSETFASTINT (mask
, modifiers
);
6299 elements
= list2 (unmodified
, mask
);
6301 /* Cache the parsing results on SYMBOL. */
6302 Fput (symbol
, Qevent_symbol_element_mask
,
6304 Fput (symbol
, Qevent_symbol_elements
,
6305 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6307 /* Since we know that SYMBOL is modifiers applied to unmodified,
6308 it would be nice to put that in unmodified's cache.
6309 But we can't, since we're not sure that parse_modifiers is
6316 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6317 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6318 doc
: /* Parse the event symbol. For internal use. */)
6319 (Lisp_Object symbol
)
6321 /* Fill the cache if needed. */
6322 parse_modifiers (symbol
);
6323 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6324 and use the Lispier representation stored on Qevent_symbol_elements
6326 return Fget (symbol
, Qevent_symbol_elements
);
6329 /* Apply the modifiers MODIFIERS to the symbol BASE.
6330 BASE must be unmodified.
6332 This is like apply_modifiers_uncached, but uses BASE's
6333 Qmodifier_cache property, if present.
6335 apply_modifiers copies the value of BASE's Qevent_kind property to
6336 the modified symbol. */
6338 apply_modifiers (int modifiers
, Lisp_Object base
)
6340 Lisp_Object cache
, idx
, entry
, new_symbol
;
6342 /* Mask out upper bits. We don't know where this value's been. */
6343 modifiers
&= INTMASK
;
6345 if (INTEGERP (base
))
6346 return make_number (XINT (base
) | modifiers
);
6348 /* The click modifier never figures into cache indices. */
6349 cache
= Fget (base
, Qmodifier_cache
);
6350 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6351 entry
= assq_no_quit (idx
, cache
);
6354 new_symbol
= XCDR (entry
);
6357 /* We have to create the symbol ourselves. */
6358 new_symbol
= apply_modifiers_uncached (modifiers
,
6359 SSDATA (SYMBOL_NAME (base
)),
6360 SCHARS (SYMBOL_NAME (base
)),
6361 SBYTES (SYMBOL_NAME (base
)));
6363 /* Add the new symbol to the base's cache. */
6364 entry
= Fcons (idx
, new_symbol
);
6365 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6367 /* We have the parsing info now for free, so we could add it to
6369 XSETFASTINT (idx, modifiers);
6370 Fput (new_symbol, Qevent_symbol_element_mask,
6372 Fput (new_symbol, Qevent_symbol_elements,
6373 Fcons (base, lispy_modifier_list (modifiers)));
6374 Sadly, this is only correct if `base' is indeed a base event,
6375 which is not necessarily the case. -stef */
6378 /* Make sure this symbol is of the same kind as BASE.
6380 You'd think we could just set this once and for all when we
6381 intern the symbol above, but reorder_modifiers may call us when
6382 BASE's property isn't set right; we can't assume that just
6383 because it has a Qmodifier_cache property it must have its
6384 Qevent_kind set right as well. */
6385 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6389 kind
= Fget (base
, Qevent_kind
);
6391 Fput (new_symbol
, Qevent_kind
, kind
);
6398 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6399 return a symbol with the modifiers placed in the canonical order.
6400 Canonical order is alphabetical, except for down and drag, which
6401 always come last. The 'click' modifier is never written out.
6403 Fdefine_key calls this to make sure that (for example) C-M-foo
6404 and M-C-foo end up being equivalent in the keymap. */
6407 reorder_modifiers (Lisp_Object symbol
)
6409 /* It's hopefully okay to write the code this way, since everything
6410 will soon be in caches, and no consing will be done at all. */
6413 parsed
= parse_modifiers (symbol
);
6414 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6419 /* For handling events, we often want to produce a symbol whose name
6420 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6421 to some base, like the name of a function key or mouse button.
6422 modify_event_symbol produces symbols of this sort.
6424 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6425 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6428 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6429 into symbol names, or a string specifying a name stem used to
6430 construct a symbol name or the form `STEM-N', where N is the decimal
6431 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6432 non-nil; otherwise NAME_TABLE is used.
6434 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6435 persist between calls to modify_event_symbol that it can use to
6436 store a cache of the symbols it's generated for this NAME_TABLE
6437 before. The object stored there may be a vector or an alist.
6439 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6441 MODIFIERS is a set of modifier bits (as given in struct input_events)
6442 whose prefixes should be applied to the symbol name.
6444 SYMBOL_KIND is the value to be placed in the event_kind property of
6445 the returned symbol.
6447 The symbols we create are supposed to have an
6448 `event-symbol-elements' property, which lists the modifiers present
6449 in the symbol's name. */
6452 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6453 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6454 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6457 Lisp_Object symbol_int
;
6459 /* Get rid of the "vendor-specific" bit here. */
6460 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6462 /* Is this a request for a valid symbol? */
6463 if (symbol_num
< 0 || symbol_num
>= table_size
)
6466 if (CONSP (*symbol_table
))
6467 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6469 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6470 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6471 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6472 we've never used that symbol before. */
6475 if (! VECTORP (*symbol_table
)
6476 || ASIZE (*symbol_table
) != table_size
)
6480 XSETFASTINT (size
, table_size
);
6481 *symbol_table
= Fmake_vector (size
, Qnil
);
6484 value
= AREF (*symbol_table
, symbol_num
);
6487 /* Have we already used this symbol before? */
6490 /* No; let's create it. */
6491 if (CONSP (name_alist_or_stem
))
6492 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6493 else if (STRINGP (name_alist_or_stem
))
6496 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6497 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6499 buf
= SAFE_ALLOCA (len
);
6500 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6501 XINT (symbol_int
) + 1);
6502 value
= intern (buf
);
6505 else if (name_table
!= 0 && name_table
[symbol_num
])
6506 value
= intern (name_table
[symbol_num
]);
6508 #ifdef HAVE_WINDOW_SYSTEM
6511 char *name
= x_get_keysym_name (symbol_num
);
6513 value
= intern (name
);
6519 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6520 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6521 value
= intern (buf
);
6524 if (CONSP (*symbol_table
))
6525 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6527 ASET (*symbol_table
, symbol_num
, value
);
6529 /* Fill in the cache entries for this symbol; this also
6530 builds the Qevent_symbol_elements property, which the user
6532 apply_modifiers (modifiers
& click_modifier
, value
);
6533 Fput (value
, Qevent_kind
, symbol_kind
);
6536 /* Apply modifiers to that symbol. */
6537 return apply_modifiers (modifiers
, value
);
6540 /* Convert a list that represents an event type,
6541 such as (ctrl meta backspace), into the usual representation of that
6542 event type as a number or a symbol. */
6544 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6545 doc
: /* Convert the event description list EVENT-DESC to an event type.
6546 EVENT-DESC should contain one base event type (a character or symbol)
6547 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6548 drag, down, double or triple). The base must be last.
6549 The return value is an event type (a character or symbol) which
6550 has the same base event type and all the specified modifiers. */)
6551 (Lisp_Object event_desc
)
6559 while (CONSP (rest
))
6567 /* Given a symbol, see if it is a modifier name. */
6568 if (SYMBOLP (elt
) && CONSP (rest
))
6569 this = parse_solitary_modifier (elt
);
6573 else if (!NILP (base
))
6574 error ("Two bases given in one event");
6580 /* Let the symbol A refer to the character A. */
6581 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6582 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6584 if (INTEGERP (base
))
6586 /* Turn (shift a) into A. */
6587 if ((modifiers
& shift_modifier
) != 0
6588 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6590 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6591 modifiers
&= ~shift_modifier
;
6594 /* Turn (control a) into C-a. */
6595 if (modifiers
& ctrl_modifier
)
6596 return make_number ((modifiers
& ~ctrl_modifier
)
6597 | make_ctrl_char (XINT (base
)));
6599 return make_number (modifiers
| XINT (base
));
6601 else if (SYMBOLP (base
))
6602 return apply_modifiers (modifiers
, base
);
6604 error ("Invalid base event");
6607 /* Try to recognize SYMBOL as a modifier name.
6608 Return the modifier flag bit, or 0 if not recognized. */
6611 parse_solitary_modifier (Lisp_Object symbol
)
6613 Lisp_Object name
= SYMBOL_NAME (symbol
);
6615 switch (SREF (name
, 0))
6617 #define SINGLE_LETTER_MOD(BIT) \
6618 if (SBYTES (name) == 1) \
6621 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6622 if (LEN == SBYTES (name) \
6623 && ! memcmp (SDATA (name), NAME, LEN)) \
6627 SINGLE_LETTER_MOD (alt_modifier
);
6631 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6635 SINGLE_LETTER_MOD (ctrl_modifier
);
6639 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6640 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6644 SINGLE_LETTER_MOD (hyper_modifier
);
6648 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6652 SINGLE_LETTER_MOD (meta_modifier
);
6656 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6660 SINGLE_LETTER_MOD (shift_modifier
);
6664 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6665 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6666 SINGLE_LETTER_MOD (super_modifier
);
6670 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6671 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6672 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6676 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6680 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6683 #undef SINGLE_LETTER_MOD
6684 #undef MULTI_LETTER_MOD
6690 /* Return true if EVENT is a list whose elements are all integers or symbols.
6691 Such a list is not valid as an event,
6692 but it can be a Lucid-style event type list. */
6695 lucid_event_type_list_p (Lisp_Object object
)
6699 if (! CONSP (object
))
6702 if (EQ (XCAR (object
), Qhelp_echo
)
6703 || EQ (XCAR (object
), Qvertical_line
)
6704 || EQ (XCAR (object
), Qmode_line
)
6705 || EQ (XCAR (object
), Qheader_line
))
6708 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6712 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6719 /* Return true if terminal input chars are available.
6720 Also, store the return value into INPUT_PENDING.
6722 Serves the purpose of ioctl (0, FIONREAD, ...)
6723 but works even if FIONREAD does not exist.
6724 (In fact, this may actually read some input.)
6726 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6727 timer events that are ripe.
6728 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6729 events (FOCUS_IN_EVENT).
6730 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6731 movements and toolkit scroll bar thumb drags. */
6734 get_input_pending (int flags
)
6736 /* First of all, have we already counted some input? */
6737 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6739 /* If input is being read as it arrives, and we have none, there is none. */
6740 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6742 /* Try to read some input and see how much we get. */
6744 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6747 return input_pending
;
6750 /* Put a BUFFER_SWITCH_EVENT in the buffer
6751 so that read_key_sequence will notice the new current buffer. */
6754 record_asynch_buffer_change (void)
6756 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6757 The purpose of the event is to make read_key_sequence look up the
6758 keymaps again. If we aren't in read_key_sequence, we don't need one,
6759 and the event could cause trouble by messing up (input-pending-p).
6760 Note: Fwaiting_for_user_input_p always returns nil when async
6761 subprocesses aren't supported. */
6762 if (!NILP (Fwaiting_for_user_input_p ()))
6764 struct input_event event
;
6767 event
.kind
= BUFFER_SWITCH_EVENT
;
6768 event
.frame_or_window
= Qnil
;
6771 /* Make sure no interrupt happens while storing the event. */
6773 if (interrupt_input
)
6774 kbd_buffer_store_event (&event
);
6779 kbd_buffer_store_event (&event
);
6785 /* Read any terminal input already buffered up by the system
6786 into the kbd_buffer, but do not wait.
6788 Return the number of keyboard chars read, or -1 meaning
6789 this is a bad time to try to read input. */
6798 /* Store pending user signal events, if any. */
6799 store_user_signal_events ();
6801 /* Loop through the available terminals, and call their input hooks. */
6805 struct terminal
*next
= t
->next_terminal
;
6807 if (t
->read_socket_hook
)
6810 struct input_event hold_quit
;
6812 if (input_blocked_p ())
6814 pending_signals
= true;
6818 EVENT_INIT (hold_quit
);
6819 hold_quit
.kind
= NO_EVENT
;
6821 /* No need for FIONREAD or fcntl; just say don't wait. */
6822 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6825 if (nr
== -1) /* Not OK to read input now. */
6829 else if (nr
== -2) /* Non-transient error. */
6831 /* The terminal device terminated; it should be closed. */
6833 /* Kill Emacs if this was our last terminal. */
6834 if (!terminal_list
->next_terminal
)
6835 /* Formerly simply reported no input, but that
6836 sometimes led to a failure of Emacs to terminate.
6837 SIGHUP seems appropriate if we can't reach the
6839 /* ??? Is it really right to send the signal just to
6840 this process rather than to the whole process
6841 group? Perhaps on systems with FIONREAD Emacs is
6842 alone in its group. */
6843 terminate_due_to_signal (SIGHUP
, 10);
6845 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6848 XSETTERMINAL (tmp
, t
);
6849 Fdelete_terminal (tmp
, Qnoelisp
);
6853 /* If there was no error, make sure the pointer
6854 is visible for all frames on this terminal. */
6857 Lisp_Object tail
, frame
;
6859 FOR_EACH_FRAME (tail
, frame
)
6861 struct frame
*f
= XFRAME (frame
);
6862 if (FRAME_TERMINAL (f
) == t
)
6863 frame_make_pointer_visible (f
);
6867 if (hold_quit
.kind
!= NO_EVENT
)
6868 kbd_buffer_store_event (&hold_quit
);
6880 /* This is the tty way of reading available input.
6882 Note that each terminal device has its own `struct terminal' object,
6883 and so this function is called once for each individual termcap
6884 terminal. The first parameter indicates which terminal to read from. */
6887 tty_read_avail_input (struct terminal
*terminal
,
6888 struct input_event
*hold_quit
)
6890 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6891 the kbd_buffer can really hold. That may prevent loss
6892 of characters on some systems when input is stuffed at us. */
6893 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6898 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6901 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6903 if (kbd_on_hold_p () || buffer_free
<= 0)
6905 #endif /* subprocesses */
6907 if (!terminal
->name
) /* Don't read from a dead terminal. */
6910 if (terminal
->type
!= output_termcap
6911 && terminal
->type
!= output_msdos_raw
)
6914 /* XXX I think the following code should be moved to separate hook
6915 functions in system-dependent files. */
6917 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6918 code sets read_socket_hook to w32_console_read_socket instead! */
6920 #else /* not WINDOWSNT */
6921 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6925 return 0; /* The terminal is suspended. */
6928 n_to_read
= dos_keysns ();
6932 cbuf
[0] = dos_keyread ();
6935 #else /* not MSDOS */
6940 struct input_event gpm_hold_quit
;
6941 int gpm
, fd
= gpm_fd
;
6943 EVENT_INIT (gpm_hold_quit
);
6944 gpm_hold_quit
.kind
= NO_EVENT
;
6946 /* gpm==1 if event received.
6947 gpm==0 if the GPM daemon has closed the connection, in which case
6948 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6949 we save it in `fd' so close_gpm can remove it from the
6951 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6952 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6953 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6956 /* Presumably the GPM daemon has closed the connection. */
6958 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6959 kbd_buffer_store_event (&gpm_hold_quit
);
6963 #endif /* HAVE_GPM */
6965 /* Determine how many characters we should *try* to read. */
6966 #ifdef USABLE_FIONREAD
6967 /* Find out how much input is available. */
6968 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6970 if (! noninteractive
)
6971 return -2; /* Close this terminal. */
6977 if (n_to_read
> sizeof cbuf
)
6978 n_to_read
= sizeof cbuf
;
6979 #elif defined USG || defined CYGWIN
6980 /* Read some input if available, but don't wait. */
6981 n_to_read
= sizeof cbuf
;
6982 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6984 # error "Cannot read without possibly delaying"
6988 /* Don't read more than we can store. */
6989 if (n_to_read
> buffer_free
)
6990 n_to_read
= buffer_free
;
6991 #endif /* subprocesses */
6993 /* Now read; for one reason or another, this will not block.
6994 NREAD is set to the number of chars read. */
6997 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6998 /* POSIX infers that processes which are not in the session leader's
6999 process group won't get SIGHUPs at logout time. BSDI adheres to
7000 this part standard and returns -1 from read (0) with errno==EIO
7001 when the control tty is taken away.
7002 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7003 if (nread
== -1 && errno
== EIO
)
7004 return -2; /* Close this terminal. */
7005 #if defined (AIX) && defined (_BSD)
7006 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7007 This looks incorrect, but it isn't, because _BSD causes
7008 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7009 and that causes a value other than 0 when there is no input. */
7011 return -2; /* Close this terminal. */
7015 /* We used to retry the read if it was interrupted.
7016 But this does the wrong thing when O_NONBLOCK causes
7017 an EAGAIN error. Does anybody know of a situation
7018 where a retry is actually needed? */
7020 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7030 #ifndef USABLE_FIONREAD
7031 #if defined (USG) || defined (CYGWIN)
7032 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7033 #endif /* USG or CYGWIN */
7034 #endif /* no FIONREAD */
7039 #endif /* not MSDOS */
7040 #endif /* not WINDOWSNT */
7042 for (i
= 0; i
< nread
; i
++)
7044 struct input_event buf
;
7046 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7048 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7049 buf
.modifiers
= meta_modifier
;
7050 if (tty
->meta_key
!= 2)
7054 /* Set the frame corresponding to the active tty. Note that the
7055 value of selected_frame is not reliable here, redisplay tends
7056 to temporarily change it. */
7057 buf
.frame_or_window
= tty
->top_frame
;
7060 kbd_buffer_store_event (&buf
);
7061 /* Don't look at input that follows a C-g too closely.
7062 This reduces lossage due to autorepeat on C-g. */
7063 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7064 && buf
.code
== quit_char
)
7072 handle_async_input (void)
7077 int nread
= gobble_input ();
7078 /* -1 means it's not ok to read the input now.
7079 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7080 0 means there was no keyboard input available. */
7088 process_pending_signals (void)
7090 pending_signals
= false;
7091 handle_async_input ();
7092 do_pending_atimers ();
7095 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7096 and reinvoke any pending signal if the level is now 0 and
7097 a fatal error is not already in progress. */
7100 unblock_input_to (int level
)
7102 interrupt_input_blocked
= level
;
7105 if (pending_signals
&& !fatal_error_in_progress
)
7106 process_pending_signals ();
7112 /* End critical section.
7114 If doing signal-driven input, and a signal came in when input was
7115 blocked, reinvoke the signal handler now to deal with it.
7117 It will also process queued input, if it was not read before.
7118 When a longer code sequence does not use block/unblock input
7119 at all, the whole input gathered up to the next call to
7120 unblock_input will be processed inside that call. */
7123 unblock_input (void)
7125 unblock_input_to (interrupt_input_blocked
- 1);
7128 /* Undo any number of BLOCK_INPUT calls,
7129 and also reinvoke any pending signal. */
7132 totally_unblock_input (void)
7134 unblock_input_to (0);
7140 handle_input_available_signal (int sig
)
7142 pending_signals
= true;
7144 if (input_available_clear_time
)
7145 *input_available_clear_time
= make_timespec (0, 0);
7149 deliver_input_available_signal (int sig
)
7151 deliver_process_signal (sig
, handle_input_available_signal
);
7153 #endif /* USABLE_SIGIO */
7156 /* User signal events. */
7158 struct user_signal_info
7160 /* Signal number. */
7163 /* Name of the signal. */
7166 /* Number of pending signals. */
7169 struct user_signal_info
*next
;
7172 /* List of user signals. */
7173 static struct user_signal_info
*user_signals
= NULL
;
7176 add_user_signal (int sig
, const char *name
)
7178 struct sigaction action
;
7179 struct user_signal_info
*p
;
7181 for (p
= user_signals
; p
; p
= p
->next
)
7183 /* Already added. */
7186 p
= xmalloc (sizeof *p
);
7188 p
->name
= xstrdup (name
);
7190 p
->next
= user_signals
;
7193 emacs_sigaction_init (&action
, deliver_user_signal
);
7194 sigaction (sig
, &action
, 0);
7198 handle_user_signal (int sig
)
7200 struct user_signal_info
*p
;
7201 const char *special_event_name
= NULL
;
7203 if (SYMBOLP (Vdebug_on_event
))
7204 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7206 for (p
= user_signals
; p
; p
= p
->next
)
7209 if (special_event_name
7210 && strcmp (special_event_name
, p
->name
) == 0)
7212 /* Enter the debugger in many ways. */
7213 debug_on_next_call
= true;
7214 debug_on_quit
= true;
7216 Vinhibit_quit
= Qnil
;
7218 /* Eat the event. */
7224 if (interrupt_input
)
7225 handle_input_available_signal (sig
);
7229 /* Tell wait_reading_process_output that it needs to wake
7230 up and look around. */
7231 if (input_available_clear_time
)
7232 *input_available_clear_time
= make_timespec (0, 0);
7239 deliver_user_signal (int sig
)
7241 deliver_process_signal (sig
, handle_user_signal
);
7245 find_user_signal_name (int sig
)
7247 struct user_signal_info
*p
;
7249 for (p
= user_signals
; p
; p
= p
->next
)
7257 store_user_signal_events (void)
7259 struct user_signal_info
*p
;
7260 struct input_event buf
;
7261 bool buf_initialized
= false;
7263 for (p
= user_signals
; p
; p
= p
->next
)
7264 if (p
->npending
> 0)
7266 if (! buf_initialized
)
7268 memset (&buf
, 0, sizeof buf
);
7269 buf
.kind
= USER_SIGNAL_EVENT
;
7270 buf
.frame_or_window
= selected_frame
;
7271 buf_initialized
= true;
7277 kbd_buffer_store_event (&buf
);
7280 while (p
->npending
> 0);
7285 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7286 static Lisp_Object menu_bar_one_keymap_changed_items
;
7288 /* These variables hold the vector under construction within
7289 menu_bar_items and its subroutines, and the current index
7290 for storing into that vector. */
7291 static Lisp_Object menu_bar_items_vector
;
7292 static int menu_bar_items_index
;
7295 static const char *separator_names
[] = {
7300 "single-dashed-line",
7301 "double-dashed-line",
7303 "shadow-etched-out",
7304 "shadow-etched-in-dash",
7305 "shadow-etched-out-dash",
7306 "shadow-double-etched-in",
7307 "shadow-double-etched-out",
7308 "shadow-double-etched-in-dash",
7309 "shadow-double-etched-out-dash",
7313 /* Return true if LABEL specifies a separator. */
7316 menu_separator_name_p (const char *label
)
7320 else if (strlen (label
) > 3
7321 && memcmp (label
, "--", 2) == 0
7326 for (i
= 0; separator_names
[i
]; ++i
)
7327 if (strcmp (label
, separator_names
[i
]) == 0)
7332 /* It's a separator if it contains only dashes. */
7333 while (*label
== '-')
7335 return (*label
== 0);
7342 /* Return a vector of menu items for a menu bar, appropriate
7343 to the current buffer. Each item has three elements in the vector:
7346 OLD is an old vector we can optionally reuse, or nil. */
7349 menu_bar_items (Lisp_Object old
)
7351 /* The number of keymaps we're scanning right now, and the number of
7352 keymaps we have allocated space for. */
7355 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7356 in the current keymaps, or nil where it is not a prefix. */
7359 Lisp_Object mapsbuf
[3];
7360 Lisp_Object def
, tail
;
7367 /* In order to build the menus, we need to call the keymap
7368 accessors. They all call QUIT. But this function is called
7369 during redisplay, during which a quit is fatal. So inhibit
7370 quitting while building the menus.
7371 We do this instead of specbind because (1) errors will clear it anyway
7372 and (2) this avoids risk of specpdl overflow. */
7373 oquit
= Vinhibit_quit
;
7377 menu_bar_items_vector
= old
;
7379 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7380 menu_bar_items_index
= 0;
7382 /* Build our list of keymaps.
7383 If we recognize a function key and replace its escape sequence in
7384 keybuf with its symbol, or if the sequence starts with a mouse
7385 click and we need to switch buffers, we jump back here to rebuild
7386 the initial keymaps from the current buffer. */
7390 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7391 if (!NILP (Voverriding_local_map_menu_flag
)
7392 && !NILP (Voverriding_local_map
))
7394 /* Yes, use them (if non-nil) as well as the global map. */
7397 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7398 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7399 if (!NILP (Voverriding_local_map
))
7400 maps
[nmaps
++] = Voverriding_local_map
;
7404 /* No, so use major and minor mode keymaps and keymap property.
7405 Note that menu-bar bindings in the local-map and keymap
7406 properties may not work reliable, as they are only
7407 recognized when the menu-bar (or mode-line) is updated,
7408 which does not normally happen after every command. */
7409 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7410 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7412 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7413 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7414 maps
[nmaps
++] = tem
;
7415 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7416 maps
[nmaps
++] = tem
;
7419 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7422 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7424 maps
[nmaps
++] = current_global_map
;
7427 /* Look up in each map the dummy prefix key `menu-bar'. */
7429 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7430 if (!NILP (maps
[mapno
]))
7432 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7436 menu_bar_one_keymap_changed_items
= Qnil
;
7437 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7441 /* Move to the end those items that should be at the end. */
7443 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7446 int end
= menu_bar_items_index
;
7448 for (i
= 0; i
< end
; i
+= 4)
7449 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7451 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7452 /* Move the item at index I to the end,
7453 shifting all the others forward. */
7454 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7455 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7456 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7457 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7459 memmove (aref_addr (menu_bar_items_vector
, i
),
7460 aref_addr (menu_bar_items_vector
, i
+ 4),
7461 (end
- i
- 4) * word_size
);
7462 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7463 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7464 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7465 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7470 /* Add nil, nil, nil, nil at the end. */
7472 int i
= menu_bar_items_index
;
7473 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7474 menu_bar_items_vector
7475 = larger_vector (menu_bar_items_vector
, 4, -1);
7476 /* Add this item. */
7477 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7478 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7479 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7480 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7481 menu_bar_items_index
= i
;
7484 Vinhibit_quit
= oquit
;
7486 return menu_bar_items_vector
;
7489 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7490 If there's already an item for KEY, add this DEF to it. */
7492 Lisp_Object item_properties
;
7495 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7501 if (EQ (item
, Qundefined
))
7503 /* If a map has an explicit `undefined' as definition,
7504 discard any previously made menu bar item. */
7506 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7507 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7509 if (menu_bar_items_index
> i
+ 4)
7510 memmove (aref_addr (menu_bar_items_vector
, i
),
7511 aref_addr (menu_bar_items_vector
, i
+ 4),
7512 (menu_bar_items_index
- i
- 4) * word_size
);
7513 menu_bar_items_index
-= 4;
7517 /* If this keymap has already contributed to this KEY,
7518 don't contribute to it a second time. */
7519 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7520 if (!NILP (tem
) || NILP (item
))
7523 menu_bar_one_keymap_changed_items
7524 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7526 /* We add to menu_bar_one_keymap_changed_items before doing the
7527 parse_menu_item, so that if it turns out it wasn't a menu item,
7528 it still correctly hides any further menu item. */
7529 parsed
= parse_menu_item (item
, 1);
7533 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7535 /* Find any existing item for this KEY. */
7536 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7537 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7540 /* If we did not find this KEY, add it at the end. */
7541 if (i
== menu_bar_items_index
)
7543 /* If vector is too small, get a bigger one. */
7544 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7545 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7546 /* Add this item. */
7547 ASET (menu_bar_items_vector
, i
, key
); i
++;
7548 ASET (menu_bar_items_vector
, i
,
7549 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7550 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7551 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7552 menu_bar_items_index
= i
;
7554 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7558 old
= AREF (menu_bar_items_vector
, i
+ 2);
7559 /* If the new and the old items are not both keymaps,
7560 the lookup will only find `item'. */
7561 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7562 ASET (menu_bar_items_vector
, i
+ 2, item
);
7566 /* This is used as the handler when calling menu_item_eval_property. */
7568 menu_item_eval_property_1 (Lisp_Object arg
)
7570 /* If we got a quit from within the menu computation,
7571 quit all the way out of it. This takes care of C-] in the debugger. */
7572 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7573 Fsignal (Qquit
, Qnil
);
7579 eval_dyn (Lisp_Object form
)
7581 return Feval (form
, Qnil
);
7584 /* Evaluate an expression and return the result (or nil if something
7585 went wrong). Used to evaluate dynamic parts of menu items. */
7587 menu_item_eval_property (Lisp_Object sexpr
)
7589 ptrdiff_t count
= SPECPDL_INDEX ();
7591 specbind (Qinhibit_redisplay
, Qt
);
7592 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7593 menu_item_eval_property_1
);
7594 return unbind_to (count
, val
);
7597 /* This function parses a menu item and leaves the result in the
7598 vector item_properties.
7599 ITEM is a key binding, a possible menu item.
7600 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7602 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7603 parse_menu_item returns true if the item is a menu item and false
7607 parse_menu_item (Lisp_Object item
, int inmenubar
)
7609 Lisp_Object def
, tem
, item_string
, start
;
7611 Lisp_Object keyhint
;
7620 /* Create item_properties vector if necessary. */
7621 if (NILP (item_properties
))
7623 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7625 /* Initialize optional entries. */
7626 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7627 ASET (item_properties
, i
, Qnil
);
7628 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7630 /* Save the item here to protect it from GC. */
7631 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7633 item_string
= XCAR (item
);
7637 if (STRINGP (item_string
))
7639 /* Old format menu item. */
7640 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7642 /* Maybe help string. */
7643 if (CONSP (item
) && STRINGP (XCAR (item
)))
7645 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7646 Fsubstitute_command_keys (XCAR (item
)));
7651 /* Maybe an obsolete key binding cache. */
7652 if (CONSP (item
) && CONSP (XCAR (item
))
7653 && (NILP (XCAR (XCAR (item
)))
7654 || VECTORP (XCAR (XCAR (item
)))))
7657 /* This is the real definition--the function to run. */
7658 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7660 /* Get enable property, if any. */
7663 tem
= Fget (item
, Qmenu_enable
);
7664 if (!NILP (Venable_disabled_menus_and_buttons
))
7665 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7666 else if (!NILP (tem
))
7667 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7670 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7672 /* New format menu item. */
7673 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7674 start
= XCDR (item
);
7677 /* We have a real binding. */
7678 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7680 item
= XCDR (start
);
7681 /* Is there an obsolete cache list with key equivalences. */
7682 if (CONSP (item
) && CONSP (XCAR (item
)))
7685 /* Parse properties. */
7686 while (CONSP (item
) && CONSP (XCDR (item
)))
7691 if (EQ (tem
, QCenable
))
7693 if (!NILP (Venable_disabled_menus_and_buttons
))
7694 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7696 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7698 else if (EQ (tem
, QCvisible
))
7700 /* If got a visible property and that evaluates to nil
7701 then ignore this item. */
7702 tem
= menu_item_eval_property (XCAR (item
));
7706 else if (EQ (tem
, QChelp
))
7708 Lisp_Object help
= XCAR (item
);
7710 help
= Fsubstitute_command_keys (help
);
7711 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7713 else if (EQ (tem
, QCfilter
))
7715 else if (EQ (tem
, QCkey_sequence
))
7718 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7719 /* Be GC protected. Set keyhint to item instead of tem. */
7722 else if (EQ (tem
, QCkeys
))
7725 if (CONSP (tem
) || STRINGP (tem
))
7726 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7728 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7733 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7735 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7737 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7743 else if (inmenubar
|| !NILP (start
))
7747 return 0; /* not a menu item */
7749 /* If item string is not a string, evaluate it to get string.
7750 If we don't get a string, skip this item. */
7751 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7752 if (!(STRINGP (item_string
)))
7754 item_string
= menu_item_eval_property (item_string
);
7755 if (!STRINGP (item_string
))
7757 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7760 /* If got a filter apply it on definition. */
7761 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7764 def
= menu_item_eval_property (list2 (XCAR (filter
),
7765 list2 (Qquote
, def
)));
7767 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7770 /* Enable or disable selection of item. */
7771 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7774 tem
= menu_item_eval_property (tem
);
7775 if (inmenubar
&& NILP (tem
))
7776 return 0; /* Ignore disabled items in menu bar. */
7777 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7780 /* If we got no definition, this item is just unselectable text which
7781 is OK in a submenu but not in the menubar. */
7783 return (!inmenubar
);
7785 /* See if this is a separate pane or a submenu. */
7786 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7787 tem
= get_keymap (def
, 0, 1);
7788 /* For a subkeymap, just record its details and exit. */
7791 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7792 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7796 /* At the top level in the menu bar, do likewise for commands also.
7797 The menu bar does not display equivalent key bindings anyway.
7798 ITEM_PROPERTY_DEF is already set up properly. */
7802 { /* This is a command. See if there is an equivalent key binding. */
7803 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7804 AUTO_STRING (space_space
, " ");
7806 /* The previous code preferred :key-sequence to :keys, so we
7807 preserve this behavior. */
7808 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7809 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7812 Lisp_Object prefix
= keyeq
;
7813 Lisp_Object keys
= Qnil
;
7817 def
= XCAR (prefix
);
7818 prefix
= XCDR (prefix
);
7821 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7823 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7825 keys
= XCAR (keyhint
);
7826 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7828 /* We have a suggested key. Is it bound to the command? */
7831 /* If the command is an alias for another
7832 (such as lmenu.el set it up), check if the
7833 original command matches the cached command. */
7835 && EQ (tem
, XSYMBOL (def
)->function
))))
7840 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7844 tem
= Fkey_description (keys
, Qnil
);
7847 if (STRINGP (XCAR (prefix
)))
7848 tem
= concat2 (XCAR (prefix
), tem
);
7849 if (STRINGP (XCDR (prefix
)))
7850 tem
= concat2 (tem
, XCDR (prefix
));
7852 keyeq
= concat2 (space_space
, tem
);
7858 /* If we have an equivalent key binding, use that. */
7859 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7862 /* Include this when menu help is implemented.
7863 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7864 if (!(NILP (tem) || STRINGP (tem)))
7866 tem = menu_item_eval_property (tem);
7869 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7873 /* Handle radio buttons or toggle boxes. */
7874 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7876 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7877 menu_item_eval_property (tem
));
7884 /***********************************************************************
7886 ***********************************************************************/
7888 /* A vector holding tool bar items while they are parsed in function
7889 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7892 static Lisp_Object tool_bar_items_vector
;
7894 /* A vector holding the result of parse_tool_bar_item. Layout is like
7895 the one for a single item in tool_bar_items_vector. */
7897 static Lisp_Object tool_bar_item_properties
;
7899 /* Next free index in tool_bar_items_vector. */
7901 static int ntool_bar_items
;
7903 /* Function prototypes. */
7905 static void init_tool_bar_items (Lisp_Object
);
7906 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7908 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7909 static void append_tool_bar_item (void);
7912 /* Return a vector of tool bar items for keymaps currently in effect.
7913 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7914 tool bar items found. */
7917 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7920 Lisp_Object mapsbuf
[3];
7928 /* In order to build the menus, we need to call the keymap
7929 accessors. They all call QUIT. But this function is called
7930 during redisplay, during which a quit is fatal. So inhibit
7931 quitting while building the menus. We do this instead of
7932 specbind because (1) errors will clear it anyway and (2) this
7933 avoids risk of specpdl overflow. */
7934 oquit
= Vinhibit_quit
;
7937 /* Initialize tool_bar_items_vector and protect it from GC. */
7938 init_tool_bar_items (reuse
);
7940 /* Build list of keymaps in maps. Set nmaps to the number of maps
7943 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7944 if (!NILP (Voverriding_local_map_menu_flag
)
7945 && !NILP (Voverriding_local_map
))
7947 /* Yes, use them (if non-nil) as well as the global map. */
7950 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7951 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7952 if (!NILP (Voverriding_local_map
))
7953 maps
[nmaps
++] = Voverriding_local_map
;
7957 /* No, so use major and minor mode keymaps and keymap property.
7958 Note that tool-bar bindings in the local-map and keymap
7959 properties may not work reliable, as they are only
7960 recognized when the tool-bar (or mode-line) is updated,
7961 which does not normally happen after every command. */
7962 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7963 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7965 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7966 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7967 maps
[nmaps
++] = tem
;
7968 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7969 maps
[nmaps
++] = tem
;
7972 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7975 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7978 /* Add global keymap at the end. */
7979 maps
[nmaps
++] = current_global_map
;
7981 /* Process maps in reverse order and look up in each map the prefix
7983 for (i
= nmaps
- 1; i
>= 0; --i
)
7984 if (!NILP (maps
[i
]))
7988 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7990 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7993 Vinhibit_quit
= oquit
;
7994 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7996 return tool_bar_items_vector
;
8000 /* Process the definition of KEY which is DEF. */
8003 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8007 if (EQ (def
, Qundefined
))
8009 /* If a map has an explicit `undefined' as definition,
8010 discard any previously made item. */
8011 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8013 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8015 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8017 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8018 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8019 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8021 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8026 else if (parse_tool_bar_item (key
, def
))
8027 /* Append a new tool bar item to tool_bar_items_vector. Accept
8028 more than one definition for the same key. */
8029 append_tool_bar_item ();
8032 /* Access slot with index IDX of vector tool_bar_item_properties. */
8033 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8035 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8037 ASET (tool_bar_item_properties
, idx
, val
);
8041 /* Parse a tool bar item specification ITEM for key KEY and return the
8042 result in tool_bar_item_properties. Value is false if ITEM is
8045 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8047 CAPTION is the caption of the item, If it's not a string, it is
8048 evaluated to get a string.
8050 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8051 as binding are currently ignored.
8053 The following properties are recognized:
8057 FORM is evaluated and specifies whether the tool bar item is
8058 enabled or disabled.
8062 FORM is evaluated and specifies whether the tool bar item is visible.
8064 - `:filter FUNCTION'
8066 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8067 result is stored as the new binding.
8069 - `:button (TYPE SELECTED)'
8071 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8072 and specifies whether the button is selected (pressed) or not.
8076 IMAGES is either a single image specification or a vector of four
8077 image specifications. See enum tool_bar_item_images.
8079 - `:help HELP-STRING'.
8081 Gives a help string to display for the tool bar item.
8083 - `:label LABEL-STRING'.
8085 A text label to show with the tool bar button if labels are enabled. */
8088 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8090 Lisp_Object filter
= Qnil
;
8091 Lisp_Object caption
;
8093 bool have_label
= false;
8095 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8096 Rule out items that aren't lists, don't start with
8097 `menu-item' or whose rest following `tool-bar-item' is not a
8102 /* As an exception, allow old-style menu separators. */
8103 if (STRINGP (XCAR (item
)))
8104 item
= list1 (XCAR (item
));
8105 else if (!EQ (XCAR (item
), Qmenu_item
)
8106 || (item
= XCDR (item
), !CONSP (item
)))
8109 /* Create tool_bar_item_properties vector if necessary. Reset it to
8111 if (VECTORP (tool_bar_item_properties
))
8113 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8117 tool_bar_item_properties
8118 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8121 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8122 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8124 /* Get the caption of the item. If the caption is not a string,
8125 evaluate it to get a string. If we don't get a string, skip this
8127 caption
= XCAR (item
);
8128 if (!STRINGP (caption
))
8130 caption
= menu_item_eval_property (caption
);
8131 if (!STRINGP (caption
))
8134 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8136 /* If the rest following the caption is not a list, the menu item is
8137 either a separator, or invalid. */
8141 if (menu_separator_name_p (SSDATA (caption
)))
8143 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8144 #if !defined (USE_GTK) && !defined (HAVE_NS)
8145 /* If we use build_desired_tool_bar_string to render the
8146 tool bar, the separator is rendered as an image. */
8147 set_prop (TOOL_BAR_ITEM_IMAGES
,
8148 (menu_item_eval_property
8149 (Vtool_bar_separator_image_expression
)));
8150 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8151 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8152 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8159 /* Store the binding. */
8160 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8163 /* Ignore cached key binding, if any. */
8164 if (CONSP (item
) && CONSP (XCAR (item
)))
8167 /* Process the rest of the properties. */
8168 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8170 Lisp_Object ikey
, value
;
8173 value
= XCAR (XCDR (item
));
8175 if (EQ (ikey
, QCenable
))
8177 /* `:enable FORM'. */
8178 if (!NILP (Venable_disabled_menus_and_buttons
))
8179 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8181 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8183 else if (EQ (ikey
, QCvisible
))
8185 /* `:visible FORM'. If got a visible property and that
8186 evaluates to nil then ignore this item. */
8187 if (NILP (menu_item_eval_property (value
)))
8190 else if (EQ (ikey
, QChelp
))
8191 /* `:help HELP-STRING'. */
8192 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8193 else if (EQ (ikey
, QCvert_only
))
8194 /* `:vert-only t/nil'. */
8195 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8196 else if (EQ (ikey
, QClabel
))
8198 const char *bad_label
= "!!?GARBLED ITEM?!!";
8199 /* `:label LABEL-STRING'. */
8200 set_prop (TOOL_BAR_ITEM_LABEL
,
8201 STRINGP (value
) ? value
: build_string (bad_label
));
8204 else if (EQ (ikey
, QCfilter
))
8205 /* ':filter FORM'. */
8207 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8209 /* `:button (TYPE . SELECTED)'. */
8210 Lisp_Object type
, selected
;
8212 type
= XCAR (value
);
8213 selected
= XCDR (value
);
8214 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8216 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8217 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8220 else if (EQ (ikey
, QCimage
)
8222 || (VECTORP (value
) && ASIZE (value
) == 4)))
8223 /* Value is either a single image specification or a vector
8224 of 4 such specifications for the different button states. */
8225 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8226 else if (EQ (ikey
, QCrtl
))
8228 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8234 /* Try to make one from caption and key. */
8235 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8236 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8237 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8238 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8240 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8241 char *buf
= xmalloc (max_lbl
+ 1);
8242 Lisp_Object new_lbl
;
8243 ptrdiff_t caption_len
= strlen (capt
);
8245 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8248 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8250 buf
[caption_len
] = '\0';
8254 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8258 strcpy (buf
, label
);
8260 for (j
= 0; buf
[j
] != '\0'; ++j
)
8268 new_lbl
= Fupcase_initials (build_string (label
));
8269 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8270 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8272 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8276 /* If got a filter apply it on binding. */
8278 set_prop (TOOL_BAR_ITEM_BINDING
,
8279 (menu_item_eval_property
8282 PROP (TOOL_BAR_ITEM_BINDING
))))));
8284 /* See if the binding is a keymap. Give up if it is. */
8285 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8288 /* Enable or disable selection of item. */
8289 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8290 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8291 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8293 /* Handle radio buttons or toggle boxes. */
8294 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8295 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8296 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8304 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8305 that can be reused. */
8308 init_tool_bar_items (Lisp_Object reuse
)
8310 if (VECTORP (reuse
))
8311 tool_bar_items_vector
= reuse
;
8313 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8314 ntool_bar_items
= 0;
8318 /* Append parsed tool bar item properties from
8319 tool_bar_item_properties */
8322 append_tool_bar_item (void)
8326 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8328 /* Enlarge tool_bar_items_vector if necessary. */
8330 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8332 /* Append entries from tool_bar_item_properties to the end of
8333 tool_bar_items_vector. */
8334 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8335 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8336 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8343 /* Read a character using menus based on the keymap MAP.
8344 Return nil if there are no menus in the maps.
8345 Return t if we displayed a menu but the user rejected it.
8347 PREV_EVENT is the previous input event, or nil if we are reading
8348 the first event of a key sequence.
8350 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8351 if we used a mouse menu to read the input, or false otherwise. If
8352 USED_MOUSE_MENU is null, don't dereference it.
8354 The prompting is done based on the prompt-string of the map
8355 and the strings associated with various map elements.
8357 This can be done with X menus or with menus put in the minibuf.
8358 These are done in different ways, depending on how the input will be read.
8359 Menus using X are done after auto-saving in read-char, getting the input
8360 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8361 and do auto-saving in the inner call of read_char. */
8364 read_char_x_menu_prompt (Lisp_Object map
,
8365 Lisp_Object prev_event
, bool *used_mouse_menu
)
8367 if (used_mouse_menu
)
8368 *used_mouse_menu
= false;
8370 /* Use local over global Menu maps. */
8372 if (! menu_prompting
)
8375 /* If we got to this point via a mouse click,
8376 use a real menu for mouse selection. */
8377 if (EVENT_HAS_PARAMETERS (prev_event
)
8378 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8379 && !EQ (XCAR (prev_event
), Qtool_bar
))
8381 /* Display the menu and get the selection. */
8384 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8389 record_menu_key (XCAR (value
));
8391 /* If we got multiple events, unread all but
8393 There is no way to prevent those unread events
8394 from showing up later in last_nonmenu_event.
8395 So turn symbol and integer events into lists,
8396 to indicate that they came from a mouse menu,
8397 so that when present in last_nonmenu_event
8398 they won't confuse things. */
8399 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8401 record_menu_key (XCAR (tem
));
8402 if (SYMBOLP (XCAR (tem
))
8403 || INTEGERP (XCAR (tem
)))
8404 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8407 /* If we got more than one event, put all but the first
8408 onto this list to be read later.
8409 Return just the first event now. */
8410 Vunread_command_events
8411 = nconc2 (XCDR (value
), Vunread_command_events
);
8412 value
= XCAR (value
);
8414 else if (NILP (value
))
8416 if (used_mouse_menu
)
8417 *used_mouse_menu
= true;
8424 read_char_minibuf_menu_prompt (int commandflag
,
8429 /* FIXME: Use the minibuffer's frame width. */
8430 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8432 bool nobindings
= true;
8433 Lisp_Object rest
, vector
;
8434 Lisp_Object prompt_strings
= Qnil
;
8438 if (! menu_prompting
)
8441 map
= get_keymap (map
, 0, 1);
8442 name
= Fkeymap_prompt (map
);
8444 /* If we don't have any menus, just read a character normally. */
8445 if (!STRINGP (name
))
8448 #define PUSH_C_STR(str, listvar) \
8449 listvar = Fcons (build_unibyte_string (str), listvar)
8451 /* Prompt string always starts with map's prompt, and a space. */
8452 prompt_strings
= Fcons (name
, prompt_strings
);
8453 PUSH_C_STR (": ", prompt_strings
);
8454 nlength
= SCHARS (name
) + 2;
8458 /* Present the documented bindings, a line at a time. */
8461 bool notfirst
= false;
8462 Lisp_Object menu_strings
= prompt_strings
;
8463 ptrdiff_t i
= nlength
;
8465 Lisp_Object orig_defn_macro
;
8467 /* Loop over elements of map. */
8472 /* FIXME: Use map_keymap to handle new keymap formats. */
8474 /* At end of map, wrap around if just starting,
8475 or end this line if already have something on it. */
8478 if (notfirst
|| nobindings
)
8484 /* Look at the next element of the map. */
8486 elt
= AREF (vector
, idx
);
8488 elt
= Fcar_safe (rest
);
8490 if (idx
< 0 && VECTORP (elt
))
8492 /* If we found a dense table in the keymap,
8493 advanced past it, but start scanning its contents. */
8494 rest
= Fcdr_safe (rest
);
8500 /* An ordinary element. */
8501 Lisp_Object event
, tem
;
8505 event
= Fcar_safe (elt
); /* alist */
8506 elt
= Fcdr_safe (elt
);
8510 XSETINT (event
, idx
); /* vector */
8513 /* Ignore the element if it has no prompt string. */
8514 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8516 /* True if the char to type matches the string. */
8518 Lisp_Object upcased_event
, downcased_event
;
8519 Lisp_Object desc
= Qnil
;
8521 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8523 upcased_event
= Fupcase (event
);
8524 downcased_event
= Fdowncase (event
);
8525 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8526 || XINT (downcased_event
) == SREF (s
, 0));
8528 desc
= Fsingle_key_description (event
, Qnil
);
8530 #if 0 /* It is redundant to list the equivalent key bindings because
8531 the prefix is what the user has already typed. */
8533 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8535 /* Insert equivalent keybinding. */
8536 s
= concat2 (s
, tem
);
8539 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8540 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8542 /* Insert button prefix. */
8543 Lisp_Object selected
8544 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8545 AUTO_STRING (radio_yes
, "(*) ");
8546 AUTO_STRING (radio_no
, "( ) ");
8547 AUTO_STRING (check_yes
, "[X] ");
8548 AUTO_STRING (check_no
, "[ ] ");
8549 if (EQ (tem
, QCradio
))
8550 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8552 tem
= NILP (selected
) ? check_yes
: check_no
;
8553 s
= concat2 (tem
, s
);
8557 /* If we have room for the prompt string, add it to this line.
8558 If this is the first on the line, always add it. */
8559 if ((SCHARS (s
) + i
+ 2
8560 + (char_matches
? 0 : SCHARS (desc
) + 3))
8564 ptrdiff_t thiswidth
;
8566 /* Punctuate between strings. */
8569 PUSH_C_STR (", ", menu_strings
);
8575 /* If the char to type doesn't match the string's
8576 first char, explicitly show what char to type. */
8579 /* Add as much of string as fits. */
8580 thiswidth
= min (SCHARS (desc
), width
- i
);
8582 = Fcons (Fsubstring (desc
, make_number (0),
8583 make_number (thiswidth
)),
8586 PUSH_C_STR (" = ", menu_strings
);
8590 /* Add as much of string as fits. */
8591 thiswidth
= min (SCHARS (s
), width
- i
);
8593 = Fcons (Fsubstring (s
, make_number (0),
8594 make_number (thiswidth
)),
8600 /* If this element does not fit, end the line now,
8601 and save the element for the next line. */
8602 PUSH_C_STR ("...", menu_strings
);
8607 /* Move past this element. */
8608 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8609 /* Handle reaching end of dense table. */
8614 rest
= Fcdr_safe (rest
);
8618 /* Prompt with that and read response. */
8619 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8621 /* Make believe it's not a keyboard macro in case the help char
8622 is pressed. Help characters are not recorded because menu prompting
8623 is not used on replay. */
8624 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8625 kset_defining_kbd_macro (current_kboard
, Qnil
);
8627 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8628 while (BUFFERP (obj
));
8629 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8631 if (!INTEGERP (obj
) || XINT (obj
) == -2
8632 || (! EQ (obj
, menu_prompt_more_char
)
8633 && (!INTEGERP (menu_prompt_more_char
)
8634 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8636 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8637 store_kbd_macro_char (obj
);
8640 /* Help char - go round again. */
8644 /* Reading key sequences. */
8647 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8649 return access_keymap (get_keymap (keymap
, 0, 1),
8654 active_maps (Lisp_Object first_event
)
8656 Lisp_Object position
8657 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8658 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8661 /* Structure used to keep track of partial application of key remapping
8662 such as Vfunction_key_map and Vkey_translation_map. */
8663 typedef struct keyremap
8665 /* This is the map originally specified for this use. */
8667 /* This is a submap reached by looking up, in PARENT,
8668 the events from START to END. */
8670 /* Positions [START, END) in the key sequence buffer
8671 are the key that we have scanned so far.
8672 Those events are the ones that we will replace
8673 if PARENT maps them into a key sequence. */
8677 /* Lookup KEY in MAP.
8678 MAP is a keymap mapping keys to key vectors or functions.
8679 If the mapping is a function and DO_FUNCALL is true,
8680 the function is called with PROMPT as parameter and its return
8681 value is used as the return value of this function (after checking
8682 that it is indeed a vector). */
8685 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8690 next
= access_keymap (map
, key
, 1, 0, 1);
8692 /* Handle a symbol whose function definition is a keymap
8694 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8695 && (ARRAYP (XSYMBOL (next
)->function
)
8696 || KEYMAPP (XSYMBOL (next
)->function
)))
8697 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8699 /* If the keymap gives a function, not an
8700 array, then call the function with one arg and use
8701 its value instead. */
8702 if (do_funcall
&& FUNCTIONP (next
))
8707 next
= call1 (next
, prompt
);
8708 /* If the function returned something invalid,
8709 barf--don't ignore it. */
8710 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8711 error ("Function %s returns invalid key sequence",
8712 SSDATA (SYMBOL_NAME (tem
)));
8717 /* Do one step of the key remapping used for function-key-map and
8718 key-translation-map:
8719 KEYBUF is the buffer holding the input events.
8720 BUFSIZE is its maximum size.
8721 FKEY is a pointer to the keyremap structure to use.
8722 INPUT is the index of the last element in KEYBUF.
8723 DOIT if true says that the remapping can actually take place.
8724 DIFF is used to return the number of keys added/removed by the remapping.
8725 PARENT is the root of the keymap.
8726 PROMPT is the prompt to use if the remapping happens through a function.
8727 Return true if the remapping actually took place. */
8730 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8731 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8733 Lisp_Object next
, key
;
8735 key
= keybuf
[fkey
->end
++];
8737 if (KEYMAPP (fkey
->parent
))
8738 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8742 /* If keybuf[fkey->start..fkey->end] is bound in the
8743 map and we're in a position to do the key remapping, replace it with
8744 the binding and restart with fkey->start at the end. */
8745 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8747 int len
= XFASTINT (Flength (next
));
8750 *diff
= len
- (fkey
->end
- fkey
->start
);
8752 if (bufsize
- input
<= *diff
)
8753 error ("Key sequence too long");
8755 /* Shift the keys that follow fkey->end. */
8757 for (i
= fkey
->end
; i
< input
; i
++)
8758 keybuf
[i
+ *diff
] = keybuf
[i
];
8760 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8761 keybuf
[i
+ *diff
] = keybuf
[i
];
8762 /* Overwrite the old keys with the new ones. */
8763 for (i
= 0; i
< len
; i
++)
8764 keybuf
[fkey
->start
+ i
]
8765 = Faref (next
, make_number (i
));
8767 fkey
->start
= fkey
->end
+= *diff
;
8768 fkey
->map
= fkey
->parent
;
8773 fkey
->map
= get_keymap (next
, 0, 1);
8775 /* If we no longer have a bound suffix, try a new position for
8777 if (!CONSP (fkey
->map
))
8779 fkey
->end
= ++fkey
->start
;
8780 fkey
->map
= fkey
->parent
;
8786 test_undefined (Lisp_Object binding
)
8788 return (NILP (binding
)
8789 || EQ (binding
, Qundefined
)
8790 || (SYMBOLP (binding
)
8791 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8794 /* Read a sequence of keys that ends with a non prefix character,
8795 storing it in KEYBUF, a buffer of size BUFSIZE.
8797 Return the length of the key sequence stored.
8798 Return -1 if the user rejected a command menu.
8800 Echo starting immediately unless `prompt' is 0.
8802 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8803 read_char with a suitable COMMANDFLAG argument.
8805 Where a key sequence ends depends on the currently active keymaps.
8806 These include any minor mode keymaps active in the current buffer,
8807 the current buffer's local map, and the global map.
8809 If a key sequence has no other bindings, we check Vfunction_key_map
8810 to see if some trailing subsequence might be the beginning of a
8811 function key's sequence. If so, we try to read the whole function
8812 key, and substitute its symbolic name into the key sequence.
8814 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8815 `double-' events into similar click events, if that would make them
8816 bound. We try to turn `triple-' events first into `double-' events,
8819 If we get a mouse click in a mode line, vertical divider, or other
8820 non-text area, we treat the click as if it were prefixed by the
8821 symbol denoting that area - `mode-line', `vertical-line', or
8824 If the sequence starts with a mouse click, we read the key sequence
8825 with respect to the buffer clicked on, not the current buffer.
8827 If the user switches frames in the midst of a key sequence, we put
8828 off the switch-frame event until later; the next call to
8829 read_char will return it.
8831 If FIX_CURRENT_BUFFER, we restore current_buffer
8832 from the selected window's buffer. */
8835 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8836 bool dont_downcase_last
, bool can_return_switch_frame
,
8837 bool fix_current_buffer
, bool prevent_redisplay
)
8839 ptrdiff_t count
= SPECPDL_INDEX ();
8841 /* How many keys there are in the current key sequence. */
8844 /* The length of the echo buffer when we started reading, and
8845 the length of this_command_keys when we started reading. */
8846 ptrdiff_t echo_start
IF_LINT (= 0);
8847 ptrdiff_t keys_start
;
8849 Lisp_Object current_binding
= Qnil
;
8850 Lisp_Object first_event
= Qnil
;
8852 /* Index of the first key that has no binding.
8853 It is useless to try fkey.start larger than that. */
8856 /* If t < mock_input, then KEYBUF[t] should be read as the next
8859 We use this to recover after recognizing a function key. Once we
8860 realize that a suffix of the current key sequence is actually a
8861 function key's escape sequence, we replace the suffix with the
8862 function key's binding from Vfunction_key_map. Now keybuf
8863 contains a new and different key sequence, so the echo area,
8864 this_command_keys, and the submaps and defs arrays are wrong. In
8865 this situation, we set mock_input to t, set t to 0, and jump to
8866 restart_sequence; the loop will read keys from keybuf up until
8867 mock_input, thus rebuilding the state; and then it will resume
8868 reading characters from the keyboard. */
8871 /* If the sequence is unbound in submaps[], then
8872 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8873 and fkey.map is its binding.
8875 These might be > t, indicating that all function key scanning
8876 should hold off until t reaches them. We do this when we've just
8877 recognized a function key, to avoid searching for the function
8878 key's again in Vfunction_key_map. */
8881 /* Likewise, for key_translation_map and input-decode-map. */
8882 keyremap keytran
, indec
;
8884 /* True if we are trying to map a key by changing an upper-case
8885 letter to lower case, or a shifted function key to an unshifted
8887 bool shift_translated
= false;
8889 /* If we receive a `switch-frame' or `select-window' event in the middle of
8890 a key sequence, we put it off for later.
8891 While we're reading, we keep the event here. */
8892 Lisp_Object delayed_switch_frame
;
8894 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8895 int original_uppercase_position
= -1;
8897 /* Gets around Microsoft compiler limitations. */
8898 bool dummyflag
= false;
8900 struct buffer
*starting_buffer
;
8902 /* List of events for which a fake prefix key has been generated. */
8903 Lisp_Object fake_prefixed_keys
= Qnil
;
8905 raw_keybuf_count
= 0;
8907 last_nonmenu_event
= Qnil
;
8909 delayed_switch_frame
= Qnil
;
8915 /* Install the string PROMPT as the beginning of the string
8916 of echoing, so that it serves as a prompt for the next
8918 kset_echo_prompt (current_kboard
, prompt
);
8919 /* FIXME: This use of echo_now doesn't look quite right and is ugly
8920 since it forces us to fiddle with current_kboard->immediate_echo
8921 before and after. */
8922 current_kboard
->immediate_echo
= false;
8924 if (!echo_keystrokes_p ())
8925 current_kboard
->immediate_echo
= false;
8927 else if (cursor_in_echo_area
/* FIXME: Not sure why we test this here,
8928 maybe we should just drop this test. */
8929 && echo_keystrokes_p ())
8930 /* This doesn't put in a dash if the echo buffer is empty, so
8931 you don't always see a dash hanging out in the minibuffer. */
8935 /* Record the initial state of the echo area and this_command_keys;
8936 we will need to restore them if we replay a key sequence. */
8938 echo_start
= echo_length ();
8939 keys_start
= this_command_key_count
;
8940 this_single_command_key_start
= keys_start
;
8942 /* We jump here when we need to reinitialize fkey and keytran; this
8943 happens if we switch keyboards between rescans. */
8944 replay_entire_sequence
:
8946 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8947 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8948 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8949 indec
.start
= indec
.end
= 0;
8950 fkey
.start
= fkey
.end
= 0;
8951 keytran
.start
= keytran
.end
= 0;
8953 /* We jump here when the key sequence has been thoroughly changed, and
8954 we need to rescan it starting from the beginning. When we jump here,
8955 keybuf[0..mock_input] holds the sequence we should reread. */
8958 starting_buffer
= current_buffer
;
8959 first_unbound
= bufsize
+ 1;
8961 /* Build our list of keymaps.
8962 If we recognize a function key and replace its escape sequence in
8963 keybuf with its symbol, or if the sequence starts with a mouse
8964 click and we need to switch buffers, we jump back here to rebuild
8965 the initial keymaps from the current buffer. */
8966 current_binding
= active_maps (first_event
);
8968 /* Start from the beginning in keybuf. */
8971 /* These are no-ops the first time through, but if we restart, they
8972 revert the echo area and this_command_keys to their original state. */
8973 this_command_key_count
= keys_start
;
8974 if (INTERACTIVE
&& t
< mock_input
)
8975 echo_truncate (echo_start
);
8977 /* If the best binding for the current key sequence is a keymap, or
8978 we may be looking at a function key's escape sequence, keep on
8980 while (!NILP (current_binding
)
8981 /* Keep reading as long as there's a prefix binding. */
8982 ? KEYMAPP (current_binding
)
8983 /* Don't return in the middle of a possible function key sequence,
8984 if the only bindings we found were via case conversion.
8985 Thus, if ESC O a has a function-key-map translation
8986 and ESC o has a binding, don't return after ESC O,
8987 so that we can translate ESC O plus the next character. */
8988 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8991 bool used_mouse_menu
= false;
8993 /* Where the last real key started. If we need to throw away a
8994 key that has expanded into more than one element of keybuf
8995 (say, a mouse click on the mode line which is being treated
8996 as [mode-line (mouse-...)], then we backtrack to this point
8998 int last_real_key_start
;
9000 /* These variables are analogous to echo_start and keys_start;
9001 while those allow us to restart the entire key sequence,
9002 echo_local_start and keys_local_start allow us to throw away
9004 ptrdiff_t echo_local_start
IF_LINT (= 0);
9005 int keys_local_start
;
9006 Lisp_Object new_binding
;
9008 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9009 eassert (indec
.start
<= indec
.end
);
9010 eassert (fkey
.start
<= fkey
.end
);
9011 eassert (keytran
.start
<= keytran
.end
);
9012 /* key-translation-map is applied *after* function-key-map
9013 which is itself applied *after* input-decode-map. */
9014 eassert (fkey
.end
<= indec
.start
);
9015 eassert (keytran
.end
<= fkey
.start
);
9017 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9018 first_unbound
< keytran
.start
)
9019 { /* The prefix upto first_unbound has no binding and has
9020 no translation left to do either, so we know it's unbound.
9021 If we don't stop now, we risk staying here indefinitely
9022 (if the user keeps entering fkey or keytran prefixes
9023 like C-c ESC ESC ESC ESC ...) */
9025 for (i
= first_unbound
+ 1; i
< t
; i
++)
9026 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9027 mock_input
= t
- first_unbound
- 1;
9028 indec
.end
= indec
.start
-= first_unbound
+ 1;
9029 indec
.map
= indec
.parent
;
9030 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9031 fkey
.map
= fkey
.parent
;
9032 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9033 keytran
.map
= keytran
.parent
;
9034 goto replay_sequence
;
9038 error ("Key sequence too long");
9041 echo_local_start
= echo_length ();
9042 keys_local_start
= this_command_key_count
;
9045 /* These are no-ops, unless we throw away a keystroke below and
9046 jumped back up to replay_key; in that case, these restore the
9047 variables to their original state, allowing us to replay the
9049 if (INTERACTIVE
&& t
< mock_input
)
9050 echo_truncate (echo_local_start
);
9051 this_command_key_count
= keys_local_start
;
9053 /* By default, assume each event is "real". */
9054 last_real_key_start
= t
;
9056 /* Does mock_input indicate that we are re-reading a key sequence? */
9060 add_command_key (key
);
9061 if (current_kboard
->immediate_echo
)
9063 /* Set immediate_echo to false so as to force echo_now to
9064 redisplay (it will set immediate_echo right back to true). */
9065 current_kboard
->immediate_echo
= false;
9070 /* If not, we should actually read a character. */
9074 KBOARD
*interrupted_kboard
= current_kboard
;
9075 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9076 /* Calling read_char with COMMANDFLAG = -2 avoids
9077 redisplay in read_char and its subroutines. */
9078 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9079 current_binding
, last_nonmenu_event
,
9080 &used_mouse_menu
, NULL
);
9081 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9082 /* When switching to a new tty (with a new keyboard),
9083 read_char returns the new buffer, rather than -2
9084 (Bug#5095). This is because `terminal-init-xterm'
9085 calls read-char, which eats the wrong_kboard_jmpbuf
9086 return. Any better way to fix this? -- cyd */
9087 || (interrupted_kboard
!= current_kboard
))
9092 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9093 if (k
== interrupted_kboard
)
9098 /* Don't touch interrupted_kboard when it's been
9100 delayed_switch_frame
= Qnil
;
9101 goto replay_entire_sequence
;
9104 if (!NILP (delayed_switch_frame
))
9107 (interrupted_kboard
,
9108 Fcons (delayed_switch_frame
,
9109 KVAR (interrupted_kboard
, kbd_queue
)));
9110 delayed_switch_frame
= Qnil
;
9115 (interrupted_kboard
,
9116 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9118 /* If the side queue is non-empty, ensure it begins with a
9119 switch-frame, so we'll replay it in the right context. */
9120 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9121 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9122 !(EVENT_HAS_PARAMETERS (key
)
9123 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9127 XSETFRAME (frame
, interrupted_frame
);
9129 (interrupted_kboard
,
9130 Fcons (make_lispy_switch_frame (frame
),
9131 KVAR (interrupted_kboard
, kbd_queue
)));
9134 goto replay_entire_sequence
;
9138 /* read_char returns t when it shows a menu and the user rejects it.
9142 unbind_to (count
, Qnil
);
9146 /* read_char returns -1 at the end of a macro.
9147 Emacs 18 handles this by returning immediately with a
9148 zero, so that's what we'll do. */
9149 if (INTEGERP (key
) && XINT (key
) == -1)
9152 /* The Microsoft C compiler can't handle the goto that
9158 /* If the current buffer has been changed from under us, the
9159 keymap may have changed, so replay the sequence. */
9162 timer_resume_idle ();
9165 /* Reset the current buffer from the selected window
9166 in case something changed the former and not the latter.
9167 This is to be more consistent with the behavior
9168 of the command_loop_1. */
9169 if (fix_current_buffer
)
9171 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9173 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9175 Fset_buffer (XWINDOW (selected_window
)->contents
);
9178 goto replay_sequence
;
9181 /* If we have a quit that was typed in another frame, and
9182 quit_throw_to_read_char switched buffers,
9183 replay to get the right keymap. */
9185 && XINT (key
) == quit_char
9186 && current_buffer
!= starting_buffer
)
9189 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9194 goto replay_sequence
;
9199 if (EVENT_HAS_PARAMETERS (key
)
9200 /* Either a `switch-frame' or a `select-window' event. */
9201 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9203 /* If we're at the beginning of a key sequence, and the caller
9204 says it's okay, go ahead and return this event. If we're
9205 in the midst of a key sequence, delay it until the end. */
9206 if (t
> 0 || !can_return_switch_frame
)
9208 delayed_switch_frame
= key
;
9213 if (NILP (first_event
))
9216 /* Even if first_event does not specify a particular
9217 window/position, it's important to recompute the maps here
9218 since a long time might have passed since we entered
9219 read_key_sequence, and a timer (or process-filter or
9220 special-event-map, ...) might have switched the current buffer
9221 or the selected window from under us in the mean time. */
9222 if (fix_current_buffer
9223 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9225 Fset_buffer (XWINDOW (selected_window
)->contents
);
9226 current_binding
= active_maps (first_event
);
9230 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9234 /* Clicks in non-text areas get prefixed by the symbol
9235 in their CHAR-ADDRESS field. For example, a click on
9236 the mode line is prefixed by the symbol `mode-line'.
9238 Furthermore, key sequences beginning with mouse clicks
9239 are read using the keymaps of the buffer clicked on, not
9240 the current buffer. So we may have to switch the buffer
9243 When we turn one event into two events, we must make sure
9244 that neither of the two looks like the original--so that,
9245 if we replay the events, they won't be expanded again.
9246 If not for this, such reexpansion could happen either here
9247 or when user programs play with this-command-keys. */
9248 if (EVENT_HAS_PARAMETERS (key
))
9250 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9251 if (EQ (kind
, Qmouse_click
))
9253 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9254 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9257 || (!NILP (fake_prefixed_keys
)
9258 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9260 /* We're looking a second time at an event for which
9261 we generated a fake prefix key. Set
9262 last_real_key_start appropriately. */
9264 last_real_key_start
= t
- 1;
9267 if (last_real_key_start
== 0)
9269 /* Key sequences beginning with mouse clicks are
9270 read using the keymaps in the buffer clicked on,
9271 not the current buffer. If we're at the
9272 beginning of a key sequence, switch buffers. */
9273 if (WINDOWP (window
)
9274 && BUFFERP (XWINDOW (window
)->contents
)
9275 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9277 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9282 /* Arrange to go back to the original buffer once we're
9283 done reading the key sequence. Note that we can't
9284 use save_excursion_{save,restore} here, because they
9285 save point as well as the current buffer; we don't
9286 want to save point, because redisplay may change it,
9287 to accommodate a Fset_window_start or something. We
9288 don't want to do this at the top of the function,
9289 because we may get input from a subprocess which
9290 wants to change the selected window and stuff (say,
9292 record_unwind_current_buffer ();
9294 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9296 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9297 goto replay_sequence
;
9301 /* Expand mode-line and scroll-bar events into two events:
9302 use posn as a fake prefix key. */
9304 && (NILP (fake_prefixed_keys
)
9305 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9307 if (bufsize
- t
<= 1)
9308 error ("Key sequence too long");
9311 keybuf
[t
+ 1] = key
;
9314 /* Record that a fake prefix key has been generated
9315 for KEY. Don't modify the event; this would
9316 prevent proper action when the event is pushed
9317 back into unread-command-events. */
9318 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9322 else if (CONSP (XCDR (key
))
9323 && CONSP (EVENT_START (key
))
9324 && CONSP (XCDR (EVENT_START (key
))))
9328 posn
= POSN_POSN (EVENT_START (key
));
9329 /* Handle menu-bar events:
9330 insert the dummy prefix event `menu-bar'. */
9331 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9333 if (bufsize
- t
<= 1)
9334 error ("Key sequence too long");
9336 keybuf
[t
+ 1] = key
;
9338 /* Zap the position in key, so we know that we've
9339 expanded it, and don't try to do so again. */
9340 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9343 goto replay_sequence
;
9345 else if (CONSP (posn
))
9347 /* We're looking at the second event of a
9348 sequence which we expanded before. Set
9349 last_real_key_start appropriately. */
9350 if (last_real_key_start
== t
&& t
> 0)
9351 last_real_key_start
= t
- 1;
9356 /* We have finally decided that KEY is something we might want
9358 new_binding
= follow_key (current_binding
, key
);
9360 /* If KEY wasn't bound, we'll try some fallbacks. */
9361 if (!NILP (new_binding
))
9362 /* This is needed for the following scenario:
9363 event 0: a down-event that gets dropped by calling replay_key.
9364 event 1: some normal prefix like C-h.
9365 After event 0, first_unbound is 0, after event 1 indec.start,
9366 fkey.start, and keytran.start are all 1, so when we see that
9367 C-h is bound, we need to update first_unbound. */
9368 first_unbound
= max (t
+ 1, first_unbound
);
9373 /* Remember the position to put an upper bound on indec.start. */
9374 first_unbound
= min (t
, first_unbound
);
9376 head
= EVENT_HEAD (key
);
9380 Lisp_Object breakdown
;
9383 breakdown
= parse_modifiers (head
);
9384 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9385 /* Attempt to reduce an unbound mouse event to a simpler
9386 event that is bound:
9387 Drags reduce to clicks.
9388 Double-clicks reduce to clicks.
9389 Triple-clicks reduce to double-clicks, then to clicks.
9390 Up/Down-clicks are eliminated.
9391 Double-downs reduce to downs, then are eliminated.
9392 Triple-downs reduce to double-downs, then to downs,
9393 then are eliminated. */
9394 if (modifiers
& (up_modifier
| down_modifier
9396 | double_modifier
| triple_modifier
))
9398 while (modifiers
& (up_modifier
| down_modifier
9400 | double_modifier
| triple_modifier
))
9402 Lisp_Object new_head
, new_click
;
9403 if (modifiers
& triple_modifier
)
9404 modifiers
^= (double_modifier
| triple_modifier
);
9405 else if (modifiers
& double_modifier
)
9406 modifiers
&= ~double_modifier
;
9407 else if (modifiers
& drag_modifier
)
9408 modifiers
&= ~drag_modifier
;
9411 /* Dispose of this `up/down' event by simply jumping
9412 back to replay_key, to get another event.
9414 Note that if this event came from mock input,
9415 then just jumping back to replay_key will just
9416 hand it to us again. So we have to wipe out any
9419 We could delete keybuf[t] and shift everything
9420 after that to the left by one spot, but we'd also
9421 have to fix up any variable that points into
9422 keybuf, and shifting isn't really necessary
9425 Adding prefixes for non-textual mouse clicks
9426 creates two characters of mock input, and both
9427 must be thrown away. If we're only looking at
9428 the prefix now, we can just jump back to
9429 replay_key. On the other hand, if we've already
9430 processed the prefix, and now the actual click
9431 itself is giving us trouble, then we've lost the
9432 state of the keymaps we want to backtrack to, and
9433 we need to replay the whole sequence to rebuild
9436 Beyond that, only function key expansion could
9437 create more than two keys, but that should never
9438 generate mouse events, so it's okay to zero
9439 mock_input in that case too.
9441 FIXME: The above paragraph seems just plain
9442 wrong, if you consider things like
9443 xterm-mouse-mode. -stef
9445 Isn't this just the most wonderful code ever? */
9447 /* If mock_input > t + 1, the above simplification
9448 will actually end up dropping keys on the floor.
9449 This is probably OK for now, but even
9450 if mock_input <= t + 1, we need to adjust indec,
9452 Typical case [header-line down-mouse-N]:
9453 mock_input = 2, t = 1, fkey.end = 1,
9454 last_real_key_start = 0. */
9455 if (indec
.end
> last_real_key_start
)
9457 indec
.end
= indec
.start
9458 = min (last_real_key_start
, indec
.start
);
9459 indec
.map
= indec
.parent
;
9460 if (fkey
.end
> last_real_key_start
)
9462 fkey
.end
= fkey
.start
9463 = min (last_real_key_start
, fkey
.start
);
9464 fkey
.map
= fkey
.parent
;
9465 if (keytran
.end
> last_real_key_start
)
9467 keytran
.end
= keytran
.start
9468 = min (last_real_key_start
, keytran
.start
);
9469 keytran
.map
= keytran
.parent
;
9473 if (t
== last_real_key_start
)
9480 mock_input
= last_real_key_start
;
9481 goto replay_sequence
;
9486 = apply_modifiers (modifiers
, XCAR (breakdown
));
9487 new_click
= list2 (new_head
, EVENT_START (key
));
9489 /* Look for a binding for this new key. */
9490 new_binding
= follow_key (current_binding
, new_click
);
9492 /* If that click is bound, go for it. */
9493 if (!NILP (new_binding
))
9495 current_binding
= new_binding
;
9499 /* Otherwise, we'll leave key set to the drag event. */
9504 current_binding
= new_binding
;
9507 /* Normally, last_nonmenu_event gets the previous key we read.
9508 But when a mouse popup menu is being used,
9509 we don't update last_nonmenu_event; it continues to hold the mouse
9510 event that preceded the first level of menu. */
9511 if (!used_mouse_menu
)
9512 last_nonmenu_event
= key
;
9514 /* Record what part of this_command_keys is the current key sequence. */
9515 this_single_command_key_start
= this_command_key_count
- t
;
9516 /* When 'input-method-function' called above causes events to be
9517 put on 'unread-post-input-method-events', and as result
9518 'reread' is set to 'true', the value of 't' can become larger
9519 than 'this_command_key_count', because 'add_command_key' is
9520 not called to update 'this_command_key_count'. If this
9521 happens, 'this_single_command_key_start' will become negative
9522 above, and any call to 'this-single-command-keys' will return
9523 a garbled vector. See bug #20223 for one such situation.
9524 Here we force 'this_single_command_key_start' to never become
9525 negative, to avoid that. */
9526 if (this_single_command_key_start
< 0)
9527 this_single_command_key_start
= 0;
9529 /* Look for this sequence in input-decode-map.
9530 Scan from indec.end until we find a bound suffix. */
9531 while (indec
.end
< t
)
9536 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9540 mock_input
= diff
+ max (t
, mock_input
);
9541 goto replay_sequence
;
9545 if (!KEYMAPP (current_binding
)
9546 && !test_undefined (current_binding
)
9547 && indec
.start
>= t
)
9548 /* There is a binding and it's not a prefix.
9549 (and it doesn't have any input-decode-map translation pending).
9550 There is thus no function-key in this sequence.
9551 Moving fkey.start is important in this case to allow keytran.start
9552 to go over the sequence before we return (since we keep the
9553 invariant that keytran.end <= fkey.start). */
9556 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9559 /* If the sequence is unbound, see if we can hang a function key
9560 off the end of it. */
9561 /* Continue scan from fkey.end until we find a bound suffix. */
9562 while (fkey
.end
< indec
.start
)
9567 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9568 max (t
, mock_input
),
9569 /* If there's a binding (i.e.
9570 first_binding >= nmaps) we don't want
9571 to apply this function-key-mapping. */
9573 && (test_undefined (current_binding
)),
9577 mock_input
= diff
+ max (t
, mock_input
);
9578 /* Adjust the input-decode-map counters. */
9580 indec
.start
+= diff
;
9582 goto replay_sequence
;
9586 /* Look for this sequence in key-translation-map.
9587 Scan from keytran.end until we find a bound suffix. */
9588 while (keytran
.end
< fkey
.start
)
9593 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9597 mock_input
= diff
+ max (t
, mock_input
);
9598 /* Adjust the function-key-map and input-decode-map counters. */
9600 indec
.start
+= diff
;
9604 goto replay_sequence
;
9608 /* If KEY is not defined in any of the keymaps,
9609 and cannot be part of a function key or translation,
9610 and is an upper case letter
9611 use the corresponding lower-case letter instead. */
9612 if (NILP (current_binding
)
9613 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9615 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9616 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9617 || (XINT (key
) & shift_modifier
)))
9619 Lisp_Object new_key
;
9621 original_uppercase
= key
;
9622 original_uppercase_position
= t
- 1;
9624 if (XINT (key
) & shift_modifier
)
9625 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9627 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9628 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9630 /* We have to do this unconditionally, regardless of whether
9631 the lower-case char is defined in the keymaps, because they
9632 might get translated through function-key-map. */
9633 keybuf
[t
- 1] = new_key
;
9634 mock_input
= max (t
, mock_input
);
9635 shift_translated
= true;
9637 goto replay_sequence
;
9640 if (NILP (current_binding
)
9641 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9643 read_key_sequence_cmd
= Vprefix_help_command
;
9644 /* The Microsoft C compiler can't handle the goto that
9650 /* If KEY is not defined in any of the keymaps,
9651 and cannot be part of a function key or translation,
9652 and is a shifted function key,
9653 use the corresponding unshifted function key instead. */
9654 if (NILP (current_binding
)
9655 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9657 Lisp_Object breakdown
= parse_modifiers (key
);
9659 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9661 if (modifiers
& shift_modifier
9662 /* Treat uppercase keys as shifted. */
9664 && (KEY_TO_CHAR (key
)
9665 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9666 && uppercasep (KEY_TO_CHAR (key
))))
9669 = (modifiers
& shift_modifier
9670 ? apply_modifiers (modifiers
& ~shift_modifier
,
9672 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9674 original_uppercase
= key
;
9675 original_uppercase_position
= t
- 1;
9677 /* We have to do this unconditionally, regardless of whether
9678 the lower-case char is defined in the keymaps, because they
9679 might get translated through function-key-map. */
9680 keybuf
[t
- 1] = new_key
;
9681 mock_input
= max (t
, mock_input
);
9682 /* Reset fkey (and consequently keytran) to apply
9683 function-key-map on the result, so that S-backspace is
9684 correctly mapped to DEL (via backspace). OTOH,
9685 input-decode-map doesn't need to go through it again. */
9686 fkey
.start
= fkey
.end
= 0;
9687 keytran
.start
= keytran
.end
= 0;
9688 shift_translated
= true;
9690 goto replay_sequence
;
9695 read_key_sequence_cmd
= current_binding
;
9696 read_key_sequence_remapped
9697 /* Remap command through active keymaps.
9698 Do the remapping here, before the unbind_to so it uses the keymaps
9699 of the appropriate buffer. */
9700 = SYMBOLP (read_key_sequence_cmd
)
9701 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9704 unread_switch_frame
= delayed_switch_frame
;
9705 unbind_to (count
, Qnil
);
9707 /* Don't downcase the last character if the caller says don't.
9708 Don't downcase it if the result is undefined, either. */
9709 if ((dont_downcase_last
|| NILP (current_binding
))
9711 && t
- 1 == original_uppercase_position
)
9713 keybuf
[t
- 1] = original_uppercase
;
9714 shift_translated
= false;
9717 if (shift_translated
)
9718 Vthis_command_keys_shift_translated
= Qt
;
9720 /* Occasionally we fabricate events, perhaps by expanding something
9721 according to function-key-map, or by adding a prefix symbol to a
9722 mouse click in the scroll bar or modeline. In this cases, return
9723 the entire generated key sequence, even if we hit an unbound
9724 prefix or a definition before the end. This means that you will
9725 be able to push back the event properly, and also means that
9726 read-key-sequence will always return a logical unit.
9729 for (; t
< mock_input
; t
++)
9730 add_command_key (keybuf
[t
]);
9737 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9738 Lisp_Object dont_downcase_last
,
9739 Lisp_Object can_return_switch_frame
,
9740 Lisp_Object cmd_loop
, bool allow_string
)
9742 Lisp_Object keybuf
[30];
9744 ptrdiff_t count
= SPECPDL_INDEX ();
9747 CHECK_STRING (prompt
);
9750 specbind (Qinput_method_exit_on_first_char
,
9751 (NILP (cmd_loop
) ? Qt
: Qnil
));
9752 specbind (Qinput_method_use_echo_area
,
9753 (NILP (cmd_loop
) ? Qt
: Qnil
));
9755 if (NILP (continue_echo
))
9757 this_command_key_count
= 0;
9758 this_single_command_key_start
= 0;
9761 #ifdef HAVE_WINDOW_SYSTEM
9762 if (display_hourglass_p
)
9763 cancel_hourglass ();
9766 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9767 prompt
, ! NILP (dont_downcase_last
),
9768 ! NILP (can_return_switch_frame
), 0, 0);
9770 #if 0 /* The following is fine for code reading a key sequence and
9771 then proceeding with a lengthy computation, but it's not good
9772 for code reading keys in a loop, like an input method. */
9773 #ifdef HAVE_WINDOW_SYSTEM
9774 if (display_hourglass_p
)
9785 return unbind_to (count
,
9786 ((allow_string
? make_event_array
: Fvector
)
9790 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9791 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9792 The sequence is sufficient to specify a non-prefix command in the
9793 current local and global maps.
9795 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9796 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9797 as a continuation of the previous key.
9799 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9800 convert the last event to lower case. (Normally any upper case event
9801 is converted to lower case if the original event is undefined and the lower
9802 case equivalent is defined.) A non-nil value is appropriate for reading
9803 a key sequence to be defined.
9805 A C-g typed while in this function is treated like any other character,
9806 and `quit-flag' is not set.
9808 If the key sequence starts with a mouse click, then the sequence is read
9809 using the keymaps of the buffer of the window clicked in, not the buffer
9810 of the selected window as normal.
9812 `read-key-sequence' drops unbound button-down events, since you normally
9813 only care about the click or drag events which follow them. If a drag
9814 or multi-click event is unbound, but the corresponding click event would
9815 be bound, `read-key-sequence' turns the event into a click event at the
9816 drag's starting position. This means that you don't have to distinguish
9817 between click and drag, double, or triple events unless you want to.
9819 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9820 lines separating windows, and scroll bars with imaginary keys
9821 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9823 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9824 function will process a switch-frame event if the user switches frames
9825 before typing anything. If the user switches frames in the middle of a
9826 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9827 is nil, then the event will be put off until after the current key sequence.
9829 `read-key-sequence' checks `function-key-map' for function key
9830 sequences, where they wouldn't conflict with ordinary bindings. See
9831 `function-key-map' for more details.
9833 The optional fifth argument CMD-LOOP, if non-nil, means
9834 that this key sequence is being read by something that will
9835 read commands one after another. It should be nil if the caller
9836 will read just one key sequence. */)
9837 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9839 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9840 can_return_switch_frame
, cmd_loop
, true);
9843 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9844 Sread_key_sequence_vector
, 1, 5, 0,
9845 doc
: /* Like `read-key-sequence' but always return a vector. */)
9846 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9848 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9849 can_return_switch_frame
, cmd_loop
, false);
9852 /* Return true if input events are pending. */
9855 detect_input_pending (void)
9857 return input_pending
|| get_input_pending (0);
9860 /* Return true if input events other than mouse movements are
9864 detect_input_pending_ignore_squeezables (void)
9866 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9869 /* Return true if input events are pending, and run any pending timers. */
9872 detect_input_pending_run_timers (bool do_display
)
9874 unsigned old_timers_run
= timers_run
;
9877 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9879 if (old_timers_run
!= timers_run
&& do_display
)
9880 redisplay_preserve_echo_area (8);
9882 return input_pending
;
9885 /* This is called in some cases before a possible quit.
9886 It cases the next call to detect_input_pending to recompute input_pending.
9887 So calling this function unnecessarily can't do any harm. */
9890 clear_input_pending (void)
9892 input_pending
= false;
9895 /* Return true if there are pending requeued events.
9896 This isn't used yet. The hope is to make wait_reading_process_output
9897 call it, and return if it runs Lisp code that unreads something.
9898 The problem is, kbd_buffer_get_event needs to be fixed to know what
9899 to do in that case. It isn't trivial. */
9902 requeued_events_pending_p (void)
9904 return (CONSP (Vunread_command_events
));
9907 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9908 doc
: /* Return t if command input is currently available with no wait.
9909 Actually, the value is nil only if we can be sure that no input is available;
9910 if there is a doubt, the value is t.
9912 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9913 (Lisp_Object check_timers
)
9915 if (CONSP (Vunread_command_events
)
9916 || !NILP (Vunread_post_input_method_events
)
9917 || !NILP (Vunread_input_method_events
))
9920 /* Process non-user-visible events (Bug#10195). */
9921 process_special_events ();
9923 return (get_input_pending ((NILP (check_timers
)
9924 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9925 | READABLE_EVENTS_FILTER_EVENTS
)
9929 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
9930 doc
: /* Return vector of last few events, not counting those from keyboard macros.
9931 If INCLUDE-CMDS is non-nil, include the commands that were run,
9932 represented as events of the form (nil . COMMAND). */)
9933 (Lisp_Object include_cmds
)
9935 bool cmds
= !NILP (include_cmds
);
9938 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
9939 return Fvector (total_keys
,
9940 XVECTOR (recent_keys
)->contents
);
9943 Lisp_Object es
= Qnil
;
9944 int i
= (total_keys
< NUM_RECENT_KEYS
9945 ? 0 : recent_keys_index
);
9946 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
9949 Lisp_Object e
= AREF (recent_keys
, i
);
9950 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
9952 if (++i
>= NUM_RECENT_KEYS
)
9954 } while (i
!= recent_keys_index
);
9955 es
= Fnreverse (es
);
9956 return Fvconcat (1, &es
);
9960 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9961 doc
: /* Return the key sequence that invoked this command.
9962 However, if the command has called `read-key-sequence', it returns
9963 the last key sequence that has been read.
9964 The value is a string or a vector.
9966 See also `this-command-keys-vector'. */)
9969 return make_event_array (this_command_key_count
,
9970 XVECTOR (this_command_keys
)->contents
);
9973 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9974 doc
: /* Return the key sequence that invoked this command, as a vector.
9975 However, if the command has called `read-key-sequence', it returns
9976 the last key sequence that has been read.
9978 See also `this-command-keys'. */)
9981 return Fvector (this_command_key_count
,
9982 XVECTOR (this_command_keys
)->contents
);
9985 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9986 Sthis_single_command_keys
, 0, 0, 0,
9987 doc
: /* Return the key sequence that invoked this command.
9988 More generally, it returns the last key sequence read, either by
9989 the command loop or by `read-key-sequence'.
9990 Unlike `this-command-keys', this function's value
9991 does not include prefix arguments.
9992 The value is always a vector. */)
9995 return Fvector (this_command_key_count
9996 - this_single_command_key_start
,
9997 (XVECTOR (this_command_keys
)->contents
9998 + this_single_command_key_start
));
10001 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10002 Sthis_single_command_raw_keys
, 0, 0, 0,
10003 doc
: /* Return the raw events that were read for this command.
10004 More generally, it returns the last key sequence read, either by
10005 the command loop or by `read-key-sequence'.
10006 Unlike `this-single-command-keys', this function's value
10007 shows the events before all translations (except for input methods).
10008 The value is always a vector. */)
10011 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10014 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10015 Sclear_this_command_keys
, 0, 1, 0,
10016 doc
: /* Clear out the vector that `this-command-keys' returns.
10017 Also clear the record of the last 100 events, unless optional arg
10018 KEEP-RECORD is non-nil. */)
10019 (Lisp_Object keep_record
)
10023 this_command_key_count
= 0;
10025 if (NILP (keep_record
))
10027 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10028 ASET (recent_keys
, i
, Qnil
);
10030 recent_keys_index
= 0;
10035 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10036 doc
: /* Return the current depth in recursive edits. */)
10040 /* Wrap around reliably on integer overflow. */
10041 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10042 XSETINT (temp
, sum
);
10046 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10047 "FOpen dribble file: ",
10048 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10049 If FILE is nil, close any open dribble file.
10050 The file will be closed when Emacs exits.
10052 Be aware that this records ALL characters you type!
10053 This may include sensitive information such as passwords. */)
10066 Lisp_Object encfile
;
10068 file
= Fexpand_file_name (file
, Qnil
);
10069 encfile
= ENCODE_FILE (file
);
10070 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10071 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10072 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10073 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10075 report_file_error ("Opening dribble", file
);
10080 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10081 doc
: /* Discard the contents of the terminal input buffer.
10082 Also end any kbd macro being defined. */)
10085 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10087 /* Discard the last command from the macro. */
10088 Fcancel_kbd_macro_events ();
10092 Vunread_command_events
= Qnil
;
10094 discard_tty_input ();
10096 kbd_fetch_ptr
= kbd_store_ptr
;
10097 input_pending
= false;
10102 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10103 doc
: /* Stop Emacs and return to superior process. You can resume later.
10104 If `cannot-suspend' is non-nil, or if the system doesn't support job
10105 control, run a subshell instead.
10107 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10108 to be read as terminal input by Emacs's parent, after suspension.
10110 Before suspending, run the normal hook `suspend-hook'.
10111 After resumption run the normal hook `suspend-resume-hook'.
10113 Some operating systems cannot stop the Emacs process and resume it later.
10114 On such systems, Emacs starts a subshell instead of suspending. */)
10115 (Lisp_Object stuffstring
)
10117 ptrdiff_t count
= SPECPDL_INDEX ();
10118 int old_height
, old_width
;
10121 if (tty_list
&& tty_list
->next
)
10122 error ("There are other tty frames open; close them before suspending Emacs");
10124 if (!NILP (stuffstring
))
10125 CHECK_STRING (stuffstring
);
10127 run_hook (intern ("suspend-hook"));
10129 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10130 reset_all_sys_modes ();
10131 /* sys_suspend can get an error if it tries to fork a subshell
10132 and the system resources aren't available for that. */
10133 record_unwind_protect_void (init_all_sys_modes
);
10134 stuff_buffered_input (stuffstring
);
10135 if (cannot_suspend
)
10139 unbind_to (count
, Qnil
);
10141 /* Check if terminal/window size has changed.
10142 Note that this is not useful when we are running directly
10143 with a window system; but suspend should be disabled in that case. */
10144 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10145 if (width
!= old_width
|| height
!= old_height
)
10146 change_frame_size (SELECTED_FRAME (), width
,
10147 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10150 run_hook (intern ("suspend-resume-hook"));
10155 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10156 Then in any case stuff anything Emacs has read ahead and not used. */
10159 stuff_buffered_input (Lisp_Object stuffstring
)
10161 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10162 register unsigned char *p
;
10164 if (STRINGP (stuffstring
))
10166 register ptrdiff_t count
;
10168 p
= SDATA (stuffstring
);
10169 count
= SBYTES (stuffstring
);
10170 while (count
-- > 0)
10175 /* Anything we have read ahead, put back for the shell to read. */
10176 /* ?? What should this do when we have multiple keyboards??
10177 Should we ignore anything that was typed in at the "wrong" kboard?
10179 rms: we should stuff everything back into the kboard
10181 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10184 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10185 kbd_fetch_ptr
= kbd_buffer
;
10186 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10187 stuff_char (kbd_fetch_ptr
->ie
.code
);
10189 clear_event (kbd_fetch_ptr
);
10192 input_pending
= false;
10193 #endif /* SIGTSTP */
10197 set_waiting_for_input (struct timespec
*time_to_clear
)
10199 input_available_clear_time
= time_to_clear
;
10201 /* Tell handle_interrupt to throw back to read_char, */
10202 waiting_for_input
= true;
10204 /* If handle_interrupt was called before and buffered a C-g,
10205 make it run again now, to avoid timing error. */
10206 if (!NILP (Vquit_flag
))
10207 quit_throw_to_read_char (0);
10211 clear_waiting_for_input (void)
10213 /* Tell handle_interrupt not to throw back to read_char, */
10214 waiting_for_input
= false;
10215 input_available_clear_time
= 0;
10218 /* The SIGINT handler.
10220 If we have a frame on the controlling tty, we assume that the
10221 SIGINT was generated by C-g, so we call handle_interrupt.
10222 Otherwise, tell QUIT to kill Emacs. */
10225 handle_interrupt_signal (int sig
)
10227 /* See if we have an active terminal on our controlling tty. */
10228 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10231 /* If there are no frames there, let's pretend that we are a
10232 well-behaving UN*X program and quit. We must not call Lisp
10233 in a signal handler, so tell QUIT to exit when it is
10235 Vquit_flag
= Qkill_emacs
;
10239 /* Otherwise, the SIGINT was probably generated by C-g. */
10241 /* Set internal_last_event_frame to the top frame of the
10242 controlling tty, if we have a frame there. We disable the
10243 interrupt key on secondary ttys, so the SIGINT must have come
10244 from the controlling tty. */
10245 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10247 handle_interrupt (1);
10252 deliver_interrupt_signal (int sig
)
10254 deliver_process_signal (sig
, handle_interrupt_signal
);
10257 /* Output MSG directly to standard output, without buffering. Ignore
10258 failures. This is safe in a signal handler. */
10260 write_stdout (char const *msg
)
10262 ignore_value (write (STDOUT_FILENO
, msg
, strlen (msg
)));
10265 /* Read a byte from stdin, without buffering. Safe in signal handlers. */
10270 return read (STDIN_FILENO
, &c
, 1) == 1 ? c
: EOF
;
10273 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10274 of the number of times C-g has been requested. If C-g is pressed
10275 enough times, then quit anyway. See bug#6585. */
10276 static int volatile force_quit_count
;
10278 /* This routine is called at interrupt level in response to C-g.
10280 It is called from the SIGINT handler or kbd_buffer_store_event.
10282 If `waiting_for_input' is non zero, then unless `echoing' is
10283 nonzero, immediately throw back to read_char.
10285 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10286 eval to throw, when it gets a chance. If quit-flag is already
10287 non-nil, it stops the job right away. */
10290 handle_interrupt (bool in_signal_handler
)
10296 /* XXX This code needs to be revised for multi-tty support. */
10297 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10299 if (! in_signal_handler
)
10301 /* If SIGINT isn't blocked, don't let us be interrupted by
10302 a SIGINT. It might be harmful due to non-reentrancy
10303 in I/O functions. */
10305 sigemptyset (&blocked
);
10306 sigaddset (&blocked
, SIGINT
);
10307 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10311 reset_all_sys_modes ();
10315 * On systems which can suspend the current process and return to the original
10316 * shell, this command causes the user to end up back at the shell.
10317 * The "Auto-save" and "Abort" questions are not asked until
10318 * the user elects to return to emacs, at which point he can save the current
10319 * job and either dump core or continue.
10323 /* Perhaps should really fork an inferior shell?
10324 But that would not provide any way to get back
10325 to the original shell, ever. */
10326 write_stdout ("No support for stopping a process"
10327 " on this operating system;\n"
10328 "you can continue or abort.\n");
10329 #endif /* not SIGTSTP */
10331 /* We must remain inside the screen area when the internal terminal
10332 is used. Note that [Enter] is not echoed by dos. */
10333 cursor_to (SELECTED_FRAME (), 0, 0);
10336 write_stdout ("Emacs is resuming after an emergency escape.\n");
10338 /* It doesn't work to autosave while GC is in progress;
10339 the code used for auto-saving doesn't cope with the mark bit. */
10340 if (!gc_in_progress
)
10342 write_stdout ("Auto-save? (y or n) ");
10344 if (c
== 'y' || c
== 'Y')
10346 Fdo_auto_save (Qt
, Qnil
);
10348 write_stdout ("\r\nAuto-save done");
10350 write_stdout ("Auto-save done\n");
10358 /* During GC, it must be safe to reenable quitting again. */
10359 Vinhibit_quit
= Qnil
;
10365 "Garbage collection in progress; cannot auto-save now\r\n"
10366 "but will instead do a real quit"
10367 " after garbage collection ends\r\n");
10371 write_stdout ("\r\nAbort? (y or n) ");
10373 write_stdout ("Abort (and dump core)? (y or n) ");
10376 if (c
== 'y' || c
== 'Y')
10381 write_stdout ("\r\nContinuing...\r\n");
10382 #else /* not MSDOS */
10383 write_stdout ("Continuing...\n");
10384 #endif /* not MSDOS */
10385 init_all_sys_modes ();
10389 /* If executing a function that wants to be interrupted out of
10390 and the user has not deferred quitting by binding `inhibit-quit'
10391 then quit right away. */
10392 if (immediate_quit
&& NILP (Vinhibit_quit
))
10394 struct gl_state_s saved
;
10396 immediate_quit
= false;
10397 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10399 Fsignal (Qquit
, Qnil
);
10403 { /* Else request quit when it's safe. */
10404 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10405 force_quit_count
= count
;
10408 immediate_quit
= true;
10409 Vinhibit_quit
= Qnil
;
10415 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10417 /* TODO: The longjmp in this call throws the NS event loop integration off,
10418 and it seems to do fine without this. Probably some attention
10419 needs to be paid to the setting of waiting_for_input in
10420 wait_reading_process_output() under HAVE_NS because of the call
10421 to ns_select there (needed because otherwise events aren't picked up
10422 outside of polling since we don't get SIGIO like X and we don't have a
10423 separate event loop thread like W32. */
10425 if (waiting_for_input
&& !echoing
)
10426 quit_throw_to_read_char (in_signal_handler
);
10430 /* Handle a C-g by making read_char return C-g. */
10433 quit_throw_to_read_char (bool from_signal
)
10435 /* When not called from a signal handler it is safe to call
10437 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10438 Fkill_emacs (Qnil
);
10440 /* Prevent another signal from doing this before we finish. */
10441 clear_waiting_for_input ();
10442 input_pending
= false;
10444 Vunread_command_events
= Qnil
;
10446 if (FRAMEP (internal_last_event_frame
)
10447 && !EQ (internal_last_event_frame
, selected_frame
))
10448 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10451 sys_longjmp (getcjmp
, 1);
10454 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10455 Sset_input_interrupt_mode
, 1, 1, 0,
10456 doc
: /* Set interrupt mode of reading keyboard input.
10457 If INTERRUPT is non-nil, Emacs will use input interrupts;
10458 otherwise Emacs uses CBREAK mode.
10460 See also `current-input-mode'. */)
10461 (Lisp_Object interrupt
)
10463 bool new_interrupt_input
;
10464 #ifdef USABLE_SIGIO
10465 #ifdef HAVE_X_WINDOWS
10466 if (x_display_list
!= NULL
)
10468 /* When using X, don't give the user a real choice,
10469 because we haven't implemented the mechanisms to support it. */
10470 new_interrupt_input
= true;
10473 #endif /* HAVE_X_WINDOWS */
10474 new_interrupt_input
= !NILP (interrupt
);
10475 #else /* not USABLE_SIGIO */
10476 new_interrupt_input
= false;
10477 #endif /* not USABLE_SIGIO */
10479 if (new_interrupt_input
!= interrupt_input
)
10481 #ifdef POLL_FOR_INPUT
10485 /* this causes startup screen to be restored and messes with the mouse */
10486 reset_all_sys_modes ();
10487 interrupt_input
= new_interrupt_input
;
10488 init_all_sys_modes ();
10490 interrupt_input
= new_interrupt_input
;
10493 #ifdef POLL_FOR_INPUT
10494 poll_suppress_count
= 1;
10501 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10502 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10503 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10504 C-q in key sequences.
10506 This setting only has an effect on tty terminals and only when
10507 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10509 See also `current-input-mode'. */)
10510 (Lisp_Object flow
, Lisp_Object terminal
)
10512 struct terminal
*t
= decode_tty_terminal (terminal
);
10513 struct tty_display_info
*tty
;
10517 tty
= t
->display_info
.tty
;
10519 if (tty
->flow_control
!= !NILP (flow
))
10522 /* This causes startup screen to be restored and messes with the mouse. */
10523 reset_sys_modes (tty
);
10526 tty
->flow_control
= !NILP (flow
);
10529 init_sys_modes (tty
);
10535 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10536 doc
: /* Enable or disable 8-bit input on TERMINAL.
10537 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10538 bit as the Meta modifier.
10540 If META is nil, Emacs will ignore the top bit, on the assumption it is
10543 Otherwise, Emacs will accept and pass through 8-bit input without
10544 specially interpreting the top bit.
10546 This setting only has an effect on tty terminal devices.
10548 Optional parameter TERMINAL specifies the tty terminal device to use.
10549 It may be a terminal object, a frame, or nil for the terminal used by
10550 the currently selected frame.
10552 See also `current-input-mode'. */)
10553 (Lisp_Object meta
, Lisp_Object terminal
)
10555 struct terminal
*t
= decode_tty_terminal (terminal
);
10556 struct tty_display_info
*tty
;
10561 tty
= t
->display_info
.tty
;
10565 else if (EQ (meta
, Qt
))
10570 if (tty
->meta_key
!= new_meta
)
10573 /* this causes startup screen to be restored and messes with the mouse */
10574 reset_sys_modes (tty
);
10577 tty
->meta_key
= new_meta
;
10580 init_sys_modes (tty
);
10586 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10587 doc
: /* Specify character used for quitting.
10588 QUIT must be an ASCII character.
10590 This function only has an effect on the controlling tty of the Emacs
10593 See also `current-input-mode'. */)
10596 struct terminal
*t
= get_named_terminal ("/dev/tty");
10597 struct tty_display_info
*tty
;
10601 tty
= t
->display_info
.tty
;
10603 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10604 error ("QUIT must be an ASCII character");
10607 /* this causes startup screen to be restored and messes with the mouse */
10608 reset_sys_modes (tty
);
10611 /* Don't let this value be out of range. */
10612 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10615 init_sys_modes (tty
);
10621 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10622 doc
: /* Set mode of reading keyboard input.
10623 First arg INTERRUPT non-nil means use input interrupts;
10624 nil means use CBREAK mode.
10625 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10626 (no effect except in CBREAK mode).
10627 Third arg META t means accept 8-bit input (for a Meta key).
10628 META nil means ignore the top bit, on the assumption it is parity.
10629 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10630 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10631 See also `current-input-mode'. */)
10632 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10634 Fset_input_interrupt_mode (interrupt
);
10635 Fset_output_flow_control (flow
, Qnil
);
10636 Fset_input_meta_mode (meta
, Qnil
);
10638 Fset_quit_char (quit
);
10642 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10643 doc
: /* Return information about the way Emacs currently reads keyboard input.
10644 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10645 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10646 nil, Emacs is using CBREAK mode.
10647 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10648 terminal; this does not apply if Emacs uses interrupt-driven input.
10649 META is t if accepting 8-bit input with 8th bit as Meta flag.
10650 META nil means ignoring the top bit, on the assumption it is parity.
10651 META is neither t nor nil if accepting 8-bit input and using
10652 all 8 bits as the character code.
10653 QUIT is the character Emacs currently uses to quit.
10654 The elements of this list correspond to the arguments of
10655 `set-input-mode'. */)
10658 struct frame
*sf
= XFRAME (selected_frame
);
10660 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10661 Lisp_Object flow
, meta
;
10662 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10664 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10665 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10667 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10674 Lisp_Object quit
= make_number (quit_char
);
10676 return list4 (interrupt
, flow
, meta
, quit
);
10679 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10680 doc
: /* Return position information for pixel coordinates X and Y.
10681 By default, X and Y are relative to text area of the selected window.
10682 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10683 If optional fourth arg WHOLE is non-nil, X is relative to the left
10684 edge of the window.
10686 The return value is similar to a mouse click position:
10687 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10688 IMAGE (DX . DY) (WIDTH . HEIGHT))
10689 The `posn-' functions access elements of such lists. */)
10690 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10693 /* We allow X of -1, for the newline in a R2L line that overflowed
10694 into the left fringe. */
10695 if (XINT (x
) != -1)
10699 if (NILP (frame_or_window
))
10700 frame_or_window
= selected_window
;
10702 if (WINDOWP (frame_or_window
))
10704 struct window
*w
= decode_live_window (frame_or_window
);
10706 XSETINT (x
, (XINT (x
)
10707 + WINDOW_LEFT_EDGE_X (w
)
10709 ? window_box_left_offset (w
, TEXT_AREA
)
10711 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10712 frame_or_window
= w
->frame
;
10715 CHECK_LIVE_FRAME (frame_or_window
);
10717 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10720 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10721 doc
: /* Return position information for buffer POS in WINDOW.
10722 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10724 Return nil if position is not visible in window. Otherwise,
10725 the return value is similar to that returned by `event-start' for
10726 a mouse click at the upper left corner of the glyph corresponding
10727 to the given buffer position:
10728 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10729 IMAGE (DX . DY) (WIDTH . HEIGHT))
10730 The `posn-' functions access elements of such lists. */)
10731 (Lisp_Object pos
, Lisp_Object window
)
10736 window
= selected_window
;
10738 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10741 Lisp_Object x
= XCAR (tem
);
10742 Lisp_Object y
= XCAR (XCDR (tem
));
10744 /* Point invisible due to hscrolling? X can be -1 when a
10745 newline in a R2L line overflows into the left fringe. */
10748 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10754 /* Set up a new kboard object with reasonable initial values.
10755 TYPE is a window system for which this keyboard is used. */
10758 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10760 kset_overriding_terminal_local_map (kb
, Qnil
);
10761 kset_last_command (kb
, Qnil
);
10762 kset_real_last_command (kb
, Qnil
);
10763 kset_keyboard_translate_table (kb
, Qnil
);
10764 kset_last_repeatable_command (kb
, Qnil
);
10765 kset_prefix_arg (kb
, Qnil
);
10766 kset_last_prefix_arg (kb
, Qnil
);
10767 kset_kbd_queue (kb
, Qnil
);
10768 kb
->kbd_queue_has_data
= false;
10769 kb
->immediate_echo
= false;
10770 kset_echo_string (kb
, Qnil
);
10771 kset_echo_prompt (kb
, Qnil
);
10772 kb
->kbd_macro_buffer
= 0;
10773 kb
->kbd_macro_bufsize
= 0;
10774 kset_defining_kbd_macro (kb
, Qnil
);
10775 kset_last_kbd_macro (kb
, Qnil
);
10776 kb
->reference_count
= 0;
10777 kset_system_key_alist (kb
, Qnil
);
10778 kset_system_key_syms (kb
, Qnil
);
10779 kset_window_system (kb
, type
);
10780 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10781 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10782 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10783 kset_default_minibuffer_frame (kb
, Qnil
);
10786 /* Allocate and basically initialize keyboard
10787 object to use with window system TYPE. */
10790 allocate_kboard (Lisp_Object type
)
10792 KBOARD
*kb
= xmalloc (sizeof *kb
);
10794 init_kboard (kb
, type
);
10795 kb
->next_kboard
= all_kboards
;
10801 * Destroy the contents of a kboard object, but not the object itself.
10802 * We use this just before deleting it, or if we're going to initialize
10803 * it a second time.
10806 wipe_kboard (KBOARD
*kb
)
10808 xfree (kb
->kbd_macro_buffer
);
10811 /* Free KB and memory referenced from it. */
10814 delete_kboard (KBOARD
*kb
)
10818 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10821 *kbp
= kb
->next_kboard
;
10823 /* Prevent a dangling reference to KB. */
10824 if (kb
== current_kboard
10825 && FRAMEP (selected_frame
)
10826 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10828 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10829 single_kboard
= false;
10830 if (current_kboard
== kb
)
10839 init_keyboard (void)
10841 /* This is correct before outermost invocation of the editor loop. */
10842 command_loop_level
= -1;
10843 immediate_quit
= false;
10844 quit_char
= Ctl ('g');
10845 Vunread_command_events
= Qnil
;
10846 timer_idleness_start_time
= invalid_timespec ();
10848 recent_keys_index
= 0;
10849 kbd_fetch_ptr
= kbd_buffer
;
10850 kbd_store_ptr
= kbd_buffer
;
10851 do_mouse_tracking
= Qnil
;
10852 input_pending
= false;
10853 interrupt_input_blocked
= 0;
10854 pending_signals
= false;
10856 /* This means that command_loop_1 won't try to select anything the first
10858 internal_last_event_frame
= Qnil
;
10859 Vlast_event_frame
= internal_last_event_frame
;
10861 current_kboard
= initial_kboard
;
10862 /* Re-initialize the keyboard again. */
10863 wipe_kboard (current_kboard
);
10864 /* A value of nil for Vwindow_system normally means a tty, but we also use
10865 it for the initial terminal since there is no window system there. */
10866 init_kboard (current_kboard
, Qnil
);
10868 if (!noninteractive
)
10870 /* Before multi-tty support, these handlers used to be installed
10871 only if the current session was a tty session. Now an Emacs
10872 session may have multiple display types, so we always handle
10873 SIGINT. There is special code in handle_interrupt_signal to exit
10874 Emacs on SIGINT when there are no termcap frames on the
10875 controlling terminal. */
10876 struct sigaction action
;
10877 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10878 sigaction (SIGINT
, &action
, 0);
10880 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10881 SIGQUIT and we can't tell which one it will give us. */
10882 sigaction (SIGQUIT
, &action
, 0);
10883 #endif /* not DOS_NT */
10885 #ifdef USABLE_SIGIO
10886 if (!noninteractive
)
10888 struct sigaction action
;
10889 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10890 sigaction (SIGIO
, &action
, 0);
10894 /* Use interrupt input by default, if it works and noninterrupt input
10895 has deficiencies. */
10897 #ifdef INTERRUPT_INPUT
10898 interrupt_input
= 1;
10900 interrupt_input
= 0;
10903 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10906 if (keyboard_init_hook
)
10907 (*keyboard_init_hook
) ();
10909 #ifdef POLL_FOR_INPUT
10911 poll_suppress_count
= 1;
10916 /* This type's only use is in syms_of_keyboard, to put properties on the
10917 event header symbols. */
10924 static const struct event_head head_table
[] = {
10925 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10926 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10928 /* Some of the event heads. */
10929 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
10931 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
10932 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
10933 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
10934 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
10935 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
10936 /* `select-window' should be handled just like `switch-frame'
10937 in read_key_sequence. */
10938 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
10942 syms_of_keyboard (void)
10944 pending_funcalls
= Qnil
;
10945 staticpro (&pending_funcalls
);
10947 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10948 staticpro (&Vlispy_mouse_stem
);
10950 regular_top_level_message
= build_pure_c_string ("Back to top level");
10951 #ifdef HAVE_STACK_OVERFLOW_HANDLING
10952 recover_top_level_message
10953 = build_pure_c_string ("Re-entering top level after C stack overflow");
10955 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
10956 doc
: /* Message displayed by `normal-top-level'. */);
10957 Vinternal__top_level_message
= regular_top_level_message
;
10960 DEFSYM (QCimage
, ":image");
10961 DEFSYM (Qhelp_echo
, "help-echo");
10962 DEFSYM (QCrtl
, ":rtl");
10964 staticpro (&item_properties
);
10965 item_properties
= Qnil
;
10967 staticpro (&tool_bar_item_properties
);
10968 tool_bar_item_properties
= Qnil
;
10969 staticpro (&tool_bar_items_vector
);
10970 tool_bar_items_vector
= Qnil
;
10972 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10974 /* Non-nil disable property on a command means do not execute it;
10975 call disabled-command-function's value instead. */
10976 DEFSYM (Qdisabled
, "disabled");
10978 DEFSYM (Qundefined
, "undefined");
10980 /* Hooks to run before and after each command. */
10981 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10982 DEFSYM (Qpost_command_hook
, "post-command-hook");
10984 DEFSYM (Qundo_auto__add_boundary
, "undo-auto--add-boundary");
10986 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10987 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10988 DEFSYM (Qfunction_key
, "function-key");
10990 /* The values of Qevent_kind properties. */
10991 DEFSYM (Qmouse_click
, "mouse-click");
10993 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10994 DEFSYM (Qsave_session
, "save-session");
10995 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10997 /* Menu and tool bar item parts. */
10998 DEFSYM (Qmenu_enable
, "menu-enable");
11001 DEFSYM (Qlanguage_change
, "language-change");
11002 DEFSYM (Qend_session
, "end-session");
11006 DEFSYM (Qdbus_event
, "dbus-event");
11009 #ifdef HAVE_XWIDGETS
11010 DEFSYM (Qxwidget_event
, "xwidget-event");
11013 #ifdef USE_FILE_NOTIFY
11014 DEFSYM (Qfile_notify
, "file-notify");
11015 #endif /* USE_FILE_NOTIFY */
11017 /* Menu and tool bar item parts. */
11018 DEFSYM (QCenable
, ":enable");
11019 DEFSYM (QCvisible
, ":visible");
11020 DEFSYM (QChelp
, ":help");
11021 DEFSYM (QCfilter
, ":filter");
11022 DEFSYM (QCbutton
, ":button");
11023 DEFSYM (QCkeys
, ":keys");
11024 DEFSYM (QCkey_sequence
, ":key-sequence");
11026 /* Non-nil disable property on a command means
11027 do not execute it; call disabled-command-function's value instead. */
11028 DEFSYM (QCtoggle
, ":toggle");
11029 DEFSYM (QCradio
, ":radio");
11030 DEFSYM (QClabel
, ":label");
11031 DEFSYM (QCvert_only
, ":vert-only");
11033 /* Symbols to use for parts of windows. */
11034 DEFSYM (Qvertical_line
, "vertical-line");
11035 DEFSYM (Qright_divider
, "right-divider");
11036 DEFSYM (Qbottom_divider
, "bottom-divider");
11038 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11040 DEFSYM (Qabove_handle
, "above-handle");
11041 DEFSYM (Qhandle
, "handle");
11042 DEFSYM (Qbelow_handle
, "below-handle");
11043 DEFSYM (Qup
, "up");
11044 DEFSYM (Qdown
, "down");
11045 DEFSYM (Qtop
, "top");
11046 DEFSYM (Qbottom
, "bottom");
11047 DEFSYM (Qend_scroll
, "end-scroll");
11048 DEFSYM (Qratio
, "ratio");
11049 DEFSYM (Qbefore_handle
, "before-handle");
11050 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11051 DEFSYM (Qafter_handle
, "after-handle");
11052 DEFSYM (Qleft
, "left");
11053 DEFSYM (Qright
, "right");
11054 DEFSYM (Qleftmost
, "leftmost");
11055 DEFSYM (Qrightmost
, "rightmost");
11057 /* Properties of event headers. */
11058 DEFSYM (Qevent_kind
, "event-kind");
11059 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11061 /* An event header symbol HEAD may have a property named
11062 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11063 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11064 mask of modifiers applied to it. If present, this is used to help
11065 speed up parse_modifiers. */
11066 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11068 /* An unmodified event header BASE may have a property named
11069 Qmodifier_cache, which is an alist mapping modifier masks onto
11070 modified versions of BASE. If present, this helps speed up
11071 apply_modifiers. */
11072 DEFSYM (Qmodifier_cache
, "modifier-cache");
11074 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11075 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11077 DEFSYM (Qpolling_period
, "polling-period");
11079 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11081 /* The primary selection. */
11082 DEFSYM (QPRIMARY
, "PRIMARY");
11084 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11085 DEFSYM (Qhandle_select_window
, "handle-select-window");
11087 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11088 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11090 DEFSYM (Qhelp_form_show
, "help-form-show");
11092 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11094 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11095 Fset (Qinput_method_use_echo_area
, Qnil
);
11097 /* Symbols to head events. */
11098 DEFSYM (Qmouse_movement
, "mouse-movement");
11099 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11100 DEFSYM (Qswitch_frame
, "switch-frame");
11101 DEFSYM (Qfocus_in
, "focus-in");
11102 DEFSYM (Qfocus_out
, "focus-out");
11103 DEFSYM (Qdelete_frame
, "delete-frame");
11104 DEFSYM (Qiconify_frame
, "iconify-frame");
11105 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11106 DEFSYM (Qselect_window
, "select-window");
11110 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11112 const struct event_head
*p
= &head_table
[i
];
11113 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11114 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11115 Fput (var
, Qevent_kind
, kind
);
11116 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11120 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11121 staticpro (&button_down_location
);
11122 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11123 staticpro (&mouse_syms
);
11124 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11126 staticpro (&wheel_syms
);
11130 int len
= ARRAYELTS (modifier_names
);
11132 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11133 for (i
= 0; i
< len
; i
++)
11134 if (modifier_names
[i
])
11135 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11136 staticpro (&modifier_symbols
);
11139 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11140 staticpro (&recent_keys
);
11142 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11143 staticpro (&this_command_keys
);
11145 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11146 staticpro (&raw_keybuf
);
11148 DEFSYM (Qcommand_execute
, "command-execute");
11149 DEFSYM (Qinternal_echo_keystrokes_prefix
, "internal-echo-keystrokes-prefix");
11151 accent_key_syms
= Qnil
;
11152 staticpro (&accent_key_syms
);
11154 func_key_syms
= Qnil
;
11155 staticpro (&func_key_syms
);
11157 drag_n_drop_syms
= Qnil
;
11158 staticpro (&drag_n_drop_syms
);
11160 unread_switch_frame
= Qnil
;
11161 staticpro (&unread_switch_frame
);
11163 internal_last_event_frame
= Qnil
;
11164 staticpro (&internal_last_event_frame
);
11166 read_key_sequence_cmd
= Qnil
;
11167 staticpro (&read_key_sequence_cmd
);
11168 read_key_sequence_remapped
= Qnil
;
11169 staticpro (&read_key_sequence_remapped
);
11171 menu_bar_one_keymap_changed_items
= Qnil
;
11172 staticpro (&menu_bar_one_keymap_changed_items
);
11174 menu_bar_items_vector
= Qnil
;
11175 staticpro (&menu_bar_items_vector
);
11177 help_form_saved_window_configs
= Qnil
;
11178 staticpro (&help_form_saved_window_configs
);
11180 defsubr (&Scurrent_idle_time
);
11181 defsubr (&Sevent_symbol_parse_modifiers
);
11182 defsubr (&Sevent_convert_list
);
11183 defsubr (&Sread_key_sequence
);
11184 defsubr (&Sread_key_sequence_vector
);
11185 defsubr (&Srecursive_edit
);
11186 defsubr (&Strack_mouse
);
11187 defsubr (&Sinput_pending_p
);
11188 defsubr (&Srecent_keys
);
11189 defsubr (&Sthis_command_keys
);
11190 defsubr (&Sthis_command_keys_vector
);
11191 defsubr (&Sthis_single_command_keys
);
11192 defsubr (&Sthis_single_command_raw_keys
);
11193 defsubr (&Sclear_this_command_keys
);
11194 defsubr (&Ssuspend_emacs
);
11195 defsubr (&Sabort_recursive_edit
);
11196 defsubr (&Sexit_recursive_edit
);
11197 defsubr (&Srecursion_depth
);
11198 defsubr (&Scommand_error_default_function
);
11199 defsubr (&Stop_level
);
11200 defsubr (&Sdiscard_input
);
11201 defsubr (&Sopen_dribble_file
);
11202 defsubr (&Sset_input_interrupt_mode
);
11203 defsubr (&Sset_output_flow_control
);
11204 defsubr (&Sset_input_meta_mode
);
11205 defsubr (&Sset_quit_char
);
11206 defsubr (&Sset_input_mode
);
11207 defsubr (&Scurrent_input_mode
);
11208 defsubr (&Sposn_at_point
);
11209 defsubr (&Sposn_at_x_y
);
11211 DEFVAR_LISP ("last-command-event", last_command_event
,
11212 doc
: /* Last input event that was part of a command. */);
11214 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11215 doc
: /* Last input event in a command, except for mouse menu events.
11216 Mouse menus give back keys that don't look like mouse events;
11217 this variable holds the actual mouse event that led to the menu,
11218 so that you can determine whether the command was run by mouse or not. */);
11220 DEFVAR_LISP ("last-input-event", last_input_event
,
11221 doc
: /* Last input event. */);
11223 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11224 doc
: /* List of events to be read as the command input.
11225 These events are processed first, before actual keyboard input.
11226 Events read from this list are not normally added to `this-command-keys',
11227 as they will already have been added once as they were read for the first time.
11228 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11229 Vunread_command_events
= Qnil
;
11231 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11232 doc
: /* List of events to be processed as input by input methods.
11233 These events are processed before `unread-command-events'
11234 and actual keyboard input, but are not given to `input-method-function'. */);
11235 Vunread_post_input_method_events
= Qnil
;
11237 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11238 doc
: /* List of events to be processed as input by input methods.
11239 These events are processed after `unread-command-events', but
11240 before actual keyboard input.
11241 If there's an active input method, the events are given to
11242 `input-method-function'. */);
11243 Vunread_input_method_events
= Qnil
;
11245 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11246 doc
: /* Meta-prefix character code.
11247 Meta-foo as command input turns into this character followed by foo. */);
11248 XSETINT (meta_prefix_char
, 033);
11250 DEFVAR_KBOARD ("last-command", Vlast_command
,
11251 doc
: /* The last command executed.
11252 Normally a symbol with a function definition, but can be whatever was found
11253 in the keymap, or whatever the variable `this-command' was set to by that
11256 The value `mode-exit' is special; it means that the previous command
11257 read an event that told it to exit, and it did so and unread that event.
11258 In other words, the present command is the event that made the previous
11261 The value `kill-region' is special; it means that the previous command
11262 was a kill command.
11264 `last-command' has a separate binding for each terminal device.
11265 See Info node `(elisp)Multiple Terminals'. */);
11267 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11268 doc
: /* Same as `last-command', but never altered by Lisp code.
11269 Taken from the previous value of `real-this-command'. */);
11271 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11272 doc
: /* Last command that may be repeated.
11273 The last command executed that was not bound to an input event.
11274 This is the command `repeat' will try to repeat.
11275 Taken from a previous value of `real-this-command'. */);
11277 DEFVAR_LISP ("this-command", Vthis_command
,
11278 doc
: /* The command now being executed.
11279 The command can set this variable; whatever is put here
11280 will be in `last-command' during the following command. */);
11281 Vthis_command
= Qnil
;
11283 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11284 doc
: /* This is like `this-command', except that commands should never modify it. */);
11285 Vreal_this_command
= Qnil
;
11287 DEFVAR_LISP ("this-command-keys-shift-translated",
11288 Vthis_command_keys_shift_translated
,
11289 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11290 Shift-translation occurs when there is no binding for the key sequence
11291 as entered, but a binding was found by changing an upper-case letter
11292 to lower-case, or a shifted function key to an unshifted one. */);
11293 Vthis_command_keys_shift_translated
= Qnil
;
11295 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11296 doc
: /* The command bound to the current key sequence before remapping.
11297 It equals `this-command' if the original command was not remapped through
11298 any of the active keymaps. Otherwise, the value of `this-command' is the
11299 result of looking up the original command in the active keymaps. */);
11300 Vthis_original_command
= Qnil
;
11302 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11303 doc
: /* Number of input events between auto-saves.
11304 Zero means disable autosaving due to number of characters typed. */);
11305 auto_save_interval
= 300;
11307 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11308 doc
: /* Number of seconds idle time before auto-save.
11309 Zero or nil means disable auto-saving due to idleness.
11310 After auto-saving due to this many seconds of idle time,
11311 Emacs also does a garbage collection if that seems to be warranted. */);
11312 XSETFASTINT (Vauto_save_timeout
, 30);
11314 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11315 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11316 The value may be integer or floating point.
11317 If the value is zero, don't echo at all. */);
11318 Vecho_keystrokes
= make_number (1);
11320 DEFVAR_INT ("polling-period", polling_period
,
11321 doc
: /* Interval between polling for input during Lisp execution.
11322 The reason for polling is to make C-g work to stop a running program.
11323 Polling is needed only when using X windows and SIGIO does not work.
11324 Polling is automatically disabled in all other cases. */);
11325 polling_period
= 2;
11327 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11328 doc
: /* Maximum time between mouse clicks to make a double-click.
11329 Measured in milliseconds. The value nil means disable double-click
11330 recognition; t means double-clicks have no time limit and are detected
11331 by position only. */);
11332 Vdouble_click_time
= make_number (500);
11334 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11335 doc
: /* Maximum mouse movement between clicks to make a double-click.
11336 On window-system frames, value is the number of pixels the mouse may have
11337 moved horizontally or vertically between two clicks to make a double-click.
11338 On non window-system frames, value is interpreted in units of 1/8 characters
11341 This variable is also the threshold for motion of the mouse
11342 to count as a drag. */);
11343 double_click_fuzz
= 3;
11345 DEFVAR_INT ("num-input-keys", num_input_keys
,
11346 doc
: /* Number of complete key sequences read as input so far.
11347 This includes key sequences read from keyboard macros.
11348 The number is effectively the number of interactive command invocations. */);
11349 num_input_keys
= 0;
11351 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11352 doc
: /* Number of input events read from the keyboard so far.
11353 This does not include events generated by keyboard macros. */);
11354 num_nonmacro_input_events
= 0;
11356 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11357 doc
: /* The frame in which the most recently read event occurred.
11358 If the last event came from a keyboard macro, this is set to `macro'. */);
11359 Vlast_event_frame
= Qnil
;
11361 /* This variable is set up in sysdep.c. */
11362 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11363 doc
: /* The ERASE character as set by the user with stty. */);
11365 DEFVAR_LISP ("help-char", Vhelp_char
,
11366 doc
: /* Character to recognize as meaning Help.
11367 When it is read, do `(eval help-form)', and display result if it's a string.
11368 If the value of `help-form' is nil, this char can be read normally. */);
11369 XSETINT (Vhelp_char
, Ctl ('H'));
11371 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11372 doc
: /* List of input events to recognize as meaning Help.
11373 These work just like the value of `help-char' (see that). */);
11374 Vhelp_event_list
= Qnil
;
11376 DEFVAR_LISP ("help-form", Vhelp_form
,
11377 doc
: /* Form to execute when character `help-char' is read.
11378 If the form returns a string, that string is displayed.
11379 If `help-form' is nil, the help char is not recognized. */);
11382 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11383 doc
: /* Command to run when `help-char' character follows a prefix key.
11384 This command is used only when there is no actual binding
11385 for that character after that prefix key. */);
11386 Vprefix_help_command
= Qnil
;
11388 DEFVAR_LISP ("top-level", Vtop_level
,
11389 doc
: /* Form to evaluate when Emacs starts up.
11390 Useful to set before you dump a modified Emacs. */);
11392 XSYMBOL (Qtop_level
)->declared_special
= false;
11394 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11395 doc
: /* Translate table for local keyboard input, or nil.
11396 If non-nil, the value should be a char-table. Each character read
11397 from the keyboard is looked up in this char-table. If the value found
11398 there is non-nil, then it is used instead of the actual input character.
11400 The value can also be a string or vector, but this is considered obsolete.
11401 If it is a string or vector of length N, character codes N and up are left
11402 untranslated. In a vector, an element which is nil means "no translation".
11404 This is applied to the characters supplied to input methods, not their
11405 output. See also `translation-table-for-input'.
11407 This variable has a separate binding for each terminal.
11408 See Info node `(elisp)Multiple Terminals'. */);
11410 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11411 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11412 \(Even if the operating system has support for stopping a process.) */);
11413 cannot_suspend
= false;
11415 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11416 doc
: /* Non-nil means prompt with menus when appropriate.
11417 This is done when reading from a keymap that has a prompt string,
11418 for elements that have prompt strings.
11419 The menu is displayed on the screen
11420 if X menus were enabled at configuration
11421 time and the previous event was a mouse click prefix key.
11422 Otherwise, menu prompting uses the echo area. */);
11423 menu_prompting
= true;
11425 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11426 doc
: /* Character to see next line of menu prompt.
11427 Type this character while in a menu prompt to rotate around the lines of it. */);
11428 XSETINT (menu_prompt_more_char
, ' ');
11430 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11431 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11432 Emacs applies the modifiers of the character stored here to each keyboard
11433 character it reads. For example, after evaluating the expression
11434 (setq extra-keyboard-modifiers ?\\C-x)
11435 all input characters will have the control modifier applied to them.
11437 Note that the character ?\\C-@, equivalent to the integer zero, does
11438 not count as a control character; rather, it counts as a character
11439 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11440 cancels any modification. */);
11441 extra_keyboard_modifiers
= 0;
11443 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11444 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11445 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11446 The command loop sets this to nil before each command,
11447 and tests the value when the command returns.
11448 Buffer modification stores t in this variable. */);
11449 Vdeactivate_mark
= Qnil
;
11450 Fmake_variable_buffer_local (Qdeactivate_mark
);
11452 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11453 doc
: /* Normal hook run before each command is executed.
11454 If an unhandled error happens in running this hook,
11455 the function in which the error occurred is unconditionally removed, since
11456 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11458 See also `post-command-hook'. */);
11459 Vpre_command_hook
= Qnil
;
11461 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11462 doc
: /* Normal hook run after each command is executed.
11463 If an unhandled error happens in running this hook,
11464 the function in which the error occurred is unconditionally removed, since
11465 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11467 It is a bad idea to use this hook for expensive processing. If
11468 unavoidable, wrap your code in `(while-no-input (redisplay) CODE)' to
11469 avoid making Emacs unresponsive while the user types.
11471 See also `pre-command-hook'. */);
11472 Vpost_command_hook
= Qnil
;
11475 DEFVAR_LISP ("echo-area-clear-hook", ...,
11476 doc
: /* Normal hook run when clearing the echo area. */);
11478 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11479 Fset (Qecho_area_clear_hook
, Qnil
);
11481 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11482 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11483 Vlucid_menu_bar_dirty_flag
= Qnil
;
11485 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11486 doc
: /* List of menu bar items to move to the end of the menu bar.
11487 The elements of the list are event types that may have menu bar bindings. */);
11488 Vmenu_bar_final_items
= Qnil
;
11490 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11491 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11492 This is used internally by graphical displays that do not render
11493 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11494 Vtool_bar_separator_image_expression
= Qnil
;
11496 DEFVAR_KBOARD ("overriding-terminal-local-map",
11497 Voverriding_terminal_local_map
,
11498 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11499 This variable is intended to let commands such as `universal-argument'
11500 set up a different keymap for reading the next command.
11502 `overriding-terminal-local-map' has a separate binding for each
11503 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11505 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11506 doc
: /* Keymap that replaces (overrides) local keymaps.
11507 If this variable is non-nil, Emacs looks up key bindings in this
11508 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11509 buffer's local map. Hence, the only active keymaps would be
11510 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11511 order of precedence. */);
11512 Voverriding_local_map
= Qnil
;
11514 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11515 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11516 Otherwise, the menu bar continues to reflect the buffer's local map
11517 and the minor mode maps regardless of `overriding-local-map'. */);
11518 Voverriding_local_map_menu_flag
= Qnil
;
11520 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11521 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11522 Vspecial_event_map
= list1 (Qkeymap
);
11524 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11525 doc
: /* Non-nil means generate motion events for mouse motion. */);
11527 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11528 doc
: /* Alist of system-specific X windows key symbols.
11529 Each element should have the form (N . SYMBOL) where N is the
11530 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11531 and SYMBOL is its name.
11533 `system-key-alist' has a separate binding for each terminal device.
11534 See Info node `(elisp)Multiple Terminals'. */);
11536 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11537 doc
: /* Keymap that translates key sequences to key sequences during input.
11538 This is used mainly for mapping key sequences into some preferred
11539 key events (symbols).
11541 The `read-key-sequence' function replaces any subsequence bound by
11542 `local-function-key-map' with its binding. More precisely, when the
11543 active keymaps have no binding for the current key sequence but
11544 `local-function-key-map' binds a suffix of the sequence to a vector or
11545 string, `read-key-sequence' replaces the matching suffix with its
11546 binding, and continues with the new sequence.
11548 If the binding is a function, it is called with one argument (the prompt)
11549 and its return value (a key sequence) is used.
11551 The events that come from bindings in `local-function-key-map' are not
11552 themselves looked up in `local-function-key-map'.
11554 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11555 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11556 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11557 typing `ESC O P x' would return [f1 x].
11559 `local-function-key-map' has a separate binding for each terminal
11560 device. See Info node `(elisp)Multiple Terminals'. If you need to
11561 define a binding on all terminals, change `function-key-map'
11562 instead. Initially, `local-function-key-map' is an empty keymap that
11563 has `function-key-map' as its parent on all terminal devices. */);
11565 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11566 doc
: /* Keymap that decodes input escape sequences.
11567 This is used mainly for mapping ASCII function key sequences into
11568 real Emacs function key events (symbols).
11570 The `read-key-sequence' function replaces any subsequence bound by
11571 `input-decode-map' with its binding. Contrary to `function-key-map',
11572 this map applies its rebinding regardless of the presence of an ordinary
11573 binding. So it is more like `key-translation-map' except that it applies
11574 before `function-key-map' rather than after.
11576 If the binding is a function, it is called with one argument (the prompt)
11577 and its return value (a key sequence) is used.
11579 The events that come from bindings in `input-decode-map' are not
11580 themselves looked up in `input-decode-map'. */);
11582 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11583 doc
: /* The parent keymap of all `local-function-key-map' instances.
11584 Function key definitions that apply to all terminal devices should go
11585 here. If a mapping is defined in both the current
11586 `local-function-key-map' binding and this variable, then the local
11587 definition will take precedence. */);
11588 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11590 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11591 doc
: /* Keymap of key translations that can override keymaps.
11592 This keymap works like `input-decode-map', but comes after `function-key-map'.
11593 Another difference is that it is global rather than terminal-local. */);
11594 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11596 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11597 doc
: /* List of deferred actions to be performed at a later time.
11598 The precise format isn't relevant here; we just check whether it is nil. */);
11599 Vdeferred_action_list
= Qnil
;
11601 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11602 doc
: /* Function to call to handle deferred actions, after each command.
11603 This function is called with no arguments after each command
11604 whenever `deferred-action-list' is non-nil. */);
11605 Vdeferred_action_function
= Qnil
;
11607 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11608 doc
: /* List of warnings to be displayed after this command.
11609 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11610 as per the args of `display-warning' (which see).
11611 If this variable is non-nil, `delayed-warnings-hook' will be run
11612 immediately after running `post-command-hook'. */);
11613 Vdelayed_warnings_list
= Qnil
;
11615 DEFVAR_LISP ("timer-list", Vtimer_list
,
11616 doc
: /* List of active absolute time timers in order of increasing time. */);
11617 Vtimer_list
= Qnil
;
11619 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11620 doc
: /* List of active idle-time timers in order of increasing time. */);
11621 Vtimer_idle_list
= Qnil
;
11623 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11624 doc
: /* If non-nil, the function that implements the current input method.
11625 It's called with one argument, a printing character that was just read.
11626 \(That means a character with code 040...0176.)
11627 Typically this function uses `read-event' to read additional events.
11628 When it does so, it should first bind `input-method-function' to nil
11629 so it will not be called recursively.
11631 The function should return a list of zero or more events
11632 to be used as input. If it wants to put back some events
11633 to be reconsidered, separately, by the input method,
11634 it can add them to the beginning of `unread-command-events'.
11636 The input method function can find in `input-method-previous-message'
11637 the previous echo area message.
11639 The input method function should refer to the variables
11640 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11641 for guidance on what to do. */);
11642 Vinput_method_function
= Qlist
;
11644 DEFVAR_LISP ("input-method-previous-message",
11645 Vinput_method_previous_message
,
11646 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11647 This variable exists because `read-event' clears the echo area
11648 before running the input method. It is nil if there was no message. */);
11649 Vinput_method_previous_message
= Qnil
;
11651 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11652 doc
: /* If non-nil, the function that implements the display of help.
11653 It's called with one argument, the help string to display. */);
11654 Vshow_help_function
= Qnil
;
11656 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11657 doc
: /* If non-nil, suppress point adjustment after executing a command.
11659 After a command is executed, if point moved into a region that has
11660 special properties (e.g. composition, display), Emacs adjusts point to
11661 the boundary of the region. But when a command leaves this variable at
11662 a non-nil value (e.g., with a setq), this point adjustment is suppressed.
11664 This variable is set to nil before reading a command, and is checked
11665 just after executing the command. */);
11666 Vdisable_point_adjustment
= Qnil
;
11668 DEFVAR_LISP ("global-disable-point-adjustment",
11669 Vglobal_disable_point_adjustment
,
11670 doc
: /* If non-nil, always suppress point adjustments.
11672 The default value is nil, in which case point adjustments are
11673 suppressed only after special commands that leave
11674 `disable-point-adjustment' (which see) at a non-nil value. */);
11675 Vglobal_disable_point_adjustment
= Qnil
;
11677 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11678 doc
: /* How long to display an echo-area message when the minibuffer is active.
11679 If the value is not a number, such messages don't time out. */);
11680 Vminibuffer_message_timeout
= make_number (2);
11682 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11683 doc
: /* If non-nil, any keyboard input throws to this symbol.
11684 The value of that variable is passed to `quit-flag' and later causes a
11685 peculiar kind of quitting. */);
11686 Vthrow_on_input
= Qnil
;
11688 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11689 doc
: /* Function to output error messages.
11690 Called with three arguments:
11691 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11692 such as what `condition-case' would bind its variable to,
11693 - the context (a string which normally goes at the start of the message),
11694 - the Lisp function within which the error was signaled. */);
11695 Vcommand_error_function
= intern ("command-error-default-function");
11697 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11698 Venable_disabled_menus_and_buttons
,
11699 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11701 Help functions bind this to allow help on disabled menu items
11702 and tool-bar buttons. */);
11703 Venable_disabled_menus_and_buttons
= Qnil
;
11705 DEFVAR_LISP ("select-active-regions",
11706 Vselect_active_regions
,
11707 doc
: /* If non-nil, an active region automatically sets the primary selection.
11708 If the value is `only', only temporarily active regions (usually made
11709 by mouse-dragging or shift-selection) set the window selection.
11711 This takes effect only when Transient Mark mode is enabled. */);
11712 Vselect_active_regions
= Qt
;
11714 DEFVAR_LISP ("saved-region-selection",
11715 Vsaved_region_selection
,
11716 doc
: /* Contents of active region prior to buffer modification.
11717 If `select-active-regions' is non-nil, Emacs sets this to the
11718 text in the region before modifying the buffer. The next call to
11719 the function `deactivate-mark' uses this to set the window selection. */);
11720 Vsaved_region_selection
= Qnil
;
11722 DEFVAR_LISP ("selection-inhibit-update-commands",
11723 Vselection_inhibit_update_commands
,
11724 doc
: /* List of commands which should not update the selection.
11725 Normally, if `select-active-regions' is non-nil and the mark remains
11726 active after a command (i.e. the mark was not deactivated), the Emacs
11727 command loop sets the selection to the text in the region. However,
11728 if the command is in this list, the selection is not updated. */);
11729 Vselection_inhibit_update_commands
11730 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11732 DEFVAR_LISP ("debug-on-event",
11734 doc
: /* Enter debugger on this event. When Emacs
11735 receives the special event specified by this variable, it will try to
11736 break into the debugger as soon as possible instead of processing the
11737 event normally through `special-event-map'.
11739 Currently, the only supported values for this
11740 variable are `sigusr1' and `sigusr2'. */);
11741 Vdebug_on_event
= intern_c_string ("sigusr2");
11743 DEFVAR_BOOL ("attempt-stack-overflow-recovery",
11744 attempt_stack_overflow_recovery
,
11745 doc
: /* If non-nil, attempt to recover from C stack
11746 overflow. This recovery is unsafe and may lead to deadlocks or data
11747 corruption, but it usually works and may preserve modified buffers
11748 that would otherwise be lost. If nil, treat stack overflow like any
11749 other kind of crash. */);
11750 attempt_stack_overflow_recovery
= true;
11752 DEFVAR_BOOL ("attempt-orderly-shutdown-on-fatal-signal",
11753 attempt_orderly_shutdown_on_fatal_signal
,
11754 doc
: /* If non-nil, attempt to perform an orderly
11755 shutdown when Emacs receives a fatal signal (e.g., a crash).
11756 This cleanup is unsafe and may lead to deadlocks or data corruption,
11757 but it usually works and may preserve modified buffers that would
11758 otherwise be lost. If nil, crash immediately in response to fatal
11760 attempt_orderly_shutdown_on_fatal_signal
= true;
11762 /* Create the initial keyboard. Qt means 'unset'. */
11763 initial_kboard
= allocate_kboard (Qt
);
11767 keys_of_keyboard (void)
11769 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11770 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11771 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11772 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11773 initial_define_key (meta_map
, 'x', "execute-extended-command");
11775 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11776 "handle-delete-frame");
11778 initial_define_lispy_key (Vspecial_event_map
, "end-session",
11781 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11782 "ns-put-working-text");
11783 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11784 "ns-unput-working-text");
11785 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11786 current-prefix-arg, as is done in `handle-switch-frame'.
11787 But `handle-switch-frame is not run from the special-map.
11788 Commands from that map are run in a special way that automatically
11789 preserves the prefix-arg. Restoring the prefix arg here is not just
11790 redundant but harmful:
11792 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11793 - after the first prompt, the exit-minibuffer-hook is run which may
11794 iconify a frame and thus push a `iconify-frame' event.
11795 - after running exit-minibuffer-hook, current-prefix-arg is
11796 restored to the non-nil value it had before the prompt.
11797 - we enter the second prompt.
11798 current-prefix-arg is non-nil, prefix-arg is nil.
11799 - before running the first real event, we run the special iconify-frame
11800 event, but we pass the `special' arg to command-execute so
11801 current-prefix-arg and prefix-arg are left untouched.
11802 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11803 - the next key event will have a spuriously non-nil current-prefix-arg. */
11804 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11806 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11808 /* Handling it at such a low-level causes read_key_sequence to get
11809 * confused because it doesn't realize that the current_buffer was
11810 * changed by read_char.
11812 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11813 * "handle-select-window"); */
11814 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11815 "handle-save-session");
11818 /* Define a special event which is raised for dbus callback
11820 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11821 "dbus-handle-event");
11824 #ifdef USE_FILE_NOTIFY
11825 /* Define a special event which is raised for notification callback
11827 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11828 "file-notify-handle-event");
11829 #endif /* USE_FILE_NOTIFY */
11831 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11833 #if defined (WINDOWSNT)
11834 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11837 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11838 "handle-focus-in");
11839 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11840 "handle-focus-out");
11843 /* Mark the pointers in the kboard objects.
11844 Called by Fgarbage_collect. */
11846 mark_kboards (void)
11850 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11852 if (kb
->kbd_macro_buffer
)
11853 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11855 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11856 mark_object (KVAR (kb
, Vlast_command
));
11857 mark_object (KVAR (kb
, Vreal_last_command
));
11858 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11859 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11860 mark_object (KVAR (kb
, Vprefix_arg
));
11861 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11862 mark_object (KVAR (kb
, kbd_queue
));
11863 mark_object (KVAR (kb
, defining_kbd_macro
));
11864 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11865 mark_object (KVAR (kb
, Vsystem_key_alist
));
11866 mark_object (KVAR (kb
, system_key_syms
));
11867 mark_object (KVAR (kb
, Vwindow_system
));
11868 mark_object (KVAR (kb
, Vinput_decode_map
));
11869 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11870 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11871 mark_object (KVAR (kb
, echo_string
));
11872 mark_object (KVAR (kb
, echo_prompt
));
11875 union buffered_input_event
*event
;
11876 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11878 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11879 event
= kbd_buffer
;
11880 /* These two special event types has no Lisp_Objects to mark. */
11881 if (event
->kind
!= SELECTION_REQUEST_EVENT
11882 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11884 mark_object (event
->ie
.x
);
11885 mark_object (event
->ie
.y
);
11886 mark_object (event
->ie
.frame_or_window
);
11887 mark_object (event
->ie
.arg
);