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);
1233 /* The last boundary auto-added to buffer-undo-list. */
1234 Lisp_Object last_undo_boundary
;
1237 command_loop_1 (void)
1240 Lisp_Object keybuf
[30];
1242 EMACS_INT prev_modiff
= 0;
1243 struct buffer
*prev_buffer
= NULL
;
1244 bool already_adjusted
= 0;
1246 kset_prefix_arg (current_kboard
, Qnil
);
1247 kset_last_prefix_arg (current_kboard
, Qnil
);
1248 Vdeactivate_mark
= Qnil
;
1249 waiting_for_input
= false;
1252 this_command_key_count
= 0;
1253 this_single_command_key_start
= 0;
1255 if (NILP (Vmemory_full
))
1257 /* Make sure this hook runs after commands that get errors and
1258 throw to top level. */
1259 /* Note that the value cell will never directly contain nil
1260 if the symbol is a local variable. */
1261 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1262 safe_run_hooks (Qpost_command_hook
);
1264 /* If displaying a message, resize the echo area window to fit
1265 that message's size exactly. */
1266 if (!NILP (echo_area_buffer
[0]))
1267 resize_echo_area_exactly ();
1269 /* If there are warnings waiting, process them. */
1270 if (!NILP (Vdelayed_warnings_list
))
1271 safe_run_hooks (Qdelayed_warnings_hook
);
1273 if (!NILP (Vdeferred_action_list
))
1274 safe_run_hooks (Qdeferred_action_function
);
1277 /* Do this after running Vpost_command_hook, for consistency. */
1278 kset_last_command (current_kboard
, Vthis_command
);
1279 kset_real_last_command (current_kboard
, Vreal_this_command
);
1280 if (!CONSP (last_command_event
))
1281 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1285 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1288 /* Make sure the current window's buffer is selected. */
1289 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1291 /* Display any malloc warning that just came out. Use while because
1292 displaying one warning can cause another. */
1294 while (pending_malloc_warning
)
1295 display_malloc_warning ();
1297 Vdeactivate_mark
= Qnil
;
1299 /* Don't ignore mouse movements for more than a single command
1300 loop. (This flag is set in xdisp.c whenever the tool bar is
1301 resized, because the resize moves text up or down, and would
1302 generate false mouse drag events if we don't ignore them.) */
1303 ignore_mouse_drag_p
= 0;
1305 /* If minibuffer on and echo area in use,
1306 wait a short time and redraw minibuffer. */
1309 && !NILP (echo_area_buffer
[0])
1310 && EQ (minibuf_window
, echo_area_window
)
1311 && NUMBERP (Vminibuffer_message_timeout
))
1313 /* Bind inhibit-quit to t so that C-g gets read in
1314 rather than quitting back to the minibuffer. */
1315 ptrdiff_t count
= SPECPDL_INDEX ();
1316 specbind (Qinhibit_quit
, Qt
);
1318 sit_for (Vminibuffer_message_timeout
, 0, 2);
1320 /* Clear the echo area. */
1322 safe_run_hooks (Qecho_area_clear_hook
);
1324 unbind_to (count
, Qnil
);
1326 /* If a C-g came in before, treat it as input now. */
1327 if (!NILP (Vquit_flag
))
1330 Vunread_command_events
= list1 (make_number (quit_char
));
1334 /* If it has changed current-menubar from previous value,
1335 really recompute the menubar from the value. */
1336 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1337 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1338 call0 (Qrecompute_lucid_menubar
);
1340 Vthis_command
= Qnil
;
1341 Vreal_this_command
= Qnil
;
1342 Vthis_original_command
= Qnil
;
1343 Vthis_command_keys_shift_translated
= Qnil
;
1345 /* Read next key sequence; i gets its length. */
1346 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1349 /* A filter may have run while we were reading the input. */
1350 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1352 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1356 /* Now we have read a key sequence of length I,
1357 or else I is 0 and we found end of file. */
1359 if (i
== 0) /* End of file -- happens only in */
1360 return Qnil
; /* a kbd macro, at the end. */
1361 /* -1 means read_key_sequence got a menu that was rejected.
1362 Just loop around and read another command. */
1366 this_command_key_count
= 0;
1367 this_single_command_key_start
= 0;
1371 last_command_event
= keybuf
[i
- 1];
1373 /* If the previous command tried to force a specific window-start,
1374 forget about that, in case this command moves point far away
1375 from that position. But also throw away beg_unchanged and
1376 end_unchanged information in that case, so that redisplay will
1377 update the whole window properly. */
1378 if (XWINDOW (selected_window
)->force_start
)
1381 XWINDOW (selected_window
)->force_start
= 0;
1382 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1383 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1386 cmd
= read_key_sequence_cmd
;
1387 if (!NILP (Vexecuting_kbd_macro
))
1389 if (!NILP (Vquit_flag
))
1391 Vexecuting_kbd_macro
= Qt
;
1392 QUIT
; /* Make some noise. */
1393 /* Will return since macro now empty. */
1397 /* Do redisplay processing after this command except in special
1398 cases identified below. */
1399 prev_buffer
= current_buffer
;
1400 prev_modiff
= MODIFF
;
1401 last_point_position
= PT
;
1403 /* By default, we adjust point to a boundary of a region that
1404 has such a property that should be treated intangible
1405 (e.g. composition, display). But, some commands will set
1406 this variable differently. */
1407 Vdisable_point_adjustment
= Qnil
;
1409 /* Process filters and timers may have messed with deactivate-mark.
1410 reset it before we execute the command. */
1411 Vdeactivate_mark
= Qnil
;
1413 /* Remap command through active keymaps. */
1414 Vthis_original_command
= cmd
;
1415 if (!NILP (read_key_sequence_remapped
))
1416 cmd
= read_key_sequence_remapped
;
1418 /* Execute the command. */
1421 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
1422 ASET (recent_keys
, recent_keys_index
,
1424 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
1425 recent_keys_index
= 0;
1427 Vthis_command
= cmd
;
1428 Vreal_this_command
= cmd
;
1429 safe_run_hooks (Qpre_command_hook
);
1431 already_adjusted
= 0;
1433 if (NILP (Vthis_command
))
1434 /* nil means key is undefined. */
1438 /* Here for a command that isn't executed directly. */
1440 #ifdef HAVE_WINDOW_SYSTEM
1441 ptrdiff_t scount
= SPECPDL_INDEX ();
1443 if (display_hourglass_p
1444 && NILP (Vexecuting_kbd_macro
))
1446 record_unwind_protect_void (cancel_hourglass
);
1452 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1455 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1456 ? Qnil
: BVAR (current_buffer
, undo_list
));
1458 call1 (Qcommand_execute
, Vthis_command
);
1460 #ifdef HAVE_WINDOW_SYSTEM
1461 /* Do not check display_hourglass_p here, because
1462 `command-execute' could change it, but we should cancel
1463 hourglass cursor anyway.
1464 But don't cancel the hourglass within a macro
1465 just because a command in the macro finishes. */
1466 if (NILP (Vexecuting_kbd_macro
))
1467 unbind_to (scount
, Qnil
);
1470 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1472 safe_run_hooks (Qpost_command_hook
);
1474 /* If displaying a message, resize the echo area window to fit
1475 that message's size exactly. */
1476 if (!NILP (echo_area_buffer
[0]))
1477 resize_echo_area_exactly ();
1479 /* If there are warnings waiting, process them. */
1480 if (!NILP (Vdelayed_warnings_list
))
1481 safe_run_hooks (Qdelayed_warnings_hook
);
1483 safe_run_hooks (Qdeferred_action_function
);
1485 kset_last_command (current_kboard
, Vthis_command
);
1486 kset_real_last_command (current_kboard
, Vreal_this_command
);
1487 if (!CONSP (last_command_event
))
1488 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1490 this_command_key_count
= 0;
1491 this_single_command_key_start
= 0;
1493 if (current_kboard
->immediate_echo
1494 && !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
1496 current_kboard
->immediate_echo
= false;
1497 /* Refresh the echo message. */
1503 if (!NILP (BVAR (current_buffer
, mark_active
))
1504 && !NILP (Vrun_hooks
))
1506 /* In Emacs 22, setting transient-mark-mode to `only' was a
1507 way of turning it on for just one command. This usage is
1508 obsolete, but support it anyway. */
1509 if (EQ (Vtransient_mark_mode
, Qidentity
))
1510 Vtransient_mark_mode
= Qnil
;
1511 else if (EQ (Vtransient_mark_mode
, Qonly
))
1512 Vtransient_mark_mode
= Qidentity
;
1514 if (!NILP (Vdeactivate_mark
))
1515 /* If `select-active-regions' is non-nil, this call to
1516 `deactivate-mark' also sets the PRIMARY selection. */
1517 call0 (Qdeactivate_mark
);
1520 /* Even if not deactivating the mark, set PRIMARY if
1521 `select-active-regions' is non-nil. */
1522 if (!NILP (Fwindow_system (Qnil
))
1523 /* Even if mark_active is non-nil, the actual buffer
1524 marker may not have been set yet (Bug#7044). */
1525 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1526 && (EQ (Vselect_active_regions
, Qonly
)
1527 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1528 : (!NILP (Vselect_active_regions
)
1529 && !NILP (Vtransient_mark_mode
)))
1530 && NILP (Fmemq (Vthis_command
,
1531 Vselection_inhibit_update_commands
)))
1534 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1535 if (XINT (Flength (txt
)) > 0)
1536 /* Don't set empty selections. */
1537 call2 (Qgui_set_selection
, QPRIMARY
, txt
);
1540 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1541 run_hook (intern ("activate-mark-hook"));
1544 Vsaved_region_selection
= Qnil
;
1549 if (current_buffer
== prev_buffer
1550 && XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
1551 && last_point_position
!= PT
1552 && NILP (Vdisable_point_adjustment
)
1553 && NILP (Vglobal_disable_point_adjustment
))
1555 if (last_point_position
> BEGV
1556 && last_point_position
< ZV
1557 && (composition_adjust_point (last_point_position
,
1558 last_point_position
)
1559 != last_point_position
))
1560 /* The last point was temporarily set within a grapheme
1561 cluster to prevent automatic composition. To recover
1562 the automatic composition, we must update the
1564 windows_or_buffers_changed
= 21;
1565 if (!already_adjusted
)
1566 adjust_point_for_property (last_point_position
,
1567 MODIFF
!= prev_modiff
);
1570 /* Install chars successfully executed in kbd macro. */
1572 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1573 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1574 finalize_kbd_macro_chars ();
1579 read_menu_command (void)
1581 Lisp_Object keybuf
[30];
1582 ptrdiff_t count
= SPECPDL_INDEX ();
1585 /* We don't want to echo the keystrokes while navigating the
1587 specbind (Qecho_keystrokes
, make_number (0));
1589 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1592 unbind_to (count
, Qnil
);
1594 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1596 if (i
== 0 || i
== -1)
1599 return read_key_sequence_cmd
;
1602 /* Adjust point to a boundary of a region that has such a property
1603 that should be treated intangible. For the moment, we check
1604 `composition', `display' and `invisible' properties.
1605 LAST_PT is the last position of point. */
1608 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1611 Lisp_Object val
, overlay
, tmp
;
1612 /* When called after buffer modification, we should temporarily
1613 suppress the point adjustment for automatic composition so that a
1614 user can keep inserting another character at point or keep
1615 deleting characters around point. */
1616 bool check_composition
= ! modified
;
1617 bool check_display
= true, check_invisible
= true;
1618 ptrdiff_t orig_pt
= PT
;
1620 eassert (XBUFFER (XWINDOW (selected_window
)->contents
) == current_buffer
);
1622 /* FIXME: cycling is probably not necessary because these properties
1623 can't be usefully combined anyway. */
1624 while (check_composition
|| check_display
|| check_invisible
)
1626 /* FIXME: check `intangible'. */
1627 if (check_composition
1628 && PT
> BEGV
&& PT
< ZV
1629 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1632 check_display
= check_invisible
= true;
1634 check_composition
= false;
1636 && PT
> BEGV
&& PT
< ZV
1637 && !NILP (val
= get_char_property_and_overlay
1638 (make_number (PT
), Qdisplay
, selected_window
,
1640 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1641 && (!OVERLAYP (overlay
)
1642 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1643 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1644 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1645 && (beg
< PT
/* && end > PT <- It's always the case. */
1646 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1649 SET_PT (PT
< last_pt
1650 ? (STRINGP (val
) && SCHARS (val
) == 0
1651 ? max (beg
- 1, BEGV
)
1654 check_composition
= check_invisible
= true;
1656 check_display
= false;
1657 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1660 bool ellipsis
= false;
1663 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1666 /* FIXME: We should stop if we find a spot between
1667 two runs of `invisible' where inserted text would
1668 be visible. This is important when we have two
1669 invisible boundaries that enclose an area: if the
1670 area is empty, we need this test in order to make
1671 it possible to place point in the middle rather
1672 than skip both boundaries. However, this code
1673 also stops anywhere in a non-sticky text-property,
1674 which breaks (e.g.) Org mode. */
1675 && (val
= Fget_pos_property (make_number (end
),
1677 TEXT_PROP_MEANS_INVISIBLE (val
))
1679 && !NILP (val
= get_char_property_and_overlay
1680 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1681 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1683 ellipsis
= ellipsis
|| inv
> 1
1684 || (OVERLAYP (overlay
)
1685 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1686 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1687 tmp
= Fnext_single_char_property_change
1688 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1689 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1693 && (val
= Fget_pos_property (make_number (beg
),
1695 TEXT_PROP_MEANS_INVISIBLE (val
))
1697 && !NILP (val
= get_char_property_and_overlay
1698 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1699 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1701 ellipsis
= ellipsis
|| inv
> 1
1702 || (OVERLAYP (overlay
)
1703 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1704 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1705 tmp
= Fprevious_single_char_property_change
1706 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1707 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1710 /* Move away from the inside area. */
1711 if (beg
< PT
&& end
> PT
)
1713 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1714 /* We haven't moved yet (so we don't need to fear
1715 infinite-looping) and we were outside the range
1716 before (so either end of the range still corresponds
1717 to a move in the right direction): pretend we moved
1718 less than we actually did, so that we still have
1719 more freedom below in choosing which end of the range
1721 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1722 /* We either have moved already or the last point
1723 was already in the range: we don't get to choose
1724 which end of the range we have to go to. */
1725 : (PT
< last_pt
? beg
: end
));
1726 check_composition
= check_display
= true;
1728 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1729 the point to something other than its argument, due to
1730 point-motion hooks, intangibility, etc. */
1731 eassert (PT
== beg
|| PT
== end
);
1734 /* Pretend the area doesn't exist if the buffer is not
1736 if (!modified
&& !ellipsis
&& beg
< end
)
1738 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1739 (check_composition
= check_display
= true, SET_PT (end
+ 1));
1740 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1741 (check_composition
= check_display
= true, SET_PT (beg
- 1));
1742 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1743 /* We've already moved as far as we can. Trying to go
1744 to the other end would mean moving backwards and thus
1745 could lead to an infinite loop. */
1747 else if (val
= Fget_pos_property (make_number (PT
),
1749 TEXT_PROP_MEANS_INVISIBLE (val
)
1750 && (val
= (Fget_pos_property
1751 (make_number (PT
== beg
? end
: beg
),
1753 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1754 (check_composition
= check_display
= true,
1755 SET_PT (PT
== beg
? end
: beg
));
1758 check_invisible
= false;
1762 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1765 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1767 eassert (nargs
== 2);
1768 return call0 (args
[1]);
1771 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1775 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1777 eassert (nargs
== 2);
1778 AUTO_STRING (format
, "Error in %s (%S): %S");
1779 Lisp_Object hook
= args
[0];
1780 Lisp_Object fun
= args
[1];
1781 CALLN (Fmessage
, format
, hook
, fun
, error
);
1787 Lisp_Object newval
= Qnil
;
1788 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1789 if (EQ (fun
, XCAR (val
)))
1792 newval
= Fcons (XCAR (val
), newval
);
1794 return Fset (hook
, Fnreverse (newval
));
1795 /* Not found in the local part of the hook. Let's look at the global
1798 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1799 : Fdefault_value (hook
));
1800 CONSP (val
); val
= XCDR (val
))
1801 if (EQ (fun
, XCAR (val
)))
1804 newval
= Fcons (XCAR (val
), newval
);
1806 return Fset_default (hook
, Fnreverse (newval
));
1812 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1814 eassert (nargs
== 2);
1815 /* Yes, run_hook_with_args works with args in the other order. */
1816 internal_condition_case_n (safe_run_hooks_1
,
1817 2, ((Lisp_Object
[]) {args
[1], args
[0]}),
1818 Qt
, safe_run_hooks_error
);
1822 /* If we get an error while running the hook, cause the hook variable
1823 to be nil. Also inhibit quits, so that C-g won't cause the hook
1824 to mysteriously evaporate. */
1827 safe_run_hooks (Lisp_Object hook
)
1829 ptrdiff_t count
= SPECPDL_INDEX ();
1831 specbind (Qinhibit_quit
, Qt
);
1832 run_hook_with_args (2, ((Lisp_Object
[]) {hook
, hook
}), safe_run_hook_funcall
);
1833 unbind_to (count
, Qnil
);
1837 /* Nonzero means polling for input is temporarily suppressed. */
1839 int poll_suppress_count
;
1842 #ifdef POLL_FOR_INPUT
1844 /* Asynchronous timer for polling. */
1846 static struct atimer
*poll_timer
;
1848 /* Poll for input, so that we catch a C-g if it comes in. */
1850 poll_for_input_1 (void)
1852 if (! input_blocked_p ()
1853 && !waiting_for_input
)
1857 /* Timer callback function for poll_timer. TIMER is equal to
1861 poll_for_input (struct atimer
*timer
)
1863 if (poll_suppress_count
== 0)
1864 pending_signals
= true;
1867 #endif /* POLL_FOR_INPUT */
1869 /* Begin signals to poll for input, if they are appropriate.
1870 This function is called unconditionally from various places. */
1873 start_polling (void)
1875 #ifdef POLL_FOR_INPUT
1876 /* XXX This condition was (read_socket_hook && !interrupt_input),
1877 but read_socket_hook is not global anymore. Let's pretend that
1879 if (!interrupt_input
)
1881 /* Turn alarm handling on unconditionally. It might have
1882 been turned off in process.c. */
1883 turn_on_atimers (1);
1885 /* If poll timer doesn't exist, or we need one with
1886 a different interval, start a new one. */
1887 if (poll_timer
== NULL
1888 || poll_timer
->interval
.tv_sec
!= polling_period
)
1890 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1891 struct timespec interval
= make_timespec (period
, 0);
1894 cancel_atimer (poll_timer
);
1896 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
1897 poll_for_input
, NULL
);
1900 /* Let the timer's callback function poll for input
1901 if this becomes zero. */
1902 --poll_suppress_count
;
1907 /* True if we are using polling to handle input asynchronously. */
1910 input_polling_used (void)
1912 #ifdef POLL_FOR_INPUT
1913 /* XXX This condition was (read_socket_hook && !interrupt_input),
1914 but read_socket_hook is not global anymore. Let's pretend that
1916 return !interrupt_input
;
1922 /* Turn off polling. */
1927 #ifdef POLL_FOR_INPUT
1928 /* XXX This condition was (read_socket_hook && !interrupt_input),
1929 but read_socket_hook is not global anymore. Let's pretend that
1931 if (!interrupt_input
)
1932 ++poll_suppress_count
;
1936 /* Set the value of poll_suppress_count to COUNT
1937 and start or stop polling accordingly. */
1940 set_poll_suppress_count (int count
)
1942 #ifdef POLL_FOR_INPUT
1943 if (count
== 0 && poll_suppress_count
!= 0)
1945 poll_suppress_count
= 1;
1948 else if (count
!= 0 && poll_suppress_count
== 0)
1952 poll_suppress_count
= count
;
1956 /* Bind polling_period to a value at least N.
1957 But don't decrease it. */
1960 bind_polling_period (int n
)
1962 #ifdef POLL_FOR_INPUT
1963 EMACS_INT
new = polling_period
;
1968 stop_other_atimers (poll_timer
);
1970 specbind (Qpolling_period
, make_number (new));
1971 /* Start a new alarm with the new period. */
1976 /* Apply the control modifier to CHARACTER. */
1979 make_ctrl_char (int c
)
1981 /* Save the upper bits here. */
1982 int upper
= c
& ~0177;
1984 if (! ASCII_CHAR_P (c
))
1985 return c
|= ctrl_modifier
;
1989 /* Everything in the columns containing the upper-case letters
1990 denotes a control character. */
1991 if (c
>= 0100 && c
< 0140)
1995 /* Set the shift modifier for a control char
1996 made from a shifted letter. But only for letters! */
1997 if (oc
>= 'A' && oc
<= 'Z')
1998 c
|= shift_modifier
;
2001 /* The lower-case letters denote control characters too. */
2002 else if (c
>= 'a' && c
<= 'z')
2005 /* Include the bits for control and shift
2006 only if the basic ASCII code can't indicate them. */
2010 /* Replace the high bits. */
2011 c
|= (upper
& ~ctrl_modifier
);
2016 /* Display the help-echo property of the character after the mouse pointer.
2017 Either show it in the echo area, or call show-help-function to display
2018 it by other means (maybe in a tooltip).
2020 If HELP is nil, that means clear the previous help echo.
2022 If HELP is a string, display that string. If HELP is a function,
2023 call it with OBJECT and POS as arguments; the function should
2024 return a help string or nil for none. For all other types of HELP,
2025 evaluate it to obtain a string.
2027 WINDOW is the window in which the help was generated, if any.
2028 It is nil if not in a window.
2030 If OBJECT is a buffer, POS is the position in the buffer where the
2031 `help-echo' text property was found.
2033 If OBJECT is an overlay, that overlay has a `help-echo' property,
2034 and POS is the position in the overlay's buffer under the mouse.
2036 If OBJECT is a string (an overlay string or a string displayed with
2037 the `display' property). POS is the position in that string under
2040 Note: this function may only be called with HELP nil or a string
2041 from X code running asynchronously. */
2044 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2047 if (!NILP (help
) && !STRINGP (help
))
2049 if (FUNCTIONP (help
))
2050 help
= safe_call (4, help
, window
, object
, pos
);
2052 help
= safe_eval (help
);
2054 if (!STRINGP (help
))
2058 if (!noninteractive
&& STRINGP (help
))
2060 /* The mouse-fixup-help-message Lisp function can call
2061 mouse_position_hook, which resets the mouse_moved flags.
2062 This causes trouble if we are trying to read a mouse motion
2063 event (i.e., if we are inside a `track-mouse' form), so we
2064 restore the mouse_moved flag. */
2065 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2066 help
= call1 (Qmouse_fixup_help_message
, help
);
2068 f
->mouse_moved
= true;
2071 if (STRINGP (help
) || NILP (help
))
2073 if (!NILP (Vshow_help_function
))
2074 call1 (Vshow_help_function
, Fsubstitute_command_keys (help
));
2075 help_echo_showing_p
= STRINGP (help
);
2081 /* Input of single characters from keyboard. */
2083 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2084 struct timespec
*end_time
);
2085 static void record_char (Lisp_Object c
);
2087 static Lisp_Object help_form_saved_window_configs
;
2089 read_char_help_form_unwind (void)
2091 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2092 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2093 if (!NILP (window_config
))
2094 Fset_window_configuration (window_config
);
2097 #define STOP_POLLING \
2098 do { if (! polling_stopped_here) stop_polling (); \
2099 polling_stopped_here = true; } while (0)
2101 #define RESUME_POLLING \
2102 do { if (polling_stopped_here) start_polling (); \
2103 polling_stopped_here = false; } while (0)
2106 read_event_from_main_queue (struct timespec
*end_time
,
2107 sys_jmp_buf local_getcjmp
,
2108 bool *used_mouse_menu
)
2110 Lisp_Object c
= Qnil
;
2111 sys_jmp_buf save_jump
;
2112 KBOARD
*kb
IF_LINT (= NULL
);
2116 /* Read from the main queue, and if that gives us something we can't use yet,
2117 we put it on the appropriate side queue and try again. */
2119 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2122 /* Actually read a character, waiting if necessary. */
2123 save_getcjmp (save_jump
);
2124 restore_getcjmp (local_getcjmp
);
2126 timer_start_idle ();
2127 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2128 restore_getcjmp (save_jump
);
2130 if (! NILP (c
) && (kb
!= current_kboard
))
2132 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2135 while (CONSP (XCDR (last
)))
2137 if (!NILP (XCDR (last
)))
2141 kset_kbd_queue (kb
, list1 (c
));
2143 XSETCDR (last
, list1 (c
));
2144 kb
->kbd_queue_has_data
= true;
2148 current_kboard
= kb
;
2149 return make_number (-2);
2152 /* Terminate Emacs in batch mode if at eof. */
2153 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2154 Fkill_emacs (make_number (1));
2158 /* Add in any extra modifiers, where appropriate. */
2159 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2160 || ((extra_keyboard_modifiers
& 0177) < ' '
2161 && (extra_keyboard_modifiers
& 0177) != 0))
2162 XSETINT (c
, make_ctrl_char (XINT (c
)));
2164 /* Transfer any other modifier bits directly from
2165 extra_keyboard_modifiers to c. Ignore the actual character code
2166 in the low 16 bits of extra_keyboard_modifiers. */
2167 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2175 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2178 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2179 sys_jmp_buf local_getcjmp
,
2180 Lisp_Object prev_event
,
2181 bool *used_mouse_menu
)
2183 #define MAX_ENCODED_BYTES 16
2185 Lisp_Object events
[MAX_ENCODED_BYTES
];
2191 = read_event_from_main_queue (end_time
, local_getcjmp
,
2194 /* w32_console already returns decoded events. It either reads
2195 Unicode characters from the Windows keyboard input, or
2196 converts characters encoded in the current codepage into
2197 Unicode. See w32inevt.c:key_event, near its end. */
2200 struct frame
*frame
= XFRAME (selected_frame
);
2201 struct terminal
*terminal
= frame
->terminal
;
2202 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2203 /* Don't apply decoding if we're just reading a raw event
2204 (e.g. reading bytes sent by the xterm to specify the position
2205 of a mouse click). */
2206 && (!EQ (prev_event
, Qt
))
2207 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2208 & CODING_REQUIRE_DECODING_MASK
)))
2209 return nextevt
; /* No decoding needed. */
2212 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2213 eassert (n
< MAX_ENCODED_BYTES
);
2214 events
[n
++] = nextevt
;
2215 if (NATNUMP (nextevt
)
2216 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2217 { /* An encoded byte sequence, let's try to decode it. */
2218 struct coding_system
*coding
2219 = TERMINAL_KEYBOARD_CODING (terminal
);
2221 if (raw_text_coding_system_p (coding
))
2225 for (i
= 0; i
< n
; i
++)
2226 events
[i
] = make_number (XINT (events
[i
]) & ~0x80);
2230 unsigned char src
[MAX_ENCODED_BYTES
];
2231 unsigned char dest
[MAX_ENCODED_BYTES
* MAX_MULTIBYTE_LENGTH
];
2233 for (i
= 0; i
< n
; i
++)
2234 src
[i
] = XINT (events
[i
]);
2236 for (i
= 0; i
< n
; i
++)
2238 coding
->destination
= dest
;
2239 coding
->dst_bytes
= sizeof dest
;
2240 decode_coding_c_string (coding
, src
, n
, Qnil
);
2241 eassert (coding
->produced_char
<= n
);
2242 if (coding
->produced_char
== 0)
2243 { /* The encoded sequence is incomplete. */
2244 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2245 continue; /* Read on! */
2249 const unsigned char *p
= coding
->destination
;
2250 eassert (coding
->carryover_bytes
== 0);
2252 while (n
< coding
->produced_char
)
2253 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2257 /* Now `events' should hold decoded events.
2258 Normally, n should be equal to 1, but better not rely on it.
2259 We can only return one event here, so return the first we
2260 had and keep the others (if any) for later. */
2262 Vunread_command_events
2263 = Fcons (events
[--n
], Vunread_command_events
);
2271 echo_keystrokes_p (void)
2273 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2274 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2277 /* Read a character from the keyboard; call the redisplay if needed. */
2278 /* commandflag 0 means do not autosave, but do redisplay.
2279 -1 means do not redisplay, but do autosave.
2280 -2 means do neither.
2283 The argument MAP is a keymap for menu prompting.
2285 PREV_EVENT is the previous input event, or nil if we are reading
2286 the first event of a key sequence (or not reading a key sequence).
2287 If PREV_EVENT is t, that is a "magic" value that says
2288 not to run input methods, but in other respects to act as if
2289 not reading a key sequence.
2291 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2292 if we used a mouse menu to read the input, or false otherwise. If
2293 USED_MOUSE_MENU is null, don't dereference it.
2295 Value is -2 when we find input on another keyboard. A second call
2296 to read_char will read it.
2298 If END_TIME is non-null, it is a pointer to a struct timespec
2299 specifying the maximum time to wait until. If no input arrives by
2300 that time, stop waiting and return nil.
2302 Value is t if we showed a menu and the user rejected it. */
2305 read_char (int commandflag
, Lisp_Object map
,
2306 Lisp_Object prev_event
,
2307 bool *used_mouse_menu
, struct timespec
*end_time
)
2311 sys_jmp_buf local_getcjmp
;
2312 sys_jmp_buf save_jump
;
2313 Lisp_Object tem
, save
;
2314 volatile Lisp_Object previous_echo_area_message
;
2315 volatile Lisp_Object also_record
;
2316 volatile bool reread
, recorded
;
2317 bool volatile polling_stopped_here
= false;
2318 struct kboard
*orig_kboard
= current_kboard
;
2323 previous_echo_area_message
= Qnil
;
2329 if (CONSP (Vunread_post_input_method_events
))
2331 c
= XCAR (Vunread_post_input_method_events
);
2332 Vunread_post_input_method_events
2333 = XCDR (Vunread_post_input_method_events
);
2335 /* Undo what read_char_x_menu_prompt did when it unread
2336 additional keys returned by Fx_popup_menu. */
2338 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2349 if (CONSP (Vunread_command_events
))
2351 bool was_disabled
= false;
2353 c
= XCAR (Vunread_command_events
);
2354 Vunread_command_events
= XCDR (Vunread_command_events
);
2356 /* Undo what sit-for did when it unread additional keys
2357 inside universal-argument. */
2359 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2364 /* Undo what read_char_x_menu_prompt did when it unread
2365 additional keys returned by Fx_popup_menu. */
2367 && EQ (XCDR (c
), Qdisabled
)
2368 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2370 was_disabled
= true;
2374 /* If the queued event is something that used the mouse,
2375 set used_mouse_menu accordingly. */
2377 /* Also check was_disabled so last-nonmenu-event won't return
2378 a bad value when submenus are involved. (Bug#447) */
2379 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2380 *used_mouse_menu
= true;
2382 goto reread_for_input_method
;
2385 if (CONSP (Vunread_input_method_events
))
2387 c
= XCAR (Vunread_input_method_events
);
2388 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2390 /* Undo what read_char_x_menu_prompt did when it unread
2391 additional keys returned by Fx_popup_menu. */
2393 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2397 goto reread_for_input_method
;
2400 if (!NILP (Vexecuting_kbd_macro
))
2402 /* We set this to Qmacro; since that's not a frame, nobody will
2403 try to switch frames on us, and the selected window will
2406 Since this event came from a macro, it would be misleading to
2407 leave internal_last_event_frame set to wherever the last
2408 real event came from. Normally, a switch-frame event selects
2409 internal_last_event_frame after each command is read, but
2410 events read from a macro should never cause a new frame to be
2412 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2414 /* Exit the macro if we are at the end.
2415 Also, some things replace the macro with t
2416 to force an early exit. */
2417 if (EQ (Vexecuting_kbd_macro
, Qt
)
2418 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2424 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2425 if (STRINGP (Vexecuting_kbd_macro
)
2426 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2427 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2429 executing_kbd_macro_index
++;
2434 if (!NILP (unread_switch_frame
))
2436 c
= unread_switch_frame
;
2437 unread_switch_frame
= Qnil
;
2439 /* This event should make it into this_command_keys, and get echoed
2440 again, so we do not set `reread'. */
2444 /* If redisplay was requested. */
2445 if (commandflag
>= 0)
2447 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2449 /* If there is pending input, process any events which are not
2450 user-visible, such as X selection_request events. */
2452 || detect_input_pending_run_timers (0))
2453 swallow_events (false); /* May clear input_pending. */
2455 /* Redisplay if no pending input. */
2456 while (!(input_pending
2457 && (input_was_pending
|| !redisplay_dont_pause
)))
2459 input_was_pending
= input_pending
;
2460 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2461 redisplay_preserve_echo_area (5);
2466 /* Normal case: no input arrived during redisplay. */
2469 /* Input arrived and pre-empted redisplay.
2470 Process any events which are not user-visible. */
2471 swallow_events (false);
2472 /* If that cleared input_pending, try again to redisplay. */
2475 /* Prevent the redisplay we just did
2476 from messing up echoing of the input after the prompt. */
2477 if (commandflag
== 0 && echo_current
)
2478 echo_message_buffer
= echo_area_buffer
[0];
2482 /* Message turns off echoing unless more keystrokes turn it on again.
2484 The code in 20.x for the condition was
2486 1. echo_area_glyphs && *echo_area_glyphs
2487 2. && echo_area_glyphs != current_kboard->echobuf
2488 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2490 (1) means there's a current message displayed
2492 (2) means it's not the message from echoing from the current
2495 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2496 is set to a non-null value. This is done in read_char and it is
2497 set to echo_area_glyphs. That means
2498 ok_to_echo_at_next_pause is either null or
2499 current_kboard->echobuf with the appropriate current_kboard at
2502 So, condition (3) means in clear text ok_to_echo_at_next_pause
2503 must be either null, or the current message isn't from echoing at
2504 all, or it's from echoing from a different kboard than the
2507 if (/* There currently is something in the echo area. */
2508 !NILP (echo_area_buffer
[0])
2509 && (/* It's an echo from a different kboard. */
2510 echo_kboard
!= current_kboard
2511 /* Or we explicitly allow overwriting whatever there is. */
2512 || ok_to_echo_at_next_pause
== NULL
))
2517 /* Try reading a character via menu prompting in the minibuf.
2518 Try this before the sit-for, because the sit-for
2519 would do the wrong thing if we are supposed to do
2520 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2521 after a mouse event so don't try a minibuf menu. */
2523 if (KEYMAPP (map
) && INTERACTIVE
2524 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2525 /* Don't bring up a menu if we already have another event. */
2526 && NILP (Vunread_command_events
)
2527 && !detect_input_pending_run_timers (0))
2529 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2531 if (INTEGERP (c
) && XINT (c
) == -2)
2532 return c
; /* wrong_kboard_jmpbuf */
2538 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2539 We will do that below, temporarily for short sections of code,
2540 when appropriate. local_getcjmp must be in effect
2541 around any call to sit_for or kbd_buffer_get_event;
2542 it *must not* be in effect when we call redisplay. */
2544 jmpcount
= SPECPDL_INDEX ();
2545 if (sys_setjmp (local_getcjmp
))
2547 /* Handle quits while reading the keyboard. */
2548 /* We must have saved the outer value of getcjmp here,
2549 so restore it now. */
2550 restore_getcjmp (save_jump
);
2551 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2552 unbind_to (jmpcount
, Qnil
);
2553 XSETINT (c
, quit_char
);
2554 internal_last_event_frame
= selected_frame
;
2555 Vlast_event_frame
= internal_last_event_frame
;
2556 /* If we report the quit char as an event,
2557 don't do so more than once. */
2558 if (!NILP (Vinhibit_quit
))
2562 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2563 if (kb
!= current_kboard
)
2565 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2566 /* We shouldn't get here if we were in single-kboard mode! */
2571 while (CONSP (XCDR (last
)))
2573 if (!NILP (XCDR (last
)))
2577 kset_kbd_queue (kb
, list1 (c
));
2579 XSETCDR (last
, list1 (c
));
2580 kb
->kbd_queue_has_data
= true;
2581 current_kboard
= kb
;
2582 return make_number (-2); /* wrong_kboard_jmpbuf */
2588 /* Start idle timers if no time limit is supplied. We don't do it
2589 if a time limit is supplied to avoid an infinite recursion in the
2590 situation where an idle timer calls `sit-for'. */
2593 timer_start_idle ();
2595 /* If in middle of key sequence and minibuffer not active,
2596 start echoing if enough time elapses. */
2598 if (minibuf_level
== 0
2600 && !current_kboard
->immediate_echo
2601 && (this_command_key_count
> 0
2602 || !NILP (call0 (Qinternal_echo_keystrokes_prefix
)))
2604 && echo_keystrokes_p ()
2605 && (/* No message. */
2606 NILP (echo_area_buffer
[0])
2607 /* Or empty message. */
2608 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2609 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2610 /* Or already echoing from same kboard. */
2611 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2612 /* Or not echoing before and echoing allowed. */
2613 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2615 /* After a mouse event, start echoing right away.
2616 This is because we are probably about to display a menu,
2617 and we don't want to delay before doing so. */
2618 if (EVENT_HAS_PARAMETERS (prev_event
))
2624 save_getcjmp (save_jump
);
2625 restore_getcjmp (local_getcjmp
);
2626 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2627 restore_getcjmp (save_jump
);
2629 && ! CONSP (Vunread_command_events
))
2634 /* Maybe auto save due to number of keystrokes. */
2636 if (commandflag
!= 0 && commandflag
!= -2
2637 && auto_save_interval
> 0
2638 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2639 && !detect_input_pending_run_timers (0))
2641 Fdo_auto_save (Qnil
, Qnil
);
2642 /* Hooks can actually change some buffers in auto save. */
2646 /* Try reading using an X menu.
2647 This is never confused with reading using the minibuf
2648 because the recursive call of read_char in read_char_minibuf_menu_prompt
2649 does not pass on any keymaps. */
2651 if (KEYMAPP (map
) && INTERACTIVE
2652 && !NILP (prev_event
)
2653 && EVENT_HAS_PARAMETERS (prev_event
)
2654 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2655 && !EQ (XCAR (prev_event
), Qtool_bar
)
2656 /* Don't bring up a menu if we already have another event. */
2657 && NILP (Vunread_command_events
))
2659 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2661 /* Now that we have read an event, Emacs is not idle. */
2668 /* Maybe autosave and/or garbage collect due to idleness. */
2670 if (INTERACTIVE
&& NILP (c
))
2673 ptrdiff_t buffer_size
;
2675 /* Slow down auto saves logarithmically in size of current buffer,
2676 and garbage collect while we're at it. */
2677 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2678 last_non_minibuf_size
= Z
- BEG
;
2679 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2681 while (buffer_size
> 64)
2682 delay_level
++, buffer_size
-= buffer_size
>> 2;
2683 if (delay_level
< 4) delay_level
= 4;
2684 /* delay_level is 4 for files under around 50k, 7 at 100k,
2685 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2687 /* Auto save if enough time goes by without input. */
2688 if (commandflag
!= 0 && commandflag
!= -2
2689 && num_nonmacro_input_events
> last_auto_save
2690 && INTEGERP (Vauto_save_timeout
)
2691 && XINT (Vauto_save_timeout
) > 0)
2694 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2696 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2697 timeout
= delay_level
* timeout
/ 4;
2698 save_getcjmp (save_jump
);
2699 restore_getcjmp (local_getcjmp
);
2700 tem0
= sit_for (make_number (timeout
), 1, 1);
2701 restore_getcjmp (save_jump
);
2704 && ! CONSP (Vunread_command_events
))
2706 Fdo_auto_save (Qnil
, Qnil
);
2711 /* If there is still no input available, ask for GC. */
2712 if (!detect_input_pending_run_timers (0))
2716 /* Notify the caller if an autosave hook, or a timer, sentinel or
2717 filter in the sit_for calls above have changed the current
2718 kboard. This could happen if they use the minibuffer or start a
2719 recursive edit, like the fancy splash screen in server.el's
2720 filter. If this longjmp wasn't here, read_key_sequence would
2721 interpret the next key sequence using the wrong translation
2722 tables and function keymaps. */
2723 if (NILP (c
) && current_kboard
!= orig_kboard
)
2724 return make_number (-2); /* wrong_kboard_jmpbuf */
2726 /* If this has become non-nil here, it has been set by a timer
2727 or sentinel or filter. */
2728 if (CONSP (Vunread_command_events
))
2730 c
= XCAR (Vunread_command_events
);
2731 Vunread_command_events
= XCDR (Vunread_command_events
);
2733 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2739 /* Read something from current KBOARD's side queue, if possible. */
2743 if (current_kboard
->kbd_queue_has_data
)
2745 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2747 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2748 kset_kbd_queue (current_kboard
,
2749 XCDR (KVAR (current_kboard
, kbd_queue
)));
2750 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2751 current_kboard
->kbd_queue_has_data
= false;
2752 input_pending
= readable_events (0);
2753 if (EVENT_HAS_PARAMETERS (c
)
2754 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2755 internal_last_event_frame
= XCAR (XCDR (c
));
2756 Vlast_event_frame
= internal_last_event_frame
;
2760 /* If current_kboard's side queue is empty check the other kboards.
2761 If one of them has data that we have not yet seen here,
2762 switch to it and process the data waiting for it.
2764 Note: if the events queued up for another kboard
2765 have already been seen here, and therefore are not a complete command,
2766 the kbd_queue_has_data field is 0, so we skip that kboard here.
2767 That's to avoid an infinite loop switching between kboards here. */
2768 if (NILP (c
) && !single_kboard
)
2771 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2772 if (kb
->kbd_queue_has_data
)
2774 current_kboard
= kb
;
2775 return make_number (-2); /* wrong_kboard_jmpbuf */
2785 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2786 prev_event
, used_mouse_menu
);
2787 if (NILP (c
) && end_time
2788 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2793 if (EQ (c
, make_number (-2)))
2805 if (commandflag
>= 0
2806 && !input_pending
&& !detect_input_pending_run_timers (0))
2812 /* Buffer switch events are only for internal wakeups
2813 so don't show them to the user.
2814 Also, don't record a key if we already did. */
2818 /* Process special events within read_char
2819 and loop around to read another event. */
2822 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2827 struct buffer
*prev_buffer
= current_buffer
;
2828 last_input_event
= c
;
2829 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2831 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2832 /* We stopped being idle for this event; undo that. This
2833 prevents automatic window selection (under
2834 mouse_autoselect_window from acting as a real input event, for
2835 example banishing the mouse under mouse-avoidance-mode. */
2836 timer_resume_idle ();
2838 if (current_buffer
!= prev_buffer
)
2840 /* The command may have changed the keymaps. Pretend there
2841 is input in another keyboard and return. This will
2842 recalculate keymaps. */
2843 c
= make_number (-2);
2850 /* Handle things that only apply to characters. */
2853 /* If kbd_buffer_get_event gave us an EOF, return that. */
2857 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2858 && UNSIGNED_CMP (XFASTINT (c
), <,
2859 SCHARS (KVAR (current_kboard
,
2860 Vkeyboard_translate_table
))))
2861 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2862 && UNSIGNED_CMP (XFASTINT (c
), <,
2863 ASIZE (KVAR (current_kboard
,
2864 Vkeyboard_translate_table
))))
2865 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2869 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2870 /* nil in keyboard-translate-table means no translation. */
2876 /* If this event is a mouse click in the menu bar,
2877 return just menu-bar for now. Modify the mouse click event
2878 so we won't do this twice, then queue it up. */
2879 if (EVENT_HAS_PARAMETERS (c
)
2881 && CONSP (EVENT_START (c
))
2882 && CONSP (XCDR (EVENT_START (c
))))
2886 posn
= POSN_POSN (EVENT_START (c
));
2887 /* Handle menu-bar events:
2888 insert the dummy prefix event `menu-bar'. */
2889 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2891 /* Change menu-bar to (menu-bar) as the event "position". */
2892 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2895 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2900 /* Store these characters into recent_keys, the dribble file if any,
2901 and the keyboard macro being defined, if any. */
2904 if (! NILP (also_record
))
2905 record_char (also_record
);
2907 /* Wipe the echo area.
2908 But first, if we are about to use an input method,
2909 save the echo area contents for it to refer to. */
2911 && ! NILP (Vinput_method_function
)
2912 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2914 previous_echo_area_message
= Fcurrent_message ();
2915 Vinput_method_previous_message
= previous_echo_area_message
;
2918 /* Now wipe the echo area, except for help events which do their
2919 own stuff with the echo area. */
2921 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2922 && !(EQ (Qswitch_frame
, XCAR (c
)))
2923 /* Don't wipe echo area for select window events: These might
2924 get delayed via `mouse-autoselect-window' (Bug#11304). */
2925 && !(EQ (Qselect_window
, XCAR (c
)))))
2927 if (!NILP (echo_area_buffer
[0]))
2929 safe_run_hooks (Qecho_area_clear_hook
);
2930 clear_message (1, 0);
2934 reread_for_input_method
:
2936 /* Pass this to the input method, if appropriate. */
2938 && ! NILP (Vinput_method_function
)
2939 /* Don't run the input method within a key sequence,
2940 after the first event of the key sequence. */
2941 && NILP (prev_event
)
2942 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2945 ptrdiff_t key_count
;
2946 ptrdiff_t command_key_start
;
2947 ptrdiff_t count
= SPECPDL_INDEX ();
2949 /* Save the echo status. */
2950 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2951 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2952 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2953 Lisp_Object saved_echo_prompt
= KVAR (current_kboard
, echo_prompt
);
2955 /* Save the this_command_keys status. */
2956 key_count
= this_command_key_count
;
2957 command_key_start
= this_single_command_key_start
;
2960 keys
= Fcopy_sequence (this_command_keys
);
2964 /* Clear out this_command_keys. */
2965 this_command_key_count
= 0;
2966 this_single_command_key_start
= 0;
2968 /* Now wipe the echo area. */
2969 if (!NILP (echo_area_buffer
[0]))
2970 safe_run_hooks (Qecho_area_clear_hook
);
2971 clear_message (1, 0);
2974 /* If we are not reading a key sequence,
2975 never use the echo area. */
2978 specbind (Qinput_method_use_echo_area
, Qt
);
2981 /* Call the input method. */
2982 tem
= call1 (Vinput_method_function
, c
);
2984 tem
= unbind_to (count
, tem
);
2986 /* Restore the saved echoing state
2987 and this_command_keys state. */
2988 this_command_key_count
= key_count
;
2989 this_single_command_key_start
= command_key_start
;
2991 this_command_keys
= keys
;
2994 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
2995 kset_echo_string (current_kboard
, saved_echo_string
);
2996 kset_echo_prompt (current_kboard
, saved_echo_prompt
);
2997 if (saved_immediate_echo
)
3000 /* The input method can return no events. */
3003 /* Bring back the previous message, if any. */
3004 if (! NILP (previous_echo_area_message
))
3005 message_with_string ("%s", previous_echo_area_message
, 0);
3008 /* It returned one event or more. */
3010 Vunread_post_input_method_events
3011 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3013 /* When we consume events from the various unread-*-events lists, we
3014 bypass the code that records input, so record these events now if
3015 they were not recorded already. */
3024 /* Display help if not echoing. */
3025 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3027 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3028 Lisp_Object help
, object
, position
, window
, htem
;
3030 htem
= Fcdr (XCDR (c
));
3033 window
= Fcar (htem
);
3035 object
= Fcar (htem
);
3037 position
= Fcar (htem
);
3039 show_help_echo (help
, window
, object
, position
);
3041 /* We stopped being idle for this event; undo that. */
3043 timer_resume_idle ();
3047 if ((! reread
|| this_command_key_count
== 0)
3051 /* Don't echo mouse motion events. */
3052 if (! (EVENT_HAS_PARAMETERS (c
)
3053 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3054 /* Once we reread a character, echoing can happen
3055 the next time we pause to read a new one. */
3056 ok_to_echo_at_next_pause
= current_kboard
;
3058 /* Record this character as part of the current key. */
3059 add_command_key (c
);
3060 if (! NILP (also_record
))
3061 add_command_key (also_record
);
3066 last_input_event
= c
;
3069 /* Process the help character specially if enabled. */
3070 if (!NILP (Vhelp_form
) && help_char_p (c
))
3072 ptrdiff_t count
= SPECPDL_INDEX ();
3074 help_form_saved_window_configs
3075 = Fcons (Fcurrent_window_configuration (Qnil
),
3076 help_form_saved_window_configs
);
3077 record_unwind_protect_void (read_char_help_form_unwind
);
3078 call0 (Qhelp_form_show
);
3083 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3084 if (EVENT_HAS_PARAMETERS (c
)
3085 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3086 XSETCAR (help_form_saved_window_configs
, Qnil
);
3088 while (BUFFERP (c
));
3089 /* Remove the help from the frame. */
3090 unbind_to (count
, Qnil
);
3093 if (EQ (c
, make_number (040)))
3097 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3098 while (BUFFERP (c
));
3104 input_was_pending
= input_pending
;
3108 /* Record a key that came from a mouse menu.
3109 Record it for echoing, for this-command-keys, and so on. */
3112 record_menu_key (Lisp_Object c
)
3114 /* Wipe the echo area. */
3115 clear_message (1, 0);
3119 /* Once we reread a character, echoing can happen
3120 the next time we pause to read a new one. */
3121 ok_to_echo_at_next_pause
= NULL
;
3123 /* Record this character as part of the current key. */
3124 add_command_key (c
);
3127 /* Re-reading in the middle of a command. */
3128 last_input_event
= c
;
3132 /* Return true if should recognize C as "the help character". */
3135 help_char_p (Lisp_Object c
)
3139 if (EQ (c
, Vhelp_char
))
3141 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3142 if (EQ (c
, XCAR (tail
)))
3147 /* Record the input event C in various ways. */
3150 record_char (Lisp_Object c
)
3154 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3156 /* To avoid filling recent_keys with help-echo and mouse-movement
3157 events, we filter out repeated help-echo events, only store the
3158 first and last in a series of mouse-movement events, and don't
3159 store repeated help-echo events which are only separated by
3160 mouse-movement events. */
3162 Lisp_Object ev1
, ev2
, ev3
;
3165 if ((ix1
= recent_keys_index
- 1) < 0)
3166 ix1
= NUM_RECENT_KEYS
- 1;
3167 ev1
= AREF (recent_keys
, ix1
);
3169 if ((ix2
= ix1
- 1) < 0)
3170 ix2
= NUM_RECENT_KEYS
- 1;
3171 ev2
= AREF (recent_keys
, ix2
);
3173 if ((ix3
= ix2
- 1) < 0)
3174 ix3
= NUM_RECENT_KEYS
- 1;
3175 ev3
= AREF (recent_keys
, ix3
);
3177 if (EQ (XCAR (c
), Qhelp_echo
))
3179 /* Don't record `help-echo' in recent_keys unless it shows some help
3180 message, and a different help than the previously recorded
3182 Lisp_Object help
, last_help
;
3184 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3185 if (!STRINGP (help
))
3187 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3188 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3190 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3191 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3192 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3194 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3195 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3196 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3197 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3200 else if (EQ (XCAR (c
), Qmouse_movement
))
3202 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3203 So additional mouse movement events replace the last element. */
3204 Lisp_Object last_window
, window
;
3206 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3207 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3208 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3209 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3210 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3212 ASET (recent_keys
, ix1
, c
);
3218 store_kbd_macro_char (c
);
3222 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3223 ASET (recent_keys
, recent_keys_index
, c
);
3224 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3225 recent_keys_index
= 0;
3227 else if (recorded
< 0)
3229 /* We need to remove one or two events from recent_keys.
3230 To do this, we simply put nil at those events and move the
3231 recent_keys_index backwards over those events. Usually,
3232 users will never see those nil events, as they will be
3233 overwritten by the command keys entered to see recent_keys
3236 while (recorded
++ < 0 && total_keys
> 0)
3238 if (total_keys
< NUM_RECENT_KEYS
)
3240 if (--recent_keys_index
< 0)
3241 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3242 ASET (recent_keys
, recent_keys_index
, Qnil
);
3246 num_nonmacro_input_events
++;
3248 /* Write c to the dribble file. If c is a lispy event, write
3249 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3250 If you, dear reader, have a better idea, you've got the source. :-) */
3256 if (XUINT (c
) < 0x100)
3257 putc (XUINT (c
), dribble
);
3259 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3263 Lisp_Object dribblee
;
3265 /* If it's a structured event, take the event header. */
3266 dribblee
= EVENT_HEAD (c
);
3268 if (SYMBOLP (dribblee
))
3270 putc ('<', dribble
);
3271 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3272 SBYTES (SYMBOL_NAME (dribblee
)),
3274 putc ('>', dribble
);
3283 /* Copy out or in the info on where C-g should throw to.
3284 This is used when running Lisp code from within get_char,
3285 in case get_char is called recursively.
3286 See read_process_output. */
3289 save_getcjmp (sys_jmp_buf temp
)
3291 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3295 restore_getcjmp (sys_jmp_buf temp
)
3297 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3300 /* Low level keyboard/mouse input.
3301 kbd_buffer_store_event places events in kbd_buffer, and
3302 kbd_buffer_get_event retrieves them. */
3304 /* Return true if there are any events in the queue that read-char
3305 would return. If this returns false, a read-char would block. */
3307 readable_events (int flags
)
3309 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3312 /* If the buffer contains only FOCUS_IN_EVENT events, and
3313 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3314 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3316 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3317 #ifdef USE_TOOLKIT_SCROLL_BARS
3318 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3322 union buffered_input_event
*event
;
3324 event
= ((kbd_fetch_ptr
< 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
))
3346 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3349 while (event
!= kbd_store_ptr
);
3355 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3356 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3360 if (current_kboard
->kbd_queue_has_data
)
3366 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3367 if (kb
->kbd_queue_has_data
)
3373 /* Set this for debugging, to have a way to get out */
3374 int stop_character EXTERNALLY_VISIBLE
;
3377 event_to_kboard (struct input_event
*event
)
3379 /* Not applicable for these special events. */
3380 if (event
->kind
== SELECTION_REQUEST_EVENT
3381 || event
->kind
== SELECTION_CLEAR_EVENT
)
3385 Lisp_Object obj
= event
->frame_or_window
;
3386 /* There are some events that set this field to nil or string. */
3388 obj
= WINDOW_FRAME (XWINDOW (obj
));
3389 /* Also ignore dead frames here. */
3390 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3391 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3396 /* Return the number of slots occupied in kbd_buffer. */
3399 kbd_buffer_nr_stored (void)
3401 return kbd_fetch_ptr
== kbd_store_ptr
3403 : (kbd_fetch_ptr
< kbd_store_ptr
3404 ? kbd_store_ptr
- kbd_fetch_ptr
3405 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3406 + (kbd_store_ptr
- kbd_buffer
)));
3408 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3411 kbd_buffer_store_event (register struct input_event
*event
)
3413 kbd_buffer_store_event_hold (event
, 0);
3416 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3418 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3419 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3420 Else, if EVENT is a quit event, store the quit event
3421 in HOLD_QUIT, and return (thus ignoring further events).
3423 This is used to postpone the processing of the quit event until all
3424 subsequent input events have been parsed (and discarded). */
3427 kbd_buffer_store_buffered_event (union buffered_input_event
*event
,
3428 struct input_event
*hold_quit
)
3430 if (event
->kind
== NO_EVENT
)
3433 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3436 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3438 int c
= event
->ie
.code
& 0377;
3440 if (event
->ie
.modifiers
& ctrl_modifier
)
3441 c
= make_ctrl_char (c
);
3443 c
|= (event
->ie
.modifiers
3444 & (meta_modifier
| alt_modifier
3445 | hyper_modifier
| super_modifier
));
3449 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->ie
.frame_or_window
));
3451 if (single_kboard
&& kb
!= current_kboard
)
3454 (kb
, list2 (make_lispy_switch_frame (event
->ie
.frame_or_window
),
3456 kb
->kbd_queue_has_data
= true;
3457 union buffered_input_event
*sp
;
3458 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3460 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3463 if (event_to_kboard (&sp
->ie
) == kb
)
3465 sp
->ie
.kind
= NO_EVENT
;
3466 sp
->ie
.frame_or_window
= Qnil
;
3475 *hold_quit
= event
->ie
;
3479 /* If this results in a quit_char being returned to Emacs as
3480 input, set Vlast_event_frame properly. If this doesn't
3481 get returned to Emacs as an event, the next event read
3482 will set Vlast_event_frame again, so this is safe to do. */
3486 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->ie
.frame_or_window
));
3488 focus
= event
->ie
.frame_or_window
;
3489 internal_last_event_frame
= focus
;
3490 Vlast_event_frame
= focus
;
3493 handle_interrupt (0);
3497 if (c
&& c
== stop_character
)
3503 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3504 Just ignore the second one. */
3505 else if (event
->kind
== BUFFER_SWITCH_EVENT
3506 && kbd_fetch_ptr
!= kbd_store_ptr
3507 && ((kbd_store_ptr
== kbd_buffer
3508 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3509 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3512 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3513 kbd_store_ptr
= kbd_buffer
;
3515 /* Don't let the very last slot in the buffer become full,
3516 since that would make the two pointers equal,
3517 and that is indistinguishable from an empty buffer.
3518 Discard the event if it would fill the last slot. */
3519 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3521 *kbd_store_ptr
= *event
;
3524 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3525 && ! kbd_on_hold_p ())
3527 /* Don't read keyboard input until we have processed kbd_buffer.
3528 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3529 hold_keyboard_input ();
3533 #endif /* subprocesses */
3536 /* If we're inside while-no-input, and this event qualifies
3537 as input, set quit-flag to cause an interrupt. */
3538 if (!NILP (Vthrow_on_input
)
3539 && event
->kind
!= FOCUS_IN_EVENT
3540 && event
->kind
!= FOCUS_OUT_EVENT
3541 && event
->kind
!= HELP_EVENT
3542 && event
->kind
!= ICONIFY_EVENT
3543 && event
->kind
!= DEICONIFY_EVENT
)
3545 Vquit_flag
= Vthrow_on_input
;
3546 /* If we're inside a function that wants immediate quits,
3548 if (immediate_quit
&& NILP (Vinhibit_quit
))
3550 immediate_quit
= false;
3559 /* Put a selection input event back in the head of the event queue. */
3562 kbd_buffer_unget_event (struct selection_input_event
*event
)
3564 if (kbd_fetch_ptr
== kbd_buffer
)
3565 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3567 /* Don't let the very last slot in the buffer become full, */
3568 union buffered_input_event
*kp
= kbd_fetch_ptr
- 1;
3569 if (kp
!= kbd_store_ptr
)
3578 /* Limit help event positions to this range, to avoid overflow problems. */
3579 #define INPUT_EVENT_POS_MAX \
3580 ((ptrdiff_t) min (PTRDIFF_MAX, min (TYPE_MAXIMUM (Time) / 2, \
3581 MOST_POSITIVE_FIXNUM)))
3582 #define INPUT_EVENT_POS_MIN (-1 - INPUT_EVENT_POS_MAX)
3584 /* Return a Time that encodes position POS. POS must be in range. */
3587 position_to_Time (ptrdiff_t pos
)
3589 eassert (INPUT_EVENT_POS_MIN
<= pos
&& pos
<= INPUT_EVENT_POS_MAX
);
3593 /* Return the position that ENCODED_POS encodes.
3594 Avoid signed integer overflow. */
3597 Time_to_position (Time encoded_pos
)
3599 if (encoded_pos
<= INPUT_EVENT_POS_MAX
)
3601 Time encoded_pos_min
= INPUT_EVENT_POS_MIN
;
3602 eassert (encoded_pos_min
<= encoded_pos
);
3603 ptrdiff_t notpos
= -1 - encoded_pos
;
3607 /* Generate a HELP_EVENT input_event and store it in the keyboard
3610 HELP is the help form.
3612 FRAME and WINDOW are the frame and window where the help is
3613 generated. OBJECT is the Lisp object where the help was found (a
3614 buffer, a string, an overlay, or nil if neither from a string nor
3615 from a buffer). POS is the position within OBJECT where the help
3619 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3620 Lisp_Object object
, ptrdiff_t pos
)
3622 struct input_event event
;
3624 event
.kind
= HELP_EVENT
;
3625 event
.frame_or_window
= frame
;
3627 event
.x
= WINDOWP (window
) ? window
: frame
;
3629 event
.timestamp
= position_to_Time (pos
);
3630 kbd_buffer_store_event (&event
);
3634 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3637 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3639 struct input_event event
;
3641 event
.kind
= HELP_EVENT
;
3642 event
.frame_or_window
= frame
;
3646 event
.timestamp
= 0;
3647 kbd_buffer_store_event (&event
);
3651 /* Discard any mouse events in the event buffer by setting them to
3654 discard_mouse_events (void)
3656 union buffered_input_event
*sp
;
3657 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3659 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3662 if (sp
->kind
== MOUSE_CLICK_EVENT
3663 || sp
->kind
== WHEEL_EVENT
3664 || sp
->kind
== HORIZ_WHEEL_EVENT
3666 || sp
->kind
== GPM_CLICK_EVENT
3668 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3669 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3671 sp
->kind
= NO_EVENT
;
3677 /* Return true if there are any real events waiting in the event
3678 buffer, not counting `NO_EVENT's.
3680 Discard NO_EVENT events at the front of the input queue, possibly
3681 leaving the input queue empty if there are no real input events. */
3684 kbd_buffer_events_waiting (void)
3686 union buffered_input_event
*sp
;
3688 for (sp
= kbd_fetch_ptr
;
3689 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3692 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3697 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3701 /* Clear input event EVENT. */
3704 clear_event (union buffered_input_event
*event
)
3706 event
->kind
= NO_EVENT
;
3710 /* Read one event from the event buffer, waiting if necessary.
3711 The value is a Lisp object representing the event.
3712 The value is nil for an event that should be ignored,
3713 or that was handled here.
3714 We always read and discard one event. */
3717 kbd_buffer_get_event (KBOARD
**kbp
,
3718 bool *used_mouse_menu
,
3719 struct timespec
*end_time
)
3724 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/ 4)
3726 /* Start reading input again because we have processed enough to
3727 be able to accept new events again. */
3728 unhold_keyboard_input ();
3732 #endif /* subprocesses */
3734 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3736 /* In case we are running as a daemon, only do this before
3737 detaching from the terminal. */
3738 || (IS_DAEMON
&& DAEMON_RUNNING
))
3742 *kbp
= current_kboard
;
3745 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3747 /* Wait until there is input available. */
3750 /* Break loop if there's an unread command event. Needed in
3751 moused window autoselection which uses a timer to insert such
3753 if (CONSP (Vunread_command_events
))
3756 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3758 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3761 /* If the quit flag is set, then read_char will return
3762 quit_char, so that counts as "available input." */
3763 if (!NILP (Vquit_flag
))
3764 quit_throw_to_read_char (0);
3766 /* One way or another, wait until input is available; then, if
3767 interrupt handlers have not read it, read it now. */
3772 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3774 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3778 struct timespec now
= current_timespec ();
3779 if (timespec_cmp (*end_time
, now
) <= 0)
3780 return Qnil
; /* Finished waiting. */
3783 struct timespec duration
= timespec_sub (*end_time
, now
);
3784 wait_reading_process_output (min (duration
.tv_sec
,
3787 -1, 1, Qnil
, NULL
, 0);
3792 bool do_display
= true;
3794 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3796 struct tty_display_info
*tty
= CURTTY ();
3798 /* When this TTY is displaying a menu, we must prevent
3799 any redisplay, because we modify the frame's glyph
3800 matrix behind the back of the display engine. */
3801 if (tty
->showing_menu
)
3805 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3808 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3812 if (CONSP (Vunread_command_events
))
3815 first
= XCAR (Vunread_command_events
);
3816 Vunread_command_events
= XCDR (Vunread_command_events
);
3817 *kbp
= current_kboard
;
3821 /* At this point, we know that there is a readable event available
3822 somewhere. If the event queue is empty, then there must be a
3823 mouse movement enabled and available. */
3824 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3826 union buffered_input_event
*event
;
3828 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3832 *kbp
= event_to_kboard (&event
->ie
);
3834 *kbp
= current_kboard
; /* Better than returning null ptr? */
3838 /* These two kinds of events get special handling
3839 and don't actually appear to the command loop.
3840 We return nil for them. */
3841 if (event
->kind
== SELECTION_REQUEST_EVENT
3842 || event
->kind
== SELECTION_CLEAR_EVENT
)
3845 /* Remove it from the buffer before processing it,
3846 since otherwise swallow_events will see it
3847 and process it again. */
3848 struct selection_input_event copy
= event
->sie
;
3849 kbd_fetch_ptr
= event
+ 1;
3850 input_pending
= readable_events (0);
3851 x_handle_selection_event (©
);
3853 /* We're getting selection request events, but we don't have
3859 #if defined (HAVE_NS)
3860 else if (event
->kind
== NS_TEXT_EVENT
)
3862 if (event
->ie
.code
== KEY_NS_PUT_WORKING_TEXT
)
3863 obj
= list1 (intern ("ns-put-working-text"));
3865 obj
= list1 (intern ("ns-unput-working-text"));
3866 kbd_fetch_ptr
= event
+ 1;
3867 if (used_mouse_menu
)
3868 *used_mouse_menu
= true;
3872 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3873 || defined (HAVE_NS)
3874 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3876 /* Make an event (delete-frame (FRAME)). */
3877 obj
= list2 (Qdelete_frame
, list1 (event
->ie
.frame_or_window
));
3878 kbd_fetch_ptr
= event
+ 1;
3881 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3882 || defined (HAVE_NS)
3883 else if (event
->kind
== ICONIFY_EVENT
)
3885 /* Make an event (iconify-frame (FRAME)). */
3886 obj
= list2 (Qiconify_frame
, list1 (event
->ie
.frame_or_window
));
3887 kbd_fetch_ptr
= event
+ 1;
3889 else if (event
->kind
== DEICONIFY_EVENT
)
3891 /* Make an event (make-frame-visible (FRAME)). */
3892 obj
= list2 (Qmake_frame_visible
, list1 (event
->ie
.frame_or_window
));
3893 kbd_fetch_ptr
= event
+ 1;
3896 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3898 /* The value doesn't matter here; only the type is tested. */
3899 XSETBUFFER (obj
, current_buffer
);
3900 kbd_fetch_ptr
= event
+ 1;
3902 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3903 || defined (HAVE_NS) || defined (USE_GTK)
3904 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3906 kbd_fetch_ptr
= event
+ 1;
3907 input_pending
= readable_events (0);
3908 if (FRAME_LIVE_P (XFRAME (event
->ie
.frame_or_window
)))
3909 x_activate_menubar (XFRAME (event
->ie
.frame_or_window
));
3913 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3915 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3916 obj
= list4 (Qlanguage_change
,
3917 event
->ie
.frame_or_window
,
3918 make_number (event
->ie
.code
),
3919 make_number (event
->ie
.modifiers
));
3920 kbd_fetch_ptr
= event
+ 1;
3923 #ifdef USE_FILE_NOTIFY
3924 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3926 #ifdef HAVE_W32NOTIFY
3927 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3928 obj
= list3 (Qfile_notify
, event
->ie
.arg
, event
->ie
.frame_or_window
);
3930 obj
= make_lispy_event (&event
->ie
);
3932 kbd_fetch_ptr
= event
+ 1;
3934 #endif /* USE_FILE_NOTIFY */
3935 else if (event
->kind
== SAVE_SESSION_EVENT
)
3937 obj
= list2 (Qsave_session
, event
->ie
.arg
);
3938 kbd_fetch_ptr
= event
+ 1;
3940 /* Just discard these, by returning nil.
3941 With MULTI_KBOARD, these events are used as placeholders
3942 when we need to randomly delete events from the queue.
3943 (They shouldn't otherwise be found in the buffer,
3944 but on some machines it appears they do show up
3945 even without MULTI_KBOARD.) */
3946 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3947 mouse events during a popup-menu call. */
3948 else if (event
->kind
== NO_EVENT
)
3949 kbd_fetch_ptr
= event
+ 1;
3950 else if (event
->kind
== HELP_EVENT
)
3952 Lisp_Object object
, position
, help
, frame
, window
;
3954 frame
= event
->ie
.frame_or_window
;
3955 object
= event
->ie
.arg
;
3956 position
= make_number (Time_to_position (event
->ie
.timestamp
));
3957 window
= event
->ie
.x
;
3959 clear_event (event
);
3961 kbd_fetch_ptr
= event
+ 1;
3962 if (!WINDOWP (window
))
3964 obj
= Fcons (Qhelp_echo
,
3965 list5 (frame
, help
, window
, object
, position
));
3967 else if (event
->kind
== FOCUS_IN_EVENT
)
3969 /* Notification of a FocusIn event. The frame receiving the
3970 focus is in event->frame_or_window. Generate a
3971 switch-frame event if necessary. */
3972 Lisp_Object frame
, focus
;
3974 frame
= event
->ie
.frame_or_window
;
3975 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3981 ! NILP (event
->ie
.arg
)
3984 !EQ (frame
, internal_last_event_frame
)
3985 && !EQ (frame
, selected_frame
))
3986 obj
= make_lispy_switch_frame (frame
);
3988 obj
= make_lispy_focus_in (frame
);
3990 internal_last_event_frame
= frame
;
3991 kbd_fetch_ptr
= event
+ 1;
3993 else if (event
->kind
== FOCUS_OUT_EVENT
)
3995 #ifdef HAVE_WINDOW_SYSTEM
3998 Lisp_Object frame
= event
->ie
.frame_or_window
;
3999 bool focused
= false;
4001 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4002 focused
= di
->x_highlight_frame
!= 0;
4005 obj
= make_lispy_focus_out (frame
);
4007 #endif /* HAVE_WINDOW_SYSTEM */
4009 kbd_fetch_ptr
= event
+ 1;
4012 else if (event
->kind
== DBUS_EVENT
)
4014 obj
= make_lispy_event (&event
->ie
);
4015 kbd_fetch_ptr
= event
+ 1;
4018 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4020 obj
= make_lispy_event (&event
->ie
);
4021 kbd_fetch_ptr
= event
+ 1;
4025 /* If this event is on a different frame, return a switch-frame this
4026 time, and leave the event in the queue for next time. */
4030 frame
= event
->ie
.frame_or_window
;
4032 frame
= XCAR (frame
);
4033 else if (WINDOWP (frame
))
4034 frame
= WINDOW_FRAME (XWINDOW (frame
));
4036 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4040 if (! EQ (frame
, internal_last_event_frame
)
4041 && !EQ (frame
, selected_frame
))
4042 obj
= make_lispy_switch_frame (frame
);
4043 internal_last_event_frame
= frame
;
4045 /* If we didn't decide to make a switch-frame event, go ahead
4046 and build a real event from the queue entry. */
4050 obj
= make_lispy_event (&event
->ie
);
4052 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4053 || defined (HAVE_NS) || defined (USE_GTK)
4054 /* If this was a menu selection, then set the flag to inhibit
4055 writing to last_nonmenu_event. Don't do this if the event
4056 we're returning is (menu-bar), though; that indicates the
4057 beginning of the menu sequence, and we might as well leave
4058 that as the `event with parameters' for this selection. */
4060 && !EQ (event
->ie
.frame_or_window
, event
->ie
.arg
)
4061 && (event
->kind
== MENU_BAR_EVENT
4062 || event
->kind
== TOOL_BAR_EVENT
))
4063 *used_mouse_menu
= true;
4066 /* Certain system events are non-key events. */
4068 && event
->kind
== NS_NONKEY_EVENT
)
4069 *used_mouse_menu
= true;
4072 /* Wipe out this event, to catch bugs. */
4073 clear_event (event
);
4074 kbd_fetch_ptr
= event
+ 1;
4078 /* Try generating a mouse motion event. */
4079 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4081 struct frame
*f
= some_mouse_moved ();
4082 Lisp_Object bar_window
;
4083 enum scroll_bar_part part
;
4087 *kbp
= current_kboard
;
4088 /* Note that this uses F to determine which terminal to look at.
4089 If there is no valid info, it does not store anything
4090 so x remains nil. */
4093 /* XXX Can f or mouse_position_hook be NULL here? */
4094 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4095 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4100 /* Decide if we should generate a switch-frame event. Don't
4101 generate switch-frame events for motion outside of all Emacs
4107 frame
= FRAME_FOCUS_FRAME (f
);
4109 XSETFRAME (frame
, f
);
4111 if (! EQ (frame
, internal_last_event_frame
)
4112 && !EQ (frame
, selected_frame
))
4113 obj
= make_lispy_switch_frame (frame
);
4114 internal_last_event_frame
= frame
;
4117 /* If we didn't decide to make a switch-frame event, go ahead and
4118 return a mouse-motion event. */
4119 if (!NILP (x
) && NILP (obj
))
4120 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4123 /* We were promised by the above while loop that there was
4124 something for us to read! */
4127 input_pending
= readable_events (0);
4129 Vlast_event_frame
= internal_last_event_frame
;
4134 /* Process any non-user-visible events (currently X selection events),
4135 without reading any user-visible events. */
4138 process_special_events (void)
4140 union buffered_input_event
*event
;
4142 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4144 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4147 if (event
== kbd_store_ptr
)
4151 /* If we find a stored X selection request, handle it now. */
4152 if (event
->kind
== SELECTION_REQUEST_EVENT
4153 || event
->kind
== SELECTION_CLEAR_EVENT
)
4157 /* Remove the event from the fifo buffer before processing;
4158 otherwise swallow_events called recursively could see it
4159 and process it again. To do this, we move the events
4160 between kbd_fetch_ptr and EVENT one slot to the right,
4163 struct selection_input_event copy
= event
->sie
;
4164 union buffered_input_event
*beg
4165 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4166 ? kbd_buffer
: kbd_fetch_ptr
;
4169 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof *beg
);
4170 else if (event
< beg
)
4172 if (event
> kbd_buffer
)
4173 memmove (kbd_buffer
+ 1, kbd_buffer
,
4174 (event
- kbd_buffer
) * sizeof *kbd_buffer
);
4175 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4176 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4177 memmove (beg
+ 1, beg
,
4178 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
) * sizeof *beg
);
4181 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4182 kbd_fetch_ptr
= kbd_buffer
+ 1;
4186 input_pending
= readable_events (0);
4187 x_handle_selection_event (©
);
4189 /* We're getting selection request events, but we don't have
4197 /* Process any events that are not user-visible, run timer events that
4198 are ripe, and return, without reading any user-visible events. */
4201 swallow_events (bool do_display
)
4203 unsigned old_timers_run
;
4205 process_special_events ();
4207 old_timers_run
= timers_run
;
4208 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4210 if (!input_pending
&& timers_run
!= old_timers_run
&& do_display
)
4211 redisplay_preserve_echo_area (7);
4214 /* Record the start of when Emacs is idle,
4215 for the sake of running idle-time timers. */
4218 timer_start_idle (void)
4220 /* If we are already in the idle state, do nothing. */
4221 if (timespec_valid_p (timer_idleness_start_time
))
4224 timer_idleness_start_time
= current_timespec ();
4225 timer_last_idleness_start_time
= timer_idleness_start_time
;
4227 /* Mark all idle-time timers as once again candidates for running. */
4228 call0 (intern ("internal-timer-start-idle"));
4231 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4234 timer_stop_idle (void)
4236 timer_idleness_start_time
= invalid_timespec ();
4239 /* Resume idle timer from last idle start time. */
4242 timer_resume_idle (void)
4244 if (timespec_valid_p (timer_idleness_start_time
))
4247 timer_idleness_start_time
= timer_last_idleness_start_time
;
4250 /* List of elisp functions to call, delayed because they were generated in
4251 a context where Elisp could not be safely run (e.g. redisplay, signal,
4252 ...). Each element has the form (FUN . ARGS). */
4253 Lisp_Object pending_funcalls
;
4255 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4257 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4261 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4263 vec
= XVECTOR (timer
)->contents
;
4264 if (! NILP (vec
[0]))
4266 if (! INTEGERP (vec
[2]))
4270 if (decode_time_components (vec
[1], vec
[2], vec
[3], vec
[8], &t
, 0) <= 0)
4272 *result
= lisp_to_timespec (t
);
4273 return timespec_valid_p (*result
);
4277 /* Check whether a timer has fired. To prevent larger problems we simply
4278 disregard elements that are not proper timers. Do not make a circular
4279 timer list for the time being.
4281 Returns the time to wait until the next timer fires. If a
4282 timer is triggering now, return zero.
4283 If no timer is active, return -1.
4285 If a timer is ripe, we run it, with quitting turned off.
4286 In that case we return 0 to indicate that a new timer_check_2 call
4289 static struct timespec
4290 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4292 struct timespec nexttime
;
4293 struct timespec now
;
4294 struct timespec idleness_now
;
4295 Lisp_Object chosen_timer
;
4297 nexttime
= invalid_timespec ();
4299 chosen_timer
= Qnil
;
4301 /* First run the code that was delayed. */
4302 while (CONSP (pending_funcalls
))
4304 Lisp_Object funcall
= XCAR (pending_funcalls
);
4305 pending_funcalls
= XCDR (pending_funcalls
);
4306 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4309 if (CONSP (timers
) || CONSP (idle_timers
))
4311 now
= current_timespec ();
4312 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4313 ? timespec_sub (now
, timer_idleness_start_time
)
4314 : make_timespec (0, 0));
4317 while (CONSP (timers
) || CONSP (idle_timers
))
4319 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4320 struct timespec timer_time
, idle_timer_time
;
4321 struct timespec difference
;
4322 struct timespec timer_difference
= invalid_timespec ();
4323 struct timespec idle_timer_difference
= invalid_timespec ();
4324 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4326 /* Set TIMER and TIMER_DIFFERENCE
4327 based on the next ordinary timer.
4328 TIMER_DIFFERENCE is the distance in time from NOW to when
4329 this timer becomes ripe.
4330 Skip past invalid timers and timers already handled. */
4333 timer
= XCAR (timers
);
4334 if (! decode_timer (timer
, &timer_time
))
4336 timers
= XCDR (timers
);
4340 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4341 timer_difference
= (timer_ripe
4342 ? timespec_sub (now
, timer_time
)
4343 : timespec_sub (timer_time
, now
));
4346 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4347 based on the next idle timer. */
4348 if (CONSP (idle_timers
))
4350 idle_timer
= XCAR (idle_timers
);
4351 if (! decode_timer (idle_timer
, &idle_timer_time
))
4353 idle_timers
= XCDR (idle_timers
);
4357 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4358 idle_timer_difference
4360 ? timespec_sub (idleness_now
, idle_timer_time
)
4361 : timespec_sub (idle_timer_time
, idleness_now
));
4364 /* Decide which timer is the next timer,
4365 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4366 Also step down the list where we found that timer. */
4368 if (timespec_valid_p (timer_difference
)
4369 && (! timespec_valid_p (idle_timer_difference
)
4370 || idle_timer_ripe
< timer_ripe
4371 || (idle_timer_ripe
== timer_ripe
4373 ? timespec_cmp (idle_timer_difference
,
4375 : timespec_cmp (timer_difference
,
4376 idle_timer_difference
))
4379 chosen_timer
= timer
;
4380 timers
= XCDR (timers
);
4381 difference
= timer_difference
;
4386 chosen_timer
= idle_timer
;
4387 idle_timers
= XCDR (idle_timers
);
4388 difference
= idle_timer_difference
;
4389 ripe
= idle_timer_ripe
;
4392 /* If timer is ripe, run it if it hasn't been run. */
4395 if (NILP (AREF (chosen_timer
, 0)))
4397 ptrdiff_t count
= SPECPDL_INDEX ();
4398 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4400 /* Mark the timer as triggered to prevent problems if the lisp
4401 code fails to reschedule it right. */
4402 ASET (chosen_timer
, 0, Qt
);
4404 specbind (Qinhibit_quit
, Qt
);
4406 call1 (Qtimer_event_handler
, chosen_timer
);
4407 Vdeactivate_mark
= old_deactivate_mark
;
4409 unbind_to (count
, Qnil
);
4411 /* Since we have handled the event,
4412 we don't need to tell the caller to wake up and do it. */
4413 /* But the caller must still wait for the next timer, so
4414 return 0 to indicate that. */
4417 nexttime
= make_timespec (0, 0);
4421 /* When we encounter a timer that is still waiting,
4422 return the amount of time to wait before it is ripe. */
4428 /* No timers are pending in the future. */
4429 /* Return 0 if we generated an event, and -1 if not. */
4434 /* Check whether a timer has fired. To prevent larger problems we simply
4435 disregard elements that are not proper timers. Do not make a circular
4436 timer list for the time being.
4438 Returns the time to wait until the next timer fires.
4439 If no timer is active, return an invalid value.
4441 As long as any timer is ripe, we run it. */
4446 struct timespec nexttime
;
4447 Lisp_Object timers
, idle_timers
;
4449 Lisp_Object tem
= Vinhibit_quit
;
4452 /* We use copies of the timers' lists to allow a timer to add itself
4453 again, without locking up Emacs if the newly added timer is
4454 already ripe when added. */
4456 /* Always consider the ordinary timers. */
4457 timers
= Fcopy_sequence (Vtimer_list
);
4458 /* Consider the idle timers only if Emacs is idle. */
4459 if (timespec_valid_p (timer_idleness_start_time
))
4460 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4464 Vinhibit_quit
= tem
;
4468 nexttime
= timer_check_2 (timers
, idle_timers
);
4470 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4475 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4476 doc
: /* Return the current length of Emacs idleness, or nil.
4477 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4478 in the same style as (current-time).
4480 The value when Emacs is not idle is nil.
4482 PSEC is a multiple of the system clock resolution. */)
4485 if (timespec_valid_p (timer_idleness_start_time
))
4486 return make_lisp_time (timespec_sub (current_timespec (),
4487 timer_idleness_start_time
));
4492 /* Caches for modify_event_symbol. */
4493 static Lisp_Object accent_key_syms
;
4494 static Lisp_Object func_key_syms
;
4495 static Lisp_Object mouse_syms
;
4496 static Lisp_Object wheel_syms
;
4497 static Lisp_Object drag_n_drop_syms
;
4499 /* This is a list of keysym codes for special "accent" characters.
4500 It parallels lispy_accent_keys. */
4502 static const int lispy_accent_codes
[] =
4504 #ifdef XK_dead_circumflex
4509 #ifdef XK_dead_grave
4514 #ifdef XK_dead_tilde
4519 #ifdef XK_dead_diaeresis
4524 #ifdef XK_dead_macron
4529 #ifdef XK_dead_degree
4534 #ifdef XK_dead_acute
4539 #ifdef XK_dead_cedilla
4544 #ifdef XK_dead_breve
4549 #ifdef XK_dead_ogonek
4554 #ifdef XK_dead_caron
4559 #ifdef XK_dead_doubleacute
4560 XK_dead_doubleacute
,
4564 #ifdef XK_dead_abovedot
4569 #ifdef XK_dead_abovering
4579 #ifdef XK_dead_belowdot
4584 #ifdef XK_dead_voiced_sound
4585 XK_dead_voiced_sound
,
4589 #ifdef XK_dead_semivoiced_sound
4590 XK_dead_semivoiced_sound
,
4606 /* This is a list of Lisp names for special "accent" characters.
4607 It parallels lispy_accent_codes. */
4609 static const char *const lispy_accent_keys
[] =
4627 "dead-voiced-sound",
4628 "dead-semivoiced-sound",
4634 #define FUNCTION_KEY_OFFSET 0x0
4636 const char *const lispy_function_keys
[] =
4640 0, /* VK_LBUTTON 0x01 */
4641 0, /* VK_RBUTTON 0x02 */
4642 "cancel", /* VK_CANCEL 0x03 */
4643 0, /* VK_MBUTTON 0x04 */
4645 0, 0, 0, /* 0x05 .. 0x07 */
4647 "backspace", /* VK_BACK 0x08 */
4648 "tab", /* VK_TAB 0x09 */
4650 0, 0, /* 0x0A .. 0x0B */
4652 "clear", /* VK_CLEAR 0x0C */
4653 "return", /* VK_RETURN 0x0D */
4655 0, 0, /* 0x0E .. 0x0F */
4657 0, /* VK_SHIFT 0x10 */
4658 0, /* VK_CONTROL 0x11 */
4659 0, /* VK_MENU 0x12 */
4660 "pause", /* VK_PAUSE 0x13 */
4661 "capslock", /* VK_CAPITAL 0x14 */
4662 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4664 "junja", /* VK_JUNJA 0x17 */
4665 "final", /* VK_FINAL 0x18 */
4666 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4668 "escape", /* VK_ESCAPE 0x1B */
4669 "convert", /* VK_CONVERT 0x1C */
4670 "non-convert", /* VK_NONCONVERT 0x1D */
4671 "accept", /* VK_ACCEPT 0x1E */
4672 "mode-change", /* VK_MODECHANGE 0x1F */
4673 0, /* VK_SPACE 0x20 */
4674 "prior", /* VK_PRIOR 0x21 */
4675 "next", /* VK_NEXT 0x22 */
4676 "end", /* VK_END 0x23 */
4677 "home", /* VK_HOME 0x24 */
4678 "left", /* VK_LEFT 0x25 */
4679 "up", /* VK_UP 0x26 */
4680 "right", /* VK_RIGHT 0x27 */
4681 "down", /* VK_DOWN 0x28 */
4682 "select", /* VK_SELECT 0x29 */
4683 "print", /* VK_PRINT 0x2A */
4684 "execute", /* VK_EXECUTE 0x2B */
4685 "snapshot", /* VK_SNAPSHOT 0x2C */
4686 "insert", /* VK_INSERT 0x2D */
4687 "delete", /* VK_DELETE 0x2E */
4688 "help", /* VK_HELP 0x2F */
4690 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4692 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4694 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4696 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4698 0, 0, 0, 0, 0, 0, 0, 0, 0,
4699 0, 0, 0, 0, 0, 0, 0, 0, 0,
4700 0, 0, 0, 0, 0, 0, 0, 0,
4702 "lwindow", /* VK_LWIN 0x5B */
4703 "rwindow", /* VK_RWIN 0x5C */
4704 "apps", /* VK_APPS 0x5D */
4707 "kp-0", /* VK_NUMPAD0 0x60 */
4708 "kp-1", /* VK_NUMPAD1 0x61 */
4709 "kp-2", /* VK_NUMPAD2 0x62 */
4710 "kp-3", /* VK_NUMPAD3 0x63 */
4711 "kp-4", /* VK_NUMPAD4 0x64 */
4712 "kp-5", /* VK_NUMPAD5 0x65 */
4713 "kp-6", /* VK_NUMPAD6 0x66 */
4714 "kp-7", /* VK_NUMPAD7 0x67 */
4715 "kp-8", /* VK_NUMPAD8 0x68 */
4716 "kp-9", /* VK_NUMPAD9 0x69 */
4717 "kp-multiply", /* VK_MULTIPLY 0x6A */
4718 "kp-add", /* VK_ADD 0x6B */
4719 "kp-separator", /* VK_SEPARATOR 0x6C */
4720 "kp-subtract", /* VK_SUBTRACT 0x6D */
4721 "kp-decimal", /* VK_DECIMAL 0x6E */
4722 "kp-divide", /* VK_DIVIDE 0x6F */
4723 "f1", /* VK_F1 0x70 */
4724 "f2", /* VK_F2 0x71 */
4725 "f3", /* VK_F3 0x72 */
4726 "f4", /* VK_F4 0x73 */
4727 "f5", /* VK_F5 0x74 */
4728 "f6", /* VK_F6 0x75 */
4729 "f7", /* VK_F7 0x76 */
4730 "f8", /* VK_F8 0x77 */
4731 "f9", /* VK_F9 0x78 */
4732 "f10", /* VK_F10 0x79 */
4733 "f11", /* VK_F11 0x7A */
4734 "f12", /* VK_F12 0x7B */
4735 "f13", /* VK_F13 0x7C */
4736 "f14", /* VK_F14 0x7D */
4737 "f15", /* VK_F15 0x7E */
4738 "f16", /* VK_F16 0x7F */
4739 "f17", /* VK_F17 0x80 */
4740 "f18", /* VK_F18 0x81 */
4741 "f19", /* VK_F19 0x82 */
4742 "f20", /* VK_F20 0x83 */
4743 "f21", /* VK_F21 0x84 */
4744 "f22", /* VK_F22 0x85 */
4745 "f23", /* VK_F23 0x86 */
4746 "f24", /* VK_F24 0x87 */
4748 0, 0, 0, 0, /* 0x88 .. 0x8B */
4749 0, 0, 0, 0, /* 0x8C .. 0x8F */
4751 "kp-numlock", /* VK_NUMLOCK 0x90 */
4752 "scroll", /* VK_SCROLL 0x91 */
4753 /* Not sure where the following block comes from.
4754 Windows headers have NEC and Fujitsu specific keys in
4755 this block, but nothing generic. */
4756 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4757 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4758 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4759 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4760 "kp-end", /* VK_NUMPAD_END 0x96 */
4761 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4762 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4763 "kp-up", /* VK_NUMPAD_UP 0x99 */
4764 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4765 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4766 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4767 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4769 0, 0, /* 0x9E .. 0x9F */
4772 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4773 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4774 * No other API or message will distinguish left and right keys this way.
4779 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4780 to enable them selectively, and gives access to a few more functions.
4781 See lispy_multimedia_keys below. */
4782 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4783 0, 0, 0, /* 0xAD .. 0xAF Volume */
4784 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4785 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4787 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4788 0, 0, 0, 0, 0, 0, 0, 0, 0,
4790 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4791 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4792 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4795 "ax", /* VK_OEM_AX 0xE1 */
4796 0, /* VK_OEM_102 0xE2 */
4797 "ico-help", /* VK_ICO_HELP 0xE3 */
4798 "ico-00", /* VK_ICO_00 0xE4 */
4799 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4800 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4801 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4803 "reset", /* VK_OEM_RESET 0xE9 */
4804 "jump", /* VK_OEM_JUMP 0xEA */
4805 "oem-pa1", /* VK_OEM_PA1 0xEB */
4806 "oem-pa2", /* VK_OEM_PA2 0xEC */
4807 "oem-pa3", /* VK_OEM_PA3 0xED */
4808 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4809 "cusel", /* VK_OEM_CUSEL 0xEF */
4810 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4811 "finish", /* VK_OEM_FINISH 0xF1 */
4812 "copy", /* VK_OEM_COPY 0xF2 */
4813 "auto", /* VK_OEM_AUTO 0xF3 */
4814 "enlw", /* VK_OEM_ENLW 0xF4 */
4815 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4816 "attn", /* VK_ATTN 0xF6 */
4817 "crsel", /* VK_CRSEL 0xF7 */
4818 "exsel", /* VK_EXSEL 0xF8 */
4819 "ereof", /* VK_EREOF 0xF9 */
4820 "play", /* VK_PLAY 0xFA */
4821 "zoom", /* VK_ZOOM 0xFB */
4822 "noname", /* VK_NONAME 0xFC */
4823 "pa1", /* VK_PA1 0xFD */
4824 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4828 /* Some of these duplicate the "Media keys" on newer keyboards,
4829 but they are delivered to the application in a different way. */
4830 static const char *const lispy_multimedia_keys
[] =
4838 "browser-favorites",
4875 "toggle-dictate-command",
4881 "media-fast-forward",
4884 "media-channel-down"
4887 #else /* not HAVE_NTGUI */
4889 /* This should be dealt with in XTread_socket now, and that doesn't
4890 depend on the client system having the Kana syms defined. See also
4891 the XK_kana_A case below. */
4894 static const char *const lispy_kana_keys
[] =
4896 /* X Keysym value */
4897 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4898 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4899 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4900 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4901 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4902 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4903 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4904 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4905 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4906 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4907 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4908 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4909 "kana-i", "kana-u", "kana-e", "kana-o",
4910 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4911 "prolongedsound", "kana-A", "kana-I", "kana-U",
4912 "kana-E", "kana-O", "kana-KA", "kana-KI",
4913 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4914 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4915 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4916 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4917 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4918 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4919 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4920 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4921 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4922 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4923 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4924 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4926 #endif /* XK_kana_A */
4929 #define FUNCTION_KEY_OFFSET 0xff00
4931 /* You'll notice that this table is arranged to be conveniently
4932 indexed by X Windows keysym values. */
4933 static const char *const lispy_function_keys
[] =
4935 /* X Keysym value */
4937 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4938 "backspace", "tab", "linefeed", "clear",
4940 0, 0, 0, "pause", /* 0xff10...1f */
4941 0, 0, 0, 0, 0, 0, 0, "escape",
4943 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4944 "romaji", "hiragana", "katakana", "hiragana-katakana",
4945 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4946 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4947 "eisu-toggle", /* 0xff30...3f */
4948 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4949 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4951 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4952 "down", "prior", "next", "end",
4953 "begin", 0, 0, 0, 0, 0, 0, 0,
4954 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4965 "break", /* 0xff6b */
4968 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4969 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4970 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4971 0, 0, 0, 0, 0, 0, 0, 0,
4972 "kp-tab", /* 0xff89 */
4974 "kp-enter", /* 0xff8d */
4976 "kp-f1", /* 0xff91 */
4980 "kp-home", /* 0xff95 */
4985 "kp-prior", /* kp-page-up */
4986 "kp-next", /* kp-page-down */
4992 0, 0, 0, 0, 0, 0, 0, 0, 0,
4993 "kp-multiply", /* 0xffaa */
4998 "kp-divide", /* 0xffaf */
4999 "kp-0", /* 0xffb0 */
5000 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5003 "kp-equal", /* 0xffbd */
5004 "f1", /* 0xffbe */ /* IsFunctionKey */
5006 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5007 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5008 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5009 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5010 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5011 0, 0, 0, 0, 0, 0, 0, 0,
5012 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5013 0, 0, 0, 0, 0, 0, 0, "delete"
5016 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5017 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5019 static const char *const iso_lispy_function_keys
[] =
5021 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5022 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5023 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5024 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5025 "iso-lefttab", /* 0xfe20 */
5026 "iso-move-line-up", "iso-move-line-down",
5027 "iso-partial-line-up", "iso-partial-line-down",
5028 "iso-partial-space-left", "iso-partial-space-right",
5029 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5030 "iso-release-margin-left", "iso-release-margin-right",
5031 "iso-release-both-margins",
5032 "iso-fast-cursor-left", "iso-fast-cursor-right",
5033 "iso-fast-cursor-up", "iso-fast-cursor-down",
5034 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5035 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5038 #endif /* not HAVE_NTGUI */
5040 static Lisp_Object Vlispy_mouse_stem
;
5042 static const char *const lispy_wheel_names
[] =
5044 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5047 /* drag-n-drop events are generated when a set of selected files are
5048 dragged from another application and dropped onto an Emacs window. */
5049 static const char *const lispy_drag_n_drop_names
[] =
5054 /* An array of symbol indexes of scroll bar parts, indexed by an enum
5055 scroll_bar_part value. Note that Qnil corresponds to
5056 scroll_bar_nowhere and should not appear in Lisp events. */
5057 static short const scroll_bar_parts
[] = {
5058 SYMBOL_INDEX (Qnil
), SYMBOL_INDEX (Qabove_handle
), SYMBOL_INDEX (Qhandle
),
5059 SYMBOL_INDEX (Qbelow_handle
), SYMBOL_INDEX (Qup
), SYMBOL_INDEX (Qdown
),
5060 SYMBOL_INDEX (Qtop
), SYMBOL_INDEX (Qbottom
), SYMBOL_INDEX (Qend_scroll
),
5061 SYMBOL_INDEX (Qratio
), SYMBOL_INDEX (Qbefore_handle
),
5062 SYMBOL_INDEX (Qhorizontal_handle
), SYMBOL_INDEX (Qafter_handle
),
5063 SYMBOL_INDEX (Qleft
), SYMBOL_INDEX (Qright
), SYMBOL_INDEX (Qleftmost
),
5064 SYMBOL_INDEX (Qrightmost
), SYMBOL_INDEX (Qend_scroll
), SYMBOL_INDEX (Qratio
)
5067 /* A vector, indexed by button number, giving the down-going location
5068 of currently depressed buttons, both scroll bar and non-scroll bar.
5070 The elements have the form
5071 (BUTTON-NUMBER MODIFIER-MASK . REST)
5072 where REST is the cdr of a position as it would be reported in the event.
5074 The make_lispy_event function stores positions here to tell the
5075 difference between click and drag events, and to store the starting
5076 location to be included in drag events. */
5078 static Lisp_Object button_down_location
;
5080 /* Information about the most recent up-going button event: Which
5081 button, what location, and what time. */
5083 static int last_mouse_button
;
5084 static int last_mouse_x
;
5085 static int last_mouse_y
;
5086 static Time button_down_time
;
5088 /* The number of clicks in this multiple-click. */
5090 static int double_click_count
;
5092 /* X and Y are frame-relative coordinates for a click or wheel event.
5093 Return a Lisp-style event list. */
5096 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5099 enum window_part part
;
5100 Lisp_Object posn
= Qnil
;
5101 Lisp_Object extra_info
= Qnil
;
5102 /* Coordinate pixel positions to return. */
5103 int xret
= 0, yret
= 0;
5104 /* The window under frame pixel coordinates (x,y) */
5105 Lisp_Object window
= f
5106 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5109 if (WINDOWP (window
))
5111 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5112 struct window
*w
= XWINDOW (window
);
5113 Lisp_Object string_info
= Qnil
;
5114 ptrdiff_t textpos
= 0;
5115 int col
= -1, row
= -1;
5116 int dx
= -1, dy
= -1;
5117 int width
= -1, height
= -1;
5118 Lisp_Object object
= Qnil
;
5120 /* Pixel coordinates relative to the window corner. */
5121 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5122 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5124 /* For text area clicks, return X, Y relative to the corner of
5125 this text area. Note that dX, dY etc are set below, by
5126 buffer_posn_from_coords. */
5127 if (part
== ON_TEXT
)
5129 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5130 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5132 /* For mode line and header line clicks, return X, Y relative to
5133 the left window edge. Use mode_line_string to look for a
5134 string on the click position. */
5135 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5140 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5141 /* Note that mode_line_string takes COL, ROW as pixels and
5142 converts them to characters. */
5145 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5146 &object
, &dx
, &dy
, &width
, &height
);
5147 if (STRINGP (string
))
5148 string_info
= Fcons (string
, make_number (charpos
));
5154 /* For fringes and margins, Y is relative to the area's (and the
5155 window's) top edge, while X is meaningless. */
5156 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5161 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5164 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5165 &object
, &dx
, &dy
, &width
, &height
);
5166 if (STRINGP (string
))
5167 string_info
= Fcons (string
, make_number (charpos
));
5169 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5171 else if (part
== ON_LEFT_FRINGE
)
5173 posn
= Qleft_fringe
;
5177 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5178 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5179 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5181 else if (part
== ON_RIGHT_FRINGE
)
5183 posn
= Qright_fringe
;
5187 - window_box_width (w
, LEFT_MARGIN_AREA
)
5188 - window_box_width (w
, TEXT_AREA
)
5189 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5190 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5192 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5194 else if (part
== ON_VERTICAL_BORDER
)
5196 posn
= Qvertical_line
;
5202 else if (part
== ON_VERTICAL_SCROLL_BAR
)
5204 posn
= Qvertical_scroll_bar
;
5205 width
= WINDOW_SCROLL_BAR_AREA_WIDTH (w
);
5209 else if (part
== ON_HORIZONTAL_SCROLL_BAR
)
5211 posn
= Qhorizontal_scroll_bar
;
5212 width
= WINDOW_SCROLL_BAR_AREA_HEIGHT (w
);
5216 else if (part
== ON_RIGHT_DIVIDER
)
5218 posn
= Qright_divider
;
5219 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5223 else if (part
== ON_BOTTOM_DIVIDER
)
5225 posn
= Qbottom_divider
;
5226 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5231 /* For clicks in the text area, fringes, margins, or vertical
5232 scroll bar, call buffer_posn_from_coords to extract TEXTPOS,
5233 the buffer position nearest to the click. */
5236 Lisp_Object string2
, object2
= Qnil
;
5237 struct display_pos p
;
5239 int width2
, height2
;
5240 /* The pixel X coordinate passed to buffer_posn_from_coords
5241 is the X coordinate relative to the text area for clicks
5242 in text-area, right-margin/fringe and right-side vertical
5243 scroll bar, zero otherwise. */
5245 = (part
== ON_TEXT
) ? xret
5246 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
5247 || (part
== ON_VERTICAL_SCROLL_BAR
5248 && WINDOW_HAS_VERTICAL_SCROLL_BAR_ON_RIGHT (w
)))
5249 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5253 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5254 &object2
, &dx2
, &dy2
,
5256 textpos
= CHARPOS (p
.pos
);
5257 if (col
< 0) col
= x2
;
5258 if (row
< 0) row
= y2
;
5259 if (dx
< 0) dx
= dx2
;
5260 if (dy
< 0) dy
= dy2
;
5261 if (width
< 0) width
= width2
;
5262 if (height
< 0) height
= height2
;
5266 posn
= make_number (textpos
);
5267 if (STRINGP (string2
))
5268 string_info
= Fcons (string2
,
5269 make_number (CHARPOS (p
.string_pos
)));
5275 #ifdef HAVE_WINDOW_SYSTEM
5276 if (IMAGEP (object
))
5278 Lisp_Object image_map
, hotspot
;
5279 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5281 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5283 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5284 posn
= XCAR (hotspot
);
5291 Fcons (make_number (dx
), make_number (dy
)),
5292 Fcons (make_number (width
), make_number (height
)));
5295 extra_info
= Fcons (string_info
,
5296 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5297 Fcons (Fcons (make_number (col
),
5303 /* Return mouse pixel coordinates here. */
5304 XSETFRAME (window
, f
);
5311 return Fcons (window
,
5313 Fcons (Fcons (make_number (xret
),
5314 make_number (yret
)),
5315 Fcons (make_number (t
),
5319 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5320 menu bar. This really means that Emacs draws and manages the menu
5321 bar as part of its normal display, and therefore can compute its
5324 toolkit_menubar_in_use (struct frame
*f
)
5326 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5327 return !(!FRAME_WINDOW_P (f
));
5333 /* Build the part of Lisp event which represents scroll bar state from
5334 EV. TYPE is one of Qvertical_scroll_bar or Qhorizontal_scroll_bar. */
5337 make_scroll_bar_position (struct input_event
*ev
, Lisp_Object type
)
5339 return list5 (ev
->frame_or_window
, type
, Fcons (ev
->x
, ev
->y
),
5340 make_number (ev
->timestamp
),
5341 builtin_lisp_symbol (scroll_bar_parts
[ev
->part
]));
5344 /* Given a struct input_event, build the lisp event which represents
5345 it. If EVENT is 0, build a mouse movement event from the mouse
5346 movement buffer, which should have a movement event in it.
5348 Note that events must be passed to this function in the order they
5349 are received; this function stores the location of button presses
5350 in order to build drag events when the button is released. */
5353 make_lispy_event (struct input_event
*event
)
5357 switch (event
->kind
)
5359 /* A simple keystroke. */
5360 case ASCII_KEYSTROKE_EVENT
:
5361 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5363 Lisp_Object lispy_c
;
5364 EMACS_INT c
= event
->code
;
5365 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5368 eassert (c
== event
->code
);
5369 /* Turn ASCII characters into control characters
5371 if (event
->modifiers
& ctrl_modifier
)
5373 c
= make_ctrl_char (c
);
5374 event
->modifiers
&= ~ctrl_modifier
;
5378 /* Add in the other modifier bits. The shift key was taken care
5379 of by the X code. */
5380 c
|= (event
->modifiers
5381 & (meta_modifier
| alt_modifier
5382 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5383 /* Distinguish Shift-SPC from SPC. */
5384 if ((event
->code
) == 040
5385 && event
->modifiers
& shift_modifier
)
5386 c
|= shift_modifier
;
5387 button_down_time
= 0;
5388 XSETFASTINT (lispy_c
, c
);
5393 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5394 except that they are non-key events (last-nonmenu-event is nil). */
5395 case NS_NONKEY_EVENT
:
5398 /* A function key. The symbol may need to have modifier prefixes
5400 case NON_ASCII_KEYSTROKE_EVENT
:
5401 button_down_time
= 0;
5403 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5404 if (event
->code
== lispy_accent_codes
[i
])
5405 return modify_event_symbol (i
,
5407 Qfunction_key
, Qnil
,
5408 lispy_accent_keys
, &accent_key_syms
,
5409 ARRAYELTS (lispy_accent_keys
));
5413 if (event
->code
>= 0x400 && event
->code
< 0x500)
5414 return modify_event_symbol (event
->code
- 0x400,
5415 event
->modifiers
& ~shift_modifier
,
5416 Qfunction_key
, Qnil
,
5417 lispy_kana_keys
, &func_key_syms
,
5418 ARRAYELTS (lispy_kana_keys
));
5419 #endif /* XK_kana_A */
5422 #ifdef ISO_FUNCTION_KEY_OFFSET
5423 if (event
->code
< FUNCTION_KEY_OFFSET
5424 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5425 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5427 Qfunction_key
, Qnil
,
5428 iso_lispy_function_keys
, &func_key_syms
,
5429 ARRAYELTS (iso_lispy_function_keys
));
5432 if ((FUNCTION_KEY_OFFSET
<= event
->code
5434 < FUNCTION_KEY_OFFSET
+ ARRAYELTS (lispy_function_keys
)))
5435 && lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5436 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5438 Qfunction_key
, Qnil
,
5439 lispy_function_keys
, &func_key_syms
,
5440 ARRAYELTS (lispy_function_keys
));
5442 /* Handle system-specific or unknown keysyms.
5443 We need to use an alist rather than a vector as the cache
5444 since we can't make a vector long enough. */
5445 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5446 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5447 return modify_event_symbol (event
->code
,
5450 KVAR (current_kboard
, Vsystem_key_alist
),
5451 0, &KVAR (current_kboard
, system_key_syms
),
5455 case MULTIMEDIA_KEY_EVENT
:
5456 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5457 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5459 return modify_event_symbol (event
->code
, event
->modifiers
,
5460 Qfunction_key
, Qnil
,
5461 lispy_multimedia_keys
, &func_key_syms
,
5462 ARRAYELTS (lispy_multimedia_keys
));
5467 /* A mouse click. Figure out where it is, decide whether it's
5468 a press, click or drag, and build the appropriate structure. */
5469 case MOUSE_CLICK_EVENT
:
5471 case GPM_CLICK_EVENT
:
5473 #ifndef USE_TOOLKIT_SCROLL_BARS
5474 case SCROLL_BAR_CLICK_EVENT
:
5475 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5478 int button
= event
->code
;
5480 Lisp_Object position
;
5481 Lisp_Object
*start_pos_ptr
;
5482 Lisp_Object start_pos
;
5486 /* Build the position as appropriate for this mouse click. */
5487 if (event
->kind
== MOUSE_CLICK_EVENT
5489 || event
->kind
== GPM_CLICK_EVENT
5493 struct frame
*f
= XFRAME (event
->frame_or_window
);
5496 /* Ignore mouse events that were made on frame that
5497 have been deleted. */
5498 if (! FRAME_LIVE_P (f
))
5501 /* EVENT->x and EVENT->y are frame-relative pixel
5502 coordinates at this place. Under old redisplay, COLUMN
5503 and ROW are set to frame relative glyph coordinates
5504 which are then used to determine whether this click is
5505 in a menu (non-toolkit version). */
5506 if (!toolkit_menubar_in_use (f
))
5508 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5509 &column
, &row
, NULL
, 1);
5511 /* In the non-toolkit version, clicks on the menu bar
5512 are ordinary button events in the event buffer.
5513 Distinguish them, and invoke the menu.
5515 (In the toolkit version, the toolkit handles the
5516 menu bar and Emacs doesn't know about it until
5517 after the user makes a selection.) */
5518 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5519 && (event
->modifiers
& down_modifier
))
5521 Lisp_Object items
, item
;
5523 /* Find the menu bar item under `column'. */
5525 items
= FRAME_MENU_BAR_ITEMS (f
);
5526 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5528 Lisp_Object pos
, string
;
5529 string
= AREF (items
, i
+ 1);
5530 pos
= AREF (items
, i
+ 3);
5533 if (column
>= XINT (pos
)
5534 && column
< XINT (pos
) + SCHARS (string
))
5536 item
= AREF (items
, i
);
5541 /* ELisp manual 2.4b says (x y) are window
5542 relative but code says they are
5544 position
= list4 (event
->frame_or_window
,
5546 Fcons (event
->x
, event
->y
),
5547 make_number (event
->timestamp
));
5549 return list2 (item
, position
);
5553 position
= make_lispy_position (f
, event
->x
, event
->y
,
5556 #ifndef USE_TOOLKIT_SCROLL_BARS
5558 /* It's a scrollbar click. */
5559 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5560 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5562 if (button
>= ASIZE (button_down_location
))
5564 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5565 button_down_location
= larger_vector (button_down_location
,
5567 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5570 start_pos_ptr
= aref_addr (button_down_location
, button
);
5571 start_pos
= *start_pos_ptr
;
5572 *start_pos_ptr
= Qnil
;
5575 /* On window-system frames, use the value of
5576 double-click-fuzz as is. On other frames, interpret it
5577 as a multiple of 1/8 characters. */
5581 if (WINDOWP (event
->frame_or_window
))
5582 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5583 else if (FRAMEP (event
->frame_or_window
))
5584 f
= XFRAME (event
->frame_or_window
);
5588 if (FRAME_WINDOW_P (f
))
5589 fuzz
= double_click_fuzz
;
5591 fuzz
= double_click_fuzz
/ 8;
5593 is_double
= (button
== last_mouse_button
5594 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5595 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5596 && button_down_time
!= 0
5597 && (EQ (Vdouble_click_time
, Qt
)
5598 || (NATNUMP (Vdouble_click_time
)
5599 && (event
->timestamp
- button_down_time
5600 < XFASTINT (Vdouble_click_time
)))));
5603 last_mouse_button
= button
;
5604 last_mouse_x
= XINT (event
->x
);
5605 last_mouse_y
= XINT (event
->y
);
5607 /* If this is a button press, squirrel away the location, so
5608 we can decide later whether it was a click or a drag. */
5609 if (event
->modifiers
& down_modifier
)
5613 double_click_count
++;
5614 event
->modifiers
|= ((double_click_count
> 2)
5619 double_click_count
= 1;
5620 button_down_time
= event
->timestamp
;
5621 *start_pos_ptr
= Fcopy_alist (position
);
5622 ignore_mouse_drag_p
= 0;
5625 /* Now we're releasing a button - check the co-ordinates to
5626 see if this was a click or a drag. */
5627 else if (event
->modifiers
& up_modifier
)
5629 /* If we did not see a down before this up, ignore the up.
5630 Probably this happened because the down event chose a
5631 menu item. It would be an annoyance to treat the
5632 release of the button that chose the menu item as a
5635 if (!CONSP (start_pos
))
5638 event
->modifiers
&= ~up_modifier
;
5641 Lisp_Object new_down
, down
;
5642 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5644 /* The third element of every position
5645 should be the (x,y) pair. */
5646 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5647 new_down
= Fcar (Fcdr (Fcdr (position
)));
5650 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5652 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5653 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5656 if (ignore_mouse_drag_p
)
5658 event
->modifiers
|= click_modifier
;
5659 ignore_mouse_drag_p
= 0;
5661 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5662 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5663 /* Maybe the mouse has moved a lot, caused scrolling, and
5664 eventually ended up at the same screen position (but
5665 not buffer position) in which case it is a drag, not
5667 /* FIXME: OTOH if the buffer position has changed
5668 because of a timer or process filter rather than
5669 because of mouse movement, it should be considered as
5670 a click. But mouse-drag-region completely ignores
5671 this case and it hasn't caused any real problem, so
5672 it's probably OK to ignore it as well. */
5673 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5674 /* Mouse hasn't moved (much). */
5675 event
->modifiers
|= click_modifier
;
5678 button_down_time
= 0;
5679 event
->modifiers
|= drag_modifier
;
5682 /* Don't check is_double; treat this as multiple
5683 if the down-event was multiple. */
5684 if (double_click_count
> 1)
5685 event
->modifiers
|= ((double_click_count
> 2)
5691 /* Every mouse event should either have the down_modifier or
5692 the up_modifier set. */
5696 /* Get the symbol we should use for the mouse click. */
5699 head
= modify_event_symbol (button
,
5701 Qmouse_click
, Vlispy_mouse_stem
,
5704 ASIZE (mouse_syms
));
5705 if (event
->modifiers
& drag_modifier
)
5706 return list3 (head
, start_pos
, position
);
5707 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5708 return list3 (head
, position
, make_number (double_click_count
));
5710 return list2 (head
, position
);
5715 case HORIZ_WHEEL_EVENT
:
5717 Lisp_Object position
;
5720 /* Build the position as appropriate for this mouse click. */
5721 struct frame
*f
= XFRAME (event
->frame_or_window
);
5723 /* Ignore wheel events that were made on frame that have been
5725 if (! FRAME_LIVE_P (f
))
5728 position
= make_lispy_position (f
, event
->x
, event
->y
,
5731 /* Set double or triple modifiers to indicate the wheel speed. */
5733 /* On window-system frames, use the value of
5734 double-click-fuzz as is. On other frames, interpret it
5735 as a multiple of 1/8 characters. */
5741 if (WINDOWP (event
->frame_or_window
))
5742 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5743 else if (FRAMEP (event
->frame_or_window
))
5744 fr
= XFRAME (event
->frame_or_window
);
5748 fuzz
= FRAME_WINDOW_P (fr
)
5749 ? double_click_fuzz
: double_click_fuzz
/ 8;
5751 if (event
->modifiers
& up_modifier
)
5753 /* Emit a wheel-up event. */
5754 event
->modifiers
&= ~up_modifier
;
5757 else if (event
->modifiers
& down_modifier
)
5759 /* Emit a wheel-down event. */
5760 event
->modifiers
&= ~down_modifier
;
5764 /* Every wheel event should either have the down_modifier or
5765 the up_modifier set. */
5768 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5771 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5772 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5773 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5774 && button_down_time
!= 0
5775 && (EQ (Vdouble_click_time
, Qt
)
5776 || (NATNUMP (Vdouble_click_time
)
5777 && (event
->timestamp
- button_down_time
5778 < XFASTINT (Vdouble_click_time
)))));
5781 double_click_count
++;
5782 event
->modifiers
|= ((double_click_count
> 2)
5788 double_click_count
= 1;
5789 event
->modifiers
|= click_modifier
;
5792 button_down_time
= event
->timestamp
;
5793 /* Use a negative value to distinguish wheel from mouse button. */
5794 last_mouse_button
= - (1 + symbol_num
);
5795 last_mouse_x
= XINT (event
->x
);
5796 last_mouse_y
= XINT (event
->y
);
5798 /* Get the symbol we should use for the wheel event. */
5799 head
= modify_event_symbol (symbol_num
,
5805 ASIZE (wheel_syms
));
5808 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5809 return list3 (head
, position
, make_number (double_click_count
));
5811 return list2 (head
, position
);
5815 #ifdef USE_TOOLKIT_SCROLL_BARS
5817 /* We don't have down and up events if using toolkit scroll bars,
5818 so make this always a click event. Store in the `part' of
5819 the Lisp event a symbol which maps to the following actions:
5821 `above_handle' page up
5822 `below_handle' page down
5826 `bottom' bottom of buffer
5827 `handle' thumb has been dragged.
5828 `end-scroll' end of interaction with scroll bar
5830 The incoming input_event contains in its `part' member an
5831 index of type `enum scroll_bar_part' which we can use as an
5832 index in scroll_bar_parts to get the appropriate symbol. */
5834 case SCROLL_BAR_CLICK_EVENT
:
5836 Lisp_Object position
, head
;
5838 position
= make_scroll_bar_position (event
, Qvertical_scroll_bar
);
5840 /* Always treat scroll bar events as clicks. */
5841 event
->modifiers
|= click_modifier
;
5842 event
->modifiers
&= ~up_modifier
;
5844 if (event
->code
>= ASIZE (mouse_syms
))
5845 mouse_syms
= larger_vector (mouse_syms
,
5846 event
->code
- ASIZE (mouse_syms
) + 1,
5849 /* Get the symbol we should use for the mouse click. */
5850 head
= modify_event_symbol (event
->code
,
5855 ASIZE (mouse_syms
));
5856 return list2 (head
, position
);
5859 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5861 Lisp_Object position
, head
;
5863 position
= make_scroll_bar_position (event
, Qhorizontal_scroll_bar
);
5865 /* Always treat scroll bar events as clicks. */
5866 event
->modifiers
|= click_modifier
;
5867 event
->modifiers
&= ~up_modifier
;
5869 if (event
->code
>= ASIZE (mouse_syms
))
5870 mouse_syms
= larger_vector (mouse_syms
,
5871 event
->code
- ASIZE (mouse_syms
) + 1,
5874 /* Get the symbol we should use for the mouse click. */
5875 head
= modify_event_symbol (event
->code
,
5880 ASIZE (mouse_syms
));
5881 return list2 (head
, position
);
5884 #endif /* USE_TOOLKIT_SCROLL_BARS */
5886 case DRAG_N_DROP_EVENT
:
5889 Lisp_Object head
, position
;
5892 f
= XFRAME (event
->frame_or_window
);
5895 /* Ignore mouse events that were made on frames that
5896 have been deleted. */
5897 if (! FRAME_LIVE_P (f
))
5900 position
= make_lispy_position (f
, event
->x
, event
->y
,
5903 head
= modify_event_symbol (0, event
->modifiers
,
5905 lispy_drag_n_drop_names
,
5906 &drag_n_drop_syms
, 1);
5907 return list3 (head
, position
, files
);
5910 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5911 || defined (HAVE_NS) || defined (USE_GTK)
5912 case MENU_BAR_EVENT
:
5913 if (EQ (event
->arg
, event
->frame_or_window
))
5914 /* This is the prefix key. We translate this to
5915 `(menu_bar)' because the code in keyboard.c for menu
5916 events, which we use, relies on this. */
5917 return list1 (Qmenu_bar
);
5921 case SELECT_WINDOW_EVENT
:
5922 /* Make an event (select-window (WINDOW)). */
5923 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5925 case TOOL_BAR_EVENT
:
5926 if (EQ (event
->arg
, event
->frame_or_window
))
5927 /* This is the prefix key. We translate this to
5928 `(tool_bar)' because the code in keyboard.c for tool bar
5929 events, which we use, relies on this. */
5930 return list1 (Qtool_bar
);
5931 else if (SYMBOLP (event
->arg
))
5932 return apply_modifiers (event
->modifiers
, event
->arg
);
5935 case USER_SIGNAL_EVENT
:
5936 /* A user signal. */
5938 char *name
= find_user_signal_name (event
->code
);
5941 return intern (name
);
5944 case SAVE_SESSION_EVENT
:
5945 return Qsave_session
;
5950 return Fcons (Qdbus_event
, event
->arg
);
5952 #endif /* HAVE_DBUS */
5954 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
5955 case FILE_NOTIFY_EVENT
:
5957 return Fcons (Qfile_notify
, event
->arg
);
5959 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
5961 case CONFIG_CHANGED_EVENT
:
5962 return list3 (Qconfig_changed_event
,
5963 event
->arg
, event
->frame_or_window
);
5965 /* The 'kind' field of the event is something we don't recognize. */
5972 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5973 Lisp_Object x
, Lisp_Object y
, Time t
)
5975 /* Is it a scroll bar movement? */
5976 if (frame
&& ! NILP (bar_window
))
5978 Lisp_Object part_sym
;
5980 part_sym
= builtin_lisp_symbol (scroll_bar_parts
[part
]);
5981 return list2 (Qscroll_bar_movement
,
5983 Qvertical_scroll_bar
,
5988 /* Or is it an ordinary mouse movement? */
5991 Lisp_Object position
;
5992 position
= make_lispy_position (frame
, x
, y
, t
);
5993 return list2 (Qmouse_movement
, position
);
5997 /* Construct a switch frame event. */
5999 make_lispy_switch_frame (Lisp_Object frame
)
6001 return list2 (Qswitch_frame
, frame
);
6005 make_lispy_focus_in (Lisp_Object frame
)
6007 return list2 (Qfocus_in
, frame
);
6010 #ifdef HAVE_WINDOW_SYSTEM
6013 make_lispy_focus_out (Lisp_Object frame
)
6015 return list2 (Qfocus_out
, frame
);
6018 #endif /* HAVE_WINDOW_SYSTEM */
6020 /* Manipulating modifiers. */
6022 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6024 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6025 SYMBOL's name of the end of the modifiers; the string from this
6026 position is the unmodified symbol name.
6028 This doesn't use any caches. */
6031 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6037 CHECK_SYMBOL (symbol
);
6040 name
= SYMBOL_NAME (symbol
);
6042 for (i
= 0; i
< SBYTES (name
) - 1; )
6044 ptrdiff_t this_mod_end
= 0;
6047 /* See if the name continues with a modifier word.
6048 Check that the word appears, but don't check what follows it.
6049 Set this_mod and this_mod_end to record what we find. */
6051 switch (SREF (name
, i
))
6053 #define SINGLE_LETTER_MOD(BIT) \
6054 (this_mod_end = i + 1, this_mod = BIT)
6057 SINGLE_LETTER_MOD (alt_modifier
);
6061 SINGLE_LETTER_MOD (ctrl_modifier
);
6065 SINGLE_LETTER_MOD (hyper_modifier
);
6069 SINGLE_LETTER_MOD (meta_modifier
);
6073 SINGLE_LETTER_MOD (shift_modifier
);
6077 SINGLE_LETTER_MOD (super_modifier
);
6080 #undef SINGLE_LETTER_MOD
6082 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6083 if (i + LEN + 1 <= SBYTES (name) \
6084 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6086 this_mod_end = i + LEN; \
6091 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6092 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6093 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6097 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6101 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6103 #undef MULTI_LETTER_MOD
6107 /* If we found no modifier, stop looking for them. */
6108 if (this_mod_end
== 0)
6111 /* Check there is a dash after the modifier, so that it
6112 really is a modifier. */
6113 if (this_mod_end
>= SBYTES (name
)
6114 || SREF (name
, this_mod_end
) != '-')
6117 /* This modifier is real; look for another. */
6118 modifiers
|= this_mod
;
6119 i
= this_mod_end
+ 1;
6122 /* Should we include the `click' modifier? */
6123 if (! (modifiers
& (down_modifier
| drag_modifier
6124 | double_modifier
| triple_modifier
))
6125 && i
+ 7 == SBYTES (name
)
6126 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6127 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6128 modifiers
|= click_modifier
;
6130 if (! (modifiers
& (double_modifier
| triple_modifier
))
6131 && i
+ 6 < SBYTES (name
)
6132 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6133 modifiers
|= click_modifier
;
6141 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6142 prepended to the string BASE[0..BASE_LEN-1].
6143 This doesn't use any caches. */
6145 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6147 /* Since BASE could contain nulls, we can't use intern here; we have
6148 to use Fintern, which expects a genuine Lisp_String, and keeps a
6150 char new_mods
[sizeof "A-C-H-M-S-s-up-down-drag-double-triple-"];
6156 /* Mouse events should not exhibit the `up' modifier once they
6157 leave the event queue only accessible to C code; `up' will
6158 always be turned into a click or drag event before being
6159 presented to lisp code. But since lisp events can be
6160 synthesized bypassing the event queue and pushed into
6161 `unread-command-events' or its companions, it's better to just
6162 deal with unexpected modifier combinations. */
6164 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6165 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6166 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6167 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6168 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6169 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6170 if (modifiers
& double_modifier
) p
= stpcpy (p
, "double-");
6171 if (modifiers
& triple_modifier
) p
= stpcpy (p
, "triple-");
6172 if (modifiers
& up_modifier
) p
= stpcpy (p
, "up-");
6173 if (modifiers
& down_modifier
) p
= stpcpy (p
, "down-");
6174 if (modifiers
& drag_modifier
) p
= stpcpy (p
, "drag-");
6175 /* The click modifier is denoted by the absence of other modifiers. */
6179 mod_len
= p
- new_mods
;
6183 Lisp_Object new_name
;
6185 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6186 mod_len
+ base_len_byte
);
6187 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6188 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6190 return Fintern (new_name
, Qnil
);
6195 static const char *const modifier_names
[] =
6197 "up", "down", "drag", "click", "double", "triple", 0, 0,
6198 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6199 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6201 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6203 static Lisp_Object modifier_symbols
;
6205 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6207 lispy_modifier_list (int modifiers
)
6209 Lisp_Object modifier_list
;
6212 modifier_list
= Qnil
;
6213 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6214 if (modifiers
& (1<<i
))
6215 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6218 return modifier_list
;
6222 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6223 where UNMODIFIED is the unmodified form of SYMBOL,
6224 MASK is the set of modifiers present in SYMBOL's name.
6225 This is similar to parse_modifiers_uncached, but uses the cache in
6226 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6227 Qevent_symbol_elements property. */
6229 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6232 parse_modifiers (Lisp_Object symbol
)
6234 Lisp_Object elements
;
6236 if (INTEGERP (symbol
))
6237 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6238 else if (!SYMBOLP (symbol
))
6241 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6242 if (CONSP (elements
))
6247 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6248 Lisp_Object unmodified
;
6251 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6252 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6255 if (modifiers
& ~INTMASK
)
6257 XSETFASTINT (mask
, modifiers
);
6258 elements
= list2 (unmodified
, mask
);
6260 /* Cache the parsing results on SYMBOL. */
6261 Fput (symbol
, Qevent_symbol_element_mask
,
6263 Fput (symbol
, Qevent_symbol_elements
,
6264 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6266 /* Since we know that SYMBOL is modifiers applied to unmodified,
6267 it would be nice to put that in unmodified's cache.
6268 But we can't, since we're not sure that parse_modifiers is
6275 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6276 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6277 doc
: /* Parse the event symbol. For internal use. */)
6278 (Lisp_Object symbol
)
6280 /* Fill the cache if needed. */
6281 parse_modifiers (symbol
);
6282 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6283 and use the Lispier representation stored on Qevent_symbol_elements
6285 return Fget (symbol
, Qevent_symbol_elements
);
6288 /* Apply the modifiers MODIFIERS to the symbol BASE.
6289 BASE must be unmodified.
6291 This is like apply_modifiers_uncached, but uses BASE's
6292 Qmodifier_cache property, if present.
6294 apply_modifiers copies the value of BASE's Qevent_kind property to
6295 the modified symbol. */
6297 apply_modifiers (int modifiers
, Lisp_Object base
)
6299 Lisp_Object cache
, idx
, entry
, new_symbol
;
6301 /* Mask out upper bits. We don't know where this value's been. */
6302 modifiers
&= INTMASK
;
6304 if (INTEGERP (base
))
6305 return make_number (XINT (base
) | modifiers
);
6307 /* The click modifier never figures into cache indices. */
6308 cache
= Fget (base
, Qmodifier_cache
);
6309 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6310 entry
= assq_no_quit (idx
, cache
);
6313 new_symbol
= XCDR (entry
);
6316 /* We have to create the symbol ourselves. */
6317 new_symbol
= apply_modifiers_uncached (modifiers
,
6318 SSDATA (SYMBOL_NAME (base
)),
6319 SCHARS (SYMBOL_NAME (base
)),
6320 SBYTES (SYMBOL_NAME (base
)));
6322 /* Add the new symbol to the base's cache. */
6323 entry
= Fcons (idx
, new_symbol
);
6324 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6326 /* We have the parsing info now for free, so we could add it to
6328 XSETFASTINT (idx, modifiers);
6329 Fput (new_symbol, Qevent_symbol_element_mask,
6331 Fput (new_symbol, Qevent_symbol_elements,
6332 Fcons (base, lispy_modifier_list (modifiers)));
6333 Sadly, this is only correct if `base' is indeed a base event,
6334 which is not necessarily the case. -stef */
6337 /* Make sure this symbol is of the same kind as BASE.
6339 You'd think we could just set this once and for all when we
6340 intern the symbol above, but reorder_modifiers may call us when
6341 BASE's property isn't set right; we can't assume that just
6342 because it has a Qmodifier_cache property it must have its
6343 Qevent_kind set right as well. */
6344 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6348 kind
= Fget (base
, Qevent_kind
);
6350 Fput (new_symbol
, Qevent_kind
, kind
);
6357 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6358 return a symbol with the modifiers placed in the canonical order.
6359 Canonical order is alphabetical, except for down and drag, which
6360 always come last. The 'click' modifier is never written out.
6362 Fdefine_key calls this to make sure that (for example) C-M-foo
6363 and M-C-foo end up being equivalent in the keymap. */
6366 reorder_modifiers (Lisp_Object symbol
)
6368 /* It's hopefully okay to write the code this way, since everything
6369 will soon be in caches, and no consing will be done at all. */
6372 parsed
= parse_modifiers (symbol
);
6373 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6378 /* For handling events, we often want to produce a symbol whose name
6379 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6380 to some base, like the name of a function key or mouse button.
6381 modify_event_symbol produces symbols of this sort.
6383 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6384 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6387 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6388 into symbol names, or a string specifying a name stem used to
6389 construct a symbol name or the form `STEM-N', where N is the decimal
6390 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6391 non-nil; otherwise NAME_TABLE is used.
6393 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6394 persist between calls to modify_event_symbol that it can use to
6395 store a cache of the symbols it's generated for this NAME_TABLE
6396 before. The object stored there may be a vector or an alist.
6398 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6400 MODIFIERS is a set of modifier bits (as given in struct input_events)
6401 whose prefixes should be applied to the symbol name.
6403 SYMBOL_KIND is the value to be placed in the event_kind property of
6404 the returned symbol.
6406 The symbols we create are supposed to have an
6407 `event-symbol-elements' property, which lists the modifiers present
6408 in the symbol's name. */
6411 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6412 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6413 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6416 Lisp_Object symbol_int
;
6418 /* Get rid of the "vendor-specific" bit here. */
6419 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6421 /* Is this a request for a valid symbol? */
6422 if (symbol_num
< 0 || symbol_num
>= table_size
)
6425 if (CONSP (*symbol_table
))
6426 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6428 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6429 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6430 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6431 we've never used that symbol before. */
6434 if (! VECTORP (*symbol_table
)
6435 || ASIZE (*symbol_table
) != table_size
)
6439 XSETFASTINT (size
, table_size
);
6440 *symbol_table
= Fmake_vector (size
, Qnil
);
6443 value
= AREF (*symbol_table
, symbol_num
);
6446 /* Have we already used this symbol before? */
6449 /* No; let's create it. */
6450 if (CONSP (name_alist_or_stem
))
6451 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6452 else if (STRINGP (name_alist_or_stem
))
6455 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6456 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6458 buf
= SAFE_ALLOCA (len
);
6459 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6460 XINT (symbol_int
) + 1);
6461 value
= intern (buf
);
6464 else if (name_table
!= 0 && name_table
[symbol_num
])
6465 value
= intern (name_table
[symbol_num
]);
6467 #ifdef HAVE_WINDOW_SYSTEM
6470 char *name
= x_get_keysym_name (symbol_num
);
6472 value
= intern (name
);
6478 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6479 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6480 value
= intern (buf
);
6483 if (CONSP (*symbol_table
))
6484 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6486 ASET (*symbol_table
, symbol_num
, value
);
6488 /* Fill in the cache entries for this symbol; this also
6489 builds the Qevent_symbol_elements property, which the user
6491 apply_modifiers (modifiers
& click_modifier
, value
);
6492 Fput (value
, Qevent_kind
, symbol_kind
);
6495 /* Apply modifiers to that symbol. */
6496 return apply_modifiers (modifiers
, value
);
6499 /* Convert a list that represents an event type,
6500 such as (ctrl meta backspace), into the usual representation of that
6501 event type as a number or a symbol. */
6503 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6504 doc
: /* Convert the event description list EVENT-DESC to an event type.
6505 EVENT-DESC should contain one base event type (a character or symbol)
6506 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6507 drag, down, double or triple). The base must be last.
6508 The return value is an event type (a character or symbol) which
6509 has the same base event type and all the specified modifiers. */)
6510 (Lisp_Object event_desc
)
6518 while (CONSP (rest
))
6526 /* Given a symbol, see if it is a modifier name. */
6527 if (SYMBOLP (elt
) && CONSP (rest
))
6528 this = parse_solitary_modifier (elt
);
6532 else if (!NILP (base
))
6533 error ("Two bases given in one event");
6539 /* Let the symbol A refer to the character A. */
6540 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6541 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6543 if (INTEGERP (base
))
6545 /* Turn (shift a) into A. */
6546 if ((modifiers
& shift_modifier
) != 0
6547 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6549 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6550 modifiers
&= ~shift_modifier
;
6553 /* Turn (control a) into C-a. */
6554 if (modifiers
& ctrl_modifier
)
6555 return make_number ((modifiers
& ~ctrl_modifier
)
6556 | make_ctrl_char (XINT (base
)));
6558 return make_number (modifiers
| XINT (base
));
6560 else if (SYMBOLP (base
))
6561 return apply_modifiers (modifiers
, base
);
6563 error ("Invalid base event");
6566 /* Try to recognize SYMBOL as a modifier name.
6567 Return the modifier flag bit, or 0 if not recognized. */
6570 parse_solitary_modifier (Lisp_Object symbol
)
6572 Lisp_Object name
= SYMBOL_NAME (symbol
);
6574 switch (SREF (name
, 0))
6576 #define SINGLE_LETTER_MOD(BIT) \
6577 if (SBYTES (name) == 1) \
6580 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6581 if (LEN == SBYTES (name) \
6582 && ! memcmp (SDATA (name), NAME, LEN)) \
6586 SINGLE_LETTER_MOD (alt_modifier
);
6590 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6594 SINGLE_LETTER_MOD (ctrl_modifier
);
6598 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6599 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6603 SINGLE_LETTER_MOD (hyper_modifier
);
6607 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6611 SINGLE_LETTER_MOD (meta_modifier
);
6615 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6619 SINGLE_LETTER_MOD (shift_modifier
);
6623 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6624 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6625 SINGLE_LETTER_MOD (super_modifier
);
6629 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6630 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6631 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6635 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6639 MULTI_LETTER_MOD (up_modifier
, "up", 2);
6642 #undef SINGLE_LETTER_MOD
6643 #undef MULTI_LETTER_MOD
6649 /* Return true if EVENT is a list whose elements are all integers or symbols.
6650 Such a list is not valid as an event,
6651 but it can be a Lucid-style event type list. */
6654 lucid_event_type_list_p (Lisp_Object object
)
6658 if (! CONSP (object
))
6661 if (EQ (XCAR (object
), Qhelp_echo
)
6662 || EQ (XCAR (object
), Qvertical_line
)
6663 || EQ (XCAR (object
), Qmode_line
)
6664 || EQ (XCAR (object
), Qheader_line
))
6667 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6671 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6678 /* Return true if terminal input chars are available.
6679 Also, store the return value into INPUT_PENDING.
6681 Serves the purpose of ioctl (0, FIONREAD, ...)
6682 but works even if FIONREAD does not exist.
6683 (In fact, this may actually read some input.)
6685 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6686 timer events that are ripe.
6687 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6688 events (FOCUS_IN_EVENT).
6689 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6690 movements and toolkit scroll bar thumb drags. */
6693 get_input_pending (int flags
)
6695 /* First of all, have we already counted some input? */
6696 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6698 /* If input is being read as it arrives, and we have none, there is none. */
6699 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6701 /* Try to read some input and see how much we get. */
6703 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6706 return input_pending
;
6709 /* Put a BUFFER_SWITCH_EVENT in the buffer
6710 so that read_key_sequence will notice the new current buffer. */
6713 record_asynch_buffer_change (void)
6715 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6716 The purpose of the event is to make read_key_sequence look up the
6717 keymaps again. If we aren't in read_key_sequence, we don't need one,
6718 and the event could cause trouble by messing up (input-pending-p).
6719 Note: Fwaiting_for_user_input_p always returns nil when async
6720 subprocesses aren't supported. */
6721 if (!NILP (Fwaiting_for_user_input_p ()))
6723 struct input_event event
;
6726 event
.kind
= BUFFER_SWITCH_EVENT
;
6727 event
.frame_or_window
= Qnil
;
6730 /* Make sure no interrupt happens while storing the event. */
6732 if (interrupt_input
)
6733 kbd_buffer_store_event (&event
);
6738 kbd_buffer_store_event (&event
);
6744 /* Read any terminal input already buffered up by the system
6745 into the kbd_buffer, but do not wait.
6747 Return the number of keyboard chars read, or -1 meaning
6748 this is a bad time to try to read input. */
6757 /* Store pending user signal events, if any. */
6758 store_user_signal_events ();
6760 /* Loop through the available terminals, and call their input hooks. */
6764 struct terminal
*next
= t
->next_terminal
;
6766 if (t
->read_socket_hook
)
6769 struct input_event hold_quit
;
6771 if (input_blocked_p ())
6773 pending_signals
= true;
6777 EVENT_INIT (hold_quit
);
6778 hold_quit
.kind
= NO_EVENT
;
6780 /* No need for FIONREAD or fcntl; just say don't wait. */
6781 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6784 if (nr
== -1) /* Not OK to read input now. */
6788 else if (nr
== -2) /* Non-transient error. */
6790 /* The terminal device terminated; it should be closed. */
6792 /* Kill Emacs if this was our last terminal. */
6793 if (!terminal_list
->next_terminal
)
6794 /* Formerly simply reported no input, but that
6795 sometimes led to a failure of Emacs to terminate.
6796 SIGHUP seems appropriate if we can't reach the
6798 /* ??? Is it really right to send the signal just to
6799 this process rather than to the whole process
6800 group? Perhaps on systems with FIONREAD Emacs is
6801 alone in its group. */
6802 terminate_due_to_signal (SIGHUP
, 10);
6804 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6807 XSETTERMINAL (tmp
, t
);
6808 Fdelete_terminal (tmp
, Qnoelisp
);
6812 /* If there was no error, make sure the pointer
6813 is visible for all frames on this terminal. */
6816 Lisp_Object tail
, frame
;
6818 FOR_EACH_FRAME (tail
, frame
)
6820 struct frame
*f
= XFRAME (frame
);
6821 if (FRAME_TERMINAL (f
) == t
)
6822 frame_make_pointer_visible (f
);
6826 if (hold_quit
.kind
!= NO_EVENT
)
6827 kbd_buffer_store_event (&hold_quit
);
6839 /* This is the tty way of reading available input.
6841 Note that each terminal device has its own `struct terminal' object,
6842 and so this function is called once for each individual termcap
6843 terminal. The first parameter indicates which terminal to read from. */
6846 tty_read_avail_input (struct terminal
*terminal
,
6847 struct input_event
*hold_quit
)
6849 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6850 the kbd_buffer can really hold. That may prevent loss
6851 of characters on some systems when input is stuffed at us. */
6852 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6854 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6857 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6859 if (kbd_on_hold_p () || buffer_free
<= 0)
6861 #endif /* subprocesses */
6863 if (!terminal
->name
) /* Don't read from a dead terminal. */
6866 if (terminal
->type
!= output_termcap
6867 && terminal
->type
!= output_msdos_raw
)
6870 /* XXX I think the following code should be moved to separate hook
6871 functions in system-dependent files. */
6873 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6874 code sets read_socket_hook to w32_console_read_socket instead! */
6876 #else /* not WINDOWSNT */
6877 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6881 return 0; /* The terminal is suspended. */
6884 n_to_read
= dos_keysns ();
6888 cbuf
[0] = dos_keyread ();
6891 #else /* not MSDOS */
6896 struct input_event gpm_hold_quit
;
6897 int gpm
, fd
= gpm_fd
;
6899 EVENT_INIT (gpm_hold_quit
);
6900 gpm_hold_quit
.kind
= NO_EVENT
;
6902 /* gpm==1 if event received.
6903 gpm==0 if the GPM daemon has closed the connection, in which case
6904 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6905 we save it in `fd' so close_gpm can remove it from the
6907 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6908 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6909 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6912 /* Presumably the GPM daemon has closed the connection. */
6914 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6915 kbd_buffer_store_event (&gpm_hold_quit
);
6919 #endif /* HAVE_GPM */
6921 /* Determine how many characters we should *try* to read. */
6922 #ifdef USABLE_FIONREAD
6923 /* Find out how much input is available. */
6924 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6926 if (! noninteractive
)
6927 return -2; /* Close this terminal. */
6933 if (n_to_read
> sizeof cbuf
)
6934 n_to_read
= sizeof cbuf
;
6935 #elif defined USG || defined CYGWIN
6936 /* Read some input if available, but don't wait. */
6937 n_to_read
= sizeof cbuf
;
6938 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6940 # error "Cannot read without possibly delaying"
6944 /* Don't read more than we can store. */
6945 if (n_to_read
> buffer_free
)
6946 n_to_read
= buffer_free
;
6947 #endif /* subprocesses */
6949 /* Now read; for one reason or another, this will not block.
6950 NREAD is set to the number of chars read. */
6953 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6954 /* POSIX infers that processes which are not in the session leader's
6955 process group won't get SIGHUPs at logout time. BSDI adheres to
6956 this part standard and returns -1 from read (0) with errno==EIO
6957 when the control tty is taken away.
6958 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6959 if (nread
== -1 && errno
== EIO
)
6960 return -2; /* Close this terminal. */
6961 #if defined (AIX) && defined (_BSD)
6962 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6963 This looks incorrect, but it isn't, because _BSD causes
6964 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6965 and that causes a value other than 0 when there is no input. */
6967 return -2; /* Close this terminal. */
6971 /* We used to retry the read if it was interrupted.
6972 But this does the wrong thing when O_NONBLOCK causes
6973 an EAGAIN error. Does anybody know of a situation
6974 where a retry is actually needed? */
6976 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
6986 #ifndef USABLE_FIONREAD
6987 #if defined (USG) || defined (CYGWIN)
6988 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6989 #endif /* USG or CYGWIN */
6990 #endif /* no FIONREAD */
6995 #endif /* not MSDOS */
6996 #endif /* not WINDOWSNT */
6998 for (i
= 0; i
< nread
; i
++)
7000 struct input_event buf
;
7002 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7004 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7005 buf
.modifiers
= meta_modifier
;
7006 if (tty
->meta_key
!= 2)
7010 /* Set the frame corresponding to the active tty. Note that the
7011 value of selected_frame is not reliable here, redisplay tends
7012 to temporarily change it. */
7013 buf
.frame_or_window
= tty
->top_frame
;
7016 kbd_buffer_store_event (&buf
);
7017 /* Don't look at input that follows a C-g too closely.
7018 This reduces lossage due to autorepeat on C-g. */
7019 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7020 && buf
.code
== quit_char
)
7028 handle_async_input (void)
7033 int nread
= gobble_input ();
7034 /* -1 means it's not ok to read the input now.
7035 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7036 0 means there was no keyboard input available. */
7044 process_pending_signals (void)
7046 pending_signals
= false;
7047 handle_async_input ();
7048 do_pending_atimers ();
7051 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7052 and reinvoke any pending signal if the level is now 0 and
7053 a fatal error is not already in progress. */
7056 unblock_input_to (int level
)
7058 interrupt_input_blocked
= level
;
7061 if (pending_signals
&& !fatal_error_in_progress
)
7062 process_pending_signals ();
7068 /* End critical section.
7070 If doing signal-driven input, and a signal came in when input was
7071 blocked, reinvoke the signal handler now to deal with it.
7073 It will also process queued input, if it was not read before.
7074 When a longer code sequence does not use block/unblock input
7075 at all, the whole input gathered up to the next call to
7076 unblock_input will be processed inside that call. */
7079 unblock_input (void)
7081 unblock_input_to (interrupt_input_blocked
- 1);
7084 /* Undo any number of BLOCK_INPUT calls,
7085 and also reinvoke any pending signal. */
7088 totally_unblock_input (void)
7090 unblock_input_to (0);
7096 handle_input_available_signal (int sig
)
7098 pending_signals
= true;
7100 if (input_available_clear_time
)
7101 *input_available_clear_time
= make_timespec (0, 0);
7105 deliver_input_available_signal (int sig
)
7107 deliver_process_signal (sig
, handle_input_available_signal
);
7109 #endif /* USABLE_SIGIO */
7112 /* User signal events. */
7114 struct user_signal_info
7116 /* Signal number. */
7119 /* Name of the signal. */
7122 /* Number of pending signals. */
7125 struct user_signal_info
*next
;
7128 /* List of user signals. */
7129 static struct user_signal_info
*user_signals
= NULL
;
7132 add_user_signal (int sig
, const char *name
)
7134 struct sigaction action
;
7135 struct user_signal_info
*p
;
7137 for (p
= user_signals
; p
; p
= p
->next
)
7139 /* Already added. */
7142 p
= xmalloc (sizeof *p
);
7144 p
->name
= xstrdup (name
);
7146 p
->next
= user_signals
;
7149 emacs_sigaction_init (&action
, deliver_user_signal
);
7150 sigaction (sig
, &action
, 0);
7154 handle_user_signal (int sig
)
7156 struct user_signal_info
*p
;
7157 const char *special_event_name
= NULL
;
7159 if (SYMBOLP (Vdebug_on_event
))
7160 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7162 for (p
= user_signals
; p
; p
= p
->next
)
7165 if (special_event_name
7166 && strcmp (special_event_name
, p
->name
) == 0)
7168 /* Enter the debugger in many ways. */
7169 debug_on_next_call
= true;
7170 debug_on_quit
= true;
7172 Vinhibit_quit
= Qnil
;
7174 /* Eat the event. */
7180 if (interrupt_input
)
7181 handle_input_available_signal (sig
);
7185 /* Tell wait_reading_process_output that it needs to wake
7186 up and look around. */
7187 if (input_available_clear_time
)
7188 *input_available_clear_time
= make_timespec (0, 0);
7195 deliver_user_signal (int sig
)
7197 deliver_process_signal (sig
, handle_user_signal
);
7201 find_user_signal_name (int sig
)
7203 struct user_signal_info
*p
;
7205 for (p
= user_signals
; p
; p
= p
->next
)
7213 store_user_signal_events (void)
7215 struct user_signal_info
*p
;
7216 struct input_event buf
;
7217 bool buf_initialized
= false;
7219 for (p
= user_signals
; p
; p
= p
->next
)
7220 if (p
->npending
> 0)
7222 if (! buf_initialized
)
7224 memset (&buf
, 0, sizeof buf
);
7225 buf
.kind
= USER_SIGNAL_EVENT
;
7226 buf
.frame_or_window
= selected_frame
;
7227 buf_initialized
= true;
7233 kbd_buffer_store_event (&buf
);
7236 while (p
->npending
> 0);
7241 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7242 static Lisp_Object menu_bar_one_keymap_changed_items
;
7244 /* These variables hold the vector under construction within
7245 menu_bar_items and its subroutines, and the current index
7246 for storing into that vector. */
7247 static Lisp_Object menu_bar_items_vector
;
7248 static int menu_bar_items_index
;
7251 static const char *separator_names
[] = {
7256 "single-dashed-line",
7257 "double-dashed-line",
7259 "shadow-etched-out",
7260 "shadow-etched-in-dash",
7261 "shadow-etched-out-dash",
7262 "shadow-double-etched-in",
7263 "shadow-double-etched-out",
7264 "shadow-double-etched-in-dash",
7265 "shadow-double-etched-out-dash",
7269 /* Return true if LABEL specifies a separator. */
7272 menu_separator_name_p (const char *label
)
7276 else if (strlen (label
) > 3
7277 && memcmp (label
, "--", 2) == 0
7282 for (i
= 0; separator_names
[i
]; ++i
)
7283 if (strcmp (label
, separator_names
[i
]) == 0)
7288 /* It's a separator if it contains only dashes. */
7289 while (*label
== '-')
7291 return (*label
== 0);
7298 /* Return a vector of menu items for a menu bar, appropriate
7299 to the current buffer. Each item has three elements in the vector:
7302 OLD is an old vector we can optionally reuse, or nil. */
7305 menu_bar_items (Lisp_Object old
)
7307 /* The number of keymaps we're scanning right now, and the number of
7308 keymaps we have allocated space for. */
7311 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7312 in the current keymaps, or nil where it is not a prefix. */
7315 Lisp_Object mapsbuf
[3];
7316 Lisp_Object def
, tail
;
7323 /* In order to build the menus, we need to call the keymap
7324 accessors. They all call QUIT. But this function is called
7325 during redisplay, during which a quit is fatal. So inhibit
7326 quitting while building the menus.
7327 We do this instead of specbind because (1) errors will clear it anyway
7328 and (2) this avoids risk of specpdl overflow. */
7329 oquit
= Vinhibit_quit
;
7333 menu_bar_items_vector
= old
;
7335 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7336 menu_bar_items_index
= 0;
7338 /* Build our list of keymaps.
7339 If we recognize a function key and replace its escape sequence in
7340 keybuf with its symbol, or if the sequence starts with a mouse
7341 click and we need to switch buffers, we jump back here to rebuild
7342 the initial keymaps from the current buffer. */
7346 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7347 if (!NILP (Voverriding_local_map_menu_flag
)
7348 && !NILP (Voverriding_local_map
))
7350 /* Yes, use them (if non-nil) as well as the global map. */
7353 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7354 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7355 if (!NILP (Voverriding_local_map
))
7356 maps
[nmaps
++] = Voverriding_local_map
;
7360 /* No, so use major and minor mode keymaps and keymap property.
7361 Note that menu-bar bindings in the local-map and keymap
7362 properties may not work reliable, as they are only
7363 recognized when the menu-bar (or mode-line) is updated,
7364 which does not normally happen after every command. */
7365 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7366 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7368 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7369 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7370 maps
[nmaps
++] = tem
;
7371 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7372 maps
[nmaps
++] = tem
;
7375 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7378 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7380 maps
[nmaps
++] = current_global_map
;
7383 /* Look up in each map the dummy prefix key `menu-bar'. */
7385 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7386 if (!NILP (maps
[mapno
]))
7388 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7392 menu_bar_one_keymap_changed_items
= Qnil
;
7393 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7397 /* Move to the end those items that should be at the end. */
7399 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7402 int end
= menu_bar_items_index
;
7404 for (i
= 0; i
< end
; i
+= 4)
7405 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7407 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7408 /* Move the item at index I to the end,
7409 shifting all the others forward. */
7410 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7411 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7412 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7413 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7415 memmove (aref_addr (menu_bar_items_vector
, i
),
7416 aref_addr (menu_bar_items_vector
, i
+ 4),
7417 (end
- i
- 4) * word_size
);
7418 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7419 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7420 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7421 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7426 /* Add nil, nil, nil, nil at the end. */
7428 int i
= menu_bar_items_index
;
7429 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7430 menu_bar_items_vector
7431 = larger_vector (menu_bar_items_vector
, 4, -1);
7432 /* Add this item. */
7433 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7434 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7435 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7436 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7437 menu_bar_items_index
= i
;
7440 Vinhibit_quit
= oquit
;
7442 return menu_bar_items_vector
;
7445 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7446 If there's already an item for KEY, add this DEF to it. */
7448 Lisp_Object item_properties
;
7451 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7457 if (EQ (item
, Qundefined
))
7459 /* If a map has an explicit `undefined' as definition,
7460 discard any previously made menu bar item. */
7462 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7463 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7465 if (menu_bar_items_index
> i
+ 4)
7466 memmove (aref_addr (menu_bar_items_vector
, i
),
7467 aref_addr (menu_bar_items_vector
, i
+ 4),
7468 (menu_bar_items_index
- i
- 4) * word_size
);
7469 menu_bar_items_index
-= 4;
7473 /* If this keymap has already contributed to this KEY,
7474 don't contribute to it a second time. */
7475 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7476 if (!NILP (tem
) || NILP (item
))
7479 menu_bar_one_keymap_changed_items
7480 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7482 /* We add to menu_bar_one_keymap_changed_items before doing the
7483 parse_menu_item, so that if it turns out it wasn't a menu item,
7484 it still correctly hides any further menu item. */
7485 parsed
= parse_menu_item (item
, 1);
7489 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7491 /* Find any existing item for this KEY. */
7492 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7493 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7496 /* If we did not find this KEY, add it at the end. */
7497 if (i
== menu_bar_items_index
)
7499 /* If vector is too small, get a bigger one. */
7500 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7501 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7502 /* Add this item. */
7503 ASET (menu_bar_items_vector
, i
, key
); i
++;
7504 ASET (menu_bar_items_vector
, i
,
7505 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7506 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7507 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7508 menu_bar_items_index
= i
;
7510 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7514 old
= AREF (menu_bar_items_vector
, i
+ 2);
7515 /* If the new and the old items are not both keymaps,
7516 the lookup will only find `item'. */
7517 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7518 ASET (menu_bar_items_vector
, i
+ 2, item
);
7522 /* This is used as the handler when calling menu_item_eval_property. */
7524 menu_item_eval_property_1 (Lisp_Object arg
)
7526 /* If we got a quit from within the menu computation,
7527 quit all the way out of it. This takes care of C-] in the debugger. */
7528 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7529 Fsignal (Qquit
, Qnil
);
7535 eval_dyn (Lisp_Object form
)
7537 return Feval (form
, Qnil
);
7540 /* Evaluate an expression and return the result (or nil if something
7541 went wrong). Used to evaluate dynamic parts of menu items. */
7543 menu_item_eval_property (Lisp_Object sexpr
)
7545 ptrdiff_t count
= SPECPDL_INDEX ();
7547 specbind (Qinhibit_redisplay
, Qt
);
7548 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7549 menu_item_eval_property_1
);
7550 return unbind_to (count
, val
);
7553 /* This function parses a menu item and leaves the result in the
7554 vector item_properties.
7555 ITEM is a key binding, a possible menu item.
7556 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7558 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7559 parse_menu_item returns true if the item is a menu item and false
7563 parse_menu_item (Lisp_Object item
, int inmenubar
)
7565 Lisp_Object def
, tem
, item_string
, start
;
7567 Lisp_Object keyhint
;
7576 /* Create item_properties vector if necessary. */
7577 if (NILP (item_properties
))
7579 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7581 /* Initialize optional entries. */
7582 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7583 ASET (item_properties
, i
, Qnil
);
7584 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7586 /* Save the item here to protect it from GC. */
7587 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7589 item_string
= XCAR (item
);
7593 if (STRINGP (item_string
))
7595 /* Old format menu item. */
7596 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7598 /* Maybe help string. */
7599 if (CONSP (item
) && STRINGP (XCAR (item
)))
7601 ASET (item_properties
, ITEM_PROPERTY_HELP
,
7602 Fsubstitute_command_keys (XCAR (item
)));
7607 /* Maybe an obsolete key binding cache. */
7608 if (CONSP (item
) && CONSP (XCAR (item
))
7609 && (NILP (XCAR (XCAR (item
)))
7610 || VECTORP (XCAR (XCAR (item
)))))
7613 /* This is the real definition--the function to run. */
7614 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7616 /* Get enable property, if any. */
7619 tem
= Fget (item
, Qmenu_enable
);
7620 if (!NILP (Venable_disabled_menus_and_buttons
))
7621 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7622 else if (!NILP (tem
))
7623 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7626 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7628 /* New format menu item. */
7629 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7630 start
= XCDR (item
);
7633 /* We have a real binding. */
7634 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7636 item
= XCDR (start
);
7637 /* Is there an obsolete cache list with key equivalences. */
7638 if (CONSP (item
) && CONSP (XCAR (item
)))
7641 /* Parse properties. */
7642 while (CONSP (item
) && CONSP (XCDR (item
)))
7647 if (EQ (tem
, QCenable
))
7649 if (!NILP (Venable_disabled_menus_and_buttons
))
7650 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7652 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7654 else if (EQ (tem
, QCvisible
))
7656 /* If got a visible property and that evaluates to nil
7657 then ignore this item. */
7658 tem
= menu_item_eval_property (XCAR (item
));
7662 else if (EQ (tem
, QChelp
))
7664 Lisp_Object help
= XCAR (item
);
7666 help
= Fsubstitute_command_keys (help
);
7667 ASET (item_properties
, ITEM_PROPERTY_HELP
, help
);
7669 else if (EQ (tem
, QCfilter
))
7671 else if (EQ (tem
, QCkey_sequence
))
7674 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7675 /* Be GC protected. Set keyhint to item instead of tem. */
7678 else if (EQ (tem
, QCkeys
))
7681 if (CONSP (tem
) || STRINGP (tem
))
7682 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7684 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7689 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7691 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7693 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7699 else if (inmenubar
|| !NILP (start
))
7703 return 0; /* not a menu item */
7705 /* If item string is not a string, evaluate it to get string.
7706 If we don't get a string, skip this item. */
7707 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7708 if (!(STRINGP (item_string
)))
7710 item_string
= menu_item_eval_property (item_string
);
7711 if (!STRINGP (item_string
))
7713 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7716 /* If got a filter apply it on definition. */
7717 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7720 def
= menu_item_eval_property (list2 (XCAR (filter
),
7721 list2 (Qquote
, def
)));
7723 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7726 /* Enable or disable selection of item. */
7727 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7730 tem
= menu_item_eval_property (tem
);
7731 if (inmenubar
&& NILP (tem
))
7732 return 0; /* Ignore disabled items in menu bar. */
7733 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7736 /* If we got no definition, this item is just unselectable text which
7737 is OK in a submenu but not in the menubar. */
7739 return (!inmenubar
);
7741 /* See if this is a separate pane or a submenu. */
7742 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7743 tem
= get_keymap (def
, 0, 1);
7744 /* For a subkeymap, just record its details and exit. */
7747 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7748 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7752 /* At the top level in the menu bar, do likewise for commands also.
7753 The menu bar does not display equivalent key bindings anyway.
7754 ITEM_PROPERTY_DEF is already set up properly. */
7758 { /* This is a command. See if there is an equivalent key binding. */
7759 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7760 AUTO_STRING (space_space
, " ");
7762 /* The previous code preferred :key-sequence to :keys, so we
7763 preserve this behavior. */
7764 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7765 keyeq
= concat2 (space_space
, Fsubstitute_command_keys (keyeq
));
7768 Lisp_Object prefix
= keyeq
;
7769 Lisp_Object keys
= Qnil
;
7773 def
= XCAR (prefix
);
7774 prefix
= XCDR (prefix
);
7777 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7779 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7781 keys
= XCAR (keyhint
);
7782 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7784 /* We have a suggested key. Is it bound to the command? */
7787 /* If the command is an alias for another
7788 (such as lmenu.el set it up), check if the
7789 original command matches the cached command. */
7791 && EQ (tem
, XSYMBOL (def
)->function
))))
7796 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7800 tem
= Fkey_description (keys
, Qnil
);
7803 if (STRINGP (XCAR (prefix
)))
7804 tem
= concat2 (XCAR (prefix
), tem
);
7805 if (STRINGP (XCDR (prefix
)))
7806 tem
= concat2 (tem
, XCDR (prefix
));
7808 keyeq
= concat2 (space_space
, tem
);
7814 /* If we have an equivalent key binding, use that. */
7815 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7818 /* Include this when menu help is implemented.
7819 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7820 if (!(NILP (tem) || STRINGP (tem)))
7822 tem = menu_item_eval_property (tem);
7825 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7829 /* Handle radio buttons or toggle boxes. */
7830 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7832 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7833 menu_item_eval_property (tem
));
7840 /***********************************************************************
7842 ***********************************************************************/
7844 /* A vector holding tool bar items while they are parsed in function
7845 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7848 static Lisp_Object tool_bar_items_vector
;
7850 /* A vector holding the result of parse_tool_bar_item. Layout is like
7851 the one for a single item in tool_bar_items_vector. */
7853 static Lisp_Object tool_bar_item_properties
;
7855 /* Next free index in tool_bar_items_vector. */
7857 static int ntool_bar_items
;
7859 /* Function prototypes. */
7861 static void init_tool_bar_items (Lisp_Object
);
7862 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7864 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7865 static void append_tool_bar_item (void);
7868 /* Return a vector of tool bar items for keymaps currently in effect.
7869 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7870 tool bar items found. */
7873 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7876 Lisp_Object mapsbuf
[3];
7884 /* In order to build the menus, we need to call the keymap
7885 accessors. They all call QUIT. But this function is called
7886 during redisplay, during which a quit is fatal. So inhibit
7887 quitting while building the menus. We do this instead of
7888 specbind because (1) errors will clear it anyway and (2) this
7889 avoids risk of specpdl overflow. */
7890 oquit
= Vinhibit_quit
;
7893 /* Initialize tool_bar_items_vector and protect it from GC. */
7894 init_tool_bar_items (reuse
);
7896 /* Build list of keymaps in maps. Set nmaps to the number of maps
7899 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7900 if (!NILP (Voverriding_local_map_menu_flag
)
7901 && !NILP (Voverriding_local_map
))
7903 /* Yes, use them (if non-nil) as well as the global map. */
7906 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7907 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7908 if (!NILP (Voverriding_local_map
))
7909 maps
[nmaps
++] = Voverriding_local_map
;
7913 /* No, so use major and minor mode keymaps and keymap property.
7914 Note that tool-bar bindings in the local-map and keymap
7915 properties may not work reliable, as they are only
7916 recognized when the tool-bar (or mode-line) is updated,
7917 which does not normally happen after every command. */
7918 ptrdiff_t nminor
= current_minor_maps (NULL
, &tmaps
);
7919 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7921 Lisp_Object tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7922 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7923 maps
[nmaps
++] = tem
;
7924 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7925 maps
[nmaps
++] = tem
;
7928 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7931 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7934 /* Add global keymap at the end. */
7935 maps
[nmaps
++] = current_global_map
;
7937 /* Process maps in reverse order and look up in each map the prefix
7939 for (i
= nmaps
- 1; i
>= 0; --i
)
7940 if (!NILP (maps
[i
]))
7944 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7946 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7949 Vinhibit_quit
= oquit
;
7950 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7952 return tool_bar_items_vector
;
7956 /* Process the definition of KEY which is DEF. */
7959 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7963 if (EQ (def
, Qundefined
))
7965 /* If a map has an explicit `undefined' as definition,
7966 discard any previously made item. */
7967 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7969 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7971 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7973 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7974 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
7975 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7977 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7982 else if (parse_tool_bar_item (key
, def
))
7983 /* Append a new tool bar item to tool_bar_items_vector. Accept
7984 more than one definition for the same key. */
7985 append_tool_bar_item ();
7988 /* Access slot with index IDX of vector tool_bar_item_properties. */
7989 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
7991 set_prop (ptrdiff_t idx
, Lisp_Object val
)
7993 ASET (tool_bar_item_properties
, idx
, val
);
7997 /* Parse a tool bar item specification ITEM for key KEY and return the
7998 result in tool_bar_item_properties. Value is false if ITEM is
8001 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8003 CAPTION is the caption of the item, If it's not a string, it is
8004 evaluated to get a string.
8006 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8007 as binding are currently ignored.
8009 The following properties are recognized:
8013 FORM is evaluated and specifies whether the tool bar item is
8014 enabled or disabled.
8018 FORM is evaluated and specifies whether the tool bar item is visible.
8020 - `:filter FUNCTION'
8022 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8023 result is stored as the new binding.
8025 - `:button (TYPE SELECTED)'
8027 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8028 and specifies whether the button is selected (pressed) or not.
8032 IMAGES is either a single image specification or a vector of four
8033 image specifications. See enum tool_bar_item_images.
8035 - `:help HELP-STRING'.
8037 Gives a help string to display for the tool bar item.
8039 - `:label LABEL-STRING'.
8041 A text label to show with the tool bar button if labels are enabled. */
8044 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8046 Lisp_Object filter
= Qnil
;
8047 Lisp_Object caption
;
8049 bool have_label
= false;
8051 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8052 Rule out items that aren't lists, don't start with
8053 `menu-item' or whose rest following `tool-bar-item' is not a
8058 /* As an exception, allow old-style menu separators. */
8059 if (STRINGP (XCAR (item
)))
8060 item
= list1 (XCAR (item
));
8061 else if (!EQ (XCAR (item
), Qmenu_item
)
8062 || (item
= XCDR (item
), !CONSP (item
)))
8065 /* Create tool_bar_item_properties vector if necessary. Reset it to
8067 if (VECTORP (tool_bar_item_properties
))
8069 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8073 tool_bar_item_properties
8074 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8077 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8078 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8080 /* Get the caption of the item. If the caption is not a string,
8081 evaluate it to get a string. If we don't get a string, skip this
8083 caption
= XCAR (item
);
8084 if (!STRINGP (caption
))
8086 caption
= menu_item_eval_property (caption
);
8087 if (!STRINGP (caption
))
8090 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8092 /* If the rest following the caption is not a list, the menu item is
8093 either a separator, or invalid. */
8097 if (menu_separator_name_p (SSDATA (caption
)))
8099 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8100 #if !defined (USE_GTK) && !defined (HAVE_NS)
8101 /* If we use build_desired_tool_bar_string to render the
8102 tool bar, the separator is rendered as an image. */
8103 set_prop (TOOL_BAR_ITEM_IMAGES
,
8104 (menu_item_eval_property
8105 (Vtool_bar_separator_image_expression
)));
8106 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8107 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8108 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8115 /* Store the binding. */
8116 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8119 /* Ignore cached key binding, if any. */
8120 if (CONSP (item
) && CONSP (XCAR (item
)))
8123 /* Process the rest of the properties. */
8124 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8126 Lisp_Object ikey
, value
;
8129 value
= XCAR (XCDR (item
));
8131 if (EQ (ikey
, QCenable
))
8133 /* `:enable FORM'. */
8134 if (!NILP (Venable_disabled_menus_and_buttons
))
8135 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8137 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8139 else if (EQ (ikey
, QCvisible
))
8141 /* `:visible FORM'. If got a visible property and that
8142 evaluates to nil then ignore this item. */
8143 if (NILP (menu_item_eval_property (value
)))
8146 else if (EQ (ikey
, QChelp
))
8147 /* `:help HELP-STRING'. */
8148 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8149 else if (EQ (ikey
, QCvert_only
))
8150 /* `:vert-only t/nil'. */
8151 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8152 else if (EQ (ikey
, QClabel
))
8154 const char *bad_label
= "!!?GARBLED ITEM?!!";
8155 /* `:label LABEL-STRING'. */
8156 set_prop (TOOL_BAR_ITEM_LABEL
,
8157 STRINGP (value
) ? value
: build_string (bad_label
));
8160 else if (EQ (ikey
, QCfilter
))
8161 /* ':filter FORM'. */
8163 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8165 /* `:button (TYPE . SELECTED)'. */
8166 Lisp_Object type
, selected
;
8168 type
= XCAR (value
);
8169 selected
= XCDR (value
);
8170 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8172 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8173 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8176 else if (EQ (ikey
, QCimage
)
8178 || (VECTORP (value
) && ASIZE (value
) == 4)))
8179 /* Value is either a single image specification or a vector
8180 of 4 such specifications for the different button states. */
8181 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8182 else if (EQ (ikey
, QCrtl
))
8184 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8190 /* Try to make one from caption and key. */
8191 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8192 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8193 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8194 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8196 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8197 char *buf
= xmalloc (max_lbl
+ 1);
8198 Lisp_Object new_lbl
;
8199 ptrdiff_t caption_len
= strlen (capt
);
8201 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8204 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8206 buf
[caption_len
] = '\0';
8210 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8214 strcpy (buf
, label
);
8216 for (j
= 0; buf
[j
] != '\0'; ++j
)
8224 new_lbl
= Fupcase_initials (build_string (label
));
8225 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8226 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8228 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8232 /* If got a filter apply it on binding. */
8234 set_prop (TOOL_BAR_ITEM_BINDING
,
8235 (menu_item_eval_property
8238 PROP (TOOL_BAR_ITEM_BINDING
))))));
8240 /* See if the binding is a keymap. Give up if it is. */
8241 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8244 /* Enable or disable selection of item. */
8245 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8246 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8247 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8249 /* Handle radio buttons or toggle boxes. */
8250 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8251 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8252 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8260 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8261 that can be reused. */
8264 init_tool_bar_items (Lisp_Object reuse
)
8266 if (VECTORP (reuse
))
8267 tool_bar_items_vector
= reuse
;
8269 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8270 ntool_bar_items
= 0;
8274 /* Append parsed tool bar item properties from
8275 tool_bar_item_properties */
8278 append_tool_bar_item (void)
8282 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8284 /* Enlarge tool_bar_items_vector if necessary. */
8286 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8288 /* Append entries from tool_bar_item_properties to the end of
8289 tool_bar_items_vector. */
8290 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8291 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8292 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8299 /* Read a character using menus based on the keymap MAP.
8300 Return nil if there are no menus in the maps.
8301 Return t if we displayed a menu but the user rejected it.
8303 PREV_EVENT is the previous input event, or nil if we are reading
8304 the first event of a key sequence.
8306 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8307 if we used a mouse menu to read the input, or false otherwise. If
8308 USED_MOUSE_MENU is null, don't dereference it.
8310 The prompting is done based on the prompt-string of the map
8311 and the strings associated with various map elements.
8313 This can be done with X menus or with menus put in the minibuf.
8314 These are done in different ways, depending on how the input will be read.
8315 Menus using X are done after auto-saving in read-char, getting the input
8316 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8317 and do auto-saving in the inner call of read_char. */
8320 read_char_x_menu_prompt (Lisp_Object map
,
8321 Lisp_Object prev_event
, bool *used_mouse_menu
)
8323 if (used_mouse_menu
)
8324 *used_mouse_menu
= false;
8326 /* Use local over global Menu maps. */
8328 if (! menu_prompting
)
8331 /* If we got to this point via a mouse click,
8332 use a real menu for mouse selection. */
8333 if (EVENT_HAS_PARAMETERS (prev_event
)
8334 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8335 && !EQ (XCAR (prev_event
), Qtool_bar
))
8337 /* Display the menu and get the selection. */
8340 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8345 record_menu_key (XCAR (value
));
8347 /* If we got multiple events, unread all but
8349 There is no way to prevent those unread events
8350 from showing up later in last_nonmenu_event.
8351 So turn symbol and integer events into lists,
8352 to indicate that they came from a mouse menu,
8353 so that when present in last_nonmenu_event
8354 they won't confuse things. */
8355 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8357 record_menu_key (XCAR (tem
));
8358 if (SYMBOLP (XCAR (tem
))
8359 || INTEGERP (XCAR (tem
)))
8360 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8363 /* If we got more than one event, put all but the first
8364 onto this list to be read later.
8365 Return just the first event now. */
8366 Vunread_command_events
8367 = nconc2 (XCDR (value
), Vunread_command_events
);
8368 value
= XCAR (value
);
8370 else if (NILP (value
))
8372 if (used_mouse_menu
)
8373 *used_mouse_menu
= true;
8380 read_char_minibuf_menu_prompt (int commandflag
,
8385 /* FIXME: Use the minibuffer's frame width. */
8386 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8388 bool nobindings
= true;
8389 Lisp_Object rest
, vector
;
8390 Lisp_Object prompt_strings
= Qnil
;
8394 if (! menu_prompting
)
8397 map
= get_keymap (map
, 0, 1);
8398 name
= Fkeymap_prompt (map
);
8400 /* If we don't have any menus, just read a character normally. */
8401 if (!STRINGP (name
))
8404 #define PUSH_C_STR(str, listvar) \
8405 listvar = Fcons (build_unibyte_string (str), listvar)
8407 /* Prompt string always starts with map's prompt, and a space. */
8408 prompt_strings
= Fcons (name
, prompt_strings
);
8409 PUSH_C_STR (": ", prompt_strings
);
8410 nlength
= SCHARS (name
) + 2;
8414 /* Present the documented bindings, a line at a time. */
8417 bool notfirst
= false;
8418 Lisp_Object menu_strings
= prompt_strings
;
8419 ptrdiff_t i
= nlength
;
8421 Lisp_Object orig_defn_macro
;
8423 /* Loop over elements of map. */
8428 /* FIXME: Use map_keymap to handle new keymap formats. */
8430 /* At end of map, wrap around if just starting,
8431 or end this line if already have something on it. */
8434 if (notfirst
|| nobindings
)
8440 /* Look at the next element of the map. */
8442 elt
= AREF (vector
, idx
);
8444 elt
= Fcar_safe (rest
);
8446 if (idx
< 0 && VECTORP (elt
))
8448 /* If we found a dense table in the keymap,
8449 advanced past it, but start scanning its contents. */
8450 rest
= Fcdr_safe (rest
);
8456 /* An ordinary element. */
8457 Lisp_Object event
, tem
;
8461 event
= Fcar_safe (elt
); /* alist */
8462 elt
= Fcdr_safe (elt
);
8466 XSETINT (event
, idx
); /* vector */
8469 /* Ignore the element if it has no prompt string. */
8470 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8472 /* True if the char to type matches the string. */
8474 Lisp_Object upcased_event
, downcased_event
;
8475 Lisp_Object desc
= Qnil
;
8477 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8479 upcased_event
= Fupcase (event
);
8480 downcased_event
= Fdowncase (event
);
8481 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8482 || XINT (downcased_event
) == SREF (s
, 0));
8484 desc
= Fsingle_key_description (event
, Qnil
);
8486 #if 0 /* It is redundant to list the equivalent key bindings because
8487 the prefix is what the user has already typed. */
8489 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8491 /* Insert equivalent keybinding. */
8492 s
= concat2 (s
, tem
);
8495 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8496 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8498 /* Insert button prefix. */
8499 Lisp_Object selected
8500 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8501 AUTO_STRING (radio_yes
, "(*) ");
8502 AUTO_STRING (radio_no
, "( ) ");
8503 AUTO_STRING (check_yes
, "[X] ");
8504 AUTO_STRING (check_no
, "[ ] ");
8505 if (EQ (tem
, QCradio
))
8506 tem
= NILP (selected
) ? radio_yes
: radio_no
;
8508 tem
= NILP (selected
) ? check_yes
: check_no
;
8509 s
= concat2 (tem
, s
);
8513 /* If we have room for the prompt string, add it to this line.
8514 If this is the first on the line, always add it. */
8515 if ((SCHARS (s
) + i
+ 2
8516 + (char_matches
? 0 : SCHARS (desc
) + 3))
8520 ptrdiff_t thiswidth
;
8522 /* Punctuate between strings. */
8525 PUSH_C_STR (", ", menu_strings
);
8531 /* If the char to type doesn't match the string's
8532 first char, explicitly show what char to type. */
8535 /* Add as much of string as fits. */
8536 thiswidth
= min (SCHARS (desc
), width
- i
);
8538 = Fcons (Fsubstring (desc
, make_number (0),
8539 make_number (thiswidth
)),
8542 PUSH_C_STR (" = ", menu_strings
);
8546 /* Add as much of string as fits. */
8547 thiswidth
= min (SCHARS (s
), width
- i
);
8549 = Fcons (Fsubstring (s
, make_number (0),
8550 make_number (thiswidth
)),
8556 /* If this element does not fit, end the line now,
8557 and save the element for the next line. */
8558 PUSH_C_STR ("...", menu_strings
);
8563 /* Move past this element. */
8564 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8565 /* Handle reaching end of dense table. */
8570 rest
= Fcdr_safe (rest
);
8574 /* Prompt with that and read response. */
8575 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8577 /* Make believe it's not a keyboard macro in case the help char
8578 is pressed. Help characters are not recorded because menu prompting
8579 is not used on replay. */
8580 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8581 kset_defining_kbd_macro (current_kboard
, Qnil
);
8583 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8584 while (BUFFERP (obj
));
8585 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8587 if (!INTEGERP (obj
) || XINT (obj
) == -2
8588 || (! EQ (obj
, menu_prompt_more_char
)
8589 && (!INTEGERP (menu_prompt_more_char
)
8590 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
)))))))
8592 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8593 store_kbd_macro_char (obj
);
8596 /* Help char - go round again. */
8600 /* Reading key sequences. */
8603 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8605 return access_keymap (get_keymap (keymap
, 0, 1),
8610 active_maps (Lisp_Object first_event
)
8612 Lisp_Object position
8613 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8614 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8617 /* Structure used to keep track of partial application of key remapping
8618 such as Vfunction_key_map and Vkey_translation_map. */
8619 typedef struct keyremap
8621 /* This is the map originally specified for this use. */
8623 /* This is a submap reached by looking up, in PARENT,
8624 the events from START to END. */
8626 /* Positions [START, END) in the key sequence buffer
8627 are the key that we have scanned so far.
8628 Those events are the ones that we will replace
8629 if PARENT maps them into a key sequence. */
8633 /* Lookup KEY in MAP.
8634 MAP is a keymap mapping keys to key vectors or functions.
8635 If the mapping is a function and DO_FUNCALL is true,
8636 the function is called with PROMPT as parameter and its return
8637 value is used as the return value of this function (after checking
8638 that it is indeed a vector). */
8641 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8646 next
= access_keymap (map
, key
, 1, 0, 1);
8648 /* Handle a symbol whose function definition is a keymap
8650 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8651 && (ARRAYP (XSYMBOL (next
)->function
)
8652 || KEYMAPP (XSYMBOL (next
)->function
)))
8653 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8655 /* If the keymap gives a function, not an
8656 array, then call the function with one arg and use
8657 its value instead. */
8658 if (do_funcall
&& FUNCTIONP (next
))
8663 next
= call1 (next
, prompt
);
8664 /* If the function returned something invalid,
8665 barf--don't ignore it. */
8666 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8667 error ("Function %s returns invalid key sequence",
8668 SSDATA (SYMBOL_NAME (tem
)));
8673 /* Do one step of the key remapping used for function-key-map and
8674 key-translation-map:
8675 KEYBUF is the buffer holding the input events.
8676 BUFSIZE is its maximum size.
8677 FKEY is a pointer to the keyremap structure to use.
8678 INPUT is the index of the last element in KEYBUF.
8679 DOIT if true says that the remapping can actually take place.
8680 DIFF is used to return the number of keys added/removed by the remapping.
8681 PARENT is the root of the keymap.
8682 PROMPT is the prompt to use if the remapping happens through a function.
8683 Return true if the remapping actually took place. */
8686 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8687 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8689 Lisp_Object next
, key
;
8691 key
= keybuf
[fkey
->end
++];
8693 if (KEYMAPP (fkey
->parent
))
8694 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8698 /* If keybuf[fkey->start..fkey->end] is bound in the
8699 map and we're in a position to do the key remapping, replace it with
8700 the binding and restart with fkey->start at the end. */
8701 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8703 int len
= XFASTINT (Flength (next
));
8706 *diff
= len
- (fkey
->end
- fkey
->start
);
8708 if (bufsize
- input
<= *diff
)
8709 error ("Key sequence too long");
8711 /* Shift the keys that follow fkey->end. */
8713 for (i
= fkey
->end
; i
< input
; i
++)
8714 keybuf
[i
+ *diff
] = keybuf
[i
];
8716 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8717 keybuf
[i
+ *diff
] = keybuf
[i
];
8718 /* Overwrite the old keys with the new ones. */
8719 for (i
= 0; i
< len
; i
++)
8720 keybuf
[fkey
->start
+ i
]
8721 = Faref (next
, make_number (i
));
8723 fkey
->start
= fkey
->end
+= *diff
;
8724 fkey
->map
= fkey
->parent
;
8729 fkey
->map
= get_keymap (next
, 0, 1);
8731 /* If we no longer have a bound suffix, try a new position for
8733 if (!CONSP (fkey
->map
))
8735 fkey
->end
= ++fkey
->start
;
8736 fkey
->map
= fkey
->parent
;
8742 test_undefined (Lisp_Object binding
)
8744 return (NILP (binding
)
8745 || EQ (binding
, Qundefined
)
8746 || (SYMBOLP (binding
)
8747 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8750 /* Read a sequence of keys that ends with a non prefix character,
8751 storing it in KEYBUF, a buffer of size BUFSIZE.
8753 Return the length of the key sequence stored.
8754 Return -1 if the user rejected a command menu.
8756 Echo starting immediately unless `prompt' is 0.
8758 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8759 read_char with a suitable COMMANDFLAG argument.
8761 Where a key sequence ends depends on the currently active keymaps.
8762 These include any minor mode keymaps active in the current buffer,
8763 the current buffer's local map, and the global map.
8765 If a key sequence has no other bindings, we check Vfunction_key_map
8766 to see if some trailing subsequence might be the beginning of a
8767 function key's sequence. If so, we try to read the whole function
8768 key, and substitute its symbolic name into the key sequence.
8770 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8771 `double-' events into similar click events, if that would make them
8772 bound. We try to turn `triple-' events first into `double-' events,
8775 If we get a mouse click in a mode line, vertical divider, or other
8776 non-text area, we treat the click as if it were prefixed by the
8777 symbol denoting that area - `mode-line', `vertical-line', or
8780 If the sequence starts with a mouse click, we read the key sequence
8781 with respect to the buffer clicked on, not the current buffer.
8783 If the user switches frames in the midst of a key sequence, we put
8784 off the switch-frame event until later; the next call to
8785 read_char will return it.
8787 If FIX_CURRENT_BUFFER, we restore current_buffer
8788 from the selected window's buffer. */
8791 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8792 bool dont_downcase_last
, bool can_return_switch_frame
,
8793 bool fix_current_buffer
, bool prevent_redisplay
)
8795 ptrdiff_t count
= SPECPDL_INDEX ();
8797 /* How many keys there are in the current key sequence. */
8800 /* The length of the echo buffer when we started reading, and
8801 the length of this_command_keys when we started reading. */
8802 ptrdiff_t echo_start
IF_LINT (= 0);
8803 ptrdiff_t keys_start
;
8805 Lisp_Object current_binding
= Qnil
;
8806 Lisp_Object first_event
= Qnil
;
8808 /* Index of the first key that has no binding.
8809 It is useless to try fkey.start larger than that. */
8812 /* If t < mock_input, then KEYBUF[t] should be read as the next
8815 We use this to recover after recognizing a function key. Once we
8816 realize that a suffix of the current key sequence is actually a
8817 function key's escape sequence, we replace the suffix with the
8818 function key's binding from Vfunction_key_map. Now keybuf
8819 contains a new and different key sequence, so the echo area,
8820 this_command_keys, and the submaps and defs arrays are wrong. In
8821 this situation, we set mock_input to t, set t to 0, and jump to
8822 restart_sequence; the loop will read keys from keybuf up until
8823 mock_input, thus rebuilding the state; and then it will resume
8824 reading characters from the keyboard. */
8827 /* If the sequence is unbound in submaps[], then
8828 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8829 and fkey.map is its binding.
8831 These might be > t, indicating that all function key scanning
8832 should hold off until t reaches them. We do this when we've just
8833 recognized a function key, to avoid searching for the function
8834 key's again in Vfunction_key_map. */
8837 /* Likewise, for key_translation_map and input-decode-map. */
8838 keyremap keytran
, indec
;
8840 /* True if we are trying to map a key by changing an upper-case
8841 letter to lower case, or a shifted function key to an unshifted
8843 bool shift_translated
= false;
8845 /* If we receive a `switch-frame' or `select-window' event in the middle of
8846 a key sequence, we put it off for later.
8847 While we're reading, we keep the event here. */
8848 Lisp_Object delayed_switch_frame
;
8850 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8851 int original_uppercase_position
= -1;
8853 /* Gets around Microsoft compiler limitations. */
8854 bool dummyflag
= false;
8856 struct buffer
*starting_buffer
;
8858 /* List of events for which a fake prefix key has been generated. */
8859 Lisp_Object fake_prefixed_keys
= Qnil
;
8861 raw_keybuf_count
= 0;
8863 last_nonmenu_event
= Qnil
;
8865 delayed_switch_frame
= Qnil
;
8871 /* Install the string PROMPT as the beginning of the string
8872 of echoing, so that it serves as a prompt for the next
8874 kset_echo_prompt (current_kboard
, prompt
);
8875 current_kboard
->immediate_echo
= false;
8878 else if (cursor_in_echo_area
8879 && echo_keystrokes_p ())
8880 /* This doesn't put in a dash if the echo buffer is empty, so
8881 you don't always see a dash hanging out in the minibuffer. */
8885 /* Record the initial state of the echo area and this_command_keys;
8886 we will need to restore them if we replay a key sequence. */
8888 echo_start
= echo_length ();
8889 keys_start
= this_command_key_count
;
8890 this_single_command_key_start
= keys_start
;
8892 /* We jump here when we need to reinitialize fkey and keytran; this
8893 happens if we switch keyboards between rescans. */
8894 replay_entire_sequence
:
8896 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8897 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8898 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8899 indec
.start
= indec
.end
= 0;
8900 fkey
.start
= fkey
.end
= 0;
8901 keytran
.start
= keytran
.end
= 0;
8903 /* We jump here when the key sequence has been thoroughly changed, and
8904 we need to rescan it starting from the beginning. When we jump here,
8905 keybuf[0..mock_input] holds the sequence we should reread. */
8908 starting_buffer
= current_buffer
;
8909 first_unbound
= bufsize
+ 1;
8911 /* Build our list of keymaps.
8912 If we recognize a function key and replace its escape sequence in
8913 keybuf with its symbol, or if the sequence starts with a mouse
8914 click and we need to switch buffers, we jump back here to rebuild
8915 the initial keymaps from the current buffer. */
8916 current_binding
= active_maps (first_event
);
8918 /* Start from the beginning in keybuf. */
8921 /* These are no-ops the first time through, but if we restart, they
8922 revert the echo area and this_command_keys to their original state. */
8923 this_command_key_count
= keys_start
;
8924 if (INTERACTIVE
&& t
< mock_input
)
8925 echo_truncate (echo_start
);
8927 /* If the best binding for the current key sequence is a keymap, or
8928 we may be looking at a function key's escape sequence, keep on
8930 while (!NILP (current_binding
)
8931 /* Keep reading as long as there's a prefix binding. */
8932 ? KEYMAPP (current_binding
)
8933 /* Don't return in the middle of a possible function key sequence,
8934 if the only bindings we found were via case conversion.
8935 Thus, if ESC O a has a function-key-map translation
8936 and ESC o has a binding, don't return after ESC O,
8937 so that we can translate ESC O plus the next character. */
8938 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8941 bool used_mouse_menu
= false;
8943 /* Where the last real key started. If we need to throw away a
8944 key that has expanded into more than one element of keybuf
8945 (say, a mouse click on the mode line which is being treated
8946 as [mode-line (mouse-...)], then we backtrack to this point
8948 int last_real_key_start
;
8950 /* These variables are analogous to echo_start and keys_start;
8951 while those allow us to restart the entire key sequence,
8952 echo_local_start and keys_local_start allow us to throw away
8954 ptrdiff_t echo_local_start
IF_LINT (= 0);
8955 int keys_local_start
;
8956 Lisp_Object new_binding
;
8958 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
8959 eassert (indec
.start
<= indec
.end
);
8960 eassert (fkey
.start
<= fkey
.end
);
8961 eassert (keytran
.start
<= keytran
.end
);
8962 /* key-translation-map is applied *after* function-key-map
8963 which is itself applied *after* input-decode-map. */
8964 eassert (fkey
.end
<= indec
.start
);
8965 eassert (keytran
.end
<= fkey
.start
);
8967 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
8968 first_unbound
< keytran
.start
)
8969 { /* The prefix upto first_unbound has no binding and has
8970 no translation left to do either, so we know it's unbound.
8971 If we don't stop now, we risk staying here indefinitely
8972 (if the user keeps entering fkey or keytran prefixes
8973 like C-c ESC ESC ESC ESC ...) */
8975 for (i
= first_unbound
+ 1; i
< t
; i
++)
8976 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
8977 mock_input
= t
- first_unbound
- 1;
8978 indec
.end
= indec
.start
-= first_unbound
+ 1;
8979 indec
.map
= indec
.parent
;
8980 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
8981 fkey
.map
= fkey
.parent
;
8982 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
8983 keytran
.map
= keytran
.parent
;
8984 goto replay_sequence
;
8988 error ("Key sequence too long");
8991 echo_local_start
= echo_length ();
8992 keys_local_start
= this_command_key_count
;
8995 /* These are no-ops, unless we throw away a keystroke below and
8996 jumped back up to replay_key; in that case, these restore the
8997 variables to their original state, allowing us to replay the
8999 if (INTERACTIVE
&& t
< mock_input
)
9000 echo_truncate (echo_local_start
);
9001 this_command_key_count
= keys_local_start
;
9003 /* By default, assume each event is "real". */
9004 last_real_key_start
= t
;
9006 /* Does mock_input indicate that we are re-reading a key sequence? */
9010 add_command_key (key
);
9011 if (current_kboard
->immediate_echo
)
9013 /* Set immediate_echo to false so as to force echo_now to
9014 redisplay (it will set immediate_echo right back to true). */
9015 current_kboard
->immediate_echo
= false;
9020 /* If not, we should actually read a character. */
9024 KBOARD
*interrupted_kboard
= current_kboard
;
9025 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9026 /* Calling read_char with COMMANDFLAG = -2 avoids
9027 redisplay in read_char and its subroutines. */
9028 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9029 current_binding
, last_nonmenu_event
,
9030 &used_mouse_menu
, NULL
);
9031 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9032 /* When switching to a new tty (with a new keyboard),
9033 read_char returns the new buffer, rather than -2
9034 (Bug#5095). This is because `terminal-init-xterm'
9035 calls read-char, which eats the wrong_kboard_jmpbuf
9036 return. Any better way to fix this? -- cyd */
9037 || (interrupted_kboard
!= current_kboard
))
9042 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9043 if (k
== interrupted_kboard
)
9048 /* Don't touch interrupted_kboard when it's been
9050 delayed_switch_frame
= Qnil
;
9051 goto replay_entire_sequence
;
9054 if (!NILP (delayed_switch_frame
))
9057 (interrupted_kboard
,
9058 Fcons (delayed_switch_frame
,
9059 KVAR (interrupted_kboard
, kbd_queue
)));
9060 delayed_switch_frame
= Qnil
;
9065 (interrupted_kboard
,
9066 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9068 /* If the side queue is non-empty, ensure it begins with a
9069 switch-frame, so we'll replay it in the right context. */
9070 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9071 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9072 !(EVENT_HAS_PARAMETERS (key
)
9073 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9077 XSETFRAME (frame
, interrupted_frame
);
9079 (interrupted_kboard
,
9080 Fcons (make_lispy_switch_frame (frame
),
9081 KVAR (interrupted_kboard
, kbd_queue
)));
9084 goto replay_entire_sequence
;
9088 /* read_char returns t when it shows a menu and the user rejects it.
9092 unbind_to (count
, Qnil
);
9096 /* read_char returns -1 at the end of a macro.
9097 Emacs 18 handles this by returning immediately with a
9098 zero, so that's what we'll do. */
9099 if (INTEGERP (key
) && XINT (key
) == -1)
9102 /* The Microsoft C compiler can't handle the goto that
9108 /* If the current buffer has been changed from under us, the
9109 keymap may have changed, so replay the sequence. */
9112 timer_resume_idle ();
9115 /* Reset the current buffer from the selected window
9116 in case something changed the former and not the latter.
9117 This is to be more consistent with the behavior
9118 of the command_loop_1. */
9119 if (fix_current_buffer
)
9121 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9123 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9125 Fset_buffer (XWINDOW (selected_window
)->contents
);
9128 goto replay_sequence
;
9131 /* If we have a quit that was typed in another frame, and
9132 quit_throw_to_read_char switched buffers,
9133 replay to get the right keymap. */
9135 && XINT (key
) == quit_char
9136 && current_buffer
!= starting_buffer
)
9139 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9144 goto replay_sequence
;
9149 if (EVENT_HAS_PARAMETERS (key
)
9150 /* Either a `switch-frame' or a `select-window' event. */
9151 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9153 /* If we're at the beginning of a key sequence, and the caller
9154 says it's okay, go ahead and return this event. If we're
9155 in the midst of a key sequence, delay it until the end. */
9156 if (t
> 0 || !can_return_switch_frame
)
9158 delayed_switch_frame
= key
;
9163 if (NILP (first_event
))
9166 /* Even if first_event does not specify a particular
9167 window/position, it's important to recompute the maps here
9168 since a long time might have passed since we entered
9169 read_key_sequence, and a timer (or process-filter or
9170 special-event-map, ...) might have switched the current buffer
9171 or the selected window from under us in the mean time. */
9172 if (fix_current_buffer
9173 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9175 Fset_buffer (XWINDOW (selected_window
)->contents
);
9176 current_binding
= active_maps (first_event
);
9180 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9184 /* Clicks in non-text areas get prefixed by the symbol
9185 in their CHAR-ADDRESS field. For example, a click on
9186 the mode line is prefixed by the symbol `mode-line'.
9188 Furthermore, key sequences beginning with mouse clicks
9189 are read using the keymaps of the buffer clicked on, not
9190 the current buffer. So we may have to switch the buffer
9193 When we turn one event into two events, we must make sure
9194 that neither of the two looks like the original--so that,
9195 if we replay the events, they won't be expanded again.
9196 If not for this, such reexpansion could happen either here
9197 or when user programs play with this-command-keys. */
9198 if (EVENT_HAS_PARAMETERS (key
))
9200 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9201 if (EQ (kind
, Qmouse_click
))
9203 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9204 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9207 || (!NILP (fake_prefixed_keys
)
9208 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9210 /* We're looking a second time at an event for which
9211 we generated a fake prefix key. Set
9212 last_real_key_start appropriately. */
9214 last_real_key_start
= t
- 1;
9217 if (last_real_key_start
== 0)
9219 /* Key sequences beginning with mouse clicks are
9220 read using the keymaps in the buffer clicked on,
9221 not the current buffer. If we're at the
9222 beginning of a key sequence, switch buffers. */
9223 if (WINDOWP (window
)
9224 && BUFFERP (XWINDOW (window
)->contents
)
9225 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9227 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9232 /* Arrange to go back to the original buffer once we're
9233 done reading the key sequence. Note that we can't
9234 use save_excursion_{save,restore} here, because they
9235 save point as well as the current buffer; we don't
9236 want to save point, because redisplay may change it,
9237 to accommodate a Fset_window_start or something. We
9238 don't want to do this at the top of the function,
9239 because we may get input from a subprocess which
9240 wants to change the selected window and stuff (say,
9242 record_unwind_current_buffer ();
9244 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9246 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9247 goto replay_sequence
;
9251 /* Expand mode-line and scroll-bar events into two events:
9252 use posn as a fake prefix key. */
9254 && (NILP (fake_prefixed_keys
)
9255 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9257 if (bufsize
- t
<= 1)
9258 error ("Key sequence too long");
9261 keybuf
[t
+ 1] = key
;
9264 /* Record that a fake prefix key has been generated
9265 for KEY. Don't modify the event; this would
9266 prevent proper action when the event is pushed
9267 back into unread-command-events. */
9268 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9272 else if (CONSP (XCDR (key
))
9273 && CONSP (EVENT_START (key
))
9274 && CONSP (XCDR (EVENT_START (key
))))
9278 posn
= POSN_POSN (EVENT_START (key
));
9279 /* Handle menu-bar events:
9280 insert the dummy prefix event `menu-bar'. */
9281 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9283 if (bufsize
- t
<= 1)
9284 error ("Key sequence too long");
9286 keybuf
[t
+ 1] = key
;
9288 /* Zap the position in key, so we know that we've
9289 expanded it, and don't try to do so again. */
9290 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9293 goto replay_sequence
;
9295 else if (CONSP (posn
))
9297 /* We're looking at the second event of a
9298 sequence which we expanded before. Set
9299 last_real_key_start appropriately. */
9300 if (last_real_key_start
== t
&& t
> 0)
9301 last_real_key_start
= t
- 1;
9306 /* We have finally decided that KEY is something we might want
9308 new_binding
= follow_key (current_binding
, key
);
9310 /* If KEY wasn't bound, we'll try some fallbacks. */
9311 if (!NILP (new_binding
))
9312 /* This is needed for the following scenario:
9313 event 0: a down-event that gets dropped by calling replay_key.
9314 event 1: some normal prefix like C-h.
9315 After event 0, first_unbound is 0, after event 1 indec.start,
9316 fkey.start, and keytran.start are all 1, so when we see that
9317 C-h is bound, we need to update first_unbound. */
9318 first_unbound
= max (t
+ 1, first_unbound
);
9323 /* Remember the position to put an upper bound on indec.start. */
9324 first_unbound
= min (t
, first_unbound
);
9326 head
= EVENT_HEAD (key
);
9330 Lisp_Object breakdown
;
9333 breakdown
= parse_modifiers (head
);
9334 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9335 /* Attempt to reduce an unbound mouse event to a simpler
9336 event that is bound:
9337 Drags reduce to clicks.
9338 Double-clicks reduce to clicks.
9339 Triple-clicks reduce to double-clicks, then to clicks.
9340 Up/Down-clicks are eliminated.
9341 Double-downs reduce to downs, then are eliminated.
9342 Triple-downs reduce to double-downs, then to downs,
9343 then are eliminated. */
9344 if (modifiers
& (up_modifier
| down_modifier
9346 | double_modifier
| triple_modifier
))
9348 while (modifiers
& (up_modifier
| down_modifier
9350 | double_modifier
| triple_modifier
))
9352 Lisp_Object new_head
, new_click
;
9353 if (modifiers
& triple_modifier
)
9354 modifiers
^= (double_modifier
| triple_modifier
);
9355 else if (modifiers
& double_modifier
)
9356 modifiers
&= ~double_modifier
;
9357 else if (modifiers
& drag_modifier
)
9358 modifiers
&= ~drag_modifier
;
9361 /* Dispose of this `up/down' event by simply jumping
9362 back to replay_key, to get another event.
9364 Note that if this event came from mock input,
9365 then just jumping back to replay_key will just
9366 hand it to us again. So we have to wipe out any
9369 We could delete keybuf[t] and shift everything
9370 after that to the left by one spot, but we'd also
9371 have to fix up any variable that points into
9372 keybuf, and shifting isn't really necessary
9375 Adding prefixes for non-textual mouse clicks
9376 creates two characters of mock input, and both
9377 must be thrown away. If we're only looking at
9378 the prefix now, we can just jump back to
9379 replay_key. On the other hand, if we've already
9380 processed the prefix, and now the actual click
9381 itself is giving us trouble, then we've lost the
9382 state of the keymaps we want to backtrack to, and
9383 we need to replay the whole sequence to rebuild
9386 Beyond that, only function key expansion could
9387 create more than two keys, but that should never
9388 generate mouse events, so it's okay to zero
9389 mock_input in that case too.
9391 FIXME: The above paragraph seems just plain
9392 wrong, if you consider things like
9393 xterm-mouse-mode. -stef
9395 Isn't this just the most wonderful code ever? */
9397 /* If mock_input > t + 1, the above simplification
9398 will actually end up dropping keys on the floor.
9399 This is probably OK for now, but even
9400 if mock_input <= t + 1, we need to adjust indec,
9402 Typical case [header-line down-mouse-N]:
9403 mock_input = 2, t = 1, fkey.end = 1,
9404 last_real_key_start = 0. */
9405 if (indec
.end
> last_real_key_start
)
9407 indec
.end
= indec
.start
9408 = min (last_real_key_start
, indec
.start
);
9409 indec
.map
= indec
.parent
;
9410 if (fkey
.end
> last_real_key_start
)
9412 fkey
.end
= fkey
.start
9413 = min (last_real_key_start
, fkey
.start
);
9414 fkey
.map
= fkey
.parent
;
9415 if (keytran
.end
> last_real_key_start
)
9417 keytran
.end
= keytran
.start
9418 = min (last_real_key_start
, keytran
.start
);
9419 keytran
.map
= keytran
.parent
;
9423 if (t
== last_real_key_start
)
9430 mock_input
= last_real_key_start
;
9431 goto replay_sequence
;
9436 = apply_modifiers (modifiers
, XCAR (breakdown
));
9437 new_click
= list2 (new_head
, EVENT_START (key
));
9439 /* Look for a binding for this new key. */
9440 new_binding
= follow_key (current_binding
, new_click
);
9442 /* If that click is bound, go for it. */
9443 if (!NILP (new_binding
))
9445 current_binding
= new_binding
;
9449 /* Otherwise, we'll leave key set to the drag event. */
9454 current_binding
= new_binding
;
9457 /* Normally, last_nonmenu_event gets the previous key we read.
9458 But when a mouse popup menu is being used,
9459 we don't update last_nonmenu_event; it continues to hold the mouse
9460 event that preceded the first level of menu. */
9461 if (!used_mouse_menu
)
9462 last_nonmenu_event
= key
;
9464 /* Record what part of this_command_keys is the current key sequence. */
9465 this_single_command_key_start
= this_command_key_count
- t
;
9466 /* When 'input-method-function' called above causes events to be
9467 put on 'unread-post-input-method-events', and as result
9468 'reread' is set to 'true', the value of 't' can become larger
9469 than 'this_command_key_count', because 'add_command_key' is
9470 not called to update 'this_command_key_count'. If this
9471 happens, 'this_single_command_key_start' will become negative
9472 above, and any call to 'this-single-command-keys' will return
9473 a garbled vector. See bug #20223 for one such situation.
9474 Here we force 'this_single_command_key_start' to never become
9475 negative, to avoid that. */
9476 if (this_single_command_key_start
< 0)
9477 this_single_command_key_start
= 0;
9479 /* Look for this sequence in input-decode-map.
9480 Scan from indec.end until we find a bound suffix. */
9481 while (indec
.end
< t
)
9486 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9490 mock_input
= diff
+ max (t
, mock_input
);
9491 goto replay_sequence
;
9495 if (!KEYMAPP (current_binding
)
9496 && !test_undefined (current_binding
)
9497 && indec
.start
>= t
)
9498 /* There is a binding and it's not a prefix.
9499 (and it doesn't have any input-decode-map translation pending).
9500 There is thus no function-key in this sequence.
9501 Moving fkey.start is important in this case to allow keytran.start
9502 to go over the sequence before we return (since we keep the
9503 invariant that keytran.end <= fkey.start). */
9506 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9509 /* If the sequence is unbound, see if we can hang a function key
9510 off the end of it. */
9511 /* Continue scan from fkey.end until we find a bound suffix. */
9512 while (fkey
.end
< indec
.start
)
9517 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9518 max (t
, mock_input
),
9519 /* If there's a binding (i.e.
9520 first_binding >= nmaps) we don't want
9521 to apply this function-key-mapping. */
9523 && (test_undefined (current_binding
)),
9527 mock_input
= diff
+ max (t
, mock_input
);
9528 /* Adjust the input-decode-map counters. */
9530 indec
.start
+= diff
;
9532 goto replay_sequence
;
9536 /* Look for this sequence in key-translation-map.
9537 Scan from keytran.end until we find a bound suffix. */
9538 while (keytran
.end
< fkey
.start
)
9543 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9547 mock_input
= diff
+ max (t
, mock_input
);
9548 /* Adjust the function-key-map and input-decode-map counters. */
9550 indec
.start
+= diff
;
9554 goto replay_sequence
;
9558 /* If KEY is not defined in any of the keymaps,
9559 and cannot be part of a function key or translation,
9560 and is an upper case letter
9561 use the corresponding lower-case letter instead. */
9562 if (NILP (current_binding
)
9563 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9565 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9566 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9567 || (XINT (key
) & shift_modifier
)))
9569 Lisp_Object new_key
;
9571 original_uppercase
= key
;
9572 original_uppercase_position
= t
- 1;
9574 if (XINT (key
) & shift_modifier
)
9575 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9577 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9578 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9580 /* We have to do this unconditionally, regardless of whether
9581 the lower-case char is defined in the keymaps, because they
9582 might get translated through function-key-map. */
9583 keybuf
[t
- 1] = new_key
;
9584 mock_input
= max (t
, mock_input
);
9585 shift_translated
= true;
9587 goto replay_sequence
;
9590 if (NILP (current_binding
)
9591 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9593 read_key_sequence_cmd
= Vprefix_help_command
;
9594 /* The Microsoft C compiler can't handle the goto that
9600 /* If KEY is not defined in any of the keymaps,
9601 and cannot be part of a function key or translation,
9602 and is a shifted function key,
9603 use the corresponding unshifted function key instead. */
9604 if (NILP (current_binding
)
9605 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9607 Lisp_Object breakdown
= parse_modifiers (key
);
9609 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9611 if (modifiers
& shift_modifier
9612 /* Treat uppercase keys as shifted. */
9614 && (KEY_TO_CHAR (key
)
9615 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9616 && uppercasep (KEY_TO_CHAR (key
))))
9619 = (modifiers
& shift_modifier
9620 ? apply_modifiers (modifiers
& ~shift_modifier
,
9622 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9624 original_uppercase
= key
;
9625 original_uppercase_position
= t
- 1;
9627 /* We have to do this unconditionally, regardless of whether
9628 the lower-case char is defined in the keymaps, because they
9629 might get translated through function-key-map. */
9630 keybuf
[t
- 1] = new_key
;
9631 mock_input
= max (t
, mock_input
);
9632 /* Reset fkey (and consequently keytran) to apply
9633 function-key-map on the result, so that S-backspace is
9634 correctly mapped to DEL (via backspace). OTOH,
9635 input-decode-map doesn't need to go through it again. */
9636 fkey
.start
= fkey
.end
= 0;
9637 keytran
.start
= keytran
.end
= 0;
9638 shift_translated
= true;
9640 goto replay_sequence
;
9645 read_key_sequence_cmd
= current_binding
;
9646 read_key_sequence_remapped
9647 /* Remap command through active keymaps.
9648 Do the remapping here, before the unbind_to so it uses the keymaps
9649 of the appropriate buffer. */
9650 = SYMBOLP (read_key_sequence_cmd
)
9651 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9654 unread_switch_frame
= delayed_switch_frame
;
9655 unbind_to (count
, Qnil
);
9657 /* Don't downcase the last character if the caller says don't.
9658 Don't downcase it if the result is undefined, either. */
9659 if ((dont_downcase_last
|| NILP (current_binding
))
9661 && t
- 1 == original_uppercase_position
)
9663 keybuf
[t
- 1] = original_uppercase
;
9664 shift_translated
= false;
9667 if (shift_translated
)
9668 Vthis_command_keys_shift_translated
= Qt
;
9670 /* Occasionally we fabricate events, perhaps by expanding something
9671 according to function-key-map, or by adding a prefix symbol to a
9672 mouse click in the scroll bar or modeline. In this cases, return
9673 the entire generated key sequence, even if we hit an unbound
9674 prefix or a definition before the end. This means that you will
9675 be able to push back the event properly, and also means that
9676 read-key-sequence will always return a logical unit.
9679 for (; t
< mock_input
; t
++)
9680 add_command_key (keybuf
[t
]);
9687 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9688 Lisp_Object dont_downcase_last
,
9689 Lisp_Object can_return_switch_frame
,
9690 Lisp_Object cmd_loop
, bool allow_string
)
9692 Lisp_Object keybuf
[30];
9694 ptrdiff_t count
= SPECPDL_INDEX ();
9697 CHECK_STRING (prompt
);
9700 specbind (Qinput_method_exit_on_first_char
,
9701 (NILP (cmd_loop
) ? Qt
: Qnil
));
9702 specbind (Qinput_method_use_echo_area
,
9703 (NILP (cmd_loop
) ? Qt
: Qnil
));
9705 if (NILP (continue_echo
))
9707 this_command_key_count
= 0;
9708 this_single_command_key_start
= 0;
9711 #ifdef HAVE_WINDOW_SYSTEM
9712 if (display_hourglass_p
)
9713 cancel_hourglass ();
9716 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9717 prompt
, ! NILP (dont_downcase_last
),
9718 ! NILP (can_return_switch_frame
), 0, 0);
9720 #if 0 /* The following is fine for code reading a key sequence and
9721 then proceeding with a lengthy computation, but it's not good
9722 for code reading keys in a loop, like an input method. */
9723 #ifdef HAVE_WINDOW_SYSTEM
9724 if (display_hourglass_p
)
9735 return unbind_to (count
,
9736 ((allow_string
? make_event_array
: Fvector
)
9740 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9741 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9742 The sequence is sufficient to specify a non-prefix command in the
9743 current local and global maps.
9745 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9746 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9747 as a continuation of the previous key.
9749 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9750 convert the last event to lower case. (Normally any upper case event
9751 is converted to lower case if the original event is undefined and the lower
9752 case equivalent is defined.) A non-nil value is appropriate for reading
9753 a key sequence to be defined.
9755 A C-g typed while in this function is treated like any other character,
9756 and `quit-flag' is not set.
9758 If the key sequence starts with a mouse click, then the sequence is read
9759 using the keymaps of the buffer of the window clicked in, not the buffer
9760 of the selected window as normal.
9762 `read-key-sequence' drops unbound button-down events, since you normally
9763 only care about the click or drag events which follow them. If a drag
9764 or multi-click event is unbound, but the corresponding click event would
9765 be bound, `read-key-sequence' turns the event into a click event at the
9766 drag's starting position. This means that you don't have to distinguish
9767 between click and drag, double, or triple events unless you want to.
9769 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9770 lines separating windows, and scroll bars with imaginary keys
9771 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9773 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9774 function will process a switch-frame event if the user switches frames
9775 before typing anything. If the user switches frames in the middle of a
9776 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9777 is nil, then the event will be put off until after the current key sequence.
9779 `read-key-sequence' checks `function-key-map' for function key
9780 sequences, where they wouldn't conflict with ordinary bindings. See
9781 `function-key-map' for more details.
9783 The optional fifth argument CMD-LOOP, if non-nil, means
9784 that this key sequence is being read by something that will
9785 read commands one after another. It should be nil if the caller
9786 will read just one key sequence. */)
9787 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9789 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9790 can_return_switch_frame
, cmd_loop
, true);
9793 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9794 Sread_key_sequence_vector
, 1, 5, 0,
9795 doc
: /* Like `read-key-sequence' but always return a vector. */)
9796 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9798 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9799 can_return_switch_frame
, cmd_loop
, false);
9802 /* Return true if input events are pending. */
9805 detect_input_pending (void)
9807 return input_pending
|| get_input_pending (0);
9810 /* Return true if input events other than mouse movements are
9814 detect_input_pending_ignore_squeezables (void)
9816 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9819 /* Return true if input events are pending, and run any pending timers. */
9822 detect_input_pending_run_timers (bool do_display
)
9824 unsigned old_timers_run
= timers_run
;
9827 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9829 if (old_timers_run
!= timers_run
&& do_display
)
9830 redisplay_preserve_echo_area (8);
9832 return input_pending
;
9835 /* This is called in some cases before a possible quit.
9836 It cases the next call to detect_input_pending to recompute input_pending.
9837 So calling this function unnecessarily can't do any harm. */
9840 clear_input_pending (void)
9842 input_pending
= false;
9845 /* Return true if there are pending requeued events.
9846 This isn't used yet. The hope is to make wait_reading_process_output
9847 call it, and return if it runs Lisp code that unreads something.
9848 The problem is, kbd_buffer_get_event needs to be fixed to know what
9849 to do in that case. It isn't trivial. */
9852 requeued_events_pending_p (void)
9854 return (!NILP (Vunread_command_events
));
9857 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9858 doc
: /* Return t if command input is currently available with no wait.
9859 Actually, the value is nil only if we can be sure that no input is available;
9860 if there is a doubt, the value is t.
9862 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9863 (Lisp_Object check_timers
)
9865 if (!NILP (Vunread_command_events
)
9866 || !NILP (Vunread_post_input_method_events
)
9867 || !NILP (Vunread_input_method_events
))
9870 /* Process non-user-visible events (Bug#10195). */
9871 process_special_events ();
9873 return (get_input_pending ((NILP (check_timers
)
9874 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9875 | READABLE_EVENTS_FILTER_EVENTS
)
9879 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 1, 0,
9880 doc
: /* Return vector of last few events, not counting those from keyboard macros.
9881 If INCLUDE-CMDS is non-nil, include the commands that were run,
9882 represented as events of the form (nil . COMMAND). */)
9883 (Lisp_Object include_cmds
)
9885 bool cmds
= !NILP (include_cmds
);
9888 || (cmds
&& total_keys
< NUM_RECENT_KEYS
))
9889 return Fvector (total_keys
,
9890 XVECTOR (recent_keys
)->contents
);
9893 Lisp_Object es
= Qnil
;
9894 int i
= (total_keys
< NUM_RECENT_KEYS
9895 ? 0 : recent_keys_index
);
9896 eassert (recent_keys_index
< NUM_RECENT_KEYS
);
9899 Lisp_Object e
= AREF (recent_keys
, i
);
9900 if (cmds
|| !CONSP (e
) || !NILP (XCAR (e
)))
9902 if (++i
>= NUM_RECENT_KEYS
)
9904 } while (i
!= recent_keys_index
);
9905 es
= Fnreverse (es
);
9906 return Fvconcat (1, &es
);
9910 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9911 doc
: /* Return the key sequence that invoked this command.
9912 However, if the command has called `read-key-sequence', it returns
9913 the last key sequence that has been read.
9914 The value is a string or a vector.
9916 See also `this-command-keys-vector'. */)
9919 return make_event_array (this_command_key_count
,
9920 XVECTOR (this_command_keys
)->contents
);
9923 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9924 doc
: /* Return the key sequence that invoked this command, as a vector.
9925 However, if the command has called `read-key-sequence', it returns
9926 the last key sequence that has been read.
9928 See also `this-command-keys'. */)
9931 return Fvector (this_command_key_count
,
9932 XVECTOR (this_command_keys
)->contents
);
9935 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9936 Sthis_single_command_keys
, 0, 0, 0,
9937 doc
: /* Return the key sequence that invoked this command.
9938 More generally, it returns the last key sequence read, either by
9939 the command loop or by `read-key-sequence'.
9940 Unlike `this-command-keys', this function's value
9941 does not include prefix arguments.
9942 The value is always a vector. */)
9945 return Fvector (this_command_key_count
9946 - this_single_command_key_start
,
9947 (XVECTOR (this_command_keys
)->contents
9948 + this_single_command_key_start
));
9951 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9952 Sthis_single_command_raw_keys
, 0, 0, 0,
9953 doc
: /* Return the raw events that were read for this command.
9954 More generally, it returns the last key sequence read, either by
9955 the command loop or by `read-key-sequence'.
9956 Unlike `this-single-command-keys', this function's value
9957 shows the events before all translations (except for input methods).
9958 The value is always a vector. */)
9961 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
9964 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
9965 Sclear_this_command_keys
, 0, 1, 0,
9966 doc
: /* Clear out the vector that `this-command-keys' returns.
9967 Also clear the record of the last 100 events, unless optional arg
9968 KEEP-RECORD is non-nil. */)
9969 (Lisp_Object keep_record
)
9973 this_command_key_count
= 0;
9975 if (NILP (keep_record
))
9977 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
9978 ASET (recent_keys
, i
, Qnil
);
9980 recent_keys_index
= 0;
9985 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
9986 doc
: /* Return the current depth in recursive edits. */)
9990 /* Wrap around reliably on integer overflow. */
9991 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
9992 XSETINT (temp
, sum
);
9996 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
9997 "FOpen dribble file: ",
9998 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
9999 If FILE is nil, close any open dribble file.
10000 The file will be closed when Emacs exits.
10002 Be aware that this records ALL characters you type!
10003 This may include sensitive information such as passwords. */)
10016 Lisp_Object encfile
;
10018 file
= Fexpand_file_name (file
, Qnil
);
10019 encfile
= ENCODE_FILE (file
);
10020 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10021 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10022 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10023 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10025 report_file_error ("Opening dribble", file
);
10030 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10031 doc
: /* Discard the contents of the terminal input buffer.
10032 Also end any kbd macro being defined. */)
10035 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10037 /* Discard the last command from the macro. */
10038 Fcancel_kbd_macro_events ();
10042 Vunread_command_events
= Qnil
;
10044 discard_tty_input ();
10046 kbd_fetch_ptr
= kbd_store_ptr
;
10047 input_pending
= false;
10052 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10053 doc
: /* Stop Emacs and return to superior process. You can resume later.
10054 If `cannot-suspend' is non-nil, or if the system doesn't support job
10055 control, run a subshell instead.
10057 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10058 to be read as terminal input by Emacs's parent, after suspension.
10060 Before suspending, run the normal hook `suspend-hook'.
10061 After resumption run the normal hook `suspend-resume-hook'.
10063 Some operating systems cannot stop the Emacs process and resume it later.
10064 On such systems, Emacs starts a subshell instead of suspending. */)
10065 (Lisp_Object stuffstring
)
10067 ptrdiff_t count
= SPECPDL_INDEX ();
10068 int old_height
, old_width
;
10071 if (tty_list
&& tty_list
->next
)
10072 error ("There are other tty frames open; close them before suspending Emacs");
10074 if (!NILP (stuffstring
))
10075 CHECK_STRING (stuffstring
);
10077 run_hook (intern ("suspend-hook"));
10079 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10080 reset_all_sys_modes ();
10081 /* sys_suspend can get an error if it tries to fork a subshell
10082 and the system resources aren't available for that. */
10083 record_unwind_protect_void (init_all_sys_modes
);
10084 stuff_buffered_input (stuffstring
);
10085 if (cannot_suspend
)
10089 unbind_to (count
, Qnil
);
10091 /* Check if terminal/window size has changed.
10092 Note that this is not useful when we are running directly
10093 with a window system; but suspend should be disabled in that case. */
10094 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10095 if (width
!= old_width
|| height
!= old_height
)
10096 change_frame_size (SELECTED_FRAME (), width
,
10097 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10100 run_hook (intern ("suspend-resume-hook"));
10105 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10106 Then in any case stuff anything Emacs has read ahead and not used. */
10109 stuff_buffered_input (Lisp_Object stuffstring
)
10111 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10112 register unsigned char *p
;
10114 if (STRINGP (stuffstring
))
10116 register ptrdiff_t count
;
10118 p
= SDATA (stuffstring
);
10119 count
= SBYTES (stuffstring
);
10120 while (count
-- > 0)
10125 /* Anything we have read ahead, put back for the shell to read. */
10126 /* ?? What should this do when we have multiple keyboards??
10127 Should we ignore anything that was typed in at the "wrong" kboard?
10129 rms: we should stuff everything back into the kboard
10131 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10134 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10135 kbd_fetch_ptr
= kbd_buffer
;
10136 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10137 stuff_char (kbd_fetch_ptr
->ie
.code
);
10139 clear_event (kbd_fetch_ptr
);
10142 input_pending
= false;
10143 #endif /* SIGTSTP */
10147 set_waiting_for_input (struct timespec
*time_to_clear
)
10149 input_available_clear_time
= time_to_clear
;
10151 /* Tell handle_interrupt to throw back to read_char, */
10152 waiting_for_input
= true;
10154 /* If handle_interrupt was called before and buffered a C-g,
10155 make it run again now, to avoid timing error. */
10156 if (!NILP (Vquit_flag
))
10157 quit_throw_to_read_char (0);
10161 clear_waiting_for_input (void)
10163 /* Tell handle_interrupt not to throw back to read_char, */
10164 waiting_for_input
= false;
10165 input_available_clear_time
= 0;
10168 /* The SIGINT handler.
10170 If we have a frame on the controlling tty, we assume that the
10171 SIGINT was generated by C-g, so we call handle_interrupt.
10172 Otherwise, tell QUIT to kill Emacs. */
10175 handle_interrupt_signal (int sig
)
10177 /* See if we have an active terminal on our controlling tty. */
10178 struct terminal
*terminal
= get_named_terminal ("/dev/tty");
10181 /* If there are no frames there, let's pretend that we are a
10182 well-behaving UN*X program and quit. We must not call Lisp
10183 in a signal handler, so tell QUIT to exit when it is
10185 Vquit_flag
= Qkill_emacs
;
10189 /* Otherwise, the SIGINT was probably generated by C-g. */
10191 /* Set internal_last_event_frame to the top frame of the
10192 controlling tty, if we have a frame there. We disable the
10193 interrupt key on secondary ttys, so the SIGINT must have come
10194 from the controlling tty. */
10195 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10197 handle_interrupt (1);
10202 deliver_interrupt_signal (int sig
)
10204 deliver_process_signal (sig
, handle_interrupt_signal
);
10208 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10209 of the number of times C-g has been requested. If C-g is pressed
10210 enough times, then quit anyway. See bug#6585. */
10211 static int volatile force_quit_count
;
10213 /* This routine is called at interrupt level in response to C-g.
10215 It is called from the SIGINT handler or kbd_buffer_store_event.
10217 If `waiting_for_input' is non zero, then unless `echoing' is
10218 nonzero, immediately throw back to read_char.
10220 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10221 eval to throw, when it gets a chance. If quit-flag is already
10222 non-nil, it stops the job right away. */
10225 handle_interrupt (bool in_signal_handler
)
10231 /* XXX This code needs to be revised for multi-tty support. */
10232 if (!NILP (Vquit_flag
) && get_named_terminal ("/dev/tty"))
10234 if (! in_signal_handler
)
10236 /* If SIGINT isn't blocked, don't let us be interrupted by
10237 a SIGINT. It might be harmful due to non-reentrancy
10238 in I/O functions. */
10240 sigemptyset (&blocked
);
10241 sigaddset (&blocked
, SIGINT
);
10242 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10246 reset_all_sys_modes ();
10250 * On systems which can suspend the current process and return to the original
10251 * shell, this command causes the user to end up back at the shell.
10252 * The "Auto-save" and "Abort" questions are not asked until
10253 * the user elects to return to emacs, at which point he can save the current
10254 * job and either dump core or continue.
10258 /* Perhaps should really fork an inferior shell?
10259 But that would not provide any way to get back
10260 to the original shell, ever. */
10261 printf ("No support for stopping a process on this operating system;\n");
10262 printf ("you can continue or abort.\n");
10263 #endif /* not SIGTSTP */
10265 /* We must remain inside the screen area when the internal terminal
10266 is used. Note that [Enter] is not echoed by dos. */
10267 cursor_to (SELECTED_FRAME (), 0, 0);
10269 /* It doesn't work to autosave while GC is in progress;
10270 the code used for auto-saving doesn't cope with the mark bit. */
10271 if (!gc_in_progress
)
10273 printf ("Auto-save? (y or n) ");
10275 if (((c
= getchar ()) & ~040) == 'Y')
10277 Fdo_auto_save (Qt
, Qnil
);
10279 printf ("\r\nAuto-save done");
10280 #else /* not MSDOS */
10281 printf ("Auto-save done\n");
10282 #endif /* not MSDOS */
10284 while (c
!= '\n') c
= getchar ();
10288 /* During GC, it must be safe to reenable quitting again. */
10289 Vinhibit_quit
= Qnil
;
10292 #endif /* not MSDOS */
10293 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10294 printf ("but will instead do a real quit after garbage collection ends\r\n");
10299 printf ("\r\nAbort? (y or n) ");
10300 #else /* not MSDOS */
10301 printf ("Abort (and dump core)? (y or n) ");
10302 #endif /* not MSDOS */
10304 if (((c
= getchar ()) & ~040) == 'Y')
10306 while (c
!= '\n') c
= getchar ();
10308 printf ("\r\nContinuing...\r\n");
10309 #else /* not MSDOS */
10310 printf ("Continuing...\n");
10311 #endif /* not MSDOS */
10313 init_all_sys_modes ();
10317 /* If executing a function that wants to be interrupted out of
10318 and the user has not deferred quitting by binding `inhibit-quit'
10319 then quit right away. */
10320 if (immediate_quit
&& NILP (Vinhibit_quit
))
10322 struct gl_state_s saved
;
10324 immediate_quit
= false;
10325 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10327 Fsignal (Qquit
, Qnil
);
10331 { /* Else request quit when it's safe. */
10332 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10333 force_quit_count
= count
;
10336 immediate_quit
= true;
10337 Vinhibit_quit
= Qnil
;
10343 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10345 /* TODO: The longjmp in this call throws the NS event loop integration off,
10346 and it seems to do fine without this. Probably some attention
10347 needs to be paid to the setting of waiting_for_input in
10348 wait_reading_process_output() under HAVE_NS because of the call
10349 to ns_select there (needed because otherwise events aren't picked up
10350 outside of polling since we don't get SIGIO like X and we don't have a
10351 separate event loop thread like W32. */
10353 if (waiting_for_input
&& !echoing
)
10354 quit_throw_to_read_char (in_signal_handler
);
10358 /* Handle a C-g by making read_char return C-g. */
10361 quit_throw_to_read_char (bool from_signal
)
10363 /* When not called from a signal handler it is safe to call
10365 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10366 Fkill_emacs (Qnil
);
10368 /* Prevent another signal from doing this before we finish. */
10369 clear_waiting_for_input ();
10370 input_pending
= false;
10372 Vunread_command_events
= Qnil
;
10374 if (FRAMEP (internal_last_event_frame
)
10375 && !EQ (internal_last_event_frame
, selected_frame
))
10376 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10379 sys_longjmp (getcjmp
, 1);
10382 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10383 Sset_input_interrupt_mode
, 1, 1, 0,
10384 doc
: /* Set interrupt mode of reading keyboard input.
10385 If INTERRUPT is non-nil, Emacs will use input interrupts;
10386 otherwise Emacs uses CBREAK mode.
10388 See also `current-input-mode'. */)
10389 (Lisp_Object interrupt
)
10391 bool new_interrupt_input
;
10392 #ifdef USABLE_SIGIO
10393 #ifdef HAVE_X_WINDOWS
10394 if (x_display_list
!= NULL
)
10396 /* When using X, don't give the user a real choice,
10397 because we haven't implemented the mechanisms to support it. */
10398 new_interrupt_input
= true;
10401 #endif /* HAVE_X_WINDOWS */
10402 new_interrupt_input
= !NILP (interrupt
);
10403 #else /* not USABLE_SIGIO */
10404 new_interrupt_input
= false;
10405 #endif /* not USABLE_SIGIO */
10407 if (new_interrupt_input
!= interrupt_input
)
10409 #ifdef POLL_FOR_INPUT
10413 /* this causes startup screen to be restored and messes with the mouse */
10414 reset_all_sys_modes ();
10415 interrupt_input
= new_interrupt_input
;
10416 init_all_sys_modes ();
10418 interrupt_input
= new_interrupt_input
;
10421 #ifdef POLL_FOR_INPUT
10422 poll_suppress_count
= 1;
10429 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10430 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10431 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10432 C-q in key sequences.
10434 This setting only has an effect on tty terminals and only when
10435 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10437 See also `current-input-mode'. */)
10438 (Lisp_Object flow
, Lisp_Object terminal
)
10440 struct terminal
*t
= decode_tty_terminal (terminal
);
10441 struct tty_display_info
*tty
;
10445 tty
= t
->display_info
.tty
;
10447 if (tty
->flow_control
!= !NILP (flow
))
10450 /* This causes startup screen to be restored and messes with the mouse. */
10451 reset_sys_modes (tty
);
10454 tty
->flow_control
= !NILP (flow
);
10457 init_sys_modes (tty
);
10463 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10464 doc
: /* Enable or disable 8-bit input on TERMINAL.
10465 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10466 bit as the Meta modifier.
10468 If META is nil, Emacs will ignore the top bit, on the assumption it is
10471 Otherwise, Emacs will accept and pass through 8-bit input without
10472 specially interpreting the top bit.
10474 This setting only has an effect on tty terminal devices.
10476 Optional parameter TERMINAL specifies the tty terminal device to use.
10477 It may be a terminal object, a frame, or nil for the terminal used by
10478 the currently selected frame.
10480 See also `current-input-mode'. */)
10481 (Lisp_Object meta
, Lisp_Object terminal
)
10483 struct terminal
*t
= decode_tty_terminal (terminal
);
10484 struct tty_display_info
*tty
;
10489 tty
= t
->display_info
.tty
;
10493 else if (EQ (meta
, Qt
))
10498 if (tty
->meta_key
!= new_meta
)
10501 /* this causes startup screen to be restored and messes with the mouse */
10502 reset_sys_modes (tty
);
10505 tty
->meta_key
= new_meta
;
10508 init_sys_modes (tty
);
10514 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10515 doc
: /* Specify character used for quitting.
10516 QUIT must be an ASCII character.
10518 This function only has an effect on the controlling tty of the Emacs
10521 See also `current-input-mode'. */)
10524 struct terminal
*t
= get_named_terminal ("/dev/tty");
10525 struct tty_display_info
*tty
;
10529 tty
= t
->display_info
.tty
;
10531 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10532 error ("QUIT must be an ASCII character");
10535 /* this causes startup screen to be restored and messes with the mouse */
10536 reset_sys_modes (tty
);
10539 /* Don't let this value be out of range. */
10540 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10543 init_sys_modes (tty
);
10549 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10550 doc
: /* Set mode of reading keyboard input.
10551 First arg INTERRUPT non-nil means use input interrupts;
10552 nil means use CBREAK mode.
10553 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10554 (no effect except in CBREAK mode).
10555 Third arg META t means accept 8-bit input (for a Meta key).
10556 META nil means ignore the top bit, on the assumption it is parity.
10557 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10558 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10559 See also `current-input-mode'. */)
10560 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10562 Fset_input_interrupt_mode (interrupt
);
10563 Fset_output_flow_control (flow
, Qnil
);
10564 Fset_input_meta_mode (meta
, Qnil
);
10566 Fset_quit_char (quit
);
10570 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10571 doc
: /* Return information about the way Emacs currently reads keyboard input.
10572 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10573 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10574 nil, Emacs is using CBREAK mode.
10575 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10576 terminal; this does not apply if Emacs uses interrupt-driven input.
10577 META is t if accepting 8-bit input with 8th bit as Meta flag.
10578 META nil means ignoring the top bit, on the assumption it is parity.
10579 META is neither t nor nil if accepting 8-bit input and using
10580 all 8 bits as the character code.
10581 QUIT is the character Emacs currently uses to quit.
10582 The elements of this list correspond to the arguments of
10583 `set-input-mode'. */)
10586 struct frame
*sf
= XFRAME (selected_frame
);
10588 Lisp_Object interrupt
= interrupt_input
? Qt
: Qnil
;
10589 Lisp_Object flow
, meta
;
10590 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10592 flow
= FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10593 meta
= (FRAME_TTY (sf
)->meta_key
== 2
10595 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10602 Lisp_Object quit
= make_number (quit_char
);
10604 return list4 (interrupt
, flow
, meta
, quit
);
10607 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10608 doc
: /* Return position information for pixel coordinates X and Y.
10609 By default, X and Y are relative to text area of the selected window.
10610 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10611 If optional fourth arg WHOLE is non-nil, X is relative to the left
10612 edge of the window.
10614 The return value is similar to a mouse click position:
10615 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10616 IMAGE (DX . DY) (WIDTH . HEIGHT))
10617 The `posn-' functions access elements of such lists. */)
10618 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10621 /* We allow X of -1, for the newline in a R2L line that overflowed
10622 into the left fringe. */
10623 if (XINT (x
) != -1)
10627 if (NILP (frame_or_window
))
10628 frame_or_window
= selected_window
;
10630 if (WINDOWP (frame_or_window
))
10632 struct window
*w
= decode_live_window (frame_or_window
);
10634 XSETINT (x
, (XINT (x
)
10635 + WINDOW_LEFT_EDGE_X (w
)
10637 ? window_box_left_offset (w
, TEXT_AREA
)
10639 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10640 frame_or_window
= w
->frame
;
10643 CHECK_LIVE_FRAME (frame_or_window
);
10645 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10648 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10649 doc
: /* Return position information for buffer POS in WINDOW.
10650 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10652 Return nil if position is not visible in window. Otherwise,
10653 the return value is similar to that returned by `event-start' for
10654 a mouse click at the upper left corner of the glyph corresponding
10655 to the given buffer position:
10656 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10657 IMAGE (DX . DY) (WIDTH . HEIGHT))
10658 The `posn-' functions access elements of such lists. */)
10659 (Lisp_Object pos
, Lisp_Object window
)
10664 window
= selected_window
;
10666 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10669 Lisp_Object x
= XCAR (tem
);
10670 Lisp_Object y
= XCAR (XCDR (tem
));
10672 /* Point invisible due to hscrolling? X can be -1 when a
10673 newline in a R2L line overflows into the left fringe. */
10676 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10682 /* Set up a new kboard object with reasonable initial values.
10683 TYPE is a window system for which this keyboard is used. */
10686 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10688 kset_overriding_terminal_local_map (kb
, Qnil
);
10689 kset_last_command (kb
, Qnil
);
10690 kset_real_last_command (kb
, Qnil
);
10691 kset_keyboard_translate_table (kb
, Qnil
);
10692 kset_last_repeatable_command (kb
, Qnil
);
10693 kset_prefix_arg (kb
, Qnil
);
10694 kset_last_prefix_arg (kb
, Qnil
);
10695 kset_kbd_queue (kb
, Qnil
);
10696 kb
->kbd_queue_has_data
= false;
10697 kb
->immediate_echo
= false;
10698 kset_echo_string (kb
, Qnil
);
10699 kset_echo_prompt (kb
, Qnil
);
10700 kb
->kbd_macro_buffer
= 0;
10701 kb
->kbd_macro_bufsize
= 0;
10702 kset_defining_kbd_macro (kb
, Qnil
);
10703 kset_last_kbd_macro (kb
, Qnil
);
10704 kb
->reference_count
= 0;
10705 kset_system_key_alist (kb
, Qnil
);
10706 kset_system_key_syms (kb
, Qnil
);
10707 kset_window_system (kb
, type
);
10708 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10709 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10710 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10711 kset_default_minibuffer_frame (kb
, Qnil
);
10714 /* Allocate and basically initialize keyboard
10715 object to use with window system TYPE. */
10718 allocate_kboard (Lisp_Object type
)
10720 KBOARD
*kb
= xmalloc (sizeof *kb
);
10722 init_kboard (kb
, type
);
10723 kb
->next_kboard
= all_kboards
;
10729 * Destroy the contents of a kboard object, but not the object itself.
10730 * We use this just before deleting it, or if we're going to initialize
10731 * it a second time.
10734 wipe_kboard (KBOARD
*kb
)
10736 xfree (kb
->kbd_macro_buffer
);
10739 /* Free KB and memory referenced from it. */
10742 delete_kboard (KBOARD
*kb
)
10746 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10749 *kbp
= kb
->next_kboard
;
10751 /* Prevent a dangling reference to KB. */
10752 if (kb
== current_kboard
10753 && FRAMEP (selected_frame
)
10754 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10756 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10757 single_kboard
= false;
10758 if (current_kboard
== kb
)
10767 init_keyboard (void)
10769 /* This is correct before outermost invocation of the editor loop. */
10770 command_loop_level
= -1;
10771 immediate_quit
= false;
10772 quit_char
= Ctl ('g');
10773 Vunread_command_events
= Qnil
;
10774 timer_idleness_start_time
= invalid_timespec ();
10776 recent_keys_index
= 0;
10777 kbd_fetch_ptr
= kbd_buffer
;
10778 kbd_store_ptr
= kbd_buffer
;
10779 do_mouse_tracking
= Qnil
;
10780 input_pending
= false;
10781 interrupt_input_blocked
= 0;
10782 pending_signals
= false;
10784 /* This means that command_loop_1 won't try to select anything the first
10786 internal_last_event_frame
= Qnil
;
10787 Vlast_event_frame
= internal_last_event_frame
;
10789 current_kboard
= initial_kboard
;
10790 /* Re-initialize the keyboard again. */
10791 wipe_kboard (current_kboard
);
10792 /* A value of nil for Vwindow_system normally means a tty, but we also use
10793 it for the initial terminal since there is no window system there. */
10794 init_kboard (current_kboard
, Qnil
);
10796 if (!noninteractive
)
10798 /* Before multi-tty support, these handlers used to be installed
10799 only if the current session was a tty session. Now an Emacs
10800 session may have multiple display types, so we always handle
10801 SIGINT. There is special code in handle_interrupt_signal to exit
10802 Emacs on SIGINT when there are no termcap frames on the
10803 controlling terminal. */
10804 struct sigaction action
;
10805 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10806 sigaction (SIGINT
, &action
, 0);
10808 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10809 SIGQUIT and we can't tell which one it will give us. */
10810 sigaction (SIGQUIT
, &action
, 0);
10811 #endif /* not DOS_NT */
10813 #ifdef USABLE_SIGIO
10814 if (!noninteractive
)
10816 struct sigaction action
;
10817 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10818 sigaction (SIGIO
, &action
, 0);
10822 /* Use interrupt input by default, if it works and noninterrupt input
10823 has deficiencies. */
10825 #ifdef INTERRUPT_INPUT
10826 interrupt_input
= 1;
10828 interrupt_input
= 0;
10831 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10834 if (keyboard_init_hook
)
10835 (*keyboard_init_hook
) ();
10837 #ifdef POLL_FOR_INPUT
10839 poll_suppress_count
= 1;
10844 /* This type's only use is in syms_of_keyboard, to put properties on the
10845 event header symbols. */
10852 static const struct event_head head_table
[] = {
10853 {SYMBOL_INDEX (Qmouse_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10854 {SYMBOL_INDEX (Qscroll_bar_movement
), SYMBOL_INDEX (Qmouse_movement
)},
10856 /* Some of the event heads. */
10857 {SYMBOL_INDEX (Qswitch_frame
), SYMBOL_INDEX (Qswitch_frame
)},
10859 {SYMBOL_INDEX (Qfocus_in
), SYMBOL_INDEX (Qfocus_in
)},
10860 {SYMBOL_INDEX (Qfocus_out
), SYMBOL_INDEX (Qfocus_out
)},
10861 {SYMBOL_INDEX (Qdelete_frame
), SYMBOL_INDEX (Qdelete_frame
)},
10862 {SYMBOL_INDEX (Qiconify_frame
), SYMBOL_INDEX (Qiconify_frame
)},
10863 {SYMBOL_INDEX (Qmake_frame_visible
), SYMBOL_INDEX (Qmake_frame_visible
)},
10864 /* `select-window' should be handled just like `switch-frame'
10865 in read_key_sequence. */
10866 {SYMBOL_INDEX (Qselect_window
), SYMBOL_INDEX (Qswitch_frame
)}
10870 syms_of_keyboard (void)
10872 pending_funcalls
= Qnil
;
10873 staticpro (&pending_funcalls
);
10875 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10876 staticpro (&Vlispy_mouse_stem
);
10878 regular_top_level_message
= build_pure_c_string ("Back to top level");
10879 #ifdef HAVE_STACK_OVERFLOW_HANDLING
10880 recover_top_level_message
10881 = build_pure_c_string ("Re-entering top level after C stack overflow");
10883 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
10884 doc
: /* Message displayed by `normal-top-level'. */);
10885 Vinternal__top_level_message
= regular_top_level_message
;
10888 DEFSYM (QCimage
, ":image");
10889 DEFSYM (Qhelp_echo
, "help-echo");
10890 DEFSYM (QCrtl
, ":rtl");
10892 staticpro (&item_properties
);
10893 item_properties
= Qnil
;
10895 staticpro (&tool_bar_item_properties
);
10896 tool_bar_item_properties
= Qnil
;
10897 staticpro (&tool_bar_items_vector
);
10898 tool_bar_items_vector
= Qnil
;
10900 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10902 /* Non-nil disable property on a command means do not execute it;
10903 call disabled-command-function's value instead. */
10904 DEFSYM (Qdisabled
, "disabled");
10906 DEFSYM (Qundefined
, "undefined");
10908 /* Hooks to run before and after each command. */
10909 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10910 DEFSYM (Qpost_command_hook
, "post-command-hook");
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. */);
11378 Vpre_command_hook
= Qnil
;
11380 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11381 doc
: /* Normal hook run after each command is executed.
11382 If an unhandled error happens in running this hook,
11383 the function in which the error occurred is unconditionally removed, since
11384 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11385 Vpost_command_hook
= Qnil
;
11388 DEFVAR_LISP ("echo-area-clear-hook", ...,
11389 doc
: /* Normal hook run when clearing the echo area. */);
11391 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11392 Fset (Qecho_area_clear_hook
, Qnil
);
11394 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11395 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11396 Vlucid_menu_bar_dirty_flag
= Qnil
;
11398 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11399 doc
: /* List of menu bar items to move to the end of the menu bar.
11400 The elements of the list are event types that may have menu bar bindings. */);
11401 Vmenu_bar_final_items
= Qnil
;
11403 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11404 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11405 This is used internally by graphical displays that do not render
11406 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11407 Vtool_bar_separator_image_expression
= Qnil
;
11409 DEFVAR_KBOARD ("overriding-terminal-local-map",
11410 Voverriding_terminal_local_map
,
11411 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11412 This variable is intended to let commands such as `universal-argument'
11413 set up a different keymap for reading the next command.
11415 `overriding-terminal-local-map' has a separate binding for each
11416 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11418 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11419 doc
: /* Keymap that replaces (overrides) local keymaps.
11420 If this variable is non-nil, Emacs looks up key bindings in this
11421 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11422 buffer's local map. Hence, the only active keymaps would be
11423 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11424 order of precedence. */);
11425 Voverriding_local_map
= Qnil
;
11427 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11428 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11429 Otherwise, the menu bar continues to reflect the buffer's local map
11430 and the minor mode maps regardless of `overriding-local-map'. */);
11431 Voverriding_local_map_menu_flag
= Qnil
;
11433 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11434 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11435 Vspecial_event_map
= list1 (Qkeymap
);
11437 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11438 doc
: /* Non-nil means generate motion events for mouse motion. */);
11440 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11441 doc
: /* Alist of system-specific X windows key symbols.
11442 Each element should have the form (N . SYMBOL) where N is the
11443 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11444 and SYMBOL is its name.
11446 `system-key-alist' has a separate binding for each terminal device.
11447 See Info node `(elisp)Multiple Terminals'. */);
11449 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11450 doc
: /* Keymap that translates key sequences to key sequences during input.
11451 This is used mainly for mapping key sequences into some preferred
11452 key events (symbols).
11454 The `read-key-sequence' function replaces any subsequence bound by
11455 `local-function-key-map' with its binding. More precisely, when the
11456 active keymaps have no binding for the current key sequence but
11457 `local-function-key-map' binds a suffix of the sequence to a vector or
11458 string, `read-key-sequence' replaces the matching suffix with its
11459 binding, and continues with the new sequence.
11461 If the binding is a function, it is called with one argument (the prompt)
11462 and its return value (a key sequence) is used.
11464 The events that come from bindings in `local-function-key-map' are not
11465 themselves looked up in `local-function-key-map'.
11467 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11468 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11469 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11470 typing `ESC O P x' would return [f1 x].
11472 `local-function-key-map' has a separate binding for each terminal
11473 device. See Info node `(elisp)Multiple Terminals'. If you need to
11474 define a binding on all terminals, change `function-key-map'
11475 instead. Initially, `local-function-key-map' is an empty keymap that
11476 has `function-key-map' as its parent on all terminal devices. */);
11478 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11479 doc
: /* Keymap that decodes input escape sequences.
11480 This is used mainly for mapping ASCII function key sequences into
11481 real Emacs function key events (symbols).
11483 The `read-key-sequence' function replaces any subsequence bound by
11484 `input-decode-map' with its binding. Contrary to `function-key-map',
11485 this map applies its rebinding regardless of the presence of an ordinary
11486 binding. So it is more like `key-translation-map' except that it applies
11487 before `function-key-map' rather than after.
11489 If the binding is a function, it is called with one argument (the prompt)
11490 and its return value (a key sequence) is used.
11492 The events that come from bindings in `input-decode-map' are not
11493 themselves looked up in `input-decode-map'. */);
11495 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11496 doc
: /* The parent keymap of all `local-function-key-map' instances.
11497 Function key definitions that apply to all terminal devices should go
11498 here. If a mapping is defined in both the current
11499 `local-function-key-map' binding and this variable, then the local
11500 definition will take precedence. */);
11501 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11503 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11504 doc
: /* Keymap of key translations that can override keymaps.
11505 This keymap works like `input-decode-map', but comes after `function-key-map'.
11506 Another difference is that it is global rather than terminal-local. */);
11507 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11509 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11510 doc
: /* List of deferred actions to be performed at a later time.
11511 The precise format isn't relevant here; we just check whether it is nil. */);
11512 Vdeferred_action_list
= Qnil
;
11514 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11515 doc
: /* Function to call to handle deferred actions, after each command.
11516 This function is called with no arguments after each command
11517 whenever `deferred-action-list' is non-nil. */);
11518 Vdeferred_action_function
= Qnil
;
11520 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11521 doc
: /* List of warnings to be displayed after this command.
11522 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11523 as per the args of `display-warning' (which see).
11524 If this variable is non-nil, `delayed-warnings-hook' will be run
11525 immediately after running `post-command-hook'. */);
11526 Vdelayed_warnings_list
= Qnil
;
11528 DEFVAR_LISP ("timer-list", Vtimer_list
,
11529 doc
: /* List of active absolute time timers in order of increasing time. */);
11530 Vtimer_list
= Qnil
;
11532 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11533 doc
: /* List of active idle-time timers in order of increasing time. */);
11534 Vtimer_idle_list
= Qnil
;
11536 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11537 doc
: /* If non-nil, the function that implements the current input method.
11538 It's called with one argument, a printing character that was just read.
11539 (That means a character with code 040...0176.)
11540 Typically this function uses `read-event' to read additional events.
11541 When it does so, it should first bind `input-method-function' to nil
11542 so it will not be called recursively.
11544 The function should return a list of zero or more events
11545 to be used as input. If it wants to put back some events
11546 to be reconsidered, separately, by the input method,
11547 it can add them to the beginning of `unread-command-events'.
11549 The input method function can find in `input-method-previous-message'
11550 the previous echo area message.
11552 The input method function should refer to the variables
11553 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11554 for guidance on what to do. */);
11555 Vinput_method_function
= Qlist
;
11557 DEFVAR_LISP ("input-method-previous-message",
11558 Vinput_method_previous_message
,
11559 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11560 This variable exists because `read-event' clears the echo area
11561 before running the input method. It is nil if there was no message. */);
11562 Vinput_method_previous_message
= Qnil
;
11564 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11565 doc
: /* If non-nil, the function that implements the display of help.
11566 It's called with one argument, the help string to display. */);
11567 Vshow_help_function
= Qnil
;
11569 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11570 doc
: /* If non-nil, suppress point adjustment after executing a command.
11572 After a command is executed, if point is moved into a region that has
11573 special properties (e.g. composition, display), we adjust point to
11574 the boundary of the region. But, when a command sets this variable to
11575 non-nil, we suppress the point adjustment.
11577 This variable is set to nil before reading a command, and is checked
11578 just after executing the command. */);
11579 Vdisable_point_adjustment
= Qnil
;
11581 DEFVAR_LISP ("global-disable-point-adjustment",
11582 Vglobal_disable_point_adjustment
,
11583 doc
: /* If non-nil, always suppress point adjustment.
11585 The default value is nil, in which case, point adjustment are
11586 suppressed only after special commands that set
11587 `disable-point-adjustment' (which see) to non-nil. */);
11588 Vglobal_disable_point_adjustment
= Qnil
;
11590 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11591 doc
: /* How long to display an echo-area message when the minibuffer is active.
11592 If the value is not a number, such messages don't time out. */);
11593 Vminibuffer_message_timeout
= make_number (2);
11595 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11596 doc
: /* If non-nil, any keyboard input throws to this symbol.
11597 The value of that variable is passed to `quit-flag' and later causes a
11598 peculiar kind of quitting. */);
11599 Vthrow_on_input
= Qnil
;
11601 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11602 doc
: /* Function to output error messages.
11603 Called with three arguments:
11604 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11605 such as what `condition-case' would bind its variable to,
11606 - the context (a string which normally goes at the start of the message),
11607 - the Lisp function within which the error was signaled. */);
11608 Vcommand_error_function
= intern ("command-error-default-function");
11610 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11611 Venable_disabled_menus_and_buttons
,
11612 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11614 Help functions bind this to allow help on disabled menu items
11615 and tool-bar buttons. */);
11616 Venable_disabled_menus_and_buttons
= Qnil
;
11618 DEFVAR_LISP ("select-active-regions",
11619 Vselect_active_regions
,
11620 doc
: /* If non-nil, an active region automatically sets the primary selection.
11621 If the value is `only', only temporarily active regions (usually made
11622 by mouse-dragging or shift-selection) set the window selection.
11624 This takes effect only when Transient Mark mode is enabled. */);
11625 Vselect_active_regions
= Qt
;
11627 DEFVAR_LISP ("saved-region-selection",
11628 Vsaved_region_selection
,
11629 doc
: /* Contents of active region prior to buffer modification.
11630 If `select-active-regions' is non-nil, Emacs sets this to the
11631 text in the region before modifying the buffer. The next call to
11632 the function `deactivate-mark' uses this to set the window selection. */);
11633 Vsaved_region_selection
= Qnil
;
11635 DEFVAR_LISP ("selection-inhibit-update-commands",
11636 Vselection_inhibit_update_commands
,
11637 doc
: /* List of commands which should not update the selection.
11638 Normally, if `select-active-regions' is non-nil and the mark remains
11639 active after a command (i.e. the mark was not deactivated), the Emacs
11640 command loop sets the selection to the text in the region. However,
11641 if the command is in this list, the selection is not updated. */);
11642 Vselection_inhibit_update_commands
11643 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11645 DEFVAR_LISP ("debug-on-event",
11647 doc
: /* Enter debugger on this event. When Emacs
11648 receives the special event specified by this variable, it will try to
11649 break into the debugger as soon as possible instead of processing the
11650 event normally through `special-event-map'.
11652 Currently, the only supported values for this
11653 variable are `sigusr1' and `sigusr2'. */);
11654 Vdebug_on_event
= intern_c_string ("sigusr2");
11656 /* Create the initial keyboard. Qt means 'unset'. */
11657 initial_kboard
= allocate_kboard (Qt
);
11661 keys_of_keyboard (void)
11663 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11664 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11665 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11666 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11667 initial_define_key (meta_map
, 'x', "execute-extended-command");
11669 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11670 "handle-delete-frame");
11671 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11672 "ns-put-working-text");
11673 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11674 "ns-unput-working-text");
11675 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11676 current-prefix-arg, as is done in `handle-switch-frame'.
11677 But `handle-switch-frame is not run from the special-map.
11678 Commands from that map are run in a special way that automatically
11679 preserves the prefix-arg. Restoring the prefix arg here is not just
11680 redundant but harmful:
11682 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11683 - after the first prompt, the exit-minibuffer-hook is run which may
11684 iconify a frame and thus push a `iconify-frame' event.
11685 - after running exit-minibuffer-hook, current-prefix-arg is
11686 restored to the non-nil value it had before the prompt.
11687 - we enter the second prompt.
11688 current-prefix-arg is non-nil, prefix-arg is nil.
11689 - before running the first real event, we run the special iconify-frame
11690 event, but we pass the `special' arg to command-execute so
11691 current-prefix-arg and prefix-arg are left untouched.
11692 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11693 - the next key event will have a spuriously non-nil current-prefix-arg. */
11694 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11696 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11698 /* Handling it at such a low-level causes read_key_sequence to get
11699 * confused because it doesn't realize that the current_buffer was
11700 * changed by read_char.
11702 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11703 * "handle-select-window"); */
11704 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11705 "handle-save-session");
11708 /* Define a special event which is raised for dbus callback
11710 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11711 "dbus-handle-event");
11714 #ifdef USE_FILE_NOTIFY
11715 /* Define a special event which is raised for notification callback
11717 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11718 "file-notify-handle-event");
11719 #endif /* USE_FILE_NOTIFY */
11721 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11723 #if defined (WINDOWSNT)
11724 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11727 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11728 "handle-focus-in");
11729 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11730 "handle-focus-out");
11733 /* Mark the pointers in the kboard objects.
11734 Called by Fgarbage_collect. */
11736 mark_kboards (void)
11740 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11742 if (kb
->kbd_macro_buffer
)
11743 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11745 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11746 mark_object (KVAR (kb
, Vlast_command
));
11747 mark_object (KVAR (kb
, Vreal_last_command
));
11748 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11749 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11750 mark_object (KVAR (kb
, Vprefix_arg
));
11751 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11752 mark_object (KVAR (kb
, kbd_queue
));
11753 mark_object (KVAR (kb
, defining_kbd_macro
));
11754 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11755 mark_object (KVAR (kb
, Vsystem_key_alist
));
11756 mark_object (KVAR (kb
, system_key_syms
));
11757 mark_object (KVAR (kb
, Vwindow_system
));
11758 mark_object (KVAR (kb
, Vinput_decode_map
));
11759 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11760 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11761 mark_object (KVAR (kb
, echo_string
));
11762 mark_object (KVAR (kb
, echo_prompt
));
11765 union buffered_input_event
*event
;
11766 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11768 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11769 event
= kbd_buffer
;
11770 /* These two special event types has no Lisp_Objects to mark. */
11771 if (event
->kind
!= SELECTION_REQUEST_EVENT
11772 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11774 mark_object (event
->ie
.x
);
11775 mark_object (event
->ie
.y
);
11776 mark_object (event
->ie
.frame_or_window
);
11777 mark_object (event
->ie
.arg
);