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
;
2125 KBOARD
*kb
IF_LINT (= NULL
);
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 #if 4 < __GNUC__ + (6 <= __GNUC_MINOR__)
2284 # pragma GCC diagnostic push
2285 # pragma GCC diagnostic ignored "-Wclobbered"
2288 /* Read a character from the keyboard; call the redisplay if needed. */
2289 /* commandflag 0 means do not autosave, but do redisplay.
2290 -1 means do not redisplay, but do autosave.
2291 -2 means do neither.
2294 The argument MAP is a keymap for menu prompting.
2296 PREV_EVENT is the previous input event, or nil if we are reading
2297 the first event of a key sequence (or not reading a key sequence).
2298 If PREV_EVENT is t, that is a "magic" value that says
2299 not to run input methods, but in other respects to act as if
2300 not reading a key sequence.
2302 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2303 if we used a mouse menu to read the input, or false otherwise. If
2304 USED_MOUSE_MENU is null, don't dereference it.
2306 Value is -2 when we find input on another keyboard. A second call
2307 to read_char will read it.
2309 If END_TIME is non-null, it is a pointer to a struct timespec
2310 specifying the maximum time to wait until. If no input arrives by
2311 that time, stop waiting and return nil.
2313 Value is t if we showed a menu and the user rejected it. */
2316 read_char (int commandflag
, Lisp_Object map
,
2317 Lisp_Object prev_event
,
2318 bool *used_mouse_menu
, struct timespec
*end_time
)
2322 sys_jmp_buf local_getcjmp
;
2323 sys_jmp_buf save_jump
;
2324 Lisp_Object tem
, save
;
2325 volatile Lisp_Object previous_echo_area_message
;
2326 volatile Lisp_Object also_record
;
2327 volatile bool reread
, recorded
;
2328 bool volatile polling_stopped_here
= false;
2329 struct kboard
*orig_kboard
= current_kboard
;
2334 previous_echo_area_message
= Qnil
;
2340 if (CONSP (Vunread_post_input_method_events
))
2342 c
= XCAR (Vunread_post_input_method_events
);
2343 Vunread_post_input_method_events
2344 = XCDR (Vunread_post_input_method_events
);
2346 /* Undo what read_char_x_menu_prompt did when it unread
2347 additional keys returned by Fx_popup_menu. */
2349 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2360 if (CONSP (Vunread_command_events
))
2362 bool was_disabled
= false;
2364 c
= XCAR (Vunread_command_events
);
2365 Vunread_command_events
= XCDR (Vunread_command_events
);
2367 /* Undo what sit-for did when it unread additional keys
2368 inside universal-argument. */
2370 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2375 /* Undo what read_char_x_menu_prompt did when it unread
2376 additional keys returned by Fx_popup_menu. */
2378 && EQ (XCDR (c
), Qdisabled
)
2379 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2381 was_disabled
= true;
2385 /* If the queued event is something that used the mouse,
2386 set used_mouse_menu accordingly. */
2388 /* Also check was_disabled so last-nonmenu-event won't return
2389 a bad value when submenus are involved. (Bug#447) */
2390 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2391 *used_mouse_menu
= true;
2393 goto reread_for_input_method
;
2396 if (CONSP (Vunread_input_method_events
))
2398 c
= XCAR (Vunread_input_method_events
);
2399 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2401 /* Undo what read_char_x_menu_prompt did when it unread
2402 additional keys returned by Fx_popup_menu. */
2404 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2408 goto reread_for_input_method
;
2411 if (!NILP (Vexecuting_kbd_macro
))
2413 /* We set this to Qmacro; since that's not a frame, nobody will
2414 try to switch frames on us, and the selected window will
2417 Since this event came from a macro, it would be misleading to
2418 leave internal_last_event_frame set to wherever the last
2419 real event came from. Normally, a switch-frame event selects
2420 internal_last_event_frame after each command is read, but
2421 events read from a macro should never cause a new frame to be
2423 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2425 /* Exit the macro if we are at the end.
2426 Also, some things replace the macro with t
2427 to force an early exit. */
2428 if (EQ (Vexecuting_kbd_macro
, Qt
)
2429 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2435 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2436 if (STRINGP (Vexecuting_kbd_macro
)
2437 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2438 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2440 executing_kbd_macro_index
++;
2445 if (!NILP (unread_switch_frame
))
2447 c
= unread_switch_frame
;
2448 unread_switch_frame
= Qnil
;
2450 /* This event should make it into this_command_keys, and get echoed
2451 again, so we do not set `reread'. */
2455 /* If redisplay was requested. */
2456 if (commandflag
>= 0)
2458 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2460 /* If there is pending input, process any events which are not
2461 user-visible, such as X selection_request events. */
2463 || detect_input_pending_run_timers (0))
2464 swallow_events (false); /* May clear input_pending. */
2466 /* Redisplay if no pending input. */
2467 while (!(input_pending
2468 && (input_was_pending
|| !redisplay_dont_pause
)))
2470 input_was_pending
= input_pending
;
2471 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2472 redisplay_preserve_echo_area (5);
2477 /* Normal case: no input arrived during redisplay. */
2480 /* Input arrived and pre-empted redisplay.
2481 Process any events which are not user-visible. */
2482 swallow_events (false);
2483 /* If that cleared input_pending, try again to redisplay. */
2486 /* Prevent the redisplay we just did
2487 from messing up echoing of the input after the prompt. */
2488 if (commandflag
== 0 && echo_current
)
2489 echo_message_buffer
= echo_area_buffer
[0];
2493 /* Message turns off echoing unless more keystrokes turn it on again.
2495 The code in 20.x for the condition was
2497 1. echo_area_glyphs && *echo_area_glyphs
2498 2. && echo_area_glyphs != current_kboard->echobuf
2499 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2501 (1) means there's a current message displayed
2503 (2) means it's not the message from echoing from the current
2506 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2507 is set to a non-null value. This is done in read_char and it is
2508 set to echo_area_glyphs. That means
2509 ok_to_echo_at_next_pause is either null or
2510 current_kboard->echobuf with the appropriate current_kboard at
2513 So, condition (3) means in clear text ok_to_echo_at_next_pause
2514 must be either null, or the current message isn't from echoing at
2515 all, or it's from echoing from a different kboard than the
2518 if (/* There currently is something in the echo area. */
2519 !NILP (echo_area_buffer
[0])
2520 && (/* It's an echo from a different kboard. */
2521 echo_kboard
!= current_kboard
2522 /* Or we explicitly allow overwriting whatever there is. */
2523 || ok_to_echo_at_next_pause
== NULL
))
2528 /* Try reading a character via menu prompting in the minibuf.
2529 Try this before the sit-for, because the sit-for
2530 would do the wrong thing if we are supposed to do
2531 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2532 after a mouse event so don't try a minibuf menu. */
2534 if (KEYMAPP (map
) && INTERACTIVE
2535 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2536 /* Don't bring up a menu if we already have another event. */
2537 && !CONSP (Vunread_command_events
)
2538 && !detect_input_pending_run_timers (0))
2540 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2542 if (INTEGERP (c
) && XINT (c
) == -2)
2543 return c
; /* wrong_kboard_jmpbuf */
2549 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2550 We will do that below, temporarily for short sections of code,
2551 when appropriate. local_getcjmp must be in effect
2552 around any call to sit_for or kbd_buffer_get_event;
2553 it *must not* be in effect when we call redisplay. */
2555 jmpcount
= SPECPDL_INDEX ();
2556 if (sys_setjmp (local_getcjmp
))
2558 /* Handle quits while reading the keyboard. */
2559 /* We must have saved the outer value of getcjmp here,
2560 so restore it now. */
2561 restore_getcjmp (save_jump
);
2562 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2563 unbind_to (jmpcount
, Qnil
);
2564 XSETINT (c
, quit_char
);
2565 internal_last_event_frame
= selected_frame
;
2566 Vlast_event_frame
= internal_last_event_frame
;
2567 /* If we report the quit char as an event,
2568 don't do so more than once. */
2569 if (!NILP (Vinhibit_quit
))
2573 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2574 if (kb
!= current_kboard
)
2576 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2577 /* We shouldn't get here if we were in single-kboard mode! */
2582 while (CONSP (XCDR (last
)))
2584 if (!NILP (XCDR (last
)))
2588 kset_kbd_queue (kb
, list1 (c
));
2590 XSETCDR (last
, list1 (c
));
2591 kb
->kbd_queue_has_data
= true;
2592 current_kboard
= kb
;
2593 return make_number (-2); /* wrong_kboard_jmpbuf */
2599 /* Start idle timers if no time limit is supplied. We don't do it
2600 if a time limit is supplied to avoid an infinite recursion in the
2601 situation where an idle timer calls `sit-for'. */
2604 timer_start_idle ();
2606 /* If in middle of key sequence and minibuffer not active,
2607 start echoing if enough time elapses. */
2609 if (minibuf_level
== 0
2611 && !current_kboard
->immediate_echo
2612 && (this_command_key_count
> 0
2613 || !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
2615 && echo_keystrokes_p ()
2616 && (/* No message. */
2617 NILP (echo_area_buffer
[0])
2618 /* Or empty message. */
2619 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2620 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2621 /* Or already echoing from same kboard. */
2622 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2623 /* Or not echoing before and echoing allowed. */
2624 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2626 /* After a mouse event, start echoing right away.
2627 This is because we are probably about to display a menu,
2628 and we don't want to delay before doing so. */
2629 if (EVENT_HAS_PARAMETERS (prev_event
))
2635 save_getcjmp (save_jump
);
2636 restore_getcjmp (local_getcjmp
);
2637 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2638 restore_getcjmp (save_jump
);
2640 && ! CONSP (Vunread_command_events
))
2645 /* Maybe auto save due to number of keystrokes. */
2647 if (commandflag
!= 0 && commandflag
!= -2
2648 && auto_save_interval
> 0
2649 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2650 && !detect_input_pending_run_timers (0))
2652 Fdo_auto_save (Qnil
, Qnil
);
2653 /* Hooks can actually change some buffers in auto save. */
2657 /* Try reading using an X menu.
2658 This is never confused with reading using the minibuf
2659 because the recursive call of read_char in read_char_minibuf_menu_prompt
2660 does not pass on any keymaps. */
2662 if (KEYMAPP (map
) && INTERACTIVE
2663 && !NILP (prev_event
)
2664 && EVENT_HAS_PARAMETERS (prev_event
)
2665 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2666 && !EQ (XCAR (prev_event
), Qtool_bar
)
2667 /* Don't bring up a menu if we already have another event. */
2668 && !CONSP (Vunread_command_events
))
2670 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2672 /* Now that we have read an event, Emacs is not idle. */
2679 /* Maybe autosave and/or garbage collect due to idleness. */
2681 if (INTERACTIVE
&& NILP (c
))
2684 ptrdiff_t buffer_size
;
2686 /* Slow down auto saves logarithmically in size of current buffer,
2687 and garbage collect while we're at it. */
2688 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2689 last_non_minibuf_size
= Z
- BEG
;
2690 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2692 while (buffer_size
> 64)
2693 delay_level
++, buffer_size
-= buffer_size
>> 2;
2694 if (delay_level
< 4) delay_level
= 4;
2695 /* delay_level is 4 for files under around 50k, 7 at 100k,
2696 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2698 /* Auto save if enough time goes by without input. */
2699 if (commandflag
!= 0 && commandflag
!= -2
2700 && num_nonmacro_input_events
> last_auto_save
2701 && INTEGERP (Vauto_save_timeout
)
2702 && XINT (Vauto_save_timeout
) > 0)
2705 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2707 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2708 timeout
= delay_level
* timeout
/ 4;
2709 save_getcjmp (save_jump
);
2710 restore_getcjmp (local_getcjmp
);
2711 tem0
= sit_for (make_number (timeout
), 1, 1);
2712 restore_getcjmp (save_jump
);
2715 && ! CONSP (Vunread_command_events
))
2717 Fdo_auto_save (Qnil
, Qnil
);
2722 /* If there is still no input available, ask for GC. */
2723 if (!detect_input_pending_run_timers (0))
2727 /* Notify the caller if an autosave hook, or a timer, sentinel or
2728 filter in the sit_for calls above have changed the current
2729 kboard. This could happen if they use the minibuffer or start a
2730 recursive edit, like the fancy splash screen in server.el's
2731 filter. If this longjmp wasn't here, read_key_sequence would
2732 interpret the next key sequence using the wrong translation
2733 tables and function keymaps. */
2734 if (NILP (c
) && current_kboard
!= orig_kboard
)
2735 return make_number (-2); /* wrong_kboard_jmpbuf */
2737 /* If this has become non-nil here, it has been set by a timer
2738 or sentinel or filter. */
2739 if (CONSP (Vunread_command_events
))
2741 c
= XCAR (Vunread_command_events
);
2742 Vunread_command_events
= XCDR (Vunread_command_events
);
2744 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2750 /* Read something from current KBOARD's side queue, if possible. */
2754 if (current_kboard
->kbd_queue_has_data
)
2756 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2758 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2759 kset_kbd_queue (current_kboard
,
2760 XCDR (KVAR (current_kboard
, kbd_queue
)));
2761 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2762 current_kboard
->kbd_queue_has_data
= false;
2763 input_pending
= readable_events (0);
2764 if (EVENT_HAS_PARAMETERS (c
)
2765 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2766 internal_last_event_frame
= XCAR (XCDR (c
));
2767 Vlast_event_frame
= internal_last_event_frame
;
2771 /* If current_kboard's side queue is empty check the other kboards.
2772 If one of them has data that we have not yet seen here,
2773 switch to it and process the data waiting for it.
2775 Note: if the events queued up for another kboard
2776 have already been seen here, and therefore are not a complete command,
2777 the kbd_queue_has_data field is 0, so we skip that kboard here.
2778 That's to avoid an infinite loop switching between kboards here. */
2779 if (NILP (c
) && !single_kboard
)
2782 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2783 if (kb
->kbd_queue_has_data
)
2785 current_kboard
= kb
;
2786 return make_number (-2); /* wrong_kboard_jmpbuf */
2796 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2797 prev_event
, used_mouse_menu
);
2798 if (NILP (c
) && end_time
2799 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2804 if (EQ (c
, make_number (-2)))
2816 if (commandflag
>= 0
2817 && !input_pending
&& !detect_input_pending_run_timers (0))
2823 /* Buffer switch events are only for internal wakeups
2824 so don't show them to the user.
2825 Also, don't record a key if we already did. */
2829 /* Process special events within read_char
2830 and loop around to read another event. */
2833 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2838 struct buffer
*prev_buffer
= current_buffer
;
2839 last_input_event
= c
;
2840 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2843 && (EQ (XCAR (c
), Qselect_window
)
2845 || EQ (XCAR (c
), Qdbus_event
)
2847 #ifdef USE_FILE_NOTIFY
2848 || EQ (XCAR (c
), Qfile_notify
)
2850 || EQ (XCAR (c
), Qconfig_changed_event
))
2852 /* We stopped being idle for this event; undo that. This
2853 prevents automatic window selection (under
2854 mouse-autoselect-window) from acting as a real input event, for
2855 example banishing the mouse under mouse-avoidance-mode. */
2856 timer_resume_idle ();
2858 if (current_buffer
!= prev_buffer
)
2860 /* The command may have changed the keymaps. Pretend there
2861 is input in another keyboard and return. This will
2862 recalculate keymaps. */
2863 c
= make_number (-2);
2870 /* Handle things that only apply to characters. */
2873 /* If kbd_buffer_get_event gave us an EOF, return that. */
2877 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2878 && UNSIGNED_CMP (XFASTINT (c
), <,
2879 SCHARS (KVAR (current_kboard
,
2880 Vkeyboard_translate_table
))))
2881 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2882 && UNSIGNED_CMP (XFASTINT (c
), <,
2883 ASIZE (KVAR (current_kboard
,
2884 Vkeyboard_translate_table
))))
2885 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2889 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2890 /* nil in keyboard-translate-table means no translation. */
2896 /* If this event is a mouse click in the menu bar,
2897 return just menu-bar for now. Modify the mouse click event
2898 so we won't do this twice, then queue it up. */
2899 if (EVENT_HAS_PARAMETERS (c
)
2901 && CONSP (EVENT_START (c
))
2902 && CONSP (XCDR (EVENT_START (c
))))
2906 posn
= POSN_POSN (EVENT_START (c
));
2907 /* Handle menu-bar events:
2908 insert the dummy prefix event `menu-bar'. */
2909 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2911 /* Change menu-bar to (menu-bar) as the event "position". */
2912 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2915 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2920 /* Store these characters into recent_keys, the dribble file if any,
2921 and the keyboard macro being defined, if any. */
2924 if (! NILP (also_record
))
2925 record_char (also_record
);
2927 /* Wipe the echo area.
2928 But first, if we are about to use an input method,
2929 save the echo area contents for it to refer to. */
2931 && ! NILP (Vinput_method_function
)
2932 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2934 previous_echo_area_message
= Fcurrent_message ();
2935 Vinput_method_previous_message
= previous_echo_area_message
;
2938 /* Now wipe the echo area, except for help events which do their
2939 own stuff with the echo area. */
2941 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2942 && !(EQ (Qswitch_frame
, XCAR (c
)))
2943 /* Don't wipe echo area for select window events: These might
2944 get delayed via `mouse-autoselect-window' (Bug#11304). */
2945 && !(EQ (Qselect_window
, XCAR (c
)))))
2947 if (!NILP (echo_area_buffer
[0]))
2949 safe_run_hooks (Qecho_area_clear_hook
);
2950 clear_message (1, 0);
2954 reread_for_input_method
:
2956 /* Pass this to the input method, if appropriate. */
2958 && ! NILP (Vinput_method_function
)
2959 /* Don't run the input method within a key sequence,
2960 after the first event of the key sequence. */
2961 && NILP (prev_event
)
2962 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2965 ptrdiff_t key_count
;
2966 ptrdiff_t command_key_start
;
2967 ptrdiff_t count
= SPECPDL_INDEX ();
2969 /* Save the echo status. */
2970 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2971 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2972 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2973 Lisp_Object saved_echo_prompt
= KVAR (current_kboard
, echo_prompt
);
2975 /* Save the this_command_keys status. */
2976 key_count
= this_command_key_count
;
2977 command_key_start
= this_single_command_key_start
;
2980 keys
= Fcopy_sequence (this_command_keys
);
2984 /* Clear out this_command_keys. */
2985 this_command_key_count
= 0;
2986 this_single_command_key_start
= 0;
2988 /* Now wipe the echo area. */
2989 if (!NILP (echo_area_buffer
[0]))
2990 safe_run_hooks (Qecho_area_clear_hook
);
2991 clear_message (1, 0);
2994 /* If we are not reading a key sequence,
2995 never use the echo area. */
2998 specbind (Qinput_method_use_echo_area
, Qt
);
3001 /* Call the input method. */
3002 tem
= call1 (Vinput_method_function
, c
);
3004 tem
= unbind_to (count
, tem
);
3006 /* Restore the saved echoing state
3007 and this_command_keys state. */
3008 this_command_key_count
= key_count
;
3009 this_single_command_key_start
= command_key_start
;
3011 this_command_keys
= keys
;
3014 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3015 kset_echo_string (current_kboard
, saved_echo_string
);
3016 kset_echo_prompt (current_kboard
, saved_echo_prompt
);
3017 if (saved_immediate_echo
)
3020 /* The input method can return no events. */
3023 /* Bring back the previous message, if any. */
3024 if (! NILP (previous_echo_area_message
))
3025 message_with_string ("%s", previous_echo_area_message
, 0);
3028 /* It returned one event or more. */
3030 Vunread_post_input_method_events
3031 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3033 /* When we consume events from the various unread-*-events lists, we
3034 bypass the code that records input, so record these events now if
3035 they were not recorded already. */
3044 /* Display help if not echoing. */
3045 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3047 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3048 Lisp_Object help
, object
, position
, window
, htem
;
3050 htem
= Fcdr (XCDR (c
));
3053 window
= Fcar (htem
);
3055 object
= Fcar (htem
);
3057 position
= Fcar (htem
);
3059 show_help_echo (help
, window
, object
, position
);
3061 /* We stopped being idle for this event; undo that. */
3063 timer_resume_idle ();
3067 if ((! reread
|| this_command_key_count
== 0)
3071 /* Don't echo mouse motion events. */
3072 if (! (EVENT_HAS_PARAMETERS (c
)
3073 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3074 /* Once we reread a character, echoing can happen
3075 the next time we pause to read a new one. */
3076 ok_to_echo_at_next_pause
= current_kboard
;
3078 /* Record this character as part of the current key. */
3079 add_command_key (c
);
3080 if (! NILP (also_record
))
3081 add_command_key (also_record
);
3086 last_input_event
= c
;
3089 /* Process the help character specially if enabled. */
3090 if (!NILP (Vhelp_form
) && help_char_p (c
))
3092 ptrdiff_t count
= SPECPDL_INDEX ();
3094 help_form_saved_window_configs
3095 = Fcons (Fcurrent_window_configuration (Qnil
),
3096 help_form_saved_window_configs
);
3097 record_unwind_protect_void (read_char_help_form_unwind
);
3098 call0 (Qhelp_form_show
);
3103 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3104 if (EVENT_HAS_PARAMETERS (c
)
3105 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3106 XSETCAR (help_form_saved_window_configs
, Qnil
);
3108 while (BUFFERP (c
));
3109 /* Remove the help from the frame. */
3110 unbind_to (count
, Qnil
);
3113 if (EQ (c
, make_number (040)))
3117 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3118 while (BUFFERP (c
));
3124 input_was_pending
= input_pending
;
3128 #if 4 < __GNUC__ + (6 <= __GNUC_MINOR__)
3129 # pragma GCC diagnostic pop
3132 /* Record a key that came from a mouse menu.
3133 Record it for echoing, for this-command-keys, and so on. */
3136 record_menu_key (Lisp_Object c
)
3138 /* Wipe the echo area. */
3139 clear_message (1, 0);
3143 /* Once we reread a character, echoing can happen
3144 the next time we pause to read a new one. */
3145 ok_to_echo_at_next_pause
= NULL
;
3147 /* Record this character as part of the current key. */
3148 add_command_key (c
);
3151 /* Re-reading in the middle of a command. */
3152 last_input_event
= c
;
3156 /* Return true if should recognize C as "the help character". */
3159 help_char_p (Lisp_Object c
)
3163 if (EQ (c
, Vhelp_char
))
3165 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3166 if (EQ (c
, XCAR (tail
)))
3171 /* Record the input event C in various ways. */
3174 record_char (Lisp_Object c
)
3178 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3180 /* To avoid filling recent_keys with help-echo and mouse-movement
3181 events, we filter out repeated help-echo events, only store the
3182 first and last in a series of mouse-movement events, and don't
3183 store repeated help-echo events which are only separated by
3184 mouse-movement events. */
3186 Lisp_Object ev1
, ev2
, ev3
;
3189 if ((ix1
= recent_keys_index
- 1) < 0)
3190 ix1
= NUM_RECENT_KEYS
- 1;
3191 ev1
= AREF (recent_keys
, ix1
);
3193 if ((ix2
= ix1
- 1) < 0)
3194 ix2
= NUM_RECENT_KEYS
- 1;
3195 ev2
= AREF (recent_keys
, ix2
);
3197 if ((ix3
= ix2
- 1) < 0)
3198 ix3
= NUM_RECENT_KEYS
- 1;
3199 ev3
= AREF (recent_keys
, ix3
);
3201 if (EQ (XCAR (c
), Qhelp_echo
))
3203 /* Don't record `help-echo' in recent_keys unless it shows some help
3204 message, and a different help than the previously recorded
3206 Lisp_Object help
, last_help
;
3208 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3209 if (!STRINGP (help
))
3211 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3212 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3214 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3215 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3216 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3218 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3219 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3220 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3221 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3224 else if (EQ (XCAR (c
), Qmouse_movement
))
3226 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3227 So additional mouse movement events replace the last element. */
3228 Lisp_Object last_window
, window
;
3230 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3231 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3232 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3233 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3234 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3236 ASET (recent_keys
, ix1
, c
);
3242 store_kbd_macro_char (c
);
3244 /* recent_keys should not include events from keyboard macros. */
3245 if (NILP (Vexecuting_kbd_macro
))
3249 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3250 ASET (recent_keys
, recent_keys_index
, c
);
3251 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3252 recent_keys_index
= 0;
3254 else if (recorded
< 0)
3256 /* We need to remove one or two events from recent_keys.
3257 To do this, we simply put nil at those events and move the
3258 recent_keys_index backwards over those events. Usually,
3259 users will never see those nil events, as they will be
3260 overwritten by the command keys entered to see recent_keys
3263 while (recorded
++ < 0 && total_keys
> 0)
3265 if (total_keys
< NUM_RECENT_KEYS
)
3267 if (--recent_keys_index
< 0)
3268 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3269 ASET (recent_keys
, recent_keys_index
, Qnil
);
3273 num_nonmacro_input_events
++;
3276 /* Write c to the dribble file. If c is a lispy event, write
3277 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3278 If you, dear reader, have a better idea, you've got the source. :-) */
3284 if (XUINT (c
) < 0x100)
3285 putc (XUINT (c
), dribble
);
3287 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3291 Lisp_Object dribblee
;
3293 /* If it's a structured event, take the event header. */
3294 dribblee
= EVENT_HEAD (c
);
3296 if (SYMBOLP (dribblee
))
3298 putc ('<', dribble
);
3299 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3300 SBYTES (SYMBOL_NAME (dribblee
)),
3302 putc ('>', dribble
);
3311 /* Copy out or in the info on where C-g should throw to.
3312 This is used when running Lisp code from within get_char,
3313 in case get_char is called recursively.
3314 See read_process_output. */
3317 save_getcjmp (sys_jmp_buf temp
)
3319 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3323 restore_getcjmp (sys_jmp_buf temp
)
3325 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3328 /* Low level keyboard/mouse input.
3329 kbd_buffer_store_event places events in kbd_buffer, and
3330 kbd_buffer_get_event retrieves them. */
3332 /* Return true if there are any events in the queue that read-char
3333 would return. If this returns false, a read-char would block. */
3335 readable_events (int flags
)
3337 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3340 /* If the buffer contains only FOCUS_IN_EVENT events, and
3341 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3342 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3344 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3345 #ifdef USE_TOOLKIT_SCROLL_BARS
3346 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3350 union buffered_input_event
*event
= kbd_fetch_ptr
;
3354 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3357 #ifdef USE_TOOLKIT_SCROLL_BARS
3358 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3360 event
->kind
== FOCUS_IN_EVENT
)
3361 #ifdef USE_TOOLKIT_SCROLL_BARS
3362 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3363 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3364 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3365 && event
->ie
.part
== scroll_bar_handle
3366 && event
->ie
.modifiers
== 0)
3368 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3369 && event
->kind
== BUFFER_SWITCH_EVENT
))
3373 while (event
!= kbd_store_ptr
);
3379 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3380 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3384 if (current_kboard
->kbd_queue_has_data
)
3390 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3391 if (kb
->kbd_queue_has_data
)
3397 /* Set this for debugging, to have a way to get out */
3398 int stop_character EXTERNALLY_VISIBLE
;
3401 event_to_kboard (struct input_event
*event
)
3403 /* Not applicable for these special events. */
3404 if (event
->kind
== SELECTION_REQUEST_EVENT
3405 || event
->kind
== SELECTION_CLEAR_EVENT
)
3409 Lisp_Object obj
= event
->frame_or_window
;
3410 /* There are some events that set this field to nil or string. */
3412 obj
= WINDOW_FRAME (XWINDOW (obj
));
3413 /* Also ignore dead frames here. */
3414 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3415 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3420 /* Return the number of slots occupied in kbd_buffer. */
3423 kbd_buffer_nr_stored (void)
3425 return kbd_fetch_ptr
== kbd_store_ptr
3427 : (kbd_fetch_ptr
< kbd_store_ptr
3428 ? kbd_store_ptr
- kbd_fetch_ptr
3429 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3430 + (kbd_store_ptr
- kbd_buffer
)));
3432 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3435 kbd_buffer_store_event (register struct input_event
*event
)
3437 kbd_buffer_store_event_hold (event
, 0);
3440 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3442 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3443 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3444 Else, if EVENT is a quit event, store the quit event
3445 in HOLD_QUIT, and return (thus ignoring further events).
3447 This is used to postpone the processing of the quit event until all
3448 subsequent input events have been parsed (and discarded). */
3451 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3452 struct input_event
*hold_quit
)
3454 if (event
->kind
== NO_EVENT
)
3457 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3460 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3462 int c
= event
->ie
.code
& 0377;
3464 if (event
->ie
.modifiers
& ctrl_modifier
)
3465 c
= make_ctrl_char (c
);
3467 c
|= (event
->ie
.modifiers
3468 & (meta_modifier
| alt_modifier
3469 | hyper_modifier
| super_modifier
));
3473 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3475 if (single_kboard
&& kb
!= current_kboard
)
3478 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3480 kb
->kbd_queue_has_data
= true;
3481 union buffered_input_event
*sp
;
3482 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3484 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3487 if (event_to_kboard (&sp
->ie
) == kb
)
3489 sp
->ie
.kind
= NO_EVENT
;
3490 sp
->ie
.frame_or_window
= Qnil
;
3499 *hold_quit
= event
->ie
;
3503 /* If this results in a quit_char being returned to Emacs as
3504 input, set Vlast_event_frame properly. If this doesn't
3505 get returned to Emacs as an event, the next event read
3506 will set Vlast_event_frame again, so this is safe to do. */
3510 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3512 focus
= event
->ie
.frame_or_window
;
3513 internal_last_event_frame
= focus
;
3514 Vlast_event_frame
= focus
;
3517 handle_interrupt (0);
3521 if (c
&& c
== stop_character
)
3527 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3528 Just ignore the second one. */
3529 else if (event
->kind
== BUFFER_SWITCH_EVENT
3530 && kbd_fetch_ptr
!= kbd_store_ptr
3531 && ((kbd_store_ptr
== kbd_buffer
3532 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3533 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3536 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3537 kbd_store_ptr
= kbd_buffer
;
3539 /* Don't let the very last slot in the buffer become full,
3540 since that would make the two pointers equal,
3541 and that is indistinguishable from an empty buffer.
3542 Discard the event if it would fill the last slot. */
3543 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3545 *kbd_store_ptr
= *event
;
3548 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3549 && ! kbd_on_hold_p ())
3551 /* Don't read keyboard input until we have processed kbd_buffer.
3552 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3553 hold_keyboard_input ();
3557 #endif /* subprocesses */
3560 /* If we're inside while-no-input, and this event qualifies
3561 as input, set quit-flag to cause an interrupt. */
3562 if (!NILP (Vthrow_on_input
)
3563 && event
->kind
!= FOCUS_IN_EVENT
3564 && event
->kind
!= FOCUS_OUT_EVENT
3565 && event
->kind
!= HELP_EVENT
3566 && event
->kind
!= ICONIFY_EVENT
3567 && event
->kind
!= DEICONIFY_EVENT
)
3569 Vquit_flag
= Vthrow_on_input
;
3570 /* If we're inside a function that wants immediate quits,
3572 if (immediate_quit
&& NILP (Vinhibit_quit
))
3574 immediate_quit
= false;
3583 /* Put a selection input event back in the head of the event queue. */
3586 kbd_buffer_unget_event (struct selection_input_event
*event
)
3588 if (kbd_fetch_ptr
== kbd_buffer
)
3589 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3591 /* Don't let the very last slot in the buffer become full, */
3592 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3593 if (kp
!= kbd_store_ptr
)
3602 /* Limit help event positions to this range, to avoid overflow problems. */
3603 #define INPUT_EVENT_POS_MAX \
3604 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3605 MOST_POSITIVE_FIXNUM)))
3606 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3608 /* Return a Time that encodes position POS. POS must be in range. */
3611 position_to_Time (ptrdiff_t pos
)
3613 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3617 /* Return the position that ENCODED_POS encodes.
3618 Avoid signed integer overflow. */
3621 Time_to_position (Time encoded_pos
)
3623 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3625 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3626 eassert (encoded_pos_min
<= encoded_pos
);
3627 ptrdiff_t notpos
= -1 - encoded_pos
;
3631 /* Generate a HELP_EVENT input_event and store it in the keyboard
3634 HELP is the help form.
3636 FRAME and WINDOW are the frame and window where the help is
3637 generated. OBJECT is the Lisp object where the help was found (a
3638 buffer, a string, an overlay, or nil if neither from a string nor
3639 from a buffer). POS is the position within OBJECT where the help
3643 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3644 Lisp_Object object
, ptrdiff_t pos
)
3646 struct input_event event
;
3648 event
.kind
= HELP_EVENT
;
3649 event
.frame_or_window
= frame
;
3651 event
.x
= WINDOWP (window
) ? window
: frame
;
3653 event
.timestamp
= position_to_Time (pos
);
3654 kbd_buffer_store_event (&event
);
3658 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3661 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3663 struct input_event event
;
3665 event
.kind
= HELP_EVENT
;
3666 event
.frame_or_window
= frame
;
3670 event
.timestamp
= 0;
3671 kbd_buffer_store_event (&event
);
3675 /* Discard any mouse events in the event buffer by setting them to
3678 discard_mouse_events (void)
3680 union buffered_input_event
*sp
;
3681 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3683 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3686 if (sp
->kind
== MOUSE_CLICK_EVENT
3687 || sp
->kind
== WHEEL_EVENT
3688 || sp
->kind
== HORIZ_WHEEL_EVENT
3690 || sp
->kind
== GPM_CLICK_EVENT
3692 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3693 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3695 sp
->kind
= NO_EVENT
;
3701 /* Return true if there are any real events waiting in the event
3702 buffer, not counting `NO_EVENT's.
3704 Discard NO_EVENT events at the front of the input queue, possibly
3705 leaving the input queue empty if there are no real input events. */
3708 kbd_buffer_events_waiting (void)
3710 union buffered_input_event
*sp
;
3712 for (sp
= kbd_fetch_ptr
;
3713 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3716 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3721 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3725 /* Clear input event EVENT. */
3728 clear_event (union buffered_input_event
*event
)
3730 event
->kind
= NO_EVENT
;
3734 /* Read one event from the event buffer, waiting if necessary.
3735 The value is a Lisp object representing the event.
3736 The value is nil for an event that should be ignored,
3737 or that was handled here.
3738 We always read and discard one event. */
3741 kbd_buffer_get_event (KBOARD
**kbp
,
3742 bool *used_mouse_menu
,
3743 struct timespec
*end_time
)
3748 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3750 /* Start reading input again because we have processed enough to
3751 be able to accept new events again. */
3752 unhold_keyboard_input ();
3756 #endif /* subprocesses */
3758 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3760 /* In case we are running as a daemon, only do this before
3761 detaching from the terminal. */
3762 || (IS_DAEMON
&& DAEMON_RUNNING
))
3766 *kbp
= current_kboard
;
3769 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3771 /* Wait until there is input available. */
3774 /* Break loop if there's an unread command event. Needed in
3775 moused window autoselection which uses a timer to insert such
3777 if (CONSP (Vunread_command_events
))
3780 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3782 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3785 /* If the quit flag is set, then read_char will return
3786 quit_char, so that counts as "available input." */
3787 if (!NILP (Vquit_flag
))
3788 quit_throw_to_read_char (0);
3790 /* One way or another, wait until input is available; then, if
3791 interrupt handlers have not read it, read it now. */
3796 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3798 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3802 struct timespec now
= current_timespec ();
3803 if (timespec_cmp (*end_time
, now
) <= 0)
3804 return Qnil
; /* Finished waiting. */
3807 struct timespec duration
= timespec_sub (*end_time
, now
);
3808 wait_reading_process_output (min (duration
.tv_sec
,
3811 -1, 1, Qnil
, NULL
, 0);
3816 bool do_display
= true;
3818 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3820 struct tty_display_info
*tty
= CURTTY ();
3822 /* When this TTY is displaying a menu, we must prevent
3823 any redisplay, because we modify the frame's glyph
3824 matrix behind the back of the display engine. */
3825 if (tty
->showing_menu
)
3829 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3832 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3836 if (CONSP (Vunread_command_events
))
3839 first
= XCAR (Vunread_command_events
);
3840 Vunread_command_events
= XCDR (Vunread_command_events
);
3841 *kbp
= current_kboard
;
3845 /* At this point, we know that there is a readable event available
3846 somewhere. If the event queue is empty, then there must be a
3847 mouse movement enabled and available. */
3848 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3850 union buffered_input_event
*event
;
3852 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3856 *kbp
= event_to_kboard (&event
->ie
);
3858 *kbp
= current_kboard
; /* Better than returning null ptr? */
3862 /* These two kinds of events get special handling
3863 and don't actually appear to the command loop.
3864 We return nil for them. */
3865 if (event
->kind
== SELECTION_REQUEST_EVENT
3866 || event
->kind
== SELECTION_CLEAR_EVENT
)
3869 /* Remove it from the buffer before processing it,
3870 since otherwise swallow_events will see it
3871 and process it again. */
3872 struct selection_input_event copy
= event
->sie
;
3873 kbd_fetch_ptr
= event
+ 1;
3874 input_pending
= readable_events (0);
3875 x_handle_selection_event (©
);
3877 /* We're getting selection request events, but we don't have
3883 #if defined (HAVE_NS)
3884 else if (event
->kind
== NS_TEXT_EVENT
)
3886 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3887 obj
= list1 (intern ("ns-put-working-text"));
3889 obj
= list1 (intern ("ns-unput-working-text"));
3890 kbd_fetch_ptr
= event
+ 1;
3891 if (used_mouse_menu
)
3892 *used_mouse_menu
= true;
3896 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3897 || defined (HAVE_NS)
3898 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3900 /* Make an event (delete-frame (FRAME)). */
3901 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
3902 kbd_fetch_ptr
= event
+ 1;
3907 else if (event
->kind
== END_SESSION_EVENT
)
3909 /* Make an event (end-session). */
3910 obj
= list1 (Qend_session
);
3911 kbd_fetch_ptr
= event
+ 1;
3915 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3916 || defined (HAVE_NS)
3917 else if (event
->kind
== ICONIFY_EVENT
)
3919 /* Make an event (iconify-frame (FRAME)). */
3920 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
3921 kbd_fetch_ptr
= event
+ 1;
3923 else if (event
->kind
== DEICONIFY_EVENT
)
3925 /* Make an event (make-frame-visible (FRAME)). */
3926 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
3927 kbd_fetch_ptr
= event
+ 1;
3930 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3932 /* The value doesn't matter here; only the type is tested. */
3933 XSETBUFFER (obj
, current_buffer
);
3934 kbd_fetch_ptr
= event
+ 1;
3936 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3937 || defined (HAVE_NS) || defined (USE_GTK)
3938 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3940 kbd_fetch_ptr
= event
+ 1;
3941 input_pending
= readable_events (0);
3942 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
3943 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
3947 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3949 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3950 obj
= list4 (Qlanguage_change
,
3951 event
->ie
.frame_or_window
,
3952 make_number (event
->ie
.code
),
3953 make_number (event
->ie
.modifiers
));
3954 kbd_fetch_ptr
= event
+ 1;
3957 #ifdef USE_FILE_NOTIFY
3958 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3960 #ifdef HAVE_W32NOTIFY
3961 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3962 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
3964 obj
= make_lispy_event (&event
->ie
);
3966 kbd_fetch_ptr
= event
+ 1;
3968 #endif /* USE_FILE_NOTIFY */
3969 else if (event
->kind
== SAVE_SESSION_EVENT
)
3971 obj
= list2 (Qsave_session
, event
->ie
.arg
);
3972 kbd_fetch_ptr
= event
+ 1;
3974 /* Just discard these, by returning nil.
3975 With MULTI_KBOARD, these events are used as placeholders
3976 when we need to randomly delete events from the queue.
3977 (They shouldn't otherwise be found in the buffer,
3978 but on some machines it appears they do show up
3979 even without MULTI_KBOARD.) */
3980 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3981 mouse events during a popup-menu call. */
3982 else if (event
->kind
== NO_EVENT
)
3983 kbd_fetch_ptr
= event
+ 1;
3984 else if (event
->kind
== HELP_EVENT
)
3986 Lisp_Object object
, position
, help
, frame
, window
;
3988 frame
= event
->ie
.frame_or_window
;
3989 object
= event
->ie
.arg
;
3990 position
= make_number (Time_to_position (event
->ie
.timestamp
));
3991 window
= event
->ie
.x
;
3993 clear_event (event
);
3995 kbd_fetch_ptr
= event
+ 1;
3996 if (!WINDOWP (window
))
3998 obj
= Fcons (Qhelp_echo
,
3999 list5 (frame
, help
, window
, object
, position
));
4001 else if (event
->kind
== FOCUS_IN_EVENT
)
4003 /* Notification of a FocusIn event. The frame receiving the
4004 focus is in event->frame_or_window. Generate a
4005 switch-frame event if necessary. */
4006 Lisp_Object frame
, focus
;
4008 frame
= event
->ie
.frame_or_window
;
4009 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4015 ! NILP (event
->ie
.arg
)
4018 !EQ (frame
, internal_last_event_frame
)
4019 && !EQ (frame
, selected_frame
))
4020 obj
= make_lispy_switch_frame (frame
);
4022 obj
= make_lispy_focus_in (frame
);
4024 internal_last_event_frame
= frame
;
4025 kbd_fetch_ptr
= event
+ 1;
4027 else if (event
->kind
== FOCUS_OUT_EVENT
)
4029 #ifdef HAVE_WINDOW_SYSTEM
4032 Lisp_Object frame
= event
->ie
.frame_or_window
;
4033 bool focused
= false;
4035 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4036 focused
= di
->x_highlight_frame
!= 0;
4039 obj
= make_lispy_focus_out (frame
);
4041 #endif /* HAVE_WINDOW_SYSTEM */
4043 kbd_fetch_ptr
= event
+ 1;
4046 else if (event
->kind
== DBUS_EVENT
)
4048 obj
= make_lispy_event (&event
->ie
);
4049 kbd_fetch_ptr
= event
+ 1;
4052 #ifdef HAVE_XWIDGETS
4053 else if (event
->kind
== XWIDGET_EVENT
)
4055 obj
= make_lispy_event (&event
->ie
);
4056 kbd_fetch_ptr
= event
+ 1;
4059 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4061 obj
= make_lispy_event (&event
->ie
);
4062 kbd_fetch_ptr
= event
+ 1;
4066 /* If this event is on a different frame, return a switch-frame this
4067 time, and leave the event in the queue for next time. */
4071 frame
= event
->ie
.frame_or_window
;
4073 frame
= XCAR (frame
);
4074 else if (WINDOWP (frame
))
4075 frame
= WINDOW_FRAME (XWINDOW (frame
));
4077 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4081 if (! EQ (frame
, internal_last_event_frame
)
4082 && !EQ (frame
, selected_frame
))
4083 obj
= make_lispy_switch_frame (frame
);
4084 internal_last_event_frame
= frame
;
4086 /* If we didn't decide to make a switch-frame event, go ahead
4087 and build a real event from the queue entry. */
4091 obj
= make_lispy_event (&event
->ie
);
4093 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4094 || defined (HAVE_NS) || defined (USE_GTK)
4095 /* If this was a menu selection, then set the flag to inhibit
4096 writing to last_nonmenu_event. Don't do this if the event
4097 we're returning is (menu-bar), though; that indicates the
4098 beginning of the menu sequence, and we might as well leave
4099 that as the `event with parameters' for this selection. */
4101 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4102 && (event
->kind
== MENU_BAR_EVENT
4103 || event
->kind
== TOOL_BAR_EVENT
))
4104 *used_mouse_menu
= true;
4107 /* Certain system events are non-key events. */
4109 && event
->kind
== NS_NONKEY_EVENT
)
4110 *used_mouse_menu
= true;
4113 /* Wipe out this event, to catch bugs. */
4114 clear_event (event
);
4115 kbd_fetch_ptr
= event
+ 1;
4119 /* Try generating a mouse motion event. */
4120 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4122 struct frame
*f
= some_mouse_moved ();
4123 Lisp_Object bar_window
;
4124 enum scroll_bar_part part
;
4128 *kbp
= current_kboard
;
4129 /* Note that this uses F to determine which terminal to look at.
4130 If there is no valid info, it does not store anything
4131 so x remains nil. */
4134 /* XXX Can f or mouse_position_hook be NULL here? */
4135 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4136 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4141 /* Decide if we should generate a switch-frame event. Don't
4142 generate switch-frame events for motion outside of all Emacs
4148 frame
= FRAME_FOCUS_FRAME (f
);
4150 XSETFRAME (frame
, f
);
4152 if (! EQ (frame
, internal_last_event_frame
)
4153 && !EQ (frame
, selected_frame
))
4154 obj
= make_lispy_switch_frame (frame
);
4155 internal_last_event_frame
= frame
;
4158 /* If we didn't decide to make a switch-frame event, go ahead and
4159 return a mouse-motion event. */
4160 if (!NILP (x
) && NILP (obj
))
4161 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4164 /* We were promised by the above while loop that there was
4165 something for us to read! */
4168 input_pending
= readable_events (0);
4170 Vlast_event_frame
= internal_last_event_frame
;
4175 /* Process any non-user-visible events (currently X selection events),
4176 without reading any user-visible events. */
4179 process_special_events (void)
4181 union buffered_input_event
*event
;
4183 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4185 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4188 if (event
== kbd_store_ptr
)
4192 /* If we find a stored X selection request, handle it now. */
4193 if (event
->kind
== SELECTION_REQUEST_EVENT
4194 || event
->kind
== SELECTION_CLEAR_EVENT
)
4198 /* Remove the event from the fifo buffer before processing;
4199 otherwise swallow_events called recursively could see it
4200 and process it again. To do this, we move the events
4201 between kbd_fetch_ptr and EVENT one slot to the right,
4204 struct selection_input_event copy
= event
->sie
;
4205 union buffered_input_event
*beg
4206 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4207 ? kbd_buffer
: kbd_fetch_ptr
;
4210 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4211 else if (event
< beg
)
4213 if (event
> kbd_buffer
)
4214 memmove (kbd_buffer
+ 1, kbd_buffer
,
4215 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4216 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4217 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4218 memmove (beg
+ 1, beg
,
4219 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4222 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4223 kbd_fetch_ptr
= kbd_buffer
+ 1;
4227 input_pending
= readable_events (0);
4228 x_handle_selection_event (©
);
4230 /* We're getting selection request events, but we don't have
4238 /* Process any events that are not user-visible, run timer events that
4239 are ripe, and return, without reading any user-visible events. */
4242 swallow_events (bool do_display
)
4244 unsigned old_timers_run
;
4246 process_special_events ();
4248 old_timers_run
= timers_run
;
4249 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4251 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4252 redisplay_preserve_echo_area (7);
4255 /* Record the start of when Emacs is idle,
4256 for the sake of running idle-time timers. */
4259 timer_start_idle (void)
4261 /* If we are already in the idle state, do nothing. */
4262 if (timespec_valid_p (timer_idleness_start_time
))
4265 timer_idleness_start_time
= current_timespec ();
4266 timer_last_idleness_start_time
= timer_idleness_start_time
;
4268 /* Mark all idle-time timers as once again candidates for running. */
4269 call0 (intern ("internal-timer-start-idle"));
4272 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4275 timer_stop_idle (void)
4277 timer_idleness_start_time
= invalid_timespec ();
4280 /* Resume idle timer from last idle start time. */
4283 timer_resume_idle (void)
4285 if (timespec_valid_p (timer_idleness_start_time
))
4288 timer_idleness_start_time
= timer_last_idleness_start_time
;
4291 /* List of elisp functions to call, delayed because they were generated in
4292 a context where Elisp could not be safely run (e.g. redisplay, signal,
4293 ...). Each element has the form (FUN . ARGS). */
4294 Lisp_Object pending_funcalls
;
4296 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4298 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4302 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4304 vec
= XVECTOR (timer
)->contents
;
4305 if (! NILP (vec
[0]))
4307 if (! INTEGERP (vec
[2]))
4311 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4313 *result
= lisp_to_timespec (t
);
4314 return timespec_valid_p (*result
);
4318 /* Check whether a timer has fired. To prevent larger problems we simply
4319 disregard elements that are not proper timers. Do not make a circular
4320 timer list for the time being.
4322 Returns the time to wait until the next timer fires. If a
4323 timer is triggering now, return zero.
4324 If no timer is active, return -1.
4326 If a timer is ripe, we run it, with quitting turned off.
4327 In that case we return 0 to indicate that a new timer_check_2 call
4330 static struct timespec
4331 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4333 struct timespec nexttime
;
4334 struct timespec now
;
4335 struct timespec idleness_now
;
4336 Lisp_Object chosen_timer
;
4338 nexttime
= invalid_timespec ();
4340 chosen_timer
= Qnil
;
4342 /* First run the code that was delayed. */
4343 while (CONSP (pending_funcalls
))
4345 Lisp_Object funcall
= XCAR (pending_funcalls
);
4346 pending_funcalls
= XCDR (pending_funcalls
);
4347 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4350 if (CONSP (timers
) || CONSP (idle_timers
))
4352 now
= current_timespec ();
4353 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4354 ? timespec_sub (now
, timer_idleness_start_time
)
4355 : make_timespec (0, 0));
4358 while (CONSP (timers
) || CONSP (idle_timers
))
4360 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4361 struct timespec timer_time
, idle_timer_time
;
4362 struct timespec difference
;
4363 struct timespec timer_difference
= invalid_timespec ();
4364 struct timespec idle_timer_difference
= invalid_timespec ();
4365 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4367 /* Set TIMER and TIMER_DIFFERENCE
4368 based on the next ordinary timer.
4369 TIMER_DIFFERENCE is the distance in time from NOW to when
4370 this timer becomes ripe.
4371 Skip past invalid timers and timers already handled. */
4374 timer
= XCAR (timers
);
4375 if (! decode_timer (timer
, &timer_time
))
4377 timers
= XCDR (timers
);
4381 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4382 timer_difference
= (timer_ripe
4383 ? timespec_sub (now
, timer_time
)
4384 : timespec_sub (timer_time
, now
));
4387 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4388 based on the next idle timer. */
4389 if (CONSP (idle_timers
))
4391 idle_timer
= XCAR (idle_timers
);
4392 if (! decode_timer (idle_timer
, &idle_timer_time
))
4394 idle_timers
= XCDR (idle_timers
);
4398 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4399 idle_timer_difference
4401 ? timespec_sub (idleness_now
, idle_timer_time
)
4402 : timespec_sub (idle_timer_time
, idleness_now
));
4405 /* Decide which timer is the next timer,
4406 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4407 Also step down the list where we found that timer. */
4409 if (timespec_valid_p (timer_difference
)
4410 && (! timespec_valid_p (idle_timer_difference
)
4411 || idle_timer_ripe
< timer_ripe
4412 || (idle_timer_ripe
== timer_ripe
4414 ? timespec_cmp (idle_timer_difference
,
4416 : timespec_cmp (timer_difference
,
4417 idle_timer_difference
))
4420 chosen_timer
= timer
;
4421 timers
= XCDR (timers
);
4422 difference
= timer_difference
;
4427 chosen_timer
= idle_timer
;
4428 idle_timers
= XCDR (idle_timers
);
4429 difference
= idle_timer_difference
;
4430 ripe
= idle_timer_ripe
;
4433 /* If timer is ripe, run it if it hasn't been run. */
4436 if (NILP (AREF (chosen_timer
, 0)))
4438 ptrdiff_t count
= SPECPDL_INDEX ();
4439 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4441 /* Mark the timer as triggered to prevent problems if the lisp
4442 code fails to reschedule it right. */
4443 ASET (chosen_timer
, 0, Qt
);
4445 specbind (Qinhibit_quit
, Qt
);
4447 call1 (Qtimer_event_handler
, chosen_timer
);
4448 Vdeactivate_mark
= old_deactivate_mark
;
4450 unbind_to (count
, Qnil
);
4452 /* Since we have handled the event,
4453 we don't need to tell the caller to wake up and do it. */
4454 /* But the caller must still wait for the next timer, so
4455 return 0 to indicate that. */
4458 nexttime
= make_timespec (0, 0);
4462 /* When we encounter a timer that is still waiting,
4463 return the amount of time to wait before it is ripe. */
4469 /* No timers are pending in the future. */
4470 /* Return 0 if we generated an event, and -1 if not. */
4475 /* Check whether a timer has fired. To prevent larger problems we simply
4476 disregard elements that are not proper timers. Do not make a circular
4477 timer list for the time being.
4479 Returns the time to wait until the next timer fires.
4480 If no timer is active, return an invalid value.
4482 As long as any timer is ripe, we run it. */
4487 struct timespec nexttime
;
4488 Lisp_Object timers
, idle_timers
;
4490 Lisp_Object tem
= Vinhibit_quit
;
4493 /* We use copies of the timers' lists to allow a timer to add itself
4494 again, without locking up Emacs if the newly added timer is
4495 already ripe when added. */
4497 /* Always consider the ordinary timers. */
4498 timers
= Fcopy_sequence (Vtimer_list
);
4499 /* Consider the idle timers only if Emacs is idle. */
4500 if (timespec_valid_p (timer_idleness_start_time
))
4501 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4505 Vinhibit_quit
= tem
;
4509 nexttime
= timer_check_2 (timers
, idle_timers
);
4511 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4516 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4517 doc
: /* Return the current length of Emacs idleness, or nil.
4518 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4519 in the same style as (current-time).
4521 The value when Emacs is not idle is nil.
4523 PSEC is a multiple of the system clock resolution. */)
4526 if (timespec_valid_p (timer_idleness_start_time
))
4527 return make_lisp_time (timespec_sub (current_timespec (),
4528 timer_idleness_start_time
));
4533 /* Caches for modify_event_symbol. */
4534 static Lisp_Object accent_key_syms
;
4535 static Lisp_Object func_key_syms
;
4536 static Lisp_Object mouse_syms
;
4537 static Lisp_Object wheel_syms
;
4538 static Lisp_Object drag_n_drop_syms
;
4540 /* This is a list of keysym codes for special "accent" characters.
4541 It parallels lispy_accent_keys. */
4543 static const int lispy_accent_codes
[] =
4545 #ifdef XK_dead_circumflex
4550 #ifdef XK_dead_grave
4555 #ifdef XK_dead_tilde
4560 #ifdef XK_dead_diaeresis
4565 #ifdef XK_dead_macron
4570 #ifdef XK_dead_degree
4575 #ifdef XK_dead_acute
4580 #ifdef XK_dead_cedilla
4585 #ifdef XK_dead_breve
4590 #ifdef XK_dead_ogonek
4595 #ifdef XK_dead_caron
4600 #ifdef XK_dead_doubleacute
4601 XK_dead_doubleacute
,
4605 #ifdef XK_dead_abovedot
4610 #ifdef XK_dead_abovering
4620 #ifdef XK_dead_belowdot
4625 #ifdef XK_dead_voiced_sound
4626 XK_dead_voiced_sound
,
4630 #ifdef XK_dead_semivoiced_sound
4631 XK_dead_semivoiced_sound
,
4647 /* This is a list of Lisp names for special "accent" characters.
4648 It parallels lispy_accent_codes. */
4650 static const char *const lispy_accent_keys
[] =
4668 "dead-voiced-sound",
4669 "dead-semivoiced-sound",
4675 #define FUNCTION_KEY_OFFSET 0x0
4677 const char *const lispy_function_keys
[] =
4681 0, /* VK_LBUTTON 0x01 */
4682 0, /* VK_RBUTTON 0x02 */
4683 "cancel", /* VK_CANCEL 0x03 */
4684 0, /* VK_MBUTTON 0x04 */
4686 0, 0, 0, /* 0x05 .. 0x07 */
4688 "backspace", /* VK_BACK 0x08 */
4689 "tab", /* VK_TAB 0x09 */
4691 0, 0, /* 0x0A .. 0x0B */
4693 "clear", /* VK_CLEAR 0x0C */
4694 "return", /* VK_RETURN 0x0D */
4696 0, 0, /* 0x0E .. 0x0F */
4698 0, /* VK_SHIFT 0x10 */
4699 0, /* VK_CONTROL 0x11 */
4700 0, /* VK_MENU 0x12 */
4701 "pause", /* VK_PAUSE 0x13 */
4702 "capslock", /* VK_CAPITAL 0x14 */
4703 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4705 "junja", /* VK_JUNJA 0x17 */
4706 "final", /* VK_FINAL 0x18 */
4707 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4709 "escape", /* VK_ESCAPE 0x1B */
4710 "convert", /* VK_CONVERT 0x1C */
4711 "non-convert", /* VK_NONCONVERT 0x1D */
4712 "accept", /* VK_ACCEPT 0x1E */
4713 "mode-change", /* VK_MODECHANGE 0x1F */
4714 0, /* VK_SPACE 0x20 */
4715 "prior", /* VK_PRIOR 0x21 */
4716 "next", /* VK_NEXT 0x22 */
4717 "end", /* VK_END 0x23 */
4718 "home", /* VK_HOME 0x24 */
4719 "left", /* VK_LEFT 0x25 */
4720 "up", /* VK_UP 0x26 */
4721 "right", /* VK_RIGHT 0x27 */
4722 "down", /* VK_DOWN 0x28 */
4723 "select", /* VK_SELECT 0x29 */
4724 "print", /* VK_PRINT 0x2A */
4725 "execute", /* VK_EXECUTE 0x2B */
4726 "snapshot", /* VK_SNAPSHOT 0x2C */
4727 "insert", /* VK_INSERT 0x2D */
4728 "delete", /* VK_DELETE 0x2E */
4729 "help", /* VK_HELP 0x2F */
4731 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4733 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4735 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4737 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4739 0, 0, 0, 0, 0, 0, 0, 0, 0,
4740 0, 0, 0, 0, 0, 0, 0, 0, 0,
4741 0, 0, 0, 0, 0, 0, 0, 0,
4743 "lwindow", /* VK_LWIN 0x5B */
4744 "rwindow", /* VK_RWIN 0x5C */
4745 "apps", /* VK_APPS 0x5D */
4748 "kp-0", /* VK_NUMPAD0 0x60 */
4749 "kp-1", /* VK_NUMPAD1 0x61 */
4750 "kp-2", /* VK_NUMPAD2 0x62 */
4751 "kp-3", /* VK_NUMPAD3 0x63 */
4752 "kp-4", /* VK_NUMPAD4 0x64 */
4753 "kp-5", /* VK_NUMPAD5 0x65 */
4754 "kp-6", /* VK_NUMPAD6 0x66 */
4755 "kp-7", /* VK_NUMPAD7 0x67 */
4756 "kp-8", /* VK_NUMPAD8 0x68 */
4757 "kp-9", /* VK_NUMPAD9 0x69 */
4758 "kp-multiply", /* VK_MULTIPLY 0x6A */
4759 "kp-add", /* VK_ADD 0x6B */
4760 "kp-separator", /* VK_SEPARATOR 0x6C */
4761 "kp-subtract", /* VK_SUBTRACT 0x6D */
4762 "kp-decimal", /* VK_DECIMAL 0x6E */
4763 "kp-divide", /* VK_DIVIDE 0x6F */
4764 "f1", /* VK_F1 0x70 */
4765 "f2", /* VK_F2 0x71 */
4766 "f3", /* VK_F3 0x72 */
4767 "f4", /* VK_F4 0x73 */
4768 "f5", /* VK_F5 0x74 */
4769 "f6", /* VK_F6 0x75 */
4770 "f7", /* VK_F7 0x76 */
4771 "f8", /* VK_F8 0x77 */
4772 "f9", /* VK_F9 0x78 */
4773 "f10", /* VK_F10 0x79 */
4774 "f11", /* VK_F11 0x7A */
4775 "f12", /* VK_F12 0x7B */
4776 "f13", /* VK_F13 0x7C */
4777 "f14", /* VK_F14 0x7D */
4778 "f15", /* VK_F15 0x7E */
4779 "f16", /* VK_F16 0x7F */
4780 "f17", /* VK_F17 0x80 */
4781 "f18", /* VK_F18 0x81 */
4782 "f19", /* VK_F19 0x82 */
4783 "f20", /* VK_F20 0x83 */
4784 "f21", /* VK_F21 0x84 */
4785 "f22", /* VK_F22 0x85 */
4786 "f23", /* VK_F23 0x86 */
4787 "f24", /* VK_F24 0x87 */
4789 0, 0, 0, 0, /* 0x88 .. 0x8B */
4790 0, 0, 0, 0, /* 0x8C .. 0x8F */
4792 "kp-numlock", /* VK_NUMLOCK 0x90 */
4793 "scroll", /* VK_SCROLL 0x91 */
4794 /* Not sure where the following block comes from.
4795 Windows headers have NEC and Fujitsu specific keys in
4796 this block, but nothing generic. */
4797 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4798 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4799 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4800 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4801 "kp-end", /* VK_NUMPAD_END 0x96 */
4802 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4803 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4804 "kp-up", /* VK_NUMPAD_UP 0x99 */
4805 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4806 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4807 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4808 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4810 0, 0, /* 0x9E .. 0x9F */
4813 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4814 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4815 * No other API or message will distinguish left and right keys this way.
4820 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4821 to enable them selectively, and gives access to a few more functions.
4822 See lispy_multimedia_keys below. */
4823 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4824 0, 0, 0, /* 0xAD .. 0xAF Volume */
4825 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4826 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4828 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4829 0, 0, 0, 0, 0, 0, 0, 0, 0,
4831 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4832 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4833 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4836 "ax", /* VK_OEM_AX 0xE1 */
4837 0, /* VK_OEM_102 0xE2 */
4838 "ico-help", /* VK_ICO_HELP 0xE3 */
4839 "ico-00", /* VK_ICO_00 0xE4 */
4840 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4841 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4842 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4844 "reset", /* VK_OEM_RESET 0xE9 */
4845 "jump", /* VK_OEM_JUMP 0xEA */
4846 "oem-pa1", /* VK_OEM_PA1 0xEB */
4847 "oem-pa2", /* VK_OEM_PA2 0xEC */
4848 "oem-pa3", /* VK_OEM_PA3 0xED */
4849 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4850 "cusel", /* VK_OEM_CUSEL 0xEF */
4851 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4852 "finish", /* VK_OEM_FINISH 0xF1 */
4853 "copy", /* VK_OEM_COPY 0xF2 */
4854 "auto", /* VK_OEM_AUTO 0xF3 */
4855 "enlw", /* VK_OEM_ENLW 0xF4 */
4856 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4857 "attn", /* VK_ATTN 0xF6 */
4858 "crsel", /* VK_CRSEL 0xF7 */
4859 "exsel", /* VK_EXSEL 0xF8 */
4860 "ereof", /* VK_EREOF 0xF9 */
4861 "play", /* VK_PLAY 0xFA */
4862 "zoom", /* VK_ZOOM 0xFB */
4863 "noname", /* VK_NONAME 0xFC */
4864 "pa1", /* VK_PA1 0xFD */
4865 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4869 /* Some of these duplicate the "Media keys" on newer keyboards,
4870 but they are delivered to the application in a different way. */
4871 static const char *const lispy_multimedia_keys
[] =
4879 "browser-favorites",
4916 "toggle-dictate-command",
4922 "media-fast-forward",
4925 "media-channel-down"
4928 #else /* not HAVE_NTGUI */
4930 /* This should be dealt with in XTread_socket now, and that doesn't
4931 depend on the client system having the Kana syms defined. See also
4932 the XK_kana_A case below. */
4935 static const char *const lispy_kana_keys
[] =
4937 /* X Keysym value */
4938 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4939 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4940 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4941 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4942 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4943 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4944 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4945 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4946 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4947 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4948 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4949 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4950 "kana-i", "kana-u", "kana-e", "kana-o",
4951 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4952 "prolongedsound", "kana-A", "kana-I", "kana-U",
4953 "kana-E", "kana-O", "kana-KA", "kana-KI",
4954 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4955 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4956 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4957 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4958 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4959 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4960 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4961 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4962 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4963 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4964 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4965 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4967 #endif /* XK_kana_A */
4970 #define FUNCTION_KEY_OFFSET 0xff00
4972 /* You'll notice that this table is arranged to be conveniently
4973 indexed by X Windows keysym values. */
4974 static const char *const lispy_function_keys
[] =
4976 /* X Keysym value */
4978 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4979 "backspace", "tab", "linefeed", "clear",
4981 0, 0, 0, "pause", /* 0xff10...1f */
4982 0, 0, 0, 0, 0, 0, 0, "escape",
4984 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4985 "romaji", "hiragana", "katakana", "hiragana-katakana",
4986 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4987 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4988 "eisu-toggle", /* 0xff30...3f */
4989 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4990 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4992 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4993 "down", "prior", "next", "end",
4994 "begin", 0, 0, 0, 0, 0, 0, 0,
4995 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5006 "break", /* 0xff6b */
5009 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5010 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5011 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5012 0, 0, 0, 0, 0, 0, 0, 0,
5013 "kp-tab", /* 0xff89 */
5015 "kp-enter", /* 0xff8d */
5017 "kp-f1", /* 0xff91 */
5021 "kp-home", /* 0xff95 */
5026 "kp-prior", /* kp-page-up */
5027 "kp-next", /* kp-page-down */
5033 0, 0, 0, 0, 0, 0, 0, 0, 0,
5034 "kp-multiply", /* 0xffaa */
5039 "kp-divide", /* 0xffaf */
5040 "kp-0", /* 0xffb0 */
5041 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5044 "kp-equal", /* 0xffbd */
5045 "f1", /* 0xffbe */ /* IsFunctionKey */
5047 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5048 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5049 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5050 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5051 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5052 0, 0, 0, 0, 0, 0, 0, 0,
5053 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5054 0, 0, 0, 0, 0, 0, 0, "delete"
5057 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5058 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5060 static const char *const iso_lispy_function_keys
[] =
5062 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5063 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5064 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5065 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5066 "iso-lefttab", /* 0xfe20 */
5067 "iso-move-line-up", "iso-move-line-down",
5068 "iso-partial-line-up", "iso-partial-line-down",
5069 "iso-partial-space-left", "iso-partial-space-right",
5070 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5071 "iso-release-margin-left", "iso-release-margin-right",
5072 "iso-release-both-margins",
5073 "iso-fast-cursor-left", "iso-fast-cursor-right",
5074 "iso-fast-cursor-up", "iso-fast-cursor-down",
5075 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5076 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5079 #endif /* not HAVE_NTGUI */
5081 static Lisp_Object Vlispy_mouse_stem
;
5083 static const char *const lispy_wheel_names
[] =
5085 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5088 /* drag-n-drop events are generated when a set of selected files are
5089 dragged from another application and dropped onto an Emacs window. */
5090 static const char *const lispy_drag_n_drop_names
[] =
5095 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5096 scroll_bar_part value. Note that Qnil corresponds to
5097 scroll_bar_nowhere and should not appear in Lisp events. */
5098 static short const scroll_bar_parts
[] = {
5099 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5100 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5101 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5102 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5103 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5104 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5105 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5108 /* A vector, indexed by button number, giving the down-going location
5109 of currently depressed buttons, both scroll bar and non-scroll bar.
5111 The elements have the form
5112 (BUTTON-NUMBER MODIFIER-MASK . REST)
5113 where REST is the cdr of a position as it would be reported in the event.
5115 The make_lispy_event function stores positions here to tell the
5116 difference between click and drag events, and to store the starting
5117 location to be included in drag events. */
5119 static Lisp_Object button_down_location
;
5121 /* Information about the most recent up-going button event: Which
5122 button, what location, and what time. */
5124 static int last_mouse_button
;
5125 static int last_mouse_x
;
5126 static int last_mouse_y
;
5127 static Time button_down_time
;
5129 /* The number of clicks in this multiple-click. */
5131 static int double_click_count
;
5133 /* X and Y are frame-relative coordinates for a click or wheel event.
5134 Return a Lisp-style event list. */
5137 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5140 enum window_part part
;
5141 Lisp_Object posn
= Qnil
;
5142 Lisp_Object extra_info
= Qnil
;
5143 /* Coordinate pixel positions to return. */
5144 int xret
= 0, yret
= 0;
5145 /* The window under frame pixel coordinates (x,y) */
5146 Lisp_Object window
= f
5147 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5150 if (WINDOWP (window
))
5152 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5153 struct window
*w
= XWINDOW (window
);
5154 Lisp_Object string_info
= Qnil
;
5155 ptrdiff_t textpos
= 0;
5156 int col
= -1, row
= -1;
5157 int dx
= -1, dy
= -1;
5158 int width
= -1, height
= -1;
5159 Lisp_Object object
= Qnil
;
5161 /* Pixel coordinates relative to the window corner. */
5162 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5163 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5165 /* For text area clicks, return X, Y relative to the corner of
5166 this text area. Note that dX, dY etc are set below, by
5167 buffer_posn_from_coords. */
5168 if (part
== ON_TEXT
)
5170 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5171 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5173 /* For mode line and header line clicks, return X, Y relative to
5174 the left window edge. Use mode_line_string to look for a
5175 string on the click position. */
5176 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5181 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5182 /* Note that mode_line_string takes COL, ROW as pixels and
5183 converts them to characters. */
5186 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5187 &object
, &dx
, &dy
, &width
, &height
);
5188 if (STRINGP (string
))
5189 string_info
= Fcons (string
, make_number (charpos
));
5195 /* For fringes and margins, Y is relative to the area's (and the
5196 window's) top edge, while X is meaningless. */
5197 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5202 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5205 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5206 &object
, &dx
, &dy
, &width
, &height
);
5207 if (STRINGP (string
))
5208 string_info
= Fcons (string
, make_number (charpos
));
5210 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5212 else if (part
== ON_LEFT_FRINGE
)
5214 posn
= Qleft_fringe
;
5218 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5219 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5220 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5222 else if (part
== ON_RIGHT_FRINGE
)
5224 posn
= Qright_fringe
;
5228 - window_box_width (w
, LEFT_MARGIN_AREA
)
5229 - window_box_width (w
, TEXT_AREA
)
5230 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5231 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5233 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5235 else if (part
== ON_VERTICAL_BORDER
)
5237 posn
= Qvertical_line
;
5243 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5245 posn
= Qvertical_scroll_bar
;
5246 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5250 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5252 posn
= Qhorizontal_scroll_bar
;
5253 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5257 else if (part
== ON_RIGHT_DIVIDER
)
5259 posn
= Qright_divider
;
5260 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5264 else if (part
== ON_BOTTOM_DIVIDER
)
5266 posn
= Qbottom_divider
;
5267 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5272 /* For clicks in the text area, fringes, margins, or vertical
5273 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5274 the buffer position nearest to the click. */
5277 Lisp_Object string2
, object2
= Qnil
;
5278 struct display_pos p
;
5280 int width2
, height2
;
5281 /* The pixel X coordinate passed to buffer_posn_from_coords
5282 is the X coordinate relative to the text area for clicks
5283 in text-area, right-margin/fringe and right-side vertical
5284 scroll bar, zero otherwise. */
5286 = (part
== ON_TEXT
) ? xret
5287 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5288 || (part
== ON_VERTICAL_SCROLL_BAR
5289 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5290 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5294 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5295 &object2
, &dx2
, &dy2
,
5297 textpos
= CHARPOS (p
.pos
);
5298 if (col
< 0) col
= x2
;
5299 if (row
< 0) row
= y2
;
5300 if (dx
< 0) dx
= dx2
;
5301 if (dy
< 0) dy
= dy2
;
5302 if (width
< 0) width
= width2
;
5303 if (height
< 0) height
= height2
;
5307 posn
= make_number (textpos
);
5308 if (STRINGP (string2
))
5309 string_info
= Fcons (string2
,
5310 make_number (CHARPOS (p
.string_pos
)));
5316 #ifdef HAVE_WINDOW_SYSTEM
5317 if (IMAGEP (object
))
5319 Lisp_Object image_map
, hotspot
;
5320 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5322 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5324 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5325 posn
= XCAR (hotspot
);
5332 Fcons (make_number (dx
), make_number (dy
)),
5333 Fcons (make_number (width
), make_number (height
)));
5336 extra_info
= Fcons (string_info
,
5337 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5338 Fcons (Fcons (make_number (col
),
5344 /* Return mouse pixel coordinates here. */
5345 XSETFRAME (window
, f
);
5352 return Fcons (window
,
5354 Fcons (Fcons (make_number (xret
),
5355 make_number (yret
)),
5356 Fcons (make_number (t
),
5360 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5361 menu bar. This really means that Emacs draws and manages the menu
5362 bar as part of its normal display, and therefore can compute its
5365 toolkit_menubar_in_use (struct frame
*f
)
5367 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5368 return !(!FRAME_WINDOW_P (f
));
5374 /* Build the part of Lisp event which represents scroll bar state from
5375 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5378 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5380 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5381 make_number (ev
->timestamp
),
5382 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5385 /* Given a struct input_event, build the lisp event which represents
5386 it. If EVENT is 0, build a mouse movement event from the mouse
5387 movement buffer, which should have a movement event in it.
5389 Note that events must be passed to this function in the order they
5390 are received; this function stores the location of button presses
5391 in order to build drag events when the button is released. */
5394 make_lispy_event (struct input_event
*event
)
5398 switch (event
->kind
)
5400 /* A simple keystroke. */
5401 case ASCII_KEYSTROKE_EVENT
:
5402 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5404 Lisp_Object lispy_c
;
5405 EMACS_INT c
= event
->code
;
5406 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5409 eassert (c
== event
->code
);
5410 /* Turn ASCII characters into control characters
5412 if (event
->modifiers
& ctrl_modifier
)
5414 c
= make_ctrl_char (c
);
5415 event
->modifiers
&= ~ctrl_modifier
;
5419 /* Add in the other modifier bits. The shift key was taken care
5420 of by the X code. */
5421 c
|= (event
->modifiers
5422 & (meta_modifier
| alt_modifier
5423 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5424 /* Distinguish Shift-SPC from SPC. */
5425 if ((event
->code
) == 040
5426 && event
->modifiers
& shift_modifier
)
5427 c
|= shift_modifier
;
5428 button_down_time
= 0;
5429 XSETFASTINT (lispy_c
, c
);
5434 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5435 except that they are non-key events (last-nonmenu-event is nil). */
5436 case NS_NONKEY_EVENT
:
5439 /* A function key. The symbol may need to have modifier prefixes
5441 case NON_ASCII_KEYSTROKE_EVENT
:
5442 button_down_time
= 0;
5444 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5445 if (event
->code
== lispy_accent_codes
[i
])
5446 return modify_event_symbol (i
,
5448 Qfunction_key
, Qnil
,
5449 lispy_accent_keys
, &accent_key_syms
,
5450 ARRAYELTS (lispy_accent_keys
));
5454 if (event
->code
>= 0x400 && event
->code
< 0x500)
5455 return modify_event_symbol (event
->code
- 0x400,
5456 event
->modifiers
& ~shift_modifier
,
5457 Qfunction_key
, Qnil
,
5458 lispy_kana_keys
, &func_key_syms
,
5459 ARRAYELTS (lispy_kana_keys
));
5460 #endif /* XK_kana_A */
5463 #ifdef ISO_FUNCTION_KEY_OFFSET
5464 if (event
->code
< FUNCTION_KEY_OFFSET
5465 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5466 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5468 Qfunction_key
, Qnil
,
5469 iso_lispy_function_keys
, &func_key_syms
,
5470 ARRAYELTS (iso_lispy_function_keys
));
5473 if ((FUNCTION_KEY_OFFSET
<= event
->code
5475 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5476 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5477 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5479 Qfunction_key
, Qnil
,
5480 lispy_function_keys
, &func_key_syms
,
5481 ARRAYELTS (lispy_function_keys
));
5483 /* Handle system-specific or unknown keysyms.
5484 We need to use an alist rather than a vector as the cache
5485 since we can't make a vector long enough. */
5486 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5487 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5488 return modify_event_symbol (event
->code
,
5491 KVAR (current_kboard
, Vsystem_key_alist
),
5492 0, &KVAR (current_kboard
, system_key_syms
),
5496 case MULTIMEDIA_KEY_EVENT
:
5497 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5498 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5500 return modify_event_symbol (event
->code
, event
->modifiers
,
5501 Qfunction_key
, Qnil
,
5502 lispy_multimedia_keys
, &func_key_syms
,
5503 ARRAYELTS (lispy_multimedia_keys
));
5508 /* A mouse click. Figure out where it is, decide whether it's
5509 a press, click or drag, and build the appropriate structure. */
5510 case MOUSE_CLICK_EVENT
:
5512 case GPM_CLICK_EVENT
:
5514 #ifndef USE_TOOLKIT_SCROLL_BARS
5515 case SCROLL_BAR_CLICK_EVENT
:
5516 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5519 int button
= event
->code
;
5521 Lisp_Object position
;
5522 Lisp_Object
*start_pos_ptr
;
5523 Lisp_Object start_pos
;
5527 /* Build the position as appropriate for this mouse click. */
5528 if (event
->kind
== MOUSE_CLICK_EVENT
5530 || event
->kind
== GPM_CLICK_EVENT
5534 struct frame
*f
= XFRAME (event
->frame_or_window
);
5537 /* Ignore mouse events that were made on frame that
5538 have been deleted. */
5539 if (! FRAME_LIVE_P (f
))
5542 /* EVENT->x and EVENT->y are frame-relative pixel
5543 coordinates at this place. Under old redisplay, COLUMN
5544 and ROW are set to frame relative glyph coordinates
5545 which are then used to determine whether this click is
5546 in a menu (non-toolkit version). */
5547 if (!toolkit_menubar_in_use (f
))
5549 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5550 &column
, &row
, NULL
, 1);
5552 /* In the non-toolkit version, clicks on the menu bar
5553 are ordinary button events in the event buffer.
5554 Distinguish them, and invoke the menu.
5556 (In the toolkit version, the toolkit handles the
5557 menu bar and Emacs doesn't know about it until
5558 after the user makes a selection.) */
5559 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5560 && (event
->modifiers
& down_modifier
))
5562 Lisp_Object items
, item
;
5564 /* Find the menu bar item under `column'. */
5566 items
= FRAME_MENU_BAR_ITEMS (f
);
5567 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5569 Lisp_Object pos
, string
;
5570 string
= AREF (items
, i
+ 1);
5571 pos
= AREF (items
, i
+ 3);
5574 if (column
>= XINT (pos
)
5575 && column
< XINT (pos
) + SCHARS (string
))
5577 item
= AREF (items
, i
);
5582 /* ELisp manual 2.4b says (x y) are window
5583 relative but code says they are
5585 position
= list4 (event
->frame_or_window
,
5587 Fcons (event
->x
, event
->y
),
5588 make_number (event
->timestamp
));
5590 return list2 (item
, position
);
5594 position
= make_lispy_position (f
, event
->x
, event
->y
,
5597 #ifndef USE_TOOLKIT_SCROLL_BARS
5599 /* It's a scrollbar click. */
5600 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5601 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5603 if (button
>= ASIZE (button_down_location
))
5605 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5606 button_down_location
= larger_vector (button_down_location
,
5608 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5611 start_pos_ptr
= aref_addr (button_down_location
, button
);
5612 start_pos
= *start_pos_ptr
;
5613 *start_pos_ptr
= Qnil
;
5616 /* On window-system frames, use the value of
5617 double-click-fuzz as is. On other frames, interpret it
5618 as a multiple of 1/8 characters. */
5622 if (WINDOWP (event
->frame_or_window
))
5623 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5624 else if (FRAMEP (event
->frame_or_window
))
5625 f
= XFRAME (event
->frame_or_window
);
5629 if (FRAME_WINDOW_P (f
))
5630 fuzz
= double_click_fuzz
;
5632 fuzz
= double_click_fuzz
/ 8;
5634 is_double
= (button
== last_mouse_button
5635 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5636 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5637 && button_down_time
!= 0
5638 && (EQ (Vdouble_click_time
, Qt
)
5639 || (NATNUMP (Vdouble_click_time
)
5640 && (event
->timestamp
- button_down_time
5641 < XFASTINT (Vdouble_click_time
)))));
5644 last_mouse_button
= button
;
5645 last_mouse_x
= XINT (event
->x
);
5646 last_mouse_y
= XINT (event
->y
);
5648 /* If this is a button press, squirrel away the location, so
5649 we can decide later whether it was a click or a drag. */
5650 if (event
->modifiers
& down_modifier
)
5654 double_click_count
++;
5655 event
->modifiers
|= ((double_click_count
> 2)
5660 double_click_count
= 1;
5661 button_down_time
= event
->timestamp
;
5662 *start_pos_ptr
= Fcopy_alist (position
);
5663 ignore_mouse_drag_p
= 0;
5666 /* Now we're releasing a button - check the co-ordinates to
5667 see if this was a click or a drag. */
5668 else if (event
->modifiers
& up_modifier
)
5670 /* If we did not see a down before this up, ignore the up.
5671 Probably this happened because the down event chose a
5672 menu item. It would be an annoyance to treat the
5673 release of the button that chose the menu item as a
5676 if (!CONSP (start_pos
))
5679 event
->modifiers
&= ~up_modifier
;
5682 Lisp_Object new_down
, down
;
5683 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5685 /* The third element of every position
5686 should be the (x,y) pair. */
5687 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5688 new_down
= Fcar (Fcdr (Fcdr (position
)));
5691 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5693 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5694 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5697 if (ignore_mouse_drag_p
)
5699 event
->modifiers
|= click_modifier
;
5700 ignore_mouse_drag_p
= 0;
5702 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5703 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5704 /* Maybe the mouse has moved a lot, caused scrolling, and
5705 eventually ended up at the same screen position (but
5706 not buffer position) in which case it is a drag, not
5708 /* FIXME: OTOH if the buffer position has changed
5709 because of a timer or process filter rather than
5710 because of mouse movement, it should be considered as
5711 a click. But mouse-drag-region completely ignores
5712 this case and it hasn't caused any real problem, so
5713 it's probably OK to ignore it as well. */
5714 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5715 /* Mouse hasn't moved (much). */
5716 event
->modifiers
|= click_modifier
;
5719 button_down_time
= 0;
5720 event
->modifiers
|= drag_modifier
;
5723 /* Don't check is_double; treat this as multiple
5724 if the down-event was multiple. */
5725 if (double_click_count
> 1)
5726 event
->modifiers
|= ((double_click_count
> 2)
5732 /* Every mouse event should either have the down_modifier or
5733 the up_modifier set. */
5737 /* Get the symbol we should use for the mouse click. */
5740 head
= modify_event_symbol (button
,
5742 Qmouse_click
, Vlispy_mouse_stem
,
5745 ASIZE (mouse_syms
));
5746 if (event
->modifiers
& drag_modifier
)
5747 return list3 (head
, start_pos
, position
);
5748 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5749 return list3 (head
, position
, make_number (double_click_count
));
5751 return list2 (head
, position
);
5756 case HORIZ_WHEEL_EVENT
:
5758 Lisp_Object position
;
5761 /* Build the position as appropriate for this mouse click. */
5762 struct frame
*f
= XFRAME (event
->frame_or_window
);
5764 /* Ignore wheel events that were made on frame that have been
5766 if (! FRAME_LIVE_P (f
))
5769 position
= make_lispy_position (f
, event
->x
, event
->y
,
5772 /* Set double or triple modifiers to indicate the wheel speed. */
5774 /* On window-system frames, use the value of
5775 double-click-fuzz as is. On other frames, interpret it
5776 as a multiple of 1/8 characters. */
5782 if (WINDOWP (event
->frame_or_window
))
5783 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5784 else if (FRAMEP (event
->frame_or_window
))
5785 fr
= XFRAME (event
->frame_or_window
);
5789 fuzz
= FRAME_WINDOW_P (fr
)
5790 ? double_click_fuzz
: double_click_fuzz
/ 8;
5792 if (event
->modifiers
& up_modifier
)
5794 /* Emit a wheel-up event. */
5795 event
->modifiers
&= ~up_modifier
;
5798 else if (event
->modifiers
& down_modifier
)
5800 /* Emit a wheel-down event. */
5801 event
->modifiers
&= ~down_modifier
;
5805 /* Every wheel event should either have the down_modifier or
5806 the up_modifier set. */
5809 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5812 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5813 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5814 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5815 && button_down_time
!= 0
5816 && (EQ (Vdouble_click_time
, Qt
)
5817 || (NATNUMP (Vdouble_click_time
)
5818 && (event
->timestamp
- button_down_time
5819 < XFASTINT (Vdouble_click_time
)))));
5822 double_click_count
++;
5823 event
->modifiers
|= ((double_click_count
> 2)
5829 double_click_count
= 1;
5830 event
->modifiers
|= click_modifier
;
5833 button_down_time
= event
->timestamp
;
5834 /* Use a negative value to distinguish wheel from mouse button. */
5835 last_mouse_button
= - (1 + symbol_num
);
5836 last_mouse_x
= XINT (event
->x
);
5837 last_mouse_y
= XINT (event
->y
);
5839 /* Get the symbol we should use for the wheel event. */
5840 head
= modify_event_symbol (symbol_num
,
5846 ASIZE (wheel_syms
));
5849 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5850 return list3 (head
, position
, make_number (double_click_count
));
5852 return list2 (head
, position
);
5856 #ifdef USE_TOOLKIT_SCROLL_BARS
5858 /* We don't have down and up events if using toolkit scroll bars,
5859 so make this always a click event. Store in the `part' of
5860 the Lisp event a symbol which maps to the following actions:
5862 `above_handle' page up
5863 `below_handle' page down
5867 `bottom' bottom of buffer
5868 `handle' thumb has been dragged.
5869 `end-scroll' end of interaction with scroll bar
5871 The incoming input_event contains in its `part' member an
5872 index of type `enum scroll_bar_part' which we can use as an
5873 index in scroll_bar_parts to get the appropriate symbol. */
5875 case SCROLL_BAR_CLICK_EVENT
:
5877 Lisp_Object position
, head
;
5879 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5881 /* Always treat scroll bar events as clicks. */
5882 event
->modifiers
|= click_modifier
;
5883 event
->modifiers
&= ~up_modifier
;
5885 if (event
->code
>= ASIZE (mouse_syms
))
5886 mouse_syms
= larger_vector (mouse_syms
,
5887 event
->code
- ASIZE (mouse_syms
) + 1,
5890 /* Get the symbol we should use for the mouse click. */
5891 head
= modify_event_symbol (event
->code
,
5896 ASIZE (mouse_syms
));
5897 return list2 (head
, position
);
5900 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5902 Lisp_Object position
, head
;
5904 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5906 /* Always treat scroll bar events as clicks. */
5907 event
->modifiers
|= click_modifier
;
5908 event
->modifiers
&= ~up_modifier
;
5910 if (event
->code
>= ASIZE (mouse_syms
))
5911 mouse_syms
= larger_vector (mouse_syms
,
5912 event
->code
- ASIZE (mouse_syms
) + 1,
5915 /* Get the symbol we should use for the mouse click. */
5916 head
= modify_event_symbol (event
->code
,
5921 ASIZE (mouse_syms
));
5922 return list2 (head
, position
);
5925 #endif /* USE_TOOLKIT_SCROLL_BARS */
5927 case DRAG_N_DROP_EVENT
:
5930 Lisp_Object head
, position
;
5933 f
= XFRAME (event
->frame_or_window
);
5936 /* Ignore mouse events that were made on frames that
5937 have been deleted. */
5938 if (! FRAME_LIVE_P (f
))
5941 position
= make_lispy_position (f
, event
->x
, event
->y
,
5944 head
= modify_event_symbol (0, event
->modifiers
,
5946 lispy_drag_n_drop_names
,
5947 &drag_n_drop_syms
, 1);
5948 return list3 (head
, position
, files
);
5951 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5952 || defined (HAVE_NS) || defined (USE_GTK)
5953 case MENU_BAR_EVENT
:
5954 if (EQ (event
->arg
, event
->frame_or_window
))
5955 /* This is the prefix key. We translate this to
5956 `(menu_bar)' because the code in keyboard.c for menu
5957 events, which we use, relies on this. */
5958 return list1 (Qmenu_bar
);
5962 case SELECT_WINDOW_EVENT
:
5963 /* Make an event (select-window (WINDOW)). */
5964 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5966 case TOOL_BAR_EVENT
:
5967 if (EQ (event
->arg
, event
->frame_or_window
))
5968 /* This is the prefix key. We translate this to
5969 `(tool_bar)' because the code in keyboard.c for tool bar
5970 events, which we use, relies on this. */
5971 return list1 (Qtool_bar
);
5972 else if (SYMBOLP (event
->arg
))
5973 return apply_modifiers (event
->modifiers
, event
->arg
);
5976 case USER_SIGNAL_EVENT
:
5977 /* A user signal. */
5979 char *name
= find_user_signal_name (event
->code
);
5982 return intern (name
);
5985 case SAVE_SESSION_EVENT
:
5986 return Qsave_session
;
5991 return Fcons (Qdbus_event
, event
->arg
);
5993 #endif /* HAVE_DBUS */
5995 #ifdef HAVE_XWIDGETS
5998 return Fcons (Qxwidget_event
, event
->arg
);
6002 #if defined HAVE_INOTIFY || defined HAVE_KQUEUE || defined HAVE_GFILENOTIFY
6003 case FILE_NOTIFY_EVENT
:
6005 return Fcons (Qfile_notify
, event
->arg
);
6007 #endif /* HAVE_INOTIFY || HAVE_KQUEUE || HAVE_GFILENOTIFY */
6009 case CONFIG_CHANGED_EVENT
:
6010 return list3 (Qconfig_changed_event
,
6011 event
->arg
, event
->frame_or_window
);
6013 /* The 'kind' field of the event is something we don't recognize. */
6020 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6021 Lisp_Object x
, Lisp_Object y
, Time t
)
6023 /* Is it a scroll bar movement? */
6024 if (frame
&& ! NILP (bar_window
))
6026 Lisp_Object part_sym
;
6028 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6029 return list2 (Qscroll_bar_movement
,
6031 Qvertical_scroll_bar
,
6036 /* Or is it an ordinary mouse movement? */
6039 Lisp_Object position
;
6040 position
= make_lispy_position (frame
, x
, y
, t
);
6041 return list2 (Qmouse_movement
, position
);
6045 /* Construct a switch frame event. */
6047 make_lispy_switch_frame (Lisp_Object frame
)
6049 return list2 (Qswitch_frame
, frame
);
6053 make_lispy_focus_in (Lisp_Object frame
)
6055 return list2 (Qfocus_in
, frame
);
6058 #ifdef HAVE_WINDOW_SYSTEM
6061 make_lispy_focus_out (Lisp_Object frame
)
6063 return list2 (Qfocus_out
, frame
);
6066 #endif /* HAVE_WINDOW_SYSTEM */
6068 /* Manipulating modifiers. */
6070 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6072 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6073 SYMBOL's name of the end of the modifiers; the string from this
6074 position is the unmodified symbol name.
6076 This doesn't use any caches. */
6079 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6085 CHECK_SYMBOL (symbol
);
6088 name
= SYMBOL_NAME (symbol
);
6090 for (i
= 0; i
< SBYTES (name
) - 1; )
6092 ptrdiff_t this_mod_end
= 0;
6095 /* See if the name continues with a modifier word.
6096 Check that the word appears, but don't check what follows it.
6097 Set this_mod and this_mod_end to record what we find. */
6099 switch (SREF (name
, i
))
6101 #define SINGLE_LETTER_MOD(BIT) \
6102 (this_mod_end = i + 1, this_mod = BIT)
6105 SINGLE_LETTER_MOD (alt_modifier
);
6109 SINGLE_LETTER_MOD (ctrl_modifier
);
6113 SINGLE_LETTER_MOD (hyper_modifier
);
6117 SINGLE_LETTER_MOD (meta_modifier
);
6121 SINGLE_LETTER_MOD (shift_modifier
);
6125 SINGLE_LETTER_MOD (super_modifier
);
6128 #undef SINGLE_LETTER_MOD
6130 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6131 if (i + LEN + 1 <= SBYTES (name) \
6132 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6134 this_mod_end = i + LEN; \
6139 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6140 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6141 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6145 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6149 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6151 #undef MULTI_LETTER_MOD
6155 /* If we found no modifier, stop looking for them. */
6156 if (this_mod_end
== 0)
6159 /* Check there is a dash after the modifier, so that it
6160 really is a modifier. */
6161 if (this_mod_end
>= SBYTES (name
)
6162 || SREF (name
, this_mod_end
) != '-')
6165 /* This modifier is real; look for another. */
6166 modifiers
|= this_mod
;
6167 i
= this_mod_end
+ 1;
6170 /* Should we include the `click' modifier? */
6171 if (! (modifiers
& (down_modifier
| drag_modifier
6172 | double_modifier
| triple_modifier
))
6173 && i
+ 7 == SBYTES (name
)
6174 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6175 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6176 modifiers
|= click_modifier
;
6178 if (! (modifiers
& (double_modifier
| triple_modifier
))
6179 && i
+ 6 < SBYTES (name
)
6180 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6181 modifiers
|= click_modifier
;
6189 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6190 prepended to the string BASE[0..BASE_LEN-1].
6191 This doesn't use any caches. */
6193 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6195 /* Since BASE could contain nulls, we can't use intern here; we have
6196 to use Fintern, which expects a genuine Lisp_String, and keeps a
6198 char new_mods
[sizeof "A-C-H-M-S-s-up-down-drag-double-triple-"];
6204 /* Mouse events should not exhibit the `up' modifier once they
6205 leave the event queue only accessible to C code; `up' will
6206 always be turned into a click or drag event before being
6207 presented to lisp code. But since lisp events can be
6208 synthesized bypassing the event queue and pushed into
6209 `unread-command-events' or its companions, it's better to just
6210 deal with unexpected modifier combinations. */
6212 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6213 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6214 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6215 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6216 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6217 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6218 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6219 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6220 if (modifiers
& up_modifier
) p
= stpcpy (p
, "up-");
6221 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6222 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6223 /* The click modifier is denoted by the absence of other modifiers. */
6227 mod_len
= p
- new_mods
;
6231 Lisp_Object new_name
;
6233 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6234 mod_len
+ base_len_byte
);
6235 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6236 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6238 return Fintern (new_name
, Qnil
);
6243 static const char *const modifier_names
[] =
6245 "up", "down", "drag", "click", "double", "triple", 0, 0,
6246 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6247 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6249 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6251 static Lisp_Object modifier_symbols
;
6253 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6255 lispy_modifier_list (int modifiers
)
6257 Lisp_Object modifier_list
;
6260 modifier_list
= Qnil
;
6261 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6262 if (modifiers
& (1<<i
))
6263 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6266 return modifier_list
;
6270 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6271 where UNMODIFIED is the unmodified form of SYMBOL,
6272 MASK is the set of modifiers present in SYMBOL's name.
6273 This is similar to parse_modifiers_uncached, but uses the cache in
6274 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6275 Qevent_symbol_elements property. */
6277 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6280 parse_modifiers (Lisp_Object symbol
)
6282 Lisp_Object elements
;
6284 if (INTEGERP (symbol
))
6285 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6286 else if (!SYMBOLP (symbol
))
6289 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6290 if (CONSP (elements
))
6295 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6296 Lisp_Object unmodified
;
6299 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6300 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6303 if (modifiers
& ~INTMASK
)
6305 XSETFASTINT (mask
, modifiers
);
6306 elements
= list2 (unmodified
, mask
);
6308 /* Cache the parsing results on SYMBOL. */
6309 Fput (symbol
, Qevent_symbol_element_mask
,
6311 Fput (symbol
, Qevent_symbol_elements
,
6312 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6314 /* Since we know that SYMBOL is modifiers applied to unmodified,
6315 it would be nice to put that in unmodified's cache.
6316 But we can't, since we're not sure that parse_modifiers is
6323 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6324 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6325 doc
: /* Parse the event symbol. For internal use. */)
6326 (Lisp_Object symbol
)
6328 /* Fill the cache if needed. */
6329 parse_modifiers (symbol
);
6330 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6331 and use the Lispier representation stored on Qevent_symbol_elements
6333 return Fget (symbol
, Qevent_symbol_elements
);
6336 /* Apply the modifiers MODIFIERS to the symbol BASE.
6337 BASE must be unmodified.
6339 This is like apply_modifiers_uncached, but uses BASE's
6340 Qmodifier_cache property, if present.
6342 apply_modifiers copies the value of BASE's Qevent_kind property to
6343 the modified symbol. */
6345 apply_modifiers (int modifiers
, Lisp_Object base
)
6347 Lisp_Object cache
, idx
, entry
, new_symbol
;
6349 /* Mask out upper bits. We don't know where this value's been. */
6350 modifiers
&= INTMASK
;
6352 if (INTEGERP (base
))
6353 return make_number (XINT (base
) | modifiers
);
6355 /* The click modifier never figures into cache indices. */
6356 cache
= Fget (base
, Qmodifier_cache
);
6357 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6358 entry
= assq_no_quit (idx
, cache
);
6361 new_symbol
= XCDR (entry
);
6364 /* We have to create the symbol ourselves. */
6365 new_symbol
= apply_modifiers_uncached (modifiers
,
6366 SSDATA (SYMBOL_NAME (base
)),
6367 SCHARS (SYMBOL_NAME (base
)),
6368 SBYTES (SYMBOL_NAME (base
)));
6370 /* Add the new symbol to the base's cache. */
6371 entry
= Fcons (idx
, new_symbol
);
6372 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6374 /* We have the parsing info now for free, so we could add it to
6376 XSETFASTINT (idx, modifiers);
6377 Fput (new_symbol, Qevent_symbol_element_mask,
6379 Fput (new_symbol, Qevent_symbol_elements,
6380 Fcons (base, lispy_modifier_list (modifiers)));
6381 Sadly, this is only correct if `base' is indeed a base event,
6382 which is not necessarily the case. -stef */
6385 /* Make sure this symbol is of the same kind as BASE.
6387 You'd think we could just set this once and for all when we
6388 intern the symbol above, but reorder_modifiers may call us when
6389 BASE's property isn't set right; we can't assume that just
6390 because it has a Qmodifier_cache property it must have its
6391 Qevent_kind set right as well. */
6392 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6396 kind
= Fget (base
, Qevent_kind
);
6398 Fput (new_symbol
, Qevent_kind
, kind
);
6405 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6406 return a symbol with the modifiers placed in the canonical order.
6407 Canonical order is alphabetical, except for down and drag, which
6408 always come last. The 'click' modifier is never written out.
6410 Fdefine_key calls this to make sure that (for example) C-M-foo
6411 and M-C-foo end up being equivalent in the keymap. */
6414 reorder_modifiers (Lisp_Object symbol
)
6416 /* It's hopefully okay to write the code this way, since everything
6417 will soon be in caches, and no consing will be done at all. */
6420 parsed
= parse_modifiers (symbol
);
6421 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6426 /* For handling events, we often want to produce a symbol whose name
6427 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6428 to some base, like the name of a function key or mouse button.
6429 modify_event_symbol produces symbols of this sort.
6431 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6432 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6435 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6436 into symbol names, or a string specifying a name stem used to
6437 construct a symbol name or the form `STEM-N', where N is the decimal
6438 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6439 non-nil; otherwise NAME_TABLE is used.
6441 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6442 persist between calls to modify_event_symbol that it can use to
6443 store a cache of the symbols it's generated for this NAME_TABLE
6444 before. The object stored there may be a vector or an alist.
6446 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6448 MODIFIERS is a set of modifier bits (as given in struct input_events)
6449 whose prefixes should be applied to the symbol name.
6451 SYMBOL_KIND is the value to be placed in the event_kind property of
6452 the returned symbol.
6454 The symbols we create are supposed to have an
6455 `event-symbol-elements' property, which lists the modifiers present
6456 in the symbol's name. */
6459 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6460 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6461 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6464 Lisp_Object symbol_int
;
6466 /* Get rid of the "vendor-specific" bit here. */
6467 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6469 /* Is this a request for a valid symbol? */
6470 if (symbol_num
< 0 || symbol_num
>= table_size
)
6473 if (CONSP (*symbol_table
))
6474 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6476 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6477 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6478 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6479 we've never used that symbol before. */
6482 if (! VECTORP (*symbol_table
)
6483 || ASIZE (*symbol_table
) != table_size
)
6487 XSETFASTINT (size
, table_size
);
6488 *symbol_table
= Fmake_vector (size
, Qnil
);
6491 value
= AREF (*symbol_table
, symbol_num
);
6494 /* Have we already used this symbol before? */
6497 /* No; let's create it. */
6498 if (CONSP (name_alist_or_stem
))
6499 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6500 else if (STRINGP (name_alist_or_stem
))
6503 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6504 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6506 buf
= SAFE_ALLOCA (len
);
6507 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6508 XINT (symbol_int
) + 1);
6509 value
= intern (buf
);
6512 else if (name_table
!= 0 && name_table
[symbol_num
])
6513 value
= intern (name_table
[symbol_num
]);
6515 #ifdef HAVE_WINDOW_SYSTEM
6518 char *name
= x_get_keysym_name (symbol_num
);
6520 value
= intern (name
);
6526 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6527 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6528 value
= intern (buf
);
6531 if (CONSP (*symbol_table
))
6532 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6534 ASET (*symbol_table
, symbol_num
, value
);
6536 /* Fill in the cache entries for this symbol; this also
6537 builds the Qevent_symbol_elements property, which the user
6539 apply_modifiers (modifiers
& click_modifier
, value
);
6540 Fput (value
, Qevent_kind
, symbol_kind
);
6543 /* Apply modifiers to that symbol. */
6544 return apply_modifiers (modifiers
, value
);
6547 /* Convert a list that represents an event type,
6548 such as (ctrl meta backspace), into the usual representation of that
6549 event type as a number or a symbol. */
6551 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6552 doc
: /* Convert the event description list EVENT-DESC to an event type.
6553 EVENT-DESC should contain one base event type (a character or symbol)
6554 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6555 drag, down, double or triple). The base must be last.
6556 The return value is an event type (a character or symbol) which
6557 has the same base event type and all the specified modifiers. */)
6558 (Lisp_Object event_desc
)
6566 while (CONSP (rest
))
6574 /* Given a symbol, see if it is a modifier name. */
6575 if (SYMBOLP (elt
) && CONSP (rest
))
6576 this = parse_solitary_modifier (elt
);
6580 else if (!NILP (base
))
6581 error ("Two bases given in one event");
6587 /* Let the symbol A refer to the character A. */
6588 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6589 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6591 if (INTEGERP (base
))
6593 /* Turn (shift a) into A. */
6594 if ((modifiers
& shift_modifier
) != 0
6595 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6597 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6598 modifiers
&= ~shift_modifier
;
6601 /* Turn (control a) into C-a. */
6602 if (modifiers
& ctrl_modifier
)
6603 return make_number ((modifiers
& ~ctrl_modifier
)
6604 | make_ctrl_char (XINT (base
)));
6606 return make_number (modifiers
| XINT (base
));
6608 else if (SYMBOLP (base
))
6609 return apply_modifiers (modifiers
, base
);
6611 error ("Invalid base event");
6614 /* Try to recognize SYMBOL as a modifier name.
6615 Return the modifier flag bit, or 0 if not recognized. */
6618 parse_solitary_modifier (Lisp_Object symbol
)
6620 Lisp_Object name
= SYMBOL_NAME (symbol
);
6622 switch (SREF (name
, 0))
6624 #define SINGLE_LETTER_MOD(BIT) \
6625 if (SBYTES (name) == 1) \
6628 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6629 if (LEN == SBYTES (name) \
6630 && ! memcmp (SDATA (name), NAME, LEN)) \
6634 SINGLE_LETTER_MOD (alt_modifier
);
6638 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6642 SINGLE_LETTER_MOD (ctrl_modifier
);
6646 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6647 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6651 SINGLE_LETTER_MOD (hyper_modifier
);
6655 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6659 SINGLE_LETTER_MOD (meta_modifier
);
6663 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6667 SINGLE_LETTER_MOD (shift_modifier
);
6671 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6672 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6673 SINGLE_LETTER_MOD (super_modifier
);
6677 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6678 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6679 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6683 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6687 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6690 #undef SINGLE_LETTER_MOD
6691 #undef MULTI_LETTER_MOD
6697 /* Return true if EVENT is a list whose elements are all integers or symbols.
6698 Such a list is not valid as an event,
6699 but it can be a Lucid-style event type list. */
6702 lucid_event_type_list_p (Lisp_Object object
)
6706 if (! CONSP (object
))
6709 if (EQ (XCAR (object
), Qhelp_echo
)
6710 || EQ (XCAR (object
), Qvertical_line
)
6711 || EQ (XCAR (object
), Qmode_line
)
6712 || EQ (XCAR (object
), Qheader_line
))
6715 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6719 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6726 /* Return true if terminal input chars are available.
6727 Also, store the return value into INPUT_PENDING.
6729 Serves the purpose of ioctl (0, FIONREAD, ...)
6730 but works even if FIONREAD does not exist.
6731 (In fact, this may actually read some input.)
6733 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6734 timer events that are ripe.
6735 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6736 events (FOCUS_IN_EVENT).
6737 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6738 movements and toolkit scroll bar thumb drags. */
6741 get_input_pending (int flags
)
6743 /* First of all, have we already counted some input? */
6744 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6746 /* If input is being read as it arrives, and we have none, there is none. */
6747 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6749 /* Try to read some input and see how much we get. */
6751 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6754 return input_pending
;
6757 /* Put a BUFFER_SWITCH_EVENT in the buffer
6758 so that read_key_sequence will notice the new current buffer. */
6761 record_asynch_buffer_change (void)
6763 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6764 The purpose of the event is to make read_key_sequence look up the
6765 keymaps again. If we aren't in read_key_sequence, we don't need one,
6766 and the event could cause trouble by messing up (input-pending-p).
6767 Note: Fwaiting_for_user_input_p always returns nil when async
6768 subprocesses aren't supported. */
6769 if (!NILP (Fwaiting_for_user_input_p ()))
6771 struct input_event event
;
6774 event
.kind
= BUFFER_SWITCH_EVENT
;
6775 event
.frame_or_window
= Qnil
;
6778 /* Make sure no interrupt happens while storing the event. */
6780 if (interrupt_input
)
6781 kbd_buffer_store_event (&event
);
6786 kbd_buffer_store_event (&event
);
6792 /* Read any terminal input already buffered up by the system
6793 into the kbd_buffer, but do not wait.
6795 Return the number of keyboard chars read, or -1 meaning
6796 this is a bad time to try to read input. */
6805 /* Store pending user signal events, if any. */
6806 store_user_signal_events ();
6808 /* Loop through the available terminals, and call their input hooks. */
6812 struct terminal
*next
= t
->next_terminal
;
6814 if (t
->read_socket_hook
)
6817 struct input_event hold_quit
;
6819 if (input_blocked_p ())
6821 pending_signals
= true;
6825 EVENT_INIT (hold_quit
);
6826 hold_quit
.kind
= NO_EVENT
;
6828 /* No need for FIONREAD or fcntl; just say don't wait. */
6829 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6832 if (nr
== -1) /* Not OK to read input now. */
6836 else if (nr
== -2) /* Non-transient error. */
6838 /* The terminal device terminated; it should be closed. */
6840 /* Kill Emacs if this was our last terminal. */
6841 if (!terminal_list
->next_terminal
)
6842 /* Formerly simply reported no input, but that
6843 sometimes led to a failure of Emacs to terminate.
6844 SIGHUP seems appropriate if we can't reach the
6846 /* ??? Is it really right to send the signal just to
6847 this process rather than to the whole process
6848 group? Perhaps on systems with FIONREAD Emacs is
6849 alone in its group. */
6850 terminate_due_to_signal (SIGHUP
, 10);
6852 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6855 XSETTERMINAL (tmp
, t
);
6856 Fdelete_terminal (tmp
, Qnoelisp
);
6860 /* If there was no error, make sure the pointer
6861 is visible for all frames on this terminal. */
6864 Lisp_Object tail
, frame
;
6866 FOR_EACH_FRAME (tail
, frame
)
6868 struct frame
*f
= XFRAME (frame
);
6869 if (FRAME_TERMINAL (f
) == t
)
6870 frame_make_pointer_visible (f
);
6874 if (hold_quit
.kind
!= NO_EVENT
)
6875 kbd_buffer_store_event (&hold_quit
);
6887 /* This is the tty way of reading available input.
6889 Note that each terminal device has its own `struct terminal' object,
6890 and so this function is called once for each individual termcap
6891 terminal. The first parameter indicates which terminal to read from. */
6894 tty_read_avail_input (struct terminal
*terminal
,
6895 struct input_event
*hold_quit
)
6897 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6898 the kbd_buffer can really hold. That may prevent loss
6899 of characters on some systems when input is stuffed at us. */
6900 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6905 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6908 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6910 if (kbd_on_hold_p () || buffer_free
<= 0)
6912 #endif /* subprocesses */
6914 if (!terminal
->name
) /* Don't read from a dead terminal. */
6917 if (terminal
->type
!= output_termcap
6918 && terminal
->type
!= output_msdos_raw
)
6921 /* XXX I think the following code should be moved to separate hook
6922 functions in system-dependent files. */
6924 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6925 code sets read_socket_hook to w32_console_read_socket instead! */
6927 #else /* not WINDOWSNT */
6928 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6932 return 0; /* The terminal is suspended. */
6935 n_to_read
= dos_keysns ();
6939 cbuf
[0] = dos_keyread ();
6942 #else /* not MSDOS */
6947 struct input_event gpm_hold_quit
;
6948 int gpm
, fd
= gpm_fd
;
6950 EVENT_INIT (gpm_hold_quit
);
6951 gpm_hold_quit
.kind
= NO_EVENT
;
6953 /* gpm==1 if event received.
6954 gpm==0 if the GPM daemon has closed the connection, in which case
6955 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6956 we save it in `fd' so close_gpm can remove it from the
6958 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6959 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6960 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6963 /* Presumably the GPM daemon has closed the connection. */
6965 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6966 kbd_buffer_store_event (&gpm_hold_quit
);
6970 #endif /* HAVE_GPM */
6972 /* Determine how many characters we should *try* to read. */
6973 #ifdef USABLE_FIONREAD
6974 /* Find out how much input is available. */
6975 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6977 if (! noninteractive
)
6978 return -2; /* Close this terminal. */
6984 if (n_to_read
> sizeof cbuf
)
6985 n_to_read
= sizeof cbuf
;
6986 #elif defined USG || defined CYGWIN
6987 /* Read some input if available, but don't wait. */
6988 n_to_read
= sizeof cbuf
;
6989 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6991 # error "Cannot read without possibly delaying"
6995 /* Don't read more than we can store. */
6996 if (n_to_read
> buffer_free
)
6997 n_to_read
= buffer_free
;
6998 #endif /* subprocesses */
7000 /* Now read; for one reason or another, this will not block.
7001 NREAD is set to the number of chars read. */
7004 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7005 /* POSIX infers that processes which are not in the session leader's
7006 process group won't get SIGHUPs at logout time. BSDI adheres to
7007 this part standard and returns -1 from read (0) with errno==EIO
7008 when the control tty is taken away.
7009 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7010 if (nread
== -1 && errno
== EIO
)
7011 return -2; /* Close this terminal. */
7012 #if defined (AIX) && defined (_BSD)
7013 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7014 This looks incorrect, but it isn't, because _BSD causes
7015 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7016 and that causes a value other than 0 when there is no input. */
7018 return -2; /* Close this terminal. */
7022 /* We used to retry the read if it was interrupted.
7023 But this does the wrong thing when O_NONBLOCK causes
7024 an EAGAIN error. Does anybody know of a situation
7025 where a retry is actually needed? */
7027 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7037 #ifndef USABLE_FIONREAD
7038 #if defined (USG) || defined (CYGWIN)
7039 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7040 #endif /* USG or CYGWIN */
7041 #endif /* no FIONREAD */
7046 #endif /* not MSDOS */
7047 #endif /* not WINDOWSNT */
7049 for (i
= 0; i
< nread
; i
++)
7051 struct input_event buf
;
7053 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7055 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7056 buf
.modifiers
= meta_modifier
;
7057 if (tty
->meta_key
!= 2)
7061 /* Set the frame corresponding to the active tty. Note that the
7062 value of selected_frame is not reliable here, redisplay tends
7063 to temporarily change it. */
7064 buf
.frame_or_window
= tty
->top_frame
;
7067 kbd_buffer_store_event (&buf
);
7068 /* Don't look at input that follows a C-g too closely.
7069 This reduces lossage due to autorepeat on C-g. */
7070 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7071 && buf
.code
== quit_char
)
7079 handle_async_input (void)
7084 int nread
= gobble_input ();
7085 /* -1 means it's not ok to read the input now.
7086 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7087 0 means there was no keyboard input available. */
7095 process_pending_signals (void)
7097 pending_signals
= false;
7098 handle_async_input ();
7099 do_pending_atimers ();
7102 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7103 and reinvoke any pending signal if the level is now 0 and
7104 a fatal error is not already in progress. */
7107 unblock_input_to (int level
)
7109 interrupt_input_blocked
= level
;
7112 if (pending_signals
&& !fatal_error_in_progress
)
7113 process_pending_signals ();
7119 /* End critical section.
7121 If doing signal-driven input, and a signal came in when input was
7122 blocked, reinvoke the signal handler now to deal with it.
7124 It will also process queued input, if it was not read before.
7125 When a longer code sequence does not use block/unblock input
7126 at all, the whole input gathered up to the next call to
7127 unblock_input will be processed inside that call. */
7130 unblock_input (void)
7132 unblock_input_to (interrupt_input_blocked
- 1);
7135 /* Undo any number of BLOCK_INPUT calls,
7136 and also reinvoke any pending signal. */
7139 totally_unblock_input (void)
7141 unblock_input_to (0);
7147 handle_input_available_signal (int sig
)
7149 pending_signals
= true;
7151 if (input_available_clear_time
)
7152 *input_available_clear_time
= make_timespec (0, 0);
7156 deliver_input_available_signal (int sig
)
7158 deliver_process_signal (sig
, handle_input_available_signal
);
7160 #endif /* USABLE_SIGIO */
7163 /* User signal events. */
7165 struct user_signal_info
7167 /* Signal number. */
7170 /* Name of the signal. */
7173 /* Number of pending signals. */
7176 struct user_signal_info
*next
;
7179 /* List of user signals. */
7180 static struct user_signal_info
*user_signals
= NULL
;
7183 add_user_signal (int sig
, const char *name
)
7185 struct sigaction action
;
7186 struct user_signal_info
*p
;
7188 for (p
= user_signals
; p
; p
= p
->next
)
7190 /* Already added. */
7193 p
= xmalloc (sizeof *p
);
7195 p
->name
= xstrdup (name
);
7197 p
->next
= user_signals
;
7200 emacs_sigaction_init (&action
, deliver_user_signal
);
7201 sigaction (sig
, &action
, 0);
7205 handle_user_signal (int sig
)
7207 struct user_signal_info
*p
;
7208 const char *special_event_name
= NULL
;
7210 if (SYMBOLP (Vdebug_on_event
))
7211 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7213 for (p
= user_signals
; p
; p
= p
->next
)
7216 if (special_event_name
7217 && strcmp (special_event_name
, p
->name
) == 0)
7219 /* Enter the debugger in many ways. */
7220 debug_on_next_call
= true;
7221 debug_on_quit
= true;
7223 Vinhibit_quit
= Qnil
;
7225 /* Eat the event. */
7231 if (interrupt_input
)
7232 handle_input_available_signal (sig
);
7236 /* Tell wait_reading_process_output that it needs to wake
7237 up and look around. */
7238 if (input_available_clear_time
)
7239 *input_available_clear_time
= make_timespec (0, 0);
7246 deliver_user_signal (int sig
)
7248 deliver_process_signal (sig
, handle_user_signal
);
7252 find_user_signal_name (int sig
)
7254 struct user_signal_info
*p
;
7256 for (p
= user_signals
; p
; p
= p
->next
)
7264 store_user_signal_events (void)
7266 struct user_signal_info
*p
;
7267 struct input_event buf
;
7268 bool buf_initialized
= false;
7270 for (p
= user_signals
; p
; p
= p
->next
)
7271 if (p
->npending
> 0)
7273 if (! buf_initialized
)
7275 memset (&buf
, 0, sizeof buf
);
7276 buf
.kind
= USER_SIGNAL_EVENT
;
7277 buf
.frame_or_window
= selected_frame
;
7278 buf_initialized
= true;
7284 kbd_buffer_store_event (&buf
);
7287 while (p
->npending
> 0);
7292 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7293 static Lisp_Object menu_bar_one_keymap_changed_items
;
7295 /* These variables hold the vector under construction within
7296 menu_bar_items and its subroutines, and the current index
7297 for storing into that vector. */
7298 static Lisp_Object menu_bar_items_vector
;
7299 static int menu_bar_items_index
;
7302 static const char *separator_names
[] = {
7307 "single-dashed-line",
7308 "double-dashed-line",
7310 "shadow-etched-out",
7311 "shadow-etched-in-dash",
7312 "shadow-etched-out-dash",
7313 "shadow-double-etched-in",
7314 "shadow-double-etched-out",
7315 "shadow-double-etched-in-dash",
7316 "shadow-double-etched-out-dash",
7320 /* Return true if LABEL specifies a separator. */
7323 menu_separator_name_p (const char *label
)
7327 else if (strlen (label
) > 3
7328 && memcmp (label
, "--", 2) == 0
7333 for (i
= 0; separator_names
[i
]; ++i
)
7334 if (strcmp (label
, separator_names
[i
]) == 0)
7339 /* It's a separator if it contains only dashes. */
7340 while (*label
== '-')
7342 return (*label
== 0);
7349 /* Return a vector of menu items for a menu bar, appropriate
7350 to the current buffer. Each item has three elements in the vector:
7353 OLD is an old vector we can optionally reuse, or nil. */
7356 menu_bar_items (Lisp_Object old
)
7358 /* The number of keymaps we're scanning right now, and the number of
7359 keymaps we have allocated space for. */
7362 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7363 in the current keymaps, or nil where it is not a prefix. */
7366 Lisp_Object mapsbuf
[3];
7367 Lisp_Object def
, tail
;
7374 /* In order to build the menus, we need to call the keymap
7375 accessors. They all call QUIT. But this function is called
7376 during redisplay, during which a quit is fatal. So inhibit
7377 quitting while building the menus.
7378 We do this instead of specbind because (1) errors will clear it anyway
7379 and (2) this avoids risk of specpdl overflow. */
7380 oquit
= Vinhibit_quit
;
7384 menu_bar_items_vector
= old
;
7386 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7387 menu_bar_items_index
= 0;
7389 /* Build our list of keymaps.
7390 If we recognize a function key and replace its escape sequence in
7391 keybuf with its symbol, or if the sequence starts with a mouse
7392 click and we need to switch buffers, we jump back here to rebuild
7393 the initial keymaps from the current buffer. */
7397 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7398 if (!NILP (Voverriding_local_map_menu_flag
)
7399 && !NILP (Voverriding_local_map
))
7401 /* Yes, use them (if non-nil) as well as the global map. */
7404 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7405 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7406 if (!NILP (Voverriding_local_map
))
7407 maps
[nmaps
++] = Voverriding_local_map
;
7411 /* No, so use major and minor mode keymaps and keymap property.
7412 Note that menu-bar bindings in the local-map and keymap
7413 properties may not work reliable, as they are only
7414 recognized when the menu-bar (or mode-line) is updated,
7415 which does not normally happen after every command. */
7416 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7417 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7419 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7420 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7421 maps
[nmaps
++] = tem
;
7422 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7423 maps
[nmaps
++] = tem
;
7426 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7429 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7431 maps
[nmaps
++] = current_global_map
;
7434 /* Look up in each map the dummy prefix key `menu-bar'. */
7436 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7437 if (!NILP (maps
[mapno
]))
7439 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7443 menu_bar_one_keymap_changed_items
= Qnil
;
7444 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7448 /* Move to the end those items that should be at the end. */
7450 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7453 int end
= menu_bar_items_index
;
7455 for (i
= 0; i
< end
; i
+= 4)
7456 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7458 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7459 /* Move the item at index I to the end,
7460 shifting all the others forward. */
7461 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7462 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7463 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7464 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7466 memmove (aref_addr (menu_bar_items_vector
, i
),
7467 aref_addr (menu_bar_items_vector
, i
+ 4),
7468 (end
- i
- 4) * word_size
);
7469 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7470 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7471 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7472 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7477 /* Add nil, nil, nil, nil at the end. */
7479 int i
= menu_bar_items_index
;
7480 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7481 menu_bar_items_vector
7482 = larger_vector (menu_bar_items_vector
, 4, -1);
7483 /* Add this item. */
7484 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7485 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7486 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7487 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7488 menu_bar_items_index
= i
;
7491 Vinhibit_quit
= oquit
;
7493 return menu_bar_items_vector
;
7496 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7497 If there's already an item for KEY, add this DEF to it. */
7499 Lisp_Object item_properties
;
7502 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7508 if (EQ (item
, Qundefined
))
7510 /* If a map has an explicit `undefined' as definition,
7511 discard any previously made menu bar item. */
7513 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7514 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7516 if (menu_bar_items_index
> i
+ 4)
7517 memmove (aref_addr (menu_bar_items_vector
, i
),
7518 aref_addr (menu_bar_items_vector
, i
+ 4),
7519 (menu_bar_items_index
- i
- 4) * word_size
);
7520 menu_bar_items_index
-= 4;
7524 /* If this keymap has already contributed to this KEY,
7525 don't contribute to it a second time. */
7526 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7527 if (!NILP (tem
) || NILP (item
))
7530 menu_bar_one_keymap_changed_items
7531 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7533 /* We add to menu_bar_one_keymap_changed_items before doing the
7534 parse_menu_item, so that if it turns out it wasn't a menu item,
7535 it still correctly hides any further menu item. */
7536 parsed
= parse_menu_item (item
, 1);
7540 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7542 /* Find any existing item for this KEY. */
7543 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7544 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7547 /* If we did not find this KEY, add it at the end. */
7548 if (i
== menu_bar_items_index
)
7550 /* If vector is too small, get a bigger one. */
7551 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7552 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7553 /* Add this item. */
7554 ASET (menu_bar_items_vector
, i
, key
); i
++;
7555 ASET (menu_bar_items_vector
, i
,
7556 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7557 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7558 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7559 menu_bar_items_index
= i
;
7561 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7565 old
= AREF (menu_bar_items_vector
, i
+ 2);
7566 /* If the new and the old items are not both keymaps,
7567 the lookup will only find `item'. */
7568 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7569 ASET (menu_bar_items_vector
, i
+ 2, item
);
7573 /* This is used as the handler when calling menu_item_eval_property. */
7575 menu_item_eval_property_1 (Lisp_Object arg
)
7577 /* If we got a quit from within the menu computation,
7578 quit all the way out of it. This takes care of C-] in the debugger. */
7579 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7580 Fsignal (Qquit
, Qnil
);
7586 eval_dyn (Lisp_Object form
)
7588 return Feval (form
, Qnil
);
7591 /* Evaluate an expression and return the result (or nil if something
7592 went wrong). Used to evaluate dynamic parts of menu items. */
7594 menu_item_eval_property (Lisp_Object sexpr
)
7596 ptrdiff_t count
= SPECPDL_INDEX ();
7598 specbind (Qinhibit_redisplay
, Qt
);
7599 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7600 menu_item_eval_property_1
);
7601 return unbind_to (count
, val
);
7604 /* This function parses a menu item and leaves the result in the
7605 vector item_properties.
7606 ITEM is a key binding, a possible menu item.
7607 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7609 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7610 parse_menu_item returns true if the item is a menu item and false
7614 parse_menu_item (Lisp_Object item
, int inmenubar
)
7616 Lisp_Object def
, tem
, item_string
, start
;
7618 Lisp_Object keyhint
;
7627 /* Create item_properties vector if necessary. */
7628 if (NILP (item_properties
))
7630 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7632 /* Initialize optional entries. */
7633 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7634 ASET (item_properties
, i
, Qnil
);
7635 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7637 /* Save the item here to protect it from GC. */
7638 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7640 item_string
= XCAR (item
);
7644 if (STRINGP (item_string
))
7646 /* Old format menu item. */
7647 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7649 /* Maybe help string. */
7650 if (CONSP (item
) && STRINGP (XCAR (item
)))
7652 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7653 Fsubstitute_command_keys (XCAR (item
)));
7658 /* Maybe an obsolete key binding cache. */
7659 if (CONSP (item
) && CONSP (XCAR (item
))
7660 && (NILP (XCAR (XCAR (item
)))
7661 || VECTORP (XCAR (XCAR (item
)))))
7664 /* This is the real definition--the function to run. */
7665 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7667 /* Get enable property, if any. */
7670 tem
= Fget (item
, Qmenu_enable
);
7671 if (!NILP (Venable_disabled_menus_and_buttons
))
7672 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7673 else if (!NILP (tem
))
7674 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7677 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7679 /* New format menu item. */
7680 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7681 start
= XCDR (item
);
7684 /* We have a real binding. */
7685 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7687 item
= XCDR (start
);
7688 /* Is there an obsolete cache list with key equivalences. */
7689 if (CONSP (item
) && CONSP (XCAR (item
)))
7692 /* Parse properties. */
7693 while (CONSP (item
) && CONSP (XCDR (item
)))
7698 if (EQ (tem
, QCenable
))
7700 if (!NILP (Venable_disabled_menus_and_buttons
))
7701 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7703 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7705 else if (EQ (tem
, QCvisible
))
7707 /* If got a visible property and that evaluates to nil
7708 then ignore this item. */
7709 tem
= menu_item_eval_property (XCAR (item
));
7713 else if (EQ (tem
, QChelp
))
7715 Lisp_Object help
= XCAR (item
);
7717 help
= Fsubstitute_command_keys (help
);
7718 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7720 else if (EQ (tem
, QCfilter
))
7722 else if (EQ (tem
, QCkey_sequence
))
7725 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7726 /* Be GC protected. Set keyhint to item instead of tem. */
7729 else if (EQ (tem
, QCkeys
))
7732 if (CONSP (tem
) || STRINGP (tem
))
7733 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7735 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7740 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7742 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7744 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7750 else if (inmenubar
|| !NILP (start
))
7754 return 0; /* not a menu item */
7756 /* If item string is not a string, evaluate it to get string.
7757 If we don't get a string, skip this item. */
7758 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7759 if (!(STRINGP (item_string
)))
7761 item_string
= menu_item_eval_property (item_string
);
7762 if (!STRINGP (item_string
))
7764 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7767 /* If got a filter apply it on definition. */
7768 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7771 def
= menu_item_eval_property (list2 (XCAR (filter
),
7772 list2 (Qquote
, def
)));
7774 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7777 /* Enable or disable selection of item. */
7778 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7781 tem
= menu_item_eval_property (tem
);
7782 if (inmenubar
&& NILP (tem
))
7783 return 0; /* Ignore disabled items in menu bar. */
7784 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7787 /* If we got no definition, this item is just unselectable text which
7788 is OK in a submenu but not in the menubar. */
7790 return (!inmenubar
);
7792 /* See if this is a separate pane or a submenu. */
7793 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7794 tem
= get_keymap (def
, 0, 1);
7795 /* For a subkeymap, just record its details and exit. */
7798 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7799 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7803 /* At the top level in the menu bar, do likewise for commands also.
7804 The menu bar does not display equivalent key bindings anyway.
7805 ITEM_PROPERTY_DEF is already set up properly. */
7809 { /* This is a command. See if there is an equivalent key binding. */
7810 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7811 AUTO_STRING (space_space
, " ");
7813 /* The previous code preferred :key-sequence to :keys, so we
7814 preserve this behavior. */
7815 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7816 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7819 Lisp_Object prefix
= keyeq
;
7820 Lisp_Object keys
= Qnil
;
7824 def
= XCAR (prefix
);
7825 prefix
= XCDR (prefix
);
7828 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7830 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7832 keys
= XCAR (keyhint
);
7833 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7835 /* We have a suggested key. Is it bound to the command? */
7838 /* If the command is an alias for another
7839 (such as lmenu.el set it up), check if the
7840 original command matches the cached command. */
7842 && EQ (tem
, XSYMBOL (def
)->function
))))
7847 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7851 tem
= Fkey_description (keys
, Qnil
);
7854 if (STRINGP (XCAR (prefix
)))
7855 tem
= concat2 (XCAR (prefix
), tem
);
7856 if (STRINGP (XCDR (prefix
)))
7857 tem
= concat2 (tem
, XCDR (prefix
));
7859 keyeq
= concat2 (space_space
, tem
);
7865 /* If we have an equivalent key binding, use that. */
7866 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7869 /* Include this when menu help is implemented.
7870 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7871 if (!(NILP (tem) || STRINGP (tem)))
7873 tem = menu_item_eval_property (tem);
7876 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7880 /* Handle radio buttons or toggle boxes. */
7881 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7883 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7884 menu_item_eval_property (tem
));
7891 /***********************************************************************
7893 ***********************************************************************/
7895 /* A vector holding tool bar items while they are parsed in function
7896 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7899 static Lisp_Object tool_bar_items_vector
;
7901 /* A vector holding the result of parse_tool_bar_item. Layout is like
7902 the one for a single item in tool_bar_items_vector. */
7904 static Lisp_Object tool_bar_item_properties
;
7906 /* Next free index in tool_bar_items_vector. */
7908 static int ntool_bar_items
;
7910 /* Function prototypes. */
7912 static void init_tool_bar_items (Lisp_Object
);
7913 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7915 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7916 static void append_tool_bar_item (void);
7919 /* Return a vector of tool bar items for keymaps currently in effect.
7920 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7921 tool bar items found. */
7924 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7927 Lisp_Object mapsbuf
[3];
7935 /* In order to build the menus, we need to call the keymap
7936 accessors. They all call QUIT. But this function is called
7937 during redisplay, during which a quit is fatal. So inhibit
7938 quitting while building the menus. We do this instead of
7939 specbind because (1) errors will clear it anyway and (2) this
7940 avoids risk of specpdl overflow. */
7941 oquit
= Vinhibit_quit
;
7944 /* Initialize tool_bar_items_vector and protect it from GC. */
7945 init_tool_bar_items (reuse
);
7947 /* Build list of keymaps in maps. Set nmaps to the number of maps
7950 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7951 if (!NILP (Voverriding_local_map_menu_flag
)
7952 && !NILP (Voverriding_local_map
))
7954 /* Yes, use them (if non-nil) as well as the global map. */
7957 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7958 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7959 if (!NILP (Voverriding_local_map
))
7960 maps
[nmaps
++] = Voverriding_local_map
;
7964 /* No, so use major and minor mode keymaps and keymap property.
7965 Note that tool-bar bindings in the local-map and keymap
7966 properties may not work reliable, as they are only
7967 recognized when the tool-bar (or mode-line) is updated,
7968 which does not normally happen after every command. */
7969 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7970 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7972 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7973 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7974 maps
[nmaps
++] = tem
;
7975 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7976 maps
[nmaps
++] = tem
;
7979 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7982 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7985 /* Add global keymap at the end. */
7986 maps
[nmaps
++] = current_global_map
;
7988 /* Process maps in reverse order and look up in each map the prefix
7990 for (i
= nmaps
- 1; i
>= 0; --i
)
7991 if (!NILP (maps
[i
]))
7995 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7997 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8000 Vinhibit_quit
= oquit
;
8001 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8003 return tool_bar_items_vector
;
8007 /* Process the definition of KEY which is DEF. */
8010 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8014 if (EQ (def
, Qundefined
))
8016 /* If a map has an explicit `undefined' as definition,
8017 discard any previously made item. */
8018 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8020 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8022 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8024 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8025 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8026 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8028 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8033 else if (parse_tool_bar_item (key
, def
))
8034 /* Append a new tool bar item to tool_bar_items_vector. Accept
8035 more than one definition for the same key. */
8036 append_tool_bar_item ();
8039 /* Access slot with index IDX of vector tool_bar_item_properties. */
8040 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8042 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8044 ASET (tool_bar_item_properties
, idx
, val
);
8048 /* Parse a tool bar item specification ITEM for key KEY and return the
8049 result in tool_bar_item_properties. Value is false if ITEM is
8052 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8054 CAPTION is the caption of the item, If it's not a string, it is
8055 evaluated to get a string.
8057 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8058 as binding are currently ignored.
8060 The following properties are recognized:
8064 FORM is evaluated and specifies whether the tool bar item is
8065 enabled or disabled.
8069 FORM is evaluated and specifies whether the tool bar item is visible.
8071 - `:filter FUNCTION'
8073 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8074 result is stored as the new binding.
8076 - `:button (TYPE SELECTED)'
8078 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8079 and specifies whether the button is selected (pressed) or not.
8083 IMAGES is either a single image specification or a vector of four
8084 image specifications. See enum tool_bar_item_images.
8086 - `:help HELP-STRING'.
8088 Gives a help string to display for the tool bar item.
8090 - `:label LABEL-STRING'.
8092 A text label to show with the tool bar button if labels are enabled. */
8095 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8097 Lisp_Object filter
= Qnil
;
8098 Lisp_Object caption
;
8100 bool have_label
= false;
8102 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8103 Rule out items that aren't lists, don't start with
8104 `menu-item' or whose rest following `tool-bar-item' is not a
8109 /* As an exception, allow old-style menu separators. */
8110 if (STRINGP (XCAR (item
)))
8111 item
= list1 (XCAR (item
));
8112 else if (!EQ (XCAR (item
), Qmenu_item
)
8113 || (item
= XCDR (item
), !CONSP (item
)))
8116 /* Create tool_bar_item_properties vector if necessary. Reset it to
8118 if (VECTORP (tool_bar_item_properties
))
8120 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8124 tool_bar_item_properties
8125 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8128 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8129 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8131 /* Get the caption of the item. If the caption is not a string,
8132 evaluate it to get a string. If we don't get a string, skip this
8134 caption
= XCAR (item
);
8135 if (!STRINGP (caption
))
8137 caption
= menu_item_eval_property (caption
);
8138 if (!STRINGP (caption
))
8141 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8143 /* If the rest following the caption is not a list, the menu item is
8144 either a separator, or invalid. */
8148 if (menu_separator_name_p (SSDATA (caption
)))
8150 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8151 #if !defined (USE_GTK) && !defined (HAVE_NS)
8152 /* If we use build_desired_tool_bar_string to render the
8153 tool bar, the separator is rendered as an image. */
8154 set_prop (TOOL_BAR_ITEM_IMAGES
,
8155 (menu_item_eval_property
8156 (Vtool_bar_separator_image_expression
)));
8157 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8158 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8159 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8166 /* Store the binding. */
8167 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8170 /* Ignore cached key binding, if any. */
8171 if (CONSP (item
) && CONSP (XCAR (item
)))
8174 /* Process the rest of the properties. */
8175 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8177 Lisp_Object ikey
, value
;
8180 value
= XCAR (XCDR (item
));
8182 if (EQ (ikey
, QCenable
))
8184 /* `:enable FORM'. */
8185 if (!NILP (Venable_disabled_menus_and_buttons
))
8186 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8188 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8190 else if (EQ (ikey
, QCvisible
))
8192 /* `:visible FORM'. If got a visible property and that
8193 evaluates to nil then ignore this item. */
8194 if (NILP (menu_item_eval_property (value
)))
8197 else if (EQ (ikey
, QChelp
))
8198 /* `:help HELP-STRING'. */
8199 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8200 else if (EQ (ikey
, QCvert_only
))
8201 /* `:vert-only t/nil'. */
8202 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8203 else if (EQ (ikey
, QClabel
))
8205 const char *bad_label
= "!!?GARBLED ITEM?!!";
8206 /* `:label LABEL-STRING'. */
8207 set_prop (TOOL_BAR_ITEM_LABEL
,
8208 STRINGP (value
) ? value
: build_string (bad_label
));
8211 else if (EQ (ikey
, QCfilter
))
8212 /* ':filter FORM'. */
8214 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8216 /* `:button (TYPE . SELECTED)'. */
8217 Lisp_Object type
, selected
;
8219 type
= XCAR (value
);
8220 selected
= XCDR (value
);
8221 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8223 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8224 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8227 else if (EQ (ikey
, QCimage
)
8229 || (VECTORP (value
) && ASIZE (value
) == 4)))
8230 /* Value is either a single image specification or a vector
8231 of 4 such specifications for the different button states. */
8232 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8233 else if (EQ (ikey
, QCrtl
))
8235 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8241 /* Try to make one from caption and key. */
8242 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8243 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8244 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8245 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8247 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8248 char *buf
= xmalloc (max_lbl
+ 1);
8249 Lisp_Object new_lbl
;
8250 ptrdiff_t caption_len
= strlen (capt
);
8252 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8255 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8257 buf
[caption_len
] = '\0';
8261 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8265 strcpy (buf
, label
);
8267 for (j
= 0; buf
[j
] != '\0'; ++j
)
8275 new_lbl
= Fupcase_initials (build_string (label
));
8276 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8277 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8279 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8283 /* If got a filter apply it on binding. */
8285 set_prop (TOOL_BAR_ITEM_BINDING
,
8286 (menu_item_eval_property
8289 PROP (TOOL_BAR_ITEM_BINDING
))))));
8291 /* See if the binding is a keymap. Give up if it is. */
8292 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8295 /* Enable or disable selection of item. */
8296 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8297 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8298 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8300 /* Handle radio buttons or toggle boxes. */
8301 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8302 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8303 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8311 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8312 that can be reused. */
8315 init_tool_bar_items (Lisp_Object reuse
)
8317 if (VECTORP (reuse
))
8318 tool_bar_items_vector
= reuse
;
8320 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8321 ntool_bar_items
= 0;
8325 /* Append parsed tool bar item properties from
8326 tool_bar_item_properties */
8329 append_tool_bar_item (void)
8333 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8335 /* Enlarge tool_bar_items_vector if necessary. */
8337 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8339 /* Append entries from tool_bar_item_properties to the end of
8340 tool_bar_items_vector. */
8341 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8342 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8343 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8350 /* Read a character using menus based on the keymap MAP.
8351 Return nil if there are no menus in the maps.
8352 Return t if we displayed a menu but the user rejected it.
8354 PREV_EVENT is the previous input event, or nil if we are reading
8355 the first event of a key sequence.
8357 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8358 if we used a mouse menu to read the input, or false otherwise. If
8359 USED_MOUSE_MENU is null, don't dereference it.
8361 The prompting is done based on the prompt-string of the map
8362 and the strings associated with various map elements.
8364 This can be done with X menus or with menus put in the minibuf.
8365 These are done in different ways, depending on how the input will be read.
8366 Menus using X are done after auto-saving in read-char, getting the input
8367 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8368 and do auto-saving in the inner call of read_char. */
8371 read_char_x_menu_prompt (Lisp_Object map
,
8372 Lisp_Object prev_event
, bool *used_mouse_menu
)
8374 if (used_mouse_menu
)
8375 *used_mouse_menu
= false;
8377 /* Use local over global Menu maps. */
8379 if (! menu_prompting
)
8382 /* If we got to this point via a mouse click,
8383 use a real menu for mouse selection. */
8384 if (EVENT_HAS_PARAMETERS (prev_event
)
8385 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8386 && !EQ (XCAR (prev_event
), Qtool_bar
))
8388 /* Display the menu and get the selection. */
8391 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8396 record_menu_key (XCAR (value
));
8398 /* If we got multiple events, unread all but
8400 There is no way to prevent those unread events
8401 from showing up later in last_nonmenu_event.
8402 So turn symbol and integer events into lists,
8403 to indicate that they came from a mouse menu,
8404 so that when present in last_nonmenu_event
8405 they won't confuse things. */
8406 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8408 record_menu_key (XCAR (tem
));
8409 if (SYMBOLP (XCAR (tem
))
8410 || INTEGERP (XCAR (tem
)))
8411 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8414 /* If we got more than one event, put all but the first
8415 onto this list to be read later.
8416 Return just the first event now. */
8417 Vunread_command_events
8418 = nconc2 (XCDR (value
), Vunread_command_events
);
8419 value
= XCAR (value
);
8421 else if (NILP (value
))
8423 if (used_mouse_menu
)
8424 *used_mouse_menu
= true;
8431 read_char_minibuf_menu_prompt (int commandflag
,
8436 /* FIXME: Use the minibuffer's frame width. */
8437 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8439 bool nobindings
= true;
8440 Lisp_Object rest
, vector
;
8441 Lisp_Object prompt_strings
= Qnil
;
8445 if (! menu_prompting
)
8448 map
= get_keymap (map
, 0, 1);
8449 name
= Fkeymap_prompt (map
);
8451 /* If we don't have any menus, just read a character normally. */
8452 if (!STRINGP (name
))
8455 #define PUSH_C_STR(str, listvar) \
8456 listvar = Fcons (build_unibyte_string (str), listvar)
8458 /* Prompt string always starts with map's prompt, and a space. */
8459 prompt_strings
= Fcons (name
, prompt_strings
);
8460 PUSH_C_STR (": ", prompt_strings
);
8461 nlength
= SCHARS (name
) + 2;
8465 /* Present the documented bindings, a line at a time. */
8468 bool notfirst
= false;
8469 Lisp_Object menu_strings
= prompt_strings
;
8470 ptrdiff_t i
= nlength
;
8472 Lisp_Object orig_defn_macro
;
8474 /* Loop over elements of map. */
8479 /* FIXME: Use map_keymap to handle new keymap formats. */
8481 /* At end of map, wrap around if just starting,
8482 or end this line if already have something on it. */
8485 if (notfirst
|| nobindings
)
8491 /* Look at the next element of the map. */
8493 elt
= AREF (vector
, idx
);
8495 elt
= Fcar_safe (rest
);
8497 if (idx
< 0 && VECTORP (elt
))
8499 /* If we found a dense table in the keymap,
8500 advanced past it, but start scanning its contents. */
8501 rest
= Fcdr_safe (rest
);
8507 /* An ordinary element. */
8508 Lisp_Object event
, tem
;
8512 event
= Fcar_safe (elt
); /* alist */
8513 elt
= Fcdr_safe (elt
);
8517 XSETINT (event
, idx
); /* vector */
8520 /* Ignore the element if it has no prompt string. */
8521 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8523 /* True if the char to type matches the string. */
8525 Lisp_Object upcased_event
, downcased_event
;
8526 Lisp_Object desc
= Qnil
;
8528 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8530 upcased_event
= Fupcase (event
);
8531 downcased_event
= Fdowncase (event
);
8532 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8533 || XINT (downcased_event
) == SREF (s
, 0));
8535 desc
= Fsingle_key_description (event
, Qnil
);
8537 #if 0 /* It is redundant to list the equivalent key bindings because
8538 the prefix is what the user has already typed. */
8540 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8542 /* Insert equivalent keybinding. */
8543 s
= concat2 (s
, tem
);
8546 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8547 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8549 /* Insert button prefix. */
8550 Lisp_Object selected
8551 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8552 AUTO_STRING (radio_yes
, "(*) ");
8553 AUTO_STRING (radio_no
, "( ) ");
8554 AUTO_STRING (check_yes
, "[X] ");
8555 AUTO_STRING (check_no
, "[ ] ");
8556 if (EQ (tem
, QCradio
))
8557 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8559 tem
= NILP (selected
) ? check_yes
: check_no
;
8560 s
= concat2 (tem
, s
);
8564 /* If we have room for the prompt string, add it to this line.
8565 If this is the first on the line, always add it. */
8566 if ((SCHARS (s
) + i
+ 2
8567 + (char_matches
? 0 : SCHARS (desc
) + 3))
8571 ptrdiff_t thiswidth
;
8573 /* Punctuate between strings. */
8576 PUSH_C_STR (", ", menu_strings
);
8582 /* If the char to type doesn't match the string's
8583 first char, explicitly show what char to type. */
8586 /* Add as much of string as fits. */
8587 thiswidth
= min (SCHARS (desc
), width
- i
);
8589 = Fcons (Fsubstring (desc
, make_number (0),
8590 make_number (thiswidth
)),
8593 PUSH_C_STR (" = ", menu_strings
);
8597 /* Add as much of string as fits. */
8598 thiswidth
= min (SCHARS (s
), width
- i
);
8600 = Fcons (Fsubstring (s
, make_number (0),
8601 make_number (thiswidth
)),
8607 /* If this element does not fit, end the line now,
8608 and save the element for the next line. */
8609 PUSH_C_STR ("...", menu_strings
);
8614 /* Move past this element. */
8615 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8616 /* Handle reaching end of dense table. */
8621 rest
= Fcdr_safe (rest
);
8625 /* Prompt with that and read response. */
8626 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8628 /* Make believe it's not a keyboard macro in case the help char
8629 is pressed. Help characters are not recorded because menu prompting
8630 is not used on replay. */
8631 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8632 kset_defining_kbd_macro (current_kboard
, Qnil
);
8634 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8635 while (BUFFERP (obj
));
8636 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8638 if (!INTEGERP (obj
) || XINT (obj
) == -2
8639 || (! EQ (obj
, menu_prompt_more_char
)
8640 && (!INTEGERP (menu_prompt_more_char
)
8641 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8643 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8644 store_kbd_macro_char (obj
);
8647 /* Help char - go round again. */
8651 /* Reading key sequences. */
8654 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8656 return access_keymap (get_keymap (keymap
, 0, 1),
8661 active_maps (Lisp_Object first_event
)
8663 Lisp_Object position
8664 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8665 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8668 /* Structure used to keep track of partial application of key remapping
8669 such as Vfunction_key_map and Vkey_translation_map. */
8670 typedef struct keyremap
8672 /* This is the map originally specified for this use. */
8674 /* This is a submap reached by looking up, in PARENT,
8675 the events from START to END. */
8677 /* Positions [START, END) in the key sequence buffer
8678 are the key that we have scanned so far.
8679 Those events are the ones that we will replace
8680 if PARENT maps them into a key sequence. */
8684 /* Lookup KEY in MAP.
8685 MAP is a keymap mapping keys to key vectors or functions.
8686 If the mapping is a function and DO_FUNCALL is true,
8687 the function is called with PROMPT as parameter and its return
8688 value is used as the return value of this function (after checking
8689 that it is indeed a vector). */
8692 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8697 next
= access_keymap (map
, key
, 1, 0, 1);
8699 /* Handle a symbol whose function definition is a keymap
8701 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8702 && (ARRAYP (XSYMBOL (next
)->function
)
8703 || KEYMAPP (XSYMBOL (next
)->function
)))
8704 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8706 /* If the keymap gives a function, not an
8707 array, then call the function with one arg and use
8708 its value instead. */
8709 if (do_funcall
&& FUNCTIONP (next
))
8714 next
= call1 (next
, prompt
);
8715 /* If the function returned something invalid,
8716 barf--don't ignore it. */
8717 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8718 error ("Function %s returns invalid key sequence",
8719 SSDATA (SYMBOL_NAME (tem
)));
8724 /* Do one step of the key remapping used for function-key-map and
8725 key-translation-map:
8726 KEYBUF is the buffer holding the input events.
8727 BUFSIZE is its maximum size.
8728 FKEY is a pointer to the keyremap structure to use.
8729 INPUT is the index of the last element in KEYBUF.
8730 DOIT if true says that the remapping can actually take place.
8731 DIFF is used to return the number of keys added/removed by the remapping.
8732 PARENT is the root of the keymap.
8733 PROMPT is the prompt to use if the remapping happens through a function.
8734 Return true if the remapping actually took place. */
8737 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8738 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8740 Lisp_Object next
, key
;
8742 key
= keybuf
[fkey
->end
++];
8744 if (KEYMAPP (fkey
->parent
))
8745 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8749 /* If keybuf[fkey->start..fkey->end] is bound in the
8750 map and we're in a position to do the key remapping, replace it with
8751 the binding and restart with fkey->start at the end. */
8752 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8754 int len
= XFASTINT (Flength (next
));
8757 *diff
= len
- (fkey
->end
- fkey
->start
);
8759 if (bufsize
- input
<= *diff
)
8760 error ("Key sequence too long");
8762 /* Shift the keys that follow fkey->end. */
8764 for (i
= fkey
->end
; i
< input
; i
++)
8765 keybuf
[i
+ *diff
] = keybuf
[i
];
8767 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8768 keybuf
[i
+ *diff
] = keybuf
[i
];
8769 /* Overwrite the old keys with the new ones. */
8770 for (i
= 0; i
< len
; i
++)
8771 keybuf
[fkey
->start
+ i
]
8772 = Faref (next
, make_number (i
));
8774 fkey
->start
= fkey
->end
+= *diff
;
8775 fkey
->map
= fkey
->parent
;
8780 fkey
->map
= get_keymap (next
, 0, 1);
8782 /* If we no longer have a bound suffix, try a new position for
8784 if (!CONSP (fkey
->map
))
8786 fkey
->end
= ++fkey
->start
;
8787 fkey
->map
= fkey
->parent
;
8793 test_undefined (Lisp_Object binding
)
8795 return (NILP (binding
)
8796 || EQ (binding
, Qundefined
)
8797 || (SYMBOLP (binding
)
8798 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8801 /* Read a sequence of keys that ends with a non prefix character,
8802 storing it in KEYBUF, a buffer of size BUFSIZE.
8804 Return the length of the key sequence stored.
8805 Return -1 if the user rejected a command menu.
8807 Echo starting immediately unless `prompt' is 0.
8809 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8810 read_char with a suitable COMMANDFLAG argument.
8812 Where a key sequence ends depends on the currently active keymaps.
8813 These include any minor mode keymaps active in the current buffer,
8814 the current buffer's local map, and the global map.
8816 If a key sequence has no other bindings, we check Vfunction_key_map
8817 to see if some trailing subsequence might be the beginning of a
8818 function key's sequence. If so, we try to read the whole function
8819 key, and substitute its symbolic name into the key sequence.
8821 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8822 `double-' events into similar click events, if that would make them
8823 bound. We try to turn `triple-' events first into `double-' events,
8826 If we get a mouse click in a mode line, vertical divider, or other
8827 non-text area, we treat the click as if it were prefixed by the
8828 symbol denoting that area - `mode-line', `vertical-line', or
8831 If the sequence starts with a mouse click, we read the key sequence
8832 with respect to the buffer clicked on, not the current buffer.
8834 If the user switches frames in the midst of a key sequence, we put
8835 off the switch-frame event until later; the next call to
8836 read_char will return it.
8838 If FIX_CURRENT_BUFFER, we restore current_buffer
8839 from the selected window's buffer. */
8842 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8843 bool dont_downcase_last
, bool can_return_switch_frame
,
8844 bool fix_current_buffer
, bool prevent_redisplay
)
8846 ptrdiff_t count
= SPECPDL_INDEX ();
8848 /* How many keys there are in the current key sequence. */
8851 /* The length of the echo buffer when we started reading, and
8852 the length of this_command_keys when we started reading. */
8853 ptrdiff_t echo_start
IF_LINT (= 0);
8854 ptrdiff_t keys_start
;
8856 Lisp_Object current_binding
= Qnil
;
8857 Lisp_Object first_event
= Qnil
;
8859 /* Index of the first key that has no binding.
8860 It is useless to try fkey.start larger than that. */
8863 /* If t < mock_input, then KEYBUF[t] should be read as the next
8866 We use this to recover after recognizing a function key. Once we
8867 realize that a suffix of the current key sequence is actually a
8868 function key's escape sequence, we replace the suffix with the
8869 function key's binding from Vfunction_key_map. Now keybuf
8870 contains a new and different key sequence, so the echo area,
8871 this_command_keys, and the submaps and defs arrays are wrong. In
8872 this situation, we set mock_input to t, set t to 0, and jump to
8873 restart_sequence; the loop will read keys from keybuf up until
8874 mock_input, thus rebuilding the state; and then it will resume
8875 reading characters from the keyboard. */
8878 /* If the sequence is unbound in submaps[], then
8879 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8880 and fkey.map is its binding.
8882 These might be > t, indicating that all function key scanning
8883 should hold off until t reaches them. We do this when we've just
8884 recognized a function key, to avoid searching for the function
8885 key's again in Vfunction_key_map. */
8888 /* Likewise, for key_translation_map and input-decode-map. */
8889 keyremap keytran
, indec
;
8891 /* True if we are trying to map a key by changing an upper-case
8892 letter to lower case, or a shifted function key to an unshifted
8894 bool shift_translated
= false;
8896 /* If we receive a `switch-frame' or `select-window' event in the middle of
8897 a key sequence, we put it off for later.
8898 While we're reading, we keep the event here. */
8899 Lisp_Object delayed_switch_frame
;
8901 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8902 int original_uppercase_position
= -1;
8904 /* Gets around Microsoft compiler limitations. */
8905 bool dummyflag
= false;
8907 struct buffer
*starting_buffer
;
8909 /* List of events for which a fake prefix key has been generated. */
8910 Lisp_Object fake_prefixed_keys
= Qnil
;
8912 raw_keybuf_count
= 0;
8914 last_nonmenu_event
= Qnil
;
8916 delayed_switch_frame
= Qnil
;
8922 /* Install the string PROMPT as the beginning of the string
8923 of echoing, so that it serves as a prompt for the next
8925 kset_echo_prompt (current_kboard
, prompt
);
8926 /* FIXME: This use of echo_now doesn't look quite right and is ugly
8927 since it forces us to fiddle with current_kboard->immediate_echo
8928 before and after. */
8929 current_kboard
->immediate_echo
= false;
8931 if (!echo_keystrokes_p ())
8932 current_kboard
->immediate_echo
= false;
8934 else if (cursor_in_echo_area
/* FIXME: Not sure why we test this here,
8935 maybe we should just drop this test. */
8936 && echo_keystrokes_p ())
8937 /* This doesn't put in a dash if the echo buffer is empty, so
8938 you don't always see a dash hanging out in the minibuffer. */
8942 /* Record the initial state of the echo area and this_command_keys;
8943 we will need to restore them if we replay a key sequence. */
8945 echo_start
= echo_length ();
8946 keys_start
= this_command_key_count
;
8947 this_single_command_key_start
= keys_start
;
8949 /* We jump here when we need to reinitialize fkey and keytran; this
8950 happens if we switch keyboards between rescans. */
8951 replay_entire_sequence
:
8953 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8954 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8955 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8956 indec
.start
= indec
.end
= 0;
8957 fkey
.start
= fkey
.end
= 0;
8958 keytran
.start
= keytran
.end
= 0;
8960 /* We jump here when the key sequence has been thoroughly changed, and
8961 we need to rescan it starting from the beginning. When we jump here,
8962 keybuf[0..mock_input] holds the sequence we should reread. */
8965 starting_buffer
= current_buffer
;
8966 first_unbound
= bufsize
+ 1;
8968 /* Build our list of keymaps.
8969 If we recognize a function key and replace its escape sequence in
8970 keybuf with its symbol, or if the sequence starts with a mouse
8971 click and we need to switch buffers, we jump back here to rebuild
8972 the initial keymaps from the current buffer. */
8973 current_binding
= active_maps (first_event
);
8975 /* Start from the beginning in keybuf. */
8978 /* These are no-ops the first time through, but if we restart, they
8979 revert the echo area and this_command_keys to their original state. */
8980 this_command_key_count
= keys_start
;
8981 if (INTERACTIVE
&& t
< mock_input
)
8982 echo_truncate (echo_start
);
8984 /* If the best binding for the current key sequence is a keymap, or
8985 we may be looking at a function key's escape sequence, keep on
8987 while (!NILP (current_binding
)
8988 /* Keep reading as long as there's a prefix binding. */
8989 ? KEYMAPP (current_binding
)
8990 /* Don't return in the middle of a possible function key sequence,
8991 if the only bindings we found were via case conversion.
8992 Thus, if ESC O a has a function-key-map translation
8993 and ESC o has a binding, don't return after ESC O,
8994 so that we can translate ESC O plus the next character. */
8995 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8998 bool used_mouse_menu
= false;
9000 /* Where the last real key started. If we need to throw away a
9001 key that has expanded into more than one element of keybuf
9002 (say, a mouse click on the mode line which is being treated
9003 as [mode-line (mouse-...)], then we backtrack to this point
9005 int last_real_key_start
;
9007 /* These variables are analogous to echo_start and keys_start;
9008 while those allow us to restart the entire key sequence,
9009 echo_local_start and keys_local_start allow us to throw away
9011 ptrdiff_t echo_local_start
IF_LINT (= 0);
9012 int keys_local_start
;
9013 Lisp_Object new_binding
;
9015 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9016 eassert (indec
.start
<= indec
.end
);
9017 eassert (fkey
.start
<= fkey
.end
);
9018 eassert (keytran
.start
<= keytran
.end
);
9019 /* key-translation-map is applied *after* function-key-map
9020 which is itself applied *after* input-decode-map. */
9021 eassert (fkey
.end
<= indec
.start
);
9022 eassert (keytran
.end
<= fkey
.start
);
9024 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9025 first_unbound
< keytran
.start
)
9026 { /* The prefix upto first_unbound has no binding and has
9027 no translation left to do either, so we know it's unbound.
9028 If we don't stop now, we risk staying here indefinitely
9029 (if the user keeps entering fkey or keytran prefixes
9030 like C-c ESC ESC ESC ESC ...) */
9032 for (i
= first_unbound
+ 1; i
< t
; i
++)
9033 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9034 mock_input
= t
- first_unbound
- 1;
9035 indec
.end
= indec
.start
-= first_unbound
+ 1;
9036 indec
.map
= indec
.parent
;
9037 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9038 fkey
.map
= fkey
.parent
;
9039 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9040 keytran
.map
= keytran
.parent
;
9041 goto replay_sequence
;
9045 error ("Key sequence too long");
9048 echo_local_start
= echo_length ();
9049 keys_local_start
= this_command_key_count
;
9052 /* These are no-ops, unless we throw away a keystroke below and
9053 jumped back up to replay_key; in that case, these restore the
9054 variables to their original state, allowing us to replay the
9056 if (INTERACTIVE
&& t
< mock_input
)
9057 echo_truncate (echo_local_start
);
9058 this_command_key_count
= keys_local_start
;
9060 /* By default, assume each event is "real". */
9061 last_real_key_start
= t
;
9063 /* Does mock_input indicate that we are re-reading a key sequence? */
9067 add_command_key (key
);
9068 if (current_kboard
->immediate_echo
)
9070 /* Set immediate_echo to false so as to force echo_now to
9071 redisplay (it will set immediate_echo right back to true). */
9072 current_kboard
->immediate_echo
= false;
9077 /* If not, we should actually read a character. */
9081 KBOARD
*interrupted_kboard
= current_kboard
;
9082 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9083 /* Calling read_char with COMMANDFLAG = -2 avoids
9084 redisplay in read_char and its subroutines. */
9085 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9086 current_binding
, last_nonmenu_event
,
9087 &used_mouse_menu
, NULL
);
9088 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9089 /* When switching to a new tty (with a new keyboard),
9090 read_char returns the new buffer, rather than -2
9091 (Bug#5095). This is because `terminal-init-xterm'
9092 calls read-char, which eats the wrong_kboard_jmpbuf
9093 return. Any better way to fix this? -- cyd */
9094 || (interrupted_kboard
!= current_kboard
))
9099 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9100 if (k
== interrupted_kboard
)
9105 /* Don't touch interrupted_kboard when it's been
9107 delayed_switch_frame
= Qnil
;
9108 goto replay_entire_sequence
;
9111 if (!NILP (delayed_switch_frame
))
9114 (interrupted_kboard
,
9115 Fcons (delayed_switch_frame
,
9116 KVAR (interrupted_kboard
, kbd_queue
)));
9117 delayed_switch_frame
= Qnil
;
9122 (interrupted_kboard
,
9123 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9125 /* If the side queue is non-empty, ensure it begins with a
9126 switch-frame, so we'll replay it in the right context. */
9127 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9128 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9129 !(EVENT_HAS_PARAMETERS (key
)
9130 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9134 XSETFRAME (frame
, interrupted_frame
);
9136 (interrupted_kboard
,
9137 Fcons (make_lispy_switch_frame (frame
),
9138 KVAR (interrupted_kboard
, kbd_queue
)));
9141 goto replay_entire_sequence
;
9145 /* read_char returns t when it shows a menu and the user rejects it.
9149 unbind_to (count
, Qnil
);
9153 /* read_char returns -1 at the end of a macro.
9154 Emacs 18 handles this by returning immediately with a
9155 zero, so that's what we'll do. */
9156 if (INTEGERP (key
) && XINT (key
) == -1)
9159 /* The Microsoft C compiler can't handle the goto that
9165 /* If the current buffer has been changed from under us, the
9166 keymap may have changed, so replay the sequence. */
9169 timer_resume_idle ();
9172 /* Reset the current buffer from the selected window
9173 in case something changed the former and not the latter.
9174 This is to be more consistent with the behavior
9175 of the command_loop_1. */
9176 if (fix_current_buffer
)
9178 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9180 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9182 Fset_buffer (XWINDOW (selected_window
)->contents
);
9185 goto replay_sequence
;
9188 /* If we have a quit that was typed in another frame, and
9189 quit_throw_to_read_char switched buffers,
9190 replay to get the right keymap. */
9192 && XINT (key
) == quit_char
9193 && current_buffer
!= starting_buffer
)
9196 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9201 goto replay_sequence
;
9206 if (EVENT_HAS_PARAMETERS (key
)
9207 /* Either a `switch-frame' or a `select-window' event. */
9208 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9210 /* If we're at the beginning of a key sequence, and the caller
9211 says it's okay, go ahead and return this event. If we're
9212 in the midst of a key sequence, delay it until the end. */
9213 if (t
> 0 || !can_return_switch_frame
)
9215 delayed_switch_frame
= key
;
9220 if (NILP (first_event
))
9223 /* Even if first_event does not specify a particular
9224 window/position, it's important to recompute the maps here
9225 since a long time might have passed since we entered
9226 read_key_sequence, and a timer (or process-filter or
9227 special-event-map, ...) might have switched the current buffer
9228 or the selected window from under us in the mean time. */
9229 if (fix_current_buffer
9230 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9232 Fset_buffer (XWINDOW (selected_window
)->contents
);
9233 current_binding
= active_maps (first_event
);
9237 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9241 /* Clicks in non-text areas get prefixed by the symbol
9242 in their CHAR-ADDRESS field. For example, a click on
9243 the mode line is prefixed by the symbol `mode-line'.
9245 Furthermore, key sequences beginning with mouse clicks
9246 are read using the keymaps of the buffer clicked on, not
9247 the current buffer. So we may have to switch the buffer
9250 When we turn one event into two events, we must make sure
9251 that neither of the two looks like the original--so that,
9252 if we replay the events, they won't be expanded again.
9253 If not for this, such reexpansion could happen either here
9254 or when user programs play with this-command-keys. */
9255 if (EVENT_HAS_PARAMETERS (key
))
9257 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9258 if (EQ (kind
, Qmouse_click
))
9260 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9261 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9264 || (!NILP (fake_prefixed_keys
)
9265 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9267 /* We're looking a second time at an event for which
9268 we generated a fake prefix key. Set
9269 last_real_key_start appropriately. */
9271 last_real_key_start
= t
- 1;
9274 if (last_real_key_start
== 0)
9276 /* Key sequences beginning with mouse clicks are
9277 read using the keymaps in the buffer clicked on,
9278 not the current buffer. If we're at the
9279 beginning of a key sequence, switch buffers. */
9280 if (WINDOWP (window
)
9281 && BUFFERP (XWINDOW (window
)->contents
)
9282 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9284 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9289 /* Arrange to go back to the original buffer once we're
9290 done reading the key sequence. Note that we can't
9291 use save_excursion_{save,restore} here, because they
9292 save point as well as the current buffer; we don't
9293 want to save point, because redisplay may change it,
9294 to accommodate a Fset_window_start or something. We
9295 don't want to do this at the top of the function,
9296 because we may get input from a subprocess which
9297 wants to change the selected window and stuff (say,
9299 record_unwind_current_buffer ();
9301 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9303 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9304 goto replay_sequence
;
9308 /* Expand mode-line and scroll-bar events into two events:
9309 use posn as a fake prefix key. */
9311 && (NILP (fake_prefixed_keys
)
9312 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9314 if (bufsize
- t
<= 1)
9315 error ("Key sequence too long");
9318 keybuf
[t
+ 1] = key
;
9321 /* Record that a fake prefix key has been generated
9322 for KEY. Don't modify the event; this would
9323 prevent proper action when the event is pushed
9324 back into unread-command-events. */
9325 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9329 else if (CONSP (XCDR (key
))
9330 && CONSP (EVENT_START (key
))
9331 && CONSP (XCDR (EVENT_START (key
))))
9335 posn
= POSN_POSN (EVENT_START (key
));
9336 /* Handle menu-bar events:
9337 insert the dummy prefix event `menu-bar'. */
9338 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9340 if (bufsize
- t
<= 1)
9341 error ("Key sequence too long");
9343 keybuf
[t
+ 1] = key
;
9345 /* Zap the position in key, so we know that we've
9346 expanded it, and don't try to do so again. */
9347 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9350 goto replay_sequence
;
9352 else if (CONSP (posn
))
9354 /* We're looking at the second event of a
9355 sequence which we expanded before. Set
9356 last_real_key_start appropriately. */
9357 if (last_real_key_start
== t
&& t
> 0)
9358 last_real_key_start
= t
- 1;
9363 /* We have finally decided that KEY is something we might want
9365 new_binding
= follow_key (current_binding
, key
);
9367 /* If KEY wasn't bound, we'll try some fallbacks. */
9368 if (!NILP (new_binding
))
9369 /* This is needed for the following scenario:
9370 event 0: a down-event that gets dropped by calling replay_key.
9371 event 1: some normal prefix like C-h.
9372 After event 0, first_unbound is 0, after event 1 indec.start,
9373 fkey.start, and keytran.start are all 1, so when we see that
9374 C-h is bound, we need to update first_unbound. */
9375 first_unbound
= max (t
+ 1, first_unbound
);
9380 /* Remember the position to put an upper bound on indec.start. */
9381 first_unbound
= min (t
, first_unbound
);
9383 head
= EVENT_HEAD (key
);
9387 Lisp_Object breakdown
;
9390 breakdown
= parse_modifiers (head
);
9391 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9392 /* Attempt to reduce an unbound mouse event to a simpler
9393 event that is bound:
9394 Drags reduce to clicks.
9395 Double-clicks reduce to clicks.
9396 Triple-clicks reduce to double-clicks, then to clicks.
9397 Up/Down-clicks are eliminated.
9398 Double-downs reduce to downs, then are eliminated.
9399 Triple-downs reduce to double-downs, then to downs,
9400 then are eliminated. */
9401 if (modifiers
& (up_modifier
| down_modifier
9403 | double_modifier
| triple_modifier
))
9405 while (modifiers
& (up_modifier
| down_modifier
9407 | double_modifier
| triple_modifier
))
9409 Lisp_Object new_head
, new_click
;
9410 if (modifiers
& triple_modifier
)
9411 modifiers
^= (double_modifier
| triple_modifier
);
9412 else if (modifiers
& double_modifier
)
9413 modifiers
&= ~double_modifier
;
9414 else if (modifiers
& drag_modifier
)
9415 modifiers
&= ~drag_modifier
;
9418 /* Dispose of this `up/down' event by simply jumping
9419 back to replay_key, to get another event.
9421 Note that if this event came from mock input,
9422 then just jumping back to replay_key will just
9423 hand it to us again. So we have to wipe out any
9426 We could delete keybuf[t] and shift everything
9427 after that to the left by one spot, but we'd also
9428 have to fix up any variable that points into
9429 keybuf, and shifting isn't really necessary
9432 Adding prefixes for non-textual mouse clicks
9433 creates two characters of mock input, and both
9434 must be thrown away. If we're only looking at
9435 the prefix now, we can just jump back to
9436 replay_key. On the other hand, if we've already
9437 processed the prefix, and now the actual click
9438 itself is giving us trouble, then we've lost the
9439 state of the keymaps we want to backtrack to, and
9440 we need to replay the whole sequence to rebuild
9443 Beyond that, only function key expansion could
9444 create more than two keys, but that should never
9445 generate mouse events, so it's okay to zero
9446 mock_input in that case too.
9448 FIXME: The above paragraph seems just plain
9449 wrong, if you consider things like
9450 xterm-mouse-mode. -stef
9452 Isn't this just the most wonderful code ever? */
9454 /* If mock_input > t + 1, the above simplification
9455 will actually end up dropping keys on the floor.
9456 This is probably OK for now, but even
9457 if mock_input <= t + 1, we need to adjust indec,
9459 Typical case [header-line down-mouse-N]:
9460 mock_input = 2, t = 1, fkey.end = 1,
9461 last_real_key_start = 0. */
9462 if (indec
.end
> last_real_key_start
)
9464 indec
.end
= indec
.start
9465 = min (last_real_key_start
, indec
.start
);
9466 indec
.map
= indec
.parent
;
9467 if (fkey
.end
> last_real_key_start
)
9469 fkey
.end
= fkey
.start
9470 = min (last_real_key_start
, fkey
.start
);
9471 fkey
.map
= fkey
.parent
;
9472 if (keytran
.end
> last_real_key_start
)
9474 keytran
.end
= keytran
.start
9475 = min (last_real_key_start
, keytran
.start
);
9476 keytran
.map
= keytran
.parent
;
9480 if (t
== last_real_key_start
)
9487 mock_input
= last_real_key_start
;
9488 goto replay_sequence
;
9493 = apply_modifiers (modifiers
, XCAR (breakdown
));
9494 new_click
= list2 (new_head
, EVENT_START (key
));
9496 /* Look for a binding for this new key. */
9497 new_binding
= follow_key (current_binding
, new_click
);
9499 /* If that click is bound, go for it. */
9500 if (!NILP (new_binding
))
9502 current_binding
= new_binding
;
9506 /* Otherwise, we'll leave key set to the drag event. */
9511 current_binding
= new_binding
;
9514 /* Normally, last_nonmenu_event gets the previous key we read.
9515 But when a mouse popup menu is being used,
9516 we don't update last_nonmenu_event; it continues to hold the mouse
9517 event that preceded the first level of menu. */
9518 if (!used_mouse_menu
)
9519 last_nonmenu_event
= key
;
9521 /* Record what part of this_command_keys is the current key sequence. */
9522 this_single_command_key_start
= this_command_key_count
- t
;
9523 /* When 'input-method-function' called above causes events to be
9524 put on 'unread-post-input-method-events', and as result
9525 'reread' is set to 'true', the value of 't' can become larger
9526 than 'this_command_key_count', because 'add_command_key' is
9527 not called to update 'this_command_key_count'. If this
9528 happens, 'this_single_command_key_start' will become negative
9529 above, and any call to 'this-single-command-keys' will return
9530 a garbled vector. See bug #20223 for one such situation.
9531 Here we force 'this_single_command_key_start' to never become
9532 negative, to avoid that. */
9533 if (this_single_command_key_start
< 0)
9534 this_single_command_key_start
= 0;
9536 /* Look for this sequence in input-decode-map.
9537 Scan from indec.end until we find a bound suffix. */
9538 while (indec
.end
< t
)
9543 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9547 mock_input
= diff
+ max (t
, mock_input
);
9548 goto replay_sequence
;
9552 if (!KEYMAPP (current_binding
)
9553 && !test_undefined (current_binding
)
9554 && indec
.start
>= t
)
9555 /* There is a binding and it's not a prefix.
9556 (and it doesn't have any input-decode-map translation pending).
9557 There is thus no function-key in this sequence.
9558 Moving fkey.start is important in this case to allow keytran.start
9559 to go over the sequence before we return (since we keep the
9560 invariant that keytran.end <= fkey.start). */
9563 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9566 /* If the sequence is unbound, see if we can hang a function key
9567 off the end of it. */
9568 /* Continue scan from fkey.end until we find a bound suffix. */
9569 while (fkey
.end
< indec
.start
)
9574 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9575 max (t
, mock_input
),
9576 /* If there's a binding (i.e.
9577 first_binding >= nmaps) we don't want
9578 to apply this function-key-mapping. */
9580 && (test_undefined (current_binding
)),
9584 mock_input
= diff
+ max (t
, mock_input
);
9585 /* Adjust the input-decode-map counters. */
9587 indec
.start
+= diff
;
9589 goto replay_sequence
;
9593 /* Look for this sequence in key-translation-map.
9594 Scan from keytran.end until we find a bound suffix. */
9595 while (keytran
.end
< fkey
.start
)
9600 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9604 mock_input
= diff
+ max (t
, mock_input
);
9605 /* Adjust the function-key-map and input-decode-map counters. */
9607 indec
.start
+= diff
;
9611 goto replay_sequence
;
9615 /* If KEY is not defined in any of the keymaps,
9616 and cannot be part of a function key or translation,
9617 and is an upper case letter
9618 use the corresponding lower-case letter instead. */
9619 if (NILP (current_binding
)
9620 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9622 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9623 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9624 || (XINT (key
) & shift_modifier
)))
9626 Lisp_Object new_key
;
9628 original_uppercase
= key
;
9629 original_uppercase_position
= t
- 1;
9631 if (XINT (key
) & shift_modifier
)
9632 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9634 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9635 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9637 /* We have to do this unconditionally, regardless of whether
9638 the lower-case char is defined in the keymaps, because they
9639 might get translated through function-key-map. */
9640 keybuf
[t
- 1] = new_key
;
9641 mock_input
= max (t
, mock_input
);
9642 shift_translated
= true;
9644 goto replay_sequence
;
9647 if (NILP (current_binding
)
9648 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9650 read_key_sequence_cmd
= Vprefix_help_command
;
9651 /* The Microsoft C compiler can't handle the goto that
9657 /* If KEY is not defined in any of the keymaps,
9658 and cannot be part of a function key or translation,
9659 and is a shifted function key,
9660 use the corresponding unshifted function key instead. */
9661 if (NILP (current_binding
)
9662 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9664 Lisp_Object breakdown
= parse_modifiers (key
);
9666 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9668 if (modifiers
& shift_modifier
9669 /* Treat uppercase keys as shifted. */
9671 && (KEY_TO_CHAR (key
)
9672 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9673 && uppercasep (KEY_TO_CHAR (key
))))
9676 = (modifiers
& shift_modifier
9677 ? apply_modifiers (modifiers
& ~shift_modifier
,
9679 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9681 original_uppercase
= key
;
9682 original_uppercase_position
= t
- 1;
9684 /* We have to do this unconditionally, regardless of whether
9685 the lower-case char is defined in the keymaps, because they
9686 might get translated through function-key-map. */
9687 keybuf
[t
- 1] = new_key
;
9688 mock_input
= max (t
, mock_input
);
9689 /* Reset fkey (and consequently keytran) to apply
9690 function-key-map on the result, so that S-backspace is
9691 correctly mapped to DEL (via backspace). OTOH,
9692 input-decode-map doesn't need to go through it again. */
9693 fkey
.start
= fkey
.end
= 0;
9694 keytran
.start
= keytran
.end
= 0;
9695 shift_translated
= true;
9697 goto replay_sequence
;
9702 read_key_sequence_cmd
= current_binding
;
9703 read_key_sequence_remapped
9704 /* Remap command through active keymaps.
9705 Do the remapping here, before the unbind_to so it uses the keymaps
9706 of the appropriate buffer. */
9707 = SYMBOLP (read_key_sequence_cmd
)
9708 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9711 unread_switch_frame
= delayed_switch_frame
;
9712 unbind_to (count
, Qnil
);
9714 /* Don't downcase the last character if the caller says don't.
9715 Don't downcase it if the result is undefined, either. */
9716 if ((dont_downcase_last
|| NILP (current_binding
))
9718 && t
- 1 == original_uppercase_position
)
9720 keybuf
[t
- 1] = original_uppercase
;
9721 shift_translated
= false;
9724 if (shift_translated
)
9725 Vthis_command_keys_shift_translated
= Qt
;
9727 /* Occasionally we fabricate events, perhaps by expanding something
9728 according to function-key-map, or by adding a prefix symbol to a
9729 mouse click in the scroll bar or modeline. In this cases, return
9730 the entire generated key sequence, even if we hit an unbound
9731 prefix or a definition before the end. This means that you will
9732 be able to push back the event properly, and also means that
9733 read-key-sequence will always return a logical unit.
9736 for (; t
< mock_input
; t
++)
9737 add_command_key (keybuf
[t
]);
9744 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9745 Lisp_Object dont_downcase_last
,
9746 Lisp_Object can_return_switch_frame
,
9747 Lisp_Object cmd_loop
, bool allow_string
)
9749 Lisp_Object keybuf
[30];
9751 ptrdiff_t count
= SPECPDL_INDEX ();
9754 CHECK_STRING (prompt
);
9757 specbind (Qinput_method_exit_on_first_char
,
9758 (NILP (cmd_loop
) ? Qt
: Qnil
));
9759 specbind (Qinput_method_use_echo_area
,
9760 (NILP (cmd_loop
) ? Qt
: Qnil
));
9762 if (NILP (continue_echo
))
9764 this_command_key_count
= 0;
9765 this_single_command_key_start
= 0;
9768 #ifdef HAVE_WINDOW_SYSTEM
9769 if (display_hourglass_p
)
9770 cancel_hourglass ();
9773 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9774 prompt
, ! NILP (dont_downcase_last
),
9775 ! NILP (can_return_switch_frame
), 0, 0);
9777 #if 0 /* The following is fine for code reading a key sequence and
9778 then proceeding with a lengthy computation, but it's not good
9779 for code reading keys in a loop, like an input method. */
9780 #ifdef HAVE_WINDOW_SYSTEM
9781 if (display_hourglass_p
)
9792 return unbind_to (count
,
9793 ((allow_string
? make_event_array
: Fvector
)
9797 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9798 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9799 The sequence is sufficient to specify a non-prefix command in the
9800 current local and global maps.
9802 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9803 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9804 as a continuation of the previous key.
9806 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9807 convert the last event to lower case. (Normally any upper case event
9808 is converted to lower case if the original event is undefined and the lower
9809 case equivalent is defined.) A non-nil value is appropriate for reading
9810 a key sequence to be defined.
9812 A C-g typed while in this function is treated like any other character,
9813 and `quit-flag' is not set.
9815 If the key sequence starts with a mouse click, then the sequence is read
9816 using the keymaps of the buffer of the window clicked in, not the buffer
9817 of the selected window as normal.
9819 `read-key-sequence' drops unbound button-down events, since you normally
9820 only care about the click or drag events which follow them. If a drag
9821 or multi-click event is unbound, but the corresponding click event would
9822 be bound, `read-key-sequence' turns the event into a click event at the
9823 drag's starting position. This means that you don't have to distinguish
9824 between click and drag, double, or triple events unless you want to.
9826 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9827 lines separating windows, and scroll bars with imaginary keys
9828 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9830 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9831 function will process a switch-frame event if the user switches frames
9832 before typing anything. If the user switches frames in the middle of a
9833 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9834 is nil, then the event will be put off until after the current key sequence.
9836 `read-key-sequence' checks `function-key-map' for function key
9837 sequences, where they wouldn't conflict with ordinary bindings. See
9838 `function-key-map' for more details.
9840 The optional fifth argument CMD-LOOP, if non-nil, means
9841 that this key sequence is being read by something that will
9842 read commands one after another. It should be nil if the caller
9843 will read just one key sequence. */)
9844 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9846 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9847 can_return_switch_frame
, cmd_loop
, true);
9850 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9851 Sread_key_sequence_vector
, 1, 5, 0,
9852 doc
: /* Like `read-key-sequence' but always return a vector. */)
9853 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9855 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9856 can_return_switch_frame
, cmd_loop
, false);
9859 /* Return true if input events are pending. */
9862 detect_input_pending (void)
9864 return input_pending
|| get_input_pending (0);
9867 /* Return true if input events other than mouse movements are
9871 detect_input_pending_ignore_squeezables (void)
9873 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9876 /* Return true if input events are pending, and run any pending timers. */
9879 detect_input_pending_run_timers (bool do_display
)
9881 unsigned old_timers_run
= timers_run
;
9884 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9886 if (old_timers_run
!= timers_run
&& do_display
)
9887 redisplay_preserve_echo_area (8);
9889 return input_pending
;
9892 /* This is called in some cases before a possible quit.
9893 It cases the next call to detect_input_pending to recompute input_pending.
9894 So calling this function unnecessarily can't do any harm. */
9897 clear_input_pending (void)
9899 input_pending
= false;
9902 /* Return true if there are pending requeued events.
9903 This isn't used yet. The hope is to make wait_reading_process_output
9904 call it, and return if it runs Lisp code that unreads something.
9905 The problem is, kbd_buffer_get_event needs to be fixed to know what
9906 to do in that case. It isn't trivial. */
9909 requeued_events_pending_p (void)
9911 return (CONSP (Vunread_command_events
));
9914 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9915 doc
: /* Return t if command input is currently available with no wait.
9916 Actually, the value is nil only if we can be sure that no input is available;
9917 if there is a doubt, the value is t.
9919 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9920 (Lisp_Object check_timers
)
9922 if (CONSP (Vunread_command_events
)
9923 || !NILP (Vunread_post_input_method_events
)
9924 || !NILP (Vunread_input_method_events
))
9927 /* Process non-user-visible events (Bug#10195). */
9928 process_special_events ();
9930 return (get_input_pending ((NILP (check_timers
)
9931 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9932 | READABLE_EVENTS_FILTER_EVENTS
)
9936 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
9937 doc
: /* Return vector of last few events, not counting those from keyboard macros.
9938 If INCLUDE-CMDS is non-nil, include the commands that were run,
9939 represented as events of the form (nil . COMMAND). */)
9940 (Lisp_Object include_cmds
)
9942 bool cmds
= !NILP (include_cmds
);
9945 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
9946 return Fvector (total_keys
,
9947 XVECTOR (recent_keys
)->contents
);
9950 Lisp_Object es
= Qnil
;
9951 int i
= (total_keys
< NUM_RECENT_KEYS
9952 ? 0 : recent_keys_index
);
9953 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
9956 Lisp_Object e
= AREF (recent_keys
, i
);
9957 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
9959 if (++i
>= NUM_RECENT_KEYS
)
9961 } while (i
!= recent_keys_index
);
9962 es
= Fnreverse (es
);
9963 return Fvconcat (1, &es
);
9967 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9968 doc
: /* Return the key sequence that invoked this command.
9969 However, if the command has called `read-key-sequence', it returns
9970 the last key sequence that has been read.
9971 The value is a string or a vector.
9973 See also `this-command-keys-vector'. */)
9976 return make_event_array (this_command_key_count
,
9977 XVECTOR (this_command_keys
)->contents
);
9980 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9981 doc
: /* Return the key sequence that invoked this command, as a vector.
9982 However, if the command has called `read-key-sequence', it returns
9983 the last key sequence that has been read.
9985 See also `this-command-keys'. */)
9988 return Fvector (this_command_key_count
,
9989 XVECTOR (this_command_keys
)->contents
);
9992 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9993 Sthis_single_command_keys
, 0, 0, 0,
9994 doc
: /* Return the key sequence that invoked this command.
9995 More generally, it returns the last key sequence read, either by
9996 the command loop or by `read-key-sequence'.
9997 Unlike `this-command-keys', this function's value
9998 does not include prefix arguments.
9999 The value is always a vector. */)
10002 return Fvector (this_command_key_count
10003 - this_single_command_key_start
,
10004 (XVECTOR (this_command_keys
)->contents
10005 + this_single_command_key_start
));
10008 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10009 Sthis_single_command_raw_keys
, 0, 0, 0,
10010 doc
: /* Return the raw events that were read for this command.
10011 More generally, it returns the last key sequence read, either by
10012 the command loop or by `read-key-sequence'.
10013 Unlike `this-single-command-keys', this function's value
10014 shows the events before all translations (except for input methods).
10015 The value is always a vector. */)
10018 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10021 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10022 Sclear_this_command_keys
, 0, 1, 0,
10023 doc
: /* Clear out the vector that `this-command-keys' returns.
10024 Also clear the record of the last 100 events, unless optional arg
10025 KEEP-RECORD is non-nil. */)
10026 (Lisp_Object keep_record
)
10030 this_command_key_count
= 0;
10032 if (NILP (keep_record
))
10034 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10035 ASET (recent_keys
, i
, Qnil
);
10037 recent_keys_index
= 0;
10042 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10043 doc
: /* Return the current depth in recursive edits. */)
10047 /* Wrap around reliably on integer overflow. */
10048 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10049 XSETINT (temp
, sum
);
10053 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10054 "FOpen dribble file: ",
10055 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10056 If FILE is nil, close any open dribble file.
10057 The file will be closed when Emacs exits.
10059 Be aware that this records ALL characters you type!
10060 This may include sensitive information such as passwords. */)
10073 Lisp_Object encfile
;
10075 file
= Fexpand_file_name (file
, Qnil
);
10076 encfile
= ENCODE_FILE (file
);
10077 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10078 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10079 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10080 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10082 report_file_error ("Opening dribble", file
);
10087 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10088 doc
: /* Discard the contents of the terminal input buffer.
10089 Also end any kbd macro being defined. */)
10092 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10094 /* Discard the last command from the macro. */
10095 Fcancel_kbd_macro_events ();
10099 Vunread_command_events
= Qnil
;
10101 discard_tty_input ();
10103 kbd_fetch_ptr
= kbd_store_ptr
;
10104 input_pending
= false;
10109 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10110 doc
: /* Stop Emacs and return to superior process. You can resume later.
10111 If `cannot-suspend' is non-nil, or if the system doesn't support job
10112 control, run a subshell instead.
10114 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10115 to be read as terminal input by Emacs's parent, after suspension.
10117 Before suspending, run the normal hook `suspend-hook'.
10118 After resumption run the normal hook `suspend-resume-hook'.
10120 Some operating systems cannot stop the Emacs process and resume it later.
10121 On such systems, Emacs starts a subshell instead of suspending. */)
10122 (Lisp_Object stuffstring
)
10124 ptrdiff_t count
= SPECPDL_INDEX ();
10125 int old_height
, old_width
;
10128 if (tty_list
&& tty_list
->next
)
10129 error ("There are other tty frames open; close them before suspending Emacs");
10131 if (!NILP (stuffstring
))
10132 CHECK_STRING (stuffstring
);
10134 run_hook (intern ("suspend-hook"));
10136 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10137 reset_all_sys_modes ();
10138 /* sys_suspend can get an error if it tries to fork a subshell
10139 and the system resources aren't available for that. */
10140 record_unwind_protect_void (init_all_sys_modes
);
10141 stuff_buffered_input (stuffstring
);
10142 if (cannot_suspend
)
10146 unbind_to (count
, Qnil
);
10148 /* Check if terminal/window size has changed.
10149 Note that this is not useful when we are running directly
10150 with a window system; but suspend should be disabled in that case. */
10151 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10152 if (width
!= old_width
|| height
!= old_height
)
10153 change_frame_size (SELECTED_FRAME (), width
,
10154 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10157 run_hook (intern ("suspend-resume-hook"));
10162 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10163 Then in any case stuff anything Emacs has read ahead and not used. */
10166 stuff_buffered_input (Lisp_Object stuffstring
)
10168 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10169 register unsigned char *p
;
10171 if (STRINGP (stuffstring
))
10173 register ptrdiff_t count
;
10175 p
= SDATA (stuffstring
);
10176 count
= SBYTES (stuffstring
);
10177 while (count
-- > 0)
10182 /* Anything we have read ahead, put back for the shell to read. */
10183 /* ?? What should this do when we have multiple keyboards??
10184 Should we ignore anything that was typed in at the "wrong" kboard?
10186 rms: we should stuff everything back into the kboard
10188 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10191 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10192 kbd_fetch_ptr
= kbd_buffer
;
10193 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10194 stuff_char (kbd_fetch_ptr
->ie
.code
);
10196 clear_event (kbd_fetch_ptr
);
10199 input_pending
= false;
10200 #endif /* SIGTSTP */
10204 set_waiting_for_input (struct timespec
*time_to_clear
)
10206 input_available_clear_time
= time_to_clear
;
10208 /* Tell handle_interrupt to throw back to read_char, */
10209 waiting_for_input
= true;
10211 /* If handle_interrupt was called before and buffered a C-g,
10212 make it run again now, to avoid timing error. */
10213 if (!NILP (Vquit_flag
))
10214 quit_throw_to_read_char (0);
10218 clear_waiting_for_input (void)
10220 /* Tell handle_interrupt not to throw back to read_char, */
10221 waiting_for_input
= false;
10222 input_available_clear_time
= 0;
10225 /* The SIGINT handler.
10227 If we have a frame on the controlling tty, we assume that the
10228 SIGINT was generated by C-g, so we call handle_interrupt.
10229 Otherwise, tell QUIT to kill Emacs. */
10232 handle_interrupt_signal (int sig
)
10234 /* See if we have an active terminal on our controlling tty. */
10235 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10238 /* If there are no frames there, let's pretend that we are a
10239 well-behaving UN*X program and quit. We must not call Lisp
10240 in a signal handler, so tell QUIT to exit when it is
10242 Vquit_flag
= Qkill_emacs
;
10246 /* Otherwise, the SIGINT was probably generated by C-g. */
10248 /* Set internal_last_event_frame to the top frame of the
10249 controlling tty, if we have a frame there. We disable the
10250 interrupt key on secondary ttys, so the SIGINT must have come
10251 from the controlling tty. */
10252 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10254 handle_interrupt (1);
10259 deliver_interrupt_signal (int sig
)
10261 deliver_process_signal (sig
, handle_interrupt_signal
);
10264 /* Output MSG directly to standard output, without buffering. Ignore
10265 failures. This is safe in a signal handler. */
10267 write_stdout (char const *msg
)
10269 ignore_value (write (STDOUT_FILENO
, msg
, strlen (msg
)));
10272 /* Read a byte from stdin, without buffering. Safe in signal handlers. */
10277 return read (STDIN_FILENO
, &c
, 1) == 1 ? c
: EOF
;
10280 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10281 of the number of times C-g has been requested. If C-g is pressed
10282 enough times, then quit anyway. See bug#6585. */
10283 static int volatile force_quit_count
;
10285 /* This routine is called at interrupt level in response to C-g.
10287 It is called from the SIGINT handler or kbd_buffer_store_event.
10289 If `waiting_for_input' is non zero, then unless `echoing' is
10290 nonzero, immediately throw back to read_char.
10292 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10293 eval to throw, when it gets a chance. If quit-flag is already
10294 non-nil, it stops the job right away. */
10297 handle_interrupt (bool in_signal_handler
)
10303 /* XXX This code needs to be revised for multi-tty support. */
10304 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10306 if (! in_signal_handler
)
10308 /* If SIGINT isn't blocked, don't let us be interrupted by
10309 a SIGINT. It might be harmful due to non-reentrancy
10310 in I/O functions. */
10312 sigemptyset (&blocked
);
10313 sigaddset (&blocked
, SIGINT
);
10314 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10318 reset_all_sys_modes ();
10322 * On systems which can suspend the current process and return to the original
10323 * shell, this command causes the user to end up back at the shell.
10324 * The "Auto-save" and "Abort" questions are not asked until
10325 * the user elects to return to emacs, at which point he can save the current
10326 * job and either dump core or continue.
10330 /* Perhaps should really fork an inferior shell?
10331 But that would not provide any way to get back
10332 to the original shell, ever. */
10333 write_stdout ("No support for stopping a process"
10334 " on this operating system;\n"
10335 "you can continue or abort.\n");
10336 #endif /* not SIGTSTP */
10338 /* We must remain inside the screen area when the internal terminal
10339 is used. Note that [Enter] is not echoed by dos. */
10340 cursor_to (SELECTED_FRAME (), 0, 0);
10343 write_stdout ("Emacs is resuming after an emergency escape.\n");
10345 /* It doesn't work to autosave while GC is in progress;
10346 the code used for auto-saving doesn't cope with the mark bit. */
10347 if (!gc_in_progress
)
10349 write_stdout ("Auto-save? (y or n) ");
10351 if (c
== 'y' || c
== 'Y')
10353 Fdo_auto_save (Qt
, Qnil
);
10355 write_stdout ("\r\nAuto-save done");
10357 write_stdout ("Auto-save done\n");
10365 /* During GC, it must be safe to reenable quitting again. */
10366 Vinhibit_quit
= Qnil
;
10372 "Garbage collection in progress; cannot auto-save now\r\n"
10373 "but will instead do a real quit"
10374 " after garbage collection ends\r\n");
10378 write_stdout ("\r\nAbort? (y or n) ");
10380 write_stdout ("Abort (and dump core)? (y or n) ");
10383 if (c
== 'y' || c
== 'Y')
10388 write_stdout ("\r\nContinuing...\r\n");
10389 #else /* not MSDOS */
10390 write_stdout ("Continuing...\n");
10391 #endif /* not MSDOS */
10392 init_all_sys_modes ();
10396 /* If executing a function that wants to be interrupted out of
10397 and the user has not deferred quitting by binding `inhibit-quit'
10398 then quit right away. */
10399 if (immediate_quit
&& NILP (Vinhibit_quit
))
10401 struct gl_state_s saved
;
10403 immediate_quit
= false;
10404 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10406 Fsignal (Qquit
, Qnil
);
10410 { /* Else request quit when it's safe. */
10411 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10412 force_quit_count
= count
;
10415 immediate_quit
= true;
10416 Vinhibit_quit
= Qnil
;
10422 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10424 /* TODO: The longjmp in this call throws the NS event loop integration off,
10425 and it seems to do fine without this. Probably some attention
10426 needs to be paid to the setting of waiting_for_input in
10427 wait_reading_process_output() under HAVE_NS because of the call
10428 to ns_select there (needed because otherwise events aren't picked up
10429 outside of polling since we don't get SIGIO like X and we don't have a
10430 separate event loop thread like W32. */
10432 if (waiting_for_input
&& !echoing
)
10433 quit_throw_to_read_char (in_signal_handler
);
10437 /* Handle a C-g by making read_char return C-g. */
10440 quit_throw_to_read_char (bool from_signal
)
10442 /* When not called from a signal handler it is safe to call
10444 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10445 Fkill_emacs (Qnil
);
10447 /* Prevent another signal from doing this before we finish. */
10448 clear_waiting_for_input ();
10449 input_pending
= false;
10451 Vunread_command_events
= Qnil
;
10453 if (FRAMEP (internal_last_event_frame
)
10454 && !EQ (internal_last_event_frame
, selected_frame
))
10455 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10458 sys_longjmp (getcjmp
, 1);
10461 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10462 Sset_input_interrupt_mode
, 1, 1, 0,
10463 doc
: /* Set interrupt mode of reading keyboard input.
10464 If INTERRUPT is non-nil, Emacs will use input interrupts;
10465 otherwise Emacs uses CBREAK mode.
10467 See also `current-input-mode'. */)
10468 (Lisp_Object interrupt
)
10470 bool new_interrupt_input
;
10471 #ifdef USABLE_SIGIO
10472 #ifdef HAVE_X_WINDOWS
10473 if (x_display_list
!= NULL
)
10475 /* When using X, don't give the user a real choice,
10476 because we haven't implemented the mechanisms to support it. */
10477 new_interrupt_input
= true;
10480 #endif /* HAVE_X_WINDOWS */
10481 new_interrupt_input
= !NILP (interrupt
);
10482 #else /* not USABLE_SIGIO */
10483 new_interrupt_input
= false;
10484 #endif /* not USABLE_SIGIO */
10486 if (new_interrupt_input
!= interrupt_input
)
10488 #ifdef POLL_FOR_INPUT
10492 /* this causes startup screen to be restored and messes with the mouse */
10493 reset_all_sys_modes ();
10494 interrupt_input
= new_interrupt_input
;
10495 init_all_sys_modes ();
10497 interrupt_input
= new_interrupt_input
;
10500 #ifdef POLL_FOR_INPUT
10501 poll_suppress_count
= 1;
10508 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10509 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10510 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10511 C-q in key sequences.
10513 This setting only has an effect on tty terminals and only when
10514 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10516 See also `current-input-mode'. */)
10517 (Lisp_Object flow
, Lisp_Object terminal
)
10519 struct terminal
*t
= decode_tty_terminal (terminal
);
10520 struct tty_display_info
*tty
;
10524 tty
= t
->display_info
.tty
;
10526 if (tty
->flow_control
!= !NILP (flow
))
10529 /* This causes startup screen to be restored and messes with the mouse. */
10530 reset_sys_modes (tty
);
10533 tty
->flow_control
= !NILP (flow
);
10536 init_sys_modes (tty
);
10542 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10543 doc
: /* Enable or disable 8-bit input on TERMINAL.
10544 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10545 bit as the Meta modifier.
10547 If META is nil, Emacs will ignore the top bit, on the assumption it is
10550 Otherwise, Emacs will accept and pass through 8-bit input without
10551 specially interpreting the top bit.
10553 This setting only has an effect on tty terminal devices.
10555 Optional parameter TERMINAL specifies the tty terminal device to use.
10556 It may be a terminal object, a frame, or nil for the terminal used by
10557 the currently selected frame.
10559 See also `current-input-mode'. */)
10560 (Lisp_Object meta
, Lisp_Object terminal
)
10562 struct terminal
*t
= decode_tty_terminal (terminal
);
10563 struct tty_display_info
*tty
;
10568 tty
= t
->display_info
.tty
;
10572 else if (EQ (meta
, Qt
))
10577 if (tty
->meta_key
!= new_meta
)
10580 /* this causes startup screen to be restored and messes with the mouse */
10581 reset_sys_modes (tty
);
10584 tty
->meta_key
= new_meta
;
10587 init_sys_modes (tty
);
10593 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10594 doc
: /* Specify character used for quitting.
10595 QUIT must be an ASCII character.
10597 This function only has an effect on the controlling tty of the Emacs
10600 See also `current-input-mode'. */)
10603 struct terminal
*t
= get_named_terminal ("/dev/tty");
10604 struct tty_display_info
*tty
;
10608 tty
= t
->display_info
.tty
;
10610 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10611 error ("QUIT must be an ASCII character");
10614 /* this causes startup screen to be restored and messes with the mouse */
10615 reset_sys_modes (tty
);
10618 /* Don't let this value be out of range. */
10619 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10622 init_sys_modes (tty
);
10628 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10629 doc
: /* Set mode of reading keyboard input.
10630 First arg INTERRUPT non-nil means use input interrupts;
10631 nil means use CBREAK mode.
10632 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10633 (no effect except in CBREAK mode).
10634 Third arg META t means accept 8-bit input (for a Meta key).
10635 META nil means ignore the top bit, on the assumption it is parity.
10636 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10637 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10638 See also `current-input-mode'. */)
10639 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10641 Fset_input_interrupt_mode (interrupt
);
10642 Fset_output_flow_control (flow
, Qnil
);
10643 Fset_input_meta_mode (meta
, Qnil
);
10645 Fset_quit_char (quit
);
10649 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10650 doc
: /* Return information about the way Emacs currently reads keyboard input.
10651 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10652 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10653 nil, Emacs is using CBREAK mode.
10654 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10655 terminal; this does not apply if Emacs uses interrupt-driven input.
10656 META is t if accepting 8-bit input with 8th bit as Meta flag.
10657 META nil means ignoring the top bit, on the assumption it is parity.
10658 META is neither t nor nil if accepting 8-bit input and using
10659 all 8 bits as the character code.
10660 QUIT is the character Emacs currently uses to quit.
10661 The elements of this list correspond to the arguments of
10662 `set-input-mode'. */)
10665 struct frame
*sf
= XFRAME (selected_frame
);
10667 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10668 Lisp_Object flow
, meta
;
10669 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10671 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10672 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10674 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10681 Lisp_Object quit
= make_number (quit_char
);
10683 return list4 (interrupt
, flow
, meta
, quit
);
10686 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10687 doc
: /* Return position information for pixel coordinates X and Y.
10688 By default, X and Y are relative to text area of the selected window.
10689 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10690 If optional fourth arg WHOLE is non-nil, X is relative to the left
10691 edge of the window.
10693 The return value is similar to a mouse click position:
10694 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10695 IMAGE (DX . DY) (WIDTH . HEIGHT))
10696 The `posn-' functions access elements of such lists. */)
10697 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10700 /* We allow X of -1, for the newline in a R2L line that overflowed
10701 into the left fringe. */
10702 if (XINT (x
) != -1)
10706 if (NILP (frame_or_window
))
10707 frame_or_window
= selected_window
;
10709 if (WINDOWP (frame_or_window
))
10711 struct window
*w
= decode_live_window (frame_or_window
);
10713 XSETINT (x
, (XINT (x
)
10714 + WINDOW_LEFT_EDGE_X (w
)
10716 ? window_box_left_offset (w
, TEXT_AREA
)
10718 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10719 frame_or_window
= w
->frame
;
10722 CHECK_LIVE_FRAME (frame_or_window
);
10724 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10727 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10728 doc
: /* Return position information for buffer POS in WINDOW.
10729 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10731 Return nil if position is not visible in window. Otherwise,
10732 the return value is similar to that returned by `event-start' for
10733 a mouse click at the upper left corner of the glyph corresponding
10734 to the given buffer position:
10735 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10736 IMAGE (DX . DY) (WIDTH . HEIGHT))
10737 The `posn-' functions access elements of such lists. */)
10738 (Lisp_Object pos
, Lisp_Object window
)
10743 window
= selected_window
;
10745 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10748 Lisp_Object x
= XCAR (tem
);
10749 Lisp_Object y
= XCAR (XCDR (tem
));
10751 /* Point invisible due to hscrolling? X can be -1 when a
10752 newline in a R2L line overflows into the left fringe. */
10755 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10761 /* Set up a new kboard object with reasonable initial values.
10762 TYPE is a window system for which this keyboard is used. */
10765 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10767 kset_overriding_terminal_local_map (kb
, Qnil
);
10768 kset_last_command (kb
, Qnil
);
10769 kset_real_last_command (kb
, Qnil
);
10770 kset_keyboard_translate_table (kb
, Qnil
);
10771 kset_last_repeatable_command (kb
, Qnil
);
10772 kset_prefix_arg (kb
, Qnil
);
10773 kset_last_prefix_arg (kb
, Qnil
);
10774 kset_kbd_queue (kb
, Qnil
);
10775 kb
->kbd_queue_has_data
= false;
10776 kb
->immediate_echo
= false;
10777 kset_echo_string (kb
, Qnil
);
10778 kset_echo_prompt (kb
, Qnil
);
10779 kb
->kbd_macro_buffer
= 0;
10780 kb
->kbd_macro_bufsize
= 0;
10781 kset_defining_kbd_macro (kb
, Qnil
);
10782 kset_last_kbd_macro (kb
, Qnil
);
10783 kb
->reference_count
= 0;
10784 kset_system_key_alist (kb
, Qnil
);
10785 kset_system_key_syms (kb
, Qnil
);
10786 kset_window_system (kb
, type
);
10787 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10788 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10789 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10790 kset_default_minibuffer_frame (kb
, Qnil
);
10793 /* Allocate and basically initialize keyboard
10794 object to use with window system TYPE. */
10797 allocate_kboard (Lisp_Object type
)
10799 KBOARD
*kb
= xmalloc (sizeof *kb
);
10801 init_kboard (kb
, type
);
10802 kb
->next_kboard
= all_kboards
;
10808 * Destroy the contents of a kboard object, but not the object itself.
10809 * We use this just before deleting it, or if we're going to initialize
10810 * it a second time.
10813 wipe_kboard (KBOARD
*kb
)
10815 xfree (kb
->kbd_macro_buffer
);
10818 /* Free KB and memory referenced from it. */
10821 delete_kboard (KBOARD
*kb
)
10825 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10828 *kbp
= kb
->next_kboard
;
10830 /* Prevent a dangling reference to KB. */
10831 if (kb
== current_kboard
10832 && FRAMEP (selected_frame
)
10833 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10835 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10836 single_kboard
= false;
10837 if (current_kboard
== kb
)
10846 init_keyboard (void)
10848 /* This is correct before outermost invocation of the editor loop. */
10849 command_loop_level
= -1;
10850 immediate_quit
= false;
10851 quit_char
= Ctl ('g');
10852 Vunread_command_events
= Qnil
;
10853 timer_idleness_start_time
= invalid_timespec ();
10855 recent_keys_index
= 0;
10856 kbd_fetch_ptr
= kbd_buffer
;
10857 kbd_store_ptr
= kbd_buffer
;
10858 do_mouse_tracking
= Qnil
;
10859 input_pending
= false;
10860 interrupt_input_blocked
= 0;
10861 pending_signals
= false;
10863 /* This means that command_loop_1 won't try to select anything the first
10865 internal_last_event_frame
= Qnil
;
10866 Vlast_event_frame
= internal_last_event_frame
;
10868 current_kboard
= initial_kboard
;
10869 /* Re-initialize the keyboard again. */
10870 wipe_kboard (current_kboard
);
10871 /* A value of nil for Vwindow_system normally means a tty, but we also use
10872 it for the initial terminal since there is no window system there. */
10873 init_kboard (current_kboard
, Qnil
);
10875 if (!noninteractive
)
10877 /* Before multi-tty support, these handlers used to be installed
10878 only if the current session was a tty session. Now an Emacs
10879 session may have multiple display types, so we always handle
10880 SIGINT. There is special code in handle_interrupt_signal to exit
10881 Emacs on SIGINT when there are no termcap frames on the
10882 controlling terminal. */
10883 struct sigaction action
;
10884 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10885 sigaction (SIGINT
, &action
, 0);
10887 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10888 SIGQUIT and we can't tell which one it will give us. */
10889 sigaction (SIGQUIT
, &action
, 0);
10890 #endif /* not DOS_NT */
10892 #ifdef USABLE_SIGIO
10893 if (!noninteractive
)
10895 struct sigaction action
;
10896 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10897 sigaction (SIGIO
, &action
, 0);
10901 /* Use interrupt input by default, if it works and noninterrupt input
10902 has deficiencies. */
10904 #ifdef INTERRUPT_INPUT
10905 interrupt_input
= 1;
10907 interrupt_input
= 0;
10910 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10913 if (keyboard_init_hook
)
10914 (*keyboard_init_hook
) ();
10916 #ifdef POLL_FOR_INPUT
10918 poll_suppress_count
= 1;
10923 /* This type's only use is in syms_of_keyboard, to put properties on the
10924 event header symbols. */
10931 static const struct event_head head_table
[] = {
10932 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10933 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10935 /* Some of the event heads. */
10936 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
10938 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
10939 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
10940 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
10941 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
10942 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
10943 /* `select-window' should be handled just like `switch-frame'
10944 in read_key_sequence. */
10945 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
10949 syms_of_keyboard (void)
10951 pending_funcalls
= Qnil
;
10952 staticpro (&pending_funcalls
);
10954 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10955 staticpro (&Vlispy_mouse_stem
);
10957 regular_top_level_message
= build_pure_c_string ("Back to top level");
10958 #ifdef HAVE_STACK_OVERFLOW_HANDLING
10959 recover_top_level_message
10960 = build_pure_c_string ("Re-entering top level after C stack overflow");
10962 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
10963 doc
: /* Message displayed by `normal-top-level'. */);
10964 Vinternal__top_level_message
= regular_top_level_message
;
10967 DEFSYM (QCimage
, ":image");
10968 DEFSYM (Qhelp_echo
, "help-echo");
10969 DEFSYM (QCrtl
, ":rtl");
10971 staticpro (&item_properties
);
10972 item_properties
= Qnil
;
10974 staticpro (&tool_bar_item_properties
);
10975 tool_bar_item_properties
= Qnil
;
10976 staticpro (&tool_bar_items_vector
);
10977 tool_bar_items_vector
= Qnil
;
10979 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10981 /* Non-nil disable property on a command means do not execute it;
10982 call disabled-command-function's value instead. */
10983 DEFSYM (Qdisabled
, "disabled");
10985 DEFSYM (Qundefined
, "undefined");
10987 /* Hooks to run before and after each command. */
10988 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10989 DEFSYM (Qpost_command_hook
, "post-command-hook");
10991 DEFSYM (Qundo_auto__add_boundary
, "undo-auto--add-boundary");
10993 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10994 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10995 DEFSYM (Qfunction_key
, "function-key");
10997 /* The values of Qevent_kind properties. */
10998 DEFSYM (Qmouse_click
, "mouse-click");
11000 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11001 DEFSYM (Qsave_session
, "save-session");
11002 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11004 /* Menu and tool bar item parts. */
11005 DEFSYM (Qmenu_enable
, "menu-enable");
11008 DEFSYM (Qlanguage_change
, "language-change");
11009 DEFSYM (Qend_session
, "end-session");
11013 DEFSYM (Qdbus_event
, "dbus-event");
11016 #ifdef HAVE_XWIDGETS
11017 DEFSYM (Qxwidget_event
, "xwidget-event");
11020 #ifdef USE_FILE_NOTIFY
11021 DEFSYM (Qfile_notify
, "file-notify");
11022 #endif /* USE_FILE_NOTIFY */
11024 /* Menu and tool bar item parts. */
11025 DEFSYM (QCenable
, ":enable");
11026 DEFSYM (QCvisible
, ":visible");
11027 DEFSYM (QChelp
, ":help");
11028 DEFSYM (QCfilter
, ":filter");
11029 DEFSYM (QCbutton
, ":button");
11030 DEFSYM (QCkeys
, ":keys");
11031 DEFSYM (QCkey_sequence
, ":key-sequence");
11033 /* Non-nil disable property on a command means
11034 do not execute it; call disabled-command-function's value instead. */
11035 DEFSYM (QCtoggle
, ":toggle");
11036 DEFSYM (QCradio
, ":radio");
11037 DEFSYM (QClabel
, ":label");
11038 DEFSYM (QCvert_only
, ":vert-only");
11040 /* Symbols to use for parts of windows. */
11041 DEFSYM (Qvertical_line
, "vertical-line");
11042 DEFSYM (Qright_divider
, "right-divider");
11043 DEFSYM (Qbottom_divider
, "bottom-divider");
11045 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11047 DEFSYM (Qabove_handle
, "above-handle");
11048 DEFSYM (Qhandle
, "handle");
11049 DEFSYM (Qbelow_handle
, "below-handle");
11050 DEFSYM (Qup
, "up");
11051 DEFSYM (Qdown
, "down");
11052 DEFSYM (Qtop
, "top");
11053 DEFSYM (Qbottom
, "bottom");
11054 DEFSYM (Qend_scroll
, "end-scroll");
11055 DEFSYM (Qratio
, "ratio");
11056 DEFSYM (Qbefore_handle
, "before-handle");
11057 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11058 DEFSYM (Qafter_handle
, "after-handle");
11059 DEFSYM (Qleft
, "left");
11060 DEFSYM (Qright
, "right");
11061 DEFSYM (Qleftmost
, "leftmost");
11062 DEFSYM (Qrightmost
, "rightmost");
11064 /* Properties of event headers. */
11065 DEFSYM (Qevent_kind
, "event-kind");
11066 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11068 /* An event header symbol HEAD may have a property named
11069 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11070 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11071 mask of modifiers applied to it. If present, this is used to help
11072 speed up parse_modifiers. */
11073 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11075 /* An unmodified event header BASE may have a property named
11076 Qmodifier_cache, which is an alist mapping modifier masks onto
11077 modified versions of BASE. If present, this helps speed up
11078 apply_modifiers. */
11079 DEFSYM (Qmodifier_cache
, "modifier-cache");
11081 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11082 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11084 DEFSYM (Qpolling_period
, "polling-period");
11086 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11088 /* The primary selection. */
11089 DEFSYM (QPRIMARY
, "PRIMARY");
11091 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11092 DEFSYM (Qhandle_select_window
, "handle-select-window");
11094 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11095 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11097 DEFSYM (Qhelp_form_show
, "help-form-show");
11099 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11101 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11102 Fset (Qinput_method_use_echo_area
, Qnil
);
11104 /* Symbols to head events. */
11105 DEFSYM (Qmouse_movement
, "mouse-movement");
11106 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11107 DEFSYM (Qswitch_frame
, "switch-frame");
11108 DEFSYM (Qfocus_in
, "focus-in");
11109 DEFSYM (Qfocus_out
, "focus-out");
11110 DEFSYM (Qdelete_frame
, "delete-frame");
11111 DEFSYM (Qiconify_frame
, "iconify-frame");
11112 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11113 DEFSYM (Qselect_window
, "select-window");
11117 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11119 const struct event_head
*p
= &head_table
[i
];
11120 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11121 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11122 Fput (var
, Qevent_kind
, kind
);
11123 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11127 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11128 staticpro (&button_down_location
);
11129 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11130 staticpro (&mouse_syms
);
11131 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11133 staticpro (&wheel_syms
);
11137 int len
= ARRAYELTS (modifier_names
);
11139 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11140 for (i
= 0; i
< len
; i
++)
11141 if (modifier_names
[i
])
11142 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11143 staticpro (&modifier_symbols
);
11146 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11147 staticpro (&recent_keys
);
11149 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11150 staticpro (&this_command_keys
);
11152 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11153 staticpro (&raw_keybuf
);
11155 DEFSYM (Qcommand_execute
, "command-execute");
11156 DEFSYM (Qinternal_echo_keystrokes_prefix
, "internal-echo-keystrokes-prefix");
11158 accent_key_syms
= Qnil
;
11159 staticpro (&accent_key_syms
);
11161 func_key_syms
= Qnil
;
11162 staticpro (&func_key_syms
);
11164 drag_n_drop_syms
= Qnil
;
11165 staticpro (&drag_n_drop_syms
);
11167 unread_switch_frame
= Qnil
;
11168 staticpro (&unread_switch_frame
);
11170 internal_last_event_frame
= Qnil
;
11171 staticpro (&internal_last_event_frame
);
11173 read_key_sequence_cmd
= Qnil
;
11174 staticpro (&read_key_sequence_cmd
);
11175 read_key_sequence_remapped
= Qnil
;
11176 staticpro (&read_key_sequence_remapped
);
11178 menu_bar_one_keymap_changed_items
= Qnil
;
11179 staticpro (&menu_bar_one_keymap_changed_items
);
11181 menu_bar_items_vector
= Qnil
;
11182 staticpro (&menu_bar_items_vector
);
11184 help_form_saved_window_configs
= Qnil
;
11185 staticpro (&help_form_saved_window_configs
);
11187 defsubr (&Scurrent_idle_time
);
11188 defsubr (&Sevent_symbol_parse_modifiers
);
11189 defsubr (&Sevent_convert_list
);
11190 defsubr (&Sread_key_sequence
);
11191 defsubr (&Sread_key_sequence_vector
);
11192 defsubr (&Srecursive_edit
);
11193 defsubr (&Strack_mouse
);
11194 defsubr (&Sinput_pending_p
);
11195 defsubr (&Srecent_keys
);
11196 defsubr (&Sthis_command_keys
);
11197 defsubr (&Sthis_command_keys_vector
);
11198 defsubr (&Sthis_single_command_keys
);
11199 defsubr (&Sthis_single_command_raw_keys
);
11200 defsubr (&Sclear_this_command_keys
);
11201 defsubr (&Ssuspend_emacs
);
11202 defsubr (&Sabort_recursive_edit
);
11203 defsubr (&Sexit_recursive_edit
);
11204 defsubr (&Srecursion_depth
);
11205 defsubr (&Scommand_error_default_function
);
11206 defsubr (&Stop_level
);
11207 defsubr (&Sdiscard_input
);
11208 defsubr (&Sopen_dribble_file
);
11209 defsubr (&Sset_input_interrupt_mode
);
11210 defsubr (&Sset_output_flow_control
);
11211 defsubr (&Sset_input_meta_mode
);
11212 defsubr (&Sset_quit_char
);
11213 defsubr (&Sset_input_mode
);
11214 defsubr (&Scurrent_input_mode
);
11215 defsubr (&Sposn_at_point
);
11216 defsubr (&Sposn_at_x_y
);
11218 DEFVAR_LISP ("last-command-event", last_command_event
,
11219 doc
: /* Last input event that was part of a command. */);
11221 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11222 doc
: /* Last input event in a command, except for mouse menu events.
11223 Mouse menus give back keys that don't look like mouse events;
11224 this variable holds the actual mouse event that led to the menu,
11225 so that you can determine whether the command was run by mouse or not. */);
11227 DEFVAR_LISP ("last-input-event", last_input_event
,
11228 doc
: /* Last input event. */);
11230 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11231 doc
: /* List of events to be read as the command input.
11232 These events are processed first, before actual keyboard input.
11233 Events read from this list are not normally added to `this-command-keys',
11234 as they will already have been added once as they were read for the first time.
11235 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11236 Vunread_command_events
= Qnil
;
11238 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11239 doc
: /* List of events to be processed as input by input methods.
11240 These events are processed before `unread-command-events'
11241 and actual keyboard input, but are not given to `input-method-function'. */);
11242 Vunread_post_input_method_events
= Qnil
;
11244 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11245 doc
: /* List of events to be processed as input by input methods.
11246 These events are processed after `unread-command-events', but
11247 before actual keyboard input.
11248 If there's an active input method, the events are given to
11249 `input-method-function'. */);
11250 Vunread_input_method_events
= Qnil
;
11252 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11253 doc
: /* Meta-prefix character code.
11254 Meta-foo as command input turns into this character followed by foo. */);
11255 XSETINT (meta_prefix_char
, 033);
11257 DEFVAR_KBOARD ("last-command", Vlast_command
,
11258 doc
: /* The last command executed.
11259 Normally a symbol with a function definition, but can be whatever was found
11260 in the keymap, or whatever the variable `this-command' was set to by that
11263 The value `mode-exit' is special; it means that the previous command
11264 read an event that told it to exit, and it did so and unread that event.
11265 In other words, the present command is the event that made the previous
11268 The value `kill-region' is special; it means that the previous command
11269 was a kill command.
11271 `last-command' has a separate binding for each terminal device.
11272 See Info node `(elisp)Multiple Terminals'. */);
11274 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11275 doc
: /* Same as `last-command', but never altered by Lisp code.
11276 Taken from the previous value of `real-this-command'. */);
11278 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11279 doc
: /* Last command that may be repeated.
11280 The last command executed that was not bound to an input event.
11281 This is the command `repeat' will try to repeat.
11282 Taken from a previous value of `real-this-command'. */);
11284 DEFVAR_LISP ("this-command", Vthis_command
,
11285 doc
: /* The command now being executed.
11286 The command can set this variable; whatever is put here
11287 will be in `last-command' during the following command. */);
11288 Vthis_command
= Qnil
;
11290 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11291 doc
: /* This is like `this-command', except that commands should never modify it. */);
11292 Vreal_this_command
= Qnil
;
11294 DEFVAR_LISP ("this-command-keys-shift-translated",
11295 Vthis_command_keys_shift_translated
,
11296 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11297 Shift-translation occurs when there is no binding for the key sequence
11298 as entered, but a binding was found by changing an upper-case letter
11299 to lower-case, or a shifted function key to an unshifted one. */);
11300 Vthis_command_keys_shift_translated
= Qnil
;
11302 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11303 doc
: /* The command bound to the current key sequence before remapping.
11304 It equals `this-command' if the original command was not remapped through
11305 any of the active keymaps. Otherwise, the value of `this-command' is the
11306 result of looking up the original command in the active keymaps. */);
11307 Vthis_original_command
= Qnil
;
11309 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11310 doc
: /* Number of input events between auto-saves.
11311 Zero means disable autosaving due to number of characters typed. */);
11312 auto_save_interval
= 300;
11314 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11315 doc
: /* Number of seconds idle time before auto-save.
11316 Zero or nil means disable auto-saving due to idleness.
11317 After auto-saving due to this many seconds of idle time,
11318 Emacs also does a garbage collection if that seems to be warranted. */);
11319 XSETFASTINT (Vauto_save_timeout
, 30);
11321 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11322 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11323 The value may be integer or floating point.
11324 If the value is zero, don't echo at all. */);
11325 Vecho_keystrokes
= make_number (1);
11327 DEFVAR_INT ("polling-period", polling_period
,
11328 doc
: /* Interval between polling for input during Lisp execution.
11329 The reason for polling is to make C-g work to stop a running program.
11330 Polling is needed only when using X windows and SIGIO does not work.
11331 Polling is automatically disabled in all other cases. */);
11332 polling_period
= 2;
11334 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11335 doc
: /* Maximum time between mouse clicks to make a double-click.
11336 Measured in milliseconds. The value nil means disable double-click
11337 recognition; t means double-clicks have no time limit and are detected
11338 by position only. */);
11339 Vdouble_click_time
= make_number (500);
11341 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11342 doc
: /* Maximum mouse movement between clicks to make a double-click.
11343 On window-system frames, value is the number of pixels the mouse may have
11344 moved horizontally or vertically between two clicks to make a double-click.
11345 On non window-system frames, value is interpreted in units of 1/8 characters
11348 This variable is also the threshold for motion of the mouse
11349 to count as a drag. */);
11350 double_click_fuzz
= 3;
11352 DEFVAR_INT ("num-input-keys", num_input_keys
,
11353 doc
: /* Number of complete key sequences read as input so far.
11354 This includes key sequences read from keyboard macros.
11355 The number is effectively the number of interactive command invocations. */);
11356 num_input_keys
= 0;
11358 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11359 doc
: /* Number of input events read from the keyboard so far.
11360 This does not include events generated by keyboard macros. */);
11361 num_nonmacro_input_events
= 0;
11363 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11364 doc
: /* The frame in which the most recently read event occurred.
11365 If the last event came from a keyboard macro, this is set to `macro'. */);
11366 Vlast_event_frame
= Qnil
;
11368 /* This variable is set up in sysdep.c. */
11369 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11370 doc
: /* The ERASE character as set by the user with stty. */);
11372 DEFVAR_LISP ("help-char", Vhelp_char
,
11373 doc
: /* Character to recognize as meaning Help.
11374 When it is read, do `(eval help-form)', and display result if it's a string.
11375 If the value of `help-form' is nil, this char can be read normally. */);
11376 XSETINT (Vhelp_char
, Ctl ('H'));
11378 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11379 doc
: /* List of input events to recognize as meaning Help.
11380 These work just like the value of `help-char' (see that). */);
11381 Vhelp_event_list
= Qnil
;
11383 DEFVAR_LISP ("help-form", Vhelp_form
,
11384 doc
: /* Form to execute when character `help-char' is read.
11385 If the form returns a string, that string is displayed.
11386 If `help-form' is nil, the help char is not recognized. */);
11389 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11390 doc
: /* Command to run when `help-char' character follows a prefix key.
11391 This command is used only when there is no actual binding
11392 for that character after that prefix key. */);
11393 Vprefix_help_command
= Qnil
;
11395 DEFVAR_LISP ("top-level", Vtop_level
,
11396 doc
: /* Form to evaluate when Emacs starts up.
11397 Useful to set before you dump a modified Emacs. */);
11399 XSYMBOL (Qtop_level
)->declared_special
= false;
11401 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11402 doc
: /* Translate table for local keyboard input, or nil.
11403 If non-nil, the value should be a char-table. Each character read
11404 from the keyboard is looked up in this char-table. If the value found
11405 there is non-nil, then it is used instead of the actual input character.
11407 The value can also be a string or vector, but this is considered obsolete.
11408 If it is a string or vector of length N, character codes N and up are left
11409 untranslated. In a vector, an element which is nil means "no translation".
11411 This is applied to the characters supplied to input methods, not their
11412 output. See also `translation-table-for-input'.
11414 This variable has a separate binding for each terminal.
11415 See Info node `(elisp)Multiple Terminals'. */);
11417 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11418 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11419 \(Even if the operating system has support for stopping a process.) */);
11420 cannot_suspend
= false;
11422 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11423 doc
: /* Non-nil means prompt with menus when appropriate.
11424 This is done when reading from a keymap that has a prompt string,
11425 for elements that have prompt strings.
11426 The menu is displayed on the screen
11427 if X menus were enabled at configuration
11428 time and the previous event was a mouse click prefix key.
11429 Otherwise, menu prompting uses the echo area. */);
11430 menu_prompting
= true;
11432 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11433 doc
: /* Character to see next line of menu prompt.
11434 Type this character while in a menu prompt to rotate around the lines of it. */);
11435 XSETINT (menu_prompt_more_char
, ' ');
11437 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11438 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11439 Emacs applies the modifiers of the character stored here to each keyboard
11440 character it reads. For example, after evaluating the expression
11441 (setq extra-keyboard-modifiers ?\\C-x)
11442 all input characters will have the control modifier applied to them.
11444 Note that the character ?\\C-@, equivalent to the integer zero, does
11445 not count as a control character; rather, it counts as a character
11446 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11447 cancels any modification. */);
11448 extra_keyboard_modifiers
= 0;
11450 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11451 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11452 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11453 The command loop sets this to nil before each command,
11454 and tests the value when the command returns.
11455 Buffer modification stores t in this variable. */);
11456 Vdeactivate_mark
= Qnil
;
11457 Fmake_variable_buffer_local (Qdeactivate_mark
);
11459 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11460 doc
: /* Normal hook run before each command is executed.
11461 If an unhandled error happens in running this hook,
11462 the function in which the error occurred is unconditionally removed, since
11463 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11465 See also `post-command-hook'. */);
11466 Vpre_command_hook
= Qnil
;
11468 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11469 doc
: /* Normal hook run after each command is executed.
11470 If an unhandled error happens in running this hook,
11471 the function in which the error occurred is unconditionally removed, since
11472 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11474 It is a bad idea to use this hook for expensive processing. If
11475 unavoidable, wrap your code in `(while-no-input (redisplay) CODE)' to
11476 avoid making Emacs unresponsive while the user types.
11478 See also `pre-command-hook'. */);
11479 Vpost_command_hook
= Qnil
;
11482 DEFVAR_LISP ("echo-area-clear-hook", ...,
11483 doc
: /* Normal hook run when clearing the echo area. */);
11485 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11486 Fset (Qecho_area_clear_hook
, Qnil
);
11488 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11489 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11490 Vlucid_menu_bar_dirty_flag
= Qnil
;
11492 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11493 doc
: /* List of menu bar items to move to the end of the menu bar.
11494 The elements of the list are event types that may have menu bar bindings. */);
11495 Vmenu_bar_final_items
= Qnil
;
11497 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11498 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11499 This is used internally by graphical displays that do not render
11500 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11501 Vtool_bar_separator_image_expression
= Qnil
;
11503 DEFVAR_KBOARD ("overriding-terminal-local-map",
11504 Voverriding_terminal_local_map
,
11505 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11506 This variable is intended to let commands such as `universal-argument'
11507 set up a different keymap for reading the next command.
11509 `overriding-terminal-local-map' has a separate binding for each
11510 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11512 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11513 doc
: /* Keymap that replaces (overrides) local keymaps.
11514 If this variable is non-nil, Emacs looks up key bindings in this
11515 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11516 buffer's local map. Hence, the only active keymaps would be
11517 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11518 order of precedence. */);
11519 Voverriding_local_map
= Qnil
;
11521 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11522 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11523 Otherwise, the menu bar continues to reflect the buffer's local map
11524 and the minor mode maps regardless of `overriding-local-map'. */);
11525 Voverriding_local_map_menu_flag
= Qnil
;
11527 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11528 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11529 Vspecial_event_map
= list1 (Qkeymap
);
11531 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11532 doc
: /* Non-nil means generate motion events for mouse motion. */);
11534 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11535 doc
: /* Alist of system-specific X windows key symbols.
11536 Each element should have the form (N . SYMBOL) where N is the
11537 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11538 and SYMBOL is its name.
11540 `system-key-alist' has a separate binding for each terminal device.
11541 See Info node `(elisp)Multiple Terminals'. */);
11543 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11544 doc
: /* Keymap that translates key sequences to key sequences during input.
11545 This is used mainly for mapping key sequences into some preferred
11546 key events (symbols).
11548 The `read-key-sequence' function replaces any subsequence bound by
11549 `local-function-key-map' with its binding. More precisely, when the
11550 active keymaps have no binding for the current key sequence but
11551 `local-function-key-map' binds a suffix of the sequence to a vector or
11552 string, `read-key-sequence' replaces the matching suffix with its
11553 binding, and continues with the new sequence.
11555 If the binding is a function, it is called with one argument (the prompt)
11556 and its return value (a key sequence) is used.
11558 The events that come from bindings in `local-function-key-map' are not
11559 themselves looked up in `local-function-key-map'.
11561 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11562 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11563 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11564 typing `ESC O P x' would return [f1 x].
11566 `local-function-key-map' has a separate binding for each terminal
11567 device. See Info node `(elisp)Multiple Terminals'. If you need to
11568 define a binding on all terminals, change `function-key-map'
11569 instead. Initially, `local-function-key-map' is an empty keymap that
11570 has `function-key-map' as its parent on all terminal devices. */);
11572 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11573 doc
: /* Keymap that decodes input escape sequences.
11574 This is used mainly for mapping ASCII function key sequences into
11575 real Emacs function key events (symbols).
11577 The `read-key-sequence' function replaces any subsequence bound by
11578 `input-decode-map' with its binding. Contrary to `function-key-map',
11579 this map applies its rebinding regardless of the presence of an ordinary
11580 binding. So it is more like `key-translation-map' except that it applies
11581 before `function-key-map' rather than after.
11583 If the binding is a function, it is called with one argument (the prompt)
11584 and its return value (a key sequence) is used.
11586 The events that come from bindings in `input-decode-map' are not
11587 themselves looked up in `input-decode-map'. */);
11589 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11590 doc
: /* The parent keymap of all `local-function-key-map' instances.
11591 Function key definitions that apply to all terminal devices should go
11592 here. If a mapping is defined in both the current
11593 `local-function-key-map' binding and this variable, then the local
11594 definition will take precedence. */);
11595 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11597 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11598 doc
: /* Keymap of key translations that can override keymaps.
11599 This keymap works like `input-decode-map', but comes after `function-key-map'.
11600 Another difference is that it is global rather than terminal-local. */);
11601 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11603 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11604 doc
: /* List of deferred actions to be performed at a later time.
11605 The precise format isn't relevant here; we just check whether it is nil. */);
11606 Vdeferred_action_list
= Qnil
;
11608 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11609 doc
: /* Function to call to handle deferred actions, after each command.
11610 This function is called with no arguments after each command
11611 whenever `deferred-action-list' is non-nil. */);
11612 Vdeferred_action_function
= Qnil
;
11614 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11615 doc
: /* List of warnings to be displayed after this command.
11616 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11617 as per the args of `display-warning' (which see).
11618 If this variable is non-nil, `delayed-warnings-hook' will be run
11619 immediately after running `post-command-hook'. */);
11620 Vdelayed_warnings_list
= Qnil
;
11622 DEFVAR_LISP ("timer-list", Vtimer_list
,
11623 doc
: /* List of active absolute time timers in order of increasing time. */);
11624 Vtimer_list
= Qnil
;
11626 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11627 doc
: /* List of active idle-time timers in order of increasing time. */);
11628 Vtimer_idle_list
= Qnil
;
11630 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11631 doc
: /* If non-nil, the function that implements the current input method.
11632 It's called with one argument, a printing character that was just read.
11633 \(That means a character with code 040...0176.)
11634 Typically this function uses `read-event' to read additional events.
11635 When it does so, it should first bind `input-method-function' to nil
11636 so it will not be called recursively.
11638 The function should return a list of zero or more events
11639 to be used as input. If it wants to put back some events
11640 to be reconsidered, separately, by the input method,
11641 it can add them to the beginning of `unread-command-events'.
11643 The input method function can find in `input-method-previous-message'
11644 the previous echo area message.
11646 The input method function should refer to the variables
11647 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11648 for guidance on what to do. */);
11649 Vinput_method_function
= Qlist
;
11651 DEFVAR_LISP ("input-method-previous-message",
11652 Vinput_method_previous_message
,
11653 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11654 This variable exists because `read-event' clears the echo area
11655 before running the input method. It is nil if there was no message. */);
11656 Vinput_method_previous_message
= Qnil
;
11658 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11659 doc
: /* If non-nil, the function that implements the display of help.
11660 It's called with one argument, the help string to display. */);
11661 Vshow_help_function
= Qnil
;
11663 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11664 doc
: /* If non-nil, suppress point adjustment after executing a command.
11666 After a command is executed, if point moved into a region that has
11667 special properties (e.g. composition, display), Emacs adjusts point to
11668 the boundary of the region. But when a command leaves this variable at
11669 a non-nil value (e.g., with a setq), this point adjustment is suppressed.
11671 This variable is set to nil before reading a command, and is checked
11672 just after executing the command. */);
11673 Vdisable_point_adjustment
= Qnil
;
11675 DEFVAR_LISP ("global-disable-point-adjustment",
11676 Vglobal_disable_point_adjustment
,
11677 doc
: /* If non-nil, always suppress point adjustments.
11679 The default value is nil, in which case point adjustments are
11680 suppressed only after special commands that leave
11681 `disable-point-adjustment' (which see) at a non-nil value. */);
11682 Vglobal_disable_point_adjustment
= Qnil
;
11684 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11685 doc
: /* How long to display an echo-area message when the minibuffer is active.
11686 If the value is not a number, such messages don't time out. */);
11687 Vminibuffer_message_timeout
= make_number (2);
11689 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11690 doc
: /* If non-nil, any keyboard input throws to this symbol.
11691 The value of that variable is passed to `quit-flag' and later causes a
11692 peculiar kind of quitting. */);
11693 Vthrow_on_input
= Qnil
;
11695 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11696 doc
: /* Function to output error messages.
11697 Called with three arguments:
11698 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11699 such as what `condition-case' would bind its variable to,
11700 - the context (a string which normally goes at the start of the message),
11701 - the Lisp function within which the error was signaled. */);
11702 Vcommand_error_function
= intern ("command-error-default-function");
11704 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11705 Venable_disabled_menus_and_buttons
,
11706 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11708 Help functions bind this to allow help on disabled menu items
11709 and tool-bar buttons. */);
11710 Venable_disabled_menus_and_buttons
= Qnil
;
11712 DEFVAR_LISP ("select-active-regions",
11713 Vselect_active_regions
,
11714 doc
: /* If non-nil, an active region automatically sets the primary selection.
11715 If the value is `only', only temporarily active regions (usually made
11716 by mouse-dragging or shift-selection) set the window selection.
11718 This takes effect only when Transient Mark mode is enabled. */);
11719 Vselect_active_regions
= Qt
;
11721 DEFVAR_LISP ("saved-region-selection",
11722 Vsaved_region_selection
,
11723 doc
: /* Contents of active region prior to buffer modification.
11724 If `select-active-regions' is non-nil, Emacs sets this to the
11725 text in the region before modifying the buffer. The next call to
11726 the function `deactivate-mark' uses this to set the window selection. */);
11727 Vsaved_region_selection
= Qnil
;
11729 DEFVAR_LISP ("selection-inhibit-update-commands",
11730 Vselection_inhibit_update_commands
,
11731 doc
: /* List of commands which should not update the selection.
11732 Normally, if `select-active-regions' is non-nil and the mark remains
11733 active after a command (i.e. the mark was not deactivated), the Emacs
11734 command loop sets the selection to the text in the region. However,
11735 if the command is in this list, the selection is not updated. */);
11736 Vselection_inhibit_update_commands
11737 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11739 DEFVAR_LISP ("debug-on-event",
11741 doc
: /* Enter debugger on this event. When Emacs
11742 receives the special event specified by this variable, it will try to
11743 break into the debugger as soon as possible instead of processing the
11744 event normally through `special-event-map'.
11746 Currently, the only supported values for this
11747 variable are `sigusr1' and `sigusr2'. */);
11748 Vdebug_on_event
= intern_c_string ("sigusr2");
11750 DEFVAR_BOOL ("attempt-stack-overflow-recovery",
11751 attempt_stack_overflow_recovery
,
11752 doc
: /* If non-nil, attempt to recover from C stack
11753 overflow. This recovery is unsafe and may lead to deadlocks or data
11754 corruption, but it usually works and may preserve modified buffers
11755 that would otherwise be lost. If nil, treat stack overflow like any
11756 other kind of crash. */);
11757 attempt_stack_overflow_recovery
= true;
11759 DEFVAR_BOOL ("attempt-orderly-shutdown-on-fatal-signal",
11760 attempt_orderly_shutdown_on_fatal_signal
,
11761 doc
: /* If non-nil, attempt to perform an orderly
11762 shutdown when Emacs receives a fatal signal (e.g., a crash).
11763 This cleanup is unsafe and may lead to deadlocks or data corruption,
11764 but it usually works and may preserve modified buffers that would
11765 otherwise be lost. If nil, crash immediately in response to fatal
11767 attempt_orderly_shutdown_on_fatal_signal
= true;
11769 /* Create the initial keyboard. Qt means 'unset'. */
11770 initial_kboard
= allocate_kboard (Qt
);
11774 keys_of_keyboard (void)
11776 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11777 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11778 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11779 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11780 initial_define_key (meta_map
, 'x', "execute-extended-command");
11782 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11783 "handle-delete-frame");
11785 initial_define_lispy_key (Vspecial_event_map
, "end-session",
11788 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11789 "ns-put-working-text");
11790 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11791 "ns-unput-working-text");
11792 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11793 current-prefix-arg, as is done in `handle-switch-frame'.
11794 But `handle-switch-frame is not run from the special-map.
11795 Commands from that map are run in a special way that automatically
11796 preserves the prefix-arg. Restoring the prefix arg here is not just
11797 redundant but harmful:
11799 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11800 - after the first prompt, the exit-minibuffer-hook is run which may
11801 iconify a frame and thus push a `iconify-frame' event.
11802 - after running exit-minibuffer-hook, current-prefix-arg is
11803 restored to the non-nil value it had before the prompt.
11804 - we enter the second prompt.
11805 current-prefix-arg is non-nil, prefix-arg is nil.
11806 - before running the first real event, we run the special iconify-frame
11807 event, but we pass the `special' arg to command-execute so
11808 current-prefix-arg and prefix-arg are left untouched.
11809 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11810 - the next key event will have a spuriously non-nil current-prefix-arg. */
11811 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11813 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11815 /* Handling it at such a low-level causes read_key_sequence to get
11816 * confused because it doesn't realize that the current_buffer was
11817 * changed by read_char.
11819 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11820 * "handle-select-window"); */
11821 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11822 "handle-save-session");
11825 /* Define a special event which is raised for dbus callback
11827 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11828 "dbus-handle-event");
11831 #ifdef USE_FILE_NOTIFY
11832 /* Define a special event which is raised for notification callback
11834 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11835 "file-notify-handle-event");
11836 #endif /* USE_FILE_NOTIFY */
11838 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11840 #if defined (WINDOWSNT)
11841 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11844 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11845 "handle-focus-in");
11846 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11847 "handle-focus-out");
11850 /* Mark the pointers in the kboard objects.
11851 Called by Fgarbage_collect. */
11853 mark_kboards (void)
11857 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11859 if (kb
->kbd_macro_buffer
)
11860 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11862 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11863 mark_object (KVAR (kb
, Vlast_command
));
11864 mark_object (KVAR (kb
, Vreal_last_command
));
11865 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11866 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11867 mark_object (KVAR (kb
, Vprefix_arg
));
11868 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11869 mark_object (KVAR (kb
, kbd_queue
));
11870 mark_object (KVAR (kb
, defining_kbd_macro
));
11871 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11872 mark_object (KVAR (kb
, Vsystem_key_alist
));
11873 mark_object (KVAR (kb
, system_key_syms
));
11874 mark_object (KVAR (kb
, Vwindow_system
));
11875 mark_object (KVAR (kb
, Vinput_decode_map
));
11876 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11877 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11878 mark_object (KVAR (kb
, echo_string
));
11879 mark_object (KVAR (kb
, echo_prompt
));
11882 union buffered_input_event
*event
;
11883 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11885 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11886 event
= kbd_buffer
;
11887 /* These two special event types has no Lisp_Objects to mark. */
11888 if (event
->kind
!= SELECTION_REQUEST_EVENT
11889 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11891 mark_object (event
->ie
.x
);
11892 mark_object (event
->ie
.y
);
11893 mark_object (event
->ie
.frame_or_window
);
11894 mark_object (event
->ie
.arg
);