1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2015 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
11 (at 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 #ifdef HAVE_WINDOW_SYSTEM
69 #endif /* HAVE_WINDOW_SYSTEM */
71 /* Variables for blockinput.h: */
73 /* Positive if interrupt input is blocked right now. */
74 volatile int interrupt_input_blocked
;
76 /* True means an input interrupt or alarm signal has arrived.
77 The QUIT macro checks this. */
78 volatile bool pending_signals
;
80 #define KBD_BUFFER_SIZE 4096
82 KBOARD
*initial_kboard
;
83 KBOARD
*current_kboard
;
84 static KBOARD
*all_kboards
;
86 /* True in the single-kboard state, false in the any-kboard state. */
87 static bool single_kboard
;
89 #define NUM_RECENT_KEYS (300)
91 /* Index for storing next element into recent_keys. */
92 static int recent_keys_index
;
94 /* Total number of elements stored into recent_keys. */
95 static int total_keys
;
97 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
98 static Lisp_Object recent_keys
;
100 /* Vector holding the key sequence that invoked the current command.
101 It is reused for each command, and it may be longer than the current
102 sequence; this_command_key_count indicates how many elements
103 actually mean something.
104 It's easier to staticpro a single Lisp_Object than an array. */
105 Lisp_Object this_command_keys
;
106 ptrdiff_t this_command_key_count
;
108 /* This vector is used as a buffer to record the events that were actually read
109 by read_key_sequence. */
110 static Lisp_Object raw_keybuf
;
111 static int raw_keybuf_count
;
113 #define GROW_RAW_KEYBUF \
114 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
115 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
117 /* Number of elements of this_command_keys
118 that precede this key sequence. */
119 static ptrdiff_t this_single_command_key_start
;
121 #ifdef HAVE_STACK_OVERFLOW_HANDLING
123 /* For longjmp to recover from C stack overflow. */
124 sigjmp_buf return_to_command_loop
;
126 /* Message displayed by Vtop_level when recovering from C stack overflow. */
127 static Lisp_Object recover_top_level_message
;
129 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
131 /* Message normally displayed by Vtop_level. */
132 static Lisp_Object regular_top_level_message
;
134 /* For longjmp to where kbd input is being done. */
136 static sys_jmp_buf getcjmp
;
138 /* True while doing kbd input. */
139 bool waiting_for_input
;
141 /* True while displaying for echoing. Delays C-g throwing. */
145 /* Non-null means we can start echoing at the next input pause even
146 though there is something in the echo area. */
148 static struct kboard
*ok_to_echo_at_next_pause
;
150 /* The kboard last echoing, or null for none. Reset to 0 in
151 cancel_echoing. If non-null, and a current echo area message
152 exists, and echo_message_buffer is eq to the current message
153 buffer, we know that the message comes from echo_kboard. */
155 struct kboard
*echo_kboard
;
157 /* The buffer used for echoing. Set in echo_now, reset in
160 Lisp_Object echo_message_buffer
;
162 /* True means C-g should cause immediate error-signal. */
165 /* Character that causes a quit. Normally C-g.
167 If we are running on an ordinary terminal, this must be an ordinary
168 ASCII char, since we want to make it our interrupt character.
170 If we are not running on an ordinary terminal, it still needs to be
171 an ordinary ASCII char. This character needs to be recognized in
172 the input interrupt handler. At this point, the keystroke is
173 represented as a struct input_event, while the desired quit
174 character is specified as a lispy event. The mapping from struct
175 input_events to lispy events cannot run in an interrupt handler,
176 and the reverse mapping is difficult for anything but ASCII
179 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
183 /* Current depth in recursive edits. */
184 EMACS_INT command_loop_level
;
186 /* If not Qnil, this is a switch-frame event which we decided to put
187 off until the end of a key sequence. This should be read as the
188 next command input, after any unread_command_events.
190 read_key_sequence uses this to delay switch-frame events until the
191 end of the key sequence; Fread_char uses it to put off switch-frame
192 events until a non-ASCII event is acceptable as input. */
193 Lisp_Object unread_switch_frame
;
195 /* Last size recorded for a current buffer which is not a minibuffer. */
196 static ptrdiff_t last_non_minibuf_size
;
198 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
199 uintmax_t num_input_events
;
201 /* Value of num_nonmacro_input_events as of last auto save. */
203 static EMACS_INT last_auto_save
;
205 /* The value of point when the last command was started. */
206 static ptrdiff_t last_point_position
;
208 /* The frame in which the last input event occurred, or Qmacro if the
209 last event came from a macro. We use this to determine when to
210 generate switch-frame events. This may be cleared by functions
211 like Fselect_frame, to make sure that a switch-frame event is
212 generated by the next character.
214 FIXME: This is modified by a signal handler so it should be volatile.
215 It's exported to Lisp, though, so it can't simply be marked
217 Lisp_Object internal_last_event_frame
;
219 /* `read_key_sequence' stores here the command definition of the
220 key sequence that it reads. */
221 static Lisp_Object read_key_sequence_cmd
;
222 static Lisp_Object read_key_sequence_remapped
;
224 /* File in which we write all commands we read. */
225 static FILE *dribble
;
227 /* True if input is available. */
230 /* True if more input was available last time we read an event.
232 Since redisplay can take a significant amount of time and is not
233 indispensable to perform the user's commands, when input arrives
234 "too fast", Emacs skips redisplay. More specifically, if the next
235 command has already been input when we finish the previous command,
236 we skip the intermediate redisplay.
238 This is useful to try and make sure Emacs keeps up with fast input
239 rates, such as auto-repeating keys. But in some cases, this proves
240 too conservative: we may end up disabling redisplay for the whole
241 duration of a key repetition, even though we could afford to
242 redisplay every once in a while.
244 So we "sample" the input_pending flag before running a command and
245 use *that* value after running the command to decide whether to
246 skip redisplay or not. This way, we only skip redisplay if we
247 really can't keep up with the repeat rate.
249 This only makes a difference if the next input arrives while running the
250 command, which is very unlikely if the command is executed quickly.
251 IOW this tends to avoid skipping redisplay after a long running command
252 (which is a case where skipping redisplay is not very useful since the
253 redisplay time is small compared to the time it took to run the command).
255 A typical use case is when scrolling. Scrolling time can be split into:
256 - Time to do jit-lock on the newly displayed portion of buffer.
257 - Time to run the actual scroll command.
258 - Time to perform the redisplay.
259 Jit-lock can happen either during the command or during the redisplay.
260 In the most painful cases, the jit-lock time is the one that dominates.
261 Also jit-lock can be tweaked (via jit-lock-defer) to delay its job, at the
262 cost of temporary inaccuracy in display and scrolling.
263 So without input_was_pending, what typically happens is the following:
264 - when the command starts, there's no pending input (yet).
265 - the scroll command triggers jit-lock.
266 - during the long jit-lock time the next input arrives.
267 - at the end of the command, we check input_pending and hence decide to
269 - we read the next input and start over.
270 End result: all the hard work of jit-locking is "wasted" since redisplay
271 doesn't actually happens (at least not before the input rate slows down).
272 With input_was_pending redisplay is still skipped if Emacs can't keep up
273 with the input rate, but if it can keep up just enough that there's no
274 input_pending when we begin the command, then redisplay is not skipped
275 which results in better feedback to the user. */
276 static bool input_was_pending
;
278 /* Circular buffer for pre-read keyboard input. */
280 static union buffered_input_event kbd_buffer
[KBD_BUFFER_SIZE
];
282 /* Pointer to next available character in kbd_buffer.
283 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
284 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
285 next available char is in kbd_buffer[0]. */
286 static union buffered_input_event
*kbd_fetch_ptr
;
288 /* Pointer to next place to store character in kbd_buffer. This
289 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
290 character should go in kbd_buffer[0]. */
291 static union buffered_input_event
*volatile kbd_store_ptr
;
293 /* The above pair of variables forms a "queue empty" flag. When we
294 enqueue a non-hook event, we increment kbd_store_ptr. When we
295 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
296 there is input available if the two pointers are not equal.
298 Why not just have a flag set and cleared by the enqueuing and
299 dequeuing functions? Such a flag could be screwed up by interrupts
300 at inopportune times. */
302 static void recursive_edit_unwind (Lisp_Object buffer
);
303 static Lisp_Object
command_loop (void);
305 static void echo_now (void);
306 static ptrdiff_t echo_length (void);
308 /* Incremented whenever a timer is run. */
311 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
313 struct timespec
*input_available_clear_time
;
315 /* True means use SIGIO interrupts; false means use CBREAK mode.
316 Default is true if INTERRUPT_INPUT is defined. */
317 bool interrupt_input
;
319 /* Nonzero while interrupts are temporarily deferred during redisplay. */
320 bool interrupts_deferred
;
322 /* The time when Emacs started being idle. */
324 static struct timespec timer_idleness_start_time
;
326 /* After Emacs stops being idle, this saves the last value
327 of timer_idleness_start_time from when it was idle. */
329 static struct timespec timer_last_idleness_start_time
;
332 /* Global variable declarations. */
334 /* Flags for readable_events. */
335 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
336 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
337 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
339 /* Function for init_keyboard to call with no args (if nonzero). */
340 static void (*keyboard_init_hook
) (void);
342 static bool get_input_pending (int);
343 static bool readable_events (int);
344 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
345 Lisp_Object
, bool *);
346 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
347 static Lisp_Object
make_lispy_event (struct input_event
*);
348 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
349 enum scroll_bar_part
,
350 Lisp_Object
, Lisp_Object
,
352 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
353 Lisp_Object
, const char *const *,
354 Lisp_Object
*, ptrdiff_t);
355 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
356 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
357 #ifdef HAVE_WINDOW_SYSTEM
358 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
359 #endif /* HAVE_WINDOW_SYSTEM */
360 static bool help_char_p (Lisp_Object
);
361 static void save_getcjmp (sys_jmp_buf
);
362 static void restore_getcjmp (sys_jmp_buf
);
363 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
364 static void restore_kboard_configuration (int);
365 static void handle_interrupt (bool);
366 static _Noreturn
void quit_throw_to_read_char (bool);
367 static void timer_start_idle (void);
368 static void timer_stop_idle (void);
369 static void timer_resume_idle (void);
370 static void deliver_user_signal (int);
371 static char *find_user_signal_name (int);
372 static void store_user_signal_events (void);
374 /* These setters are used only in this file, so they can be private. */
376 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
378 kb
->echo_string_
= val
;
381 kset_echo_prompt (struct kboard
*kb
, Lisp_Object val
)
383 kb
->echo_prompt_
= val
;
386 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
388 kb
->kbd_queue_
= val
;
391 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
393 kb
->Vkeyboard_translate_table_
= val
;
396 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
398 kb
->Vlast_prefix_arg_
= val
;
401 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
403 kb
->Vlast_repeatable_command_
= val
;
406 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
408 kb
->Vlocal_function_key_map_
= val
;
411 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
413 kb
->Voverriding_terminal_local_map_
= val
;
416 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
418 kb
->Vreal_last_command_
= val
;
421 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
423 kb
->system_key_syms_
= val
;
427 /* Add C to the echo string, without echoing it immediately. C can be
428 a character, which is pretty-printed, or a symbol, whose name is
432 echo_add_key (Lisp_Object c
)
434 char initbuf
[KEY_DESCRIPTION_SIZE
+ 100];
435 ptrdiff_t size
= sizeof initbuf
;
436 char *buffer
= initbuf
;
438 Lisp_Object echo_string
= KVAR (current_kboard
, echo_string
);
441 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
442 /* Add a space at the end as a separator between keys. */
445 /* If someone has passed us a composite event, use its head symbol. */
449 ptr
= push_key_description (XINT (c
), ptr
);
450 else if (SYMBOLP (c
))
452 Lisp_Object name
= SYMBOL_NAME (c
);
453 ptrdiff_t nbytes
= SBYTES (name
);
455 if (size
- (ptr
- buffer
) < nbytes
)
457 ptrdiff_t offset
= ptr
- buffer
;
458 size
= max (2 * size
, size
+ nbytes
);
459 buffer
= SAFE_ALLOCA (size
);
460 ptr
= buffer
+ offset
;
463 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
464 STRING_MULTIBYTE (name
), 1);
467 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
470 static const char text
[] = " (Type ? for further options)";
471 int len
= sizeof text
- 1;
473 if (size
- (ptr
- buffer
) < len
)
475 ptrdiff_t offset
= ptr
- buffer
;
477 buffer
= SAFE_ALLOCA (size
);
478 ptr
= buffer
+ offset
;
481 memcpy (ptr
, text
, len
);
487 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
491 /* Temporarily add a dash to the end of the echo string if it's not
492 empty, so that it serves as a mini-prompt for the very next
498 /* Do nothing if not echoing at all. */
499 if (NILP (KVAR (current_kboard
, echo_string
)))
502 if (!current_kboard
->immediate_echo
503 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
506 /* Do nothing if we just printed a prompt. */
507 if (STRINGP (KVAR (current_kboard
, echo_prompt
))
508 && (SCHARS (KVAR (current_kboard
, echo_prompt
))
509 == SCHARS (KVAR (current_kboard
, echo_string
))))
512 /* Do nothing if we have already put a dash at the end. */
513 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
515 Lisp_Object last_char
, prev_char
, idx
;
517 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
518 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
520 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
521 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
523 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
527 /* Put a dash at the end of the buffer temporarily,
528 but make it go away when the next character is added. */
529 AUTO_STRING (dash
, "-");
530 kset_echo_string (current_kboard
,
531 concat2 (KVAR (current_kboard
, echo_string
), dash
));
538 if (current_kboard
->immediate_echo
)
541 Lisp_Object prompt
= KVAR (current_kboard
, echo_prompt
);
542 Lisp_Object prefix
= call0 (Qinternal_echo_keystrokes_prefix
);
543 kset_echo_string (current_kboard
,
544 NILP (prompt
) ? prefix
545 : NILP (prefix
) ? prompt
546 : concat2 (prompt
, prefix
));
548 for (i
= 0; i
< this_command_key_count
; i
++)
552 c
= AREF (this_command_keys
, i
);
553 if (! (EVENT_HAS_PARAMETERS (c
)
554 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
562 /* Display the current echo string, and begin echoing if not already
568 if (!current_kboard
->immediate_echo
)
570 current_kboard
->immediate_echo
= true;
572 /* Put a dash at the end to invite the user to type more. */
577 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
578 message3_nolog (KVAR (current_kboard
, echo_string
));
581 /* Record in what buffer we echoed, and from which kboard. */
582 echo_message_buffer
= echo_area_buffer
[0];
583 echo_kboard
= current_kboard
;
585 if (waiting_for_input
&& !NILP (Vquit_flag
))
586 quit_throw_to_read_char (0);
589 /* Turn off echoing, for the start of a new command. */
592 cancel_echoing (void)
594 current_kboard
->immediate_echo
= false;
595 kset_echo_prompt (current_kboard
, Qnil
);
596 kset_echo_string (current_kboard
, Qnil
);
597 ok_to_echo_at_next_pause
= NULL
;
599 echo_message_buffer
= Qnil
;
602 /* Return the length of the current echo string. */
607 return (STRINGP (KVAR (current_kboard
, echo_string
))
608 ? SCHARS (KVAR (current_kboard
, echo_string
))
612 /* Truncate the current echo message to its first LEN chars.
613 This and echo_char get used by read_key_sequence when the user
614 switches frames while entering a key sequence. */
617 echo_truncate (ptrdiff_t nchars
)
619 if (STRINGP (KVAR (current_kboard
, echo_string
)))
620 kset_echo_string (current_kboard
,
621 Fsubstring (KVAR (current_kboard
, echo_string
),
622 make_number (0), make_number (nchars
)));
623 truncate_echo_area (nchars
);
627 /* Functions for manipulating this_command_keys. */
629 add_command_key (Lisp_Object key
)
631 if (this_command_key_count
>= ASIZE (this_command_keys
))
632 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
634 ASET (this_command_keys
, this_command_key_count
, key
);
635 ++this_command_key_count
;
640 recursive_edit_1 (void)
642 ptrdiff_t count
= SPECPDL_INDEX ();
645 if (command_loop_level
> 0)
647 specbind (Qstandard_output
, Qt
);
648 specbind (Qstandard_input
, Qt
);
651 #ifdef HAVE_WINDOW_SYSTEM
652 /* The command loop has started an hourglass timer, so we have to
653 cancel it here, otherwise it will fire because the recursive edit
654 can take some time. Do not check for display_hourglass_p here,
655 because it could already be nil. */
659 /* This function may have been called from a debugger called from
660 within redisplay, for instance by Edebugging a function called
661 from fontification-functions. We want to allow redisplay in
662 the debugging session.
664 The recursive edit is left with a `(throw exit ...)'. The `exit'
665 tag is not caught anywhere in redisplay, i.e. when we leave the
666 recursive edit, the original redisplay leading to the recursive
667 edit will be unwound. The outcome should therefore be safe. */
668 specbind (Qinhibit_redisplay
, Qnil
);
671 val
= command_loop ();
673 Fsignal (Qquit
, Qnil
);
674 /* Handle throw from read_minibuf when using minibuffer
675 while it's active but we're in another window. */
677 xsignal1 (Qerror
, val
);
679 return unbind_to (count
, Qnil
);
682 /* When an auto-save happens, record the "time", and don't do again soon. */
685 record_auto_save (void)
687 last_auto_save
= num_nonmacro_input_events
;
690 /* Make an auto save happen as soon as possible at command level. */
694 force_auto_save_soon (void)
696 last_auto_save
= - auto_save_interval
- 1;
698 record_asynch_buffer_change ();
702 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
703 doc
: /* Invoke the editor command loop recursively.
704 To get out of the recursive edit, a command can throw to `exit' -- for
705 instance (throw \\='exit nil).
706 If you throw a value other than t, `recursive-edit' returns normally
707 to the function that called it. Throwing a t value causes
708 `recursive-edit' to quit, so that control returns to the command loop
711 This function is called by the editor initialization to begin editing. */)
714 ptrdiff_t count
= SPECPDL_INDEX ();
717 /* If we enter while input is blocked, don't lock up here.
718 This may happen through the debugger during redisplay. */
719 if (input_blocked_p ())
722 if (command_loop_level
>= 0
723 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
724 buffer
= Fcurrent_buffer ();
728 /* Don't do anything interesting between the increment and the
729 record_unwind_protect! Otherwise, we could get distracted and
730 never decrement the counter again. */
731 command_loop_level
++;
732 update_mode_lines
= 17;
733 record_unwind_protect (recursive_edit_unwind
, buffer
);
735 /* If we leave recursive_edit_1 below with a `throw' for instance,
736 like it is done in the splash screen display, we have to
737 make sure that we restore single_kboard as command_loop_1
738 would have done if it were left normally. */
739 if (command_loop_level
> 0)
740 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
743 return unbind_to (count
, Qnil
);
747 recursive_edit_unwind (Lisp_Object buffer
)
749 if (BUFFERP (buffer
))
750 Fset_buffer (buffer
);
752 command_loop_level
--;
753 update_mode_lines
= 18;
757 #if 0 /* These two functions are now replaced with
758 temporarily_switch_to_single_kboard. */
762 #if 0 /* Theory: if there's anything in Vunread_command_events,
763 it will right away be read by read_key_sequence,
764 and then if we do switch KBOARDS, it will go into the side
765 queue then. So we don't need to do anything special here -- rms. */
766 if (CONSP (Vunread_command_events
))
768 current_kboard
->kbd_queue
769 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
770 current_kboard
->kbd_queue_has_data
= true;
772 Vunread_command_events
= Qnil
;
774 single_kboard
= false;
777 /* Switch to the single-kboard state, making current_kboard
778 the only KBOARD from which further input is accepted. */
781 single_kboard_state ()
783 single_kboard
= true;
787 /* If we're in single_kboard state for kboard KBOARD,
791 not_single_kboard_state (KBOARD
*kboard
)
793 if (kboard
== current_kboard
)
794 single_kboard
= false;
797 /* Maintain a stack of kboards, so other parts of Emacs
798 can switch temporarily to the kboard of a given frame
799 and then revert to the previous status. */
804 struct kboard_stack
*next
;
807 static struct kboard_stack
*kboard_stack
;
810 push_kboard (struct kboard
*k
)
812 struct kboard_stack
*p
= xmalloc (sizeof *p
);
814 p
->next
= kboard_stack
;
815 p
->kboard
= current_kboard
;
825 struct kboard_stack
*p
= kboard_stack
;
827 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
829 if (t
->kboard
== p
->kboard
)
831 current_kboard
= p
->kboard
;
838 /* The terminal we remembered has been deleted. */
839 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
840 single_kboard
= false;
842 kboard_stack
= p
->next
;
846 /* Switch to single_kboard mode, making current_kboard the only KBOARD
847 from which further input is accepted. If F is non-nil, set its
848 KBOARD as the current keyboard.
850 This function uses record_unwind_protect_int to return to the previous
853 If Emacs is already in single_kboard mode, and F's keyboard is
854 locked, then this function will throw an error. */
857 temporarily_switch_to_single_kboard (struct frame
*f
)
859 bool was_locked
= single_kboard
;
862 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
863 /* We can not switch keyboards while in single_kboard mode.
864 In rare cases, Lisp code may call `recursive-edit' (or
865 `read-minibuffer' or `y-or-n-p') after it switched to a
866 locked frame. For example, this is likely to happen
867 when server.el connects to a new terminal while Emacs is in
868 single_kboard mode. It is best to throw an error instead
869 of presenting the user with a frozen screen. */
870 error ("Terminal %d is locked, cannot read from it",
871 FRAME_TERMINAL (f
)->id
);
873 /* This call is unnecessary, but helps
874 `restore_kboard_configuration' discover if somebody changed
875 `current_kboard' behind our back. */
876 push_kboard (current_kboard
);
879 current_kboard
= FRAME_KBOARD (f
);
880 single_kboard
= true;
881 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
884 #if 0 /* This function is not needed anymore. */
886 record_single_kboard_state ()
889 push_kboard (current_kboard
);
890 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
895 restore_kboard_configuration (int was_locked
)
897 single_kboard
= was_locked
;
900 struct kboard
*prev
= current_kboard
;
902 /* The pop should not change the kboard. */
903 if (single_kboard
&& current_kboard
!= prev
)
909 /* Handle errors that are not handled at inner levels
910 by printing an error message and returning to the editor command loop. */
913 cmd_error (Lisp_Object data
)
915 Lisp_Object old_level
, old_length
;
916 char macroerror
[sizeof "After..kbd macro iterations: "
917 + INT_STRLEN_BOUND (EMACS_INT
)];
919 #ifdef HAVE_WINDOW_SYSTEM
920 if (display_hourglass_p
)
924 if (!NILP (executing_kbd_macro
))
926 if (executing_kbd_macro_iterations
== 1)
927 sprintf (macroerror
, "After 1 kbd macro iteration: ");
929 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
930 executing_kbd_macro_iterations
);
935 Vstandard_output
= Qt
;
936 Vstandard_input
= Qt
;
937 Vexecuting_kbd_macro
= Qnil
;
938 executing_kbd_macro
= Qnil
;
939 kset_prefix_arg (current_kboard
, Qnil
);
940 kset_last_prefix_arg (current_kboard
, Qnil
);
943 /* Avoid unquittable loop if data contains a circular list. */
944 old_level
= Vprint_level
;
945 old_length
= Vprint_length
;
946 XSETFASTINT (Vprint_level
, 10);
947 XSETFASTINT (Vprint_length
, 10);
948 cmd_error_internal (data
, macroerror
);
949 Vprint_level
= old_level
;
950 Vprint_length
= old_length
;
953 Vinhibit_quit
= Qnil
;
955 return make_number (0);
958 /* Take actions on handling an error. DATA is the data that describes
961 CONTEXT is a C-string containing ASCII characters only which
962 describes the context in which the error happened. If we need to
963 generalize CONTEXT to allow multibyte characters, make it a Lisp
967 cmd_error_internal (Lisp_Object data
, const char *context
)
969 /* The immediate context is not interesting for Quits,
970 since they are asynchronous. */
971 if (EQ (XCAR (data
), Qquit
))
972 Vsignaling_function
= Qnil
;
977 /* Use user's specified output function if any. */
978 if (!NILP (Vcommand_error_function
))
979 call3 (Vcommand_error_function
, data
,
980 context
? build_string (context
) : empty_unibyte_string
,
981 Vsignaling_function
);
983 Vsignaling_function
= Qnil
;
986 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
987 Scommand_error_default_function
, 3, 3, 0,
988 doc
: /* Produce default output for unhandled error message.
989 Default value of `command-error-function'. */)
990 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
992 struct frame
*sf
= SELECTED_FRAME ();
994 CHECK_STRING (context
);
996 /* If the window system or terminal frame hasn't been initialized
997 yet, or we're not interactive, write the message to stderr and exit. */
998 if (!sf
->glyphs_initialized_p
999 /* The initial frame is a special non-displaying frame. It
1000 will be current in daemon mode when there are no frames
1001 to display, and in non-daemon mode before the real frame
1002 has finished initializing. If an error is thrown in the
1003 latter case while creating the frame, then the frame
1004 will never be displayed, so the safest thing to do is
1005 write to stderr and quit. In daemon mode, there are
1006 many other potential errors that do not prevent frames
1007 from being created, so continuing as normal is better in
1009 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1012 print_error_message (data
, Qexternal_debugging_output
,
1013 SSDATA (context
), signal
);
1014 Fterpri (Qexternal_debugging_output
, Qnil
);
1015 Fkill_emacs (make_number (-1));
1019 clear_message (1, 0);
1021 message_log_maybe_newline ();
1024 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1029 static Lisp_Object
command_loop_2 (Lisp_Object
);
1030 static Lisp_Object
top_level_1 (Lisp_Object
);
1032 /* Entry to editor-command-loop.
1033 This level has the catches for exiting/returning to editor command loop.
1034 It returns nil to exit recursive edit, t to abort it. */
1039 #ifdef HAVE_STACK_OVERFLOW_HANDLING
1040 /* At least on GNU/Linux, saving signal mask is important here. */
1041 if (sigsetjmp (return_to_command_loop
, 1) != 0)
1043 /* Comes here from handle_sigsegv (see sysdep.c) and
1044 stack_overflow_handler (see w32fns.c). */
1046 w32_reset_stack_overflow_guard ();
1049 Vinternal__top_level_message
= recover_top_level_message
;
1052 Vinternal__top_level_message
= regular_top_level_message
;
1053 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
1054 if (command_loop_level
> 0 || minibuf_level
> 0)
1057 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1058 executing_kbd_macro
= Qnil
;
1064 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1065 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1066 executing_kbd_macro
= Qnil
;
1068 /* End of file in -batch run causes exit here. */
1074 /* Here we catch errors in execution of commands within the
1075 editing loop, and reenter the editing loop.
1076 When there is an error, cmd_error runs and returns a non-nil
1077 value to us. A value of nil means that command_loop_1 itself
1078 returned due to end of file (or end of kbd macro). */
1081 command_loop_2 (Lisp_Object ignore
)
1083 register Lisp_Object val
;
1086 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1087 while (!NILP (val
));
1095 return Feval (Vtop_level
, Qnil
);
1099 top_level_1 (Lisp_Object ignore
)
1101 /* On entry to the outer level, run the startup file. */
1102 if (!NILP (Vtop_level
))
1103 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1104 else if (!NILP (Vpurify_flag
))
1105 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1107 message1 ("Bare Emacs (standard Lisp code not loaded)");
1111 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1112 doc
: /* Exit all recursive editing levels.
1113 This also exits all active minibuffers. */
1114 attributes
: noreturn
)
1117 #ifdef HAVE_WINDOW_SYSTEM
1118 if (display_hourglass_p
)
1119 cancel_hourglass ();
1122 /* Unblock input if we enter with input blocked. This may happen if
1123 redisplay traps e.g. during tool-bar update with input blocked. */
1124 totally_unblock_input ();
1126 Fthrow (Qtop_level
, Qnil
);
1129 static _Noreturn
void
1130 user_error (const char *msg
)
1132 xsignal1 (Quser_error
, build_string (msg
));
1135 /* _Noreturn will be added to prototype by make-docfile. */
1136 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1137 doc
: /* Exit from the innermost recursive edit or minibuffer. */
1138 attributes
: noreturn
)
1141 if (command_loop_level
> 0 || minibuf_level
> 0)
1142 Fthrow (Qexit
, Qnil
);
1144 user_error ("No recursive edit is in progress");
1147 /* _Noreturn will be added to prototype by make-docfile. */
1148 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1149 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */
1150 attributes
: noreturn
)
1153 if (command_loop_level
> 0 || minibuf_level
> 0)
1156 user_error ("No recursive edit is in progress");
1159 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1160 of this function. */
1163 tracking_off (Lisp_Object old_value
)
1165 do_mouse_tracking
= old_value
;
1166 if (NILP (old_value
))
1168 /* Redisplay may have been preempted because there was input
1169 available, and it assumes it will be called again after the
1170 input has been processed. If the only input available was
1171 the sort that we have just disabled, then we need to call
1173 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1175 redisplay_preserve_echo_area (6);
1176 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1181 DEFUN ("internal--track-mouse", Ftrack_mouse
, Strack_mouse
, 1, 1, 0,
1182 doc
: /* Call BODYFUN with mouse movement events enabled. */)
1183 (Lisp_Object bodyfun
)
1185 ptrdiff_t count
= SPECPDL_INDEX ();
1188 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1190 do_mouse_tracking
= Qt
;
1192 val
= call0 (bodyfun
);
1193 return unbind_to (count
, val
);
1196 /* If mouse has moved on some frame, return one of those frames.
1200 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1201 after resizing the tool-bar window. */
1203 bool ignore_mouse_drag_p
;
1205 static struct frame
*
1206 some_mouse_moved (void)
1208 Lisp_Object tail
, frame
;
1210 if (ignore_mouse_drag_p
)
1212 /* ignore_mouse_drag_p = 0; */
1216 FOR_EACH_FRAME (tail
, frame
)
1218 if (XFRAME (frame
)->mouse_moved
)
1219 return XFRAME (frame
);
1226 /* This is the actual command reading loop,
1227 sans error-handling encapsulation. */
1229 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1230 bool, bool, bool, bool);
1231 static void adjust_point_for_property (ptrdiff_t, bool);
1234 command_loop_1 (void)
1237 Lisp_Object keybuf
[30];
1239 EMACS_INT prev_modiff
= 0;
1240 struct buffer
*prev_buffer
= NULL
;
1241 bool already_adjusted
= 0;
1243 kset_prefix_arg (current_kboard
, Qnil
);
1244 kset_last_prefix_arg (current_kboard
, Qnil
);
1245 Vdeactivate_mark
= Qnil
;
1246 waiting_for_input
= false;
1249 this_command_key_count
= 0;
1250 this_single_command_key_start
= 0;
1252 if (NILP (Vmemory_full
))
1254 /* Make sure this hook runs after commands that get errors and
1255 throw to top level. */
1256 /* Note that the value cell will never directly contain nil
1257 if the symbol is a local variable. */
1258 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1259 safe_run_hooks (Qpost_command_hook
);
1261 /* If displaying a message, resize the echo area window to fit
1262 that message's size exactly. */
1263 if (!NILP (echo_area_buffer
[0]))
1264 resize_echo_area_exactly ();
1266 /* If there are warnings waiting, process them. */
1267 if (!NILP (Vdelayed_warnings_list
))
1268 safe_run_hooks (Qdelayed_warnings_hook
);
1270 if (!NILP (Vdeferred_action_list
))
1271 safe_run_hooks (Qdeferred_action_function
);
1274 /* Do this after running Vpost_command_hook, for consistency. */
1275 kset_last_command (current_kboard
, Vthis_command
);
1276 kset_real_last_command (current_kboard
, Vreal_this_command
);
1277 if (!CONSP (last_command_event
))
1278 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1282 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1285 /* Make sure the current window's buffer is selected. */
1286 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1288 /* Display any malloc warning that just came out. Use while because
1289 displaying one warning can cause another. */
1291 while (pending_malloc_warning
)
1292 display_malloc_warning ();
1294 Vdeactivate_mark
= Qnil
;
1296 /* Don't ignore mouse movements for more than a single command
1297 loop. (This flag is set in xdisp.c whenever the tool bar is
1298 resized, because the resize moves text up or down, and would
1299 generate false mouse drag events if we don't ignore them.) */
1300 ignore_mouse_drag_p
= 0;
1302 /* If minibuffer on and echo area in use,
1303 wait a short time and redraw minibuffer. */
1306 && !NILP (echo_area_buffer
[0])
1307 && EQ (minibuf_window
, echo_area_window
)
1308 && NUMBERP (Vminibuffer_message_timeout
))
1310 /* Bind inhibit-quit to t so that C-g gets read in
1311 rather than quitting back to the minibuffer. */
1312 ptrdiff_t count
= SPECPDL_INDEX ();
1313 specbind (Qinhibit_quit
, Qt
);
1315 sit_for (Vminibuffer_message_timeout
, 0, 2);
1317 /* Clear the echo area. */
1319 safe_run_hooks (Qecho_area_clear_hook
);
1321 unbind_to (count
, Qnil
);
1323 /* If a C-g came in before, treat it as input now. */
1324 if (!NILP (Vquit_flag
))
1327 Vunread_command_events
= list1 (make_number (quit_char
));
1331 /* If it has changed current-menubar from previous value,
1332 really recompute the menubar from the value. */
1333 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1334 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1335 call0 (Qrecompute_lucid_menubar
);
1337 Vthis_command
= Qnil
;
1338 Vreal_this_command
= Qnil
;
1339 Vthis_original_command
= Qnil
;
1340 Vthis_command_keys_shift_translated
= Qnil
;
1342 /* Read next key sequence; i gets its length. */
1343 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1346 /* A filter may have run while we were reading the input. */
1347 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1349 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1353 /* Now we have read a key sequence of length I,
1354 or else I is 0 and we found end of file. */
1356 if (i
== 0) /* End of file -- happens only in */
1357 return Qnil
; /* a kbd macro, at the end. */
1358 /* -1 means read_key_sequence got a menu that was rejected.
1359 Just loop around and read another command. */
1363 this_command_key_count
= 0;
1364 this_single_command_key_start
= 0;
1368 last_command_event
= keybuf
[i
- 1];
1370 /* If the previous command tried to force a specific window-start,
1371 forget about that, in case this command moves point far away
1372 from that position. But also throw away beg_unchanged and
1373 end_unchanged information in that case, so that redisplay will
1374 update the whole window properly. */
1375 if (XWINDOW (selected_window
)->force_start
)
1378 XWINDOW (selected_window
)->force_start
= 0;
1379 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1380 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1383 cmd
= read_key_sequence_cmd
;
1384 if (!NILP (Vexecuting_kbd_macro
))
1386 if (!NILP (Vquit_flag
))
1388 Vexecuting_kbd_macro
= Qt
;
1389 QUIT
; /* Make some noise. */
1390 /* Will return since macro now empty. */
1394 /* Do redisplay processing after this command except in special
1395 cases identified below. */
1396 prev_buffer
= current_buffer
;
1397 prev_modiff
= MODIFF
;
1398 last_point_position
= PT
;
1400 /* By default, we adjust point to a boundary of a region that
1401 has such a property that should be treated intangible
1402 (e.g. composition, display). But, some commands will set
1403 this variable differently. */
1404 Vdisable_point_adjustment
= Qnil
;
1406 /* Process filters and timers may have messed with deactivate-mark.
1407 reset it before we execute the command. */
1408 Vdeactivate_mark
= Qnil
;
1410 /* Remap command through active keymaps. */
1411 Vthis_original_command
= cmd
;
1412 if (!NILP (read_key_sequence_remapped
))
1413 cmd
= read_key_sequence_remapped
;
1415 /* Execute the command. */
1418 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
1419 ASET (recent_keys
, recent_keys_index
,
1421 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1422 recent_keys_index
= 0;
1424 Vthis_command
= cmd
;
1425 Vreal_this_command
= cmd
;
1426 safe_run_hooks (Qpre_command_hook
);
1428 already_adjusted
= 0;
1430 if (NILP (Vthis_command
))
1431 /* nil means key is undefined. */
1435 /* Here for a command that isn't executed directly. */
1437 #ifdef HAVE_WINDOW_SYSTEM
1438 ptrdiff_t scount
= SPECPDL_INDEX ();
1440 if (display_hourglass_p
1441 && NILP (Vexecuting_kbd_macro
))
1443 record_unwind_protect_void (cancel_hourglass
);
1448 /* Ensure that we have added appropriate undo-boundaries as a
1449 result of changes from the last command. */
1450 call0 (Qundo_auto__add_boundary
);
1452 /* Record point and buffer, so we can put point into the undo
1453 information if necessary. */
1454 point_before_last_command_or_undo
= PT
;
1455 buffer_before_last_command_or_undo
= current_buffer
;
1457 call1 (Qcommand_execute
, Vthis_command
);
1459 #ifdef HAVE_WINDOW_SYSTEM
1460 /* Do not check display_hourglass_p here, because
1461 `command-execute' could change it, but we should cancel
1462 hourglass cursor anyway.
1463 But don't cancel the hourglass within a macro
1464 just because a command in the macro finishes. */
1465 if (NILP (Vexecuting_kbd_macro
))
1466 unbind_to (scount
, Qnil
);
1469 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1471 safe_run_hooks (Qpost_command_hook
);
1473 /* If displaying a message, resize the echo area window to fit
1474 that message's size exactly. */
1475 if (!NILP (echo_area_buffer
[0]))
1476 resize_echo_area_exactly ();
1478 /* If there are warnings waiting, process them. */
1479 if (!NILP (Vdelayed_warnings_list
))
1480 safe_run_hooks (Qdelayed_warnings_hook
);
1482 safe_run_hooks (Qdeferred_action_function
);
1484 kset_last_command (current_kboard
, Vthis_command
);
1485 kset_real_last_command (current_kboard
, Vreal_this_command
);
1486 if (!CONSP (last_command_event
))
1487 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1489 /* Don't reset this_command_key_count if we've processed
1491 if (NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
1493 this_command_key_count
= 0;
1494 this_single_command_key_start
= 0;
1496 else if (current_kboard
->immediate_echo
)
1498 current_kboard
->immediate_echo
= false;
1499 /* Refresh the echo message. */
1505 if (!NILP (BVAR (current_buffer
, mark_active
))
1506 && !NILP (Vrun_hooks
))
1508 /* In Emacs 22, setting transient-mark-mode to `only' was a
1509 way of turning it on for just one command. This usage is
1510 obsolete, but support it anyway. */
1511 if (EQ (Vtransient_mark_mode
, Qidentity
))
1512 Vtransient_mark_mode
= Qnil
;
1513 else if (EQ (Vtransient_mark_mode
, Qonly
))
1514 Vtransient_mark_mode
= Qidentity
;
1516 if (!NILP (Vdeactivate_mark
))
1517 /* If `select-active-regions' is non-nil, this call to
1518 `deactivate-mark' also sets the PRIMARY selection. */
1519 call0 (Qdeactivate_mark
);
1522 /* Even if not deactivating the mark, set PRIMARY if
1523 `select-active-regions' is non-nil. */
1524 if (!NILP (Fwindow_system (Qnil
))
1525 /* Even if mark_active is non-nil, the actual buffer
1526 marker may not have been set yet (Bug#7044). */
1527 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1528 && (EQ (Vselect_active_regions
, Qonly
)
1529 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1530 : (!NILP (Vselect_active_regions
)
1531 && !NILP (Vtransient_mark_mode
)))
1532 && NILP (Fmemq (Vthis_command
,
1533 Vselection_inhibit_update_commands
)))
1536 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1537 if (XINT (Flength (txt
)) > 0)
1538 /* Don't set empty selections. */
1539 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1542 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1543 run_hook (intern ("activate-mark-hook"));
1546 Vsaved_region_selection
= Qnil
;
1551 if (current_buffer
== prev_buffer
1552 && XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
1553 && last_point_position
!= PT
1554 && NILP (Vdisable_point_adjustment
)
1555 && NILP (Vglobal_disable_point_adjustment
))
1557 if (last_point_position
> BEGV
1558 && last_point_position
< ZV
1559 && (composition_adjust_point (last_point_position
,
1560 last_point_position
)
1561 != last_point_position
))
1562 /* The last point was temporarily set within a grapheme
1563 cluster to prevent automatic composition. To recover
1564 the automatic composition, we must update the
1566 windows_or_buffers_changed
= 21;
1567 if (!already_adjusted
)
1568 adjust_point_for_property (last_point_position
,
1569 MODIFF
!= prev_modiff
);
1572 /* Install chars successfully executed in kbd macro. */
1574 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1575 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1576 finalize_kbd_macro_chars ();
1581 read_menu_command (void)
1583 Lisp_Object keybuf
[30];
1584 ptrdiff_t count
= SPECPDL_INDEX ();
1587 /* We don't want to echo the keystrokes while navigating the
1589 specbind (Qecho_keystrokes
, make_number (0));
1591 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1594 unbind_to (count
, Qnil
);
1596 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1598 if (i
== 0 || i
== -1)
1601 return read_key_sequence_cmd
;
1604 /* Adjust point to a boundary of a region that has such a property
1605 that should be treated intangible. For the moment, we check
1606 `composition', `display' and `invisible' properties.
1607 LAST_PT is the last position of point. */
1610 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1613 Lisp_Object val
, overlay
, tmp
;
1614 /* When called after buffer modification, we should temporarily
1615 suppress the point adjustment for automatic composition so that a
1616 user can keep inserting another character at point or keep
1617 deleting characters around point. */
1618 bool check_composition
= ! modified
;
1619 bool check_display
= true, check_invisible
= true;
1620 ptrdiff_t orig_pt
= PT
;
1622 eassert (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
);
1624 /* FIXME: cycling is probably not necessary because these properties
1625 can't be usefully combined anyway. */
1626 while (check_composition
|| check_display
|| check_invisible
)
1628 /* FIXME: check `intangible'. */
1629 if (check_composition
1630 && PT
> BEGV
&& PT
< ZV
1631 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1634 check_display
= check_invisible
= true;
1636 check_composition
= false;
1638 && PT
> BEGV
&& PT
< ZV
1639 && !NILP (val
= get_char_property_and_overlay
1640 (make_number (PT
), Qdisplay
, selected_window
,
1642 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1643 && (!OVERLAYP (overlay
)
1644 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1645 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1646 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1647 && (beg
< PT
/* && end > PT <- It's always the case. */
1648 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1651 SET_PT (PT
< last_pt
1652 ? (STRINGP (val
) && SCHARS (val
) == 0
1653 ? max (beg
- 1, BEGV
)
1656 check_composition
= check_invisible
= true;
1658 check_display
= false;
1659 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1662 bool ellipsis
= false;
1665 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1668 /* FIXME: We should stop if we find a spot between
1669 two runs of `invisible' where inserted text would
1670 be visible. This is important when we have two
1671 invisible boundaries that enclose an area: if the
1672 area is empty, we need this test in order to make
1673 it possible to place point in the middle rather
1674 than skip both boundaries. However, this code
1675 also stops anywhere in a non-sticky text-property,
1676 which breaks (e.g.) Org mode. */
1677 && (val
= Fget_pos_property (make_number (end
),
1679 TEXT_PROP_MEANS_INVISIBLE (val
))
1681 && !NILP (val
= get_char_property_and_overlay
1682 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1683 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1685 ellipsis
= ellipsis
|| inv
> 1
1686 || (OVERLAYP (overlay
)
1687 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1688 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1689 tmp
= Fnext_single_char_property_change
1690 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1691 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1695 && (val
= Fget_pos_property (make_number (beg
),
1697 TEXT_PROP_MEANS_INVISIBLE (val
))
1699 && !NILP (val
= get_char_property_and_overlay
1700 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1701 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1703 ellipsis
= ellipsis
|| inv
> 1
1704 || (OVERLAYP (overlay
)
1705 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1706 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1707 tmp
= Fprevious_single_char_property_change
1708 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1709 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1712 /* Move away from the inside area. */
1713 if (beg
< PT
&& end
> PT
)
1715 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1716 /* We haven't moved yet (so we don't need to fear
1717 infinite-looping) and we were outside the range
1718 before (so either end of the range still corresponds
1719 to a move in the right direction): pretend we moved
1720 less than we actually did, so that we still have
1721 more freedom below in choosing which end of the range
1723 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1724 /* We either have moved already or the last point
1725 was already in the range: we don't get to choose
1726 which end of the range we have to go to. */
1727 : (PT
< last_pt
? beg
: end
));
1728 check_composition
= check_display
= true;
1730 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1731 the point to something other than its argument, due to
1732 point-motion hooks, intangibility, etc. */
1733 eassert (PT
== beg
|| PT
== end
);
1736 /* Pretend the area doesn't exist if the buffer is not
1738 if (!modified
&& !ellipsis
&& beg
< end
)
1740 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1741 (check_composition
= check_display
= true, SET_PT (end
+ 1));
1742 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1743 (check_composition
= check_display
= true, SET_PT (beg
- 1));
1744 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1745 /* We've already moved as far as we can. Trying to go
1746 to the other end would mean moving backwards and thus
1747 could lead to an infinite loop. */
1749 else if (val
= Fget_pos_property (make_number (PT
),
1751 TEXT_PROP_MEANS_INVISIBLE (val
)
1752 && (val
= (Fget_pos_property
1753 (make_number (PT
== beg
? end
: beg
),
1755 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1756 (check_composition
= check_display
= true,
1757 SET_PT (PT
== beg
? end
: beg
));
1760 check_invisible
= false;
1764 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1767 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1769 eassert (nargs
== 2);
1770 return call0 (args
[1]);
1773 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1777 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1779 eassert (nargs
== 2);
1780 AUTO_STRING (format
, "Error in %s (%S): %S");
1781 Lisp_Object hook
= args
[0];
1782 Lisp_Object fun
= args
[1];
1783 CALLN (Fmessage
, format
, hook
, fun
, error
);
1789 Lisp_Object newval
= Qnil
;
1790 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1791 if (EQ (fun
, XCAR (val
)))
1794 newval
= Fcons (XCAR (val
), newval
);
1796 return Fset (hook
, Fnreverse (newval
));
1797 /* Not found in the local part of the hook. Let's look at the global
1800 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1801 : Fdefault_value (hook
));
1802 CONSP (val
); val
= XCDR (val
))
1803 if (EQ (fun
, XCAR (val
)))
1806 newval
= Fcons (XCAR (val
), newval
);
1808 return Fset_default (hook
, Fnreverse (newval
));
1814 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1816 eassert (nargs
== 2);
1817 /* Yes, run_hook_with_args works with args in the other order. */
1818 internal_condition_case_n (safe_run_hooks_1
,
1819 2, ((Lisp_Object
[]) {args
[1], args
[0]}),
1820 Qt
, safe_run_hooks_error
);
1824 /* If we get an error while running the hook, cause the hook variable
1825 to be nil. Also inhibit quits, so that C-g won't cause the hook
1826 to mysteriously evaporate. */
1829 safe_run_hooks (Lisp_Object hook
)
1831 ptrdiff_t count
= SPECPDL_INDEX ();
1833 specbind (Qinhibit_quit
, Qt
);
1834 run_hook_with_args (2, ((Lisp_Object
[]) {hook
, hook
}), safe_run_hook_funcall
);
1835 unbind_to (count
, Qnil
);
1839 /* Nonzero means polling for input is temporarily suppressed. */
1841 int poll_suppress_count
;
1844 #ifdef POLL_FOR_INPUT
1846 /* Asynchronous timer for polling. */
1848 static struct atimer
*poll_timer
;
1850 /* Poll for input, so that we catch a C-g if it comes in. */
1852 poll_for_input_1 (void)
1854 if (! input_blocked_p ()
1855 && !waiting_for_input
)
1859 /* Timer callback function for poll_timer. TIMER is equal to
1863 poll_for_input (struct atimer
*timer
)
1865 if (poll_suppress_count
== 0)
1866 pending_signals
= true;
1869 #endif /* POLL_FOR_INPUT */
1871 /* Begin signals to poll for input, if they are appropriate.
1872 This function is called unconditionally from various places. */
1875 start_polling (void)
1877 #ifdef POLL_FOR_INPUT
1878 /* XXX This condition was (read_socket_hook && !interrupt_input),
1879 but read_socket_hook is not global anymore. Let's pretend that
1881 if (!interrupt_input
)
1883 /* Turn alarm handling on unconditionally. It might have
1884 been turned off in process.c. */
1885 turn_on_atimers (1);
1887 /* If poll timer doesn't exist, or we need one with
1888 a different interval, start a new one. */
1889 if (poll_timer
== NULL
1890 || poll_timer
->interval
.tv_sec
!= polling_period
)
1892 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1893 struct timespec interval
= make_timespec (period
, 0);
1896 cancel_atimer (poll_timer
);
1898 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1899 poll_for_input
, NULL
);
1902 /* Let the timer's callback function poll for input
1903 if this becomes zero. */
1904 --poll_suppress_count
;
1909 /* True if we are using polling to handle input asynchronously. */
1912 input_polling_used (void)
1914 #ifdef POLL_FOR_INPUT
1915 /* XXX This condition was (read_socket_hook && !interrupt_input),
1916 but read_socket_hook is not global anymore. Let's pretend that
1918 return !interrupt_input
;
1924 /* Turn off polling. */
1929 #ifdef POLL_FOR_INPUT
1930 /* XXX This condition was (read_socket_hook && !interrupt_input),
1931 but read_socket_hook is not global anymore. Let's pretend that
1933 if (!interrupt_input
)
1934 ++poll_suppress_count
;
1938 /* Set the value of poll_suppress_count to COUNT
1939 and start or stop polling accordingly. */
1942 set_poll_suppress_count (int count
)
1944 #ifdef POLL_FOR_INPUT
1945 if (count
== 0 && poll_suppress_count
!= 0)
1947 poll_suppress_count
= 1;
1950 else if (count
!= 0 && poll_suppress_count
== 0)
1954 poll_suppress_count
= count
;
1958 /* Bind polling_period to a value at least N.
1959 But don't decrease it. */
1962 bind_polling_period (int n
)
1964 #ifdef POLL_FOR_INPUT
1965 EMACS_INT
new = polling_period
;
1970 stop_other_atimers (poll_timer
);
1972 specbind (Qpolling_period
, make_number (new));
1973 /* Start a new alarm with the new period. */
1978 /* Apply the control modifier to CHARACTER. */
1981 make_ctrl_char (int c
)
1983 /* Save the upper bits here. */
1984 int upper
= c
& ~0177;
1986 if (! ASCII_CHAR_P (c
))
1987 return c
|= ctrl_modifier
;
1991 /* Everything in the columns containing the upper-case letters
1992 denotes a control character. */
1993 if (c
>= 0100 && c
< 0140)
1997 /* Set the shift modifier for a control char
1998 made from a shifted letter. But only for letters! */
1999 if (oc
>= 'A' && oc
<= 'Z')
2000 c
|= shift_modifier
;
2003 /* The lower-case letters denote control characters too. */
2004 else if (c
>= 'a' && c
<= 'z')
2007 /* Include the bits for control and shift
2008 only if the basic ASCII code can't indicate them. */
2012 /* Replace the high bits. */
2013 c
|= (upper
& ~ctrl_modifier
);
2018 /* Display the help-echo property of the character after the mouse pointer.
2019 Either show it in the echo area, or call show-help-function to display
2020 it by other means (maybe in a tooltip).
2022 If HELP is nil, that means clear the previous help echo.
2024 If HELP is a string, display that string. If HELP is a function,
2025 call it with OBJECT and POS as arguments; the function should
2026 return a help string or nil for none. For all other types of HELP,
2027 evaluate it to obtain a string.
2029 WINDOW is the window in which the help was generated, if any.
2030 It is nil if not in a window.
2032 If OBJECT is a buffer, POS is the position in the buffer where the
2033 `help-echo' text property was found.
2035 If OBJECT is an overlay, that overlay has a `help-echo' property,
2036 and POS is the position in the overlay's buffer under the mouse.
2038 If OBJECT is a string (an overlay string or a string displayed with
2039 the `display' property). POS is the position in that string under
2042 Note: this function may only be called with HELP nil or a string
2043 from X code running asynchronously. */
2046 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2049 if (!NILP (help
) && !STRINGP (help
))
2051 if (FUNCTIONP (help
))
2052 help
= safe_call (4, help
, window
, object
, pos
);
2054 help
= safe_eval (help
);
2056 if (!STRINGP (help
))
2060 if (!noninteractive
&& STRINGP (help
))
2062 /* The mouse-fixup-help-message Lisp function can call
2063 mouse_position_hook, which resets the mouse_moved flags.
2064 This causes trouble if we are trying to read a mouse motion
2065 event (i.e., if we are inside a `track-mouse' form), so we
2066 restore the mouse_moved flag. */
2067 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2068 help
= call1 (Qmouse_fixup_help_message
, help
);
2070 f
->mouse_moved
= true;
2073 if (STRINGP (help
) || NILP (help
))
2075 if (!NILP (Vshow_help_function
))
2076 call1 (Vshow_help_function
, Fsubstitute_command_keys (help
));
2077 help_echo_showing_p
= STRINGP (help
);
2083 /* Input of single characters from keyboard. */
2085 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2086 struct timespec
*end_time
);
2087 static void record_char (Lisp_Object c
);
2089 static Lisp_Object help_form_saved_window_configs
;
2091 read_char_help_form_unwind (void)
2093 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2094 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2095 if (!NILP (window_config
))
2096 Fset_window_configuration (window_config
);
2099 #define STOP_POLLING \
2100 do { if (! polling_stopped_here) stop_polling (); \
2101 polling_stopped_here = true; } while (0)
2103 #define RESUME_POLLING \
2104 do { if (polling_stopped_here) start_polling (); \
2105 polling_stopped_here = false; } while (0)
2108 read_event_from_main_queue (struct timespec
*end_time
,
2109 sys_jmp_buf local_getcjmp
,
2110 bool *used_mouse_menu
)
2112 Lisp_Object c
= Qnil
;
2113 sys_jmp_buf save_jump
;
2114 KBOARD
*kb
IF_LINT (= NULL
);
2118 /* Read from the main queue, and if that gives us something we can't use yet,
2119 we put it on the appropriate side queue and try again. */
2121 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2124 /* Actually read a character, waiting if necessary. */
2125 save_getcjmp (save_jump
);
2126 restore_getcjmp (local_getcjmp
);
2128 timer_start_idle ();
2129 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2130 restore_getcjmp (save_jump
);
2132 if (! NILP (c
) && (kb
!= current_kboard
))
2134 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2137 while (CONSP (XCDR (last
)))
2139 if (!NILP (XCDR (last
)))
2143 kset_kbd_queue (kb
, list1 (c
));
2145 XSETCDR (last
, list1 (c
));
2146 kb
->kbd_queue_has_data
= true;
2150 current_kboard
= kb
;
2151 return make_number (-2);
2154 /* Terminate Emacs in batch mode if at eof. */
2155 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2156 Fkill_emacs (make_number (1));
2160 /* Add in any extra modifiers, where appropriate. */
2161 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2162 || ((extra_keyboard_modifiers
& 0177) < ' '
2163 && (extra_keyboard_modifiers
& 0177) != 0))
2164 XSETINT (c
, make_ctrl_char (XINT (c
)));
2166 /* Transfer any other modifier bits directly from
2167 extra_keyboard_modifiers to c. Ignore the actual character code
2168 in the low 16 bits of extra_keyboard_modifiers. */
2169 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2177 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2180 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2181 sys_jmp_buf local_getcjmp
,
2182 Lisp_Object prev_event
,
2183 bool *used_mouse_menu
)
2185 #define MAX_ENCODED_BYTES 16
2187 Lisp_Object events
[MAX_ENCODED_BYTES
];
2193 = read_event_from_main_queue (end_time
, local_getcjmp
,
2196 /* w32_console already returns decoded events. It either reads
2197 Unicode characters from the Windows keyboard input, or
2198 converts characters encoded in the current codepage into
2199 Unicode. See w32inevt.c:key_event, near its end. */
2202 struct frame
*frame
= XFRAME (selected_frame
);
2203 struct terminal
*terminal
= frame
->terminal
;
2204 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2205 /* Don't apply decoding if we're just reading a raw event
2206 (e.g. reading bytes sent by the xterm to specify the position
2207 of a mouse click). */
2208 && (!EQ (prev_event
, Qt
))
2209 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2210 & CODING_REQUIRE_DECODING_MASK
)))
2211 return nextevt
; /* No decoding needed. */
2214 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2215 eassert (n
< MAX_ENCODED_BYTES
);
2216 events
[n
++] = nextevt
;
2217 if (NATNUMP (nextevt
)
2218 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2219 { /* An encoded byte sequence, let's try to decode it. */
2220 struct coding_system
*coding
2221 = TERMINAL_KEYBOARD_CODING (terminal
);
2223 if (raw_text_coding_system_p (coding
))
2227 for (i
= 0; i
< n
; i
++)
2228 events
[i
] = make_number (XINT (events
[i
]) & ~0x80);
2232 unsigned char src
[MAX_ENCODED_BYTES
];
2233 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2235 for (i
= 0; i
< n
; i
++)
2236 src
[i
] = XINT (events
[i
]);
2238 for (i
= 0; i
< n
; i
++)
2240 coding
->destination
= dest
;
2241 coding
->dst_bytes
= sizeof dest
;
2242 decode_coding_c_string (coding
, src
, n
, Qnil
);
2243 eassert (coding
->produced_char
<= n
);
2244 if (coding
->produced_char
== 0)
2245 { /* The encoded sequence is incomplete. */
2246 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2247 continue; /* Read on! */
2251 const unsigned char *p
= coding
->destination
;
2252 eassert (coding
->carryover_bytes
== 0);
2254 while (n
< coding
->produced_char
)
2255 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2259 /* Now `events' should hold decoded events.
2260 Normally, n should be equal to 1, but better not rely on it.
2261 We can only return one event here, so return the first we
2262 had and keep the others (if any) for later. */
2264 Vunread_command_events
2265 = Fcons (events
[--n
], Vunread_command_events
);
2273 echo_keystrokes_p (void)
2275 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2276 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2279 /* Read a character from the keyboard; call the redisplay if needed. */
2280 /* commandflag 0 means do not autosave, but do redisplay.
2281 -1 means do not redisplay, but do autosave.
2282 -2 means do neither.
2285 The argument MAP is a keymap for menu prompting.
2287 PREV_EVENT is the previous input event, or nil if we are reading
2288 the first event of a key sequence (or not reading a key sequence).
2289 If PREV_EVENT is t, that is a "magic" value that says
2290 not to run input methods, but in other respects to act as if
2291 not reading a key sequence.
2293 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2294 if we used a mouse menu to read the input, or false otherwise. If
2295 USED_MOUSE_MENU is null, don't dereference it.
2297 Value is -2 when we find input on another keyboard. A second call
2298 to read_char will read it.
2300 If END_TIME is non-null, it is a pointer to a struct timespec
2301 specifying the maximum time to wait until. If no input arrives by
2302 that time, stop waiting and return nil.
2304 Value is t if we showed a menu and the user rejected it. */
2307 read_char (int commandflag
, Lisp_Object map
,
2308 Lisp_Object prev_event
,
2309 bool *used_mouse_menu
, struct timespec
*end_time
)
2313 sys_jmp_buf local_getcjmp
;
2314 sys_jmp_buf save_jump
;
2315 Lisp_Object tem
, save
;
2316 volatile Lisp_Object previous_echo_area_message
;
2317 volatile Lisp_Object also_record
;
2318 volatile bool reread
, recorded
;
2319 bool volatile polling_stopped_here
= false;
2320 struct kboard
*orig_kboard
= current_kboard
;
2325 previous_echo_area_message
= Qnil
;
2331 if (CONSP (Vunread_post_input_method_events
))
2333 c
= XCAR (Vunread_post_input_method_events
);
2334 Vunread_post_input_method_events
2335 = XCDR (Vunread_post_input_method_events
);
2337 /* Undo what read_char_x_menu_prompt did when it unread
2338 additional keys returned by Fx_popup_menu. */
2340 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2351 if (CONSP (Vunread_command_events
))
2353 bool was_disabled
= false;
2355 c
= XCAR (Vunread_command_events
);
2356 Vunread_command_events
= XCDR (Vunread_command_events
);
2358 /* Undo what sit-for did when it unread additional keys
2359 inside universal-argument. */
2361 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2366 /* Undo what read_char_x_menu_prompt did when it unread
2367 additional keys returned by Fx_popup_menu. */
2369 && EQ (XCDR (c
), Qdisabled
)
2370 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2372 was_disabled
= true;
2376 /* If the queued event is something that used the mouse,
2377 set used_mouse_menu accordingly. */
2379 /* Also check was_disabled so last-nonmenu-event won't return
2380 a bad value when submenus are involved. (Bug#447) */
2381 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2382 *used_mouse_menu
= true;
2384 goto reread_for_input_method
;
2387 if (CONSP (Vunread_input_method_events
))
2389 c
= XCAR (Vunread_input_method_events
);
2390 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2392 /* Undo what read_char_x_menu_prompt did when it unread
2393 additional keys returned by Fx_popup_menu. */
2395 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2399 goto reread_for_input_method
;
2402 if (!NILP (Vexecuting_kbd_macro
))
2404 /* We set this to Qmacro; since that's not a frame, nobody will
2405 try to switch frames on us, and the selected window will
2408 Since this event came from a macro, it would be misleading to
2409 leave internal_last_event_frame set to wherever the last
2410 real event came from. Normally, a switch-frame event selects
2411 internal_last_event_frame after each command is read, but
2412 events read from a macro should never cause a new frame to be
2414 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2416 /* Exit the macro if we are at the end.
2417 Also, some things replace the macro with t
2418 to force an early exit. */
2419 if (EQ (Vexecuting_kbd_macro
, Qt
)
2420 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2426 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2427 if (STRINGP (Vexecuting_kbd_macro
)
2428 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2429 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2431 executing_kbd_macro_index
++;
2436 if (!NILP (unread_switch_frame
))
2438 c
= unread_switch_frame
;
2439 unread_switch_frame
= Qnil
;
2441 /* This event should make it into this_command_keys, and get echoed
2442 again, so we do not set `reread'. */
2446 /* If redisplay was requested. */
2447 if (commandflag
>= 0)
2449 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2451 /* If there is pending input, process any events which are not
2452 user-visible, such as X selection_request events. */
2454 || detect_input_pending_run_timers (0))
2455 swallow_events (false); /* May clear input_pending. */
2457 /* Redisplay if no pending input. */
2458 while (!(input_pending
2459 && (input_was_pending
|| !redisplay_dont_pause
)))
2461 input_was_pending
= input_pending
;
2462 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2463 redisplay_preserve_echo_area (5);
2468 /* Normal case: no input arrived during redisplay. */
2471 /* Input arrived and pre-empted redisplay.
2472 Process any events which are not user-visible. */
2473 swallow_events (false);
2474 /* If that cleared input_pending, try again to redisplay. */
2477 /* Prevent the redisplay we just did
2478 from messing up echoing of the input after the prompt. */
2479 if (commandflag
== 0 && echo_current
)
2480 echo_message_buffer
= echo_area_buffer
[0];
2484 /* Message turns off echoing unless more keystrokes turn it on again.
2486 The code in 20.x for the condition was
2488 1. echo_area_glyphs && *echo_area_glyphs
2489 2. && echo_area_glyphs != current_kboard->echobuf
2490 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2492 (1) means there's a current message displayed
2494 (2) means it's not the message from echoing from the current
2497 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2498 is set to a non-null value. This is done in read_char and it is
2499 set to echo_area_glyphs. That means
2500 ok_to_echo_at_next_pause is either null or
2501 current_kboard->echobuf with the appropriate current_kboard at
2504 So, condition (3) means in clear text ok_to_echo_at_next_pause
2505 must be either null, or the current message isn't from echoing at
2506 all, or it's from echoing from a different kboard than the
2509 if (/* There currently is something in the echo area. */
2510 !NILP (echo_area_buffer
[0])
2511 && (/* It's an echo from a different kboard. */
2512 echo_kboard
!= current_kboard
2513 /* Or we explicitly allow overwriting whatever there is. */
2514 || ok_to_echo_at_next_pause
== NULL
))
2519 /* Try reading a character via menu prompting in the minibuf.
2520 Try this before the sit-for, because the sit-for
2521 would do the wrong thing if we are supposed to do
2522 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2523 after a mouse event so don't try a minibuf menu. */
2525 if (KEYMAPP (map
) && INTERACTIVE
2526 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2527 /* Don't bring up a menu if we already have another event. */
2528 && NILP (Vunread_command_events
)
2529 && !detect_input_pending_run_timers (0))
2531 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2533 if (INTEGERP (c
) && XINT (c
) == -2)
2534 return c
; /* wrong_kboard_jmpbuf */
2540 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2541 We will do that below, temporarily for short sections of code,
2542 when appropriate. local_getcjmp must be in effect
2543 around any call to sit_for or kbd_buffer_get_event;
2544 it *must not* be in effect when we call redisplay. */
2546 jmpcount
= SPECPDL_INDEX ();
2547 if (sys_setjmp (local_getcjmp
))
2549 /* Handle quits while reading the keyboard. */
2550 /* We must have saved the outer value of getcjmp here,
2551 so restore it now. */
2552 restore_getcjmp (save_jump
);
2553 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2554 unbind_to (jmpcount
, Qnil
);
2555 XSETINT (c
, quit_char
);
2556 internal_last_event_frame
= selected_frame
;
2557 Vlast_event_frame
= internal_last_event_frame
;
2558 /* If we report the quit char as an event,
2559 don't do so more than once. */
2560 if (!NILP (Vinhibit_quit
))
2564 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2565 if (kb
!= current_kboard
)
2567 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2568 /* We shouldn't get here if we were in single-kboard mode! */
2573 while (CONSP (XCDR (last
)))
2575 if (!NILP (XCDR (last
)))
2579 kset_kbd_queue (kb
, list1 (c
));
2581 XSETCDR (last
, list1 (c
));
2582 kb
->kbd_queue_has_data
= true;
2583 current_kboard
= kb
;
2584 return make_number (-2); /* wrong_kboard_jmpbuf */
2590 /* Start idle timers if no time limit is supplied. We don't do it
2591 if a time limit is supplied to avoid an infinite recursion in the
2592 situation where an idle timer calls `sit-for'. */
2595 timer_start_idle ();
2597 /* If in middle of key sequence and minibuffer not active,
2598 start echoing if enough time elapses. */
2600 if (minibuf_level
== 0
2602 && !current_kboard
->immediate_echo
2603 && (this_command_key_count
> 0
2604 || !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
2606 && echo_keystrokes_p ()
2607 && (/* No message. */
2608 NILP (echo_area_buffer
[0])
2609 /* Or empty message. */
2610 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2611 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2612 /* Or already echoing from same kboard. */
2613 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2614 /* Or not echoing before and echoing allowed. */
2615 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2617 /* After a mouse event, start echoing right away.
2618 This is because we are probably about to display a menu,
2619 and we don't want to delay before doing so. */
2620 if (EVENT_HAS_PARAMETERS (prev_event
))
2626 save_getcjmp (save_jump
);
2627 restore_getcjmp (local_getcjmp
);
2628 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2629 restore_getcjmp (save_jump
);
2631 && ! CONSP (Vunread_command_events
))
2636 /* Maybe auto save due to number of keystrokes. */
2638 if (commandflag
!= 0 && commandflag
!= -2
2639 && auto_save_interval
> 0
2640 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2641 && !detect_input_pending_run_timers (0))
2643 Fdo_auto_save (Qnil
, Qnil
);
2644 /* Hooks can actually change some buffers in auto save. */
2648 /* Try reading using an X menu.
2649 This is never confused with reading using the minibuf
2650 because the recursive call of read_char in read_char_minibuf_menu_prompt
2651 does not pass on any keymaps. */
2653 if (KEYMAPP (map
) && INTERACTIVE
2654 && !NILP (prev_event
)
2655 && EVENT_HAS_PARAMETERS (prev_event
)
2656 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2657 && !EQ (XCAR (prev_event
), Qtool_bar
)
2658 /* Don't bring up a menu if we already have another event. */
2659 && NILP (Vunread_command_events
))
2661 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2663 /* Now that we have read an event, Emacs is not idle. */
2670 /* Maybe autosave and/or garbage collect due to idleness. */
2672 if (INTERACTIVE
&& NILP (c
))
2675 ptrdiff_t buffer_size
;
2677 /* Slow down auto saves logarithmically in size of current buffer,
2678 and garbage collect while we're at it. */
2679 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2680 last_non_minibuf_size
= Z
- BEG
;
2681 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2683 while (buffer_size
> 64)
2684 delay_level
++, buffer_size
-= buffer_size
>> 2;
2685 if (delay_level
< 4) delay_level
= 4;
2686 /* delay_level is 4 for files under around 50k, 7 at 100k,
2687 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2689 /* Auto save if enough time goes by without input. */
2690 if (commandflag
!= 0 && commandflag
!= -2
2691 && num_nonmacro_input_events
> last_auto_save
2692 && INTEGERP (Vauto_save_timeout
)
2693 && XINT (Vauto_save_timeout
) > 0)
2696 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2698 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2699 timeout
= delay_level
* timeout
/ 4;
2700 save_getcjmp (save_jump
);
2701 restore_getcjmp (local_getcjmp
);
2702 tem0
= sit_for (make_number (timeout
), 1, 1);
2703 restore_getcjmp (save_jump
);
2706 && ! CONSP (Vunread_command_events
))
2708 Fdo_auto_save (Qnil
, Qnil
);
2713 /* If there is still no input available, ask for GC. */
2714 if (!detect_input_pending_run_timers (0))
2718 /* Notify the caller if an autosave hook, or a timer, sentinel or
2719 filter in the sit_for calls above have changed the current
2720 kboard. This could happen if they use the minibuffer or start a
2721 recursive edit, like the fancy splash screen in server.el's
2722 filter. If this longjmp wasn't here, read_key_sequence would
2723 interpret the next key sequence using the wrong translation
2724 tables and function keymaps. */
2725 if (NILP (c
) && current_kboard
!= orig_kboard
)
2726 return make_number (-2); /* wrong_kboard_jmpbuf */
2728 /* If this has become non-nil here, it has been set by a timer
2729 or sentinel or filter. */
2730 if (CONSP (Vunread_command_events
))
2732 c
= XCAR (Vunread_command_events
);
2733 Vunread_command_events
= XCDR (Vunread_command_events
);
2735 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2741 /* Read something from current KBOARD's side queue, if possible. */
2745 if (current_kboard
->kbd_queue_has_data
)
2747 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2749 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2750 kset_kbd_queue (current_kboard
,
2751 XCDR (KVAR (current_kboard
, kbd_queue
)));
2752 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2753 current_kboard
->kbd_queue_has_data
= false;
2754 input_pending
= readable_events (0);
2755 if (EVENT_HAS_PARAMETERS (c
)
2756 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2757 internal_last_event_frame
= XCAR (XCDR (c
));
2758 Vlast_event_frame
= internal_last_event_frame
;
2762 /* If current_kboard's side queue is empty check the other kboards.
2763 If one of them has data that we have not yet seen here,
2764 switch to it and process the data waiting for it.
2766 Note: if the events queued up for another kboard
2767 have already been seen here, and therefore are not a complete command,
2768 the kbd_queue_has_data field is 0, so we skip that kboard here.
2769 That's to avoid an infinite loop switching between kboards here. */
2770 if (NILP (c
) && !single_kboard
)
2773 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2774 if (kb
->kbd_queue_has_data
)
2776 current_kboard
= kb
;
2777 return make_number (-2); /* wrong_kboard_jmpbuf */
2787 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2788 prev_event
, used_mouse_menu
);
2789 if (NILP (c
) && end_time
2790 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2795 if (EQ (c
, make_number (-2)))
2807 if (commandflag
>= 0
2808 && !input_pending
&& !detect_input_pending_run_timers (0))
2814 /* Buffer switch events are only for internal wakeups
2815 so don't show them to the user.
2816 Also, don't record a key if we already did. */
2820 /* Process special events within read_char
2821 and loop around to read another event. */
2824 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2829 struct buffer
*prev_buffer
= current_buffer
;
2830 last_input_event
= c
;
2831 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2833 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2834 /* We stopped being idle for this event; undo that. This
2835 prevents automatic window selection (under
2836 mouse_autoselect_window from acting as a real input event, for
2837 example banishing the mouse under mouse-avoidance-mode. */
2838 timer_resume_idle ();
2840 if (current_buffer
!= prev_buffer
)
2842 /* The command may have changed the keymaps. Pretend there
2843 is input in another keyboard and return. This will
2844 recalculate keymaps. */
2845 c
= make_number (-2);
2852 /* Handle things that only apply to characters. */
2855 /* If kbd_buffer_get_event gave us an EOF, return that. */
2859 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2860 && UNSIGNED_CMP (XFASTINT (c
), <,
2861 SCHARS (KVAR (current_kboard
,
2862 Vkeyboard_translate_table
))))
2863 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2864 && UNSIGNED_CMP (XFASTINT (c
), <,
2865 ASIZE (KVAR (current_kboard
,
2866 Vkeyboard_translate_table
))))
2867 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2871 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2872 /* nil in keyboard-translate-table means no translation. */
2878 /* If this event is a mouse click in the menu bar,
2879 return just menu-bar for now. Modify the mouse click event
2880 so we won't do this twice, then queue it up. */
2881 if (EVENT_HAS_PARAMETERS (c
)
2883 && CONSP (EVENT_START (c
))
2884 && CONSP (XCDR (EVENT_START (c
))))
2888 posn
= POSN_POSN (EVENT_START (c
));
2889 /* Handle menu-bar events:
2890 insert the dummy prefix event `menu-bar'. */
2891 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2893 /* Change menu-bar to (menu-bar) as the event "position". */
2894 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2897 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2902 /* Store these characters into recent_keys, the dribble file if any,
2903 and the keyboard macro being defined, if any. */
2906 if (! NILP (also_record
))
2907 record_char (also_record
);
2909 /* Wipe the echo area.
2910 But first, if we are about to use an input method,
2911 save the echo area contents for it to refer to. */
2913 && ! NILP (Vinput_method_function
)
2914 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2916 previous_echo_area_message
= Fcurrent_message ();
2917 Vinput_method_previous_message
= previous_echo_area_message
;
2920 /* Now wipe the echo area, except for help events which do their
2921 own stuff with the echo area. */
2923 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2924 && !(EQ (Qswitch_frame
, XCAR (c
)))
2925 /* Don't wipe echo area for select window events: These might
2926 get delayed via `mouse-autoselect-window' (Bug#11304). */
2927 && !(EQ (Qselect_window
, XCAR (c
)))))
2929 if (!NILP (echo_area_buffer
[0]))
2931 safe_run_hooks (Qecho_area_clear_hook
);
2932 clear_message (1, 0);
2936 reread_for_input_method
:
2938 /* Pass this to the input method, if appropriate. */
2940 && ! NILP (Vinput_method_function
)
2941 /* Don't run the input method within a key sequence,
2942 after the first event of the key sequence. */
2943 && NILP (prev_event
)
2944 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2947 ptrdiff_t key_count
;
2948 ptrdiff_t command_key_start
;
2949 ptrdiff_t count
= SPECPDL_INDEX ();
2951 /* Save the echo status. */
2952 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2953 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2954 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2955 Lisp_Object saved_echo_prompt
= KVAR (current_kboard
, echo_prompt
);
2957 /* Save the this_command_keys status. */
2958 key_count
= this_command_key_count
;
2959 command_key_start
= this_single_command_key_start
;
2962 keys
= Fcopy_sequence (this_command_keys
);
2966 /* Clear out this_command_keys. */
2967 this_command_key_count
= 0;
2968 this_single_command_key_start
= 0;
2970 /* Now wipe the echo area. */
2971 if (!NILP (echo_area_buffer
[0]))
2972 safe_run_hooks (Qecho_area_clear_hook
);
2973 clear_message (1, 0);
2976 /* If we are not reading a key sequence,
2977 never use the echo area. */
2980 specbind (Qinput_method_use_echo_area
, Qt
);
2983 /* Call the input method. */
2984 tem
= call1 (Vinput_method_function
, c
);
2986 tem
= unbind_to (count
, tem
);
2988 /* Restore the saved echoing state
2989 and this_command_keys state. */
2990 this_command_key_count
= key_count
;
2991 this_single_command_key_start
= command_key_start
;
2993 this_command_keys
= keys
;
2996 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2997 kset_echo_string (current_kboard
, saved_echo_string
);
2998 kset_echo_prompt (current_kboard
, saved_echo_prompt
);
2999 if (saved_immediate_echo
)
3002 /* The input method can return no events. */
3005 /* Bring back the previous message, if any. */
3006 if (! NILP (previous_echo_area_message
))
3007 message_with_string ("%s", previous_echo_area_message
, 0);
3010 /* It returned one event or more. */
3012 Vunread_post_input_method_events
3013 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3015 /* When we consume events from the various unread-*-events lists, we
3016 bypass the code that records input, so record these events now if
3017 they were not recorded already. */
3026 /* Display help if not echoing. */
3027 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3029 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3030 Lisp_Object help
, object
, position
, window
, htem
;
3032 htem
= Fcdr (XCDR (c
));
3035 window
= Fcar (htem
);
3037 object
= Fcar (htem
);
3039 position
= Fcar (htem
);
3041 show_help_echo (help
, window
, object
, position
);
3043 /* We stopped being idle for this event; undo that. */
3045 timer_resume_idle ();
3049 if ((! reread
|| this_command_key_count
== 0)
3053 /* Don't echo mouse motion events. */
3054 if (! (EVENT_HAS_PARAMETERS (c
)
3055 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3056 /* Once we reread a character, echoing can happen
3057 the next time we pause to read a new one. */
3058 ok_to_echo_at_next_pause
= current_kboard
;
3060 /* Record this character as part of the current key. */
3061 add_command_key (c
);
3062 if (! NILP (also_record
))
3063 add_command_key (also_record
);
3068 last_input_event
= c
;
3071 /* Process the help character specially if enabled. */
3072 if (!NILP (Vhelp_form
) && help_char_p (c
))
3074 ptrdiff_t count
= SPECPDL_INDEX ();
3076 help_form_saved_window_configs
3077 = Fcons (Fcurrent_window_configuration (Qnil
),
3078 help_form_saved_window_configs
);
3079 record_unwind_protect_void (read_char_help_form_unwind
);
3080 call0 (Qhelp_form_show
);
3085 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3086 if (EVENT_HAS_PARAMETERS (c
)
3087 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3088 XSETCAR (help_form_saved_window_configs
, Qnil
);
3090 while (BUFFERP (c
));
3091 /* Remove the help from the frame. */
3092 unbind_to (count
, Qnil
);
3095 if (EQ (c
, make_number (040)))
3099 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3100 while (BUFFERP (c
));
3106 input_was_pending
= input_pending
;
3110 /* Record a key that came from a mouse menu.
3111 Record it for echoing, for this-command-keys, and so on. */
3114 record_menu_key (Lisp_Object c
)
3116 /* Wipe the echo area. */
3117 clear_message (1, 0);
3121 /* Once we reread a character, echoing can happen
3122 the next time we pause to read a new one. */
3123 ok_to_echo_at_next_pause
= NULL
;
3125 /* Record this character as part of the current key. */
3126 add_command_key (c
);
3129 /* Re-reading in the middle of a command. */
3130 last_input_event
= c
;
3134 /* Return true if should recognize C as "the help character". */
3137 help_char_p (Lisp_Object c
)
3141 if (EQ (c
, Vhelp_char
))
3143 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3144 if (EQ (c
, XCAR (tail
)))
3149 /* Record the input event C in various ways. */
3152 record_char (Lisp_Object c
)
3156 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3158 /* To avoid filling recent_keys with help-echo and mouse-movement
3159 events, we filter out repeated help-echo events, only store the
3160 first and last in a series of mouse-movement events, and don't
3161 store repeated help-echo events which are only separated by
3162 mouse-movement events. */
3164 Lisp_Object ev1
, ev2
, ev3
;
3167 if ((ix1
= recent_keys_index
- 1) < 0)
3168 ix1
= NUM_RECENT_KEYS
- 1;
3169 ev1
= AREF (recent_keys
, ix1
);
3171 if ((ix2
= ix1
- 1) < 0)
3172 ix2
= NUM_RECENT_KEYS
- 1;
3173 ev2
= AREF (recent_keys
, ix2
);
3175 if ((ix3
= ix2
- 1) < 0)
3176 ix3
= NUM_RECENT_KEYS
- 1;
3177 ev3
= AREF (recent_keys
, ix3
);
3179 if (EQ (XCAR (c
), Qhelp_echo
))
3181 /* Don't record `help-echo' in recent_keys unless it shows some help
3182 message, and a different help than the previously recorded
3184 Lisp_Object help
, last_help
;
3186 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3187 if (!STRINGP (help
))
3189 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3190 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3192 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3193 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3194 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3196 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3197 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3198 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3199 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3202 else if (EQ (XCAR (c
), Qmouse_movement
))
3204 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3205 So additional mouse movement events replace the last element. */
3206 Lisp_Object last_window
, window
;
3208 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3209 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3210 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3211 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3212 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3214 ASET (recent_keys
, ix1
, c
);
3220 store_kbd_macro_char (c
);
3224 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3225 ASET (recent_keys
, recent_keys_index
, c
);
3226 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3227 recent_keys_index
= 0;
3229 else if (recorded
< 0)
3231 /* We need to remove one or two events from recent_keys.
3232 To do this, we simply put nil at those events and move the
3233 recent_keys_index backwards over those events. Usually,
3234 users will never see those nil events, as they will be
3235 overwritten by the command keys entered to see recent_keys
3238 while (recorded
++ < 0 && total_keys
> 0)
3240 if (total_keys
< NUM_RECENT_KEYS
)
3242 if (--recent_keys_index
< 0)
3243 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3244 ASET (recent_keys
, recent_keys_index
, Qnil
);
3248 num_nonmacro_input_events
++;
3250 /* Write c to the dribble file. If c is a lispy event, write
3251 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3252 If you, dear reader, have a better idea, you've got the source. :-) */
3258 if (XUINT (c
) < 0x100)
3259 putc (XUINT (c
), dribble
);
3261 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3265 Lisp_Object dribblee
;
3267 /* If it's a structured event, take the event header. */
3268 dribblee
= EVENT_HEAD (c
);
3270 if (SYMBOLP (dribblee
))
3272 putc ('<', dribble
);
3273 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3274 SBYTES (SYMBOL_NAME (dribblee
)),
3276 putc ('>', dribble
);
3285 /* Copy out or in the info on where C-g should throw to.
3286 This is used when running Lisp code from within get_char,
3287 in case get_char is called recursively.
3288 See read_process_output. */
3291 save_getcjmp (sys_jmp_buf temp
)
3293 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3297 restore_getcjmp (sys_jmp_buf temp
)
3299 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3302 /* Low level keyboard/mouse input.
3303 kbd_buffer_store_event places events in kbd_buffer, and
3304 kbd_buffer_get_event retrieves them. */
3306 /* Return true if there are any events in the queue that read-char
3307 would return. If this returns false, a read-char would block. */
3309 readable_events (int flags
)
3311 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3314 /* If the buffer contains only FOCUS_IN_EVENT events, and
3315 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3316 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3318 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3319 #ifdef USE_TOOLKIT_SCROLL_BARS
3320 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3324 union buffered_input_event
*event
= kbd_fetch_ptr
;
3328 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3331 #ifdef USE_TOOLKIT_SCROLL_BARS
3332 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3334 event
->kind
== FOCUS_IN_EVENT
)
3335 #ifdef USE_TOOLKIT_SCROLL_BARS
3336 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3337 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3338 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3339 && event
->ie
.part
== scroll_bar_handle
3340 && event
->ie
.modifiers
== 0)
3342 && !((flags
& READABLE_EVENTS_FILTER_EVENTS
)
3343 && event
->kind
== BUFFER_SWITCH_EVENT
))
3347 while (event
!= kbd_store_ptr
);
3353 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3354 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3358 if (current_kboard
->kbd_queue_has_data
)
3364 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3365 if (kb
->kbd_queue_has_data
)
3371 /* Set this for debugging, to have a way to get out */
3372 int stop_character EXTERNALLY_VISIBLE
;
3375 event_to_kboard (struct input_event
*event
)
3377 /* Not applicable for these special events. */
3378 if (event
->kind
== SELECTION_REQUEST_EVENT
3379 || event
->kind
== SELECTION_CLEAR_EVENT
)
3383 Lisp_Object obj
= event
->frame_or_window
;
3384 /* There are some events that set this field to nil or string. */
3386 obj
= WINDOW_FRAME (XWINDOW (obj
));
3387 /* Also ignore dead frames here. */
3388 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3389 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3394 /* Return the number of slots occupied in kbd_buffer. */
3397 kbd_buffer_nr_stored (void)
3399 return kbd_fetch_ptr
== kbd_store_ptr
3401 : (kbd_fetch_ptr
< kbd_store_ptr
3402 ? kbd_store_ptr
- kbd_fetch_ptr
3403 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3404 + (kbd_store_ptr
- kbd_buffer
)));
3406 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3409 kbd_buffer_store_event (register struct input_event
*event
)
3411 kbd_buffer_store_event_hold (event
, 0);
3414 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3416 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3417 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3418 Else, if EVENT is a quit event, store the quit event
3419 in HOLD_QUIT, and return (thus ignoring further events).
3421 This is used to postpone the processing of the quit event until all
3422 subsequent input events have been parsed (and discarded). */
3425 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3426 struct input_event
*hold_quit
)
3428 if (event
->kind
== NO_EVENT
)
3431 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3434 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3436 int c
= event
->ie
.code
& 0377;
3438 if (event
->ie
.modifiers
& ctrl_modifier
)
3439 c
= make_ctrl_char (c
);
3441 c
|= (event
->ie
.modifiers
3442 & (meta_modifier
| alt_modifier
3443 | hyper_modifier
| super_modifier
));
3447 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3449 if (single_kboard
&& kb
!= current_kboard
)
3452 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3454 kb
->kbd_queue_has_data
= true;
3455 union buffered_input_event
*sp
;
3456 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3458 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3461 if (event_to_kboard (&sp
->ie
) == kb
)
3463 sp
->ie
.kind
= NO_EVENT
;
3464 sp
->ie
.frame_or_window
= Qnil
;
3473 *hold_quit
= event
->ie
;
3477 /* If this results in a quit_char being returned to Emacs as
3478 input, set Vlast_event_frame properly. If this doesn't
3479 get returned to Emacs as an event, the next event read
3480 will set Vlast_event_frame again, so this is safe to do. */
3484 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3486 focus
= event
->ie
.frame_or_window
;
3487 internal_last_event_frame
= focus
;
3488 Vlast_event_frame
= focus
;
3491 handle_interrupt (0);
3495 if (c
&& c
== stop_character
)
3501 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3502 Just ignore the second one. */
3503 else if (event
->kind
== BUFFER_SWITCH_EVENT
3504 && kbd_fetch_ptr
!= kbd_store_ptr
3505 && ((kbd_store_ptr
== kbd_buffer
3506 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3507 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3510 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3511 kbd_store_ptr
= kbd_buffer
;
3513 /* Don't let the very last slot in the buffer become full,
3514 since that would make the two pointers equal,
3515 and that is indistinguishable from an empty buffer.
3516 Discard the event if it would fill the last slot. */
3517 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3519 *kbd_store_ptr
= *event
;
3522 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3523 && ! kbd_on_hold_p ())
3525 /* Don't read keyboard input until we have processed kbd_buffer.
3526 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3527 hold_keyboard_input ();
3531 #endif /* subprocesses */
3534 /* If we're inside while-no-input, and this event qualifies
3535 as input, set quit-flag to cause an interrupt. */
3536 if (!NILP (Vthrow_on_input
)
3537 && event
->kind
!= FOCUS_IN_EVENT
3538 && event
->kind
!= FOCUS_OUT_EVENT
3539 && event
->kind
!= HELP_EVENT
3540 && event
->kind
!= ICONIFY_EVENT
3541 && event
->kind
!= DEICONIFY_EVENT
)
3543 Vquit_flag
= Vthrow_on_input
;
3544 /* If we're inside a function that wants immediate quits,
3546 if (immediate_quit
&& NILP (Vinhibit_quit
))
3548 immediate_quit
= false;
3557 /* Put a selection input event back in the head of the event queue. */
3560 kbd_buffer_unget_event (struct selection_input_event
*event
)
3562 if (kbd_fetch_ptr
== kbd_buffer
)
3563 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3565 /* Don't let the very last slot in the buffer become full, */
3566 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3567 if (kp
!= kbd_store_ptr
)
3576 /* Limit help event positions to this range, to avoid overflow problems. */
3577 #define INPUT_EVENT_POS_MAX \
3578 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3579 MOST_POSITIVE_FIXNUM)))
3580 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3582 /* Return a Time that encodes position POS. POS must be in range. */
3585 position_to_Time (ptrdiff_t pos
)
3587 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3591 /* Return the position that ENCODED_POS encodes.
3592 Avoid signed integer overflow. */
3595 Time_to_position (Time encoded_pos
)
3597 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3599 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3600 eassert (encoded_pos_min
<= encoded_pos
);
3601 ptrdiff_t notpos
= -1 - encoded_pos
;
3605 /* Generate a HELP_EVENT input_event and store it in the keyboard
3608 HELP is the help form.
3610 FRAME and WINDOW are the frame and window where the help is
3611 generated. OBJECT is the Lisp object where the help was found (a
3612 buffer, a string, an overlay, or nil if neither from a string nor
3613 from a buffer). POS is the position within OBJECT where the help
3617 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3618 Lisp_Object object
, ptrdiff_t pos
)
3620 struct input_event event
;
3622 event
.kind
= HELP_EVENT
;
3623 event
.frame_or_window
= frame
;
3625 event
.x
= WINDOWP (window
) ? window
: frame
;
3627 event
.timestamp
= position_to_Time (pos
);
3628 kbd_buffer_store_event (&event
);
3632 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3635 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3637 struct input_event event
;
3639 event
.kind
= HELP_EVENT
;
3640 event
.frame_or_window
= frame
;
3644 event
.timestamp
= 0;
3645 kbd_buffer_store_event (&event
);
3649 /* Discard any mouse events in the event buffer by setting them to
3652 discard_mouse_events (void)
3654 union buffered_input_event
*sp
;
3655 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3657 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3660 if (sp
->kind
== MOUSE_CLICK_EVENT
3661 || sp
->kind
== WHEEL_EVENT
3662 || sp
->kind
== HORIZ_WHEEL_EVENT
3664 || sp
->kind
== GPM_CLICK_EVENT
3666 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3667 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3669 sp
->kind
= NO_EVENT
;
3675 /* Return true if there are any real events waiting in the event
3676 buffer, not counting `NO_EVENT's.
3678 Discard NO_EVENT events at the front of the input queue, possibly
3679 leaving the input queue empty if there are no real input events. */
3682 kbd_buffer_events_waiting (void)
3684 union buffered_input_event
*sp
;
3686 for (sp
= kbd_fetch_ptr
;
3687 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3690 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3695 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3699 /* Clear input event EVENT. */
3702 clear_event (union buffered_input_event
*event
)
3704 event
->kind
= NO_EVENT
;
3708 /* Read one event from the event buffer, waiting if necessary.
3709 The value is a Lisp object representing the event.
3710 The value is nil for an event that should be ignored,
3711 or that was handled here.
3712 We always read and discard one event. */
3715 kbd_buffer_get_event (KBOARD
**kbp
,
3716 bool *used_mouse_menu
,
3717 struct timespec
*end_time
)
3722 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3724 /* Start reading input again because we have processed enough to
3725 be able to accept new events again. */
3726 unhold_keyboard_input ();
3730 #endif /* subprocesses */
3732 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3734 /* In case we are running as a daemon, only do this before
3735 detaching from the terminal. */
3736 || (IS_DAEMON
&& DAEMON_RUNNING
))
3740 *kbp
= current_kboard
;
3743 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3745 /* Wait until there is input available. */
3748 /* Break loop if there's an unread command event. Needed in
3749 moused window autoselection which uses a timer to insert such
3751 if (CONSP (Vunread_command_events
))
3754 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3756 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3759 /* If the quit flag is set, then read_char will return
3760 quit_char, so that counts as "available input." */
3761 if (!NILP (Vquit_flag
))
3762 quit_throw_to_read_char (0);
3764 /* One way or another, wait until input is available; then, if
3765 interrupt handlers have not read it, read it now. */
3770 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3772 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3776 struct timespec now
= current_timespec ();
3777 if (timespec_cmp (*end_time
, now
) <= 0)
3778 return Qnil
; /* Finished waiting. */
3781 struct timespec duration
= timespec_sub (*end_time
, now
);
3782 wait_reading_process_output (min (duration
.tv_sec
,
3785 -1, 1, Qnil
, NULL
, 0);
3790 bool do_display
= true;
3792 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3794 struct tty_display_info
*tty
= CURTTY ();
3796 /* When this TTY is displaying a menu, we must prevent
3797 any redisplay, because we modify the frame's glyph
3798 matrix behind the back of the display engine. */
3799 if (tty
->showing_menu
)
3803 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3806 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3810 if (CONSP (Vunread_command_events
))
3813 first
= XCAR (Vunread_command_events
);
3814 Vunread_command_events
= XCDR (Vunread_command_events
);
3815 *kbp
= current_kboard
;
3819 /* At this point, we know that there is a readable event available
3820 somewhere. If the event queue is empty, then there must be a
3821 mouse movement enabled and available. */
3822 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3824 union buffered_input_event
*event
;
3826 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3830 *kbp
= event_to_kboard (&event
->ie
);
3832 *kbp
= current_kboard
; /* Better than returning null ptr? */
3836 /* These two kinds of events get special handling
3837 and don't actually appear to the command loop.
3838 We return nil for them. */
3839 if (event
->kind
== SELECTION_REQUEST_EVENT
3840 || event
->kind
== SELECTION_CLEAR_EVENT
)
3843 /* Remove it from the buffer before processing it,
3844 since otherwise swallow_events will see it
3845 and process it again. */
3846 struct selection_input_event copy
= event
->sie
;
3847 kbd_fetch_ptr
= event
+ 1;
3848 input_pending
= readable_events (0);
3849 x_handle_selection_event (©
);
3851 /* We're getting selection request events, but we don't have
3857 #if defined (HAVE_NS)
3858 else if (event
->kind
== NS_TEXT_EVENT
)
3860 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3861 obj
= list1 (intern ("ns-put-working-text"));
3863 obj
= list1 (intern ("ns-unput-working-text"));
3864 kbd_fetch_ptr
= event
+ 1;
3865 if (used_mouse_menu
)
3866 *used_mouse_menu
= true;
3870 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3871 || defined (HAVE_NS)
3872 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3874 /* Make an event (delete-frame (FRAME)). */
3875 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
3876 kbd_fetch_ptr
= event
+ 1;
3879 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3880 || defined (HAVE_NS)
3881 else if (event
->kind
== ICONIFY_EVENT
)
3883 /* Make an event (iconify-frame (FRAME)). */
3884 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
3885 kbd_fetch_ptr
= event
+ 1;
3887 else if (event
->kind
== DEICONIFY_EVENT
)
3889 /* Make an event (make-frame-visible (FRAME)). */
3890 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
3891 kbd_fetch_ptr
= event
+ 1;
3894 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3896 /* The value doesn't matter here; only the type is tested. */
3897 XSETBUFFER (obj
, current_buffer
);
3898 kbd_fetch_ptr
= event
+ 1;
3900 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3901 || defined (HAVE_NS) || defined (USE_GTK)
3902 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3904 kbd_fetch_ptr
= event
+ 1;
3905 input_pending
= readable_events (0);
3906 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
3907 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
3911 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3913 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3914 obj
= list4 (Qlanguage_change
,
3915 event
->ie
.frame_or_window
,
3916 make_number (event
->ie
.code
),
3917 make_number (event
->ie
.modifiers
));
3918 kbd_fetch_ptr
= event
+ 1;
3921 #ifdef USE_FILE_NOTIFY
3922 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3924 #ifdef HAVE_W32NOTIFY
3925 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3926 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
3928 obj
= make_lispy_event (&event
->ie
);
3930 kbd_fetch_ptr
= event
+ 1;
3932 #endif /* USE_FILE_NOTIFY */
3933 else if (event
->kind
== SAVE_SESSION_EVENT
)
3935 obj
= list2 (Qsave_session
, event
->ie
.arg
);
3936 kbd_fetch_ptr
= event
+ 1;
3938 /* Just discard these, by returning nil.
3939 With MULTI_KBOARD, these events are used as placeholders
3940 when we need to randomly delete events from the queue.
3941 (They shouldn't otherwise be found in the buffer,
3942 but on some machines it appears they do show up
3943 even without MULTI_KBOARD.) */
3944 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3945 mouse events during a popup-menu call. */
3946 else if (event
->kind
== NO_EVENT
)
3947 kbd_fetch_ptr
= event
+ 1;
3948 else if (event
->kind
== HELP_EVENT
)
3950 Lisp_Object object
, position
, help
, frame
, window
;
3952 frame
= event
->ie
.frame_or_window
;
3953 object
= event
->ie
.arg
;
3954 position
= make_number (Time_to_position (event
->ie
.timestamp
));
3955 window
= event
->ie
.x
;
3957 clear_event (event
);
3959 kbd_fetch_ptr
= event
+ 1;
3960 if (!WINDOWP (window
))
3962 obj
= Fcons (Qhelp_echo
,
3963 list5 (frame
, help
, window
, object
, position
));
3965 else if (event
->kind
== FOCUS_IN_EVENT
)
3967 /* Notification of a FocusIn event. The frame receiving the
3968 focus is in event->frame_or_window. Generate a
3969 switch-frame event if necessary. */
3970 Lisp_Object frame
, focus
;
3972 frame
= event
->ie
.frame_or_window
;
3973 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3979 ! NILP (event
->ie
.arg
)
3982 !EQ (frame
, internal_last_event_frame
)
3983 && !EQ (frame
, selected_frame
))
3984 obj
= make_lispy_switch_frame (frame
);
3986 obj
= make_lispy_focus_in (frame
);
3988 internal_last_event_frame
= frame
;
3989 kbd_fetch_ptr
= event
+ 1;
3991 else if (event
->kind
== FOCUS_OUT_EVENT
)
3993 #ifdef HAVE_WINDOW_SYSTEM
3996 Lisp_Object frame
= event
->ie
.frame_or_window
;
3997 bool focused
= false;
3999 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4000 focused
= di
->x_highlight_frame
!= 0;
4003 obj
= make_lispy_focus_out (frame
);
4005 #endif /* HAVE_WINDOW_SYSTEM */
4007 kbd_fetch_ptr
= event
+ 1;
4010 else if (event
->kind
== DBUS_EVENT
)
4012 obj
= make_lispy_event (&event
->ie
);
4013 kbd_fetch_ptr
= event
+ 1;
4016 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4018 obj
= make_lispy_event (&event
->ie
);
4019 kbd_fetch_ptr
= event
+ 1;
4023 /* If this event is on a different frame, return a switch-frame this
4024 time, and leave the event in the queue for next time. */
4028 frame
= event
->ie
.frame_or_window
;
4030 frame
= XCAR (frame
);
4031 else if (WINDOWP (frame
))
4032 frame
= WINDOW_FRAME (XWINDOW (frame
));
4034 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4038 if (! EQ (frame
, internal_last_event_frame
)
4039 && !EQ (frame
, selected_frame
))
4040 obj
= make_lispy_switch_frame (frame
);
4041 internal_last_event_frame
= frame
;
4043 /* If we didn't decide to make a switch-frame event, go ahead
4044 and build a real event from the queue entry. */
4048 obj
= make_lispy_event (&event
->ie
);
4050 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4051 || defined (HAVE_NS) || defined (USE_GTK)
4052 /* If this was a menu selection, then set the flag to inhibit
4053 writing to last_nonmenu_event. Don't do this if the event
4054 we're returning is (menu-bar), though; that indicates the
4055 beginning of the menu sequence, and we might as well leave
4056 that as the `event with parameters' for this selection. */
4058 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4059 && (event
->kind
== MENU_BAR_EVENT
4060 || event
->kind
== TOOL_BAR_EVENT
))
4061 *used_mouse_menu
= true;
4064 /* Certain system events are non-key events. */
4066 && event
->kind
== NS_NONKEY_EVENT
)
4067 *used_mouse_menu
= true;
4070 /* Wipe out this event, to catch bugs. */
4071 clear_event (event
);
4072 kbd_fetch_ptr
= event
+ 1;
4076 /* Try generating a mouse motion event. */
4077 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4079 struct frame
*f
= some_mouse_moved ();
4080 Lisp_Object bar_window
;
4081 enum scroll_bar_part part
;
4085 *kbp
= current_kboard
;
4086 /* Note that this uses F to determine which terminal to look at.
4087 If there is no valid info, it does not store anything
4088 so x remains nil. */
4091 /* XXX Can f or mouse_position_hook be NULL here? */
4092 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4093 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4098 /* Decide if we should generate a switch-frame event. Don't
4099 generate switch-frame events for motion outside of all Emacs
4105 frame
= FRAME_FOCUS_FRAME (f
);
4107 XSETFRAME (frame
, f
);
4109 if (! EQ (frame
, internal_last_event_frame
)
4110 && !EQ (frame
, selected_frame
))
4111 obj
= make_lispy_switch_frame (frame
);
4112 internal_last_event_frame
= frame
;
4115 /* If we didn't decide to make a switch-frame event, go ahead and
4116 return a mouse-motion event. */
4117 if (!NILP (x
) && NILP (obj
))
4118 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4121 /* We were promised by the above while loop that there was
4122 something for us to read! */
4125 input_pending
= readable_events (0);
4127 Vlast_event_frame
= internal_last_event_frame
;
4132 /* Process any non-user-visible events (currently X selection events),
4133 without reading any user-visible events. */
4136 process_special_events (void)
4138 union buffered_input_event
*event
;
4140 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4142 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4145 if (event
== kbd_store_ptr
)
4149 /* If we find a stored X selection request, handle it now. */
4150 if (event
->kind
== SELECTION_REQUEST_EVENT
4151 || event
->kind
== SELECTION_CLEAR_EVENT
)
4155 /* Remove the event from the fifo buffer before processing;
4156 otherwise swallow_events called recursively could see it
4157 and process it again. To do this, we move the events
4158 between kbd_fetch_ptr and EVENT one slot to the right,
4161 struct selection_input_event copy
= event
->sie
;
4162 union buffered_input_event
*beg
4163 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4164 ? kbd_buffer
: kbd_fetch_ptr
;
4167 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4168 else if (event
< beg
)
4170 if (event
> kbd_buffer
)
4171 memmove (kbd_buffer
+ 1, kbd_buffer
,
4172 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4173 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4174 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4175 memmove (beg
+ 1, beg
,
4176 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4179 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4180 kbd_fetch_ptr
= kbd_buffer
+ 1;
4184 input_pending
= readable_events (0);
4185 x_handle_selection_event (©
);
4187 /* We're getting selection request events, but we don't have
4195 /* Process any events that are not user-visible, run timer events that
4196 are ripe, and return, without reading any user-visible events. */
4199 swallow_events (bool do_display
)
4201 unsigned old_timers_run
;
4203 process_special_events ();
4205 old_timers_run
= timers_run
;
4206 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4208 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4209 redisplay_preserve_echo_area (7);
4212 /* Record the start of when Emacs is idle,
4213 for the sake of running idle-time timers. */
4216 timer_start_idle (void)
4218 /* If we are already in the idle state, do nothing. */
4219 if (timespec_valid_p (timer_idleness_start_time
))
4222 timer_idleness_start_time
= current_timespec ();
4223 timer_last_idleness_start_time
= timer_idleness_start_time
;
4225 /* Mark all idle-time timers as once again candidates for running. */
4226 call0 (intern ("internal-timer-start-idle"));
4229 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4232 timer_stop_idle (void)
4234 timer_idleness_start_time
= invalid_timespec ();
4237 /* Resume idle timer from last idle start time. */
4240 timer_resume_idle (void)
4242 if (timespec_valid_p (timer_idleness_start_time
))
4245 timer_idleness_start_time
= timer_last_idleness_start_time
;
4248 /* List of elisp functions to call, delayed because they were generated in
4249 a context where Elisp could not be safely run (e.g. redisplay, signal,
4250 ...). Each element has the form (FUN . ARGS). */
4251 Lisp_Object pending_funcalls
;
4253 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4255 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4259 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4261 vec
= XVECTOR (timer
)->contents
;
4262 if (! NILP (vec
[0]))
4264 if (! INTEGERP (vec
[2]))
4268 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4270 *result
= lisp_to_timespec (t
);
4271 return timespec_valid_p (*result
);
4275 /* Check whether a timer has fired. To prevent larger problems we simply
4276 disregard elements that are not proper timers. Do not make a circular
4277 timer list for the time being.
4279 Returns the time to wait until the next timer fires. If a
4280 timer is triggering now, return zero.
4281 If no timer is active, return -1.
4283 If a timer is ripe, we run it, with quitting turned off.
4284 In that case we return 0 to indicate that a new timer_check_2 call
4287 static struct timespec
4288 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4290 struct timespec nexttime
;
4291 struct timespec now
;
4292 struct timespec idleness_now
;
4293 Lisp_Object chosen_timer
;
4295 nexttime
= invalid_timespec ();
4297 chosen_timer
= Qnil
;
4299 /* First run the code that was delayed. */
4300 while (CONSP (pending_funcalls
))
4302 Lisp_Object funcall
= XCAR (pending_funcalls
);
4303 pending_funcalls
= XCDR (pending_funcalls
);
4304 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4307 if (CONSP (timers
) || CONSP (idle_timers
))
4309 now
= current_timespec ();
4310 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4311 ? timespec_sub (now
, timer_idleness_start_time
)
4312 : make_timespec (0, 0));
4315 while (CONSP (timers
) || CONSP (idle_timers
))
4317 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4318 struct timespec timer_time
, idle_timer_time
;
4319 struct timespec difference
;
4320 struct timespec timer_difference
= invalid_timespec ();
4321 struct timespec idle_timer_difference
= invalid_timespec ();
4322 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4324 /* Set TIMER and TIMER_DIFFERENCE
4325 based on the next ordinary timer.
4326 TIMER_DIFFERENCE is the distance in time from NOW to when
4327 this timer becomes ripe.
4328 Skip past invalid timers and timers already handled. */
4331 timer
= XCAR (timers
);
4332 if (! decode_timer (timer
, &timer_time
))
4334 timers
= XCDR (timers
);
4338 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4339 timer_difference
= (timer_ripe
4340 ? timespec_sub (now
, timer_time
)
4341 : timespec_sub (timer_time
, now
));
4344 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4345 based on the next idle timer. */
4346 if (CONSP (idle_timers
))
4348 idle_timer
= XCAR (idle_timers
);
4349 if (! decode_timer (idle_timer
, &idle_timer_time
))
4351 idle_timers
= XCDR (idle_timers
);
4355 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4356 idle_timer_difference
4358 ? timespec_sub (idleness_now
, idle_timer_time
)
4359 : timespec_sub (idle_timer_time
, idleness_now
));
4362 /* Decide which timer is the next timer,
4363 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4364 Also step down the list where we found that timer. */
4366 if (timespec_valid_p (timer_difference
)
4367 && (! timespec_valid_p (idle_timer_difference
)
4368 || idle_timer_ripe
< timer_ripe
4369 || (idle_timer_ripe
== timer_ripe
4371 ? timespec_cmp (idle_timer_difference
,
4373 : timespec_cmp (timer_difference
,
4374 idle_timer_difference
))
4377 chosen_timer
= timer
;
4378 timers
= XCDR (timers
);
4379 difference
= timer_difference
;
4384 chosen_timer
= idle_timer
;
4385 idle_timers
= XCDR (idle_timers
);
4386 difference
= idle_timer_difference
;
4387 ripe
= idle_timer_ripe
;
4390 /* If timer is ripe, run it if it hasn't been run. */
4393 if (NILP (AREF (chosen_timer
, 0)))
4395 ptrdiff_t count
= SPECPDL_INDEX ();
4396 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4398 /* Mark the timer as triggered to prevent problems if the lisp
4399 code fails to reschedule it right. */
4400 ASET (chosen_timer
, 0, Qt
);
4402 specbind (Qinhibit_quit
, Qt
);
4404 call1 (Qtimer_event_handler
, chosen_timer
);
4405 Vdeactivate_mark
= old_deactivate_mark
;
4407 unbind_to (count
, Qnil
);
4409 /* Since we have handled the event,
4410 we don't need to tell the caller to wake up and do it. */
4411 /* But the caller must still wait for the next timer, so
4412 return 0 to indicate that. */
4415 nexttime
= make_timespec (0, 0);
4419 /* When we encounter a timer that is still waiting,
4420 return the amount of time to wait before it is ripe. */
4426 /* No timers are pending in the future. */
4427 /* Return 0 if we generated an event, and -1 if not. */
4432 /* Check whether a timer has fired. To prevent larger problems we simply
4433 disregard elements that are not proper timers. Do not make a circular
4434 timer list for the time being.
4436 Returns the time to wait until the next timer fires.
4437 If no timer is active, return an invalid value.
4439 As long as any timer is ripe, we run it. */
4444 struct timespec nexttime
;
4445 Lisp_Object timers
, idle_timers
;
4447 Lisp_Object tem
= Vinhibit_quit
;
4450 /* We use copies of the timers' lists to allow a timer to add itself
4451 again, without locking up Emacs if the newly added timer is
4452 already ripe when added. */
4454 /* Always consider the ordinary timers. */
4455 timers
= Fcopy_sequence (Vtimer_list
);
4456 /* Consider the idle timers only if Emacs is idle. */
4457 if (timespec_valid_p (timer_idleness_start_time
))
4458 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4462 Vinhibit_quit
= tem
;
4466 nexttime
= timer_check_2 (timers
, idle_timers
);
4468 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4473 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4474 doc
: /* Return the current length of Emacs idleness, or nil.
4475 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4476 in the same style as (current-time).
4478 The value when Emacs is not idle is nil.
4480 PSEC is a multiple of the system clock resolution. */)
4483 if (timespec_valid_p (timer_idleness_start_time
))
4484 return make_lisp_time (timespec_sub (current_timespec (),
4485 timer_idleness_start_time
));
4490 /* Caches for modify_event_symbol. */
4491 static Lisp_Object accent_key_syms
;
4492 static Lisp_Object func_key_syms
;
4493 static Lisp_Object mouse_syms
;
4494 static Lisp_Object wheel_syms
;
4495 static Lisp_Object drag_n_drop_syms
;
4497 /* This is a list of keysym codes for special "accent" characters.
4498 It parallels lispy_accent_keys. */
4500 static const int lispy_accent_codes
[] =
4502 #ifdef XK_dead_circumflex
4507 #ifdef XK_dead_grave
4512 #ifdef XK_dead_tilde
4517 #ifdef XK_dead_diaeresis
4522 #ifdef XK_dead_macron
4527 #ifdef XK_dead_degree
4532 #ifdef XK_dead_acute
4537 #ifdef XK_dead_cedilla
4542 #ifdef XK_dead_breve
4547 #ifdef XK_dead_ogonek
4552 #ifdef XK_dead_caron
4557 #ifdef XK_dead_doubleacute
4558 XK_dead_doubleacute
,
4562 #ifdef XK_dead_abovedot
4567 #ifdef XK_dead_abovering
4577 #ifdef XK_dead_belowdot
4582 #ifdef XK_dead_voiced_sound
4583 XK_dead_voiced_sound
,
4587 #ifdef XK_dead_semivoiced_sound
4588 XK_dead_semivoiced_sound
,
4604 /* This is a list of Lisp names for special "accent" characters.
4605 It parallels lispy_accent_codes. */
4607 static const char *const lispy_accent_keys
[] =
4625 "dead-voiced-sound",
4626 "dead-semivoiced-sound",
4632 #define FUNCTION_KEY_OFFSET 0x0
4634 const char *const lispy_function_keys
[] =
4638 0, /* VK_LBUTTON 0x01 */
4639 0, /* VK_RBUTTON 0x02 */
4640 "cancel", /* VK_CANCEL 0x03 */
4641 0, /* VK_MBUTTON 0x04 */
4643 0, 0, 0, /* 0x05 .. 0x07 */
4645 "backspace", /* VK_BACK 0x08 */
4646 "tab", /* VK_TAB 0x09 */
4648 0, 0, /* 0x0A .. 0x0B */
4650 "clear", /* VK_CLEAR 0x0C */
4651 "return", /* VK_RETURN 0x0D */
4653 0, 0, /* 0x0E .. 0x0F */
4655 0, /* VK_SHIFT 0x10 */
4656 0, /* VK_CONTROL 0x11 */
4657 0, /* VK_MENU 0x12 */
4658 "pause", /* VK_PAUSE 0x13 */
4659 "capslock", /* VK_CAPITAL 0x14 */
4660 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4662 "junja", /* VK_JUNJA 0x17 */
4663 "final", /* VK_FINAL 0x18 */
4664 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4666 "escape", /* VK_ESCAPE 0x1B */
4667 "convert", /* VK_CONVERT 0x1C */
4668 "non-convert", /* VK_NONCONVERT 0x1D */
4669 "accept", /* VK_ACCEPT 0x1E */
4670 "mode-change", /* VK_MODECHANGE 0x1F */
4671 0, /* VK_SPACE 0x20 */
4672 "prior", /* VK_PRIOR 0x21 */
4673 "next", /* VK_NEXT 0x22 */
4674 "end", /* VK_END 0x23 */
4675 "home", /* VK_HOME 0x24 */
4676 "left", /* VK_LEFT 0x25 */
4677 "up", /* VK_UP 0x26 */
4678 "right", /* VK_RIGHT 0x27 */
4679 "down", /* VK_DOWN 0x28 */
4680 "select", /* VK_SELECT 0x29 */
4681 "print", /* VK_PRINT 0x2A */
4682 "execute", /* VK_EXECUTE 0x2B */
4683 "snapshot", /* VK_SNAPSHOT 0x2C */
4684 "insert", /* VK_INSERT 0x2D */
4685 "delete", /* VK_DELETE 0x2E */
4686 "help", /* VK_HELP 0x2F */
4688 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4690 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4692 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4694 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4696 0, 0, 0, 0, 0, 0, 0, 0, 0,
4697 0, 0, 0, 0, 0, 0, 0, 0, 0,
4698 0, 0, 0, 0, 0, 0, 0, 0,
4700 "lwindow", /* VK_LWIN 0x5B */
4701 "rwindow", /* VK_RWIN 0x5C */
4702 "apps", /* VK_APPS 0x5D */
4705 "kp-0", /* VK_NUMPAD0 0x60 */
4706 "kp-1", /* VK_NUMPAD1 0x61 */
4707 "kp-2", /* VK_NUMPAD2 0x62 */
4708 "kp-3", /* VK_NUMPAD3 0x63 */
4709 "kp-4", /* VK_NUMPAD4 0x64 */
4710 "kp-5", /* VK_NUMPAD5 0x65 */
4711 "kp-6", /* VK_NUMPAD6 0x66 */
4712 "kp-7", /* VK_NUMPAD7 0x67 */
4713 "kp-8", /* VK_NUMPAD8 0x68 */
4714 "kp-9", /* VK_NUMPAD9 0x69 */
4715 "kp-multiply", /* VK_MULTIPLY 0x6A */
4716 "kp-add", /* VK_ADD 0x6B */
4717 "kp-separator", /* VK_SEPARATOR 0x6C */
4718 "kp-subtract", /* VK_SUBTRACT 0x6D */
4719 "kp-decimal", /* VK_DECIMAL 0x6E */
4720 "kp-divide", /* VK_DIVIDE 0x6F */
4721 "f1", /* VK_F1 0x70 */
4722 "f2", /* VK_F2 0x71 */
4723 "f3", /* VK_F3 0x72 */
4724 "f4", /* VK_F4 0x73 */
4725 "f5", /* VK_F5 0x74 */
4726 "f6", /* VK_F6 0x75 */
4727 "f7", /* VK_F7 0x76 */
4728 "f8", /* VK_F8 0x77 */
4729 "f9", /* VK_F9 0x78 */
4730 "f10", /* VK_F10 0x79 */
4731 "f11", /* VK_F11 0x7A */
4732 "f12", /* VK_F12 0x7B */
4733 "f13", /* VK_F13 0x7C */
4734 "f14", /* VK_F14 0x7D */
4735 "f15", /* VK_F15 0x7E */
4736 "f16", /* VK_F16 0x7F */
4737 "f17", /* VK_F17 0x80 */
4738 "f18", /* VK_F18 0x81 */
4739 "f19", /* VK_F19 0x82 */
4740 "f20", /* VK_F20 0x83 */
4741 "f21", /* VK_F21 0x84 */
4742 "f22", /* VK_F22 0x85 */
4743 "f23", /* VK_F23 0x86 */
4744 "f24", /* VK_F24 0x87 */
4746 0, 0, 0, 0, /* 0x88 .. 0x8B */
4747 0, 0, 0, 0, /* 0x8C .. 0x8F */
4749 "kp-numlock", /* VK_NUMLOCK 0x90 */
4750 "scroll", /* VK_SCROLL 0x91 */
4751 /* Not sure where the following block comes from.
4752 Windows headers have NEC and Fujitsu specific keys in
4753 this block, but nothing generic. */
4754 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4755 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4756 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4757 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4758 "kp-end", /* VK_NUMPAD_END 0x96 */
4759 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4760 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4761 "kp-up", /* VK_NUMPAD_UP 0x99 */
4762 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4763 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4764 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4765 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4767 0, 0, /* 0x9E .. 0x9F */
4770 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4771 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4772 * No other API or message will distinguish left and right keys this way.
4777 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4778 to enable them selectively, and gives access to a few more functions.
4779 See lispy_multimedia_keys below. */
4780 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4781 0, 0, 0, /* 0xAD .. 0xAF Volume */
4782 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4783 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4785 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4786 0, 0, 0, 0, 0, 0, 0, 0, 0,
4788 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4789 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4790 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4793 "ax", /* VK_OEM_AX 0xE1 */
4794 0, /* VK_OEM_102 0xE2 */
4795 "ico-help", /* VK_ICO_HELP 0xE3 */
4796 "ico-00", /* VK_ICO_00 0xE4 */
4797 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4798 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4799 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4801 "reset", /* VK_OEM_RESET 0xE9 */
4802 "jump", /* VK_OEM_JUMP 0xEA */
4803 "oem-pa1", /* VK_OEM_PA1 0xEB */
4804 "oem-pa2", /* VK_OEM_PA2 0xEC */
4805 "oem-pa3", /* VK_OEM_PA3 0xED */
4806 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4807 "cusel", /* VK_OEM_CUSEL 0xEF */
4808 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4809 "finish", /* VK_OEM_FINISH 0xF1 */
4810 "copy", /* VK_OEM_COPY 0xF2 */
4811 "auto", /* VK_OEM_AUTO 0xF3 */
4812 "enlw", /* VK_OEM_ENLW 0xF4 */
4813 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4814 "attn", /* VK_ATTN 0xF6 */
4815 "crsel", /* VK_CRSEL 0xF7 */
4816 "exsel", /* VK_EXSEL 0xF8 */
4817 "ereof", /* VK_EREOF 0xF9 */
4818 "play", /* VK_PLAY 0xFA */
4819 "zoom", /* VK_ZOOM 0xFB */
4820 "noname", /* VK_NONAME 0xFC */
4821 "pa1", /* VK_PA1 0xFD */
4822 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4826 /* Some of these duplicate the "Media keys" on newer keyboards,
4827 but they are delivered to the application in a different way. */
4828 static const char *const lispy_multimedia_keys
[] =
4836 "browser-favorites",
4873 "toggle-dictate-command",
4879 "media-fast-forward",
4882 "media-channel-down"
4885 #else /* not HAVE_NTGUI */
4887 /* This should be dealt with in XTread_socket now, and that doesn't
4888 depend on the client system having the Kana syms defined. See also
4889 the XK_kana_A case below. */
4892 static const char *const lispy_kana_keys
[] =
4894 /* X Keysym value */
4895 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4896 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4897 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4898 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4899 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4900 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4901 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4902 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4903 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4904 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4905 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4906 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4907 "kana-i", "kana-u", "kana-e", "kana-o",
4908 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4909 "prolongedsound", "kana-A", "kana-I", "kana-U",
4910 "kana-E", "kana-O", "kana-KA", "kana-KI",
4911 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4912 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4913 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4914 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4915 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4916 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4917 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4918 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4919 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4920 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4921 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4922 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4924 #endif /* XK_kana_A */
4927 #define FUNCTION_KEY_OFFSET 0xff00
4929 /* You'll notice that this table is arranged to be conveniently
4930 indexed by X Windows keysym values. */
4931 static const char *const lispy_function_keys
[] =
4933 /* X Keysym value */
4935 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4936 "backspace", "tab", "linefeed", "clear",
4938 0, 0, 0, "pause", /* 0xff10...1f */
4939 0, 0, 0, 0, 0, 0, 0, "escape",
4941 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4942 "romaji", "hiragana", "katakana", "hiragana-katakana",
4943 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4944 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4945 "eisu-toggle", /* 0xff30...3f */
4946 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4947 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4949 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4950 "down", "prior", "next", "end",
4951 "begin", 0, 0, 0, 0, 0, 0, 0,
4952 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4963 "break", /* 0xff6b */
4966 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4967 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4968 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4969 0, 0, 0, 0, 0, 0, 0, 0,
4970 "kp-tab", /* 0xff89 */
4972 "kp-enter", /* 0xff8d */
4974 "kp-f1", /* 0xff91 */
4978 "kp-home", /* 0xff95 */
4983 "kp-prior", /* kp-page-up */
4984 "kp-next", /* kp-page-down */
4990 0, 0, 0, 0, 0, 0, 0, 0, 0,
4991 "kp-multiply", /* 0xffaa */
4996 "kp-divide", /* 0xffaf */
4997 "kp-0", /* 0xffb0 */
4998 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5001 "kp-equal", /* 0xffbd */
5002 "f1", /* 0xffbe */ /* IsFunctionKey */
5004 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5005 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5006 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5007 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5008 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5009 0, 0, 0, 0, 0, 0, 0, 0,
5010 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5011 0, 0, 0, 0, 0, 0, 0, "delete"
5014 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5015 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5017 static const char *const iso_lispy_function_keys
[] =
5019 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5020 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5021 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5022 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5023 "iso-lefttab", /* 0xfe20 */
5024 "iso-move-line-up", "iso-move-line-down",
5025 "iso-partial-line-up", "iso-partial-line-down",
5026 "iso-partial-space-left", "iso-partial-space-right",
5027 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5028 "iso-release-margin-left", "iso-release-margin-right",
5029 "iso-release-both-margins",
5030 "iso-fast-cursor-left", "iso-fast-cursor-right",
5031 "iso-fast-cursor-up", "iso-fast-cursor-down",
5032 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5033 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5036 #endif /* not HAVE_NTGUI */
5038 static Lisp_Object Vlispy_mouse_stem
;
5040 static const char *const lispy_wheel_names
[] =
5042 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5045 /* drag-n-drop events are generated when a set of selected files are
5046 dragged from another application and dropped onto an Emacs window. */
5047 static const char *const lispy_drag_n_drop_names
[] =
5052 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5053 scroll_bar_part value. Note that Qnil corresponds to
5054 scroll_bar_nowhere and should not appear in Lisp events. */
5055 static short const scroll_bar_parts
[] = {
5056 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5057 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5058 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5059 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5060 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5061 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5062 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5065 /* A vector, indexed by button number, giving the down-going location
5066 of currently depressed buttons, both scroll bar and non-scroll bar.
5068 The elements have the form
5069 (BUTTON-NUMBER MODIFIER-MASK . REST)
5070 where REST is the cdr of a position as it would be reported in the event.
5072 The make_lispy_event function stores positions here to tell the
5073 difference between click and drag events, and to store the starting
5074 location to be included in drag events. */
5076 static Lisp_Object button_down_location
;
5078 /* Information about the most recent up-going button event: Which
5079 button, what location, and what time. */
5081 static int last_mouse_button
;
5082 static int last_mouse_x
;
5083 static int last_mouse_y
;
5084 static Time button_down_time
;
5086 /* The number of clicks in this multiple-click. */
5088 static int double_click_count
;
5090 /* X and Y are frame-relative coordinates for a click or wheel event.
5091 Return a Lisp-style event list. */
5094 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5097 enum window_part part
;
5098 Lisp_Object posn
= Qnil
;
5099 Lisp_Object extra_info
= Qnil
;
5100 /* Coordinate pixel positions to return. */
5101 int xret
= 0, yret
= 0;
5102 /* The window under frame pixel coordinates (x,y) */
5103 Lisp_Object window
= f
5104 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5107 if (WINDOWP (window
))
5109 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5110 struct window
*w
= XWINDOW (window
);
5111 Lisp_Object string_info
= Qnil
;
5112 ptrdiff_t textpos
= 0;
5113 int col
= -1, row
= -1;
5114 int dx
= -1, dy
= -1;
5115 int width
= -1, height
= -1;
5116 Lisp_Object object
= Qnil
;
5118 /* Pixel coordinates relative to the window corner. */
5119 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5120 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5122 /* For text area clicks, return X, Y relative to the corner of
5123 this text area. Note that dX, dY etc are set below, by
5124 buffer_posn_from_coords. */
5125 if (part
== ON_TEXT
)
5127 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5128 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5130 /* For mode line and header line clicks, return X, Y relative to
5131 the left window edge. Use mode_line_string to look for a
5132 string on the click position. */
5133 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5138 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5139 /* Note that mode_line_string takes COL, ROW as pixels and
5140 converts them to characters. */
5143 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5144 &object
, &dx
, &dy
, &width
, &height
);
5145 if (STRINGP (string
))
5146 string_info
= Fcons (string
, make_number (charpos
));
5152 /* For fringes and margins, Y is relative to the area's (and the
5153 window's) top edge, while X is meaningless. */
5154 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5159 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5162 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5163 &object
, &dx
, &dy
, &width
, &height
);
5164 if (STRINGP (string
))
5165 string_info
= Fcons (string
, make_number (charpos
));
5167 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5169 else if (part
== ON_LEFT_FRINGE
)
5171 posn
= Qleft_fringe
;
5175 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5176 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5177 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5179 else if (part
== ON_RIGHT_FRINGE
)
5181 posn
= Qright_fringe
;
5185 - window_box_width (w
, LEFT_MARGIN_AREA
)
5186 - window_box_width (w
, TEXT_AREA
)
5187 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5188 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5190 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5192 else if (part
== ON_VERTICAL_BORDER
)
5194 posn
= Qvertical_line
;
5200 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5202 posn
= Qvertical_scroll_bar
;
5203 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5207 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5209 posn
= Qhorizontal_scroll_bar
;
5210 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5214 else if (part
== ON_RIGHT_DIVIDER
)
5216 posn
= Qright_divider
;
5217 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5221 else if (part
== ON_BOTTOM_DIVIDER
)
5223 posn
= Qbottom_divider
;
5224 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5229 /* For clicks in the text area, fringes, margins, or vertical
5230 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5231 the buffer position nearest to the click. */
5234 Lisp_Object string2
, object2
= Qnil
;
5235 struct display_pos p
;
5237 int width2
, height2
;
5238 /* The pixel X coordinate passed to buffer_posn_from_coords
5239 is the X coordinate relative to the text area for clicks
5240 in text-area, right-margin/fringe and right-side vertical
5241 scroll bar, zero otherwise. */
5243 = (part
== ON_TEXT
) ? xret
5244 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5245 || (part
== ON_VERTICAL_SCROLL_BAR
5246 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5247 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5251 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5252 &object2
, &dx2
, &dy2
,
5254 textpos
= CHARPOS (p
.pos
);
5255 if (col
< 0) col
= x2
;
5256 if (row
< 0) row
= y2
;
5257 if (dx
< 0) dx
= dx2
;
5258 if (dy
< 0) dy
= dy2
;
5259 if (width
< 0) width
= width2
;
5260 if (height
< 0) height
= height2
;
5264 posn
= make_number (textpos
);
5265 if (STRINGP (string2
))
5266 string_info
= Fcons (string2
,
5267 make_number (CHARPOS (p
.string_pos
)));
5273 #ifdef HAVE_WINDOW_SYSTEM
5274 if (IMAGEP (object
))
5276 Lisp_Object image_map
, hotspot
;
5277 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5279 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5281 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5282 posn
= XCAR (hotspot
);
5289 Fcons (make_number (dx
), make_number (dy
)),
5290 Fcons (make_number (width
), make_number (height
)));
5293 extra_info
= Fcons (string_info
,
5294 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5295 Fcons (Fcons (make_number (col
),
5301 /* Return mouse pixel coordinates here. */
5302 XSETFRAME (window
, f
);
5309 return Fcons (window
,
5311 Fcons (Fcons (make_number (xret
),
5312 make_number (yret
)),
5313 Fcons (make_number (t
),
5317 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5318 menu bar. This really means that Emacs draws and manages the menu
5319 bar as part of its normal display, and therefore can compute its
5322 toolkit_menubar_in_use (struct frame
*f
)
5324 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5325 return !(!FRAME_WINDOW_P (f
));
5331 /* Build the part of Lisp event which represents scroll bar state from
5332 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5335 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5337 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5338 make_number (ev
->timestamp
),
5339 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5342 /* Given a struct input_event, build the lisp event which represents
5343 it. If EVENT is 0, build a mouse movement event from the mouse
5344 movement buffer, which should have a movement event in it.
5346 Note that events must be passed to this function in the order they
5347 are received; this function stores the location of button presses
5348 in order to build drag events when the button is released. */
5351 make_lispy_event (struct input_event
*event
)
5355 switch (event
->kind
)
5357 /* A simple keystroke. */
5358 case ASCII_KEYSTROKE_EVENT
:
5359 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5361 Lisp_Object lispy_c
;
5362 EMACS_INT c
= event
->code
;
5363 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5366 eassert (c
== event
->code
);
5367 /* Turn ASCII characters into control characters
5369 if (event
->modifiers
& ctrl_modifier
)
5371 c
= make_ctrl_char (c
);
5372 event
->modifiers
&= ~ctrl_modifier
;
5376 /* Add in the other modifier bits. The shift key was taken care
5377 of by the X code. */
5378 c
|= (event
->modifiers
5379 & (meta_modifier
| alt_modifier
5380 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5381 /* Distinguish Shift-SPC from SPC. */
5382 if ((event
->code
) == 040
5383 && event
->modifiers
& shift_modifier
)
5384 c
|= shift_modifier
;
5385 button_down_time
= 0;
5386 XSETFASTINT (lispy_c
, c
);
5391 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5392 except that they are non-key events (last-nonmenu-event is nil). */
5393 case NS_NONKEY_EVENT
:
5396 /* A function key. The symbol may need to have modifier prefixes
5398 case NON_ASCII_KEYSTROKE_EVENT
:
5399 button_down_time
= 0;
5401 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5402 if (event
->code
== lispy_accent_codes
[i
])
5403 return modify_event_symbol (i
,
5405 Qfunction_key
, Qnil
,
5406 lispy_accent_keys
, &accent_key_syms
,
5407 ARRAYELTS (lispy_accent_keys
));
5411 if (event
->code
>= 0x400 && event
->code
< 0x500)
5412 return modify_event_symbol (event
->code
- 0x400,
5413 event
->modifiers
& ~shift_modifier
,
5414 Qfunction_key
, Qnil
,
5415 lispy_kana_keys
, &func_key_syms
,
5416 ARRAYELTS (lispy_kana_keys
));
5417 #endif /* XK_kana_A */
5420 #ifdef ISO_FUNCTION_KEY_OFFSET
5421 if (event
->code
< FUNCTION_KEY_OFFSET
5422 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5423 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5425 Qfunction_key
, Qnil
,
5426 iso_lispy_function_keys
, &func_key_syms
,
5427 ARRAYELTS (iso_lispy_function_keys
));
5430 if ((FUNCTION_KEY_OFFSET
<= event
->code
5432 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5433 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5434 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5436 Qfunction_key
, Qnil
,
5437 lispy_function_keys
, &func_key_syms
,
5438 ARRAYELTS (lispy_function_keys
));
5440 /* Handle system-specific or unknown keysyms.
5441 We need to use an alist rather than a vector as the cache
5442 since we can't make a vector long enough. */
5443 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5444 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5445 return modify_event_symbol (event
->code
,
5448 KVAR (current_kboard
, Vsystem_key_alist
),
5449 0, &KVAR (current_kboard
, system_key_syms
),
5453 case MULTIMEDIA_KEY_EVENT
:
5454 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5455 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5457 return modify_event_symbol (event
->code
, event
->modifiers
,
5458 Qfunction_key
, Qnil
,
5459 lispy_multimedia_keys
, &func_key_syms
,
5460 ARRAYELTS (lispy_multimedia_keys
));
5465 /* A mouse click. Figure out where it is, decide whether it's
5466 a press, click or drag, and build the appropriate structure. */
5467 case MOUSE_CLICK_EVENT
:
5469 case GPM_CLICK_EVENT
:
5471 #ifndef USE_TOOLKIT_SCROLL_BARS
5472 case SCROLL_BAR_CLICK_EVENT
:
5473 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5476 int button
= event
->code
;
5478 Lisp_Object position
;
5479 Lisp_Object
*start_pos_ptr
;
5480 Lisp_Object start_pos
;
5484 /* Build the position as appropriate for this mouse click. */
5485 if (event
->kind
== MOUSE_CLICK_EVENT
5487 || event
->kind
== GPM_CLICK_EVENT
5491 struct frame
*f
= XFRAME (event
->frame_or_window
);
5494 /* Ignore mouse events that were made on frame that
5495 have been deleted. */
5496 if (! FRAME_LIVE_P (f
))
5499 /* EVENT->x and EVENT->y are frame-relative pixel
5500 coordinates at this place. Under old redisplay, COLUMN
5501 and ROW are set to frame relative glyph coordinates
5502 which are then used to determine whether this click is
5503 in a menu (non-toolkit version). */
5504 if (!toolkit_menubar_in_use (f
))
5506 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5507 &column
, &row
, NULL
, 1);
5509 /* In the non-toolkit version, clicks on the menu bar
5510 are ordinary button events in the event buffer.
5511 Distinguish them, and invoke the menu.
5513 (In the toolkit version, the toolkit handles the
5514 menu bar and Emacs doesn't know about it until
5515 after the user makes a selection.) */
5516 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5517 && (event
->modifiers
& down_modifier
))
5519 Lisp_Object items
, item
;
5521 /* Find the menu bar item under `column'. */
5523 items
= FRAME_MENU_BAR_ITEMS (f
);
5524 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5526 Lisp_Object pos
, string
;
5527 string
= AREF (items
, i
+ 1);
5528 pos
= AREF (items
, i
+ 3);
5531 if (column
>= XINT (pos
)
5532 && column
< XINT (pos
) + SCHARS (string
))
5534 item
= AREF (items
, i
);
5539 /* ELisp manual 2.4b says (x y) are window
5540 relative but code says they are
5542 position
= list4 (event
->frame_or_window
,
5544 Fcons (event
->x
, event
->y
),
5545 make_number (event
->timestamp
));
5547 return list2 (item
, position
);
5551 position
= make_lispy_position (f
, event
->x
, event
->y
,
5554 #ifndef USE_TOOLKIT_SCROLL_BARS
5556 /* It's a scrollbar click. */
5557 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5558 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5560 if (button
>= ASIZE (button_down_location
))
5562 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5563 button_down_location
= larger_vector (button_down_location
,
5565 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5568 start_pos_ptr
= aref_addr (button_down_location
, button
);
5569 start_pos
= *start_pos_ptr
;
5570 *start_pos_ptr
= Qnil
;
5573 /* On window-system frames, use the value of
5574 double-click-fuzz as is. On other frames, interpret it
5575 as a multiple of 1/8 characters. */
5579 if (WINDOWP (event
->frame_or_window
))
5580 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5581 else if (FRAMEP (event
->frame_or_window
))
5582 f
= XFRAME (event
->frame_or_window
);
5586 if (FRAME_WINDOW_P (f
))
5587 fuzz
= double_click_fuzz
;
5589 fuzz
= double_click_fuzz
/ 8;
5591 is_double
= (button
== last_mouse_button
5592 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5593 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5594 && button_down_time
!= 0
5595 && (EQ (Vdouble_click_time
, Qt
)
5596 || (NATNUMP (Vdouble_click_time
)
5597 && (event
->timestamp
- button_down_time
5598 < XFASTINT (Vdouble_click_time
)))));
5601 last_mouse_button
= button
;
5602 last_mouse_x
= XINT (event
->x
);
5603 last_mouse_y
= XINT (event
->y
);
5605 /* If this is a button press, squirrel away the location, so
5606 we can decide later whether it was a click or a drag. */
5607 if (event
->modifiers
& down_modifier
)
5611 double_click_count
++;
5612 event
->modifiers
|= ((double_click_count
> 2)
5617 double_click_count
= 1;
5618 button_down_time
= event
->timestamp
;
5619 *start_pos_ptr
= Fcopy_alist (position
);
5620 ignore_mouse_drag_p
= 0;
5623 /* Now we're releasing a button - check the co-ordinates to
5624 see if this was a click or a drag. */
5625 else if (event
->modifiers
& up_modifier
)
5627 /* If we did not see a down before this up, ignore the up.
5628 Probably this happened because the down event chose a
5629 menu item. It would be an annoyance to treat the
5630 release of the button that chose the menu item as a
5633 if (!CONSP (start_pos
))
5636 event
->modifiers
&= ~up_modifier
;
5639 Lisp_Object new_down
, down
;
5640 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5642 /* The third element of every position
5643 should be the (x,y) pair. */
5644 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5645 new_down
= Fcar (Fcdr (Fcdr (position
)));
5648 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5650 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5651 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5654 if (ignore_mouse_drag_p
)
5656 event
->modifiers
|= click_modifier
;
5657 ignore_mouse_drag_p
= 0;
5659 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5660 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5661 /* Maybe the mouse has moved a lot, caused scrolling, and
5662 eventually ended up at the same screen position (but
5663 not buffer position) in which case it is a drag, not
5665 /* FIXME: OTOH if the buffer position has changed
5666 because of a timer or process filter rather than
5667 because of mouse movement, it should be considered as
5668 a click. But mouse-drag-region completely ignores
5669 this case and it hasn't caused any real problem, so
5670 it's probably OK to ignore it as well. */
5671 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5672 /* Mouse hasn't moved (much). */
5673 event
->modifiers
|= click_modifier
;
5676 button_down_time
= 0;
5677 event
->modifiers
|= drag_modifier
;
5680 /* Don't check is_double; treat this as multiple
5681 if the down-event was multiple. */
5682 if (double_click_count
> 1)
5683 event
->modifiers
|= ((double_click_count
> 2)
5689 /* Every mouse event should either have the down_modifier or
5690 the up_modifier set. */
5694 /* Get the symbol we should use for the mouse click. */
5697 head
= modify_event_symbol (button
,
5699 Qmouse_click
, Vlispy_mouse_stem
,
5702 ASIZE (mouse_syms
));
5703 if (event
->modifiers
& drag_modifier
)
5704 return list3 (head
, start_pos
, position
);
5705 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5706 return list3 (head
, position
, make_number (double_click_count
));
5708 return list2 (head
, position
);
5713 case HORIZ_WHEEL_EVENT
:
5715 Lisp_Object position
;
5718 /* Build the position as appropriate for this mouse click. */
5719 struct frame
*f
= XFRAME (event
->frame_or_window
);
5721 /* Ignore wheel events that were made on frame that have been
5723 if (! FRAME_LIVE_P (f
))
5726 position
= make_lispy_position (f
, event
->x
, event
->y
,
5729 /* Set double or triple modifiers to indicate the wheel speed. */
5731 /* On window-system frames, use the value of
5732 double-click-fuzz as is. On other frames, interpret it
5733 as a multiple of 1/8 characters. */
5739 if (WINDOWP (event
->frame_or_window
))
5740 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5741 else if (FRAMEP (event
->frame_or_window
))
5742 fr
= XFRAME (event
->frame_or_window
);
5746 fuzz
= FRAME_WINDOW_P (fr
)
5747 ? double_click_fuzz
: double_click_fuzz
/ 8;
5749 if (event
->modifiers
& up_modifier
)
5751 /* Emit a wheel-up event. */
5752 event
->modifiers
&= ~up_modifier
;
5755 else if (event
->modifiers
& down_modifier
)
5757 /* Emit a wheel-down event. */
5758 event
->modifiers
&= ~down_modifier
;
5762 /* Every wheel event should either have the down_modifier or
5763 the up_modifier set. */
5766 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5769 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5770 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5771 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5772 && button_down_time
!= 0
5773 && (EQ (Vdouble_click_time
, Qt
)
5774 || (NATNUMP (Vdouble_click_time
)
5775 && (event
->timestamp
- button_down_time
5776 < XFASTINT (Vdouble_click_time
)))));
5779 double_click_count
++;
5780 event
->modifiers
|= ((double_click_count
> 2)
5786 double_click_count
= 1;
5787 event
->modifiers
|= click_modifier
;
5790 button_down_time
= event
->timestamp
;
5791 /* Use a negative value to distinguish wheel from mouse button. */
5792 last_mouse_button
= - (1 + symbol_num
);
5793 last_mouse_x
= XINT (event
->x
);
5794 last_mouse_y
= XINT (event
->y
);
5796 /* Get the symbol we should use for the wheel event. */
5797 head
= modify_event_symbol (symbol_num
,
5803 ASIZE (wheel_syms
));
5806 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5807 return list3 (head
, position
, make_number (double_click_count
));
5809 return list2 (head
, position
);
5813 #ifdef USE_TOOLKIT_SCROLL_BARS
5815 /* We don't have down and up events if using toolkit scroll bars,
5816 so make this always a click event. Store in the `part' of
5817 the Lisp event a symbol which maps to the following actions:
5819 `above_handle' page up
5820 `below_handle' page down
5824 `bottom' bottom of buffer
5825 `handle' thumb has been dragged.
5826 `end-scroll' end of interaction with scroll bar
5828 The incoming input_event contains in its `part' member an
5829 index of type `enum scroll_bar_part' which we can use as an
5830 index in scroll_bar_parts to get the appropriate symbol. */
5832 case SCROLL_BAR_CLICK_EVENT
:
5834 Lisp_Object position
, head
;
5836 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5838 /* Always treat scroll bar events as clicks. */
5839 event
->modifiers
|= click_modifier
;
5840 event
->modifiers
&= ~up_modifier
;
5842 if (event
->code
>= ASIZE (mouse_syms
))
5843 mouse_syms
= larger_vector (mouse_syms
,
5844 event
->code
- ASIZE (mouse_syms
) + 1,
5847 /* Get the symbol we should use for the mouse click. */
5848 head
= modify_event_symbol (event
->code
,
5853 ASIZE (mouse_syms
));
5854 return list2 (head
, position
);
5857 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5859 Lisp_Object position
, head
;
5861 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5863 /* Always treat scroll bar events as clicks. */
5864 event
->modifiers
|= click_modifier
;
5865 event
->modifiers
&= ~up_modifier
;
5867 if (event
->code
>= ASIZE (mouse_syms
))
5868 mouse_syms
= larger_vector (mouse_syms
,
5869 event
->code
- ASIZE (mouse_syms
) + 1,
5872 /* Get the symbol we should use for the mouse click. */
5873 head
= modify_event_symbol (event
->code
,
5878 ASIZE (mouse_syms
));
5879 return list2 (head
, position
);
5882 #endif /* USE_TOOLKIT_SCROLL_BARS */
5884 case DRAG_N_DROP_EVENT
:
5887 Lisp_Object head
, position
;
5890 f
= XFRAME (event
->frame_or_window
);
5893 /* Ignore mouse events that were made on frames that
5894 have been deleted. */
5895 if (! FRAME_LIVE_P (f
))
5898 position
= make_lispy_position (f
, event
->x
, event
->y
,
5901 head
= modify_event_symbol (0, event
->modifiers
,
5903 lispy_drag_n_drop_names
,
5904 &drag_n_drop_syms
, 1);
5905 return list3 (head
, position
, files
);
5908 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5909 || defined (HAVE_NS) || defined (USE_GTK)
5910 case MENU_BAR_EVENT
:
5911 if (EQ (event
->arg
, event
->frame_or_window
))
5912 /* This is the prefix key. We translate this to
5913 `(menu_bar)' because the code in keyboard.c for menu
5914 events, which we use, relies on this. */
5915 return list1 (Qmenu_bar
);
5919 case SELECT_WINDOW_EVENT
:
5920 /* Make an event (select-window (WINDOW)). */
5921 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5923 case TOOL_BAR_EVENT
:
5924 if (EQ (event
->arg
, event
->frame_or_window
))
5925 /* This is the prefix key. We translate this to
5926 `(tool_bar)' because the code in keyboard.c for tool bar
5927 events, which we use, relies on this. */
5928 return list1 (Qtool_bar
);
5929 else if (SYMBOLP (event
->arg
))
5930 return apply_modifiers (event
->modifiers
, event
->arg
);
5933 case USER_SIGNAL_EVENT
:
5934 /* A user signal. */
5936 char *name
= find_user_signal_name (event
->code
);
5939 return intern (name
);
5942 case SAVE_SESSION_EVENT
:
5943 return Qsave_session
;
5948 return Fcons (Qdbus_event
, event
->arg
);
5950 #endif /* HAVE_DBUS */
5952 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
5953 case FILE_NOTIFY_EVENT
:
5955 return Fcons (Qfile_notify
, event
->arg
);
5957 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
5959 case CONFIG_CHANGED_EVENT
:
5960 return list3 (Qconfig_changed_event
,
5961 event
->arg
, event
->frame_or_window
);
5963 /* The 'kind' field of the event is something we don't recognize. */
5970 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5971 Lisp_Object x
, Lisp_Object y
, Time t
)
5973 /* Is it a scroll bar movement? */
5974 if (frame
&& ! NILP (bar_window
))
5976 Lisp_Object part_sym
;
5978 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
5979 return list2 (Qscroll_bar_movement
,
5981 Qvertical_scroll_bar
,
5986 /* Or is it an ordinary mouse movement? */
5989 Lisp_Object position
;
5990 position
= make_lispy_position (frame
, x
, y
, t
);
5991 return list2 (Qmouse_movement
, position
);
5995 /* Construct a switch frame event. */
5997 make_lispy_switch_frame (Lisp_Object frame
)
5999 return list2 (Qswitch_frame
, frame
);
6003 make_lispy_focus_in (Lisp_Object frame
)
6005 return list2 (Qfocus_in
, frame
);
6008 #ifdef HAVE_WINDOW_SYSTEM
6011 make_lispy_focus_out (Lisp_Object frame
)
6013 return list2 (Qfocus_out
, frame
);
6016 #endif /* HAVE_WINDOW_SYSTEM */
6018 /* Manipulating modifiers. */
6020 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6022 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6023 SYMBOL's name of the end of the modifiers; the string from this
6024 position is the unmodified symbol name.
6026 This doesn't use any caches. */
6029 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6035 CHECK_SYMBOL (symbol
);
6038 name
= SYMBOL_NAME (symbol
);
6040 for (i
= 0; i
< SBYTES (name
) - 1; )
6042 ptrdiff_t this_mod_end
= 0;
6045 /* See if the name continues with a modifier word.
6046 Check that the word appears, but don't check what follows it.
6047 Set this_mod and this_mod_end to record what we find. */
6049 switch (SREF (name
, i
))
6051 #define SINGLE_LETTER_MOD(BIT) \
6052 (this_mod_end = i + 1, this_mod = BIT)
6055 SINGLE_LETTER_MOD (alt_modifier
);
6059 SINGLE_LETTER_MOD (ctrl_modifier
);
6063 SINGLE_LETTER_MOD (hyper_modifier
);
6067 SINGLE_LETTER_MOD (meta_modifier
);
6071 SINGLE_LETTER_MOD (shift_modifier
);
6075 SINGLE_LETTER_MOD (super_modifier
);
6078 #undef SINGLE_LETTER_MOD
6080 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6081 if (i + LEN + 1 <= SBYTES (name) \
6082 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6084 this_mod_end = i + LEN; \
6089 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6090 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6091 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6095 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6099 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6101 #undef MULTI_LETTER_MOD
6105 /* If we found no modifier, stop looking for them. */
6106 if (this_mod_end
== 0)
6109 /* Check there is a dash after the modifier, so that it
6110 really is a modifier. */
6111 if (this_mod_end
>= SBYTES (name
)
6112 || SREF (name
, this_mod_end
) != '-')
6115 /* This modifier is real; look for another. */
6116 modifiers
|= this_mod
;
6117 i
= this_mod_end
+ 1;
6120 /* Should we include the `click' modifier? */
6121 if (! (modifiers
& (down_modifier
| drag_modifier
6122 | double_modifier
| triple_modifier
))
6123 && i
+ 7 == SBYTES (name
)
6124 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6125 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6126 modifiers
|= click_modifier
;
6128 if (! (modifiers
& (double_modifier
| triple_modifier
))
6129 && i
+ 6 < SBYTES (name
)
6130 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6131 modifiers
|= click_modifier
;
6139 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6140 prepended to the string BASE[0..BASE_LEN-1].
6141 This doesn't use any caches. */
6143 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6145 /* Since BASE could contain nulls, we can't use intern here; we have
6146 to use Fintern, which expects a genuine Lisp_String, and keeps a
6148 char new_mods
[sizeof "A-C-H-M-S-s-up-down-drag-double-triple-"];
6154 /* Mouse events should not exhibit the `up' modifier once they
6155 leave the event queue only accessible to C code; `up' will
6156 always be turned into a click or drag event before being
6157 presented to lisp code. But since lisp events can be
6158 synthesized bypassing the event queue and pushed into
6159 `unread-command-events' or its companions, it's better to just
6160 deal with unexpected modifier combinations. */
6162 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6163 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6164 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6165 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6166 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6167 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6168 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6169 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6170 if (modifiers
& up_modifier
) p
= stpcpy (p
, "up-");
6171 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6172 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6173 /* The click modifier is denoted by the absence of other modifiers. */
6177 mod_len
= p
- new_mods
;
6181 Lisp_Object new_name
;
6183 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6184 mod_len
+ base_len_byte
);
6185 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6186 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6188 return Fintern (new_name
, Qnil
);
6193 static const char *const modifier_names
[] =
6195 "up", "down", "drag", "click", "double", "triple", 0, 0,
6196 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6197 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6199 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6201 static Lisp_Object modifier_symbols
;
6203 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6205 lispy_modifier_list (int modifiers
)
6207 Lisp_Object modifier_list
;
6210 modifier_list
= Qnil
;
6211 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6212 if (modifiers
& (1<<i
))
6213 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6216 return modifier_list
;
6220 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6221 where UNMODIFIED is the unmodified form of SYMBOL,
6222 MASK is the set of modifiers present in SYMBOL's name.
6223 This is similar to parse_modifiers_uncached, but uses the cache in
6224 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6225 Qevent_symbol_elements property. */
6227 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6230 parse_modifiers (Lisp_Object symbol
)
6232 Lisp_Object elements
;
6234 if (INTEGERP (symbol
))
6235 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6236 else if (!SYMBOLP (symbol
))
6239 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6240 if (CONSP (elements
))
6245 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6246 Lisp_Object unmodified
;
6249 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6250 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6253 if (modifiers
& ~INTMASK
)
6255 XSETFASTINT (mask
, modifiers
);
6256 elements
= list2 (unmodified
, mask
);
6258 /* Cache the parsing results on SYMBOL. */
6259 Fput (symbol
, Qevent_symbol_element_mask
,
6261 Fput (symbol
, Qevent_symbol_elements
,
6262 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6264 /* Since we know that SYMBOL is modifiers applied to unmodified,
6265 it would be nice to put that in unmodified's cache.
6266 But we can't, since we're not sure that parse_modifiers is
6273 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6274 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6275 doc
: /* Parse the event symbol. For internal use. */)
6276 (Lisp_Object symbol
)
6278 /* Fill the cache if needed. */
6279 parse_modifiers (symbol
);
6280 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6281 and use the Lispier representation stored on Qevent_symbol_elements
6283 return Fget (symbol
, Qevent_symbol_elements
);
6286 /* Apply the modifiers MODIFIERS to the symbol BASE.
6287 BASE must be unmodified.
6289 This is like apply_modifiers_uncached, but uses BASE's
6290 Qmodifier_cache property, if present.
6292 apply_modifiers copies the value of BASE's Qevent_kind property to
6293 the modified symbol. */
6295 apply_modifiers (int modifiers
, Lisp_Object base
)
6297 Lisp_Object cache
, idx
, entry
, new_symbol
;
6299 /* Mask out upper bits. We don't know where this value's been. */
6300 modifiers
&= INTMASK
;
6302 if (INTEGERP (base
))
6303 return make_number (XINT (base
) | modifiers
);
6305 /* The click modifier never figures into cache indices. */
6306 cache
= Fget (base
, Qmodifier_cache
);
6307 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6308 entry
= assq_no_quit (idx
, cache
);
6311 new_symbol
= XCDR (entry
);
6314 /* We have to create the symbol ourselves. */
6315 new_symbol
= apply_modifiers_uncached (modifiers
,
6316 SSDATA (SYMBOL_NAME (base
)),
6317 SCHARS (SYMBOL_NAME (base
)),
6318 SBYTES (SYMBOL_NAME (base
)));
6320 /* Add the new symbol to the base's cache. */
6321 entry
= Fcons (idx
, new_symbol
);
6322 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6324 /* We have the parsing info now for free, so we could add it to
6326 XSETFASTINT (idx, modifiers);
6327 Fput (new_symbol, Qevent_symbol_element_mask,
6329 Fput (new_symbol, Qevent_symbol_elements,
6330 Fcons (base, lispy_modifier_list (modifiers)));
6331 Sadly, this is only correct if `base' is indeed a base event,
6332 which is not necessarily the case. -stef */
6335 /* Make sure this symbol is of the same kind as BASE.
6337 You'd think we could just set this once and for all when we
6338 intern the symbol above, but reorder_modifiers may call us when
6339 BASE's property isn't set right; we can't assume that just
6340 because it has a Qmodifier_cache property it must have its
6341 Qevent_kind set right as well. */
6342 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6346 kind
= Fget (base
, Qevent_kind
);
6348 Fput (new_symbol
, Qevent_kind
, kind
);
6355 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6356 return a symbol with the modifiers placed in the canonical order.
6357 Canonical order is alphabetical, except for down and drag, which
6358 always come last. The 'click' modifier is never written out.
6360 Fdefine_key calls this to make sure that (for example) C-M-foo
6361 and M-C-foo end up being equivalent in the keymap. */
6364 reorder_modifiers (Lisp_Object symbol
)
6366 /* It's hopefully okay to write the code this way, since everything
6367 will soon be in caches, and no consing will be done at all. */
6370 parsed
= parse_modifiers (symbol
);
6371 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6376 /* For handling events, we often want to produce a symbol whose name
6377 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6378 to some base, like the name of a function key or mouse button.
6379 modify_event_symbol produces symbols of this sort.
6381 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6382 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6385 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6386 into symbol names, or a string specifying a name stem used to
6387 construct a symbol name or the form `STEM-N', where N is the decimal
6388 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6389 non-nil; otherwise NAME_TABLE is used.
6391 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6392 persist between calls to modify_event_symbol that it can use to
6393 store a cache of the symbols it's generated for this NAME_TABLE
6394 before. The object stored there may be a vector or an alist.
6396 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6398 MODIFIERS is a set of modifier bits (as given in struct input_events)
6399 whose prefixes should be applied to the symbol name.
6401 SYMBOL_KIND is the value to be placed in the event_kind property of
6402 the returned symbol.
6404 The symbols we create are supposed to have an
6405 `event-symbol-elements' property, which lists the modifiers present
6406 in the symbol's name. */
6409 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6410 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6411 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6414 Lisp_Object symbol_int
;
6416 /* Get rid of the "vendor-specific" bit here. */
6417 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6419 /* Is this a request for a valid symbol? */
6420 if (symbol_num
< 0 || symbol_num
>= table_size
)
6423 if (CONSP (*symbol_table
))
6424 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6426 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6427 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6428 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6429 we've never used that symbol before. */
6432 if (! VECTORP (*symbol_table
)
6433 || ASIZE (*symbol_table
) != table_size
)
6437 XSETFASTINT (size
, table_size
);
6438 *symbol_table
= Fmake_vector (size
, Qnil
);
6441 value
= AREF (*symbol_table
, symbol_num
);
6444 /* Have we already used this symbol before? */
6447 /* No; let's create it. */
6448 if (CONSP (name_alist_or_stem
))
6449 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6450 else if (STRINGP (name_alist_or_stem
))
6453 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6454 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6456 buf
= SAFE_ALLOCA (len
);
6457 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6458 XINT (symbol_int
) + 1);
6459 value
= intern (buf
);
6462 else if (name_table
!= 0 && name_table
[symbol_num
])
6463 value
= intern (name_table
[symbol_num
]);
6465 #ifdef HAVE_WINDOW_SYSTEM
6468 char *name
= x_get_keysym_name (symbol_num
);
6470 value
= intern (name
);
6476 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6477 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6478 value
= intern (buf
);
6481 if (CONSP (*symbol_table
))
6482 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6484 ASET (*symbol_table
, symbol_num
, value
);
6486 /* Fill in the cache entries for this symbol; this also
6487 builds the Qevent_symbol_elements property, which the user
6489 apply_modifiers (modifiers
& click_modifier
, value
);
6490 Fput (value
, Qevent_kind
, symbol_kind
);
6493 /* Apply modifiers to that symbol. */
6494 return apply_modifiers (modifiers
, value
);
6497 /* Convert a list that represents an event type,
6498 such as (ctrl meta backspace), into the usual representation of that
6499 event type as a number or a symbol. */
6501 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6502 doc
: /* Convert the event description list EVENT-DESC to an event type.
6503 EVENT-DESC should contain one base event type (a character or symbol)
6504 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6505 drag, down, double or triple). The base must be last.
6506 The return value is an event type (a character or symbol) which
6507 has the same base event type and all the specified modifiers. */)
6508 (Lisp_Object event_desc
)
6516 while (CONSP (rest
))
6524 /* Given a symbol, see if it is a modifier name. */
6525 if (SYMBOLP (elt
) && CONSP (rest
))
6526 this = parse_solitary_modifier (elt
);
6530 else if (!NILP (base
))
6531 error ("Two bases given in one event");
6537 /* Let the symbol A refer to the character A. */
6538 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6539 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6541 if (INTEGERP (base
))
6543 /* Turn (shift a) into A. */
6544 if ((modifiers
& shift_modifier
) != 0
6545 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6547 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6548 modifiers
&= ~shift_modifier
;
6551 /* Turn (control a) into C-a. */
6552 if (modifiers
& ctrl_modifier
)
6553 return make_number ((modifiers
& ~ctrl_modifier
)
6554 | make_ctrl_char (XINT (base
)));
6556 return make_number (modifiers
| XINT (base
));
6558 else if (SYMBOLP (base
))
6559 return apply_modifiers (modifiers
, base
);
6561 error ("Invalid base event");
6564 /* Try to recognize SYMBOL as a modifier name.
6565 Return the modifier flag bit, or 0 if not recognized. */
6568 parse_solitary_modifier (Lisp_Object symbol
)
6570 Lisp_Object name
= SYMBOL_NAME (symbol
);
6572 switch (SREF (name
, 0))
6574 #define SINGLE_LETTER_MOD(BIT) \
6575 if (SBYTES (name) == 1) \
6578 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6579 if (LEN == SBYTES (name) \
6580 && ! memcmp (SDATA (name), NAME, LEN)) \
6584 SINGLE_LETTER_MOD (alt_modifier
);
6588 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6592 SINGLE_LETTER_MOD (ctrl_modifier
);
6596 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6597 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6601 SINGLE_LETTER_MOD (hyper_modifier
);
6605 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6609 SINGLE_LETTER_MOD (meta_modifier
);
6613 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6617 SINGLE_LETTER_MOD (shift_modifier
);
6621 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6622 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6623 SINGLE_LETTER_MOD (super_modifier
);
6627 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6628 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6629 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6633 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6637 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6640 #undef SINGLE_LETTER_MOD
6641 #undef MULTI_LETTER_MOD
6647 /* Return true if EVENT is a list whose elements are all integers or symbols.
6648 Such a list is not valid as an event,
6649 but it can be a Lucid-style event type list. */
6652 lucid_event_type_list_p (Lisp_Object object
)
6656 if (! CONSP (object
))
6659 if (EQ (XCAR (object
), Qhelp_echo
)
6660 || EQ (XCAR (object
), Qvertical_line
)
6661 || EQ (XCAR (object
), Qmode_line
)
6662 || EQ (XCAR (object
), Qheader_line
))
6665 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6669 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6676 /* Return true if terminal input chars are available.
6677 Also, store the return value into INPUT_PENDING.
6679 Serves the purpose of ioctl (0, FIONREAD, ...)
6680 but works even if FIONREAD does not exist.
6681 (In fact, this may actually read some input.)
6683 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6684 timer events that are ripe.
6685 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6686 events (FOCUS_IN_EVENT).
6687 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6688 movements and toolkit scroll bar thumb drags. */
6691 get_input_pending (int flags
)
6693 /* First of all, have we already counted some input? */
6694 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6696 /* If input is being read as it arrives, and we have none, there is none. */
6697 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6699 /* Try to read some input and see how much we get. */
6701 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6704 return input_pending
;
6707 /* Put a BUFFER_SWITCH_EVENT in the buffer
6708 so that read_key_sequence will notice the new current buffer. */
6711 record_asynch_buffer_change (void)
6713 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6714 The purpose of the event is to make read_key_sequence look up the
6715 keymaps again. If we aren't in read_key_sequence, we don't need one,
6716 and the event could cause trouble by messing up (input-pending-p).
6717 Note: Fwaiting_for_user_input_p always returns nil when async
6718 subprocesses aren't supported. */
6719 if (!NILP (Fwaiting_for_user_input_p ()))
6721 struct input_event event
;
6724 event
.kind
= BUFFER_SWITCH_EVENT
;
6725 event
.frame_or_window
= Qnil
;
6728 /* Make sure no interrupt happens while storing the event. */
6730 if (interrupt_input
)
6731 kbd_buffer_store_event (&event
);
6736 kbd_buffer_store_event (&event
);
6742 /* Read any terminal input already buffered up by the system
6743 into the kbd_buffer, but do not wait.
6745 Return the number of keyboard chars read, or -1 meaning
6746 this is a bad time to try to read input. */
6755 /* Store pending user signal events, if any. */
6756 store_user_signal_events ();
6758 /* Loop through the available terminals, and call their input hooks. */
6762 struct terminal
*next
= t
->next_terminal
;
6764 if (t
->read_socket_hook
)
6767 struct input_event hold_quit
;
6769 if (input_blocked_p ())
6771 pending_signals
= true;
6775 EVENT_INIT (hold_quit
);
6776 hold_quit
.kind
= NO_EVENT
;
6778 /* No need for FIONREAD or fcntl; just say don't wait. */
6779 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6782 if (nr
== -1) /* Not OK to read input now. */
6786 else if (nr
== -2) /* Non-transient error. */
6788 /* The terminal device terminated; it should be closed. */
6790 /* Kill Emacs if this was our last terminal. */
6791 if (!terminal_list
->next_terminal
)
6792 /* Formerly simply reported no input, but that
6793 sometimes led to a failure of Emacs to terminate.
6794 SIGHUP seems appropriate if we can't reach the
6796 /* ??? Is it really right to send the signal just to
6797 this process rather than to the whole process
6798 group? Perhaps on systems with FIONREAD Emacs is
6799 alone in its group. */
6800 terminate_due_to_signal (SIGHUP
, 10);
6802 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6805 XSETTERMINAL (tmp
, t
);
6806 Fdelete_terminal (tmp
, Qnoelisp
);
6810 /* If there was no error, make sure the pointer
6811 is visible for all frames on this terminal. */
6814 Lisp_Object tail
, frame
;
6816 FOR_EACH_FRAME (tail
, frame
)
6818 struct frame
*f
= XFRAME (frame
);
6819 if (FRAME_TERMINAL (f
) == t
)
6820 frame_make_pointer_visible (f
);
6824 if (hold_quit
.kind
!= NO_EVENT
)
6825 kbd_buffer_store_event (&hold_quit
);
6837 /* This is the tty way of reading available input.
6839 Note that each terminal device has its own `struct terminal' object,
6840 and so this function is called once for each individual termcap
6841 terminal. The first parameter indicates which terminal to read from. */
6844 tty_read_avail_input (struct terminal
*terminal
,
6845 struct input_event
*hold_quit
)
6847 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6848 the kbd_buffer can really hold. That may prevent loss
6849 of characters on some systems when input is stuffed at us. */
6850 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6852 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6855 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6857 if (kbd_on_hold_p () || buffer_free
<= 0)
6859 #endif /* subprocesses */
6861 if (!terminal
->name
) /* Don't read from a dead terminal. */
6864 if (terminal
->type
!= output_termcap
6865 && terminal
->type
!= output_msdos_raw
)
6868 /* XXX I think the following code should be moved to separate hook
6869 functions in system-dependent files. */
6871 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6872 code sets read_socket_hook to w32_console_read_socket instead! */
6874 #else /* not WINDOWSNT */
6875 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6879 return 0; /* The terminal is suspended. */
6882 n_to_read
= dos_keysns ();
6886 cbuf
[0] = dos_keyread ();
6889 #else /* not MSDOS */
6894 struct input_event gpm_hold_quit
;
6895 int gpm
, fd
= gpm_fd
;
6897 EVENT_INIT (gpm_hold_quit
);
6898 gpm_hold_quit
.kind
= NO_EVENT
;
6900 /* gpm==1 if event received.
6901 gpm==0 if the GPM daemon has closed the connection, in which case
6902 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6903 we save it in `fd' so close_gpm can remove it from the
6905 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6906 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6907 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6910 /* Presumably the GPM daemon has closed the connection. */
6912 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6913 kbd_buffer_store_event (&gpm_hold_quit
);
6917 #endif /* HAVE_GPM */
6919 /* Determine how many characters we should *try* to read. */
6920 #ifdef USABLE_FIONREAD
6921 /* Find out how much input is available. */
6922 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6924 if (! noninteractive
)
6925 return -2; /* Close this terminal. */
6931 if (n_to_read
> sizeof cbuf
)
6932 n_to_read
= sizeof cbuf
;
6933 #elif defined USG || defined CYGWIN
6934 /* Read some input if available, but don't wait. */
6935 n_to_read
= sizeof cbuf
;
6936 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6938 # error "Cannot read without possibly delaying"
6942 /* Don't read more than we can store. */
6943 if (n_to_read
> buffer_free
)
6944 n_to_read
= buffer_free
;
6945 #endif /* subprocesses */
6947 /* Now read; for one reason or another, this will not block.
6948 NREAD is set to the number of chars read. */
6951 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6952 /* POSIX infers that processes which are not in the session leader's
6953 process group won't get SIGHUPs at logout time. BSDI adheres to
6954 this part standard and returns -1 from read (0) with errno==EIO
6955 when the control tty is taken away.
6956 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6957 if (nread
== -1 && errno
== EIO
)
6958 return -2; /* Close this terminal. */
6959 #if defined (AIX) && defined (_BSD)
6960 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6961 This looks incorrect, but it isn't, because _BSD causes
6962 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6963 and that causes a value other than 0 when there is no input. */
6965 return -2; /* Close this terminal. */
6969 /* We used to retry the read if it was interrupted.
6970 But this does the wrong thing when O_NONBLOCK causes
6971 an EAGAIN error. Does anybody know of a situation
6972 where a retry is actually needed? */
6974 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
6984 #ifndef USABLE_FIONREAD
6985 #if defined (USG) || defined (CYGWIN)
6986 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6987 #endif /* USG or CYGWIN */
6988 #endif /* no FIONREAD */
6993 #endif /* not MSDOS */
6994 #endif /* not WINDOWSNT */
6996 for (i
= 0; i
< nread
; i
++)
6998 struct input_event buf
;
7000 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7002 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7003 buf
.modifiers
= meta_modifier
;
7004 if (tty
->meta_key
!= 2)
7008 /* Set the frame corresponding to the active tty. Note that the
7009 value of selected_frame is not reliable here, redisplay tends
7010 to temporarily change it. */
7011 buf
.frame_or_window
= tty
->top_frame
;
7014 kbd_buffer_store_event (&buf
);
7015 /* Don't look at input that follows a C-g too closely.
7016 This reduces lossage due to autorepeat on C-g. */
7017 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7018 && buf
.code
== quit_char
)
7026 handle_async_input (void)
7031 int nread
= gobble_input ();
7032 /* -1 means it's not ok to read the input now.
7033 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7034 0 means there was no keyboard input available. */
7042 process_pending_signals (void)
7044 pending_signals
= false;
7045 handle_async_input ();
7046 do_pending_atimers ();
7049 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7050 and reinvoke any pending signal if the level is now 0 and
7051 a fatal error is not already in progress. */
7054 unblock_input_to (int level
)
7056 interrupt_input_blocked
= level
;
7059 if (pending_signals
&& !fatal_error_in_progress
)
7060 process_pending_signals ();
7066 /* End critical section.
7068 If doing signal-driven input, and a signal came in when input was
7069 blocked, reinvoke the signal handler now to deal with it.
7071 It will also process queued input, if it was not read before.
7072 When a longer code sequence does not use block/unblock input
7073 at all, the whole input gathered up to the next call to
7074 unblock_input will be processed inside that call. */
7077 unblock_input (void)
7079 unblock_input_to (interrupt_input_blocked
- 1);
7082 /* Undo any number of BLOCK_INPUT calls,
7083 and also reinvoke any pending signal. */
7086 totally_unblock_input (void)
7088 unblock_input_to (0);
7094 handle_input_available_signal (int sig
)
7096 pending_signals
= true;
7098 if (input_available_clear_time
)
7099 *input_available_clear_time
= make_timespec (0, 0);
7103 deliver_input_available_signal (int sig
)
7105 deliver_process_signal (sig
, handle_input_available_signal
);
7107 #endif /* USABLE_SIGIO */
7110 /* User signal events. */
7112 struct user_signal_info
7114 /* Signal number. */
7117 /* Name of the signal. */
7120 /* Number of pending signals. */
7123 struct user_signal_info
*next
;
7126 /* List of user signals. */
7127 static struct user_signal_info
*user_signals
= NULL
;
7130 add_user_signal (int sig
, const char *name
)
7132 struct sigaction action
;
7133 struct user_signal_info
*p
;
7135 for (p
= user_signals
; p
; p
= p
->next
)
7137 /* Already added. */
7140 p
= xmalloc (sizeof *p
);
7142 p
->name
= xstrdup (name
);
7144 p
->next
= user_signals
;
7147 emacs_sigaction_init (&action
, deliver_user_signal
);
7148 sigaction (sig
, &action
, 0);
7152 handle_user_signal (int sig
)
7154 struct user_signal_info
*p
;
7155 const char *special_event_name
= NULL
;
7157 if (SYMBOLP (Vdebug_on_event
))
7158 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7160 for (p
= user_signals
; p
; p
= p
->next
)
7163 if (special_event_name
7164 && strcmp (special_event_name
, p
->name
) == 0)
7166 /* Enter the debugger in many ways. */
7167 debug_on_next_call
= true;
7168 debug_on_quit
= true;
7170 Vinhibit_quit
= Qnil
;
7172 /* Eat the event. */
7178 if (interrupt_input
)
7179 handle_input_available_signal (sig
);
7183 /* Tell wait_reading_process_output that it needs to wake
7184 up and look around. */
7185 if (input_available_clear_time
)
7186 *input_available_clear_time
= make_timespec (0, 0);
7193 deliver_user_signal (int sig
)
7195 deliver_process_signal (sig
, handle_user_signal
);
7199 find_user_signal_name (int sig
)
7201 struct user_signal_info
*p
;
7203 for (p
= user_signals
; p
; p
= p
->next
)
7211 store_user_signal_events (void)
7213 struct user_signal_info
*p
;
7214 struct input_event buf
;
7215 bool buf_initialized
= false;
7217 for (p
= user_signals
; p
; p
= p
->next
)
7218 if (p
->npending
> 0)
7220 if (! buf_initialized
)
7222 memset (&buf
, 0, sizeof buf
);
7223 buf
.kind
= USER_SIGNAL_EVENT
;
7224 buf
.frame_or_window
= selected_frame
;
7225 buf_initialized
= true;
7231 kbd_buffer_store_event (&buf
);
7234 while (p
->npending
> 0);
7239 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7240 static Lisp_Object menu_bar_one_keymap_changed_items
;
7242 /* These variables hold the vector under construction within
7243 menu_bar_items and its subroutines, and the current index
7244 for storing into that vector. */
7245 static Lisp_Object menu_bar_items_vector
;
7246 static int menu_bar_items_index
;
7249 static const char *separator_names
[] = {
7254 "single-dashed-line",
7255 "double-dashed-line",
7257 "shadow-etched-out",
7258 "shadow-etched-in-dash",
7259 "shadow-etched-out-dash",
7260 "shadow-double-etched-in",
7261 "shadow-double-etched-out",
7262 "shadow-double-etched-in-dash",
7263 "shadow-double-etched-out-dash",
7267 /* Return true if LABEL specifies a separator. */
7270 menu_separator_name_p (const char *label
)
7274 else if (strlen (label
) > 3
7275 && memcmp (label
, "--", 2) == 0
7280 for (i
= 0; separator_names
[i
]; ++i
)
7281 if (strcmp (label
, separator_names
[i
]) == 0)
7286 /* It's a separator if it contains only dashes. */
7287 while (*label
== '-')
7289 return (*label
== 0);
7296 /* Return a vector of menu items for a menu bar, appropriate
7297 to the current buffer. Each item has three elements in the vector:
7300 OLD is an old vector we can optionally reuse, or nil. */
7303 menu_bar_items (Lisp_Object old
)
7305 /* The number of keymaps we're scanning right now, and the number of
7306 keymaps we have allocated space for. */
7309 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7310 in the current keymaps, or nil where it is not a prefix. */
7313 Lisp_Object mapsbuf
[3];
7314 Lisp_Object def
, tail
;
7321 /* In order to build the menus, we need to call the keymap
7322 accessors. They all call QUIT. But this function is called
7323 during redisplay, during which a quit is fatal. So inhibit
7324 quitting while building the menus.
7325 We do this instead of specbind because (1) errors will clear it anyway
7326 and (2) this avoids risk of specpdl overflow. */
7327 oquit
= Vinhibit_quit
;
7331 menu_bar_items_vector
= old
;
7333 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7334 menu_bar_items_index
= 0;
7336 /* Build our list of keymaps.
7337 If we recognize a function key and replace its escape sequence in
7338 keybuf with its symbol, or if the sequence starts with a mouse
7339 click and we need to switch buffers, we jump back here to rebuild
7340 the initial keymaps from the current buffer. */
7344 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7345 if (!NILP (Voverriding_local_map_menu_flag
)
7346 && !NILP (Voverriding_local_map
))
7348 /* Yes, use them (if non-nil) as well as the global map. */
7351 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7352 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7353 if (!NILP (Voverriding_local_map
))
7354 maps
[nmaps
++] = Voverriding_local_map
;
7358 /* No, so use major and minor mode keymaps and keymap property.
7359 Note that menu-bar bindings in the local-map and keymap
7360 properties may not work reliable, as they are only
7361 recognized when the menu-bar (or mode-line) is updated,
7362 which does not normally happen after every command. */
7363 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7364 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7366 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7367 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7368 maps
[nmaps
++] = tem
;
7369 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7370 maps
[nmaps
++] = tem
;
7373 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7376 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7378 maps
[nmaps
++] = current_global_map
;
7381 /* Look up in each map the dummy prefix key `menu-bar'. */
7383 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7384 if (!NILP (maps
[mapno
]))
7386 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7390 menu_bar_one_keymap_changed_items
= Qnil
;
7391 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7395 /* Move to the end those items that should be at the end. */
7397 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7400 int end
= menu_bar_items_index
;
7402 for (i
= 0; i
< end
; i
+= 4)
7403 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7405 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7406 /* Move the item at index I to the end,
7407 shifting all the others forward. */
7408 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7409 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7410 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7411 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7413 memmove (aref_addr (menu_bar_items_vector
, i
),
7414 aref_addr (menu_bar_items_vector
, i
+ 4),
7415 (end
- i
- 4) * word_size
);
7416 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7417 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7418 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7419 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7424 /* Add nil, nil, nil, nil at the end. */
7426 int i
= menu_bar_items_index
;
7427 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7428 menu_bar_items_vector
7429 = larger_vector (menu_bar_items_vector
, 4, -1);
7430 /* Add this item. */
7431 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7432 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7433 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7434 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7435 menu_bar_items_index
= i
;
7438 Vinhibit_quit
= oquit
;
7440 return menu_bar_items_vector
;
7443 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7444 If there's already an item for KEY, add this DEF to it. */
7446 Lisp_Object item_properties
;
7449 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7455 if (EQ (item
, Qundefined
))
7457 /* If a map has an explicit `undefined' as definition,
7458 discard any previously made menu bar item. */
7460 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7461 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7463 if (menu_bar_items_index
> i
+ 4)
7464 memmove (aref_addr (menu_bar_items_vector
, i
),
7465 aref_addr (menu_bar_items_vector
, i
+ 4),
7466 (menu_bar_items_index
- i
- 4) * word_size
);
7467 menu_bar_items_index
-= 4;
7471 /* If this keymap has already contributed to this KEY,
7472 don't contribute to it a second time. */
7473 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7474 if (!NILP (tem
) || NILP (item
))
7477 menu_bar_one_keymap_changed_items
7478 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7480 /* We add to menu_bar_one_keymap_changed_items before doing the
7481 parse_menu_item, so that if it turns out it wasn't a menu item,
7482 it still correctly hides any further menu item. */
7483 parsed
= parse_menu_item (item
, 1);
7487 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7489 /* Find any existing item for this KEY. */
7490 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7491 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7494 /* If we did not find this KEY, add it at the end. */
7495 if (i
== menu_bar_items_index
)
7497 /* If vector is too small, get a bigger one. */
7498 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7499 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7500 /* Add this item. */
7501 ASET (menu_bar_items_vector
, i
, key
); i
++;
7502 ASET (menu_bar_items_vector
, i
,
7503 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7504 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7505 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7506 menu_bar_items_index
= i
;
7508 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7512 old
= AREF (menu_bar_items_vector
, i
+ 2);
7513 /* If the new and the old items are not both keymaps,
7514 the lookup will only find `item'. */
7515 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7516 ASET (menu_bar_items_vector
, i
+ 2, item
);
7520 /* This is used as the handler when calling menu_item_eval_property. */
7522 menu_item_eval_property_1 (Lisp_Object arg
)
7524 /* If we got a quit from within the menu computation,
7525 quit all the way out of it. This takes care of C-] in the debugger. */
7526 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7527 Fsignal (Qquit
, Qnil
);
7533 eval_dyn (Lisp_Object form
)
7535 return Feval (form
, Qnil
);
7538 /* Evaluate an expression and return the result (or nil if something
7539 went wrong). Used to evaluate dynamic parts of menu items. */
7541 menu_item_eval_property (Lisp_Object sexpr
)
7543 ptrdiff_t count
= SPECPDL_INDEX ();
7545 specbind (Qinhibit_redisplay
, Qt
);
7546 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7547 menu_item_eval_property_1
);
7548 return unbind_to (count
, val
);
7551 /* This function parses a menu item and leaves the result in the
7552 vector item_properties.
7553 ITEM is a key binding, a possible menu item.
7554 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7556 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7557 parse_menu_item returns true if the item is a menu item and false
7561 parse_menu_item (Lisp_Object item
, int inmenubar
)
7563 Lisp_Object def
, tem
, item_string
, start
;
7565 Lisp_Object keyhint
;
7574 /* Create item_properties vector if necessary. */
7575 if (NILP (item_properties
))
7577 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7579 /* Initialize optional entries. */
7580 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7581 ASET (item_properties
, i
, Qnil
);
7582 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7584 /* Save the item here to protect it from GC. */
7585 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7587 item_string
= XCAR (item
);
7591 if (STRINGP (item_string
))
7593 /* Old format menu item. */
7594 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7596 /* Maybe help string. */
7597 if (CONSP (item
) && STRINGP (XCAR (item
)))
7599 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7600 Fsubstitute_command_keys (XCAR (item
)));
7605 /* Maybe an obsolete key binding cache. */
7606 if (CONSP (item
) && CONSP (XCAR (item
))
7607 && (NILP (XCAR (XCAR (item
)))
7608 || VECTORP (XCAR (XCAR (item
)))))
7611 /* This is the real definition--the function to run. */
7612 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7614 /* Get enable property, if any. */
7617 tem
= Fget (item
, Qmenu_enable
);
7618 if (!NILP (Venable_disabled_menus_and_buttons
))
7619 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7620 else if (!NILP (tem
))
7621 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7624 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7626 /* New format menu item. */
7627 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7628 start
= XCDR (item
);
7631 /* We have a real binding. */
7632 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7634 item
= XCDR (start
);
7635 /* Is there an obsolete cache list with key equivalences. */
7636 if (CONSP (item
) && CONSP (XCAR (item
)))
7639 /* Parse properties. */
7640 while (CONSP (item
) && CONSP (XCDR (item
)))
7645 if (EQ (tem
, QCenable
))
7647 if (!NILP (Venable_disabled_menus_and_buttons
))
7648 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7650 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7652 else if (EQ (tem
, QCvisible
))
7654 /* If got a visible property and that evaluates to nil
7655 then ignore this item. */
7656 tem
= menu_item_eval_property (XCAR (item
));
7660 else if (EQ (tem
, QChelp
))
7662 Lisp_Object help
= XCAR (item
);
7664 help
= Fsubstitute_command_keys (help
);
7665 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7667 else if (EQ (tem
, QCfilter
))
7669 else if (EQ (tem
, QCkey_sequence
))
7672 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7673 /* Be GC protected. Set keyhint to item instead of tem. */
7676 else if (EQ (tem
, QCkeys
))
7679 if (CONSP (tem
) || STRINGP (tem
))
7680 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7682 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7687 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7689 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7691 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7697 else if (inmenubar
|| !NILP (start
))
7701 return 0; /* not a menu item */
7703 /* If item string is not a string, evaluate it to get string.
7704 If we don't get a string, skip this item. */
7705 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7706 if (!(STRINGP (item_string
)))
7708 item_string
= menu_item_eval_property (item_string
);
7709 if (!STRINGP (item_string
))
7711 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7714 /* If got a filter apply it on definition. */
7715 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7718 def
= menu_item_eval_property (list2 (XCAR (filter
),
7719 list2 (Qquote
, def
)));
7721 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7724 /* Enable or disable selection of item. */
7725 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7728 tem
= menu_item_eval_property (tem
);
7729 if (inmenubar
&& NILP (tem
))
7730 return 0; /* Ignore disabled items in menu bar. */
7731 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7734 /* If we got no definition, this item is just unselectable text which
7735 is OK in a submenu but not in the menubar. */
7737 return (!inmenubar
);
7739 /* See if this is a separate pane or a submenu. */
7740 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7741 tem
= get_keymap (def
, 0, 1);
7742 /* For a subkeymap, just record its details and exit. */
7745 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7746 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7750 /* At the top level in the menu bar, do likewise for commands also.
7751 The menu bar does not display equivalent key bindings anyway.
7752 ITEM_PROPERTY_DEF is already set up properly. */
7756 { /* This is a command. See if there is an equivalent key binding. */
7757 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7758 AUTO_STRING (space_space
, " ");
7760 /* The previous code preferred :key-sequence to :keys, so we
7761 preserve this behavior. */
7762 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7763 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7766 Lisp_Object prefix
= keyeq
;
7767 Lisp_Object keys
= Qnil
;
7771 def
= XCAR (prefix
);
7772 prefix
= XCDR (prefix
);
7775 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7777 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7779 keys
= XCAR (keyhint
);
7780 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7782 /* We have a suggested key. Is it bound to the command? */
7785 /* If the command is an alias for another
7786 (such as lmenu.el set it up), check if the
7787 original command matches the cached command. */
7789 && EQ (tem
, XSYMBOL (def
)->function
))))
7794 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7798 tem
= Fkey_description (keys
, Qnil
);
7801 if (STRINGP (XCAR (prefix
)))
7802 tem
= concat2 (XCAR (prefix
), tem
);
7803 if (STRINGP (XCDR (prefix
)))
7804 tem
= concat2 (tem
, XCDR (prefix
));
7806 keyeq
= concat2 (space_space
, tem
);
7812 /* If we have an equivalent key binding, use that. */
7813 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7816 /* Include this when menu help is implemented.
7817 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7818 if (!(NILP (tem) || STRINGP (tem)))
7820 tem = menu_item_eval_property (tem);
7823 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7827 /* Handle radio buttons or toggle boxes. */
7828 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7830 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7831 menu_item_eval_property (tem
));
7838 /***********************************************************************
7840 ***********************************************************************/
7842 /* A vector holding tool bar items while they are parsed in function
7843 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7846 static Lisp_Object tool_bar_items_vector
;
7848 /* A vector holding the result of parse_tool_bar_item. Layout is like
7849 the one for a single item in tool_bar_items_vector. */
7851 static Lisp_Object tool_bar_item_properties
;
7853 /* Next free index in tool_bar_items_vector. */
7855 static int ntool_bar_items
;
7857 /* Function prototypes. */
7859 static void init_tool_bar_items (Lisp_Object
);
7860 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7862 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7863 static void append_tool_bar_item (void);
7866 /* Return a vector of tool bar items for keymaps currently in effect.
7867 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7868 tool bar items found. */
7871 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7874 Lisp_Object mapsbuf
[3];
7882 /* In order to build the menus, we need to call the keymap
7883 accessors. They all call QUIT. But this function is called
7884 during redisplay, during which a quit is fatal. So inhibit
7885 quitting while building the menus. We do this instead of
7886 specbind because (1) errors will clear it anyway and (2) this
7887 avoids risk of specpdl overflow. */
7888 oquit
= Vinhibit_quit
;
7891 /* Initialize tool_bar_items_vector and protect it from GC. */
7892 init_tool_bar_items (reuse
);
7894 /* Build list of keymaps in maps. Set nmaps to the number of maps
7897 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7898 if (!NILP (Voverriding_local_map_menu_flag
)
7899 && !NILP (Voverriding_local_map
))
7901 /* Yes, use them (if non-nil) as well as the global map. */
7904 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7905 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7906 if (!NILP (Voverriding_local_map
))
7907 maps
[nmaps
++] = Voverriding_local_map
;
7911 /* No, so use major and minor mode keymaps and keymap property.
7912 Note that tool-bar bindings in the local-map and keymap
7913 properties may not work reliable, as they are only
7914 recognized when the tool-bar (or mode-line) is updated,
7915 which does not normally happen after every command. */
7916 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7917 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7919 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7920 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7921 maps
[nmaps
++] = tem
;
7922 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7923 maps
[nmaps
++] = tem
;
7926 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7929 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7932 /* Add global keymap at the end. */
7933 maps
[nmaps
++] = current_global_map
;
7935 /* Process maps in reverse order and look up in each map the prefix
7937 for (i
= nmaps
- 1; i
>= 0; --i
)
7938 if (!NILP (maps
[i
]))
7942 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7944 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7947 Vinhibit_quit
= oquit
;
7948 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7950 return tool_bar_items_vector
;
7954 /* Process the definition of KEY which is DEF. */
7957 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7961 if (EQ (def
, Qundefined
))
7963 /* If a map has an explicit `undefined' as definition,
7964 discard any previously made item. */
7965 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7967 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7969 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7971 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7972 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
7973 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7975 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7980 else if (parse_tool_bar_item (key
, def
))
7981 /* Append a new tool bar item to tool_bar_items_vector. Accept
7982 more than one definition for the same key. */
7983 append_tool_bar_item ();
7986 /* Access slot with index IDX of vector tool_bar_item_properties. */
7987 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
7989 set_prop (ptrdiff_t idx
, Lisp_Object val
)
7991 ASET (tool_bar_item_properties
, idx
, val
);
7995 /* Parse a tool bar item specification ITEM for key KEY and return the
7996 result in tool_bar_item_properties. Value is false if ITEM is
7999 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8001 CAPTION is the caption of the item, If it's not a string, it is
8002 evaluated to get a string.
8004 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8005 as binding are currently ignored.
8007 The following properties are recognized:
8011 FORM is evaluated and specifies whether the tool bar item is
8012 enabled or disabled.
8016 FORM is evaluated and specifies whether the tool bar item is visible.
8018 - `:filter FUNCTION'
8020 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8021 result is stored as the new binding.
8023 - `:button (TYPE SELECTED)'
8025 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8026 and specifies whether the button is selected (pressed) or not.
8030 IMAGES is either a single image specification or a vector of four
8031 image specifications. See enum tool_bar_item_images.
8033 - `:help HELP-STRING'.
8035 Gives a help string to display for the tool bar item.
8037 - `:label LABEL-STRING'.
8039 A text label to show with the tool bar button if labels are enabled. */
8042 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8044 Lisp_Object filter
= Qnil
;
8045 Lisp_Object caption
;
8047 bool have_label
= false;
8049 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8050 Rule out items that aren't lists, don't start with
8051 `menu-item' or whose rest following `tool-bar-item' is not a
8056 /* As an exception, allow old-style menu separators. */
8057 if (STRINGP (XCAR (item
)))
8058 item
= list1 (XCAR (item
));
8059 else if (!EQ (XCAR (item
), Qmenu_item
)
8060 || (item
= XCDR (item
), !CONSP (item
)))
8063 /* Create tool_bar_item_properties vector if necessary. Reset it to
8065 if (VECTORP (tool_bar_item_properties
))
8067 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8071 tool_bar_item_properties
8072 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8075 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8076 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8078 /* Get the caption of the item. If the caption is not a string,
8079 evaluate it to get a string. If we don't get a string, skip this
8081 caption
= XCAR (item
);
8082 if (!STRINGP (caption
))
8084 caption
= menu_item_eval_property (caption
);
8085 if (!STRINGP (caption
))
8088 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8090 /* If the rest following the caption is not a list, the menu item is
8091 either a separator, or invalid. */
8095 if (menu_separator_name_p (SSDATA (caption
)))
8097 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8098 #if !defined (USE_GTK) && !defined (HAVE_NS)
8099 /* If we use build_desired_tool_bar_string to render the
8100 tool bar, the separator is rendered as an image. */
8101 set_prop (TOOL_BAR_ITEM_IMAGES
,
8102 (menu_item_eval_property
8103 (Vtool_bar_separator_image_expression
)));
8104 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8105 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8106 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8113 /* Store the binding. */
8114 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8117 /* Ignore cached key binding, if any. */
8118 if (CONSP (item
) && CONSP (XCAR (item
)))
8121 /* Process the rest of the properties. */
8122 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8124 Lisp_Object ikey
, value
;
8127 value
= XCAR (XCDR (item
));
8129 if (EQ (ikey
, QCenable
))
8131 /* `:enable FORM'. */
8132 if (!NILP (Venable_disabled_menus_and_buttons
))
8133 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8135 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8137 else if (EQ (ikey
, QCvisible
))
8139 /* `:visible FORM'. If got a visible property and that
8140 evaluates to nil then ignore this item. */
8141 if (NILP (menu_item_eval_property (value
)))
8144 else if (EQ (ikey
, QChelp
))
8145 /* `:help HELP-STRING'. */
8146 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8147 else if (EQ (ikey
, QCvert_only
))
8148 /* `:vert-only t/nil'. */
8149 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8150 else if (EQ (ikey
, QClabel
))
8152 const char *bad_label
= "!!?GARBLED ITEM?!!";
8153 /* `:label LABEL-STRING'. */
8154 set_prop (TOOL_BAR_ITEM_LABEL
,
8155 STRINGP (value
) ? value
: build_string (bad_label
));
8158 else if (EQ (ikey
, QCfilter
))
8159 /* ':filter FORM'. */
8161 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8163 /* `:button (TYPE . SELECTED)'. */
8164 Lisp_Object type
, selected
;
8166 type
= XCAR (value
);
8167 selected
= XCDR (value
);
8168 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8170 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8171 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8174 else if (EQ (ikey
, QCimage
)
8176 || (VECTORP (value
) && ASIZE (value
) == 4)))
8177 /* Value is either a single image specification or a vector
8178 of 4 such specifications for the different button states. */
8179 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8180 else if (EQ (ikey
, QCrtl
))
8182 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8188 /* Try to make one from caption and key. */
8189 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8190 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8191 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8192 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8194 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8195 char *buf
= xmalloc (max_lbl
+ 1);
8196 Lisp_Object new_lbl
;
8197 ptrdiff_t caption_len
= strlen (capt
);
8199 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8202 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8204 buf
[caption_len
] = '\0';
8208 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8212 strcpy (buf
, label
);
8214 for (j
= 0; buf
[j
] != '\0'; ++j
)
8222 new_lbl
= Fupcase_initials (build_string (label
));
8223 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8224 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8226 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8230 /* If got a filter apply it on binding. */
8232 set_prop (TOOL_BAR_ITEM_BINDING
,
8233 (menu_item_eval_property
8236 PROP (TOOL_BAR_ITEM_BINDING
))))));
8238 /* See if the binding is a keymap. Give up if it is. */
8239 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8242 /* Enable or disable selection of item. */
8243 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8244 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8245 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8247 /* Handle radio buttons or toggle boxes. */
8248 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8249 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8250 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8258 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8259 that can be reused. */
8262 init_tool_bar_items (Lisp_Object reuse
)
8264 if (VECTORP (reuse
))
8265 tool_bar_items_vector
= reuse
;
8267 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8268 ntool_bar_items
= 0;
8272 /* Append parsed tool bar item properties from
8273 tool_bar_item_properties */
8276 append_tool_bar_item (void)
8280 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8282 /* Enlarge tool_bar_items_vector if necessary. */
8284 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8286 /* Append entries from tool_bar_item_properties to the end of
8287 tool_bar_items_vector. */
8288 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8289 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8290 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8297 /* Read a character using menus based on the keymap MAP.
8298 Return nil if there are no menus in the maps.
8299 Return t if we displayed a menu but the user rejected it.
8301 PREV_EVENT is the previous input event, or nil if we are reading
8302 the first event of a key sequence.
8304 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8305 if we used a mouse menu to read the input, or false otherwise. If
8306 USED_MOUSE_MENU is null, don't dereference it.
8308 The prompting is done based on the prompt-string of the map
8309 and the strings associated with various map elements.
8311 This can be done with X menus or with menus put in the minibuf.
8312 These are done in different ways, depending on how the input will be read.
8313 Menus using X are done after auto-saving in read-char, getting the input
8314 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8315 and do auto-saving in the inner call of read_char. */
8318 read_char_x_menu_prompt (Lisp_Object map
,
8319 Lisp_Object prev_event
, bool *used_mouse_menu
)
8321 if (used_mouse_menu
)
8322 *used_mouse_menu
= false;
8324 /* Use local over global Menu maps. */
8326 if (! menu_prompting
)
8329 /* If we got to this point via a mouse click,
8330 use a real menu for mouse selection. */
8331 if (EVENT_HAS_PARAMETERS (prev_event
)
8332 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8333 && !EQ (XCAR (prev_event
), Qtool_bar
))
8335 /* Display the menu and get the selection. */
8338 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8343 record_menu_key (XCAR (value
));
8345 /* If we got multiple events, unread all but
8347 There is no way to prevent those unread events
8348 from showing up later in last_nonmenu_event.
8349 So turn symbol and integer events into lists,
8350 to indicate that they came from a mouse menu,
8351 so that when present in last_nonmenu_event
8352 they won't confuse things. */
8353 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8355 record_menu_key (XCAR (tem
));
8356 if (SYMBOLP (XCAR (tem
))
8357 || INTEGERP (XCAR (tem
)))
8358 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8361 /* If we got more than one event, put all but the first
8362 onto this list to be read later.
8363 Return just the first event now. */
8364 Vunread_command_events
8365 = nconc2 (XCDR (value
), Vunread_command_events
);
8366 value
= XCAR (value
);
8368 else if (NILP (value
))
8370 if (used_mouse_menu
)
8371 *used_mouse_menu
= true;
8378 read_char_minibuf_menu_prompt (int commandflag
,
8383 /* FIXME: Use the minibuffer's frame width. */
8384 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8386 bool nobindings
= true;
8387 Lisp_Object rest
, vector
;
8388 Lisp_Object prompt_strings
= Qnil
;
8392 if (! menu_prompting
)
8395 map
= get_keymap (map
, 0, 1);
8396 name
= Fkeymap_prompt (map
);
8398 /* If we don't have any menus, just read a character normally. */
8399 if (!STRINGP (name
))
8402 #define PUSH_C_STR(str, listvar) \
8403 listvar = Fcons (build_unibyte_string (str), listvar)
8405 /* Prompt string always starts with map's prompt, and a space. */
8406 prompt_strings
= Fcons (name
, prompt_strings
);
8407 PUSH_C_STR (": ", prompt_strings
);
8408 nlength
= SCHARS (name
) + 2;
8412 /* Present the documented bindings, a line at a time. */
8415 bool notfirst
= false;
8416 Lisp_Object menu_strings
= prompt_strings
;
8417 ptrdiff_t i
= nlength
;
8419 Lisp_Object orig_defn_macro
;
8421 /* Loop over elements of map. */
8426 /* FIXME: Use map_keymap to handle new keymap formats. */
8428 /* At end of map, wrap around if just starting,
8429 or end this line if already have something on it. */
8432 if (notfirst
|| nobindings
)
8438 /* Look at the next element of the map. */
8440 elt
= AREF (vector
, idx
);
8442 elt
= Fcar_safe (rest
);
8444 if (idx
< 0 && VECTORP (elt
))
8446 /* If we found a dense table in the keymap,
8447 advanced past it, but start scanning its contents. */
8448 rest
= Fcdr_safe (rest
);
8454 /* An ordinary element. */
8455 Lisp_Object event
, tem
;
8459 event
= Fcar_safe (elt
); /* alist */
8460 elt
= Fcdr_safe (elt
);
8464 XSETINT (event
, idx
); /* vector */
8467 /* Ignore the element if it has no prompt string. */
8468 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8470 /* True if the char to type matches the string. */
8472 Lisp_Object upcased_event
, downcased_event
;
8473 Lisp_Object desc
= Qnil
;
8475 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8477 upcased_event
= Fupcase (event
);
8478 downcased_event
= Fdowncase (event
);
8479 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8480 || XINT (downcased_event
) == SREF (s
, 0));
8482 desc
= Fsingle_key_description (event
, Qnil
);
8484 #if 0 /* It is redundant to list the equivalent key bindings because
8485 the prefix is what the user has already typed. */
8487 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8489 /* Insert equivalent keybinding. */
8490 s
= concat2 (s
, tem
);
8493 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8494 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8496 /* Insert button prefix. */
8497 Lisp_Object selected
8498 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8499 AUTO_STRING (radio_yes
, "(*) ");
8500 AUTO_STRING (radio_no
, "( ) ");
8501 AUTO_STRING (check_yes
, "[X] ");
8502 AUTO_STRING (check_no
, "[ ] ");
8503 if (EQ (tem
, QCradio
))
8504 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8506 tem
= NILP (selected
) ? check_yes
: check_no
;
8507 s
= concat2 (tem
, s
);
8511 /* If we have room for the prompt string, add it to this line.
8512 If this is the first on the line, always add it. */
8513 if ((SCHARS (s
) + i
+ 2
8514 + (char_matches
? 0 : SCHARS (desc
) + 3))
8518 ptrdiff_t thiswidth
;
8520 /* Punctuate between strings. */
8523 PUSH_C_STR (", ", menu_strings
);
8529 /* If the char to type doesn't match the string's
8530 first char, explicitly show what char to type. */
8533 /* Add as much of string as fits. */
8534 thiswidth
= min (SCHARS (desc
), width
- i
);
8536 = Fcons (Fsubstring (desc
, make_number (0),
8537 make_number (thiswidth
)),
8540 PUSH_C_STR (" = ", menu_strings
);
8544 /* Add as much of string as fits. */
8545 thiswidth
= min (SCHARS (s
), width
- i
);
8547 = Fcons (Fsubstring (s
, make_number (0),
8548 make_number (thiswidth
)),
8554 /* If this element does not fit, end the line now,
8555 and save the element for the next line. */
8556 PUSH_C_STR ("...", menu_strings
);
8561 /* Move past this element. */
8562 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8563 /* Handle reaching end of dense table. */
8568 rest
= Fcdr_safe (rest
);
8572 /* Prompt with that and read response. */
8573 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8575 /* Make believe it's not a keyboard macro in case the help char
8576 is pressed. Help characters are not recorded because menu prompting
8577 is not used on replay. */
8578 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8579 kset_defining_kbd_macro (current_kboard
, Qnil
);
8581 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8582 while (BUFFERP (obj
));
8583 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8585 if (!INTEGERP (obj
) || XINT (obj
) == -2
8586 || (! EQ (obj
, menu_prompt_more_char
)
8587 && (!INTEGERP (menu_prompt_more_char
)
8588 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8590 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8591 store_kbd_macro_char (obj
);
8594 /* Help char - go round again. */
8598 /* Reading key sequences. */
8601 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8603 return access_keymap (get_keymap (keymap
, 0, 1),
8608 active_maps (Lisp_Object first_event
)
8610 Lisp_Object position
8611 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8612 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8615 /* Structure used to keep track of partial application of key remapping
8616 such as Vfunction_key_map and Vkey_translation_map. */
8617 typedef struct keyremap
8619 /* This is the map originally specified for this use. */
8621 /* This is a submap reached by looking up, in PARENT,
8622 the events from START to END. */
8624 /* Positions [START, END) in the key sequence buffer
8625 are the key that we have scanned so far.
8626 Those events are the ones that we will replace
8627 if PARENT maps them into a key sequence. */
8631 /* Lookup KEY in MAP.
8632 MAP is a keymap mapping keys to key vectors or functions.
8633 If the mapping is a function and DO_FUNCALL is true,
8634 the function is called with PROMPT as parameter and its return
8635 value is used as the return value of this function (after checking
8636 that it is indeed a vector). */
8639 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8644 next
= access_keymap (map
, key
, 1, 0, 1);
8646 /* Handle a symbol whose function definition is a keymap
8648 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8649 && (ARRAYP (XSYMBOL (next
)->function
)
8650 || KEYMAPP (XSYMBOL (next
)->function
)))
8651 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8653 /* If the keymap gives a function, not an
8654 array, then call the function with one arg and use
8655 its value instead. */
8656 if (do_funcall
&& FUNCTIONP (next
))
8661 next
= call1 (next
, prompt
);
8662 /* If the function returned something invalid,
8663 barf--don't ignore it. */
8664 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8665 error ("Function %s returns invalid key sequence",
8666 SSDATA (SYMBOL_NAME (tem
)));
8671 /* Do one step of the key remapping used for function-key-map and
8672 key-translation-map:
8673 KEYBUF is the buffer holding the input events.
8674 BUFSIZE is its maximum size.
8675 FKEY is a pointer to the keyremap structure to use.
8676 INPUT is the index of the last element in KEYBUF.
8677 DOIT if true says that the remapping can actually take place.
8678 DIFF is used to return the number of keys added/removed by the remapping.
8679 PARENT is the root of the keymap.
8680 PROMPT is the prompt to use if the remapping happens through a function.
8681 Return true if the remapping actually took place. */
8684 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8685 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8687 Lisp_Object next
, key
;
8689 key
= keybuf
[fkey
->end
++];
8691 if (KEYMAPP (fkey
->parent
))
8692 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8696 /* If keybuf[fkey->start..fkey->end] is bound in the
8697 map and we're in a position to do the key remapping, replace it with
8698 the binding and restart with fkey->start at the end. */
8699 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8701 int len
= XFASTINT (Flength (next
));
8704 *diff
= len
- (fkey
->end
- fkey
->start
);
8706 if (bufsize
- input
<= *diff
)
8707 error ("Key sequence too long");
8709 /* Shift the keys that follow fkey->end. */
8711 for (i
= fkey
->end
; i
< input
; i
++)
8712 keybuf
[i
+ *diff
] = keybuf
[i
];
8714 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8715 keybuf
[i
+ *diff
] = keybuf
[i
];
8716 /* Overwrite the old keys with the new ones. */
8717 for (i
= 0; i
< len
; i
++)
8718 keybuf
[fkey
->start
+ i
]
8719 = Faref (next
, make_number (i
));
8721 fkey
->start
= fkey
->end
+= *diff
;
8722 fkey
->map
= fkey
->parent
;
8727 fkey
->map
= get_keymap (next
, 0, 1);
8729 /* If we no longer have a bound suffix, try a new position for
8731 if (!CONSP (fkey
->map
))
8733 fkey
->end
= ++fkey
->start
;
8734 fkey
->map
= fkey
->parent
;
8740 test_undefined (Lisp_Object binding
)
8742 return (NILP (binding
)
8743 || EQ (binding
, Qundefined
)
8744 || (SYMBOLP (binding
)
8745 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8748 /* Read a sequence of keys that ends with a non prefix character,
8749 storing it in KEYBUF, a buffer of size BUFSIZE.
8751 Return the length of the key sequence stored.
8752 Return -1 if the user rejected a command menu.
8754 Echo starting immediately unless `prompt' is 0.
8756 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8757 read_char with a suitable COMMANDFLAG argument.
8759 Where a key sequence ends depends on the currently active keymaps.
8760 These include any minor mode keymaps active in the current buffer,
8761 the current buffer's local map, and the global map.
8763 If a key sequence has no other bindings, we check Vfunction_key_map
8764 to see if some trailing subsequence might be the beginning of a
8765 function key's sequence. If so, we try to read the whole function
8766 key, and substitute its symbolic name into the key sequence.
8768 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8769 `double-' events into similar click events, if that would make them
8770 bound. We try to turn `triple-' events first into `double-' events,
8773 If we get a mouse click in a mode line, vertical divider, or other
8774 non-text area, we treat the click as if it were prefixed by the
8775 symbol denoting that area - `mode-line', `vertical-line', or
8778 If the sequence starts with a mouse click, we read the key sequence
8779 with respect to the buffer clicked on, not the current buffer.
8781 If the user switches frames in the midst of a key sequence, we put
8782 off the switch-frame event until later; the next call to
8783 read_char will return it.
8785 If FIX_CURRENT_BUFFER, we restore current_buffer
8786 from the selected window's buffer. */
8789 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8790 bool dont_downcase_last
, bool can_return_switch_frame
,
8791 bool fix_current_buffer
, bool prevent_redisplay
)
8793 ptrdiff_t count
= SPECPDL_INDEX ();
8795 /* How many keys there are in the current key sequence. */
8798 /* The length of the echo buffer when we started reading, and
8799 the length of this_command_keys when we started reading. */
8800 ptrdiff_t echo_start
IF_LINT (= 0);
8801 ptrdiff_t keys_start
;
8803 Lisp_Object current_binding
= Qnil
;
8804 Lisp_Object first_event
= Qnil
;
8806 /* Index of the first key that has no binding.
8807 It is useless to try fkey.start larger than that. */
8810 /* If t < mock_input, then KEYBUF[t] should be read as the next
8813 We use this to recover after recognizing a function key. Once we
8814 realize that a suffix of the current key sequence is actually a
8815 function key's escape sequence, we replace the suffix with the
8816 function key's binding from Vfunction_key_map. Now keybuf
8817 contains a new and different key sequence, so the echo area,
8818 this_command_keys, and the submaps and defs arrays are wrong. In
8819 this situation, we set mock_input to t, set t to 0, and jump to
8820 restart_sequence; the loop will read keys from keybuf up until
8821 mock_input, thus rebuilding the state; and then it will resume
8822 reading characters from the keyboard. */
8825 /* If the sequence is unbound in submaps[], then
8826 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8827 and fkey.map is its binding.
8829 These might be > t, indicating that all function key scanning
8830 should hold off until t reaches them. We do this when we've just
8831 recognized a function key, to avoid searching for the function
8832 key's again in Vfunction_key_map. */
8835 /* Likewise, for key_translation_map and input-decode-map. */
8836 keyremap keytran
, indec
;
8838 /* True if we are trying to map a key by changing an upper-case
8839 letter to lower case, or a shifted function key to an unshifted
8841 bool shift_translated
= false;
8843 /* If we receive a `switch-frame' or `select-window' event in the middle of
8844 a key sequence, we put it off for later.
8845 While we're reading, we keep the event here. */
8846 Lisp_Object delayed_switch_frame
;
8848 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8849 int original_uppercase_position
= -1;
8851 /* Gets around Microsoft compiler limitations. */
8852 bool dummyflag
= false;
8854 struct buffer
*starting_buffer
;
8856 /* List of events for which a fake prefix key has been generated. */
8857 Lisp_Object fake_prefixed_keys
= Qnil
;
8859 raw_keybuf_count
= 0;
8861 last_nonmenu_event
= Qnil
;
8863 delayed_switch_frame
= Qnil
;
8869 /* Install the string PROMPT as the beginning of the string
8870 of echoing, so that it serves as a prompt for the next
8872 kset_echo_prompt (current_kboard
, prompt
);
8873 current_kboard
->immediate_echo
= false;
8876 else if (cursor_in_echo_area
8877 && echo_keystrokes_p ())
8878 /* This doesn't put in a dash if the echo buffer is empty, so
8879 you don't always see a dash hanging out in the minibuffer. */
8883 /* Record the initial state of the echo area and this_command_keys;
8884 we will need to restore them if we replay a key sequence. */
8886 echo_start
= echo_length ();
8887 keys_start
= this_command_key_count
;
8888 this_single_command_key_start
= keys_start
;
8890 /* We jump here when we need to reinitialize fkey and keytran; this
8891 happens if we switch keyboards between rescans. */
8892 replay_entire_sequence
:
8894 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8895 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8896 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8897 indec
.start
= indec
.end
= 0;
8898 fkey
.start
= fkey
.end
= 0;
8899 keytran
.start
= keytran
.end
= 0;
8901 /* We jump here when the key sequence has been thoroughly changed, and
8902 we need to rescan it starting from the beginning. When we jump here,
8903 keybuf[0..mock_input] holds the sequence we should reread. */
8906 starting_buffer
= current_buffer
;
8907 first_unbound
= bufsize
+ 1;
8909 /* Build our list of keymaps.
8910 If we recognize a function key and replace its escape sequence in
8911 keybuf with its symbol, or if the sequence starts with a mouse
8912 click and we need to switch buffers, we jump back here to rebuild
8913 the initial keymaps from the current buffer. */
8914 current_binding
= active_maps (first_event
);
8916 /* Start from the beginning in keybuf. */
8919 /* These are no-ops the first time through, but if we restart, they
8920 revert the echo area and this_command_keys to their original state. */
8921 this_command_key_count
= keys_start
;
8922 if (INTERACTIVE
&& t
< mock_input
)
8923 echo_truncate (echo_start
);
8925 /* If the best binding for the current key sequence is a keymap, or
8926 we may be looking at a function key's escape sequence, keep on
8928 while (!NILP (current_binding
)
8929 /* Keep reading as long as there's a prefix binding. */
8930 ? KEYMAPP (current_binding
)
8931 /* Don't return in the middle of a possible function key sequence,
8932 if the only bindings we found were via case conversion.
8933 Thus, if ESC O a has a function-key-map translation
8934 and ESC o has a binding, don't return after ESC O,
8935 so that we can translate ESC O plus the next character. */
8936 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8939 bool used_mouse_menu
= false;
8941 /* Where the last real key started. If we need to throw away a
8942 key that has expanded into more than one element of keybuf
8943 (say, a mouse click on the mode line which is being treated
8944 as [mode-line (mouse-...)], then we backtrack to this point
8946 int last_real_key_start
;
8948 /* These variables are analogous to echo_start and keys_start;
8949 while those allow us to restart the entire key sequence,
8950 echo_local_start and keys_local_start allow us to throw away
8952 ptrdiff_t echo_local_start
IF_LINT (= 0);
8953 int keys_local_start
;
8954 Lisp_Object new_binding
;
8956 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
8957 eassert (indec
.start
<= indec
.end
);
8958 eassert (fkey
.start
<= fkey
.end
);
8959 eassert (keytran
.start
<= keytran
.end
);
8960 /* key-translation-map is applied *after* function-key-map
8961 which is itself applied *after* input-decode-map. */
8962 eassert (fkey
.end
<= indec
.start
);
8963 eassert (keytran
.end
<= fkey
.start
);
8965 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
8966 first_unbound
< keytran
.start
)
8967 { /* The prefix upto first_unbound has no binding and has
8968 no translation left to do either, so we know it's unbound.
8969 If we don't stop now, we risk staying here indefinitely
8970 (if the user keeps entering fkey or keytran prefixes
8971 like C-c ESC ESC ESC ESC ...) */
8973 for (i
= first_unbound
+ 1; i
< t
; i
++)
8974 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8975 mock_input
= t
- first_unbound
- 1;
8976 indec
.end
= indec
.start
-= first_unbound
+ 1;
8977 indec
.map
= indec
.parent
;
8978 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8979 fkey
.map
= fkey
.parent
;
8980 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8981 keytran
.map
= keytran
.parent
;
8982 goto replay_sequence
;
8986 error ("Key sequence too long");
8989 echo_local_start
= echo_length ();
8990 keys_local_start
= this_command_key_count
;
8993 /* These are no-ops, unless we throw away a keystroke below and
8994 jumped back up to replay_key; in that case, these restore the
8995 variables to their original state, allowing us to replay the
8997 if (INTERACTIVE
&& t
< mock_input
)
8998 echo_truncate (echo_local_start
);
8999 this_command_key_count
= keys_local_start
;
9001 /* By default, assume each event is "real". */
9002 last_real_key_start
= t
;
9004 /* Does mock_input indicate that we are re-reading a key sequence? */
9008 add_command_key (key
);
9009 if (current_kboard
->immediate_echo
)
9011 /* Set immediate_echo to false so as to force echo_now to
9012 redisplay (it will set immediate_echo right back to true). */
9013 current_kboard
->immediate_echo
= false;
9018 /* If not, we should actually read a character. */
9022 KBOARD
*interrupted_kboard
= current_kboard
;
9023 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9024 /* Calling read_char with COMMANDFLAG = -2 avoids
9025 redisplay in read_char and its subroutines. */
9026 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9027 current_binding
, last_nonmenu_event
,
9028 &used_mouse_menu
, NULL
);
9029 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9030 /* When switching to a new tty (with a new keyboard),
9031 read_char returns the new buffer, rather than -2
9032 (Bug#5095). This is because `terminal-init-xterm'
9033 calls read-char, which eats the wrong_kboard_jmpbuf
9034 return. Any better way to fix this? -- cyd */
9035 || (interrupted_kboard
!= current_kboard
))
9040 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9041 if (k
== interrupted_kboard
)
9046 /* Don't touch interrupted_kboard when it's been
9048 delayed_switch_frame
= Qnil
;
9049 goto replay_entire_sequence
;
9052 if (!NILP (delayed_switch_frame
))
9055 (interrupted_kboard
,
9056 Fcons (delayed_switch_frame
,
9057 KVAR (interrupted_kboard
, kbd_queue
)));
9058 delayed_switch_frame
= Qnil
;
9063 (interrupted_kboard
,
9064 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9066 /* If the side queue is non-empty, ensure it begins with a
9067 switch-frame, so we'll replay it in the right context. */
9068 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9069 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9070 !(EVENT_HAS_PARAMETERS (key
)
9071 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9075 XSETFRAME (frame
, interrupted_frame
);
9077 (interrupted_kboard
,
9078 Fcons (make_lispy_switch_frame (frame
),
9079 KVAR (interrupted_kboard
, kbd_queue
)));
9082 goto replay_entire_sequence
;
9086 /* read_char returns t when it shows a menu and the user rejects it.
9090 unbind_to (count
, Qnil
);
9094 /* read_char returns -1 at the end of a macro.
9095 Emacs 18 handles this by returning immediately with a
9096 zero, so that's what we'll do. */
9097 if (INTEGERP (key
) && XINT (key
) == -1)
9100 /* The Microsoft C compiler can't handle the goto that
9106 /* If the current buffer has been changed from under us, the
9107 keymap may have changed, so replay the sequence. */
9110 timer_resume_idle ();
9113 /* Reset the current buffer from the selected window
9114 in case something changed the former and not the latter.
9115 This is to be more consistent with the behavior
9116 of the command_loop_1. */
9117 if (fix_current_buffer
)
9119 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9121 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9123 Fset_buffer (XWINDOW (selected_window
)->contents
);
9126 goto replay_sequence
;
9129 /* If we have a quit that was typed in another frame, and
9130 quit_throw_to_read_char switched buffers,
9131 replay to get the right keymap. */
9133 && XINT (key
) == quit_char
9134 && current_buffer
!= starting_buffer
)
9137 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9142 goto replay_sequence
;
9147 if (EVENT_HAS_PARAMETERS (key
)
9148 /* Either a `switch-frame' or a `select-window' event. */
9149 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9151 /* If we're at the beginning of a key sequence, and the caller
9152 says it's okay, go ahead and return this event. If we're
9153 in the midst of a key sequence, delay it until the end. */
9154 if (t
> 0 || !can_return_switch_frame
)
9156 delayed_switch_frame
= key
;
9161 if (NILP (first_event
))
9164 /* Even if first_event does not specify a particular
9165 window/position, it's important to recompute the maps here
9166 since a long time might have passed since we entered
9167 read_key_sequence, and a timer (or process-filter or
9168 special-event-map, ...) might have switched the current buffer
9169 or the selected window from under us in the mean time. */
9170 if (fix_current_buffer
9171 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9173 Fset_buffer (XWINDOW (selected_window
)->contents
);
9174 current_binding
= active_maps (first_event
);
9178 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9182 /* Clicks in non-text areas get prefixed by the symbol
9183 in their CHAR-ADDRESS field. For example, a click on
9184 the mode line is prefixed by the symbol `mode-line'.
9186 Furthermore, key sequences beginning with mouse clicks
9187 are read using the keymaps of the buffer clicked on, not
9188 the current buffer. So we may have to switch the buffer
9191 When we turn one event into two events, we must make sure
9192 that neither of the two looks like the original--so that,
9193 if we replay the events, they won't be expanded again.
9194 If not for this, such reexpansion could happen either here
9195 or when user programs play with this-command-keys. */
9196 if (EVENT_HAS_PARAMETERS (key
))
9198 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9199 if (EQ (kind
, Qmouse_click
))
9201 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9202 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9205 || (!NILP (fake_prefixed_keys
)
9206 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9208 /* We're looking a second time at an event for which
9209 we generated a fake prefix key. Set
9210 last_real_key_start appropriately. */
9212 last_real_key_start
= t
- 1;
9215 if (last_real_key_start
== 0)
9217 /* Key sequences beginning with mouse clicks are
9218 read using the keymaps in the buffer clicked on,
9219 not the current buffer. If we're at the
9220 beginning of a key sequence, switch buffers. */
9221 if (WINDOWP (window
)
9222 && BUFFERP (XWINDOW (window
)->contents
)
9223 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9225 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9230 /* Arrange to go back to the original buffer once we're
9231 done reading the key sequence. Note that we can't
9232 use save_excursion_{save,restore} here, because they
9233 save point as well as the current buffer; we don't
9234 want to save point, because redisplay may change it,
9235 to accommodate a Fset_window_start or something. We
9236 don't want to do this at the top of the function,
9237 because we may get input from a subprocess which
9238 wants to change the selected window and stuff (say,
9240 record_unwind_current_buffer ();
9242 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9244 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9245 goto replay_sequence
;
9249 /* Expand mode-line and scroll-bar events into two events:
9250 use posn as a fake prefix key. */
9252 && (NILP (fake_prefixed_keys
)
9253 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9255 if (bufsize
- t
<= 1)
9256 error ("Key sequence too long");
9259 keybuf
[t
+ 1] = key
;
9262 /* Record that a fake prefix key has been generated
9263 for KEY. Don't modify the event; this would
9264 prevent proper action when the event is pushed
9265 back into unread-command-events. */
9266 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9270 else if (CONSP (XCDR (key
))
9271 && CONSP (EVENT_START (key
))
9272 && CONSP (XCDR (EVENT_START (key
))))
9276 posn
= POSN_POSN (EVENT_START (key
));
9277 /* Handle menu-bar events:
9278 insert the dummy prefix event `menu-bar'. */
9279 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9281 if (bufsize
- t
<= 1)
9282 error ("Key sequence too long");
9284 keybuf
[t
+ 1] = key
;
9286 /* Zap the position in key, so we know that we've
9287 expanded it, and don't try to do so again. */
9288 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9291 goto replay_sequence
;
9293 else if (CONSP (posn
))
9295 /* We're looking at the second event of a
9296 sequence which we expanded before. Set
9297 last_real_key_start appropriately. */
9298 if (last_real_key_start
== t
&& t
> 0)
9299 last_real_key_start
= t
- 1;
9304 /* We have finally decided that KEY is something we might want
9306 new_binding
= follow_key (current_binding
, key
);
9308 /* If KEY wasn't bound, we'll try some fallbacks. */
9309 if (!NILP (new_binding
))
9310 /* This is needed for the following scenario:
9311 event 0: a down-event that gets dropped by calling replay_key.
9312 event 1: some normal prefix like C-h.
9313 After event 0, first_unbound is 0, after event 1 indec.start,
9314 fkey.start, and keytran.start are all 1, so when we see that
9315 C-h is bound, we need to update first_unbound. */
9316 first_unbound
= max (t
+ 1, first_unbound
);
9321 /* Remember the position to put an upper bound on indec.start. */
9322 first_unbound
= min (t
, first_unbound
);
9324 head
= EVENT_HEAD (key
);
9328 Lisp_Object breakdown
;
9331 breakdown
= parse_modifiers (head
);
9332 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9333 /* Attempt to reduce an unbound mouse event to a simpler
9334 event that is bound:
9335 Drags reduce to clicks.
9336 Double-clicks reduce to clicks.
9337 Triple-clicks reduce to double-clicks, then to clicks.
9338 Up/Down-clicks are eliminated.
9339 Double-downs reduce to downs, then are eliminated.
9340 Triple-downs reduce to double-downs, then to downs,
9341 then are eliminated. */
9342 if (modifiers
& (up_modifier
| down_modifier
9344 | double_modifier
| triple_modifier
))
9346 while (modifiers
& (up_modifier
| down_modifier
9348 | double_modifier
| triple_modifier
))
9350 Lisp_Object new_head
, new_click
;
9351 if (modifiers
& triple_modifier
)
9352 modifiers
^= (double_modifier
| triple_modifier
);
9353 else if (modifiers
& double_modifier
)
9354 modifiers
&= ~double_modifier
;
9355 else if (modifiers
& drag_modifier
)
9356 modifiers
&= ~drag_modifier
;
9359 /* Dispose of this `up/down' event by simply jumping
9360 back to replay_key, to get another event.
9362 Note that if this event came from mock input,
9363 then just jumping back to replay_key will just
9364 hand it to us again. So we have to wipe out any
9367 We could delete keybuf[t] and shift everything
9368 after that to the left by one spot, but we'd also
9369 have to fix up any variable that points into
9370 keybuf, and shifting isn't really necessary
9373 Adding prefixes for non-textual mouse clicks
9374 creates two characters of mock input, and both
9375 must be thrown away. If we're only looking at
9376 the prefix now, we can just jump back to
9377 replay_key. On the other hand, if we've already
9378 processed the prefix, and now the actual click
9379 itself is giving us trouble, then we've lost the
9380 state of the keymaps we want to backtrack to, and
9381 we need to replay the whole sequence to rebuild
9384 Beyond that, only function key expansion could
9385 create more than two keys, but that should never
9386 generate mouse events, so it's okay to zero
9387 mock_input in that case too.
9389 FIXME: The above paragraph seems just plain
9390 wrong, if you consider things like
9391 xterm-mouse-mode. -stef
9393 Isn't this just the most wonderful code ever? */
9395 /* If mock_input > t + 1, the above simplification
9396 will actually end up dropping keys on the floor.
9397 This is probably OK for now, but even
9398 if mock_input <= t + 1, we need to adjust indec,
9400 Typical case [header-line down-mouse-N]:
9401 mock_input = 2, t = 1, fkey.end = 1,
9402 last_real_key_start = 0. */
9403 if (indec
.end
> last_real_key_start
)
9405 indec
.end
= indec
.start
9406 = min (last_real_key_start
, indec
.start
);
9407 indec
.map
= indec
.parent
;
9408 if (fkey
.end
> last_real_key_start
)
9410 fkey
.end
= fkey
.start
9411 = min (last_real_key_start
, fkey
.start
);
9412 fkey
.map
= fkey
.parent
;
9413 if (keytran
.end
> last_real_key_start
)
9415 keytran
.end
= keytran
.start
9416 = min (last_real_key_start
, keytran
.start
);
9417 keytran
.map
= keytran
.parent
;
9421 if (t
== last_real_key_start
)
9428 mock_input
= last_real_key_start
;
9429 goto replay_sequence
;
9434 = apply_modifiers (modifiers
, XCAR (breakdown
));
9435 new_click
= list2 (new_head
, EVENT_START (key
));
9437 /* Look for a binding for this new key. */
9438 new_binding
= follow_key (current_binding
, new_click
);
9440 /* If that click is bound, go for it. */
9441 if (!NILP (new_binding
))
9443 current_binding
= new_binding
;
9447 /* Otherwise, we'll leave key set to the drag event. */
9452 current_binding
= new_binding
;
9455 /* Normally, last_nonmenu_event gets the previous key we read.
9456 But when a mouse popup menu is being used,
9457 we don't update last_nonmenu_event; it continues to hold the mouse
9458 event that preceded the first level of menu. */
9459 if (!used_mouse_menu
)
9460 last_nonmenu_event
= key
;
9462 /* Record what part of this_command_keys is the current key sequence. */
9463 this_single_command_key_start
= this_command_key_count
- t
;
9464 /* When 'input-method-function' called above causes events to be
9465 put on 'unread-post-input-method-events', and as result
9466 'reread' is set to 'true', the value of 't' can become larger
9467 than 'this_command_key_count', because 'add_command_key' is
9468 not called to update 'this_command_key_count'. If this
9469 happens, 'this_single_command_key_start' will become negative
9470 above, and any call to 'this-single-command-keys' will return
9471 a garbled vector. See bug #20223 for one such situation.
9472 Here we force 'this_single_command_key_start' to never become
9473 negative, to avoid that. */
9474 if (this_single_command_key_start
< 0)
9475 this_single_command_key_start
= 0;
9477 /* Look for this sequence in input-decode-map.
9478 Scan from indec.end until we find a bound suffix. */
9479 while (indec
.end
< t
)
9484 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9488 mock_input
= diff
+ max (t
, mock_input
);
9489 goto replay_sequence
;
9493 if (!KEYMAPP (current_binding
)
9494 && !test_undefined (current_binding
)
9495 && indec
.start
>= t
)
9496 /* There is a binding and it's not a prefix.
9497 (and it doesn't have any input-decode-map translation pending).
9498 There is thus no function-key in this sequence.
9499 Moving fkey.start is important in this case to allow keytran.start
9500 to go over the sequence before we return (since we keep the
9501 invariant that keytran.end <= fkey.start). */
9504 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9507 /* If the sequence is unbound, see if we can hang a function key
9508 off the end of it. */
9509 /* Continue scan from fkey.end until we find a bound suffix. */
9510 while (fkey
.end
< indec
.start
)
9515 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9516 max (t
, mock_input
),
9517 /* If there's a binding (i.e.
9518 first_binding >= nmaps) we don't want
9519 to apply this function-key-mapping. */
9521 && (test_undefined (current_binding
)),
9525 mock_input
= diff
+ max (t
, mock_input
);
9526 /* Adjust the input-decode-map counters. */
9528 indec
.start
+= diff
;
9530 goto replay_sequence
;
9534 /* Look for this sequence in key-translation-map.
9535 Scan from keytran.end until we find a bound suffix. */
9536 while (keytran
.end
< fkey
.start
)
9541 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9545 mock_input
= diff
+ max (t
, mock_input
);
9546 /* Adjust the function-key-map and input-decode-map counters. */
9548 indec
.start
+= diff
;
9552 goto replay_sequence
;
9556 /* If KEY is not defined in any of the keymaps,
9557 and cannot be part of a function key or translation,
9558 and is an upper case letter
9559 use the corresponding lower-case letter instead. */
9560 if (NILP (current_binding
)
9561 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9563 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9564 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9565 || (XINT (key
) & shift_modifier
)))
9567 Lisp_Object new_key
;
9569 original_uppercase
= key
;
9570 original_uppercase_position
= t
- 1;
9572 if (XINT (key
) & shift_modifier
)
9573 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9575 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9576 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9578 /* We have to do this unconditionally, regardless of whether
9579 the lower-case char is defined in the keymaps, because they
9580 might get translated through function-key-map. */
9581 keybuf
[t
- 1] = new_key
;
9582 mock_input
= max (t
, mock_input
);
9583 shift_translated
= true;
9585 goto replay_sequence
;
9588 if (NILP (current_binding
)
9589 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9591 read_key_sequence_cmd
= Vprefix_help_command
;
9592 /* The Microsoft C compiler can't handle the goto that
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 a shifted function key,
9601 use the corresponding unshifted function key instead. */
9602 if (NILP (current_binding
)
9603 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9605 Lisp_Object breakdown
= parse_modifiers (key
);
9607 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9609 if (modifiers
& shift_modifier
9610 /* Treat uppercase keys as shifted. */
9612 && (KEY_TO_CHAR (key
)
9613 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9614 && uppercasep (KEY_TO_CHAR (key
))))
9617 = (modifiers
& shift_modifier
9618 ? apply_modifiers (modifiers
& ~shift_modifier
,
9620 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9622 original_uppercase
= key
;
9623 original_uppercase_position
= t
- 1;
9625 /* We have to do this unconditionally, regardless of whether
9626 the lower-case char is defined in the keymaps, because they
9627 might get translated through function-key-map. */
9628 keybuf
[t
- 1] = new_key
;
9629 mock_input
= max (t
, mock_input
);
9630 /* Reset fkey (and consequently keytran) to apply
9631 function-key-map on the result, so that S-backspace is
9632 correctly mapped to DEL (via backspace). OTOH,
9633 input-decode-map doesn't need to go through it again. */
9634 fkey
.start
= fkey
.end
= 0;
9635 keytran
.start
= keytran
.end
= 0;
9636 shift_translated
= true;
9638 goto replay_sequence
;
9643 read_key_sequence_cmd
= current_binding
;
9644 read_key_sequence_remapped
9645 /* Remap command through active keymaps.
9646 Do the remapping here, before the unbind_to so it uses the keymaps
9647 of the appropriate buffer. */
9648 = SYMBOLP (read_key_sequence_cmd
)
9649 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9652 unread_switch_frame
= delayed_switch_frame
;
9653 unbind_to (count
, Qnil
);
9655 /* Don't downcase the last character if the caller says don't.
9656 Don't downcase it if the result is undefined, either. */
9657 if ((dont_downcase_last
|| NILP (current_binding
))
9659 && t
- 1 == original_uppercase_position
)
9661 keybuf
[t
- 1] = original_uppercase
;
9662 shift_translated
= false;
9665 if (shift_translated
)
9666 Vthis_command_keys_shift_translated
= Qt
;
9668 /* Occasionally we fabricate events, perhaps by expanding something
9669 according to function-key-map, or by adding a prefix symbol to a
9670 mouse click in the scroll bar or modeline. In this cases, return
9671 the entire generated key sequence, even if we hit an unbound
9672 prefix or a definition before the end. This means that you will
9673 be able to push back the event properly, and also means that
9674 read-key-sequence will always return a logical unit.
9677 for (; t
< mock_input
; t
++)
9678 add_command_key (keybuf
[t
]);
9685 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9686 Lisp_Object dont_downcase_last
,
9687 Lisp_Object can_return_switch_frame
,
9688 Lisp_Object cmd_loop
, bool allow_string
)
9690 Lisp_Object keybuf
[30];
9692 ptrdiff_t count
= SPECPDL_INDEX ();
9695 CHECK_STRING (prompt
);
9698 specbind (Qinput_method_exit_on_first_char
,
9699 (NILP (cmd_loop
) ? Qt
: Qnil
));
9700 specbind (Qinput_method_use_echo_area
,
9701 (NILP (cmd_loop
) ? Qt
: Qnil
));
9703 if (NILP (continue_echo
))
9705 this_command_key_count
= 0;
9706 this_single_command_key_start
= 0;
9709 #ifdef HAVE_WINDOW_SYSTEM
9710 if (display_hourglass_p
)
9711 cancel_hourglass ();
9714 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9715 prompt
, ! NILP (dont_downcase_last
),
9716 ! NILP (can_return_switch_frame
), 0, 0);
9718 #if 0 /* The following is fine for code reading a key sequence and
9719 then proceeding with a lengthy computation, but it's not good
9720 for code reading keys in a loop, like an input method. */
9721 #ifdef HAVE_WINDOW_SYSTEM
9722 if (display_hourglass_p
)
9733 return unbind_to (count
,
9734 ((allow_string
? make_event_array
: Fvector
)
9738 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9739 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9740 The sequence is sufficient to specify a non-prefix command in the
9741 current local and global maps.
9743 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9744 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9745 as a continuation of the previous key.
9747 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9748 convert the last event to lower case. (Normally any upper case event
9749 is converted to lower case if the original event is undefined and the lower
9750 case equivalent is defined.) A non-nil value is appropriate for reading
9751 a key sequence to be defined.
9753 A C-g typed while in this function is treated like any other character,
9754 and `quit-flag' is not set.
9756 If the key sequence starts with a mouse click, then the sequence is read
9757 using the keymaps of the buffer of the window clicked in, not the buffer
9758 of the selected window as normal.
9760 `read-key-sequence' drops unbound button-down events, since you normally
9761 only care about the click or drag events which follow them. If a drag
9762 or multi-click event is unbound, but the corresponding click event would
9763 be bound, `read-key-sequence' turns the event into a click event at the
9764 drag's starting position. This means that you don't have to distinguish
9765 between click and drag, double, or triple events unless you want to.
9767 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9768 lines separating windows, and scroll bars with imaginary keys
9769 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9771 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9772 function will process a switch-frame event if the user switches frames
9773 before typing anything. If the user switches frames in the middle of a
9774 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9775 is nil, then the event will be put off until after the current key sequence.
9777 `read-key-sequence' checks `function-key-map' for function key
9778 sequences, where they wouldn't conflict with ordinary bindings. See
9779 `function-key-map' for more details.
9781 The optional fifth argument CMD-LOOP, if non-nil, means
9782 that this key sequence is being read by something that will
9783 read commands one after another. It should be nil if the caller
9784 will read just one key sequence. */)
9785 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9787 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9788 can_return_switch_frame
, cmd_loop
, true);
9791 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9792 Sread_key_sequence_vector
, 1, 5, 0,
9793 doc
: /* Like `read-key-sequence' but always return a vector. */)
9794 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9796 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9797 can_return_switch_frame
, cmd_loop
, false);
9800 /* Return true if input events are pending. */
9803 detect_input_pending (void)
9805 return input_pending
|| get_input_pending (0);
9808 /* Return true if input events other than mouse movements are
9812 detect_input_pending_ignore_squeezables (void)
9814 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9817 /* Return true if input events are pending, and run any pending timers. */
9820 detect_input_pending_run_timers (bool do_display
)
9822 unsigned old_timers_run
= timers_run
;
9825 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9827 if (old_timers_run
!= timers_run
&& do_display
)
9828 redisplay_preserve_echo_area (8);
9830 return input_pending
;
9833 /* This is called in some cases before a possible quit.
9834 It cases the next call to detect_input_pending to recompute input_pending.
9835 So calling this function unnecessarily can't do any harm. */
9838 clear_input_pending (void)
9840 input_pending
= false;
9843 /* Return true if there are pending requeued events.
9844 This isn't used yet. The hope is to make wait_reading_process_output
9845 call it, and return if it runs Lisp code that unreads something.
9846 The problem is, kbd_buffer_get_event needs to be fixed to know what
9847 to do in that case. It isn't trivial. */
9850 requeued_events_pending_p (void)
9852 return (!NILP (Vunread_command_events
));
9855 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9856 doc
: /* Return t if command input is currently available with no wait.
9857 Actually, the value is nil only if we can be sure that no input is available;
9858 if there is a doubt, the value is t.
9860 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9861 (Lisp_Object check_timers
)
9863 if (!NILP (Vunread_command_events
)
9864 || !NILP (Vunread_post_input_method_events
)
9865 || !NILP (Vunread_input_method_events
))
9868 /* Process non-user-visible events (Bug#10195). */
9869 process_special_events ();
9871 return (get_input_pending ((NILP (check_timers
)
9872 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9873 | READABLE_EVENTS_FILTER_EVENTS
)
9877 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
9878 doc
: /* Return vector of last few events, not counting those from keyboard macros.
9879 If INCLUDE-CMDS is non-nil, include the commands that were run,
9880 represented as events of the form (nil . COMMAND). */)
9881 (Lisp_Object include_cmds
)
9883 bool cmds
= !NILP (include_cmds
);
9886 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
9887 return Fvector (total_keys
,
9888 XVECTOR (recent_keys
)->contents
);
9891 Lisp_Object es
= Qnil
;
9892 int i
= (total_keys
< NUM_RECENT_KEYS
9893 ? 0 : recent_keys_index
);
9894 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
9897 Lisp_Object e
= AREF (recent_keys
, i
);
9898 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
9900 if (++i
>= NUM_RECENT_KEYS
)
9902 } while (i
!= recent_keys_index
);
9903 es
= Fnreverse (es
);
9904 return Fvconcat (1, &es
);
9908 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9909 doc
: /* Return the key sequence that invoked this command.
9910 However, if the command has called `read-key-sequence', it returns
9911 the last key sequence that has been read.
9912 The value is a string or a vector.
9914 See also `this-command-keys-vector'. */)
9917 return make_event_array (this_command_key_count
,
9918 XVECTOR (this_command_keys
)->contents
);
9921 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9922 doc
: /* Return the key sequence that invoked this command, as a vector.
9923 However, if the command has called `read-key-sequence', it returns
9924 the last key sequence that has been read.
9926 See also `this-command-keys'. */)
9929 return Fvector (this_command_key_count
,
9930 XVECTOR (this_command_keys
)->contents
);
9933 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9934 Sthis_single_command_keys
, 0, 0, 0,
9935 doc
: /* Return the key sequence that invoked this command.
9936 More generally, it returns the last key sequence read, either by
9937 the command loop or by `read-key-sequence'.
9938 Unlike `this-command-keys', this function's value
9939 does not include prefix arguments.
9940 The value is always a vector. */)
9943 return Fvector (this_command_key_count
9944 - this_single_command_key_start
,
9945 (XVECTOR (this_command_keys
)->contents
9946 + this_single_command_key_start
));
9949 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9950 Sthis_single_command_raw_keys
, 0, 0, 0,
9951 doc
: /* Return the raw events that were read for this command.
9952 More generally, it returns the last key sequence read, either by
9953 the command loop or by `read-key-sequence'.
9954 Unlike `this-single-command-keys', this function's value
9955 shows the events before all translations (except for input methods).
9956 The value is always a vector. */)
9959 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
9962 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9963 Sclear_this_command_keys
, 0, 1, 0,
9964 doc
: /* Clear out the vector that `this-command-keys' returns.
9965 Also clear the record of the last 100 events, unless optional arg
9966 KEEP-RECORD is non-nil. */)
9967 (Lisp_Object keep_record
)
9971 this_command_key_count
= 0;
9973 if (NILP (keep_record
))
9975 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
9976 ASET (recent_keys
, i
, Qnil
);
9978 recent_keys_index
= 0;
9983 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9984 doc
: /* Return the current depth in recursive edits. */)
9988 /* Wrap around reliably on integer overflow. */
9989 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
9990 XSETINT (temp
, sum
);
9994 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9995 "FOpen dribble file: ",
9996 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
9997 If FILE is nil, close any open dribble file.
9998 The file will be closed when Emacs exits.
10000 Be aware that this records ALL characters you type!
10001 This may include sensitive information such as passwords. */)
10014 Lisp_Object encfile
;
10016 file
= Fexpand_file_name (file
, Qnil
);
10017 encfile
= ENCODE_FILE (file
);
10018 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10019 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10020 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10021 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10023 report_file_error ("Opening dribble", file
);
10028 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10029 doc
: /* Discard the contents of the terminal input buffer.
10030 Also end any kbd macro being defined. */)
10033 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10035 /* Discard the last command from the macro. */
10036 Fcancel_kbd_macro_events ();
10040 Vunread_command_events
= Qnil
;
10042 discard_tty_input ();
10044 kbd_fetch_ptr
= kbd_store_ptr
;
10045 input_pending
= false;
10050 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10051 doc
: /* Stop Emacs and return to superior process. You can resume later.
10052 If `cannot-suspend' is non-nil, or if the system doesn't support job
10053 control, run a subshell instead.
10055 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10056 to be read as terminal input by Emacs's parent, after suspension.
10058 Before suspending, run the normal hook `suspend-hook'.
10059 After resumption run the normal hook `suspend-resume-hook'.
10061 Some operating systems cannot stop the Emacs process and resume it later.
10062 On such systems, Emacs starts a subshell instead of suspending. */)
10063 (Lisp_Object stuffstring
)
10065 ptrdiff_t count
= SPECPDL_INDEX ();
10066 int old_height
, old_width
;
10069 if (tty_list
&& tty_list
->next
)
10070 error ("There are other tty frames open; close them before suspending Emacs");
10072 if (!NILP (stuffstring
))
10073 CHECK_STRING (stuffstring
);
10075 run_hook (intern ("suspend-hook"));
10077 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10078 reset_all_sys_modes ();
10079 /* sys_suspend can get an error if it tries to fork a subshell
10080 and the system resources aren't available for that. */
10081 record_unwind_protect_void (init_all_sys_modes
);
10082 stuff_buffered_input (stuffstring
);
10083 if (cannot_suspend
)
10087 unbind_to (count
, Qnil
);
10089 /* Check if terminal/window size has changed.
10090 Note that this is not useful when we are running directly
10091 with a window system; but suspend should be disabled in that case. */
10092 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10093 if (width
!= old_width
|| height
!= old_height
)
10094 change_frame_size (SELECTED_FRAME (), width
,
10095 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10098 run_hook (intern ("suspend-resume-hook"));
10103 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10104 Then in any case stuff anything Emacs has read ahead and not used. */
10107 stuff_buffered_input (Lisp_Object stuffstring
)
10109 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10110 register unsigned char *p
;
10112 if (STRINGP (stuffstring
))
10114 register ptrdiff_t count
;
10116 p
= SDATA (stuffstring
);
10117 count
= SBYTES (stuffstring
);
10118 while (count
-- > 0)
10123 /* Anything we have read ahead, put back for the shell to read. */
10124 /* ?? What should this do when we have multiple keyboards??
10125 Should we ignore anything that was typed in at the "wrong" kboard?
10127 rms: we should stuff everything back into the kboard
10129 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10132 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10133 kbd_fetch_ptr
= kbd_buffer
;
10134 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10135 stuff_char (kbd_fetch_ptr
->ie
.code
);
10137 clear_event (kbd_fetch_ptr
);
10140 input_pending
= false;
10141 #endif /* SIGTSTP */
10145 set_waiting_for_input (struct timespec
*time_to_clear
)
10147 input_available_clear_time
= time_to_clear
;
10149 /* Tell handle_interrupt to throw back to read_char, */
10150 waiting_for_input
= true;
10152 /* If handle_interrupt was called before and buffered a C-g,
10153 make it run again now, to avoid timing error. */
10154 if (!NILP (Vquit_flag
))
10155 quit_throw_to_read_char (0);
10159 clear_waiting_for_input (void)
10161 /* Tell handle_interrupt not to throw back to read_char, */
10162 waiting_for_input
= false;
10163 input_available_clear_time
= 0;
10166 /* The SIGINT handler.
10168 If we have a frame on the controlling tty, we assume that the
10169 SIGINT was generated by C-g, so we call handle_interrupt.
10170 Otherwise, tell QUIT to kill Emacs. */
10173 handle_interrupt_signal (int sig
)
10175 /* See if we have an active terminal on our controlling tty. */
10176 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10179 /* If there are no frames there, let's pretend that we are a
10180 well-behaving UN*X program and quit. We must not call Lisp
10181 in a signal handler, so tell QUIT to exit when it is
10183 Vquit_flag
= Qkill_emacs
;
10187 /* Otherwise, the SIGINT was probably generated by C-g. */
10189 /* Set internal_last_event_frame to the top frame of the
10190 controlling tty, if we have a frame there. We disable the
10191 interrupt key on secondary ttys, so the SIGINT must have come
10192 from the controlling tty. */
10193 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10195 handle_interrupt (1);
10200 deliver_interrupt_signal (int sig
)
10202 deliver_process_signal (sig
, handle_interrupt_signal
);
10206 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10207 of the number of times C-g has been requested. If C-g is pressed
10208 enough times, then quit anyway. See bug#6585. */
10209 static int volatile force_quit_count
;
10211 /* This routine is called at interrupt level in response to C-g.
10213 It is called from the SIGINT handler or kbd_buffer_store_event.
10215 If `waiting_for_input' is non zero, then unless `echoing' is
10216 nonzero, immediately throw back to read_char.
10218 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10219 eval to throw, when it gets a chance. If quit-flag is already
10220 non-nil, it stops the job right away. */
10223 handle_interrupt (bool in_signal_handler
)
10229 /* XXX This code needs to be revised for multi-tty support. */
10230 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10232 if (! in_signal_handler
)
10234 /* If SIGINT isn't blocked, don't let us be interrupted by
10235 a SIGINT. It might be harmful due to non-reentrancy
10236 in I/O functions. */
10238 sigemptyset (&blocked
);
10239 sigaddset (&blocked
, SIGINT
);
10240 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10244 reset_all_sys_modes ();
10248 * On systems which can suspend the current process and return to the original
10249 * shell, this command causes the user to end up back at the shell.
10250 * The "Auto-save" and "Abort" questions are not asked until
10251 * the user elects to return to emacs, at which point he can save the current
10252 * job and either dump core or continue.
10256 /* Perhaps should really fork an inferior shell?
10257 But that would not provide any way to get back
10258 to the original shell, ever. */
10259 printf ("No support for stopping a process on this operating system;\n");
10260 printf ("you can continue or abort.\n");
10261 #endif /* not SIGTSTP */
10263 /* We must remain inside the screen area when the internal terminal
10264 is used. Note that [Enter] is not echoed by dos. */
10265 cursor_to (SELECTED_FRAME (), 0, 0);
10267 /* It doesn't work to autosave while GC is in progress;
10268 the code used for auto-saving doesn't cope with the mark bit. */
10269 if (!gc_in_progress
)
10271 printf ("Auto-save? (y or n) ");
10273 if (((c
= getchar ()) & ~040) == 'Y')
10275 Fdo_auto_save (Qt
, Qnil
);
10277 printf ("\r\nAuto-save done");
10278 #else /* not MSDOS */
10279 printf ("Auto-save done\n");
10280 #endif /* not MSDOS */
10282 while (c
!= '\n') c
= getchar ();
10286 /* During GC, it must be safe to reenable quitting again. */
10287 Vinhibit_quit
= Qnil
;
10290 #endif /* not MSDOS */
10291 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10292 printf ("but will instead do a real quit after garbage collection ends\r\n");
10297 printf ("\r\nAbort? (y or n) ");
10298 #else /* not MSDOS */
10299 printf ("Abort (and dump core)? (y or n) ");
10300 #endif /* not MSDOS */
10302 if (((c
= getchar ()) & ~040) == 'Y')
10304 while (c
!= '\n') c
= getchar ();
10306 printf ("\r\nContinuing...\r\n");
10307 #else /* not MSDOS */
10308 printf ("Continuing...\n");
10309 #endif /* not MSDOS */
10311 init_all_sys_modes ();
10315 /* If executing a function that wants to be interrupted out of
10316 and the user has not deferred quitting by binding `inhibit-quit'
10317 then quit right away. */
10318 if (immediate_quit
&& NILP (Vinhibit_quit
))
10320 struct gl_state_s saved
;
10322 immediate_quit
= false;
10323 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10325 Fsignal (Qquit
, Qnil
);
10329 { /* Else request quit when it's safe. */
10330 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10331 force_quit_count
= count
;
10334 immediate_quit
= true;
10335 Vinhibit_quit
= Qnil
;
10341 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10343 /* TODO: The longjmp in this call throws the NS event loop integration off,
10344 and it seems to do fine without this. Probably some attention
10345 needs to be paid to the setting of waiting_for_input in
10346 wait_reading_process_output() under HAVE_NS because of the call
10347 to ns_select there (needed because otherwise events aren't picked up
10348 outside of polling since we don't get SIGIO like X and we don't have a
10349 separate event loop thread like W32. */
10351 if (waiting_for_input
&& !echoing
)
10352 quit_throw_to_read_char (in_signal_handler
);
10356 /* Handle a C-g by making read_char return C-g. */
10359 quit_throw_to_read_char (bool from_signal
)
10361 /* When not called from a signal handler it is safe to call
10363 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10364 Fkill_emacs (Qnil
);
10366 /* Prevent another signal from doing this before we finish. */
10367 clear_waiting_for_input ();
10368 input_pending
= false;
10370 Vunread_command_events
= Qnil
;
10372 if (FRAMEP (internal_last_event_frame
)
10373 && !EQ (internal_last_event_frame
, selected_frame
))
10374 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10377 sys_longjmp (getcjmp
, 1);
10380 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10381 Sset_input_interrupt_mode
, 1, 1, 0,
10382 doc
: /* Set interrupt mode of reading keyboard input.
10383 If INTERRUPT is non-nil, Emacs will use input interrupts;
10384 otherwise Emacs uses CBREAK mode.
10386 See also `current-input-mode'. */)
10387 (Lisp_Object interrupt
)
10389 bool new_interrupt_input
;
10390 #ifdef USABLE_SIGIO
10391 #ifdef HAVE_X_WINDOWS
10392 if (x_display_list
!= NULL
)
10394 /* When using X, don't give the user a real choice,
10395 because we haven't implemented the mechanisms to support it. */
10396 new_interrupt_input
= true;
10399 #endif /* HAVE_X_WINDOWS */
10400 new_interrupt_input
= !NILP (interrupt
);
10401 #else /* not USABLE_SIGIO */
10402 new_interrupt_input
= false;
10403 #endif /* not USABLE_SIGIO */
10405 if (new_interrupt_input
!= interrupt_input
)
10407 #ifdef POLL_FOR_INPUT
10411 /* this causes startup screen to be restored and messes with the mouse */
10412 reset_all_sys_modes ();
10413 interrupt_input
= new_interrupt_input
;
10414 init_all_sys_modes ();
10416 interrupt_input
= new_interrupt_input
;
10419 #ifdef POLL_FOR_INPUT
10420 poll_suppress_count
= 1;
10427 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10428 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10429 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10430 C-q in key sequences.
10432 This setting only has an effect on tty terminals and only when
10433 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10435 See also `current-input-mode'. */)
10436 (Lisp_Object flow
, Lisp_Object terminal
)
10438 struct terminal
*t
= decode_tty_terminal (terminal
);
10439 struct tty_display_info
*tty
;
10443 tty
= t
->display_info
.tty
;
10445 if (tty
->flow_control
!= !NILP (flow
))
10448 /* This causes startup screen to be restored and messes with the mouse. */
10449 reset_sys_modes (tty
);
10452 tty
->flow_control
= !NILP (flow
);
10455 init_sys_modes (tty
);
10461 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10462 doc
: /* Enable or disable 8-bit input on TERMINAL.
10463 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10464 bit as the Meta modifier.
10466 If META is nil, Emacs will ignore the top bit, on the assumption it is
10469 Otherwise, Emacs will accept and pass through 8-bit input without
10470 specially interpreting the top bit.
10472 This setting only has an effect on tty terminal devices.
10474 Optional parameter TERMINAL specifies the tty terminal device to use.
10475 It may be a terminal object, a frame, or nil for the terminal used by
10476 the currently selected frame.
10478 See also `current-input-mode'. */)
10479 (Lisp_Object meta
, Lisp_Object terminal
)
10481 struct terminal
*t
= decode_tty_terminal (terminal
);
10482 struct tty_display_info
*tty
;
10487 tty
= t
->display_info
.tty
;
10491 else if (EQ (meta
, Qt
))
10496 if (tty
->meta_key
!= new_meta
)
10499 /* this causes startup screen to be restored and messes with the mouse */
10500 reset_sys_modes (tty
);
10503 tty
->meta_key
= new_meta
;
10506 init_sys_modes (tty
);
10512 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10513 doc
: /* Specify character used for quitting.
10514 QUIT must be an ASCII character.
10516 This function only has an effect on the controlling tty of the Emacs
10519 See also `current-input-mode'. */)
10522 struct terminal
*t
= get_named_terminal ("/dev/tty");
10523 struct tty_display_info
*tty
;
10527 tty
= t
->display_info
.tty
;
10529 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10530 error ("QUIT must be an ASCII character");
10533 /* this causes startup screen to be restored and messes with the mouse */
10534 reset_sys_modes (tty
);
10537 /* Don't let this value be out of range. */
10538 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10541 init_sys_modes (tty
);
10547 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10548 doc
: /* Set mode of reading keyboard input.
10549 First arg INTERRUPT non-nil means use input interrupts;
10550 nil means use CBREAK mode.
10551 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10552 (no effect except in CBREAK mode).
10553 Third arg META t means accept 8-bit input (for a Meta key).
10554 META nil means ignore the top bit, on the assumption it is parity.
10555 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10556 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10557 See also `current-input-mode'. */)
10558 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10560 Fset_input_interrupt_mode (interrupt
);
10561 Fset_output_flow_control (flow
, Qnil
);
10562 Fset_input_meta_mode (meta
, Qnil
);
10564 Fset_quit_char (quit
);
10568 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10569 doc
: /* Return information about the way Emacs currently reads keyboard input.
10570 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10571 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10572 nil, Emacs is using CBREAK mode.
10573 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10574 terminal; this does not apply if Emacs uses interrupt-driven input.
10575 META is t if accepting 8-bit input with 8th bit as Meta flag.
10576 META nil means ignoring the top bit, on the assumption it is parity.
10577 META is neither t nor nil if accepting 8-bit input and using
10578 all 8 bits as the character code.
10579 QUIT is the character Emacs currently uses to quit.
10580 The elements of this list correspond to the arguments of
10581 `set-input-mode'. */)
10584 struct frame
*sf
= XFRAME (selected_frame
);
10586 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10587 Lisp_Object flow
, meta
;
10588 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10590 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10591 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10593 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10600 Lisp_Object quit
= make_number (quit_char
);
10602 return list4 (interrupt
, flow
, meta
, quit
);
10605 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10606 doc
: /* Return position information for pixel coordinates X and Y.
10607 By default, X and Y are relative to text area of the selected window.
10608 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10609 If optional fourth arg WHOLE is non-nil, X is relative to the left
10610 edge of the window.
10612 The return value is similar to a mouse click position:
10613 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10614 IMAGE (DX . DY) (WIDTH . HEIGHT))
10615 The `posn-' functions access elements of such lists. */)
10616 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10619 /* We allow X of -1, for the newline in a R2L line that overflowed
10620 into the left fringe. */
10621 if (XINT (x
) != -1)
10625 if (NILP (frame_or_window
))
10626 frame_or_window
= selected_window
;
10628 if (WINDOWP (frame_or_window
))
10630 struct window
*w
= decode_live_window (frame_or_window
);
10632 XSETINT (x
, (XINT (x
)
10633 + WINDOW_LEFT_EDGE_X (w
)
10635 ? window_box_left_offset (w
, TEXT_AREA
)
10637 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10638 frame_or_window
= w
->frame
;
10641 CHECK_LIVE_FRAME (frame_or_window
);
10643 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10646 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10647 doc
: /* Return position information for buffer POS in WINDOW.
10648 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10650 Return nil if position is not visible in window. Otherwise,
10651 the return value is similar to that returned by `event-start' for
10652 a mouse click at the upper left corner of the glyph corresponding
10653 to the given buffer position:
10654 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10655 IMAGE (DX . DY) (WIDTH . HEIGHT))
10656 The `posn-' functions access elements of such lists. */)
10657 (Lisp_Object pos
, Lisp_Object window
)
10662 window
= selected_window
;
10664 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10667 Lisp_Object x
= XCAR (tem
);
10668 Lisp_Object y
= XCAR (XCDR (tem
));
10670 /* Point invisible due to hscrolling? X can be -1 when a
10671 newline in a R2L line overflows into the left fringe. */
10674 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10680 /* Set up a new kboard object with reasonable initial values.
10681 TYPE is a window system for which this keyboard is used. */
10684 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10686 kset_overriding_terminal_local_map (kb
, Qnil
);
10687 kset_last_command (kb
, Qnil
);
10688 kset_real_last_command (kb
, Qnil
);
10689 kset_keyboard_translate_table (kb
, Qnil
);
10690 kset_last_repeatable_command (kb
, Qnil
);
10691 kset_prefix_arg (kb
, Qnil
);
10692 kset_last_prefix_arg (kb
, Qnil
);
10693 kset_kbd_queue (kb
, Qnil
);
10694 kb
->kbd_queue_has_data
= false;
10695 kb
->immediate_echo
= false;
10696 kset_echo_string (kb
, Qnil
);
10697 kset_echo_prompt (kb
, Qnil
);
10698 kb
->kbd_macro_buffer
= 0;
10699 kb
->kbd_macro_bufsize
= 0;
10700 kset_defining_kbd_macro (kb
, Qnil
);
10701 kset_last_kbd_macro (kb
, Qnil
);
10702 kb
->reference_count
= 0;
10703 kset_system_key_alist (kb
, Qnil
);
10704 kset_system_key_syms (kb
, Qnil
);
10705 kset_window_system (kb
, type
);
10706 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10707 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10708 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10709 kset_default_minibuffer_frame (kb
, Qnil
);
10712 /* Allocate and basically initialize keyboard
10713 object to use with window system TYPE. */
10716 allocate_kboard (Lisp_Object type
)
10718 KBOARD
*kb
= xmalloc (sizeof *kb
);
10720 init_kboard (kb
, type
);
10721 kb
->next_kboard
= all_kboards
;
10727 * Destroy the contents of a kboard object, but not the object itself.
10728 * We use this just before deleting it, or if we're going to initialize
10729 * it a second time.
10732 wipe_kboard (KBOARD
*kb
)
10734 xfree (kb
->kbd_macro_buffer
);
10737 /* Free KB and memory referenced from it. */
10740 delete_kboard (KBOARD
*kb
)
10744 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10747 *kbp
= kb
->next_kboard
;
10749 /* Prevent a dangling reference to KB. */
10750 if (kb
== current_kboard
10751 && FRAMEP (selected_frame
)
10752 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10754 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10755 single_kboard
= false;
10756 if (current_kboard
== kb
)
10765 init_keyboard (void)
10767 /* This is correct before outermost invocation of the editor loop. */
10768 command_loop_level
= -1;
10769 immediate_quit
= false;
10770 quit_char
= Ctl ('g');
10771 Vunread_command_events
= Qnil
;
10772 timer_idleness_start_time
= invalid_timespec ();
10774 recent_keys_index
= 0;
10775 kbd_fetch_ptr
= kbd_buffer
;
10776 kbd_store_ptr
= kbd_buffer
;
10777 do_mouse_tracking
= Qnil
;
10778 input_pending
= false;
10779 interrupt_input_blocked
= 0;
10780 pending_signals
= false;
10782 /* This means that command_loop_1 won't try to select anything the first
10784 internal_last_event_frame
= Qnil
;
10785 Vlast_event_frame
= internal_last_event_frame
;
10787 current_kboard
= initial_kboard
;
10788 /* Re-initialize the keyboard again. */
10789 wipe_kboard (current_kboard
);
10790 /* A value of nil for Vwindow_system normally means a tty, but we also use
10791 it for the initial terminal since there is no window system there. */
10792 init_kboard (current_kboard
, Qnil
);
10794 if (!noninteractive
)
10796 /* Before multi-tty support, these handlers used to be installed
10797 only if the current session was a tty session. Now an Emacs
10798 session may have multiple display types, so we always handle
10799 SIGINT. There is special code in handle_interrupt_signal to exit
10800 Emacs on SIGINT when there are no termcap frames on the
10801 controlling terminal. */
10802 struct sigaction action
;
10803 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10804 sigaction (SIGINT
, &action
, 0);
10806 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10807 SIGQUIT and we can't tell which one it will give us. */
10808 sigaction (SIGQUIT
, &action
, 0);
10809 #endif /* not DOS_NT */
10811 #ifdef USABLE_SIGIO
10812 if (!noninteractive
)
10814 struct sigaction action
;
10815 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10816 sigaction (SIGIO
, &action
, 0);
10820 /* Use interrupt input by default, if it works and noninterrupt input
10821 has deficiencies. */
10823 #ifdef INTERRUPT_INPUT
10824 interrupt_input
= 1;
10826 interrupt_input
= 0;
10829 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10832 if (keyboard_init_hook
)
10833 (*keyboard_init_hook
) ();
10835 #ifdef POLL_FOR_INPUT
10837 poll_suppress_count
= 1;
10842 /* This type's only use is in syms_of_keyboard, to put properties on the
10843 event header symbols. */
10850 static const struct event_head head_table
[] = {
10851 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10852 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10854 /* Some of the event heads. */
10855 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
10857 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
10858 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
10859 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
10860 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
10861 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
10862 /* `select-window' should be handled just like `switch-frame'
10863 in read_key_sequence. */
10864 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
10868 syms_of_keyboard (void)
10870 pending_funcalls
= Qnil
;
10871 staticpro (&pending_funcalls
);
10873 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10874 staticpro (&Vlispy_mouse_stem
);
10876 regular_top_level_message
= build_pure_c_string ("Back to top level");
10877 #ifdef HAVE_STACK_OVERFLOW_HANDLING
10878 recover_top_level_message
10879 = build_pure_c_string ("Re-entering top level after C stack overflow");
10881 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
10882 doc
: /* Message displayed by `normal-top-level'. */);
10883 Vinternal__top_level_message
= regular_top_level_message
;
10886 DEFSYM (QCimage
, ":image");
10887 DEFSYM (Qhelp_echo
, "help-echo");
10888 DEFSYM (QCrtl
, ":rtl");
10890 staticpro (&item_properties
);
10891 item_properties
= Qnil
;
10893 staticpro (&tool_bar_item_properties
);
10894 tool_bar_item_properties
= Qnil
;
10895 staticpro (&tool_bar_items_vector
);
10896 tool_bar_items_vector
= Qnil
;
10898 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10900 /* Non-nil disable property on a command means do not execute it;
10901 call disabled-command-function's value instead. */
10902 DEFSYM (Qdisabled
, "disabled");
10904 DEFSYM (Qundefined
, "undefined");
10906 /* Hooks to run before and after each command. */
10907 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10908 DEFSYM (Qpost_command_hook
, "post-command-hook");
10910 DEFSYM (Qundo_auto__add_boundary
, "undo-auto--add-boundary");
10912 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10913 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10914 DEFSYM (Qfunction_key
, "function-key");
10916 /* The values of Qevent_kind properties. */
10917 DEFSYM (Qmouse_click
, "mouse-click");
10919 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10920 DEFSYM (Qsave_session
, "save-session");
10921 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10923 /* Menu and tool bar item parts. */
10924 DEFSYM (Qmenu_enable
, "menu-enable");
10927 DEFSYM (Qlanguage_change
, "language-change");
10931 DEFSYM (Qdbus_event
, "dbus-event");
10934 #ifdef USE_FILE_NOTIFY
10935 DEFSYM (Qfile_notify
, "file-notify");
10936 #endif /* USE_FILE_NOTIFY */
10938 /* Menu and tool bar item parts. */
10939 DEFSYM (QCenable
, ":enable");
10940 DEFSYM (QCvisible
, ":visible");
10941 DEFSYM (QChelp
, ":help");
10942 DEFSYM (QCfilter
, ":filter");
10943 DEFSYM (QCbutton
, ":button");
10944 DEFSYM (QCkeys
, ":keys");
10945 DEFSYM (QCkey_sequence
, ":key-sequence");
10947 /* Non-nil disable property on a command means
10948 do not execute it; call disabled-command-function's value instead. */
10949 DEFSYM (QCtoggle
, ":toggle");
10950 DEFSYM (QCradio
, ":radio");
10951 DEFSYM (QClabel
, ":label");
10952 DEFSYM (QCvert_only
, ":vert-only");
10954 /* Symbols to use for parts of windows. */
10955 DEFSYM (Qvertical_line
, "vertical-line");
10956 DEFSYM (Qright_divider
, "right-divider");
10957 DEFSYM (Qbottom_divider
, "bottom-divider");
10959 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
10961 DEFSYM (Qabove_handle
, "above-handle");
10962 DEFSYM (Qhandle
, "handle");
10963 DEFSYM (Qbelow_handle
, "below-handle");
10964 DEFSYM (Qup
, "up");
10965 DEFSYM (Qdown
, "down");
10966 DEFSYM (Qtop
, "top");
10967 DEFSYM (Qbottom
, "bottom");
10968 DEFSYM (Qend_scroll
, "end-scroll");
10969 DEFSYM (Qratio
, "ratio");
10970 DEFSYM (Qbefore_handle
, "before-handle");
10971 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
10972 DEFSYM (Qafter_handle
, "after-handle");
10973 DEFSYM (Qleft
, "left");
10974 DEFSYM (Qright
, "right");
10975 DEFSYM (Qleftmost
, "leftmost");
10976 DEFSYM (Qrightmost
, "rightmost");
10978 /* Properties of event headers. */
10979 DEFSYM (Qevent_kind
, "event-kind");
10980 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
10982 /* An event header symbol HEAD may have a property named
10983 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
10984 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
10985 mask of modifiers applied to it. If present, this is used to help
10986 speed up parse_modifiers. */
10987 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
10989 /* An unmodified event header BASE may have a property named
10990 Qmodifier_cache, which is an alist mapping modifier masks onto
10991 modified versions of BASE. If present, this helps speed up
10992 apply_modifiers. */
10993 DEFSYM (Qmodifier_cache
, "modifier-cache");
10995 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
10996 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
10998 DEFSYM (Qpolling_period
, "polling-period");
11000 DEFSYM (Qgui_set_selection
, "gui-set-selection");
11002 /* The primary selection. */
11003 DEFSYM (QPRIMARY
, "PRIMARY");
11005 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11006 DEFSYM (Qhandle_select_window
, "handle-select-window");
11008 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11009 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11011 DEFSYM (Qhelp_form_show
, "help-form-show");
11013 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11015 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11016 Fset (Qinput_method_use_echo_area
, Qnil
);
11018 /* Symbols to head events. */
11019 DEFSYM (Qmouse_movement
, "mouse-movement");
11020 DEFSYM (Qscroll_bar_movement
, "scroll-bar-movement");
11021 DEFSYM (Qswitch_frame
, "switch-frame");
11022 DEFSYM (Qfocus_in
, "focus-in");
11023 DEFSYM (Qfocus_out
, "focus-out");
11024 DEFSYM (Qdelete_frame
, "delete-frame");
11025 DEFSYM (Qiconify_frame
, "iconify-frame");
11026 DEFSYM (Qmake_frame_visible
, "make-frame-visible");
11027 DEFSYM (Qselect_window
, "select-window");
11031 for (i
= 0; i
< ARRAYELTS (head_table
); i
++)
11033 const struct event_head
*p
= &head_table
[i
];
11034 Lisp_Object var
= builtin_lisp_symbol (p
->var
);
11035 Lisp_Object kind
= builtin_lisp_symbol (p
->kind
);
11036 Fput (var
, Qevent_kind
, kind
);
11037 Fput (var
, Qevent_symbol_elements
, list1 (var
));
11041 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11042 staticpro (&button_down_location
);
11043 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11044 staticpro (&mouse_syms
);
11045 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11047 staticpro (&wheel_syms
);
11051 int len
= ARRAYELTS (modifier_names
);
11053 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11054 for (i
= 0; i
< len
; i
++)
11055 if (modifier_names
[i
])
11056 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11057 staticpro (&modifier_symbols
);
11060 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11061 staticpro (&recent_keys
);
11063 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11064 staticpro (&this_command_keys
);
11066 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11067 staticpro (&raw_keybuf
);
11069 DEFSYM (Qcommand_execute
, "command-execute");
11070 DEFSYM (Qinternal_echo_keystrokes_prefix
, "internal-echo-keystrokes-prefix");
11072 accent_key_syms
= Qnil
;
11073 staticpro (&accent_key_syms
);
11075 func_key_syms
= Qnil
;
11076 staticpro (&func_key_syms
);
11078 drag_n_drop_syms
= Qnil
;
11079 staticpro (&drag_n_drop_syms
);
11081 unread_switch_frame
= Qnil
;
11082 staticpro (&unread_switch_frame
);
11084 internal_last_event_frame
= Qnil
;
11085 staticpro (&internal_last_event_frame
);
11087 read_key_sequence_cmd
= Qnil
;
11088 staticpro (&read_key_sequence_cmd
);
11089 read_key_sequence_remapped
= Qnil
;
11090 staticpro (&read_key_sequence_remapped
);
11092 menu_bar_one_keymap_changed_items
= Qnil
;
11093 staticpro (&menu_bar_one_keymap_changed_items
);
11095 menu_bar_items_vector
= Qnil
;
11096 staticpro (&menu_bar_items_vector
);
11098 help_form_saved_window_configs
= Qnil
;
11099 staticpro (&help_form_saved_window_configs
);
11101 defsubr (&Scurrent_idle_time
);
11102 defsubr (&Sevent_symbol_parse_modifiers
);
11103 defsubr (&Sevent_convert_list
);
11104 defsubr (&Sread_key_sequence
);
11105 defsubr (&Sread_key_sequence_vector
);
11106 defsubr (&Srecursive_edit
);
11107 defsubr (&Strack_mouse
);
11108 defsubr (&Sinput_pending_p
);
11109 defsubr (&Srecent_keys
);
11110 defsubr (&Sthis_command_keys
);
11111 defsubr (&Sthis_command_keys_vector
);
11112 defsubr (&Sthis_single_command_keys
);
11113 defsubr (&Sthis_single_command_raw_keys
);
11114 defsubr (&Sclear_this_command_keys
);
11115 defsubr (&Ssuspend_emacs
);
11116 defsubr (&Sabort_recursive_edit
);
11117 defsubr (&Sexit_recursive_edit
);
11118 defsubr (&Srecursion_depth
);
11119 defsubr (&Scommand_error_default_function
);
11120 defsubr (&Stop_level
);
11121 defsubr (&Sdiscard_input
);
11122 defsubr (&Sopen_dribble_file
);
11123 defsubr (&Sset_input_interrupt_mode
);
11124 defsubr (&Sset_output_flow_control
);
11125 defsubr (&Sset_input_meta_mode
);
11126 defsubr (&Sset_quit_char
);
11127 defsubr (&Sset_input_mode
);
11128 defsubr (&Scurrent_input_mode
);
11129 defsubr (&Sposn_at_point
);
11130 defsubr (&Sposn_at_x_y
);
11132 DEFVAR_LISP ("last-command-event", last_command_event
,
11133 doc
: /* Last input event that was part of a command. */);
11135 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11136 doc
: /* Last input event in a command, except for mouse menu events.
11137 Mouse menus give back keys that don't look like mouse events;
11138 this variable holds the actual mouse event that led to the menu,
11139 so that you can determine whether the command was run by mouse or not. */);
11141 DEFVAR_LISP ("last-input-event", last_input_event
,
11142 doc
: /* Last input event. */);
11144 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11145 doc
: /* List of events to be read as the command input.
11146 These events are processed first, before actual keyboard input.
11147 Events read from this list are not normally added to `this-command-keys',
11148 as they will already have been added once as they were read for the first time.
11149 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11150 Vunread_command_events
= Qnil
;
11152 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11153 doc
: /* List of events to be processed as input by input methods.
11154 These events are processed before `unread-command-events'
11155 and actual keyboard input, but are not given to `input-method-function'. */);
11156 Vunread_post_input_method_events
= Qnil
;
11158 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11159 doc
: /* List of events to be processed as input by input methods.
11160 These events are processed after `unread-command-events', but
11161 before actual keyboard input.
11162 If there's an active input method, the events are given to
11163 `input-method-function'. */);
11164 Vunread_input_method_events
= Qnil
;
11166 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11167 doc
: /* Meta-prefix character code.
11168 Meta-foo as command input turns into this character followed by foo. */);
11169 XSETINT (meta_prefix_char
, 033);
11171 DEFVAR_KBOARD ("last-command", Vlast_command
,
11172 doc
: /* The last command executed.
11173 Normally a symbol with a function definition, but can be whatever was found
11174 in the keymap, or whatever the variable `this-command' was set to by that
11177 The value `mode-exit' is special; it means that the previous command
11178 read an event that told it to exit, and it did so and unread that event.
11179 In other words, the present command is the event that made the previous
11182 The value `kill-region' is special; it means that the previous command
11183 was a kill command.
11185 `last-command' has a separate binding for each terminal device.
11186 See Info node `(elisp)Multiple Terminals'. */);
11188 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11189 doc
: /* Same as `last-command', but never altered by Lisp code.
11190 Taken from the previous value of `real-this-command'. */);
11192 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11193 doc
: /* Last command that may be repeated.
11194 The last command executed that was not bound to an input event.
11195 This is the command `repeat' will try to repeat.
11196 Taken from a previous value of `real-this-command'. */);
11198 DEFVAR_LISP ("this-command", Vthis_command
,
11199 doc
: /* The command now being executed.
11200 The command can set this variable; whatever is put here
11201 will be in `last-command' during the following command. */);
11202 Vthis_command
= Qnil
;
11204 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11205 doc
: /* This is like `this-command', except that commands should never modify it. */);
11206 Vreal_this_command
= Qnil
;
11208 DEFVAR_LISP ("this-command-keys-shift-translated",
11209 Vthis_command_keys_shift_translated
,
11210 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11211 Shift-translation occurs when there is no binding for the key sequence
11212 as entered, but a binding was found by changing an upper-case letter
11213 to lower-case, or a shifted function key to an unshifted one. */);
11214 Vthis_command_keys_shift_translated
= Qnil
;
11216 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11217 doc
: /* The command bound to the current key sequence before remapping.
11218 It equals `this-command' if the original command was not remapped through
11219 any of the active keymaps. Otherwise, the value of `this-command' is the
11220 result of looking up the original command in the active keymaps. */);
11221 Vthis_original_command
= Qnil
;
11223 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11224 doc
: /* Number of input events between auto-saves.
11225 Zero means disable autosaving due to number of characters typed. */);
11226 auto_save_interval
= 300;
11228 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11229 doc
: /* Number of seconds idle time before auto-save.
11230 Zero or nil means disable auto-saving due to idleness.
11231 After auto-saving due to this many seconds of idle time,
11232 Emacs also does a garbage collection if that seems to be warranted. */);
11233 XSETFASTINT (Vauto_save_timeout
, 30);
11235 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11236 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11237 The value may be integer or floating point.
11238 If the value is zero, don't echo at all. */);
11239 Vecho_keystrokes
= make_number (1);
11241 DEFVAR_INT ("polling-period", polling_period
,
11242 doc
: /* Interval between polling for input during Lisp execution.
11243 The reason for polling is to make C-g work to stop a running program.
11244 Polling is needed only when using X windows and SIGIO does not work.
11245 Polling is automatically disabled in all other cases. */);
11246 polling_period
= 2;
11248 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11249 doc
: /* Maximum time between mouse clicks to make a double-click.
11250 Measured in milliseconds. The value nil means disable double-click
11251 recognition; t means double-clicks have no time limit and are detected
11252 by position only. */);
11253 Vdouble_click_time
= make_number (500);
11255 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11256 doc
: /* Maximum mouse movement between clicks to make a double-click.
11257 On window-system frames, value is the number of pixels the mouse may have
11258 moved horizontally or vertically between two clicks to make a double-click.
11259 On non window-system frames, value is interpreted in units of 1/8 characters
11262 This variable is also the threshold for motion of the mouse
11263 to count as a drag. */);
11264 double_click_fuzz
= 3;
11266 DEFVAR_INT ("num-input-keys", num_input_keys
,
11267 doc
: /* Number of complete key sequences read as input so far.
11268 This includes key sequences read from keyboard macros.
11269 The number is effectively the number of interactive command invocations. */);
11270 num_input_keys
= 0;
11272 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11273 doc
: /* Number of input events read from the keyboard so far.
11274 This does not include events generated by keyboard macros. */);
11275 num_nonmacro_input_events
= 0;
11277 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11278 doc
: /* The frame in which the most recently read event occurred.
11279 If the last event came from a keyboard macro, this is set to `macro'. */);
11280 Vlast_event_frame
= Qnil
;
11282 /* This variable is set up in sysdep.c. */
11283 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11284 doc
: /* The ERASE character as set by the user with stty. */);
11286 DEFVAR_LISP ("help-char", Vhelp_char
,
11287 doc
: /* Character to recognize as meaning Help.
11288 When it is read, do `(eval help-form)', and display result if it's a string.
11289 If the value of `help-form' is nil, this char can be read normally. */);
11290 XSETINT (Vhelp_char
, Ctl ('H'));
11292 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11293 doc
: /* List of input events to recognize as meaning Help.
11294 These work just like the value of `help-char' (see that). */);
11295 Vhelp_event_list
= Qnil
;
11297 DEFVAR_LISP ("help-form", Vhelp_form
,
11298 doc
: /* Form to execute when character `help-char' is read.
11299 If the form returns a string, that string is displayed.
11300 If `help-form' is nil, the help char is not recognized. */);
11303 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11304 doc
: /* Command to run when `help-char' character follows a prefix key.
11305 This command is used only when there is no actual binding
11306 for that character after that prefix key. */);
11307 Vprefix_help_command
= Qnil
;
11309 DEFVAR_LISP ("top-level", Vtop_level
,
11310 doc
: /* Form to evaluate when Emacs starts up.
11311 Useful to set before you dump a modified Emacs. */);
11313 XSYMBOL (Qtop_level
)->declared_special
= false;
11315 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11316 doc
: /* Translate table for local keyboard input, or nil.
11317 If non-nil, the value should be a char-table. Each character read
11318 from the keyboard is looked up in this char-table. If the value found
11319 there is non-nil, then it is used instead of the actual input character.
11321 The value can also be a string or vector, but this is considered obsolete.
11322 If it is a string or vector of length N, character codes N and up are left
11323 untranslated. In a vector, an element which is nil means "no translation".
11325 This is applied to the characters supplied to input methods, not their
11326 output. See also `translation-table-for-input'.
11328 This variable has a separate binding for each terminal.
11329 See Info node `(elisp)Multiple Terminals'. */);
11331 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11332 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11333 (Even if the operating system has support for stopping a process.) */);
11334 cannot_suspend
= false;
11336 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11337 doc
: /* Non-nil means prompt with menus when appropriate.
11338 This is done when reading from a keymap that has a prompt string,
11339 for elements that have prompt strings.
11340 The menu is displayed on the screen
11341 if X menus were enabled at configuration
11342 time and the previous event was a mouse click prefix key.
11343 Otherwise, menu prompting uses the echo area. */);
11344 menu_prompting
= true;
11346 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11347 doc
: /* Character to see next line of menu prompt.
11348 Type this character while in a menu prompt to rotate around the lines of it. */);
11349 XSETINT (menu_prompt_more_char
, ' ');
11351 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11352 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11353 Emacs applies the modifiers of the character stored here to each keyboard
11354 character it reads. For example, after evaluating the expression
11355 (setq extra-keyboard-modifiers ?\\C-x)
11356 all input characters will have the control modifier applied to them.
11358 Note that the character ?\\C-@, equivalent to the integer zero, does
11359 not count as a control character; rather, it counts as a character
11360 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11361 cancels any modification. */);
11362 extra_keyboard_modifiers
= 0;
11364 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11365 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11366 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11367 The command loop sets this to nil before each command,
11368 and tests the value when the command returns.
11369 Buffer modification stores t in this variable. */);
11370 Vdeactivate_mark
= Qnil
;
11371 Fmake_variable_buffer_local (Qdeactivate_mark
);
11373 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11374 doc
: /* Normal hook run before each command is executed.
11375 If an unhandled error happens in running this hook,
11376 the function in which the error occurred is unconditionally removed, since
11377 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11379 See also `post-command-hook'. */);
11380 Vpre_command_hook
= Qnil
;
11382 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11383 doc
: /* Normal hook run after each command is executed.
11384 If an unhandled error happens in running this hook,
11385 the function in which the error occurred is unconditionally removed, since
11386 otherwise the error might happen repeatedly and make Emacs nonfunctional.
11388 It is a bad idea to use this hook for expensive processing. If
11389 unavoidable, wrap your code in `(while-no-input (redisplay) CODE)' to
11390 avoid making Emacs unresponsive while the user types.
11392 See also `pre-command-hook'. */);
11393 Vpost_command_hook
= Qnil
;
11396 DEFVAR_LISP ("echo-area-clear-hook", ...,
11397 doc
: /* Normal hook run when clearing the echo area. */);
11399 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11400 Fset (Qecho_area_clear_hook
, Qnil
);
11402 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11403 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11404 Vlucid_menu_bar_dirty_flag
= Qnil
;
11406 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11407 doc
: /* List of menu bar items to move to the end of the menu bar.
11408 The elements of the list are event types that may have menu bar bindings. */);
11409 Vmenu_bar_final_items
= Qnil
;
11411 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11412 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11413 This is used internally by graphical displays that do not render
11414 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11415 Vtool_bar_separator_image_expression
= Qnil
;
11417 DEFVAR_KBOARD ("overriding-terminal-local-map",
11418 Voverriding_terminal_local_map
,
11419 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11420 This variable is intended to let commands such as `universal-argument'
11421 set up a different keymap for reading the next command.
11423 `overriding-terminal-local-map' has a separate binding for each
11424 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11426 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11427 doc
: /* Keymap that replaces (overrides) local keymaps.
11428 If this variable is non-nil, Emacs looks up key bindings in this
11429 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11430 buffer's local map. Hence, the only active keymaps would be
11431 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11432 order of precedence. */);
11433 Voverriding_local_map
= Qnil
;
11435 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11436 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11437 Otherwise, the menu bar continues to reflect the buffer's local map
11438 and the minor mode maps regardless of `overriding-local-map'. */);
11439 Voverriding_local_map_menu_flag
= Qnil
;
11441 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11442 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11443 Vspecial_event_map
= list1 (Qkeymap
);
11445 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11446 doc
: /* Non-nil means generate motion events for mouse motion. */);
11448 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11449 doc
: /* Alist of system-specific X windows key symbols.
11450 Each element should have the form (N . SYMBOL) where N is the
11451 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11452 and SYMBOL is its name.
11454 `system-key-alist' has a separate binding for each terminal device.
11455 See Info node `(elisp)Multiple Terminals'. */);
11457 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11458 doc
: /* Keymap that translates key sequences to key sequences during input.
11459 This is used mainly for mapping key sequences into some preferred
11460 key events (symbols).
11462 The `read-key-sequence' function replaces any subsequence bound by
11463 `local-function-key-map' with its binding. More precisely, when the
11464 active keymaps have no binding for the current key sequence but
11465 `local-function-key-map' binds a suffix of the sequence to a vector or
11466 string, `read-key-sequence' replaces the matching suffix with its
11467 binding, and continues with the new sequence.
11469 If the binding is a function, it is called with one argument (the prompt)
11470 and its return value (a key sequence) is used.
11472 The events that come from bindings in `local-function-key-map' are not
11473 themselves looked up in `local-function-key-map'.
11475 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11476 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11477 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11478 typing `ESC O P x' would return [f1 x].
11480 `local-function-key-map' has a separate binding for each terminal
11481 device. See Info node `(elisp)Multiple Terminals'. If you need to
11482 define a binding on all terminals, change `function-key-map'
11483 instead. Initially, `local-function-key-map' is an empty keymap that
11484 has `function-key-map' as its parent on all terminal devices. */);
11486 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11487 doc
: /* Keymap that decodes input escape sequences.
11488 This is used mainly for mapping ASCII function key sequences into
11489 real Emacs function key events (symbols).
11491 The `read-key-sequence' function replaces any subsequence bound by
11492 `input-decode-map' with its binding. Contrary to `function-key-map',
11493 this map applies its rebinding regardless of the presence of an ordinary
11494 binding. So it is more like `key-translation-map' except that it applies
11495 before `function-key-map' rather than after.
11497 If the binding is a function, it is called with one argument (the prompt)
11498 and its return value (a key sequence) is used.
11500 The events that come from bindings in `input-decode-map' are not
11501 themselves looked up in `input-decode-map'. */);
11503 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11504 doc
: /* The parent keymap of all `local-function-key-map' instances.
11505 Function key definitions that apply to all terminal devices should go
11506 here. If a mapping is defined in both the current
11507 `local-function-key-map' binding and this variable, then the local
11508 definition will take precedence. */);
11509 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11511 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11512 doc
: /* Keymap of key translations that can override keymaps.
11513 This keymap works like `input-decode-map', but comes after `function-key-map'.
11514 Another difference is that it is global rather than terminal-local. */);
11515 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11517 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11518 doc
: /* List of deferred actions to be performed at a later time.
11519 The precise format isn't relevant here; we just check whether it is nil. */);
11520 Vdeferred_action_list
= Qnil
;
11522 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11523 doc
: /* Function to call to handle deferred actions, after each command.
11524 This function is called with no arguments after each command
11525 whenever `deferred-action-list' is non-nil. */);
11526 Vdeferred_action_function
= Qnil
;
11528 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11529 doc
: /* List of warnings to be displayed after this command.
11530 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11531 as per the args of `display-warning' (which see).
11532 If this variable is non-nil, `delayed-warnings-hook' will be run
11533 immediately after running `post-command-hook'. */);
11534 Vdelayed_warnings_list
= Qnil
;
11536 DEFVAR_LISP ("timer-list", Vtimer_list
,
11537 doc
: /* List of active absolute time timers in order of increasing time. */);
11538 Vtimer_list
= Qnil
;
11540 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11541 doc
: /* List of active idle-time timers in order of increasing time. */);
11542 Vtimer_idle_list
= Qnil
;
11544 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11545 doc
: /* If non-nil, the function that implements the current input method.
11546 It's called with one argument, a printing character that was just read.
11547 (That means a character with code 040...0176.)
11548 Typically this function uses `read-event' to read additional events.
11549 When it does so, it should first bind `input-method-function' to nil
11550 so it will not be called recursively.
11552 The function should return a list of zero or more events
11553 to be used as input. If it wants to put back some events
11554 to be reconsidered, separately, by the input method,
11555 it can add them to the beginning of `unread-command-events'.
11557 The input method function can find in `input-method-previous-message'
11558 the previous echo area message.
11560 The input method function should refer to the variables
11561 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11562 for guidance on what to do. */);
11563 Vinput_method_function
= Qlist
;
11565 DEFVAR_LISP ("input-method-previous-message",
11566 Vinput_method_previous_message
,
11567 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11568 This variable exists because `read-event' clears the echo area
11569 before running the input method. It is nil if there was no message. */);
11570 Vinput_method_previous_message
= Qnil
;
11572 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11573 doc
: /* If non-nil, the function that implements the display of help.
11574 It's called with one argument, the help string to display. */);
11575 Vshow_help_function
= Qnil
;
11577 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11578 doc
: /* If non-nil, suppress point adjustment after executing a command.
11580 After a command is executed, if point is moved into a region that has
11581 special properties (e.g. composition, display), we adjust point to
11582 the boundary of the region. But, when a command sets this variable to
11583 non-nil, we suppress the point adjustment.
11585 This variable is set to nil before reading a command, and is checked
11586 just after executing the command. */);
11587 Vdisable_point_adjustment
= Qnil
;
11589 DEFVAR_LISP ("global-disable-point-adjustment",
11590 Vglobal_disable_point_adjustment
,
11591 doc
: /* If non-nil, always suppress point adjustment.
11593 The default value is nil, in which case, point adjustment are
11594 suppressed only after special commands that set
11595 `disable-point-adjustment' (which see) to non-nil. */);
11596 Vglobal_disable_point_adjustment
= Qnil
;
11598 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11599 doc
: /* How long to display an echo-area message when the minibuffer is active.
11600 If the value is not a number, such messages don't time out. */);
11601 Vminibuffer_message_timeout
= make_number (2);
11603 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11604 doc
: /* If non-nil, any keyboard input throws to this symbol.
11605 The value of that variable is passed to `quit-flag' and later causes a
11606 peculiar kind of quitting. */);
11607 Vthrow_on_input
= Qnil
;
11609 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11610 doc
: /* Function to output error messages.
11611 Called with three arguments:
11612 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11613 such as what `condition-case' would bind its variable to,
11614 - the context (a string which normally goes at the start of the message),
11615 - the Lisp function within which the error was signaled. */);
11616 Vcommand_error_function
= intern ("command-error-default-function");
11618 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11619 Venable_disabled_menus_and_buttons
,
11620 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11622 Help functions bind this to allow help on disabled menu items
11623 and tool-bar buttons. */);
11624 Venable_disabled_menus_and_buttons
= Qnil
;
11626 DEFVAR_LISP ("select-active-regions",
11627 Vselect_active_regions
,
11628 doc
: /* If non-nil, an active region automatically sets the primary selection.
11629 If the value is `only', only temporarily active regions (usually made
11630 by mouse-dragging or shift-selection) set the window selection.
11632 This takes effect only when Transient Mark mode is enabled. */);
11633 Vselect_active_regions
= Qt
;
11635 DEFVAR_LISP ("saved-region-selection",
11636 Vsaved_region_selection
,
11637 doc
: /* Contents of active region prior to buffer modification.
11638 If `select-active-regions' is non-nil, Emacs sets this to the
11639 text in the region before modifying the buffer. The next call to
11640 the function `deactivate-mark' uses this to set the window selection. */);
11641 Vsaved_region_selection
= Qnil
;
11643 DEFVAR_LISP ("selection-inhibit-update-commands",
11644 Vselection_inhibit_update_commands
,
11645 doc
: /* List of commands which should not update the selection.
11646 Normally, if `select-active-regions' is non-nil and the mark remains
11647 active after a command (i.e. the mark was not deactivated), the Emacs
11648 command loop sets the selection to the text in the region. However,
11649 if the command is in this list, the selection is not updated. */);
11650 Vselection_inhibit_update_commands
11651 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11653 DEFVAR_LISP ("debug-on-event",
11655 doc
: /* Enter debugger on this event. When Emacs
11656 receives the special event specified by this variable, it will try to
11657 break into the debugger as soon as possible instead of processing the
11658 event normally through `special-event-map'.
11660 Currently, the only supported values for this
11661 variable are `sigusr1' and `sigusr2'. */);
11662 Vdebug_on_event
= intern_c_string ("sigusr2");
11664 /* Create the initial keyboard. Qt means 'unset'. */
11665 initial_kboard
= allocate_kboard (Qt
);
11669 keys_of_keyboard (void)
11671 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11672 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11673 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11674 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11675 initial_define_key (meta_map
, 'x', "execute-extended-command");
11677 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11678 "handle-delete-frame");
11679 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11680 "ns-put-working-text");
11681 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11682 "ns-unput-working-text");
11683 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11684 current-prefix-arg, as is done in `handle-switch-frame'.
11685 But `handle-switch-frame is not run from the special-map.
11686 Commands from that map are run in a special way that automatically
11687 preserves the prefix-arg. Restoring the prefix arg here is not just
11688 redundant but harmful:
11690 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11691 - after the first prompt, the exit-minibuffer-hook is run which may
11692 iconify a frame and thus push a `iconify-frame' event.
11693 - after running exit-minibuffer-hook, current-prefix-arg is
11694 restored to the non-nil value it had before the prompt.
11695 - we enter the second prompt.
11696 current-prefix-arg is non-nil, prefix-arg is nil.
11697 - before running the first real event, we run the special iconify-frame
11698 event, but we pass the `special' arg to command-execute so
11699 current-prefix-arg and prefix-arg are left untouched.
11700 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11701 - the next key event will have a spuriously non-nil current-prefix-arg. */
11702 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11704 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11706 /* Handling it at such a low-level causes read_key_sequence to get
11707 * confused because it doesn't realize that the current_buffer was
11708 * changed by read_char.
11710 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11711 * "handle-select-window"); */
11712 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11713 "handle-save-session");
11716 /* Define a special event which is raised for dbus callback
11718 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11719 "dbus-handle-event");
11722 #ifdef USE_FILE_NOTIFY
11723 /* Define a special event which is raised for notification callback
11725 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11726 "file-notify-handle-event");
11727 #endif /* USE_FILE_NOTIFY */
11729 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11731 #if defined (WINDOWSNT)
11732 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11735 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11736 "handle-focus-in");
11737 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11738 "handle-focus-out");
11741 /* Mark the pointers in the kboard objects.
11742 Called by Fgarbage_collect. */
11744 mark_kboards (void)
11748 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11750 if (kb
->kbd_macro_buffer
)
11751 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11753 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11754 mark_object (KVAR (kb
, Vlast_command
));
11755 mark_object (KVAR (kb
, Vreal_last_command
));
11756 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11757 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11758 mark_object (KVAR (kb
, Vprefix_arg
));
11759 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11760 mark_object (KVAR (kb
, kbd_queue
));
11761 mark_object (KVAR (kb
, defining_kbd_macro
));
11762 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11763 mark_object (KVAR (kb
, Vsystem_key_alist
));
11764 mark_object (KVAR (kb
, system_key_syms
));
11765 mark_object (KVAR (kb
, Vwindow_system
));
11766 mark_object (KVAR (kb
, Vinput_decode_map
));
11767 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11768 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11769 mark_object (KVAR (kb
, echo_string
));
11770 mark_object (KVAR (kb
, echo_prompt
));
11773 union buffered_input_event
*event
;
11774 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11776 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11777 event
= kbd_buffer
;
11778 /* These two special event types has no Lisp_Objects to mark. */
11779 if (event
->kind
!= SELECTION_REQUEST_EVENT
11780 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11782 mark_object (event
->ie
.x
);
11783 mark_object (event
->ie
.y
);
11784 mark_object (event
->ie
.frame_or_window
);
11785 mark_object (event
->ie
.arg
);