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"
78 /* Variables for blockinput.h: */
80 /* Positive if interrupt input is blocked right now. */
81 volatile int interrupt_input_blocked
;
83 /* True means an input interrupt or alarm signal has arrived.
84 The QUIT macro checks this. */
85 volatile bool pending_signals
;
87 #define KBD_BUFFER_SIZE 4096
89 KBOARD
*initial_kboard
;
90 KBOARD
*current_kboard
;
91 static KBOARD
*all_kboards
;
93 /* True in the single-kboard state, false in the any-kboard state. */
94 static bool single_kboard
;
96 #define NUM_RECENT_KEYS (300)
98 /* Index for storing next element into recent_keys. */
99 static int recent_keys_index
;
101 /* Total number of elements stored into recent_keys. */
102 static int total_keys
;
104 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
105 static Lisp_Object recent_keys
;
107 /* Vector holding the key sequence that invoked the current command.
108 It is reused for each command, and it may be longer than the current
109 sequence; this_command_key_count indicates how many elements
110 actually mean something.
111 It's easier to staticpro a single Lisp_Object than an array. */
112 Lisp_Object this_command_keys
;
113 ptrdiff_t this_command_key_count
;
115 /* This vector is used as a buffer to record the events that were actually read
116 by read_key_sequence. */
117 static Lisp_Object raw_keybuf
;
118 static int raw_keybuf_count
;
120 #define GROW_RAW_KEYBUF \
121 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
122 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
124 /* Number of elements of this_command_keys
125 that precede this key sequence. */
126 static ptrdiff_t this_single_command_key_start
;
128 #ifdef HAVE_STACK_OVERFLOW_HANDLING
130 /* For longjmp to recover from C stack overflow. */
131 sigjmp_buf return_to_command_loop
;
133 /* Message displayed by Vtop_level when recovering from C stack overflow. */
134 static Lisp_Object recover_top_level_message
;
136 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
138 /* Message normally displayed by Vtop_level. */
139 static Lisp_Object regular_top_level_message
;
141 /* For longjmp to where kbd input is being done. */
143 static sys_jmp_buf getcjmp
;
145 /* True while doing kbd input. */
146 bool waiting_for_input
;
148 /* True while displaying for echoing. Delays C-g throwing. */
152 /* Non-null means we can start echoing at the next input pause even
153 though there is something in the echo area. */
155 static struct kboard
*ok_to_echo_at_next_pause
;
157 /* The kboard last echoing, or null for none. Reset to 0 in
158 cancel_echoing. If non-null, and a current echo area message
159 exists, and echo_message_buffer is eq to the current message
160 buffer, we know that the message comes from echo_kboard. */
162 struct kboard
*echo_kboard
;
164 /* The buffer used for echoing. Set in echo_now, reset in
167 Lisp_Object echo_message_buffer
;
169 /* True means C-g should cause immediate error-signal. */
172 /* Character that causes a quit. Normally C-g.
174 If we are running on an ordinary terminal, this must be an ordinary
175 ASCII char, since we want to make it our interrupt character.
177 If we are not running on an ordinary terminal, it still needs to be
178 an ordinary ASCII char. This character needs to be recognized in
179 the input interrupt handler. At this point, the keystroke is
180 represented as a struct input_event, while the desired quit
181 character is specified as a lispy event. The mapping from struct
182 input_events to lispy events cannot run in an interrupt handler,
183 and the reverse mapping is difficult for anything but ASCII
186 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
190 /* Current depth in recursive edits. */
191 EMACS_INT command_loop_level
;
193 /* If not Qnil, this is a switch-frame event which we decided to put
194 off until the end of a key sequence. This should be read as the
195 next command input, after any unread_command_events.
197 read_key_sequence uses this to delay switch-frame events until the
198 end of the key sequence; Fread_char uses it to put off switch-frame
199 events until a non-ASCII event is acceptable as input. */
200 Lisp_Object unread_switch_frame
;
202 /* Last size recorded for a current buffer which is not a minibuffer. */
203 static ptrdiff_t last_non_minibuf_size
;
205 uintmax_t num_input_events
;
206 ptrdiff_t point_before_last_command_or_undo
;
207 struct buffer
*buffer_before_last_command_or_undo
;
209 /* Value of num_nonmacro_input_events as of last auto save. */
211 static EMACS_INT last_auto_save
;
213 /* The value of point when the last command was started. */
214 static ptrdiff_t last_point_position
;
216 /* The frame in which the last input event occurred, or Qmacro if the
217 last event came from a macro. We use this to determine when to
218 generate switch-frame events. This may be cleared by functions
219 like Fselect_frame, to make sure that a switch-frame event is
220 generated by the next character.
222 FIXME: This is modified by a signal handler so it should be volatile.
223 It's exported to Lisp, though, so it can't simply be marked
225 Lisp_Object internal_last_event_frame
;
227 /* `read_key_sequence' stores here the command definition of the
228 key sequence that it reads. */
229 static Lisp_Object read_key_sequence_cmd
;
230 static Lisp_Object read_key_sequence_remapped
;
232 /* File in which we write all commands we read. */
233 static FILE *dribble
;
235 /* True if input is available. */
238 /* True if more input was available last time we read an event.
240 Since redisplay can take a significant amount of time and is not
241 indispensable to perform the user's commands, when input arrives
242 "too fast", Emacs skips redisplay. More specifically, if the next
243 command has already been input when we finish the previous command,
244 we skip the intermediate redisplay.
246 This is useful to try and make sure Emacs keeps up with fast input
247 rates, such as auto-repeating keys. But in some cases, this proves
248 too conservative: we may end up disabling redisplay for the whole
249 duration of a key repetition, even though we could afford to
250 redisplay every once in a while.
252 So we "sample" the input_pending flag before running a command and
253 use *that* value after running the command to decide whether to
254 skip redisplay or not. This way, we only skip redisplay if we
255 really can't keep up with the repeat rate.
257 This only makes a difference if the next input arrives while running the
258 command, which is very unlikely if the command is executed quickly.
259 IOW this tends to avoid skipping redisplay after a long running command
260 (which is a case where skipping redisplay is not very useful since the
261 redisplay time is small compared to the time it took to run the command).
263 A typical use case is when scrolling. Scrolling time can be split into:
264 - Time to do jit-lock on the newly displayed portion of buffer.
265 - Time to run the actual scroll command.
266 - Time to perform the redisplay.
267 Jit-lock can happen either during the command or during the redisplay.
268 In the most painful cases, the jit-lock time is the one that dominates.
269 Also jit-lock can be tweaked (via jit-lock-defer) to delay its job, at the
270 cost of temporary inaccuracy in display and scrolling.
271 So without input_was_pending, what typically happens is the following:
272 - when the command starts, there's no pending input (yet).
273 - the scroll command triggers jit-lock.
274 - during the long jit-lock time the next input arrives.
275 - at the end of the command, we check input_pending and hence decide to
277 - we read the next input and start over.
278 End result: all the hard work of jit-locking is "wasted" since redisplay
279 doesn't actually happens (at least not before the input rate slows down).
280 With input_was_pending redisplay is still skipped if Emacs can't keep up
281 with the input rate, but if it can keep up just enough that there's no
282 input_pending when we begin the command, then redisplay is not skipped
283 which results in better feedback to the user. */
284 static bool input_was_pending
;
286 /* Circular buffer for pre-read keyboard input. */
288 static union buffered_input_event kbd_buffer
[KBD_BUFFER_SIZE
];
290 /* Pointer to next available character in kbd_buffer.
291 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
292 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
293 next available char is in kbd_buffer[0]. */
294 static union buffered_input_event
*kbd_fetch_ptr
;
296 /* Pointer to next place to store character in kbd_buffer. This
297 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
298 character should go in kbd_buffer[0]. */
299 static union buffered_input_event
*volatile kbd_store_ptr
;
301 /* The above pair of variables forms a "queue empty" flag. When we
302 enqueue a non-hook event, we increment kbd_store_ptr. When we
303 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
304 there is input available if the two pointers are not equal.
306 Why not just have a flag set and cleared by the enqueuing and
307 dequeuing functions? Such a flag could be screwed up by interrupts
308 at inopportune times. */
310 static void recursive_edit_unwind (Lisp_Object buffer
);
311 static Lisp_Object
command_loop (void);
313 static void echo_now (void);
314 static ptrdiff_t echo_length (void);
316 /* Incremented whenever a timer is run. */
319 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
321 struct timespec
*input_available_clear_time
;
323 /* True means use SIGIO interrupts; false means use CBREAK mode.
324 Default is true if INTERRUPT_INPUT is defined. */
325 bool interrupt_input
;
327 /* Nonzero while interrupts are temporarily deferred during redisplay. */
328 bool interrupts_deferred
;
330 /* The time when Emacs started being idle. */
332 static struct timespec timer_idleness_start_time
;
334 /* After Emacs stops being idle, this saves the last value
335 of timer_idleness_start_time from when it was idle. */
337 static struct timespec timer_last_idleness_start_time
;
340 /* Global variable declarations. */
342 /* Flags for readable_events. */
343 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
344 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
345 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
347 /* Function for init_keyboard to call with no args (if nonzero). */
348 static void (*keyboard_init_hook
) (void);
350 static bool get_input_pending (int);
351 static bool readable_events (int);
352 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
353 Lisp_Object
, bool *);
354 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
355 static Lisp_Object
make_lispy_event (struct input_event
*);
356 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
357 enum scroll_bar_part
,
358 Lisp_Object
, Lisp_Object
,
360 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
361 Lisp_Object
, const char *const *,
362 Lisp_Object
*, ptrdiff_t);
363 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
364 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
365 #ifdef HAVE_WINDOW_SYSTEM
366 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
367 #endif /* HAVE_WINDOW_SYSTEM */
368 static bool help_char_p (Lisp_Object
);
369 static void save_getcjmp (sys_jmp_buf
);
370 static void restore_getcjmp (sys_jmp_buf
);
371 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
372 static void restore_kboard_configuration (int);
373 static void handle_interrupt (bool);
374 static _Noreturn
void quit_throw_to_read_char (bool);
375 static void timer_start_idle (void);
376 static void timer_stop_idle (void);
377 static void timer_resume_idle (void);
378 static void deliver_user_signal (int);
379 static char *find_user_signal_name (int);
380 static void store_user_signal_events (void);
382 /* These setters are used only in this file, so they can be private. */
384 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
386 kb
->echo_string_
= val
;
389 kset_echo_prompt (struct kboard
*kb
, Lisp_Object val
)
391 kb
->echo_prompt_
= val
;
394 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
396 kb
->kbd_queue_
= val
;
399 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
401 kb
->Vkeyboard_translate_table_
= val
;
404 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
406 kb
->Vlast_prefix_arg_
= val
;
409 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
411 kb
->Vlast_repeatable_command_
= val
;
414 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
416 kb
->Vlocal_function_key_map_
= val
;
419 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
421 kb
->Voverriding_terminal_local_map_
= val
;
424 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
426 kb
->Vreal_last_command_
= val
;
429 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
431 kb
->system_key_syms_
= val
;
436 echo_keystrokes_p (void)
438 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
439 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0
443 /* Add C to the echo string, without echoing it immediately. C can be
444 a character, which is pretty-printed, or a symbol, whose name is
448 echo_add_key (Lisp_Object c
)
450 char initbuf
[KEY_DESCRIPTION_SIZE
+ 100];
451 ptrdiff_t size
= sizeof initbuf
;
452 char *buffer
= initbuf
;
454 Lisp_Object echo_string
= KVAR (current_kboard
, echo_string
);
457 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
458 /* Add a space at the end as a separator between keys. */
461 /* If someone has passed us a composite event, use its head symbol. */
465 ptr
= push_key_description (XINT (c
), ptr
);
466 else if (SYMBOLP (c
))
468 Lisp_Object name
= SYMBOL_NAME (c
);
469 ptrdiff_t nbytes
= SBYTES (name
);
471 if (size
- (ptr
- buffer
) < nbytes
)
473 ptrdiff_t offset
= ptr
- buffer
;
474 size
= max (2 * size
, size
+ nbytes
);
475 buffer
= SAFE_ALLOCA (size
);
476 ptr
= buffer
+ offset
;
479 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
480 STRING_MULTIBYTE (name
), 1);
483 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
486 static const char text
[] = " (Type ? for further options)";
487 int len
= sizeof text
- 1;
489 if (size
- (ptr
- buffer
) < len
)
491 ptrdiff_t offset
= ptr
- buffer
;
493 buffer
= SAFE_ALLOCA (size
);
494 ptr
= buffer
+ offset
;
497 memcpy (ptr
, text
, len
);
503 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
507 /* Temporarily add a dash to the end of the echo string if it's not
508 empty, so that it serves as a mini-prompt for the very next
514 /* Do nothing if not echoing at all. */
515 if (NILP (KVAR (current_kboard
, echo_string
)))
518 if (!current_kboard
->immediate_echo
519 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
522 /* Do nothing if we just printed a prompt. */
523 if (STRINGP (KVAR (current_kboard
, echo_prompt
))
524 && (SCHARS (KVAR (current_kboard
, echo_prompt
))
525 == SCHARS (KVAR (current_kboard
, echo_string
))))
528 /* Do nothing if we have already put a dash at the end. */
529 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
531 Lisp_Object last_char
, prev_char
, idx
;
533 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
534 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
536 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
537 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
539 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
543 /* Put a dash at the end of the buffer temporarily,
544 but make it go away when the next character is added. */
545 AUTO_STRING (dash
, "-");
546 kset_echo_string (current_kboard
,
547 concat2 (KVAR (current_kboard
, echo_string
), dash
));
554 if (current_kboard
->immediate_echo
)
557 Lisp_Object prompt
= KVAR (current_kboard
, echo_prompt
);
558 Lisp_Object prefix
= call0 (Qinternal_echo_keystrokes_prefix
);
559 kset_echo_string (current_kboard
,
560 NILP (prompt
) ? prefix
561 : NILP (prefix
) ? prompt
562 : concat2 (prompt
, prefix
));
564 for (i
= 0; i
< this_command_key_count
; i
++)
568 c
= AREF (this_command_keys
, i
);
569 if (! (EVENT_HAS_PARAMETERS (c
)
570 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
578 /* Display the current echo string, and begin echoing if not already
584 if (!current_kboard
->immediate_echo
585 /* This test breaks calls that use `echo_now' to display the echo_prompt.
586 && echo_keystrokes_p () */)
588 current_kboard
->immediate_echo
= true;
590 /* Put a dash at the end to invite the user to type more. */
595 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
596 message3_nolog (KVAR (current_kboard
, echo_string
));
599 /* Record in what buffer we echoed, and from which kboard. */
600 echo_message_buffer
= echo_area_buffer
[0];
601 echo_kboard
= current_kboard
;
603 if (waiting_for_input
&& !NILP (Vquit_flag
))
604 quit_throw_to_read_char (0);
607 /* Turn off echoing, for the start of a new command. */
610 cancel_echoing (void)
612 current_kboard
->immediate_echo
= false;
613 kset_echo_prompt (current_kboard
, Qnil
);
614 kset_echo_string (current_kboard
, Qnil
);
615 ok_to_echo_at_next_pause
= NULL
;
617 echo_message_buffer
= Qnil
;
620 /* Return the length of the current echo string. */
625 return (STRINGP (KVAR (current_kboard
, echo_string
))
626 ? SCHARS (KVAR (current_kboard
, echo_string
))
630 /* Truncate the current echo message to its first LEN chars.
631 This and echo_char get used by read_key_sequence when the user
632 switches frames while entering a key sequence. */
635 echo_truncate (ptrdiff_t nchars
)
637 if (STRINGP (KVAR (current_kboard
, echo_string
)))
638 kset_echo_string (current_kboard
,
639 Fsubstring (KVAR (current_kboard
, echo_string
),
640 make_number (0), make_number (nchars
)));
641 truncate_echo_area (nchars
);
645 /* Functions for manipulating this_command_keys. */
647 add_command_key (Lisp_Object key
)
649 if (this_command_key_count
>= ASIZE (this_command_keys
))
650 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
652 ASET (this_command_keys
, this_command_key_count
, key
);
653 ++this_command_key_count
;
658 recursive_edit_1 (void)
660 ptrdiff_t count
= SPECPDL_INDEX ();
663 if (command_loop_level
> 0)
665 specbind (Qstandard_output
, Qt
);
666 specbind (Qstandard_input
, Qt
);
669 #ifdef HAVE_WINDOW_SYSTEM
670 /* The command loop has started an hourglass timer, so we have to
671 cancel it here, otherwise it will fire because the recursive edit
672 can take some time. Do not check for display_hourglass_p here,
673 because it could already be nil. */
677 /* This function may have been called from a debugger called from
678 within redisplay, for instance by Edebugging a function called
679 from fontification-functions. We want to allow redisplay in
680 the debugging session.
682 The recursive edit is left with a `(throw exit ...)'. The `exit'
683 tag is not caught anywhere in redisplay, i.e. when we leave the
684 recursive edit, the original redisplay leading to the recursive
685 edit will be unwound. The outcome should therefore be safe. */
686 specbind (Qinhibit_redisplay
, Qnil
);
689 /* This variable stores buffers that have changed so that an undo
690 boundary can be added. specbind this so that changes in the
691 recursive edit will not result in undo boundaries in buffers
692 changed before we entered there recursive edit.
695 specbind (Qundo_auto__undoably_changed_buffers
, Qnil
);
697 val
= command_loop ();
699 Fsignal (Qquit
, Qnil
);
700 /* Handle throw from read_minibuf when using minibuffer
701 while it's active but we're in another window. */
703 xsignal1 (Qerror
, val
);
705 return unbind_to (count
, Qnil
);
708 /* When an auto-save happens, record the "time", and don't do again soon. */
711 record_auto_save (void)
713 last_auto_save
= num_nonmacro_input_events
;
716 /* Make an auto save happen as soon as possible at command level. */
720 force_auto_save_soon (void)
722 last_auto_save
= - auto_save_interval
- 1;
724 record_asynch_buffer_change ();
728 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
729 doc
: /* Invoke the editor command loop recursively.
730 To get out of the recursive edit, a command can throw to `exit' -- for
731 instance (throw \\='exit nil).
732 If you throw a value other than t, `recursive-edit' returns normally
733 to the function that called it. Throwing a t value causes
734 `recursive-edit' to quit, so that control returns to the command loop
737 This function is called by the editor initialization to begin editing. */)
740 ptrdiff_t count
= SPECPDL_INDEX ();
743 /* If we enter while input is blocked, don't lock up here.
744 This may happen through the debugger during redisplay. */
745 if (input_blocked_p ())
748 if (command_loop_level
>= 0
749 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
750 buffer
= Fcurrent_buffer ();
754 /* Don't do anything interesting between the increment and the
755 record_unwind_protect! Otherwise, we could get distracted and
756 never decrement the counter again. */
757 command_loop_level
++;
758 update_mode_lines
= 17;
759 record_unwind_protect (recursive_edit_unwind
, buffer
);
761 /* If we leave recursive_edit_1 below with a `throw' for instance,
762 like it is done in the splash screen display, we have to
763 make sure that we restore single_kboard as command_loop_1
764 would have done if it were left normally. */
765 if (command_loop_level
> 0)
766 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
769 return unbind_to (count
, Qnil
);
773 recursive_edit_unwind (Lisp_Object buffer
)
775 if (BUFFERP (buffer
))
776 Fset_buffer (buffer
);
778 command_loop_level
--;
779 update_mode_lines
= 18;
783 #if 0 /* These two functions are now replaced with
784 temporarily_switch_to_single_kboard. */
788 #if 0 /* Theory: if there's anything in Vunread_command_events,
789 it will right away be read by read_key_sequence,
790 and then if we do switch KBOARDS, it will go into the side
791 queue then. So we don't need to do anything special here -- rms. */
792 if (CONSP (Vunread_command_events
))
794 current_kboard
->kbd_queue
795 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
796 current_kboard
->kbd_queue_has_data
= true;
798 Vunread_command_events
= Qnil
;
800 single_kboard
= false;
803 /* Switch to the single-kboard state, making current_kboard
804 the only KBOARD from which further input is accepted. */
807 single_kboard_state ()
809 single_kboard
= true;
813 /* If we're in single_kboard state for kboard KBOARD,
817 not_single_kboard_state (KBOARD
*kboard
)
819 if (kboard
== current_kboard
)
820 single_kboard
= false;
823 /* Maintain a stack of kboards, so other parts of Emacs
824 can switch temporarily to the kboard of a given frame
825 and then revert to the previous status. */
830 struct kboard_stack
*next
;
833 static struct kboard_stack
*kboard_stack
;
836 push_kboard (struct kboard
*k
)
838 struct kboard_stack
*p
= xmalloc (sizeof *p
);
840 p
->next
= kboard_stack
;
841 p
->kboard
= current_kboard
;
851 struct kboard_stack
*p
= kboard_stack
;
853 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
855 if (t
->kboard
== p
->kboard
)
857 current_kboard
= p
->kboard
;
864 /* The terminal we remembered has been deleted. */
865 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
866 single_kboard
= false;
868 kboard_stack
= p
->next
;
872 /* Switch to single_kboard mode, making current_kboard the only KBOARD
873 from which further input is accepted. If F is non-nil, set its
874 KBOARD as the current keyboard.
876 This function uses record_unwind_protect_int to return to the previous
879 If Emacs is already in single_kboard mode, and F's keyboard is
880 locked, then this function will throw an error. */
883 temporarily_switch_to_single_kboard (struct frame
*f
)
885 bool was_locked
= single_kboard
;
888 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
889 /* We can not switch keyboards while in single_kboard mode.
890 In rare cases, Lisp code may call `recursive-edit' (or
891 `read-minibuffer' or `y-or-n-p') after it switched to a
892 locked frame. For example, this is likely to happen
893 when server.el connects to a new terminal while Emacs is in
894 single_kboard mode. It is best to throw an error instead
895 of presenting the user with a frozen screen. */
896 error ("Terminal %d is locked, cannot read from it",
897 FRAME_TERMINAL (f
)->id
);
899 /* This call is unnecessary, but helps
900 `restore_kboard_configuration' discover if somebody changed
901 `current_kboard' behind our back. */
902 push_kboard (current_kboard
);
905 current_kboard
= FRAME_KBOARD (f
);
906 single_kboard
= true;
907 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
910 #if 0 /* This function is not needed anymore. */
912 record_single_kboard_state ()
915 push_kboard (current_kboard
);
916 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
921 restore_kboard_configuration (int was_locked
)
923 single_kboard
= was_locked
;
926 struct kboard
*prev
= current_kboard
;
928 /* The pop should not change the kboard. */
929 if (single_kboard
&& current_kboard
!= prev
)
935 /* Handle errors that are not handled at inner levels
936 by printing an error message and returning to the editor command loop. */
939 cmd_error (Lisp_Object data
)
941 Lisp_Object old_level
, old_length
;
942 char macroerror
[sizeof "After..kbd macro iterations: "
943 + INT_STRLEN_BOUND (EMACS_INT
)];
945 #ifdef HAVE_WINDOW_SYSTEM
946 if (display_hourglass_p
)
950 if (!NILP (executing_kbd_macro
))
952 if (executing_kbd_macro_iterations
== 1)
953 sprintf (macroerror
, "After 1 kbd macro iteration: ");
955 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
956 executing_kbd_macro_iterations
);
961 Vstandard_output
= Qt
;
962 Vstandard_input
= Qt
;
963 Vexecuting_kbd_macro
= Qnil
;
964 executing_kbd_macro
= Qnil
;
965 kset_prefix_arg (current_kboard
, Qnil
);
966 kset_last_prefix_arg (current_kboard
, Qnil
);
969 /* Avoid unquittable loop if data contains a circular list. */
970 old_level
= Vprint_level
;
971 old_length
= Vprint_length
;
972 XSETFASTINT (Vprint_level
, 10);
973 XSETFASTINT (Vprint_length
, 10);
974 cmd_error_internal (data
, macroerror
);
975 Vprint_level
= old_level
;
976 Vprint_length
= old_length
;
979 Vinhibit_quit
= Qnil
;
981 return make_number (0);
984 /* Take actions on handling an error. DATA is the data that describes
987 CONTEXT is a C-string containing ASCII characters only which
988 describes the context in which the error happened. If we need to
989 generalize CONTEXT to allow multibyte characters, make it a Lisp
993 cmd_error_internal (Lisp_Object data
, const char *context
)
995 /* The immediate context is not interesting for Quits,
996 since they are asynchronous. */
997 if (EQ (XCAR (data
), Qquit
))
998 Vsignaling_function
= Qnil
;
1003 /* Use user's specified output function if any. */
1004 if (!NILP (Vcommand_error_function
))
1005 call3 (Vcommand_error_function
, data
,
1006 context
? build_string (context
) : empty_unibyte_string
,
1007 Vsignaling_function
);
1009 Vsignaling_function
= Qnil
;
1012 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1013 Scommand_error_default_function
, 3, 3, 0,
1014 doc
: /* Produce default output for unhandled error message.
1015 Default value of `command-error-function'. */)
1016 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1018 struct frame
*sf
= SELECTED_FRAME ();
1020 CHECK_STRING (context
);
1022 /* If the window system or terminal frame hasn't been initialized
1023 yet, or we're not interactive, write the message to stderr and exit. */
1024 if (!sf
->glyphs_initialized_p
1025 /* The initial frame is a special non-displaying frame. It
1026 will be current in daemon mode when there are no frames
1027 to display, and in non-daemon mode before the real frame
1028 has finished initializing. If an error is thrown in the
1029 latter case while creating the frame, then the frame
1030 will never be displayed, so the safest thing to do is
1031 write to stderr and quit. In daemon mode, there are
1032 many other potential errors that do not prevent frames
1033 from being created, so continuing as normal is better in
1035 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1038 print_error_message (data
, Qexternal_debugging_output
,
1039 SSDATA (context
), signal
);
1040 Fterpri (Qexternal_debugging_output
, Qnil
);
1041 Fkill_emacs (make_number (-1));
1045 clear_message (1, 0);
1047 message_log_maybe_newline ();
1050 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1055 static Lisp_Object
command_loop_2 (Lisp_Object
);
1056 static Lisp_Object
top_level_1 (Lisp_Object
);
1058 /* Entry to editor-command-loop.
1059 This level has the catches for exiting/returning to editor command loop.
1060 It returns nil to exit recursive edit, t to abort it. */
1065 #ifdef HAVE_STACK_OVERFLOW_HANDLING
1066 /* At least on GNU/Linux, saving signal mask is important here. */
1067 if (sigsetjmp (return_to_command_loop
, 1) != 0)
1069 /* Comes here from handle_sigsegv (see sysdep.c) and
1070 stack_overflow_handler (see w32fns.c). */
1072 w32_reset_stack_overflow_guard ();
1075 Vinternal__top_level_message
= recover_top_level_message
;
1078 Vinternal__top_level_message
= regular_top_level_message
;
1079 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
1080 if (command_loop_level
> 0 || minibuf_level
> 0)
1083 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1084 executing_kbd_macro
= Qnil
;
1090 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1091 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1092 executing_kbd_macro
= Qnil
;
1094 /* End of file in -batch run causes exit here. */
1100 /* Here we catch errors in execution of commands within the
1101 editing loop, and reenter the editing loop.
1102 When there is an error, cmd_error runs and returns a non-nil
1103 value to us. A value of nil means that command_loop_1 itself
1104 returned due to end of file (or end of kbd macro). */
1107 command_loop_2 (Lisp_Object ignore
)
1109 register Lisp_Object val
;
1112 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1113 while (!NILP (val
));
1121 return Feval (Vtop_level
, Qnil
);
1125 top_level_1 (Lisp_Object ignore
)
1127 /* On entry to the outer level, run the startup file. */
1128 if (!NILP (Vtop_level
))
1129 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1130 else if (!NILP (Vpurify_flag
))
1131 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1133 message1 ("Bare Emacs (standard Lisp code not loaded)");
1137 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1138 doc
: /* Exit all recursive editing levels.
1139 This also exits all active minibuffers. */
1140 attributes
: noreturn
)
1143 #ifdef HAVE_WINDOW_SYSTEM
1144 if (display_hourglass_p
)
1145 cancel_hourglass ();
1148 /* Unblock input if we enter with input blocked. This may happen if
1149 redisplay traps e.g. during tool-bar update with input blocked. */
1150 totally_unblock_input ();
1152 Fthrow (Qtop_level
, Qnil
);
1155 static _Noreturn
void
1156 user_error (const char *msg
)
1158 xsignal1 (Quser_error
, build_string (msg
));
1161 /* _Noreturn will be added to prototype by make-docfile. */
1162 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1163 doc
: /* Exit from the innermost recursive edit or minibuffer. */
1164 attributes
: noreturn
)
1167 if (command_loop_level
> 0 || minibuf_level
> 0)
1168 Fthrow (Qexit
, Qnil
);
1170 user_error ("No recursive edit is in progress");
1173 /* _Noreturn will be added to prototype by make-docfile. */
1174 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1175 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */
1176 attributes
: noreturn
)
1179 if (command_loop_level
> 0 || minibuf_level
> 0)
1182 user_error ("No recursive edit is in progress");
1185 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1186 of this function. */
1189 tracking_off (Lisp_Object old_value
)
1191 do_mouse_tracking
= old_value
;
1192 if (NILP (old_value
))
1194 /* Redisplay may have been preempted because there was input
1195 available, and it assumes it will be called again after the
1196 input has been processed. If the only input available was
1197 the sort that we have just disabled, then we need to call
1199 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1201 redisplay_preserve_echo_area (6);
1202 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1207 DEFUN ("internal--track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1208 doc
: /* Call BODYFUN with mouse movement events enabled. */)
1209 (Lisp_Object bodyfun
)
1211 ptrdiff_t count
= SPECPDL_INDEX ();
1214 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1216 do_mouse_tracking
= Qt
;
1218 val
= call0 (bodyfun
);
1219 return unbind_to (count
, val
);
1222 /* If mouse has moved on some frame, return one of those frames.
1226 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1227 after resizing the tool-bar window. */
1229 bool ignore_mouse_drag_p
;
1231 static struct frame
*
1232 some_mouse_moved (void)
1234 Lisp_Object tail
, frame
;
1236 if (ignore_mouse_drag_p
)
1238 /* ignore_mouse_drag_p = 0; */
1242 FOR_EACH_FRAME (tail
, frame
)
1244 if (XFRAME (frame
)->mouse_moved
)
1245 return XFRAME (frame
);
1252 /* This is the actual command reading loop,
1253 sans error-handling encapsulation. */
1255 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1256 bool, bool, bool, bool);
1257 static void adjust_point_for_property (ptrdiff_t, bool);
1260 command_loop_1 (void)
1262 EMACS_INT prev_modiff
= 0;
1263 struct buffer
*prev_buffer
= NULL
;
1264 bool already_adjusted
= 0;
1266 kset_prefix_arg (current_kboard
, Qnil
);
1267 kset_last_prefix_arg (current_kboard
, Qnil
);
1268 Vdeactivate_mark
= Qnil
;
1269 waiting_for_input
= false;
1272 this_command_key_count
= 0;
1273 this_single_command_key_start
= 0;
1275 if (NILP (Vmemory_full
))
1277 /* Make sure this hook runs after commands that get errors and
1278 throw to top level. */
1279 /* Note that the value cell will never directly contain nil
1280 if the symbol is a local variable. */
1281 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1282 safe_run_hooks (Qpost_command_hook
);
1284 /* If displaying a message, resize the echo area window to fit
1285 that message's size exactly. */
1286 if (!NILP (echo_area_buffer
[0]))
1287 resize_echo_area_exactly ();
1289 /* If there are warnings waiting, process them. */
1290 if (!NILP (Vdelayed_warnings_list
))
1291 safe_run_hooks (Qdelayed_warnings_hook
);
1293 if (!NILP (Vdeferred_action_list
))
1294 safe_run_hooks (Qdeferred_action_function
);
1297 /* Do this after running Vpost_command_hook, for consistency. */
1298 kset_last_command (current_kboard
, Vthis_command
);
1299 kset_real_last_command (current_kboard
, Vreal_this_command
);
1300 if (!CONSP (last_command_event
))
1301 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1306 Lisp_Object keybuf
[30];
1309 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1312 /* Make sure the current window's buffer is selected. */
1313 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1315 /* Display any malloc warning that just came out. Use while because
1316 displaying one warning can cause another. */
1318 while (pending_malloc_warning
)
1319 display_malloc_warning ();
1321 Vdeactivate_mark
= Qnil
;
1323 /* Don't ignore mouse movements for more than a single command
1324 loop. (This flag is set in xdisp.c whenever the tool bar is
1325 resized, because the resize moves text up or down, and would
1326 generate false mouse drag events if we don't ignore them.) */
1327 ignore_mouse_drag_p
= 0;
1329 /* If minibuffer on and echo area in use,
1330 wait a short time and redraw minibuffer. */
1333 && !NILP (echo_area_buffer
[0])
1334 && EQ (minibuf_window
, echo_area_window
)
1335 && NUMBERP (Vminibuffer_message_timeout
))
1337 /* Bind inhibit-quit to t so that C-g gets read in
1338 rather than quitting back to the minibuffer. */
1339 ptrdiff_t count
= SPECPDL_INDEX ();
1340 specbind (Qinhibit_quit
, Qt
);
1342 sit_for (Vminibuffer_message_timeout
, 0, 2);
1344 /* Clear the echo area. */
1346 safe_run_hooks (Qecho_area_clear_hook
);
1348 unbind_to (count
, Qnil
);
1350 /* If a C-g came in before, treat it as input now. */
1351 if (!NILP (Vquit_flag
))
1354 Vunread_command_events
= list1 (make_number (quit_char
));
1358 /* If it has changed current-menubar from previous value,
1359 really recompute the menubar from the value. */
1360 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1361 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1362 call0 (Qrecompute_lucid_menubar
);
1364 Vthis_command
= Qnil
;
1365 Vreal_this_command
= Qnil
;
1366 Vthis_original_command
= Qnil
;
1367 Vthis_command_keys_shift_translated
= Qnil
;
1369 /* Read next key sequence; i gets its length. */
1370 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1373 /* A filter may have run while we were reading the input. */
1374 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1376 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1380 /* Now we have read a key sequence of length I,
1381 or else I is 0 and we found end of file. */
1383 if (i
== 0) /* End of file -- happens only in */
1384 return Qnil
; /* a kbd macro, at the end. */
1385 /* -1 means read_key_sequence got a menu that was rejected.
1386 Just loop around and read another command. */
1390 this_command_key_count
= 0;
1391 this_single_command_key_start
= 0;
1395 last_command_event
= keybuf
[i
- 1];
1397 /* If the previous command tried to force a specific window-start,
1398 forget about that, in case this command moves point far away
1399 from that position. But also throw away beg_unchanged and
1400 end_unchanged information in that case, so that redisplay will
1401 update the whole window properly. */
1402 if (XWINDOW (selected_window
)->force_start
)
1405 XWINDOW (selected_window
)->force_start
= 0;
1406 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1407 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1410 cmd
= read_key_sequence_cmd
;
1411 if (!NILP (Vexecuting_kbd_macro
))
1413 if (!NILP (Vquit_flag
))
1415 Vexecuting_kbd_macro
= Qt
;
1416 QUIT
; /* Make some noise. */
1417 /* Will return since macro now empty. */
1421 /* Do redisplay processing after this command except in special
1422 cases identified below. */
1423 prev_buffer
= current_buffer
;
1424 prev_modiff
= MODIFF
;
1425 last_point_position
= PT
;
1427 /* By default, we adjust point to a boundary of a region that
1428 has such a property that should be treated intangible
1429 (e.g. composition, display). But, some commands will set
1430 this variable differently. */
1431 Vdisable_point_adjustment
= Qnil
;
1433 /* Process filters and timers may have messed with deactivate-mark.
1434 reset it before we execute the command. */
1435 Vdeactivate_mark
= Qnil
;
1437 /* Remap command through active keymaps. */
1438 Vthis_original_command
= cmd
;
1439 if (!NILP (read_key_sequence_remapped
))
1440 cmd
= read_key_sequence_remapped
;
1442 /* Execute the command. */
1445 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
1446 ASET (recent_keys
, recent_keys_index
,
1448 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1449 recent_keys_index
= 0;
1451 Vthis_command
= cmd
;
1452 Vreal_this_command
= cmd
;
1453 safe_run_hooks (Qpre_command_hook
);
1455 already_adjusted
= 0;
1457 if (NILP (Vthis_command
))
1458 /* nil means key is undefined. */
1462 /* Here for a command that isn't executed directly. */
1464 #ifdef HAVE_WINDOW_SYSTEM
1465 ptrdiff_t scount
= SPECPDL_INDEX ();
1467 if (display_hourglass_p
1468 && NILP (Vexecuting_kbd_macro
))
1470 record_unwind_protect_void (cancel_hourglass
);
1475 /* Ensure that we have added appropriate undo-boundaries as a
1476 result of changes from the last command. */
1477 call0 (Qundo_auto__add_boundary
);
1479 /* Record point and buffer, so we can put point into the undo
1480 information if necessary. */
1481 point_before_last_command_or_undo
= PT
;
1482 buffer_before_last_command_or_undo
= current_buffer
;
1484 call1 (Qcommand_execute
, Vthis_command
);
1486 #ifdef HAVE_WINDOW_SYSTEM
1487 /* Do not check display_hourglass_p here, because
1488 `command-execute' could change it, but we should cancel
1489 hourglass cursor anyway.
1490 But don't cancel the hourglass within a macro
1491 just because a command in the macro finishes. */
1492 if (NILP (Vexecuting_kbd_macro
))
1493 unbind_to (scount
, Qnil
);
1496 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1498 safe_run_hooks (Qpost_command_hook
);
1500 /* If displaying a message, resize the echo area window to fit
1501 that message's size exactly. */
1502 if (!NILP (echo_area_buffer
[0]))
1503 resize_echo_area_exactly ();
1505 /* If there are warnings waiting, process them. */
1506 if (!NILP (Vdelayed_warnings_list
))
1507 safe_run_hooks (Qdelayed_warnings_hook
);
1509 safe_run_hooks (Qdeferred_action_function
);
1511 kset_last_command (current_kboard
, Vthis_command
);
1512 kset_real_last_command (current_kboard
, Vreal_this_command
);
1513 if (!CONSP (last_command_event
))
1514 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1516 this_command_key_count
= 0;
1517 this_single_command_key_start
= 0;
1519 if (current_kboard
->immediate_echo
1520 && !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
1522 current_kboard
->immediate_echo
= false;
1523 /* Refresh the echo message. */
1529 if (!NILP (BVAR (current_buffer
, mark_active
))
1530 && !NILP (Vrun_hooks
))
1532 /* In Emacs 22, setting transient-mark-mode to `only' was a
1533 way of turning it on for just one command. This usage is
1534 obsolete, but support it anyway. */
1535 if (EQ (Vtransient_mark_mode
, Qidentity
))
1536 Vtransient_mark_mode
= Qnil
;
1537 else if (EQ (Vtransient_mark_mode
, Qonly
))
1538 Vtransient_mark_mode
= Qidentity
;
1540 if (!NILP (Vdeactivate_mark
))
1541 /* If `select-active-regions' is non-nil, this call to
1542 `deactivate-mark' also sets the PRIMARY selection. */
1543 call0 (Qdeactivate_mark
);
1546 /* Even if not deactivating the mark, set PRIMARY if
1547 `select-active-regions' is non-nil. */
1548 if (!NILP (Fwindow_system (Qnil
))
1549 /* Even if mark_active is non-nil, the actual buffer
1550 marker may not have been set yet (Bug#7044). */
1551 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1552 && (EQ (Vselect_active_regions
, Qonly
)
1553 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1554 : (!NILP (Vselect_active_regions
)
1555 && !NILP (Vtransient_mark_mode
)))
1556 && NILP (Fmemq (Vthis_command
,
1557 Vselection_inhibit_update_commands
)))
1560 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1561 if (XINT (Flength (txt
)) > 0)
1562 /* Don't set empty selections. */
1563 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1566 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1567 run_hook (intern ("activate-mark-hook"));
1570 Vsaved_region_selection
= Qnil
;
1575 if (current_buffer
== prev_buffer
1576 && XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
1577 && last_point_position
!= PT
1578 && NILP (Vdisable_point_adjustment
)
1579 && NILP (Vglobal_disable_point_adjustment
))
1581 if (last_point_position
> BEGV
1582 && last_point_position
< ZV
1583 && (composition_adjust_point (last_point_position
,
1584 last_point_position
)
1585 != last_point_position
))
1586 /* The last point was temporarily set within a grapheme
1587 cluster to prevent automatic composition. To recover
1588 the automatic composition, we must update the
1590 windows_or_buffers_changed
= 21;
1591 if (!already_adjusted
)
1592 adjust_point_for_property (last_point_position
,
1593 MODIFF
!= prev_modiff
);
1596 /* Install chars successfully executed in kbd macro. */
1598 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1599 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1600 finalize_kbd_macro_chars ();
1605 read_menu_command (void)
1607 Lisp_Object keybuf
[30];
1608 ptrdiff_t count
= SPECPDL_INDEX ();
1611 /* We don't want to echo the keystrokes while navigating the
1613 specbind (Qecho_keystrokes
, make_number (0));
1615 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1618 unbind_to (count
, Qnil
);
1620 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1622 if (i
== 0 || i
== -1)
1625 return read_key_sequence_cmd
;
1628 /* Adjust point to a boundary of a region that has such a property
1629 that should be treated intangible. For the moment, we check
1630 `composition', `display' and `invisible' properties.
1631 LAST_PT is the last position of point. */
1634 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1637 Lisp_Object val
, overlay
, tmp
;
1638 /* When called after buffer modification, we should temporarily
1639 suppress the point adjustment for automatic composition so that a
1640 user can keep inserting another character at point or keep
1641 deleting characters around point. */
1642 bool check_composition
= ! modified
;
1643 bool check_display
= true, check_invisible
= true;
1644 ptrdiff_t orig_pt
= PT
;
1646 eassert (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
);
1648 /* FIXME: cycling is probably not necessary because these properties
1649 can't be usefully combined anyway. */
1650 while (check_composition
|| check_display
|| check_invisible
)
1652 /* FIXME: check `intangible'. */
1653 if (check_composition
1654 && PT
> BEGV
&& PT
< ZV
1655 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1658 check_display
= check_invisible
= true;
1660 check_composition
= false;
1662 && PT
> BEGV
&& PT
< ZV
1663 && !NILP (val
= get_char_property_and_overlay
1664 (make_number (PT
), Qdisplay
, selected_window
,
1666 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1667 && (!OVERLAYP (overlay
)
1668 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1669 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1670 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1671 && (beg
< PT
/* && end > PT <- It's always the case. */
1672 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1675 SET_PT (PT
< last_pt
1676 ? (STRINGP (val
) && SCHARS (val
) == 0
1677 ? max (beg
- 1, BEGV
)
1680 check_composition
= check_invisible
= true;
1682 check_display
= false;
1683 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1686 bool ellipsis
= false;
1689 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1692 /* FIXME: We should stop if we find a spot between
1693 two runs of `invisible' where inserted text would
1694 be visible. This is important when we have two
1695 invisible boundaries that enclose an area: if the
1696 area is empty, we need this test in order to make
1697 it possible to place point in the middle rather
1698 than skip both boundaries. However, this code
1699 also stops anywhere in a non-sticky text-property,
1700 which breaks (e.g.) Org mode. */
1701 && (val
= Fget_pos_property (make_number (end
),
1703 TEXT_PROP_MEANS_INVISIBLE (val
))
1705 && !NILP (val
= get_char_property_and_overlay
1706 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1707 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1709 ellipsis
= ellipsis
|| inv
> 1
1710 || (OVERLAYP (overlay
)
1711 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1712 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1713 tmp
= Fnext_single_char_property_change
1714 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1715 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1719 && (val
= Fget_pos_property (make_number (beg
),
1721 TEXT_PROP_MEANS_INVISIBLE (val
))
1723 && !NILP (val
= get_char_property_and_overlay
1724 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1725 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1727 ellipsis
= ellipsis
|| inv
> 1
1728 || (OVERLAYP (overlay
)
1729 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1730 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1731 tmp
= Fprevious_single_char_property_change
1732 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1733 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1736 /* Move away from the inside area. */
1737 if (beg
< PT
&& end
> PT
)
1739 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1740 /* We haven't moved yet (so we don't need to fear
1741 infinite-looping) and we were outside the range
1742 before (so either end of the range still corresponds
1743 to a move in the right direction): pretend we moved
1744 less than we actually did, so that we still have
1745 more freedom below in choosing which end of the range
1747 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1748 /* We either have moved already or the last point
1749 was already in the range: we don't get to choose
1750 which end of the range we have to go to. */
1751 : (PT
< last_pt
? beg
: end
));
1752 check_composition
= check_display
= true;
1754 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1755 the point to something other than its argument, due to
1756 point-motion hooks, intangibility, etc. */
1757 eassert (PT
== beg
|| PT
== end
);
1760 /* Pretend the area doesn't exist if the buffer is not
1762 if (!modified
&& !ellipsis
&& beg
< end
)
1764 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1765 (check_composition
= check_display
= true, SET_PT (end
+ 1));
1766 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1767 (check_composition
= check_display
= true, SET_PT (beg
- 1));
1768 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1769 /* We've already moved as far as we can. Trying to go
1770 to the other end would mean moving backwards and thus
1771 could lead to an infinite loop. */
1773 else if (val
= Fget_pos_property (make_number (PT
),
1775 TEXT_PROP_MEANS_INVISIBLE (val
)
1776 && (val
= (Fget_pos_property
1777 (make_number (PT
== beg
? end
: beg
),
1779 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1780 (check_composition
= check_display
= true,
1781 SET_PT (PT
== beg
? end
: beg
));
1784 check_invisible
= false;
1788 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1791 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1793 eassert (nargs
== 2);
1794 return call0 (args
[1]);
1797 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1801 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1803 eassert (nargs
== 2);
1804 AUTO_STRING (format
, "Error in %s (%S): %S");
1805 Lisp_Object hook
= args
[0];
1806 Lisp_Object fun
= args
[1];
1807 CALLN (Fmessage
, format
, hook
, fun
, error
);
1813 Lisp_Object newval
= Qnil
;
1814 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1815 if (EQ (fun
, XCAR (val
)))
1818 newval
= Fcons (XCAR (val
), newval
);
1820 return Fset (hook
, Fnreverse (newval
));
1821 /* Not found in the local part of the hook. Let's look at the global
1824 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1825 : Fdefault_value (hook
));
1826 CONSP (val
); val
= XCDR (val
))
1827 if (EQ (fun
, XCAR (val
)))
1830 newval
= Fcons (XCAR (val
), newval
);
1832 return Fset_default (hook
, Fnreverse (newval
));
1838 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1840 eassert (nargs
== 2);
1841 /* Yes, run_hook_with_args works with args in the other order. */
1842 internal_condition_case_n (safe_run_hooks_1
,
1843 2, ((Lisp_Object
[]) {args
[1], args
[0]}),
1844 Qt
, safe_run_hooks_error
);
1848 /* If we get an error while running the hook, cause the hook variable
1849 to be nil. Also inhibit quits, so that C-g won't cause the hook
1850 to mysteriously evaporate. */
1853 safe_run_hooks (Lisp_Object hook
)
1855 ptrdiff_t count
= SPECPDL_INDEX ();
1857 specbind (Qinhibit_quit
, Qt
);
1858 run_hook_with_args (2, ((Lisp_Object
[]) {hook
, hook
}), safe_run_hook_funcall
);
1859 unbind_to (count
, Qnil
);
1863 /* Nonzero means polling for input is temporarily suppressed. */
1865 int poll_suppress_count
;
1868 #ifdef POLL_FOR_INPUT
1870 /* Asynchronous timer for polling. */
1872 static struct atimer
*poll_timer
;
1874 /* Poll for input, so that we catch a C-g if it comes in. */
1876 poll_for_input_1 (void)
1878 if (! input_blocked_p ()
1879 && !waiting_for_input
)
1883 /* Timer callback function for poll_timer. TIMER is equal to
1887 poll_for_input (struct atimer
*timer
)
1889 if (poll_suppress_count
== 0)
1890 pending_signals
= true;
1893 #endif /* POLL_FOR_INPUT */
1895 /* Begin signals to poll for input, if they are appropriate.
1896 This function is called unconditionally from various places. */
1899 start_polling (void)
1901 #ifdef POLL_FOR_INPUT
1902 /* XXX This condition was (read_socket_hook && !interrupt_input),
1903 but read_socket_hook is not global anymore. Let's pretend that
1905 if (!interrupt_input
)
1907 /* Turn alarm handling on unconditionally. It might have
1908 been turned off in process.c. */
1909 turn_on_atimers (1);
1911 /* If poll timer doesn't exist, or we need one with
1912 a different interval, start a new one. */
1913 if (poll_timer
== NULL
1914 || poll_timer
->interval
.tv_sec
!= polling_period
)
1916 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1917 struct timespec interval
= make_timespec (period
, 0);
1920 cancel_atimer (poll_timer
);
1922 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1923 poll_for_input
, NULL
);
1926 /* Let the timer's callback function poll for input
1927 if this becomes zero. */
1928 --poll_suppress_count
;
1933 /* True if we are using polling to handle input asynchronously. */
1936 input_polling_used (void)
1938 #ifdef POLL_FOR_INPUT
1939 /* XXX This condition was (read_socket_hook && !interrupt_input),
1940 but read_socket_hook is not global anymore. Let's pretend that
1942 return !interrupt_input
;
1948 /* Turn off polling. */
1953 #ifdef POLL_FOR_INPUT
1954 /* XXX This condition was (read_socket_hook && !interrupt_input),
1955 but read_socket_hook is not global anymore. Let's pretend that
1957 if (!interrupt_input
)
1958 ++poll_suppress_count
;
1962 /* Set the value of poll_suppress_count to COUNT
1963 and start or stop polling accordingly. */
1966 set_poll_suppress_count (int count
)
1968 #ifdef POLL_FOR_INPUT
1969 if (count
== 0 && poll_suppress_count
!= 0)
1971 poll_suppress_count
= 1;
1974 else if (count
!= 0 && poll_suppress_count
== 0)
1978 poll_suppress_count
= count
;
1982 /* Bind polling_period to a value at least N.
1983 But don't decrease it. */
1986 bind_polling_period (int n
)
1988 #ifdef POLL_FOR_INPUT
1989 EMACS_INT
new = polling_period
;
1994 stop_other_atimers (poll_timer
);
1996 specbind (Qpolling_period
, make_number (new));
1997 /* Start a new alarm with the new period. */
2002 /* Apply the control modifier to CHARACTER. */
2005 make_ctrl_char (int c
)
2007 /* Save the upper bits here. */
2008 int upper
= c
& ~0177;
2010 if (! ASCII_CHAR_P (c
))
2011 return c
|= ctrl_modifier
;
2015 /* Everything in the columns containing the upper-case letters
2016 denotes a control character. */
2017 if (c
>= 0100 && c
< 0140)
2021 /* Set the shift modifier for a control char
2022 made from a shifted letter. But only for letters! */
2023 if (oc
>= 'A' && oc
<= 'Z')
2024 c
|= shift_modifier
;
2027 /* The lower-case letters denote control characters too. */
2028 else if (c
>= 'a' && c
<= 'z')
2031 /* Include the bits for control and shift
2032 only if the basic ASCII code can't indicate them. */
2036 /* Replace the high bits. */
2037 c
|= (upper
& ~ctrl_modifier
);
2042 /* Display the help-echo property of the character after the mouse pointer.
2043 Either show it in the echo area, or call show-help-function to display
2044 it by other means (maybe in a tooltip).
2046 If HELP is nil, that means clear the previous help echo.
2048 If HELP is a string, display that string. If HELP is a function,
2049 call it with OBJECT and POS as arguments; the function should
2050 return a help string or nil for none. For all other types of HELP,
2051 evaluate it to obtain a string.
2053 WINDOW is the window in which the help was generated, if any.
2054 It is nil if not in a window.
2056 If OBJECT is a buffer, POS is the position in the buffer where the
2057 `help-echo' text property was found.
2059 If OBJECT is an overlay, that overlay has a `help-echo' property,
2060 and POS is the position in the overlay's buffer under the mouse.
2062 If OBJECT is a string (an overlay string or a string displayed with
2063 the `display' property). POS is the position in that string under
2066 Note: this function may only be called with HELP nil or a string
2067 from X code running asynchronously. */
2070 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2073 if (!NILP (help
) && !STRINGP (help
))
2075 if (FUNCTIONP (help
))
2076 help
= safe_call (4, help
, window
, object
, pos
);
2078 help
= safe_eval (help
);
2080 if (!STRINGP (help
))
2084 if (!noninteractive
&& STRINGP (help
))
2086 /* The mouse-fixup-help-message Lisp function can call
2087 mouse_position_hook, which resets the mouse_moved flags.
2088 This causes trouble if we are trying to read a mouse motion
2089 event (i.e., if we are inside a `track-mouse' form), so we
2090 restore the mouse_moved flag. */
2091 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2092 help
= call1 (Qmouse_fixup_help_message
, help
);
2094 f
->mouse_moved
= true;
2097 if (STRINGP (help
) || NILP (help
))
2099 if (!NILP (Vshow_help_function
))
2100 call1 (Vshow_help_function
, Fsubstitute_command_keys (help
));
2101 help_echo_showing_p
= STRINGP (help
);
2107 /* Input of single characters from keyboard. */
2109 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2110 struct timespec
*end_time
);
2111 static void record_char (Lisp_Object c
);
2113 static Lisp_Object help_form_saved_window_configs
;
2115 read_char_help_form_unwind (void)
2117 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2118 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2119 if (!NILP (window_config
))
2120 Fset_window_configuration (window_config
);
2123 #define STOP_POLLING \
2124 do { if (! polling_stopped_here) stop_polling (); \
2125 polling_stopped_here = true; } while (0)
2127 #define RESUME_POLLING \
2128 do { if (polling_stopped_here) start_polling (); \
2129 polling_stopped_here = false; } while (0)
2132 read_event_from_main_queue (struct timespec
*end_time
,
2133 sys_jmp_buf local_getcjmp
,
2134 bool *used_mouse_menu
)
2136 Lisp_Object c
= Qnil
;
2137 sys_jmp_buf save_jump
;
2138 KBOARD
*kb
IF_LINT (= NULL
);
2142 /* Read from the main queue, and if that gives us something we can't use yet,
2143 we put it on the appropriate side queue and try again. */
2145 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2148 /* Actually read a character, waiting if necessary. */
2149 save_getcjmp (save_jump
);
2150 restore_getcjmp (local_getcjmp
);
2152 timer_start_idle ();
2153 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2154 restore_getcjmp (save_jump
);
2156 if (! NILP (c
) && (kb
!= current_kboard
))
2158 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2161 while (CONSP (XCDR (last
)))
2163 if (!NILP (XCDR (last
)))
2167 kset_kbd_queue (kb
, list1 (c
));
2169 XSETCDR (last
, list1 (c
));
2170 kb
->kbd_queue_has_data
= true;
2174 current_kboard
= kb
;
2175 return make_number (-2);
2178 /* Terminate Emacs in batch mode if at eof. */
2179 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2180 Fkill_emacs (make_number (1));
2184 /* Add in any extra modifiers, where appropriate. */
2185 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2186 || ((extra_keyboard_modifiers
& 0177) < ' '
2187 && (extra_keyboard_modifiers
& 0177) != 0))
2188 XSETINT (c
, make_ctrl_char (XINT (c
)));
2190 /* Transfer any other modifier bits directly from
2191 extra_keyboard_modifiers to c. Ignore the actual character code
2192 in the low 16 bits of extra_keyboard_modifiers. */
2193 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2201 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2204 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2205 sys_jmp_buf local_getcjmp
,
2206 Lisp_Object prev_event
,
2207 bool *used_mouse_menu
)
2209 #define MAX_ENCODED_BYTES 16
2211 Lisp_Object events
[MAX_ENCODED_BYTES
];
2217 = read_event_from_main_queue (end_time
, local_getcjmp
,
2220 /* w32_console already returns decoded events. It either reads
2221 Unicode characters from the Windows keyboard input, or
2222 converts characters encoded in the current codepage into
2223 Unicode. See w32inevt.c:key_event, near its end. */
2226 struct frame
*frame
= XFRAME (selected_frame
);
2227 struct terminal
*terminal
= frame
->terminal
;
2228 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2229 /* Don't apply decoding if we're just reading a raw event
2230 (e.g. reading bytes sent by the xterm to specify the position
2231 of a mouse click). */
2232 && (!EQ (prev_event
, Qt
))
2233 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2234 & CODING_REQUIRE_DECODING_MASK
)))
2235 return nextevt
; /* No decoding needed. */
2238 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2239 eassert (n
< MAX_ENCODED_BYTES
);
2240 events
[n
++] = nextevt
;
2241 if (NATNUMP (nextevt
)
2242 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2243 { /* An encoded byte sequence, let's try to decode it. */
2244 struct coding_system
*coding
2245 = TERMINAL_KEYBOARD_CODING (terminal
);
2247 if (raw_text_coding_system_p (coding
))
2251 for (i
= 0; i
< n
; i
++)
2252 events
[i
] = make_number (XINT (events
[i
]) & ~0x80);
2256 unsigned char src
[MAX_ENCODED_BYTES
];
2257 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2259 for (i
= 0; i
< n
; i
++)
2260 src
[i
] = XINT (events
[i
]);
2262 for (i
= 0; i
< n
; i
++)
2264 coding
->destination
= dest
;
2265 coding
->dst_bytes
= sizeof dest
;
2266 decode_coding_c_string (coding
, src
, n
, Qnil
);
2267 eassert (coding
->produced_char
<= n
);
2268 if (coding
->produced_char
== 0)
2269 { /* The encoded sequence is incomplete. */
2270 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2271 continue; /* Read on! */
2275 const unsigned char *p
= coding
->destination
;
2276 eassert (coding
->carryover_bytes
== 0);
2278 while (n
< coding
->produced_char
)
2279 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2283 /* Now `events' should hold decoded events.
2284 Normally, n should be equal to 1, but better not rely on it.
2285 We can only return one event here, so return the first we
2286 had and keep the others (if any) for later. */
2288 Vunread_command_events
2289 = Fcons (events
[--n
], Vunread_command_events
);
2296 /* Read a character from the keyboard; call the redisplay if needed. */
2297 /* commandflag 0 means do not autosave, but do redisplay.
2298 -1 means do not redisplay, but do autosave.
2299 -2 means do neither.
2302 The argument MAP is a keymap for menu prompting.
2304 PREV_EVENT is the previous input event, or nil if we are reading
2305 the first event of a key sequence (or not reading a key sequence).
2306 If PREV_EVENT is t, that is a "magic" value that says
2307 not to run input methods, but in other respects to act as if
2308 not reading a key sequence.
2310 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2311 if we used a mouse menu to read the input, or false otherwise. If
2312 USED_MOUSE_MENU is null, don't dereference it.
2314 Value is -2 when we find input on another keyboard. A second call
2315 to read_char will read it.
2317 If END_TIME is non-null, it is a pointer to a struct timespec
2318 specifying the maximum time to wait until. If no input arrives by
2319 that time, stop waiting and return nil.
2321 Value is t if we showed a menu and the user rejected it. */
2324 read_char (int commandflag
, Lisp_Object map
,
2325 Lisp_Object prev_event
,
2326 bool *used_mouse_menu
, struct timespec
*end_time
)
2330 sys_jmp_buf local_getcjmp
;
2331 sys_jmp_buf save_jump
;
2332 Lisp_Object tem
, save
;
2333 volatile Lisp_Object previous_echo_area_message
;
2334 volatile Lisp_Object also_record
;
2335 volatile bool reread
, recorded
;
2336 bool volatile polling_stopped_here
= false;
2337 struct kboard
*orig_kboard
= current_kboard
;
2342 previous_echo_area_message
= Qnil
;
2348 if (CONSP (Vunread_post_input_method_events
))
2350 c
= XCAR (Vunread_post_input_method_events
);
2351 Vunread_post_input_method_events
2352 = XCDR (Vunread_post_input_method_events
);
2354 /* Undo what read_char_x_menu_prompt did when it unread
2355 additional keys returned by Fx_popup_menu. */
2357 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2368 if (CONSP (Vunread_command_events
))
2370 bool was_disabled
= false;
2372 c
= XCAR (Vunread_command_events
);
2373 Vunread_command_events
= XCDR (Vunread_command_events
);
2375 /* Undo what sit-for did when it unread additional keys
2376 inside universal-argument. */
2378 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2383 /* Undo what read_char_x_menu_prompt did when it unread
2384 additional keys returned by Fx_popup_menu. */
2386 && EQ (XCDR (c
), Qdisabled
)
2387 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2389 was_disabled
= true;
2393 /* If the queued event is something that used the mouse,
2394 set used_mouse_menu accordingly. */
2396 /* Also check was_disabled so last-nonmenu-event won't return
2397 a bad value when submenus are involved. (Bug#447) */
2398 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2399 *used_mouse_menu
= true;
2401 goto reread_for_input_method
;
2404 if (CONSP (Vunread_input_method_events
))
2406 c
= XCAR (Vunread_input_method_events
);
2407 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2409 /* Undo what read_char_x_menu_prompt did when it unread
2410 additional keys returned by Fx_popup_menu. */
2412 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2416 goto reread_for_input_method
;
2419 if (!NILP (Vexecuting_kbd_macro
))
2421 /* We set this to Qmacro; since that's not a frame, nobody will
2422 try to switch frames on us, and the selected window will
2425 Since this event came from a macro, it would be misleading to
2426 leave internal_last_event_frame set to wherever the last
2427 real event came from. Normally, a switch-frame event selects
2428 internal_last_event_frame after each command is read, but
2429 events read from a macro should never cause a new frame to be
2431 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2433 /* Exit the macro if we are at the end.
2434 Also, some things replace the macro with t
2435 to force an early exit. */
2436 if (EQ (Vexecuting_kbd_macro
, Qt
)
2437 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2443 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2444 if (STRINGP (Vexecuting_kbd_macro
)
2445 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2446 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2448 executing_kbd_macro_index
++;
2453 if (!NILP (unread_switch_frame
))
2455 c
= unread_switch_frame
;
2456 unread_switch_frame
= Qnil
;
2458 /* This event should make it into this_command_keys, and get echoed
2459 again, so we do not set `reread'. */
2463 /* If redisplay was requested. */
2464 if (commandflag
>= 0)
2466 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2468 /* If there is pending input, process any events which are not
2469 user-visible, such as X selection_request events. */
2471 || detect_input_pending_run_timers (0))
2472 swallow_events (false); /* May clear input_pending. */
2474 /* Redisplay if no pending input. */
2475 while (!(input_pending
2476 && (input_was_pending
|| !redisplay_dont_pause
)))
2478 input_was_pending
= input_pending
;
2479 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2480 redisplay_preserve_echo_area (5);
2485 /* Normal case: no input arrived during redisplay. */
2488 /* Input arrived and pre-empted redisplay.
2489 Process any events which are not user-visible. */
2490 swallow_events (false);
2491 /* If that cleared input_pending, try again to redisplay. */
2494 /* Prevent the redisplay we just did
2495 from messing up echoing of the input after the prompt. */
2496 if (commandflag
== 0 && echo_current
)
2497 echo_message_buffer
= echo_area_buffer
[0];
2501 /* Message turns off echoing unless more keystrokes turn it on again.
2503 The code in 20.x for the condition was
2505 1. echo_area_glyphs && *echo_area_glyphs
2506 2. && echo_area_glyphs != current_kboard->echobuf
2507 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2509 (1) means there's a current message displayed
2511 (2) means it's not the message from echoing from the current
2514 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2515 is set to a non-null value. This is done in read_char and it is
2516 set to echo_area_glyphs. That means
2517 ok_to_echo_at_next_pause is either null or
2518 current_kboard->echobuf with the appropriate current_kboard at
2521 So, condition (3) means in clear text ok_to_echo_at_next_pause
2522 must be either null, or the current message isn't from echoing at
2523 all, or it's from echoing from a different kboard than the
2526 if (/* There currently is something in the echo area. */
2527 !NILP (echo_area_buffer
[0])
2528 && (/* It's an echo from a different kboard. */
2529 echo_kboard
!= current_kboard
2530 /* Or we explicitly allow overwriting whatever there is. */
2531 || ok_to_echo_at_next_pause
== NULL
))
2536 /* Try reading a character via menu prompting in the minibuf.
2537 Try this before the sit-for, because the sit-for
2538 would do the wrong thing if we are supposed to do
2539 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2540 after a mouse event so don't try a minibuf menu. */
2542 if (KEYMAPP (map
) && INTERACTIVE
2543 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2544 /* Don't bring up a menu if we already have another event. */
2545 && !CONSP (Vunread_command_events
)
2546 && !detect_input_pending_run_timers (0))
2548 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2550 if (INTEGERP (c
) && XINT (c
) == -2)
2551 return c
; /* wrong_kboard_jmpbuf */
2557 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2558 We will do that below, temporarily for short sections of code,
2559 when appropriate. local_getcjmp must be in effect
2560 around any call to sit_for or kbd_buffer_get_event;
2561 it *must not* be in effect when we call redisplay. */
2563 jmpcount
= SPECPDL_INDEX ();
2564 if (sys_setjmp (local_getcjmp
))
2566 /* Handle quits while reading the keyboard. */
2567 /* We must have saved the outer value of getcjmp here,
2568 so restore it now. */
2569 restore_getcjmp (save_jump
);
2570 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2571 unbind_to (jmpcount
, Qnil
);
2572 XSETINT (c
, quit_char
);
2573 internal_last_event_frame
= selected_frame
;
2574 Vlast_event_frame
= internal_last_event_frame
;
2575 /* If we report the quit char as an event,
2576 don't do so more than once. */
2577 if (!NILP (Vinhibit_quit
))
2581 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2582 if (kb
!= current_kboard
)
2584 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2585 /* We shouldn't get here if we were in single-kboard mode! */
2590 while (CONSP (XCDR (last
)))
2592 if (!NILP (XCDR (last
)))
2596 kset_kbd_queue (kb
, list1 (c
));
2598 XSETCDR (last
, list1 (c
));
2599 kb
->kbd_queue_has_data
= true;
2600 current_kboard
= kb
;
2601 return make_number (-2); /* wrong_kboard_jmpbuf */
2607 /* Start idle timers if no time limit is supplied. We don't do it
2608 if a time limit is supplied to avoid an infinite recursion in the
2609 situation where an idle timer calls `sit-for'. */
2612 timer_start_idle ();
2614 /* If in middle of key sequence and minibuffer not active,
2615 start echoing if enough time elapses. */
2617 if (minibuf_level
== 0
2619 && !current_kboard
->immediate_echo
2620 && (this_command_key_count
> 0
2621 || !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
2623 && echo_keystrokes_p ()
2624 && (/* No message. */
2625 NILP (echo_area_buffer
[0])
2626 /* Or empty message. */
2627 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2628 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2629 /* Or already echoing from same kboard. */
2630 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2631 /* Or not echoing before and echoing allowed. */
2632 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2634 /* After a mouse event, start echoing right away.
2635 This is because we are probably about to display a menu,
2636 and we don't want to delay before doing so. */
2637 if (EVENT_HAS_PARAMETERS (prev_event
))
2643 save_getcjmp (save_jump
);
2644 restore_getcjmp (local_getcjmp
);
2645 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2646 restore_getcjmp (save_jump
);
2648 && ! CONSP (Vunread_command_events
))
2653 /* Maybe auto save due to number of keystrokes. */
2655 if (commandflag
!= 0 && commandflag
!= -2
2656 && auto_save_interval
> 0
2657 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2658 && !detect_input_pending_run_timers (0))
2660 Fdo_auto_save (Qnil
, Qnil
);
2661 /* Hooks can actually change some buffers in auto save. */
2665 /* Try reading using an X menu.
2666 This is never confused with reading using the minibuf
2667 because the recursive call of read_char in read_char_minibuf_menu_prompt
2668 does not pass on any keymaps. */
2670 if (KEYMAPP (map
) && INTERACTIVE
2671 && !NILP (prev_event
)
2672 && EVENT_HAS_PARAMETERS (prev_event
)
2673 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2674 && !EQ (XCAR (prev_event
), Qtool_bar
)
2675 /* Don't bring up a menu if we already have another event. */
2676 && !CONSP (Vunread_command_events
))
2678 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2680 /* Now that we have read an event, Emacs is not idle. */
2687 /* Maybe autosave and/or garbage collect due to idleness. */
2689 if (INTERACTIVE
&& NILP (c
))
2692 ptrdiff_t buffer_size
;
2694 /* Slow down auto saves logarithmically in size of current buffer,
2695 and garbage collect while we're at it. */
2696 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2697 last_non_minibuf_size
= Z
- BEG
;
2698 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2700 while (buffer_size
> 64)
2701 delay_level
++, buffer_size
-= buffer_size
>> 2;
2702 if (delay_level
< 4) delay_level
= 4;
2703 /* delay_level is 4 for files under around 50k, 7 at 100k,
2704 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2706 /* Auto save if enough time goes by without input. */
2707 if (commandflag
!= 0 && commandflag
!= -2
2708 && num_nonmacro_input_events
> last_auto_save
2709 && INTEGERP (Vauto_save_timeout
)
2710 && XINT (Vauto_save_timeout
) > 0)
2713 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2715 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2716 timeout
= delay_level
* timeout
/ 4;
2717 save_getcjmp (save_jump
);
2718 restore_getcjmp (local_getcjmp
);
2719 tem0
= sit_for (make_number (timeout
), 1, 1);
2720 restore_getcjmp (save_jump
);
2723 && ! CONSP (Vunread_command_events
))
2725 Fdo_auto_save (Qnil
, Qnil
);
2730 /* If there is still no input available, ask for GC. */
2731 if (!detect_input_pending_run_timers (0))
2735 /* Notify the caller if an autosave hook, or a timer, sentinel or
2736 filter in the sit_for calls above have changed the current
2737 kboard. This could happen if they use the minibuffer or start a
2738 recursive edit, like the fancy splash screen in server.el's
2739 filter. If this longjmp wasn't here, read_key_sequence would
2740 interpret the next key sequence using the wrong translation
2741 tables and function keymaps. */
2742 if (NILP (c
) && current_kboard
!= orig_kboard
)
2743 return make_number (-2); /* wrong_kboard_jmpbuf */
2745 /* If this has become non-nil here, it has been set by a timer
2746 or sentinel or filter. */
2747 if (CONSP (Vunread_command_events
))
2749 c
= XCAR (Vunread_command_events
);
2750 Vunread_command_events
= XCDR (Vunread_command_events
);
2752 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2758 /* Read something from current KBOARD's side queue, if possible. */
2762 if (current_kboard
->kbd_queue_has_data
)
2764 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2766 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2767 kset_kbd_queue (current_kboard
,
2768 XCDR (KVAR (current_kboard
, kbd_queue
)));
2769 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2770 current_kboard
->kbd_queue_has_data
= false;
2771 input_pending
= readable_events (0);
2772 if (EVENT_HAS_PARAMETERS (c
)
2773 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2774 internal_last_event_frame
= XCAR (XCDR (c
));
2775 Vlast_event_frame
= internal_last_event_frame
;
2779 /* If current_kboard's side queue is empty check the other kboards.
2780 If one of them has data that we have not yet seen here,
2781 switch to it and process the data waiting for it.
2783 Note: if the events queued up for another kboard
2784 have already been seen here, and therefore are not a complete command,
2785 the kbd_queue_has_data field is 0, so we skip that kboard here.
2786 That's to avoid an infinite loop switching between kboards here. */
2787 if (NILP (c
) && !single_kboard
)
2790 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2791 if (kb
->kbd_queue_has_data
)
2793 current_kboard
= kb
;
2794 return make_number (-2); /* wrong_kboard_jmpbuf */
2804 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2805 prev_event
, used_mouse_menu
);
2806 if (NILP (c
) && end_time
2807 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2812 if (EQ (c
, make_number (-2)))
2824 if (commandflag
>= 0
2825 && !input_pending
&& !detect_input_pending_run_timers (0))
2831 /* Buffer switch events are only for internal wakeups
2832 so don't show them to the user.
2833 Also, don't record a key if we already did. */
2837 /* Process special events within read_char
2838 and loop around to read another event. */
2841 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2846 struct buffer
*prev_buffer
= current_buffer
;
2847 last_input_event
= c
;
2848 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2850 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2851 /* We stopped being idle for this event; undo that. This
2852 prevents automatic window selection (under
2853 mouse-autoselect-window) from acting as a real input event, for
2854 example banishing the mouse under mouse-avoidance-mode. */
2855 timer_resume_idle ();
2857 if (current_buffer
!= prev_buffer
)
2859 /* The command may have changed the keymaps. Pretend there
2860 is input in another keyboard and return. This will
2861 recalculate keymaps. */
2862 c
= make_number (-2);
2869 /* Handle things that only apply to characters. */
2872 /* If kbd_buffer_get_event gave us an EOF, return that. */
2876 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2877 && UNSIGNED_CMP (XFASTINT (c
), <,
2878 SCHARS (KVAR (current_kboard
,
2879 Vkeyboard_translate_table
))))
2880 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2881 && UNSIGNED_CMP (XFASTINT (c
), <,
2882 ASIZE (KVAR (current_kboard
,
2883 Vkeyboard_translate_table
))))
2884 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2888 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2889 /* nil in keyboard-translate-table means no translation. */
2895 /* If this event is a mouse click in the menu bar,
2896 return just menu-bar for now. Modify the mouse click event
2897 so we won't do this twice, then queue it up. */
2898 if (EVENT_HAS_PARAMETERS (c
)
2900 && CONSP (EVENT_START (c
))
2901 && CONSP (XCDR (EVENT_START (c
))))
2905 posn
= POSN_POSN (EVENT_START (c
));
2906 /* Handle menu-bar events:
2907 insert the dummy prefix event `menu-bar'. */
2908 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2910 /* Change menu-bar to (menu-bar) as the event "position". */
2911 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2914 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2919 /* Store these characters into recent_keys, the dribble file if any,
2920 and the keyboard macro being defined, if any. */
2923 if (! NILP (also_record
))
2924 record_char (also_record
);
2926 /* Wipe the echo area.
2927 But first, if we are about to use an input method,
2928 save the echo area contents for it to refer to. */
2930 && ! NILP (Vinput_method_function
)
2931 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2933 previous_echo_area_message
= Fcurrent_message ();
2934 Vinput_method_previous_message
= previous_echo_area_message
;
2937 /* Now wipe the echo area, except for help events which do their
2938 own stuff with the echo area. */
2940 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2941 && !(EQ (Qswitch_frame
, XCAR (c
)))
2942 /* Don't wipe echo area for select window events: These might
2943 get delayed via `mouse-autoselect-window' (Bug#11304). */
2944 && !(EQ (Qselect_window
, XCAR (c
)))))
2946 if (!NILP (echo_area_buffer
[0]))
2948 safe_run_hooks (Qecho_area_clear_hook
);
2949 clear_message (1, 0);
2953 reread_for_input_method
:
2955 /* Pass this to the input method, if appropriate. */
2957 && ! NILP (Vinput_method_function
)
2958 /* Don't run the input method within a key sequence,
2959 after the first event of the key sequence. */
2960 && NILP (prev_event
)
2961 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2964 ptrdiff_t key_count
;
2965 ptrdiff_t command_key_start
;
2966 ptrdiff_t count
= SPECPDL_INDEX ();
2968 /* Save the echo status. */
2969 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2970 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2971 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2972 Lisp_Object saved_echo_prompt
= KVAR (current_kboard
, echo_prompt
);
2974 /* Save the this_command_keys status. */
2975 key_count
= this_command_key_count
;
2976 command_key_start
= this_single_command_key_start
;
2979 keys
= Fcopy_sequence (this_command_keys
);
2983 /* Clear out this_command_keys. */
2984 this_command_key_count
= 0;
2985 this_single_command_key_start
= 0;
2987 /* Now wipe the echo area. */
2988 if (!NILP (echo_area_buffer
[0]))
2989 safe_run_hooks (Qecho_area_clear_hook
);
2990 clear_message (1, 0);
2993 /* If we are not reading a key sequence,
2994 never use the echo area. */
2997 specbind (Qinput_method_use_echo_area
, Qt
);
3000 /* Call the input method. */
3001 tem
= call1 (Vinput_method_function
, c
);
3003 tem
= unbind_to (count
, tem
);
3005 /* Restore the saved echoing state
3006 and this_command_keys state. */
3007 this_command_key_count
= key_count
;
3008 this_single_command_key_start
= command_key_start
;
3010 this_command_keys
= keys
;
3013 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3014 kset_echo_string (current_kboard
, saved_echo_string
);
3015 kset_echo_prompt (current_kboard
, saved_echo_prompt
);
3016 if (saved_immediate_echo
)
3019 /* The input method can return no events. */
3022 /* Bring back the previous message, if any. */
3023 if (! NILP (previous_echo_area_message
))
3024 message_with_string ("%s", previous_echo_area_message
, 0);
3027 /* It returned one event or more. */
3029 Vunread_post_input_method_events
3030 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3032 /* When we consume events from the various unread-*-events lists, we
3033 bypass the code that records input, so record these events now if
3034 they were not recorded already. */
3043 /* Display help if not echoing. */
3044 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3046 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3047 Lisp_Object help
, object
, position
, window
, htem
;
3049 htem
= Fcdr (XCDR (c
));
3052 window
= Fcar (htem
);
3054 object
= Fcar (htem
);
3056 position
= Fcar (htem
);
3058 show_help_echo (help
, window
, object
, position
);
3060 /* We stopped being idle for this event; undo that. */
3062 timer_resume_idle ();
3066 if ((! reread
|| this_command_key_count
== 0)
3070 /* Don't echo mouse motion events. */
3071 if (! (EVENT_HAS_PARAMETERS (c
)
3072 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3073 /* Once we reread a character, echoing can happen
3074 the next time we pause to read a new one. */
3075 ok_to_echo_at_next_pause
= current_kboard
;
3077 /* Record this character as part of the current key. */
3078 add_command_key (c
);
3079 if (! NILP (also_record
))
3080 add_command_key (also_record
);
3085 last_input_event
= c
;
3088 /* Process the help character specially if enabled. */
3089 if (!NILP (Vhelp_form
) && help_char_p (c
))
3091 ptrdiff_t count
= SPECPDL_INDEX ();
3093 help_form_saved_window_configs
3094 = Fcons (Fcurrent_window_configuration (Qnil
),
3095 help_form_saved_window_configs
);
3096 record_unwind_protect_void (read_char_help_form_unwind
);
3097 call0 (Qhelp_form_show
);
3102 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3103 if (EVENT_HAS_PARAMETERS (c
)
3104 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3105 XSETCAR (help_form_saved_window_configs
, Qnil
);
3107 while (BUFFERP (c
));
3108 /* Remove the help from the frame. */
3109 unbind_to (count
, Qnil
);
3112 if (EQ (c
, make_number (040)))
3116 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3117 while (BUFFERP (c
));
3123 input_was_pending
= input_pending
;
3127 /* Record a key that came from a mouse menu.
3128 Record it for echoing, for this-command-keys, and so on. */
3131 record_menu_key (Lisp_Object c
)
3133 /* Wipe the echo area. */
3134 clear_message (1, 0);
3138 /* Once we reread a character, echoing can happen
3139 the next time we pause to read a new one. */
3140 ok_to_echo_at_next_pause
= NULL
;
3142 /* Record this character as part of the current key. */
3143 add_command_key (c
);
3146 /* Re-reading in the middle of a command. */
3147 last_input_event
= c
;
3151 /* Return true if should recognize C as "the help character". */
3154 help_char_p (Lisp_Object c
)
3158 if (EQ (c
, Vhelp_char
))
3160 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3161 if (EQ (c
, XCAR (tail
)))
3166 /* Record the input event C in various ways. */
3169 record_char (Lisp_Object c
)
3173 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3175 /* To avoid filling recent_keys with help-echo and mouse-movement
3176 events, we filter out repeated help-echo events, only store the
3177 first and last in a series of mouse-movement events, and don't
3178 store repeated help-echo events which are only separated by
3179 mouse-movement events. */
3181 Lisp_Object ev1
, ev2
, ev3
;
3184 if ((ix1
= recent_keys_index
- 1) < 0)
3185 ix1
= NUM_RECENT_KEYS
- 1;
3186 ev1
= AREF (recent_keys
, ix1
);
3188 if ((ix2
= ix1
- 1) < 0)
3189 ix2
= NUM_RECENT_KEYS
- 1;
3190 ev2
= AREF (recent_keys
, ix2
);
3192 if ((ix3
= ix2
- 1) < 0)
3193 ix3
= NUM_RECENT_KEYS
- 1;
3194 ev3
= AREF (recent_keys
, ix3
);
3196 if (EQ (XCAR (c
), Qhelp_echo
))
3198 /* Don't record `help-echo' in recent_keys unless it shows some help
3199 message, and a different help than the previously recorded
3201 Lisp_Object help
, last_help
;
3203 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3204 if (!STRINGP (help
))
3206 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3207 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3209 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3210 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3211 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3213 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3214 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3215 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3216 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3219 else if (EQ (XCAR (c
), Qmouse_movement
))
3221 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3222 So additional mouse movement events replace the last element. */
3223 Lisp_Object last_window
, window
;
3225 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3226 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3227 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3228 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3229 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3231 ASET (recent_keys
, ix1
, c
);
3237 store_kbd_macro_char (c
);
3239 /* recent_keys should not include events from keyboard macros. */
3240 if (NILP (Vexecuting_kbd_macro
))
3244 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3245 ASET (recent_keys
, recent_keys_index
, c
);
3246 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3247 recent_keys_index
= 0;
3249 else if (recorded
< 0)
3251 /* We need to remove one or two events from recent_keys.
3252 To do this, we simply put nil at those events and move the
3253 recent_keys_index backwards over those events. Usually,
3254 users will never see those nil events, as they will be
3255 overwritten by the command keys entered to see recent_keys
3258 while (recorded
++ < 0 && total_keys
> 0)
3260 if (total_keys
< NUM_RECENT_KEYS
)
3262 if (--recent_keys_index
< 0)
3263 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3264 ASET (recent_keys
, recent_keys_index
, Qnil
);
3268 num_nonmacro_input_events
++;
3271 /* Write c to the dribble file. If c is a lispy event, write
3272 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3273 If you, dear reader, have a better idea, you've got the source. :-) */
3279 if (XUINT (c
) < 0x100)
3280 putc (XUINT (c
), dribble
);
3282 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3286 Lisp_Object dribblee
;
3288 /* If it's a structured event, take the event header. */
3289 dribblee
= EVENT_HEAD (c
);
3291 if (SYMBOLP (dribblee
))
3293 putc ('<', dribble
);
3294 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3295 SBYTES (SYMBOL_NAME (dribblee
)),
3297 putc ('>', dribble
);
3306 /* Copy out or in the info on where C-g should throw to.
3307 This is used when running Lisp code from within get_char,
3308 in case get_char is called recursively.
3309 See read_process_output. */
3312 save_getcjmp (sys_jmp_buf temp
)
3314 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3318 restore_getcjmp (sys_jmp_buf temp
)
3320 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3323 /* Low level keyboard/mouse input.
3324 kbd_buffer_store_event places events in kbd_buffer, and
3325 kbd_buffer_get_event retrieves them. */
3327 /* Return true if there are any events in the queue that read-char
3328 would return. If this returns false, a read-char would block. */
3330 readable_events (int flags
)
3332 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3335 /* If the buffer contains only FOCUS_IN_EVENT events, and
3336 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3337 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3339 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3340 #ifdef USE_TOOLKIT_SCROLL_BARS
3341 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3345 union buffered_input_event
*event
= kbd_fetch_ptr
;
3349 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3352 #ifdef USE_TOOLKIT_SCROLL_BARS
3353 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3355 event
->kind
== FOCUS_IN_EVENT
)
3356 #ifdef USE_TOOLKIT_SCROLL_BARS
3357 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3358 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3359 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3360 && event
->ie
.part
== scroll_bar_handle
3361 && event
->ie
.modifiers
== 0)
3363 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3364 && event
->kind
== BUFFER_SWITCH_EVENT
))
3368 while (event
!= kbd_store_ptr
);
3374 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3375 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3379 if (current_kboard
->kbd_queue_has_data
)
3385 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3386 if (kb
->kbd_queue_has_data
)
3392 /* Set this for debugging, to have a way to get out */
3393 int stop_character EXTERNALLY_VISIBLE
;
3396 event_to_kboard (struct input_event
*event
)
3398 /* Not applicable for these special events. */
3399 if (event
->kind
== SELECTION_REQUEST_EVENT
3400 || event
->kind
== SELECTION_CLEAR_EVENT
)
3404 Lisp_Object obj
= event
->frame_or_window
;
3405 /* There are some events that set this field to nil or string. */
3407 obj
= WINDOW_FRAME (XWINDOW (obj
));
3408 /* Also ignore dead frames here. */
3409 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3410 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3415 /* Return the number of slots occupied in kbd_buffer. */
3418 kbd_buffer_nr_stored (void)
3420 return kbd_fetch_ptr
== kbd_store_ptr
3422 : (kbd_fetch_ptr
< kbd_store_ptr
3423 ? kbd_store_ptr
- kbd_fetch_ptr
3424 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3425 + (kbd_store_ptr
- kbd_buffer
)));
3427 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3430 kbd_buffer_store_event (register struct input_event
*event
)
3432 kbd_buffer_store_event_hold (event
, 0);
3435 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3437 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3438 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3439 Else, if EVENT is a quit event, store the quit event
3440 in HOLD_QUIT, and return (thus ignoring further events).
3442 This is used to postpone the processing of the quit event until all
3443 subsequent input events have been parsed (and discarded). */
3446 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3447 struct input_event
*hold_quit
)
3449 if (event
->kind
== NO_EVENT
)
3452 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3455 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3457 int c
= event
->ie
.code
& 0377;
3459 if (event
->ie
.modifiers
& ctrl_modifier
)
3460 c
= make_ctrl_char (c
);
3462 c
|= (event
->ie
.modifiers
3463 & (meta_modifier
| alt_modifier
3464 | hyper_modifier
| super_modifier
));
3468 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3470 if (single_kboard
&& kb
!= current_kboard
)
3473 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3475 kb
->kbd_queue_has_data
= true;
3476 union buffered_input_event
*sp
;
3477 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3479 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3482 if (event_to_kboard (&sp
->ie
) == kb
)
3484 sp
->ie
.kind
= NO_EVENT
;
3485 sp
->ie
.frame_or_window
= Qnil
;
3494 *hold_quit
= event
->ie
;
3498 /* If this results in a quit_char being returned to Emacs as
3499 input, set Vlast_event_frame properly. If this doesn't
3500 get returned to Emacs as an event, the next event read
3501 will set Vlast_event_frame again, so this is safe to do. */
3505 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3507 focus
= event
->ie
.frame_or_window
;
3508 internal_last_event_frame
= focus
;
3509 Vlast_event_frame
= focus
;
3512 handle_interrupt (0);
3516 if (c
&& c
== stop_character
)
3522 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3523 Just ignore the second one. */
3524 else if (event
->kind
== BUFFER_SWITCH_EVENT
3525 && kbd_fetch_ptr
!= kbd_store_ptr
3526 && ((kbd_store_ptr
== kbd_buffer
3527 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3528 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3531 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3532 kbd_store_ptr
= kbd_buffer
;
3534 /* Don't let the very last slot in the buffer become full,
3535 since that would make the two pointers equal,
3536 and that is indistinguishable from an empty buffer.
3537 Discard the event if it would fill the last slot. */
3538 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3540 *kbd_store_ptr
= *event
;
3543 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3544 && ! kbd_on_hold_p ())
3546 /* Don't read keyboard input until we have processed kbd_buffer.
3547 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3548 hold_keyboard_input ();
3552 #endif /* subprocesses */
3555 /* If we're inside while-no-input, and this event qualifies
3556 as input, set quit-flag to cause an interrupt. */
3557 if (!NILP (Vthrow_on_input
)
3558 && event
->kind
!= FOCUS_IN_EVENT
3559 && event
->kind
!= FOCUS_OUT_EVENT
3560 && event
->kind
!= HELP_EVENT
3561 && event
->kind
!= ICONIFY_EVENT
3562 && event
->kind
!= DEICONIFY_EVENT
)
3564 Vquit_flag
= Vthrow_on_input
;
3565 /* If we're inside a function that wants immediate quits,
3567 if (immediate_quit
&& NILP (Vinhibit_quit
))
3569 immediate_quit
= false;
3578 /* Put a selection input event back in the head of the event queue. */
3581 kbd_buffer_unget_event (struct selection_input_event
*event
)
3583 if (kbd_fetch_ptr
== kbd_buffer
)
3584 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3586 /* Don't let the very last slot in the buffer become full, */
3587 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3588 if (kp
!= kbd_store_ptr
)
3597 /* Limit help event positions to this range, to avoid overflow problems. */
3598 #define INPUT_EVENT_POS_MAX \
3599 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3600 MOST_POSITIVE_FIXNUM)))
3601 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3603 /* Return a Time that encodes position POS. POS must be in range. */
3606 position_to_Time (ptrdiff_t pos
)
3608 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3612 /* Return the position that ENCODED_POS encodes.
3613 Avoid signed integer overflow. */
3616 Time_to_position (Time encoded_pos
)
3618 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3620 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3621 eassert (encoded_pos_min
<= encoded_pos
);
3622 ptrdiff_t notpos
= -1 - encoded_pos
;
3626 /* Generate a HELP_EVENT input_event and store it in the keyboard
3629 HELP is the help form.
3631 FRAME and WINDOW are the frame and window where the help is
3632 generated. OBJECT is the Lisp object where the help was found (a
3633 buffer, a string, an overlay, or nil if neither from a string nor
3634 from a buffer). POS is the position within OBJECT where the help
3638 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3639 Lisp_Object object
, ptrdiff_t pos
)
3641 struct input_event event
;
3643 event
.kind
= HELP_EVENT
;
3644 event
.frame_or_window
= frame
;
3646 event
.x
= WINDOWP (window
) ? window
: frame
;
3648 event
.timestamp
= position_to_Time (pos
);
3649 kbd_buffer_store_event (&event
);
3653 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3656 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3658 struct input_event event
;
3660 event
.kind
= HELP_EVENT
;
3661 event
.frame_or_window
= frame
;
3665 event
.timestamp
= 0;
3666 kbd_buffer_store_event (&event
);
3670 /* Discard any mouse events in the event buffer by setting them to
3673 discard_mouse_events (void)
3675 union buffered_input_event
*sp
;
3676 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3678 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3681 if (sp
->kind
== MOUSE_CLICK_EVENT
3682 || sp
->kind
== WHEEL_EVENT
3683 || sp
->kind
== HORIZ_WHEEL_EVENT
3685 || sp
->kind
== GPM_CLICK_EVENT
3687 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3688 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3690 sp
->kind
= NO_EVENT
;
3696 /* Return true if there are any real events waiting in the event
3697 buffer, not counting `NO_EVENT's.
3699 Discard NO_EVENT events at the front of the input queue, possibly
3700 leaving the input queue empty if there are no real input events. */
3703 kbd_buffer_events_waiting (void)
3705 union buffered_input_event
*sp
;
3707 for (sp
= kbd_fetch_ptr
;
3708 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3711 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3716 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3720 /* Clear input event EVENT. */
3723 clear_event (union buffered_input_event
*event
)
3725 event
->kind
= NO_EVENT
;
3729 /* Read one event from the event buffer, waiting if necessary.
3730 The value is a Lisp object representing the event.
3731 The value is nil for an event that should be ignored,
3732 or that was handled here.
3733 We always read and discard one event. */
3736 kbd_buffer_get_event (KBOARD
**kbp
,
3737 bool *used_mouse_menu
,
3738 struct timespec
*end_time
)
3743 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3745 /* Start reading input again because we have processed enough to
3746 be able to accept new events again. */
3747 unhold_keyboard_input ();
3751 #endif /* subprocesses */
3753 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3755 /* In case we are running as a daemon, only do this before
3756 detaching from the terminal. */
3757 || (IS_DAEMON
&& DAEMON_RUNNING
))
3761 *kbp
= current_kboard
;
3764 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3766 /* Wait until there is input available. */
3769 /* Break loop if there's an unread command event. Needed in
3770 moused window autoselection which uses a timer to insert such
3772 if (CONSP (Vunread_command_events
))
3775 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3777 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3780 /* If the quit flag is set, then read_char will return
3781 quit_char, so that counts as "available input." */
3782 if (!NILP (Vquit_flag
))
3783 quit_throw_to_read_char (0);
3785 /* One way or another, wait until input is available; then, if
3786 interrupt handlers have not read it, read it now. */
3791 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3793 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3797 struct timespec now
= current_timespec ();
3798 if (timespec_cmp (*end_time
, now
) <= 0)
3799 return Qnil
; /* Finished waiting. */
3802 struct timespec duration
= timespec_sub (*end_time
, now
);
3803 wait_reading_process_output (min (duration
.tv_sec
,
3806 -1, 1, Qnil
, NULL
, 0);
3811 bool do_display
= true;
3813 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3815 struct tty_display_info
*tty
= CURTTY ();
3817 /* When this TTY is displaying a menu, we must prevent
3818 any redisplay, because we modify the frame's glyph
3819 matrix behind the back of the display engine. */
3820 if (tty
->showing_menu
)
3824 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3827 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3831 if (CONSP (Vunread_command_events
))
3834 first
= XCAR (Vunread_command_events
);
3835 Vunread_command_events
= XCDR (Vunread_command_events
);
3836 *kbp
= current_kboard
;
3840 /* At this point, we know that there is a readable event available
3841 somewhere. If the event queue is empty, then there must be a
3842 mouse movement enabled and available. */
3843 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3845 union buffered_input_event
*event
;
3847 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3851 *kbp
= event_to_kboard (&event
->ie
);
3853 *kbp
= current_kboard
; /* Better than returning null ptr? */
3857 /* These two kinds of events get special handling
3858 and don't actually appear to the command loop.
3859 We return nil for them. */
3860 if (event
->kind
== SELECTION_REQUEST_EVENT
3861 || event
->kind
== SELECTION_CLEAR_EVENT
)
3864 /* Remove it from the buffer before processing it,
3865 since otherwise swallow_events will see it
3866 and process it again. */
3867 struct selection_input_event copy
= event
->sie
;
3868 kbd_fetch_ptr
= event
+ 1;
3869 input_pending
= readable_events (0);
3870 x_handle_selection_event (©
);
3872 /* We're getting selection request events, but we don't have
3878 #if defined (HAVE_NS)
3879 else if (event
->kind
== NS_TEXT_EVENT
)
3881 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3882 obj
= list1 (intern ("ns-put-working-text"));
3884 obj
= list1 (intern ("ns-unput-working-text"));
3885 kbd_fetch_ptr
= event
+ 1;
3886 if (used_mouse_menu
)
3887 *used_mouse_menu
= true;
3891 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3892 || defined (HAVE_NS)
3893 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3895 /* Make an event (delete-frame (FRAME)). */
3896 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
3897 kbd_fetch_ptr
= event
+ 1;
3900 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3901 || defined (HAVE_NS)
3902 else if (event
->kind
== ICONIFY_EVENT
)
3904 /* Make an event (iconify-frame (FRAME)). */
3905 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
3906 kbd_fetch_ptr
= event
+ 1;
3908 else if (event
->kind
== DEICONIFY_EVENT
)
3910 /* Make an event (make-frame-visible (FRAME)). */
3911 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
3912 kbd_fetch_ptr
= event
+ 1;
3915 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3917 /* The value doesn't matter here; only the type is tested. */
3918 XSETBUFFER (obj
, current_buffer
);
3919 kbd_fetch_ptr
= event
+ 1;
3921 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3922 || defined (HAVE_NS) || defined (USE_GTK)
3923 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3925 kbd_fetch_ptr
= event
+ 1;
3926 input_pending
= readable_events (0);
3927 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
3928 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
3932 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3934 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3935 obj
= list4 (Qlanguage_change
,
3936 event
->ie
.frame_or_window
,
3937 make_number (event
->ie
.code
),
3938 make_number (event
->ie
.modifiers
));
3939 kbd_fetch_ptr
= event
+ 1;
3942 #ifdef USE_FILE_NOTIFY
3943 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3945 #ifdef HAVE_W32NOTIFY
3946 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3947 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
3949 obj
= make_lispy_event (&event
->ie
);
3951 kbd_fetch_ptr
= event
+ 1;
3953 #endif /* USE_FILE_NOTIFY */
3954 else if (event
->kind
== SAVE_SESSION_EVENT
)
3956 obj
= list2 (Qsave_session
, event
->ie
.arg
);
3957 kbd_fetch_ptr
= event
+ 1;
3959 /* Just discard these, by returning nil.
3960 With MULTI_KBOARD, these events are used as placeholders
3961 when we need to randomly delete events from the queue.
3962 (They shouldn't otherwise be found in the buffer,
3963 but on some machines it appears they do show up
3964 even without MULTI_KBOARD.) */
3965 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3966 mouse events during a popup-menu call. */
3967 else if (event
->kind
== NO_EVENT
)
3968 kbd_fetch_ptr
= event
+ 1;
3969 else if (event
->kind
== HELP_EVENT
)
3971 Lisp_Object object
, position
, help
, frame
, window
;
3973 frame
= event
->ie
.frame_or_window
;
3974 object
= event
->ie
.arg
;
3975 position
= make_number (Time_to_position (event
->ie
.timestamp
));
3976 window
= event
->ie
.x
;
3978 clear_event (event
);
3980 kbd_fetch_ptr
= event
+ 1;
3981 if (!WINDOWP (window
))
3983 obj
= Fcons (Qhelp_echo
,
3984 list5 (frame
, help
, window
, object
, position
));
3986 else if (event
->kind
== FOCUS_IN_EVENT
)
3988 /* Notification of a FocusIn event. The frame receiving the
3989 focus is in event->frame_or_window. Generate a
3990 switch-frame event if necessary. */
3991 Lisp_Object frame
, focus
;
3993 frame
= event
->ie
.frame_or_window
;
3994 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4000 ! NILP (event
->ie
.arg
)
4003 !EQ (frame
, internal_last_event_frame
)
4004 && !EQ (frame
, selected_frame
))
4005 obj
= make_lispy_switch_frame (frame
);
4007 obj
= make_lispy_focus_in (frame
);
4009 internal_last_event_frame
= frame
;
4010 kbd_fetch_ptr
= event
+ 1;
4012 else if (event
->kind
== FOCUS_OUT_EVENT
)
4014 #ifdef HAVE_WINDOW_SYSTEM
4017 Lisp_Object frame
= event
->ie
.frame_or_window
;
4018 bool focused
= false;
4020 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4021 focused
= di
->x_highlight_frame
!= 0;
4024 obj
= make_lispy_focus_out (frame
);
4026 #endif /* HAVE_WINDOW_SYSTEM */
4028 kbd_fetch_ptr
= event
+ 1;
4031 else if (event
->kind
== DBUS_EVENT
)
4033 obj
= make_lispy_event (&event
->ie
);
4034 kbd_fetch_ptr
= event
+ 1;
4037 #ifdef HAVE_XWIDGETS
4038 else if (event
->kind
== XWIDGET_EVENT
)
4040 obj
= make_lispy_event (&event
->ie
);
4041 kbd_fetch_ptr
= event
+ 1;
4044 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4046 obj
= make_lispy_event (&event
->ie
);
4047 kbd_fetch_ptr
= event
+ 1;
4051 /* If this event is on a different frame, return a switch-frame this
4052 time, and leave the event in the queue for next time. */
4056 frame
= event
->ie
.frame_or_window
;
4058 frame
= XCAR (frame
);
4059 else if (WINDOWP (frame
))
4060 frame
= WINDOW_FRAME (XWINDOW (frame
));
4062 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4066 if (! EQ (frame
, internal_last_event_frame
)
4067 && !EQ (frame
, selected_frame
))
4068 obj
= make_lispy_switch_frame (frame
);
4069 internal_last_event_frame
= frame
;
4071 /* If we didn't decide to make a switch-frame event, go ahead
4072 and build a real event from the queue entry. */
4076 obj
= make_lispy_event (&event
->ie
);
4078 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4079 || defined (HAVE_NS) || defined (USE_GTK)
4080 /* If this was a menu selection, then set the flag to inhibit
4081 writing to last_nonmenu_event. Don't do this if the event
4082 we're returning is (menu-bar), though; that indicates the
4083 beginning of the menu sequence, and we might as well leave
4084 that as the `event with parameters' for this selection. */
4086 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4087 && (event
->kind
== MENU_BAR_EVENT
4088 || event
->kind
== TOOL_BAR_EVENT
))
4089 *used_mouse_menu
= true;
4092 /* Certain system events are non-key events. */
4094 && event
->kind
== NS_NONKEY_EVENT
)
4095 *used_mouse_menu
= true;
4098 /* Wipe out this event, to catch bugs. */
4099 clear_event (event
);
4100 kbd_fetch_ptr
= event
+ 1;
4104 /* Try generating a mouse motion event. */
4105 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4107 struct frame
*f
= some_mouse_moved ();
4108 Lisp_Object bar_window
;
4109 enum scroll_bar_part part
;
4113 *kbp
= current_kboard
;
4114 /* Note that this uses F to determine which terminal to look at.
4115 If there is no valid info, it does not store anything
4116 so x remains nil. */
4119 /* XXX Can f or mouse_position_hook be NULL here? */
4120 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4121 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4126 /* Decide if we should generate a switch-frame event. Don't
4127 generate switch-frame events for motion outside of all Emacs
4133 frame
= FRAME_FOCUS_FRAME (f
);
4135 XSETFRAME (frame
, f
);
4137 if (! EQ (frame
, internal_last_event_frame
)
4138 && !EQ (frame
, selected_frame
))
4139 obj
= make_lispy_switch_frame (frame
);
4140 internal_last_event_frame
= frame
;
4143 /* If we didn't decide to make a switch-frame event, go ahead and
4144 return a mouse-motion event. */
4145 if (!NILP (x
) && NILP (obj
))
4146 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4149 /* We were promised by the above while loop that there was
4150 something for us to read! */
4153 input_pending
= readable_events (0);
4155 Vlast_event_frame
= internal_last_event_frame
;
4160 /* Process any non-user-visible events (currently X selection events),
4161 without reading any user-visible events. */
4164 process_special_events (void)
4166 union buffered_input_event
*event
;
4168 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4170 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4173 if (event
== kbd_store_ptr
)
4177 /* If we find a stored X selection request, handle it now. */
4178 if (event
->kind
== SELECTION_REQUEST_EVENT
4179 || event
->kind
== SELECTION_CLEAR_EVENT
)
4183 /* Remove the event from the fifo buffer before processing;
4184 otherwise swallow_events called recursively could see it
4185 and process it again. To do this, we move the events
4186 between kbd_fetch_ptr and EVENT one slot to the right,
4189 struct selection_input_event copy
= event
->sie
;
4190 union buffered_input_event
*beg
4191 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4192 ? kbd_buffer
: kbd_fetch_ptr
;
4195 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4196 else if (event
< beg
)
4198 if (event
> kbd_buffer
)
4199 memmove (kbd_buffer
+ 1, kbd_buffer
,
4200 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4201 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4202 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4203 memmove (beg
+ 1, beg
,
4204 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4207 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4208 kbd_fetch_ptr
= kbd_buffer
+ 1;
4212 input_pending
= readable_events (0);
4213 x_handle_selection_event (©
);
4215 /* We're getting selection request events, but we don't have
4223 /* Process any events that are not user-visible, run timer events that
4224 are ripe, and return, without reading any user-visible events. */
4227 swallow_events (bool do_display
)
4229 unsigned old_timers_run
;
4231 process_special_events ();
4233 old_timers_run
= timers_run
;
4234 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4236 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4237 redisplay_preserve_echo_area (7);
4240 /* Record the start of when Emacs is idle,
4241 for the sake of running idle-time timers. */
4244 timer_start_idle (void)
4246 /* If we are already in the idle state, do nothing. */
4247 if (timespec_valid_p (timer_idleness_start_time
))
4250 timer_idleness_start_time
= current_timespec ();
4251 timer_last_idleness_start_time
= timer_idleness_start_time
;
4253 /* Mark all idle-time timers as once again candidates for running. */
4254 call0 (intern ("internal-timer-start-idle"));
4257 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4260 timer_stop_idle (void)
4262 timer_idleness_start_time
= invalid_timespec ();
4265 /* Resume idle timer from last idle start time. */
4268 timer_resume_idle (void)
4270 if (timespec_valid_p (timer_idleness_start_time
))
4273 timer_idleness_start_time
= timer_last_idleness_start_time
;
4276 /* List of elisp functions to call, delayed because they were generated in
4277 a context where Elisp could not be safely run (e.g. redisplay, signal,
4278 ...). Each element has the form (FUN . ARGS). */
4279 Lisp_Object pending_funcalls
;
4281 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4283 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4287 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4289 vec
= XVECTOR (timer
)->contents
;
4290 if (! NILP (vec
[0]))
4292 if (! INTEGERP (vec
[2]))
4296 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4298 *result
= lisp_to_timespec (t
);
4299 return timespec_valid_p (*result
);
4303 /* Check whether a timer has fired. To prevent larger problems we simply
4304 disregard elements that are not proper timers. Do not make a circular
4305 timer list for the time being.
4307 Returns the time to wait until the next timer fires. If a
4308 timer is triggering now, return zero.
4309 If no timer is active, return -1.
4311 If a timer is ripe, we run it, with quitting turned off.
4312 In that case we return 0 to indicate that a new timer_check_2 call
4315 static struct timespec
4316 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4318 struct timespec nexttime
;
4319 struct timespec now
;
4320 struct timespec idleness_now
;
4321 Lisp_Object chosen_timer
;
4323 nexttime
= invalid_timespec ();
4325 chosen_timer
= Qnil
;
4327 /* First run the code that was delayed. */
4328 while (CONSP (pending_funcalls
))
4330 Lisp_Object funcall
= XCAR (pending_funcalls
);
4331 pending_funcalls
= XCDR (pending_funcalls
);
4332 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4335 if (CONSP (timers
) || CONSP (idle_timers
))
4337 now
= current_timespec ();
4338 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4339 ? timespec_sub (now
, timer_idleness_start_time
)
4340 : make_timespec (0, 0));
4343 while (CONSP (timers
) || CONSP (idle_timers
))
4345 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4346 struct timespec timer_time
, idle_timer_time
;
4347 struct timespec difference
;
4348 struct timespec timer_difference
= invalid_timespec ();
4349 struct timespec idle_timer_difference
= invalid_timespec ();
4350 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4352 /* Set TIMER and TIMER_DIFFERENCE
4353 based on the next ordinary timer.
4354 TIMER_DIFFERENCE is the distance in time from NOW to when
4355 this timer becomes ripe.
4356 Skip past invalid timers and timers already handled. */
4359 timer
= XCAR (timers
);
4360 if (! decode_timer (timer
, &timer_time
))
4362 timers
= XCDR (timers
);
4366 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4367 timer_difference
= (timer_ripe
4368 ? timespec_sub (now
, timer_time
)
4369 : timespec_sub (timer_time
, now
));
4372 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4373 based on the next idle timer. */
4374 if (CONSP (idle_timers
))
4376 idle_timer
= XCAR (idle_timers
);
4377 if (! decode_timer (idle_timer
, &idle_timer_time
))
4379 idle_timers
= XCDR (idle_timers
);
4383 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4384 idle_timer_difference
4386 ? timespec_sub (idleness_now
, idle_timer_time
)
4387 : timespec_sub (idle_timer_time
, idleness_now
));
4390 /* Decide which timer is the next timer,
4391 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4392 Also step down the list where we found that timer. */
4394 if (timespec_valid_p (timer_difference
)
4395 && (! timespec_valid_p (idle_timer_difference
)
4396 || idle_timer_ripe
< timer_ripe
4397 || (idle_timer_ripe
== timer_ripe
4399 ? timespec_cmp (idle_timer_difference
,
4401 : timespec_cmp (timer_difference
,
4402 idle_timer_difference
))
4405 chosen_timer
= timer
;
4406 timers
= XCDR (timers
);
4407 difference
= timer_difference
;
4412 chosen_timer
= idle_timer
;
4413 idle_timers
= XCDR (idle_timers
);
4414 difference
= idle_timer_difference
;
4415 ripe
= idle_timer_ripe
;
4418 /* If timer is ripe, run it if it hasn't been run. */
4421 if (NILP (AREF (chosen_timer
, 0)))
4423 ptrdiff_t count
= SPECPDL_INDEX ();
4424 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4426 /* Mark the timer as triggered to prevent problems if the lisp
4427 code fails to reschedule it right. */
4428 ASET (chosen_timer
, 0, Qt
);
4430 specbind (Qinhibit_quit
, Qt
);
4432 call1 (Qtimer_event_handler
, chosen_timer
);
4433 Vdeactivate_mark
= old_deactivate_mark
;
4435 unbind_to (count
, Qnil
);
4437 /* Since we have handled the event,
4438 we don't need to tell the caller to wake up and do it. */
4439 /* But the caller must still wait for the next timer, so
4440 return 0 to indicate that. */
4443 nexttime
= make_timespec (0, 0);
4447 /* When we encounter a timer that is still waiting,
4448 return the amount of time to wait before it is ripe. */
4454 /* No timers are pending in the future. */
4455 /* Return 0 if we generated an event, and -1 if not. */
4460 /* Check whether a timer has fired. To prevent larger problems we simply
4461 disregard elements that are not proper timers. Do not make a circular
4462 timer list for the time being.
4464 Returns the time to wait until the next timer fires.
4465 If no timer is active, return an invalid value.
4467 As long as any timer is ripe, we run it. */
4472 struct timespec nexttime
;
4473 Lisp_Object timers
, idle_timers
;
4475 Lisp_Object tem
= Vinhibit_quit
;
4478 /* We use copies of the timers' lists to allow a timer to add itself
4479 again, without locking up Emacs if the newly added timer is
4480 already ripe when added. */
4482 /* Always consider the ordinary timers. */
4483 timers
= Fcopy_sequence (Vtimer_list
);
4484 /* Consider the idle timers only if Emacs is idle. */
4485 if (timespec_valid_p (timer_idleness_start_time
))
4486 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4490 Vinhibit_quit
= tem
;
4494 nexttime
= timer_check_2 (timers
, idle_timers
);
4496 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4501 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4502 doc
: /* Return the current length of Emacs idleness, or nil.
4503 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4504 in the same style as (current-time).
4506 The value when Emacs is not idle is nil.
4508 PSEC is a multiple of the system clock resolution. */)
4511 if (timespec_valid_p (timer_idleness_start_time
))
4512 return make_lisp_time (timespec_sub (current_timespec (),
4513 timer_idleness_start_time
));
4518 /* Caches for modify_event_symbol. */
4519 static Lisp_Object accent_key_syms
;
4520 static Lisp_Object func_key_syms
;
4521 static Lisp_Object mouse_syms
;
4522 static Lisp_Object wheel_syms
;
4523 static Lisp_Object drag_n_drop_syms
;
4525 /* This is a list of keysym codes for special "accent" characters.
4526 It parallels lispy_accent_keys. */
4528 static const int lispy_accent_codes
[] =
4530 #ifdef XK_dead_circumflex
4535 #ifdef XK_dead_grave
4540 #ifdef XK_dead_tilde
4545 #ifdef XK_dead_diaeresis
4550 #ifdef XK_dead_macron
4555 #ifdef XK_dead_degree
4560 #ifdef XK_dead_acute
4565 #ifdef XK_dead_cedilla
4570 #ifdef XK_dead_breve
4575 #ifdef XK_dead_ogonek
4580 #ifdef XK_dead_caron
4585 #ifdef XK_dead_doubleacute
4586 XK_dead_doubleacute
,
4590 #ifdef XK_dead_abovedot
4595 #ifdef XK_dead_abovering
4605 #ifdef XK_dead_belowdot
4610 #ifdef XK_dead_voiced_sound
4611 XK_dead_voiced_sound
,
4615 #ifdef XK_dead_semivoiced_sound
4616 XK_dead_semivoiced_sound
,
4632 /* This is a list of Lisp names for special "accent" characters.
4633 It parallels lispy_accent_codes. */
4635 static const char *const lispy_accent_keys
[] =
4653 "dead-voiced-sound",
4654 "dead-semivoiced-sound",
4660 #define FUNCTION_KEY_OFFSET 0x0
4662 const char *const lispy_function_keys
[] =
4666 0, /* VK_LBUTTON 0x01 */
4667 0, /* VK_RBUTTON 0x02 */
4668 "cancel", /* VK_CANCEL 0x03 */
4669 0, /* VK_MBUTTON 0x04 */
4671 0, 0, 0, /* 0x05 .. 0x07 */
4673 "backspace", /* VK_BACK 0x08 */
4674 "tab", /* VK_TAB 0x09 */
4676 0, 0, /* 0x0A .. 0x0B */
4678 "clear", /* VK_CLEAR 0x0C */
4679 "return", /* VK_RETURN 0x0D */
4681 0, 0, /* 0x0E .. 0x0F */
4683 0, /* VK_SHIFT 0x10 */
4684 0, /* VK_CONTROL 0x11 */
4685 0, /* VK_MENU 0x12 */
4686 "pause", /* VK_PAUSE 0x13 */
4687 "capslock", /* VK_CAPITAL 0x14 */
4688 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4690 "junja", /* VK_JUNJA 0x17 */
4691 "final", /* VK_FINAL 0x18 */
4692 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4694 "escape", /* VK_ESCAPE 0x1B */
4695 "convert", /* VK_CONVERT 0x1C */
4696 "non-convert", /* VK_NONCONVERT 0x1D */
4697 "accept", /* VK_ACCEPT 0x1E */
4698 "mode-change", /* VK_MODECHANGE 0x1F */
4699 0, /* VK_SPACE 0x20 */
4700 "prior", /* VK_PRIOR 0x21 */
4701 "next", /* VK_NEXT 0x22 */
4702 "end", /* VK_END 0x23 */
4703 "home", /* VK_HOME 0x24 */
4704 "left", /* VK_LEFT 0x25 */
4705 "up", /* VK_UP 0x26 */
4706 "right", /* VK_RIGHT 0x27 */
4707 "down", /* VK_DOWN 0x28 */
4708 "select", /* VK_SELECT 0x29 */
4709 "print", /* VK_PRINT 0x2A */
4710 "execute", /* VK_EXECUTE 0x2B */
4711 "snapshot", /* VK_SNAPSHOT 0x2C */
4712 "insert", /* VK_INSERT 0x2D */
4713 "delete", /* VK_DELETE 0x2E */
4714 "help", /* VK_HELP 0x2F */
4716 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4718 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4720 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4722 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4724 0, 0, 0, 0, 0, 0, 0, 0, 0,
4725 0, 0, 0, 0, 0, 0, 0, 0, 0,
4726 0, 0, 0, 0, 0, 0, 0, 0,
4728 "lwindow", /* VK_LWIN 0x5B */
4729 "rwindow", /* VK_RWIN 0x5C */
4730 "apps", /* VK_APPS 0x5D */
4733 "kp-0", /* VK_NUMPAD0 0x60 */
4734 "kp-1", /* VK_NUMPAD1 0x61 */
4735 "kp-2", /* VK_NUMPAD2 0x62 */
4736 "kp-3", /* VK_NUMPAD3 0x63 */
4737 "kp-4", /* VK_NUMPAD4 0x64 */
4738 "kp-5", /* VK_NUMPAD5 0x65 */
4739 "kp-6", /* VK_NUMPAD6 0x66 */
4740 "kp-7", /* VK_NUMPAD7 0x67 */
4741 "kp-8", /* VK_NUMPAD8 0x68 */
4742 "kp-9", /* VK_NUMPAD9 0x69 */
4743 "kp-multiply", /* VK_MULTIPLY 0x6A */
4744 "kp-add", /* VK_ADD 0x6B */
4745 "kp-separator", /* VK_SEPARATOR 0x6C */
4746 "kp-subtract", /* VK_SUBTRACT 0x6D */
4747 "kp-decimal", /* VK_DECIMAL 0x6E */
4748 "kp-divide", /* VK_DIVIDE 0x6F */
4749 "f1", /* VK_F1 0x70 */
4750 "f2", /* VK_F2 0x71 */
4751 "f3", /* VK_F3 0x72 */
4752 "f4", /* VK_F4 0x73 */
4753 "f5", /* VK_F5 0x74 */
4754 "f6", /* VK_F6 0x75 */
4755 "f7", /* VK_F7 0x76 */
4756 "f8", /* VK_F8 0x77 */
4757 "f9", /* VK_F9 0x78 */
4758 "f10", /* VK_F10 0x79 */
4759 "f11", /* VK_F11 0x7A */
4760 "f12", /* VK_F12 0x7B */
4761 "f13", /* VK_F13 0x7C */
4762 "f14", /* VK_F14 0x7D */
4763 "f15", /* VK_F15 0x7E */
4764 "f16", /* VK_F16 0x7F */
4765 "f17", /* VK_F17 0x80 */
4766 "f18", /* VK_F18 0x81 */
4767 "f19", /* VK_F19 0x82 */
4768 "f20", /* VK_F20 0x83 */
4769 "f21", /* VK_F21 0x84 */
4770 "f22", /* VK_F22 0x85 */
4771 "f23", /* VK_F23 0x86 */
4772 "f24", /* VK_F24 0x87 */
4774 0, 0, 0, 0, /* 0x88 .. 0x8B */
4775 0, 0, 0, 0, /* 0x8C .. 0x8F */
4777 "kp-numlock", /* VK_NUMLOCK 0x90 */
4778 "scroll", /* VK_SCROLL 0x91 */
4779 /* Not sure where the following block comes from.
4780 Windows headers have NEC and Fujitsu specific keys in
4781 this block, but nothing generic. */
4782 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4783 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4784 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4785 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4786 "kp-end", /* VK_NUMPAD_END 0x96 */
4787 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4788 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4789 "kp-up", /* VK_NUMPAD_UP 0x99 */
4790 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4791 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4792 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4793 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4795 0, 0, /* 0x9E .. 0x9F */
4798 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4799 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4800 * No other API or message will distinguish left and right keys this way.
4805 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4806 to enable them selectively, and gives access to a few more functions.
4807 See lispy_multimedia_keys below. */
4808 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4809 0, 0, 0, /* 0xAD .. 0xAF Volume */
4810 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4811 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4813 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4814 0, 0, 0, 0, 0, 0, 0, 0, 0,
4816 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4817 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4818 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4821 "ax", /* VK_OEM_AX 0xE1 */
4822 0, /* VK_OEM_102 0xE2 */
4823 "ico-help", /* VK_ICO_HELP 0xE3 */
4824 "ico-00", /* VK_ICO_00 0xE4 */
4825 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4826 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4827 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4829 "reset", /* VK_OEM_RESET 0xE9 */
4830 "jump", /* VK_OEM_JUMP 0xEA */
4831 "oem-pa1", /* VK_OEM_PA1 0xEB */
4832 "oem-pa2", /* VK_OEM_PA2 0xEC */
4833 "oem-pa3", /* VK_OEM_PA3 0xED */
4834 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4835 "cusel", /* VK_OEM_CUSEL 0xEF */
4836 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4837 "finish", /* VK_OEM_FINISH 0xF1 */
4838 "copy", /* VK_OEM_COPY 0xF2 */
4839 "auto", /* VK_OEM_AUTO 0xF3 */
4840 "enlw", /* VK_OEM_ENLW 0xF4 */
4841 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4842 "attn", /* VK_ATTN 0xF6 */
4843 "crsel", /* VK_CRSEL 0xF7 */
4844 "exsel", /* VK_EXSEL 0xF8 */
4845 "ereof", /* VK_EREOF 0xF9 */
4846 "play", /* VK_PLAY 0xFA */
4847 "zoom", /* VK_ZOOM 0xFB */
4848 "noname", /* VK_NONAME 0xFC */
4849 "pa1", /* VK_PA1 0xFD */
4850 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4854 /* Some of these duplicate the "Media keys" on newer keyboards,
4855 but they are delivered to the application in a different way. */
4856 static const char *const lispy_multimedia_keys
[] =
4864 "browser-favorites",
4901 "toggle-dictate-command",
4907 "media-fast-forward",
4910 "media-channel-down"
4913 #else /* not HAVE_NTGUI */
4915 /* This should be dealt with in XTread_socket now, and that doesn't
4916 depend on the client system having the Kana syms defined. See also
4917 the XK_kana_A case below. */
4920 static const char *const lispy_kana_keys
[] =
4922 /* X Keysym value */
4923 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4924 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4925 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4926 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4927 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4928 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4929 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4930 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4931 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4932 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4933 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4934 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4935 "kana-i", "kana-u", "kana-e", "kana-o",
4936 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4937 "prolongedsound", "kana-A", "kana-I", "kana-U",
4938 "kana-E", "kana-O", "kana-KA", "kana-KI",
4939 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4940 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4941 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4942 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4943 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4944 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4945 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4946 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4947 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4948 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4949 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4950 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4952 #endif /* XK_kana_A */
4955 #define FUNCTION_KEY_OFFSET 0xff00
4957 /* You'll notice that this table is arranged to be conveniently
4958 indexed by X Windows keysym values. */
4959 static const char *const lispy_function_keys
[] =
4961 /* X Keysym value */
4963 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4964 "backspace", "tab", "linefeed", "clear",
4966 0, 0, 0, "pause", /* 0xff10...1f */
4967 0, 0, 0, 0, 0, 0, 0, "escape",
4969 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4970 "romaji", "hiragana", "katakana", "hiragana-katakana",
4971 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4972 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4973 "eisu-toggle", /* 0xff30...3f */
4974 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4975 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4977 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4978 "down", "prior", "next", "end",
4979 "begin", 0, 0, 0, 0, 0, 0, 0,
4980 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4991 "break", /* 0xff6b */
4994 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4995 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4996 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4997 0, 0, 0, 0, 0, 0, 0, 0,
4998 "kp-tab", /* 0xff89 */
5000 "kp-enter", /* 0xff8d */
5002 "kp-f1", /* 0xff91 */
5006 "kp-home", /* 0xff95 */
5011 "kp-prior", /* kp-page-up */
5012 "kp-next", /* kp-page-down */
5018 0, 0, 0, 0, 0, 0, 0, 0, 0,
5019 "kp-multiply", /* 0xffaa */
5024 "kp-divide", /* 0xffaf */
5025 "kp-0", /* 0xffb0 */
5026 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5029 "kp-equal", /* 0xffbd */
5030 "f1", /* 0xffbe */ /* IsFunctionKey */
5032 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5033 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5034 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5035 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5036 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5037 0, 0, 0, 0, 0, 0, 0, 0,
5038 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5039 0, 0, 0, 0, 0, 0, 0, "delete"
5042 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5043 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5045 static const char *const iso_lispy_function_keys
[] =
5047 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5048 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5049 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5050 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5051 "iso-lefttab", /* 0xfe20 */
5052 "iso-move-line-up", "iso-move-line-down",
5053 "iso-partial-line-up", "iso-partial-line-down",
5054 "iso-partial-space-left", "iso-partial-space-right",
5055 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5056 "iso-release-margin-left", "iso-release-margin-right",
5057 "iso-release-both-margins",
5058 "iso-fast-cursor-left", "iso-fast-cursor-right",
5059 "iso-fast-cursor-up", "iso-fast-cursor-down",
5060 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5061 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5064 #endif /* not HAVE_NTGUI */
5066 static Lisp_Object Vlispy_mouse_stem
;
5068 static const char *const lispy_wheel_names
[] =
5070 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5073 /* drag-n-drop events are generated when a set of selected files are
5074 dragged from another application and dropped onto an Emacs window. */
5075 static const char *const lispy_drag_n_drop_names
[] =
5080 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5081 scroll_bar_part value. Note that Qnil corresponds to
5082 scroll_bar_nowhere and should not appear in Lisp events. */
5083 static short const scroll_bar_parts
[] = {
5084 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5085 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5086 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5087 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5088 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5089 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5090 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5093 /* A vector, indexed by button number, giving the down-going location
5094 of currently depressed buttons, both scroll bar and non-scroll bar.
5096 The elements have the form
5097 (BUTTON-NUMBER MODIFIER-MASK . REST)
5098 where REST is the cdr of a position as it would be reported in the event.
5100 The make_lispy_event function stores positions here to tell the
5101 difference between click and drag events, and to store the starting
5102 location to be included in drag events. */
5104 static Lisp_Object button_down_location
;
5106 /* Information about the most recent up-going button event: Which
5107 button, what location, and what time. */
5109 static int last_mouse_button
;
5110 static int last_mouse_x
;
5111 static int last_mouse_y
;
5112 static Time button_down_time
;
5114 /* The number of clicks in this multiple-click. */
5116 static int double_click_count
;
5118 /* X and Y are frame-relative coordinates for a click or wheel event.
5119 Return a Lisp-style event list. */
5122 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5125 enum window_part part
;
5126 Lisp_Object posn
= Qnil
;
5127 Lisp_Object extra_info
= Qnil
;
5128 /* Coordinate pixel positions to return. */
5129 int xret
= 0, yret
= 0;
5130 /* The window under frame pixel coordinates (x,y) */
5131 Lisp_Object window
= f
5132 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5135 if (WINDOWP (window
))
5137 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5138 struct window
*w
= XWINDOW (window
);
5139 Lisp_Object string_info
= Qnil
;
5140 ptrdiff_t textpos
= 0;
5141 int col
= -1, row
= -1;
5142 int dx
= -1, dy
= -1;
5143 int width
= -1, height
= -1;
5144 Lisp_Object object
= Qnil
;
5146 /* Pixel coordinates relative to the window corner. */
5147 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5148 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5150 /* For text area clicks, return X, Y relative to the corner of
5151 this text area. Note that dX, dY etc are set below, by
5152 buffer_posn_from_coords. */
5153 if (part
== ON_TEXT
)
5155 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5156 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5158 /* For mode line and header line clicks, return X, Y relative to
5159 the left window edge. Use mode_line_string to look for a
5160 string on the click position. */
5161 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5166 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5167 /* Note that mode_line_string takes COL, ROW as pixels and
5168 converts them to characters. */
5171 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5172 &object
, &dx
, &dy
, &width
, &height
);
5173 if (STRINGP (string
))
5174 string_info
= Fcons (string
, make_number (charpos
));
5180 /* For fringes and margins, Y is relative to the area's (and the
5181 window's) top edge, while X is meaningless. */
5182 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5187 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5190 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5191 &object
, &dx
, &dy
, &width
, &height
);
5192 if (STRINGP (string
))
5193 string_info
= Fcons (string
, make_number (charpos
));
5195 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5197 else if (part
== ON_LEFT_FRINGE
)
5199 posn
= Qleft_fringe
;
5203 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5204 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5205 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5207 else if (part
== ON_RIGHT_FRINGE
)
5209 posn
= Qright_fringe
;
5213 - window_box_width (w
, LEFT_MARGIN_AREA
)
5214 - window_box_width (w
, TEXT_AREA
)
5215 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5216 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5218 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5220 else if (part
== ON_VERTICAL_BORDER
)
5222 posn
= Qvertical_line
;
5228 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5230 posn
= Qvertical_scroll_bar
;
5231 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5235 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5237 posn
= Qhorizontal_scroll_bar
;
5238 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5242 else if (part
== ON_RIGHT_DIVIDER
)
5244 posn
= Qright_divider
;
5245 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5249 else if (part
== ON_BOTTOM_DIVIDER
)
5251 posn
= Qbottom_divider
;
5252 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5257 /* For clicks in the text area, fringes, margins, or vertical
5258 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5259 the buffer position nearest to the click. */
5262 Lisp_Object string2
, object2
= Qnil
;
5263 struct display_pos p
;
5265 int width2
, height2
;
5266 /* The pixel X coordinate passed to buffer_posn_from_coords
5267 is the X coordinate relative to the text area for clicks
5268 in text-area, right-margin/fringe and right-side vertical
5269 scroll bar, zero otherwise. */
5271 = (part
== ON_TEXT
) ? xret
5272 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5273 || (part
== ON_VERTICAL_SCROLL_BAR
5274 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5275 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5279 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5280 &object2
, &dx2
, &dy2
,
5282 textpos
= CHARPOS (p
.pos
);
5283 if (col
< 0) col
= x2
;
5284 if (row
< 0) row
= y2
;
5285 if (dx
< 0) dx
= dx2
;
5286 if (dy
< 0) dy
= dy2
;
5287 if (width
< 0) width
= width2
;
5288 if (height
< 0) height
= height2
;
5292 posn
= make_number (textpos
);
5293 if (STRINGP (string2
))
5294 string_info
= Fcons (string2
,
5295 make_number (CHARPOS (p
.string_pos
)));
5301 #ifdef HAVE_WINDOW_SYSTEM
5302 if (IMAGEP (object
))
5304 Lisp_Object image_map
, hotspot
;
5305 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5307 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5309 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5310 posn
= XCAR (hotspot
);
5317 Fcons (make_number (dx
), make_number (dy
)),
5318 Fcons (make_number (width
), make_number (height
)));
5321 extra_info
= Fcons (string_info
,
5322 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5323 Fcons (Fcons (make_number (col
),
5329 /* Return mouse pixel coordinates here. */
5330 XSETFRAME (window
, f
);
5337 return Fcons (window
,
5339 Fcons (Fcons (make_number (xret
),
5340 make_number (yret
)),
5341 Fcons (make_number (t
),
5345 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5346 menu bar. This really means that Emacs draws and manages the menu
5347 bar as part of its normal display, and therefore can compute its
5350 toolkit_menubar_in_use (struct frame
*f
)
5352 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5353 return !(!FRAME_WINDOW_P (f
));
5359 /* Build the part of Lisp event which represents scroll bar state from
5360 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5363 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5365 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5366 make_number (ev
->timestamp
),
5367 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5370 /* Given a struct input_event, build the lisp event which represents
5371 it. If EVENT is 0, build a mouse movement event from the mouse
5372 movement buffer, which should have a movement event in it.
5374 Note that events must be passed to this function in the order they
5375 are received; this function stores the location of button presses
5376 in order to build drag events when the button is released. */
5379 make_lispy_event (struct input_event
*event
)
5383 switch (event
->kind
)
5385 /* A simple keystroke. */
5386 case ASCII_KEYSTROKE_EVENT
:
5387 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5389 Lisp_Object lispy_c
;
5390 EMACS_INT c
= event
->code
;
5391 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5394 eassert (c
== event
->code
);
5395 /* Turn ASCII characters into control characters
5397 if (event
->modifiers
& ctrl_modifier
)
5399 c
= make_ctrl_char (c
);
5400 event
->modifiers
&= ~ctrl_modifier
;
5404 /* Add in the other modifier bits. The shift key was taken care
5405 of by the X code. */
5406 c
|= (event
->modifiers
5407 & (meta_modifier
| alt_modifier
5408 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5409 /* Distinguish Shift-SPC from SPC. */
5410 if ((event
->code
) == 040
5411 && event
->modifiers
& shift_modifier
)
5412 c
|= shift_modifier
;
5413 button_down_time
= 0;
5414 XSETFASTINT (lispy_c
, c
);
5419 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5420 except that they are non-key events (last-nonmenu-event is nil). */
5421 case NS_NONKEY_EVENT
:
5424 /* A function key. The symbol may need to have modifier prefixes
5426 case NON_ASCII_KEYSTROKE_EVENT
:
5427 button_down_time
= 0;
5429 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5430 if (event
->code
== lispy_accent_codes
[i
])
5431 return modify_event_symbol (i
,
5433 Qfunction_key
, Qnil
,
5434 lispy_accent_keys
, &accent_key_syms
,
5435 ARRAYELTS (lispy_accent_keys
));
5439 if (event
->code
>= 0x400 && event
->code
< 0x500)
5440 return modify_event_symbol (event
->code
- 0x400,
5441 event
->modifiers
& ~shift_modifier
,
5442 Qfunction_key
, Qnil
,
5443 lispy_kana_keys
, &func_key_syms
,
5444 ARRAYELTS (lispy_kana_keys
));
5445 #endif /* XK_kana_A */
5448 #ifdef ISO_FUNCTION_KEY_OFFSET
5449 if (event
->code
< FUNCTION_KEY_OFFSET
5450 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5451 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5453 Qfunction_key
, Qnil
,
5454 iso_lispy_function_keys
, &func_key_syms
,
5455 ARRAYELTS (iso_lispy_function_keys
));
5458 if ((FUNCTION_KEY_OFFSET
<= event
->code
5460 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5461 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5462 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5464 Qfunction_key
, Qnil
,
5465 lispy_function_keys
, &func_key_syms
,
5466 ARRAYELTS (lispy_function_keys
));
5468 /* Handle system-specific or unknown keysyms.
5469 We need to use an alist rather than a vector as the cache
5470 since we can't make a vector long enough. */
5471 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5472 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5473 return modify_event_symbol (event
->code
,
5476 KVAR (current_kboard
, Vsystem_key_alist
),
5477 0, &KVAR (current_kboard
, system_key_syms
),
5481 case MULTIMEDIA_KEY_EVENT
:
5482 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5483 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5485 return modify_event_symbol (event
->code
, event
->modifiers
,
5486 Qfunction_key
, Qnil
,
5487 lispy_multimedia_keys
, &func_key_syms
,
5488 ARRAYELTS (lispy_multimedia_keys
));
5493 /* A mouse click. Figure out where it is, decide whether it's
5494 a press, click or drag, and build the appropriate structure. */
5495 case MOUSE_CLICK_EVENT
:
5497 case GPM_CLICK_EVENT
:
5499 #ifndef USE_TOOLKIT_SCROLL_BARS
5500 case SCROLL_BAR_CLICK_EVENT
:
5501 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5504 int button
= event
->code
;
5506 Lisp_Object position
;
5507 Lisp_Object
*start_pos_ptr
;
5508 Lisp_Object start_pos
;
5512 /* Build the position as appropriate for this mouse click. */
5513 if (event
->kind
== MOUSE_CLICK_EVENT
5515 || event
->kind
== GPM_CLICK_EVENT
5519 struct frame
*f
= XFRAME (event
->frame_or_window
);
5522 /* Ignore mouse events that were made on frame that
5523 have been deleted. */
5524 if (! FRAME_LIVE_P (f
))
5527 /* EVENT->x and EVENT->y are frame-relative pixel
5528 coordinates at this place. Under old redisplay, COLUMN
5529 and ROW are set to frame relative glyph coordinates
5530 which are then used to determine whether this click is
5531 in a menu (non-toolkit version). */
5532 if (!toolkit_menubar_in_use (f
))
5534 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5535 &column
, &row
, NULL
, 1);
5537 /* In the non-toolkit version, clicks on the menu bar
5538 are ordinary button events in the event buffer.
5539 Distinguish them, and invoke the menu.
5541 (In the toolkit version, the toolkit handles the
5542 menu bar and Emacs doesn't know about it until
5543 after the user makes a selection.) */
5544 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5545 && (event
->modifiers
& down_modifier
))
5547 Lisp_Object items
, item
;
5549 /* Find the menu bar item under `column'. */
5551 items
= FRAME_MENU_BAR_ITEMS (f
);
5552 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5554 Lisp_Object pos
, string
;
5555 string
= AREF (items
, i
+ 1);
5556 pos
= AREF (items
, i
+ 3);
5559 if (column
>= XINT (pos
)
5560 && column
< XINT (pos
) + SCHARS (string
))
5562 item
= AREF (items
, i
);
5567 /* ELisp manual 2.4b says (x y) are window
5568 relative but code says they are
5570 position
= list4 (event
->frame_or_window
,
5572 Fcons (event
->x
, event
->y
),
5573 make_number (event
->timestamp
));
5575 return list2 (item
, position
);
5579 position
= make_lispy_position (f
, event
->x
, event
->y
,
5582 #ifndef USE_TOOLKIT_SCROLL_BARS
5584 /* It's a scrollbar click. */
5585 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5586 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5588 if (button
>= ASIZE (button_down_location
))
5590 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5591 button_down_location
= larger_vector (button_down_location
,
5593 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5596 start_pos_ptr
= aref_addr (button_down_location
, button
);
5597 start_pos
= *start_pos_ptr
;
5598 *start_pos_ptr
= Qnil
;
5601 /* On window-system frames, use the value of
5602 double-click-fuzz as is. On other frames, interpret it
5603 as a multiple of 1/8 characters. */
5607 if (WINDOWP (event
->frame_or_window
))
5608 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5609 else if (FRAMEP (event
->frame_or_window
))
5610 f
= XFRAME (event
->frame_or_window
);
5614 if (FRAME_WINDOW_P (f
))
5615 fuzz
= double_click_fuzz
;
5617 fuzz
= double_click_fuzz
/ 8;
5619 is_double
= (button
== last_mouse_button
5620 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5621 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5622 && button_down_time
!= 0
5623 && (EQ (Vdouble_click_time
, Qt
)
5624 || (NATNUMP (Vdouble_click_time
)
5625 && (event
->timestamp
- button_down_time
5626 < XFASTINT (Vdouble_click_time
)))));
5629 last_mouse_button
= button
;
5630 last_mouse_x
= XINT (event
->x
);
5631 last_mouse_y
= XINT (event
->y
);
5633 /* If this is a button press, squirrel away the location, so
5634 we can decide later whether it was a click or a drag. */
5635 if (event
->modifiers
& down_modifier
)
5639 double_click_count
++;
5640 event
->modifiers
|= ((double_click_count
> 2)
5645 double_click_count
= 1;
5646 button_down_time
= event
->timestamp
;
5647 *start_pos_ptr
= Fcopy_alist (position
);
5648 ignore_mouse_drag_p
= 0;
5651 /* Now we're releasing a button - check the co-ordinates to
5652 see if this was a click or a drag. */
5653 else if (event
->modifiers
& up_modifier
)
5655 /* If we did not see a down before this up, ignore the up.
5656 Probably this happened because the down event chose a
5657 menu item. It would be an annoyance to treat the
5658 release of the button that chose the menu item as a
5661 if (!CONSP (start_pos
))
5664 event
->modifiers
&= ~up_modifier
;
5667 Lisp_Object new_down
, down
;
5668 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5670 /* The third element of every position
5671 should be the (x,y) pair. */
5672 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5673 new_down
= Fcar (Fcdr (Fcdr (position
)));
5676 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5678 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5679 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5682 if (ignore_mouse_drag_p
)
5684 event
->modifiers
|= click_modifier
;
5685 ignore_mouse_drag_p
= 0;
5687 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5688 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5689 /* Maybe the mouse has moved a lot, caused scrolling, and
5690 eventually ended up at the same screen position (but
5691 not buffer position) in which case it is a drag, not
5693 /* FIXME: OTOH if the buffer position has changed
5694 because of a timer or process filter rather than
5695 because of mouse movement, it should be considered as
5696 a click. But mouse-drag-region completely ignores
5697 this case and it hasn't caused any real problem, so
5698 it's probably OK to ignore it as well. */
5699 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5700 /* Mouse hasn't moved (much). */
5701 event
->modifiers
|= click_modifier
;
5704 button_down_time
= 0;
5705 event
->modifiers
|= drag_modifier
;
5708 /* Don't check is_double; treat this as multiple
5709 if the down-event was multiple. */
5710 if (double_click_count
> 1)
5711 event
->modifiers
|= ((double_click_count
> 2)
5717 /* Every mouse event should either have the down_modifier or
5718 the up_modifier set. */
5722 /* Get the symbol we should use for the mouse click. */
5725 head
= modify_event_symbol (button
,
5727 Qmouse_click
, Vlispy_mouse_stem
,
5730 ASIZE (mouse_syms
));
5731 if (event
->modifiers
& drag_modifier
)
5732 return list3 (head
, start_pos
, position
);
5733 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5734 return list3 (head
, position
, make_number (double_click_count
));
5736 return list2 (head
, position
);
5741 case HORIZ_WHEEL_EVENT
:
5743 Lisp_Object position
;
5746 /* Build the position as appropriate for this mouse click. */
5747 struct frame
*f
= XFRAME (event
->frame_or_window
);
5749 /* Ignore wheel events that were made on frame that have been
5751 if (! FRAME_LIVE_P (f
))
5754 position
= make_lispy_position (f
, event
->x
, event
->y
,
5757 /* Set double or triple modifiers to indicate the wheel speed. */
5759 /* On window-system frames, use the value of
5760 double-click-fuzz as is. On other frames, interpret it
5761 as a multiple of 1/8 characters. */
5767 if (WINDOWP (event
->frame_or_window
))
5768 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5769 else if (FRAMEP (event
->frame_or_window
))
5770 fr
= XFRAME (event
->frame_or_window
);
5774 fuzz
= FRAME_WINDOW_P (fr
)
5775 ? double_click_fuzz
: double_click_fuzz
/ 8;
5777 if (event
->modifiers
& up_modifier
)
5779 /* Emit a wheel-up event. */
5780 event
->modifiers
&= ~up_modifier
;
5783 else if (event
->modifiers
& down_modifier
)
5785 /* Emit a wheel-down event. */
5786 event
->modifiers
&= ~down_modifier
;
5790 /* Every wheel event should either have the down_modifier or
5791 the up_modifier set. */
5794 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5797 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5798 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5799 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5800 && button_down_time
!= 0
5801 && (EQ (Vdouble_click_time
, Qt
)
5802 || (NATNUMP (Vdouble_click_time
)
5803 && (event
->timestamp
- button_down_time
5804 < XFASTINT (Vdouble_click_time
)))));
5807 double_click_count
++;
5808 event
->modifiers
|= ((double_click_count
> 2)
5814 double_click_count
= 1;
5815 event
->modifiers
|= click_modifier
;
5818 button_down_time
= event
->timestamp
;
5819 /* Use a negative value to distinguish wheel from mouse button. */
5820 last_mouse_button
= - (1 + symbol_num
);
5821 last_mouse_x
= XINT (event
->x
);
5822 last_mouse_y
= XINT (event
->y
);
5824 /* Get the symbol we should use for the wheel event. */
5825 head
= modify_event_symbol (symbol_num
,
5831 ASIZE (wheel_syms
));
5834 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5835 return list3 (head
, position
, make_number (double_click_count
));
5837 return list2 (head
, position
);
5841 #ifdef USE_TOOLKIT_SCROLL_BARS
5843 /* We don't have down and up events if using toolkit scroll bars,
5844 so make this always a click event. Store in the `part' of
5845 the Lisp event a symbol which maps to the following actions:
5847 `above_handle' page up
5848 `below_handle' page down
5852 `bottom' bottom of buffer
5853 `handle' thumb has been dragged.
5854 `end-scroll' end of interaction with scroll bar
5856 The incoming input_event contains in its `part' member an
5857 index of type `enum scroll_bar_part' which we can use as an
5858 index in scroll_bar_parts to get the appropriate symbol. */
5860 case SCROLL_BAR_CLICK_EVENT
:
5862 Lisp_Object position
, head
;
5864 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5866 /* Always treat scroll bar events as clicks. */
5867 event
->modifiers
|= click_modifier
;
5868 event
->modifiers
&= ~up_modifier
;
5870 if (event
->code
>= ASIZE (mouse_syms
))
5871 mouse_syms
= larger_vector (mouse_syms
,
5872 event
->code
- ASIZE (mouse_syms
) + 1,
5875 /* Get the symbol we should use for the mouse click. */
5876 head
= modify_event_symbol (event
->code
,
5881 ASIZE (mouse_syms
));
5882 return list2 (head
, position
);
5885 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5887 Lisp_Object position
, head
;
5889 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5891 /* Always treat scroll bar events as clicks. */
5892 event
->modifiers
|= click_modifier
;
5893 event
->modifiers
&= ~up_modifier
;
5895 if (event
->code
>= ASIZE (mouse_syms
))
5896 mouse_syms
= larger_vector (mouse_syms
,
5897 event
->code
- ASIZE (mouse_syms
) + 1,
5900 /* Get the symbol we should use for the mouse click. */
5901 head
= modify_event_symbol (event
->code
,
5906 ASIZE (mouse_syms
));
5907 return list2 (head
, position
);
5910 #endif /* USE_TOOLKIT_SCROLL_BARS */
5912 case DRAG_N_DROP_EVENT
:
5915 Lisp_Object head
, position
;
5918 f
= XFRAME (event
->frame_or_window
);
5921 /* Ignore mouse events that were made on frames that
5922 have been deleted. */
5923 if (! FRAME_LIVE_P (f
))
5926 position
= make_lispy_position (f
, event
->x
, event
->y
,
5929 head
= modify_event_symbol (0, event
->modifiers
,
5931 lispy_drag_n_drop_names
,
5932 &drag_n_drop_syms
, 1);
5933 return list3 (head
, position
, files
);
5936 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5937 || defined (HAVE_NS) || defined (USE_GTK)
5938 case MENU_BAR_EVENT
:
5939 if (EQ (event
->arg
, event
->frame_or_window
))
5940 /* This is the prefix key. We translate this to
5941 `(menu_bar)' because the code in keyboard.c for menu
5942 events, which we use, relies on this. */
5943 return list1 (Qmenu_bar
);
5947 case SELECT_WINDOW_EVENT
:
5948 /* Make an event (select-window (WINDOW)). */
5949 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5951 case TOOL_BAR_EVENT
:
5952 if (EQ (event
->arg
, event
->frame_or_window
))
5953 /* This is the prefix key. We translate this to
5954 `(tool_bar)' because the code in keyboard.c for tool bar
5955 events, which we use, relies on this. */
5956 return list1 (Qtool_bar
);
5957 else if (SYMBOLP (event
->arg
))
5958 return apply_modifiers (event
->modifiers
, event
->arg
);
5961 case USER_SIGNAL_EVENT
:
5962 /* A user signal. */
5964 char *name
= find_user_signal_name (event
->code
);
5967 return intern (name
);
5970 case SAVE_SESSION_EVENT
:
5971 return Qsave_session
;
5976 return Fcons (Qdbus_event
, event
->arg
);
5978 #endif /* HAVE_DBUS */
5980 #ifdef HAVE_XWIDGETS
5983 return Fcons (Qxwidget_event
, event
->arg
);
5988 #if defined HAVE_INOTIFY || defined HAVE_KQUEUE || defined HAVE_GFILENOTIFY
5989 case FILE_NOTIFY_EVENT
:
5991 return Fcons (Qfile_notify
, event
->arg
);
5993 #endif /* HAVE_INOTIFY || HAVE_KQUEUE || HAVE_GFILENOTIFY */
5995 case CONFIG_CHANGED_EVENT
:
5996 return list3 (Qconfig_changed_event
,
5997 event
->arg
, event
->frame_or_window
);
5999 /* The 'kind' field of the event is something we don't recognize. */
6006 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6007 Lisp_Object x
, Lisp_Object y
, Time t
)
6009 /* Is it a scroll bar movement? */
6010 if (frame
&& ! NILP (bar_window
))
6012 Lisp_Object part_sym
;
6014 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
6015 return list2 (Qscroll_bar_movement
,
6017 Qvertical_scroll_bar
,
6022 /* Or is it an ordinary mouse movement? */
6025 Lisp_Object position
;
6026 position
= make_lispy_position (frame
, x
, y
, t
);
6027 return list2 (Qmouse_movement
, position
);
6031 /* Construct a switch frame event. */
6033 make_lispy_switch_frame (Lisp_Object frame
)
6035 return list2 (Qswitch_frame
, frame
);
6039 make_lispy_focus_in (Lisp_Object frame
)
6041 return list2 (Qfocus_in
, frame
);
6044 #ifdef HAVE_WINDOW_SYSTEM
6047 make_lispy_focus_out (Lisp_Object frame
)
6049 return list2 (Qfocus_out
, frame
);
6052 #endif /* HAVE_WINDOW_SYSTEM */
6054 /* Manipulating modifiers. */
6056 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6058 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6059 SYMBOL's name of the end of the modifiers; the string from this
6060 position is the unmodified symbol name.
6062 This doesn't use any caches. */
6065 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6071 CHECK_SYMBOL (symbol
);
6074 name
= SYMBOL_NAME (symbol
);
6076 for (i
= 0; i
< SBYTES (name
) - 1; )
6078 ptrdiff_t this_mod_end
= 0;
6081 /* See if the name continues with a modifier word.
6082 Check that the word appears, but don't check what follows it.
6083 Set this_mod and this_mod_end to record what we find. */
6085 switch (SREF (name
, i
))
6087 #define SINGLE_LETTER_MOD(BIT) \
6088 (this_mod_end = i + 1, this_mod = BIT)
6091 SINGLE_LETTER_MOD (alt_modifier
);
6095 SINGLE_LETTER_MOD (ctrl_modifier
);
6099 SINGLE_LETTER_MOD (hyper_modifier
);
6103 SINGLE_LETTER_MOD (meta_modifier
);
6107 SINGLE_LETTER_MOD (shift_modifier
);
6111 SINGLE_LETTER_MOD (super_modifier
);
6114 #undef SINGLE_LETTER_MOD
6116 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6117 if (i + LEN + 1 <= SBYTES (name) \
6118 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6120 this_mod_end = i + LEN; \
6125 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6126 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6127 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6131 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6135 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6137 #undef MULTI_LETTER_MOD
6141 /* If we found no modifier, stop looking for them. */
6142 if (this_mod_end
== 0)
6145 /* Check there is a dash after the modifier, so that it
6146 really is a modifier. */
6147 if (this_mod_end
>= SBYTES (name
)
6148 || SREF (name
, this_mod_end
) != '-')
6151 /* This modifier is real; look for another. */
6152 modifiers
|= this_mod
;
6153 i
= this_mod_end
+ 1;
6156 /* Should we include the `click' modifier? */
6157 if (! (modifiers
& (down_modifier
| drag_modifier
6158 | double_modifier
| triple_modifier
))
6159 && i
+ 7 == SBYTES (name
)
6160 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6161 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6162 modifiers
|= click_modifier
;
6164 if (! (modifiers
& (double_modifier
| triple_modifier
))
6165 && i
+ 6 < SBYTES (name
)
6166 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6167 modifiers
|= click_modifier
;
6175 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6176 prepended to the string BASE[0..BASE_LEN-1].
6177 This doesn't use any caches. */
6179 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6181 /* Since BASE could contain nulls, we can't use intern here; we have
6182 to use Fintern, which expects a genuine Lisp_String, and keeps a
6184 char new_mods
[sizeof "A-C-H-M-S-s-up-down-drag-double-triple-"];
6190 /* Mouse events should not exhibit the `up' modifier once they
6191 leave the event queue only accessible to C code; `up' will
6192 always be turned into a click or drag event before being
6193 presented to lisp code. But since lisp events can be
6194 synthesized bypassing the event queue and pushed into
6195 `unread-command-events' or its companions, it's better to just
6196 deal with unexpected modifier combinations. */
6198 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6199 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6200 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6201 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6202 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6203 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6204 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6205 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6206 if (modifiers
& up_modifier
) p
= stpcpy (p
, "up-");
6207 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6208 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6209 /* The click modifier is denoted by the absence of other modifiers. */
6213 mod_len
= p
- new_mods
;
6217 Lisp_Object new_name
;
6219 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6220 mod_len
+ base_len_byte
);
6221 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6222 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6224 return Fintern (new_name
, Qnil
);
6229 static const char *const modifier_names
[] =
6231 "up", "down", "drag", "click", "double", "triple", 0, 0,
6232 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6233 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6235 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6237 static Lisp_Object modifier_symbols
;
6239 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6241 lispy_modifier_list (int modifiers
)
6243 Lisp_Object modifier_list
;
6246 modifier_list
= Qnil
;
6247 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6248 if (modifiers
& (1<<i
))
6249 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6252 return modifier_list
;
6256 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6257 where UNMODIFIED is the unmodified form of SYMBOL,
6258 MASK is the set of modifiers present in SYMBOL's name.
6259 This is similar to parse_modifiers_uncached, but uses the cache in
6260 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6261 Qevent_symbol_elements property. */
6263 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6266 parse_modifiers (Lisp_Object symbol
)
6268 Lisp_Object elements
;
6270 if (INTEGERP (symbol
))
6271 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6272 else if (!SYMBOLP (symbol
))
6275 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6276 if (CONSP (elements
))
6281 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6282 Lisp_Object unmodified
;
6285 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6286 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6289 if (modifiers
& ~INTMASK
)
6291 XSETFASTINT (mask
, modifiers
);
6292 elements
= list2 (unmodified
, mask
);
6294 /* Cache the parsing results on SYMBOL. */
6295 Fput (symbol
, Qevent_symbol_element_mask
,
6297 Fput (symbol
, Qevent_symbol_elements
,
6298 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6300 /* Since we know that SYMBOL is modifiers applied to unmodified,
6301 it would be nice to put that in unmodified's cache.
6302 But we can't, since we're not sure that parse_modifiers is
6309 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6310 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6311 doc
: /* Parse the event symbol. For internal use. */)
6312 (Lisp_Object symbol
)
6314 /* Fill the cache if needed. */
6315 parse_modifiers (symbol
);
6316 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6317 and use the Lispier representation stored on Qevent_symbol_elements
6319 return Fget (symbol
, Qevent_symbol_elements
);
6322 /* Apply the modifiers MODIFIERS to the symbol BASE.
6323 BASE must be unmodified.
6325 This is like apply_modifiers_uncached, but uses BASE's
6326 Qmodifier_cache property, if present.
6328 apply_modifiers copies the value of BASE's Qevent_kind property to
6329 the modified symbol. */
6331 apply_modifiers (int modifiers
, Lisp_Object base
)
6333 Lisp_Object cache
, idx
, entry
, new_symbol
;
6335 /* Mask out upper bits. We don't know where this value's been. */
6336 modifiers
&= INTMASK
;
6338 if (INTEGERP (base
))
6339 return make_number (XINT (base
) | modifiers
);
6341 /* The click modifier never figures into cache indices. */
6342 cache
= Fget (base
, Qmodifier_cache
);
6343 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6344 entry
= assq_no_quit (idx
, cache
);
6347 new_symbol
= XCDR (entry
);
6350 /* We have to create the symbol ourselves. */
6351 new_symbol
= apply_modifiers_uncached (modifiers
,
6352 SSDATA (SYMBOL_NAME (base
)),
6353 SCHARS (SYMBOL_NAME (base
)),
6354 SBYTES (SYMBOL_NAME (base
)));
6356 /* Add the new symbol to the base's cache. */
6357 entry
= Fcons (idx
, new_symbol
);
6358 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6360 /* We have the parsing info now for free, so we could add it to
6362 XSETFASTINT (idx, modifiers);
6363 Fput (new_symbol, Qevent_symbol_element_mask,
6365 Fput (new_symbol, Qevent_symbol_elements,
6366 Fcons (base, lispy_modifier_list (modifiers)));
6367 Sadly, this is only correct if `base' is indeed a base event,
6368 which is not necessarily the case. -stef */
6371 /* Make sure this symbol is of the same kind as BASE.
6373 You'd think we could just set this once and for all when we
6374 intern the symbol above, but reorder_modifiers may call us when
6375 BASE's property isn't set right; we can't assume that just
6376 because it has a Qmodifier_cache property it must have its
6377 Qevent_kind set right as well. */
6378 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6382 kind
= Fget (base
, Qevent_kind
);
6384 Fput (new_symbol
, Qevent_kind
, kind
);
6391 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6392 return a symbol with the modifiers placed in the canonical order.
6393 Canonical order is alphabetical, except for down and drag, which
6394 always come last. The 'click' modifier is never written out.
6396 Fdefine_key calls this to make sure that (for example) C-M-foo
6397 and M-C-foo end up being equivalent in the keymap. */
6400 reorder_modifiers (Lisp_Object symbol
)
6402 /* It's hopefully okay to write the code this way, since everything
6403 will soon be in caches, and no consing will be done at all. */
6406 parsed
= parse_modifiers (symbol
);
6407 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6412 /* For handling events, we often want to produce a symbol whose name
6413 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6414 to some base, like the name of a function key or mouse button.
6415 modify_event_symbol produces symbols of this sort.
6417 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6418 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6421 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6422 into symbol names, or a string specifying a name stem used to
6423 construct a symbol name or the form `STEM-N', where N is the decimal
6424 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6425 non-nil; otherwise NAME_TABLE is used.
6427 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6428 persist between calls to modify_event_symbol that it can use to
6429 store a cache of the symbols it's generated for this NAME_TABLE
6430 before. The object stored there may be a vector or an alist.
6432 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6434 MODIFIERS is a set of modifier bits (as given in struct input_events)
6435 whose prefixes should be applied to the symbol name.
6437 SYMBOL_KIND is the value to be placed in the event_kind property of
6438 the returned symbol.
6440 The symbols we create are supposed to have an
6441 `event-symbol-elements' property, which lists the modifiers present
6442 in the symbol's name. */
6445 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6446 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6447 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6450 Lisp_Object symbol_int
;
6452 /* Get rid of the "vendor-specific" bit here. */
6453 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6455 /* Is this a request for a valid symbol? */
6456 if (symbol_num
< 0 || symbol_num
>= table_size
)
6459 if (CONSP (*symbol_table
))
6460 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6462 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6463 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6464 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6465 we've never used that symbol before. */
6468 if (! VECTORP (*symbol_table
)
6469 || ASIZE (*symbol_table
) != table_size
)
6473 XSETFASTINT (size
, table_size
);
6474 *symbol_table
= Fmake_vector (size
, Qnil
);
6477 value
= AREF (*symbol_table
, symbol_num
);
6480 /* Have we already used this symbol before? */
6483 /* No; let's create it. */
6484 if (CONSP (name_alist_or_stem
))
6485 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6486 else if (STRINGP (name_alist_or_stem
))
6489 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6490 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6492 buf
= SAFE_ALLOCA (len
);
6493 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6494 XINT (symbol_int
) + 1);
6495 value
= intern (buf
);
6498 else if (name_table
!= 0 && name_table
[symbol_num
])
6499 value
= intern (name_table
[symbol_num
]);
6501 #ifdef HAVE_WINDOW_SYSTEM
6504 char *name
= x_get_keysym_name (symbol_num
);
6506 value
= intern (name
);
6512 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6513 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6514 value
= intern (buf
);
6517 if (CONSP (*symbol_table
))
6518 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6520 ASET (*symbol_table
, symbol_num
, value
);
6522 /* Fill in the cache entries for this symbol; this also
6523 builds the Qevent_symbol_elements property, which the user
6525 apply_modifiers (modifiers
& click_modifier
, value
);
6526 Fput (value
, Qevent_kind
, symbol_kind
);
6529 /* Apply modifiers to that symbol. */
6530 return apply_modifiers (modifiers
, value
);
6533 /* Convert a list that represents an event type,
6534 such as (ctrl meta backspace), into the usual representation of that
6535 event type as a number or a symbol. */
6537 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6538 doc
: /* Convert the event description list EVENT-DESC to an event type.
6539 EVENT-DESC should contain one base event type (a character or symbol)
6540 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6541 drag, down, double or triple). The base must be last.
6542 The return value is an event type (a character or symbol) which
6543 has the same base event type and all the specified modifiers. */)
6544 (Lisp_Object event_desc
)
6552 while (CONSP (rest
))
6560 /* Given a symbol, see if it is a modifier name. */
6561 if (SYMBOLP (elt
) && CONSP (rest
))
6562 this = parse_solitary_modifier (elt
);
6566 else if (!NILP (base
))
6567 error ("Two bases given in one event");
6573 /* Let the symbol A refer to the character A. */
6574 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6575 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6577 if (INTEGERP (base
))
6579 /* Turn (shift a) into A. */
6580 if ((modifiers
& shift_modifier
) != 0
6581 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6583 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6584 modifiers
&= ~shift_modifier
;
6587 /* Turn (control a) into C-a. */
6588 if (modifiers
& ctrl_modifier
)
6589 return make_number ((modifiers
& ~ctrl_modifier
)
6590 | make_ctrl_char (XINT (base
)));
6592 return make_number (modifiers
| XINT (base
));
6594 else if (SYMBOLP (base
))
6595 return apply_modifiers (modifiers
, base
);
6597 error ("Invalid base event");
6600 /* Try to recognize SYMBOL as a modifier name.
6601 Return the modifier flag bit, or 0 if not recognized. */
6604 parse_solitary_modifier (Lisp_Object symbol
)
6606 Lisp_Object name
= SYMBOL_NAME (symbol
);
6608 switch (SREF (name
, 0))
6610 #define SINGLE_LETTER_MOD(BIT) \
6611 if (SBYTES (name) == 1) \
6614 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6615 if (LEN == SBYTES (name) \
6616 && ! memcmp (SDATA (name), NAME, LEN)) \
6620 SINGLE_LETTER_MOD (alt_modifier
);
6624 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6628 SINGLE_LETTER_MOD (ctrl_modifier
);
6632 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6633 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6637 SINGLE_LETTER_MOD (hyper_modifier
);
6641 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6645 SINGLE_LETTER_MOD (meta_modifier
);
6649 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6653 SINGLE_LETTER_MOD (shift_modifier
);
6657 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6658 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6659 SINGLE_LETTER_MOD (super_modifier
);
6663 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6664 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6665 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6669 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6673 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6676 #undef SINGLE_LETTER_MOD
6677 #undef MULTI_LETTER_MOD
6683 /* Return true if EVENT is a list whose elements are all integers or symbols.
6684 Such a list is not valid as an event,
6685 but it can be a Lucid-style event type list. */
6688 lucid_event_type_list_p (Lisp_Object object
)
6692 if (! CONSP (object
))
6695 if (EQ (XCAR (object
), Qhelp_echo
)
6696 || EQ (XCAR (object
), Qvertical_line
)
6697 || EQ (XCAR (object
), Qmode_line
)
6698 || EQ (XCAR (object
), Qheader_line
))
6701 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6705 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6712 /* Return true if terminal input chars are available.
6713 Also, store the return value into INPUT_PENDING.
6715 Serves the purpose of ioctl (0, FIONREAD, ...)
6716 but works even if FIONREAD does not exist.
6717 (In fact, this may actually read some input.)
6719 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6720 timer events that are ripe.
6721 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6722 events (FOCUS_IN_EVENT).
6723 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6724 movements and toolkit scroll bar thumb drags. */
6727 get_input_pending (int flags
)
6729 /* First of all, have we already counted some input? */
6730 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6732 /* If input is being read as it arrives, and we have none, there is none. */
6733 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6735 /* Try to read some input and see how much we get. */
6737 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6740 return input_pending
;
6743 /* Put a BUFFER_SWITCH_EVENT in the buffer
6744 so that read_key_sequence will notice the new current buffer. */
6747 record_asynch_buffer_change (void)
6749 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6750 The purpose of the event is to make read_key_sequence look up the
6751 keymaps again. If we aren't in read_key_sequence, we don't need one,
6752 and the event could cause trouble by messing up (input-pending-p).
6753 Note: Fwaiting_for_user_input_p always returns nil when async
6754 subprocesses aren't supported. */
6755 if (!NILP (Fwaiting_for_user_input_p ()))
6757 struct input_event event
;
6760 event
.kind
= BUFFER_SWITCH_EVENT
;
6761 event
.frame_or_window
= Qnil
;
6764 /* Make sure no interrupt happens while storing the event. */
6766 if (interrupt_input
)
6767 kbd_buffer_store_event (&event
);
6772 kbd_buffer_store_event (&event
);
6778 /* Read any terminal input already buffered up by the system
6779 into the kbd_buffer, but do not wait.
6781 Return the number of keyboard chars read, or -1 meaning
6782 this is a bad time to try to read input. */
6791 /* Store pending user signal events, if any. */
6792 store_user_signal_events ();
6794 /* Loop through the available terminals, and call their input hooks. */
6798 struct terminal
*next
= t
->next_terminal
;
6800 if (t
->read_socket_hook
)
6803 struct input_event hold_quit
;
6805 if (input_blocked_p ())
6807 pending_signals
= true;
6811 EVENT_INIT (hold_quit
);
6812 hold_quit
.kind
= NO_EVENT
;
6814 /* No need for FIONREAD or fcntl; just say don't wait. */
6815 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6818 if (nr
== -1) /* Not OK to read input now. */
6822 else if (nr
== -2) /* Non-transient error. */
6824 /* The terminal device terminated; it should be closed. */
6826 /* Kill Emacs if this was our last terminal. */
6827 if (!terminal_list
->next_terminal
)
6828 /* Formerly simply reported no input, but that
6829 sometimes led to a failure of Emacs to terminate.
6830 SIGHUP seems appropriate if we can't reach the
6832 /* ??? Is it really right to send the signal just to
6833 this process rather than to the whole process
6834 group? Perhaps on systems with FIONREAD Emacs is
6835 alone in its group. */
6836 terminate_due_to_signal (SIGHUP
, 10);
6838 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6841 XSETTERMINAL (tmp
, t
);
6842 Fdelete_terminal (tmp
, Qnoelisp
);
6846 /* If there was no error, make sure the pointer
6847 is visible for all frames on this terminal. */
6850 Lisp_Object tail
, frame
;
6852 FOR_EACH_FRAME (tail
, frame
)
6854 struct frame
*f
= XFRAME (frame
);
6855 if (FRAME_TERMINAL (f
) == t
)
6856 frame_make_pointer_visible (f
);
6860 if (hold_quit
.kind
!= NO_EVENT
)
6861 kbd_buffer_store_event (&hold_quit
);
6873 /* This is the tty way of reading available input.
6875 Note that each terminal device has its own `struct terminal' object,
6876 and so this function is called once for each individual termcap
6877 terminal. The first parameter indicates which terminal to read from. */
6880 tty_read_avail_input (struct terminal
*terminal
,
6881 struct input_event
*hold_quit
)
6883 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6884 the kbd_buffer can really hold. That may prevent loss
6885 of characters on some systems when input is stuffed at us. */
6886 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6888 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6891 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6893 if (kbd_on_hold_p () || buffer_free
<= 0)
6895 #endif /* subprocesses */
6897 if (!terminal
->name
) /* Don't read from a dead terminal. */
6900 if (terminal
->type
!= output_termcap
6901 && terminal
->type
!= output_msdos_raw
)
6904 /* XXX I think the following code should be moved to separate hook
6905 functions in system-dependent files. */
6907 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6908 code sets read_socket_hook to w32_console_read_socket instead! */
6910 #else /* not WINDOWSNT */
6911 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6915 return 0; /* The terminal is suspended. */
6918 n_to_read
= dos_keysns ();
6922 cbuf
[0] = dos_keyread ();
6925 #else /* not MSDOS */
6930 struct input_event gpm_hold_quit
;
6931 int gpm
, fd
= gpm_fd
;
6933 EVENT_INIT (gpm_hold_quit
);
6934 gpm_hold_quit
.kind
= NO_EVENT
;
6936 /* gpm==1 if event received.
6937 gpm==0 if the GPM daemon has closed the connection, in which case
6938 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6939 we save it in `fd' so close_gpm can remove it from the
6941 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6942 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6943 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6946 /* Presumably the GPM daemon has closed the connection. */
6948 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6949 kbd_buffer_store_event (&gpm_hold_quit
);
6953 #endif /* HAVE_GPM */
6955 /* Determine how many characters we should *try* to read. */
6956 #ifdef USABLE_FIONREAD
6957 /* Find out how much input is available. */
6958 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6960 if (! noninteractive
)
6961 return -2; /* Close this terminal. */
6967 if (n_to_read
> sizeof cbuf
)
6968 n_to_read
= sizeof cbuf
;
6969 #elif defined USG || defined CYGWIN
6970 /* Read some input if available, but don't wait. */
6971 n_to_read
= sizeof cbuf
;
6972 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6974 # error "Cannot read without possibly delaying"
6978 /* Don't read more than we can store. */
6979 if (n_to_read
> buffer_free
)
6980 n_to_read
= buffer_free
;
6981 #endif /* subprocesses */
6983 /* Now read; for one reason or another, this will not block.
6984 NREAD is set to the number of chars read. */
6987 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6988 /* POSIX infers that processes which are not in the session leader's
6989 process group won't get SIGHUPs at logout time. BSDI adheres to
6990 this part standard and returns -1 from read (0) with errno==EIO
6991 when the control tty is taken away.
6992 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6993 if (nread
== -1 && errno
== EIO
)
6994 return -2; /* Close this terminal. */
6995 #if defined (AIX) && defined (_BSD)
6996 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6997 This looks incorrect, but it isn't, because _BSD causes
6998 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6999 and that causes a value other than 0 when there is no input. */
7001 return -2; /* Close this terminal. */
7005 /* We used to retry the read if it was interrupted.
7006 But this does the wrong thing when O_NONBLOCK causes
7007 an EAGAIN error. Does anybody know of a situation
7008 where a retry is actually needed? */
7010 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7020 #ifndef USABLE_FIONREAD
7021 #if defined (USG) || defined (CYGWIN)
7022 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7023 #endif /* USG or CYGWIN */
7024 #endif /* no FIONREAD */
7029 #endif /* not MSDOS */
7030 #endif /* not WINDOWSNT */
7032 for (i
= 0; i
< nread
; i
++)
7034 struct input_event buf
;
7036 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7038 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7039 buf
.modifiers
= meta_modifier
;
7040 if (tty
->meta_key
!= 2)
7044 /* Set the frame corresponding to the active tty. Note that the
7045 value of selected_frame is not reliable here, redisplay tends
7046 to temporarily change it. */
7047 buf
.frame_or_window
= tty
->top_frame
;
7050 kbd_buffer_store_event (&buf
);
7051 /* Don't look at input that follows a C-g too closely.
7052 This reduces lossage due to autorepeat on C-g. */
7053 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7054 && buf
.code
== quit_char
)
7062 handle_async_input (void)
7067 int nread
= gobble_input ();
7068 /* -1 means it's not ok to read the input now.
7069 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7070 0 means there was no keyboard input available. */
7078 process_pending_signals (void)
7080 pending_signals
= false;
7081 handle_async_input ();
7082 do_pending_atimers ();
7085 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7086 and reinvoke any pending signal if the level is now 0 and
7087 a fatal error is not already in progress. */
7090 unblock_input_to (int level
)
7092 interrupt_input_blocked
= level
;
7095 if (pending_signals
&& !fatal_error_in_progress
)
7096 process_pending_signals ();
7102 /* End critical section.
7104 If doing signal-driven input, and a signal came in when input was
7105 blocked, reinvoke the signal handler now to deal with it.
7107 It will also process queued input, if it was not read before.
7108 When a longer code sequence does not use block/unblock input
7109 at all, the whole input gathered up to the next call to
7110 unblock_input will be processed inside that call. */
7113 unblock_input (void)
7115 unblock_input_to (interrupt_input_blocked
- 1);
7118 /* Undo any number of BLOCK_INPUT calls,
7119 and also reinvoke any pending signal. */
7122 totally_unblock_input (void)
7124 unblock_input_to (0);
7130 handle_input_available_signal (int sig
)
7132 pending_signals
= true;
7134 if (input_available_clear_time
)
7135 *input_available_clear_time
= make_timespec (0, 0);
7139 deliver_input_available_signal (int sig
)
7141 deliver_process_signal (sig
, handle_input_available_signal
);
7143 #endif /* USABLE_SIGIO */
7146 /* User signal events. */
7148 struct user_signal_info
7150 /* Signal number. */
7153 /* Name of the signal. */
7156 /* Number of pending signals. */
7159 struct user_signal_info
*next
;
7162 /* List of user signals. */
7163 static struct user_signal_info
*user_signals
= NULL
;
7166 add_user_signal (int sig
, const char *name
)
7168 struct sigaction action
;
7169 struct user_signal_info
*p
;
7171 for (p
= user_signals
; p
; p
= p
->next
)
7173 /* Already added. */
7176 p
= xmalloc (sizeof *p
);
7178 p
->name
= xstrdup (name
);
7180 p
->next
= user_signals
;
7183 emacs_sigaction_init (&action
, deliver_user_signal
);
7184 sigaction (sig
, &action
, 0);
7188 handle_user_signal (int sig
)
7190 struct user_signal_info
*p
;
7191 const char *special_event_name
= NULL
;
7193 if (SYMBOLP (Vdebug_on_event
))
7194 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7196 for (p
= user_signals
; p
; p
= p
->next
)
7199 if (special_event_name
7200 && strcmp (special_event_name
, p
->name
) == 0)
7202 /* Enter the debugger in many ways. */
7203 debug_on_next_call
= true;
7204 debug_on_quit
= true;
7206 Vinhibit_quit
= Qnil
;
7208 /* Eat the event. */
7214 if (interrupt_input
)
7215 handle_input_available_signal (sig
);
7219 /* Tell wait_reading_process_output that it needs to wake
7220 up and look around. */
7221 if (input_available_clear_time
)
7222 *input_available_clear_time
= make_timespec (0, 0);
7229 deliver_user_signal (int sig
)
7231 deliver_process_signal (sig
, handle_user_signal
);
7235 find_user_signal_name (int sig
)
7237 struct user_signal_info
*p
;
7239 for (p
= user_signals
; p
; p
= p
->next
)
7247 store_user_signal_events (void)
7249 struct user_signal_info
*p
;
7250 struct input_event buf
;
7251 bool buf_initialized
= false;
7253 for (p
= user_signals
; p
; p
= p
->next
)
7254 if (p
->npending
> 0)
7256 if (! buf_initialized
)
7258 memset (&buf
, 0, sizeof buf
);
7259 buf
.kind
= USER_SIGNAL_EVENT
;
7260 buf
.frame_or_window
= selected_frame
;
7261 buf_initialized
= true;
7267 kbd_buffer_store_event (&buf
);
7270 while (p
->npending
> 0);
7275 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7276 static Lisp_Object menu_bar_one_keymap_changed_items
;
7278 /* These variables hold the vector under construction within
7279 menu_bar_items and its subroutines, and the current index
7280 for storing into that vector. */
7281 static Lisp_Object menu_bar_items_vector
;
7282 static int menu_bar_items_index
;
7285 static const char *separator_names
[] = {
7290 "single-dashed-line",
7291 "double-dashed-line",
7293 "shadow-etched-out",
7294 "shadow-etched-in-dash",
7295 "shadow-etched-out-dash",
7296 "shadow-double-etched-in",
7297 "shadow-double-etched-out",
7298 "shadow-double-etched-in-dash",
7299 "shadow-double-etched-out-dash",
7303 /* Return true if LABEL specifies a separator. */
7306 menu_separator_name_p (const char *label
)
7310 else if (strlen (label
) > 3
7311 && memcmp (label
, "--", 2) == 0
7316 for (i
= 0; separator_names
[i
]; ++i
)
7317 if (strcmp (label
, separator_names
[i
]) == 0)
7322 /* It's a separator if it contains only dashes. */
7323 while (*label
== '-')
7325 return (*label
== 0);
7332 /* Return a vector of menu items for a menu bar, appropriate
7333 to the current buffer. Each item has three elements in the vector:
7336 OLD is an old vector we can optionally reuse, or nil. */
7339 menu_bar_items (Lisp_Object old
)
7341 /* The number of keymaps we're scanning right now, and the number of
7342 keymaps we have allocated space for. */
7345 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7346 in the current keymaps, or nil where it is not a prefix. */
7349 Lisp_Object mapsbuf
[3];
7350 Lisp_Object def
, tail
;
7357 /* In order to build the menus, we need to call the keymap
7358 accessors. They all call QUIT. But this function is called
7359 during redisplay, during which a quit is fatal. So inhibit
7360 quitting while building the menus.
7361 We do this instead of specbind because (1) errors will clear it anyway
7362 and (2) this avoids risk of specpdl overflow. */
7363 oquit
= Vinhibit_quit
;
7367 menu_bar_items_vector
= old
;
7369 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7370 menu_bar_items_index
= 0;
7372 /* Build our list of keymaps.
7373 If we recognize a function key and replace its escape sequence in
7374 keybuf with its symbol, or if the sequence starts with a mouse
7375 click and we need to switch buffers, we jump back here to rebuild
7376 the initial keymaps from the current buffer. */
7380 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7381 if (!NILP (Voverriding_local_map_menu_flag
)
7382 && !NILP (Voverriding_local_map
))
7384 /* Yes, use them (if non-nil) as well as the global map. */
7387 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7388 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7389 if (!NILP (Voverriding_local_map
))
7390 maps
[nmaps
++] = Voverriding_local_map
;
7394 /* No, so use major and minor mode keymaps and keymap property.
7395 Note that menu-bar bindings in the local-map and keymap
7396 properties may not work reliable, as they are only
7397 recognized when the menu-bar (or mode-line) is updated,
7398 which does not normally happen after every command. */
7399 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7400 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7402 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7403 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7404 maps
[nmaps
++] = tem
;
7405 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7406 maps
[nmaps
++] = tem
;
7409 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7412 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7414 maps
[nmaps
++] = current_global_map
;
7417 /* Look up in each map the dummy prefix key `menu-bar'. */
7419 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7420 if (!NILP (maps
[mapno
]))
7422 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7426 menu_bar_one_keymap_changed_items
= Qnil
;
7427 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7431 /* Move to the end those items that should be at the end. */
7433 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7436 int end
= menu_bar_items_index
;
7438 for (i
= 0; i
< end
; i
+= 4)
7439 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7441 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7442 /* Move the item at index I to the end,
7443 shifting all the others forward. */
7444 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7445 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7446 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7447 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7449 memmove (aref_addr (menu_bar_items_vector
, i
),
7450 aref_addr (menu_bar_items_vector
, i
+ 4),
7451 (end
- i
- 4) * word_size
);
7452 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7453 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7454 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7455 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7460 /* Add nil, nil, nil, nil at the end. */
7462 int i
= menu_bar_items_index
;
7463 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7464 menu_bar_items_vector
7465 = larger_vector (menu_bar_items_vector
, 4, -1);
7466 /* Add this item. */
7467 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7468 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7469 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7470 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7471 menu_bar_items_index
= i
;
7474 Vinhibit_quit
= oquit
;
7476 return menu_bar_items_vector
;
7479 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7480 If there's already an item for KEY, add this DEF to it. */
7482 Lisp_Object item_properties
;
7485 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7491 if (EQ (item
, Qundefined
))
7493 /* If a map has an explicit `undefined' as definition,
7494 discard any previously made menu bar item. */
7496 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7497 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7499 if (menu_bar_items_index
> i
+ 4)
7500 memmove (aref_addr (menu_bar_items_vector
, i
),
7501 aref_addr (menu_bar_items_vector
, i
+ 4),
7502 (menu_bar_items_index
- i
- 4) * word_size
);
7503 menu_bar_items_index
-= 4;
7507 /* If this keymap has already contributed to this KEY,
7508 don't contribute to it a second time. */
7509 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7510 if (!NILP (tem
) || NILP (item
))
7513 menu_bar_one_keymap_changed_items
7514 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7516 /* We add to menu_bar_one_keymap_changed_items before doing the
7517 parse_menu_item, so that if it turns out it wasn't a menu item,
7518 it still correctly hides any further menu item. */
7519 parsed
= parse_menu_item (item
, 1);
7523 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7525 /* Find any existing item for this KEY. */
7526 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7527 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7530 /* If we did not find this KEY, add it at the end. */
7531 if (i
== menu_bar_items_index
)
7533 /* If vector is too small, get a bigger one. */
7534 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7535 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7536 /* Add this item. */
7537 ASET (menu_bar_items_vector
, i
, key
); i
++;
7538 ASET (menu_bar_items_vector
, i
,
7539 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7540 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7541 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7542 menu_bar_items_index
= i
;
7544 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7548 old
= AREF (menu_bar_items_vector
, i
+ 2);
7549 /* If the new and the old items are not both keymaps,
7550 the lookup will only find `item'. */
7551 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7552 ASET (menu_bar_items_vector
, i
+ 2, item
);
7556 /* This is used as the handler when calling menu_item_eval_property. */
7558 menu_item_eval_property_1 (Lisp_Object arg
)
7560 /* If we got a quit from within the menu computation,
7561 quit all the way out of it. This takes care of C-] in the debugger. */
7562 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7563 Fsignal (Qquit
, Qnil
);
7569 eval_dyn (Lisp_Object form
)
7571 return Feval (form
, Qnil
);
7574 /* Evaluate an expression and return the result (or nil if something
7575 went wrong). Used to evaluate dynamic parts of menu items. */
7577 menu_item_eval_property (Lisp_Object sexpr
)
7579 ptrdiff_t count
= SPECPDL_INDEX ();
7581 specbind (Qinhibit_redisplay
, Qt
);
7582 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7583 menu_item_eval_property_1
);
7584 return unbind_to (count
, val
);
7587 /* This function parses a menu item and leaves the result in the
7588 vector item_properties.
7589 ITEM is a key binding, a possible menu item.
7590 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7592 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7593 parse_menu_item returns true if the item is a menu item and false
7597 parse_menu_item (Lisp_Object item
, int inmenubar
)
7599 Lisp_Object def
, tem
, item_string
, start
;
7601 Lisp_Object keyhint
;
7610 /* Create item_properties vector if necessary. */
7611 if (NILP (item_properties
))
7613 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7615 /* Initialize optional entries. */
7616 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7617 ASET (item_properties
, i
, Qnil
);
7618 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7620 /* Save the item here to protect it from GC. */
7621 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7623 item_string
= XCAR (item
);
7627 if (STRINGP (item_string
))
7629 /* Old format menu item. */
7630 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7632 /* Maybe help string. */
7633 if (CONSP (item
) && STRINGP (XCAR (item
)))
7635 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7636 Fsubstitute_command_keys (XCAR (item
)));
7641 /* Maybe an obsolete key binding cache. */
7642 if (CONSP (item
) && CONSP (XCAR (item
))
7643 && (NILP (XCAR (XCAR (item
)))
7644 || VECTORP (XCAR (XCAR (item
)))))
7647 /* This is the real definition--the function to run. */
7648 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7650 /* Get enable property, if any. */
7653 tem
= Fget (item
, Qmenu_enable
);
7654 if (!NILP (Venable_disabled_menus_and_buttons
))
7655 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7656 else if (!NILP (tem
))
7657 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7660 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7662 /* New format menu item. */
7663 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7664 start
= XCDR (item
);
7667 /* We have a real binding. */
7668 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7670 item
= XCDR (start
);
7671 /* Is there an obsolete cache list with key equivalences. */
7672 if (CONSP (item
) && CONSP (XCAR (item
)))
7675 /* Parse properties. */
7676 while (CONSP (item
) && CONSP (XCDR (item
)))
7681 if (EQ (tem
, QCenable
))
7683 if (!NILP (Venable_disabled_menus_and_buttons
))
7684 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7686 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7688 else if (EQ (tem
, QCvisible
))
7690 /* If got a visible property and that evaluates to nil
7691 then ignore this item. */
7692 tem
= menu_item_eval_property (XCAR (item
));
7696 else if (EQ (tem
, QChelp
))
7698 Lisp_Object help
= XCAR (item
);
7700 help
= Fsubstitute_command_keys (help
);
7701 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7703 else if (EQ (tem
, QCfilter
))
7705 else if (EQ (tem
, QCkey_sequence
))
7708 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7709 /* Be GC protected. Set keyhint to item instead of tem. */
7712 else if (EQ (tem
, QCkeys
))
7715 if (CONSP (tem
) || STRINGP (tem
))
7716 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7718 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7723 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7725 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7727 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7733 else if (inmenubar
|| !NILP (start
))
7737 return 0; /* not a menu item */
7739 /* If item string is not a string, evaluate it to get string.
7740 If we don't get a string, skip this item. */
7741 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7742 if (!(STRINGP (item_string
)))
7744 item_string
= menu_item_eval_property (item_string
);
7745 if (!STRINGP (item_string
))
7747 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7750 /* If got a filter apply it on definition. */
7751 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7754 def
= menu_item_eval_property (list2 (XCAR (filter
),
7755 list2 (Qquote
, def
)));
7757 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7760 /* Enable or disable selection of item. */
7761 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7764 tem
= menu_item_eval_property (tem
);
7765 if (inmenubar
&& NILP (tem
))
7766 return 0; /* Ignore disabled items in menu bar. */
7767 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7770 /* If we got no definition, this item is just unselectable text which
7771 is OK in a submenu but not in the menubar. */
7773 return (!inmenubar
);
7775 /* See if this is a separate pane or a submenu. */
7776 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7777 tem
= get_keymap (def
, 0, 1);
7778 /* For a subkeymap, just record its details and exit. */
7781 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7782 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7786 /* At the top level in the menu bar, do likewise for commands also.
7787 The menu bar does not display equivalent key bindings anyway.
7788 ITEM_PROPERTY_DEF is already set up properly. */
7792 { /* This is a command. See if there is an equivalent key binding. */
7793 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7794 AUTO_STRING (space_space
, " ");
7796 /* The previous code preferred :key-sequence to :keys, so we
7797 preserve this behavior. */
7798 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7799 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7802 Lisp_Object prefix
= keyeq
;
7803 Lisp_Object keys
= Qnil
;
7807 def
= XCAR (prefix
);
7808 prefix
= XCDR (prefix
);
7811 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7813 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7815 keys
= XCAR (keyhint
);
7816 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7818 /* We have a suggested key. Is it bound to the command? */
7821 /* If the command is an alias for another
7822 (such as lmenu.el set it up), check if the
7823 original command matches the cached command. */
7825 && EQ (tem
, XSYMBOL (def
)->function
))))
7830 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7834 tem
= Fkey_description (keys
, Qnil
);
7837 if (STRINGP (XCAR (prefix
)))
7838 tem
= concat2 (XCAR (prefix
), tem
);
7839 if (STRINGP (XCDR (prefix
)))
7840 tem
= concat2 (tem
, XCDR (prefix
));
7842 keyeq
= concat2 (space_space
, tem
);
7848 /* If we have an equivalent key binding, use that. */
7849 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7852 /* Include this when menu help is implemented.
7853 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7854 if (!(NILP (tem) || STRINGP (tem)))
7856 tem = menu_item_eval_property (tem);
7859 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7863 /* Handle radio buttons or toggle boxes. */
7864 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7866 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7867 menu_item_eval_property (tem
));
7874 /***********************************************************************
7876 ***********************************************************************/
7878 /* A vector holding tool bar items while they are parsed in function
7879 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7882 static Lisp_Object tool_bar_items_vector
;
7884 /* A vector holding the result of parse_tool_bar_item. Layout is like
7885 the one for a single item in tool_bar_items_vector. */
7887 static Lisp_Object tool_bar_item_properties
;
7889 /* Next free index in tool_bar_items_vector. */
7891 static int ntool_bar_items
;
7893 /* Function prototypes. */
7895 static void init_tool_bar_items (Lisp_Object
);
7896 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7898 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7899 static void append_tool_bar_item (void);
7902 /* Return a vector of tool bar items for keymaps currently in effect.
7903 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7904 tool bar items found. */
7907 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7910 Lisp_Object mapsbuf
[3];
7918 /* In order to build the menus, we need to call the keymap
7919 accessors. They all call QUIT. But this function is called
7920 during redisplay, during which a quit is fatal. So inhibit
7921 quitting while building the menus. We do this instead of
7922 specbind because (1) errors will clear it anyway and (2) this
7923 avoids risk of specpdl overflow. */
7924 oquit
= Vinhibit_quit
;
7927 /* Initialize tool_bar_items_vector and protect it from GC. */
7928 init_tool_bar_items (reuse
);
7930 /* Build list of keymaps in maps. Set nmaps to the number of maps
7933 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7934 if (!NILP (Voverriding_local_map_menu_flag
)
7935 && !NILP (Voverriding_local_map
))
7937 /* Yes, use them (if non-nil) as well as the global map. */
7940 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7941 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7942 if (!NILP (Voverriding_local_map
))
7943 maps
[nmaps
++] = Voverriding_local_map
;
7947 /* No, so use major and minor mode keymaps and keymap property.
7948 Note that tool-bar bindings in the local-map and keymap
7949 properties may not work reliable, as they are only
7950 recognized when the tool-bar (or mode-line) is updated,
7951 which does not normally happen after every command. */
7952 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7953 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7955 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7956 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7957 maps
[nmaps
++] = tem
;
7958 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7959 maps
[nmaps
++] = tem
;
7962 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7965 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7968 /* Add global keymap at the end. */
7969 maps
[nmaps
++] = current_global_map
;
7971 /* Process maps in reverse order and look up in each map the prefix
7973 for (i
= nmaps
- 1; i
>= 0; --i
)
7974 if (!NILP (maps
[i
]))
7978 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7980 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7983 Vinhibit_quit
= oquit
;
7984 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7986 return tool_bar_items_vector
;
7990 /* Process the definition of KEY which is DEF. */
7993 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7997 if (EQ (def
, Qundefined
))
7999 /* If a map has an explicit `undefined' as definition,
8000 discard any previously made item. */
8001 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8003 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8005 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8007 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8008 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8009 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8011 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8016 else if (parse_tool_bar_item (key
, def
))
8017 /* Append a new tool bar item to tool_bar_items_vector. Accept
8018 more than one definition for the same key. */
8019 append_tool_bar_item ();
8022 /* Access slot with index IDX of vector tool_bar_item_properties. */
8023 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8025 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8027 ASET (tool_bar_item_properties
, idx
, val
);
8031 /* Parse a tool bar item specification ITEM for key KEY and return the
8032 result in tool_bar_item_properties. Value is false if ITEM is
8035 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8037 CAPTION is the caption of the item, If it's not a string, it is
8038 evaluated to get a string.
8040 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8041 as binding are currently ignored.
8043 The following properties are recognized:
8047 FORM is evaluated and specifies whether the tool bar item is
8048 enabled or disabled.
8052 FORM is evaluated and specifies whether the tool bar item is visible.
8054 - `:filter FUNCTION'
8056 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8057 result is stored as the new binding.
8059 - `:button (TYPE SELECTED)'
8061 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8062 and specifies whether the button is selected (pressed) or not.
8066 IMAGES is either a single image specification or a vector of four
8067 image specifications. See enum tool_bar_item_images.
8069 - `:help HELP-STRING'.
8071 Gives a help string to display for the tool bar item.
8073 - `:label LABEL-STRING'.
8075 A text label to show with the tool bar button if labels are enabled. */
8078 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8080 Lisp_Object filter
= Qnil
;
8081 Lisp_Object caption
;
8083 bool have_label
= false;
8085 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8086 Rule out items that aren't lists, don't start with
8087 `menu-item' or whose rest following `tool-bar-item' is not a
8092 /* As an exception, allow old-style menu separators. */
8093 if (STRINGP (XCAR (item
)))
8094 item
= list1 (XCAR (item
));
8095 else if (!EQ (XCAR (item
), Qmenu_item
)
8096 || (item
= XCDR (item
), !CONSP (item
)))
8099 /* Create tool_bar_item_properties vector if necessary. Reset it to
8101 if (VECTORP (tool_bar_item_properties
))
8103 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8107 tool_bar_item_properties
8108 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8111 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8112 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8114 /* Get the caption of the item. If the caption is not a string,
8115 evaluate it to get a string. If we don't get a string, skip this
8117 caption
= XCAR (item
);
8118 if (!STRINGP (caption
))
8120 caption
= menu_item_eval_property (caption
);
8121 if (!STRINGP (caption
))
8124 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8126 /* If the rest following the caption is not a list, the menu item is
8127 either a separator, or invalid. */
8131 if (menu_separator_name_p (SSDATA (caption
)))
8133 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8134 #if !defined (USE_GTK) && !defined (HAVE_NS)
8135 /* If we use build_desired_tool_bar_string to render the
8136 tool bar, the separator is rendered as an image. */
8137 set_prop (TOOL_BAR_ITEM_IMAGES
,
8138 (menu_item_eval_property
8139 (Vtool_bar_separator_image_expression
)));
8140 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8141 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8142 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8149 /* Store the binding. */
8150 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8153 /* Ignore cached key binding, if any. */
8154 if (CONSP (item
) && CONSP (XCAR (item
)))
8157 /* Process the rest of the properties. */
8158 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8160 Lisp_Object ikey
, value
;
8163 value
= XCAR (XCDR (item
));
8165 if (EQ (ikey
, QCenable
))
8167 /* `:enable FORM'. */
8168 if (!NILP (Venable_disabled_menus_and_buttons
))
8169 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8171 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8173 else if (EQ (ikey
, QCvisible
))
8175 /* `:visible FORM'. If got a visible property and that
8176 evaluates to nil then ignore this item. */
8177 if (NILP (menu_item_eval_property (value
)))
8180 else if (EQ (ikey
, QChelp
))
8181 /* `:help HELP-STRING'. */
8182 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8183 else if (EQ (ikey
, QCvert_only
))
8184 /* `:vert-only t/nil'. */
8185 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8186 else if (EQ (ikey
, QClabel
))
8188 const char *bad_label
= "!!?GARBLED ITEM?!!";
8189 /* `:label LABEL-STRING'. */
8190 set_prop (TOOL_BAR_ITEM_LABEL
,
8191 STRINGP (value
) ? value
: build_string (bad_label
));
8194 else if (EQ (ikey
, QCfilter
))
8195 /* ':filter FORM'. */
8197 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8199 /* `:button (TYPE . SELECTED)'. */
8200 Lisp_Object type
, selected
;
8202 type
= XCAR (value
);
8203 selected
= XCDR (value
);
8204 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8206 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8207 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8210 else if (EQ (ikey
, QCimage
)
8212 || (VECTORP (value
) && ASIZE (value
) == 4)))
8213 /* Value is either a single image specification or a vector
8214 of 4 such specifications for the different button states. */
8215 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8216 else if (EQ (ikey
, QCrtl
))
8218 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8224 /* Try to make one from caption and key. */
8225 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8226 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8227 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8228 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8230 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8231 char *buf
= xmalloc (max_lbl
+ 1);
8232 Lisp_Object new_lbl
;
8233 ptrdiff_t caption_len
= strlen (capt
);
8235 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8238 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8240 buf
[caption_len
] = '\0';
8244 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8248 strcpy (buf
, label
);
8250 for (j
= 0; buf
[j
] != '\0'; ++j
)
8258 new_lbl
= Fupcase_initials (build_string (label
));
8259 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8260 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8262 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8266 /* If got a filter apply it on binding. */
8268 set_prop (TOOL_BAR_ITEM_BINDING
,
8269 (menu_item_eval_property
8272 PROP (TOOL_BAR_ITEM_BINDING
))))));
8274 /* See if the binding is a keymap. Give up if it is. */
8275 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8278 /* Enable or disable selection of item. */
8279 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8280 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8281 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8283 /* Handle radio buttons or toggle boxes. */
8284 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8285 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8286 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8294 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8295 that can be reused. */
8298 init_tool_bar_items (Lisp_Object reuse
)
8300 if (VECTORP (reuse
))
8301 tool_bar_items_vector
= reuse
;
8303 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8304 ntool_bar_items
= 0;
8308 /* Append parsed tool bar item properties from
8309 tool_bar_item_properties */
8312 append_tool_bar_item (void)
8316 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8318 /* Enlarge tool_bar_items_vector if necessary. */
8320 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8322 /* Append entries from tool_bar_item_properties to the end of
8323 tool_bar_items_vector. */
8324 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8325 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8326 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8333 /* Read a character using menus based on the keymap MAP.
8334 Return nil if there are no menus in the maps.
8335 Return t if we displayed a menu but the user rejected it.
8337 PREV_EVENT is the previous input event, or nil if we are reading
8338 the first event of a key sequence.
8340 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8341 if we used a mouse menu to read the input, or false otherwise. If
8342 USED_MOUSE_MENU is null, don't dereference it.
8344 The prompting is done based on the prompt-string of the map
8345 and the strings associated with various map elements.
8347 This can be done with X menus or with menus put in the minibuf.
8348 These are done in different ways, depending on how the input will be read.
8349 Menus using X are done after auto-saving in read-char, getting the input
8350 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8351 and do auto-saving in the inner call of read_char. */
8354 read_char_x_menu_prompt (Lisp_Object map
,
8355 Lisp_Object prev_event
, bool *used_mouse_menu
)
8357 if (used_mouse_menu
)
8358 *used_mouse_menu
= false;
8360 /* Use local over global Menu maps. */
8362 if (! menu_prompting
)
8365 /* If we got to this point via a mouse click,
8366 use a real menu for mouse selection. */
8367 if (EVENT_HAS_PARAMETERS (prev_event
)
8368 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8369 && !EQ (XCAR (prev_event
), Qtool_bar
))
8371 /* Display the menu and get the selection. */
8374 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8379 record_menu_key (XCAR (value
));
8381 /* If we got multiple events, unread all but
8383 There is no way to prevent those unread events
8384 from showing up later in last_nonmenu_event.
8385 So turn symbol and integer events into lists,
8386 to indicate that they came from a mouse menu,
8387 so that when present in last_nonmenu_event
8388 they won't confuse things. */
8389 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8391 record_menu_key (XCAR (tem
));
8392 if (SYMBOLP (XCAR (tem
))
8393 || INTEGERP (XCAR (tem
)))
8394 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8397 /* If we got more than one event, put all but the first
8398 onto this list to be read later.
8399 Return just the first event now. */
8400 Vunread_command_events
8401 = nconc2 (XCDR (value
), Vunread_command_events
);
8402 value
= XCAR (value
);
8404 else if (NILP (value
))
8406 if (used_mouse_menu
)
8407 *used_mouse_menu
= true;
8414 read_char_minibuf_menu_prompt (int commandflag
,
8419 /* FIXME: Use the minibuffer's frame width. */
8420 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8422 bool nobindings
= true;
8423 Lisp_Object rest
, vector
;
8424 Lisp_Object prompt_strings
= Qnil
;
8428 if (! menu_prompting
)
8431 map
= get_keymap (map
, 0, 1);
8432 name
= Fkeymap_prompt (map
);
8434 /* If we don't have any menus, just read a character normally. */
8435 if (!STRINGP (name
))
8438 #define PUSH_C_STR(str, listvar) \
8439 listvar = Fcons (build_unibyte_string (str), listvar)
8441 /* Prompt string always starts with map's prompt, and a space. */
8442 prompt_strings
= Fcons (name
, prompt_strings
);
8443 PUSH_C_STR (": ", prompt_strings
);
8444 nlength
= SCHARS (name
) + 2;
8448 /* Present the documented bindings, a line at a time. */
8451 bool notfirst
= false;
8452 Lisp_Object menu_strings
= prompt_strings
;
8453 ptrdiff_t i
= nlength
;
8455 Lisp_Object orig_defn_macro
;
8457 /* Loop over elements of map. */
8462 /* FIXME: Use map_keymap to handle new keymap formats. */
8464 /* At end of map, wrap around if just starting,
8465 or end this line if already have something on it. */
8468 if (notfirst
|| nobindings
)
8474 /* Look at the next element of the map. */
8476 elt
= AREF (vector
, idx
);
8478 elt
= Fcar_safe (rest
);
8480 if (idx
< 0 && VECTORP (elt
))
8482 /* If we found a dense table in the keymap,
8483 advanced past it, but start scanning its contents. */
8484 rest
= Fcdr_safe (rest
);
8490 /* An ordinary element. */
8491 Lisp_Object event
, tem
;
8495 event
= Fcar_safe (elt
); /* alist */
8496 elt
= Fcdr_safe (elt
);
8500 XSETINT (event
, idx
); /* vector */
8503 /* Ignore the element if it has no prompt string. */
8504 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8506 /* True if the char to type matches the string. */
8508 Lisp_Object upcased_event
, downcased_event
;
8509 Lisp_Object desc
= Qnil
;
8511 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8513 upcased_event
= Fupcase (event
);
8514 downcased_event
= Fdowncase (event
);
8515 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8516 || XINT (downcased_event
) == SREF (s
, 0));
8518 desc
= Fsingle_key_description (event
, Qnil
);
8520 #if 0 /* It is redundant to list the equivalent key bindings because
8521 the prefix is what the user has already typed. */
8523 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8525 /* Insert equivalent keybinding. */
8526 s
= concat2 (s
, tem
);
8529 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8530 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8532 /* Insert button prefix. */
8533 Lisp_Object selected
8534 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8535 AUTO_STRING (radio_yes
, "(*) ");
8536 AUTO_STRING (radio_no
, "( ) ");
8537 AUTO_STRING (check_yes
, "[X] ");
8538 AUTO_STRING (check_no
, "[ ] ");
8539 if (EQ (tem
, QCradio
))
8540 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8542 tem
= NILP (selected
) ? check_yes
: check_no
;
8543 s
= concat2 (tem
, s
);
8547 /* If we have room for the prompt string, add it to this line.
8548 If this is the first on the line, always add it. */
8549 if ((SCHARS (s
) + i
+ 2
8550 + (char_matches
? 0 : SCHARS (desc
) + 3))
8554 ptrdiff_t thiswidth
;
8556 /* Punctuate between strings. */
8559 PUSH_C_STR (", ", menu_strings
);
8565 /* If the char to type doesn't match the string's
8566 first char, explicitly show what char to type. */
8569 /* Add as much of string as fits. */
8570 thiswidth
= min (SCHARS (desc
), width
- i
);
8572 = Fcons (Fsubstring (desc
, make_number (0),
8573 make_number (thiswidth
)),
8576 PUSH_C_STR (" = ", menu_strings
);
8580 /* Add as much of string as fits. */
8581 thiswidth
= min (SCHARS (s
), width
- i
);
8583 = Fcons (Fsubstring (s
, make_number (0),
8584 make_number (thiswidth
)),
8590 /* If this element does not fit, end the line now,
8591 and save the element for the next line. */
8592 PUSH_C_STR ("...", menu_strings
);
8597 /* Move past this element. */
8598 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8599 /* Handle reaching end of dense table. */
8604 rest
= Fcdr_safe (rest
);
8608 /* Prompt with that and read response. */
8609 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8611 /* Make believe it's not a keyboard macro in case the help char
8612 is pressed. Help characters are not recorded because menu prompting
8613 is not used on replay. */
8614 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8615 kset_defining_kbd_macro (current_kboard
, Qnil
);
8617 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8618 while (BUFFERP (obj
));
8619 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8621 if (!INTEGERP (obj
) || XINT (obj
) == -2
8622 || (! EQ (obj
, menu_prompt_more_char
)
8623 && (!INTEGERP (menu_prompt_more_char
)
8624 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8626 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8627 store_kbd_macro_char (obj
);
8630 /* Help char - go round again. */
8634 /* Reading key sequences. */
8637 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8639 return access_keymap (get_keymap (keymap
, 0, 1),
8644 active_maps (Lisp_Object first_event
)
8646 Lisp_Object position
8647 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8648 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8651 /* Structure used to keep track of partial application of key remapping
8652 such as Vfunction_key_map and Vkey_translation_map. */
8653 typedef struct keyremap
8655 /* This is the map originally specified for this use. */
8657 /* This is a submap reached by looking up, in PARENT,
8658 the events from START to END. */
8660 /* Positions [START, END) in the key sequence buffer
8661 are the key that we have scanned so far.
8662 Those events are the ones that we will replace
8663 if PARENT maps them into a key sequence. */
8667 /* Lookup KEY in MAP.
8668 MAP is a keymap mapping keys to key vectors or functions.
8669 If the mapping is a function and DO_FUNCALL is true,
8670 the function is called with PROMPT as parameter and its return
8671 value is used as the return value of this function (after checking
8672 that it is indeed a vector). */
8675 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8680 next
= access_keymap (map
, key
, 1, 0, 1);
8682 /* Handle a symbol whose function definition is a keymap
8684 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8685 && (ARRAYP (XSYMBOL (next
)->function
)
8686 || KEYMAPP (XSYMBOL (next
)->function
)))
8687 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8689 /* If the keymap gives a function, not an
8690 array, then call the function with one arg and use
8691 its value instead. */
8692 if (do_funcall
&& FUNCTIONP (next
))
8697 next
= call1 (next
, prompt
);
8698 /* If the function returned something invalid,
8699 barf--don't ignore it. */
8700 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8701 error ("Function %s returns invalid key sequence",
8702 SSDATA (SYMBOL_NAME (tem
)));
8707 /* Do one step of the key remapping used for function-key-map and
8708 key-translation-map:
8709 KEYBUF is the buffer holding the input events.
8710 BUFSIZE is its maximum size.
8711 FKEY is a pointer to the keyremap structure to use.
8712 INPUT is the index of the last element in KEYBUF.
8713 DOIT if true says that the remapping can actually take place.
8714 DIFF is used to return the number of keys added/removed by the remapping.
8715 PARENT is the root of the keymap.
8716 PROMPT is the prompt to use if the remapping happens through a function.
8717 Return true if the remapping actually took place. */
8720 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8721 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8723 Lisp_Object next
, key
;
8725 key
= keybuf
[fkey
->end
++];
8727 if (KEYMAPP (fkey
->parent
))
8728 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8732 /* If keybuf[fkey->start..fkey->end] is bound in the
8733 map and we're in a position to do the key remapping, replace it with
8734 the binding and restart with fkey->start at the end. */
8735 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8737 int len
= XFASTINT (Flength (next
));
8740 *diff
= len
- (fkey
->end
- fkey
->start
);
8742 if (bufsize
- input
<= *diff
)
8743 error ("Key sequence too long");
8745 /* Shift the keys that follow fkey->end. */
8747 for (i
= fkey
->end
; i
< input
; i
++)
8748 keybuf
[i
+ *diff
] = keybuf
[i
];
8750 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8751 keybuf
[i
+ *diff
] = keybuf
[i
];
8752 /* Overwrite the old keys with the new ones. */
8753 for (i
= 0; i
< len
; i
++)
8754 keybuf
[fkey
->start
+ i
]
8755 = Faref (next
, make_number (i
));
8757 fkey
->start
= fkey
->end
+= *diff
;
8758 fkey
->map
= fkey
->parent
;
8763 fkey
->map
= get_keymap (next
, 0, 1);
8765 /* If we no longer have a bound suffix, try a new position for
8767 if (!CONSP (fkey
->map
))
8769 fkey
->end
= ++fkey
->start
;
8770 fkey
->map
= fkey
->parent
;
8776 test_undefined (Lisp_Object binding
)
8778 return (NILP (binding
)
8779 || EQ (binding
, Qundefined
)
8780 || (SYMBOLP (binding
)
8781 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8784 /* Read a sequence of keys that ends with a non prefix character,
8785 storing it in KEYBUF, a buffer of size BUFSIZE.
8787 Return the length of the key sequence stored.
8788 Return -1 if the user rejected a command menu.
8790 Echo starting immediately unless `prompt' is 0.
8792 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8793 read_char with a suitable COMMANDFLAG argument.
8795 Where a key sequence ends depends on the currently active keymaps.
8796 These include any minor mode keymaps active in the current buffer,
8797 the current buffer's local map, and the global map.
8799 If a key sequence has no other bindings, we check Vfunction_key_map
8800 to see if some trailing subsequence might be the beginning of a
8801 function key's sequence. If so, we try to read the whole function
8802 key, and substitute its symbolic name into the key sequence.
8804 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8805 `double-' events into similar click events, if that would make them
8806 bound. We try to turn `triple-' events first into `double-' events,
8809 If we get a mouse click in a mode line, vertical divider, or other
8810 non-text area, we treat the click as if it were prefixed by the
8811 symbol denoting that area - `mode-line', `vertical-line', or
8814 If the sequence starts with a mouse click, we read the key sequence
8815 with respect to the buffer clicked on, not the current buffer.
8817 If the user switches frames in the midst of a key sequence, we put
8818 off the switch-frame event until later; the next call to
8819 read_char will return it.
8821 If FIX_CURRENT_BUFFER, we restore current_buffer
8822 from the selected window's buffer. */
8825 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8826 bool dont_downcase_last
, bool can_return_switch_frame
,
8827 bool fix_current_buffer
, bool prevent_redisplay
)
8829 ptrdiff_t count
= SPECPDL_INDEX ();
8831 /* How many keys there are in the current key sequence. */
8834 /* The length of the echo buffer when we started reading, and
8835 the length of this_command_keys when we started reading. */
8836 ptrdiff_t echo_start
IF_LINT (= 0);
8837 ptrdiff_t keys_start
;
8839 Lisp_Object current_binding
= Qnil
;
8840 Lisp_Object first_event
= Qnil
;
8842 /* Index of the first key that has no binding.
8843 It is useless to try fkey.start larger than that. */
8846 /* If t < mock_input, then KEYBUF[t] should be read as the next
8849 We use this to recover after recognizing a function key. Once we
8850 realize that a suffix of the current key sequence is actually a
8851 function key's escape sequence, we replace the suffix with the
8852 function key's binding from Vfunction_key_map. Now keybuf
8853 contains a new and different key sequence, so the echo area,
8854 this_command_keys, and the submaps and defs arrays are wrong. In
8855 this situation, we set mock_input to t, set t to 0, and jump to
8856 restart_sequence; the loop will read keys from keybuf up until
8857 mock_input, thus rebuilding the state; and then it will resume
8858 reading characters from the keyboard. */
8861 /* If the sequence is unbound in submaps[], then
8862 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8863 and fkey.map is its binding.
8865 These might be > t, indicating that all function key scanning
8866 should hold off until t reaches them. We do this when we've just
8867 recognized a function key, to avoid searching for the function
8868 key's again in Vfunction_key_map. */
8871 /* Likewise, for key_translation_map and input-decode-map. */
8872 keyremap keytran
, indec
;
8874 /* True if we are trying to map a key by changing an upper-case
8875 letter to lower case, or a shifted function key to an unshifted
8877 bool shift_translated
= false;
8879 /* If we receive a `switch-frame' or `select-window' event in the middle of
8880 a key sequence, we put it off for later.
8881 While we're reading, we keep the event here. */
8882 Lisp_Object delayed_switch_frame
;
8884 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8885 int original_uppercase_position
= -1;
8887 /* Gets around Microsoft compiler limitations. */
8888 bool dummyflag
= false;
8890 struct buffer
*starting_buffer
;
8892 /* List of events for which a fake prefix key has been generated. */
8893 Lisp_Object fake_prefixed_keys
= Qnil
;
8895 raw_keybuf_count
= 0;
8897 last_nonmenu_event
= Qnil
;
8899 delayed_switch_frame
= Qnil
;
8905 /* Install the string PROMPT as the beginning of the string
8906 of echoing, so that it serves as a prompt for the next
8908 kset_echo_prompt (current_kboard
, prompt
);
8909 /* FIXME: This use of echo_now doesn't look quite right and is ugly
8910 since it forces us to fiddle with current_kboard->immediate_echo
8911 before and after. */
8912 current_kboard
->immediate_echo
= false;
8914 if (!echo_keystrokes_p ())
8915 current_kboard
->immediate_echo
= false;
8917 else if (cursor_in_echo_area
/* FIXME: Not sure why we test this here,
8918 maybe we should just drop this test. */
8919 && echo_keystrokes_p ())
8920 /* This doesn't put in a dash if the echo buffer is empty, so
8921 you don't always see a dash hanging out in the minibuffer. */
8925 /* Record the initial state of the echo area and this_command_keys;
8926 we will need to restore them if we replay a key sequence. */
8928 echo_start
= echo_length ();
8929 keys_start
= this_command_key_count
;
8930 this_single_command_key_start
= keys_start
;
8932 /* We jump here when we need to reinitialize fkey and keytran; this
8933 happens if we switch keyboards between rescans. */
8934 replay_entire_sequence
:
8936 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8937 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8938 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8939 indec
.start
= indec
.end
= 0;
8940 fkey
.start
= fkey
.end
= 0;
8941 keytran
.start
= keytran
.end
= 0;
8943 /* We jump here when the key sequence has been thoroughly changed, and
8944 we need to rescan it starting from the beginning. When we jump here,
8945 keybuf[0..mock_input] holds the sequence we should reread. */
8948 starting_buffer
= current_buffer
;
8949 first_unbound
= bufsize
+ 1;
8951 /* Build our list of keymaps.
8952 If we recognize a function key and replace its escape sequence in
8953 keybuf with its symbol, or if the sequence starts with a mouse
8954 click and we need to switch buffers, we jump back here to rebuild
8955 the initial keymaps from the current buffer. */
8956 current_binding
= active_maps (first_event
);
8958 /* Start from the beginning in keybuf. */
8961 /* These are no-ops the first time through, but if we restart, they
8962 revert the echo area and this_command_keys to their original state. */
8963 this_command_key_count
= keys_start
;
8964 if (INTERACTIVE
&& t
< mock_input
)
8965 echo_truncate (echo_start
);
8967 /* If the best binding for the current key sequence is a keymap, or
8968 we may be looking at a function key's escape sequence, keep on
8970 while (!NILP (current_binding
)
8971 /* Keep reading as long as there's a prefix binding. */
8972 ? KEYMAPP (current_binding
)
8973 /* Don't return in the middle of a possible function key sequence,
8974 if the only bindings we found were via case conversion.
8975 Thus, if ESC O a has a function-key-map translation
8976 and ESC o has a binding, don't return after ESC O,
8977 so that we can translate ESC O plus the next character. */
8978 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8981 bool used_mouse_menu
= false;
8983 /* Where the last real key started. If we need to throw away a
8984 key that has expanded into more than one element of keybuf
8985 (say, a mouse click on the mode line which is being treated
8986 as [mode-line (mouse-...)], then we backtrack to this point
8988 int last_real_key_start
;
8990 /* These variables are analogous to echo_start and keys_start;
8991 while those allow us to restart the entire key sequence,
8992 echo_local_start and keys_local_start allow us to throw away
8994 ptrdiff_t echo_local_start
IF_LINT (= 0);
8995 int keys_local_start
;
8996 Lisp_Object new_binding
;
8998 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
8999 eassert (indec
.start
<= indec
.end
);
9000 eassert (fkey
.start
<= fkey
.end
);
9001 eassert (keytran
.start
<= keytran
.end
);
9002 /* key-translation-map is applied *after* function-key-map
9003 which is itself applied *after* input-decode-map. */
9004 eassert (fkey
.end
<= indec
.start
);
9005 eassert (keytran
.end
<= fkey
.start
);
9007 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9008 first_unbound
< keytran
.start
)
9009 { /* The prefix upto first_unbound has no binding and has
9010 no translation left to do either, so we know it's unbound.
9011 If we don't stop now, we risk staying here indefinitely
9012 (if the user keeps entering fkey or keytran prefixes
9013 like C-c ESC ESC ESC ESC ...) */
9015 for (i
= first_unbound
+ 1; i
< t
; i
++)
9016 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9017 mock_input
= t
- first_unbound
- 1;
9018 indec
.end
= indec
.start
-= first_unbound
+ 1;
9019 indec
.map
= indec
.parent
;
9020 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9021 fkey
.map
= fkey
.parent
;
9022 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9023 keytran
.map
= keytran
.parent
;
9024 goto replay_sequence
;
9028 error ("Key sequence too long");
9031 echo_local_start
= echo_length ();
9032 keys_local_start
= this_command_key_count
;
9035 /* These are no-ops, unless we throw away a keystroke below and
9036 jumped back up to replay_key; in that case, these restore the
9037 variables to their original state, allowing us to replay the
9039 if (INTERACTIVE
&& t
< mock_input
)
9040 echo_truncate (echo_local_start
);
9041 this_command_key_count
= keys_local_start
;
9043 /* By default, assume each event is "real". */
9044 last_real_key_start
= t
;
9046 /* Does mock_input indicate that we are re-reading a key sequence? */
9050 add_command_key (key
);
9051 if (current_kboard
->immediate_echo
)
9053 /* Set immediate_echo to false so as to force echo_now to
9054 redisplay (it will set immediate_echo right back to true). */
9055 current_kboard
->immediate_echo
= false;
9060 /* If not, we should actually read a character. */
9064 KBOARD
*interrupted_kboard
= current_kboard
;
9065 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9066 /* Calling read_char with COMMANDFLAG = -2 avoids
9067 redisplay in read_char and its subroutines. */
9068 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9069 current_binding
, last_nonmenu_event
,
9070 &used_mouse_menu
, NULL
);
9071 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9072 /* When switching to a new tty (with a new keyboard),
9073 read_char returns the new buffer, rather than -2
9074 (Bug#5095). This is because `terminal-init-xterm'
9075 calls read-char, which eats the wrong_kboard_jmpbuf
9076 return. Any better way to fix this? -- cyd */
9077 || (interrupted_kboard
!= current_kboard
))
9082 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9083 if (k
== interrupted_kboard
)
9088 /* Don't touch interrupted_kboard when it's been
9090 delayed_switch_frame
= Qnil
;
9091 goto replay_entire_sequence
;
9094 if (!NILP (delayed_switch_frame
))
9097 (interrupted_kboard
,
9098 Fcons (delayed_switch_frame
,
9099 KVAR (interrupted_kboard
, kbd_queue
)));
9100 delayed_switch_frame
= Qnil
;
9105 (interrupted_kboard
,
9106 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9108 /* If the side queue is non-empty, ensure it begins with a
9109 switch-frame, so we'll replay it in the right context. */
9110 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9111 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9112 !(EVENT_HAS_PARAMETERS (key
)
9113 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9117 XSETFRAME (frame
, interrupted_frame
);
9119 (interrupted_kboard
,
9120 Fcons (make_lispy_switch_frame (frame
),
9121 KVAR (interrupted_kboard
, kbd_queue
)));
9124 goto replay_entire_sequence
;
9128 /* read_char returns t when it shows a menu and the user rejects it.
9132 unbind_to (count
, Qnil
);
9136 /* read_char returns -1 at the end of a macro.
9137 Emacs 18 handles this by returning immediately with a
9138 zero, so that's what we'll do. */
9139 if (INTEGERP (key
) && XINT (key
) == -1)
9142 /* The Microsoft C compiler can't handle the goto that
9148 /* If the current buffer has been changed from under us, the
9149 keymap may have changed, so replay the sequence. */
9152 timer_resume_idle ();
9155 /* Reset the current buffer from the selected window
9156 in case something changed the former and not the latter.
9157 This is to be more consistent with the behavior
9158 of the command_loop_1. */
9159 if (fix_current_buffer
)
9161 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9163 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9165 Fset_buffer (XWINDOW (selected_window
)->contents
);
9168 goto replay_sequence
;
9171 /* If we have a quit that was typed in another frame, and
9172 quit_throw_to_read_char switched buffers,
9173 replay to get the right keymap. */
9175 && XINT (key
) == quit_char
9176 && current_buffer
!= starting_buffer
)
9179 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9184 goto replay_sequence
;
9189 if (EVENT_HAS_PARAMETERS (key
)
9190 /* Either a `switch-frame' or a `select-window' event. */
9191 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9193 /* If we're at the beginning of a key sequence, and the caller
9194 says it's okay, go ahead and return this event. If we're
9195 in the midst of a key sequence, delay it until the end. */
9196 if (t
> 0 || !can_return_switch_frame
)
9198 delayed_switch_frame
= key
;
9203 if (NILP (first_event
))
9206 /* Even if first_event does not specify a particular
9207 window/position, it's important to recompute the maps here
9208 since a long time might have passed since we entered
9209 read_key_sequence, and a timer (or process-filter or
9210 special-event-map, ...) might have switched the current buffer
9211 or the selected window from under us in the mean time. */
9212 if (fix_current_buffer
9213 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9215 Fset_buffer (XWINDOW (selected_window
)->contents
);
9216 current_binding
= active_maps (first_event
);
9220 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9224 /* Clicks in non-text areas get prefixed by the symbol
9225 in their CHAR-ADDRESS field. For example, a click on
9226 the mode line is prefixed by the symbol `mode-line'.
9228 Furthermore, key sequences beginning with mouse clicks
9229 are read using the keymaps of the buffer clicked on, not
9230 the current buffer. So we may have to switch the buffer
9233 When we turn one event into two events, we must make sure
9234 that neither of the two looks like the original--so that,
9235 if we replay the events, they won't be expanded again.
9236 If not for this, such reexpansion could happen either here
9237 or when user programs play with this-command-keys. */
9238 if (EVENT_HAS_PARAMETERS (key
))
9240 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9241 if (EQ (kind
, Qmouse_click
))
9243 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9244 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9247 || (!NILP (fake_prefixed_keys
)
9248 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9250 /* We're looking a second time at an event for which
9251 we generated a fake prefix key. Set
9252 last_real_key_start appropriately. */
9254 last_real_key_start
= t
- 1;
9257 if (last_real_key_start
== 0)
9259 /* Key sequences beginning with mouse clicks are
9260 read using the keymaps in the buffer clicked on,
9261 not the current buffer. If we're at the
9262 beginning of a key sequence, switch buffers. */
9263 if (WINDOWP (window
)
9264 && BUFFERP (XWINDOW (window
)->contents
)
9265 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9267 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9272 /* Arrange to go back to the original buffer once we're
9273 done reading the key sequence. Note that we can't
9274 use save_excursion_{save,restore} here, because they
9275 save point as well as the current buffer; we don't
9276 want to save point, because redisplay may change it,
9277 to accommodate a Fset_window_start or something. We
9278 don't want to do this at the top of the function,
9279 because we may get input from a subprocess which
9280 wants to change the selected window and stuff (say,
9282 record_unwind_current_buffer ();
9284 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9286 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9287 goto replay_sequence
;
9291 /* Expand mode-line and scroll-bar events into two events:
9292 use posn as a fake prefix key. */
9294 && (NILP (fake_prefixed_keys
)
9295 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9297 if (bufsize
- t
<= 1)
9298 error ("Key sequence too long");
9301 keybuf
[t
+ 1] = key
;
9304 /* Record that a fake prefix key has been generated
9305 for KEY. Don't modify the event; this would
9306 prevent proper action when the event is pushed
9307 back into unread-command-events. */
9308 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9312 else if (CONSP (XCDR (key
))
9313 && CONSP (EVENT_START (key
))
9314 && CONSP (XCDR (EVENT_START (key
))))
9318 posn
= POSN_POSN (EVENT_START (key
));
9319 /* Handle menu-bar events:
9320 insert the dummy prefix event `menu-bar'. */
9321 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9323 if (bufsize
- t
<= 1)
9324 error ("Key sequence too long");
9326 keybuf
[t
+ 1] = key
;
9328 /* Zap the position in key, so we know that we've
9329 expanded it, and don't try to do so again. */
9330 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9333 goto replay_sequence
;
9335 else if (CONSP (posn
))
9337 /* We're looking at the second event of a
9338 sequence which we expanded before. Set
9339 last_real_key_start appropriately. */
9340 if (last_real_key_start
== t
&& t
> 0)
9341 last_real_key_start
= t
- 1;
9346 /* We have finally decided that KEY is something we might want
9348 new_binding
= follow_key (current_binding
, key
);
9350 /* If KEY wasn't bound, we'll try some fallbacks. */
9351 if (!NILP (new_binding
))
9352 /* This is needed for the following scenario:
9353 event 0: a down-event that gets dropped by calling replay_key.
9354 event 1: some normal prefix like C-h.
9355 After event 0, first_unbound is 0, after event 1 indec.start,
9356 fkey.start, and keytran.start are all 1, so when we see that
9357 C-h is bound, we need to update first_unbound. */
9358 first_unbound
= max (t
+ 1, first_unbound
);
9363 /* Remember the position to put an upper bound on indec.start. */
9364 first_unbound
= min (t
, first_unbound
);
9366 head
= EVENT_HEAD (key
);
9370 Lisp_Object breakdown
;
9373 breakdown
= parse_modifiers (head
);
9374 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9375 /* Attempt to reduce an unbound mouse event to a simpler
9376 event that is bound:
9377 Drags reduce to clicks.
9378 Double-clicks reduce to clicks.
9379 Triple-clicks reduce to double-clicks, then to clicks.
9380 Up/Down-clicks are eliminated.
9381 Double-downs reduce to downs, then are eliminated.
9382 Triple-downs reduce to double-downs, then to downs,
9383 then are eliminated. */
9384 if (modifiers
& (up_modifier
| down_modifier
9386 | double_modifier
| triple_modifier
))
9388 while (modifiers
& (up_modifier
| down_modifier
9390 | double_modifier
| triple_modifier
))
9392 Lisp_Object new_head
, new_click
;
9393 if (modifiers
& triple_modifier
)
9394 modifiers
^= (double_modifier
| triple_modifier
);
9395 else if (modifiers
& double_modifier
)
9396 modifiers
&= ~double_modifier
;
9397 else if (modifiers
& drag_modifier
)
9398 modifiers
&= ~drag_modifier
;
9401 /* Dispose of this `up/down' event by simply jumping
9402 back to replay_key, to get another event.
9404 Note that if this event came from mock input,
9405 then just jumping back to replay_key will just
9406 hand it to us again. So we have to wipe out any
9409 We could delete keybuf[t] and shift everything
9410 after that to the left by one spot, but we'd also
9411 have to fix up any variable that points into
9412 keybuf, and shifting isn't really necessary
9415 Adding prefixes for non-textual mouse clicks
9416 creates two characters of mock input, and both
9417 must be thrown away. If we're only looking at
9418 the prefix now, we can just jump back to
9419 replay_key. On the other hand, if we've already
9420 processed the prefix, and now the actual click
9421 itself is giving us trouble, then we've lost the
9422 state of the keymaps we want to backtrack to, and
9423 we need to replay the whole sequence to rebuild
9426 Beyond that, only function key expansion could
9427 create more than two keys, but that should never
9428 generate mouse events, so it's okay to zero
9429 mock_input in that case too.
9431 FIXME: The above paragraph seems just plain
9432 wrong, if you consider things like
9433 xterm-mouse-mode. -stef
9435 Isn't this just the most wonderful code ever? */
9437 /* If mock_input > t + 1, the above simplification
9438 will actually end up dropping keys on the floor.
9439 This is probably OK for now, but even
9440 if mock_input <= t + 1, we need to adjust indec,
9442 Typical case [header-line down-mouse-N]:
9443 mock_input = 2, t = 1, fkey.end = 1,
9444 last_real_key_start = 0. */
9445 if (indec
.end
> last_real_key_start
)
9447 indec
.end
= indec
.start
9448 = min (last_real_key_start
, indec
.start
);
9449 indec
.map
= indec
.parent
;
9450 if (fkey
.end
> last_real_key_start
)
9452 fkey
.end
= fkey
.start
9453 = min (last_real_key_start
, fkey
.start
);
9454 fkey
.map
= fkey
.parent
;
9455 if (keytran
.end
> last_real_key_start
)
9457 keytran
.end
= keytran
.start
9458 = min (last_real_key_start
, keytran
.start
);
9459 keytran
.map
= keytran
.parent
;
9463 if (t
== last_real_key_start
)
9470 mock_input
= last_real_key_start
;
9471 goto replay_sequence
;
9476 = apply_modifiers (modifiers
, XCAR (breakdown
));
9477 new_click
= list2 (new_head
, EVENT_START (key
));
9479 /* Look for a binding for this new key. */
9480 new_binding
= follow_key (current_binding
, new_click
);
9482 /* If that click is bound, go for it. */
9483 if (!NILP (new_binding
))
9485 current_binding
= new_binding
;
9489 /* Otherwise, we'll leave key set to the drag event. */
9494 current_binding
= new_binding
;
9497 /* Normally, last_nonmenu_event gets the previous key we read.
9498 But when a mouse popup menu is being used,
9499 we don't update last_nonmenu_event; it continues to hold the mouse
9500 event that preceded the first level of menu. */
9501 if (!used_mouse_menu
)
9502 last_nonmenu_event
= key
;
9504 /* Record what part of this_command_keys is the current key sequence. */
9505 this_single_command_key_start
= this_command_key_count
- t
;
9506 /* When 'input-method-function' called above causes events to be
9507 put on 'unread-post-input-method-events', and as result
9508 'reread' is set to 'true', the value of 't' can become larger
9509 than 'this_command_key_count', because 'add_command_key' is
9510 not called to update 'this_command_key_count'. If this
9511 happens, 'this_single_command_key_start' will become negative
9512 above, and any call to 'this-single-command-keys' will return
9513 a garbled vector. See bug #20223 for one such situation.
9514 Here we force 'this_single_command_key_start' to never become
9515 negative, to avoid that. */
9516 if (this_single_command_key_start
< 0)
9517 this_single_command_key_start
= 0;
9519 /* Look for this sequence in input-decode-map.
9520 Scan from indec.end until we find a bound suffix. */
9521 while (indec
.end
< t
)
9526 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9530 mock_input
= diff
+ max (t
, mock_input
);
9531 goto replay_sequence
;
9535 if (!KEYMAPP (current_binding
)
9536 && !test_undefined (current_binding
)
9537 && indec
.start
>= t
)
9538 /* There is a binding and it's not a prefix.
9539 (and it doesn't have any input-decode-map translation pending).
9540 There is thus no function-key in this sequence.
9541 Moving fkey.start is important in this case to allow keytran.start
9542 to go over the sequence before we return (since we keep the
9543 invariant that keytran.end <= fkey.start). */
9546 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9549 /* If the sequence is unbound, see if we can hang a function key
9550 off the end of it. */
9551 /* Continue scan from fkey.end until we find a bound suffix. */
9552 while (fkey
.end
< indec
.start
)
9557 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9558 max (t
, mock_input
),
9559 /* If there's a binding (i.e.
9560 first_binding >= nmaps) we don't want
9561 to apply this function-key-mapping. */
9563 && (test_undefined (current_binding
)),
9567 mock_input
= diff
+ max (t
, mock_input
);
9568 /* Adjust the input-decode-map counters. */
9570 indec
.start
+= diff
;
9572 goto replay_sequence
;
9576 /* Look for this sequence in key-translation-map.
9577 Scan from keytran.end until we find a bound suffix. */
9578 while (keytran
.end
< fkey
.start
)
9583 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9587 mock_input
= diff
+ max (t
, mock_input
);
9588 /* Adjust the function-key-map and input-decode-map counters. */
9590 indec
.start
+= diff
;
9594 goto replay_sequence
;
9598 /* If KEY is not defined in any of the keymaps,
9599 and cannot be part of a function key or translation,
9600 and is an upper case letter
9601 use the corresponding lower-case letter instead. */
9602 if (NILP (current_binding
)
9603 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9605 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9606 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9607 || (XINT (key
) & shift_modifier
)))
9609 Lisp_Object new_key
;
9611 original_uppercase
= key
;
9612 original_uppercase_position
= t
- 1;
9614 if (XINT (key
) & shift_modifier
)
9615 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9617 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9618 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9620 /* We have to do this unconditionally, regardless of whether
9621 the lower-case char is defined in the keymaps, because they
9622 might get translated through function-key-map. */
9623 keybuf
[t
- 1] = new_key
;
9624 mock_input
= max (t
, mock_input
);
9625 shift_translated
= true;
9627 goto replay_sequence
;
9630 if (NILP (current_binding
)
9631 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9633 read_key_sequence_cmd
= Vprefix_help_command
;
9634 /* The Microsoft C compiler can't handle the goto that
9640 /* If KEY is not defined in any of the keymaps,
9641 and cannot be part of a function key or translation,
9642 and is a shifted function key,
9643 use the corresponding unshifted function key instead. */
9644 if (NILP (current_binding
)
9645 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9647 Lisp_Object breakdown
= parse_modifiers (key
);
9649 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9651 if (modifiers
& shift_modifier
9652 /* Treat uppercase keys as shifted. */
9654 && (KEY_TO_CHAR (key
)
9655 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9656 && uppercasep (KEY_TO_CHAR (key
))))
9659 = (modifiers
& shift_modifier
9660 ? apply_modifiers (modifiers
& ~shift_modifier
,
9662 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9664 original_uppercase
= key
;
9665 original_uppercase_position
= t
- 1;
9667 /* We have to do this unconditionally, regardless of whether
9668 the lower-case char is defined in the keymaps, because they
9669 might get translated through function-key-map. */
9670 keybuf
[t
- 1] = new_key
;
9671 mock_input
= max (t
, mock_input
);
9672 /* Reset fkey (and consequently keytran) to apply
9673 function-key-map on the result, so that S-backspace is
9674 correctly mapped to DEL (via backspace). OTOH,
9675 input-decode-map doesn't need to go through it again. */
9676 fkey
.start
= fkey
.end
= 0;
9677 keytran
.start
= keytran
.end
= 0;
9678 shift_translated
= true;
9680 goto replay_sequence
;
9685 read_key_sequence_cmd
= current_binding
;
9686 read_key_sequence_remapped
9687 /* Remap command through active keymaps.
9688 Do the remapping here, before the unbind_to so it uses the keymaps
9689 of the appropriate buffer. */
9690 = SYMBOLP (read_key_sequence_cmd
)
9691 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9694 unread_switch_frame
= delayed_switch_frame
;
9695 unbind_to (count
, Qnil
);
9697 /* Don't downcase the last character if the caller says don't.
9698 Don't downcase it if the result is undefined, either. */
9699 if ((dont_downcase_last
|| NILP (current_binding
))
9701 && t
- 1 == original_uppercase_position
)
9703 keybuf
[t
- 1] = original_uppercase
;
9704 shift_translated
= false;
9707 if (shift_translated
)
9708 Vthis_command_keys_shift_translated
= Qt
;
9710 /* Occasionally we fabricate events, perhaps by expanding something
9711 according to function-key-map, or by adding a prefix symbol to a
9712 mouse click in the scroll bar or modeline. In this cases, return
9713 the entire generated key sequence, even if we hit an unbound
9714 prefix or a definition before the end. This means that you will
9715 be able to push back the event properly, and also means that
9716 read-key-sequence will always return a logical unit.
9719 for (; t
< mock_input
; t
++)
9720 add_command_key (keybuf
[t
]);
9727 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9728 Lisp_Object dont_downcase_last
,
9729 Lisp_Object can_return_switch_frame
,
9730 Lisp_Object cmd_loop
, bool allow_string
)
9732 Lisp_Object keybuf
[30];
9734 ptrdiff_t count
= SPECPDL_INDEX ();
9737 CHECK_STRING (prompt
);
9740 specbind (Qinput_method_exit_on_first_char
,
9741 (NILP (cmd_loop
) ? Qt
: Qnil
));
9742 specbind (Qinput_method_use_echo_area
,
9743 (NILP (cmd_loop
) ? Qt
: Qnil
));
9745 if (NILP (continue_echo
))
9747 this_command_key_count
= 0;
9748 this_single_command_key_start
= 0;
9751 #ifdef HAVE_WINDOW_SYSTEM
9752 if (display_hourglass_p
)
9753 cancel_hourglass ();
9756 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9757 prompt
, ! NILP (dont_downcase_last
),
9758 ! NILP (can_return_switch_frame
), 0, 0);
9760 #if 0 /* The following is fine for code reading a key sequence and
9761 then proceeding with a lengthy computation, but it's not good
9762 for code reading keys in a loop, like an input method. */
9763 #ifdef HAVE_WINDOW_SYSTEM
9764 if (display_hourglass_p
)
9775 return unbind_to (count
,
9776 ((allow_string
? make_event_array
: Fvector
)
9780 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9781 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9782 The sequence is sufficient to specify a non-prefix command in the
9783 current local and global maps.
9785 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9786 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9787 as a continuation of the previous key.
9789 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9790 convert the last event to lower case. (Normally any upper case event
9791 is converted to lower case if the original event is undefined and the lower
9792 case equivalent is defined.) A non-nil value is appropriate for reading
9793 a key sequence to be defined.
9795 A C-g typed while in this function is treated like any other character,
9796 and `quit-flag' is not set.
9798 If the key sequence starts with a mouse click, then the sequence is read
9799 using the keymaps of the buffer of the window clicked in, not the buffer
9800 of the selected window as normal.
9802 `read-key-sequence' drops unbound button-down events, since you normally
9803 only care about the click or drag events which follow them. If a drag
9804 or multi-click event is unbound, but the corresponding click event would
9805 be bound, `read-key-sequence' turns the event into a click event at the
9806 drag's starting position. This means that you don't have to distinguish
9807 between click and drag, double, or triple events unless you want to.
9809 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9810 lines separating windows, and scroll bars with imaginary keys
9811 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9813 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9814 function will process a switch-frame event if the user switches frames
9815 before typing anything. If the user switches frames in the middle of a
9816 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9817 is nil, then the event will be put off until after the current key sequence.
9819 `read-key-sequence' checks `function-key-map' for function key
9820 sequences, where they wouldn't conflict with ordinary bindings. See
9821 `function-key-map' for more details.
9823 The optional fifth argument CMD-LOOP, if non-nil, means
9824 that this key sequence is being read by something that will
9825 read commands one after another. It should be nil if the caller
9826 will read just one key sequence. */)
9827 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9829 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9830 can_return_switch_frame
, cmd_loop
, true);
9833 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9834 Sread_key_sequence_vector
, 1, 5, 0,
9835 doc
: /* Like `read-key-sequence' but always return a vector. */)
9836 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9838 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9839 can_return_switch_frame
, cmd_loop
, false);
9842 /* Return true if input events are pending. */
9845 detect_input_pending (void)
9847 return input_pending
|| get_input_pending (0);
9850 /* Return true if input events other than mouse movements are
9854 detect_input_pending_ignore_squeezables (void)
9856 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9859 /* Return true if input events are pending, and run any pending timers. */
9862 detect_input_pending_run_timers (bool do_display
)
9864 unsigned old_timers_run
= timers_run
;
9867 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9869 if (old_timers_run
!= timers_run
&& do_display
)
9870 redisplay_preserve_echo_area (8);
9872 return input_pending
;
9875 /* This is called in some cases before a possible quit.
9876 It cases the next call to detect_input_pending to recompute input_pending.
9877 So calling this function unnecessarily can't do any harm. */
9880 clear_input_pending (void)
9882 input_pending
= false;
9885 /* Return true if there are pending requeued events.
9886 This isn't used yet. The hope is to make wait_reading_process_output
9887 call it, and return if it runs Lisp code that unreads something.
9888 The problem is, kbd_buffer_get_event needs to be fixed to know what
9889 to do in that case. It isn't trivial. */
9892 requeued_events_pending_p (void)
9894 return (CONSP (Vunread_command_events
));
9897 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9898 doc
: /* Return t if command input is currently available with no wait.
9899 Actually, the value is nil only if we can be sure that no input is available;
9900 if there is a doubt, the value is t.
9902 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9903 (Lisp_Object check_timers
)
9905 if (CONSP (Vunread_command_events
)
9906 || !NILP (Vunread_post_input_method_events
)
9907 || !NILP (Vunread_input_method_events
))
9910 /* Process non-user-visible events (Bug#10195). */
9911 process_special_events ();
9913 return (get_input_pending ((NILP (check_timers
)
9914 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9915 | READABLE_EVENTS_FILTER_EVENTS
)
9919 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
9920 doc
: /* Return vector of last few events, not counting those from keyboard macros.
9921 If INCLUDE-CMDS is non-nil, include the commands that were run,
9922 represented as events of the form (nil . COMMAND). */)
9923 (Lisp_Object include_cmds
)
9925 bool cmds
= !NILP (include_cmds
);
9928 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
9929 return Fvector (total_keys
,
9930 XVECTOR (recent_keys
)->contents
);
9933 Lisp_Object es
= Qnil
;
9934 int i
= (total_keys
< NUM_RECENT_KEYS
9935 ? 0 : recent_keys_index
);
9936 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
9939 Lisp_Object e
= AREF (recent_keys
, i
);
9940 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
9942 if (++i
>= NUM_RECENT_KEYS
)
9944 } while (i
!= recent_keys_index
);
9945 es
= Fnreverse (es
);
9946 return Fvconcat (1, &es
);
9950 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9951 doc
: /* Return the key sequence that invoked this command.
9952 However, if the command has called `read-key-sequence', it returns
9953 the last key sequence that has been read.
9954 The value is a string or a vector.
9956 See also `this-command-keys-vector'. */)
9959 return make_event_array (this_command_key_count
,
9960 XVECTOR (this_command_keys
)->contents
);
9963 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9964 doc
: /* Return the key sequence that invoked this command, as a vector.
9965 However, if the command has called `read-key-sequence', it returns
9966 the last key sequence that has been read.
9968 See also `this-command-keys'. */)
9971 return Fvector (this_command_key_count
,
9972 XVECTOR (this_command_keys
)->contents
);
9975 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9976 Sthis_single_command_keys
, 0, 0, 0,
9977 doc
: /* Return the key sequence that invoked this command.
9978 More generally, it returns the last key sequence read, either by
9979 the command loop or by `read-key-sequence'.
9980 Unlike `this-command-keys', this function's value
9981 does not include prefix arguments.
9982 The value is always a vector. */)
9985 return Fvector (this_command_key_count
9986 - this_single_command_key_start
,
9987 (XVECTOR (this_command_keys
)->contents
9988 + this_single_command_key_start
));
9991 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9992 Sthis_single_command_raw_keys
, 0, 0, 0,
9993 doc
: /* Return the raw events that were read for this command.
9994 More generally, it returns the last key sequence read, either by
9995 the command loop or by `read-key-sequence'.
9996 Unlike `this-single-command-keys', this function's value
9997 shows the events before all translations (except for input methods).
9998 The value is always a vector. */)
10001 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10004 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10005 Sclear_this_command_keys
, 0, 1, 0,
10006 doc
: /* Clear out the vector that `this-command-keys' returns.
10007 Also clear the record of the last 100 events, unless optional arg
10008 KEEP-RECORD is non-nil. */)
10009 (Lisp_Object keep_record
)
10013 this_command_key_count
= 0;
10015 if (NILP (keep_record
))
10017 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10018 ASET (recent_keys
, i
, Qnil
);
10020 recent_keys_index
= 0;
10025 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10026 doc
: /* Return the current depth in recursive edits. */)
10030 /* Wrap around reliably on integer overflow. */
10031 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10032 XSETINT (temp
, sum
);
10036 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10037 "FOpen dribble file: ",
10038 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10039 If FILE is nil, close any open dribble file.
10040 The file will be closed when Emacs exits.
10042 Be aware that this records ALL characters you type!
10043 This may include sensitive information such as passwords. */)
10056 Lisp_Object encfile
;
10058 file
= Fexpand_file_name (file
, Qnil
);
10059 encfile
= ENCODE_FILE (file
);
10060 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10061 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10062 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10063 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10065 report_file_error ("Opening dribble", file
);
10070 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10071 doc
: /* Discard the contents of the terminal input buffer.
10072 Also end any kbd macro being defined. */)
10075 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10077 /* Discard the last command from the macro. */
10078 Fcancel_kbd_macro_events ();
10082 Vunread_command_events
= Qnil
;
10084 discard_tty_input ();
10086 kbd_fetch_ptr
= kbd_store_ptr
;
10087 input_pending
= false;
10092 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10093 doc
: /* Stop Emacs and return to superior process. You can resume later.
10094 If `cannot-suspend' is non-nil, or if the system doesn't support job
10095 control, run a subshell instead.
10097 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10098 to be read as terminal input by Emacs's parent, after suspension.
10100 Before suspending, run the normal hook `suspend-hook'.
10101 After resumption run the normal hook `suspend-resume-hook'.
10103 Some operating systems cannot stop the Emacs process and resume it later.
10104 On such systems, Emacs starts a subshell instead of suspending. */)
10105 (Lisp_Object stuffstring
)
10107 ptrdiff_t count
= SPECPDL_INDEX ();
10108 int old_height
, old_width
;
10111 if (tty_list
&& tty_list
->next
)
10112 error ("There are other tty frames open; close them before suspending Emacs");
10114 if (!NILP (stuffstring
))
10115 CHECK_STRING (stuffstring
);
10117 run_hook (intern ("suspend-hook"));
10119 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10120 reset_all_sys_modes ();
10121 /* sys_suspend can get an error if it tries to fork a subshell
10122 and the system resources aren't available for that. */
10123 record_unwind_protect_void (init_all_sys_modes
);
10124 stuff_buffered_input (stuffstring
);
10125 if (cannot_suspend
)
10129 unbind_to (count
, Qnil
);
10131 /* Check if terminal/window size has changed.
10132 Note that this is not useful when we are running directly
10133 with a window system; but suspend should be disabled in that case. */
10134 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10135 if (width
!= old_width
|| height
!= old_height
)
10136 change_frame_size (SELECTED_FRAME (), width
,
10137 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10140 run_hook (intern ("suspend-resume-hook"));
10145 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10146 Then in any case stuff anything Emacs has read ahead and not used. */
10149 stuff_buffered_input (Lisp_Object stuffstring
)
10151 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10152 register unsigned char *p
;
10154 if (STRINGP (stuffstring
))
10156 register ptrdiff_t count
;
10158 p
= SDATA (stuffstring
);
10159 count
= SBYTES (stuffstring
);
10160 while (count
-- > 0)
10165 /* Anything we have read ahead, put back for the shell to read. */
10166 /* ?? What should this do when we have multiple keyboards??
10167 Should we ignore anything that was typed in at the "wrong" kboard?
10169 rms: we should stuff everything back into the kboard
10171 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10174 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10175 kbd_fetch_ptr
= kbd_buffer
;
10176 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10177 stuff_char (kbd_fetch_ptr
->ie
.code
);
10179 clear_event (kbd_fetch_ptr
);
10182 input_pending
= false;
10183 #endif /* SIGTSTP */
10187 set_waiting_for_input (struct timespec
*time_to_clear
)
10189 input_available_clear_time
= time_to_clear
;
10191 /* Tell handle_interrupt to throw back to read_char, */
10192 waiting_for_input
= true;
10194 /* If handle_interrupt was called before and buffered a C-g,
10195 make it run again now, to avoid timing error. */
10196 if (!NILP (Vquit_flag
))
10197 quit_throw_to_read_char (0);
10201 clear_waiting_for_input (void)
10203 /* Tell handle_interrupt not to throw back to read_char, */
10204 waiting_for_input
= false;
10205 input_available_clear_time
= 0;
10208 /* The SIGINT handler.
10210 If we have a frame on the controlling tty, we assume that the
10211 SIGINT was generated by C-g, so we call handle_interrupt.
10212 Otherwise, tell QUIT to kill Emacs. */
10215 handle_interrupt_signal (int sig
)
10217 /* See if we have an active terminal on our controlling tty. */
10218 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10221 /* If there are no frames there, let's pretend that we are a
10222 well-behaving UN*X program and quit. We must not call Lisp
10223 in a signal handler, so tell QUIT to exit when it is
10225 Vquit_flag
= Qkill_emacs
;
10229 /* Otherwise, the SIGINT was probably generated by C-g. */
10231 /* Set internal_last_event_frame to the top frame of the
10232 controlling tty, if we have a frame there. We disable the
10233 interrupt key on secondary ttys, so the SIGINT must have come
10234 from the controlling tty. */
10235 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10237 handle_interrupt (1);
10242 deliver_interrupt_signal (int sig
)
10244 deliver_process_signal (sig
, handle_interrupt_signal
);
10247 /* Output MSG directly to standard output, without buffering. Ignore
10248 failures. This is safe in a signal handler. */
10250 write_stdout (char const *msg
)
10252 ignore_value (write (STDOUT_FILENO
, msg
, strlen (msg
)));
10255 /* Read a byte from stdin, without buffering. Safe in signal handlers. */
10260 return read (STDIN_FILENO
, &c
, 1) == 1 ? c
: EOF
;
10263 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10264 of the number of times C-g has been requested. If C-g is pressed
10265 enough times, then quit anyway. See bug#6585. */
10266 static int volatile force_quit_count
;
10268 /* This routine is called at interrupt level in response to C-g.
10270 It is called from the SIGINT handler or kbd_buffer_store_event.
10272 If `waiting_for_input' is non zero, then unless `echoing' is
10273 nonzero, immediately throw back to read_char.
10275 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10276 eval to throw, when it gets a chance. If quit-flag is already
10277 non-nil, it stops the job right away. */
10280 handle_interrupt (bool in_signal_handler
)
10286 /* XXX This code needs to be revised for multi-tty support. */
10287 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10289 if (! in_signal_handler
)
10291 /* If SIGINT isn't blocked, don't let us be interrupted by
10292 a SIGINT. It might be harmful due to non-reentrancy
10293 in I/O functions. */
10295 sigemptyset (&blocked
);
10296 sigaddset (&blocked
, SIGINT
);
10297 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10301 reset_all_sys_modes ();
10305 * On systems which can suspend the current process and return to the original
10306 * shell, this command causes the user to end up back at the shell.
10307 * The "Auto-save" and "Abort" questions are not asked until
10308 * the user elects to return to emacs, at which point he can save the current
10309 * job and either dump core or continue.
10313 /* Perhaps should really fork an inferior shell?
10314 But that would not provide any way to get back
10315 to the original shell, ever. */
10316 write_stdout ("No support for stopping a process"
10317 " on this operating system;\n"
10318 "you can continue or abort.\n");
10319 #endif /* not SIGTSTP */
10321 /* We must remain inside the screen area when the internal terminal
10322 is used. Note that [Enter] is not echoed by dos. */
10323 cursor_to (SELECTED_FRAME (), 0, 0);
10325 /* It doesn't work to autosave while GC is in progress;
10326 the code used for auto-saving doesn't cope with the mark bit. */
10327 if (!gc_in_progress
)
10329 write_stdout ("Auto-save? (y or n) ");
10331 if (c
== 'y' || c
== 'Y')
10333 Fdo_auto_save (Qt
, Qnil
);
10335 write_stdout ("\r\nAuto-save done");
10337 write_stdout ("Auto-save done\n");
10345 /* During GC, it must be safe to reenable quitting again. */
10346 Vinhibit_quit
= Qnil
;
10352 "Garbage collection in progress; cannot auto-save now\r\n"
10353 "but will instead do a real quit"
10354 " after garbage collection ends\r\n");
10358 write_stdout ("\r\nAbort? (y or n) ");
10360 write_stdout ("Abort (and dump core)? (y or n) ");
10363 if (c
== 'y' || c
== 'Y')
10368 write_stdout ("\r\nContinuing...\r\n");
10369 #else /* not MSDOS */
10370 write_stdout ("Continuing...\n");
10371 #endif /* not MSDOS */
10372 init_all_sys_modes ();
10376 /* If executing a function that wants to be interrupted out of
10377 and the user has not deferred quitting by binding `inhibit-quit'
10378 then quit right away. */
10379 if (immediate_quit
&& NILP (Vinhibit_quit
))
10381 struct gl_state_s saved
;
10383 immediate_quit
= false;
10384 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10386 Fsignal (Qquit
, Qnil
);
10390 { /* Else request quit when it's safe. */
10391 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10392 force_quit_count
= count
;
10395 immediate_quit
= true;
10396 Vinhibit_quit
= Qnil
;
10402 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10404 /* TODO: The longjmp in this call throws the NS event loop integration off,
10405 and it seems to do fine without this. Probably some attention
10406 needs to be paid to the setting of waiting_for_input in
10407 wait_reading_process_output() under HAVE_NS because of the call
10408 to ns_select there (needed because otherwise events aren't picked up
10409 outside of polling since we don't get SIGIO like X and we don't have a
10410 separate event loop thread like W32. */
10412 if (waiting_for_input
&& !echoing
)
10413 quit_throw_to_read_char (in_signal_handler
);
10417 /* Handle a C-g by making read_char return C-g. */
10420 quit_throw_to_read_char (bool from_signal
)
10422 /* When not called from a signal handler it is safe to call
10424 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10425 Fkill_emacs (Qnil
);
10427 /* Prevent another signal from doing this before we finish. */
10428 clear_waiting_for_input ();
10429 input_pending
= false;
10431 Vunread_command_events
= Qnil
;
10433 if (FRAMEP (internal_last_event_frame
)
10434 && !EQ (internal_last_event_frame
, selected_frame
))
10435 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10438 sys_longjmp (getcjmp
, 1);
10441 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10442 Sset_input_interrupt_mode
, 1, 1, 0,
10443 doc
: /* Set interrupt mode of reading keyboard input.
10444 If INTERRUPT is non-nil, Emacs will use input interrupts;
10445 otherwise Emacs uses CBREAK mode.
10447 See also `current-input-mode'. */)
10448 (Lisp_Object interrupt
)
10450 bool new_interrupt_input
;
10451 #ifdef USABLE_SIGIO
10452 #ifdef HAVE_X_WINDOWS
10453 if (x_display_list
!= NULL
)
10455 /* When using X, don't give the user a real choice,
10456 because we haven't implemented the mechanisms to support it. */
10457 new_interrupt_input
= true;
10460 #endif /* HAVE_X_WINDOWS */
10461 new_interrupt_input
= !NILP (interrupt
);
10462 #else /* not USABLE_SIGIO */
10463 new_interrupt_input
= false;
10464 #endif /* not USABLE_SIGIO */
10466 if (new_interrupt_input
!= interrupt_input
)
10468 #ifdef POLL_FOR_INPUT
10472 /* this causes startup screen to be restored and messes with the mouse */
10473 reset_all_sys_modes ();
10474 interrupt_input
= new_interrupt_input
;
10475 init_all_sys_modes ();
10477 interrupt_input
= new_interrupt_input
;
10480 #ifdef POLL_FOR_INPUT
10481 poll_suppress_count
= 1;
10488 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10489 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10490 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10491 C-q in key sequences.
10493 This setting only has an effect on tty terminals and only when
10494 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10496 See also `current-input-mode'. */)
10497 (Lisp_Object flow
, Lisp_Object terminal
)
10499 struct terminal
*t
= decode_tty_terminal (terminal
);
10500 struct tty_display_info
*tty
;
10504 tty
= t
->display_info
.tty
;
10506 if (tty
->flow_control
!= !NILP (flow
))
10509 /* This causes startup screen to be restored and messes with the mouse. */
10510 reset_sys_modes (tty
);
10513 tty
->flow_control
= !NILP (flow
);
10516 init_sys_modes (tty
);
10522 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10523 doc
: /* Enable or disable 8-bit input on TERMINAL.
10524 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10525 bit as the Meta modifier.
10527 If META is nil, Emacs will ignore the top bit, on the assumption it is
10530 Otherwise, Emacs will accept and pass through 8-bit input without
10531 specially interpreting the top bit.
10533 This setting only has an effect on tty terminal devices.
10535 Optional parameter TERMINAL specifies the tty terminal device to use.
10536 It may be a terminal object, a frame, or nil for the terminal used by
10537 the currently selected frame.
10539 See also `current-input-mode'. */)
10540 (Lisp_Object meta
, Lisp_Object terminal
)
10542 struct terminal
*t
= decode_tty_terminal (terminal
);
10543 struct tty_display_info
*tty
;
10548 tty
= t
->display_info
.tty
;
10552 else if (EQ (meta
, Qt
))
10557 if (tty
->meta_key
!= new_meta
)
10560 /* this causes startup screen to be restored and messes with the mouse */
10561 reset_sys_modes (tty
);
10564 tty
->meta_key
= new_meta
;
10567 init_sys_modes (tty
);
10573 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10574 doc
: /* Specify character used for quitting.
10575 QUIT must be an ASCII character.
10577 This function only has an effect on the controlling tty of the Emacs
10580 See also `current-input-mode'. */)
10583 struct terminal
*t
= get_named_terminal ("/dev/tty");
10584 struct tty_display_info
*tty
;
10588 tty
= t
->display_info
.tty
;
10590 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10591 error ("QUIT must be an ASCII character");
10594 /* this causes startup screen to be restored and messes with the mouse */
10595 reset_sys_modes (tty
);
10598 /* Don't let this value be out of range. */
10599 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10602 init_sys_modes (tty
);
10608 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10609 doc
: /* Set mode of reading keyboard input.
10610 First arg INTERRUPT non-nil means use input interrupts;
10611 nil means use CBREAK mode.
10612 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10613 (no effect except in CBREAK mode).
10614 Third arg META t means accept 8-bit input (for a Meta key).
10615 META nil means ignore the top bit, on the assumption it is parity.
10616 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10617 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10618 See also `current-input-mode'. */)
10619 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10621 Fset_input_interrupt_mode (interrupt
);
10622 Fset_output_flow_control (flow
, Qnil
);
10623 Fset_input_meta_mode (meta
, Qnil
);
10625 Fset_quit_char (quit
);
10629 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10630 doc
: /* Return information about the way Emacs currently reads keyboard input.
10631 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10632 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10633 nil, Emacs is using CBREAK mode.
10634 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10635 terminal; this does not apply if Emacs uses interrupt-driven input.
10636 META is t if accepting 8-bit input with 8th bit as Meta flag.
10637 META nil means ignoring the top bit, on the assumption it is parity.
10638 META is neither t nor nil if accepting 8-bit input and using
10639 all 8 bits as the character code.
10640 QUIT is the character Emacs currently uses to quit.
10641 The elements of this list correspond to the arguments of
10642 `set-input-mode'. */)
10645 struct frame
*sf
= XFRAME (selected_frame
);
10647 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10648 Lisp_Object flow
, meta
;
10649 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10651 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10652 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10654 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10661 Lisp_Object quit
= make_number (quit_char
);
10663 return list4 (interrupt
, flow
, meta
, quit
);
10666 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10667 doc
: /* Return position information for pixel coordinates X and Y.
10668 By default, X and Y are relative to text area of the selected window.
10669 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10670 If optional fourth arg WHOLE is non-nil, X is relative to the left
10671 edge of the window.
10673 The return value is similar to a mouse click position:
10674 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10675 IMAGE (DX . DY) (WIDTH . HEIGHT))
10676 The `posn-' functions access elements of such lists. */)
10677 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10680 /* We allow X of -1, for the newline in a R2L line that overflowed
10681 into the left fringe. */
10682 if (XINT (x
) != -1)
10686 if (NILP (frame_or_window
))
10687 frame_or_window
= selected_window
;
10689 if (WINDOWP (frame_or_window
))
10691 struct window
*w
= decode_live_window (frame_or_window
);
10693 XSETINT (x
, (XINT (x
)
10694 + WINDOW_LEFT_EDGE_X (w
)
10696 ? window_box_left_offset (w
, TEXT_AREA
)
10698 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10699 frame_or_window
= w
->frame
;
10702 CHECK_LIVE_FRAME (frame_or_window
);
10704 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10707 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10708 doc
: /* Return position information for buffer POS in WINDOW.
10709 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10711 Return nil if position is not visible in window. Otherwise,
10712 the return value is similar to that returned by `event-start' for
10713 a mouse click at the upper left corner of the glyph corresponding
10714 to the given buffer position:
10715 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10716 IMAGE (DX . DY) (WIDTH . HEIGHT))
10717 The `posn-' functions access elements of such lists. */)
10718 (Lisp_Object pos
, Lisp_Object window
)
10723 window
= selected_window
;
10725 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10728 Lisp_Object x
= XCAR (tem
);
10729 Lisp_Object y
= XCAR (XCDR (tem
));
10731 /* Point invisible due to hscrolling? X can be -1 when a
10732 newline in a R2L line overflows into the left fringe. */
10735 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10741 /* Set up a new kboard object with reasonable initial values.
10742 TYPE is a window system for which this keyboard is used. */
10745 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10747 kset_overriding_terminal_local_map (kb
, Qnil
);
10748 kset_last_command (kb
, Qnil
);
10749 kset_real_last_command (kb
, Qnil
);
10750 kset_keyboard_translate_table (kb
, Qnil
);
10751 kset_last_repeatable_command (kb
, Qnil
);
10752 kset_prefix_arg (kb
, Qnil
);
10753 kset_last_prefix_arg (kb
, Qnil
);
10754 kset_kbd_queue (kb
, Qnil
);
10755 kb
->kbd_queue_has_data
= false;
10756 kb
->immediate_echo
= false;
10757 kset_echo_string (kb
, Qnil
);
10758 kset_echo_prompt (kb
, Qnil
);
10759 kb
->kbd_macro_buffer
= 0;
10760 kb
->kbd_macro_bufsize
= 0;
10761 kset_defining_kbd_macro (kb
, Qnil
);
10762 kset_last_kbd_macro (kb
, Qnil
);
10763 kb
->reference_count
= 0;
10764 kset_system_key_alist (kb
, Qnil
);
10765 kset_system_key_syms (kb
, Qnil
);
10766 kset_window_system (kb
, type
);
10767 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10768 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10769 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10770 kset_default_minibuffer_frame (kb
, Qnil
);
10773 /* Allocate and basically initialize keyboard
10774 object to use with window system TYPE. */
10777 allocate_kboard (Lisp_Object type
)
10779 KBOARD
*kb
= xmalloc (sizeof *kb
);
10781 init_kboard (kb
, type
);
10782 kb
->next_kboard
= all_kboards
;
10788 * Destroy the contents of a kboard object, but not the object itself.
10789 * We use this just before deleting it, or if we're going to initialize
10790 * it a second time.
10793 wipe_kboard (KBOARD
*kb
)
10795 xfree (kb
->kbd_macro_buffer
);
10798 /* Free KB and memory referenced from it. */
10801 delete_kboard (KBOARD
*kb
)
10805 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10808 *kbp
= kb
->next_kboard
;
10810 /* Prevent a dangling reference to KB. */
10811 if (kb
== current_kboard
10812 && FRAMEP (selected_frame
)
10813 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10815 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10816 single_kboard
= false;
10817 if (current_kboard
== kb
)
10826 init_keyboard (void)
10828 /* This is correct before outermost invocation of the editor loop. */
10829 command_loop_level
= -1;
10830 immediate_quit
= false;
10831 quit_char
= Ctl ('g');
10832 Vunread_command_events
= Qnil
;
10833 timer_idleness_start_time
= invalid_timespec ();
10835 recent_keys_index
= 0;
10836 kbd_fetch_ptr
= kbd_buffer
;
10837 kbd_store_ptr
= kbd_buffer
;
10838 do_mouse_tracking
= Qnil
;
10839 input_pending
= false;
10840 interrupt_input_blocked
= 0;
10841 pending_signals
= false;
10843 /* This means that command_loop_1 won't try to select anything the first
10845 internal_last_event_frame
= Qnil
;
10846 Vlast_event_frame
= internal_last_event_frame
;
10848 current_kboard
= initial_kboard
;
10849 /* Re-initialize the keyboard again. */
10850 wipe_kboard (current_kboard
);
10851 /* A value of nil for Vwindow_system normally means a tty, but we also use
10852 it for the initial terminal since there is no window system there. */
10853 init_kboard (current_kboard
, Qnil
);
10855 if (!noninteractive
)
10857 /* Before multi-tty support, these handlers used to be installed
10858 only if the current session was a tty session. Now an Emacs
10859 session may have multiple display types, so we always handle
10860 SIGINT. There is special code in handle_interrupt_signal to exit
10861 Emacs on SIGINT when there are no termcap frames on the
10862 controlling terminal. */
10863 struct sigaction action
;
10864 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10865 sigaction (SIGINT
, &action
, 0);
10867 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10868 SIGQUIT and we can't tell which one it will give us. */
10869 sigaction (SIGQUIT
, &action
, 0);
10870 #endif /* not DOS_NT */
10872 #ifdef USABLE_SIGIO
10873 if (!noninteractive
)
10875 struct sigaction action
;
10876 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10877 sigaction (SIGIO
, &action
, 0);
10881 /* Use interrupt input by default, if it works and noninterrupt input
10882 has deficiencies. */
10884 #ifdef INTERRUPT_INPUT
10885 interrupt_input
= 1;
10887 interrupt_input
= 0;
10890 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10893 if (keyboard_init_hook
)
10894 (*keyboard_init_hook
) ();
10896 #ifdef POLL_FOR_INPUT
10898 poll_suppress_count
= 1;
10903 /* This type's only use is in syms_of_keyboard, to put properties on the
10904 event header symbols. */
10911 static const struct event_head head_table
[] = {
10912 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10913 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10915 /* Some of the event heads. */
10916 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
10918 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
10919 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
10920 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
10921 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
10922 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
10923 /* `select-window' should be handled just like `switch-frame'
10924 in read_key_sequence. */
10925 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
10929 syms_of_keyboard (void)
10931 pending_funcalls
= Qnil
;
10932 staticpro (&pending_funcalls
);
10934 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10935 staticpro (&Vlispy_mouse_stem
);
10937 regular_top_level_message
= build_pure_c_string ("Back to top level");
10938 #ifdef HAVE_STACK_OVERFLOW_HANDLING
10939 recover_top_level_message
10940 = build_pure_c_string ("Re-entering top level after C stack overflow");
10942 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
10943 doc
: /* Message displayed by `normal-top-level'. */);
10944 Vinternal__top_level_message
= regular_top_level_message
;
10947 DEFSYM (QCimage
, ":image");
10948 DEFSYM (Qhelp_echo
, "help-echo");
10949 DEFSYM (QCrtl
, ":rtl");
10951 staticpro (&item_properties
);
10952 item_properties
= Qnil
;
10954 staticpro (&tool_bar_item_properties
);
10955 tool_bar_item_properties
= Qnil
;
10956 staticpro (&tool_bar_items_vector
);
10957 tool_bar_items_vector
= Qnil
;
10959 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10961 /* Non-nil disable property on a command means do not execute it;
10962 call disabled-command-function's value instead. */
10963 DEFSYM (Qdisabled
, "disabled");
10965 DEFSYM (Qundefined
, "undefined");
10967 /* Hooks to run before and after each command. */
10968 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10969 DEFSYM (Qpost_command_hook
, "post-command-hook");
10971 DEFSYM (Qundo_auto__add_boundary
, "undo-auto--add-boundary");
10972 DEFSYM (Qundo_auto__undoably_changed_buffers
,
10973 "undo-auto--undoably-changed-buffers");
10975 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10976 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10977 DEFSYM (Qfunction_key
, "function-key");
10979 /* The values of Qevent_kind properties. */
10980 DEFSYM (Qmouse_click
, "mouse-click");
10982 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10983 DEFSYM (Qsave_session
, "save-session");
10984 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10986 /* Menu and tool bar item parts. */
10987 DEFSYM (Qmenu_enable
, "menu-enable");
10990 DEFSYM (Qlanguage_change
, "language-change");
10994 DEFSYM (Qdbus_event
, "dbus-event");
10997 #ifdef HAVE_XWIDGETS
10998 DEFSYM (Qxwidget_event
, "xwidget-event");
11001 #ifdef USE_FILE_NOTIFY
11002 DEFSYM (Qfile_notify
, "file-notify");
11003 #endif /* USE_FILE_NOTIFY */
11005 /* Menu and tool bar item parts. */
11006 DEFSYM (QCenable
, ":enable");
11007 DEFSYM (QCvisible
, ":visible");
11008 DEFSYM (QChelp
, ":help");
11009 DEFSYM (QCfilter
, ":filter");
11010 DEFSYM (QCbutton
, ":button");
11011 DEFSYM (QCkeys
, ":keys");
11012 DEFSYM (QCkey_sequence
, ":key-sequence");
11014 /* Non-nil disable property on a command means
11015 do not execute it; call disabled-command-function's value instead. */
11016 DEFSYM (QCtoggle
, ":toggle");
11017 DEFSYM (QCradio
, ":radio");
11018 DEFSYM (QClabel
, ":label");
11019 DEFSYM (QCvert_only
, ":vert-only");
11021 /* Symbols to use for parts of windows. */
11022 DEFSYM (Qvertical_line
, "vertical-line");
11023 DEFSYM (Qright_divider
, "right-divider");
11024 DEFSYM (Qbottom_divider
, "bottom-divider");
11026 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11028 DEFSYM (Qabove_handle
, "above-handle");
11029 DEFSYM (Qhandle
, "handle");
11030 DEFSYM (Qbelow_handle
, "below-handle");
11031 DEFSYM (Qup
, "up");
11032 DEFSYM (Qdown
, "down");
11033 DEFSYM (Qtop
, "top");
11034 DEFSYM (Qbottom
, "bottom");
11035 DEFSYM (Qend_scroll
, "end-scroll");
11036 DEFSYM (Qratio
, "ratio");
11037 DEFSYM (Qbefore_handle
, "before-handle");
11038 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11039 DEFSYM (Qafter_handle
, "after-handle");
11040 DEFSYM (Qleft
, "left");
11041 DEFSYM (Qright
, "right");
11042 DEFSYM (Qleftmost
, "leftmost");
11043 DEFSYM (Qrightmost
, "rightmost");
11045 /* Properties of event headers. */
11046 DEFSYM (Qevent_kind
, "event-kind");
11047 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11049 /* An event header symbol HEAD may have a property named
11050 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
11051 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
11052 mask of modifiers applied to it. If present, this is used to help
11053 speed up parse_modifiers. */
11054 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11056 /* An unmodified event header BASE may have a property named
11057 Qmodifier_cache, which is an alist mapping modifier masks onto
11058 modified versions of BASE. If present, this helps speed up
11059 apply_modifiers. */
11060 DEFSYM (Qmodifier_cache
, "modifier-cache");
11062 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11063 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11065 DEFSYM (Qpolling_period
, "polling-period");
11067 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11069 /* The primary selection. */
11070 DEFSYM (QPRIMARY
, "PRIMARY");
11072 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11073 DEFSYM (Qhandle_select_window
, "handle-select-window");
11075 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11076 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11078 DEFSYM (Qhelp_form_show
, "help-form-show");
11080 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11082 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11083 Fset (Qinput_method_use_echo_area
, Qnil
);
11085 /* Symbols to head events. */
11086 DEFSYM (Qmouse_movement
, "mouse-movement");
11087 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11088 DEFSYM (Qswitch_frame
, "switch-frame");
11089 DEFSYM (Qfocus_in
, "focus-in");
11090 DEFSYM (Qfocus_out
, "focus-out");
11091 DEFSYM (Qdelete_frame
, "delete-frame");
11092 DEFSYM (Qiconify_frame
, "iconify-frame");
11093 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11094 DEFSYM (Qselect_window
, "select-window");
11098 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11100 const struct event_head
*p
= &head_table
[i
];
11101 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11102 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11103 Fput (var
, Qevent_kind
, kind
);
11104 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11108 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11109 staticpro (&button_down_location
);
11110 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11111 staticpro (&mouse_syms
);
11112 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11114 staticpro (&wheel_syms
);
11118 int len
= ARRAYELTS (modifier_names
);
11120 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11121 for (i
= 0; i
< len
; i
++)
11122 if (modifier_names
[i
])
11123 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11124 staticpro (&modifier_symbols
);
11127 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11128 staticpro (&recent_keys
);
11130 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11131 staticpro (&this_command_keys
);
11133 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11134 staticpro (&raw_keybuf
);
11136 DEFSYM (Qcommand_execute
, "command-execute");
11137 DEFSYM (Qinternal_echo_keystrokes_prefix
, "internal-echo-keystrokes-prefix");
11139 accent_key_syms
= Qnil
;
11140 staticpro (&accent_key_syms
);
11142 func_key_syms
= Qnil
;
11143 staticpro (&func_key_syms
);
11145 drag_n_drop_syms
= Qnil
;
11146 staticpro (&drag_n_drop_syms
);
11148 unread_switch_frame
= Qnil
;
11149 staticpro (&unread_switch_frame
);
11151 internal_last_event_frame
= Qnil
;
11152 staticpro (&internal_last_event_frame
);
11154 read_key_sequence_cmd
= Qnil
;
11155 staticpro (&read_key_sequence_cmd
);
11156 read_key_sequence_remapped
= Qnil
;
11157 staticpro (&read_key_sequence_remapped
);
11159 menu_bar_one_keymap_changed_items
= Qnil
;
11160 staticpro (&menu_bar_one_keymap_changed_items
);
11162 menu_bar_items_vector
= Qnil
;
11163 staticpro (&menu_bar_items_vector
);
11165 help_form_saved_window_configs
= Qnil
;
11166 staticpro (&help_form_saved_window_configs
);
11168 defsubr (&Scurrent_idle_time
);
11169 defsubr (&Sevent_symbol_parse_modifiers
);
11170 defsubr (&Sevent_convert_list
);
11171 defsubr (&Sread_key_sequence
);
11172 defsubr (&Sread_key_sequence_vector
);
11173 defsubr (&Srecursive_edit
);
11174 defsubr (&Strack_mouse
);
11175 defsubr (&Sinput_pending_p
);
11176 defsubr (&Srecent_keys
);
11177 defsubr (&Sthis_command_keys
);
11178 defsubr (&Sthis_command_keys_vector
);
11179 defsubr (&Sthis_single_command_keys
);
11180 defsubr (&Sthis_single_command_raw_keys
);
11181 defsubr (&Sclear_this_command_keys
);
11182 defsubr (&Ssuspend_emacs
);
11183 defsubr (&Sabort_recursive_edit
);
11184 defsubr (&Sexit_recursive_edit
);
11185 defsubr (&Srecursion_depth
);
11186 defsubr (&Scommand_error_default_function
);
11187 defsubr (&Stop_level
);
11188 defsubr (&Sdiscard_input
);
11189 defsubr (&Sopen_dribble_file
);
11190 defsubr (&Sset_input_interrupt_mode
);
11191 defsubr (&Sset_output_flow_control
);
11192 defsubr (&Sset_input_meta_mode
);
11193 defsubr (&Sset_quit_char
);
11194 defsubr (&Sset_input_mode
);
11195 defsubr (&Scurrent_input_mode
);
11196 defsubr (&Sposn_at_point
);
11197 defsubr (&Sposn_at_x_y
);
11199 DEFVAR_LISP ("last-command-event", last_command_event
,
11200 doc
: /* Last input event that was part of a command. */);
11202 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11203 doc
: /* Last input event in a command, except for mouse menu events.
11204 Mouse menus give back keys that don't look like mouse events;
11205 this variable holds the actual mouse event that led to the menu,
11206 so that you can determine whether the command was run by mouse or not. */);
11208 DEFVAR_LISP ("last-input-event", last_input_event
,
11209 doc
: /* Last input event. */);
11211 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11212 doc
: /* List of events to be read as the command input.
11213 These events are processed first, before actual keyboard input.
11214 Events read from this list are not normally added to `this-command-keys',
11215 as they will already have been added once as they were read for the first time.
11216 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11217 Vunread_command_events
= Qnil
;
11219 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11220 doc
: /* List of events to be processed as input by input methods.
11221 These events are processed before `unread-command-events'
11222 and actual keyboard input, but are not given to `input-method-function'. */);
11223 Vunread_post_input_method_events
= Qnil
;
11225 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11226 doc
: /* List of events to be processed as input by input methods.
11227 These events are processed after `unread-command-events', but
11228 before actual keyboard input.
11229 If there's an active input method, the events are given to
11230 `input-method-function'. */);
11231 Vunread_input_method_events
= Qnil
;
11233 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11234 doc
: /* Meta-prefix character code.
11235 Meta-foo as command input turns into this character followed by foo. */);
11236 XSETINT (meta_prefix_char
, 033);
11238 DEFVAR_KBOARD ("last-command", Vlast_command
,
11239 doc
: /* The last command executed.
11240 Normally a symbol with a function definition, but can be whatever was found
11241 in the keymap, or whatever the variable `this-command' was set to by that
11244 The value `mode-exit' is special; it means that the previous command
11245 read an event that told it to exit, and it did so and unread that event.
11246 In other words, the present command is the event that made the previous
11249 The value `kill-region' is special; it means that the previous command
11250 was a kill command.
11252 `last-command' has a separate binding for each terminal device.
11253 See Info node `(elisp)Multiple Terminals'. */);
11255 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11256 doc
: /* Same as `last-command', but never altered by Lisp code.
11257 Taken from the previous value of `real-this-command'. */);
11259 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11260 doc
: /* Last command that may be repeated.
11261 The last command executed that was not bound to an input event.
11262 This is the command `repeat' will try to repeat.
11263 Taken from a previous value of `real-this-command'. */);
11265 DEFVAR_LISP ("this-command", Vthis_command
,
11266 doc
: /* The command now being executed.
11267 The command can set this variable; whatever is put here
11268 will be in `last-command' during the following command. */);
11269 Vthis_command
= Qnil
;
11271 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11272 doc
: /* This is like `this-command', except that commands should never modify it. */);
11273 Vreal_this_command
= Qnil
;
11275 DEFVAR_LISP ("this-command-keys-shift-translated",
11276 Vthis_command_keys_shift_translated
,
11277 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11278 Shift-translation occurs when there is no binding for the key sequence
11279 as entered, but a binding was found by changing an upper-case letter
11280 to lower-case, or a shifted function key to an unshifted one. */);
11281 Vthis_command_keys_shift_translated
= Qnil
;
11283 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11284 doc
: /* The command bound to the current key sequence before remapping.
11285 It equals `this-command' if the original command was not remapped through
11286 any of the active keymaps. Otherwise, the value of `this-command' is the
11287 result of looking up the original command in the active keymaps. */);
11288 Vthis_original_command
= Qnil
;
11290 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11291 doc
: /* Number of input events between auto-saves.
11292 Zero means disable autosaving due to number of characters typed. */);
11293 auto_save_interval
= 300;
11295 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11296 doc
: /* Number of seconds idle time before auto-save.
11297 Zero or nil means disable auto-saving due to idleness.
11298 After auto-saving due to this many seconds of idle time,
11299 Emacs also does a garbage collection if that seems to be warranted. */);
11300 XSETFASTINT (Vauto_save_timeout
, 30);
11302 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11303 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11304 The value may be integer or floating point.
11305 If the value is zero, don't echo at all. */);
11306 Vecho_keystrokes
= make_number (1);
11308 DEFVAR_INT ("polling-period", polling_period
,
11309 doc
: /* Interval between polling for input during Lisp execution.
11310 The reason for polling is to make C-g work to stop a running program.
11311 Polling is needed only when using X windows and SIGIO does not work.
11312 Polling is automatically disabled in all other cases. */);
11313 polling_period
= 2;
11315 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11316 doc
: /* Maximum time between mouse clicks to make a double-click.
11317 Measured in milliseconds. The value nil means disable double-click
11318 recognition; t means double-clicks have no time limit and are detected
11319 by position only. */);
11320 Vdouble_click_time
= make_number (500);
11322 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11323 doc
: /* Maximum mouse movement between clicks to make a double-click.
11324 On window-system frames, value is the number of pixels the mouse may have
11325 moved horizontally or vertically between two clicks to make a double-click.
11326 On non window-system frames, value is interpreted in units of 1/8 characters
11329 This variable is also the threshold for motion of the mouse
11330 to count as a drag. */);
11331 double_click_fuzz
= 3;
11333 DEFVAR_INT ("num-input-keys", num_input_keys
,
11334 doc
: /* Number of complete key sequences read as input so far.
11335 This includes key sequences read from keyboard macros.
11336 The number is effectively the number of interactive command invocations. */);
11337 num_input_keys
= 0;
11339 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11340 doc
: /* Number of input events read from the keyboard so far.
11341 This does not include events generated by keyboard macros. */);
11342 num_nonmacro_input_events
= 0;
11344 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11345 doc
: /* The frame in which the most recently read event occurred.
11346 If the last event came from a keyboard macro, this is set to `macro'. */);
11347 Vlast_event_frame
= Qnil
;
11349 /* This variable is set up in sysdep.c. */
11350 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11351 doc
: /* The ERASE character as set by the user with stty. */);
11353 DEFVAR_LISP ("help-char", Vhelp_char
,
11354 doc
: /* Character to recognize as meaning Help.
11355 When it is read, do `(eval help-form)', and display result if it's a string.
11356 If the value of `help-form' is nil, this char can be read normally. */);
11357 XSETINT (Vhelp_char
, Ctl ('H'));
11359 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11360 doc
: /* List of input events to recognize as meaning Help.
11361 These work just like the value of `help-char' (see that). */);
11362 Vhelp_event_list
= Qnil
;
11364 DEFVAR_LISP ("help-form", Vhelp_form
,
11365 doc
: /* Form to execute when character `help-char' is read.
11366 If the form returns a string, that string is displayed.
11367 If `help-form' is nil, the help char is not recognized. */);
11370 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11371 doc
: /* Command to run when `help-char' character follows a prefix key.
11372 This command is used only when there is no actual binding
11373 for that character after that prefix key. */);
11374 Vprefix_help_command
= Qnil
;
11376 DEFVAR_LISP ("top-level", Vtop_level
,
11377 doc
: /* Form to evaluate when Emacs starts up.
11378 Useful to set before you dump a modified Emacs. */);
11380 XSYMBOL (Qtop_level
)->declared_special
= false;
11382 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11383 doc
: /* Translate table for local keyboard input, or nil.
11384 If non-nil, the value should be a char-table. Each character read
11385 from the keyboard is looked up in this char-table. If the value found
11386 there is non-nil, then it is used instead of the actual input character.
11388 The value can also be a string or vector, but this is considered obsolete.
11389 If it is a string or vector of length N, character codes N and up are left
11390 untranslated. In a vector, an element which is nil means "no translation".
11392 This is applied to the characters supplied to input methods, not their
11393 output. See also `translation-table-for-input'.
11395 This variable has a separate binding for each terminal.
11396 See Info node `(elisp)Multiple Terminals'. */);
11398 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11399 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11400 \(Even if the operating system has support for stopping a process.) */);
11401 cannot_suspend
= false;
11403 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11404 doc
: /* Non-nil means prompt with menus when appropriate.
11405 This is done when reading from a keymap that has a prompt string,
11406 for elements that have prompt strings.
11407 The menu is displayed on the screen
11408 if X menus were enabled at configuration
11409 time and the previous event was a mouse click prefix key.
11410 Otherwise, menu prompting uses the echo area. */);
11411 menu_prompting
= true;
11413 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11414 doc
: /* Character to see next line of menu prompt.
11415 Type this character while in a menu prompt to rotate around the lines of it. */);
11416 XSETINT (menu_prompt_more_char
, ' ');
11418 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11419 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11420 Emacs applies the modifiers of the character stored here to each keyboard
11421 character it reads. For example, after evaluating the expression
11422 (setq extra-keyboard-modifiers ?\\C-x)
11423 all input characters will have the control modifier applied to them.
11425 Note that the character ?\\C-@, equivalent to the integer zero, does
11426 not count as a control character; rather, it counts as a character
11427 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11428 cancels any modification. */);
11429 extra_keyboard_modifiers
= 0;
11431 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11432 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11433 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11434 The command loop sets this to nil before each command,
11435 and tests the value when the command returns.
11436 Buffer modification stores t in this variable. */);
11437 Vdeactivate_mark
= Qnil
;
11438 Fmake_variable_buffer_local (Qdeactivate_mark
);
11440 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11441 doc
: /* Normal hook run before each command is executed.
11442 If an unhandled error happens in running this hook,
11443 the function in which the error occurred is unconditionally removed, since
11444 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11446 See also `post-command-hook'. */);
11447 Vpre_command_hook
= Qnil
;
11449 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11450 doc
: /* Normal hook run after each command is executed.
11451 If an unhandled error happens in running this hook,
11452 the function in which the error occurred is unconditionally removed, since
11453 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11455 It is a bad idea to use this hook for expensive processing. If
11456 unavoidable, wrap your code in `(while-no-input (redisplay) CODE)' to
11457 avoid making Emacs unresponsive while the user types.
11459 See also `pre-command-hook'. */);
11460 Vpost_command_hook
= Qnil
;
11463 DEFVAR_LISP ("echo-area-clear-hook", ...,
11464 doc
: /* Normal hook run when clearing the echo area. */);
11466 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11467 Fset (Qecho_area_clear_hook
, Qnil
);
11469 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11470 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11471 Vlucid_menu_bar_dirty_flag
= Qnil
;
11473 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11474 doc
: /* List of menu bar items to move to the end of the menu bar.
11475 The elements of the list are event types that may have menu bar bindings. */);
11476 Vmenu_bar_final_items
= Qnil
;
11478 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11479 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11480 This is used internally by graphical displays that do not render
11481 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11482 Vtool_bar_separator_image_expression
= Qnil
;
11484 DEFVAR_KBOARD ("overriding-terminal-local-map",
11485 Voverriding_terminal_local_map
,
11486 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11487 This variable is intended to let commands such as `universal-argument'
11488 set up a different keymap for reading the next command.
11490 `overriding-terminal-local-map' has a separate binding for each
11491 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11493 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11494 doc
: /* Keymap that replaces (overrides) local keymaps.
11495 If this variable is non-nil, Emacs looks up key bindings in this
11496 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11497 buffer's local map. Hence, the only active keymaps would be
11498 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11499 order of precedence. */);
11500 Voverriding_local_map
= Qnil
;
11502 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11503 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11504 Otherwise, the menu bar continues to reflect the buffer's local map
11505 and the minor mode maps regardless of `overriding-local-map'. */);
11506 Voverriding_local_map_menu_flag
= Qnil
;
11508 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11509 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11510 Vspecial_event_map
= list1 (Qkeymap
);
11512 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11513 doc
: /* Non-nil means generate motion events for mouse motion. */);
11515 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11516 doc
: /* Alist of system-specific X windows key symbols.
11517 Each element should have the form (N . SYMBOL) where N is the
11518 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11519 and SYMBOL is its name.
11521 `system-key-alist' has a separate binding for each terminal device.
11522 See Info node `(elisp)Multiple Terminals'. */);
11524 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11525 doc
: /* Keymap that translates key sequences to key sequences during input.
11526 This is used mainly for mapping key sequences into some preferred
11527 key events (symbols).
11529 The `read-key-sequence' function replaces any subsequence bound by
11530 `local-function-key-map' with its binding. More precisely, when the
11531 active keymaps have no binding for the current key sequence but
11532 `local-function-key-map' binds a suffix of the sequence to a vector or
11533 string, `read-key-sequence' replaces the matching suffix with its
11534 binding, and continues with the new sequence.
11536 If the binding is a function, it is called with one argument (the prompt)
11537 and its return value (a key sequence) is used.
11539 The events that come from bindings in `local-function-key-map' are not
11540 themselves looked up in `local-function-key-map'.
11542 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11543 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11544 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11545 typing `ESC O P x' would return [f1 x].
11547 `local-function-key-map' has a separate binding for each terminal
11548 device. See Info node `(elisp)Multiple Terminals'. If you need to
11549 define a binding on all terminals, change `function-key-map'
11550 instead. Initially, `local-function-key-map' is an empty keymap that
11551 has `function-key-map' as its parent on all terminal devices. */);
11553 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11554 doc
: /* Keymap that decodes input escape sequences.
11555 This is used mainly for mapping ASCII function key sequences into
11556 real Emacs function key events (symbols).
11558 The `read-key-sequence' function replaces any subsequence bound by
11559 `input-decode-map' with its binding. Contrary to `function-key-map',
11560 this map applies its rebinding regardless of the presence of an ordinary
11561 binding. So it is more like `key-translation-map' except that it applies
11562 before `function-key-map' rather than after.
11564 If the binding is a function, it is called with one argument (the prompt)
11565 and its return value (a key sequence) is used.
11567 The events that come from bindings in `input-decode-map' are not
11568 themselves looked up in `input-decode-map'. */);
11570 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11571 doc
: /* The parent keymap of all `local-function-key-map' instances.
11572 Function key definitions that apply to all terminal devices should go
11573 here. If a mapping is defined in both the current
11574 `local-function-key-map' binding and this variable, then the local
11575 definition will take precedence. */);
11576 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11578 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11579 doc
: /* Keymap of key translations that can override keymaps.
11580 This keymap works like `input-decode-map', but comes after `function-key-map'.
11581 Another difference is that it is global rather than terminal-local. */);
11582 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11584 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11585 doc
: /* List of deferred actions to be performed at a later time.
11586 The precise format isn't relevant here; we just check whether it is nil. */);
11587 Vdeferred_action_list
= Qnil
;
11589 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11590 doc
: /* Function to call to handle deferred actions, after each command.
11591 This function is called with no arguments after each command
11592 whenever `deferred-action-list' is non-nil. */);
11593 Vdeferred_action_function
= Qnil
;
11595 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11596 doc
: /* List of warnings to be displayed after this command.
11597 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11598 as per the args of `display-warning' (which see).
11599 If this variable is non-nil, `delayed-warnings-hook' will be run
11600 immediately after running `post-command-hook'. */);
11601 Vdelayed_warnings_list
= Qnil
;
11603 DEFVAR_LISP ("timer-list", Vtimer_list
,
11604 doc
: /* List of active absolute time timers in order of increasing time. */);
11605 Vtimer_list
= Qnil
;
11607 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11608 doc
: /* List of active idle-time timers in order of increasing time. */);
11609 Vtimer_idle_list
= Qnil
;
11611 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11612 doc
: /* If non-nil, the function that implements the current input method.
11613 It's called with one argument, a printing character that was just read.
11614 \(That means a character with code 040...0176.)
11615 Typically this function uses `read-event' to read additional events.
11616 When it does so, it should first bind `input-method-function' to nil
11617 so it will not be called recursively.
11619 The function should return a list of zero or more events
11620 to be used as input. If it wants to put back some events
11621 to be reconsidered, separately, by the input method,
11622 it can add them to the beginning of `unread-command-events'.
11624 The input method function can find in `input-method-previous-message'
11625 the previous echo area message.
11627 The input method function should refer to the variables
11628 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11629 for guidance on what to do. */);
11630 Vinput_method_function
= Qlist
;
11632 DEFVAR_LISP ("input-method-previous-message",
11633 Vinput_method_previous_message
,
11634 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11635 This variable exists because `read-event' clears the echo area
11636 before running the input method. It is nil if there was no message. */);
11637 Vinput_method_previous_message
= Qnil
;
11639 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11640 doc
: /* If non-nil, the function that implements the display of help.
11641 It's called with one argument, the help string to display. */);
11642 Vshow_help_function
= Qnil
;
11644 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11645 doc
: /* If non-nil, suppress point adjustment after executing a command.
11647 After a command is executed, if point moved into a region that has
11648 special properties (e.g. composition, display), Emacs adjusts point to
11649 the boundary of the region. But when a command leaves this variable at
11650 a non-nil value (e.g., with a setq), this point adjustment is suppressed.
11652 This variable is set to nil before reading a command, and is checked
11653 just after executing the command. */);
11654 Vdisable_point_adjustment
= Qnil
;
11656 DEFVAR_LISP ("global-disable-point-adjustment",
11657 Vglobal_disable_point_adjustment
,
11658 doc
: /* If non-nil, always suppress point adjustments.
11660 The default value is nil, in which case point adjustments are
11661 suppressed only after special commands that leave
11662 `disable-point-adjustment' (which see) at a non-nil value. */);
11663 Vglobal_disable_point_adjustment
= Qnil
;
11665 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11666 doc
: /* How long to display an echo-area message when the minibuffer is active.
11667 If the value is a number, it should be specified in seconds.
11668 If the value is not a number, such messages never time out. */);
11669 Vminibuffer_message_timeout
= make_number (2);
11671 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11672 doc
: /* If non-nil, any keyboard input throws to this symbol.
11673 The value of that variable is passed to `quit-flag' and later causes a
11674 peculiar kind of quitting. */);
11675 Vthrow_on_input
= Qnil
;
11677 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11678 doc
: /* Function to output error messages.
11679 Called with three arguments:
11680 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11681 such as what `condition-case' would bind its variable to,
11682 - the context (a string which normally goes at the start of the message),
11683 - the Lisp function within which the error was signaled. */);
11684 Vcommand_error_function
= intern ("command-error-default-function");
11686 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11687 Venable_disabled_menus_and_buttons
,
11688 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11690 Help functions bind this to allow help on disabled menu items
11691 and tool-bar buttons. */);
11692 Venable_disabled_menus_and_buttons
= Qnil
;
11694 DEFVAR_LISP ("select-active-regions",
11695 Vselect_active_regions
,
11696 doc
: /* If non-nil, an active region automatically sets the primary selection.
11697 If the value is `only', only temporarily active regions (usually made
11698 by mouse-dragging or shift-selection) set the window selection.
11700 This takes effect only when Transient Mark mode is enabled. */);
11701 Vselect_active_regions
= Qt
;
11703 DEFVAR_LISP ("saved-region-selection",
11704 Vsaved_region_selection
,
11705 doc
: /* Contents of active region prior to buffer modification.
11706 If `select-active-regions' is non-nil, Emacs sets this to the
11707 text in the region before modifying the buffer. The next call to
11708 the function `deactivate-mark' uses this to set the window selection. */);
11709 Vsaved_region_selection
= Qnil
;
11711 DEFVAR_LISP ("selection-inhibit-update-commands",
11712 Vselection_inhibit_update_commands
,
11713 doc
: /* List of commands which should not update the selection.
11714 Normally, if `select-active-regions' is non-nil and the mark remains
11715 active after a command (i.e. the mark was not deactivated), the Emacs
11716 command loop sets the selection to the text in the region. However,
11717 if the command is in this list, the selection is not updated. */);
11718 Vselection_inhibit_update_commands
11719 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11721 DEFVAR_LISP ("debug-on-event",
11723 doc
: /* Enter debugger on this event. When Emacs
11724 receives the special event specified by this variable, it will try to
11725 break into the debugger as soon as possible instead of processing the
11726 event normally through `special-event-map'.
11728 Currently, the only supported values for this
11729 variable are `sigusr1' and `sigusr2'. */);
11730 Vdebug_on_event
= intern_c_string ("sigusr2");
11732 /* Create the initial keyboard. Qt means 'unset'. */
11733 initial_kboard
= allocate_kboard (Qt
);
11737 keys_of_keyboard (void)
11739 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11740 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11741 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11742 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11743 initial_define_key (meta_map
, 'x', "execute-extended-command");
11745 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11746 "handle-delete-frame");
11747 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11748 "ns-put-working-text");
11749 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11750 "ns-unput-working-text");
11751 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11752 current-prefix-arg, as is done in `handle-switch-frame'.
11753 But `handle-switch-frame is not run from the special-map.
11754 Commands from that map are run in a special way that automatically
11755 preserves the prefix-arg. Restoring the prefix arg here is not just
11756 redundant but harmful:
11758 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11759 - after the first prompt, the exit-minibuffer-hook is run which may
11760 iconify a frame and thus push a `iconify-frame' event.
11761 - after running exit-minibuffer-hook, current-prefix-arg is
11762 restored to the non-nil value it had before the prompt.
11763 - we enter the second prompt.
11764 current-prefix-arg is non-nil, prefix-arg is nil.
11765 - before running the first real event, we run the special iconify-frame
11766 event, but we pass the `special' arg to command-execute so
11767 current-prefix-arg and prefix-arg are left untouched.
11768 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11769 - the next key event will have a spuriously non-nil current-prefix-arg. */
11770 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11772 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11774 /* Handling it at such a low-level causes read_key_sequence to get
11775 * confused because it doesn't realize that the current_buffer was
11776 * changed by read_char.
11778 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11779 * "handle-select-window"); */
11780 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11781 "handle-save-session");
11784 /* Define a special event which is raised for dbus callback
11786 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11787 "dbus-handle-event");
11790 #ifdef USE_FILE_NOTIFY
11791 /* Define a special event which is raised for notification callback
11793 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11794 "file-notify-handle-event");
11795 #endif /* USE_FILE_NOTIFY */
11797 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11799 #if defined (WINDOWSNT)
11800 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11803 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11804 "handle-focus-in");
11805 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11806 "handle-focus-out");
11809 /* Mark the pointers in the kboard objects.
11810 Called by Fgarbage_collect. */
11812 mark_kboards (void)
11816 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11818 if (kb
->kbd_macro_buffer
)
11819 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11821 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11822 mark_object (KVAR (kb
, Vlast_command
));
11823 mark_object (KVAR (kb
, Vreal_last_command
));
11824 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11825 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11826 mark_object (KVAR (kb
, Vprefix_arg
));
11827 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11828 mark_object (KVAR (kb
, kbd_queue
));
11829 mark_object (KVAR (kb
, defining_kbd_macro
));
11830 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11831 mark_object (KVAR (kb
, Vsystem_key_alist
));
11832 mark_object (KVAR (kb
, system_key_syms
));
11833 mark_object (KVAR (kb
, Vwindow_system
));
11834 mark_object (KVAR (kb
, Vinput_decode_map
));
11835 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11836 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11837 mark_object (KVAR (kb
, echo_string
));
11838 mark_object (KVAR (kb
, echo_prompt
));
11841 union buffered_input_event
*event
;
11842 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11844 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11845 event
= kbd_buffer
;
11846 /* These two special event types has no Lisp_Objects to mark. */
11847 if (event
->kind
!= SELECTION_REQUEST_EVENT
11848 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11850 mark_object (event
->ie
.x
);
11851 mark_object (event
->ie
.y
);
11852 mark_object (event
->ie
.frame_or_window
);
11853 mark_object (event
->ie
.arg
);