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 /* Work around GCC bug 54561. */
74 #if GNUC_PREREQ (4, 3, 0)
75 # pragma GCC diagnostic ignored "-Wclobbered"
79 char const DEV_TTY
[] = "CONOUT$";
81 char const DEV_TTY
[] = "/dev/tty";
84 /* Variables for blockinput.h: */
86 /* Positive if interrupt input is blocked right now. */
87 volatile int interrupt_input_blocked
;
89 /* True means an input interrupt or alarm signal has arrived.
90 The QUIT macro checks this. */
91 volatile bool pending_signals
;
93 #define KBD_BUFFER_SIZE 4096
95 KBOARD
*initial_kboard
;
96 KBOARD
*current_kboard
;
97 static KBOARD
*all_kboards
;
99 /* True in the single-kboard state, false in the any-kboard state. */
100 static bool single_kboard
;
102 #define NUM_RECENT_KEYS (300)
104 /* Index for storing next element into recent_keys. */
105 static int recent_keys_index
;
107 /* Total number of elements stored into recent_keys. */
108 static int total_keys
;
110 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
111 static Lisp_Object recent_keys
;
113 /* Vector holding the key sequence that invoked the current command.
114 It is reused for each command, and it may be longer than the current
115 sequence; this_command_key_count indicates how many elements
116 actually mean something.
117 It's easier to staticpro a single Lisp_Object than an array. */
118 Lisp_Object this_command_keys
;
119 ptrdiff_t this_command_key_count
;
121 /* This vector is used as a buffer to record the events that were actually read
122 by read_key_sequence. */
123 static Lisp_Object raw_keybuf
;
124 static int raw_keybuf_count
;
126 #define GROW_RAW_KEYBUF \
127 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
128 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
130 /* Number of elements of this_command_keys
131 that precede this key sequence. */
132 static ptrdiff_t this_single_command_key_start
;
134 #ifdef HAVE_STACK_OVERFLOW_HANDLING
136 /* For longjmp to recover from C stack overflow. */
137 sigjmp_buf return_to_command_loop
;
139 /* Message displayed by Vtop_level when recovering from C stack overflow. */
140 static Lisp_Object recover_top_level_message
;
142 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
144 /* Message normally displayed by Vtop_level. */
145 static Lisp_Object regular_top_level_message
;
147 /* For longjmp to where kbd input is being done. */
149 static sys_jmp_buf getcjmp
;
151 /* True while doing kbd input. */
152 bool waiting_for_input
;
154 /* True while displaying for echoing. Delays C-g throwing. */
158 /* Non-null means we can start echoing at the next input pause even
159 though there is something in the echo area. */
161 static struct kboard
*ok_to_echo_at_next_pause
;
163 /* The kboard last echoing, or null for none. Reset to 0 in
164 cancel_echoing. If non-null, and a current echo area message
165 exists, and echo_message_buffer is eq to the current message
166 buffer, we know that the message comes from echo_kboard. */
168 struct kboard
*echo_kboard
;
170 /* The buffer used for echoing. Set in echo_now, reset in
173 Lisp_Object echo_message_buffer
;
175 /* True means C-g should cause immediate error-signal. */
178 /* Character that causes a quit. Normally C-g.
180 If we are running on an ordinary terminal, this must be an ordinary
181 ASCII char, since we want to make it our interrupt character.
183 If we are not running on an ordinary terminal, it still needs to be
184 an ordinary ASCII char. This character needs to be recognized in
185 the input interrupt handler. At this point, the keystroke is
186 represented as a struct input_event, while the desired quit
187 character is specified as a lispy event. The mapping from struct
188 input_events to lispy events cannot run in an interrupt handler,
189 and the reverse mapping is difficult for anything but ASCII
192 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
196 /* Current depth in recursive edits. */
197 EMACS_INT command_loop_level
;
199 /* If not Qnil, this is a switch-frame event which we decided to put
200 off until the end of a key sequence. This should be read as the
201 next command input, after any unread_command_events.
203 read_key_sequence uses this to delay switch-frame events until the
204 end of the key sequence; Fread_char uses it to put off switch-frame
205 events until a non-ASCII event is acceptable as input. */
206 Lisp_Object unread_switch_frame
;
208 /* Last size recorded for a current buffer which is not a minibuffer. */
209 static ptrdiff_t last_non_minibuf_size
;
211 uintmax_t num_input_events
;
212 ptrdiff_t point_before_last_command_or_undo
;
213 struct buffer
*buffer_before_last_command_or_undo
;
215 /* Value of num_nonmacro_input_events as of last auto save. */
217 static EMACS_INT last_auto_save
;
219 /* The value of point when the last command was started. */
220 static ptrdiff_t last_point_position
;
222 /* The frame in which the last input event occurred, or Qmacro if the
223 last event came from a macro. We use this to determine when to
224 generate switch-frame events. This may be cleared by functions
225 like Fselect_frame, to make sure that a switch-frame event is
226 generated by the next character.
228 FIXME: This is modified by a signal handler so it should be volatile.
229 It's exported to Lisp, though, so it can't simply be marked
231 Lisp_Object internal_last_event_frame
;
233 /* `read_key_sequence' stores here the command definition of the
234 key sequence that it reads. */
235 static Lisp_Object read_key_sequence_cmd
;
236 static Lisp_Object read_key_sequence_remapped
;
238 /* File in which we write all commands we read. */
239 static FILE *dribble
;
241 /* True if input is available. */
244 /* True if more input was available last time we read an event.
246 Since redisplay can take a significant amount of time and is not
247 indispensable to perform the user's commands, when input arrives
248 "too fast", Emacs skips redisplay. More specifically, if the next
249 command has already been input when we finish the previous command,
250 we skip the intermediate redisplay.
252 This is useful to try and make sure Emacs keeps up with fast input
253 rates, such as auto-repeating keys. But in some cases, this proves
254 too conservative: we may end up disabling redisplay for the whole
255 duration of a key repetition, even though we could afford to
256 redisplay every once in a while.
258 So we "sample" the input_pending flag before running a command and
259 use *that* value after running the command to decide whether to
260 skip redisplay or not. This way, we only skip redisplay if we
261 really can't keep up with the repeat rate.
263 This only makes a difference if the next input arrives while running the
264 command, which is very unlikely if the command is executed quickly.
265 IOW this tends to avoid skipping redisplay after a long running command
266 (which is a case where skipping redisplay is not very useful since the
267 redisplay time is small compared to the time it took to run the command).
269 A typical use case is when scrolling. Scrolling time can be split into:
270 - Time to do jit-lock on the newly displayed portion of buffer.
271 - Time to run the actual scroll command.
272 - Time to perform the redisplay.
273 Jit-lock can happen either during the command or during the redisplay.
274 In the most painful cases, the jit-lock time is the one that dominates.
275 Also jit-lock can be tweaked (via jit-lock-defer) to delay its job, at the
276 cost of temporary inaccuracy in display and scrolling.
277 So without input_was_pending, what typically happens is the following:
278 - when the command starts, there's no pending input (yet).
279 - the scroll command triggers jit-lock.
280 - during the long jit-lock time the next input arrives.
281 - at the end of the command, we check input_pending and hence decide to
283 - we read the next input and start over.
284 End result: all the hard work of jit-locking is "wasted" since redisplay
285 doesn't actually happens (at least not before the input rate slows down).
286 With input_was_pending redisplay is still skipped if Emacs can't keep up
287 with the input rate, but if it can keep up just enough that there's no
288 input_pending when we begin the command, then redisplay is not skipped
289 which results in better feedback to the user. */
290 static bool input_was_pending
;
292 /* Circular buffer for pre-read keyboard input. */
294 static union buffered_input_event kbd_buffer
[KBD_BUFFER_SIZE
];
296 /* Pointer to next available character in kbd_buffer.
297 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
298 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
299 next available char is in kbd_buffer[0]. */
300 static union buffered_input_event
*kbd_fetch_ptr
;
302 /* Pointer to next place to store character in kbd_buffer. This
303 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
304 character should go in kbd_buffer[0]. */
305 static union buffered_input_event
*volatile kbd_store_ptr
;
307 /* The above pair of variables forms a "queue empty" flag. When we
308 enqueue a non-hook event, we increment kbd_store_ptr. When we
309 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
310 there is input available if the two pointers are not equal.
312 Why not just have a flag set and cleared by the enqueuing and
313 dequeuing functions? Such a flag could be screwed up by interrupts
314 at inopportune times. */
316 static void recursive_edit_unwind (Lisp_Object buffer
);
317 static Lisp_Object
command_loop (void);
319 static void echo_now (void);
320 static ptrdiff_t echo_length (void);
322 /* Incremented whenever a timer is run. */
325 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
327 struct timespec
*input_available_clear_time
;
329 /* True means use SIGIO interrupts; false means use CBREAK mode.
330 Default is true if INTERRUPT_INPUT is defined. */
331 bool interrupt_input
;
333 /* Nonzero while interrupts are temporarily deferred during redisplay. */
334 bool interrupts_deferred
;
336 /* The time when Emacs started being idle. */
338 static struct timespec timer_idleness_start_time
;
340 /* After Emacs stops being idle, this saves the last value
341 of timer_idleness_start_time from when it was idle. */
343 static struct timespec timer_last_idleness_start_time
;
346 /* Global variable declarations. */
348 /* Flags for readable_events. */
349 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
350 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
351 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
353 /* Function for init_keyboard to call with no args (if nonzero). */
354 static void (*keyboard_init_hook
) (void);
356 static bool get_input_pending (int);
357 static bool readable_events (int);
358 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
359 Lisp_Object
, bool *);
360 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
361 static Lisp_Object
make_lispy_event (struct input_event
*);
362 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
363 enum scroll_bar_part
,
364 Lisp_Object
, Lisp_Object
,
366 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
367 Lisp_Object
, const char *const *,
368 Lisp_Object
*, ptrdiff_t);
369 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
370 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
371 #ifdef HAVE_WINDOW_SYSTEM
372 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
373 #endif /* HAVE_WINDOW_SYSTEM */
374 static bool help_char_p (Lisp_Object
);
375 static void save_getcjmp (sys_jmp_buf
);
376 static void restore_getcjmp (sys_jmp_buf
);
377 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
378 static void restore_kboard_configuration (int);
379 static void handle_interrupt (bool);
380 static _Noreturn
void quit_throw_to_read_char (bool);
381 static void timer_start_idle (void);
382 static void timer_stop_idle (void);
383 static void timer_resume_idle (void);
384 static void deliver_user_signal (int);
385 static char *find_user_signal_name (int);
386 static void store_user_signal_events (void);
388 /* These setters are used only in this file, so they can be private. */
390 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
392 kb
->echo_string_
= val
;
395 kset_echo_prompt (struct kboard
*kb
, Lisp_Object val
)
397 kb
->echo_prompt_
= val
;
400 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
402 kb
->kbd_queue_
= val
;
405 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
407 kb
->Vkeyboard_translate_table_
= val
;
410 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
412 kb
->Vlast_prefix_arg_
= val
;
415 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
417 kb
->Vlast_repeatable_command_
= val
;
420 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
422 kb
->Vlocal_function_key_map_
= val
;
425 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
427 kb
->Voverriding_terminal_local_map_
= val
;
430 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
432 kb
->Vreal_last_command_
= val
;
435 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
437 kb
->system_key_syms_
= val
;
442 echo_keystrokes_p (void)
444 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
445 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0
449 /* Add C to the echo string, without echoing it immediately. C can be
450 a character, which is pretty-printed, or a symbol, whose name is
454 echo_add_key (Lisp_Object c
)
456 char initbuf
[KEY_DESCRIPTION_SIZE
+ 100];
457 ptrdiff_t size
= sizeof initbuf
;
458 char *buffer
= initbuf
;
460 Lisp_Object echo_string
= KVAR (current_kboard
, echo_string
);
463 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
464 /* Add a space at the end as a separator between keys. */
467 /* If someone has passed us a composite event, use its head symbol. */
471 ptr
= push_key_description (XINT (c
), ptr
);
472 else if (SYMBOLP (c
))
474 Lisp_Object name
= SYMBOL_NAME (c
);
475 ptrdiff_t nbytes
= SBYTES (name
);
477 if (size
- (ptr
- buffer
) < nbytes
)
479 ptrdiff_t offset
= ptr
- buffer
;
480 size
= max (2 * size
, size
+ nbytes
);
481 buffer
= SAFE_ALLOCA (size
);
482 ptr
= buffer
+ offset
;
485 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
486 STRING_MULTIBYTE (name
), 1);
489 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
492 static const char text
[] = " (Type ? for further options)";
493 int len
= sizeof text
- 1;
495 if (size
- (ptr
- buffer
) < len
)
497 ptrdiff_t offset
= ptr
- buffer
;
499 buffer
= SAFE_ALLOCA (size
);
500 ptr
= buffer
+ offset
;
503 memcpy (ptr
, text
, len
);
509 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
513 /* Temporarily add a dash to the end of the echo string if it's not
514 empty, so that it serves as a mini-prompt for the very next
520 /* Do nothing if not echoing at all. */
521 if (NILP (KVAR (current_kboard
, echo_string
)))
524 if (!current_kboard
->immediate_echo
525 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
528 /* Do nothing if we just printed a prompt. */
529 if (STRINGP (KVAR (current_kboard
, echo_prompt
))
530 && (SCHARS (KVAR (current_kboard
, echo_prompt
))
531 == SCHARS (KVAR (current_kboard
, echo_string
))))
534 /* Do nothing if we have already put a dash at the end. */
535 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
537 Lisp_Object last_char
, prev_char
, idx
;
539 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
540 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
542 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
543 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
545 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
549 /* Put a dash at the end of the buffer temporarily,
550 but make it go away when the next character is added. */
551 AUTO_STRING (dash
, "-");
552 kset_echo_string (current_kboard
,
553 concat2 (KVAR (current_kboard
, echo_string
), dash
));
560 if (current_kboard
->immediate_echo
)
563 Lisp_Object prompt
= KVAR (current_kboard
, echo_prompt
);
564 Lisp_Object prefix
= call0 (Qinternal_echo_keystrokes_prefix
);
565 kset_echo_string (current_kboard
,
566 NILP (prompt
) ? prefix
567 : NILP (prefix
) ? prompt
568 : concat2 (prompt
, prefix
));
570 for (i
= 0; i
< this_command_key_count
; i
++)
574 c
= AREF (this_command_keys
, i
);
575 if (! (EVENT_HAS_PARAMETERS (c
)
576 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
584 /* Display the current echo string, and begin echoing if not already
590 if (!current_kboard
->immediate_echo
591 /* This test breaks calls that use `echo_now' to display the echo_prompt.
592 && echo_keystrokes_p () */)
594 current_kboard
->immediate_echo
= true;
596 /* Put a dash at the end to invite the user to type more. */
601 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
602 message3_nolog (KVAR (current_kboard
, echo_string
));
605 /* Record in what buffer we echoed, and from which kboard. */
606 echo_message_buffer
= echo_area_buffer
[0];
607 echo_kboard
= current_kboard
;
609 if (waiting_for_input
&& !NILP (Vquit_flag
))
610 quit_throw_to_read_char (0);
613 /* Turn off echoing, for the start of a new command. */
616 cancel_echoing (void)
618 current_kboard
->immediate_echo
= false;
619 kset_echo_prompt (current_kboard
, Qnil
);
620 kset_echo_string (current_kboard
, Qnil
);
621 ok_to_echo_at_next_pause
= NULL
;
623 echo_message_buffer
= Qnil
;
626 /* Return the length of the current echo string. */
631 return (STRINGP (KVAR (current_kboard
, echo_string
))
632 ? SCHARS (KVAR (current_kboard
, echo_string
))
636 /* Truncate the current echo message to its first LEN chars.
637 This and echo_char get used by read_key_sequence when the user
638 switches frames while entering a key sequence. */
641 echo_truncate (ptrdiff_t nchars
)
643 if (STRINGP (KVAR (current_kboard
, echo_string
)))
644 kset_echo_string (current_kboard
,
645 Fsubstring (KVAR (current_kboard
, echo_string
),
646 make_number (0), make_number (nchars
)));
647 truncate_echo_area (nchars
);
651 /* Functions for manipulating this_command_keys. */
653 add_command_key (Lisp_Object key
)
655 if (this_command_key_count
>= ASIZE (this_command_keys
))
656 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
658 ASET (this_command_keys
, this_command_key_count
, key
);
659 ++this_command_key_count
;
664 recursive_edit_1 (void)
666 ptrdiff_t count
= SPECPDL_INDEX ();
669 if (command_loop_level
> 0)
671 specbind (Qstandard_output
, Qt
);
672 specbind (Qstandard_input
, Qt
);
675 #ifdef HAVE_WINDOW_SYSTEM
676 /* The command loop has started an hourglass timer, so we have to
677 cancel it here, otherwise it will fire because the recursive edit
678 can take some time. Do not check for display_hourglass_p here,
679 because it could already be nil. */
683 /* This function may have been called from a debugger called from
684 within redisplay, for instance by Edebugging a function called
685 from fontification-functions. We want to allow redisplay in
686 the debugging session.
688 The recursive edit is left with a `(throw exit ...)'. The `exit'
689 tag is not caught anywhere in redisplay, i.e. when we leave the
690 recursive edit, the original redisplay leading to the recursive
691 edit will be unwound. The outcome should therefore be safe. */
692 specbind (Qinhibit_redisplay
, Qnil
);
695 /* This variable stores buffers that have changed so that an undo
696 boundary can be added. specbind this so that changes in the
697 recursive edit will not result in undo boundaries in buffers
698 changed before we entered there recursive edit.
701 specbind (Qundo_auto__undoably_changed_buffers
, Qnil
);
703 val
= command_loop ();
706 /* Handle throw from read_minibuf when using minibuffer
707 while it's active but we're in another window. */
709 xsignal1 (Qerror
, val
);
711 return unbind_to (count
, Qnil
);
714 /* When an auto-save happens, record the "time", and don't do again soon. */
717 record_auto_save (void)
719 last_auto_save
= num_nonmacro_input_events
;
722 /* Make an auto save happen as soon as possible at command level. */
726 force_auto_save_soon (void)
728 last_auto_save
= - auto_save_interval
- 1;
730 record_asynch_buffer_change ();
734 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
735 doc
: /* Invoke the editor command loop recursively.
736 To get out of the recursive edit, a command can throw to `exit' -- for
737 instance (throw \\='exit nil).
738 If you throw a value other than t, `recursive-edit' returns normally
739 to the function that called it. Throwing a t value causes
740 `recursive-edit' to quit, so that control returns to the command loop
743 This function is called by the editor initialization to begin editing. */)
746 ptrdiff_t count
= SPECPDL_INDEX ();
749 /* If we enter while input is blocked, don't lock up here.
750 This may happen through the debugger during redisplay. */
751 if (input_blocked_p ())
754 if (command_loop_level
>= 0
755 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
756 buffer
= Fcurrent_buffer ();
760 /* Don't do anything interesting between the increment and the
761 record_unwind_protect! Otherwise, we could get distracted and
762 never decrement the counter again. */
763 command_loop_level
++;
764 update_mode_lines
= 17;
765 record_unwind_protect (recursive_edit_unwind
, buffer
);
767 /* If we leave recursive_edit_1 below with a `throw' for instance,
768 like it is done in the splash screen display, we have to
769 make sure that we restore single_kboard as command_loop_1
770 would have done if it were left normally. */
771 if (command_loop_level
> 0)
772 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
775 return unbind_to (count
, Qnil
);
779 recursive_edit_unwind (Lisp_Object buffer
)
781 if (BUFFERP (buffer
))
782 Fset_buffer (buffer
);
784 command_loop_level
--;
785 update_mode_lines
= 18;
789 #if 0 /* These two functions are now replaced with
790 temporarily_switch_to_single_kboard. */
794 #if 0 /* Theory: if there's anything in Vunread_command_events,
795 it will right away be read by read_key_sequence,
796 and then if we do switch KBOARDS, it will go into the side
797 queue then. So we don't need to do anything special here -- rms. */
798 if (CONSP (Vunread_command_events
))
800 current_kboard
->kbd_queue
801 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
802 current_kboard
->kbd_queue_has_data
= true;
804 Vunread_command_events
= Qnil
;
806 single_kboard
= false;
809 /* Switch to the single-kboard state, making current_kboard
810 the only KBOARD from which further input is accepted. */
813 single_kboard_state ()
815 single_kboard
= true;
819 /* If we're in single_kboard state for kboard KBOARD,
823 not_single_kboard_state (KBOARD
*kboard
)
825 if (kboard
== current_kboard
)
826 single_kboard
= false;
829 /* Maintain a stack of kboards, so other parts of Emacs
830 can switch temporarily to the kboard of a given frame
831 and then revert to the previous status. */
836 struct kboard_stack
*next
;
839 static struct kboard_stack
*kboard_stack
;
842 push_kboard (struct kboard
*k
)
844 struct kboard_stack
*p
= xmalloc (sizeof *p
);
846 p
->next
= kboard_stack
;
847 p
->kboard
= current_kboard
;
857 struct kboard_stack
*p
= kboard_stack
;
859 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
861 if (t
->kboard
== p
->kboard
)
863 current_kboard
= p
->kboard
;
870 /* The terminal we remembered has been deleted. */
871 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
872 single_kboard
= false;
874 kboard_stack
= p
->next
;
878 /* Switch to single_kboard mode, making current_kboard the only KBOARD
879 from which further input is accepted. If F is non-nil, set its
880 KBOARD as the current keyboard.
882 This function uses record_unwind_protect_int to return to the previous
885 If Emacs is already in single_kboard mode, and F's keyboard is
886 locked, then this function will throw an error. */
889 temporarily_switch_to_single_kboard (struct frame
*f
)
891 bool was_locked
= single_kboard
;
894 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
895 /* We can not switch keyboards while in single_kboard mode.
896 In rare cases, Lisp code may call `recursive-edit' (or
897 `read-minibuffer' or `y-or-n-p') after it switched to a
898 locked frame. For example, this is likely to happen
899 when server.el connects to a new terminal while Emacs is in
900 single_kboard mode. It is best to throw an error instead
901 of presenting the user with a frozen screen. */
902 error ("Terminal %d is locked, cannot read from it",
903 FRAME_TERMINAL (f
)->id
);
905 /* This call is unnecessary, but helps
906 `restore_kboard_configuration' discover if somebody changed
907 `current_kboard' behind our back. */
908 push_kboard (current_kboard
);
911 current_kboard
= FRAME_KBOARD (f
);
912 single_kboard
= true;
913 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
916 #if 0 /* This function is not needed anymore. */
918 record_single_kboard_state ()
921 push_kboard (current_kboard
);
922 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
927 restore_kboard_configuration (int was_locked
)
929 single_kboard
= was_locked
;
932 struct kboard
*prev
= current_kboard
;
934 /* The pop should not change the kboard. */
935 if (single_kboard
&& current_kboard
!= prev
)
941 /* Handle errors that are not handled at inner levels
942 by printing an error message and returning to the editor command loop. */
945 cmd_error (Lisp_Object data
)
947 Lisp_Object old_level
, old_length
;
948 char macroerror
[sizeof "After..kbd macro iterations: "
949 + INT_STRLEN_BOUND (EMACS_INT
)];
951 #ifdef HAVE_WINDOW_SYSTEM
952 if (display_hourglass_p
)
956 if (!NILP (executing_kbd_macro
))
958 if (executing_kbd_macro_iterations
== 1)
959 sprintf (macroerror
, "After 1 kbd macro iteration: ");
961 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
962 executing_kbd_macro_iterations
);
967 Vstandard_output
= Qt
;
968 Vstandard_input
= Qt
;
969 Vexecuting_kbd_macro
= Qnil
;
970 executing_kbd_macro
= Qnil
;
971 kset_prefix_arg (current_kboard
, Qnil
);
972 kset_last_prefix_arg (current_kboard
, Qnil
);
975 /* Avoid unquittable loop if data contains a circular list. */
976 old_level
= Vprint_level
;
977 old_length
= Vprint_length
;
978 XSETFASTINT (Vprint_level
, 10);
979 XSETFASTINT (Vprint_length
, 10);
980 cmd_error_internal (data
, macroerror
);
981 Vprint_level
= old_level
;
982 Vprint_length
= old_length
;
985 Vinhibit_quit
= Qnil
;
987 return make_number (0);
990 /* Take actions on handling an error. DATA is the data that describes
993 CONTEXT is a C-string containing ASCII characters only which
994 describes the context in which the error happened. If we need to
995 generalize CONTEXT to allow multibyte characters, make it a Lisp
999 cmd_error_internal (Lisp_Object data
, const char *context
)
1001 /* The immediate context is not interesting for Quits,
1002 since they are asynchronous. */
1003 if (EQ (XCAR (data
), Qquit
))
1004 Vsignaling_function
= Qnil
;
1009 /* Use user's specified output function if any. */
1010 if (!NILP (Vcommand_error_function
))
1011 call3 (Vcommand_error_function
, data
,
1012 context
? build_string (context
) : empty_unibyte_string
,
1013 Vsignaling_function
);
1015 Vsignaling_function
= Qnil
;
1018 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1019 Scommand_error_default_function
, 3, 3, 0,
1020 doc
: /* Produce default output for unhandled error message.
1021 Default value of `command-error-function'. */)
1022 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1024 struct frame
*sf
= SELECTED_FRAME ();
1026 CHECK_STRING (context
);
1028 /* If the window system or terminal frame hasn't been initialized
1029 yet, or we're not interactive, write the message to stderr and exit. */
1030 if (!sf
->glyphs_initialized_p
1031 /* The initial frame is a special non-displaying frame. It
1032 will be current in daemon mode when there are no frames
1033 to display, and in non-daemon mode before the real frame
1034 has finished initializing. If an error is thrown in the
1035 latter case while creating the frame, then the frame
1036 will never be displayed, so the safest thing to do is
1037 write to stderr and quit. In daemon mode, there are
1038 many other potential errors that do not prevent frames
1039 from being created, so continuing as normal is better in
1041 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1044 print_error_message (data
, Qexternal_debugging_output
,
1045 SSDATA (context
), signal
);
1046 Fterpri (Qexternal_debugging_output
, Qnil
);
1047 Fkill_emacs (make_number (-1));
1051 clear_message (1, 0);
1053 message_log_maybe_newline ();
1056 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1061 static Lisp_Object
command_loop_2 (Lisp_Object
);
1062 static Lisp_Object
top_level_1 (Lisp_Object
);
1064 /* Entry to editor-command-loop.
1065 This level has the catches for exiting/returning to editor command loop.
1066 It returns nil to exit recursive edit, t to abort it. */
1071 #ifdef HAVE_STACK_OVERFLOW_HANDLING
1072 /* At least on GNU/Linux, saving signal mask is important here. */
1073 if (sigsetjmp (return_to_command_loop
, 1) != 0)
1075 /* Comes here from handle_sigsegv (see sysdep.c) and
1076 stack_overflow_handler (see w32fns.c). */
1078 w32_reset_stack_overflow_guard ();
1081 Vinternal__top_level_message
= recover_top_level_message
;
1084 Vinternal__top_level_message
= regular_top_level_message
;
1085 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
1086 if (command_loop_level
> 0 || minibuf_level
> 0)
1089 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1090 executing_kbd_macro
= Qnil
;
1096 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1097 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1098 executing_kbd_macro
= Qnil
;
1100 /* End of file in -batch run causes exit here. */
1106 /* Here we catch errors in execution of commands within the
1107 editing loop, and reenter the editing loop.
1108 When there is an error, cmd_error runs and returns a non-nil
1109 value to us. A value of nil means that command_loop_1 itself
1110 returned due to end of file (or end of kbd macro). */
1113 command_loop_2 (Lisp_Object ignore
)
1115 register Lisp_Object val
;
1118 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1119 while (!NILP (val
));
1127 return Feval (Vtop_level
, Qnil
);
1131 top_level_1 (Lisp_Object ignore
)
1133 /* On entry to the outer level, run the startup file. */
1134 if (!NILP (Vtop_level
))
1135 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1136 else if (!NILP (Vpurify_flag
))
1137 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1139 message1 ("Bare Emacs (standard Lisp code not loaded)");
1143 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1144 doc
: /* Exit all recursive editing levels.
1145 This also exits all active minibuffers. */
1146 attributes
: noreturn
)
1149 #ifdef HAVE_WINDOW_SYSTEM
1150 if (display_hourglass_p
)
1151 cancel_hourglass ();
1154 /* Unblock input if we enter with input blocked. This may happen if
1155 redisplay traps e.g. during tool-bar update with input blocked. */
1156 totally_unblock_input ();
1158 Fthrow (Qtop_level
, Qnil
);
1161 static _Noreturn
void
1162 user_error (const char *msg
)
1164 xsignal1 (Quser_error
, build_string (msg
));
1167 /* _Noreturn will be added to prototype by make-docfile. */
1168 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1169 doc
: /* Exit from the innermost recursive edit or minibuffer. */
1170 attributes
: noreturn
)
1173 if (command_loop_level
> 0 || minibuf_level
> 0)
1174 Fthrow (Qexit
, Qnil
);
1176 user_error ("No recursive edit is in progress");
1179 /* _Noreturn will be added to prototype by make-docfile. */
1180 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1181 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */
1182 attributes
: noreturn
)
1185 if (command_loop_level
> 0 || minibuf_level
> 0)
1188 user_error ("No recursive edit is in progress");
1191 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1192 of this function. */
1195 tracking_off (Lisp_Object old_value
)
1197 do_mouse_tracking
= old_value
;
1198 if (NILP (old_value
))
1200 /* Redisplay may have been preempted because there was input
1201 available, and it assumes it will be called again after the
1202 input has been processed. If the only input available was
1203 the sort that we have just disabled, then we need to call
1205 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1207 redisplay_preserve_echo_area (6);
1208 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1213 DEFUN ("internal--track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1214 doc
: /* Call BODYFUN with mouse movement events enabled. */)
1215 (Lisp_Object bodyfun
)
1217 ptrdiff_t count
= SPECPDL_INDEX ();
1220 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1222 do_mouse_tracking
= Qt
;
1224 val
= call0 (bodyfun
);
1225 return unbind_to (count
, val
);
1228 /* If mouse has moved on some frame, return one of those frames.
1232 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1233 after resizing the tool-bar window. */
1235 bool ignore_mouse_drag_p
;
1237 static struct frame
*
1238 some_mouse_moved (void)
1240 Lisp_Object tail
, frame
;
1242 if (ignore_mouse_drag_p
)
1244 /* ignore_mouse_drag_p = 0; */
1248 FOR_EACH_FRAME (tail
, frame
)
1250 if (XFRAME (frame
)->mouse_moved
)
1251 return XFRAME (frame
);
1258 /* This is the actual command reading loop,
1259 sans error-handling encapsulation. */
1261 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1262 bool, bool, bool, bool);
1263 static void adjust_point_for_property (ptrdiff_t, bool);
1266 command_loop_1 (void)
1268 EMACS_INT prev_modiff
= 0;
1269 struct buffer
*prev_buffer
= NULL
;
1270 bool already_adjusted
= 0;
1272 kset_prefix_arg (current_kboard
, Qnil
);
1273 kset_last_prefix_arg (current_kboard
, Qnil
);
1274 Vdeactivate_mark
= Qnil
;
1275 waiting_for_input
= false;
1278 this_command_key_count
= 0;
1279 this_single_command_key_start
= 0;
1281 if (NILP (Vmemory_full
))
1283 /* Make sure this hook runs after commands that get errors and
1284 throw to top level. */
1285 /* Note that the value cell will never directly contain nil
1286 if the symbol is a local variable. */
1287 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1288 safe_run_hooks (Qpost_command_hook
);
1290 /* If displaying a message, resize the echo area window to fit
1291 that message's size exactly. */
1292 if (!NILP (echo_area_buffer
[0]))
1293 resize_echo_area_exactly ();
1295 /* If there are warnings waiting, process them. */
1296 if (!NILP (Vdelayed_warnings_list
))
1297 safe_run_hooks (Qdelayed_warnings_hook
);
1299 if (!NILP (Vdeferred_action_list
))
1300 safe_run_hooks (Qdeferred_action_function
);
1303 /* Do this after running Vpost_command_hook, for consistency. */
1304 kset_last_command (current_kboard
, Vthis_command
);
1305 kset_real_last_command (current_kboard
, Vreal_this_command
);
1306 if (!CONSP (last_command_event
))
1307 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1312 Lisp_Object keybuf
[30];
1315 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1318 /* Make sure the current window's buffer is selected. */
1319 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1321 /* Display any malloc warning that just came out. Use while because
1322 displaying one warning can cause another. */
1324 while (pending_malloc_warning
)
1325 display_malloc_warning ();
1327 Vdeactivate_mark
= Qnil
;
1329 /* Don't ignore mouse movements for more than a single command
1330 loop. (This flag is set in xdisp.c whenever the tool bar is
1331 resized, because the resize moves text up or down, and would
1332 generate false mouse drag events if we don't ignore them.) */
1333 ignore_mouse_drag_p
= 0;
1335 /* If minibuffer on and echo area in use,
1336 wait a short time and redraw minibuffer. */
1339 && !NILP (echo_area_buffer
[0])
1340 && EQ (minibuf_window
, echo_area_window
)
1341 && NUMBERP (Vminibuffer_message_timeout
))
1343 /* Bind inhibit-quit to t so that C-g gets read in
1344 rather than quitting back to the minibuffer. */
1345 ptrdiff_t count
= SPECPDL_INDEX ();
1346 specbind (Qinhibit_quit
, Qt
);
1348 sit_for (Vminibuffer_message_timeout
, 0, 2);
1350 /* Clear the echo area. */
1352 safe_run_hooks (Qecho_area_clear_hook
);
1354 unbind_to (count
, Qnil
);
1356 /* If a C-g came in before, treat it as input now. */
1357 if (!NILP (Vquit_flag
))
1360 Vunread_command_events
= list1 (make_number (quit_char
));
1364 /* If it has changed current-menubar from previous value,
1365 really recompute the menubar from the value. */
1366 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1367 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1368 call0 (Qrecompute_lucid_menubar
);
1370 Vthis_command
= Qnil
;
1371 Vreal_this_command
= Qnil
;
1372 Vthis_original_command
= Qnil
;
1373 Vthis_command_keys_shift_translated
= Qnil
;
1375 /* Read next key sequence; i gets its length. */
1376 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1379 /* A filter may have run while we were reading the input. */
1380 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1382 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1386 /* Now we have read a key sequence of length I,
1387 or else I is 0 and we found end of file. */
1389 if (i
== 0) /* End of file -- happens only in */
1390 return Qnil
; /* a kbd macro, at the end. */
1391 /* -1 means read_key_sequence got a menu that was rejected.
1392 Just loop around and read another command. */
1396 this_command_key_count
= 0;
1397 this_single_command_key_start
= 0;
1401 last_command_event
= keybuf
[i
- 1];
1403 /* If the previous command tried to force a specific window-start,
1404 forget about that, in case this command moves point far away
1405 from that position. But also throw away beg_unchanged and
1406 end_unchanged information in that case, so that redisplay will
1407 update the whole window properly. */
1408 if (XWINDOW (selected_window
)->force_start
)
1411 XWINDOW (selected_window
)->force_start
= 0;
1412 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1413 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1416 cmd
= read_key_sequence_cmd
;
1417 if (!NILP (Vexecuting_kbd_macro
))
1419 if (!NILP (Vquit_flag
))
1421 Vexecuting_kbd_macro
= Qt
;
1422 QUIT
; /* Make some noise. */
1423 /* Will return since macro now empty. */
1427 /* Do redisplay processing after this command except in special
1428 cases identified below. */
1429 prev_buffer
= current_buffer
;
1430 prev_modiff
= MODIFF
;
1431 last_point_position
= PT
;
1433 /* By default, we adjust point to a boundary of a region that
1434 has such a property that should be treated intangible
1435 (e.g. composition, display). But, some commands will set
1436 this variable differently. */
1437 Vdisable_point_adjustment
= Qnil
;
1439 /* Process filters and timers may have messed with deactivate-mark.
1440 reset it before we execute the command. */
1441 Vdeactivate_mark
= Qnil
;
1443 /* Remap command through active keymaps. */
1444 Vthis_original_command
= cmd
;
1445 if (!NILP (read_key_sequence_remapped
))
1446 cmd
= read_key_sequence_remapped
;
1448 /* Execute the command. */
1451 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
1452 ASET (recent_keys
, recent_keys_index
,
1454 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1455 recent_keys_index
= 0;
1457 Vthis_command
= cmd
;
1458 Vreal_this_command
= cmd
;
1459 safe_run_hooks (Qpre_command_hook
);
1461 already_adjusted
= 0;
1463 if (NILP (Vthis_command
))
1464 /* nil means key is undefined. */
1468 /* Here for a command that isn't executed directly. */
1470 #ifdef HAVE_WINDOW_SYSTEM
1471 ptrdiff_t scount
= SPECPDL_INDEX ();
1473 if (display_hourglass_p
1474 && NILP (Vexecuting_kbd_macro
))
1476 record_unwind_protect_void (cancel_hourglass
);
1481 /* Ensure that we have added appropriate undo-boundaries as a
1482 result of changes from the last command. */
1483 call0 (Qundo_auto__add_boundary
);
1485 /* Record point and buffer, so we can put point into the undo
1486 information if necessary. */
1487 point_before_last_command_or_undo
= PT
;
1488 buffer_before_last_command_or_undo
= current_buffer
;
1490 call1 (Qcommand_execute
, Vthis_command
);
1492 #ifdef HAVE_WINDOW_SYSTEM
1493 /* Do not check display_hourglass_p here, because
1494 `command-execute' could change it, but we should cancel
1495 hourglass cursor anyway.
1496 But don't cancel the hourglass within a macro
1497 just because a command in the macro finishes. */
1498 if (NILP (Vexecuting_kbd_macro
))
1499 unbind_to (scount
, Qnil
);
1502 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1504 safe_run_hooks (Qpost_command_hook
);
1506 /* If displaying a message, resize the echo area window to fit
1507 that message's size exactly. */
1508 if (!NILP (echo_area_buffer
[0]))
1509 resize_echo_area_exactly ();
1511 /* If there are warnings waiting, process them. */
1512 if (!NILP (Vdelayed_warnings_list
))
1513 safe_run_hooks (Qdelayed_warnings_hook
);
1515 safe_run_hooks (Qdeferred_action_function
);
1517 kset_last_command (current_kboard
, Vthis_command
);
1518 kset_real_last_command (current_kboard
, Vreal_this_command
);
1519 if (!CONSP (last_command_event
))
1520 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1522 this_command_key_count
= 0;
1523 this_single_command_key_start
= 0;
1525 if (current_kboard
->immediate_echo
1526 && !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
1528 current_kboard
->immediate_echo
= false;
1529 /* Refresh the echo message. */
1535 if (!NILP (BVAR (current_buffer
, mark_active
))
1536 && !NILP (Vrun_hooks
))
1538 /* In Emacs 22, setting transient-mark-mode to `only' was a
1539 way of turning it on for just one command. This usage is
1540 obsolete, but support it anyway. */
1541 if (EQ (Vtransient_mark_mode
, Qidentity
))
1542 Vtransient_mark_mode
= Qnil
;
1543 else if (EQ (Vtransient_mark_mode
, Qonly
))
1544 Vtransient_mark_mode
= Qidentity
;
1546 if (!NILP (Vdeactivate_mark
))
1547 /* If `select-active-regions' is non-nil, this call to
1548 `deactivate-mark' also sets the PRIMARY selection. */
1549 call0 (Qdeactivate_mark
);
1552 /* Even if not deactivating the mark, set PRIMARY if
1553 `select-active-regions' is non-nil. */
1554 if (!NILP (Fwindow_system (Qnil
))
1555 /* Even if mark_active is non-nil, the actual buffer
1556 marker may not have been set yet (Bug#7044). */
1557 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1558 && (EQ (Vselect_active_regions
, Qonly
)
1559 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1560 : (!NILP (Vselect_active_regions
)
1561 && !NILP (Vtransient_mark_mode
)))
1562 && NILP (Fmemq (Vthis_command
,
1563 Vselection_inhibit_update_commands
)))
1566 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1567 if (XINT (Flength (txt
)) > 0)
1568 /* Don't set empty selections. */
1569 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1572 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1573 run_hook (intern ("activate-mark-hook"));
1576 Vsaved_region_selection
= Qnil
;
1581 if (current_buffer
== prev_buffer
1582 && XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
1583 && last_point_position
!= PT
1584 && NILP (Vdisable_point_adjustment
)
1585 && NILP (Vglobal_disable_point_adjustment
))
1587 if (last_point_position
> BEGV
1588 && last_point_position
< ZV
1589 && (composition_adjust_point (last_point_position
,
1590 last_point_position
)
1591 != last_point_position
))
1592 /* The last point was temporarily set within a grapheme
1593 cluster to prevent automatic composition. To recover
1594 the automatic composition, we must update the
1596 windows_or_buffers_changed
= 21;
1597 if (!already_adjusted
)
1598 adjust_point_for_property (last_point_position
,
1599 MODIFF
!= prev_modiff
);
1602 /* Install chars successfully executed in kbd macro. */
1604 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1605 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1606 finalize_kbd_macro_chars ();
1611 read_menu_command (void)
1613 Lisp_Object keybuf
[30];
1614 ptrdiff_t count
= SPECPDL_INDEX ();
1617 /* We don't want to echo the keystrokes while navigating the
1619 specbind (Qecho_keystrokes
, make_number (0));
1621 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1624 unbind_to (count
, Qnil
);
1626 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1628 if (i
== 0 || i
== -1)
1631 return read_key_sequence_cmd
;
1634 /* Adjust point to a boundary of a region that has such a property
1635 that should be treated intangible. For the moment, we check
1636 `composition', `display' and `invisible' properties.
1637 LAST_PT is the last position of point. */
1640 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1643 Lisp_Object val
, overlay
, tmp
;
1644 /* When called after buffer modification, we should temporarily
1645 suppress the point adjustment for automatic composition so that a
1646 user can keep inserting another character at point or keep
1647 deleting characters around point. */
1648 bool check_composition
= ! modified
;
1649 bool check_display
= true, check_invisible
= true;
1650 ptrdiff_t orig_pt
= PT
;
1652 eassert (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
);
1654 /* FIXME: cycling is probably not necessary because these properties
1655 can't be usefully combined anyway. */
1656 while (check_composition
|| check_display
|| check_invisible
)
1658 /* FIXME: check `intangible'. */
1659 if (check_composition
1660 && PT
> BEGV
&& PT
< ZV
1661 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1664 check_display
= check_invisible
= true;
1666 check_composition
= false;
1668 && PT
> BEGV
&& PT
< ZV
1669 && !NILP (val
= get_char_property_and_overlay
1670 (make_number (PT
), Qdisplay
, selected_window
,
1672 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1673 && (!OVERLAYP (overlay
)
1674 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1675 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1676 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1677 && (beg
< PT
/* && end > PT <- It's always the case. */
1678 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1681 SET_PT (PT
< last_pt
1682 ? (STRINGP (val
) && SCHARS (val
) == 0
1683 ? max (beg
- 1, BEGV
)
1686 check_composition
= check_invisible
= true;
1688 check_display
= false;
1689 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1692 bool ellipsis
= false;
1695 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1698 /* FIXME: We should stop if we find a spot between
1699 two runs of `invisible' where inserted text would
1700 be visible. This is important when we have two
1701 invisible boundaries that enclose an area: if the
1702 area is empty, we need this test in order to make
1703 it possible to place point in the middle rather
1704 than skip both boundaries. However, this code
1705 also stops anywhere in a non-sticky text-property,
1706 which breaks (e.g.) Org mode. */
1707 && (val
= Fget_pos_property (make_number (end
),
1709 TEXT_PROP_MEANS_INVISIBLE (val
))
1711 && !NILP (val
= get_char_property_and_overlay
1712 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1713 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1715 ellipsis
= ellipsis
|| inv
> 1
1716 || (OVERLAYP (overlay
)
1717 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1718 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1719 tmp
= Fnext_single_char_property_change
1720 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1721 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1725 && (val
= Fget_pos_property (make_number (beg
),
1727 TEXT_PROP_MEANS_INVISIBLE (val
))
1729 && !NILP (val
= get_char_property_and_overlay
1730 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1731 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1733 ellipsis
= ellipsis
|| inv
> 1
1734 || (OVERLAYP (overlay
)
1735 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1736 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1737 tmp
= Fprevious_single_char_property_change
1738 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1739 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1742 /* Move away from the inside area. */
1743 if (beg
< PT
&& end
> PT
)
1745 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1746 /* We haven't moved yet (so we don't need to fear
1747 infinite-looping) and we were outside the range
1748 before (so either end of the range still corresponds
1749 to a move in the right direction): pretend we moved
1750 less than we actually did, so that we still have
1751 more freedom below in choosing which end of the range
1753 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1754 /* We either have moved already or the last point
1755 was already in the range: we don't get to choose
1756 which end of the range we have to go to. */
1757 : (PT
< last_pt
? beg
: end
));
1758 check_composition
= check_display
= true;
1760 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1761 the point to something other than its argument, due to
1762 point-motion hooks, intangibility, etc. */
1763 eassert (PT
== beg
|| PT
== end
);
1766 /* Pretend the area doesn't exist if the buffer is not
1768 if (!modified
&& !ellipsis
&& beg
< end
)
1770 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1771 (check_composition
= check_display
= true, SET_PT (end
+ 1));
1772 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1773 (check_composition
= check_display
= true, SET_PT (beg
- 1));
1774 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1775 /* We've already moved as far as we can. Trying to go
1776 to the other end would mean moving backwards and thus
1777 could lead to an infinite loop. */
1779 else if (val
= Fget_pos_property (make_number (PT
),
1781 TEXT_PROP_MEANS_INVISIBLE (val
)
1782 && (val
= (Fget_pos_property
1783 (make_number (PT
== beg
? end
: beg
),
1785 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1786 (check_composition
= check_display
= true,
1787 SET_PT (PT
== beg
? end
: beg
));
1790 check_invisible
= false;
1794 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1797 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1799 eassert (nargs
== 2);
1800 return call0 (args
[1]);
1803 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1807 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1809 eassert (nargs
== 2);
1810 AUTO_STRING (format
, "Error in %s (%S): %S");
1811 Lisp_Object hook
= args
[0];
1812 Lisp_Object fun
= args
[1];
1813 CALLN (Fmessage
, format
, hook
, fun
, error
);
1819 Lisp_Object newval
= Qnil
;
1820 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1821 if (EQ (fun
, XCAR (val
)))
1824 newval
= Fcons (XCAR (val
), newval
);
1826 return Fset (hook
, Fnreverse (newval
));
1827 /* Not found in the local part of the hook. Let's look at the global
1830 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1831 : Fdefault_value (hook
));
1832 CONSP (val
); val
= XCDR (val
))
1833 if (EQ (fun
, XCAR (val
)))
1836 newval
= Fcons (XCAR (val
), newval
);
1838 return Fset_default (hook
, Fnreverse (newval
));
1844 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1846 eassert (nargs
== 2);
1847 /* Yes, run_hook_with_args works with args in the other order. */
1848 internal_condition_case_n (safe_run_hooks_1
,
1849 2, ((Lisp_Object
[]) {args
[1], args
[0]}),
1850 Qt
, safe_run_hooks_error
);
1854 /* If we get an error while running the hook, cause the hook variable
1855 to be nil. Also inhibit quits, so that C-g won't cause the hook
1856 to mysteriously evaporate. */
1859 safe_run_hooks (Lisp_Object hook
)
1861 ptrdiff_t count
= SPECPDL_INDEX ();
1863 specbind (Qinhibit_quit
, Qt
);
1864 run_hook_with_args (2, ((Lisp_Object
[]) {hook
, hook
}), safe_run_hook_funcall
);
1865 unbind_to (count
, Qnil
);
1869 /* Nonzero means polling for input is temporarily suppressed. */
1871 int poll_suppress_count
;
1874 #ifdef POLL_FOR_INPUT
1876 /* Asynchronous timer for polling. */
1878 static struct atimer
*poll_timer
;
1880 /* Poll for input, so that we catch a C-g if it comes in. */
1882 poll_for_input_1 (void)
1884 if (! input_blocked_p ()
1885 && !waiting_for_input
)
1889 /* Timer callback function for poll_timer. TIMER is equal to
1893 poll_for_input (struct atimer
*timer
)
1895 if (poll_suppress_count
== 0)
1896 pending_signals
= true;
1899 #endif /* POLL_FOR_INPUT */
1901 /* Begin signals to poll for input, if they are appropriate.
1902 This function is called unconditionally from various places. */
1905 start_polling (void)
1907 #ifdef POLL_FOR_INPUT
1908 /* XXX This condition was (read_socket_hook && !interrupt_input),
1909 but read_socket_hook is not global anymore. Let's pretend that
1911 if (!interrupt_input
)
1913 /* Turn alarm handling on unconditionally. It might have
1914 been turned off in process.c. */
1915 turn_on_atimers (1);
1917 /* If poll timer doesn't exist, or we need one with
1918 a different interval, start a new one. */
1919 if (poll_timer
== NULL
1920 || poll_timer
->interval
.tv_sec
!= polling_period
)
1922 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1923 struct timespec interval
= make_timespec (period
, 0);
1926 cancel_atimer (poll_timer
);
1928 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1929 poll_for_input
, NULL
);
1932 /* Let the timer's callback function poll for input
1933 if this becomes zero. */
1934 --poll_suppress_count
;
1939 /* True if we are using polling to handle input asynchronously. */
1942 input_polling_used (void)
1944 #ifdef POLL_FOR_INPUT
1945 /* XXX This condition was (read_socket_hook && !interrupt_input),
1946 but read_socket_hook is not global anymore. Let's pretend that
1948 return !interrupt_input
;
1954 /* Turn off polling. */
1959 #ifdef POLL_FOR_INPUT
1960 /* XXX This condition was (read_socket_hook && !interrupt_input),
1961 but read_socket_hook is not global anymore. Let's pretend that
1963 if (!interrupt_input
)
1964 ++poll_suppress_count
;
1968 /* Set the value of poll_suppress_count to COUNT
1969 and start or stop polling accordingly. */
1972 set_poll_suppress_count (int count
)
1974 #ifdef POLL_FOR_INPUT
1975 if (count
== 0 && poll_suppress_count
!= 0)
1977 poll_suppress_count
= 1;
1980 else if (count
!= 0 && poll_suppress_count
== 0)
1984 poll_suppress_count
= count
;
1988 /* Bind polling_period to a value at least N.
1989 But don't decrease it. */
1992 bind_polling_period (int n
)
1994 #ifdef POLL_FOR_INPUT
1995 EMACS_INT
new = polling_period
;
2000 stop_other_atimers (poll_timer
);
2002 specbind (Qpolling_period
, make_number (new));
2003 /* Start a new alarm with the new period. */
2008 /* Apply the control modifier to CHARACTER. */
2011 make_ctrl_char (int c
)
2013 /* Save the upper bits here. */
2014 int upper
= c
& ~0177;
2016 if (! ASCII_CHAR_P (c
))
2017 return c
|= ctrl_modifier
;
2021 /* Everything in the columns containing the upper-case letters
2022 denotes a control character. */
2023 if (c
>= 0100 && c
< 0140)
2027 /* Set the shift modifier for a control char
2028 made from a shifted letter. But only for letters! */
2029 if (oc
>= 'A' && oc
<= 'Z')
2030 c
|= shift_modifier
;
2033 /* The lower-case letters denote control characters too. */
2034 else if (c
>= 'a' && c
<= 'z')
2037 /* Include the bits for control and shift
2038 only if the basic ASCII code can't indicate them. */
2042 /* Replace the high bits. */
2043 c
|= (upper
& ~ctrl_modifier
);
2048 /* Display the help-echo property of the character after the mouse pointer.
2049 Either show it in the echo area, or call show-help-function to display
2050 it by other means (maybe in a tooltip).
2052 If HELP is nil, that means clear the previous help echo.
2054 If HELP is a string, display that string. If HELP is a function,
2055 call it with OBJECT and POS as arguments; the function should
2056 return a help string or nil for none. For all other types of HELP,
2057 evaluate it to obtain a string.
2059 WINDOW is the window in which the help was generated, if any.
2060 It is nil if not in a window.
2062 If OBJECT is a buffer, POS is the position in the buffer where the
2063 `help-echo' text property was found.
2065 If OBJECT is an overlay, that overlay has a `help-echo' property,
2066 and POS is the position in the overlay's buffer under the mouse.
2068 If OBJECT is a string (an overlay string or a string displayed with
2069 the `display' property). POS is the position in that string under
2072 Note: this function may only be called with HELP nil or a string
2073 from X code running asynchronously. */
2076 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2079 if (!NILP (help
) && !STRINGP (help
))
2081 if (FUNCTIONP (help
))
2082 help
= safe_call (4, help
, window
, object
, pos
);
2084 help
= safe_eval (help
);
2086 if (!STRINGP (help
))
2090 if (!noninteractive
&& STRINGP (help
))
2092 /* The mouse-fixup-help-message Lisp function can call
2093 mouse_position_hook, which resets the mouse_moved flags.
2094 This causes trouble if we are trying to read a mouse motion
2095 event (i.e., if we are inside a `track-mouse' form), so we
2096 restore the mouse_moved flag. */
2097 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2098 help
= call1 (Qmouse_fixup_help_message
, help
);
2100 f
->mouse_moved
= true;
2103 if (STRINGP (help
) || NILP (help
))
2105 if (!NILP (Vshow_help_function
))
2106 call1 (Vshow_help_function
, Fsubstitute_command_keys (help
));
2107 help_echo_showing_p
= STRINGP (help
);
2113 /* Input of single characters from keyboard. */
2115 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2116 struct timespec
*end_time
);
2117 static void record_char (Lisp_Object c
);
2119 static Lisp_Object help_form_saved_window_configs
;
2121 read_char_help_form_unwind (void)
2123 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2124 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2125 if (!NILP (window_config
))
2126 Fset_window_configuration (window_config
);
2129 #define STOP_POLLING \
2130 do { if (! polling_stopped_here) stop_polling (); \
2131 polling_stopped_here = true; } while (0)
2133 #define RESUME_POLLING \
2134 do { if (polling_stopped_here) start_polling (); \
2135 polling_stopped_here = false; } while (0)
2138 read_event_from_main_queue (struct timespec
*end_time
,
2139 sys_jmp_buf local_getcjmp
,
2140 bool *used_mouse_menu
)
2142 Lisp_Object c
= Qnil
;
2143 sys_jmp_buf save_jump
;
2148 /* Read from the main queue, and if that gives us something we can't use yet,
2149 we put it on the appropriate side queue and try again. */
2151 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2154 /* Actually read a character, waiting if necessary. */
2155 save_getcjmp (save_jump
);
2156 restore_getcjmp (local_getcjmp
);
2158 timer_start_idle ();
2159 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2160 restore_getcjmp (save_jump
);
2162 if (! NILP (c
) && (kb
!= current_kboard
))
2164 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2167 while (CONSP (XCDR (last
)))
2169 if (!NILP (XCDR (last
)))
2173 kset_kbd_queue (kb
, list1 (c
));
2175 XSETCDR (last
, list1 (c
));
2176 kb
->kbd_queue_has_data
= true;
2180 current_kboard
= kb
;
2181 return make_number (-2);
2184 /* Terminate Emacs in batch mode if at eof. */
2185 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2186 Fkill_emacs (make_number (1));
2190 /* Add in any extra modifiers, where appropriate. */
2191 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2192 || ((extra_keyboard_modifiers
& 0177) < ' '
2193 && (extra_keyboard_modifiers
& 0177) != 0))
2194 XSETINT (c
, make_ctrl_char (XINT (c
)));
2196 /* Transfer any other modifier bits directly from
2197 extra_keyboard_modifiers to c. Ignore the actual character code
2198 in the low 16 bits of extra_keyboard_modifiers. */
2199 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2207 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2210 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2211 sys_jmp_buf local_getcjmp
,
2212 Lisp_Object prev_event
,
2213 bool *used_mouse_menu
)
2216 #define MAX_ENCODED_BYTES 16
2217 Lisp_Object events
[MAX_ENCODED_BYTES
];
2223 = read_event_from_main_queue (end_time
, local_getcjmp
,
2226 /* w32_console already returns decoded events. It either reads
2227 Unicode characters from the Windows keyboard input, or
2228 converts characters encoded in the current codepage into
2229 Unicode. See w32inevt.c:key_event, near its end. */
2232 struct frame
*frame
= XFRAME (selected_frame
);
2233 struct terminal
*terminal
= frame
->terminal
;
2234 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2235 /* Don't apply decoding if we're just reading a raw event
2236 (e.g. reading bytes sent by the xterm to specify the position
2237 of a mouse click). */
2238 && (!EQ (prev_event
, Qt
))
2239 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2240 & CODING_REQUIRE_DECODING_MASK
)))
2241 return nextevt
; /* No decoding needed. */
2244 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2245 eassert (n
< MAX_ENCODED_BYTES
);
2246 events
[n
++] = nextevt
;
2247 if (NATNUMP (nextevt
)
2248 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2249 { /* An encoded byte sequence, let's try to decode it. */
2250 struct coding_system
*coding
2251 = TERMINAL_KEYBOARD_CODING (terminal
);
2253 if (raw_text_coding_system_p (coding
))
2257 for (i
= 0; i
< n
; i
++)
2258 events
[i
] = make_number (XINT (events
[i
]) & ~0x80);
2262 unsigned char src
[MAX_ENCODED_BYTES
];
2263 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2265 for (i
= 0; i
< n
; i
++)
2266 src
[i
] = XINT (events
[i
]);
2268 for (i
= 0; i
< n
; i
++)
2270 coding
->destination
= dest
;
2271 coding
->dst_bytes
= sizeof dest
;
2272 decode_coding_c_string (coding
, src
, n
, Qnil
);
2273 eassert (coding
->produced_char
<= n
);
2274 if (coding
->produced_char
== 0)
2275 { /* The encoded sequence is incomplete. */
2276 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2277 continue; /* Read on! */
2281 const unsigned char *p
= coding
->destination
;
2282 eassert (coding
->carryover_bytes
== 0);
2284 while (n
< coding
->produced_char
)
2285 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2289 /* Now `events' should hold decoded events.
2290 Normally, n should be equal to 1, but better not rely on it.
2291 We can only return one event here, so return the first we
2292 had and keep the others (if any) for later. */
2294 Vunread_command_events
2295 = Fcons (events
[--n
], Vunread_command_events
);
2302 /* Read a character from the keyboard; call the redisplay if needed. */
2303 /* commandflag 0 means do not autosave, but do redisplay.
2304 -1 means do not redisplay, but do autosave.
2305 -2 means do neither.
2308 The argument MAP is a keymap for menu prompting.
2310 PREV_EVENT is the previous input event, or nil if we are reading
2311 the first event of a key sequence (or not reading a key sequence).
2312 If PREV_EVENT is t, that is a "magic" value that says
2313 not to run input methods, but in other respects to act as if
2314 not reading a key sequence.
2316 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2317 if we used a mouse menu to read the input, or false otherwise. If
2318 USED_MOUSE_MENU is null, don't dereference it.
2320 Value is -2 when we find input on another keyboard. A second call
2321 to read_char will read it.
2323 If END_TIME is non-null, it is a pointer to a struct timespec
2324 specifying the maximum time to wait until. If no input arrives by
2325 that time, stop waiting and return nil.
2327 Value is t if we showed a menu and the user rejected it. */
2330 read_char (int commandflag
, Lisp_Object map
,
2331 Lisp_Object prev_event
,
2332 bool *used_mouse_menu
, struct timespec
*end_time
)
2336 sys_jmp_buf local_getcjmp
;
2337 sys_jmp_buf save_jump
;
2338 Lisp_Object tem
, save
;
2339 volatile Lisp_Object previous_echo_area_message
;
2340 volatile Lisp_Object also_record
;
2341 volatile bool reread
, recorded
;
2342 bool volatile polling_stopped_here
= false;
2343 struct kboard
*orig_kboard
= current_kboard
;
2348 previous_echo_area_message
= Qnil
;
2354 if (CONSP (Vunread_post_input_method_events
))
2356 c
= XCAR (Vunread_post_input_method_events
);
2357 Vunread_post_input_method_events
2358 = XCDR (Vunread_post_input_method_events
);
2360 /* Undo what read_char_x_menu_prompt did when it unread
2361 additional keys returned by Fx_popup_menu. */
2363 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2374 if (CONSP (Vunread_command_events
))
2376 bool was_disabled
= false;
2378 c
= XCAR (Vunread_command_events
);
2379 Vunread_command_events
= XCDR (Vunread_command_events
);
2381 /* Undo what sit-for did when it unread additional keys
2382 inside universal-argument. */
2384 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2389 /* Undo what read_char_x_menu_prompt did when it unread
2390 additional keys returned by Fx_popup_menu. */
2392 && EQ (XCDR (c
), Qdisabled
)
2393 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2395 was_disabled
= true;
2399 /* If the queued event is something that used the mouse,
2400 set used_mouse_menu accordingly. */
2402 /* Also check was_disabled so last-nonmenu-event won't return
2403 a bad value when submenus are involved. (Bug#447) */
2404 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2405 *used_mouse_menu
= true;
2407 goto reread_for_input_method
;
2410 if (CONSP (Vunread_input_method_events
))
2412 c
= XCAR (Vunread_input_method_events
);
2413 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2415 /* Undo what read_char_x_menu_prompt did when it unread
2416 additional keys returned by Fx_popup_menu. */
2418 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2422 goto reread_for_input_method
;
2425 if (!NILP (Vexecuting_kbd_macro
))
2427 /* We set this to Qmacro; since that's not a frame, nobody will
2428 try to switch frames on us, and the selected window will
2431 Since this event came from a macro, it would be misleading to
2432 leave internal_last_event_frame set to wherever the last
2433 real event came from. Normally, a switch-frame event selects
2434 internal_last_event_frame after each command is read, but
2435 events read from a macro should never cause a new frame to be
2437 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2439 /* Exit the macro if we are at the end.
2440 Also, some things replace the macro with t
2441 to force an early exit. */
2442 if (EQ (Vexecuting_kbd_macro
, Qt
)
2443 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2449 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2450 if (STRINGP (Vexecuting_kbd_macro
)
2451 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2452 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2454 executing_kbd_macro_index
++;
2459 if (!NILP (unread_switch_frame
))
2461 c
= unread_switch_frame
;
2462 unread_switch_frame
= Qnil
;
2464 /* This event should make it into this_command_keys, and get echoed
2465 again, so we do not set `reread'. */
2469 /* If redisplay was requested. */
2470 if (commandflag
>= 0)
2472 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2474 /* If there is pending input, process any events which are not
2475 user-visible, such as X selection_request events. */
2477 || detect_input_pending_run_timers (0))
2478 swallow_events (false); /* May clear input_pending. */
2480 /* Redisplay if no pending input. */
2481 while (!(input_pending
2482 && (input_was_pending
|| !redisplay_dont_pause
)))
2484 input_was_pending
= input_pending
;
2485 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2486 redisplay_preserve_echo_area (5);
2491 /* Normal case: no input arrived during redisplay. */
2494 /* Input arrived and pre-empted redisplay.
2495 Process any events which are not user-visible. */
2496 swallow_events (false);
2497 /* If that cleared input_pending, try again to redisplay. */
2500 /* Prevent the redisplay we just did
2501 from messing up echoing of the input after the prompt. */
2502 if (commandflag
== 0 && echo_current
)
2503 echo_message_buffer
= echo_area_buffer
[0];
2507 /* Message turns off echoing unless more keystrokes turn it on again.
2509 The code in 20.x for the condition was
2511 1. echo_area_glyphs && *echo_area_glyphs
2512 2. && echo_area_glyphs != current_kboard->echobuf
2513 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2515 (1) means there's a current message displayed
2517 (2) means it's not the message from echoing from the current
2520 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2521 is set to a non-null value. This is done in read_char and it is
2522 set to echo_area_glyphs. That means
2523 ok_to_echo_at_next_pause is either null or
2524 current_kboard->echobuf with the appropriate current_kboard at
2527 So, condition (3) means in clear text ok_to_echo_at_next_pause
2528 must be either null, or the current message isn't from echoing at
2529 all, or it's from echoing from a different kboard than the
2532 if (/* There currently is something in the echo area. */
2533 !NILP (echo_area_buffer
[0])
2534 && (/* It's an echo from a different kboard. */
2535 echo_kboard
!= current_kboard
2536 /* Or we explicitly allow overwriting whatever there is. */
2537 || ok_to_echo_at_next_pause
== NULL
))
2542 /* Try reading a character via menu prompting in the minibuf.
2543 Try this before the sit-for, because the sit-for
2544 would do the wrong thing if we are supposed to do
2545 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2546 after a mouse event so don't try a minibuf menu. */
2548 if (KEYMAPP (map
) && INTERACTIVE
2549 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2550 /* Don't bring up a menu if we already have another event. */
2551 && !CONSP (Vunread_command_events
)
2552 && !detect_input_pending_run_timers (0))
2554 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2556 if (INTEGERP (c
) && XINT (c
) == -2)
2557 return c
; /* wrong_kboard_jmpbuf */
2563 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2564 We will do that below, temporarily for short sections of code,
2565 when appropriate. local_getcjmp must be in effect
2566 around any call to sit_for or kbd_buffer_get_event;
2567 it *must not* be in effect when we call redisplay. */
2569 jmpcount
= SPECPDL_INDEX ();
2570 if (sys_setjmp (local_getcjmp
))
2572 /* Handle quits while reading the keyboard. */
2573 /* We must have saved the outer value of getcjmp here,
2574 so restore it now. */
2575 restore_getcjmp (save_jump
);
2576 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2577 unbind_to (jmpcount
, Qnil
);
2578 XSETINT (c
, quit_char
);
2579 internal_last_event_frame
= selected_frame
;
2580 Vlast_event_frame
= internal_last_event_frame
;
2581 /* If we report the quit char as an event,
2582 don't do so more than once. */
2583 if (!NILP (Vinhibit_quit
))
2587 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2588 if (kb
!= current_kboard
)
2590 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2591 /* We shouldn't get here if we were in single-kboard mode! */
2596 while (CONSP (XCDR (last
)))
2598 if (!NILP (XCDR (last
)))
2602 kset_kbd_queue (kb
, list1 (c
));
2604 XSETCDR (last
, list1 (c
));
2605 kb
->kbd_queue_has_data
= true;
2606 current_kboard
= kb
;
2607 return make_number (-2); /* wrong_kboard_jmpbuf */
2613 /* Start idle timers if no time limit is supplied. We don't do it
2614 if a time limit is supplied to avoid an infinite recursion in the
2615 situation where an idle timer calls `sit-for'. */
2618 timer_start_idle ();
2620 /* If in middle of key sequence and minibuffer not active,
2621 start echoing if enough time elapses. */
2623 if (minibuf_level
== 0
2625 && !current_kboard
->immediate_echo
2626 && (this_command_key_count
> 0
2627 || !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
2629 && echo_keystrokes_p ()
2630 && (/* No message. */
2631 NILP (echo_area_buffer
[0])
2632 /* Or empty message. */
2633 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2634 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2635 /* Or already echoing from same kboard. */
2636 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2637 /* Or not echoing before and echoing allowed. */
2638 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2640 /* After a mouse event, start echoing right away.
2641 This is because we are probably about to display a menu,
2642 and we don't want to delay before doing so. */
2643 if (EVENT_HAS_PARAMETERS (prev_event
))
2649 save_getcjmp (save_jump
);
2650 restore_getcjmp (local_getcjmp
);
2651 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2652 restore_getcjmp (save_jump
);
2654 && ! CONSP (Vunread_command_events
))
2659 /* Maybe auto save due to number of keystrokes. */
2661 if (commandflag
!= 0 && commandflag
!= -2
2662 && auto_save_interval
> 0
2663 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2664 && !detect_input_pending_run_timers (0))
2666 Fdo_auto_save (Qnil
, Qnil
);
2667 /* Hooks can actually change some buffers in auto save. */
2671 /* Try reading using an X menu.
2672 This is never confused with reading using the minibuf
2673 because the recursive call of read_char in read_char_minibuf_menu_prompt
2674 does not pass on any keymaps. */
2676 if (KEYMAPP (map
) && INTERACTIVE
2677 && !NILP (prev_event
)
2678 && EVENT_HAS_PARAMETERS (prev_event
)
2679 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2680 && !EQ (XCAR (prev_event
), Qtool_bar
)
2681 /* Don't bring up a menu if we already have another event. */
2682 && !CONSP (Vunread_command_events
))
2684 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2686 /* Now that we have read an event, Emacs is not idle. */
2693 /* Maybe autosave and/or garbage collect due to idleness. */
2695 if (INTERACTIVE
&& NILP (c
))
2698 ptrdiff_t buffer_size
;
2700 /* Slow down auto saves logarithmically in size of current buffer,
2701 and garbage collect while we're at it. */
2702 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2703 last_non_minibuf_size
= Z
- BEG
;
2704 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2706 while (buffer_size
> 64)
2707 delay_level
++, buffer_size
-= buffer_size
>> 2;
2708 if (delay_level
< 4) delay_level
= 4;
2709 /* delay_level is 4 for files under around 50k, 7 at 100k,
2710 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2712 /* Auto save if enough time goes by without input. */
2713 if (commandflag
!= 0 && commandflag
!= -2
2714 && num_nonmacro_input_events
> last_auto_save
2715 && INTEGERP (Vauto_save_timeout
)
2716 && XINT (Vauto_save_timeout
) > 0)
2719 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2721 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2722 timeout
= delay_level
* timeout
/ 4;
2723 save_getcjmp (save_jump
);
2724 restore_getcjmp (local_getcjmp
);
2725 tem0
= sit_for (make_number (timeout
), 1, 1);
2726 restore_getcjmp (save_jump
);
2729 && ! CONSP (Vunread_command_events
))
2731 Fdo_auto_save (Qnil
, Qnil
);
2736 /* If there is still no input available, ask for GC. */
2737 if (!detect_input_pending_run_timers (0))
2741 /* Notify the caller if an autosave hook, or a timer, sentinel or
2742 filter in the sit_for calls above have changed the current
2743 kboard. This could happen if they use the minibuffer or start a
2744 recursive edit, like the fancy splash screen in server.el's
2745 filter. If this longjmp wasn't here, read_key_sequence would
2746 interpret the next key sequence using the wrong translation
2747 tables and function keymaps. */
2748 if (NILP (c
) && current_kboard
!= orig_kboard
)
2749 return make_number (-2); /* wrong_kboard_jmpbuf */
2751 /* If this has become non-nil here, it has been set by a timer
2752 or sentinel or filter. */
2753 if (CONSP (Vunread_command_events
))
2755 c
= XCAR (Vunread_command_events
);
2756 Vunread_command_events
= XCDR (Vunread_command_events
);
2758 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2764 /* Read something from current KBOARD's side queue, if possible. */
2768 if (current_kboard
->kbd_queue_has_data
)
2770 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2772 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2773 kset_kbd_queue (current_kboard
,
2774 XCDR (KVAR (current_kboard
, kbd_queue
)));
2775 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2776 current_kboard
->kbd_queue_has_data
= false;
2777 input_pending
= readable_events (0);
2778 if (EVENT_HAS_PARAMETERS (c
)
2779 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2780 internal_last_event_frame
= XCAR (XCDR (c
));
2781 Vlast_event_frame
= internal_last_event_frame
;
2785 /* If current_kboard's side queue is empty check the other kboards.
2786 If one of them has data that we have not yet seen here,
2787 switch to it and process the data waiting for it.
2789 Note: if the events queued up for another kboard
2790 have already been seen here, and therefore are not a complete command,
2791 the kbd_queue_has_data field is 0, so we skip that kboard here.
2792 That's to avoid an infinite loop switching between kboards here. */
2793 if (NILP (c
) && !single_kboard
)
2796 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2797 if (kb
->kbd_queue_has_data
)
2799 current_kboard
= kb
;
2800 return make_number (-2); /* wrong_kboard_jmpbuf */
2810 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2811 prev_event
, used_mouse_menu
);
2812 if (NILP (c
) && end_time
2813 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2818 if (EQ (c
, make_number (-2)))
2830 if (commandflag
>= 0
2831 && !input_pending
&& !detect_input_pending_run_timers (0))
2837 /* Buffer switch events are only for internal wakeups
2838 so don't show them to the user.
2839 Also, don't record a key if we already did. */
2843 /* Process special events within read_char
2844 and loop around to read another event. */
2847 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2852 struct buffer
*prev_buffer
= current_buffer
;
2853 last_input_event
= c
;
2854 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2857 && (EQ (XCAR (c
), Qselect_window
)
2859 || EQ (XCAR (c
), Qdbus_event
)
2861 #ifdef USE_FILE_NOTIFY
2862 || EQ (XCAR (c
), Qfile_notify
)
2864 || EQ (XCAR (c
), Qconfig_changed_event
))
2866 /* We stopped being idle for this event; undo that. This
2867 prevents automatic window selection (under
2868 mouse-autoselect-window) from acting as a real input event, for
2869 example banishing the mouse under mouse-avoidance-mode. */
2870 timer_resume_idle ();
2872 if (current_buffer
!= prev_buffer
)
2874 /* The command may have changed the keymaps. Pretend there
2875 is input in another keyboard and return. This will
2876 recalculate keymaps. */
2877 c
= make_number (-2);
2884 /* Handle things that only apply to characters. */
2887 /* If kbd_buffer_get_event gave us an EOF, return that. */
2891 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2892 && UNSIGNED_CMP (XFASTINT (c
), <,
2893 SCHARS (KVAR (current_kboard
,
2894 Vkeyboard_translate_table
))))
2895 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2896 && UNSIGNED_CMP (XFASTINT (c
), <,
2897 ASIZE (KVAR (current_kboard
,
2898 Vkeyboard_translate_table
))))
2899 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2903 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2904 /* nil in keyboard-translate-table means no translation. */
2910 /* If this event is a mouse click in the menu bar,
2911 return just menu-bar for now. Modify the mouse click event
2912 so we won't do this twice, then queue it up. */
2913 if (EVENT_HAS_PARAMETERS (c
)
2915 && CONSP (EVENT_START (c
))
2916 && CONSP (XCDR (EVENT_START (c
))))
2920 posn
= POSN_POSN (EVENT_START (c
));
2921 /* Handle menu-bar events:
2922 insert the dummy prefix event `menu-bar'. */
2923 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2925 /* Change menu-bar to (menu-bar) as the event "position". */
2926 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2929 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2934 /* Store these characters into recent_keys, the dribble file if any,
2935 and the keyboard macro being defined, if any. */
2938 if (! NILP (also_record
))
2939 record_char (also_record
);
2941 /* Wipe the echo area.
2942 But first, if we are about to use an input method,
2943 save the echo area contents for it to refer to. */
2945 && ! NILP (Vinput_method_function
)
2946 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2948 previous_echo_area_message
= Fcurrent_message ();
2949 Vinput_method_previous_message
= previous_echo_area_message
;
2952 /* Now wipe the echo area, except for help events which do their
2953 own stuff with the echo area. */
2955 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2956 && !(EQ (Qswitch_frame
, XCAR (c
)))
2957 /* Don't wipe echo area for select window events: These might
2958 get delayed via `mouse-autoselect-window' (Bug#11304). */
2959 && !(EQ (Qselect_window
, XCAR (c
)))))
2961 if (!NILP (echo_area_buffer
[0]))
2963 safe_run_hooks (Qecho_area_clear_hook
);
2964 clear_message (1, 0);
2968 reread_for_input_method
:
2970 /* Pass this to the input method, if appropriate. */
2972 && ! NILP (Vinput_method_function
)
2973 /* Don't run the input method within a key sequence,
2974 after the first event of the key sequence. */
2975 && NILP (prev_event
)
2976 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2979 ptrdiff_t key_count
;
2980 ptrdiff_t command_key_start
;
2981 ptrdiff_t count
= SPECPDL_INDEX ();
2983 /* Save the echo status. */
2984 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2985 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2986 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2987 Lisp_Object saved_echo_prompt
= KVAR (current_kboard
, echo_prompt
);
2989 /* Save the this_command_keys status. */
2990 key_count
= this_command_key_count
;
2991 command_key_start
= this_single_command_key_start
;
2994 keys
= Fcopy_sequence (this_command_keys
);
2998 /* Clear out this_command_keys. */
2999 this_command_key_count
= 0;
3000 this_single_command_key_start
= 0;
3002 /* Now wipe the echo area. */
3003 if (!NILP (echo_area_buffer
[0]))
3004 safe_run_hooks (Qecho_area_clear_hook
);
3005 clear_message (1, 0);
3008 /* If we are not reading a key sequence,
3009 never use the echo area. */
3012 specbind (Qinput_method_use_echo_area
, Qt
);
3015 /* Call the input method. */
3016 tem
= call1 (Vinput_method_function
, c
);
3018 tem
= unbind_to (count
, tem
);
3020 /* Restore the saved echoing state
3021 and this_command_keys state. */
3022 this_command_key_count
= key_count
;
3023 this_single_command_key_start
= command_key_start
;
3025 this_command_keys
= keys
;
3028 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3029 kset_echo_string (current_kboard
, saved_echo_string
);
3030 kset_echo_prompt (current_kboard
, saved_echo_prompt
);
3031 if (saved_immediate_echo
)
3034 /* The input method can return no events. */
3037 /* Bring back the previous message, if any. */
3038 if (! NILP (previous_echo_area_message
))
3039 message_with_string ("%s", previous_echo_area_message
, 0);
3042 /* It returned one event or more. */
3044 Vunread_post_input_method_events
3045 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3047 /* When we consume events from the various unread-*-events lists, we
3048 bypass the code that records input, so record these events now if
3049 they were not recorded already. */
3058 /* Display help if not echoing. */
3059 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3061 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3062 Lisp_Object help
, object
, position
, window
, htem
;
3064 htem
= Fcdr (XCDR (c
));
3067 window
= Fcar (htem
);
3069 object
= Fcar (htem
);
3071 position
= Fcar (htem
);
3073 show_help_echo (help
, window
, object
, position
);
3075 /* We stopped being idle for this event; undo that. */
3077 timer_resume_idle ();
3081 if ((! reread
|| this_command_key_count
== 0)
3085 /* Don't echo mouse motion events. */
3086 if (! (EVENT_HAS_PARAMETERS (c
)
3087 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3088 /* Once we reread a character, echoing can happen
3089 the next time we pause to read a new one. */
3090 ok_to_echo_at_next_pause
= current_kboard
;
3092 /* Record this character as part of the current key. */
3093 add_command_key (c
);
3094 if (! NILP (also_record
))
3095 add_command_key (also_record
);
3100 last_input_event
= c
;
3103 /* Process the help character specially if enabled. */
3104 if (!NILP (Vhelp_form
) && help_char_p (c
))
3106 ptrdiff_t count
= SPECPDL_INDEX ();
3108 help_form_saved_window_configs
3109 = Fcons (Fcurrent_window_configuration (Qnil
),
3110 help_form_saved_window_configs
);
3111 record_unwind_protect_void (read_char_help_form_unwind
);
3112 call0 (Qhelp_form_show
);
3117 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3118 if (EVENT_HAS_PARAMETERS (c
)
3119 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3120 XSETCAR (help_form_saved_window_configs
, Qnil
);
3122 while (BUFFERP (c
));
3123 /* Remove the help from the frame. */
3124 unbind_to (count
, Qnil
);
3127 if (EQ (c
, make_number (040)))
3131 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3132 while (BUFFERP (c
));
3138 input_was_pending
= input_pending
;
3142 /* Record a key that came from a mouse menu.
3143 Record it for echoing, for this-command-keys, and so on. */
3146 record_menu_key (Lisp_Object c
)
3148 /* Wipe the echo area. */
3149 clear_message (1, 0);
3153 /* Once we reread a character, echoing can happen
3154 the next time we pause to read a new one. */
3155 ok_to_echo_at_next_pause
= NULL
;
3157 /* Record this character as part of the current key. */
3158 add_command_key (c
);
3161 /* Re-reading in the middle of a command. */
3162 last_input_event
= c
;
3166 /* Return true if should recognize C as "the help character". */
3169 help_char_p (Lisp_Object c
)
3173 if (EQ (c
, Vhelp_char
))
3175 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3176 if (EQ (c
, XCAR (tail
)))
3181 /* Record the input event C in various ways. */
3184 record_char (Lisp_Object c
)
3188 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3190 /* To avoid filling recent_keys with help-echo and mouse-movement
3191 events, we filter out repeated help-echo events, only store the
3192 first and last in a series of mouse-movement events, and don't
3193 store repeated help-echo events which are only separated by
3194 mouse-movement events. */
3196 Lisp_Object ev1
, ev2
, ev3
;
3199 if ((ix1
= recent_keys_index
- 1) < 0)
3200 ix1
= NUM_RECENT_KEYS
- 1;
3201 ev1
= AREF (recent_keys
, ix1
);
3203 if ((ix2
= ix1
- 1) < 0)
3204 ix2
= NUM_RECENT_KEYS
- 1;
3205 ev2
= AREF (recent_keys
, ix2
);
3207 if ((ix3
= ix2
- 1) < 0)
3208 ix3
= NUM_RECENT_KEYS
- 1;
3209 ev3
= AREF (recent_keys
, ix3
);
3211 if (EQ (XCAR (c
), Qhelp_echo
))
3213 /* Don't record `help-echo' in recent_keys unless it shows some help
3214 message, and a different help than the previously recorded
3216 Lisp_Object help
, last_help
;
3218 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3219 if (!STRINGP (help
))
3221 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3222 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3224 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3225 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3226 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3228 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3229 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3230 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3231 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3234 else if (EQ (XCAR (c
), Qmouse_movement
))
3236 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3237 So additional mouse movement events replace the last element. */
3238 Lisp_Object last_window
, window
;
3240 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3241 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3242 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3243 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3244 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3246 ASET (recent_keys
, ix1
, c
);
3252 store_kbd_macro_char (c
);
3254 /* recent_keys should not include events from keyboard macros. */
3255 if (NILP (Vexecuting_kbd_macro
))
3259 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3260 ASET (recent_keys
, recent_keys_index
, c
);
3261 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3262 recent_keys_index
= 0;
3264 else if (recorded
< 0)
3266 /* We need to remove one or two events from recent_keys.
3267 To do this, we simply put nil at those events and move the
3268 recent_keys_index backwards over those events. Usually,
3269 users will never see those nil events, as they will be
3270 overwritten by the command keys entered to see recent_keys
3273 while (recorded
++ < 0 && total_keys
> 0)
3275 if (total_keys
< NUM_RECENT_KEYS
)
3277 if (--recent_keys_index
< 0)
3278 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3279 ASET (recent_keys
, recent_keys_index
, Qnil
);
3283 num_nonmacro_input_events
++;
3286 /* Write c to the dribble file. If c is a lispy event, write
3287 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3288 If you, dear reader, have a better idea, you've got the source. :-) */
3294 if (XUINT (c
) < 0x100)
3295 putc (XUINT (c
), dribble
);
3297 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3301 Lisp_Object dribblee
;
3303 /* If it's a structured event, take the event header. */
3304 dribblee
= EVENT_HEAD (c
);
3306 if (SYMBOLP (dribblee
))
3308 putc ('<', dribble
);
3309 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3310 SBYTES (SYMBOL_NAME (dribblee
)),
3312 putc ('>', dribble
);
3321 /* Copy out or in the info on where C-g should throw to.
3322 This is used when running Lisp code from within get_char,
3323 in case get_char is called recursively.
3324 See read_process_output. */
3327 save_getcjmp (sys_jmp_buf temp
)
3329 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3333 restore_getcjmp (sys_jmp_buf temp
)
3335 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3338 /* Low level keyboard/mouse input.
3339 kbd_buffer_store_event places events in kbd_buffer, and
3340 kbd_buffer_get_event retrieves them. */
3342 /* Return true if there are any events in the queue that read-char
3343 would return. If this returns false, a read-char would block. */
3345 readable_events (int flags
)
3347 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3350 /* If the buffer contains only FOCUS_IN_EVENT events, and
3351 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3352 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3354 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3355 #ifdef USE_TOOLKIT_SCROLL_BARS
3356 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3360 union buffered_input_event
*event
= kbd_fetch_ptr
;
3364 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3367 #ifdef USE_TOOLKIT_SCROLL_BARS
3368 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3370 event
->kind
== FOCUS_IN_EVENT
)
3371 #ifdef USE_TOOLKIT_SCROLL_BARS
3372 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3373 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3374 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3375 && event
->ie
.part
== scroll_bar_handle
3376 && event
->ie
.modifiers
== 0)
3378 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3379 && event
->kind
== BUFFER_SWITCH_EVENT
))
3383 while (event
!= kbd_store_ptr
);
3389 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3390 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3394 if (current_kboard
->kbd_queue_has_data
)
3400 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3401 if (kb
->kbd_queue_has_data
)
3407 /* Set this for debugging, to have a way to get out */
3408 int stop_character EXTERNALLY_VISIBLE
;
3411 event_to_kboard (struct input_event
*event
)
3413 /* Not applicable for these special events. */
3414 if (event
->kind
== SELECTION_REQUEST_EVENT
3415 || event
->kind
== SELECTION_CLEAR_EVENT
)
3419 Lisp_Object obj
= event
->frame_or_window
;
3420 /* There are some events that set this field to nil or string. */
3422 obj
= WINDOW_FRAME (XWINDOW (obj
));
3423 /* Also ignore dead frames here. */
3424 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3425 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3430 /* Return the number of slots occupied in kbd_buffer. */
3433 kbd_buffer_nr_stored (void)
3435 return kbd_fetch_ptr
== kbd_store_ptr
3437 : (kbd_fetch_ptr
< kbd_store_ptr
3438 ? kbd_store_ptr
- kbd_fetch_ptr
3439 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3440 + (kbd_store_ptr
- kbd_buffer
)));
3442 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3445 kbd_buffer_store_event (register struct input_event
*event
)
3447 kbd_buffer_store_event_hold (event
, 0);
3450 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3452 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3453 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3454 Else, if EVENT is a quit event, store the quit event
3455 in HOLD_QUIT, and return (thus ignoring further events).
3457 This is used to postpone the processing of the quit event until all
3458 subsequent input events have been parsed (and discarded). */
3461 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3462 struct input_event
*hold_quit
)
3464 if (event
->kind
== NO_EVENT
)
3467 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3470 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3472 int c
= event
->ie
.code
& 0377;
3474 if (event
->ie
.modifiers
& ctrl_modifier
)
3475 c
= make_ctrl_char (c
);
3477 c
|= (event
->ie
.modifiers
3478 & (meta_modifier
| alt_modifier
3479 | hyper_modifier
| super_modifier
));
3483 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3485 if (single_kboard
&& kb
!= current_kboard
)
3488 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3490 kb
->kbd_queue_has_data
= true;
3491 union buffered_input_event
*sp
;
3492 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3494 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3497 if (event_to_kboard (&sp
->ie
) == kb
)
3499 sp
->ie
.kind
= NO_EVENT
;
3500 sp
->ie
.frame_or_window
= Qnil
;
3509 *hold_quit
= event
->ie
;
3513 /* If this results in a quit_char being returned to Emacs as
3514 input, set Vlast_event_frame properly. If this doesn't
3515 get returned to Emacs as an event, the next event read
3516 will set Vlast_event_frame again, so this is safe to do. */
3520 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3522 focus
= event
->ie
.frame_or_window
;
3523 internal_last_event_frame
= focus
;
3524 Vlast_event_frame
= focus
;
3527 handle_interrupt (0);
3531 if (c
&& c
== stop_character
)
3537 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3538 Just ignore the second one. */
3539 else if (event
->kind
== BUFFER_SWITCH_EVENT
3540 && kbd_fetch_ptr
!= kbd_store_ptr
3541 && ((kbd_store_ptr
== kbd_buffer
3542 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3543 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3546 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3547 kbd_store_ptr
= kbd_buffer
;
3549 /* Don't let the very last slot in the buffer become full,
3550 since that would make the two pointers equal,
3551 and that is indistinguishable from an empty buffer.
3552 Discard the event if it would fill the last slot. */
3553 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3555 *kbd_store_ptr
= *event
;
3558 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3559 && ! kbd_on_hold_p ())
3561 /* Don't read keyboard input until we have processed kbd_buffer.
3562 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3563 hold_keyboard_input ();
3567 #endif /* subprocesses */
3570 /* If we're inside while-no-input, and this event qualifies
3571 as input, set quit-flag to cause an interrupt. */
3572 if (!NILP (Vthrow_on_input
)
3573 && event
->kind
!= FOCUS_IN_EVENT
3574 && event
->kind
!= FOCUS_OUT_EVENT
3575 && event
->kind
!= HELP_EVENT
3576 && event
->kind
!= ICONIFY_EVENT
3577 && event
->kind
!= DEICONIFY_EVENT
)
3579 Vquit_flag
= Vthrow_on_input
;
3580 /* If we're inside a function that wants immediate quits,
3582 if (immediate_quit
&& NILP (Vinhibit_quit
))
3584 immediate_quit
= false;
3593 /* Put a selection input event back in the head of the event queue. */
3596 kbd_buffer_unget_event (struct selection_input_event
*event
)
3598 if (kbd_fetch_ptr
== kbd_buffer
)
3599 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3601 /* Don't let the very last slot in the buffer become full, */
3602 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3603 if (kp
!= kbd_store_ptr
)
3612 /* Limit help event positions to this range, to avoid overflow problems. */
3613 #define INPUT_EVENT_POS_MAX \
3614 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3615 MOST_POSITIVE_FIXNUM)))
3616 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3618 /* Return a Time that encodes position POS. POS must be in range. */
3621 position_to_Time (ptrdiff_t pos
)
3623 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3627 /* Return the position that ENCODED_POS encodes.
3628 Avoid signed integer overflow. */
3631 Time_to_position (Time encoded_pos
)
3633 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3635 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3636 eassert (encoded_pos_min
<= encoded_pos
);
3637 ptrdiff_t notpos
= -1 - encoded_pos
;
3641 /* Generate a HELP_EVENT input_event and store it in the keyboard
3644 HELP is the help form.
3646 FRAME and WINDOW are the frame and window where the help is
3647 generated. OBJECT is the Lisp object where the help was found (a
3648 buffer, a string, an overlay, or nil if neither from a string nor
3649 from a buffer). POS is the position within OBJECT where the help
3653 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3654 Lisp_Object object
, ptrdiff_t pos
)
3656 struct input_event event
;
3658 event
.kind
= HELP_EVENT
;
3659 event
.frame_or_window
= frame
;
3661 event
.x
= WINDOWP (window
) ? window
: frame
;
3663 event
.timestamp
= position_to_Time (pos
);
3664 kbd_buffer_store_event (&event
);
3668 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3671 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3673 struct input_event event
;
3675 event
.kind
= HELP_EVENT
;
3676 event
.frame_or_window
= frame
;
3680 event
.timestamp
= 0;
3681 kbd_buffer_store_event (&event
);
3685 /* Discard any mouse events in the event buffer by setting them to
3688 discard_mouse_events (void)
3690 union buffered_input_event
*sp
;
3691 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3693 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3696 if (sp
->kind
== MOUSE_CLICK_EVENT
3697 || sp
->kind
== WHEEL_EVENT
3698 || sp
->kind
== HORIZ_WHEEL_EVENT
3700 || sp
->kind
== GPM_CLICK_EVENT
3702 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3703 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3705 sp
->kind
= NO_EVENT
;
3711 /* Return true if there are any real events waiting in the event
3712 buffer, not counting `NO_EVENT's.
3714 Discard NO_EVENT events at the front of the input queue, possibly
3715 leaving the input queue empty if there are no real input events. */
3718 kbd_buffer_events_waiting (void)
3720 union buffered_input_event
*sp
;
3722 for (sp
= kbd_fetch_ptr
;
3723 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3726 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3731 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3735 /* Clear input event EVENT. */
3738 clear_event (union buffered_input_event
*event
)
3740 event
->kind
= NO_EVENT
;
3744 /* Read one event from the event buffer, waiting if necessary.
3745 The value is a Lisp object representing the event.
3746 The value is nil for an event that should be ignored,
3747 or that was handled here.
3748 We always read and discard one event. */
3751 kbd_buffer_get_event (KBOARD
**kbp
,
3752 bool *used_mouse_menu
,
3753 struct timespec
*end_time
)
3758 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3760 /* Start reading input again because we have processed enough to
3761 be able to accept new events again. */
3762 unhold_keyboard_input ();
3766 #endif /* subprocesses */
3768 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3770 /* In case we are running as a daemon, only do this before
3771 detaching from the terminal. */
3772 || (IS_DAEMON
&& DAEMON_RUNNING
))
3776 *kbp
= current_kboard
;
3779 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3781 /* Wait until there is input available. */
3784 /* Break loop if there's an unread command event. Needed in
3785 moused window autoselection which uses a timer to insert such
3787 if (CONSP (Vunread_command_events
))
3790 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3792 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3795 /* If the quit flag is set, then read_char will return
3796 quit_char, so that counts as "available input." */
3797 if (!NILP (Vquit_flag
))
3798 quit_throw_to_read_char (0);
3800 /* One way or another, wait until input is available; then, if
3801 interrupt handlers have not read it, read it now. */
3806 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3808 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3812 struct timespec now
= current_timespec ();
3813 if (timespec_cmp (*end_time
, now
) <= 0)
3814 return Qnil
; /* Finished waiting. */
3817 struct timespec duration
= timespec_sub (*end_time
, now
);
3818 wait_reading_process_output (min (duration
.tv_sec
,
3821 -1, 1, Qnil
, NULL
, 0);
3826 bool do_display
= true;
3828 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3830 struct tty_display_info
*tty
= CURTTY ();
3832 /* When this TTY is displaying a menu, we must prevent
3833 any redisplay, because we modify the frame's glyph
3834 matrix behind the back of the display engine. */
3835 if (tty
->showing_menu
)
3839 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3842 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3846 if (CONSP (Vunread_command_events
))
3849 first
= XCAR (Vunread_command_events
);
3850 Vunread_command_events
= XCDR (Vunread_command_events
);
3851 *kbp
= current_kboard
;
3855 /* At this point, we know that there is a readable event available
3856 somewhere. If the event queue is empty, then there must be a
3857 mouse movement enabled and available. */
3858 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3860 union buffered_input_event
*event
;
3862 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3866 *kbp
= event_to_kboard (&event
->ie
);
3868 *kbp
= current_kboard
; /* Better than returning null ptr? */
3872 /* These two kinds of events get special handling
3873 and don't actually appear to the command loop.
3874 We return nil for them. */
3875 if (event
->kind
== SELECTION_REQUEST_EVENT
3876 || event
->kind
== SELECTION_CLEAR_EVENT
)
3879 /* Remove it from the buffer before processing it,
3880 since otherwise swallow_events will see it
3881 and process it again. */
3882 struct selection_input_event copy
= event
->sie
;
3883 kbd_fetch_ptr
= event
+ 1;
3884 input_pending
= readable_events (0);
3885 x_handle_selection_event (©
);
3887 /* We're getting selection request events, but we don't have
3893 #if defined (HAVE_NS)
3894 else if (event
->kind
== NS_TEXT_EVENT
)
3896 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3897 obj
= list1 (intern ("ns-put-working-text"));
3899 obj
= list1 (intern ("ns-unput-working-text"));
3900 kbd_fetch_ptr
= event
+ 1;
3901 if (used_mouse_menu
)
3902 *used_mouse_menu
= true;
3906 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3907 || defined (HAVE_NS)
3908 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3910 /* Make an event (delete-frame (FRAME)). */
3911 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
3912 kbd_fetch_ptr
= event
+ 1;
3917 else if (event
->kind
== END_SESSION_EVENT
)
3919 /* Make an event (end-session). */
3920 obj
= list1 (Qend_session
);
3921 kbd_fetch_ptr
= event
+ 1;
3925 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3926 || defined (HAVE_NS)
3927 else if (event
->kind
== ICONIFY_EVENT
)
3929 /* Make an event (iconify-frame (FRAME)). */
3930 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
3931 kbd_fetch_ptr
= event
+ 1;
3933 else if (event
->kind
== DEICONIFY_EVENT
)
3935 /* Make an event (make-frame-visible (FRAME)). */
3936 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
3937 kbd_fetch_ptr
= event
+ 1;
3940 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3942 /* The value doesn't matter here; only the type is tested. */
3943 XSETBUFFER (obj
, current_buffer
);
3944 kbd_fetch_ptr
= event
+ 1;
3946 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3947 || defined (HAVE_NS) || defined (USE_GTK)
3948 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3950 kbd_fetch_ptr
= event
+ 1;
3951 input_pending
= readable_events (0);
3952 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
3953 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
3957 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3959 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3960 obj
= list4 (Qlanguage_change
,
3961 event
->ie
.frame_or_window
,
3962 make_number (event
->ie
.code
),
3963 make_number (event
->ie
.modifiers
));
3964 kbd_fetch_ptr
= event
+ 1;
3967 #ifdef USE_FILE_NOTIFY
3968 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3970 #ifdef HAVE_W32NOTIFY
3971 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3972 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
3974 obj
= make_lispy_event (&event
->ie
);
3976 kbd_fetch_ptr
= event
+ 1;
3978 #endif /* USE_FILE_NOTIFY */
3979 else if (event
->kind
== SAVE_SESSION_EVENT
)
3981 obj
= list2 (Qsave_session
, event
->ie
.arg
);
3982 kbd_fetch_ptr
= event
+ 1;
3984 /* Just discard these, by returning nil.
3985 With MULTI_KBOARD, these events are used as placeholders
3986 when we need to randomly delete events from the queue.
3987 (They shouldn't otherwise be found in the buffer,
3988 but on some machines it appears they do show up
3989 even without MULTI_KBOARD.) */
3990 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3991 mouse events during a popup-menu call. */
3992 else if (event
->kind
== NO_EVENT
)
3993 kbd_fetch_ptr
= event
+ 1;
3994 else if (event
->kind
== HELP_EVENT
)
3996 Lisp_Object object
, position
, help
, frame
, window
;
3998 frame
= event
->ie
.frame_or_window
;
3999 object
= event
->ie
.arg
;
4000 position
= make_number (Time_to_position (event
->ie
.timestamp
));
4001 window
= event
->ie
.x
;
4003 clear_event (event
);
4005 kbd_fetch_ptr
= event
+ 1;
4006 if (!WINDOWP (window
))
4008 obj
= Fcons (Qhelp_echo
,
4009 list5 (frame
, help
, window
, object
, position
));
4011 else if (event
->kind
== FOCUS_IN_EVENT
)
4013 /* Notification of a FocusIn event. The frame receiving the
4014 focus is in event->frame_or_window. Generate a
4015 switch-frame event if necessary. */
4016 Lisp_Object frame
, focus
;
4018 frame
= event
->ie
.frame_or_window
;
4019 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4025 ! NILP (event
->ie
.arg
)
4028 !EQ (frame
, internal_last_event_frame
)
4029 && !EQ (frame
, selected_frame
))
4030 obj
= make_lispy_switch_frame (frame
);
4032 obj
= make_lispy_focus_in (frame
);
4034 internal_last_event_frame
= frame
;
4035 kbd_fetch_ptr
= event
+ 1;
4037 else if (event
->kind
== FOCUS_OUT_EVENT
)
4039 #ifdef HAVE_WINDOW_SYSTEM
4042 Lisp_Object frame
= event
->ie
.frame_or_window
;
4043 bool focused
= false;
4045 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4046 focused
= di
->x_highlight_frame
!= 0;
4049 obj
= make_lispy_focus_out (frame
);
4051 #endif /* HAVE_WINDOW_SYSTEM */
4053 kbd_fetch_ptr
= event
+ 1;
4056 else if (event
->kind
== DBUS_EVENT
)
4058 obj
= make_lispy_event (&event
->ie
);
4059 kbd_fetch_ptr
= event
+ 1;
4062 #ifdef HAVE_XWIDGETS
4063 else if (event
->kind
== XWIDGET_EVENT
)
4065 obj
= make_lispy_event (&event
->ie
);
4066 kbd_fetch_ptr
= event
+ 1;
4069 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4071 obj
= make_lispy_event (&event
->ie
);
4072 kbd_fetch_ptr
= event
+ 1;
4076 /* If this event is on a different frame, return a switch-frame this
4077 time, and leave the event in the queue for next time. */
4081 frame
= event
->ie
.frame_or_window
;
4083 frame
= XCAR (frame
);
4084 else if (WINDOWP (frame
))
4085 frame
= WINDOW_FRAME (XWINDOW (frame
));
4087 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4091 if (! EQ (frame
, internal_last_event_frame
)
4092 && !EQ (frame
, selected_frame
))
4093 obj
= make_lispy_switch_frame (frame
);
4094 internal_last_event_frame
= frame
;
4096 /* If we didn't decide to make a switch-frame event, go ahead
4097 and build a real event from the queue entry. */
4101 obj
= make_lispy_event (&event
->ie
);
4103 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4104 || defined (HAVE_NS) || defined (USE_GTK)
4105 /* If this was a menu selection, then set the flag to inhibit
4106 writing to last_nonmenu_event. Don't do this if the event
4107 we're returning is (menu-bar), though; that indicates the
4108 beginning of the menu sequence, and we might as well leave
4109 that as the `event with parameters' for this selection. */
4111 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4112 && (event
->kind
== MENU_BAR_EVENT
4113 || event
->kind
== TOOL_BAR_EVENT
))
4114 *used_mouse_menu
= true;
4117 /* Certain system events are non-key events. */
4119 && event
->kind
== NS_NONKEY_EVENT
)
4120 *used_mouse_menu
= true;
4123 /* Wipe out this event, to catch bugs. */
4124 clear_event (event
);
4125 kbd_fetch_ptr
= event
+ 1;
4129 /* Try generating a mouse motion event. */
4130 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4132 struct frame
*f
= some_mouse_moved ();
4133 Lisp_Object bar_window
;
4134 enum scroll_bar_part part
;
4138 *kbp
= current_kboard
;
4139 /* Note that this uses F to determine which terminal to look at.
4140 If there is no valid info, it does not store anything
4141 so x remains nil. */
4144 /* XXX Can f or mouse_position_hook be NULL here? */
4145 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4146 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4151 /* Decide if we should generate a switch-frame event. Don't
4152 generate switch-frame events for motion outside of all Emacs
4158 frame
= FRAME_FOCUS_FRAME (f
);
4160 XSETFRAME (frame
, f
);
4162 if (! EQ (frame
, internal_last_event_frame
)
4163 && !EQ (frame
, selected_frame
))
4164 obj
= make_lispy_switch_frame (frame
);
4165 internal_last_event_frame
= frame
;
4168 /* If we didn't decide to make a switch-frame event, go ahead and
4169 return a mouse-motion event. */
4170 if (!NILP (x
) && NILP (obj
))
4171 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4174 /* We were promised by the above while loop that there was
4175 something for us to read! */
4178 input_pending
= readable_events (0);
4180 Vlast_event_frame
= internal_last_event_frame
;
4185 /* Process any non-user-visible events (currently X selection events),
4186 without reading any user-visible events. */
4189 process_special_events (void)
4191 union buffered_input_event
*event
;
4193 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4195 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4198 if (event
== kbd_store_ptr
)
4202 /* If we find a stored X selection request, handle it now. */
4203 if (event
->kind
== SELECTION_REQUEST_EVENT
4204 || event
->kind
== SELECTION_CLEAR_EVENT
)
4208 /* Remove the event from the fifo buffer before processing;
4209 otherwise swallow_events called recursively could see it
4210 and process it again. To do this, we move the events
4211 between kbd_fetch_ptr and EVENT one slot to the right,
4214 struct selection_input_event copy
= event
->sie
;
4215 union buffered_input_event
*beg
4216 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4217 ? kbd_buffer
: kbd_fetch_ptr
;
4220 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4221 else if (event
< beg
)
4223 if (event
> kbd_buffer
)
4224 memmove (kbd_buffer
+ 1, kbd_buffer
,
4225 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4226 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4227 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4228 memmove (beg
+ 1, beg
,
4229 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4232 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4233 kbd_fetch_ptr
= kbd_buffer
+ 1;
4237 input_pending
= readable_events (0);
4238 x_handle_selection_event (©
);
4240 /* We're getting selection request events, but we don't have
4248 /* Process any events that are not user-visible, run timer events that
4249 are ripe, and return, without reading any user-visible events. */
4252 swallow_events (bool do_display
)
4254 unsigned old_timers_run
;
4256 process_special_events ();
4258 old_timers_run
= timers_run
;
4259 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4261 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4262 redisplay_preserve_echo_area (7);
4265 /* Record the start of when Emacs is idle,
4266 for the sake of running idle-time timers. */
4269 timer_start_idle (void)
4271 /* If we are already in the idle state, do nothing. */
4272 if (timespec_valid_p (timer_idleness_start_time
))
4275 timer_idleness_start_time
= current_timespec ();
4276 timer_last_idleness_start_time
= timer_idleness_start_time
;
4278 /* Mark all idle-time timers as once again candidates for running. */
4279 call0 (intern ("internal-timer-start-idle"));
4282 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4285 timer_stop_idle (void)
4287 timer_idleness_start_time
= invalid_timespec ();
4290 /* Resume idle timer from last idle start time. */
4293 timer_resume_idle (void)
4295 if (timespec_valid_p (timer_idleness_start_time
))
4298 timer_idleness_start_time
= timer_last_idleness_start_time
;
4301 /* List of elisp functions to call, delayed because they were generated in
4302 a context where Elisp could not be safely run (e.g. redisplay, signal,
4303 ...). Each element has the form (FUN . ARGS). */
4304 Lisp_Object pending_funcalls
;
4306 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4308 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4312 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4314 vec
= XVECTOR (timer
)->contents
;
4315 if (! NILP (vec
[0]))
4317 if (! INTEGERP (vec
[2]))
4321 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4323 *result
= lisp_to_timespec (t
);
4324 return timespec_valid_p (*result
);
4328 /* Check whether a timer has fired. To prevent larger problems we simply
4329 disregard elements that are not proper timers. Do not make a circular
4330 timer list for the time being.
4332 Returns the time to wait until the next timer fires. If a
4333 timer is triggering now, return zero.
4334 If no timer is active, return -1.
4336 If a timer is ripe, we run it, with quitting turned off.
4337 In that case we return 0 to indicate that a new timer_check_2 call
4340 static struct timespec
4341 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4343 struct timespec nexttime
;
4344 struct timespec now
;
4345 struct timespec idleness_now
;
4346 Lisp_Object chosen_timer
;
4348 nexttime
= invalid_timespec ();
4350 chosen_timer
= Qnil
;
4352 /* First run the code that was delayed. */
4353 while (CONSP (pending_funcalls
))
4355 Lisp_Object funcall
= XCAR (pending_funcalls
);
4356 pending_funcalls
= XCDR (pending_funcalls
);
4357 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4360 if (CONSP (timers
) || CONSP (idle_timers
))
4362 now
= current_timespec ();
4363 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4364 ? timespec_sub (now
, timer_idleness_start_time
)
4365 : make_timespec (0, 0));
4368 while (CONSP (timers
) || CONSP (idle_timers
))
4370 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4371 struct timespec timer_time
, idle_timer_time
;
4372 struct timespec difference
;
4373 struct timespec timer_difference
= invalid_timespec ();
4374 struct timespec idle_timer_difference
= invalid_timespec ();
4375 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4377 /* Set TIMER and TIMER_DIFFERENCE
4378 based on the next ordinary timer.
4379 TIMER_DIFFERENCE is the distance in time from NOW to when
4380 this timer becomes ripe.
4381 Skip past invalid timers and timers already handled. */
4384 timer
= XCAR (timers
);
4385 if (! decode_timer (timer
, &timer_time
))
4387 timers
= XCDR (timers
);
4391 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4392 timer_difference
= (timer_ripe
4393 ? timespec_sub (now
, timer_time
)
4394 : timespec_sub (timer_time
, now
));
4397 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4398 based on the next idle timer. */
4399 if (CONSP (idle_timers
))
4401 idle_timer
= XCAR (idle_timers
);
4402 if (! decode_timer (idle_timer
, &idle_timer_time
))
4404 idle_timers
= XCDR (idle_timers
);
4408 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4409 idle_timer_difference
4411 ? timespec_sub (idleness_now
, idle_timer_time
)
4412 : timespec_sub (idle_timer_time
, idleness_now
));
4415 /* Decide which timer is the next timer,
4416 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4417 Also step down the list where we found that timer. */
4419 if (timespec_valid_p (timer_difference
)
4420 && (! timespec_valid_p (idle_timer_difference
)
4421 || idle_timer_ripe
< timer_ripe
4422 || (idle_timer_ripe
== timer_ripe
4424 ? timespec_cmp (idle_timer_difference
,
4426 : timespec_cmp (timer_difference
,
4427 idle_timer_difference
))
4430 chosen_timer
= timer
;
4431 timers
= XCDR (timers
);
4432 difference
= timer_difference
;
4437 chosen_timer
= idle_timer
;
4438 idle_timers
= XCDR (idle_timers
);
4439 difference
= idle_timer_difference
;
4440 ripe
= idle_timer_ripe
;
4443 /* If timer is ripe, run it if it hasn't been run. */
4446 if (NILP (AREF (chosen_timer
, 0)))
4448 ptrdiff_t count
= SPECPDL_INDEX ();
4449 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4451 /* Mark the timer as triggered to prevent problems if the lisp
4452 code fails to reschedule it right. */
4453 ASET (chosen_timer
, 0, Qt
);
4455 specbind (Qinhibit_quit
, Qt
);
4457 call1 (Qtimer_event_handler
, chosen_timer
);
4458 Vdeactivate_mark
= old_deactivate_mark
;
4460 unbind_to (count
, Qnil
);
4462 /* Since we have handled the event,
4463 we don't need to tell the caller to wake up and do it. */
4464 /* But the caller must still wait for the next timer, so
4465 return 0 to indicate that. */
4468 nexttime
= make_timespec (0, 0);
4472 /* When we encounter a timer that is still waiting,
4473 return the amount of time to wait before it is ripe. */
4479 /* No timers are pending in the future. */
4480 /* Return 0 if we generated an event, and -1 if not. */
4485 /* Check whether a timer has fired. To prevent larger problems we simply
4486 disregard elements that are not proper timers. Do not make a circular
4487 timer list for the time being.
4489 Returns the time to wait until the next timer fires.
4490 If no timer is active, return an invalid value.
4492 As long as any timer is ripe, we run it. */
4497 struct timespec nexttime
;
4498 Lisp_Object timers
, idle_timers
;
4500 Lisp_Object tem
= Vinhibit_quit
;
4503 /* We use copies of the timers' lists to allow a timer to add itself
4504 again, without locking up Emacs if the newly added timer is
4505 already ripe when added. */
4507 /* Always consider the ordinary timers. */
4508 timers
= Fcopy_sequence (Vtimer_list
);
4509 /* Consider the idle timers only if Emacs is idle. */
4510 if (timespec_valid_p (timer_idleness_start_time
))
4511 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4515 Vinhibit_quit
= tem
;
4519 nexttime
= timer_check_2 (timers
, idle_timers
);
4521 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4526 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4527 doc
: /* Return the current length of Emacs idleness, or nil.
4528 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4529 in the same style as (current-time).
4531 The value when Emacs is not idle is nil.
4533 PSEC is a multiple of the system clock resolution. */)
4536 if (timespec_valid_p (timer_idleness_start_time
))
4537 return make_lisp_time (timespec_sub (current_timespec (),
4538 timer_idleness_start_time
));
4543 /* Caches for modify_event_symbol. */
4544 static Lisp_Object accent_key_syms
;
4545 static Lisp_Object func_key_syms
;
4546 static Lisp_Object mouse_syms
;
4547 static Lisp_Object wheel_syms
;
4548 static Lisp_Object drag_n_drop_syms
;
4550 /* This is a list of keysym codes for special "accent" characters.
4551 It parallels lispy_accent_keys. */
4553 static const int lispy_accent_codes
[] =
4555 #ifdef XK_dead_circumflex
4560 #ifdef XK_dead_grave
4565 #ifdef XK_dead_tilde
4570 #ifdef XK_dead_diaeresis
4575 #ifdef XK_dead_macron
4580 #ifdef XK_dead_degree
4585 #ifdef XK_dead_acute
4590 #ifdef XK_dead_cedilla
4595 #ifdef XK_dead_breve
4600 #ifdef XK_dead_ogonek
4605 #ifdef XK_dead_caron
4610 #ifdef XK_dead_doubleacute
4611 XK_dead_doubleacute
,
4615 #ifdef XK_dead_abovedot
4620 #ifdef XK_dead_abovering
4630 #ifdef XK_dead_belowdot
4635 #ifdef XK_dead_voiced_sound
4636 XK_dead_voiced_sound
,
4640 #ifdef XK_dead_semivoiced_sound
4641 XK_dead_semivoiced_sound
,
4657 /* This is a list of Lisp names for special "accent" characters.
4658 It parallels lispy_accent_codes. */
4660 static const char *const lispy_accent_keys
[] =
4678 "dead-voiced-sound",
4679 "dead-semivoiced-sound",
4685 #define FUNCTION_KEY_OFFSET 0x0
4687 const char *const lispy_function_keys
[] =
4691 0, /* VK_LBUTTON 0x01 */
4692 0, /* VK_RBUTTON 0x02 */
4693 "cancel", /* VK_CANCEL 0x03 */
4694 0, /* VK_MBUTTON 0x04 */
4696 0, 0, 0, /* 0x05 .. 0x07 */
4698 "backspace", /* VK_BACK 0x08 */
4699 "tab", /* VK_TAB 0x09 */
4701 0, 0, /* 0x0A .. 0x0B */
4703 "clear", /* VK_CLEAR 0x0C */
4704 "return", /* VK_RETURN 0x0D */
4706 0, 0, /* 0x0E .. 0x0F */
4708 0, /* VK_SHIFT 0x10 */
4709 0, /* VK_CONTROL 0x11 */
4710 0, /* VK_MENU 0x12 */
4711 "pause", /* VK_PAUSE 0x13 */
4712 "capslock", /* VK_CAPITAL 0x14 */
4713 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4715 "junja", /* VK_JUNJA 0x17 */
4716 "final", /* VK_FINAL 0x18 */
4717 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4719 "escape", /* VK_ESCAPE 0x1B */
4720 "convert", /* VK_CONVERT 0x1C */
4721 "non-convert", /* VK_NONCONVERT 0x1D */
4722 "accept", /* VK_ACCEPT 0x1E */
4723 "mode-change", /* VK_MODECHANGE 0x1F */
4724 0, /* VK_SPACE 0x20 */
4725 "prior", /* VK_PRIOR 0x21 */
4726 "next", /* VK_NEXT 0x22 */
4727 "end", /* VK_END 0x23 */
4728 "home", /* VK_HOME 0x24 */
4729 "left", /* VK_LEFT 0x25 */
4730 "up", /* VK_UP 0x26 */
4731 "right", /* VK_RIGHT 0x27 */
4732 "down", /* VK_DOWN 0x28 */
4733 "select", /* VK_SELECT 0x29 */
4734 "print", /* VK_PRINT 0x2A */
4735 "execute", /* VK_EXECUTE 0x2B */
4736 "snapshot", /* VK_SNAPSHOT 0x2C */
4737 "insert", /* VK_INSERT 0x2D */
4738 "delete", /* VK_DELETE 0x2E */
4739 "help", /* VK_HELP 0x2F */
4741 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4743 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4745 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4747 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4749 0, 0, 0, 0, 0, 0, 0, 0, 0,
4750 0, 0, 0, 0, 0, 0, 0, 0, 0,
4751 0, 0, 0, 0, 0, 0, 0, 0,
4753 "lwindow", /* VK_LWIN 0x5B */
4754 "rwindow", /* VK_RWIN 0x5C */
4755 "apps", /* VK_APPS 0x5D */
4758 "kp-0", /* VK_NUMPAD0 0x60 */
4759 "kp-1", /* VK_NUMPAD1 0x61 */
4760 "kp-2", /* VK_NUMPAD2 0x62 */
4761 "kp-3", /* VK_NUMPAD3 0x63 */
4762 "kp-4", /* VK_NUMPAD4 0x64 */
4763 "kp-5", /* VK_NUMPAD5 0x65 */
4764 "kp-6", /* VK_NUMPAD6 0x66 */
4765 "kp-7", /* VK_NUMPAD7 0x67 */
4766 "kp-8", /* VK_NUMPAD8 0x68 */
4767 "kp-9", /* VK_NUMPAD9 0x69 */
4768 "kp-multiply", /* VK_MULTIPLY 0x6A */
4769 "kp-add", /* VK_ADD 0x6B */
4770 "kp-separator", /* VK_SEPARATOR 0x6C */
4771 "kp-subtract", /* VK_SUBTRACT 0x6D */
4772 "kp-decimal", /* VK_DECIMAL 0x6E */
4773 "kp-divide", /* VK_DIVIDE 0x6F */
4774 "f1", /* VK_F1 0x70 */
4775 "f2", /* VK_F2 0x71 */
4776 "f3", /* VK_F3 0x72 */
4777 "f4", /* VK_F4 0x73 */
4778 "f5", /* VK_F5 0x74 */
4779 "f6", /* VK_F6 0x75 */
4780 "f7", /* VK_F7 0x76 */
4781 "f8", /* VK_F8 0x77 */
4782 "f9", /* VK_F9 0x78 */
4783 "f10", /* VK_F10 0x79 */
4784 "f11", /* VK_F11 0x7A */
4785 "f12", /* VK_F12 0x7B */
4786 "f13", /* VK_F13 0x7C */
4787 "f14", /* VK_F14 0x7D */
4788 "f15", /* VK_F15 0x7E */
4789 "f16", /* VK_F16 0x7F */
4790 "f17", /* VK_F17 0x80 */
4791 "f18", /* VK_F18 0x81 */
4792 "f19", /* VK_F19 0x82 */
4793 "f20", /* VK_F20 0x83 */
4794 "f21", /* VK_F21 0x84 */
4795 "f22", /* VK_F22 0x85 */
4796 "f23", /* VK_F23 0x86 */
4797 "f24", /* VK_F24 0x87 */
4799 0, 0, 0, 0, /* 0x88 .. 0x8B */
4800 0, 0, 0, 0, /* 0x8C .. 0x8F */
4802 "kp-numlock", /* VK_NUMLOCK 0x90 */
4803 "scroll", /* VK_SCROLL 0x91 */
4804 /* Not sure where the following block comes from.
4805 Windows headers have NEC and Fujitsu specific keys in
4806 this block, but nothing generic. */
4807 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4808 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4809 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4810 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4811 "kp-end", /* VK_NUMPAD_END 0x96 */
4812 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4813 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4814 "kp-up", /* VK_NUMPAD_UP 0x99 */
4815 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4816 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4817 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4818 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4820 0, 0, /* 0x9E .. 0x9F */
4823 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4824 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4825 * No other API or message will distinguish left and right keys this way.
4830 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4831 to enable them selectively, and gives access to a few more functions.
4832 See lispy_multimedia_keys below. */
4833 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4834 0, 0, 0, /* 0xAD .. 0xAF Volume */
4835 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4836 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4838 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4839 0, 0, 0, 0, 0, 0, 0, 0, 0,
4841 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4842 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4843 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4846 "ax", /* VK_OEM_AX 0xE1 */
4847 0, /* VK_OEM_102 0xE2 */
4848 "ico-help", /* VK_ICO_HELP 0xE3 */
4849 "ico-00", /* VK_ICO_00 0xE4 */
4850 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4851 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4852 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4854 "reset", /* VK_OEM_RESET 0xE9 */
4855 "jump", /* VK_OEM_JUMP 0xEA */
4856 "oem-pa1", /* VK_OEM_PA1 0xEB */
4857 "oem-pa2", /* VK_OEM_PA2 0xEC */
4858 "oem-pa3", /* VK_OEM_PA3 0xED */
4859 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4860 "cusel", /* VK_OEM_CUSEL 0xEF */
4861 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4862 "finish", /* VK_OEM_FINISH 0xF1 */
4863 "copy", /* VK_OEM_COPY 0xF2 */
4864 "auto", /* VK_OEM_AUTO 0xF3 */
4865 "enlw", /* VK_OEM_ENLW 0xF4 */
4866 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4867 "attn", /* VK_ATTN 0xF6 */
4868 "crsel", /* VK_CRSEL 0xF7 */
4869 "exsel", /* VK_EXSEL 0xF8 */
4870 "ereof", /* VK_EREOF 0xF9 */
4871 "play", /* VK_PLAY 0xFA */
4872 "zoom", /* VK_ZOOM 0xFB */
4873 "noname", /* VK_NONAME 0xFC */
4874 "pa1", /* VK_PA1 0xFD */
4875 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4879 /* Some of these duplicate the "Media keys" on newer keyboards,
4880 but they are delivered to the application in a different way. */
4881 static const char *const lispy_multimedia_keys
[] =
4889 "browser-favorites",
4926 "toggle-dictate-command",
4932 "media-fast-forward",
4935 "media-channel-down"
4938 #else /* not HAVE_NTGUI */
4940 /* This should be dealt with in XTread_socket now, and that doesn't
4941 depend on the client system having the Kana syms defined. See also
4942 the XK_kana_A case below. */
4945 static const char *const lispy_kana_keys
[] =
4947 /* X Keysym value */
4948 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4949 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4950 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4951 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4952 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4953 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4954 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4955 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4956 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4957 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4958 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4959 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4960 "kana-i", "kana-u", "kana-e", "kana-o",
4961 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4962 "prolongedsound", "kana-A", "kana-I", "kana-U",
4963 "kana-E", "kana-O", "kana-KA", "kana-KI",
4964 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4965 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4966 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4967 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4968 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4969 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4970 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4971 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4972 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4973 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4974 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4975 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4977 #endif /* XK_kana_A */
4980 #define FUNCTION_KEY_OFFSET 0xff00
4982 /* You'll notice that this table is arranged to be conveniently
4983 indexed by X Windows keysym values. */
4984 static const char *const lispy_function_keys
[] =
4986 /* X Keysym value */
4988 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4989 "backspace", "tab", "linefeed", "clear",
4991 0, 0, 0, "pause", /* 0xff10...1f */
4992 0, 0, 0, 0, 0, 0, 0, "escape",
4994 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4995 "romaji", "hiragana", "katakana", "hiragana-katakana",
4996 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4997 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4998 "eisu-toggle", /* 0xff30...3f */
4999 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5000 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5002 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5003 "down", "prior", "next", "end",
5004 "begin", 0, 0, 0, 0, 0, 0, 0,
5005 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5016 "break", /* 0xff6b */
5019 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5020 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5021 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5022 0, 0, 0, 0, 0, 0, 0, 0,
5023 "kp-tab", /* 0xff89 */
5025 "kp-enter", /* 0xff8d */
5027 "kp-f1", /* 0xff91 */
5031 "kp-home", /* 0xff95 */
5036 "kp-prior", /* kp-page-up */
5037 "kp-next", /* kp-page-down */
5043 0, 0, 0, 0, 0, 0, 0, 0, 0,
5044 "kp-multiply", /* 0xffaa */
5049 "kp-divide", /* 0xffaf */
5050 "kp-0", /* 0xffb0 */
5051 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5054 "kp-equal", /* 0xffbd */
5055 "f1", /* 0xffbe */ /* IsFunctionKey */
5057 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5058 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5059 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5060 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5061 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5062 0, 0, 0, 0, 0, 0, 0, 0,
5063 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5064 0, 0, 0, 0, 0, 0, 0, "delete"
5067 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5068 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5070 static const char *const iso_lispy_function_keys
[] =
5072 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5073 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5074 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5075 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5076 "iso-lefttab", /* 0xfe20 */
5077 "iso-move-line-up", "iso-move-line-down",
5078 "iso-partial-line-up", "iso-partial-line-down",
5079 "iso-partial-space-left", "iso-partial-space-right",
5080 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5081 "iso-release-margin-left", "iso-release-margin-right",
5082 "iso-release-both-margins",
5083 "iso-fast-cursor-left", "iso-fast-cursor-right",
5084 "iso-fast-cursor-up", "iso-fast-cursor-down",
5085 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5086 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5089 #endif /* not HAVE_NTGUI */
5091 static Lisp_Object Vlispy_mouse_stem
;
5093 static const char *const lispy_wheel_names
[] =
5095 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5098 /* drag-n-drop events are generated when a set of selected files are
5099 dragged from another application and dropped onto an Emacs window. */
5100 static const char *const lispy_drag_n_drop_names
[] =
5105 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5106 scroll_bar_part value. Note that Qnil corresponds to
5107 scroll_bar_nowhere and should not appear in Lisp events. */
5108 static short const scroll_bar_parts
[] = {
5109 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5110 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5111 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5112 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5113 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5114 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5115 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5118 /* A vector, indexed by button number, giving the down-going location
5119 of currently depressed buttons, both scroll bar and non-scroll bar.
5121 The elements have the form
5122 (BUTTON-NUMBER MODIFIER-MASK . REST)
5123 where REST is the cdr of a position as it would be reported in the event.
5125 The make_lispy_event function stores positions here to tell the
5126 difference between click and drag events, and to store the starting
5127 location to be included in drag events. */
5129 static Lisp_Object button_down_location
;
5131 /* Information about the most recent up-going button event: Which
5132 button, what location, and what time. */
5134 static int last_mouse_button
;
5135 static int last_mouse_x
;
5136 static int last_mouse_y
;
5137 static Time button_down_time
;
5139 /* The number of clicks in this multiple-click. */
5141 static int double_click_count
;
5143 /* X and Y are frame-relative coordinates for a click or wheel event.
5144 Return a Lisp-style event list. */
5147 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5150 enum window_part part
;
5151 Lisp_Object posn
= Qnil
;
5152 Lisp_Object extra_info
= Qnil
;
5153 /* Coordinate pixel positions to return. */
5154 int xret
= 0, yret
= 0;
5155 /* The window under frame pixel coordinates (x,y) */
5156 Lisp_Object window
= f
5157 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5160 if (WINDOWP (window
))
5162 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5163 struct window
*w
= XWINDOW (window
);
5164 Lisp_Object string_info
= Qnil
;
5165 ptrdiff_t textpos
= 0;
5166 int col
= -1, row
= -1;
5167 int dx
= -1, dy
= -1;
5168 int width
= -1, height
= -1;
5169 Lisp_Object object
= Qnil
;
5171 /* Pixel coordinates relative to the window corner. */
5172 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5173 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5175 /* For text area clicks, return X, Y relative to the corner of
5176 this text area. Note that dX, dY etc are set below, by
5177 buffer_posn_from_coords. */
5178 if (part
== ON_TEXT
)
5180 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5181 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5183 /* For mode line and header line clicks, return X, Y relative to
5184 the left window edge. Use mode_line_string to look for a
5185 string on the click position. */
5186 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5191 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5192 /* Note that mode_line_string takes COL, ROW as pixels and
5193 converts them to characters. */
5196 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5197 &object
, &dx
, &dy
, &width
, &height
);
5198 if (STRINGP (string
))
5199 string_info
= Fcons (string
, make_number (charpos
));
5205 /* For fringes and margins, Y is relative to the area's (and the
5206 window's) top edge, while X is meaningless. */
5207 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5212 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5215 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5216 &object
, &dx
, &dy
, &width
, &height
);
5217 if (STRINGP (string
))
5218 string_info
= Fcons (string
, make_number (charpos
));
5220 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5222 else if (part
== ON_LEFT_FRINGE
)
5224 posn
= Qleft_fringe
;
5228 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5229 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5230 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5232 else if (part
== ON_RIGHT_FRINGE
)
5234 posn
= Qright_fringe
;
5238 - window_box_width (w
, LEFT_MARGIN_AREA
)
5239 - window_box_width (w
, TEXT_AREA
)
5240 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5241 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5243 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5245 else if (part
== ON_VERTICAL_BORDER
)
5247 posn
= Qvertical_line
;
5253 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5255 posn
= Qvertical_scroll_bar
;
5256 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5260 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5262 posn
= Qhorizontal_scroll_bar
;
5263 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5267 else if (part
== ON_RIGHT_DIVIDER
)
5269 posn
= Qright_divider
;
5270 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5274 else if (part
== ON_BOTTOM_DIVIDER
)
5276 posn
= Qbottom_divider
;
5277 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5282 /* For clicks in the text area, fringes, margins, or vertical
5283 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5284 the buffer position nearest to the click. */
5287 Lisp_Object string2
, object2
= Qnil
;
5288 struct display_pos p
;
5290 int width2
, height2
;
5291 /* The pixel X coordinate passed to buffer_posn_from_coords
5292 is the X coordinate relative to the text area for clicks
5293 in text-area, right-margin/fringe and right-side vertical
5294 scroll bar, zero otherwise. */
5296 = (part
== ON_TEXT
) ? xret
5297 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5298 || (part
== ON_VERTICAL_SCROLL_BAR
5299 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5300 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5304 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5305 &object2
, &dx2
, &dy2
,
5307 textpos
= CHARPOS (p
.pos
);
5308 if (col
< 0) col
= x2
;
5309 if (row
< 0) row
= y2
;
5310 if (dx
< 0) dx
= dx2
;
5311 if (dy
< 0) dy
= dy2
;
5312 if (width
< 0) width
= width2
;
5313 if (height
< 0) height
= height2
;
5317 posn
= make_number (textpos
);
5318 if (STRINGP (string2
))
5319 string_info
= Fcons (string2
,
5320 make_number (CHARPOS (p
.string_pos
)));
5326 #ifdef HAVE_WINDOW_SYSTEM
5327 if (IMAGEP (object
))
5329 Lisp_Object image_map
, hotspot
;
5330 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5332 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5334 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5335 posn
= XCAR (hotspot
);
5342 Fcons (make_number (dx
), make_number (dy
)),
5343 Fcons (make_number (width
), make_number (height
)));
5346 extra_info
= Fcons (string_info
,
5347 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5348 Fcons (Fcons (make_number (col
),
5354 /* Return mouse pixel coordinates here. */
5355 XSETFRAME (window
, f
);
5362 return Fcons (window
,
5364 Fcons (Fcons (make_number (xret
),
5365 make_number (yret
)),
5366 Fcons (make_number (t
),
5370 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5371 menu bar. This really means that Emacs draws and manages the menu
5372 bar as part of its normal display, and therefore can compute its
5375 toolkit_menubar_in_use (struct frame
*f
)
5377 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5378 return !(!FRAME_WINDOW_P (f
));
5384 /* Build the part of Lisp event which represents scroll bar state from
5385 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5388 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5390 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5391 make_number (ev
->timestamp
),
5392 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5395 /* Given a struct input_event, build the lisp event which represents
5396 it. If EVENT is 0, build a mouse movement event from the mouse
5397 movement buffer, which should have a movement event in it.
5399 Note that events must be passed to this function in the order they
5400 are received; this function stores the location of button presses
5401 in order to build drag events when the button is released. */
5404 make_lispy_event (struct input_event
*event
)
5408 switch (event
->kind
)
5410 /* A simple keystroke. */
5411 case ASCII_KEYSTROKE_EVENT
:
5412 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5414 Lisp_Object lispy_c
;
5415 EMACS_INT c
= event
->code
;
5416 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5419 eassert (c
== event
->code
);
5422 /* Caps-lock shouldn't affect interpretation of key chords:
5423 Control+s should produce C-s whether caps-lock is on or
5424 not. And Control+Shift+s should produce C-S-s whether
5425 caps-lock is on or not. */
5426 if (event
->modifiers
& ~shift_modifier
)
5428 /* This is a key chord: some non-shift modifier is
5431 if (uppercasep (c
) &&
5432 !(event
->modifiers
& shift_modifier
))
5434 /* Got a capital letter without a shift. The caps
5435 lock is on. Un-capitalize the letter. */
5438 else if (lowercasep (c
) &&
5439 (event
->modifiers
& shift_modifier
))
5441 /* Got a lower-case letter even though shift is
5442 depressed. The caps lock is on. Capitalize the
5448 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5450 /* Turn ASCII characters into control characters
5452 if (event
->modifiers
& ctrl_modifier
)
5454 c
= make_ctrl_char (c
);
5455 event
->modifiers
&= ~ctrl_modifier
;
5459 /* Add in the other modifier bits. The shift key was taken care
5460 of by the X code. */
5461 c
|= (event
->modifiers
5462 & (meta_modifier
| alt_modifier
5463 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5464 /* Distinguish Shift-SPC from SPC. */
5465 if ((event
->code
) == 040
5466 && event
->modifiers
& shift_modifier
)
5467 c
|= shift_modifier
;
5468 button_down_time
= 0;
5469 XSETFASTINT (lispy_c
, c
);
5474 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5475 except that they are non-key events (last-nonmenu-event is nil). */
5476 case NS_NONKEY_EVENT
:
5479 /* A function key. The symbol may need to have modifier prefixes
5481 case NON_ASCII_KEYSTROKE_EVENT
:
5482 button_down_time
= 0;
5484 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5485 if (event
->code
== lispy_accent_codes
[i
])
5486 return modify_event_symbol (i
,
5488 Qfunction_key
, Qnil
,
5489 lispy_accent_keys
, &accent_key_syms
,
5490 ARRAYELTS (lispy_accent_keys
));
5494 if (event
->code
>= 0x400 && event
->code
< 0x500)
5495 return modify_event_symbol (event
->code
- 0x400,
5496 event
->modifiers
& ~shift_modifier
,
5497 Qfunction_key
, Qnil
,
5498 lispy_kana_keys
, &func_key_syms
,
5499 ARRAYELTS (lispy_kana_keys
));
5500 #endif /* XK_kana_A */
5503 #ifdef ISO_FUNCTION_KEY_OFFSET
5504 if (event
->code
< FUNCTION_KEY_OFFSET
5505 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5506 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5508 Qfunction_key
, Qnil
,
5509 iso_lispy_function_keys
, &func_key_syms
,
5510 ARRAYELTS (iso_lispy_function_keys
));
5513 if ((FUNCTION_KEY_OFFSET
<= event
->code
5515 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5516 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5517 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5519 Qfunction_key
, Qnil
,
5520 lispy_function_keys
, &func_key_syms
,
5521 ARRAYELTS (lispy_function_keys
));
5523 /* Handle system-specific or unknown keysyms.
5524 We need to use an alist rather than a vector as the cache
5525 since we can't make a vector long enough. */
5526 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5527 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5528 return modify_event_symbol (event
->code
,
5531 KVAR (current_kboard
, Vsystem_key_alist
),
5532 0, &KVAR (current_kboard
, system_key_syms
),
5536 case MULTIMEDIA_KEY_EVENT
:
5537 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5538 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5540 return modify_event_symbol (event
->code
, event
->modifiers
,
5541 Qfunction_key
, Qnil
,
5542 lispy_multimedia_keys
, &func_key_syms
,
5543 ARRAYELTS (lispy_multimedia_keys
));
5548 /* A mouse click. Figure out where it is, decide whether it's
5549 a press, click or drag, and build the appropriate structure. */
5550 case MOUSE_CLICK_EVENT
:
5552 case GPM_CLICK_EVENT
:
5554 #ifndef USE_TOOLKIT_SCROLL_BARS
5555 case SCROLL_BAR_CLICK_EVENT
:
5556 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5559 int button
= event
->code
;
5561 Lisp_Object position
;
5562 Lisp_Object
*start_pos_ptr
;
5563 Lisp_Object start_pos
;
5567 /* Build the position as appropriate for this mouse click. */
5568 if (event
->kind
== MOUSE_CLICK_EVENT
5570 || event
->kind
== GPM_CLICK_EVENT
5574 struct frame
*f
= XFRAME (event
->frame_or_window
);
5577 /* Ignore mouse events that were made on frame that
5578 have been deleted. */
5579 if (! FRAME_LIVE_P (f
))
5582 /* EVENT->x and EVENT->y are frame-relative pixel
5583 coordinates at this place. Under old redisplay, COLUMN
5584 and ROW are set to frame relative glyph coordinates
5585 which are then used to determine whether this click is
5586 in a menu (non-toolkit version). */
5587 if (!toolkit_menubar_in_use (f
))
5589 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5590 &column
, &row
, NULL
, 1);
5592 /* In the non-toolkit version, clicks on the menu bar
5593 are ordinary button events in the event buffer.
5594 Distinguish them, and invoke the menu.
5596 (In the toolkit version, the toolkit handles the
5597 menu bar and Emacs doesn't know about it until
5598 after the user makes a selection.) */
5599 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5600 && (event
->modifiers
& down_modifier
))
5602 Lisp_Object items
, item
;
5604 /* Find the menu bar item under `column'. */
5606 items
= FRAME_MENU_BAR_ITEMS (f
);
5607 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5609 Lisp_Object pos
, string
;
5610 string
= AREF (items
, i
+ 1);
5611 pos
= AREF (items
, i
+ 3);
5614 if (column
>= XINT (pos
)
5615 && column
< XINT (pos
) + SCHARS (string
))
5617 item
= AREF (items
, i
);
5622 /* ELisp manual 2.4b says (x y) are window
5623 relative but code says they are
5625 position
= list4 (event
->frame_or_window
,
5627 Fcons (event
->x
, event
->y
),
5628 make_number (event
->timestamp
));
5630 return list2 (item
, position
);
5634 position
= make_lispy_position (f
, event
->x
, event
->y
,
5637 #ifndef USE_TOOLKIT_SCROLL_BARS
5639 /* It's a scrollbar click. */
5640 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5641 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5643 if (button
>= ASIZE (button_down_location
))
5645 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5646 button_down_location
= larger_vector (button_down_location
,
5648 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5651 start_pos_ptr
= aref_addr (button_down_location
, button
);
5652 start_pos
= *start_pos_ptr
;
5653 *start_pos_ptr
= Qnil
;
5656 /* On window-system frames, use the value of
5657 double-click-fuzz as is. On other frames, interpret it
5658 as a multiple of 1/8 characters. */
5662 if (WINDOWP (event
->frame_or_window
))
5663 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5664 else if (FRAMEP (event
->frame_or_window
))
5665 f
= XFRAME (event
->frame_or_window
);
5669 if (FRAME_WINDOW_P (f
))
5670 fuzz
= double_click_fuzz
;
5672 fuzz
= double_click_fuzz
/ 8;
5674 is_double
= (button
== last_mouse_button
5675 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5676 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5677 && button_down_time
!= 0
5678 && (EQ (Vdouble_click_time
, Qt
)
5679 || (NATNUMP (Vdouble_click_time
)
5680 && (event
->timestamp
- button_down_time
5681 < XFASTINT (Vdouble_click_time
)))));
5684 last_mouse_button
= button
;
5685 last_mouse_x
= XINT (event
->x
);
5686 last_mouse_y
= XINT (event
->y
);
5688 /* If this is a button press, squirrel away the location, so
5689 we can decide later whether it was a click or a drag. */
5690 if (event
->modifiers
& down_modifier
)
5694 double_click_count
++;
5695 event
->modifiers
|= ((double_click_count
> 2)
5700 double_click_count
= 1;
5701 button_down_time
= event
->timestamp
;
5702 *start_pos_ptr
= Fcopy_alist (position
);
5703 ignore_mouse_drag_p
= 0;
5706 /* Now we're releasing a button - check the co-ordinates to
5707 see if this was a click or a drag. */
5708 else if (event
->modifiers
& up_modifier
)
5710 /* If we did not see a down before this up, ignore the up.
5711 Probably this happened because the down event chose a
5712 menu item. It would be an annoyance to treat the
5713 release of the button that chose the menu item as a
5716 if (!CONSP (start_pos
))
5719 event
->modifiers
&= ~up_modifier
;
5722 Lisp_Object new_down
, down
;
5723 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5725 /* The third element of every position
5726 should be the (x,y) pair. */
5727 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5728 new_down
= Fcar (Fcdr (Fcdr (position
)));
5731 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5733 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5734 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5737 if (ignore_mouse_drag_p
)
5739 event
->modifiers
|= click_modifier
;
5740 ignore_mouse_drag_p
= 0;
5742 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5743 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5744 /* Maybe the mouse has moved a lot, caused scrolling, and
5745 eventually ended up at the same screen position (but
5746 not buffer position) in which case it is a drag, not
5748 /* FIXME: OTOH if the buffer position has changed
5749 because of a timer or process filter rather than
5750 because of mouse movement, it should be considered as
5751 a click. But mouse-drag-region completely ignores
5752 this case and it hasn't caused any real problem, so
5753 it's probably OK to ignore it as well. */
5754 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5755 /* Mouse hasn't moved (much). */
5756 event
->modifiers
|= click_modifier
;
5759 button_down_time
= 0;
5760 event
->modifiers
|= drag_modifier
;
5763 /* Don't check is_double; treat this as multiple
5764 if the down-event was multiple. */
5765 if (double_click_count
> 1)
5766 event
->modifiers
|= ((double_click_count
> 2)
5772 /* Every mouse event should either have the down_modifier or
5773 the up_modifier set. */
5777 /* Get the symbol we should use for the mouse click. */
5780 head
= modify_event_symbol (button
,
5782 Qmouse_click
, Vlispy_mouse_stem
,
5785 ASIZE (mouse_syms
));
5786 if (event
->modifiers
& drag_modifier
)
5787 return list3 (head
, start_pos
, position
);
5788 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5789 return list3 (head
, position
, make_number (double_click_count
));
5791 return list2 (head
, position
);
5796 case HORIZ_WHEEL_EVENT
:
5798 Lisp_Object position
;
5801 /* Build the position as appropriate for this mouse click. */
5802 struct frame
*f
= XFRAME (event
->frame_or_window
);
5804 /* Ignore wheel events that were made on frame that have been
5806 if (! FRAME_LIVE_P (f
))
5809 position
= make_lispy_position (f
, event
->x
, event
->y
,
5812 /* Set double or triple modifiers to indicate the wheel speed. */
5814 /* On window-system frames, use the value of
5815 double-click-fuzz as is. On other frames, interpret it
5816 as a multiple of 1/8 characters. */
5822 if (WINDOWP (event
->frame_or_window
))
5823 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5824 else if (FRAMEP (event
->frame_or_window
))
5825 fr
= XFRAME (event
->frame_or_window
);
5829 fuzz
= FRAME_WINDOW_P (fr
)
5830 ? double_click_fuzz
: double_click_fuzz
/ 8;
5832 if (event
->modifiers
& up_modifier
)
5834 /* Emit a wheel-up event. */
5835 event
->modifiers
&= ~up_modifier
;
5838 else if (event
->modifiers
& down_modifier
)
5840 /* Emit a wheel-down event. */
5841 event
->modifiers
&= ~down_modifier
;
5845 /* Every wheel event should either have the down_modifier or
5846 the up_modifier set. */
5849 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5852 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5853 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5854 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5855 && button_down_time
!= 0
5856 && (EQ (Vdouble_click_time
, Qt
)
5857 || (NATNUMP (Vdouble_click_time
)
5858 && (event
->timestamp
- button_down_time
5859 < XFASTINT (Vdouble_click_time
)))));
5862 double_click_count
++;
5863 event
->modifiers
|= ((double_click_count
> 2)
5869 double_click_count
= 1;
5870 event
->modifiers
|= click_modifier
;
5873 button_down_time
= event
->timestamp
;
5874 /* Use a negative value to distinguish wheel from mouse button. */
5875 last_mouse_button
= - (1 + symbol_num
);
5876 last_mouse_x
= XINT (event
->x
);
5877 last_mouse_y
= XINT (event
->y
);
5879 /* Get the symbol we should use for the wheel event. */
5880 head
= modify_event_symbol (symbol_num
,
5886 ASIZE (wheel_syms
));
5889 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5890 return list3 (head
, position
, make_number (double_click_count
));
5892 return list2 (head
, position
);
5896 #ifdef USE_TOOLKIT_SCROLL_BARS
5898 /* We don't have down and up events if using toolkit scroll bars,
5899 so make this always a click event. Store in the `part' of
5900 the Lisp event a symbol which maps to the following actions:
5902 `above_handle' page up
5903 `below_handle' page down
5907 `bottom' bottom of buffer
5908 `handle' thumb has been dragged.
5909 `end-scroll' end of interaction with scroll bar
5911 The incoming input_event contains in its `part' member an
5912 index of type `enum scroll_bar_part' which we can use as an
5913 index in scroll_bar_parts to get the appropriate symbol. */
5915 case SCROLL_BAR_CLICK_EVENT
:
5917 Lisp_Object position
, head
;
5919 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5921 /* Always treat scroll bar events as clicks. */
5922 event
->modifiers
|= click_modifier
;
5923 event
->modifiers
&= ~up_modifier
;
5925 if (event
->code
>= ASIZE (mouse_syms
))
5926 mouse_syms
= larger_vector (mouse_syms
,
5927 event
->code
- ASIZE (mouse_syms
) + 1,
5930 /* Get the symbol we should use for the mouse click. */
5931 head
= modify_event_symbol (event
->code
,
5936 ASIZE (mouse_syms
));
5937 return list2 (head
, position
);
5940 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5942 Lisp_Object position
, head
;
5944 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5946 /* Always treat scroll bar events as clicks. */
5947 event
->modifiers
|= click_modifier
;
5948 event
->modifiers
&= ~up_modifier
;
5950 if (event
->code
>= ASIZE (mouse_syms
))
5951 mouse_syms
= larger_vector (mouse_syms
,
5952 event
->code
- ASIZE (mouse_syms
) + 1,
5955 /* Get the symbol we should use for the mouse click. */
5956 head
= modify_event_symbol (event
->code
,
5961 ASIZE (mouse_syms
));
5962 return list2 (head
, position
);
5965 #endif /* USE_TOOLKIT_SCROLL_BARS */
5967 case DRAG_N_DROP_EVENT
:
5970 Lisp_Object head
, position
;
5973 f
= XFRAME (event
->frame_or_window
);
5976 /* Ignore mouse events that were made on frames that
5977 have been deleted. */
5978 if (! FRAME_LIVE_P (f
))
5981 position
= make_lispy_position (f
, event
->x
, event
->y
,
5984 head
= modify_event_symbol (0, event
->modifiers
,
5986 lispy_drag_n_drop_names
,
5987 &drag_n_drop_syms
, 1);
5988 return list3 (head
, position
, files
);
5991 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5992 || defined (HAVE_NS) || defined (USE_GTK)
5993 case MENU_BAR_EVENT
:
5994 if (EQ (event
->arg
, event
->frame_or_window
))
5995 /* This is the prefix key. We translate this to
5996 `(menu_bar)' because the code in keyboard.c for menu
5997 events, which we use, relies on this. */
5998 return list1 (Qmenu_bar
);
6002 case SELECT_WINDOW_EVENT
:
6003 /* Make an event (select-window (WINDOW)). */
6004 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6006 case TOOL_BAR_EVENT
:
6007 if (EQ (event
->arg
, event
->frame_or_window
))
6008 /* This is the prefix key. We translate this to
6009 `(tool_bar)' because the code in keyboard.c for tool bar
6010 events, which we use, relies on this. */
6011 return list1 (Qtool_bar
);
6012 else if (SYMBOLP (event
->arg
))
6013 return apply_modifiers (event
->modifiers
, event
->arg
);
6016 case USER_SIGNAL_EVENT
:
6017 /* A user signal. */
6019 char *name
= find_user_signal_name (event
->code
);
6022 return intern (name
);
6025 case SAVE_SESSION_EVENT
:
6026 return Qsave_session
;
6031 return Fcons (Qdbus_event
, event
->arg
);
6033 #endif /* HAVE_DBUS */
6035 #ifdef HAVE_XWIDGETS
6038 return Fcons (Qxwidget_event
, event
->arg
);
6042 #if defined HAVE_INOTIFY || defined HAVE_KQUEUE || defined HAVE_GFILENOTIFY
6043 case FILE_NOTIFY_EVENT
:
6045 return Fcons (Qfile_notify
, event
->arg
);
6047 #endif /* HAVE_INOTIFY || HAVE_KQUEUE || HAVE_GFILENOTIFY */
6049 case CONFIG_CHANGED_EVENT
:
6050 return list3 (Qconfig_changed_event
,
6051 event
->arg
, event
->frame_or_window
);
6053 /* The 'kind' field of the event is something we don't recognize. */
6060 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6061 Lisp_Object x
, Lisp_Object y
, Time t
)
6063 /* Is it a scroll bar movement? */
6064 if (frame
&& ! NILP (bar_window
))
6066 Lisp_Object part_sym
;
6068 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6069 return list2 (Qscroll_bar_movement
,
6071 Qvertical_scroll_bar
,
6076 /* Or is it an ordinary mouse movement? */
6079 Lisp_Object position
;
6080 position
= make_lispy_position (frame
, x
, y
, t
);
6081 return list2 (Qmouse_movement
, position
);
6085 /* Construct a switch frame event. */
6087 make_lispy_switch_frame (Lisp_Object frame
)
6089 return list2 (Qswitch_frame
, frame
);
6093 make_lispy_focus_in (Lisp_Object frame
)
6095 return list2 (Qfocus_in
, frame
);
6098 #ifdef HAVE_WINDOW_SYSTEM
6101 make_lispy_focus_out (Lisp_Object frame
)
6103 return list2 (Qfocus_out
, frame
);
6106 #endif /* HAVE_WINDOW_SYSTEM */
6108 /* Manipulating modifiers. */
6110 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6112 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6113 SYMBOL's name of the end of the modifiers; the string from this
6114 position is the unmodified symbol name.
6116 This doesn't use any caches. */
6119 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6125 CHECK_SYMBOL (symbol
);
6128 name
= SYMBOL_NAME (symbol
);
6130 for (i
= 0; i
< SBYTES (name
) - 1; )
6132 ptrdiff_t this_mod_end
= 0;
6135 /* See if the name continues with a modifier word.
6136 Check that the word appears, but don't check what follows it.
6137 Set this_mod and this_mod_end to record what we find. */
6139 switch (SREF (name
, i
))
6141 #define SINGLE_LETTER_MOD(BIT) \
6142 (this_mod_end = i + 1, this_mod = BIT)
6145 SINGLE_LETTER_MOD (alt_modifier
);
6149 SINGLE_LETTER_MOD (ctrl_modifier
);
6153 SINGLE_LETTER_MOD (hyper_modifier
);
6157 SINGLE_LETTER_MOD (meta_modifier
);
6161 SINGLE_LETTER_MOD (shift_modifier
);
6165 SINGLE_LETTER_MOD (super_modifier
);
6168 #undef SINGLE_LETTER_MOD
6170 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6171 if (i + LEN + 1 <= SBYTES (name) \
6172 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6174 this_mod_end = i + LEN; \
6179 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6180 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6181 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6185 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6189 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6191 #undef MULTI_LETTER_MOD
6195 /* If we found no modifier, stop looking for them. */
6196 if (this_mod_end
== 0)
6199 /* Check there is a dash after the modifier, so that it
6200 really is a modifier. */
6201 if (this_mod_end
>= SBYTES (name
)
6202 || SREF (name
, this_mod_end
) != '-')
6205 /* This modifier is real; look for another. */
6206 modifiers
|= this_mod
;
6207 i
= this_mod_end
+ 1;
6210 /* Should we include the `click' modifier? */
6211 if (! (modifiers
& (down_modifier
| drag_modifier
6212 | double_modifier
| triple_modifier
))
6213 && i
+ 7 == SBYTES (name
)
6214 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6215 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6216 modifiers
|= click_modifier
;
6218 if (! (modifiers
& (double_modifier
| triple_modifier
))
6219 && i
+ 6 < SBYTES (name
)
6220 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6221 modifiers
|= click_modifier
;
6229 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6230 prepended to the string BASE[0..BASE_LEN-1].
6231 This doesn't use any caches. */
6233 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6235 /* Since BASE could contain nulls, we can't use intern here; we have
6236 to use Fintern, which expects a genuine Lisp_String, and keeps a
6238 char new_mods
[sizeof "A-C-H-M-S-s-up-down-drag-double-triple-"];
6244 /* Mouse events should not exhibit the `up' modifier once they
6245 leave the event queue only accessible to C code; `up' will
6246 always be turned into a click or drag event before being
6247 presented to lisp code. But since lisp events can be
6248 synthesized bypassing the event queue and pushed into
6249 `unread-command-events' or its companions, it's better to just
6250 deal with unexpected modifier combinations. */
6252 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6253 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6254 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6255 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6256 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6257 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6258 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6259 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6260 if (modifiers
& up_modifier
) p
= stpcpy (p
, "up-");
6261 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6262 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6263 /* The click modifier is denoted by the absence of other modifiers. */
6267 mod_len
= p
- new_mods
;
6271 Lisp_Object new_name
;
6273 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6274 mod_len
+ base_len_byte
);
6275 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6276 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6278 return Fintern (new_name
, Qnil
);
6283 static const char *const modifier_names
[] =
6285 "up", "down", "drag", "click", "double", "triple", 0, 0,
6286 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6287 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6289 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6291 static Lisp_Object modifier_symbols
;
6293 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6295 lispy_modifier_list (int modifiers
)
6297 Lisp_Object modifier_list
;
6300 modifier_list
= Qnil
;
6301 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6302 if (modifiers
& (1<<i
))
6303 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6306 return modifier_list
;
6310 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6311 where UNMODIFIED is the unmodified form of SYMBOL,
6312 MASK is the set of modifiers present in SYMBOL's name.
6313 This is similar to parse_modifiers_uncached, but uses the cache in
6314 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6315 Qevent_symbol_elements property. */
6317 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6320 parse_modifiers (Lisp_Object symbol
)
6322 Lisp_Object elements
;
6324 if (INTEGERP (symbol
))
6325 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6326 else if (!SYMBOLP (symbol
))
6329 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6330 if (CONSP (elements
))
6335 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6336 Lisp_Object unmodified
;
6339 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6340 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6343 if (modifiers
& ~INTMASK
)
6345 XSETFASTINT (mask
, modifiers
);
6346 elements
= list2 (unmodified
, mask
);
6348 /* Cache the parsing results on SYMBOL. */
6349 Fput (symbol
, Qevent_symbol_element_mask
,
6351 Fput (symbol
, Qevent_symbol_elements
,
6352 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6354 /* Since we know that SYMBOL is modifiers applied to unmodified,
6355 it would be nice to put that in unmodified's cache.
6356 But we can't, since we're not sure that parse_modifiers is
6363 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6364 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6365 doc
: /* Parse the event symbol. For internal use. */)
6366 (Lisp_Object symbol
)
6368 /* Fill the cache if needed. */
6369 parse_modifiers (symbol
);
6370 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6371 and use the Lispier representation stored on Qevent_symbol_elements
6373 return Fget (symbol
, Qevent_symbol_elements
);
6376 /* Apply the modifiers MODIFIERS to the symbol BASE.
6377 BASE must be unmodified.
6379 This is like apply_modifiers_uncached, but uses BASE's
6380 Qmodifier_cache property, if present.
6382 apply_modifiers copies the value of BASE's Qevent_kind property to
6383 the modified symbol. */
6385 apply_modifiers (int modifiers
, Lisp_Object base
)
6387 Lisp_Object cache
, idx
, entry
, new_symbol
;
6389 /* Mask out upper bits. We don't know where this value's been. */
6390 modifiers
&= INTMASK
;
6392 if (INTEGERP (base
))
6393 return make_number (XINT (base
) | modifiers
);
6395 /* The click modifier never figures into cache indices. */
6396 cache
= Fget (base
, Qmodifier_cache
);
6397 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6398 entry
= assq_no_quit (idx
, cache
);
6401 new_symbol
= XCDR (entry
);
6404 /* We have to create the symbol ourselves. */
6405 new_symbol
= apply_modifiers_uncached (modifiers
,
6406 SSDATA (SYMBOL_NAME (base
)),
6407 SCHARS (SYMBOL_NAME (base
)),
6408 SBYTES (SYMBOL_NAME (base
)));
6410 /* Add the new symbol to the base's cache. */
6411 entry
= Fcons (idx
, new_symbol
);
6412 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6414 /* We have the parsing info now for free, so we could add it to
6416 XSETFASTINT (idx, modifiers);
6417 Fput (new_symbol, Qevent_symbol_element_mask,
6419 Fput (new_symbol, Qevent_symbol_elements,
6420 Fcons (base, lispy_modifier_list (modifiers)));
6421 Sadly, this is only correct if `base' is indeed a base event,
6422 which is not necessarily the case. -stef */
6425 /* Make sure this symbol is of the same kind as BASE.
6427 You'd think we could just set this once and for all when we
6428 intern the symbol above, but reorder_modifiers may call us when
6429 BASE's property isn't set right; we can't assume that just
6430 because it has a Qmodifier_cache property it must have its
6431 Qevent_kind set right as well. */
6432 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6436 kind
= Fget (base
, Qevent_kind
);
6438 Fput (new_symbol
, Qevent_kind
, kind
);
6445 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6446 return a symbol with the modifiers placed in the canonical order.
6447 Canonical order is alphabetical, except for down and drag, which
6448 always come last. The 'click' modifier is never written out.
6450 Fdefine_key calls this to make sure that (for example) C-M-foo
6451 and M-C-foo end up being equivalent in the keymap. */
6454 reorder_modifiers (Lisp_Object symbol
)
6456 /* It's hopefully okay to write the code this way, since everything
6457 will soon be in caches, and no consing will be done at all. */
6460 parsed
= parse_modifiers (symbol
);
6461 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6466 /* For handling events, we often want to produce a symbol whose name
6467 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6468 to some base, like the name of a function key or mouse button.
6469 modify_event_symbol produces symbols of this sort.
6471 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6472 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6475 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6476 into symbol names, or a string specifying a name stem used to
6477 construct a symbol name or the form `STEM-N', where N is the decimal
6478 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6479 non-nil; otherwise NAME_TABLE is used.
6481 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6482 persist between calls to modify_event_symbol that it can use to
6483 store a cache of the symbols it's generated for this NAME_TABLE
6484 before. The object stored there may be a vector or an alist.
6486 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6488 MODIFIERS is a set of modifier bits (as given in struct input_events)
6489 whose prefixes should be applied to the symbol name.
6491 SYMBOL_KIND is the value to be placed in the event_kind property of
6492 the returned symbol.
6494 The symbols we create are supposed to have an
6495 `event-symbol-elements' property, which lists the modifiers present
6496 in the symbol's name. */
6499 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6500 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6501 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6504 Lisp_Object symbol_int
;
6506 /* Get rid of the "vendor-specific" bit here. */
6507 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6509 /* Is this a request for a valid symbol? */
6510 if (symbol_num
< 0 || symbol_num
>= table_size
)
6513 if (CONSP (*symbol_table
))
6514 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6516 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6517 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6518 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6519 we've never used that symbol before. */
6522 if (! VECTORP (*symbol_table
)
6523 || ASIZE (*symbol_table
) != table_size
)
6527 XSETFASTINT (size
, table_size
);
6528 *symbol_table
= Fmake_vector (size
, Qnil
);
6531 value
= AREF (*symbol_table
, symbol_num
);
6534 /* Have we already used this symbol before? */
6537 /* No; let's create it. */
6538 if (CONSP (name_alist_or_stem
))
6539 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6540 else if (STRINGP (name_alist_or_stem
))
6543 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6544 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6546 buf
= SAFE_ALLOCA (len
);
6547 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6548 XINT (symbol_int
) + 1);
6549 value
= intern (buf
);
6552 else if (name_table
!= 0 && name_table
[symbol_num
])
6553 value
= intern (name_table
[symbol_num
]);
6555 #ifdef HAVE_WINDOW_SYSTEM
6558 char *name
= x_get_keysym_name (symbol_num
);
6560 value
= intern (name
);
6566 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6567 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6568 value
= intern (buf
);
6571 if (CONSP (*symbol_table
))
6572 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6574 ASET (*symbol_table
, symbol_num
, value
);
6576 /* Fill in the cache entries for this symbol; this also
6577 builds the Qevent_symbol_elements property, which the user
6579 apply_modifiers (modifiers
& click_modifier
, value
);
6580 Fput (value
, Qevent_kind
, symbol_kind
);
6583 /* Apply modifiers to that symbol. */
6584 return apply_modifiers (modifiers
, value
);
6587 /* Convert a list that represents an event type,
6588 such as (ctrl meta backspace), into the usual representation of that
6589 event type as a number or a symbol. */
6591 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6592 doc
: /* Convert the event description list EVENT-DESC to an event type.
6593 EVENT-DESC should contain one base event type (a character or symbol)
6594 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6595 drag, down, double or triple). The base must be last.
6596 The return value is an event type (a character or symbol) which
6597 has the same base event type and all the specified modifiers. */)
6598 (Lisp_Object event_desc
)
6606 while (CONSP (rest
))
6614 /* Given a symbol, see if it is a modifier name. */
6615 if (SYMBOLP (elt
) && CONSP (rest
))
6616 this = parse_solitary_modifier (elt
);
6620 else if (!NILP (base
))
6621 error ("Two bases given in one event");
6627 /* Let the symbol A refer to the character A. */
6628 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6629 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6631 if (INTEGERP (base
))
6633 /* Turn (shift a) into A. */
6634 if ((modifiers
& shift_modifier
) != 0
6635 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6637 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6638 modifiers
&= ~shift_modifier
;
6641 /* Turn (control a) into C-a. */
6642 if (modifiers
& ctrl_modifier
)
6643 return make_number ((modifiers
& ~ctrl_modifier
)
6644 | make_ctrl_char (XINT (base
)));
6646 return make_number (modifiers
| XINT (base
));
6648 else if (SYMBOLP (base
))
6649 return apply_modifiers (modifiers
, base
);
6651 error ("Invalid base event");
6654 /* Try to recognize SYMBOL as a modifier name.
6655 Return the modifier flag bit, or 0 if not recognized. */
6658 parse_solitary_modifier (Lisp_Object symbol
)
6662 if (!SYMBOLP (symbol
))
6665 name
= SYMBOL_NAME (symbol
);
6667 switch (SREF (name
, 0))
6669 #define SINGLE_LETTER_MOD(BIT) \
6670 if (SBYTES (name) == 1) \
6673 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6674 if (LEN == SBYTES (name) \
6675 && ! memcmp (SDATA (name), NAME, LEN)) \
6679 SINGLE_LETTER_MOD (alt_modifier
);
6683 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6687 SINGLE_LETTER_MOD (ctrl_modifier
);
6691 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6692 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6696 SINGLE_LETTER_MOD (hyper_modifier
);
6700 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6704 SINGLE_LETTER_MOD (meta_modifier
);
6708 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6712 SINGLE_LETTER_MOD (shift_modifier
);
6716 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6717 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6718 SINGLE_LETTER_MOD (super_modifier
);
6722 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6723 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6724 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6728 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6732 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6735 #undef SINGLE_LETTER_MOD
6736 #undef MULTI_LETTER_MOD
6742 /* Return true if EVENT is a list whose elements are all integers or symbols.
6743 Such a list is not valid as an event,
6744 but it can be a Lucid-style event type list. */
6747 lucid_event_type_list_p (Lisp_Object object
)
6751 if (! CONSP (object
))
6754 if (EQ (XCAR (object
), Qhelp_echo
)
6755 || EQ (XCAR (object
), Qvertical_line
)
6756 || EQ (XCAR (object
), Qmode_line
)
6757 || EQ (XCAR (object
), Qheader_line
))
6760 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6764 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6771 /* Return true if terminal input chars are available.
6772 Also, store the return value into INPUT_PENDING.
6774 Serves the purpose of ioctl (0, FIONREAD, ...)
6775 but works even if FIONREAD does not exist.
6776 (In fact, this may actually read some input.)
6778 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6779 timer events that are ripe.
6780 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6781 events (FOCUS_IN_EVENT).
6782 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6783 movements and toolkit scroll bar thumb drags. */
6786 get_input_pending (int flags
)
6788 /* First of all, have we already counted some input? */
6789 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6791 /* If input is being read as it arrives, and we have none, there is none. */
6792 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6794 /* Try to read some input and see how much we get. */
6796 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6799 return input_pending
;
6802 /* Put a BUFFER_SWITCH_EVENT in the buffer
6803 so that read_key_sequence will notice the new current buffer. */
6806 record_asynch_buffer_change (void)
6808 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6809 The purpose of the event is to make read_key_sequence look up the
6810 keymaps again. If we aren't in read_key_sequence, we don't need one,
6811 and the event could cause trouble by messing up (input-pending-p).
6812 Note: Fwaiting_for_user_input_p always returns nil when async
6813 subprocesses aren't supported. */
6814 if (!NILP (Fwaiting_for_user_input_p ()))
6816 struct input_event event
;
6819 event
.kind
= BUFFER_SWITCH_EVENT
;
6820 event
.frame_or_window
= Qnil
;
6823 /* Make sure no interrupt happens while storing the event. */
6825 if (interrupt_input
)
6826 kbd_buffer_store_event (&event
);
6831 kbd_buffer_store_event (&event
);
6837 /* Read any terminal input already buffered up by the system
6838 into the kbd_buffer, but do not wait.
6840 Return the number of keyboard chars read, or -1 meaning
6841 this is a bad time to try to read input. */
6850 /* Store pending user signal events, if any. */
6851 store_user_signal_events ();
6853 /* Loop through the available terminals, and call their input hooks. */
6857 struct terminal
*next
= t
->next_terminal
;
6859 if (t
->read_socket_hook
)
6862 struct input_event hold_quit
;
6864 if (input_blocked_p ())
6866 pending_signals
= true;
6870 EVENT_INIT (hold_quit
);
6871 hold_quit
.kind
= NO_EVENT
;
6873 /* No need for FIONREAD or fcntl; just say don't wait. */
6874 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6877 if (nr
== -1) /* Not OK to read input now. */
6881 else if (nr
== -2) /* Non-transient error. */
6883 /* The terminal device terminated; it should be closed. */
6885 /* Kill Emacs if this was our last terminal. */
6886 if (!terminal_list
->next_terminal
)
6887 /* Formerly simply reported no input, but that
6888 sometimes led to a failure of Emacs to terminate.
6889 SIGHUP seems appropriate if we can't reach the
6891 /* ??? Is it really right to send the signal just to
6892 this process rather than to the whole process
6893 group? Perhaps on systems with FIONREAD Emacs is
6894 alone in its group. */
6895 terminate_due_to_signal (SIGHUP
, 10);
6897 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6900 XSETTERMINAL (tmp
, t
);
6901 Fdelete_terminal (tmp
, Qnoelisp
);
6905 /* If there was no error, make sure the pointer
6906 is visible for all frames on this terminal. */
6909 Lisp_Object tail
, frame
;
6911 FOR_EACH_FRAME (tail
, frame
)
6913 struct frame
*f
= XFRAME (frame
);
6914 if (FRAME_TERMINAL (f
) == t
)
6915 frame_make_pointer_visible (f
);
6919 if (hold_quit
.kind
!= NO_EVENT
)
6920 kbd_buffer_store_event (&hold_quit
);
6932 /* This is the tty way of reading available input.
6934 Note that each terminal device has its own `struct terminal' object,
6935 and so this function is called once for each individual termcap
6936 terminal. The first parameter indicates which terminal to read from. */
6939 tty_read_avail_input (struct terminal
*terminal
,
6940 struct input_event
*hold_quit
)
6942 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6943 the kbd_buffer can really hold. That may prevent loss
6944 of characters on some systems when input is stuffed at us. */
6945 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6950 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6953 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6955 if (kbd_on_hold_p () || buffer_free
<= 0)
6957 #endif /* subprocesses */
6959 if (!terminal
->name
) /* Don't read from a dead terminal. */
6962 if (terminal
->type
!= output_termcap
6963 && terminal
->type
!= output_msdos_raw
)
6966 /* XXX I think the following code should be moved to separate hook
6967 functions in system-dependent files. */
6969 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6970 code sets read_socket_hook to w32_console_read_socket instead! */
6972 #else /* not WINDOWSNT */
6973 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6977 return 0; /* The terminal is suspended. */
6980 n_to_read
= dos_keysns ();
6984 cbuf
[0] = dos_keyread ();
6987 #else /* not MSDOS */
6992 struct input_event gpm_hold_quit
;
6993 int gpm
, fd
= gpm_fd
;
6995 EVENT_INIT (gpm_hold_quit
);
6996 gpm_hold_quit
.kind
= NO_EVENT
;
6998 /* gpm==1 if event received.
6999 gpm==0 if the GPM daemon has closed the connection, in which case
7000 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7001 we save it in `fd' so close_gpm can remove it from the
7003 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7004 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7005 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7008 /* Presumably the GPM daemon has closed the connection. */
7010 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7011 kbd_buffer_store_event (&gpm_hold_quit
);
7015 #endif /* HAVE_GPM */
7017 /* Determine how many characters we should *try* to read. */
7018 #ifdef USABLE_FIONREAD
7019 /* Find out how much input is available. */
7020 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7022 if (! noninteractive
)
7023 return -2; /* Close this terminal. */
7029 if (n_to_read
> sizeof cbuf
)
7030 n_to_read
= sizeof cbuf
;
7031 #elif defined USG || defined CYGWIN
7032 /* Read some input if available, but don't wait. */
7033 n_to_read
= sizeof cbuf
;
7034 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7036 # error "Cannot read without possibly delaying"
7040 /* Don't read more than we can store. */
7041 if (n_to_read
> buffer_free
)
7042 n_to_read
= buffer_free
;
7043 #endif /* subprocesses */
7045 /* Now read; for one reason or another, this will not block.
7046 NREAD is set to the number of chars read. */
7049 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7050 /* POSIX infers that processes which are not in the session leader's
7051 process group won't get SIGHUPs at logout time. BSDI adheres to
7052 this part standard and returns -1 from read (0) with errno==EIO
7053 when the control tty is taken away.
7054 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7055 if (nread
== -1 && errno
== EIO
)
7056 return -2; /* Close this terminal. */
7057 #if defined (AIX) && defined (_BSD)
7058 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7059 This looks incorrect, but it isn't, because _BSD causes
7060 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7061 and that causes a value other than 0 when there is no input. */
7063 return -2; /* Close this terminal. */
7067 /* We used to retry the read if it was interrupted.
7068 But this does the wrong thing when O_NONBLOCK causes
7069 an EAGAIN error. Does anybody know of a situation
7070 where a retry is actually needed? */
7072 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7082 #ifndef USABLE_FIONREAD
7083 #if defined (USG) || defined (CYGWIN)
7084 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7085 #endif /* USG or CYGWIN */
7086 #endif /* no FIONREAD */
7091 #endif /* not MSDOS */
7092 #endif /* not WINDOWSNT */
7094 for (i
= 0; i
< nread
; i
++)
7096 struct input_event buf
;
7098 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7100 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7101 buf
.modifiers
= meta_modifier
;
7102 if (tty
->meta_key
!= 2)
7106 /* Set the frame corresponding to the active tty. Note that the
7107 value of selected_frame is not reliable here, redisplay tends
7108 to temporarily change it. */
7109 buf
.frame_or_window
= tty
->top_frame
;
7112 kbd_buffer_store_event (&buf
);
7113 /* Don't look at input that follows a C-g too closely.
7114 This reduces lossage due to autorepeat on C-g. */
7115 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7116 && buf
.code
== quit_char
)
7124 handle_async_input (void)
7129 int nread
= gobble_input ();
7130 /* -1 means it's not ok to read the input now.
7131 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7132 0 means there was no keyboard input available. */
7140 process_pending_signals (void)
7142 pending_signals
= false;
7143 handle_async_input ();
7144 do_pending_atimers ();
7147 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7148 and reinvoke any pending signal if the level is now 0 and
7149 a fatal error is not already in progress. */
7152 unblock_input_to (int level
)
7154 interrupt_input_blocked
= level
;
7157 if (pending_signals
&& !fatal_error_in_progress
)
7158 process_pending_signals ();
7164 /* End critical section.
7166 If doing signal-driven input, and a signal came in when input was
7167 blocked, reinvoke the signal handler now to deal with it.
7169 It will also process queued input, if it was not read before.
7170 When a longer code sequence does not use block/unblock input
7171 at all, the whole input gathered up to the next call to
7172 unblock_input will be processed inside that call. */
7175 unblock_input (void)
7177 unblock_input_to (interrupt_input_blocked
- 1);
7180 /* Undo any number of BLOCK_INPUT calls,
7181 and also reinvoke any pending signal. */
7184 totally_unblock_input (void)
7186 unblock_input_to (0);
7192 handle_input_available_signal (int sig
)
7194 pending_signals
= true;
7196 if (input_available_clear_time
)
7197 *input_available_clear_time
= make_timespec (0, 0);
7201 deliver_input_available_signal (int sig
)
7203 deliver_process_signal (sig
, handle_input_available_signal
);
7205 #endif /* USABLE_SIGIO */
7208 /* User signal events. */
7210 struct user_signal_info
7212 /* Signal number. */
7215 /* Name of the signal. */
7218 /* Number of pending signals. */
7221 struct user_signal_info
*next
;
7224 /* List of user signals. */
7225 static struct user_signal_info
*user_signals
= NULL
;
7228 add_user_signal (int sig
, const char *name
)
7230 struct sigaction action
;
7231 struct user_signal_info
*p
;
7233 for (p
= user_signals
; p
; p
= p
->next
)
7235 /* Already added. */
7238 p
= xmalloc (sizeof *p
);
7240 p
->name
= xstrdup (name
);
7242 p
->next
= user_signals
;
7245 emacs_sigaction_init (&action
, deliver_user_signal
);
7246 sigaction (sig
, &action
, 0);
7250 handle_user_signal (int sig
)
7252 struct user_signal_info
*p
;
7253 const char *special_event_name
= NULL
;
7255 if (SYMBOLP (Vdebug_on_event
))
7256 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7258 for (p
= user_signals
; p
; p
= p
->next
)
7261 if (special_event_name
7262 && strcmp (special_event_name
, p
->name
) == 0)
7264 /* Enter the debugger in many ways. */
7265 debug_on_next_call
= true;
7266 debug_on_quit
= true;
7268 Vinhibit_quit
= Qnil
;
7270 /* Eat the event. */
7276 if (interrupt_input
)
7277 handle_input_available_signal (sig
);
7281 /* Tell wait_reading_process_output that it needs to wake
7282 up and look around. */
7283 if (input_available_clear_time
)
7284 *input_available_clear_time
= make_timespec (0, 0);
7291 deliver_user_signal (int sig
)
7293 deliver_process_signal (sig
, handle_user_signal
);
7297 find_user_signal_name (int sig
)
7299 struct user_signal_info
*p
;
7301 for (p
= user_signals
; p
; p
= p
->next
)
7309 store_user_signal_events (void)
7311 struct user_signal_info
*p
;
7312 struct input_event buf
;
7313 bool buf_initialized
= false;
7315 for (p
= user_signals
; p
; p
= p
->next
)
7316 if (p
->npending
> 0)
7318 if (! buf_initialized
)
7320 memset (&buf
, 0, sizeof buf
);
7321 buf
.kind
= USER_SIGNAL_EVENT
;
7322 buf
.frame_or_window
= selected_frame
;
7323 buf_initialized
= true;
7329 kbd_buffer_store_event (&buf
);
7332 while (p
->npending
> 0);
7337 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7338 static Lisp_Object menu_bar_one_keymap_changed_items
;
7340 /* These variables hold the vector under construction within
7341 menu_bar_items and its subroutines, and the current index
7342 for storing into that vector. */
7343 static Lisp_Object menu_bar_items_vector
;
7344 static int menu_bar_items_index
;
7347 static const char *separator_names
[] = {
7352 "single-dashed-line",
7353 "double-dashed-line",
7355 "shadow-etched-out",
7356 "shadow-etched-in-dash",
7357 "shadow-etched-out-dash",
7358 "shadow-double-etched-in",
7359 "shadow-double-etched-out",
7360 "shadow-double-etched-in-dash",
7361 "shadow-double-etched-out-dash",
7365 /* Return true if LABEL specifies a separator. */
7368 menu_separator_name_p (const char *label
)
7372 else if (strlen (label
) > 3
7373 && memcmp (label
, "--", 2) == 0
7378 for (i
= 0; separator_names
[i
]; ++i
)
7379 if (strcmp (label
, separator_names
[i
]) == 0)
7384 /* It's a separator if it contains only dashes. */
7385 while (*label
== '-')
7387 return (*label
== 0);
7394 /* Return a vector of menu items for a menu bar, appropriate
7395 to the current buffer. Each item has three elements in the vector:
7398 OLD is an old vector we can optionally reuse, or nil. */
7401 menu_bar_items (Lisp_Object old
)
7403 /* The number of keymaps we're scanning right now, and the number of
7404 keymaps we have allocated space for. */
7407 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7408 in the current keymaps, or nil where it is not a prefix. */
7411 Lisp_Object mapsbuf
[3];
7412 Lisp_Object def
, tail
;
7419 /* In order to build the menus, we need to call the keymap
7420 accessors. They all call QUIT. But this function is called
7421 during redisplay, during which a quit is fatal. So inhibit
7422 quitting while building the menus.
7423 We do this instead of specbind because (1) errors will clear it anyway
7424 and (2) this avoids risk of specpdl overflow. */
7425 oquit
= Vinhibit_quit
;
7429 menu_bar_items_vector
= old
;
7431 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7432 menu_bar_items_index
= 0;
7434 /* Build our list of keymaps.
7435 If we recognize a function key and replace its escape sequence in
7436 keybuf with its symbol, or if the sequence starts with a mouse
7437 click and we need to switch buffers, we jump back here to rebuild
7438 the initial keymaps from the current buffer. */
7442 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7443 if (!NILP (Voverriding_local_map_menu_flag
)
7444 && !NILP (Voverriding_local_map
))
7446 /* Yes, use them (if non-nil) as well as the global map. */
7449 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7450 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7451 if (!NILP (Voverriding_local_map
))
7452 maps
[nmaps
++] = Voverriding_local_map
;
7456 /* No, so use major and minor mode keymaps and keymap property.
7457 Note that menu-bar bindings in the local-map and keymap
7458 properties may not work reliable, as they are only
7459 recognized when the menu-bar (or mode-line) is updated,
7460 which does not normally happen after every command. */
7461 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7462 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7464 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7465 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7466 maps
[nmaps
++] = tem
;
7467 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7468 maps
[nmaps
++] = tem
;
7471 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7474 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7476 maps
[nmaps
++] = current_global_map
;
7479 /* Look up in each map the dummy prefix key `menu-bar'. */
7481 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7482 if (!NILP (maps
[mapno
]))
7484 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7488 menu_bar_one_keymap_changed_items
= Qnil
;
7489 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7493 /* Move to the end those items that should be at the end. */
7495 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7498 int end
= menu_bar_items_index
;
7500 for (i
= 0; i
< end
; i
+= 4)
7501 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7503 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7504 /* Move the item at index I to the end,
7505 shifting all the others forward. */
7506 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7507 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7508 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7509 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7511 memmove (aref_addr (menu_bar_items_vector
, i
),
7512 aref_addr (menu_bar_items_vector
, i
+ 4),
7513 (end
- i
- 4) * word_size
);
7514 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7515 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7516 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7517 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7522 /* Add nil, nil, nil, nil at the end. */
7524 int i
= menu_bar_items_index
;
7525 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7526 menu_bar_items_vector
7527 = larger_vector (menu_bar_items_vector
, 4, -1);
7528 /* Add this item. */
7529 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7530 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7531 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7532 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7533 menu_bar_items_index
= i
;
7536 Vinhibit_quit
= oquit
;
7538 return menu_bar_items_vector
;
7541 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7542 If there's already an item for KEY, add this DEF to it. */
7544 Lisp_Object item_properties
;
7547 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7553 if (EQ (item
, Qundefined
))
7555 /* If a map has an explicit `undefined' as definition,
7556 discard any previously made menu bar item. */
7558 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7559 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7561 if (menu_bar_items_index
> i
+ 4)
7562 memmove (aref_addr (menu_bar_items_vector
, i
),
7563 aref_addr (menu_bar_items_vector
, i
+ 4),
7564 (menu_bar_items_index
- i
- 4) * word_size
);
7565 menu_bar_items_index
-= 4;
7569 /* If this keymap has already contributed to this KEY,
7570 don't contribute to it a second time. */
7571 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7572 if (!NILP (tem
) || NILP (item
))
7575 menu_bar_one_keymap_changed_items
7576 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7578 /* We add to menu_bar_one_keymap_changed_items before doing the
7579 parse_menu_item, so that if it turns out it wasn't a menu item,
7580 it still correctly hides any further menu item. */
7581 parsed
= parse_menu_item (item
, 1);
7585 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7587 /* Find any existing item for this KEY. */
7588 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7589 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7592 /* If we did not find this KEY, add it at the end. */
7593 if (i
== menu_bar_items_index
)
7595 /* If vector is too small, get a bigger one. */
7596 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7597 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7598 /* Add this item. */
7599 ASET (menu_bar_items_vector
, i
, key
); i
++;
7600 ASET (menu_bar_items_vector
, i
,
7601 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7602 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7603 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7604 menu_bar_items_index
= i
;
7606 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7610 old
= AREF (menu_bar_items_vector
, i
+ 2);
7611 /* If the new and the old items are not both keymaps,
7612 the lookup will only find `item'. */
7613 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7614 ASET (menu_bar_items_vector
, i
+ 2, item
);
7618 /* This is used as the handler when calling menu_item_eval_property. */
7620 menu_item_eval_property_1 (Lisp_Object arg
)
7622 /* If we got a quit from within the menu computation,
7623 quit all the way out of it. This takes care of C-] in the debugger. */
7624 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7631 eval_dyn (Lisp_Object form
)
7633 return Feval (form
, Qnil
);
7636 /* Evaluate an expression and return the result (or nil if something
7637 went wrong). Used to evaluate dynamic parts of menu items. */
7639 menu_item_eval_property (Lisp_Object sexpr
)
7641 ptrdiff_t count
= SPECPDL_INDEX ();
7643 specbind (Qinhibit_redisplay
, Qt
);
7644 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7645 menu_item_eval_property_1
);
7646 return unbind_to (count
, val
);
7649 /* This function parses a menu item and leaves the result in the
7650 vector item_properties.
7651 ITEM is a key binding, a possible menu item.
7652 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7654 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7655 parse_menu_item returns true if the item is a menu item and false
7659 parse_menu_item (Lisp_Object item
, int inmenubar
)
7661 Lisp_Object def
, tem
, item_string
, start
;
7663 Lisp_Object keyhint
;
7672 /* Create item_properties vector if necessary. */
7673 if (NILP (item_properties
))
7675 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7677 /* Initialize optional entries. */
7678 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7679 ASET (item_properties
, i
, Qnil
);
7680 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7682 /* Save the item here to protect it from GC. */
7683 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7685 item_string
= XCAR (item
);
7689 if (STRINGP (item_string
))
7691 /* Old format menu item. */
7692 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7694 /* Maybe help string. */
7695 if (CONSP (item
) && STRINGP (XCAR (item
)))
7697 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7698 Fsubstitute_command_keys (XCAR (item
)));
7703 /* Maybe an obsolete key binding cache. */
7704 if (CONSP (item
) && CONSP (XCAR (item
))
7705 && (NILP (XCAR (XCAR (item
)))
7706 || VECTORP (XCAR (XCAR (item
)))))
7709 /* This is the real definition--the function to run. */
7710 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7712 /* Get enable property, if any. */
7715 tem
= Fget (item
, Qmenu_enable
);
7716 if (!NILP (Venable_disabled_menus_and_buttons
))
7717 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7718 else if (!NILP (tem
))
7719 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7722 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7724 /* New format menu item. */
7725 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7726 start
= XCDR (item
);
7729 /* We have a real binding. */
7730 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7732 item
= XCDR (start
);
7733 /* Is there an obsolete cache list with key equivalences. */
7734 if (CONSP (item
) && CONSP (XCAR (item
)))
7737 /* Parse properties. */
7738 while (CONSP (item
) && CONSP (XCDR (item
)))
7743 if (EQ (tem
, QCenable
))
7745 if (!NILP (Venable_disabled_menus_and_buttons
))
7746 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7748 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7750 else if (EQ (tem
, QCvisible
))
7752 /* If got a visible property and that evaluates to nil
7753 then ignore this item. */
7754 tem
= menu_item_eval_property (XCAR (item
));
7758 else if (EQ (tem
, QChelp
))
7760 Lisp_Object help
= XCAR (item
);
7762 help
= Fsubstitute_command_keys (help
);
7763 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7765 else if (EQ (tem
, QCfilter
))
7767 else if (EQ (tem
, QCkey_sequence
))
7770 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7771 /* Be GC protected. Set keyhint to item instead of tem. */
7774 else if (EQ (tem
, QCkeys
))
7777 if (CONSP (tem
) || STRINGP (tem
))
7778 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7780 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7785 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7787 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7789 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7795 else if (inmenubar
|| !NILP (start
))
7799 return 0; /* not a menu item */
7801 /* If item string is not a string, evaluate it to get string.
7802 If we don't get a string, skip this item. */
7803 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7804 if (!(STRINGP (item_string
)))
7806 item_string
= menu_item_eval_property (item_string
);
7807 if (!STRINGP (item_string
))
7809 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7812 /* If got a filter apply it on definition. */
7813 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7816 def
= menu_item_eval_property (list2 (XCAR (filter
),
7817 list2 (Qquote
, def
)));
7819 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7822 /* Enable or disable selection of item. */
7823 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7826 tem
= menu_item_eval_property (tem
);
7827 if (inmenubar
&& NILP (tem
))
7828 return 0; /* Ignore disabled items in menu bar. */
7829 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7832 /* If we got no definition, this item is just unselectable text which
7833 is OK in a submenu but not in the menubar. */
7835 return (!inmenubar
);
7837 /* See if this is a separate pane or a submenu. */
7838 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7839 tem
= get_keymap (def
, 0, 1);
7840 /* For a subkeymap, just record its details and exit. */
7843 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7844 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7848 /* At the top level in the menu bar, do likewise for commands also.
7849 The menu bar does not display equivalent key bindings anyway.
7850 ITEM_PROPERTY_DEF is already set up properly. */
7854 { /* This is a command. See if there is an equivalent key binding. */
7855 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7856 AUTO_STRING (space_space
, " ");
7858 /* The previous code preferred :key-sequence to :keys, so we
7859 preserve this behavior. */
7860 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7861 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7864 Lisp_Object prefix
= keyeq
;
7865 Lisp_Object keys
= Qnil
;
7869 def
= XCAR (prefix
);
7870 prefix
= XCDR (prefix
);
7873 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7875 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7877 keys
= XCAR (keyhint
);
7878 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7880 /* We have a suggested key. Is it bound to the command? */
7883 /* If the command is an alias for another
7884 (such as lmenu.el set it up), check if the
7885 original command matches the cached command. */
7887 && EQ (tem
, XSYMBOL (def
)->function
))))
7892 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7896 tem
= Fkey_description (keys
, Qnil
);
7899 if (STRINGP (XCAR (prefix
)))
7900 tem
= concat2 (XCAR (prefix
), tem
);
7901 if (STRINGP (XCDR (prefix
)))
7902 tem
= concat2 (tem
, XCDR (prefix
));
7904 keyeq
= concat2 (space_space
, tem
);
7910 /* If we have an equivalent key binding, use that. */
7911 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7914 /* Include this when menu help is implemented.
7915 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7916 if (!(NILP (tem) || STRINGP (tem)))
7918 tem = menu_item_eval_property (tem);
7921 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7925 /* Handle radio buttons or toggle boxes. */
7926 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7928 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7929 menu_item_eval_property (tem
));
7936 /***********************************************************************
7938 ***********************************************************************/
7940 /* A vector holding tool bar items while they are parsed in function
7941 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7944 static Lisp_Object tool_bar_items_vector
;
7946 /* A vector holding the result of parse_tool_bar_item. Layout is like
7947 the one for a single item in tool_bar_items_vector. */
7949 static Lisp_Object tool_bar_item_properties
;
7951 /* Next free index in tool_bar_items_vector. */
7953 static int ntool_bar_items
;
7955 /* Function prototypes. */
7957 static void init_tool_bar_items (Lisp_Object
);
7958 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7960 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7961 static void append_tool_bar_item (void);
7964 /* Return a vector of tool bar items for keymaps currently in effect.
7965 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7966 tool bar items found. */
7969 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7972 Lisp_Object mapsbuf
[3];
7980 /* In order to build the menus, we need to call the keymap
7981 accessors. They all call QUIT. But this function is called
7982 during redisplay, during which a quit is fatal. So inhibit
7983 quitting while building the menus. We do this instead of
7984 specbind because (1) errors will clear it anyway and (2) this
7985 avoids risk of specpdl overflow. */
7986 oquit
= Vinhibit_quit
;
7989 /* Initialize tool_bar_items_vector and protect it from GC. */
7990 init_tool_bar_items (reuse
);
7992 /* Build list of keymaps in maps. Set nmaps to the number of maps
7995 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7996 if (!NILP (Voverriding_local_map_menu_flag
)
7997 && !NILP (Voverriding_local_map
))
7999 /* Yes, use them (if non-nil) as well as the global map. */
8002 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8003 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8004 if (!NILP (Voverriding_local_map
))
8005 maps
[nmaps
++] = Voverriding_local_map
;
8009 /* No, so use major and minor mode keymaps and keymap property.
8010 Note that tool-bar bindings in the local-map and keymap
8011 properties may not work reliable, as they are only
8012 recognized when the tool-bar (or mode-line) is updated,
8013 which does not normally happen after every command. */
8014 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
8015 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
8017 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8018 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8019 maps
[nmaps
++] = tem
;
8020 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8021 maps
[nmaps
++] = tem
;
8024 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8027 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8030 /* Add global keymap at the end. */
8031 maps
[nmaps
++] = current_global_map
;
8033 /* Process maps in reverse order and look up in each map the prefix
8035 for (i
= nmaps
- 1; i
>= 0; --i
)
8036 if (!NILP (maps
[i
]))
8040 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8042 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8045 Vinhibit_quit
= oquit
;
8046 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8048 return tool_bar_items_vector
;
8052 /* Process the definition of KEY which is DEF. */
8055 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8059 if (EQ (def
, Qundefined
))
8061 /* If a map has an explicit `undefined' as definition,
8062 discard any previously made item. */
8063 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8065 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8067 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8069 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8070 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8071 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8073 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8078 else if (parse_tool_bar_item (key
, def
))
8079 /* Append a new tool bar item to tool_bar_items_vector. Accept
8080 more than one definition for the same key. */
8081 append_tool_bar_item ();
8084 /* Access slot with index IDX of vector tool_bar_item_properties. */
8085 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8087 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8089 ASET (tool_bar_item_properties
, idx
, val
);
8093 /* Parse a tool bar item specification ITEM for key KEY and return the
8094 result in tool_bar_item_properties. Value is false if ITEM is
8097 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8099 CAPTION is the caption of the item, If it's not a string, it is
8100 evaluated to get a string.
8102 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8103 as binding are currently ignored.
8105 The following properties are recognized:
8109 FORM is evaluated and specifies whether the tool bar item is
8110 enabled or disabled.
8114 FORM is evaluated and specifies whether the tool bar item is visible.
8116 - `:filter FUNCTION'
8118 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8119 result is stored as the new binding.
8121 - `:button (TYPE SELECTED)'
8123 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8124 and specifies whether the button is selected (pressed) or not.
8128 IMAGES is either a single image specification or a vector of four
8129 image specifications. See enum tool_bar_item_images.
8131 - `:help HELP-STRING'.
8133 Gives a help string to display for the tool bar item.
8135 - `:label LABEL-STRING'.
8137 A text label to show with the tool bar button if labels are enabled. */
8140 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8142 Lisp_Object filter
= Qnil
;
8143 Lisp_Object caption
;
8145 bool have_label
= false;
8147 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8148 Rule out items that aren't lists, don't start with
8149 `menu-item' or whose rest following `tool-bar-item' is not a
8154 /* As an exception, allow old-style menu separators. */
8155 if (STRINGP (XCAR (item
)))
8156 item
= list1 (XCAR (item
));
8157 else if (!EQ (XCAR (item
), Qmenu_item
)
8158 || (item
= XCDR (item
), !CONSP (item
)))
8161 /* Create tool_bar_item_properties vector if necessary. Reset it to
8163 if (VECTORP (tool_bar_item_properties
))
8165 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8169 tool_bar_item_properties
8170 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8173 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8174 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8176 /* Get the caption of the item. If the caption is not a string,
8177 evaluate it to get a string. If we don't get a string, skip this
8179 caption
= XCAR (item
);
8180 if (!STRINGP (caption
))
8182 caption
= menu_item_eval_property (caption
);
8183 if (!STRINGP (caption
))
8186 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8188 /* If the rest following the caption is not a list, the menu item is
8189 either a separator, or invalid. */
8193 if (menu_separator_name_p (SSDATA (caption
)))
8195 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8196 #if !defined (USE_GTK) && !defined (HAVE_NS)
8197 /* If we use build_desired_tool_bar_string to render the
8198 tool bar, the separator is rendered as an image. */
8199 set_prop (TOOL_BAR_ITEM_IMAGES
,
8200 (menu_item_eval_property
8201 (Vtool_bar_separator_image_expression
)));
8202 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8203 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8204 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8211 /* Store the binding. */
8212 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8215 /* Ignore cached key binding, if any. */
8216 if (CONSP (item
) && CONSP (XCAR (item
)))
8219 /* Process the rest of the properties. */
8220 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8222 Lisp_Object ikey
, value
;
8225 value
= XCAR (XCDR (item
));
8227 if (EQ (ikey
, QCenable
))
8229 /* `:enable FORM'. */
8230 if (!NILP (Venable_disabled_menus_and_buttons
))
8231 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8233 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8235 else if (EQ (ikey
, QCvisible
))
8237 /* `:visible FORM'. If got a visible property and that
8238 evaluates to nil then ignore this item. */
8239 if (NILP (menu_item_eval_property (value
)))
8242 else if (EQ (ikey
, QChelp
))
8243 /* `:help HELP-STRING'. */
8244 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8245 else if (EQ (ikey
, QCvert_only
))
8246 /* `:vert-only t/nil'. */
8247 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8248 else if (EQ (ikey
, QClabel
))
8250 const char *bad_label
= "!!?GARBLED ITEM?!!";
8251 /* `:label LABEL-STRING'. */
8252 set_prop (TOOL_BAR_ITEM_LABEL
,
8253 STRINGP (value
) ? value
: build_string (bad_label
));
8256 else if (EQ (ikey
, QCfilter
))
8257 /* ':filter FORM'. */
8259 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8261 /* `:button (TYPE . SELECTED)'. */
8262 Lisp_Object type
, selected
;
8264 type
= XCAR (value
);
8265 selected
= XCDR (value
);
8266 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8268 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8269 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8272 else if (EQ (ikey
, QCimage
)
8274 || (VECTORP (value
) && ASIZE (value
) == 4)))
8275 /* Value is either a single image specification or a vector
8276 of 4 such specifications for the different button states. */
8277 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8278 else if (EQ (ikey
, QCrtl
))
8280 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8286 /* Try to make one from caption and key. */
8287 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8288 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8289 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8290 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8292 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8293 char *buf
= xmalloc (max_lbl
+ 1);
8294 Lisp_Object new_lbl
;
8295 ptrdiff_t caption_len
= strlen (capt
);
8297 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8300 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8302 buf
[caption_len
] = '\0';
8306 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8310 strcpy (buf
, label
);
8312 for (j
= 0; buf
[j
] != '\0'; ++j
)
8320 new_lbl
= Fupcase_initials (build_string (label
));
8321 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8322 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8324 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8328 /* If got a filter apply it on binding. */
8330 set_prop (TOOL_BAR_ITEM_BINDING
,
8331 (menu_item_eval_property
8334 PROP (TOOL_BAR_ITEM_BINDING
))))));
8336 /* See if the binding is a keymap. Give up if it is. */
8337 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8340 /* Enable or disable selection of item. */
8341 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8342 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8343 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8345 /* Handle radio buttons or toggle boxes. */
8346 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8347 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8348 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8356 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8357 that can be reused. */
8360 init_tool_bar_items (Lisp_Object reuse
)
8362 if (VECTORP (reuse
))
8363 tool_bar_items_vector
= reuse
;
8365 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8366 ntool_bar_items
= 0;
8370 /* Append parsed tool bar item properties from
8371 tool_bar_item_properties */
8374 append_tool_bar_item (void)
8378 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8380 /* Enlarge tool_bar_items_vector if necessary. */
8382 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8384 /* Append entries from tool_bar_item_properties to the end of
8385 tool_bar_items_vector. */
8386 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8387 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8388 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8395 /* Read a character using menus based on the keymap MAP.
8396 Return nil if there are no menus in the maps.
8397 Return t if we displayed a menu but the user rejected it.
8399 PREV_EVENT is the previous input event, or nil if we are reading
8400 the first event of a key sequence.
8402 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8403 if we used a mouse menu to read the input, or false otherwise. If
8404 USED_MOUSE_MENU is null, don't dereference it.
8406 The prompting is done based on the prompt-string of the map
8407 and the strings associated with various map elements.
8409 This can be done with X menus or with menus put in the minibuf.
8410 These are done in different ways, depending on how the input will be read.
8411 Menus using X are done after auto-saving in read-char, getting the input
8412 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8413 and do auto-saving in the inner call of read_char. */
8416 read_char_x_menu_prompt (Lisp_Object map
,
8417 Lisp_Object prev_event
, bool *used_mouse_menu
)
8419 if (used_mouse_menu
)
8420 *used_mouse_menu
= false;
8422 /* Use local over global Menu maps. */
8424 if (! menu_prompting
)
8427 /* If we got to this point via a mouse click,
8428 use a real menu for mouse selection. */
8429 if (EVENT_HAS_PARAMETERS (prev_event
)
8430 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8431 && !EQ (XCAR (prev_event
), Qtool_bar
))
8433 /* Display the menu and get the selection. */
8436 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8441 record_menu_key (XCAR (value
));
8443 /* If we got multiple events, unread all but
8445 There is no way to prevent those unread events
8446 from showing up later in last_nonmenu_event.
8447 So turn symbol and integer events into lists,
8448 to indicate that they came from a mouse menu,
8449 so that when present in last_nonmenu_event
8450 they won't confuse things. */
8451 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8453 record_menu_key (XCAR (tem
));
8454 if (SYMBOLP (XCAR (tem
))
8455 || INTEGERP (XCAR (tem
)))
8456 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8459 /* If we got more than one event, put all but the first
8460 onto this list to be read later.
8461 Return just the first event now. */
8462 Vunread_command_events
8463 = nconc2 (XCDR (value
), Vunread_command_events
);
8464 value
= XCAR (value
);
8466 else if (NILP (value
))
8468 if (used_mouse_menu
)
8469 *used_mouse_menu
= true;
8476 read_char_minibuf_menu_prompt (int commandflag
,
8481 /* FIXME: Use the minibuffer's frame width. */
8482 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8484 bool nobindings
= true;
8485 Lisp_Object rest
, vector
;
8486 Lisp_Object prompt_strings
= Qnil
;
8490 if (! menu_prompting
)
8493 map
= get_keymap (map
, 0, 1);
8494 name
= Fkeymap_prompt (map
);
8496 /* If we don't have any menus, just read a character normally. */
8497 if (!STRINGP (name
))
8500 #define PUSH_C_STR(str, listvar) \
8501 listvar = Fcons (build_unibyte_string (str), listvar)
8503 /* Prompt string always starts with map's prompt, and a space. */
8504 prompt_strings
= Fcons (name
, prompt_strings
);
8505 PUSH_C_STR (": ", prompt_strings
);
8506 nlength
= SCHARS (name
) + 2;
8510 /* Present the documented bindings, a line at a time. */
8513 bool notfirst
= false;
8514 Lisp_Object menu_strings
= prompt_strings
;
8515 ptrdiff_t i
= nlength
;
8517 Lisp_Object orig_defn_macro
;
8519 /* Loop over elements of map. */
8524 /* FIXME: Use map_keymap to handle new keymap formats. */
8526 /* At end of map, wrap around if just starting,
8527 or end this line if already have something on it. */
8530 if (notfirst
|| nobindings
)
8536 /* Look at the next element of the map. */
8538 elt
= AREF (vector
, idx
);
8540 elt
= Fcar_safe (rest
);
8542 if (idx
< 0 && VECTORP (elt
))
8544 /* If we found a dense table in the keymap,
8545 advanced past it, but start scanning its contents. */
8546 rest
= Fcdr_safe (rest
);
8552 /* An ordinary element. */
8553 Lisp_Object event
, tem
;
8557 event
= Fcar_safe (elt
); /* alist */
8558 elt
= Fcdr_safe (elt
);
8562 XSETINT (event
, idx
); /* vector */
8565 /* Ignore the element if it has no prompt string. */
8566 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8568 /* True if the char to type matches the string. */
8570 Lisp_Object upcased_event
, downcased_event
;
8571 Lisp_Object desc
= Qnil
;
8573 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8575 upcased_event
= Fupcase (event
);
8576 downcased_event
= Fdowncase (event
);
8577 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8578 || XINT (downcased_event
) == SREF (s
, 0));
8580 desc
= Fsingle_key_description (event
, Qnil
);
8582 #if 0 /* It is redundant to list the equivalent key bindings because
8583 the prefix is what the user has already typed. */
8585 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8587 /* Insert equivalent keybinding. */
8588 s
= concat2 (s
, tem
);
8591 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8592 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8594 /* Insert button prefix. */
8595 Lisp_Object selected
8596 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8597 AUTO_STRING (radio_yes
, "(*) ");
8598 AUTO_STRING (radio_no
, "( ) ");
8599 AUTO_STRING (check_yes
, "[X] ");
8600 AUTO_STRING (check_no
, "[ ] ");
8601 if (EQ (tem
, QCradio
))
8602 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8604 tem
= NILP (selected
) ? check_yes
: check_no
;
8605 s
= concat2 (tem
, s
);
8609 /* If we have room for the prompt string, add it to this line.
8610 If this is the first on the line, always add it. */
8611 if ((SCHARS (s
) + i
+ 2
8612 + (char_matches
? 0 : SCHARS (desc
) + 3))
8616 ptrdiff_t thiswidth
;
8618 /* Punctuate between strings. */
8621 PUSH_C_STR (", ", menu_strings
);
8627 /* If the char to type doesn't match the string's
8628 first char, explicitly show what char to type. */
8631 /* Add as much of string as fits. */
8632 thiswidth
= min (SCHARS (desc
), width
- i
);
8634 = Fcons (Fsubstring (desc
, make_number (0),
8635 make_number (thiswidth
)),
8638 PUSH_C_STR (" = ", menu_strings
);
8642 /* Add as much of string as fits. */
8643 thiswidth
= min (SCHARS (s
), width
- i
);
8645 = Fcons (Fsubstring (s
, make_number (0),
8646 make_number (thiswidth
)),
8652 /* If this element does not fit, end the line now,
8653 and save the element for the next line. */
8654 PUSH_C_STR ("...", menu_strings
);
8659 /* Move past this element. */
8660 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8661 /* Handle reaching end of dense table. */
8666 rest
= Fcdr_safe (rest
);
8670 /* Prompt with that and read response. */
8671 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8673 /* Make believe it's not a keyboard macro in case the help char
8674 is pressed. Help characters are not recorded because menu prompting
8675 is not used on replay. */
8676 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8677 kset_defining_kbd_macro (current_kboard
, Qnil
);
8679 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8680 while (BUFFERP (obj
));
8681 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8683 if (!INTEGERP (obj
) || XINT (obj
) == -2
8684 || (! EQ (obj
, menu_prompt_more_char
)
8685 && (!INTEGERP (menu_prompt_more_char
)
8686 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8688 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8689 store_kbd_macro_char (obj
);
8692 /* Help char - go round again. */
8696 /* Reading key sequences. */
8699 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8701 return access_keymap (get_keymap (keymap
, 0, 1),
8706 active_maps (Lisp_Object first_event
)
8708 Lisp_Object position
8709 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8710 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8713 /* Structure used to keep track of partial application of key remapping
8714 such as Vfunction_key_map and Vkey_translation_map. */
8715 typedef struct keyremap
8717 /* This is the map originally specified for this use. */
8719 /* This is a submap reached by looking up, in PARENT,
8720 the events from START to END. */
8722 /* Positions [START, END) in the key sequence buffer
8723 are the key that we have scanned so far.
8724 Those events are the ones that we will replace
8725 if PARENT maps them into a key sequence. */
8729 /* Lookup KEY in MAP.
8730 MAP is a keymap mapping keys to key vectors or functions.
8731 If the mapping is a function and DO_FUNCALL is true,
8732 the function is called with PROMPT as parameter and its return
8733 value is used as the return value of this function (after checking
8734 that it is indeed a vector). */
8737 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8742 next
= access_keymap (map
, key
, 1, 0, 1);
8744 /* Handle a symbol whose function definition is a keymap
8746 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8747 && (ARRAYP (XSYMBOL (next
)->function
)
8748 || KEYMAPP (XSYMBOL (next
)->function
)))
8749 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8751 /* If the keymap gives a function, not an
8752 array, then call the function with one arg and use
8753 its value instead. */
8754 if (do_funcall
&& FUNCTIONP (next
))
8759 next
= call1 (next
, prompt
);
8760 /* If the function returned something invalid,
8761 barf--don't ignore it. */
8762 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8763 error ("Function %s returns invalid key sequence",
8764 SSDATA (SYMBOL_NAME (tem
)));
8769 /* Do one step of the key remapping used for function-key-map and
8770 key-translation-map:
8771 KEYBUF is the buffer holding the input events.
8772 BUFSIZE is its maximum size.
8773 FKEY is a pointer to the keyremap structure to use.
8774 INPUT is the index of the last element in KEYBUF.
8775 DOIT if true says that the remapping can actually take place.
8776 DIFF is used to return the number of keys added/removed by the remapping.
8777 PARENT is the root of the keymap.
8778 PROMPT is the prompt to use if the remapping happens through a function.
8779 Return true if the remapping actually took place. */
8782 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8783 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8785 Lisp_Object next
, key
;
8787 key
= keybuf
[fkey
->end
++];
8789 if (KEYMAPP (fkey
->parent
))
8790 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8794 /* If keybuf[fkey->start..fkey->end] is bound in the
8795 map and we're in a position to do the key remapping, replace it with
8796 the binding and restart with fkey->start at the end. */
8797 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8799 int len
= XFASTINT (Flength (next
));
8802 *diff
= len
- (fkey
->end
- fkey
->start
);
8804 if (bufsize
- input
<= *diff
)
8805 error ("Key sequence too long");
8807 /* Shift the keys that follow fkey->end. */
8809 for (i
= fkey
->end
; i
< input
; i
++)
8810 keybuf
[i
+ *diff
] = keybuf
[i
];
8812 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8813 keybuf
[i
+ *diff
] = keybuf
[i
];
8814 /* Overwrite the old keys with the new ones. */
8815 for (i
= 0; i
< len
; i
++)
8816 keybuf
[fkey
->start
+ i
]
8817 = Faref (next
, make_number (i
));
8819 fkey
->start
= fkey
->end
+= *diff
;
8820 fkey
->map
= fkey
->parent
;
8825 fkey
->map
= get_keymap (next
, 0, 1);
8827 /* If we no longer have a bound suffix, try a new position for
8829 if (!CONSP (fkey
->map
))
8831 fkey
->end
= ++fkey
->start
;
8832 fkey
->map
= fkey
->parent
;
8838 test_undefined (Lisp_Object binding
)
8840 return (NILP (binding
)
8841 || EQ (binding
, Qundefined
)
8842 || (SYMBOLP (binding
)
8843 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8846 /* Read a sequence of keys that ends with a non prefix character,
8847 storing it in KEYBUF, a buffer of size BUFSIZE.
8849 Return the length of the key sequence stored.
8850 Return -1 if the user rejected a command menu.
8852 Echo starting immediately unless `prompt' is 0.
8854 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8855 read_char with a suitable COMMANDFLAG argument.
8857 Where a key sequence ends depends on the currently active keymaps.
8858 These include any minor mode keymaps active in the current buffer,
8859 the current buffer's local map, and the global map.
8861 If a key sequence has no other bindings, we check Vfunction_key_map
8862 to see if some trailing subsequence might be the beginning of a
8863 function key's sequence. If so, we try to read the whole function
8864 key, and substitute its symbolic name into the key sequence.
8866 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8867 `double-' events into similar click events, if that would make them
8868 bound. We try to turn `triple-' events first into `double-' events,
8871 If we get a mouse click in a mode line, vertical divider, or other
8872 non-text area, we treat the click as if it were prefixed by the
8873 symbol denoting that area - `mode-line', `vertical-line', or
8876 If the sequence starts with a mouse click, we read the key sequence
8877 with respect to the buffer clicked on, not the current buffer.
8879 If the user switches frames in the midst of a key sequence, we put
8880 off the switch-frame event until later; the next call to
8881 read_char will return it.
8883 If FIX_CURRENT_BUFFER, we restore current_buffer
8884 from the selected window's buffer. */
8887 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8888 bool dont_downcase_last
, bool can_return_switch_frame
,
8889 bool fix_current_buffer
, bool prevent_redisplay
)
8891 ptrdiff_t count
= SPECPDL_INDEX ();
8893 /* How many keys there are in the current key sequence. */
8896 /* The length of the echo buffer when we started reading, and
8897 the length of this_command_keys when we started reading. */
8898 ptrdiff_t echo_start UNINIT
;
8899 ptrdiff_t keys_start
;
8901 Lisp_Object current_binding
= Qnil
;
8902 Lisp_Object first_event
= Qnil
;
8904 /* Index of the first key that has no binding.
8905 It is useless to try fkey.start larger than that. */
8908 /* If t < mock_input, then KEYBUF[t] should be read as the next
8911 We use this to recover after recognizing a function key. Once we
8912 realize that a suffix of the current key sequence is actually a
8913 function key's escape sequence, we replace the suffix with the
8914 function key's binding from Vfunction_key_map. Now keybuf
8915 contains a new and different key sequence, so the echo area,
8916 this_command_keys, and the submaps and defs arrays are wrong. In
8917 this situation, we set mock_input to t, set t to 0, and jump to
8918 restart_sequence; the loop will read keys from keybuf up until
8919 mock_input, thus rebuilding the state; and then it will resume
8920 reading characters from the keyboard. */
8923 /* If the sequence is unbound in submaps[], then
8924 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8925 and fkey.map is its binding.
8927 These might be > t, indicating that all function key scanning
8928 should hold off until t reaches them. We do this when we've just
8929 recognized a function key, to avoid searching for the function
8930 key's again in Vfunction_key_map. */
8933 /* Likewise, for key_translation_map and input-decode-map. */
8934 keyremap keytran
, indec
;
8936 /* True if we are trying to map a key by changing an upper-case
8937 letter to lower case, or a shifted function key to an unshifted
8939 bool shift_translated
= false;
8941 /* If we receive a `switch-frame' or `select-window' event in the middle of
8942 a key sequence, we put it off for later.
8943 While we're reading, we keep the event here. */
8944 Lisp_Object delayed_switch_frame
;
8946 Lisp_Object original_uppercase UNINIT
;
8947 int original_uppercase_position
= -1;
8949 /* Gets around Microsoft compiler limitations. */
8950 bool dummyflag
= false;
8952 struct buffer
*starting_buffer
;
8954 /* List of events for which a fake prefix key has been generated. */
8955 Lisp_Object fake_prefixed_keys
= Qnil
;
8957 raw_keybuf_count
= 0;
8959 last_nonmenu_event
= Qnil
;
8961 delayed_switch_frame
= Qnil
;
8967 /* Install the string PROMPT as the beginning of the string
8968 of echoing, so that it serves as a prompt for the next
8970 kset_echo_prompt (current_kboard
, prompt
);
8971 /* FIXME: This use of echo_now doesn't look quite right and is ugly
8972 since it forces us to fiddle with current_kboard->immediate_echo
8973 before and after. */
8974 current_kboard
->immediate_echo
= false;
8976 if (!echo_keystrokes_p ())
8977 current_kboard
->immediate_echo
= false;
8979 else if (cursor_in_echo_area
/* FIXME: Not sure why we test this here,
8980 maybe we should just drop this test. */
8981 && echo_keystrokes_p ())
8982 /* This doesn't put in a dash if the echo buffer is empty, so
8983 you don't always see a dash hanging out in the minibuffer. */
8987 /* Record the initial state of the echo area and this_command_keys;
8988 we will need to restore them if we replay a key sequence. */
8990 echo_start
= echo_length ();
8991 keys_start
= this_command_key_count
;
8992 this_single_command_key_start
= keys_start
;
8994 /* We jump here when we need to reinitialize fkey and keytran; this
8995 happens if we switch keyboards between rescans. */
8996 replay_entire_sequence
:
8998 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8999 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9000 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9001 indec
.start
= indec
.end
= 0;
9002 fkey
.start
= fkey
.end
= 0;
9003 keytran
.start
= keytran
.end
= 0;
9005 /* We jump here when the key sequence has been thoroughly changed, and
9006 we need to rescan it starting from the beginning. When we jump here,
9007 keybuf[0..mock_input] holds the sequence we should reread. */
9010 starting_buffer
= current_buffer
;
9011 first_unbound
= bufsize
+ 1;
9013 /* Build our list of keymaps.
9014 If we recognize a function key and replace its escape sequence in
9015 keybuf with its symbol, or if the sequence starts with a mouse
9016 click and we need to switch buffers, we jump back here to rebuild
9017 the initial keymaps from the current buffer. */
9018 current_binding
= active_maps (first_event
);
9020 /* Start from the beginning in keybuf. */
9023 /* These are no-ops the first time through, but if we restart, they
9024 revert the echo area and this_command_keys to their original state. */
9025 this_command_key_count
= keys_start
;
9026 if (INTERACTIVE
&& t
< mock_input
)
9027 echo_truncate (echo_start
);
9029 /* If the best binding for the current key sequence is a keymap, or
9030 we may be looking at a function key's escape sequence, keep on
9032 while (!NILP (current_binding
)
9033 /* Keep reading as long as there's a prefix binding. */
9034 ? KEYMAPP (current_binding
)
9035 /* Don't return in the middle of a possible function key sequence,
9036 if the only bindings we found were via case conversion.
9037 Thus, if ESC O a has a function-key-map translation
9038 and ESC o has a binding, don't return after ESC O,
9039 so that we can translate ESC O plus the next character. */
9040 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9043 bool used_mouse_menu
= false;
9045 /* Where the last real key started. If we need to throw away a
9046 key that has expanded into more than one element of keybuf
9047 (say, a mouse click on the mode line which is being treated
9048 as [mode-line (mouse-...)], then we backtrack to this point
9050 int last_real_key_start
;
9052 /* These variables are analogous to echo_start and keys_start;
9053 while those allow us to restart the entire key sequence,
9054 echo_local_start and keys_local_start allow us to throw away
9056 ptrdiff_t echo_local_start UNINIT
;
9057 int keys_local_start
;
9058 Lisp_Object new_binding
;
9060 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9061 eassert (indec
.start
<= indec
.end
);
9062 eassert (fkey
.start
<= fkey
.end
);
9063 eassert (keytran
.start
<= keytran
.end
);
9064 /* key-translation-map is applied *after* function-key-map
9065 which is itself applied *after* input-decode-map. */
9066 eassert (fkey
.end
<= indec
.start
);
9067 eassert (keytran
.end
<= fkey
.start
);
9069 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9070 first_unbound
< keytran
.start
)
9071 { /* The prefix upto first_unbound has no binding and has
9072 no translation left to do either, so we know it's unbound.
9073 If we don't stop now, we risk staying here indefinitely
9074 (if the user keeps entering fkey or keytran prefixes
9075 like C-c ESC ESC ESC ESC ...) */
9077 for (i
= first_unbound
+ 1; i
< t
; i
++)
9078 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9079 mock_input
= t
- first_unbound
- 1;
9080 indec
.end
= indec
.start
-= first_unbound
+ 1;
9081 indec
.map
= indec
.parent
;
9082 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9083 fkey
.map
= fkey
.parent
;
9084 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9085 keytran
.map
= keytran
.parent
;
9086 goto replay_sequence
;
9090 error ("Key sequence too long");
9093 echo_local_start
= echo_length ();
9094 keys_local_start
= this_command_key_count
;
9097 /* These are no-ops, unless we throw away a keystroke below and
9098 jumped back up to replay_key; in that case, these restore the
9099 variables to their original state, allowing us to replay the
9101 if (INTERACTIVE
&& t
< mock_input
)
9102 echo_truncate (echo_local_start
);
9103 this_command_key_count
= keys_local_start
;
9105 /* By default, assume each event is "real". */
9106 last_real_key_start
= t
;
9108 /* Does mock_input indicate that we are re-reading a key sequence? */
9112 add_command_key (key
);
9113 if (current_kboard
->immediate_echo
)
9115 /* Set immediate_echo to false so as to force echo_now to
9116 redisplay (it will set immediate_echo right back to true). */
9117 current_kboard
->immediate_echo
= false;
9122 /* If not, we should actually read a character. */
9126 KBOARD
*interrupted_kboard
= current_kboard
;
9127 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9128 /* Calling read_char with COMMANDFLAG = -2 avoids
9129 redisplay in read_char and its subroutines. */
9130 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9131 current_binding
, last_nonmenu_event
,
9132 &used_mouse_menu
, NULL
);
9133 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9134 /* When switching to a new tty (with a new keyboard),
9135 read_char returns the new buffer, rather than -2
9136 (Bug#5095). This is because `terminal-init-xterm'
9137 calls read-char, which eats the wrong_kboard_jmpbuf
9138 return. Any better way to fix this? -- cyd */
9139 || (interrupted_kboard
!= current_kboard
))
9144 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9145 if (k
== interrupted_kboard
)
9150 /* Don't touch interrupted_kboard when it's been
9152 delayed_switch_frame
= Qnil
;
9153 goto replay_entire_sequence
;
9156 if (!NILP (delayed_switch_frame
))
9159 (interrupted_kboard
,
9160 Fcons (delayed_switch_frame
,
9161 KVAR (interrupted_kboard
, kbd_queue
)));
9162 delayed_switch_frame
= Qnil
;
9167 (interrupted_kboard
,
9168 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9170 /* If the side queue is non-empty, ensure it begins with a
9171 switch-frame, so we'll replay it in the right context. */
9172 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9173 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9174 !(EVENT_HAS_PARAMETERS (key
)
9175 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9179 XSETFRAME (frame
, interrupted_frame
);
9181 (interrupted_kboard
,
9182 Fcons (make_lispy_switch_frame (frame
),
9183 KVAR (interrupted_kboard
, kbd_queue
)));
9186 goto replay_entire_sequence
;
9190 /* read_char returns t when it shows a menu and the user rejects it.
9194 unbind_to (count
, Qnil
);
9198 /* read_char returns -1 at the end of a macro.
9199 Emacs 18 handles this by returning immediately with a
9200 zero, so that's what we'll do. */
9201 if (INTEGERP (key
) && XINT (key
) == -1)
9204 /* The Microsoft C compiler can't handle the goto that
9210 /* If the current buffer has been changed from under us, the
9211 keymap may have changed, so replay the sequence. */
9214 timer_resume_idle ();
9217 /* Reset the current buffer from the selected window
9218 in case something changed the former and not the latter.
9219 This is to be more consistent with the behavior
9220 of the command_loop_1. */
9221 if (fix_current_buffer
)
9223 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9225 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9227 Fset_buffer (XWINDOW (selected_window
)->contents
);
9230 goto replay_sequence
;
9233 /* If we have a quit that was typed in another frame, and
9234 quit_throw_to_read_char switched buffers,
9235 replay to get the right keymap. */
9237 && XINT (key
) == quit_char
9238 && current_buffer
!= starting_buffer
)
9241 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9246 goto replay_sequence
;
9251 if (EVENT_HAS_PARAMETERS (key
)
9252 /* Either a `switch-frame' or a `select-window' event. */
9253 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9255 /* If we're at the beginning of a key sequence, and the caller
9256 says it's okay, go ahead and return this event. If we're
9257 in the midst of a key sequence, delay it until the end. */
9258 if (t
> 0 || !can_return_switch_frame
)
9260 delayed_switch_frame
= key
;
9265 if (NILP (first_event
))
9268 /* Even if first_event does not specify a particular
9269 window/position, it's important to recompute the maps here
9270 since a long time might have passed since we entered
9271 read_key_sequence, and a timer (or process-filter or
9272 special-event-map, ...) might have switched the current buffer
9273 or the selected window from under us in the mean time. */
9274 if (fix_current_buffer
9275 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9277 Fset_buffer (XWINDOW (selected_window
)->contents
);
9278 current_binding
= active_maps (first_event
);
9282 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9286 /* Clicks in non-text areas get prefixed by the symbol
9287 in their CHAR-ADDRESS field. For example, a click on
9288 the mode line is prefixed by the symbol `mode-line'.
9290 Furthermore, key sequences beginning with mouse clicks
9291 are read using the keymaps of the buffer clicked on, not
9292 the current buffer. So we may have to switch the buffer
9295 When we turn one event into two events, we must make sure
9296 that neither of the two looks like the original--so that,
9297 if we replay the events, they won't be expanded again.
9298 If not for this, such reexpansion could happen either here
9299 or when user programs play with this-command-keys. */
9300 if (EVENT_HAS_PARAMETERS (key
))
9302 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9303 if (EQ (kind
, Qmouse_click
))
9305 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9306 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9309 || (!NILP (fake_prefixed_keys
)
9310 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9312 /* We're looking a second time at an event for which
9313 we generated a fake prefix key. Set
9314 last_real_key_start appropriately. */
9316 last_real_key_start
= t
- 1;
9319 if (last_real_key_start
== 0)
9321 /* Key sequences beginning with mouse clicks are
9322 read using the keymaps in the buffer clicked on,
9323 not the current buffer. If we're at the
9324 beginning of a key sequence, switch buffers. */
9325 if (WINDOWP (window
)
9326 && BUFFERP (XWINDOW (window
)->contents
)
9327 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9329 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9334 /* Arrange to go back to the original buffer once we're
9335 done reading the key sequence. Note that we can't
9336 use save_excursion_{save,restore} here, because they
9337 save point as well as the current buffer; we don't
9338 want to save point, because redisplay may change it,
9339 to accommodate a Fset_window_start or something. We
9340 don't want to do this at the top of the function,
9341 because we may get input from a subprocess which
9342 wants to change the selected window and stuff (say,
9344 record_unwind_current_buffer ();
9346 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9348 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9349 goto replay_sequence
;
9353 /* Expand mode-line and scroll-bar events into two events:
9354 use posn as a fake prefix key. */
9356 && (NILP (fake_prefixed_keys
)
9357 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9359 if (bufsize
- t
<= 1)
9360 error ("Key sequence too long");
9363 keybuf
[t
+ 1] = key
;
9366 /* Record that a fake prefix key has been generated
9367 for KEY. Don't modify the event; this would
9368 prevent proper action when the event is pushed
9369 back into unread-command-events. */
9370 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9374 else if (CONSP (XCDR (key
))
9375 && CONSP (EVENT_START (key
))
9376 && CONSP (XCDR (EVENT_START (key
))))
9380 posn
= POSN_POSN (EVENT_START (key
));
9381 /* Handle menu-bar events:
9382 insert the dummy prefix event `menu-bar'. */
9383 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9385 if (bufsize
- t
<= 1)
9386 error ("Key sequence too long");
9388 keybuf
[t
+ 1] = key
;
9390 /* Zap the position in key, so we know that we've
9391 expanded it, and don't try to do so again. */
9392 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9395 goto replay_sequence
;
9397 else if (CONSP (posn
))
9399 /* We're looking at the second event of a
9400 sequence which we expanded before. Set
9401 last_real_key_start appropriately. */
9402 if (last_real_key_start
== t
&& t
> 0)
9403 last_real_key_start
= t
- 1;
9408 /* We have finally decided that KEY is something we might want
9410 new_binding
= follow_key (current_binding
, key
);
9412 /* If KEY wasn't bound, we'll try some fallbacks. */
9413 if (!NILP (new_binding
))
9414 /* This is needed for the following scenario:
9415 event 0: a down-event that gets dropped by calling replay_key.
9416 event 1: some normal prefix like C-h.
9417 After event 0, first_unbound is 0, after event 1 indec.start,
9418 fkey.start, and keytran.start are all 1, so when we see that
9419 C-h is bound, we need to update first_unbound. */
9420 first_unbound
= max (t
+ 1, first_unbound
);
9425 /* Remember the position to put an upper bound on indec.start. */
9426 first_unbound
= min (t
, first_unbound
);
9428 head
= EVENT_HEAD (key
);
9432 Lisp_Object breakdown
;
9435 breakdown
= parse_modifiers (head
);
9436 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9437 /* Attempt to reduce an unbound mouse event to a simpler
9438 event that is bound:
9439 Drags reduce to clicks.
9440 Double-clicks reduce to clicks.
9441 Triple-clicks reduce to double-clicks, then to clicks.
9442 Up/Down-clicks are eliminated.
9443 Double-downs reduce to downs, then are eliminated.
9444 Triple-downs reduce to double-downs, then to downs,
9445 then are eliminated. */
9446 if (modifiers
& (up_modifier
| down_modifier
9448 | double_modifier
| triple_modifier
))
9450 while (modifiers
& (up_modifier
| down_modifier
9452 | double_modifier
| triple_modifier
))
9454 Lisp_Object new_head
, new_click
;
9455 if (modifiers
& triple_modifier
)
9456 modifiers
^= (double_modifier
| triple_modifier
);
9457 else if (modifiers
& double_modifier
)
9458 modifiers
&= ~double_modifier
;
9459 else if (modifiers
& drag_modifier
)
9460 modifiers
&= ~drag_modifier
;
9463 /* Dispose of this `up/down' event by simply jumping
9464 back to replay_key, to get another event.
9466 Note that if this event came from mock input,
9467 then just jumping back to replay_key will just
9468 hand it to us again. So we have to wipe out any
9471 We could delete keybuf[t] and shift everything
9472 after that to the left by one spot, but we'd also
9473 have to fix up any variable that points into
9474 keybuf, and shifting isn't really necessary
9477 Adding prefixes for non-textual mouse clicks
9478 creates two characters of mock input, and both
9479 must be thrown away. If we're only looking at
9480 the prefix now, we can just jump back to
9481 replay_key. On the other hand, if we've already
9482 processed the prefix, and now the actual click
9483 itself is giving us trouble, then we've lost the
9484 state of the keymaps we want to backtrack to, and
9485 we need to replay the whole sequence to rebuild
9488 Beyond that, only function key expansion could
9489 create more than two keys, but that should never
9490 generate mouse events, so it's okay to zero
9491 mock_input in that case too.
9493 FIXME: The above paragraph seems just plain
9494 wrong, if you consider things like
9495 xterm-mouse-mode. -stef
9497 Isn't this just the most wonderful code ever? */
9499 /* If mock_input > t + 1, the above simplification
9500 will actually end up dropping keys on the floor.
9501 This is probably OK for now, but even
9502 if mock_input <= t + 1, we need to adjust indec,
9504 Typical case [header-line down-mouse-N]:
9505 mock_input = 2, t = 1, fkey.end = 1,
9506 last_real_key_start = 0. */
9507 if (indec
.end
> last_real_key_start
)
9509 indec
.end
= indec
.start
9510 = min (last_real_key_start
, indec
.start
);
9511 indec
.map
= indec
.parent
;
9512 if (fkey
.end
> last_real_key_start
)
9514 fkey
.end
= fkey
.start
9515 = min (last_real_key_start
, fkey
.start
);
9516 fkey
.map
= fkey
.parent
;
9517 if (keytran
.end
> last_real_key_start
)
9519 keytran
.end
= keytran
.start
9520 = min (last_real_key_start
, keytran
.start
);
9521 keytran
.map
= keytran
.parent
;
9525 if (t
== last_real_key_start
)
9532 mock_input
= last_real_key_start
;
9533 goto replay_sequence
;
9538 = apply_modifiers (modifiers
, XCAR (breakdown
));
9539 new_click
= list2 (new_head
, EVENT_START (key
));
9541 /* Look for a binding for this new key. */
9542 new_binding
= follow_key (current_binding
, new_click
);
9544 /* If that click is bound, go for it. */
9545 if (!NILP (new_binding
))
9547 current_binding
= new_binding
;
9551 /* Otherwise, we'll leave key set to the drag event. */
9556 current_binding
= new_binding
;
9559 /* Normally, last_nonmenu_event gets the previous key we read.
9560 But when a mouse popup menu is being used,
9561 we don't update last_nonmenu_event; it continues to hold the mouse
9562 event that preceded the first level of menu. */
9563 if (!used_mouse_menu
)
9564 last_nonmenu_event
= key
;
9566 /* Record what part of this_command_keys is the current key sequence. */
9567 this_single_command_key_start
= this_command_key_count
- t
;
9568 /* When 'input-method-function' called above causes events to be
9569 put on 'unread-post-input-method-events', and as result
9570 'reread' is set to 'true', the value of 't' can become larger
9571 than 'this_command_key_count', because 'add_command_key' is
9572 not called to update 'this_command_key_count'. If this
9573 happens, 'this_single_command_key_start' will become negative
9574 above, and any call to 'this-single-command-keys' will return
9575 a garbled vector. See bug #20223 for one such situation.
9576 Here we force 'this_single_command_key_start' to never become
9577 negative, to avoid that. */
9578 if (this_single_command_key_start
< 0)
9579 this_single_command_key_start
= 0;
9581 /* Look for this sequence in input-decode-map.
9582 Scan from indec.end until we find a bound suffix. */
9583 while (indec
.end
< t
)
9588 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9592 mock_input
= diff
+ max (t
, mock_input
);
9593 goto replay_sequence
;
9597 if (!KEYMAPP (current_binding
)
9598 && !test_undefined (current_binding
)
9599 && indec
.start
>= t
)
9600 /* There is a binding and it's not a prefix.
9601 (and it doesn't have any input-decode-map translation pending).
9602 There is thus no function-key in this sequence.
9603 Moving fkey.start is important in this case to allow keytran.start
9604 to go over the sequence before we return (since we keep the
9605 invariant that keytran.end <= fkey.start). */
9608 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9611 /* If the sequence is unbound, see if we can hang a function key
9612 off the end of it. */
9613 /* Continue scan from fkey.end until we find a bound suffix. */
9614 while (fkey
.end
< indec
.start
)
9619 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9620 max (t
, mock_input
),
9621 /* If there's a binding (i.e.
9622 first_binding >= nmaps) we don't want
9623 to apply this function-key-mapping. */
9625 && (test_undefined (current_binding
)),
9629 mock_input
= diff
+ max (t
, mock_input
);
9630 /* Adjust the input-decode-map counters. */
9632 indec
.start
+= diff
;
9634 goto replay_sequence
;
9638 /* Look for this sequence in key-translation-map.
9639 Scan from keytran.end until we find a bound suffix. */
9640 while (keytran
.end
< fkey
.start
)
9645 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9649 mock_input
= diff
+ max (t
, mock_input
);
9650 /* Adjust the function-key-map and input-decode-map counters. */
9652 indec
.start
+= diff
;
9656 goto replay_sequence
;
9660 /* If KEY is not defined in any of the keymaps,
9661 and cannot be part of a function key or translation,
9662 and is an upper case letter
9663 use the corresponding lower-case letter instead. */
9664 if (NILP (current_binding
)
9665 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9667 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9668 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9669 || (XINT (key
) & shift_modifier
)))
9671 Lisp_Object new_key
;
9673 original_uppercase
= key
;
9674 original_uppercase_position
= t
- 1;
9676 if (XINT (key
) & shift_modifier
)
9677 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9679 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9680 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9682 /* We have to do this unconditionally, regardless of whether
9683 the lower-case char is defined in the keymaps, because they
9684 might get translated through function-key-map. */
9685 keybuf
[t
- 1] = new_key
;
9686 mock_input
= max (t
, mock_input
);
9687 shift_translated
= true;
9689 goto replay_sequence
;
9692 if (NILP (current_binding
)
9693 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9695 read_key_sequence_cmd
= Vprefix_help_command
;
9696 /* The Microsoft C compiler can't handle the goto that
9702 /* If KEY is not defined in any of the keymaps,
9703 and cannot be part of a function key or translation,
9704 and is a shifted function key,
9705 use the corresponding unshifted function key instead. */
9706 if (NILP (current_binding
)
9707 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9709 Lisp_Object breakdown
= parse_modifiers (key
);
9711 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9713 if (modifiers
& shift_modifier
9714 /* Treat uppercase keys as shifted. */
9716 && (KEY_TO_CHAR (key
)
9717 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9718 && uppercasep (KEY_TO_CHAR (key
))))
9721 = (modifiers
& shift_modifier
9722 ? apply_modifiers (modifiers
& ~shift_modifier
,
9724 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9726 original_uppercase
= key
;
9727 original_uppercase_position
= t
- 1;
9729 /* We have to do this unconditionally, regardless of whether
9730 the lower-case char is defined in the keymaps, because they
9731 might get translated through function-key-map. */
9732 keybuf
[t
- 1] = new_key
;
9733 mock_input
= max (t
, mock_input
);
9734 /* Reset fkey (and consequently keytran) to apply
9735 function-key-map on the result, so that S-backspace is
9736 correctly mapped to DEL (via backspace). OTOH,
9737 input-decode-map doesn't need to go through it again. */
9738 fkey
.start
= fkey
.end
= 0;
9739 keytran
.start
= keytran
.end
= 0;
9740 shift_translated
= true;
9742 goto replay_sequence
;
9747 read_key_sequence_cmd
= current_binding
;
9748 read_key_sequence_remapped
9749 /* Remap command through active keymaps.
9750 Do the remapping here, before the unbind_to so it uses the keymaps
9751 of the appropriate buffer. */
9752 = SYMBOLP (read_key_sequence_cmd
)
9753 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9756 unread_switch_frame
= delayed_switch_frame
;
9757 unbind_to (count
, Qnil
);
9759 /* Don't downcase the last character if the caller says don't.
9760 Don't downcase it if the result is undefined, either. */
9761 if ((dont_downcase_last
|| NILP (current_binding
))
9763 && t
- 1 == original_uppercase_position
)
9765 keybuf
[t
- 1] = original_uppercase
;
9766 shift_translated
= false;
9769 if (shift_translated
)
9770 Vthis_command_keys_shift_translated
= Qt
;
9772 /* Occasionally we fabricate events, perhaps by expanding something
9773 according to function-key-map, or by adding a prefix symbol to a
9774 mouse click in the scroll bar or modeline. In this cases, return
9775 the entire generated key sequence, even if we hit an unbound
9776 prefix or a definition before the end. This means that you will
9777 be able to push back the event properly, and also means that
9778 read-key-sequence will always return a logical unit.
9781 for (; t
< mock_input
; t
++)
9782 add_command_key (keybuf
[t
]);
9789 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9790 Lisp_Object dont_downcase_last
,
9791 Lisp_Object can_return_switch_frame
,
9792 Lisp_Object cmd_loop
, bool allow_string
)
9794 Lisp_Object keybuf
[30];
9796 ptrdiff_t count
= SPECPDL_INDEX ();
9799 CHECK_STRING (prompt
);
9802 specbind (Qinput_method_exit_on_first_char
,
9803 (NILP (cmd_loop
) ? Qt
: Qnil
));
9804 specbind (Qinput_method_use_echo_area
,
9805 (NILP (cmd_loop
) ? Qt
: Qnil
));
9807 if (NILP (continue_echo
))
9809 this_command_key_count
= 0;
9810 this_single_command_key_start
= 0;
9813 #ifdef HAVE_WINDOW_SYSTEM
9814 if (display_hourglass_p
)
9815 cancel_hourglass ();
9818 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9819 prompt
, ! NILP (dont_downcase_last
),
9820 ! NILP (can_return_switch_frame
), 0, 0);
9822 #if 0 /* The following is fine for code reading a key sequence and
9823 then proceeding with a lengthy computation, but it's not good
9824 for code reading keys in a loop, like an input method. */
9825 #ifdef HAVE_WINDOW_SYSTEM
9826 if (display_hourglass_p
)
9837 return unbind_to (count
,
9838 ((allow_string
? make_event_array
: Fvector
)
9842 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9843 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9844 The sequence is sufficient to specify a non-prefix command in the
9845 current local and global maps.
9847 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9848 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9849 as a continuation of the previous key.
9851 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9852 convert the last event to lower case. (Normally any upper case event
9853 is converted to lower case if the original event is undefined and the lower
9854 case equivalent is defined.) A non-nil value is appropriate for reading
9855 a key sequence to be defined.
9857 A C-g typed while in this function is treated like any other character,
9858 and `quit-flag' is not set.
9860 If the key sequence starts with a mouse click, then the sequence is read
9861 using the keymaps of the buffer of the window clicked in, not the buffer
9862 of the selected window as normal.
9864 `read-key-sequence' drops unbound button-down events, since you normally
9865 only care about the click or drag events which follow them. If a drag
9866 or multi-click event is unbound, but the corresponding click event would
9867 be bound, `read-key-sequence' turns the event into a click event at the
9868 drag's starting position. This means that you don't have to distinguish
9869 between click and drag, double, or triple events unless you want to.
9871 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9872 lines separating windows, and scroll bars with imaginary keys
9873 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9875 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9876 function will process a switch-frame event if the user switches frames
9877 before typing anything. If the user switches frames in the middle of a
9878 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9879 is nil, then the event will be put off until after the current key sequence.
9881 `read-key-sequence' checks `function-key-map' for function key
9882 sequences, where they wouldn't conflict with ordinary bindings. See
9883 `function-key-map' for more details.
9885 The optional fifth argument CMD-LOOP, if non-nil, means
9886 that this key sequence is being read by something that will
9887 read commands one after another. It should be nil if the caller
9888 will read just one key sequence. */)
9889 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9891 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9892 can_return_switch_frame
, cmd_loop
, true);
9895 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9896 Sread_key_sequence_vector
, 1, 5, 0,
9897 doc
: /* Like `read-key-sequence' but always return a vector. */)
9898 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9900 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9901 can_return_switch_frame
, cmd_loop
, false);
9904 /* Return true if input events are pending. */
9907 detect_input_pending (void)
9909 return input_pending
|| get_input_pending (0);
9912 /* Return true if input events other than mouse movements are
9916 detect_input_pending_ignore_squeezables (void)
9918 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9921 /* Return true if input events are pending, and run any pending timers. */
9924 detect_input_pending_run_timers (bool do_display
)
9926 unsigned old_timers_run
= timers_run
;
9929 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9931 if (old_timers_run
!= timers_run
&& do_display
)
9932 redisplay_preserve_echo_area (8);
9934 return input_pending
;
9937 /* This is called in some cases before a possible quit.
9938 It cases the next call to detect_input_pending to recompute input_pending.
9939 So calling this function unnecessarily can't do any harm. */
9942 clear_input_pending (void)
9944 input_pending
= false;
9947 /* Return true if there are pending requeued events.
9948 This isn't used yet. The hope is to make wait_reading_process_output
9949 call it, and return if it runs Lisp code that unreads something.
9950 The problem is, kbd_buffer_get_event needs to be fixed to know what
9951 to do in that case. It isn't trivial. */
9954 requeued_events_pending_p (void)
9956 return (CONSP (Vunread_command_events
));
9959 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9960 doc
: /* Return t if command input is currently available with no wait.
9961 Actually, the value is nil only if we can be sure that no input is available;
9962 if there is a doubt, the value is t.
9964 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9965 (Lisp_Object check_timers
)
9967 if (CONSP (Vunread_command_events
)
9968 || !NILP (Vunread_post_input_method_events
)
9969 || !NILP (Vunread_input_method_events
))
9972 /* Process non-user-visible events (Bug#10195). */
9973 process_special_events ();
9975 return (get_input_pending ((NILP (check_timers
)
9976 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9977 | READABLE_EVENTS_FILTER_EVENTS
)
9981 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
9982 doc
: /* Return vector of last few events, not counting those from keyboard macros.
9983 If INCLUDE-CMDS is non-nil, include the commands that were run,
9984 represented as events of the form (nil . COMMAND). */)
9985 (Lisp_Object include_cmds
)
9987 bool cmds
= !NILP (include_cmds
);
9990 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
9991 return Fvector (total_keys
,
9992 XVECTOR (recent_keys
)->contents
);
9995 Lisp_Object es
= Qnil
;
9996 int i
= (total_keys
< NUM_RECENT_KEYS
9997 ? 0 : recent_keys_index
);
9998 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
10001 Lisp_Object e
= AREF (recent_keys
, i
);
10002 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
10003 es
= Fcons (e
, es
);
10004 if (++i
>= NUM_RECENT_KEYS
)
10006 } while (i
!= recent_keys_index
);
10007 es
= Fnreverse (es
);
10008 return Fvconcat (1, &es
);
10012 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10013 doc
: /* Return the key sequence that invoked this command.
10014 However, if the command has called `read-key-sequence', it returns
10015 the last key sequence that has been read.
10016 The value is a string or a vector.
10018 See also `this-command-keys-vector'. */)
10021 return make_event_array (this_command_key_count
,
10022 XVECTOR (this_command_keys
)->contents
);
10025 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10026 doc
: /* Return the key sequence that invoked this command, as a vector.
10027 However, if the command has called `read-key-sequence', it returns
10028 the last key sequence that has been read.
10030 See also `this-command-keys'. */)
10033 return Fvector (this_command_key_count
,
10034 XVECTOR (this_command_keys
)->contents
);
10037 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10038 Sthis_single_command_keys
, 0, 0, 0,
10039 doc
: /* Return the key sequence that invoked this command.
10040 More generally, it returns the last key sequence read, either by
10041 the command loop or by `read-key-sequence'.
10042 Unlike `this-command-keys', this function's value
10043 does not include prefix arguments.
10044 The value is always a vector. */)
10047 return Fvector (this_command_key_count
10048 - this_single_command_key_start
,
10049 (XVECTOR (this_command_keys
)->contents
10050 + this_single_command_key_start
));
10053 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10054 Sthis_single_command_raw_keys
, 0, 0, 0,
10055 doc
: /* Return the raw events that were read for this command.
10056 More generally, it returns the last key sequence read, either by
10057 the command loop or by `read-key-sequence'.
10058 Unlike `this-single-command-keys', this function's value
10059 shows the events before all translations (except for input methods).
10060 The value is always a vector. */)
10063 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10066 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10067 Sclear_this_command_keys
, 0, 1, 0,
10068 doc
: /* Clear out the vector that `this-command-keys' returns.
10069 Also clear the record of the last 100 events, unless optional arg
10070 KEEP-RECORD is non-nil. */)
10071 (Lisp_Object keep_record
)
10075 this_command_key_count
= 0;
10077 if (NILP (keep_record
))
10079 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10080 ASET (recent_keys
, i
, Qnil
);
10082 recent_keys_index
= 0;
10087 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10088 doc
: /* Return the current depth in recursive edits. */)
10092 INT_ADD_WRAPV (command_loop_level
, minibuf_level
, &sum
);
10093 return make_number (sum
);
10096 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10097 "FOpen dribble file: ",
10098 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10099 If FILE is nil, close any open dribble file.
10100 The file will be closed when Emacs exits.
10102 Be aware that this records ALL characters you type!
10103 This may include sensitive information such as passwords. */)
10116 Lisp_Object encfile
;
10118 file
= Fexpand_file_name (file
, Qnil
);
10119 encfile
= ENCODE_FILE (file
);
10120 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10121 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10122 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10123 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10125 report_file_error ("Opening dribble", file
);
10130 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10131 doc
: /* Discard the contents of the terminal input buffer.
10132 Also end any kbd macro being defined. */)
10135 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10137 /* Discard the last command from the macro. */
10138 Fcancel_kbd_macro_events ();
10142 Vunread_command_events
= Qnil
;
10144 discard_tty_input ();
10146 kbd_fetch_ptr
= kbd_store_ptr
;
10147 input_pending
= false;
10152 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10153 doc
: /* Stop Emacs and return to superior process. You can resume later.
10154 If `cannot-suspend' is non-nil, or if the system doesn't support job
10155 control, run a subshell instead.
10157 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10158 to be read as terminal input by Emacs's parent, after suspension.
10160 Before suspending, run the normal hook `suspend-hook'.
10161 After resumption run the normal hook `suspend-resume-hook'.
10163 Some operating systems cannot stop the Emacs process and resume it later.
10164 On such systems, Emacs starts a subshell instead of suspending. */)
10165 (Lisp_Object stuffstring
)
10167 ptrdiff_t count
= SPECPDL_INDEX ();
10168 int old_height
, old_width
;
10171 if (tty_list
&& tty_list
->next
)
10172 error ("There are other tty frames open; close them before suspending Emacs");
10174 if (!NILP (stuffstring
))
10175 CHECK_STRING (stuffstring
);
10177 run_hook (intern ("suspend-hook"));
10179 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10180 reset_all_sys_modes ();
10181 /* sys_suspend can get an error if it tries to fork a subshell
10182 and the system resources aren't available for that. */
10183 record_unwind_protect_void (init_all_sys_modes
);
10184 stuff_buffered_input (stuffstring
);
10185 if (cannot_suspend
)
10189 unbind_to (count
, Qnil
);
10191 /* Check if terminal/window size has changed.
10192 Note that this is not useful when we are running directly
10193 with a window system; but suspend should be disabled in that case. */
10194 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10195 if (width
!= old_width
|| height
!= old_height
)
10196 change_frame_size (SELECTED_FRAME (), width
,
10197 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10200 run_hook (intern ("suspend-resume-hook"));
10205 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10206 Then in any case stuff anything Emacs has read ahead and not used. */
10209 stuff_buffered_input (Lisp_Object stuffstring
)
10211 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10212 register unsigned char *p
;
10214 if (STRINGP (stuffstring
))
10216 register ptrdiff_t count
;
10218 p
= SDATA (stuffstring
);
10219 count
= SBYTES (stuffstring
);
10220 while (count
-- > 0)
10225 /* Anything we have read ahead, put back for the shell to read. */
10226 /* ?? What should this do when we have multiple keyboards??
10227 Should we ignore anything that was typed in at the "wrong" kboard?
10229 rms: we should stuff everything back into the kboard
10231 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10234 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10235 kbd_fetch_ptr
= kbd_buffer
;
10236 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10237 stuff_char (kbd_fetch_ptr
->ie
.code
);
10239 clear_event (kbd_fetch_ptr
);
10242 input_pending
= false;
10243 #endif /* SIGTSTP */
10247 set_waiting_for_input (struct timespec
*time_to_clear
)
10249 input_available_clear_time
= time_to_clear
;
10251 /* Tell handle_interrupt to throw back to read_char, */
10252 waiting_for_input
= true;
10254 /* If handle_interrupt was called before and buffered a C-g,
10255 make it run again now, to avoid timing error. */
10256 if (!NILP (Vquit_flag
))
10257 quit_throw_to_read_char (0);
10261 clear_waiting_for_input (void)
10263 /* Tell handle_interrupt not to throw back to read_char, */
10264 waiting_for_input
= false;
10265 input_available_clear_time
= 0;
10268 /* The SIGINT handler.
10270 If we have a frame on the controlling tty, we assume that the
10271 SIGINT was generated by C-g, so we call handle_interrupt.
10272 Otherwise, tell QUIT to kill Emacs. */
10275 handle_interrupt_signal (int sig
)
10277 /* See if we have an active terminal on our controlling tty. */
10278 struct terminal
*terminal
= get_named_terminal (DEV_TTY
);
10281 /* If there are no frames there, let's pretend that we are a
10282 well-behaving UN*X program and quit. We must not call Lisp
10283 in a signal handler, so tell QUIT to exit when it is
10285 Vquit_flag
= Qkill_emacs
;
10289 /* Otherwise, the SIGINT was probably generated by C-g. */
10291 /* Set internal_last_event_frame to the top frame of the
10292 controlling tty, if we have a frame there. We disable the
10293 interrupt key on secondary ttys, so the SIGINT must have come
10294 from the controlling tty. */
10295 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10297 handle_interrupt (1);
10302 deliver_interrupt_signal (int sig
)
10304 deliver_process_signal (sig
, handle_interrupt_signal
);
10307 /* Output MSG directly to standard output, without buffering. Ignore
10308 failures. This is safe in a signal handler. */
10310 write_stdout (char const *msg
)
10312 ignore_value (write (STDOUT_FILENO
, msg
, strlen (msg
)));
10315 /* Read a byte from stdin, without buffering. Safe in signal handlers. */
10320 return read (STDIN_FILENO
, &c
, 1) == 1 ? c
: EOF
;
10323 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10324 of the number of times C-g has been requested. If C-g is pressed
10325 enough times, then quit anyway. See bug#6585. */
10326 static int volatile force_quit_count
;
10328 /* This routine is called at interrupt level in response to C-g.
10330 It is called from the SIGINT handler or kbd_buffer_store_event.
10332 If `waiting_for_input' is non zero, then unless `echoing' is
10333 nonzero, immediately throw back to read_char.
10335 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10336 eval to throw, when it gets a chance. If quit-flag is already
10337 non-nil, it stops the job right away. */
10340 handle_interrupt (bool in_signal_handler
)
10346 /* XXX This code needs to be revised for multi-tty support. */
10347 if (!NILP (Vquit_flag
) && get_named_terminal (DEV_TTY
))
10349 if (! in_signal_handler
)
10351 /* If SIGINT isn't blocked, don't let us be interrupted by
10352 a SIGINT. It might be harmful due to non-reentrancy
10353 in I/O functions. */
10355 sigemptyset (&blocked
);
10356 sigaddset (&blocked
, SIGINT
);
10357 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10361 reset_all_sys_modes ();
10365 * On systems which can suspend the current process and return to the original
10366 * shell, this command causes the user to end up back at the shell.
10367 * The "Auto-save" and "Abort" questions are not asked until
10368 * the user elects to return to emacs, at which point he can save the current
10369 * job and either dump core or continue.
10373 /* Perhaps should really fork an inferior shell?
10374 But that would not provide any way to get back
10375 to the original shell, ever. */
10376 write_stdout ("No support for stopping a process"
10377 " on this operating system;\n"
10378 "you can continue or abort.\n");
10379 #endif /* not SIGTSTP */
10381 /* We must remain inside the screen area when the internal terminal
10382 is used. Note that [Enter] is not echoed by dos. */
10383 cursor_to (SELECTED_FRAME (), 0, 0);
10386 write_stdout ("Emacs is resuming after an emergency escape.\n");
10388 /* It doesn't work to autosave while GC is in progress;
10389 the code used for auto-saving doesn't cope with the mark bit. */
10390 if (!gc_in_progress
)
10392 write_stdout ("Auto-save? (y or n) ");
10394 if (c
== 'y' || c
== 'Y')
10396 Fdo_auto_save (Qt
, Qnil
);
10398 write_stdout ("\r\nAuto-save done");
10400 write_stdout ("Auto-save done\n");
10408 /* During GC, it must be safe to reenable quitting again. */
10409 Vinhibit_quit
= Qnil
;
10415 "Garbage collection in progress; cannot auto-save now\r\n"
10416 "but will instead do a real quit"
10417 " after garbage collection ends\r\n");
10421 write_stdout ("\r\nAbort? (y or n) ");
10423 write_stdout ("Abort (and dump core)? (y or n) ");
10426 if (c
== 'y' || c
== 'Y')
10431 write_stdout ("\r\nContinuing...\r\n");
10432 #else /* not MSDOS */
10433 write_stdout ("Continuing...\n");
10434 #endif /* not MSDOS */
10435 init_all_sys_modes ();
10439 /* If executing a function that wants to be interrupted out of
10440 and the user has not deferred quitting by binding `inhibit-quit'
10441 then quit right away. */
10442 if (immediate_quit
&& NILP (Vinhibit_quit
))
10444 struct gl_state_s saved
;
10446 immediate_quit
= false;
10447 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10453 { /* Else request quit when it's safe. */
10454 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10455 force_quit_count
= count
;
10458 immediate_quit
= true;
10459 Vinhibit_quit
= Qnil
;
10465 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10467 /* TODO: The longjmp in this call throws the NS event loop integration off,
10468 and it seems to do fine without this. Probably some attention
10469 needs to be paid to the setting of waiting_for_input in
10470 wait_reading_process_output() under HAVE_NS because of the call
10471 to ns_select there (needed because otherwise events aren't picked up
10472 outside of polling since we don't get SIGIO like X and we don't have a
10473 separate event loop thread like W32. */
10475 if (waiting_for_input
&& !echoing
)
10476 quit_throw_to_read_char (in_signal_handler
);
10480 /* Handle a C-g by making read_char return C-g. */
10483 quit_throw_to_read_char (bool from_signal
)
10485 /* When not called from a signal handler it is safe to call
10487 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10488 Fkill_emacs (Qnil
);
10490 /* Prevent another signal from doing this before we finish. */
10491 clear_waiting_for_input ();
10492 input_pending
= false;
10494 Vunread_command_events
= Qnil
;
10496 if (FRAMEP (internal_last_event_frame
)
10497 && !EQ (internal_last_event_frame
, selected_frame
))
10498 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10501 sys_longjmp (getcjmp
, 1);
10504 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10505 Sset_input_interrupt_mode
, 1, 1, 0,
10506 doc
: /* Set interrupt mode of reading keyboard input.
10507 If INTERRUPT is non-nil, Emacs will use input interrupts;
10508 otherwise Emacs uses CBREAK mode.
10510 See also `current-input-mode'. */)
10511 (Lisp_Object interrupt
)
10513 bool new_interrupt_input
;
10514 #ifdef USABLE_SIGIO
10515 #ifdef HAVE_X_WINDOWS
10516 if (x_display_list
!= NULL
)
10518 /* When using X, don't give the user a real choice,
10519 because we haven't implemented the mechanisms to support it. */
10520 new_interrupt_input
= true;
10523 #endif /* HAVE_X_WINDOWS */
10524 new_interrupt_input
= !NILP (interrupt
);
10525 #else /* not USABLE_SIGIO */
10526 new_interrupt_input
= false;
10527 #endif /* not USABLE_SIGIO */
10529 if (new_interrupt_input
!= interrupt_input
)
10531 #ifdef POLL_FOR_INPUT
10535 /* this causes startup screen to be restored and messes with the mouse */
10536 reset_all_sys_modes ();
10537 interrupt_input
= new_interrupt_input
;
10538 init_all_sys_modes ();
10540 interrupt_input
= new_interrupt_input
;
10543 #ifdef POLL_FOR_INPUT
10544 poll_suppress_count
= 1;
10551 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10552 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10553 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10554 C-q in key sequences.
10556 This setting only has an effect on tty terminals and only when
10557 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10559 See also `current-input-mode'. */)
10560 (Lisp_Object flow
, Lisp_Object terminal
)
10562 struct terminal
*t
= decode_tty_terminal (terminal
);
10563 struct tty_display_info
*tty
;
10567 tty
= t
->display_info
.tty
;
10569 if (tty
->flow_control
!= !NILP (flow
))
10572 /* This causes startup screen to be restored and messes with the mouse. */
10573 reset_sys_modes (tty
);
10576 tty
->flow_control
= !NILP (flow
);
10579 init_sys_modes (tty
);
10585 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10586 doc
: /* Enable or disable 8-bit input on TERMINAL.
10587 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10588 bit as the Meta modifier.
10590 If META is nil, Emacs will ignore the top bit, on the assumption it is
10593 Otherwise, Emacs will accept and pass through 8-bit input without
10594 specially interpreting the top bit.
10596 This setting only has an effect on tty terminal devices.
10598 Optional parameter TERMINAL specifies the tty terminal device to use.
10599 It may be a terminal object, a frame, or nil for the terminal used by
10600 the currently selected frame.
10602 See also `current-input-mode'. */)
10603 (Lisp_Object meta
, Lisp_Object terminal
)
10605 struct terminal
*t
= decode_tty_terminal (terminal
);
10606 struct tty_display_info
*tty
;
10611 tty
= t
->display_info
.tty
;
10615 else if (EQ (meta
, Qt
))
10620 if (tty
->meta_key
!= new_meta
)
10623 /* this causes startup screen to be restored and messes with the mouse */
10624 reset_sys_modes (tty
);
10627 tty
->meta_key
= new_meta
;
10630 init_sys_modes (tty
);
10636 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10637 doc
: /* Specify character used for quitting.
10638 QUIT must be an ASCII character.
10640 This function only has an effect on the controlling tty of the Emacs
10643 See also `current-input-mode'. */)
10646 struct terminal
*t
= get_named_terminal (DEV_TTY
);
10647 struct tty_display_info
*tty
;
10651 tty
= t
->display_info
.tty
;
10653 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10654 error ("QUIT must be an ASCII character");
10657 /* this causes startup screen to be restored and messes with the mouse */
10658 reset_sys_modes (tty
);
10661 /* Don't let this value be out of range. */
10662 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10665 init_sys_modes (tty
);
10671 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10672 doc
: /* Set mode of reading keyboard input.
10673 First arg INTERRUPT non-nil means use input interrupts;
10674 nil means use CBREAK mode.
10675 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10676 (no effect except in CBREAK mode).
10677 Third arg META t means accept 8-bit input (for a Meta key).
10678 META nil means ignore the top bit, on the assumption it is parity.
10679 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10680 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10681 See also `current-input-mode'. */)
10682 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10684 Fset_input_interrupt_mode (interrupt
);
10685 Fset_output_flow_control (flow
, Qnil
);
10686 Fset_input_meta_mode (meta
, Qnil
);
10688 Fset_quit_char (quit
);
10692 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10693 doc
: /* Return information about the way Emacs currently reads keyboard input.
10694 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10695 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10696 nil, Emacs is using CBREAK mode.
10697 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10698 terminal; this does not apply if Emacs uses interrupt-driven input.
10699 META is t if accepting 8-bit input with 8th bit as Meta flag.
10700 META nil means ignoring the top bit, on the assumption it is parity.
10701 META is neither t nor nil if accepting 8-bit input and using
10702 all 8 bits as the character code.
10703 QUIT is the character Emacs currently uses to quit.
10704 The elements of this list correspond to the arguments of
10705 `set-input-mode'. */)
10708 struct frame
*sf
= XFRAME (selected_frame
);
10710 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10711 Lisp_Object flow
, meta
;
10712 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10714 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10715 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10717 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10724 Lisp_Object quit
= make_number (quit_char
);
10726 return list4 (interrupt
, flow
, meta
, quit
);
10729 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10730 doc
: /* Return position information for pixel coordinates X and Y.
10731 By default, X and Y are relative to text area of the selected window.
10732 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10733 If optional fourth arg WHOLE is non-nil, X is relative to the left
10734 edge of the window.
10736 The return value is similar to a mouse click position:
10737 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10738 IMAGE (DX . DY) (WIDTH . HEIGHT))
10739 The `posn-' functions access elements of such lists. */)
10740 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10743 /* We allow X of -1, for the newline in a R2L line that overflowed
10744 into the left fringe. */
10745 if (XINT (x
) != -1)
10749 if (NILP (frame_or_window
))
10750 frame_or_window
= selected_window
;
10752 if (WINDOWP (frame_or_window
))
10754 struct window
*w
= decode_live_window (frame_or_window
);
10756 XSETINT (x
, (XINT (x
)
10757 + WINDOW_LEFT_EDGE_X (w
)
10759 ? window_box_left_offset (w
, TEXT_AREA
)
10761 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10762 frame_or_window
= w
->frame
;
10765 CHECK_LIVE_FRAME (frame_or_window
);
10767 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10770 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10771 doc
: /* Return position information for buffer POS in WINDOW.
10772 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10774 Return nil if position is not visible in window. Otherwise,
10775 the return value is similar to that returned by `event-start' for
10776 a mouse click at the upper left corner of the glyph corresponding
10777 to the given buffer position:
10778 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10779 IMAGE (DX . DY) (WIDTH . HEIGHT))
10780 The `posn-' functions access elements of such lists. */)
10781 (Lisp_Object pos
, Lisp_Object window
)
10786 window
= selected_window
;
10788 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10791 Lisp_Object x
= XCAR (tem
);
10792 Lisp_Object y
= XCAR (XCDR (tem
));
10794 /* Point invisible due to hscrolling? X can be -1 when a
10795 newline in a R2L line overflows into the left fringe. */
10798 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10804 /* Set up a new kboard object with reasonable initial values.
10805 TYPE is a window system for which this keyboard is used. */
10808 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10810 kset_overriding_terminal_local_map (kb
, Qnil
);
10811 kset_last_command (kb
, Qnil
);
10812 kset_real_last_command (kb
, Qnil
);
10813 kset_keyboard_translate_table (kb
, Qnil
);
10814 kset_last_repeatable_command (kb
, Qnil
);
10815 kset_prefix_arg (kb
, Qnil
);
10816 kset_last_prefix_arg (kb
, Qnil
);
10817 kset_kbd_queue (kb
, Qnil
);
10818 kb
->kbd_queue_has_data
= false;
10819 kb
->immediate_echo
= false;
10820 kset_echo_string (kb
, Qnil
);
10821 kset_echo_prompt (kb
, Qnil
);
10822 kb
->kbd_macro_buffer
= 0;
10823 kb
->kbd_macro_bufsize
= 0;
10824 kset_defining_kbd_macro (kb
, Qnil
);
10825 kset_last_kbd_macro (kb
, Qnil
);
10826 kb
->reference_count
= 0;
10827 kset_system_key_alist (kb
, Qnil
);
10828 kset_system_key_syms (kb
, Qnil
);
10829 kset_window_system (kb
, type
);
10830 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10831 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10832 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10833 kset_default_minibuffer_frame (kb
, Qnil
);
10836 /* Allocate and basically initialize keyboard
10837 object to use with window system TYPE. */
10840 allocate_kboard (Lisp_Object type
)
10842 KBOARD
*kb
= xmalloc (sizeof *kb
);
10844 init_kboard (kb
, type
);
10845 kb
->next_kboard
= all_kboards
;
10851 * Destroy the contents of a kboard object, but not the object itself.
10852 * We use this just before deleting it, or if we're going to initialize
10853 * it a second time.
10856 wipe_kboard (KBOARD
*kb
)
10858 xfree (kb
->kbd_macro_buffer
);
10861 /* Free KB and memory referenced from it. */
10864 delete_kboard (KBOARD
*kb
)
10868 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10871 *kbp
= kb
->next_kboard
;
10873 /* Prevent a dangling reference to KB. */
10874 if (kb
== current_kboard
10875 && FRAMEP (selected_frame
)
10876 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10878 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10879 single_kboard
= false;
10880 if (current_kboard
== kb
)
10889 init_keyboard (void)
10891 /* This is correct before outermost invocation of the editor loop. */
10892 command_loop_level
= -1;
10893 immediate_quit
= false;
10894 quit_char
= Ctl ('g');
10895 Vunread_command_events
= Qnil
;
10896 timer_idleness_start_time
= invalid_timespec ();
10898 recent_keys_index
= 0;
10899 kbd_fetch_ptr
= kbd_buffer
;
10900 kbd_store_ptr
= kbd_buffer
;
10901 do_mouse_tracking
= Qnil
;
10902 input_pending
= false;
10903 interrupt_input_blocked
= 0;
10904 pending_signals
= false;
10906 /* This means that command_loop_1 won't try to select anything the first
10908 internal_last_event_frame
= Qnil
;
10909 Vlast_event_frame
= internal_last_event_frame
;
10911 current_kboard
= initial_kboard
;
10912 /* Re-initialize the keyboard again. */
10913 wipe_kboard (current_kboard
);
10914 /* A value of nil for Vwindow_system normally means a tty, but we also use
10915 it for the initial terminal since there is no window system there. */
10916 init_kboard (current_kboard
, Qnil
);
10918 if (!noninteractive
)
10920 /* Before multi-tty support, these handlers used to be installed
10921 only if the current session was a tty session. Now an Emacs
10922 session may have multiple display types, so we always handle
10923 SIGINT. There is special code in handle_interrupt_signal to exit
10924 Emacs on SIGINT when there are no termcap frames on the
10925 controlling terminal. */
10926 struct sigaction action
;
10927 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10928 sigaction (SIGINT
, &action
, 0);
10930 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10931 SIGQUIT and we can't tell which one it will give us. */
10932 sigaction (SIGQUIT
, &action
, 0);
10933 #endif /* not DOS_NT */
10935 #ifdef USABLE_SIGIO
10936 if (!noninteractive
)
10938 struct sigaction action
;
10939 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10940 sigaction (SIGIO
, &action
, 0);
10944 /* Use interrupt input by default, if it works and noninterrupt input
10945 has deficiencies. */
10947 #ifdef INTERRUPT_INPUT
10948 interrupt_input
= 1;
10950 interrupt_input
= 0;
10953 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10956 if (keyboard_init_hook
)
10957 (*keyboard_init_hook
) ();
10959 #ifdef POLL_FOR_INPUT
10961 poll_suppress_count
= 1;
10966 /* This type's only use is in syms_of_keyboard, to put properties on the
10967 event header symbols. */
10974 static const struct event_head head_table
[] = {
10975 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10976 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10978 /* Some of the event heads. */
10979 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
10981 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
10982 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
10983 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
10984 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
10985 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
10986 /* `select-window' should be handled just like `switch-frame'
10987 in read_key_sequence. */
10988 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
10992 syms_of_keyboard (void)
10994 pending_funcalls
= Qnil
;
10995 staticpro (&pending_funcalls
);
10997 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10998 staticpro (&Vlispy_mouse_stem
);
11000 regular_top_level_message
= build_pure_c_string ("Back to top level");
11001 #ifdef HAVE_STACK_OVERFLOW_HANDLING
11002 recover_top_level_message
11003 = build_pure_c_string ("Re-entering top level after C stack overflow");
11005 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
11006 doc
: /* Message displayed by `normal-top-level'. */);
11007 Vinternal__top_level_message
= regular_top_level_message
;
11010 DEFSYM (QCimage
, ":image");
11011 DEFSYM (Qhelp_echo
, "help-echo");
11012 DEFSYM (QCrtl
, ":rtl");
11014 staticpro (&item_properties
);
11015 item_properties
= Qnil
;
11017 staticpro (&tool_bar_item_properties
);
11018 tool_bar_item_properties
= Qnil
;
11019 staticpro (&tool_bar_items_vector
);
11020 tool_bar_items_vector
= Qnil
;
11022 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11024 /* Non-nil disable property on a command means do not execute it;
11025 call disabled-command-function's value instead. */
11026 DEFSYM (Qdisabled
, "disabled");
11028 DEFSYM (Qundefined
, "undefined");
11030 /* Hooks to run before and after each command. */
11031 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11032 DEFSYM (Qpost_command_hook
, "post-command-hook");
11034 DEFSYM (Qundo_auto__add_boundary
, "undo-auto--add-boundary");
11035 DEFSYM (Qundo_auto__undoably_changed_buffers
,
11036 "undo-auto--undoably-changed-buffers");
11038 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11039 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11040 DEFSYM (Qfunction_key
, "function-key");
11042 /* The values of Qevent_kind properties. */
11043 DEFSYM (Qmouse_click
, "mouse-click");
11045 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11046 DEFSYM (Qsave_session
, "save-session");
11047 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11049 /* Menu and tool bar item parts. */
11050 DEFSYM (Qmenu_enable
, "menu-enable");
11053 DEFSYM (Qlanguage_change
, "language-change");
11054 DEFSYM (Qend_session
, "end-session");
11058 DEFSYM (Qdbus_event
, "dbus-event");
11061 #ifdef HAVE_XWIDGETS
11062 DEFSYM (Qxwidget_event
, "xwidget-event");
11065 #ifdef USE_FILE_NOTIFY
11066 DEFSYM (Qfile_notify
, "file-notify");
11067 #endif /* USE_FILE_NOTIFY */
11069 /* Menu and tool bar item parts. */
11070 DEFSYM (QCenable
, ":enable");
11071 DEFSYM (QCvisible
, ":visible");
11072 DEFSYM (QChelp
, ":help");
11073 DEFSYM (QCfilter
, ":filter");
11074 DEFSYM (QCbutton
, ":button");
11075 DEFSYM (QCkeys
, ":keys");
11076 DEFSYM (QCkey_sequence
, ":key-sequence");
11078 /* Non-nil disable property on a command means
11079 do not execute it; call disabled-command-function's value instead. */
11080 DEFSYM (QCtoggle
, ":toggle");
11081 DEFSYM (QCradio
, ":radio");
11082 DEFSYM (QClabel
, ":label");
11083 DEFSYM (QCvert_only
, ":vert-only");
11085 /* Symbols to use for parts of windows. */
11086 DEFSYM (Qvertical_line
, "vertical-line");
11087 DEFSYM (Qright_divider
, "right-divider");
11088 DEFSYM (Qbottom_divider
, "bottom-divider");
11090 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11092 DEFSYM (Qabove_handle
, "above-handle");
11093 DEFSYM (Qhandle
, "handle");
11094 DEFSYM (Qbelow_handle
, "below-handle");
11095 DEFSYM (Qup
, "up");
11096 DEFSYM (Qdown
, "down");
11097 DEFSYM (Qtop
, "top");
11098 DEFSYM (Qbottom
, "bottom");
11099 DEFSYM (Qend_scroll
, "end-scroll");
11100 DEFSYM (Qratio
, "ratio");
11101 DEFSYM (Qbefore_handle
, "before-handle");
11102 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11103 DEFSYM (Qafter_handle
, "after-handle");
11104 DEFSYM (Qleft
, "left");
11105 DEFSYM (Qright
, "right");
11106 DEFSYM (Qleftmost
, "leftmost");
11107 DEFSYM (Qrightmost
, "rightmost");
11109 /* Properties of event headers. */
11110 DEFSYM (Qevent_kind
, "event-kind");
11111 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11113 /* An event header symbol HEAD may have a property named
11114 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11115 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11116 mask of modifiers applied to it. If present, this is used to help
11117 speed up parse_modifiers. */
11118 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11120 /* An unmodified event header BASE may have a property named
11121 Qmodifier_cache, which is an alist mapping modifier masks onto
11122 modified versions of BASE. If present, this helps speed up
11123 apply_modifiers. */
11124 DEFSYM (Qmodifier_cache
, "modifier-cache");
11126 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11127 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11129 DEFSYM (Qpolling_period
, "polling-period");
11131 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11133 /* The primary selection. */
11134 DEFSYM (QPRIMARY
, "PRIMARY");
11136 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11137 DEFSYM (Qhandle_select_window
, "handle-select-window");
11139 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11140 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11142 DEFSYM (Qhelp_form_show
, "help-form-show");
11144 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11146 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11147 Fset (Qinput_method_use_echo_area
, Qnil
);
11149 /* Symbols to head events. */
11150 DEFSYM (Qmouse_movement
, "mouse-movement");
11151 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11152 DEFSYM (Qswitch_frame
, "switch-frame");
11153 DEFSYM (Qfocus_in
, "focus-in");
11154 DEFSYM (Qfocus_out
, "focus-out");
11155 DEFSYM (Qdelete_frame
, "delete-frame");
11156 DEFSYM (Qiconify_frame
, "iconify-frame");
11157 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11158 DEFSYM (Qselect_window
, "select-window");
11162 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11164 const struct event_head
*p
= &head_table
[i
];
11165 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11166 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11167 Fput (var
, Qevent_kind
, kind
);
11168 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11172 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11173 staticpro (&button_down_location
);
11174 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11175 staticpro (&mouse_syms
);
11176 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11178 staticpro (&wheel_syms
);
11182 int len
= ARRAYELTS (modifier_names
);
11184 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11185 for (i
= 0; i
< len
; i
++)
11186 if (modifier_names
[i
])
11187 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11188 staticpro (&modifier_symbols
);
11191 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11192 staticpro (&recent_keys
);
11194 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11195 staticpro (&this_command_keys
);
11197 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11198 staticpro (&raw_keybuf
);
11200 DEFSYM (Qcommand_execute
, "command-execute");
11201 DEFSYM (Qinternal_echo_keystrokes_prefix
, "internal-echo-keystrokes-prefix");
11203 accent_key_syms
= Qnil
;
11204 staticpro (&accent_key_syms
);
11206 func_key_syms
= Qnil
;
11207 staticpro (&func_key_syms
);
11209 drag_n_drop_syms
= Qnil
;
11210 staticpro (&drag_n_drop_syms
);
11212 unread_switch_frame
= Qnil
;
11213 staticpro (&unread_switch_frame
);
11215 internal_last_event_frame
= Qnil
;
11216 staticpro (&internal_last_event_frame
);
11218 read_key_sequence_cmd
= Qnil
;
11219 staticpro (&read_key_sequence_cmd
);
11220 read_key_sequence_remapped
= Qnil
;
11221 staticpro (&read_key_sequence_remapped
);
11223 menu_bar_one_keymap_changed_items
= Qnil
;
11224 staticpro (&menu_bar_one_keymap_changed_items
);
11226 menu_bar_items_vector
= Qnil
;
11227 staticpro (&menu_bar_items_vector
);
11229 help_form_saved_window_configs
= Qnil
;
11230 staticpro (&help_form_saved_window_configs
);
11232 defsubr (&Scurrent_idle_time
);
11233 defsubr (&Sevent_symbol_parse_modifiers
);
11234 defsubr (&Sevent_convert_list
);
11235 defsubr (&Sread_key_sequence
);
11236 defsubr (&Sread_key_sequence_vector
);
11237 defsubr (&Srecursive_edit
);
11238 defsubr (&Strack_mouse
);
11239 defsubr (&Sinput_pending_p
);
11240 defsubr (&Srecent_keys
);
11241 defsubr (&Sthis_command_keys
);
11242 defsubr (&Sthis_command_keys_vector
);
11243 defsubr (&Sthis_single_command_keys
);
11244 defsubr (&Sthis_single_command_raw_keys
);
11245 defsubr (&Sclear_this_command_keys
);
11246 defsubr (&Ssuspend_emacs
);
11247 defsubr (&Sabort_recursive_edit
);
11248 defsubr (&Sexit_recursive_edit
);
11249 defsubr (&Srecursion_depth
);
11250 defsubr (&Scommand_error_default_function
);
11251 defsubr (&Stop_level
);
11252 defsubr (&Sdiscard_input
);
11253 defsubr (&Sopen_dribble_file
);
11254 defsubr (&Sset_input_interrupt_mode
);
11255 defsubr (&Sset_output_flow_control
);
11256 defsubr (&Sset_input_meta_mode
);
11257 defsubr (&Sset_quit_char
);
11258 defsubr (&Sset_input_mode
);
11259 defsubr (&Scurrent_input_mode
);
11260 defsubr (&Sposn_at_point
);
11261 defsubr (&Sposn_at_x_y
);
11263 DEFVAR_LISP ("last-command-event", last_command_event
,
11264 doc
: /* Last input event that was part of a command. */);
11266 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11267 doc
: /* Last input event in a command, except for mouse menu events.
11268 Mouse menus give back keys that don't look like mouse events;
11269 this variable holds the actual mouse event that led to the menu,
11270 so that you can determine whether the command was run by mouse or not. */);
11272 DEFVAR_LISP ("last-input-event", last_input_event
,
11273 doc
: /* Last input event. */);
11275 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11276 doc
: /* List of events to be read as the command input.
11277 These events are processed first, before actual keyboard input.
11278 Events read from this list are not normally added to `this-command-keys',
11279 as they will already have been added once as they were read for the first time.
11280 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11281 Vunread_command_events
= Qnil
;
11283 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11284 doc
: /* List of events to be processed as input by input methods.
11285 These events are processed before `unread-command-events'
11286 and actual keyboard input, but are not given to `input-method-function'. */);
11287 Vunread_post_input_method_events
= Qnil
;
11289 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11290 doc
: /* List of events to be processed as input by input methods.
11291 These events are processed after `unread-command-events', but
11292 before actual keyboard input.
11293 If there's an active input method, the events are given to
11294 `input-method-function'. */);
11295 Vunread_input_method_events
= Qnil
;
11297 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11298 doc
: /* Meta-prefix character code.
11299 Meta-foo as command input turns into this character followed by foo. */);
11300 XSETINT (meta_prefix_char
, 033);
11302 DEFVAR_KBOARD ("last-command", Vlast_command
,
11303 doc
: /* The last command executed.
11304 Normally a symbol with a function definition, but can be whatever was found
11305 in the keymap, or whatever the variable `this-command' was set to by that
11308 The value `mode-exit' is special; it means that the previous command
11309 read an event that told it to exit, and it did so and unread that event.
11310 In other words, the present command is the event that made the previous
11313 The value `kill-region' is special; it means that the previous command
11314 was a kill command.
11316 `last-command' has a separate binding for each terminal device.
11317 See Info node `(elisp)Multiple Terminals'. */);
11319 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11320 doc
: /* Same as `last-command', but never altered by Lisp code.
11321 Taken from the previous value of `real-this-command'. */);
11323 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11324 doc
: /* Last command that may be repeated.
11325 The last command executed that was not bound to an input event.
11326 This is the command `repeat' will try to repeat.
11327 Taken from a previous value of `real-this-command'. */);
11329 DEFVAR_LISP ("this-command", Vthis_command
,
11330 doc
: /* The command now being executed.
11331 The command can set this variable; whatever is put here
11332 will be in `last-command' during the following command. */);
11333 Vthis_command
= Qnil
;
11335 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11336 doc
: /* This is like `this-command', except that commands should never modify it. */);
11337 Vreal_this_command
= Qnil
;
11339 DEFVAR_LISP ("this-command-keys-shift-translated",
11340 Vthis_command_keys_shift_translated
,
11341 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11342 Shift-translation occurs when there is no binding for the key sequence
11343 as entered, but a binding was found by changing an upper-case letter
11344 to lower-case, or a shifted function key to an unshifted one. */);
11345 Vthis_command_keys_shift_translated
= Qnil
;
11347 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11348 doc
: /* The command bound to the current key sequence before remapping.
11349 It equals `this-command' if the original command was not remapped through
11350 any of the active keymaps. Otherwise, the value of `this-command' is the
11351 result of looking up the original command in the active keymaps. */);
11352 Vthis_original_command
= Qnil
;
11354 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11355 doc
: /* Number of input events between auto-saves.
11356 Zero means disable autosaving due to number of characters typed. */);
11357 auto_save_interval
= 300;
11359 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11360 doc
: /* Number of seconds idle time before auto-save.
11361 Zero or nil means disable auto-saving due to idleness.
11362 After auto-saving due to this many seconds of idle time,
11363 Emacs also does a garbage collection if that seems to be warranted. */);
11364 XSETFASTINT (Vauto_save_timeout
, 30);
11366 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11367 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11368 The value may be integer or floating point.
11369 If the value is zero, don't echo at all. */);
11370 Vecho_keystrokes
= make_number (1);
11372 DEFVAR_INT ("polling-period", polling_period
,
11373 doc
: /* Interval between polling for input during Lisp execution.
11374 The reason for polling is to make C-g work to stop a running program.
11375 Polling is needed only when using X windows and SIGIO does not work.
11376 Polling is automatically disabled in all other cases. */);
11377 polling_period
= 2;
11379 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11380 doc
: /* Maximum time between mouse clicks to make a double-click.
11381 Measured in milliseconds. The value nil means disable double-click
11382 recognition; t means double-clicks have no time limit and are detected
11383 by position only. */);
11384 Vdouble_click_time
= make_number (500);
11386 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11387 doc
: /* Maximum mouse movement between clicks to make a double-click.
11388 On window-system frames, value is the number of pixels the mouse may have
11389 moved horizontally or vertically between two clicks to make a double-click.
11390 On non window-system frames, value is interpreted in units of 1/8 characters
11393 This variable is also the threshold for motion of the mouse
11394 to count as a drag. */);
11395 double_click_fuzz
= 3;
11397 DEFVAR_INT ("num-input-keys", num_input_keys
,
11398 doc
: /* Number of complete key sequences read as input so far.
11399 This includes key sequences read from keyboard macros.
11400 The number is effectively the number of interactive command invocations. */);
11401 num_input_keys
= 0;
11403 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11404 doc
: /* Number of input events read from the keyboard so far.
11405 This does not include events generated by keyboard macros. */);
11406 num_nonmacro_input_events
= 0;
11408 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11409 doc
: /* The frame in which the most recently read event occurred.
11410 If the last event came from a keyboard macro, this is set to `macro'. */);
11411 Vlast_event_frame
= Qnil
;
11413 /* This variable is set up in sysdep.c. */
11414 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11415 doc
: /* The ERASE character as set by the user with stty. */);
11417 DEFVAR_LISP ("help-char", Vhelp_char
,
11418 doc
: /* Character to recognize as meaning Help.
11419 When it is read, do `(eval help-form)', and display result if it's a string.
11420 If the value of `help-form' is nil, this char can be read normally. */);
11421 XSETINT (Vhelp_char
, Ctl ('H'));
11423 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11424 doc
: /* List of input events to recognize as meaning Help.
11425 These work just like the value of `help-char' (see that). */);
11426 Vhelp_event_list
= Qnil
;
11428 DEFVAR_LISP ("help-form", Vhelp_form
,
11429 doc
: /* Form to execute when character `help-char' is read.
11430 If the form returns a string, that string is displayed.
11431 If `help-form' is nil, the help char is not recognized. */);
11434 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11435 doc
: /* Command to run when `help-char' character follows a prefix key.
11436 This command is used only when there is no actual binding
11437 for that character after that prefix key. */);
11438 Vprefix_help_command
= Qnil
;
11440 DEFVAR_LISP ("top-level", Vtop_level
,
11441 doc
: /* Form to evaluate when Emacs starts up.
11442 Useful to set before you dump a modified Emacs. */);
11444 XSYMBOL (Qtop_level
)->declared_special
= false;
11446 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11447 doc
: /* Translate table for local keyboard input, or nil.
11448 If non-nil, the value should be a char-table. Each character read
11449 from the keyboard is looked up in this char-table. If the value found
11450 there is non-nil, then it is used instead of the actual input character.
11452 The value can also be a string or vector, but this is considered obsolete.
11453 If it is a string or vector of length N, character codes N and up are left
11454 untranslated. In a vector, an element which is nil means "no translation".
11456 This is applied to the characters supplied to input methods, not their
11457 output. See also `translation-table-for-input'.
11459 This variable has a separate binding for each terminal.
11460 See Info node `(elisp)Multiple Terminals'. */);
11462 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11463 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11464 \(Even if the operating system has support for stopping a process.) */);
11465 cannot_suspend
= false;
11467 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11468 doc
: /* Non-nil means prompt with menus when appropriate.
11469 This is done when reading from a keymap that has a prompt string,
11470 for elements that have prompt strings.
11471 The menu is displayed on the screen
11472 if X menus were enabled at configuration
11473 time and the previous event was a mouse click prefix key.
11474 Otherwise, menu prompting uses the echo area. */);
11475 menu_prompting
= true;
11477 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11478 doc
: /* Character to see next line of menu prompt.
11479 Type this character while in a menu prompt to rotate around the lines of it. */);
11480 XSETINT (menu_prompt_more_char
, ' ');
11482 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11483 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11484 Emacs applies the modifiers of the character stored here to each keyboard
11485 character it reads. For example, after evaluating the expression
11486 (setq extra-keyboard-modifiers ?\\C-x)
11487 all input characters will have the control modifier applied to them.
11489 Note that the character ?\\C-@, equivalent to the integer zero, does
11490 not count as a control character; rather, it counts as a character
11491 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11492 cancels any modification. */);
11493 extra_keyboard_modifiers
= 0;
11495 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11496 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11497 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11498 The command loop sets this to nil before each command,
11499 and tests the value when the command returns.
11500 Buffer modification stores t in this variable. */);
11501 Vdeactivate_mark
= Qnil
;
11502 Fmake_variable_buffer_local (Qdeactivate_mark
);
11504 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11505 doc
: /* Normal hook run before each command is executed.
11506 If an unhandled error happens in running this hook,
11507 the function in which the error occurred is unconditionally removed, since
11508 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11510 See also `post-command-hook'. */);
11511 Vpre_command_hook
= Qnil
;
11513 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11514 doc
: /* Normal hook run after each command is executed.
11515 If an unhandled error happens in running this hook,
11516 the function in which the error occurred is unconditionally removed, since
11517 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11519 It is a bad idea to use this hook for expensive processing. If
11520 unavoidable, wrap your code in `(while-no-input (redisplay) CODE)' to
11521 avoid making Emacs unresponsive while the user types.
11523 See also `pre-command-hook'. */);
11524 Vpost_command_hook
= Qnil
;
11527 DEFVAR_LISP ("echo-area-clear-hook", ...,
11528 doc
: /* Normal hook run when clearing the echo area. */);
11530 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11531 Fset (Qecho_area_clear_hook
, Qnil
);
11533 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11534 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11535 Vlucid_menu_bar_dirty_flag
= Qnil
;
11537 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11538 doc
: /* List of menu bar items to move to the end of the menu bar.
11539 The elements of the list are event types that may have menu bar bindings. */);
11540 Vmenu_bar_final_items
= Qnil
;
11542 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11543 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11544 This is used internally by graphical displays that do not render
11545 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11546 Vtool_bar_separator_image_expression
= Qnil
;
11548 DEFVAR_KBOARD ("overriding-terminal-local-map",
11549 Voverriding_terminal_local_map
,
11550 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11551 This variable is intended to let commands such as `universal-argument'
11552 set up a different keymap for reading the next command.
11554 `overriding-terminal-local-map' has a separate binding for each
11555 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11557 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11558 doc
: /* Keymap that replaces (overrides) local keymaps.
11559 If this variable is non-nil, Emacs looks up key bindings in this
11560 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11561 buffer's local map. Hence, the only active keymaps would be
11562 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11563 order of precedence. */);
11564 Voverriding_local_map
= Qnil
;
11566 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11567 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11568 Otherwise, the menu bar continues to reflect the buffer's local map
11569 and the minor mode maps regardless of `overriding-local-map'. */);
11570 Voverriding_local_map_menu_flag
= Qnil
;
11572 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11573 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11574 Vspecial_event_map
= list1 (Qkeymap
);
11576 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11577 doc
: /* Non-nil means generate motion events for mouse motion. */);
11579 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11580 doc
: /* Alist of system-specific X windows key symbols.
11581 Each element should have the form (N . SYMBOL) where N is the
11582 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11583 and SYMBOL is its name.
11585 `system-key-alist' has a separate binding for each terminal device.
11586 See Info node `(elisp)Multiple Terminals'. */);
11588 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11589 doc
: /* Keymap that translates key sequences to key sequences during input.
11590 This is used mainly for mapping key sequences into some preferred
11591 key events (symbols).
11593 The `read-key-sequence' function replaces any subsequence bound by
11594 `local-function-key-map' with its binding. More precisely, when the
11595 active keymaps have no binding for the current key sequence but
11596 `local-function-key-map' binds a suffix of the sequence to a vector or
11597 string, `read-key-sequence' replaces the matching suffix with its
11598 binding, and continues with the new sequence.
11600 If the binding is a function, it is called with one argument (the prompt)
11601 and its return value (a key sequence) is used.
11603 The events that come from bindings in `local-function-key-map' are not
11604 themselves looked up in `local-function-key-map'.
11606 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11607 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11608 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11609 typing `ESC O P x' would return [f1 x].
11611 `local-function-key-map' has a separate binding for each terminal
11612 device. See Info node `(elisp)Multiple Terminals'. If you need to
11613 define a binding on all terminals, change `function-key-map'
11614 instead. Initially, `local-function-key-map' is an empty keymap that
11615 has `function-key-map' as its parent on all terminal devices. */);
11617 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11618 doc
: /* Keymap that decodes input escape sequences.
11619 This is used mainly for mapping ASCII function key sequences into
11620 real Emacs function key events (symbols).
11622 The `read-key-sequence' function replaces any subsequence bound by
11623 `input-decode-map' with its binding. Contrary to `function-key-map',
11624 this map applies its rebinding regardless of the presence of an ordinary
11625 binding. So it is more like `key-translation-map' except that it applies
11626 before `function-key-map' rather than after.
11628 If the binding is a function, it is called with one argument (the prompt)
11629 and its return value (a key sequence) is used.
11631 The events that come from bindings in `input-decode-map' are not
11632 themselves looked up in `input-decode-map'. */);
11634 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11635 doc
: /* The parent keymap of all `local-function-key-map' instances.
11636 Function key definitions that apply to all terminal devices should go
11637 here. If a mapping is defined in both the current
11638 `local-function-key-map' binding and this variable, then the local
11639 definition will take precedence. */);
11640 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11642 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11643 doc
: /* Keymap of key translations that can override keymaps.
11644 This keymap works like `input-decode-map', but comes after `function-key-map'.
11645 Another difference is that it is global rather than terminal-local. */);
11646 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11648 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11649 doc
: /* List of deferred actions to be performed at a later time.
11650 The precise format isn't relevant here; we just check whether it is nil. */);
11651 Vdeferred_action_list
= Qnil
;
11653 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11654 doc
: /* Function to call to handle deferred actions, after each command.
11655 This function is called with no arguments after each command
11656 whenever `deferred-action-list' is non-nil. */);
11657 Vdeferred_action_function
= Qnil
;
11659 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11660 doc
: /* List of warnings to be displayed after this command.
11661 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11662 as per the args of `display-warning' (which see).
11663 If this variable is non-nil, `delayed-warnings-hook' will be run
11664 immediately after running `post-command-hook'. */);
11665 Vdelayed_warnings_list
= Qnil
;
11667 DEFVAR_LISP ("timer-list", Vtimer_list
,
11668 doc
: /* List of active absolute time timers in order of increasing time. */);
11669 Vtimer_list
= Qnil
;
11671 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11672 doc
: /* List of active idle-time timers in order of increasing time. */);
11673 Vtimer_idle_list
= Qnil
;
11675 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11676 doc
: /* If non-nil, the function that implements the current input method.
11677 It's called with one argument, a printing character that was just read.
11678 \(That means a character with code 040...0176.)
11679 Typically this function uses `read-event' to read additional events.
11680 When it does so, it should first bind `input-method-function' to nil
11681 so it will not be called recursively.
11683 The function should return a list of zero or more events
11684 to be used as input. If it wants to put back some events
11685 to be reconsidered, separately, by the input method,
11686 it can add them to the beginning of `unread-command-events'.
11688 The input method function can find in `input-method-previous-message'
11689 the previous echo area message.
11691 The input method function should refer to the variables
11692 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11693 for guidance on what to do. */);
11694 Vinput_method_function
= Qlist
;
11696 DEFVAR_LISP ("input-method-previous-message",
11697 Vinput_method_previous_message
,
11698 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11699 This variable exists because `read-event' clears the echo area
11700 before running the input method. It is nil if there was no message. */);
11701 Vinput_method_previous_message
= Qnil
;
11703 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11704 doc
: /* If non-nil, the function that implements the display of help.
11705 It's called with one argument, the help string to display. */);
11706 Vshow_help_function
= Qnil
;
11708 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11709 doc
: /* If non-nil, suppress point adjustment after executing a command.
11711 After a command is executed, if point moved into a region that has
11712 special properties (e.g. composition, display), Emacs adjusts point to
11713 the boundary of the region. But when a command leaves this variable at
11714 a non-nil value (e.g., with a setq), this point adjustment is suppressed.
11716 This variable is set to nil before reading a command, and is checked
11717 just after executing the command. */);
11718 Vdisable_point_adjustment
= Qnil
;
11720 DEFVAR_LISP ("global-disable-point-adjustment",
11721 Vglobal_disable_point_adjustment
,
11722 doc
: /* If non-nil, always suppress point adjustments.
11724 The default value is nil, in which case point adjustments are
11725 suppressed only after special commands that leave
11726 `disable-point-adjustment' (which see) at a non-nil value. */);
11727 Vglobal_disable_point_adjustment
= Qnil
;
11729 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11730 doc
: /* How long to display an echo-area message when the minibuffer is active.
11731 If the value is a number, it should be specified in seconds.
11732 If the value is not a number, such messages never time out. */);
11733 Vminibuffer_message_timeout
= make_number (2);
11735 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11736 doc
: /* If non-nil, any keyboard input throws to this symbol.
11737 The value of that variable is passed to `quit-flag' and later causes a
11738 peculiar kind of quitting. */);
11739 Vthrow_on_input
= Qnil
;
11741 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11742 doc
: /* Function to output error messages.
11743 Called with three arguments:
11744 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11745 such as what `condition-case' would bind its variable to,
11746 - the context (a string which normally goes at the start of the message),
11747 - the Lisp function within which the error was signaled. */);
11748 Vcommand_error_function
= intern ("command-error-default-function");
11750 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11751 Venable_disabled_menus_and_buttons
,
11752 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11754 Help functions bind this to allow help on disabled menu items
11755 and tool-bar buttons. */);
11756 Venable_disabled_menus_and_buttons
= Qnil
;
11758 DEFVAR_LISP ("select-active-regions",
11759 Vselect_active_regions
,
11760 doc
: /* If non-nil, an active region automatically sets the primary selection.
11761 If the value is `only', only temporarily active regions (usually made
11762 by mouse-dragging or shift-selection) set the window selection.
11764 This takes effect only when Transient Mark mode is enabled. */);
11765 Vselect_active_regions
= Qt
;
11767 DEFVAR_LISP ("saved-region-selection",
11768 Vsaved_region_selection
,
11769 doc
: /* Contents of active region prior to buffer modification.
11770 If `select-active-regions' is non-nil, Emacs sets this to the
11771 text in the region before modifying the buffer. The next call to
11772 the function `deactivate-mark' uses this to set the window selection. */);
11773 Vsaved_region_selection
= Qnil
;
11775 DEFVAR_LISP ("selection-inhibit-update-commands",
11776 Vselection_inhibit_update_commands
,
11777 doc
: /* List of commands which should not update the selection.
11778 Normally, if `select-active-regions' is non-nil and the mark remains
11779 active after a command (i.e. the mark was not deactivated), the Emacs
11780 command loop sets the selection to the text in the region. However,
11781 if the command is in this list, the selection is not updated. */);
11782 Vselection_inhibit_update_commands
11783 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11785 DEFVAR_LISP ("debug-on-event",
11787 doc
: /* Enter debugger on this event. When Emacs
11788 receives the special event specified by this variable, it will try to
11789 break into the debugger as soon as possible instead of processing the
11790 event normally through `special-event-map'.
11792 Currently, the only supported values for this
11793 variable are `sigusr1' and `sigusr2'. */);
11794 Vdebug_on_event
= intern_c_string ("sigusr2");
11796 DEFVAR_BOOL ("attempt-stack-overflow-recovery",
11797 attempt_stack_overflow_recovery
,
11798 doc
: /* If non-nil, attempt to recover from C stack
11799 overflow. This recovery is unsafe and may lead to deadlocks or data
11800 corruption, but it usually works and may preserve modified buffers
11801 that would otherwise be lost. If nil, treat stack overflow like any
11802 other kind of crash. */);
11803 attempt_stack_overflow_recovery
= true;
11805 DEFVAR_BOOL ("attempt-orderly-shutdown-on-fatal-signal",
11806 attempt_orderly_shutdown_on_fatal_signal
,
11807 doc
: /* If non-nil, attempt to perform an orderly
11808 shutdown when Emacs receives a fatal signal (e.g., a crash).
11809 This cleanup is unsafe and may lead to deadlocks or data corruption,
11810 but it usually works and may preserve modified buffers that would
11811 otherwise be lost. If nil, crash immediately in response to fatal
11813 attempt_orderly_shutdown_on_fatal_signal
= true;
11815 /* Create the initial keyboard. Qt means 'unset'. */
11816 initial_kboard
= allocate_kboard (Qt
);
11820 keys_of_keyboard (void)
11822 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11823 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11824 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11825 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11826 initial_define_key (meta_map
, 'x', "execute-extended-command");
11828 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11829 "handle-delete-frame");
11831 initial_define_lispy_key (Vspecial_event_map
, "end-session",
11834 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11835 "ns-put-working-text");
11836 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11837 "ns-unput-working-text");
11838 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11839 current-prefix-arg, as is done in `handle-switch-frame'.
11840 But `handle-switch-frame is not run from the special-map.
11841 Commands from that map are run in a special way that automatically
11842 preserves the prefix-arg. Restoring the prefix arg here is not just
11843 redundant but harmful:
11845 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11846 - after the first prompt, the exit-minibuffer-hook is run which may
11847 iconify a frame and thus push a `iconify-frame' event.
11848 - after running exit-minibuffer-hook, current-prefix-arg is
11849 restored to the non-nil value it had before the prompt.
11850 - we enter the second prompt.
11851 current-prefix-arg is non-nil, prefix-arg is nil.
11852 - before running the first real event, we run the special iconify-frame
11853 event, but we pass the `special' arg to command-execute so
11854 current-prefix-arg and prefix-arg are left untouched.
11855 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11856 - the next key event will have a spuriously non-nil current-prefix-arg. */
11857 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11859 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11861 /* Handling it at such a low-level causes read_key_sequence to get
11862 * confused because it doesn't realize that the current_buffer was
11863 * changed by read_char.
11865 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11866 * "handle-select-window"); */
11867 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11868 "handle-save-session");
11871 /* Define a special event which is raised for dbus callback
11873 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11874 "dbus-handle-event");
11877 #ifdef USE_FILE_NOTIFY
11878 /* Define a special event which is raised for notification callback
11880 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11881 "file-notify-handle-event");
11882 #endif /* USE_FILE_NOTIFY */
11884 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11886 #if defined (WINDOWSNT)
11887 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11890 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11891 "handle-focus-in");
11892 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11893 "handle-focus-out");
11896 /* Mark the pointers in the kboard objects.
11897 Called by Fgarbage_collect. */
11899 mark_kboards (void)
11903 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11905 if (kb
->kbd_macro_buffer
)
11906 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11908 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11909 mark_object (KVAR (kb
, Vlast_command
));
11910 mark_object (KVAR (kb
, Vreal_last_command
));
11911 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11912 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11913 mark_object (KVAR (kb
, Vprefix_arg
));
11914 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11915 mark_object (KVAR (kb
, kbd_queue
));
11916 mark_object (KVAR (kb
, defining_kbd_macro
));
11917 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11918 mark_object (KVAR (kb
, Vsystem_key_alist
));
11919 mark_object (KVAR (kb
, system_key_syms
));
11920 mark_object (KVAR (kb
, Vwindow_system
));
11921 mark_object (KVAR (kb
, Vinput_decode_map
));
11922 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11923 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11924 mark_object (KVAR (kb
, echo_string
));
11925 mark_object (KVAR (kb
, echo_prompt
));
11928 union buffered_input_event
*event
;
11929 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11931 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11932 event
= kbd_buffer
;
11933 /* These two special event types has no Lisp_Objects to mark. */
11934 if (event
->kind
!= SELECTION_REQUEST_EVENT
11935 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11937 mark_object (event
->ie
.x
);
11938 mark_object (event
->ie
.y
);
11939 mark_object (event
->ie
.frame_or_window
);
11940 mark_object (event
->ie
.arg
);