1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2014 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/>. */
29 #include "termhooks.h"
34 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #if defined USABLE_FIONREAD && defined USG5_4
59 # include <sys/filio.h>
62 #include "syssignal.h"
64 #include <sys/types.h>
68 #ifdef HAVE_WINDOW_SYSTEM
70 #endif /* HAVE_WINDOW_SYSTEM */
72 /* Variables for blockinput.h: */
74 /* Positive if interrupt input is blocked right now. */
75 volatile int interrupt_input_blocked
;
77 /* True means an input interrupt or alarm signal has arrived.
78 The QUIT macro checks this. */
79 volatile bool pending_signals
;
81 #define KBD_BUFFER_SIZE 4096
83 KBOARD
*initial_kboard
;
84 KBOARD
*current_kboard
;
85 static KBOARD
*all_kboards
;
87 /* True in the single-kboard state, false in the any-kboard state. */
88 static bool single_kboard
;
90 /* Non-nil disable property on a command means
91 do not execute it; call disabled-command-function's value instead. */
92 Lisp_Object Qdisabled
;
93 static Lisp_Object Qdisabled_command_function
;
95 #define NUM_RECENT_KEYS (300)
97 /* Index for storing next element into recent_keys. */
98 static int recent_keys_index
;
100 /* Total number of elements stored into recent_keys. */
101 static int total_keys
;
103 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
104 static Lisp_Object recent_keys
;
106 /* Vector holding the key sequence that invoked the current command.
107 It is reused for each command, and it may be longer than the current
108 sequence; this_command_key_count indicates how many elements
109 actually mean something.
110 It's easier to staticpro a single Lisp_Object than an array. */
111 Lisp_Object this_command_keys
;
112 ptrdiff_t this_command_key_count
;
114 /* True after calling Freset_this_command_lengths.
115 Usually it is false. */
116 static bool this_command_key_count_reset
;
118 /* This vector is used as a buffer to record the events that were actually read
119 by read_key_sequence. */
120 static Lisp_Object raw_keybuf
;
121 static int raw_keybuf_count
;
123 #define GROW_RAW_KEYBUF \
124 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
125 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
127 /* Number of elements of this_command_keys
128 that precede this key sequence. */
129 static ptrdiff_t this_single_command_key_start
;
131 /* Record values of this_command_key_count and echo_length ()
132 before this command was read. */
133 static ptrdiff_t before_command_key_count
;
134 static ptrdiff_t before_command_echo_length
;
136 /* For longjmp to where kbd input is being done. */
138 static sys_jmp_buf getcjmp
;
140 /* True while doing kbd input. */
141 bool waiting_for_input
;
143 /* True while displaying for echoing. Delays C-g throwing. */
147 /* Non-null means we can start echoing at the next input pause even
148 though there is something in the echo area. */
150 static struct kboard
*ok_to_echo_at_next_pause
;
152 /* The kboard last echoing, or null for none. Reset to 0 in
153 cancel_echoing. If non-null, and a current echo area message
154 exists, and echo_message_buffer is eq to the current message
155 buffer, we know that the message comes from echo_kboard. */
157 struct kboard
*echo_kboard
;
159 /* The buffer used for echoing. Set in echo_now, reset in
162 Lisp_Object echo_message_buffer
;
164 /* True means C-g should cause immediate error-signal. */
167 /* Character that causes a quit. Normally C-g.
169 If we are running on an ordinary terminal, this must be an ordinary
170 ASCII char, since we want to make it our interrupt character.
172 If we are not running on an ordinary terminal, it still needs to be
173 an ordinary ASCII char. This character needs to be recognized in
174 the input interrupt handler. At this point, the keystroke is
175 represented as a struct input_event, while the desired quit
176 character is specified as a lispy event. The mapping from struct
177 input_events to lispy events cannot run in an interrupt handler,
178 and the reverse mapping is difficult for anything but ASCII
181 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
185 /* Current depth in recursive edits. */
186 EMACS_INT command_loop_level
;
188 /* If not Qnil, this is a switch-frame event which we decided to put
189 off until the end of a key sequence. This should be read as the
190 next command input, after any unread_command_events.
192 read_key_sequence uses this to delay switch-frame events until the
193 end of the key sequence; Fread_char uses it to put off switch-frame
194 events until a non-ASCII event is acceptable as input. */
195 Lisp_Object unread_switch_frame
;
197 /* Last size recorded for a current buffer which is not a minibuffer. */
198 static ptrdiff_t last_non_minibuf_size
;
200 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
201 uintmax_t num_input_events
;
203 /* Value of num_nonmacro_input_events as of last auto save. */
205 static EMACS_INT last_auto_save
;
207 /* The value of point when the last command was started. */
208 static ptrdiff_t last_point_position
;
210 /* The frame in which the last input event occurred, or Qmacro if the
211 last event came from a macro. We use this to determine when to
212 generate switch-frame events. This may be cleared by functions
213 like Fselect_frame, to make sure that a switch-frame event is
214 generated by the next character.
216 FIXME: This is modified by a signal handler so it should be volatile.
217 It's exported to Lisp, though, so it can't simply be marked
219 Lisp_Object internal_last_event_frame
;
221 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
222 static Lisp_Object Qhandle_select_window
;
223 Lisp_Object QPRIMARY
;
225 static Lisp_Object Qself_insert_command
;
226 static Lisp_Object Qforward_char
;
227 static Lisp_Object Qbackward_char
;
228 Lisp_Object Qundefined
;
229 static Lisp_Object Qtimer_event_handler
;
231 /* read_key_sequence stores here the command definition of the
232 key sequence that it reads. */
233 static Lisp_Object read_key_sequence_cmd
;
234 static Lisp_Object read_key_sequence_remapped
;
236 static Lisp_Object Qinput_method_function
;
238 static Lisp_Object Qdeactivate_mark
;
240 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
242 static Lisp_Object Qecho_area_clear_hook
;
244 /* Hooks to run before and after each command. */
245 static Lisp_Object Qpre_command_hook
;
246 static Lisp_Object Qpost_command_hook
;
248 static Lisp_Object Qdeferred_action_function
;
250 static Lisp_Object Qdelayed_warnings_hook
;
252 static Lisp_Object Qinput_method_exit_on_first_char
;
253 static Lisp_Object Qinput_method_use_echo_area
;
255 static Lisp_Object Qhelp_form_show
;
257 /* File in which we write all commands we read. */
258 static FILE *dribble
;
260 /* Nonzero if input is available. */
263 /* Circular buffer for pre-read keyboard input. */
265 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
267 /* Pointer to next available character in kbd_buffer.
268 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
269 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
270 next available char is in kbd_buffer[0]. */
271 static struct input_event
*kbd_fetch_ptr
;
273 /* Pointer to next place to store character in kbd_buffer. This
274 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
275 character should go in kbd_buffer[0]. */
276 static struct input_event
* volatile kbd_store_ptr
;
278 /* The above pair of variables forms a "queue empty" flag. When we
279 enqueue a non-hook event, we increment kbd_store_ptr. When we
280 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
281 there is input available if the two pointers are not equal.
283 Why not just have a flag set and cleared by the enqueuing and
284 dequeuing functions? Such a flag could be screwed up by interrupts
285 at inopportune times. */
287 /* Symbols to head events. */
288 static Lisp_Object Qmouse_movement
;
289 static Lisp_Object Qscroll_bar_movement
;
290 Lisp_Object Qswitch_frame
;
291 static Lisp_Object Qfocus_in
, Qfocus_out
;
292 static Lisp_Object Qdelete_frame
;
293 static Lisp_Object Qiconify_frame
;
294 static Lisp_Object Qmake_frame_visible
;
295 static Lisp_Object Qselect_window
;
296 Lisp_Object Qhelp_echo
;
298 static Lisp_Object Qmouse_fixup_help_message
;
300 /* Symbols to denote kinds of events. */
301 static Lisp_Object Qfunction_key
;
302 Lisp_Object Qmouse_click
;
304 Lisp_Object Qlanguage_change
;
306 static Lisp_Object Qdrag_n_drop
;
307 static Lisp_Object Qsave_session
;
309 static Lisp_Object Qdbus_event
;
311 #ifdef USE_FILE_NOTIFY
312 static Lisp_Object Qfile_notify
;
313 #endif /* USE_FILE_NOTIFY */
314 static Lisp_Object Qconfig_changed_event
;
316 /* Lisp_Object Qmouse_movement; - also an event header */
318 /* Properties of event headers. */
319 Lisp_Object Qevent_kind
;
320 static Lisp_Object Qevent_symbol_elements
;
322 /* Menu and tool bar item parts. */
323 static Lisp_Object Qmenu_enable
;
324 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
325 Lisp_Object QCfilter
;
327 /* Non-nil disable property on a command means
328 do not execute it; call disabled-command-function's value instead. */
329 Lisp_Object QCtoggle
, QCradio
;
330 static Lisp_Object QCbutton
, QClabel
;
332 static Lisp_Object QCvert_only
;
334 /* An event header symbol HEAD may have a property named
335 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
336 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
337 mask of modifiers applied to it. If present, this is used to help
338 speed up parse_modifiers. */
339 Lisp_Object Qevent_symbol_element_mask
;
341 /* An unmodified event header BASE may have a property named
342 Qmodifier_cache, which is an alist mapping modifier masks onto
343 modified versions of BASE. If present, this helps speed up
345 static Lisp_Object Qmodifier_cache
;
347 /* Symbols to use for parts of windows. */
348 Lisp_Object Qmode_line
;
349 Lisp_Object Qvertical_line
;
350 Lisp_Object Qright_divider
, Qbottom_divider
;
351 static Lisp_Object Qvertical_scroll_bar
;
352 Lisp_Object Qmenu_bar
;
354 static Lisp_Object Qecho_keystrokes
;
356 static void recursive_edit_unwind (Lisp_Object buffer
);
357 static Lisp_Object
command_loop (void);
358 static Lisp_Object Qcommand_execute
;
359 struct timespec
timer_check (void);
361 static void echo_now (void);
362 static ptrdiff_t echo_length (void);
364 static Lisp_Object Qpolling_period
;
366 /* Incremented whenever a timer is run. */
369 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
371 struct timespec
*input_available_clear_time
;
373 /* True means use SIGIO interrupts; false means use CBREAK mode.
374 Default is true if INTERRUPT_INPUT is defined. */
375 bool interrupt_input
;
377 /* Nonzero while interrupts are temporarily deferred during redisplay. */
378 bool interrupts_deferred
;
380 /* If we support a window system, turn on the code to poll periodically
381 to detect C-g. It isn't actually used when doing interrupt input. */
382 #ifdef HAVE_WINDOW_SYSTEM
383 #define POLL_FOR_INPUT
386 /* The time when Emacs started being idle. */
388 static struct timespec timer_idleness_start_time
;
390 /* After Emacs stops being idle, this saves the last value
391 of timer_idleness_start_time from when it was idle. */
393 static struct timespec timer_last_idleness_start_time
;
396 /* Global variable declarations. */
398 /* Flags for readable_events. */
399 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
400 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
401 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
403 /* Function for init_keyboard to call with no args (if nonzero). */
404 static void (*keyboard_init_hook
) (void);
406 static bool get_input_pending (int);
407 static bool readable_events (int);
408 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
409 Lisp_Object
, bool *);
410 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
411 static Lisp_Object
make_lispy_event (struct input_event
*);
412 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
413 enum scroll_bar_part
,
414 Lisp_Object
, Lisp_Object
,
416 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
417 Lisp_Object
, const char *const *,
418 Lisp_Object
*, ptrdiff_t);
419 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
420 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
421 #ifdef HAVE_WINDOW_SYSTEM
422 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
423 #endif /* HAVE_WINDOW_SYSTEM */
424 static bool help_char_p (Lisp_Object
);
425 static void save_getcjmp (sys_jmp_buf
);
426 static void restore_getcjmp (sys_jmp_buf
);
427 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
428 static void clear_event (struct input_event
*);
429 static void restore_kboard_configuration (int);
431 static void deliver_input_available_signal (int signo
);
433 static void handle_interrupt (bool);
434 static _Noreturn
void quit_throw_to_read_char (bool);
435 static void process_special_events (void);
436 static void timer_start_idle (void);
437 static void timer_stop_idle (void);
438 static void timer_resume_idle (void);
439 static void deliver_user_signal (int);
440 static char *find_user_signal_name (int);
441 static void store_user_signal_events (void);
443 /* These setters are used only in this file, so they can be private. */
445 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
447 kb
->INTERNAL_FIELD (echo_string
) = val
;
450 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
452 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
455 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
457 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
460 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
462 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
465 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
467 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
470 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
472 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
475 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
477 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
480 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
482 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
485 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
487 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
491 /* Add C to the echo string, without echoing it immediately. C can be
492 a character, which is pretty-printed, or a symbol, whose name is
496 echo_add_key (Lisp_Object c
)
498 int size
= KEY_DESCRIPTION_SIZE
+ 100;
499 char *buffer
= alloca (size
);
501 Lisp_Object echo_string
;
503 echo_string
= KVAR (current_kboard
, echo_string
);
505 /* If someone has passed us a composite event, use its head symbol. */
509 ptr
= push_key_description (XINT (c
), ptr
);
510 else if (SYMBOLP (c
))
512 Lisp_Object name
= SYMBOL_NAME (c
);
513 int nbytes
= SBYTES (name
);
515 if (size
- (ptr
- buffer
) < nbytes
)
517 int offset
= ptr
- buffer
;
518 size
= max (2 * size
, size
+ nbytes
);
519 buffer
= alloca (size
);
520 ptr
= buffer
+ offset
;
523 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
524 STRING_MULTIBYTE (name
), 1);
527 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
530 const char *text
= " (Type ? for further options)";
531 int len
= strlen (text
);
533 if (size
- (ptr
- buffer
) < len
)
535 int offset
= ptr
- buffer
;
537 buffer
= alloca (size
);
538 ptr
= buffer
+ offset
;
541 memcpy (ptr
, text
, len
);
545 /* Replace a dash from echo_dash with a space, otherwise add a space
546 at the end as a separator between keys. */
547 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
549 Lisp_Object last_char
, prev_char
, idx
;
551 idx
= make_number (SCHARS (echo_string
) - 2);
552 prev_char
= Faref (echo_string
, idx
);
554 idx
= make_number (SCHARS (echo_string
) - 1);
555 last_char
= Faref (echo_string
, idx
);
557 /* We test PREV_CHAR to make sure this isn't the echoing of a
559 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
560 Faset (echo_string
, idx
, make_number (' '));
562 echo_string
= concat2 (echo_string
, build_string (" "));
564 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
565 echo_string
= concat2 (echo_string
, build_string (" "));
569 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
572 /* Add C to the echo string, if echoing is going on. C can be a
573 character or a symbol. */
576 echo_char (Lisp_Object c
)
578 if (current_kboard
->immediate_echo
)
585 /* Temporarily add a dash to the end of the echo string if it's not
586 empty, so that it serves as a mini-prompt for the very next
592 /* Do nothing if not echoing at all. */
593 if (NILP (KVAR (current_kboard
, echo_string
)))
596 if (this_command_key_count
== 0)
599 if (!current_kboard
->immediate_echo
600 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
603 /* Do nothing if we just printed a prompt. */
604 if (current_kboard
->echo_after_prompt
605 == SCHARS (KVAR (current_kboard
, echo_string
)))
608 /* Do nothing if we have already put a dash at the end. */
609 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
611 Lisp_Object last_char
, prev_char
, idx
;
613 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
614 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
616 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
617 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
619 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
623 /* Put a dash at the end of the buffer temporarily,
624 but make it go away when the next character is added. */
627 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
631 /* Display the current echo string, and begin echoing if not already
637 if (!current_kboard
->immediate_echo
)
640 current_kboard
->immediate_echo
= 1;
642 for (i
= 0; i
< this_command_key_count
; i
++)
646 /* Set before_command_echo_length to the value that would
647 have been saved before the start of this subcommand in
648 command_loop_1, if we had already been echoing then. */
649 if (i
== this_single_command_key_start
)
650 before_command_echo_length
= echo_length ();
652 c
= AREF (this_command_keys
, i
);
653 if (! (EVENT_HAS_PARAMETERS (c
)
654 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
658 /* Set before_command_echo_length to the value that would
659 have been saved before the start of this subcommand in
660 command_loop_1, if we had already been echoing then. */
661 if (this_command_key_count
== this_single_command_key_start
)
662 before_command_echo_length
= echo_length ();
664 /* Put a dash at the end to invite the user to type more. */
669 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
670 message3_nolog (KVAR (current_kboard
, echo_string
));
673 /* Record in what buffer we echoed, and from which kboard. */
674 echo_message_buffer
= echo_area_buffer
[0];
675 echo_kboard
= current_kboard
;
677 if (waiting_for_input
&& !NILP (Vquit_flag
))
678 quit_throw_to_read_char (0);
681 /* Turn off echoing, for the start of a new command. */
684 cancel_echoing (void)
686 current_kboard
->immediate_echo
= 0;
687 current_kboard
->echo_after_prompt
= -1;
688 kset_echo_string (current_kboard
, Qnil
);
689 ok_to_echo_at_next_pause
= NULL
;
691 echo_message_buffer
= Qnil
;
694 /* Return the length of the current echo string. */
699 return (STRINGP (KVAR (current_kboard
, echo_string
))
700 ? SCHARS (KVAR (current_kboard
, echo_string
))
704 /* Truncate the current echo message to its first LEN chars.
705 This and echo_char get used by read_key_sequence when the user
706 switches frames while entering a key sequence. */
709 echo_truncate (ptrdiff_t nchars
)
711 if (STRINGP (KVAR (current_kboard
, echo_string
)))
712 kset_echo_string (current_kboard
,
713 Fsubstring (KVAR (current_kboard
, echo_string
),
714 make_number (0), make_number (nchars
)));
715 truncate_echo_area (nchars
);
719 /* Functions for manipulating this_command_keys. */
721 add_command_key (Lisp_Object key
)
723 #if 0 /* Not needed after we made Freset_this_command_lengths
724 do the job immediately. */
725 /* If reset-this-command-length was called recently, obey it now.
726 See the doc string of that function for an explanation of why. */
727 if (before_command_restore_flag
)
729 this_command_key_count
= before_command_key_count_1
;
730 if (this_command_key_count
< this_single_command_key_start
)
731 this_single_command_key_start
= this_command_key_count
;
732 echo_truncate (before_command_echo_length_1
);
733 before_command_restore_flag
= 0;
737 if (this_command_key_count
>= ASIZE (this_command_keys
))
738 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
740 ASET (this_command_keys
, this_command_key_count
, key
);
741 ++this_command_key_count
;
746 recursive_edit_1 (void)
748 ptrdiff_t count
= SPECPDL_INDEX ();
751 if (command_loop_level
> 0)
753 specbind (Qstandard_output
, Qt
);
754 specbind (Qstandard_input
, Qt
);
757 #ifdef HAVE_WINDOW_SYSTEM
758 /* The command loop has started an hourglass timer, so we have to
759 cancel it here, otherwise it will fire because the recursive edit
760 can take some time. Do not check for display_hourglass_p here,
761 because it could already be nil. */
765 /* This function may have been called from a debugger called from
766 within redisplay, for instance by Edebugging a function called
767 from fontification-functions. We want to allow redisplay in
768 the debugging session.
770 The recursive edit is left with a `(throw exit ...)'. The `exit'
771 tag is not caught anywhere in redisplay, i.e. when we leave the
772 recursive edit, the original redisplay leading to the recursive
773 edit will be unwound. The outcome should therefore be safe. */
774 specbind (Qinhibit_redisplay
, Qnil
);
777 val
= command_loop ();
779 Fsignal (Qquit
, Qnil
);
780 /* Handle throw from read_minibuf when using minibuffer
781 while it's active but we're in another window. */
783 xsignal1 (Qerror
, val
);
785 return unbind_to (count
, Qnil
);
788 /* When an auto-save happens, record the "time", and don't do again soon. */
791 record_auto_save (void)
793 last_auto_save
= num_nonmacro_input_events
;
796 /* Make an auto save happen as soon as possible at command level. */
800 force_auto_save_soon (void)
802 last_auto_save
= - auto_save_interval
- 1;
804 record_asynch_buffer_change ();
808 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
809 doc
: /* Invoke the editor command loop recursively.
810 To get out of the recursive edit, a command can throw to `exit' -- for
811 instance `(throw 'exit nil)'.
812 If you throw a value other than t, `recursive-edit' returns normally
813 to the function that called it. Throwing a t value causes
814 `recursive-edit' to quit, so that control returns to the command loop
817 This function is called by the editor initialization to begin editing. */)
820 ptrdiff_t count
= SPECPDL_INDEX ();
823 /* If we enter while input is blocked, don't lock up here.
824 This may happen through the debugger during redisplay. */
825 if (input_blocked_p ())
828 command_loop_level
++;
829 update_mode_lines
= 17;
831 if (command_loop_level
832 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
833 buffer
= Fcurrent_buffer ();
837 /* If we leave recursive_edit_1 below with a `throw' for instance,
838 like it is done in the splash screen display, we have to
839 make sure that we restore single_kboard as command_loop_1
840 would have done if it were left normally. */
841 if (command_loop_level
> 0)
842 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
843 record_unwind_protect (recursive_edit_unwind
, buffer
);
846 return unbind_to (count
, Qnil
);
850 recursive_edit_unwind (Lisp_Object buffer
)
852 if (BUFFERP (buffer
))
853 Fset_buffer (buffer
);
855 command_loop_level
--;
856 update_mode_lines
= 18;
860 #if 0 /* These two functions are now replaced with
861 temporarily_switch_to_single_kboard. */
865 #if 0 /* Theory: if there's anything in Vunread_command_events,
866 it will right away be read by read_key_sequence,
867 and then if we do switch KBOARDS, it will go into the side
868 queue then. So we don't need to do anything special here -- rms. */
869 if (CONSP (Vunread_command_events
))
871 current_kboard
->kbd_queue
872 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
873 current_kboard
->kbd_queue_has_data
= 1;
875 Vunread_command_events
= Qnil
;
880 /* Switch to the single-kboard state, making current_kboard
881 the only KBOARD from which further input is accepted. */
884 single_kboard_state ()
890 /* If we're in single_kboard state for kboard KBOARD,
894 not_single_kboard_state (KBOARD
*kboard
)
896 if (kboard
== current_kboard
)
900 /* Maintain a stack of kboards, so other parts of Emacs
901 can switch temporarily to the kboard of a given frame
902 and then revert to the previous status. */
907 struct kboard_stack
*next
;
910 static struct kboard_stack
*kboard_stack
;
913 push_kboard (struct kboard
*k
)
915 struct kboard_stack
*p
= xmalloc (sizeof *p
);
917 p
->next
= kboard_stack
;
918 p
->kboard
= current_kboard
;
928 struct kboard_stack
*p
= kboard_stack
;
930 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
932 if (t
->kboard
== p
->kboard
)
934 current_kboard
= p
->kboard
;
941 /* The terminal we remembered has been deleted. */
942 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
945 kboard_stack
= p
->next
;
949 /* Switch to single_kboard mode, making current_kboard the only KBOARD
950 from which further input is accepted. If F is non-nil, set its
951 KBOARD as the current keyboard.
953 This function uses record_unwind_protect_int to return to the previous
956 If Emacs is already in single_kboard mode, and F's keyboard is
957 locked, then this function will throw an error. */
960 temporarily_switch_to_single_kboard (struct frame
*f
)
962 bool was_locked
= single_kboard
;
965 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
966 /* We can not switch keyboards while in single_kboard mode.
967 In rare cases, Lisp code may call `recursive-edit' (or
968 `read-minibuffer' or `y-or-n-p') after it switched to a
969 locked frame. For example, this is likely to happen
970 when server.el connects to a new terminal while Emacs is in
971 single_kboard mode. It is best to throw an error instead
972 of presenting the user with a frozen screen. */
973 error ("Terminal %d is locked, cannot read from it",
974 FRAME_TERMINAL (f
)->id
);
976 /* This call is unnecessary, but helps
977 `restore_kboard_configuration' discover if somebody changed
978 `current_kboard' behind our back. */
979 push_kboard (current_kboard
);
982 current_kboard
= FRAME_KBOARD (f
);
984 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
987 #if 0 /* This function is not needed anymore. */
989 record_single_kboard_state ()
992 push_kboard (current_kboard
);
993 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
998 restore_kboard_configuration (int was_locked
)
1000 single_kboard
= was_locked
;
1003 struct kboard
*prev
= current_kboard
;
1005 /* The pop should not change the kboard. */
1006 if (single_kboard
&& current_kboard
!= prev
)
1012 /* Handle errors that are not handled at inner levels
1013 by printing an error message and returning to the editor command loop. */
1016 cmd_error (Lisp_Object data
)
1018 Lisp_Object old_level
, old_length
;
1019 char macroerror
[sizeof "After..kbd macro iterations: "
1020 + INT_STRLEN_BOUND (EMACS_INT
)];
1022 #ifdef HAVE_WINDOW_SYSTEM
1023 if (display_hourglass_p
)
1024 cancel_hourglass ();
1027 if (!NILP (executing_kbd_macro
))
1029 if (executing_kbd_macro_iterations
== 1)
1030 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1032 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1033 executing_kbd_macro_iterations
);
1038 Vstandard_output
= Qt
;
1039 Vstandard_input
= Qt
;
1040 Vexecuting_kbd_macro
= Qnil
;
1041 executing_kbd_macro
= Qnil
;
1042 kset_prefix_arg (current_kboard
, Qnil
);
1043 kset_last_prefix_arg (current_kboard
, Qnil
);
1046 /* Avoid unquittable loop if data contains a circular list. */
1047 old_level
= Vprint_level
;
1048 old_length
= Vprint_length
;
1049 XSETFASTINT (Vprint_level
, 10);
1050 XSETFASTINT (Vprint_length
, 10);
1051 cmd_error_internal (data
, macroerror
);
1052 Vprint_level
= old_level
;
1053 Vprint_length
= old_length
;
1056 Vinhibit_quit
= Qnil
;
1058 return make_number (0);
1061 /* Take actions on handling an error. DATA is the data that describes
1064 CONTEXT is a C-string containing ASCII characters only which
1065 describes the context in which the error happened. If we need to
1066 generalize CONTEXT to allow multibyte characters, make it a Lisp
1070 cmd_error_internal (Lisp_Object data
, const char *context
)
1072 /* The immediate context is not interesting for Quits,
1073 since they are asynchronous. */
1074 if (EQ (XCAR (data
), Qquit
))
1075 Vsignaling_function
= Qnil
;
1080 /* Use user's specified output function if any. */
1081 if (!NILP (Vcommand_error_function
))
1082 call3 (Vcommand_error_function
, data
,
1083 context
? build_string (context
) : empty_unibyte_string
,
1084 Vsignaling_function
);
1086 Vsignaling_function
= Qnil
;
1089 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1090 Scommand_error_default_function
, 3, 3, 0,
1091 doc
: /* Produce default output for unhandled error message.
1092 Default value of `command-error-function'. */)
1093 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1095 struct frame
*sf
= SELECTED_FRAME ();
1097 CHECK_STRING (context
);
1099 /* If the window system or terminal frame hasn't been initialized
1100 yet, or we're not interactive, write the message to stderr and exit. */
1101 if (!sf
->glyphs_initialized_p
1102 /* The initial frame is a special non-displaying frame. It
1103 will be current in daemon mode when there are no frames
1104 to display, and in non-daemon mode before the real frame
1105 has finished initializing. If an error is thrown in the
1106 latter case while creating the frame, then the frame
1107 will never be displayed, so the safest thing to do is
1108 write to stderr and quit. In daemon mode, there are
1109 many other potential errors that do not prevent frames
1110 from being created, so continuing as normal is better in
1112 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1115 print_error_message (data
, Qexternal_debugging_output
,
1116 SSDATA (context
), signal
);
1117 Fterpri (Qexternal_debugging_output
);
1118 Fkill_emacs (make_number (-1));
1122 clear_message (1, 0);
1124 message_log_maybe_newline ();
1127 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1132 static Lisp_Object
command_loop_2 (Lisp_Object
);
1133 static Lisp_Object
top_level_1 (Lisp_Object
);
1135 /* Entry to editor-command-loop.
1136 This level has the catches for exiting/returning to editor command loop.
1137 It returns nil to exit recursive edit, t to abort it. */
1142 if (command_loop_level
> 0 || minibuf_level
> 0)
1145 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1146 executing_kbd_macro
= Qnil
;
1152 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1153 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1154 executing_kbd_macro
= Qnil
;
1156 /* End of file in -batch run causes exit here. */
1162 /* Here we catch errors in execution of commands within the
1163 editing loop, and reenter the editing loop.
1164 When there is an error, cmd_error runs and returns a non-nil
1165 value to us. A value of nil means that command_loop_1 itself
1166 returned due to end of file (or end of kbd macro). */
1169 command_loop_2 (Lisp_Object ignore
)
1171 register Lisp_Object val
;
1174 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1175 while (!NILP (val
));
1183 return Feval (Vtop_level
, Qnil
);
1187 top_level_1 (Lisp_Object ignore
)
1189 /* On entry to the outer level, run the startup file. */
1190 if (!NILP (Vtop_level
))
1191 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1192 else if (!NILP (Vpurify_flag
))
1193 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1195 message1 ("Bare Emacs (standard Lisp code not loaded)");
1199 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1200 doc
: /* Exit all recursive editing levels.
1201 This also exits all active minibuffers. */)
1204 #ifdef HAVE_WINDOW_SYSTEM
1205 if (display_hourglass_p
)
1206 cancel_hourglass ();
1209 /* Unblock input if we enter with input blocked. This may happen if
1210 redisplay traps e.g. during tool-bar update with input blocked. */
1211 totally_unblock_input ();
1213 Fthrow (Qtop_level
, Qnil
);
1216 static _Noreturn
void
1217 user_error (const char *msg
)
1219 xsignal1 (Quser_error
, build_string (msg
));
1223 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1224 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1227 if (command_loop_level
> 0 || minibuf_level
> 0)
1228 Fthrow (Qexit
, Qnil
);
1230 user_error ("No recursive edit is in progress");
1234 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1235 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1238 if (command_loop_level
> 0 || minibuf_level
> 0)
1241 user_error ("No recursive edit is in progress");
1244 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1245 of this function. */
1248 tracking_off (Lisp_Object old_value
)
1250 do_mouse_tracking
= old_value
;
1251 if (NILP (old_value
))
1253 /* Redisplay may have been preempted because there was input
1254 available, and it assumes it will be called again after the
1255 input has been processed. If the only input available was
1256 the sort that we have just disabled, then we need to call
1258 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1260 redisplay_preserve_echo_area (6);
1261 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1266 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1267 doc
: /* Evaluate BODY with mouse movement events enabled.
1268 Within a `track-mouse' form, mouse motion generates input events that
1269 you can read with `read-event'.
1270 Normally, mouse motion is ignored.
1271 usage: (track-mouse BODY...) */)
1274 ptrdiff_t count
= SPECPDL_INDEX ();
1277 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1279 do_mouse_tracking
= Qt
;
1281 val
= Fprogn (args
);
1282 return unbind_to (count
, val
);
1285 /* If mouse has moved on some frame, return one of those frames.
1289 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1290 after resizing the tool-bar window. */
1292 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1295 bool ignore_mouse_drag_p
;
1297 static struct frame
*
1298 some_mouse_moved (void)
1300 Lisp_Object tail
, frame
;
1302 if (ignore_mouse_drag_p
)
1304 /* ignore_mouse_drag_p = 0; */
1308 FOR_EACH_FRAME (tail
, frame
)
1310 if (XFRAME (frame
)->mouse_moved
)
1311 return XFRAME (frame
);
1318 /* This is the actual command reading loop,
1319 sans error-handling encapsulation. */
1321 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1322 bool, bool, bool, bool);
1323 void safe_run_hooks (Lisp_Object
);
1324 static void adjust_point_for_property (ptrdiff_t, bool);
1326 /* The last boundary auto-added to buffer-undo-list. */
1327 Lisp_Object last_undo_boundary
;
1329 extern Lisp_Object Qregion_extract_function
;
1331 /* FIXME: This is wrong rather than test window-system, we should call
1332 a new set-selection, which will then dispatch to x-set-selection, or
1333 tty-set-selection, or w32-set-selection, ... */
1336 command_loop_1 (void)
1339 Lisp_Object keybuf
[30];
1341 EMACS_INT prev_modiff
= 0;
1342 struct buffer
*prev_buffer
= NULL
;
1343 bool already_adjusted
= 0;
1345 kset_prefix_arg (current_kboard
, Qnil
);
1346 kset_last_prefix_arg (current_kboard
, Qnil
);
1347 Vdeactivate_mark
= Qnil
;
1348 waiting_for_input
= 0;
1351 this_command_key_count
= 0;
1352 this_command_key_count_reset
= 0;
1353 this_single_command_key_start
= 0;
1355 if (NILP (Vmemory_full
))
1357 /* Make sure this hook runs after commands that get errors and
1358 throw to top level. */
1359 /* Note that the value cell will never directly contain nil
1360 if the symbol is a local variable. */
1361 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1362 safe_run_hooks (Qpost_command_hook
);
1364 /* If displaying a message, resize the echo area window to fit
1365 that message's size exactly. */
1366 if (!NILP (echo_area_buffer
[0]))
1367 resize_echo_area_exactly ();
1369 /* If there are warnings waiting, process them. */
1370 if (!NILP (Vdelayed_warnings_list
))
1371 safe_run_hooks (Qdelayed_warnings_hook
);
1373 if (!NILP (Vdeferred_action_list
))
1374 safe_run_hooks (Qdeferred_action_function
);
1377 /* Do this after running Vpost_command_hook, for consistency. */
1378 kset_last_command (current_kboard
, Vthis_command
);
1379 kset_real_last_command (current_kboard
, Vreal_this_command
);
1380 if (!CONSP (last_command_event
))
1381 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1385 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1388 /* Make sure the current window's buffer is selected. */
1389 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1391 /* Display any malloc warning that just came out. Use while because
1392 displaying one warning can cause another. */
1394 while (pending_malloc_warning
)
1395 display_malloc_warning ();
1397 Vdeactivate_mark
= Qnil
;
1399 /* Don't ignore mouse movements for more than a single command
1400 loop. (This flag is set in xdisp.c whenever the tool bar is
1401 resized, because the resize moves text up or down, and would
1402 generate false mouse drag events if we don't ignore them.) */
1403 ignore_mouse_drag_p
= 0;
1405 /* If minibuffer on and echo area in use,
1406 wait a short time and redraw minibuffer. */
1409 && !NILP (echo_area_buffer
[0])
1410 && EQ (minibuf_window
, echo_area_window
)
1411 && NUMBERP (Vminibuffer_message_timeout
))
1413 /* Bind inhibit-quit to t so that C-g gets read in
1414 rather than quitting back to the minibuffer. */
1415 ptrdiff_t count
= SPECPDL_INDEX ();
1416 specbind (Qinhibit_quit
, Qt
);
1418 sit_for (Vminibuffer_message_timeout
, 0, 2);
1420 /* Clear the echo area. */
1422 safe_run_hooks (Qecho_area_clear_hook
);
1424 unbind_to (count
, Qnil
);
1426 /* If a C-g came in before, treat it as input now. */
1427 if (!NILP (Vquit_flag
))
1430 Vunread_command_events
= list1 (make_number (quit_char
));
1434 /* If it has changed current-menubar from previous value,
1435 really recompute the menubar from the value. */
1436 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1437 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1438 call0 (Qrecompute_lucid_menubar
);
1440 before_command_key_count
= this_command_key_count
;
1441 before_command_echo_length
= echo_length ();
1443 Vthis_command
= Qnil
;
1444 Vreal_this_command
= Qnil
;
1445 Vthis_original_command
= Qnil
;
1446 Vthis_command_keys_shift_translated
= Qnil
;
1448 /* Read next key sequence; i gets its length. */
1449 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1452 /* A filter may have run while we were reading the input. */
1453 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1455 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1459 /* Now we have read a key sequence of length I,
1460 or else I is 0 and we found end of file. */
1462 if (i
== 0) /* End of file -- happens only in */
1463 return Qnil
; /* a kbd macro, at the end. */
1464 /* -1 means read_key_sequence got a menu that was rejected.
1465 Just loop around and read another command. */
1469 this_command_key_count
= 0;
1470 this_command_key_count_reset
= 0;
1471 this_single_command_key_start
= 0;
1475 last_command_event
= keybuf
[i
- 1];
1477 /* If the previous command tried to force a specific window-start,
1478 forget about that, in case this command moves point far away
1479 from that position. But also throw away beg_unchanged and
1480 end_unchanged information in that case, so that redisplay will
1481 update the whole window properly. */
1482 if (XWINDOW (selected_window
)->force_start
)
1485 XWINDOW (selected_window
)->force_start
= 0;
1486 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1487 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1490 cmd
= read_key_sequence_cmd
;
1491 if (!NILP (Vexecuting_kbd_macro
))
1493 if (!NILP (Vquit_flag
))
1495 Vexecuting_kbd_macro
= Qt
;
1496 QUIT
; /* Make some noise. */
1497 /* Will return since macro now empty. */
1501 /* Do redisplay processing after this command except in special
1502 cases identified below. */
1503 prev_buffer
= current_buffer
;
1504 prev_modiff
= MODIFF
;
1505 last_point_position
= PT
;
1507 /* By default, we adjust point to a boundary of a region that
1508 has such a property that should be treated intangible
1509 (e.g. composition, display). But, some commands will set
1510 this variable differently. */
1511 Vdisable_point_adjustment
= Qnil
;
1513 /* Process filters and timers may have messed with deactivate-mark.
1514 reset it before we execute the command. */
1515 Vdeactivate_mark
= Qnil
;
1517 /* Remap command through active keymaps. */
1518 Vthis_original_command
= cmd
;
1519 if (!NILP (read_key_sequence_remapped
))
1520 cmd
= read_key_sequence_remapped
;
1522 /* Execute the command. */
1524 Vthis_command
= cmd
;
1525 Vreal_this_command
= cmd
;
1526 safe_run_hooks (Qpre_command_hook
);
1528 already_adjusted
= 0;
1530 if (NILP (Vthis_command
))
1531 /* nil means key is undefined. */
1535 /* Here for a command that isn't executed directly. */
1537 #ifdef HAVE_WINDOW_SYSTEM
1538 ptrdiff_t scount
= SPECPDL_INDEX ();
1540 if (display_hourglass_p
1541 && NILP (Vexecuting_kbd_macro
))
1543 record_unwind_protect_void (cancel_hourglass
);
1548 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1550 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1553 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1554 ? Qnil
: BVAR (current_buffer
, undo_list
));
1556 call1 (Qcommand_execute
, Vthis_command
);
1558 #ifdef HAVE_WINDOW_SYSTEM
1559 /* Do not check display_hourglass_p here, because
1560 `command-execute' could change it, but we should cancel
1561 hourglass cursor anyway.
1562 But don't cancel the hourglass within a macro
1563 just because a command in the macro finishes. */
1564 if (NILP (Vexecuting_kbd_macro
))
1565 unbind_to (scount
, Qnil
);
1568 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1570 safe_run_hooks (Qpost_command_hook
);
1572 /* If displaying a message, resize the echo area window to fit
1573 that message's size exactly. */
1574 if (!NILP (echo_area_buffer
[0]))
1575 resize_echo_area_exactly ();
1577 /* If there are warnings waiting, process them. */
1578 if (!NILP (Vdelayed_warnings_list
))
1579 safe_run_hooks (Qdelayed_warnings_hook
);
1581 safe_run_hooks (Qdeferred_action_function
);
1583 /* If there is a prefix argument,
1584 1) We don't want Vlast_command to be ``universal-argument''
1585 (that would be dumb), so don't set Vlast_command,
1586 2) we want to leave echoing on so that the prefix will be
1587 echoed as part of this key sequence, so don't call
1589 3) we want to leave this_command_key_count non-zero, so that
1590 read_char will realize that it is re-reading a character, and
1591 not echo it a second time.
1593 If the command didn't actually create a prefix arg,
1594 but is merely a frame event that is transparent to prefix args,
1595 then the above doesn't apply. */
1596 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1597 || CONSP (last_command_event
))
1599 kset_last_command (current_kboard
, Vthis_command
);
1600 kset_real_last_command (current_kboard
, Vreal_this_command
);
1601 if (!CONSP (last_command_event
))
1602 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1604 this_command_key_count
= 0;
1605 this_command_key_count_reset
= 0;
1606 this_single_command_key_start
= 0;
1609 if (!NILP (BVAR (current_buffer
, mark_active
))
1610 && !NILP (Vrun_hooks
))
1612 /* In Emacs 22, setting transient-mark-mode to `only' was a
1613 way of turning it on for just one command. This usage is
1614 obsolete, but support it anyway. */
1615 if (EQ (Vtransient_mark_mode
, Qidentity
))
1616 Vtransient_mark_mode
= Qnil
;
1617 else if (EQ (Vtransient_mark_mode
, Qonly
))
1618 Vtransient_mark_mode
= Qidentity
;
1620 if (!NILP (Vdeactivate_mark
))
1621 /* If `select-active-regions' is non-nil, this call to
1622 `deactivate-mark' also sets the PRIMARY selection. */
1623 call0 (Qdeactivate_mark
);
1626 /* Even if not deactivating the mark, set PRIMARY if
1627 `select-active-regions' is non-nil. */
1628 if (!NILP (Fwindow_system (Qnil
))
1629 /* Even if mark_active is non-nil, the actual buffer
1630 marker may not have been set yet (Bug#7044). */
1631 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1632 && (EQ (Vselect_active_regions
, Qonly
)
1633 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1634 : (!NILP (Vselect_active_regions
)
1635 && !NILP (Vtransient_mark_mode
)))
1636 && NILP (Fmemq (Vthis_command
,
1637 Vselection_inhibit_update_commands
)))
1640 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1641 if (XINT (Flength (txt
)) > 0)
1642 /* Don't set empty selections. */
1643 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1646 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1648 Lisp_Object hook
= intern ("activate-mark-hook");
1649 Frun_hooks (1, &hook
);
1653 Vsaved_region_selection
= Qnil
;
1658 if (current_buffer
== prev_buffer
1659 && last_point_position
!= PT
1660 && NILP (Vdisable_point_adjustment
)
1661 && NILP (Vglobal_disable_point_adjustment
))
1663 if (last_point_position
> BEGV
1664 && last_point_position
< ZV
1665 && (composition_adjust_point (last_point_position
,
1666 last_point_position
)
1667 != last_point_position
))
1668 /* The last point was temporarily set within a grapheme
1669 cluster to prevent automatic composition. To recover
1670 the automatic composition, we must update the
1672 windows_or_buffers_changed
= 21;
1673 if (!already_adjusted
)
1674 adjust_point_for_property (last_point_position
,
1675 MODIFF
!= prev_modiff
);
1678 /* Install chars successfully executed in kbd macro. */
1680 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1681 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1682 finalize_kbd_macro_chars ();
1687 read_menu_command (void)
1689 Lisp_Object keybuf
[30];
1690 ptrdiff_t count
= SPECPDL_INDEX ();
1693 /* We don't want to echo the keystrokes while navigating the
1695 specbind (Qecho_keystrokes
, make_number (0));
1697 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1700 unbind_to (count
, Qnil
);
1702 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1704 if (i
== 0 || i
== -1)
1707 return read_key_sequence_cmd
;
1710 /* Adjust point to a boundary of a region that has such a property
1711 that should be treated intangible. For the moment, we check
1712 `composition', `display' and `invisible' properties.
1713 LAST_PT is the last position of point. */
1716 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1719 Lisp_Object val
, overlay
, tmp
;
1720 /* When called after buffer modification, we should temporarily
1721 suppress the point adjustment for automatic composition so that a
1722 user can keep inserting another character at point or keep
1723 deleting characters around point. */
1724 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1725 ptrdiff_t orig_pt
= PT
;
1727 /* FIXME: cycling is probably not necessary because these properties
1728 can't be usefully combined anyway. */
1729 while (check_composition
|| check_display
|| check_invisible
)
1731 /* FIXME: check `intangible'. */
1732 if (check_composition
1733 && PT
> BEGV
&& PT
< ZV
1734 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1737 check_display
= check_invisible
= 1;
1739 check_composition
= 0;
1741 && PT
> BEGV
&& PT
< ZV
1742 && !NILP (val
= get_char_property_and_overlay
1743 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1744 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1745 && (!OVERLAYP (overlay
)
1746 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1747 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1748 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1749 && (beg
< PT
/* && end > PT <- It's always the case. */
1750 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1753 SET_PT (PT
< last_pt
1754 ? (STRINGP (val
) && SCHARS (val
) == 0
1755 ? max (beg
- 1, BEGV
)
1758 check_composition
= check_invisible
= 1;
1761 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1767 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1770 /* FIXME: We should stop if we find a spot between
1771 two runs of `invisible' where inserted text would
1772 be visible. This is important when we have two
1773 invisible boundaries that enclose an area: if the
1774 area is empty, we need this test in order to make
1775 it possible to place point in the middle rather
1776 than skip both boundaries. However, this code
1777 also stops anywhere in a non-sticky text-property,
1778 which breaks (e.g.) Org mode. */
1779 && (val
= Fget_pos_property (make_number (end
),
1781 TEXT_PROP_MEANS_INVISIBLE (val
))
1783 && !NILP (val
= get_char_property_and_overlay
1784 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1785 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1787 ellipsis
= ellipsis
|| inv
> 1
1788 || (OVERLAYP (overlay
)
1789 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1790 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1791 tmp
= Fnext_single_char_property_change
1792 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1793 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1797 && (val
= Fget_pos_property (make_number (beg
),
1799 TEXT_PROP_MEANS_INVISIBLE (val
))
1801 && !NILP (val
= get_char_property_and_overlay
1802 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1803 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1805 ellipsis
= ellipsis
|| inv
> 1
1806 || (OVERLAYP (overlay
)
1807 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1808 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1809 tmp
= Fprevious_single_char_property_change
1810 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1811 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1814 /* Move away from the inside area. */
1815 if (beg
< PT
&& end
> PT
)
1817 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1818 /* We haven't moved yet (so we don't need to fear
1819 infinite-looping) and we were outside the range
1820 before (so either end of the range still corresponds
1821 to a move in the right direction): pretend we moved
1822 less than we actually did, so that we still have
1823 more freedom below in choosing which end of the range
1825 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1826 /* We either have moved already or the last point
1827 was already in the range: we don't get to choose
1828 which end of the range we have to go to. */
1829 : (PT
< last_pt
? beg
: end
));
1830 check_composition
= check_display
= 1;
1832 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1833 the point to something other than its argument, due to
1834 point-motion hooks, intangibility, etc. */
1835 eassert (PT
== beg
|| PT
== end
);
1838 /* Pretend the area doesn't exist if the buffer is not
1840 if (!modified
&& !ellipsis
&& beg
< end
)
1842 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1843 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1844 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1845 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1846 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1847 /* We've already moved as far as we can. Trying to go
1848 to the other end would mean moving backwards and thus
1849 could lead to an infinite loop. */
1851 else if (val
= Fget_pos_property (make_number (PT
),
1853 TEXT_PROP_MEANS_INVISIBLE (val
)
1854 && (val
= (Fget_pos_property
1855 (make_number (PT
== beg
? end
: beg
),
1857 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1858 (check_composition
= check_display
= 1,
1859 SET_PT (PT
== beg
? end
: beg
));
1862 check_invisible
= 0;
1866 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1869 safe_run_hooks_1 (void)
1871 eassert (CONSP (Vinhibit_quit
));
1872 return call0 (XCDR (Vinhibit_quit
));
1875 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1879 safe_run_hooks_error (Lisp_Object error_data
)
1882 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1883 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1884 Lisp_Object args
[4];
1885 args
[0] = build_string ("Error in %s (%S): %S");
1888 args
[3] = error_data
;
1894 Lisp_Object newval
= Qnil
;
1895 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1896 if (EQ (fun
, XCAR (val
)))
1899 newval
= Fcons (XCAR (val
), newval
);
1901 return Fset (hook
, Fnreverse (newval
));
1902 /* Not found in the local part of the hook. Let's look at the global
1905 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1906 : Fdefault_value (hook
));
1907 CONSP (val
); val
= XCDR (val
))
1908 if (EQ (fun
, XCAR (val
)))
1911 newval
= Fcons (XCAR (val
), newval
);
1913 return Fset_default (hook
, Fnreverse (newval
));
1919 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1921 eassert (nargs
== 1);
1922 if (CONSP (Vinhibit_quit
))
1923 XSETCDR (Vinhibit_quit
, args
[0]);
1925 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1927 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1931 /* If we get an error while running the hook, cause the hook variable
1932 to be nil. Also inhibit quits, so that C-g won't cause the hook
1933 to mysteriously evaporate. */
1936 safe_run_hooks (Lisp_Object hook
)
1938 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1939 to its body or to its handlers other than via globals such as
1940 dynamically-bound variables ;-) */
1941 ptrdiff_t count
= SPECPDL_INDEX ();
1942 specbind (Qinhibit_quit
, hook
);
1944 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1946 unbind_to (count
, Qnil
);
1950 /* Nonzero means polling for input is temporarily suppressed. */
1952 int poll_suppress_count
;
1955 #ifdef POLL_FOR_INPUT
1957 /* Asynchronous timer for polling. */
1959 static struct atimer
*poll_timer
;
1961 /* Poll for input, so that we catch a C-g if it comes in. */
1963 poll_for_input_1 (void)
1965 if (! input_blocked_p ()
1966 && !waiting_for_input
)
1970 /* Timer callback function for poll_timer. TIMER is equal to
1974 poll_for_input (struct atimer
*timer
)
1976 if (poll_suppress_count
== 0)
1977 pending_signals
= 1;
1980 #endif /* POLL_FOR_INPUT */
1982 /* Begin signals to poll for input, if they are appropriate.
1983 This function is called unconditionally from various places. */
1986 start_polling (void)
1988 #ifdef POLL_FOR_INPUT
1989 /* XXX This condition was (read_socket_hook && !interrupt_input),
1990 but read_socket_hook is not global anymore. Let's pretend that
1992 if (!interrupt_input
)
1994 /* Turn alarm handling on unconditionally. It might have
1995 been turned off in process.c. */
1996 turn_on_atimers (1);
1998 /* If poll timer doesn't exist, or we need one with
1999 a different interval, start a new one. */
2000 if (poll_timer
== NULL
2001 || poll_timer
->interval
.tv_sec
!= polling_period
)
2003 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2004 struct timespec interval
= make_timespec (period
, 0);
2007 cancel_atimer (poll_timer
);
2009 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2010 poll_for_input
, NULL
);
2013 /* Let the timer's callback function poll for input
2014 if this becomes zero. */
2015 --poll_suppress_count
;
2020 /* True if we are using polling to handle input asynchronously. */
2023 input_polling_used (void)
2025 #ifdef POLL_FOR_INPUT
2026 /* XXX This condition was (read_socket_hook && !interrupt_input),
2027 but read_socket_hook is not global anymore. Let's pretend that
2029 return !interrupt_input
;
2035 /* Turn off polling. */
2040 #ifdef POLL_FOR_INPUT
2041 /* XXX This condition was (read_socket_hook && !interrupt_input),
2042 but read_socket_hook is not global anymore. Let's pretend that
2044 if (!interrupt_input
)
2045 ++poll_suppress_count
;
2049 /* Set the value of poll_suppress_count to COUNT
2050 and start or stop polling accordingly. */
2053 set_poll_suppress_count (int count
)
2055 #ifdef POLL_FOR_INPUT
2056 if (count
== 0 && poll_suppress_count
!= 0)
2058 poll_suppress_count
= 1;
2061 else if (count
!= 0 && poll_suppress_count
== 0)
2065 poll_suppress_count
= count
;
2069 /* Bind polling_period to a value at least N.
2070 But don't decrease it. */
2073 bind_polling_period (int n
)
2075 #ifdef POLL_FOR_INPUT
2076 EMACS_INT
new = polling_period
;
2081 stop_other_atimers (poll_timer
);
2083 specbind (Qpolling_period
, make_number (new));
2084 /* Start a new alarm with the new period. */
2089 /* Apply the control modifier to CHARACTER. */
2095 make_ctrl_char (int c
)
2097 /* Save the upper bits here. */
2098 int upper
= c
& ~0177;
2100 if (! ASCII_BYTE_P (c
))
2101 return c
|= ctrl_modifier
;
2105 /* Everything in the columns containing the upper-case letters
2106 denotes a control character. */
2107 if (c
>= 0100 && c
< 0140)
2111 /* Set the shift modifier for a control char
2112 made from a shifted letter. But only for letters! */
2113 if (oc
>= 'A' && oc
<= 'Z')
2114 c
|= shift_modifier
;
2117 /* The lower-case letters denote control characters too. */
2118 else if (c
>= 'a' && c
<= 'z')
2121 /* Include the bits for control and shift
2122 only if the basic ASCII code can't indicate them. */
2126 /* Replace the high bits. */
2127 c
|= (upper
& ~ctrl_modifier
);
2132 /* Display the help-echo property of the character after the mouse pointer.
2133 Either show it in the echo area, or call show-help-function to display
2134 it by other means (maybe in a tooltip).
2136 If HELP is nil, that means clear the previous help echo.
2138 If HELP is a string, display that string. If HELP is a function,
2139 call it with OBJECT and POS as arguments; the function should
2140 return a help string or nil for none. For all other types of HELP,
2141 evaluate it to obtain a string.
2143 WINDOW is the window in which the help was generated, if any.
2144 It is nil if not in a window.
2146 If OBJECT is a buffer, POS is the position in the buffer where the
2147 `help-echo' text property was found.
2149 If OBJECT is an overlay, that overlay has a `help-echo' property,
2150 and POS is the position in the overlay's buffer under the mouse.
2152 If OBJECT is a string (an overlay string or a string displayed with
2153 the `display' property). POS is the position in that string under
2156 Note: this function may only be called with HELP nil or a string
2157 from X code running asynchronously. */
2160 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2163 if (!NILP (help
) && !STRINGP (help
))
2165 if (FUNCTIONP (help
))
2166 help
= safe_call (4, help
, window
, object
, pos
);
2168 help
= safe_eval (help
);
2170 if (!STRINGP (help
))
2174 if (!noninteractive
&& STRINGP (help
))
2176 /* The mouse-fixup-help-message Lisp function can call
2177 mouse_position_hook, which resets the mouse_moved flags.
2178 This causes trouble if we are trying to read a mouse motion
2179 event (i.e., if we are inside a `track-mouse' form), so we
2180 restore the mouse_moved flag. */
2181 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2182 help
= call1 (Qmouse_fixup_help_message
, help
);
2187 if (STRINGP (help
) || NILP (help
))
2189 if (!NILP (Vshow_help_function
))
2190 call1 (Vshow_help_function
, help
);
2191 help_echo_showing_p
= STRINGP (help
);
2197 /* Input of single characters from keyboard */
2199 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2200 struct timespec
*end_time
);
2201 static void record_char (Lisp_Object c
);
2203 static Lisp_Object help_form_saved_window_configs
;
2205 read_char_help_form_unwind (void)
2207 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2208 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2209 if (!NILP (window_config
))
2210 Fset_window_configuration (window_config
);
2213 #define STOP_POLLING \
2214 do { if (! polling_stopped_here) stop_polling (); \
2215 polling_stopped_here = 1; } while (0)
2217 #define RESUME_POLLING \
2218 do { if (polling_stopped_here) start_polling (); \
2219 polling_stopped_here = 0; } while (0)
2222 read_event_from_main_queue (struct timespec
*end_time
,
2223 sys_jmp_buf local_getcjmp
,
2224 bool *used_mouse_menu
)
2226 Lisp_Object c
= Qnil
;
2227 sys_jmp_buf save_jump
;
2228 KBOARD
*kb
IF_LINT (= NULL
);
2232 /* Read from the main queue, and if that gives us something we can't use yet,
2233 we put it on the appropriate side queue and try again. */
2235 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2238 /* Actually read a character, waiting if necessary. */
2239 save_getcjmp (save_jump
);
2240 restore_getcjmp (local_getcjmp
);
2242 timer_start_idle ();
2243 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2244 restore_getcjmp (save_jump
);
2246 if (! NILP (c
) && (kb
!= current_kboard
))
2248 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2251 while (CONSP (XCDR (last
)))
2253 if (!NILP (XCDR (last
)))
2257 kset_kbd_queue (kb
, list1 (c
));
2259 XSETCDR (last
, list1 (c
));
2260 kb
->kbd_queue_has_data
= 1;
2264 current_kboard
= kb
;
2265 /* This is going to exit from read_char
2266 so we had better get rid of this frame's stuff. */
2267 return make_number (-2);
2270 /* Terminate Emacs in batch mode if at eof. */
2271 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2272 Fkill_emacs (make_number (1));
2276 /* Add in any extra modifiers, where appropriate. */
2277 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2278 || ((extra_keyboard_modifiers
& 0177) < ' '
2279 && (extra_keyboard_modifiers
& 0177) != 0))
2280 XSETINT (c
, make_ctrl_char (XINT (c
)));
2282 /* Transfer any other modifier bits directly from
2283 extra_keyboard_modifiers to c. Ignore the actual character code
2284 in the low 16 bits of extra_keyboard_modifiers. */
2285 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2293 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2296 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2297 sys_jmp_buf local_getcjmp
,
2298 Lisp_Object prev_event
,
2299 bool *used_mouse_menu
)
2301 #define MAX_ENCODED_BYTES 16
2303 Lisp_Object events
[MAX_ENCODED_BYTES
];
2309 = read_event_from_main_queue (end_time
, local_getcjmp
,
2312 /* w32_console already returns decoded events. It either reads
2313 Unicode characters from the Windows keyboard input, or
2314 converts characters encoded in the current codepage into
2315 Unicode. See w32inevt.c:key_event, near its end. */
2318 struct frame
*frame
= XFRAME (selected_frame
);
2319 struct terminal
*terminal
= frame
->terminal
;
2320 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2321 /* Don't apply decoding if we're just reading a raw event
2322 (e.g. reading bytes sent by the xterm to specify the position
2323 of a mouse click). */
2324 && (!EQ (prev_event
, Qt
))
2325 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2326 & CODING_REQUIRE_DECODING_MASK
)))
2327 return nextevt
; /* No decoding needed. */
2330 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2331 eassert (n
< MAX_ENCODED_BYTES
);
2332 events
[n
++] = nextevt
;
2333 if (NATNUMP (nextevt
)
2334 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2335 { /* An encoded byte sequence, let's try to decode it. */
2336 struct coding_system
*coding
2337 = TERMINAL_KEYBOARD_CODING (terminal
);
2338 unsigned char *src
= alloca (n
);
2340 for (i
= 0; i
< n
; i
++)
2341 src
[i
] = XINT (events
[i
]);
2343 for (i
= 0; i
< n
; i
++)
2345 coding
->destination
= alloca (n
* 4);
2346 coding
->dst_bytes
= n
* 4;
2347 decode_coding_c_string (coding
, src
, n
, Qnil
);
2348 eassert (coding
->produced_char
<= n
);
2349 if (coding
->produced_char
== 0)
2350 { /* The encoded sequence is incomplete. */
2351 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2352 continue; /* Read on! */
2356 const unsigned char *p
= coding
->destination
;
2357 eassert (coding
->carryover_bytes
== 0);
2359 while (n
< coding
->produced_char
)
2360 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2363 /* Now `events' should hold decoded events.
2364 Normally, n should be equal to 1, but better not rely on it.
2365 We can only return one event here, so return the first we
2366 had and keep the others (if any) for later. */
2368 Vunread_command_events
2369 = Fcons (events
[--n
], Vunread_command_events
);
2376 /* Read a character from the keyboard; call the redisplay if needed. */
2377 /* commandflag 0 means do not autosave, but do redisplay.
2378 -1 means do not redisplay, but do autosave.
2379 -2 means do neither.
2382 /* The arguments MAP is for menu prompting. MAP is a keymap.
2384 PREV_EVENT is the previous input event, or nil if we are reading
2385 the first event of a key sequence (or not reading a key sequence).
2386 If PREV_EVENT is t, that is a "magic" value that says
2387 not to run input methods, but in other respects to act as if
2388 not reading a key sequence.
2390 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2391 if we used a mouse menu to read the input, or false otherwise. If
2392 USED_MOUSE_MENU is null, don't dereference it.
2394 Value is -2 when we find input on another keyboard. A second call
2395 to read_char will read it.
2397 If END_TIME is non-null, it is a pointer to a struct timespec
2398 specifying the maximum time to wait until. If no input arrives by
2399 that time, stop waiting and return nil.
2401 Value is t if we showed a menu and the user rejected it. */
2404 read_char (int commandflag
, Lisp_Object map
,
2405 Lisp_Object prev_event
,
2406 bool *used_mouse_menu
, struct timespec
*end_time
)
2410 sys_jmp_buf local_getcjmp
;
2411 sys_jmp_buf save_jump
;
2412 Lisp_Object tem
, save
;
2413 volatile Lisp_Object previous_echo_area_message
;
2414 volatile Lisp_Object also_record
;
2415 volatile bool reread
;
2416 struct gcpro gcpro1
, gcpro2
;
2417 bool volatile polling_stopped_here
= 0;
2418 struct kboard
*orig_kboard
= current_kboard
;
2422 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2423 before_command_key_count
= this_command_key_count
;
2424 before_command_echo_length
= echo_length ();
2427 previous_echo_area_message
= Qnil
;
2429 GCPRO2 (c
, previous_echo_area_message
);
2434 if (CONSP (Vunread_post_input_method_events
))
2436 c
= XCAR (Vunread_post_input_method_events
);
2437 Vunread_post_input_method_events
2438 = XCDR (Vunread_post_input_method_events
);
2440 /* Undo what read_char_x_menu_prompt did when it unread
2441 additional keys returned by Fx_popup_menu. */
2443 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2451 if (CONSP (Vunread_command_events
))
2453 bool was_disabled
= 0;
2455 c
= XCAR (Vunread_command_events
);
2456 Vunread_command_events
= XCDR (Vunread_command_events
);
2460 /* Undo what sit-for did when it unread additional keys
2461 inside universal-argument. */
2464 && EQ (XCAR (c
), Qt
))
2470 /* Undo what read_char_x_menu_prompt did when it unread
2471 additional keys returned by Fx_popup_menu. */
2473 && EQ (XCDR (c
), Qdisabled
)
2474 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2480 /* If the queued event is something that used the mouse,
2481 set used_mouse_menu accordingly. */
2483 /* Also check was_disabled so last-nonmenu-event won't return
2484 a bad value when submenus are involved. (Bug#447) */
2485 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2486 *used_mouse_menu
= 1;
2488 goto reread_for_input_method
;
2491 if (CONSP (Vunread_input_method_events
))
2493 c
= XCAR (Vunread_input_method_events
);
2494 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2496 /* Undo what read_char_x_menu_prompt did when it unread
2497 additional keys returned by Fx_popup_menu. */
2499 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2503 goto reread_for_input_method
;
2506 this_command_key_count_reset
= 0;
2508 if (!NILP (Vexecuting_kbd_macro
))
2510 /* We set this to Qmacro; since that's not a frame, nobody will
2511 try to switch frames on us, and the selected window will
2514 Since this event came from a macro, it would be misleading to
2515 leave internal_last_event_frame set to wherever the last
2516 real event came from. Normally, a switch-frame event selects
2517 internal_last_event_frame after each command is read, but
2518 events read from a macro should never cause a new frame to be
2520 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2522 /* Exit the macro if we are at the end.
2523 Also, some things replace the macro with t
2524 to force an early exit. */
2525 if (EQ (Vexecuting_kbd_macro
, Qt
)
2526 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2532 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2533 if (STRINGP (Vexecuting_kbd_macro
)
2534 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2535 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2537 executing_kbd_macro_index
++;
2542 if (!NILP (unread_switch_frame
))
2544 c
= unread_switch_frame
;
2545 unread_switch_frame
= Qnil
;
2547 /* This event should make it into this_command_keys, and get echoed
2548 again, so we do not set `reread'. */
2552 /* If redisplay was requested. */
2553 if (commandflag
>= 0)
2555 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2557 /* If there is pending input, process any events which are not
2558 user-visible, such as X selection_request events. */
2560 || detect_input_pending_run_timers (0))
2561 swallow_events (0); /* May clear input_pending. */
2563 /* Redisplay if no pending input. */
2564 while (!input_pending
)
2566 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2567 redisplay_preserve_echo_area (5);
2572 /* Normal case: no input arrived during redisplay. */
2575 /* Input arrived and pre-empted redisplay.
2576 Process any events which are not user-visible. */
2578 /* If that cleared input_pending, try again to redisplay. */
2581 /* Prevent the redisplay we just did
2582 from messing up echoing of the input after the prompt. */
2583 if (commandflag
== 0 && echo_current
)
2584 echo_message_buffer
= echo_area_buffer
[0];
2588 /* Message turns off echoing unless more keystrokes turn it on again.
2590 The code in 20.x for the condition was
2592 1. echo_area_glyphs && *echo_area_glyphs
2593 2. && echo_area_glyphs != current_kboard->echobuf
2594 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2596 (1) means there's a current message displayed
2598 (2) means it's not the message from echoing from the current
2601 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2602 is set to a non-null value. This is done in read_char and it is
2603 set to echo_area_glyphs after a call to echo_char. That means
2604 ok_to_echo_at_next_pause is either null or
2605 current_kboard->echobuf with the appropriate current_kboard at
2608 So, condition (3) means in clear text ok_to_echo_at_next_pause
2609 must be either null, or the current message isn't from echoing at
2610 all, or it's from echoing from a different kboard than the
2613 if (/* There currently is something in the echo area. */
2614 !NILP (echo_area_buffer
[0])
2615 && (/* It's an echo from a different kboard. */
2616 echo_kboard
!= current_kboard
2617 /* Or we explicitly allow overwriting whatever there is. */
2618 || ok_to_echo_at_next_pause
== NULL
))
2623 /* Try reading a character via menu prompting in the minibuf.
2624 Try this before the sit-for, because the sit-for
2625 would do the wrong thing if we are supposed to do
2626 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2627 after a mouse event so don't try a minibuf menu. */
2629 if (KEYMAPP (map
) && INTERACTIVE
2630 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2631 /* Don't bring up a menu if we already have another event. */
2632 && NILP (Vunread_command_events
)
2633 && !detect_input_pending_run_timers (0))
2635 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2637 if (INTEGERP (c
) && XINT (c
) == -2)
2638 return c
; /* wrong_kboard_jmpbuf */
2644 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2645 We will do that below, temporarily for short sections of code,
2646 when appropriate. local_getcjmp must be in effect
2647 around any call to sit_for or kbd_buffer_get_event;
2648 it *must not* be in effect when we call redisplay. */
2650 jmpcount
= SPECPDL_INDEX ();
2651 if (sys_setjmp (local_getcjmp
))
2653 /* Handle quits while reading the keyboard. */
2654 /* We must have saved the outer value of getcjmp here,
2655 so restore it now. */
2656 restore_getcjmp (save_jump
);
2657 unbind_to (jmpcount
, Qnil
);
2658 XSETINT (c
, quit_char
);
2659 internal_last_event_frame
= selected_frame
;
2660 Vlast_event_frame
= internal_last_event_frame
;
2661 /* If we report the quit char as an event,
2662 don't do so more than once. */
2663 if (!NILP (Vinhibit_quit
))
2667 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2668 if (kb
!= current_kboard
)
2670 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2671 /* We shouldn't get here if we were in single-kboard mode! */
2676 while (CONSP (XCDR (last
)))
2678 if (!NILP (XCDR (last
)))
2682 kset_kbd_queue (kb
, list1 (c
));
2684 XSETCDR (last
, list1 (c
));
2685 kb
->kbd_queue_has_data
= 1;
2686 current_kboard
= kb
;
2687 /* This is going to exit from read_char
2688 so we had better get rid of this frame's stuff. */
2690 return make_number (-2); /* wrong_kboard_jmpbuf */
2696 /* Start idle timers if no time limit is supplied. We don't do it
2697 if a time limit is supplied to avoid an infinite recursion in the
2698 situation where an idle timer calls `sit-for'. */
2701 timer_start_idle ();
2703 /* If in middle of key sequence and minibuffer not active,
2704 start echoing if enough time elapses. */
2706 if (minibuf_level
== 0
2708 && !current_kboard
->immediate_echo
2709 && this_command_key_count
> 0
2711 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2712 && NILP (Fzerop (Vecho_keystrokes
))
2713 && (/* No message. */
2714 NILP (echo_area_buffer
[0])
2715 /* Or empty message. */
2716 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2717 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2718 /* Or already echoing from same kboard. */
2719 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2720 /* Or not echoing before and echoing allowed. */
2721 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2723 /* After a mouse event, start echoing right away.
2724 This is because we are probably about to display a menu,
2725 and we don't want to delay before doing so. */
2726 if (EVENT_HAS_PARAMETERS (prev_event
))
2732 save_getcjmp (save_jump
);
2733 restore_getcjmp (local_getcjmp
);
2734 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2735 restore_getcjmp (save_jump
);
2737 && ! CONSP (Vunread_command_events
))
2742 /* Maybe auto save due to number of keystrokes. */
2744 if (commandflag
!= 0 && commandflag
!= -2
2745 && auto_save_interval
> 0
2746 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2747 && !detect_input_pending_run_timers (0))
2749 Fdo_auto_save (Qnil
, Qnil
);
2750 /* Hooks can actually change some buffers in auto save. */
2754 /* Try reading using an X menu.
2755 This is never confused with reading using the minibuf
2756 because the recursive call of read_char in read_char_minibuf_menu_prompt
2757 does not pass on any keymaps. */
2759 if (KEYMAPP (map
) && INTERACTIVE
2760 && !NILP (prev_event
)
2761 && EVENT_HAS_PARAMETERS (prev_event
)
2762 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2763 && !EQ (XCAR (prev_event
), Qtool_bar
)
2764 /* Don't bring up a menu if we already have another event. */
2765 && NILP (Vunread_command_events
))
2767 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2769 /* Now that we have read an event, Emacs is not idle. */
2776 /* Maybe autosave and/or garbage collect due to idleness. */
2778 if (INTERACTIVE
&& NILP (c
))
2781 ptrdiff_t buffer_size
;
2783 /* Slow down auto saves logarithmically in size of current buffer,
2784 and garbage collect while we're at it. */
2785 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2786 last_non_minibuf_size
= Z
- BEG
;
2787 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2789 while (buffer_size
> 64)
2790 delay_level
++, buffer_size
-= buffer_size
>> 2;
2791 if (delay_level
< 4) delay_level
= 4;
2792 /* delay_level is 4 for files under around 50k, 7 at 100k,
2793 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2795 /* Auto save if enough time goes by without input. */
2796 if (commandflag
!= 0 && commandflag
!= -2
2797 && num_nonmacro_input_events
> last_auto_save
2798 && INTEGERP (Vauto_save_timeout
)
2799 && XINT (Vauto_save_timeout
) > 0)
2802 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2804 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2805 timeout
= delay_level
* timeout
/ 4;
2806 save_getcjmp (save_jump
);
2807 restore_getcjmp (local_getcjmp
);
2808 tem0
= sit_for (make_number (timeout
), 1, 1);
2809 restore_getcjmp (save_jump
);
2812 && ! CONSP (Vunread_command_events
))
2814 Fdo_auto_save (Qnil
, Qnil
);
2819 /* If there is still no input available, ask for GC. */
2820 if (!detect_input_pending_run_timers (0))
2824 /* Notify the caller if an autosave hook, or a timer, sentinel or
2825 filter in the sit_for calls above have changed the current
2826 kboard. This could happen if they use the minibuffer or start a
2827 recursive edit, like the fancy splash screen in server.el's
2828 filter. If this longjmp wasn't here, read_key_sequence would
2829 interpret the next key sequence using the wrong translation
2830 tables and function keymaps. */
2831 if (NILP (c
) && current_kboard
!= orig_kboard
)
2834 return make_number (-2); /* wrong_kboard_jmpbuf */
2837 /* If this has become non-nil here, it has been set by a timer
2838 or sentinel or filter. */
2839 if (CONSP (Vunread_command_events
))
2841 c
= XCAR (Vunread_command_events
);
2842 Vunread_command_events
= XCDR (Vunread_command_events
);
2845 /* Read something from current KBOARD's side queue, if possible. */
2849 if (current_kboard
->kbd_queue_has_data
)
2851 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2853 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2854 kset_kbd_queue (current_kboard
,
2855 XCDR (KVAR (current_kboard
, kbd_queue
)));
2856 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2857 current_kboard
->kbd_queue_has_data
= 0;
2858 input_pending
= readable_events (0);
2859 if (EVENT_HAS_PARAMETERS (c
)
2860 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2861 internal_last_event_frame
= XCAR (XCDR (c
));
2862 Vlast_event_frame
= internal_last_event_frame
;
2866 /* If current_kboard's side queue is empty check the other kboards.
2867 If one of them has data that we have not yet seen here,
2868 switch to it and process the data waiting for it.
2870 Note: if the events queued up for another kboard
2871 have already been seen here, and therefore are not a complete command,
2872 the kbd_queue_has_data field is 0, so we skip that kboard here.
2873 That's to avoid an infinite loop switching between kboards here. */
2874 if (NILP (c
) && !single_kboard
)
2877 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2878 if (kb
->kbd_queue_has_data
)
2880 current_kboard
= kb
;
2881 /* This is going to exit from read_char
2882 so we had better get rid of this frame's stuff. */
2884 return make_number (-2); /* wrong_kboard_jmpbuf */
2894 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2895 prev_event
, used_mouse_menu
);
2896 if (NILP(c
) && end_time
&&
2897 timespec_cmp (*end_time
, current_timespec ()) <= 0)
2902 if (EQ (c
, make_number (-2)))
2904 /* This is going to exit from read_char
2905 so we had better get rid of this frame's stuff. */
2919 if (commandflag
>= 0
2920 && !input_pending
&& !detect_input_pending_run_timers (0))
2926 /* Buffer switch events are only for internal wakeups
2927 so don't show them to the user.
2928 Also, don't record a key if we already did. */
2932 /* Process special events within read_char
2933 and loop around to read another event. */
2936 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2941 struct buffer
*prev_buffer
= current_buffer
;
2942 last_input_event
= c
;
2943 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2945 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2946 /* We stopped being idle for this event; undo that. This
2947 prevents automatic window selection (under
2948 mouse_autoselect_window from acting as a real input event, for
2949 example banishing the mouse under mouse-avoidance-mode. */
2950 timer_resume_idle ();
2952 if (current_buffer
!= prev_buffer
)
2954 /* The command may have changed the keymaps. Pretend there
2955 is input in another keyboard and return. This will
2956 recalculate keymaps. */
2957 c
= make_number (-2);
2964 /* Handle things that only apply to characters. */
2967 /* If kbd_buffer_get_event gave us an EOF, return that. */
2971 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2972 && UNSIGNED_CMP (XFASTINT (c
), <,
2973 SCHARS (KVAR (current_kboard
,
2974 Vkeyboard_translate_table
))))
2975 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2976 && UNSIGNED_CMP (XFASTINT (c
), <,
2977 ASIZE (KVAR (current_kboard
,
2978 Vkeyboard_translate_table
))))
2979 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2983 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2984 /* nil in keyboard-translate-table means no translation. */
2990 /* If this event is a mouse click in the menu bar,
2991 return just menu-bar for now. Modify the mouse click event
2992 so we won't do this twice, then queue it up. */
2993 if (EVENT_HAS_PARAMETERS (c
)
2995 && CONSP (EVENT_START (c
))
2996 && CONSP (XCDR (EVENT_START (c
))))
3000 posn
= POSN_POSN (EVENT_START (c
));
3001 /* Handle menu-bar events:
3002 insert the dummy prefix event `menu-bar'. */
3003 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3005 /* Change menu-bar to (menu-bar) as the event "position". */
3006 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3009 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3014 /* Store these characters into recent_keys, the dribble file if any,
3015 and the keyboard macro being defined, if any. */
3017 if (! NILP (also_record
))
3018 record_char (also_record
);
3020 /* Wipe the echo area.
3021 But first, if we are about to use an input method,
3022 save the echo area contents for it to refer to. */
3024 && ! NILP (Vinput_method_function
)
3025 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3027 previous_echo_area_message
= Fcurrent_message ();
3028 Vinput_method_previous_message
= previous_echo_area_message
;
3031 /* Now wipe the echo area, except for help events which do their
3032 own stuff with the echo area. */
3034 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3035 && !(EQ (Qswitch_frame
, XCAR (c
)))
3036 /* Don't wipe echo area for select window events: These might
3037 get delayed via `mouse-autoselect-window' (Bug#11304). */
3038 && !(EQ (Qselect_window
, XCAR (c
)))))
3040 if (!NILP (echo_area_buffer
[0]))
3042 safe_run_hooks (Qecho_area_clear_hook
);
3043 clear_message (1, 0);
3047 reread_for_input_method
:
3049 /* Pass this to the input method, if appropriate. */
3051 && ! NILP (Vinput_method_function
)
3052 /* Don't run the input method within a key sequence,
3053 after the first event of the key sequence. */
3054 && NILP (prev_event
)
3055 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3058 ptrdiff_t key_count
;
3059 bool key_count_reset
;
3060 struct gcpro gcpro1
;
3061 ptrdiff_t count
= SPECPDL_INDEX ();
3063 /* Save the echo status. */
3064 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3065 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3066 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3067 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3070 if (before_command_restore_flag
)
3072 this_command_key_count
= before_command_key_count_1
;
3073 if (this_command_key_count
< this_single_command_key_start
)
3074 this_single_command_key_start
= this_command_key_count
;
3075 echo_truncate (before_command_echo_length_1
);
3076 before_command_restore_flag
= 0;
3080 /* Save the this_command_keys status. */
3081 key_count
= this_command_key_count
;
3082 key_count_reset
= this_command_key_count_reset
;
3085 keys
= Fcopy_sequence (this_command_keys
);
3090 /* Clear out this_command_keys. */
3091 this_command_key_count
= 0;
3092 this_command_key_count_reset
= 0;
3094 /* Now wipe the echo area. */
3095 if (!NILP (echo_area_buffer
[0]))
3096 safe_run_hooks (Qecho_area_clear_hook
);
3097 clear_message (1, 0);
3100 /* If we are not reading a key sequence,
3101 never use the echo area. */
3104 specbind (Qinput_method_use_echo_area
, Qt
);
3107 /* Call the input method. */
3108 tem
= call1 (Vinput_method_function
, c
);
3110 tem
= unbind_to (count
, tem
);
3112 /* Restore the saved echoing state
3113 and this_command_keys state. */
3114 this_command_key_count
= key_count
;
3115 this_command_key_count_reset
= key_count_reset
;
3117 this_command_keys
= keys
;
3120 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3121 kset_echo_string (current_kboard
, saved_echo_string
);
3122 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3123 if (saved_immediate_echo
)
3128 /* The input method can return no events. */
3131 /* Bring back the previous message, if any. */
3132 if (! NILP (previous_echo_area_message
))
3133 message_with_string ("%s", previous_echo_area_message
, 0);
3136 /* It returned one event or more. */
3138 Vunread_post_input_method_events
3139 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3144 /* Display help if not echoing. */
3145 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3147 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3148 Lisp_Object help
, object
, position
, window
, htem
;
3150 htem
= Fcdr (XCDR (c
));
3153 window
= Fcar (htem
);
3155 object
= Fcar (htem
);
3157 position
= Fcar (htem
);
3159 show_help_echo (help
, window
, object
, position
);
3161 /* We stopped being idle for this event; undo that. */
3163 timer_resume_idle ();
3167 if ((! reread
|| this_command_key_count
== 0
3168 || this_command_key_count_reset
)
3172 /* Don't echo mouse motion events. */
3173 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3174 && NILP (Fzerop (Vecho_keystrokes
))
3175 && ! (EVENT_HAS_PARAMETERS (c
)
3176 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3179 if (! NILP (also_record
))
3180 echo_char (also_record
);
3181 /* Once we reread a character, echoing can happen
3182 the next time we pause to read a new one. */
3183 ok_to_echo_at_next_pause
= current_kboard
;
3186 /* Record this character as part of the current key. */
3187 add_command_key (c
);
3188 if (! NILP (also_record
))
3189 add_command_key (also_record
);
3192 last_input_event
= c
;
3195 /* Process the help character specially if enabled. */
3196 if (!NILP (Vhelp_form
) && help_char_p (c
))
3198 ptrdiff_t count
= SPECPDL_INDEX ();
3200 help_form_saved_window_configs
3201 = Fcons (Fcurrent_window_configuration (Qnil
),
3202 help_form_saved_window_configs
);
3203 record_unwind_protect_void (read_char_help_form_unwind
);
3204 call0 (Qhelp_form_show
);
3209 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3210 if (EVENT_HAS_PARAMETERS (c
)
3211 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3212 XSETCAR (help_form_saved_window_configs
, Qnil
);
3214 while (BUFFERP (c
));
3215 /* Remove the help from the frame. */
3216 unbind_to (count
, Qnil
);
3219 if (EQ (c
, make_number (040)))
3223 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3224 while (BUFFERP (c
));
3233 /* Record a key that came from a mouse menu.
3234 Record it for echoing, for this-command-keys, and so on. */
3237 record_menu_key (Lisp_Object c
)
3239 /* Wipe the echo area. */
3240 clear_message (1, 0);
3245 before_command_key_count
= this_command_key_count
;
3246 before_command_echo_length
= echo_length ();
3249 /* Don't echo mouse motion events. */
3250 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3251 && NILP (Fzerop (Vecho_keystrokes
)))
3255 /* Once we reread a character, echoing can happen
3256 the next time we pause to read a new one. */
3257 ok_to_echo_at_next_pause
= 0;
3260 /* Record this character as part of the current key. */
3261 add_command_key (c
);
3263 /* Re-reading in the middle of a command. */
3264 last_input_event
= c
;
3268 /* Return true if should recognize C as "the help character". */
3271 help_char_p (Lisp_Object c
)
3275 if (EQ (c
, Vhelp_char
))
3277 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3278 if (EQ (c
, XCAR (tail
)))
3283 /* Record the input event C in various ways. */
3286 record_char (Lisp_Object c
)
3290 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3292 /* To avoid filling recent_keys with help-echo and mouse-movement
3293 events, we filter out repeated help-echo events, only store the
3294 first and last in a series of mouse-movement events, and don't
3295 store repeated help-echo events which are only separated by
3296 mouse-movement events. */
3298 Lisp_Object ev1
, ev2
, ev3
;
3301 if ((ix1
= recent_keys_index
- 1) < 0)
3302 ix1
= NUM_RECENT_KEYS
- 1;
3303 ev1
= AREF (recent_keys
, ix1
);
3305 if ((ix2
= ix1
- 1) < 0)
3306 ix2
= NUM_RECENT_KEYS
- 1;
3307 ev2
= AREF (recent_keys
, ix2
);
3309 if ((ix3
= ix2
- 1) < 0)
3310 ix3
= NUM_RECENT_KEYS
- 1;
3311 ev3
= AREF (recent_keys
, ix3
);
3313 if (EQ (XCAR (c
), Qhelp_echo
))
3315 /* Don't record `help-echo' in recent_keys unless it shows some help
3316 message, and a different help than the previously recorded
3318 Lisp_Object help
, last_help
;
3320 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3321 if (!STRINGP (help
))
3323 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3324 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3326 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3327 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3328 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3330 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3331 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3332 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3333 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3336 else if (EQ (XCAR (c
), Qmouse_movement
))
3338 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3339 So additional mouse movement events replace the last element. */
3340 Lisp_Object last_window
, window
;
3342 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3343 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3344 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3345 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3346 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3348 ASET (recent_keys
, ix1
, c
);
3354 store_kbd_macro_char (c
);
3358 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3359 ASET (recent_keys
, recent_keys_index
, c
);
3360 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3361 recent_keys_index
= 0;
3363 else if (recorded
< 0)
3365 /* We need to remove one or two events from recent_keys.
3366 To do this, we simply put nil at those events and move the
3367 recent_keys_index backwards over those events. Usually,
3368 users will never see those nil events, as they will be
3369 overwritten by the command keys entered to see recent_keys
3372 while (recorded
++ < 0 && total_keys
> 0)
3374 if (total_keys
< NUM_RECENT_KEYS
)
3376 if (--recent_keys_index
< 0)
3377 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3378 ASET (recent_keys
, recent_keys_index
, Qnil
);
3382 num_nonmacro_input_events
++;
3384 /* Write c to the dribble file. If c is a lispy event, write
3385 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3386 If you, dear reader, have a better idea, you've got the source. :-) */
3392 if (XUINT (c
) < 0x100)
3393 putc (XUINT (c
), dribble
);
3395 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3399 Lisp_Object dribblee
;
3401 /* If it's a structured event, take the event header. */
3402 dribblee
= EVENT_HEAD (c
);
3404 if (SYMBOLP (dribblee
))
3406 putc ('<', dribble
);
3407 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3408 SBYTES (SYMBOL_NAME (dribblee
)),
3410 putc ('>', dribble
);
3419 /* Copy out or in the info on where C-g should throw to.
3420 This is used when running Lisp code from within get_char,
3421 in case get_char is called recursively.
3422 See read_process_output. */
3425 save_getcjmp (sys_jmp_buf temp
)
3427 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3431 restore_getcjmp (sys_jmp_buf temp
)
3433 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3436 /* Low level keyboard/mouse input.
3437 kbd_buffer_store_event places events in kbd_buffer, and
3438 kbd_buffer_get_event retrieves them. */
3440 /* Return true if there are any events in the queue that read-char
3441 would return. If this returns false, a read-char would block. */
3443 readable_events (int flags
)
3445 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3448 /* If the buffer contains only FOCUS_IN_EVENT events, and
3449 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3450 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3452 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3453 #ifdef USE_TOOLKIT_SCROLL_BARS
3454 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3458 struct input_event
*event
;
3460 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3467 #ifdef USE_TOOLKIT_SCROLL_BARS
3468 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3470 event
->kind
== FOCUS_IN_EVENT
)
3471 #ifdef USE_TOOLKIT_SCROLL_BARS
3472 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3473 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3474 && event
->part
== scroll_bar_handle
3475 && event
->modifiers
== 0)
3480 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3483 while (event
!= kbd_store_ptr
);
3489 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3490 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3494 if (current_kboard
->kbd_queue_has_data
)
3500 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3501 if (kb
->kbd_queue_has_data
)
3507 /* Set this for debugging, to have a way to get out */
3508 int stop_character EXTERNALLY_VISIBLE
;
3511 event_to_kboard (struct input_event
*event
)
3513 /* Not applicable for these special events. */
3514 if (event
->kind
== SELECTION_REQUEST_EVENT
3515 || event
->kind
== SELECTION_CLEAR_EVENT
)
3519 Lisp_Object obj
= event
->frame_or_window
;
3520 /* There are some events that set this field to nil or string. */
3522 obj
= WINDOW_FRAME (XWINDOW (obj
));
3523 /* Also ignore dead frames here. */
3524 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3525 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3530 /* Return the number of slots occupied in kbd_buffer. */
3533 kbd_buffer_nr_stored (void)
3535 return kbd_fetch_ptr
== kbd_store_ptr
3537 : (kbd_fetch_ptr
< kbd_store_ptr
3538 ? kbd_store_ptr
- kbd_fetch_ptr
3539 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3540 + (kbd_store_ptr
- kbd_buffer
)));
3542 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3545 kbd_buffer_store_event (register struct input_event
*event
)
3547 kbd_buffer_store_event_hold (event
, 0);
3550 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3552 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3553 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3554 Else, if EVENT is a quit event, store the quit event
3555 in HOLD_QUIT, and return (thus ignoring further events).
3557 This is used to postpone the processing of the quit event until all
3558 subsequent input events have been parsed (and discarded). */
3561 kbd_buffer_store_event_hold (register struct input_event
*event
,
3562 struct input_event
*hold_quit
)
3564 if (event
->kind
== NO_EVENT
)
3567 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3570 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3572 register int c
= event
->code
& 0377;
3574 if (event
->modifiers
& ctrl_modifier
)
3575 c
= make_ctrl_char (c
);
3577 c
|= (event
->modifiers
3578 & (meta_modifier
| alt_modifier
3579 | hyper_modifier
| super_modifier
));
3583 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3584 struct input_event
*sp
;
3586 if (single_kboard
&& kb
!= current_kboard
)
3589 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3591 kb
->kbd_queue_has_data
= 1;
3592 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3594 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3597 if (event_to_kboard (sp
) == kb
)
3599 sp
->kind
= NO_EVENT
;
3600 sp
->frame_or_window
= Qnil
;
3609 *hold_quit
= *event
;
3613 /* If this results in a quit_char being returned to Emacs as
3614 input, set Vlast_event_frame properly. If this doesn't
3615 get returned to Emacs as an event, the next event read
3616 will set Vlast_event_frame again, so this is safe to do. */
3620 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3622 focus
= event
->frame_or_window
;
3623 internal_last_event_frame
= focus
;
3624 Vlast_event_frame
= focus
;
3627 handle_interrupt (0);
3631 if (c
&& c
== stop_character
)
3637 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3638 Just ignore the second one. */
3639 else if (event
->kind
== BUFFER_SWITCH_EVENT
3640 && kbd_fetch_ptr
!= kbd_store_ptr
3641 && ((kbd_store_ptr
== kbd_buffer
3642 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3643 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3646 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3647 kbd_store_ptr
= kbd_buffer
;
3649 /* Don't let the very last slot in the buffer become full,
3650 since that would make the two pointers equal,
3651 and that is indistinguishable from an empty buffer.
3652 Discard the event if it would fill the last slot. */
3653 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3655 *kbd_store_ptr
= *event
;
3658 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3660 /* Don't read keyboard input until we have processed kbd_buffer.
3661 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3662 hold_keyboard_input ();
3663 if (!noninteractive
)
3667 #endif /* subprocesses */
3670 /* If we're inside while-no-input, and this event qualifies
3671 as input, set quit-flag to cause an interrupt. */
3672 if (!NILP (Vthrow_on_input
)
3673 && event
->kind
!= FOCUS_IN_EVENT
3674 && event
->kind
!= HELP_EVENT
3675 && event
->kind
!= DEICONIFY_EVENT
)
3677 Vquit_flag
= Vthrow_on_input
;
3678 /* If we're inside a function that wants immediate quits,
3680 if (immediate_quit
&& NILP (Vinhibit_quit
))
3689 /* Put an input event back in the head of the event queue. */
3692 kbd_buffer_unget_event (register struct input_event
*event
)
3694 if (kbd_fetch_ptr
== kbd_buffer
)
3695 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3697 /* Don't let the very last slot in the buffer become full, */
3698 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3701 *kbd_fetch_ptr
= *event
;
3706 /* Generate a HELP_EVENT input_event and store it in the keyboard
3709 HELP is the help form.
3711 FRAME and WINDOW are the frame and window where the help is
3712 generated. OBJECT is the Lisp object where the help was found (a
3713 buffer, a string, an overlay, or nil if neither from a string nor
3714 from a buffer). POS is the position within OBJECT where the help
3718 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3719 Lisp_Object object
, ptrdiff_t pos
)
3721 struct input_event event
;
3725 event
.kind
= HELP_EVENT
;
3726 event
.frame_or_window
= frame
;
3728 event
.x
= WINDOWP (window
) ? window
: frame
;
3731 kbd_buffer_store_event (&event
);
3735 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3738 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3740 struct input_event event
;
3742 event
.kind
= HELP_EVENT
;
3743 event
.frame_or_window
= frame
;
3748 kbd_buffer_store_event (&event
);
3752 /* Discard any mouse events in the event buffer by setting them to
3755 discard_mouse_events (void)
3757 struct input_event
*sp
;
3758 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3760 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3763 if (sp
->kind
== MOUSE_CLICK_EVENT
3764 || sp
->kind
== WHEEL_EVENT
3765 || sp
->kind
== HORIZ_WHEEL_EVENT
3767 || sp
->kind
== GPM_CLICK_EVENT
3769 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3771 sp
->kind
= NO_EVENT
;
3777 /* Return true if there are any real events waiting in the event
3778 buffer, not counting `NO_EVENT's.
3780 Discard NO_EVENT events at the front of the input queue, possibly
3781 leaving the input queue empty if there are no real input events. */
3784 kbd_buffer_events_waiting (void)
3786 struct input_event
*sp
;
3788 for (sp
= kbd_fetch_ptr
;
3789 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3792 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3797 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3801 /* Clear input event EVENT. */
3804 clear_event (struct input_event
*event
)
3806 event
->kind
= NO_EVENT
;
3810 /* Read one event from the event buffer, waiting if necessary.
3811 The value is a Lisp object representing the event.
3812 The value is nil for an event that should be ignored,
3813 or that was handled here.
3814 We always read and discard one event. */
3817 kbd_buffer_get_event (KBOARD
**kbp
,
3818 bool *used_mouse_menu
,
3819 struct timespec
*end_time
)
3824 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3826 /* Start reading input again because we have processed enough to
3827 be able to accept new events again. */
3828 unhold_keyboard_input ();
3831 #endif /* subprocesses */
3833 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3835 /* In case we are running as a daemon, only do this before
3836 detaching from the terminal. */
3837 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3841 *kbp
= current_kboard
;
3844 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3846 /* Wait until there is input available. */
3849 /* Break loop if there's an unread command event. Needed in
3850 moused window autoselection which uses a timer to insert such
3852 if (CONSP (Vunread_command_events
))
3855 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3857 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3860 /* If the quit flag is set, then read_char will return
3861 quit_char, so that counts as "available input." */
3862 if (!NILP (Vquit_flag
))
3863 quit_throw_to_read_char (0);
3865 /* One way or another, wait until input is available; then, if
3866 interrupt handlers have not read it, read it now. */
3871 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3873 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3877 struct timespec now
= current_timespec ();
3878 if (timespec_cmp (*end_time
, now
) <= 0)
3879 return Qnil
; /* Finished waiting. */
3882 struct timespec duration
= timespec_sub (*end_time
, now
);
3883 wait_reading_process_output (min (duration
.tv_sec
,
3886 -1, 1, Qnil
, NULL
, 0);
3891 bool do_display
= true;
3893 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3895 struct tty_display_info
*tty
= CURTTY ();
3897 /* When this TTY is displaying a menu, we must prevent
3898 any redisplay, because we modify the frame's glyph
3899 matrix behind the back of the display engine. */
3900 if (tty
->showing_menu
)
3904 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3907 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3911 if (CONSP (Vunread_command_events
))
3914 first
= XCAR (Vunread_command_events
);
3915 Vunread_command_events
= XCDR (Vunread_command_events
);
3916 *kbp
= current_kboard
;
3920 /* At this point, we know that there is a readable event available
3921 somewhere. If the event queue is empty, then there must be a
3922 mouse movement enabled and available. */
3923 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3925 struct input_event
*event
;
3927 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3931 *kbp
= event_to_kboard (event
);
3933 *kbp
= current_kboard
; /* Better than returning null ptr? */
3937 /* These two kinds of events get special handling
3938 and don't actually appear to the command loop.
3939 We return nil for them. */
3940 if (event
->kind
== SELECTION_REQUEST_EVENT
3941 || event
->kind
== SELECTION_CLEAR_EVENT
)
3944 struct input_event copy
;
3946 /* Remove it from the buffer before processing it,
3947 since otherwise swallow_events will see it
3948 and process it again. */
3950 kbd_fetch_ptr
= event
+ 1;
3951 input_pending
= readable_events (0);
3952 x_handle_selection_event (©
);
3954 /* We're getting selection request events, but we don't have
3960 #if defined (HAVE_NS)
3961 else if (event
->kind
== NS_TEXT_EVENT
)
3963 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3964 obj
= list1 (intern ("ns-put-working-text"));
3966 obj
= list1 (intern ("ns-unput-working-text"));
3967 kbd_fetch_ptr
= event
+ 1;
3968 if (used_mouse_menu
)
3969 *used_mouse_menu
= 1;
3973 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3974 || defined (HAVE_NS)
3975 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3977 /* Make an event (delete-frame (FRAME)). */
3978 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3979 kbd_fetch_ptr
= event
+ 1;
3982 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3983 || defined (HAVE_NS)
3984 else if (event
->kind
== ICONIFY_EVENT
)
3986 /* Make an event (iconify-frame (FRAME)). */
3987 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3988 kbd_fetch_ptr
= event
+ 1;
3990 else if (event
->kind
== DEICONIFY_EVENT
)
3992 /* Make an event (make-frame-visible (FRAME)). */
3993 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3994 kbd_fetch_ptr
= event
+ 1;
3997 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3999 /* The value doesn't matter here; only the type is tested. */
4000 XSETBUFFER (obj
, current_buffer
);
4001 kbd_fetch_ptr
= event
+ 1;
4003 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4004 || defined (HAVE_NS) || defined (USE_GTK)
4005 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4007 kbd_fetch_ptr
= event
+ 1;
4008 input_pending
= readable_events (0);
4009 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4010 x_activate_menubar (XFRAME (event
->frame_or_window
));
4014 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4016 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4017 obj
= list4 (Qlanguage_change
,
4018 event
->frame_or_window
,
4019 make_number (event
->code
),
4020 make_number (event
->modifiers
));
4021 kbd_fetch_ptr
= event
+ 1;
4024 #ifdef USE_FILE_NOTIFY
4025 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4027 #ifdef HAVE_W32NOTIFY
4028 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4029 obj
= list3 (Qfile_notify
,
4030 list3 (make_number (event
->code
),
4033 event
->frame_or_window
);
4035 obj
= make_lispy_event (event
);
4037 kbd_fetch_ptr
= event
+ 1;
4039 #endif /* USE_FILE_NOTIFY */
4040 else if (event
->kind
== SAVE_SESSION_EVENT
)
4042 obj
= list2 (Qsave_session
, event
->arg
);
4043 kbd_fetch_ptr
= event
+ 1;
4045 /* Just discard these, by returning nil.
4046 With MULTI_KBOARD, these events are used as placeholders
4047 when we need to randomly delete events from the queue.
4048 (They shouldn't otherwise be found in the buffer,
4049 but on some machines it appears they do show up
4050 even without MULTI_KBOARD.) */
4051 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4052 mouse events during a popup-menu call. */
4053 else if (event
->kind
== NO_EVENT
)
4054 kbd_fetch_ptr
= event
+ 1;
4055 else if (event
->kind
== HELP_EVENT
)
4057 Lisp_Object object
, position
, help
, frame
, window
;
4059 frame
= event
->frame_or_window
;
4060 object
= event
->arg
;
4061 position
= make_number (event
->code
);
4064 clear_event (event
);
4066 kbd_fetch_ptr
= event
+ 1;
4067 if (!WINDOWP (window
))
4069 obj
= Fcons (Qhelp_echo
,
4070 list5 (frame
, help
, window
, object
, position
));
4072 else if (event
->kind
== FOCUS_IN_EVENT
)
4074 /* Notification of a FocusIn event. The frame receiving the
4075 focus is in event->frame_or_window. Generate a
4076 switch-frame event if necessary. */
4077 Lisp_Object frame
, focus
;
4079 frame
= event
->frame_or_window
;
4080 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4089 !EQ (frame
, internal_last_event_frame
)
4090 && !EQ (frame
, selected_frame
))
4091 obj
= make_lispy_switch_frame (frame
);
4093 obj
= make_lispy_focus_in (frame
);
4095 internal_last_event_frame
= frame
;
4096 kbd_fetch_ptr
= event
+ 1;
4098 else if (event
->kind
== FOCUS_OUT_EVENT
)
4100 #ifdef HAVE_WINDOW_SYSTEM
4103 Lisp_Object frame
= event
->frame_or_window
;
4104 bool focused
= false;
4106 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4107 focused
= di
->x_highlight_frame
!= 0;
4110 obj
= make_lispy_focus_out (frame
);
4112 #endif /* HAVE_WINDOW_SYSTEM */
4114 kbd_fetch_ptr
= event
+ 1;
4117 else if (event
->kind
== DBUS_EVENT
)
4119 obj
= make_lispy_event (event
);
4120 kbd_fetch_ptr
= event
+ 1;
4123 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4125 obj
= make_lispy_event (event
);
4126 kbd_fetch_ptr
= event
+ 1;
4130 /* If this event is on a different frame, return a switch-frame this
4131 time, and leave the event in the queue for next time. */
4135 frame
= event
->frame_or_window
;
4137 frame
= XCAR (frame
);
4138 else if (WINDOWP (frame
))
4139 frame
= WINDOW_FRAME (XWINDOW (frame
));
4141 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4145 if (! EQ (frame
, internal_last_event_frame
)
4146 && !EQ (frame
, selected_frame
))
4147 obj
= make_lispy_switch_frame (frame
);
4148 internal_last_event_frame
= frame
;
4150 /* If we didn't decide to make a switch-frame event, go ahead
4151 and build a real event from the queue entry. */
4155 obj
= make_lispy_event (event
);
4157 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4158 || defined (HAVE_NS) || defined (USE_GTK)
4159 /* If this was a menu selection, then set the flag to inhibit
4160 writing to last_nonmenu_event. Don't do this if the event
4161 we're returning is (menu-bar), though; that indicates the
4162 beginning of the menu sequence, and we might as well leave
4163 that as the `event with parameters' for this selection. */
4165 && !EQ (event
->frame_or_window
, event
->arg
)
4166 && (event
->kind
== MENU_BAR_EVENT
4167 || event
->kind
== TOOL_BAR_EVENT
))
4168 *used_mouse_menu
= 1;
4171 /* Certain system events are non-key events. */
4173 && event
->kind
== NS_NONKEY_EVENT
)
4174 *used_mouse_menu
= 1;
4177 /* Wipe out this event, to catch bugs. */
4178 clear_event (event
);
4179 kbd_fetch_ptr
= event
+ 1;
4183 /* Try generating a mouse motion event. */
4184 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4186 struct frame
*f
= some_mouse_moved ();
4187 Lisp_Object bar_window
;
4188 enum scroll_bar_part part
;
4192 *kbp
= current_kboard
;
4193 /* Note that this uses F to determine which terminal to look at.
4194 If there is no valid info, it does not store anything
4195 so x remains nil. */
4198 /* XXX Can f or mouse_position_hook be NULL here? */
4199 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4200 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4205 /* Decide if we should generate a switch-frame event. Don't
4206 generate switch-frame events for motion outside of all Emacs
4212 frame
= FRAME_FOCUS_FRAME (f
);
4214 XSETFRAME (frame
, f
);
4216 if (! EQ (frame
, internal_last_event_frame
)
4217 && !EQ (frame
, selected_frame
))
4218 obj
= make_lispy_switch_frame (frame
);
4219 internal_last_event_frame
= frame
;
4222 /* If we didn't decide to make a switch-frame event, go ahead and
4223 return a mouse-motion event. */
4224 if (!NILP (x
) && NILP (obj
))
4225 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4228 /* We were promised by the above while loop that there was
4229 something for us to read! */
4232 input_pending
= readable_events (0);
4234 Vlast_event_frame
= internal_last_event_frame
;
4239 /* Process any non-user-visible events (currently X selection events),
4240 without reading any user-visible events. */
4243 process_special_events (void)
4245 struct input_event
*event
;
4247 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4249 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4252 if (event
== kbd_store_ptr
)
4256 /* If we find a stored X selection request, handle it now. */
4257 if (event
->kind
== SELECTION_REQUEST_EVENT
4258 || event
->kind
== SELECTION_CLEAR_EVENT
)
4262 /* Remove the event from the fifo buffer before processing;
4263 otherwise swallow_events called recursively could see it
4264 and process it again. To do this, we move the events
4265 between kbd_fetch_ptr and EVENT one slot to the right,
4268 struct input_event copy
= *event
;
4269 struct input_event
*beg
4270 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4271 ? kbd_buffer
: kbd_fetch_ptr
;
4274 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4275 else if (event
< beg
)
4277 if (event
> kbd_buffer
)
4278 memmove (kbd_buffer
+ 1, kbd_buffer
,
4279 (event
- kbd_buffer
) * sizeof (struct input_event
));
4280 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4281 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4282 memmove (beg
+ 1, beg
,
4283 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4284 * sizeof (struct input_event
));
4287 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4288 kbd_fetch_ptr
= kbd_buffer
+ 1;
4292 input_pending
= readable_events (0);
4293 x_handle_selection_event (©
);
4295 /* We're getting selection request events, but we don't have
4303 /* Process any events that are not user-visible, run timer events that
4304 are ripe, and return, without reading any user-visible events. */
4307 swallow_events (bool do_display
)
4309 unsigned old_timers_run
;
4311 process_special_events ();
4313 old_timers_run
= timers_run
;
4314 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4316 if (timers_run
!= old_timers_run
&& do_display
)
4317 redisplay_preserve_echo_area (7);
4320 /* Record the start of when Emacs is idle,
4321 for the sake of running idle-time timers. */
4324 timer_start_idle (void)
4326 /* If we are already in the idle state, do nothing. */
4327 if (timespec_valid_p (timer_idleness_start_time
))
4330 timer_idleness_start_time
= current_timespec ();
4331 timer_last_idleness_start_time
= timer_idleness_start_time
;
4333 /* Mark all idle-time timers as once again candidates for running. */
4334 call0 (intern ("internal-timer-start-idle"));
4337 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4340 timer_stop_idle (void)
4342 timer_idleness_start_time
= invalid_timespec ();
4345 /* Resume idle timer from last idle start time. */
4348 timer_resume_idle (void)
4350 if (timespec_valid_p (timer_idleness_start_time
))
4353 timer_idleness_start_time
= timer_last_idleness_start_time
;
4356 /* This is only for debugging. */
4357 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4359 /* List of elisp functions to call, delayed because they were generated in
4360 a context where Elisp could not be safely run (e.g. redisplay, signal,
4361 ...). Each element has the form (FUN . ARGS). */
4362 Lisp_Object pending_funcalls
;
4364 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4366 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4368 Lisp_Object
*vector
;
4370 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4372 vector
= XVECTOR (timer
)->contents
;
4373 if (! NILP (vector
[0]))
4376 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4381 /* Check whether a timer has fired. To prevent larger problems we simply
4382 disregard elements that are not proper timers. Do not make a circular
4383 timer list for the time being.
4385 Returns the time to wait until the next timer fires. If a
4386 timer is triggering now, return zero.
4387 If no timer is active, return -1.
4389 If a timer is ripe, we run it, with quitting turned off.
4390 In that case we return 0 to indicate that a new timer_check_2 call
4393 static struct timespec
4394 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4396 struct timespec nexttime
;
4397 struct timespec now
;
4398 struct timespec idleness_now
;
4399 Lisp_Object chosen_timer
;
4400 struct gcpro gcpro1
;
4402 nexttime
= invalid_timespec ();
4404 chosen_timer
= Qnil
;
4405 GCPRO1 (chosen_timer
);
4407 /* First run the code that was delayed. */
4408 while (CONSP (pending_funcalls
))
4410 Lisp_Object funcall
= XCAR (pending_funcalls
);
4411 pending_funcalls
= XCDR (pending_funcalls
);
4412 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4415 if (CONSP (timers
) || CONSP (idle_timers
))
4417 now
= current_timespec ();
4418 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4419 ? timespec_sub (now
, timer_idleness_start_time
)
4420 : make_timespec (0, 0));
4423 while (CONSP (timers
) || CONSP (idle_timers
))
4425 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4426 struct timespec timer_time
, idle_timer_time
;
4427 struct timespec difference
;
4428 struct timespec timer_difference
= invalid_timespec ();
4429 struct timespec idle_timer_difference
= invalid_timespec ();
4430 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4432 /* Set TIMER and TIMER_DIFFERENCE
4433 based on the next ordinary timer.
4434 TIMER_DIFFERENCE is the distance in time from NOW to when
4435 this timer becomes ripe (negative if it's already ripe).
4436 Skip past invalid timers and timers already handled. */
4439 timer
= XCAR (timers
);
4440 if (! decode_timer (timer
, &timer_time
))
4442 timers
= XCDR (timers
);
4446 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4447 timer_difference
= (timer_ripe
4448 ? timespec_sub (now
, timer_time
)
4449 : timespec_sub (timer_time
, now
));
4452 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4453 based on the next idle timer. */
4454 if (CONSP (idle_timers
))
4456 idle_timer
= XCAR (idle_timers
);
4457 if (! decode_timer (idle_timer
, &idle_timer_time
))
4459 idle_timers
= XCDR (idle_timers
);
4463 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4464 idle_timer_difference
4466 ? timespec_sub (idleness_now
, idle_timer_time
)
4467 : timespec_sub (idle_timer_time
, idleness_now
));
4470 /* Decide which timer is the next timer,
4471 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4472 Also step down the list where we found that timer. */
4474 if (timespec_valid_p (timer_difference
)
4475 && (! timespec_valid_p (idle_timer_difference
)
4476 || idle_timer_ripe
< timer_ripe
4477 || (idle_timer_ripe
== timer_ripe
4479 ? timespec_cmp (idle_timer_difference
,
4481 : timespec_cmp (timer_difference
,
4482 idle_timer_difference
))
4485 chosen_timer
= timer
;
4486 timers
= XCDR (timers
);
4487 difference
= timer_difference
;
4492 chosen_timer
= idle_timer
;
4493 idle_timers
= XCDR (idle_timers
);
4494 difference
= idle_timer_difference
;
4495 ripe
= idle_timer_ripe
;
4498 /* If timer is ripe, run it if it hasn't been run. */
4501 if (NILP (AREF (chosen_timer
, 0)))
4503 ptrdiff_t count
= SPECPDL_INDEX ();
4504 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4506 /* Mark the timer as triggered to prevent problems if the lisp
4507 code fails to reschedule it right. */
4508 ASET (chosen_timer
, 0, Qt
);
4510 specbind (Qinhibit_quit
, Qt
);
4512 call1 (Qtimer_event_handler
, chosen_timer
);
4513 Vdeactivate_mark
= old_deactivate_mark
;
4515 unbind_to (count
, Qnil
);
4517 /* Since we have handled the event,
4518 we don't need to tell the caller to wake up and do it. */
4519 /* But the caller must still wait for the next timer, so
4520 return 0 to indicate that. */
4523 nexttime
= make_timespec (0, 0);
4527 /* When we encounter a timer that is still waiting,
4528 return the amount of time to wait before it is ripe. */
4535 /* No timers are pending in the future. */
4536 /* Return 0 if we generated an event, and -1 if not. */
4542 /* Check whether a timer has fired. To prevent larger problems we simply
4543 disregard elements that are not proper timers. Do not make a circular
4544 timer list for the time being.
4546 Returns the time to wait until the next timer fires.
4547 If no timer is active, return an invalid value.
4549 As long as any timer is ripe, we run it. */
4554 struct timespec nexttime
;
4555 Lisp_Object timers
, idle_timers
;
4556 struct gcpro gcpro1
, gcpro2
;
4558 Lisp_Object tem
= Vinhibit_quit
;
4561 /* We use copies of the timers' lists to allow a timer to add itself
4562 again, without locking up Emacs if the newly added timer is
4563 already ripe when added. */
4565 /* Always consider the ordinary timers. */
4566 timers
= Fcopy_sequence (Vtimer_list
);
4567 /* Consider the idle timers only if Emacs is idle. */
4568 if (timespec_valid_p (timer_idleness_start_time
))
4569 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4573 Vinhibit_quit
= tem
;
4575 GCPRO2 (timers
, idle_timers
);
4579 nexttime
= timer_check_2 (timers
, idle_timers
);
4581 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4587 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4588 doc
: /* Return the current length of Emacs idleness, or nil.
4589 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4590 in the same style as (current-time).
4592 The value when Emacs is not idle is nil.
4594 PSEC is a multiple of the system clock resolution. */)
4597 if (timespec_valid_p (timer_idleness_start_time
))
4598 return make_lisp_time (timespec_sub (current_timespec (),
4599 timer_idleness_start_time
));
4604 /* Caches for modify_event_symbol. */
4605 static Lisp_Object accent_key_syms
;
4606 static Lisp_Object func_key_syms
;
4607 static Lisp_Object mouse_syms
;
4608 static Lisp_Object wheel_syms
;
4609 static Lisp_Object drag_n_drop_syms
;
4611 /* This is a list of keysym codes for special "accent" characters.
4612 It parallels lispy_accent_keys. */
4614 static const int lispy_accent_codes
[] =
4616 #ifdef XK_dead_circumflex
4621 #ifdef XK_dead_grave
4626 #ifdef XK_dead_tilde
4631 #ifdef XK_dead_diaeresis
4636 #ifdef XK_dead_macron
4641 #ifdef XK_dead_degree
4646 #ifdef XK_dead_acute
4651 #ifdef XK_dead_cedilla
4656 #ifdef XK_dead_breve
4661 #ifdef XK_dead_ogonek
4666 #ifdef XK_dead_caron
4671 #ifdef XK_dead_doubleacute
4672 XK_dead_doubleacute
,
4676 #ifdef XK_dead_abovedot
4681 #ifdef XK_dead_abovering
4691 #ifdef XK_dead_belowdot
4696 #ifdef XK_dead_voiced_sound
4697 XK_dead_voiced_sound
,
4701 #ifdef XK_dead_semivoiced_sound
4702 XK_dead_semivoiced_sound
,
4718 /* This is a list of Lisp names for special "accent" characters.
4719 It parallels lispy_accent_codes. */
4721 static const char *const lispy_accent_keys
[] =
4739 "dead-voiced-sound",
4740 "dead-semivoiced-sound",
4746 #define FUNCTION_KEY_OFFSET 0x0
4748 const char *const lispy_function_keys
[] =
4752 0, /* VK_LBUTTON 0x01 */
4753 0, /* VK_RBUTTON 0x02 */
4754 "cancel", /* VK_CANCEL 0x03 */
4755 0, /* VK_MBUTTON 0x04 */
4757 0, 0, 0, /* 0x05 .. 0x07 */
4759 "backspace", /* VK_BACK 0x08 */
4760 "tab", /* VK_TAB 0x09 */
4762 0, 0, /* 0x0A .. 0x0B */
4764 "clear", /* VK_CLEAR 0x0C */
4765 "return", /* VK_RETURN 0x0D */
4767 0, 0, /* 0x0E .. 0x0F */
4769 0, /* VK_SHIFT 0x10 */
4770 0, /* VK_CONTROL 0x11 */
4771 0, /* VK_MENU 0x12 */
4772 "pause", /* VK_PAUSE 0x13 */
4773 "capslock", /* VK_CAPITAL 0x14 */
4774 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4776 "junja", /* VK_JUNJA 0x17 */
4777 "final", /* VK_FINAL 0x18 */
4778 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4780 "escape", /* VK_ESCAPE 0x1B */
4781 "convert", /* VK_CONVERT 0x1C */
4782 "non-convert", /* VK_NONCONVERT 0x1D */
4783 "accept", /* VK_ACCEPT 0x1E */
4784 "mode-change", /* VK_MODECHANGE 0x1F */
4785 0, /* VK_SPACE 0x20 */
4786 "prior", /* VK_PRIOR 0x21 */
4787 "next", /* VK_NEXT 0x22 */
4788 "end", /* VK_END 0x23 */
4789 "home", /* VK_HOME 0x24 */
4790 "left", /* VK_LEFT 0x25 */
4791 "up", /* VK_UP 0x26 */
4792 "right", /* VK_RIGHT 0x27 */
4793 "down", /* VK_DOWN 0x28 */
4794 "select", /* VK_SELECT 0x29 */
4795 "print", /* VK_PRINT 0x2A */
4796 "execute", /* VK_EXECUTE 0x2B */
4797 "snapshot", /* VK_SNAPSHOT 0x2C */
4798 "insert", /* VK_INSERT 0x2D */
4799 "delete", /* VK_DELETE 0x2E */
4800 "help", /* VK_HELP 0x2F */
4802 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4804 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4806 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4808 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4810 0, 0, 0, 0, 0, 0, 0, 0, 0,
4811 0, 0, 0, 0, 0, 0, 0, 0, 0,
4812 0, 0, 0, 0, 0, 0, 0, 0,
4814 "lwindow", /* VK_LWIN 0x5B */
4815 "rwindow", /* VK_RWIN 0x5C */
4816 "apps", /* VK_APPS 0x5D */
4819 "kp-0", /* VK_NUMPAD0 0x60 */
4820 "kp-1", /* VK_NUMPAD1 0x61 */
4821 "kp-2", /* VK_NUMPAD2 0x62 */
4822 "kp-3", /* VK_NUMPAD3 0x63 */
4823 "kp-4", /* VK_NUMPAD4 0x64 */
4824 "kp-5", /* VK_NUMPAD5 0x65 */
4825 "kp-6", /* VK_NUMPAD6 0x66 */
4826 "kp-7", /* VK_NUMPAD7 0x67 */
4827 "kp-8", /* VK_NUMPAD8 0x68 */
4828 "kp-9", /* VK_NUMPAD9 0x69 */
4829 "kp-multiply", /* VK_MULTIPLY 0x6A */
4830 "kp-add", /* VK_ADD 0x6B */
4831 "kp-separator", /* VK_SEPARATOR 0x6C */
4832 "kp-subtract", /* VK_SUBTRACT 0x6D */
4833 "kp-decimal", /* VK_DECIMAL 0x6E */
4834 "kp-divide", /* VK_DIVIDE 0x6F */
4835 "f1", /* VK_F1 0x70 */
4836 "f2", /* VK_F2 0x71 */
4837 "f3", /* VK_F3 0x72 */
4838 "f4", /* VK_F4 0x73 */
4839 "f5", /* VK_F5 0x74 */
4840 "f6", /* VK_F6 0x75 */
4841 "f7", /* VK_F7 0x76 */
4842 "f8", /* VK_F8 0x77 */
4843 "f9", /* VK_F9 0x78 */
4844 "f10", /* VK_F10 0x79 */
4845 "f11", /* VK_F11 0x7A */
4846 "f12", /* VK_F12 0x7B */
4847 "f13", /* VK_F13 0x7C */
4848 "f14", /* VK_F14 0x7D */
4849 "f15", /* VK_F15 0x7E */
4850 "f16", /* VK_F16 0x7F */
4851 "f17", /* VK_F17 0x80 */
4852 "f18", /* VK_F18 0x81 */
4853 "f19", /* VK_F19 0x82 */
4854 "f20", /* VK_F20 0x83 */
4855 "f21", /* VK_F21 0x84 */
4856 "f22", /* VK_F22 0x85 */
4857 "f23", /* VK_F23 0x86 */
4858 "f24", /* VK_F24 0x87 */
4860 0, 0, 0, 0, /* 0x88 .. 0x8B */
4861 0, 0, 0, 0, /* 0x8C .. 0x8F */
4863 "kp-numlock", /* VK_NUMLOCK 0x90 */
4864 "scroll", /* VK_SCROLL 0x91 */
4865 /* Not sure where the following block comes from.
4866 Windows headers have NEC and Fujitsu specific keys in
4867 this block, but nothing generic. */
4868 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4869 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4870 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4871 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4872 "kp-end", /* VK_NUMPAD_END 0x96 */
4873 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4874 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4875 "kp-up", /* VK_NUMPAD_UP 0x99 */
4876 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4877 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4878 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4879 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4881 0, 0, /* 0x9E .. 0x9F */
4884 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4885 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4886 * No other API or message will distinguish left and right keys this way.
4891 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4892 to enable them selectively, and gives access to a few more functions.
4893 See lispy_multimedia_keys below. */
4894 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4895 0, 0, 0, /* 0xAD .. 0xAF Volume */
4896 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4897 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4899 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4900 0, 0, 0, 0, 0, 0, 0, 0, 0,
4902 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4903 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4904 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4907 "ax", /* VK_OEM_AX 0xE1 */
4908 0, /* VK_OEM_102 0xE2 */
4909 "ico-help", /* VK_ICO_HELP 0xE3 */
4910 "ico-00", /* VK_ICO_00 0xE4 */
4911 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4912 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4913 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4915 "reset", /* VK_OEM_RESET 0xE9 */
4916 "jump", /* VK_OEM_JUMP 0xEA */
4917 "oem-pa1", /* VK_OEM_PA1 0xEB */
4918 "oem-pa2", /* VK_OEM_PA2 0xEC */
4919 "oem-pa3", /* VK_OEM_PA3 0xED */
4920 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4921 "cusel", /* VK_OEM_CUSEL 0xEF */
4922 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4923 "finish", /* VK_OEM_FINISH 0xF1 */
4924 "copy", /* VK_OEM_COPY 0xF2 */
4925 "auto", /* VK_OEM_AUTO 0xF3 */
4926 "enlw", /* VK_OEM_ENLW 0xF4 */
4927 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4928 "attn", /* VK_ATTN 0xF6 */
4929 "crsel", /* VK_CRSEL 0xF7 */
4930 "exsel", /* VK_EXSEL 0xF8 */
4931 "ereof", /* VK_EREOF 0xF9 */
4932 "play", /* VK_PLAY 0xFA */
4933 "zoom", /* VK_ZOOM 0xFB */
4934 "noname", /* VK_NONAME 0xFC */
4935 "pa1", /* VK_PA1 0xFD */
4936 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4940 /* Some of these duplicate the "Media keys" on newer keyboards,
4941 but they are delivered to the application in a different way. */
4942 static const char *const lispy_multimedia_keys
[] =
4950 "browser-favorites",
4987 "toggle-dictate-command",
4993 "media-fast-forward",
4996 "media-channel-down"
4999 #else /* not HAVE_NTGUI */
5001 /* This should be dealt with in XTread_socket now, and that doesn't
5002 depend on the client system having the Kana syms defined. See also
5003 the XK_kana_A case below. */
5006 static const char *const lispy_kana_keys
[] =
5008 /* X Keysym value */
5009 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5010 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5011 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5012 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5013 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5014 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5015 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5016 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5017 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5018 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5019 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5020 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5021 "kana-i", "kana-u", "kana-e", "kana-o",
5022 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5023 "prolongedsound", "kana-A", "kana-I", "kana-U",
5024 "kana-E", "kana-O", "kana-KA", "kana-KI",
5025 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5026 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5027 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5028 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5029 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5030 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5031 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5032 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5033 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5034 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5035 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5036 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5038 #endif /* XK_kana_A */
5041 #define FUNCTION_KEY_OFFSET 0xff00
5043 /* You'll notice that this table is arranged to be conveniently
5044 indexed by X Windows keysym values. */
5045 static const char *const lispy_function_keys
[] =
5047 /* X Keysym value */
5049 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5050 "backspace", "tab", "linefeed", "clear",
5052 0, 0, 0, "pause", /* 0xff10...1f */
5053 0, 0, 0, 0, 0, 0, 0, "escape",
5055 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5056 "romaji", "hiragana", "katakana", "hiragana-katakana",
5057 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5058 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5059 "eisu-toggle", /* 0xff30...3f */
5060 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5061 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5063 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5064 "down", "prior", "next", "end",
5065 "begin", 0, 0, 0, 0, 0, 0, 0,
5066 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5077 "break", /* 0xff6b */
5080 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5081 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5082 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5083 0, 0, 0, 0, 0, 0, 0, 0,
5084 "kp-tab", /* 0xff89 */
5086 "kp-enter", /* 0xff8d */
5088 "kp-f1", /* 0xff91 */
5092 "kp-home", /* 0xff95 */
5097 "kp-prior", /* kp-page-up */
5098 "kp-next", /* kp-page-down */
5104 0, 0, 0, 0, 0, 0, 0, 0, 0,
5105 "kp-multiply", /* 0xffaa */
5110 "kp-divide", /* 0xffaf */
5111 "kp-0", /* 0xffb0 */
5112 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5115 "kp-equal", /* 0xffbd */
5116 "f1", /* 0xffbe */ /* IsFunctionKey */
5118 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5119 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5120 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5121 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5122 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5123 0, 0, 0, 0, 0, 0, 0, 0,
5124 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5125 0, 0, 0, 0, 0, 0, 0, "delete"
5128 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5129 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5131 static const char *const iso_lispy_function_keys
[] =
5133 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5134 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5135 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5136 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5137 "iso-lefttab", /* 0xfe20 */
5138 "iso-move-line-up", "iso-move-line-down",
5139 "iso-partial-line-up", "iso-partial-line-down",
5140 "iso-partial-space-left", "iso-partial-space-right",
5141 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5142 "iso-release-margin-left", "iso-release-margin-right",
5143 "iso-release-both-margins",
5144 "iso-fast-cursor-left", "iso-fast-cursor-right",
5145 "iso-fast-cursor-up", "iso-fast-cursor-down",
5146 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5147 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5150 #endif /* not HAVE_NTGUI */
5152 static Lisp_Object Vlispy_mouse_stem
;
5154 static const char *const lispy_wheel_names
[] =
5156 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5159 /* drag-n-drop events are generated when a set of selected files are
5160 dragged from another application and dropped onto an Emacs window. */
5161 static const char *const lispy_drag_n_drop_names
[] =
5166 /* Scroll bar parts. */
5167 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5168 Lisp_Object Qup
, Qdown
, Qbottom
;
5169 static Lisp_Object Qend_scroll
;
5171 static Lisp_Object Qratio
;
5173 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5174 static Lisp_Object
*const scroll_bar_parts
[] = {
5175 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5176 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5179 /* A vector, indexed by button number, giving the down-going location
5180 of currently depressed buttons, both scroll bar and non-scroll bar.
5182 The elements have the form
5183 (BUTTON-NUMBER MODIFIER-MASK . REST)
5184 where REST is the cdr of a position as it would be reported in the event.
5186 The make_lispy_event function stores positions here to tell the
5187 difference between click and drag events, and to store the starting
5188 location to be included in drag events. */
5190 static Lisp_Object button_down_location
;
5192 /* Information about the most recent up-going button event: Which
5193 button, what location, and what time. */
5195 static int last_mouse_button
;
5196 static int last_mouse_x
;
5197 static int last_mouse_y
;
5198 static Time button_down_time
;
5200 /* The number of clicks in this multiple-click. */
5202 static int double_click_count
;
5204 /* X and Y are frame-relative coordinates for a click or wheel event.
5205 Return a Lisp-style event list. */
5208 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5211 enum window_part part
;
5212 Lisp_Object posn
= Qnil
;
5213 Lisp_Object extra_info
= Qnil
;
5214 /* Coordinate pixel positions to return. */
5215 int xret
= 0, yret
= 0;
5216 /* The window under frame pixel coordinates (x,y) */
5217 Lisp_Object window
= f
5218 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5221 if (WINDOWP (window
))
5223 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5224 struct window
*w
= XWINDOW (window
);
5225 Lisp_Object string_info
= Qnil
;
5226 ptrdiff_t textpos
= -1;
5227 int col
= -1, row
= -1;
5228 int dx
= -1, dy
= -1;
5229 int width
= -1, height
= -1;
5230 Lisp_Object object
= Qnil
;
5232 /* Pixel coordinates relative to the window corner. */
5233 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5234 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5236 /* For text area clicks, return X, Y relative to the corner of
5237 this text area. Note that dX, dY etc are set below, by
5238 buffer_posn_from_coords. */
5239 if (part
== ON_TEXT
)
5241 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5242 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5244 /* For mode line and header line clicks, return X, Y relative to
5245 the left window edge. Use mode_line_string to look for a
5246 string on the click position. */
5247 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5252 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5253 /* Note that mode_line_string takes COL, ROW as pixels and
5254 converts them to characters. */
5257 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5258 &object
, &dx
, &dy
, &width
, &height
);
5259 if (STRINGP (string
))
5260 string_info
= Fcons (string
, make_number (charpos
));
5261 textpos
= (w
== XWINDOW (selected_window
)
5262 && current_buffer
== XBUFFER (w
->contents
))
5263 ? PT
: marker_position (w
->pointm
);
5268 /* For fringes and margins, Y is relative to the area's (and the
5269 window's) top edge, while X is meaningless. */
5270 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5275 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5278 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5279 &object
, &dx
, &dy
, &width
, &height
);
5280 if (STRINGP (string
))
5281 string_info
= Fcons (string
, make_number (charpos
));
5282 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5284 else if (part
== ON_LEFT_FRINGE
)
5286 posn
= Qleft_fringe
;
5289 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5290 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5291 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5293 else if (part
== ON_RIGHT_FRINGE
)
5295 posn
= Qright_fringe
;
5298 - window_box_width (w
, LEFT_MARGIN_AREA
)
5299 - window_box_width (w
, TEXT_AREA
)
5300 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5301 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5303 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5305 else if (part
== ON_VERTICAL_BORDER
)
5307 posn
= Qvertical_line
;
5312 /* Nothing special for part == ON_SCROLL_BAR. */
5313 else if (part
== ON_RIGHT_DIVIDER
)
5315 posn
= Qright_divider
;
5316 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5320 else if (part
== ON_BOTTOM_DIVIDER
)
5322 posn
= Qbottom_divider
;
5323 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5328 /* For clicks in the text area, fringes, or margins, call
5329 buffer_posn_from_coords to extract TEXTPOS, the buffer
5330 position nearest to the click. */
5333 Lisp_Object string2
, object2
= Qnil
;
5334 struct display_pos p
;
5336 int width2
, height2
;
5337 /* The pixel X coordinate passed to buffer_posn_from_coords
5338 is the X coordinate relative to the text area for
5339 text-area and right-margin clicks, zero otherwise. */
5341 = (part
== ON_TEXT
) ? xret
5342 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5343 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5347 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5348 &object2
, &dx2
, &dy2
,
5350 textpos
= CHARPOS (p
.pos
);
5351 if (col
< 0) col
= x2
;
5352 if (row
< 0) row
= y2
;
5353 if (dx
< 0) dx
= dx2
;
5354 if (dy
< 0) dy
= dy2
;
5355 if (width
< 0) width
= width2
;
5356 if (height
< 0) height
= height2
;
5360 posn
= make_number (textpos
);
5361 if (STRINGP (string2
))
5362 string_info
= Fcons (string2
,
5363 make_number (CHARPOS (p
.string_pos
)));
5369 #ifdef HAVE_WINDOW_SYSTEM
5370 if (IMAGEP (object
))
5372 Lisp_Object image_map
, hotspot
;
5373 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5375 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5377 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5378 posn
= XCAR (hotspot
);
5385 Fcons (make_number (dx
), make_number (dy
)),
5386 Fcons (make_number (width
), make_number (height
)));
5389 extra_info
= Fcons (string_info
,
5390 Fcons (make_number (textpos
),
5391 Fcons (Fcons (make_number (col
),
5396 XSETFRAME (window
, f
);
5400 return Fcons (window
,
5402 Fcons (Fcons (make_number (xret
),
5403 make_number (yret
)),
5404 Fcons (make_number (t
),
5408 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5409 menu bar. This really means that Emacs draws and manages the menu
5410 bar as part of its normal display, and therefore can compute its
5413 toolkit_menubar_in_use (struct frame
*f
)
5415 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5416 return !(!FRAME_WINDOW_P (f
));
5422 /* Given a struct input_event, build the lisp event which represents
5423 it. If EVENT is 0, build a mouse movement event from the mouse
5424 movement buffer, which should have a movement event in it.
5426 Note that events must be passed to this function in the order they
5427 are received; this function stores the location of button presses
5428 in order to build drag events when the button is released. */
5431 make_lispy_event (struct input_event
*event
)
5435 switch (event
->kind
)
5437 /* A simple keystroke. */
5438 case ASCII_KEYSTROKE_EVENT
:
5439 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5441 Lisp_Object lispy_c
;
5442 EMACS_INT c
= event
->code
;
5443 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5446 eassert (c
== event
->code
);
5447 /* Turn ASCII characters into control characters
5449 if (event
->modifiers
& ctrl_modifier
)
5451 c
= make_ctrl_char (c
);
5452 event
->modifiers
&= ~ctrl_modifier
;
5456 /* Add in the other modifier bits. The shift key was taken care
5457 of by the X code. */
5458 c
|= (event
->modifiers
5459 & (meta_modifier
| alt_modifier
5460 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5461 /* Distinguish Shift-SPC from SPC. */
5462 if ((event
->code
) == 040
5463 && event
->modifiers
& shift_modifier
)
5464 c
|= shift_modifier
;
5465 button_down_time
= 0;
5466 XSETFASTINT (lispy_c
, c
);
5471 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5472 except that they are non-key events (last-nonmenu-event is nil). */
5473 case NS_NONKEY_EVENT
:
5476 /* A function key. The symbol may need to have modifier prefixes
5478 case NON_ASCII_KEYSTROKE_EVENT
:
5479 button_down_time
= 0;
5481 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5482 if (event
->code
== lispy_accent_codes
[i
])
5483 return modify_event_symbol (i
,
5485 Qfunction_key
, Qnil
,
5486 lispy_accent_keys
, &accent_key_syms
,
5487 ARRAYELTS (lispy_accent_keys
));
5491 if (event
->code
>= 0x400 && event
->code
< 0x500)
5492 return modify_event_symbol (event
->code
- 0x400,
5493 event
->modifiers
& ~shift_modifier
,
5494 Qfunction_key
, Qnil
,
5495 lispy_kana_keys
, &func_key_syms
,
5496 ARRAYELTS (lispy_kana_keys
));
5497 #endif /* XK_kana_A */
5500 #ifdef ISO_FUNCTION_KEY_OFFSET
5501 if (event
->code
< FUNCTION_KEY_OFFSET
5502 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5503 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5505 Qfunction_key
, Qnil
,
5506 iso_lispy_function_keys
, &func_key_syms
,
5507 ARRAYELTS (iso_lispy_function_keys
));
5510 /* Handle system-specific or unknown keysyms. */
5511 if (event
->code
& (1 << 28)
5512 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5513 || (event
->code
- FUNCTION_KEY_OFFSET
5514 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5515 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5517 /* We need to use an alist rather than a vector as the cache
5518 since we can't make a vector long enough. */
5519 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5520 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5521 return modify_event_symbol (event
->code
,
5524 KVAR (current_kboard
, Vsystem_key_alist
),
5525 0, &KVAR (current_kboard
, system_key_syms
),
5529 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5531 Qfunction_key
, Qnil
,
5532 lispy_function_keys
, &func_key_syms
,
5533 ARRAYELTS (lispy_function_keys
));
5536 case MULTIMEDIA_KEY_EVENT
:
5537 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5538 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5540 return modify_event_symbol (event
->code
, event
->modifiers
,
5541 Qfunction_key
, Qnil
,
5542 lispy_multimedia_keys
, &func_key_syms
,
5543 ARRAYELTS (lispy_multimedia_keys
));
5548 /* A mouse click. Figure out where it is, decide whether it's
5549 a press, click or drag, and build the appropriate structure. */
5550 case MOUSE_CLICK_EVENT
:
5552 case GPM_CLICK_EVENT
:
5554 #ifndef USE_TOOLKIT_SCROLL_BARS
5555 case SCROLL_BAR_CLICK_EVENT
:
5558 int button
= event
->code
;
5560 Lisp_Object position
;
5561 Lisp_Object
*start_pos_ptr
;
5562 Lisp_Object start_pos
;
5566 /* Build the position as appropriate for this mouse click. */
5567 if (event
->kind
== MOUSE_CLICK_EVENT
5569 || event
->kind
== GPM_CLICK_EVENT
5573 struct frame
*f
= XFRAME (event
->frame_or_window
);
5576 /* Ignore mouse events that were made on frame that
5577 have been deleted. */
5578 if (! FRAME_LIVE_P (f
))
5581 /* EVENT->x and EVENT->y are frame-relative pixel
5582 coordinates at this place. Under old redisplay, COLUMN
5583 and ROW are set to frame relative glyph coordinates
5584 which are then used to determine whether this click is
5585 in a menu (non-toolkit version). */
5586 if (!toolkit_menubar_in_use (f
))
5588 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5589 &column
, &row
, NULL
, 1);
5591 /* In the non-toolkit version, clicks on the menu bar
5592 are ordinary button events in the event buffer.
5593 Distinguish them, and invoke the menu.
5595 (In the toolkit version, the toolkit handles the
5596 menu bar and Emacs doesn't know about it until
5597 after the user makes a selection.) */
5598 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5599 && (event
->modifiers
& down_modifier
))
5601 Lisp_Object items
, item
;
5603 /* Find the menu bar item under `column'. */
5605 items
= FRAME_MENU_BAR_ITEMS (f
);
5606 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5608 Lisp_Object pos
, string
;
5609 string
= AREF (items
, i
+ 1);
5610 pos
= AREF (items
, i
+ 3);
5613 if (column
>= XINT (pos
)
5614 && column
< XINT (pos
) + SCHARS (string
))
5616 item
= AREF (items
, i
);
5621 /* ELisp manual 2.4b says (x y) are window
5622 relative but code says they are
5624 position
= list4 (event
->frame_or_window
,
5626 Fcons (event
->x
, event
->y
),
5627 make_number (event
->timestamp
));
5629 return list2 (item
, position
);
5633 position
= make_lispy_position (f
, event
->x
, event
->y
,
5636 #ifndef USE_TOOLKIT_SCROLL_BARS
5639 /* It's a scrollbar click. */
5641 Lisp_Object portion_whole
;
5644 window
= event
->frame_or_window
;
5645 portion_whole
= Fcons (event
->x
, event
->y
);
5646 part
= *scroll_bar_parts
[(int) event
->part
];
5648 position
= list5 (window
, Qvertical_scroll_bar
,
5649 portion_whole
, make_number (event
->timestamp
),
5652 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5654 if (button
>= ASIZE (button_down_location
))
5656 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5657 button_down_location
= larger_vector (button_down_location
,
5659 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5662 start_pos_ptr
= aref_addr (button_down_location
, button
);
5663 start_pos
= *start_pos_ptr
;
5664 *start_pos_ptr
= Qnil
;
5667 /* On window-system frames, use the value of
5668 double-click-fuzz as is. On other frames, interpret it
5669 as a multiple of 1/8 characters. */
5673 if (WINDOWP (event
->frame_or_window
))
5674 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5675 else if (FRAMEP (event
->frame_or_window
))
5676 f
= XFRAME (event
->frame_or_window
);
5680 if (FRAME_WINDOW_P (f
))
5681 fuzz
= double_click_fuzz
;
5683 fuzz
= double_click_fuzz
/ 8;
5685 is_double
= (button
== last_mouse_button
5686 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5687 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5688 && button_down_time
!= 0
5689 && (EQ (Vdouble_click_time
, Qt
)
5690 || (NATNUMP (Vdouble_click_time
)
5691 && (event
->timestamp
- button_down_time
5692 < XFASTINT (Vdouble_click_time
)))));
5695 last_mouse_button
= button
;
5696 last_mouse_x
= XINT (event
->x
);
5697 last_mouse_y
= XINT (event
->y
);
5699 /* If this is a button press, squirrel away the location, so
5700 we can decide later whether it was a click or a drag. */
5701 if (event
->modifiers
& down_modifier
)
5705 double_click_count
++;
5706 event
->modifiers
|= ((double_click_count
> 2)
5711 double_click_count
= 1;
5712 button_down_time
= event
->timestamp
;
5713 *start_pos_ptr
= Fcopy_alist (position
);
5714 ignore_mouse_drag_p
= 0;
5717 /* Now we're releasing a button - check the co-ordinates to
5718 see if this was a click or a drag. */
5719 else if (event
->modifiers
& up_modifier
)
5721 /* If we did not see a down before this up, ignore the up.
5722 Probably this happened because the down event chose a
5723 menu item. It would be an annoyance to treat the
5724 release of the button that chose the menu item as a
5727 if (!CONSP (start_pos
))
5730 event
->modifiers
&= ~up_modifier
;
5733 Lisp_Object new_down
, down
;
5734 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5736 /* The third element of every position
5737 should be the (x,y) pair. */
5738 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5739 new_down
= Fcar (Fcdr (Fcdr (position
)));
5742 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5744 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5745 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5748 if (ignore_mouse_drag_p
)
5750 event
->modifiers
|= click_modifier
;
5751 ignore_mouse_drag_p
= 0;
5753 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5754 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5755 /* Maybe the mouse has moved a lot, caused scrolling, and
5756 eventually ended up at the same screen position (but
5757 not buffer position) in which case it is a drag, not
5759 /* FIXME: OTOH if the buffer position has changed
5760 because of a timer or process filter rather than
5761 because of mouse movement, it should be considered as
5762 a click. But mouse-drag-region completely ignores
5763 this case and it hasn't caused any real problem, so
5764 it's probably OK to ignore it as well. */
5765 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5766 /* Mouse hasn't moved (much). */
5767 event
->modifiers
|= click_modifier
;
5770 button_down_time
= 0;
5771 event
->modifiers
|= drag_modifier
;
5774 /* Don't check is_double; treat this as multiple
5775 if the down-event was multiple. */
5776 if (double_click_count
> 1)
5777 event
->modifiers
|= ((double_click_count
> 2)
5783 /* Every mouse event should either have the down_modifier or
5784 the up_modifier set. */
5788 /* Get the symbol we should use for the mouse click. */
5791 head
= modify_event_symbol (button
,
5793 Qmouse_click
, Vlispy_mouse_stem
,
5796 ASIZE (mouse_syms
));
5797 if (event
->modifiers
& drag_modifier
)
5798 return list3 (head
, start_pos
, position
);
5799 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5800 return list3 (head
, position
, make_number (double_click_count
));
5802 return list2 (head
, position
);
5807 case HORIZ_WHEEL_EVENT
:
5809 Lisp_Object position
;
5812 /* Build the position as appropriate for this mouse click. */
5813 struct frame
*f
= XFRAME (event
->frame_or_window
);
5815 /* Ignore wheel events that were made on frame that have been
5817 if (! FRAME_LIVE_P (f
))
5820 position
= make_lispy_position (f
, event
->x
, event
->y
,
5823 /* Set double or triple modifiers to indicate the wheel speed. */
5825 /* On window-system frames, use the value of
5826 double-click-fuzz as is. On other frames, interpret it
5827 as a multiple of 1/8 characters. */
5833 if (WINDOWP (event
->frame_or_window
))
5834 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5835 else if (FRAMEP (event
->frame_or_window
))
5836 fr
= XFRAME (event
->frame_or_window
);
5840 fuzz
= FRAME_WINDOW_P (fr
)
5841 ? double_click_fuzz
: double_click_fuzz
/ 8;
5843 if (event
->modifiers
& up_modifier
)
5845 /* Emit a wheel-up event. */
5846 event
->modifiers
&= ~up_modifier
;
5849 else if (event
->modifiers
& down_modifier
)
5851 /* Emit a wheel-down event. */
5852 event
->modifiers
&= ~down_modifier
;
5856 /* Every wheel event should either have the down_modifier or
5857 the up_modifier set. */
5860 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5863 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5864 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5865 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5866 && button_down_time
!= 0
5867 && (EQ (Vdouble_click_time
, Qt
)
5868 || (NATNUMP (Vdouble_click_time
)
5869 && (event
->timestamp
- button_down_time
5870 < XFASTINT (Vdouble_click_time
)))));
5873 double_click_count
++;
5874 event
->modifiers
|= ((double_click_count
> 2)
5880 double_click_count
= 1;
5881 event
->modifiers
|= click_modifier
;
5884 button_down_time
= event
->timestamp
;
5885 /* Use a negative value to distinguish wheel from mouse button. */
5886 last_mouse_button
= - (1 + symbol_num
);
5887 last_mouse_x
= XINT (event
->x
);
5888 last_mouse_y
= XINT (event
->y
);
5890 /* Get the symbol we should use for the wheel event. */
5891 head
= modify_event_symbol (symbol_num
,
5897 ASIZE (wheel_syms
));
5900 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5901 return list3 (head
, position
, make_number (double_click_count
));
5903 return list2 (head
, position
);
5907 #ifdef USE_TOOLKIT_SCROLL_BARS
5909 /* We don't have down and up events if using toolkit scroll bars,
5910 so make this always a click event. Store in the `part' of
5911 the Lisp event a symbol which maps to the following actions:
5913 `above_handle' page up
5914 `below_handle' page down
5918 `bottom' bottom of buffer
5919 `handle' thumb has been dragged.
5920 `end-scroll' end of interaction with scroll bar
5922 The incoming input_event contains in its `part' member an
5923 index of type `enum scroll_bar_part' which we can use as an
5924 index in scroll_bar_parts to get the appropriate symbol. */
5926 case SCROLL_BAR_CLICK_EVENT
:
5928 Lisp_Object position
, head
, window
, portion_whole
, part
;
5930 window
= event
->frame_or_window
;
5931 portion_whole
= Fcons (event
->x
, event
->y
);
5932 part
= *scroll_bar_parts
[(int) event
->part
];
5934 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5935 make_number (event
->timestamp
), part
);
5937 /* Always treat scroll bar events as clicks. */
5938 event
->modifiers
|= click_modifier
;
5939 event
->modifiers
&= ~up_modifier
;
5941 if (event
->code
>= ASIZE (mouse_syms
))
5942 mouse_syms
= larger_vector (mouse_syms
,
5943 event
->code
- ASIZE (mouse_syms
) + 1,
5946 /* Get the symbol we should use for the mouse click. */
5947 head
= modify_event_symbol (event
->code
,
5952 ASIZE (mouse_syms
));
5953 return list2 (head
, position
);
5956 #endif /* USE_TOOLKIT_SCROLL_BARS */
5958 case DRAG_N_DROP_EVENT
:
5961 Lisp_Object head
, position
;
5964 f
= XFRAME (event
->frame_or_window
);
5967 /* Ignore mouse events that were made on frames that
5968 have been deleted. */
5969 if (! FRAME_LIVE_P (f
))
5972 position
= make_lispy_position (f
, event
->x
, event
->y
,
5975 head
= modify_event_symbol (0, event
->modifiers
,
5977 lispy_drag_n_drop_names
,
5978 &drag_n_drop_syms
, 1);
5979 return list3 (head
, position
, files
);
5982 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5983 || defined (HAVE_NS) || defined (USE_GTK)
5984 case MENU_BAR_EVENT
:
5985 if (EQ (event
->arg
, event
->frame_or_window
))
5986 /* This is the prefix key. We translate this to
5987 `(menu_bar)' because the code in keyboard.c for menu
5988 events, which we use, relies on this. */
5989 return list1 (Qmenu_bar
);
5993 case SELECT_WINDOW_EVENT
:
5994 /* Make an event (select-window (WINDOW)). */
5995 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5997 case TOOL_BAR_EVENT
:
5998 if (EQ (event
->arg
, event
->frame_or_window
))
5999 /* This is the prefix key. We translate this to
6000 `(tool_bar)' because the code in keyboard.c for tool bar
6001 events, which we use, relies on this. */
6002 return list1 (Qtool_bar
);
6003 else if (SYMBOLP (event
->arg
))
6004 return apply_modifiers (event
->modifiers
, event
->arg
);
6007 case USER_SIGNAL_EVENT
:
6008 /* A user signal. */
6010 char *name
= find_user_signal_name (event
->code
);
6013 return intern (name
);
6016 case SAVE_SESSION_EVENT
:
6017 return Qsave_session
;
6022 return Fcons (Qdbus_event
, event
->arg
);
6024 #endif /* HAVE_DBUS */
6026 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6027 case FILE_NOTIFY_EVENT
:
6029 return Fcons (Qfile_notify
, event
->arg
);
6031 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6033 case CONFIG_CHANGED_EVENT
:
6034 return list3 (Qconfig_changed_event
,
6035 event
->arg
, event
->frame_or_window
);
6037 /* The 'kind' field of the event is something we don't recognize. */
6044 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6045 Lisp_Object x
, Lisp_Object y
, Time t
)
6047 /* Is it a scroll bar movement? */
6048 if (frame
&& ! NILP (bar_window
))
6050 Lisp_Object part_sym
;
6052 part_sym
= *scroll_bar_parts
[(int) part
];
6053 return list2 (Qscroll_bar_movement
,
6055 Qvertical_scroll_bar
,
6060 /* Or is it an ordinary mouse movement? */
6063 Lisp_Object position
;
6064 position
= make_lispy_position (frame
, x
, y
, t
);
6065 return list2 (Qmouse_movement
, position
);
6069 /* Construct a switch frame event. */
6071 make_lispy_switch_frame (Lisp_Object frame
)
6073 return list2 (Qswitch_frame
, frame
);
6077 make_lispy_focus_in (Lisp_Object frame
)
6079 return list2 (Qfocus_in
, frame
);
6082 #ifdef HAVE_WINDOW_SYSTEM
6085 make_lispy_focus_out (Lisp_Object frame
)
6087 return list2 (Qfocus_out
, frame
);
6090 #endif /* HAVE_WINDOW_SYSTEM */
6092 /* Manipulating modifiers. */
6094 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6096 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6097 SYMBOL's name of the end of the modifiers; the string from this
6098 position is the unmodified symbol name.
6100 This doesn't use any caches. */
6103 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6109 CHECK_SYMBOL (symbol
);
6112 name
= SYMBOL_NAME (symbol
);
6114 for (i
= 0; i
< SBYTES (name
) - 1; )
6116 ptrdiff_t this_mod_end
= 0;
6119 /* See if the name continues with a modifier word.
6120 Check that the word appears, but don't check what follows it.
6121 Set this_mod and this_mod_end to record what we find. */
6123 switch (SREF (name
, i
))
6125 #define SINGLE_LETTER_MOD(BIT) \
6126 (this_mod_end = i + 1, this_mod = BIT)
6129 SINGLE_LETTER_MOD (alt_modifier
);
6133 SINGLE_LETTER_MOD (ctrl_modifier
);
6137 SINGLE_LETTER_MOD (hyper_modifier
);
6141 SINGLE_LETTER_MOD (meta_modifier
);
6145 SINGLE_LETTER_MOD (shift_modifier
);
6149 SINGLE_LETTER_MOD (super_modifier
);
6152 #undef SINGLE_LETTER_MOD
6154 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6155 if (i + LEN + 1 <= SBYTES (name) \
6156 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6158 this_mod_end = i + LEN; \
6163 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6164 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6165 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6169 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6171 #undef MULTI_LETTER_MOD
6175 /* If we found no modifier, stop looking for them. */
6176 if (this_mod_end
== 0)
6179 /* Check there is a dash after the modifier, so that it
6180 really is a modifier. */
6181 if (this_mod_end
>= SBYTES (name
)
6182 || SREF (name
, this_mod_end
) != '-')
6185 /* This modifier is real; look for another. */
6186 modifiers
|= this_mod
;
6187 i
= this_mod_end
+ 1;
6190 /* Should we include the `click' modifier? */
6191 if (! (modifiers
& (down_modifier
| drag_modifier
6192 | double_modifier
| triple_modifier
))
6193 && i
+ 7 == SBYTES (name
)
6194 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6195 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6196 modifiers
|= click_modifier
;
6198 if (! (modifiers
& (double_modifier
| triple_modifier
))
6199 && i
+ 6 < SBYTES (name
)
6200 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6201 modifiers
|= click_modifier
;
6209 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6210 prepended to the string BASE[0..BASE_LEN-1].
6211 This doesn't use any caches. */
6213 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6215 /* Since BASE could contain nulls, we can't use intern here; we have
6216 to use Fintern, which expects a genuine Lisp_String, and keeps a
6218 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6224 /* Only the event queue may use the `up' modifier; it should always
6225 be turned into a click or drag event before presented to lisp code. */
6226 if (modifiers
& up_modifier
)
6229 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6230 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6231 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6232 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6233 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6234 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6235 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6236 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6237 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6238 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6239 /* The click modifier is denoted by the absence of other modifiers. */
6243 mod_len
= p
- new_mods
;
6247 Lisp_Object new_name
;
6249 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6250 mod_len
+ base_len_byte
);
6251 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6252 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6254 return Fintern (new_name
, Qnil
);
6259 static const char *const modifier_names
[] =
6261 "up", "down", "drag", "click", "double", "triple", 0, 0,
6262 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6263 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6265 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6267 static Lisp_Object modifier_symbols
;
6269 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6271 lispy_modifier_list (int modifiers
)
6273 Lisp_Object modifier_list
;
6276 modifier_list
= Qnil
;
6277 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6278 if (modifiers
& (1<<i
))
6279 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6282 return modifier_list
;
6286 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6287 where UNMODIFIED is the unmodified form of SYMBOL,
6288 MASK is the set of modifiers present in SYMBOL's name.
6289 This is similar to parse_modifiers_uncached, but uses the cache in
6290 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6291 Qevent_symbol_elements property. */
6293 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6296 parse_modifiers (Lisp_Object symbol
)
6298 Lisp_Object elements
;
6300 if (INTEGERP (symbol
))
6301 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6302 else if (!SYMBOLP (symbol
))
6305 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6306 if (CONSP (elements
))
6311 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6312 Lisp_Object unmodified
;
6315 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6316 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6319 if (modifiers
& ~INTMASK
)
6321 XSETFASTINT (mask
, modifiers
);
6322 elements
= list2 (unmodified
, mask
);
6324 /* Cache the parsing results on SYMBOL. */
6325 Fput (symbol
, Qevent_symbol_element_mask
,
6327 Fput (symbol
, Qevent_symbol_elements
,
6328 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6330 /* Since we know that SYMBOL is modifiers applied to unmodified,
6331 it would be nice to put that in unmodified's cache.
6332 But we can't, since we're not sure that parse_modifiers is
6339 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6340 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6341 doc
: /* Parse the event symbol. For internal use. */)
6342 (Lisp_Object symbol
)
6344 /* Fill the cache if needed. */
6345 parse_modifiers (symbol
);
6346 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6347 and use the Lispier representation stored on Qevent_symbol_elements
6349 return Fget (symbol
, Qevent_symbol_elements
);
6352 /* Apply the modifiers MODIFIERS to the symbol BASE.
6353 BASE must be unmodified.
6355 This is like apply_modifiers_uncached, but uses BASE's
6356 Qmodifier_cache property, if present. It also builds
6357 Qevent_symbol_elements properties, since it has that info anyway.
6359 apply_modifiers copies the value of BASE's Qevent_kind property to
6360 the modified symbol. */
6362 apply_modifiers (int modifiers
, Lisp_Object base
)
6364 Lisp_Object cache
, idx
, entry
, new_symbol
;
6366 /* Mask out upper bits. We don't know where this value's been. */
6367 modifiers
&= INTMASK
;
6369 if (INTEGERP (base
))
6370 return make_number (XINT (base
) | modifiers
);
6372 /* The click modifier never figures into cache indices. */
6373 cache
= Fget (base
, Qmodifier_cache
);
6374 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6375 entry
= assq_no_quit (idx
, cache
);
6378 new_symbol
= XCDR (entry
);
6381 /* We have to create the symbol ourselves. */
6382 new_symbol
= apply_modifiers_uncached (modifiers
,
6383 SSDATA (SYMBOL_NAME (base
)),
6384 SCHARS (SYMBOL_NAME (base
)),
6385 SBYTES (SYMBOL_NAME (base
)));
6387 /* Add the new symbol to the base's cache. */
6388 entry
= Fcons (idx
, new_symbol
);
6389 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6391 /* We have the parsing info now for free, so we could add it to
6393 XSETFASTINT (idx, modifiers);
6394 Fput (new_symbol, Qevent_symbol_element_mask,
6396 Fput (new_symbol, Qevent_symbol_elements,
6397 Fcons (base, lispy_modifier_list (modifiers)));
6398 Sadly, this is only correct if `base' is indeed a base event,
6399 which is not necessarily the case. -stef */
6402 /* Make sure this symbol is of the same kind as BASE.
6404 You'd think we could just set this once and for all when we
6405 intern the symbol above, but reorder_modifiers may call us when
6406 BASE's property isn't set right; we can't assume that just
6407 because it has a Qmodifier_cache property it must have its
6408 Qevent_kind set right as well. */
6409 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6413 kind
= Fget (base
, Qevent_kind
);
6415 Fput (new_symbol
, Qevent_kind
, kind
);
6422 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6423 return a symbol with the modifiers placed in the canonical order.
6424 Canonical order is alphabetical, except for down and drag, which
6425 always come last. The 'click' modifier is never written out.
6427 Fdefine_key calls this to make sure that (for example) C-M-foo
6428 and M-C-foo end up being equivalent in the keymap. */
6431 reorder_modifiers (Lisp_Object symbol
)
6433 /* It's hopefully okay to write the code this way, since everything
6434 will soon be in caches, and no consing will be done at all. */
6437 parsed
= parse_modifiers (symbol
);
6438 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6443 /* For handling events, we often want to produce a symbol whose name
6444 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6445 to some base, like the name of a function key or mouse button.
6446 modify_event_symbol produces symbols of this sort.
6448 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6449 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6452 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6453 into symbol names, or a string specifying a name stem used to
6454 construct a symbol name or the form `STEM-N', where N is the decimal
6455 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6456 non-nil; otherwise NAME_TABLE is used.
6458 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6459 persist between calls to modify_event_symbol that it can use to
6460 store a cache of the symbols it's generated for this NAME_TABLE
6461 before. The object stored there may be a vector or an alist.
6463 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6465 MODIFIERS is a set of modifier bits (as given in struct input_events)
6466 whose prefixes should be applied to the symbol name.
6468 SYMBOL_KIND is the value to be placed in the event_kind property of
6469 the returned symbol.
6471 The symbols we create are supposed to have an
6472 `event-symbol-elements' property, which lists the modifiers present
6473 in the symbol's name. */
6476 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6477 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6478 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6481 Lisp_Object symbol_int
;
6483 /* Get rid of the "vendor-specific" bit here. */
6484 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6486 /* Is this a request for a valid symbol? */
6487 if (symbol_num
< 0 || symbol_num
>= table_size
)
6490 if (CONSP (*symbol_table
))
6491 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6493 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6494 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6495 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6496 we've never used that symbol before. */
6499 if (! VECTORP (*symbol_table
)
6500 || ASIZE (*symbol_table
) != table_size
)
6504 XSETFASTINT (size
, table_size
);
6505 *symbol_table
= Fmake_vector (size
, Qnil
);
6508 value
= AREF (*symbol_table
, symbol_num
);
6511 /* Have we already used this symbol before? */
6514 /* No; let's create it. */
6515 if (CONSP (name_alist_or_stem
))
6516 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6517 else if (STRINGP (name_alist_or_stem
))
6520 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6521 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6523 buf
= SAFE_ALLOCA (len
);
6524 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6525 XINT (symbol_int
) + 1);
6526 value
= intern (buf
);
6529 else if (name_table
!= 0 && name_table
[symbol_num
])
6530 value
= intern (name_table
[symbol_num
]);
6532 #ifdef HAVE_WINDOW_SYSTEM
6535 char *name
= x_get_keysym_name (symbol_num
);
6537 value
= intern (name
);
6543 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6544 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6545 value
= intern (buf
);
6548 if (CONSP (*symbol_table
))
6549 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6551 ASET (*symbol_table
, symbol_num
, value
);
6553 /* Fill in the cache entries for this symbol; this also
6554 builds the Qevent_symbol_elements property, which the user
6556 apply_modifiers (modifiers
& click_modifier
, value
);
6557 Fput (value
, Qevent_kind
, symbol_kind
);
6560 /* Apply modifiers to that symbol. */
6561 return apply_modifiers (modifiers
, value
);
6564 /* Convert a list that represents an event type,
6565 such as (ctrl meta backspace), into the usual representation of that
6566 event type as a number or a symbol. */
6568 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6569 doc
: /* Convert the event description list EVENT-DESC to an event type.
6570 EVENT-DESC should contain one base event type (a character or symbol)
6571 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6572 drag, down, double or triple). The base must be last.
6573 The return value is an event type (a character or symbol) which
6574 has the same base event type and all the specified modifiers. */)
6575 (Lisp_Object event_desc
)
6583 while (CONSP (rest
))
6591 /* Given a symbol, see if it is a modifier name. */
6592 if (SYMBOLP (elt
) && CONSP (rest
))
6593 this = parse_solitary_modifier (elt
);
6597 else if (!NILP (base
))
6598 error ("Two bases given in one event");
6604 /* Let the symbol A refer to the character A. */
6605 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6606 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6608 if (INTEGERP (base
))
6610 /* Turn (shift a) into A. */
6611 if ((modifiers
& shift_modifier
) != 0
6612 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6614 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6615 modifiers
&= ~shift_modifier
;
6618 /* Turn (control a) into C-a. */
6619 if (modifiers
& ctrl_modifier
)
6620 return make_number ((modifiers
& ~ctrl_modifier
)
6621 | make_ctrl_char (XINT (base
)));
6623 return make_number (modifiers
| XINT (base
));
6625 else if (SYMBOLP (base
))
6626 return apply_modifiers (modifiers
, base
);
6628 error ("Invalid base event");
6631 /* Try to recognize SYMBOL as a modifier name.
6632 Return the modifier flag bit, or 0 if not recognized. */
6635 parse_solitary_modifier (Lisp_Object symbol
)
6637 Lisp_Object name
= SYMBOL_NAME (symbol
);
6639 switch (SREF (name
, 0))
6641 #define SINGLE_LETTER_MOD(BIT) \
6642 if (SBYTES (name) == 1) \
6645 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6646 if (LEN == SBYTES (name) \
6647 && ! memcmp (SDATA (name), NAME, LEN)) \
6651 SINGLE_LETTER_MOD (alt_modifier
);
6655 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6659 SINGLE_LETTER_MOD (ctrl_modifier
);
6663 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6664 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6668 SINGLE_LETTER_MOD (hyper_modifier
);
6672 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6676 SINGLE_LETTER_MOD (meta_modifier
);
6680 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6684 SINGLE_LETTER_MOD (shift_modifier
);
6688 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6689 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6690 SINGLE_LETTER_MOD (super_modifier
);
6694 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6695 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6696 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6700 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6703 #undef SINGLE_LETTER_MOD
6704 #undef MULTI_LETTER_MOD
6710 /* Return true if EVENT is a list whose elements are all integers or symbols.
6711 Such a list is not valid as an event,
6712 but it can be a Lucid-style event type list. */
6715 lucid_event_type_list_p (Lisp_Object object
)
6719 if (! CONSP (object
))
6722 if (EQ (XCAR (object
), Qhelp_echo
)
6723 || EQ (XCAR (object
), Qvertical_line
)
6724 || EQ (XCAR (object
), Qmode_line
)
6725 || EQ (XCAR (object
), Qheader_line
))
6728 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6732 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6739 /* Return true if terminal input chars are available.
6740 Also, store the return value into INPUT_PENDING.
6742 Serves the purpose of ioctl (0, FIONREAD, ...)
6743 but works even if FIONREAD does not exist.
6744 (In fact, this may actually read some input.)
6746 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6747 timer events that are ripe.
6748 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6749 events (FOCUS_IN_EVENT).
6750 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6751 movements and toolkit scroll bar thumb drags. */
6754 get_input_pending (int flags
)
6756 /* First of all, have we already counted some input? */
6757 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6759 /* If input is being read as it arrives, and we have none, there is none. */
6760 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6762 /* Try to read some input and see how much we get. */
6764 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6767 return input_pending
;
6770 /* Put a BUFFER_SWITCH_EVENT in the buffer
6771 so that read_key_sequence will notice the new current buffer. */
6774 record_asynch_buffer_change (void)
6776 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6777 The purpose of the event is to make read_key_sequence look up the
6778 keymaps again. If we aren't in read_key_sequence, we don't need one,
6779 and the event could cause trouble by messing up (input-pending-p).
6780 Note: Fwaiting_for_user_input_p always returns nil when async
6781 subprocesses aren't supported. */
6782 if (!NILP (Fwaiting_for_user_input_p ()))
6784 struct input_event event
;
6787 event
.kind
= BUFFER_SWITCH_EVENT
;
6788 event
.frame_or_window
= Qnil
;
6791 /* Make sure no interrupt happens while storing the event. */
6793 if (interrupt_input
)
6794 kbd_buffer_store_event (&event
);
6799 kbd_buffer_store_event (&event
);
6805 /* Read any terminal input already buffered up by the system
6806 into the kbd_buffer, but do not wait.
6808 Return the number of keyboard chars read, or -1 meaning
6809 this is a bad time to try to read input. */
6818 /* Store pending user signal events, if any. */
6819 store_user_signal_events ();
6821 /* Loop through the available terminals, and call their input hooks. */
6825 struct terminal
*next
= t
->next_terminal
;
6827 if (t
->read_socket_hook
)
6830 struct input_event hold_quit
;
6832 if (input_blocked_p ())
6834 pending_signals
= 1;
6838 EVENT_INIT (hold_quit
);
6839 hold_quit
.kind
= NO_EVENT
;
6841 /* No need for FIONREAD or fcntl; just say don't wait. */
6842 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6845 if (nr
== -1) /* Not OK to read input now. */
6849 else if (nr
== -2) /* Non-transient error. */
6851 /* The terminal device terminated; it should be closed. */
6853 /* Kill Emacs if this was our last terminal. */
6854 if (!terminal_list
->next_terminal
)
6855 /* Formerly simply reported no input, but that
6856 sometimes led to a failure of Emacs to terminate.
6857 SIGHUP seems appropriate if we can't reach the
6859 /* ??? Is it really right to send the signal just to
6860 this process rather than to the whole process
6861 group? Perhaps on systems with FIONREAD Emacs is
6862 alone in its group. */
6863 terminate_due_to_signal (SIGHUP
, 10);
6865 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6868 XSETTERMINAL (tmp
, t
);
6869 Fdelete_terminal (tmp
, Qnoelisp
);
6873 if (hold_quit
.kind
!= NO_EVENT
)
6874 kbd_buffer_store_event (&hold_quit
);
6883 frame_make_pointer_visible ();
6888 /* This is the tty way of reading available input.
6890 Note that each terminal device has its own `struct terminal' object,
6891 and so this function is called once for each individual termcap
6892 terminal. The first parameter indicates which terminal to read from. */
6895 tty_read_avail_input (struct terminal
*terminal
,
6896 struct input_event
*hold_quit
)
6898 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6899 the kbd_buffer can really hold. That may prevent loss
6900 of characters on some systems when input is stuffed at us. */
6901 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6903 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6906 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6908 if (kbd_on_hold_p () || buffer_free
<= 0)
6910 #endif /* subprocesses */
6912 if (!terminal
->name
) /* Don't read from a dead terminal. */
6915 if (terminal
->type
!= output_termcap
6916 && terminal
->type
!= output_msdos_raw
)
6919 /* XXX I think the following code should be moved to separate hook
6920 functions in system-dependent files. */
6922 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6923 code sets read_socket_hook to w32_console_read_socket instead! */
6925 #else /* not WINDOWSNT */
6926 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6930 return 0; /* The terminal is suspended. */
6933 n_to_read
= dos_keysns ();
6937 cbuf
[0] = dos_keyread ();
6940 #else /* not MSDOS */
6945 struct input_event gpm_hold_quit
;
6946 int gpm
, fd
= gpm_fd
;
6948 EVENT_INIT (gpm_hold_quit
);
6949 gpm_hold_quit
.kind
= NO_EVENT
;
6951 /* gpm==1 if event received.
6952 gpm==0 if the GPM daemon has closed the connection, in which case
6953 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6954 we save it in `fd' so close_gpm can remove it from the
6956 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6957 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6958 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6961 /* Presumably the GPM daemon has closed the connection. */
6963 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6964 kbd_buffer_store_event (&gpm_hold_quit
);
6968 #endif /* HAVE_GPM */
6970 /* Determine how many characters we should *try* to read. */
6971 #ifdef USABLE_FIONREAD
6972 /* Find out how much input is available. */
6973 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6975 if (! noninteractive
)
6976 return -2; /* Close this terminal. */
6982 if (n_to_read
> sizeof cbuf
)
6983 n_to_read
= sizeof cbuf
;
6984 #elif defined USG || defined CYGWIN
6985 /* Read some input if available, but don't wait. */
6986 n_to_read
= sizeof cbuf
;
6987 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6989 # error "Cannot read without possibly delaying"
6993 /* Don't read more than we can store. */
6994 if (n_to_read
> buffer_free
)
6995 n_to_read
= buffer_free
;
6996 #endif /* subprocesses */
6998 /* Now read; for one reason or another, this will not block.
6999 NREAD is set to the number of chars read. */
7002 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7003 /* POSIX infers that processes which are not in the session leader's
7004 process group won't get SIGHUPs at logout time. BSDI adheres to
7005 this part standard and returns -1 from read (0) with errno==EIO
7006 when the control tty is taken away.
7007 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7008 if (nread
== -1 && errno
== EIO
)
7009 return -2; /* Close this terminal. */
7010 #if defined (AIX) && defined (_BSD)
7011 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7012 This looks incorrect, but it isn't, because _BSD causes
7013 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7014 and that causes a value other than 0 when there is no input. */
7016 return -2; /* Close this terminal. */
7020 /* We used to retry the read if it was interrupted.
7021 But this does the wrong thing when O_NONBLOCK causes
7022 an EAGAIN error. Does anybody know of a situation
7023 where a retry is actually needed? */
7025 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7035 #ifndef USABLE_FIONREAD
7036 #if defined (USG) || defined (CYGWIN)
7037 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7038 #endif /* USG or CYGWIN */
7039 #endif /* no FIONREAD */
7044 #endif /* not MSDOS */
7045 #endif /* not WINDOWSNT */
7047 for (i
= 0; i
< nread
; i
++)
7049 struct input_event buf
;
7051 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7053 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7054 buf
.modifiers
= meta_modifier
;
7055 if (tty
->meta_key
!= 2)
7059 /* Set the frame corresponding to the active tty. Note that the
7060 value of selected_frame is not reliable here, redisplay tends
7061 to temporarily change it. */
7062 buf
.frame_or_window
= tty
->top_frame
;
7065 kbd_buffer_store_event (&buf
);
7066 /* Don't look at input that follows a C-g too closely.
7067 This reduces lossage due to autorepeat on C-g. */
7068 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7069 && buf
.code
== quit_char
)
7077 handle_async_input (void)
7082 int nread
= gobble_input ();
7083 /* -1 means it's not ok to read the input now.
7084 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7085 0 means there was no keyboard input available. */
7093 process_pending_signals (void)
7095 pending_signals
= 0;
7096 handle_async_input ();
7097 do_pending_atimers ();
7100 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7101 and reinvoke any pending signal if the level is now 0 and
7102 a fatal error is not already in progress. */
7105 unblock_input_to (int level
)
7107 interrupt_input_blocked
= level
;
7110 if (pending_signals
&& !fatal_error_in_progress
)
7111 process_pending_signals ();
7117 /* End critical section.
7119 If doing signal-driven input, and a signal came in when input was
7120 blocked, reinvoke the signal handler now to deal with it. */
7123 unblock_input (void)
7125 unblock_input_to (interrupt_input_blocked
- 1);
7128 /* Undo any number of BLOCK_INPUT calls,
7129 and also reinvoke any pending signal. */
7132 totally_unblock_input (void)
7134 unblock_input_to (0);
7140 handle_input_available_signal (int sig
)
7142 pending_signals
= 1;
7144 if (input_available_clear_time
)
7145 *input_available_clear_time
= make_timespec (0, 0);
7149 deliver_input_available_signal (int sig
)
7151 deliver_process_signal (sig
, handle_input_available_signal
);
7153 #endif /* USABLE_SIGIO */
7156 /* User signal events. */
7158 struct user_signal_info
7160 /* Signal number. */
7163 /* Name of the signal. */
7166 /* Number of pending signals. */
7169 struct user_signal_info
*next
;
7172 /* List of user signals. */
7173 static struct user_signal_info
*user_signals
= NULL
;
7176 add_user_signal (int sig
, const char *name
)
7178 struct sigaction action
;
7179 struct user_signal_info
*p
;
7181 for (p
= user_signals
; p
; p
= p
->next
)
7183 /* Already added. */
7186 p
= xmalloc (sizeof *p
);
7188 p
->name
= xstrdup (name
);
7190 p
->next
= user_signals
;
7193 emacs_sigaction_init (&action
, deliver_user_signal
);
7194 sigaction (sig
, &action
, 0);
7198 handle_user_signal (int sig
)
7200 struct user_signal_info
*p
;
7201 const char *special_event_name
= NULL
;
7203 if (SYMBOLP (Vdebug_on_event
))
7204 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7206 for (p
= user_signals
; p
; p
= p
->next
)
7209 if (special_event_name
7210 && strcmp (special_event_name
, p
->name
) == 0)
7212 /* Enter the debugger in many ways. */
7213 debug_on_next_call
= 1;
7216 Vinhibit_quit
= Qnil
;
7218 /* Eat the event. */
7224 if (interrupt_input
)
7225 handle_input_available_signal (sig
);
7229 /* Tell wait_reading_process_output that it needs to wake
7230 up and look around. */
7231 if (input_available_clear_time
)
7232 *input_available_clear_time
= make_timespec (0, 0);
7239 deliver_user_signal (int sig
)
7241 deliver_process_signal (sig
, handle_user_signal
);
7245 find_user_signal_name (int sig
)
7247 struct user_signal_info
*p
;
7249 for (p
= user_signals
; p
; p
= p
->next
)
7257 store_user_signal_events (void)
7259 struct user_signal_info
*p
;
7260 struct input_event buf
;
7261 bool buf_initialized
= 0;
7263 for (p
= user_signals
; p
; p
= p
->next
)
7264 if (p
->npending
> 0)
7266 if (! buf_initialized
)
7268 memset (&buf
, 0, sizeof buf
);
7269 buf
.kind
= USER_SIGNAL_EVENT
;
7270 buf
.frame_or_window
= selected_frame
;
7271 buf_initialized
= 1;
7277 kbd_buffer_store_event (&buf
);
7280 while (p
->npending
> 0);
7285 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7286 static Lisp_Object menu_bar_one_keymap_changed_items
;
7288 /* These variables hold the vector under construction within
7289 menu_bar_items and its subroutines, and the current index
7290 for storing into that vector. */
7291 static Lisp_Object menu_bar_items_vector
;
7292 static int menu_bar_items_index
;
7295 static const char* separator_names
[] = {
7300 "single-dashed-line",
7301 "double-dashed-line",
7303 "shadow-etched-out",
7304 "shadow-etched-in-dash",
7305 "shadow-etched-out-dash",
7306 "shadow-double-etched-in",
7307 "shadow-double-etched-out",
7308 "shadow-double-etched-in-dash",
7309 "shadow-double-etched-out-dash",
7313 /* Return true if LABEL specifies a separator. */
7316 menu_separator_name_p (const char *label
)
7320 else if (strlen (label
) > 3
7321 && memcmp (label
, "--", 2) == 0
7326 for (i
= 0; separator_names
[i
]; ++i
)
7327 if (strcmp (label
, separator_names
[i
]) == 0)
7332 /* It's a separator if it contains only dashes. */
7333 while (*label
== '-')
7335 return (*label
== 0);
7342 /* Return a vector of menu items for a menu bar, appropriate
7343 to the current buffer. Each item has three elements in the vector:
7346 OLD is an old vector we can optionally reuse, or nil. */
7349 menu_bar_items (Lisp_Object old
)
7351 /* The number of keymaps we're scanning right now, and the number of
7352 keymaps we have allocated space for. */
7355 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7356 in the current keymaps, or nil where it is not a prefix. */
7359 Lisp_Object def
, tail
;
7364 /* In order to build the menus, we need to call the keymap
7365 accessors. They all call QUIT. But this function is called
7366 during redisplay, during which a quit is fatal. So inhibit
7367 quitting while building the menus.
7368 We do this instead of specbind because (1) errors will clear it anyway
7369 and (2) this avoids risk of specpdl overflow. */
7370 oquit
= Vinhibit_quit
;
7374 menu_bar_items_vector
= old
;
7376 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7377 menu_bar_items_index
= 0;
7379 /* Build our list of keymaps.
7380 If we recognize a function key and replace its escape sequence in
7381 keybuf with its symbol, or if the sequence starts with a mouse
7382 click and we need to switch buffers, we jump back here to rebuild
7383 the initial keymaps from the current buffer. */
7387 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7388 if (!NILP (Voverriding_local_map_menu_flag
)
7389 && !NILP (Voverriding_local_map
))
7391 /* Yes, use them (if non-nil) as well as the global map. */
7392 maps
= alloca (3 * sizeof (maps
[0]));
7394 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7395 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7396 if (!NILP (Voverriding_local_map
))
7397 maps
[nmaps
++] = Voverriding_local_map
;
7401 /* No, so use major and minor mode keymaps and keymap property.
7402 Note that menu-bar bindings in the local-map and keymap
7403 properties may not work reliable, as they are only
7404 recognized when the menu-bar (or mode-line) is updated,
7405 which does not normally happen after every command. */
7408 nminor
= current_minor_maps (NULL
, &tmaps
);
7409 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7411 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7412 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7413 maps
[nmaps
++] = tem
;
7414 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7415 maps
[nmaps
++] = tem
;
7416 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7418 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7420 maps
[nmaps
++] = current_global_map
;
7423 /* Look up in each map the dummy prefix key `menu-bar'. */
7425 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7426 if (!NILP (maps
[mapno
]))
7428 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7432 menu_bar_one_keymap_changed_items
= Qnil
;
7433 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7437 /* Move to the end those items that should be at the end. */
7439 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7442 int end
= menu_bar_items_index
;
7444 for (i
= 0; i
< end
; i
+= 4)
7445 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7447 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7448 /* Move the item at index I to the end,
7449 shifting all the others forward. */
7450 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7451 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7452 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7453 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7455 memmove (aref_addr (menu_bar_items_vector
, i
),
7456 aref_addr (menu_bar_items_vector
, i
+ 4),
7457 (end
- i
- 4) * word_size
);
7458 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7459 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7460 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7461 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7466 /* Add nil, nil, nil, nil at the end. */
7468 int i
= menu_bar_items_index
;
7469 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7470 menu_bar_items_vector
=
7471 larger_vector (menu_bar_items_vector
, 4, -1);
7472 /* Add this item. */
7473 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7474 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7475 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7476 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7477 menu_bar_items_index
= i
;
7480 Vinhibit_quit
= oquit
;
7481 return menu_bar_items_vector
;
7484 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7485 If there's already an item for KEY, add this DEF to it. */
7487 Lisp_Object item_properties
;
7490 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7492 struct gcpro gcpro1
;
7497 if (EQ (item
, Qundefined
))
7499 /* If a map has an explicit `undefined' as definition,
7500 discard any previously made menu bar item. */
7502 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7503 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7505 if (menu_bar_items_index
> i
+ 4)
7506 memmove (aref_addr (menu_bar_items_vector
, i
),
7507 aref_addr (menu_bar_items_vector
, i
+ 4),
7508 (menu_bar_items_index
- i
- 4) * word_size
);
7509 menu_bar_items_index
-= 4;
7513 /* If this keymap has already contributed to this KEY,
7514 don't contribute to it a second time. */
7515 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7516 if (!NILP (tem
) || NILP (item
))
7519 menu_bar_one_keymap_changed_items
7520 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7522 /* We add to menu_bar_one_keymap_changed_items before doing the
7523 parse_menu_item, so that if it turns out it wasn't a menu item,
7524 it still correctly hides any further menu item. */
7526 parsed
= parse_menu_item (item
, 1);
7531 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7533 /* Find any existing item for this KEY. */
7534 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7535 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7538 /* If we did not find this KEY, add it at the end. */
7539 if (i
== menu_bar_items_index
)
7541 /* If vector is too small, get a bigger one. */
7542 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7543 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7544 /* Add this item. */
7545 ASET (menu_bar_items_vector
, i
, key
); i
++;
7546 ASET (menu_bar_items_vector
, i
,
7547 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7548 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7549 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7550 menu_bar_items_index
= i
;
7552 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7556 old
= AREF (menu_bar_items_vector
, i
+ 2);
7557 /* If the new and the old items are not both keymaps,
7558 the lookup will only find `item'. */
7559 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7560 ASET (menu_bar_items_vector
, i
+ 2, item
);
7564 /* This is used as the handler when calling menu_item_eval_property. */
7566 menu_item_eval_property_1 (Lisp_Object arg
)
7568 /* If we got a quit from within the menu computation,
7569 quit all the way out of it. This takes care of C-] in the debugger. */
7570 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7571 Fsignal (Qquit
, Qnil
);
7577 eval_dyn (Lisp_Object form
)
7579 return Feval (form
, Qnil
);
7582 /* Evaluate an expression and return the result (or nil if something
7583 went wrong). Used to evaluate dynamic parts of menu items. */
7585 menu_item_eval_property (Lisp_Object sexpr
)
7587 ptrdiff_t count
= SPECPDL_INDEX ();
7589 specbind (Qinhibit_redisplay
, Qt
);
7590 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7591 menu_item_eval_property_1
);
7592 return unbind_to (count
, val
);
7595 /* This function parses a menu item and leaves the result in the
7596 vector item_properties.
7597 ITEM is a key binding, a possible menu item.
7598 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7600 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7601 parse_menu_item returns true if the item is a menu item and false
7605 parse_menu_item (Lisp_Object item
, int inmenubar
)
7607 Lisp_Object def
, tem
, item_string
, start
;
7609 Lisp_Object keyhint
;
7618 /* Create item_properties vector if necessary. */
7619 if (NILP (item_properties
))
7621 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7623 /* Initialize optional entries. */
7624 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7625 ASET (item_properties
, i
, Qnil
);
7626 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7628 /* Save the item here to protect it from GC. */
7629 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7631 item_string
= XCAR (item
);
7635 if (STRINGP (item_string
))
7637 /* Old format menu item. */
7638 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7640 /* Maybe help string. */
7641 if (CONSP (item
) && STRINGP (XCAR (item
)))
7643 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7648 /* Maybe an obsolete key binding cache. */
7649 if (CONSP (item
) && CONSP (XCAR (item
))
7650 && (NILP (XCAR (XCAR (item
)))
7651 || VECTORP (XCAR (XCAR (item
)))))
7654 /* This is the real definition--the function to run. */
7655 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7657 /* Get enable property, if any. */
7660 tem
= Fget (item
, Qmenu_enable
);
7661 if (!NILP (Venable_disabled_menus_and_buttons
))
7662 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7663 else if (!NILP (tem
))
7664 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7667 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7669 /* New format menu item. */
7670 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7671 start
= XCDR (item
);
7674 /* We have a real binding. */
7675 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7677 item
= XCDR (start
);
7678 /* Is there an obsolete cache list with key equivalences. */
7679 if (CONSP (item
) && CONSP (XCAR (item
)))
7682 /* Parse properties. */
7683 while (CONSP (item
) && CONSP (XCDR (item
)))
7688 if (EQ (tem
, QCenable
))
7690 if (!NILP (Venable_disabled_menus_and_buttons
))
7691 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7693 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7695 else if (EQ (tem
, QCvisible
))
7697 /* If got a visible property and that evaluates to nil
7698 then ignore this item. */
7699 tem
= menu_item_eval_property (XCAR (item
));
7703 else if (EQ (tem
, QChelp
))
7704 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7705 else if (EQ (tem
, QCfilter
))
7707 else if (EQ (tem
, QCkey_sequence
))
7710 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7711 /* Be GC protected. Set keyhint to item instead of tem. */
7714 else if (EQ (tem
, QCkeys
))
7717 if (CONSP (tem
) || STRINGP (tem
))
7718 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7720 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7725 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7727 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7729 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7735 else if (inmenubar
|| !NILP (start
))
7739 return 0; /* not a menu item */
7741 /* If item string is not a string, evaluate it to get string.
7742 If we don't get a string, skip this item. */
7743 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7744 if (!(STRINGP (item_string
)))
7746 item_string
= menu_item_eval_property (item_string
);
7747 if (!STRINGP (item_string
))
7749 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7752 /* If got a filter apply it on definition. */
7753 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7756 def
= menu_item_eval_property (list2 (XCAR (filter
),
7757 list2 (Qquote
, def
)));
7759 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7762 /* Enable or disable selection of item. */
7763 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7766 tem
= menu_item_eval_property (tem
);
7767 if (inmenubar
&& NILP (tem
))
7768 return 0; /* Ignore disabled items in menu bar. */
7769 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7772 /* If we got no definition, this item is just unselectable text which
7773 is OK in a submenu but not in the menubar. */
7775 return (!inmenubar
);
7777 /* See if this is a separate pane or a submenu. */
7778 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7779 tem
= get_keymap (def
, 0, 1);
7780 /* For a subkeymap, just record its details and exit. */
7783 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7784 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7788 /* At the top level in the menu bar, do likewise for commands also.
7789 The menu bar does not display equivalent key bindings anyway.
7790 ITEM_PROPERTY_DEF is already set up properly. */
7794 { /* This is a command. See if there is an equivalent key binding. */
7795 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7797 /* The previous code preferred :key-sequence to :keys, so we
7798 preserve this behavior. */
7799 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7800 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7803 Lisp_Object prefix
= keyeq
;
7804 Lisp_Object keys
= Qnil
;
7808 def
= XCAR (prefix
);
7809 prefix
= XCDR (prefix
);
7812 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7814 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7816 keys
= XCAR (keyhint
);
7817 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7819 /* We have a suggested key. Is it bound to the command? */
7822 /* If the command is an alias for another
7823 (such as lmenu.el set it up), check if the
7824 original command matches the cached command. */
7826 && EQ (tem
, XSYMBOL (def
)->function
))))
7831 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7835 tem
= Fkey_description (keys
, Qnil
);
7838 if (STRINGP (XCAR (prefix
)))
7839 tem
= concat2 (XCAR (prefix
), tem
);
7840 if (STRINGP (XCDR (prefix
)))
7841 tem
= concat2 (tem
, XCDR (prefix
));
7843 keyeq
= concat2 (build_string (" "), tem
);
7844 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7850 /* If we have an equivalent key binding, use that. */
7851 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7854 /* Include this when menu help is implemented.
7855 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7856 if (!(NILP (tem) || STRINGP (tem)))
7858 tem = menu_item_eval_property (tem);
7861 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7865 /* Handle radio buttons or toggle boxes. */
7866 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7868 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7869 menu_item_eval_property (tem
));
7876 /***********************************************************************
7878 ***********************************************************************/
7880 /* A vector holding tool bar items while they are parsed in function
7881 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7884 static Lisp_Object tool_bar_items_vector
;
7886 /* A vector holding the result of parse_tool_bar_item. Layout is like
7887 the one for a single item in tool_bar_items_vector. */
7889 static Lisp_Object tool_bar_item_properties
;
7891 /* Next free index in tool_bar_items_vector. */
7893 static int ntool_bar_items
;
7895 /* The symbols `:image' and `:rtl'. */
7897 static Lisp_Object QCimage
;
7898 static Lisp_Object QCrtl
;
7900 /* Function prototypes. */
7902 static void init_tool_bar_items (Lisp_Object
);
7903 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7904 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7905 static void append_tool_bar_item (void);
7908 /* Return a vector of tool bar items for keymaps currently in effect.
7909 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7910 tool bar items found. */
7913 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7922 /* In order to build the menus, we need to call the keymap
7923 accessors. They all call QUIT. But this function is called
7924 during redisplay, during which a quit is fatal. So inhibit
7925 quitting while building the menus. We do this instead of
7926 specbind because (1) errors will clear it anyway and (2) this
7927 avoids risk of specpdl overflow. */
7928 oquit
= Vinhibit_quit
;
7931 /* Initialize tool_bar_items_vector and protect it from GC. */
7932 init_tool_bar_items (reuse
);
7934 /* Build list of keymaps in maps. Set nmaps to the number of maps
7937 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7938 if (!NILP (Voverriding_local_map_menu_flag
)
7939 && !NILP (Voverriding_local_map
))
7941 /* Yes, use them (if non-nil) as well as the global map. */
7942 maps
= alloca (3 * sizeof *maps
);
7944 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7945 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7946 if (!NILP (Voverriding_local_map
))
7947 maps
[nmaps
++] = Voverriding_local_map
;
7951 /* No, so use major and minor mode keymaps and keymap property.
7952 Note that tool-bar bindings in the local-map and keymap
7953 properties may not work reliable, as they are only
7954 recognized when the tool-bar (or mode-line) is updated,
7955 which does not normally happen after every command. */
7958 nminor
= current_minor_maps (NULL
, &tmaps
);
7959 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7961 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7962 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7963 maps
[nmaps
++] = tem
;
7964 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7965 maps
[nmaps
++] = tem
;
7966 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7968 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7971 /* Add global keymap at the end. */
7972 maps
[nmaps
++] = current_global_map
;
7974 /* Process maps in reverse order and look up in each map the prefix
7976 for (i
= nmaps
- 1; i
>= 0; --i
)
7977 if (!NILP (maps
[i
]))
7981 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7983 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7986 Vinhibit_quit
= oquit
;
7987 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7988 return tool_bar_items_vector
;
7992 /* Process the definition of KEY which is DEF. */
7995 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7998 struct gcpro gcpro1
, gcpro2
;
8000 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8004 if (EQ (def
, Qundefined
))
8006 /* If a map has an explicit `undefined' as definition,
8007 discard any previously made item. */
8008 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8010 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8012 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8014 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8015 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8016 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8018 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8023 else if (parse_tool_bar_item (key
, def
))
8024 /* Append a new tool bar item to tool_bar_items_vector. Accept
8025 more than one definition for the same key. */
8026 append_tool_bar_item ();
8031 /* Access slot with index IDX of vector tool_bar_item_properties. */
8032 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8034 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8036 ASET (tool_bar_item_properties
, idx
, val
);
8040 /* Parse a tool bar item specification ITEM for key KEY and return the
8041 result in tool_bar_item_properties. Value is false if ITEM is
8044 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8046 CAPTION is the caption of the item, If it's not a string, it is
8047 evaluated to get a string.
8049 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8050 as binding are currently ignored.
8052 The following properties are recognized:
8056 FORM is evaluated and specifies whether the tool bar item is
8057 enabled or disabled.
8061 FORM is evaluated and specifies whether the tool bar item is visible.
8063 - `:filter FUNCTION'
8065 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8066 result is stored as the new binding.
8068 - `:button (TYPE SELECTED)'
8070 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8071 and specifies whether the button is selected (pressed) or not.
8075 IMAGES is either a single image specification or a vector of four
8076 image specifications. See enum tool_bar_item_images.
8078 - `:help HELP-STRING'.
8080 Gives a help string to display for the tool bar item.
8082 - `:label LABEL-STRING'.
8084 A text label to show with the tool bar button if labels are enabled. */
8087 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8089 Lisp_Object filter
= Qnil
;
8090 Lisp_Object caption
;
8092 bool have_label
= 0;
8094 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8095 Rule out items that aren't lists, don't start with
8096 `menu-item' or whose rest following `tool-bar-item' is not a
8101 /* As an exception, allow old-style menu separators. */
8102 if (STRINGP (XCAR (item
)))
8103 item
= list1 (XCAR (item
));
8104 else if (!EQ (XCAR (item
), Qmenu_item
)
8105 || (item
= XCDR (item
), !CONSP (item
)))
8108 /* Create tool_bar_item_properties vector if necessary. Reset it to
8110 if (VECTORP (tool_bar_item_properties
))
8112 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8116 tool_bar_item_properties
8117 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8120 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8121 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8123 /* Get the caption of the item. If the caption is not a string,
8124 evaluate it to get a string. If we don't get a string, skip this
8126 caption
= XCAR (item
);
8127 if (!STRINGP (caption
))
8129 caption
= menu_item_eval_property (caption
);
8130 if (!STRINGP (caption
))
8133 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8135 /* If the rest following the caption is not a list, the menu item is
8136 either a separator, or invalid. */
8140 if (menu_separator_name_p (SSDATA (caption
)))
8142 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8143 #if !defined (USE_GTK) && !defined (HAVE_NS)
8144 /* If we use build_desired_tool_bar_string to render the
8145 tool bar, the separator is rendered as an image. */
8146 set_prop (TOOL_BAR_ITEM_IMAGES
,
8147 (menu_item_eval_property
8148 (Vtool_bar_separator_image_expression
)));
8149 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8150 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8151 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8158 /* Store the binding. */
8159 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8162 /* Ignore cached key binding, if any. */
8163 if (CONSP (item
) && CONSP (XCAR (item
)))
8166 /* Process the rest of the properties. */
8167 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8169 Lisp_Object ikey
, value
;
8172 value
= XCAR (XCDR (item
));
8174 if (EQ (ikey
, QCenable
))
8176 /* `:enable FORM'. */
8177 if (!NILP (Venable_disabled_menus_and_buttons
))
8178 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8180 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8182 else if (EQ (ikey
, QCvisible
))
8184 /* `:visible FORM'. If got a visible property and that
8185 evaluates to nil then ignore this item. */
8186 if (NILP (menu_item_eval_property (value
)))
8189 else if (EQ (ikey
, QChelp
))
8190 /* `:help HELP-STRING'. */
8191 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8192 else if (EQ (ikey
, QCvert_only
))
8193 /* `:vert-only t/nil'. */
8194 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8195 else if (EQ (ikey
, QClabel
))
8197 const char *bad_label
= "!!?GARBLED ITEM?!!";
8198 /* `:label LABEL-STRING'. */
8199 set_prop (TOOL_BAR_ITEM_LABEL
,
8200 STRINGP (value
) ? value
: build_string (bad_label
));
8203 else if (EQ (ikey
, QCfilter
))
8204 /* ':filter FORM'. */
8206 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8208 /* `:button (TYPE . SELECTED)'. */
8209 Lisp_Object type
, selected
;
8211 type
= XCAR (value
);
8212 selected
= XCDR (value
);
8213 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8215 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8216 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8219 else if (EQ (ikey
, QCimage
)
8221 || (VECTORP (value
) && ASIZE (value
) == 4)))
8222 /* Value is either a single image specification or a vector
8223 of 4 such specifications for the different button states. */
8224 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8225 else if (EQ (ikey
, QCrtl
))
8227 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8233 /* Try to make one from caption and key. */
8234 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8235 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8236 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8237 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8239 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8240 char *buf
= xmalloc (max_lbl
+ 1);
8241 Lisp_Object new_lbl
;
8242 ptrdiff_t caption_len
= strlen (capt
);
8244 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8247 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8249 buf
[caption_len
] = '\0';
8253 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8257 strcpy (buf
, label
);
8259 for (j
= 0; buf
[j
] != '\0'; ++j
)
8267 new_lbl
= Fupcase_initials (build_string (label
));
8268 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8269 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8271 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8275 /* If got a filter apply it on binding. */
8277 set_prop (TOOL_BAR_ITEM_BINDING
,
8278 (menu_item_eval_property
8281 PROP (TOOL_BAR_ITEM_BINDING
))))));
8283 /* See if the binding is a keymap. Give up if it is. */
8284 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8287 /* Enable or disable selection of item. */
8288 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8289 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8290 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8292 /* Handle radio buttons or toggle boxes. */
8293 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8294 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8295 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8303 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8304 that can be reused. */
8307 init_tool_bar_items (Lisp_Object reuse
)
8309 if (VECTORP (reuse
))
8310 tool_bar_items_vector
= reuse
;
8312 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8313 ntool_bar_items
= 0;
8317 /* Append parsed tool bar item properties from
8318 tool_bar_item_properties */
8321 append_tool_bar_item (void)
8325 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8327 /* Enlarge tool_bar_items_vector if necessary. */
8329 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8331 /* Append entries from tool_bar_item_properties to the end of
8332 tool_bar_items_vector. */
8333 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8334 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8335 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8342 /* Read a character using menus based on the keymap MAP.
8343 Return nil if there are no menus in the maps.
8344 Return t if we displayed a menu but the user rejected it.
8346 PREV_EVENT is the previous input event, or nil if we are reading
8347 the first event of a key sequence.
8349 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8350 if we used a mouse menu to read the input, or false otherwise. If
8351 USED_MOUSE_MENU is null, don't dereference it.
8353 The prompting is done based on the prompt-string of the map
8354 and the strings associated with various map elements.
8356 This can be done with X menus or with menus put in the minibuf.
8357 These are done in different ways, depending on how the input will be read.
8358 Menus using X are done after auto-saving in read-char, getting the input
8359 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8360 and do auto-saving in the inner call of read_char. */
8363 read_char_x_menu_prompt (Lisp_Object map
,
8364 Lisp_Object prev_event
, bool *used_mouse_menu
)
8366 if (used_mouse_menu
)
8367 *used_mouse_menu
= 0;
8369 /* Use local over global Menu maps. */
8371 if (! menu_prompting
)
8374 /* If we got to this point via a mouse click,
8375 use a real menu for mouse selection. */
8376 if (EVENT_HAS_PARAMETERS (prev_event
)
8377 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8378 && !EQ (XCAR (prev_event
), Qtool_bar
))
8380 /* Display the menu and get the selection. */
8383 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8388 record_menu_key (XCAR (value
));
8390 /* If we got multiple events, unread all but
8392 There is no way to prevent those unread events
8393 from showing up later in last_nonmenu_event.
8394 So turn symbol and integer events into lists,
8395 to indicate that they came from a mouse menu,
8396 so that when present in last_nonmenu_event
8397 they won't confuse things. */
8398 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8400 record_menu_key (XCAR (tem
));
8401 if (SYMBOLP (XCAR (tem
))
8402 || INTEGERP (XCAR (tem
)))
8403 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8406 /* If we got more than one event, put all but the first
8407 onto this list to be read later.
8408 Return just the first event now. */
8409 Vunread_command_events
8410 = nconc2 (XCDR (value
), Vunread_command_events
);
8411 value
= XCAR (value
);
8413 else if (NILP (value
))
8415 if (used_mouse_menu
)
8416 *used_mouse_menu
= 1;
8423 read_char_minibuf_menu_prompt (int commandflag
,
8426 register Lisp_Object name
;
8428 /* FIXME: Use the minibuffer's frame width. */
8429 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8431 bool nobindings
= 1;
8432 Lisp_Object rest
, vector
;
8433 Lisp_Object prompt_strings
= Qnil
;
8437 if (! menu_prompting
)
8440 map
= get_keymap (map
, 0, 1);
8441 name
= Fkeymap_prompt (map
);
8443 /* If we don't have any menus, just read a character normally. */
8444 if (!STRINGP (name
))
8447 #define PUSH_C_STR(str, listvar) \
8448 listvar = Fcons (build_unibyte_string (str), listvar)
8450 /* Prompt string always starts with map's prompt, and a space. */
8451 prompt_strings
= Fcons (name
, prompt_strings
);
8452 PUSH_C_STR (": ", prompt_strings
);
8453 nlength
= SCHARS (name
) + 2;
8457 /* Present the documented bindings, a line at a time. */
8461 Lisp_Object menu_strings
= prompt_strings
;
8462 ptrdiff_t i
= nlength
;
8464 Lisp_Object orig_defn_macro
;
8466 /* Loop over elements of map. */
8471 /* FIXME: Use map_keymap to handle new keymap formats. */
8473 /* At end of map, wrap around if just starting,
8474 or end this line if already have something on it. */
8477 if (notfirst
|| nobindings
)
8483 /* Look at the next element of the map. */
8485 elt
= AREF (vector
, idx
);
8487 elt
= Fcar_safe (rest
);
8489 if (idx
< 0 && VECTORP (elt
))
8491 /* If we found a dense table in the keymap,
8492 advanced past it, but start scanning its contents. */
8493 rest
= Fcdr_safe (rest
);
8499 /* An ordinary element. */
8500 Lisp_Object event
, tem
;
8504 event
= Fcar_safe (elt
); /* alist */
8505 elt
= Fcdr_safe (elt
);
8509 XSETINT (event
, idx
); /* vector */
8512 /* Ignore the element if it has no prompt string. */
8513 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8515 /* True if the char to type matches the string. */
8517 Lisp_Object upcased_event
, downcased_event
;
8518 Lisp_Object desc
= Qnil
;
8520 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8522 upcased_event
= Fupcase (event
);
8523 downcased_event
= Fdowncase (event
);
8524 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8525 || XINT (downcased_event
) == SREF (s
, 0));
8527 desc
= Fsingle_key_description (event
, Qnil
);
8529 #if 0 /* It is redundant to list the equivalent key bindings because
8530 the prefix is what the user has already typed. */
8532 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8534 /* Insert equivalent keybinding. */
8535 s
= concat2 (s
, tem
);
8538 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8539 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8541 /* Insert button prefix. */
8542 Lisp_Object selected
8543 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8544 if (EQ (tem
, QCradio
))
8545 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8547 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8548 s
= concat2 (tem
, s
);
8552 /* If we have room for the prompt string, add it to this line.
8553 If this is the first on the line, always add it. */
8554 if ((SCHARS (s
) + i
+ 2
8555 + (char_matches
? 0 : SCHARS (desc
) + 3))
8559 ptrdiff_t thiswidth
;
8561 /* Punctuate between strings. */
8564 PUSH_C_STR (", ", menu_strings
);
8570 /* If the char to type doesn't match the string's
8571 first char, explicitly show what char to type. */
8574 /* Add as much of string as fits. */
8575 thiswidth
= min (SCHARS (desc
), width
- i
);
8577 = Fcons (Fsubstring (desc
, make_number (0),
8578 make_number (thiswidth
)),
8581 PUSH_C_STR (" = ", menu_strings
);
8585 /* Add as much of string as fits. */
8586 thiswidth
= min (SCHARS (s
), width
- i
);
8588 = Fcons (Fsubstring (s
, make_number (0),
8589 make_number (thiswidth
)),
8595 /* If this element does not fit, end the line now,
8596 and save the element for the next line. */
8597 PUSH_C_STR ("...", menu_strings
);
8602 /* Move past this element. */
8603 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8604 /* Handle reaching end of dense table. */
8609 rest
= Fcdr_safe (rest
);
8613 /* Prompt with that and read response. */
8614 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8616 /* Make believe it's not a keyboard macro in case the help char
8617 is pressed. Help characters are not recorded because menu prompting
8618 is not used on replay. */
8619 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8620 kset_defining_kbd_macro (current_kboard
, Qnil
);
8622 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8623 while (BUFFERP (obj
));
8624 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8626 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8629 if (! EQ (obj
, menu_prompt_more_char
)
8630 && (!INTEGERP (menu_prompt_more_char
)
8631 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8633 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8634 store_kbd_macro_char (obj
);
8637 /* Help char - go round again. */
8641 /* Reading key sequences. */
8644 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8646 return access_keymap (get_keymap (keymap
, 0, 1),
8651 active_maps (Lisp_Object first_event
)
8653 Lisp_Object position
8654 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8655 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8658 /* Structure used to keep track of partial application of key remapping
8659 such as Vfunction_key_map and Vkey_translation_map. */
8660 typedef struct keyremap
8662 /* This is the map originally specified for this use. */
8664 /* This is a submap reached by looking up, in PARENT,
8665 the events from START to END. */
8667 /* Positions [START, END) in the key sequence buffer
8668 are the key that we have scanned so far.
8669 Those events are the ones that we will replace
8670 if PARENT maps them into a key sequence. */
8674 /* Lookup KEY in MAP.
8675 MAP is a keymap mapping keys to key vectors or functions.
8676 If the mapping is a function and DO_FUNCALL is true,
8677 the function is called with PROMPT as parameter and its return
8678 value is used as the return value of this function (after checking
8679 that it is indeed a vector). */
8682 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8687 next
= access_keymap (map
, key
, 1, 0, 1);
8689 /* Handle a symbol whose function definition is a keymap
8691 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8692 && (ARRAYP (XSYMBOL (next
)->function
)
8693 || KEYMAPP (XSYMBOL (next
)->function
)))
8694 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8696 /* If the keymap gives a function, not an
8697 array, then call the function with one arg and use
8698 its value instead. */
8699 if (do_funcall
&& FUNCTIONP (next
))
8704 next
= call1 (next
, prompt
);
8705 /* If the function returned something invalid,
8706 barf--don't ignore it.
8707 (To ignore it safely, we would need to gcpro a bunch of
8708 other variables.) */
8709 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8710 error ("Function %s returns invalid key sequence",
8711 SSDATA (SYMBOL_NAME (tem
)));
8716 /* Do one step of the key remapping used for function-key-map and
8717 key-translation-map:
8718 KEYBUF is the buffer holding the input events.
8719 BUFSIZE is its maximum size.
8720 FKEY is a pointer to the keyremap structure to use.
8721 INPUT is the index of the last element in KEYBUF.
8722 DOIT if true says that the remapping can actually take place.
8723 DIFF is used to return the number of keys added/removed by the remapping.
8724 PARENT is the root of the keymap.
8725 PROMPT is the prompt to use if the remapping happens through a function.
8726 Return true if the remapping actually took place. */
8729 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8730 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8732 Lisp_Object next
, key
;
8734 key
= keybuf
[fkey
->end
++];
8736 if (KEYMAPP (fkey
->parent
))
8737 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8741 /* If keybuf[fkey->start..fkey->end] is bound in the
8742 map and we're in a position to do the key remapping, replace it with
8743 the binding and restart with fkey->start at the end. */
8744 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8746 int len
= XFASTINT (Flength (next
));
8749 *diff
= len
- (fkey
->end
- fkey
->start
);
8751 if (bufsize
- input
<= *diff
)
8752 error ("Key sequence too long");
8754 /* Shift the keys that follow fkey->end. */
8756 for (i
= fkey
->end
; i
< input
; i
++)
8757 keybuf
[i
+ *diff
] = keybuf
[i
];
8759 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8760 keybuf
[i
+ *diff
] = keybuf
[i
];
8761 /* Overwrite the old keys with the new ones. */
8762 for (i
= 0; i
< len
; i
++)
8763 keybuf
[fkey
->start
+ i
]
8764 = Faref (next
, make_number (i
));
8766 fkey
->start
= fkey
->end
+= *diff
;
8767 fkey
->map
= fkey
->parent
;
8772 fkey
->map
= get_keymap (next
, 0, 1);
8774 /* If we no longer have a bound suffix, try a new position for
8776 if (!CONSP (fkey
->map
))
8778 fkey
->end
= ++fkey
->start
;
8779 fkey
->map
= fkey
->parent
;
8785 test_undefined (Lisp_Object binding
)
8787 return (NILP (binding
)
8788 || EQ (binding
, Qundefined
)
8789 || (SYMBOLP (binding
)
8790 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8793 /* Read a sequence of keys that ends with a non prefix character,
8794 storing it in KEYBUF, a buffer of size BUFSIZE.
8796 Return the length of the key sequence stored.
8797 Return -1 if the user rejected a command menu.
8799 Echo starting immediately unless `prompt' is 0.
8801 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8802 read_char with a suitable COMMANDFLAG argument.
8804 Where a key sequence ends depends on the currently active keymaps.
8805 These include any minor mode keymaps active in the current buffer,
8806 the current buffer's local map, and the global map.
8808 If a key sequence has no other bindings, we check Vfunction_key_map
8809 to see if some trailing subsequence might be the beginning of a
8810 function key's sequence. If so, we try to read the whole function
8811 key, and substitute its symbolic name into the key sequence.
8813 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8814 `double-' events into similar click events, if that would make them
8815 bound. We try to turn `triple-' events first into `double-' events,
8818 If we get a mouse click in a mode line, vertical divider, or other
8819 non-text area, we treat the click as if it were prefixed by the
8820 symbol denoting that area - `mode-line', `vertical-line', or
8823 If the sequence starts with a mouse click, we read the key sequence
8824 with respect to the buffer clicked on, not the current buffer.
8826 If the user switches frames in the midst of a key sequence, we put
8827 off the switch-frame event until later; the next call to
8828 read_char will return it.
8830 If FIX_CURRENT_BUFFER, we restore current_buffer
8831 from the selected window's buffer. */
8834 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8835 bool dont_downcase_last
, bool can_return_switch_frame
,
8836 bool fix_current_buffer
, bool prevent_redisplay
)
8838 ptrdiff_t count
= SPECPDL_INDEX ();
8840 /* How many keys there are in the current key sequence. */
8843 /* The length of the echo buffer when we started reading, and
8844 the length of this_command_keys when we started reading. */
8845 ptrdiff_t echo_start
IF_LINT (= 0);
8846 ptrdiff_t keys_start
;
8848 Lisp_Object current_binding
= Qnil
;
8849 Lisp_Object first_event
= Qnil
;
8851 /* Index of the first key that has no binding.
8852 It is useless to try fkey.start larger than that. */
8855 /* If t < mock_input, then KEYBUF[t] should be read as the next
8858 We use this to recover after recognizing a function key. Once we
8859 realize that a suffix of the current key sequence is actually a
8860 function key's escape sequence, we replace the suffix with the
8861 function key's binding from Vfunction_key_map. Now keybuf
8862 contains a new and different key sequence, so the echo area,
8863 this_command_keys, and the submaps and defs arrays are wrong. In
8864 this situation, we set mock_input to t, set t to 0, and jump to
8865 restart_sequence; the loop will read keys from keybuf up until
8866 mock_input, thus rebuilding the state; and then it will resume
8867 reading characters from the keyboard. */
8870 /* If the sequence is unbound in submaps[], then
8871 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8872 and fkey.map is its binding.
8874 These might be > t, indicating that all function key scanning
8875 should hold off until t reaches them. We do this when we've just
8876 recognized a function key, to avoid searching for the function
8877 key's again in Vfunction_key_map. */
8880 /* Likewise, for key_translation_map and input-decode-map. */
8881 keyremap keytran
, indec
;
8883 /* True if we are trying to map a key by changing an upper-case
8884 letter to lower case, or a shifted function key to an unshifted
8886 bool shift_translated
= 0;
8888 /* If we receive a `switch-frame' or `select-window' event in the middle of
8889 a key sequence, we put it off for later.
8890 While we're reading, we keep the event here. */
8891 Lisp_Object delayed_switch_frame
;
8893 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8894 int original_uppercase_position
= -1;
8896 /* Gets around Microsoft compiler limitations. */
8899 struct buffer
*starting_buffer
;
8901 /* List of events for which a fake prefix key has been generated. */
8902 Lisp_Object fake_prefixed_keys
= Qnil
;
8904 struct gcpro gcpro1
;
8906 GCPRO1 (fake_prefixed_keys
);
8907 raw_keybuf_count
= 0;
8909 last_nonmenu_event
= Qnil
;
8911 delayed_switch_frame
= Qnil
;
8917 /* Install the string PROMPT as the beginning of the string
8918 of echoing, so that it serves as a prompt for the next
8920 kset_echo_string (current_kboard
, prompt
);
8921 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8924 else if (cursor_in_echo_area
8925 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8926 && NILP (Fzerop (Vecho_keystrokes
)))
8927 /* This doesn't put in a dash if the echo buffer is empty, so
8928 you don't always see a dash hanging out in the minibuffer. */
8932 /* Record the initial state of the echo area and this_command_keys;
8933 we will need to restore them if we replay a key sequence. */
8935 echo_start
= echo_length ();
8936 keys_start
= this_command_key_count
;
8937 this_single_command_key_start
= keys_start
;
8939 /* We jump here when we need to reinitialize fkey and keytran; this
8940 happens if we switch keyboards between rescans. */
8941 replay_entire_sequence
:
8943 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8944 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8945 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8946 indec
.start
= indec
.end
= 0;
8947 fkey
.start
= fkey
.end
= 0;
8948 keytran
.start
= keytran
.end
= 0;
8950 /* We jump here when the key sequence has been thoroughly changed, and
8951 we need to rescan it starting from the beginning. When we jump here,
8952 keybuf[0..mock_input] holds the sequence we should reread. */
8955 starting_buffer
= current_buffer
;
8956 first_unbound
= bufsize
+ 1;
8958 /* Build our list of keymaps.
8959 If we recognize a function key and replace its escape sequence in
8960 keybuf with its symbol, or if the sequence starts with a mouse
8961 click and we need to switch buffers, we jump back here to rebuild
8962 the initial keymaps from the current buffer. */
8963 current_binding
= active_maps (first_event
);
8965 /* Start from the beginning in keybuf. */
8968 /* These are no-ops the first time through, but if we restart, they
8969 revert the echo area and this_command_keys to their original state. */
8970 this_command_key_count
= keys_start
;
8971 if (INTERACTIVE
&& t
< mock_input
)
8972 echo_truncate (echo_start
);
8974 /* If the best binding for the current key sequence is a keymap, or
8975 we may be looking at a function key's escape sequence, keep on
8977 while (!NILP (current_binding
)
8978 /* Keep reading as long as there's a prefix binding. */
8979 ? KEYMAPP (current_binding
)
8980 /* Don't return in the middle of a possible function key sequence,
8981 if the only bindings we found were via case conversion.
8982 Thus, if ESC O a has a function-key-map translation
8983 and ESC o has a binding, don't return after ESC O,
8984 so that we can translate ESC O plus the next character. */
8985 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8988 bool used_mouse_menu
= 0;
8990 /* Where the last real key started. If we need to throw away a
8991 key that has expanded into more than one element of keybuf
8992 (say, a mouse click on the mode line which is being treated
8993 as [mode-line (mouse-...)], then we backtrack to this point
8995 int last_real_key_start
;
8997 /* These variables are analogous to echo_start and keys_start;
8998 while those allow us to restart the entire key sequence,
8999 echo_local_start and keys_local_start allow us to throw away
9001 ptrdiff_t echo_local_start
IF_LINT (= 0);
9002 int keys_local_start
;
9003 Lisp_Object new_binding
;
9005 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9006 eassert (indec
.start
<= indec
.end
);
9007 eassert (fkey
.start
<= fkey
.end
);
9008 eassert (keytran
.start
<= keytran
.end
);
9009 /* key-translation-map is applied *after* function-key-map
9010 which is itself applied *after* input-decode-map. */
9011 eassert (fkey
.end
<= indec
.start
);
9012 eassert (keytran
.end
<= fkey
.start
);
9014 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9015 first_unbound
< keytran
.start
)
9016 { /* The prefix upto first_unbound has no binding and has
9017 no translation left to do either, so we know it's unbound.
9018 If we don't stop now, we risk staying here indefinitely
9019 (if the user keeps entering fkey or keytran prefixes
9020 like C-c ESC ESC ESC ESC ...) */
9022 for (i
= first_unbound
+ 1; i
< t
; i
++)
9023 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9024 mock_input
= t
- first_unbound
- 1;
9025 indec
.end
= indec
.start
-= first_unbound
+ 1;
9026 indec
.map
= indec
.parent
;
9027 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9028 fkey
.map
= fkey
.parent
;
9029 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9030 keytran
.map
= keytran
.parent
;
9031 goto replay_sequence
;
9035 error ("Key sequence too long");
9038 echo_local_start
= echo_length ();
9039 keys_local_start
= this_command_key_count
;
9042 /* These are no-ops, unless we throw away a keystroke below and
9043 jumped back up to replay_key; in that case, these restore the
9044 variables to their original state, allowing us to replay the
9046 if (INTERACTIVE
&& t
< mock_input
)
9047 echo_truncate (echo_local_start
);
9048 this_command_key_count
= keys_local_start
;
9050 /* By default, assume each event is "real". */
9051 last_real_key_start
= t
;
9053 /* Does mock_input indicate that we are re-reading a key sequence? */
9057 add_command_key (key
);
9058 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9059 && NILP (Fzerop (Vecho_keystrokes
))
9060 && current_kboard
->immediate_echo
)
9067 /* If not, we should actually read a character. */
9071 KBOARD
*interrupted_kboard
= current_kboard
;
9072 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9073 /* Calling read_char with COMMANDFLAG = -2 avoids
9074 redisplay in read_char and its subroutines. */
9075 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9076 current_binding
, last_nonmenu_event
,
9077 &used_mouse_menu
, NULL
);
9078 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9079 /* When switching to a new tty (with a new keyboard),
9080 read_char returns the new buffer, rather than -2
9081 (Bug#5095). This is because `terminal-init-xterm'
9082 calls read-char, which eats the wrong_kboard_jmpbuf
9083 return. Any better way to fix this? -- cyd */
9084 || (interrupted_kboard
!= current_kboard
))
9089 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9090 if (k
== interrupted_kboard
)
9095 /* Don't touch interrupted_kboard when it's been
9097 delayed_switch_frame
= Qnil
;
9098 goto replay_entire_sequence
;
9101 if (!NILP (delayed_switch_frame
))
9104 (interrupted_kboard
,
9105 Fcons (delayed_switch_frame
,
9106 KVAR (interrupted_kboard
, kbd_queue
)));
9107 delayed_switch_frame
= Qnil
;
9112 (interrupted_kboard
,
9113 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9115 /* If the side queue is non-empty, ensure it begins with a
9116 switch-frame, so we'll replay it in the right context. */
9117 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9118 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9119 !(EVENT_HAS_PARAMETERS (key
)
9120 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9124 XSETFRAME (frame
, interrupted_frame
);
9126 (interrupted_kboard
,
9127 Fcons (make_lispy_switch_frame (frame
),
9128 KVAR (interrupted_kboard
, kbd_queue
)));
9131 goto replay_entire_sequence
;
9135 /* read_char returns t when it shows a menu and the user rejects it.
9139 unbind_to (count
, Qnil
);
9144 /* read_char returns -1 at the end of a macro.
9145 Emacs 18 handles this by returning immediately with a
9146 zero, so that's what we'll do. */
9147 if (INTEGERP (key
) && XINT (key
) == -1)
9150 /* The Microsoft C compiler can't handle the goto that
9156 /* If the current buffer has been changed from under us, the
9157 keymap may have changed, so replay the sequence. */
9160 timer_resume_idle ();
9163 /* Reset the current buffer from the selected window
9164 in case something changed the former and not the latter.
9165 This is to be more consistent with the behavior
9166 of the command_loop_1. */
9167 if (fix_current_buffer
)
9169 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9171 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9173 Fset_buffer (XWINDOW (selected_window
)->contents
);
9176 goto replay_sequence
;
9179 /* If we have a quit that was typed in another frame, and
9180 quit_throw_to_read_char switched buffers,
9181 replay to get the right keymap. */
9183 && XINT (key
) == quit_char
9184 && current_buffer
!= starting_buffer
)
9187 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9192 goto replay_sequence
;
9197 if (EVENT_HAS_PARAMETERS (key
)
9198 /* Either a `switch-frame' or a `select-window' event. */
9199 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9201 /* If we're at the beginning of a key sequence, and the caller
9202 says it's okay, go ahead and return this event. If we're
9203 in the midst of a key sequence, delay it until the end. */
9204 if (t
> 0 || !can_return_switch_frame
)
9206 delayed_switch_frame
= key
;
9211 if (NILP (first_event
))
9214 /* Even if first_event does not specify a particular
9215 window/position, it's important to recompute the maps here
9216 since a long time might have passed since we entered
9217 read_key_sequence, and a timer (or process-filter or
9218 special-event-map, ...) might have switched the current buffer
9219 or the selected window from under us in the mean time. */
9220 if (fix_current_buffer
9221 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9223 Fset_buffer (XWINDOW (selected_window
)->contents
);
9224 current_binding
= active_maps (first_event
);
9228 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9232 /* Clicks in non-text areas get prefixed by the symbol
9233 in their CHAR-ADDRESS field. For example, a click on
9234 the mode line is prefixed by the symbol `mode-line'.
9236 Furthermore, key sequences beginning with mouse clicks
9237 are read using the keymaps of the buffer clicked on, not
9238 the current buffer. So we may have to switch the buffer
9241 When we turn one event into two events, we must make sure
9242 that neither of the two looks like the original--so that,
9243 if we replay the events, they won't be expanded again.
9244 If not for this, such reexpansion could happen either here
9245 or when user programs play with this-command-keys. */
9246 if (EVENT_HAS_PARAMETERS (key
))
9248 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9249 if (EQ (kind
, Qmouse_click
))
9251 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9252 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9255 || (!NILP (fake_prefixed_keys
)
9256 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9258 /* We're looking a second time at an event for which
9259 we generated a fake prefix key. Set
9260 last_real_key_start appropriately. */
9262 last_real_key_start
= t
- 1;
9265 if (last_real_key_start
== 0)
9267 /* Key sequences beginning with mouse clicks are
9268 read using the keymaps in the buffer clicked on,
9269 not the current buffer. If we're at the
9270 beginning of a key sequence, switch buffers. */
9271 if (WINDOWP (window
)
9272 && BUFFERP (XWINDOW (window
)->contents
)
9273 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9275 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9280 /* Arrange to go back to the original buffer once we're
9281 done reading the key sequence. Note that we can't
9282 use save_excursion_{save,restore} here, because they
9283 save point as well as the current buffer; we don't
9284 want to save point, because redisplay may change it,
9285 to accommodate a Fset_window_start or something. We
9286 don't want to do this at the top of the function,
9287 because we may get input from a subprocess which
9288 wants to change the selected window and stuff (say,
9290 record_unwind_current_buffer ();
9292 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9294 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9295 goto replay_sequence
;
9299 /* Expand mode-line and scroll-bar events into two events:
9300 use posn as a fake prefix key. */
9302 && (NILP (fake_prefixed_keys
)
9303 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9305 if (bufsize
- t
<= 1)
9306 error ("Key sequence too long");
9309 keybuf
[t
+ 1] = key
;
9312 /* Record that a fake prefix key has been generated
9313 for KEY. Don't modify the event; this would
9314 prevent proper action when the event is pushed
9315 back into unread-command-events. */
9316 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9320 else if (CONSP (XCDR (key
))
9321 && CONSP (EVENT_START (key
))
9322 && CONSP (XCDR (EVENT_START (key
))))
9326 posn
= POSN_POSN (EVENT_START (key
));
9327 /* Handle menu-bar events:
9328 insert the dummy prefix event `menu-bar'. */
9329 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9331 if (bufsize
- t
<= 1)
9332 error ("Key sequence too long");
9334 keybuf
[t
+ 1] = key
;
9336 /* Zap the position in key, so we know that we've
9337 expanded it, and don't try to do so again. */
9338 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9341 goto replay_sequence
;
9343 else if (CONSP (posn
))
9345 /* We're looking at the second event of a
9346 sequence which we expanded before. Set
9347 last_real_key_start appropriately. */
9348 if (last_real_key_start
== t
&& t
> 0)
9349 last_real_key_start
= t
- 1;
9354 /* We have finally decided that KEY is something we might want
9356 new_binding
= follow_key (current_binding
, key
);
9358 /* If KEY wasn't bound, we'll try some fallbacks. */
9359 if (!NILP (new_binding
))
9360 /* This is needed for the following scenario:
9361 event 0: a down-event that gets dropped by calling replay_key.
9362 event 1: some normal prefix like C-h.
9363 After event 0, first_unbound is 0, after event 1 indec.start,
9364 fkey.start, and keytran.start are all 1, so when we see that
9365 C-h is bound, we need to update first_unbound. */
9366 first_unbound
= max (t
+ 1, first_unbound
);
9371 /* Remember the position to put an upper bound on indec.start. */
9372 first_unbound
= min (t
, first_unbound
);
9374 head
= EVENT_HEAD (key
);
9375 if (help_char_p (head
) && t
> 0)
9377 read_key_sequence_cmd
= Vprefix_help_command
;
9379 last_nonmenu_event
= key
;
9380 /* The Microsoft C compiler can't handle the goto that
9388 Lisp_Object breakdown
;
9391 breakdown
= parse_modifiers (head
);
9392 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9393 /* Attempt to reduce an unbound mouse event to a simpler
9394 event that is bound:
9395 Drags reduce to clicks.
9396 Double-clicks reduce to clicks.
9397 Triple-clicks reduce to double-clicks, then to clicks.
9398 Down-clicks are eliminated.
9399 Double-downs reduce to downs, then are eliminated.
9400 Triple-downs reduce to double-downs, then to downs,
9401 then are eliminated. */
9402 if (modifiers
& (down_modifier
| drag_modifier
9403 | double_modifier
| triple_modifier
))
9405 while (modifiers
& (down_modifier
| drag_modifier
9406 | double_modifier
| triple_modifier
))
9408 Lisp_Object new_head
, new_click
;
9409 if (modifiers
& triple_modifier
)
9410 modifiers
^= (double_modifier
| triple_modifier
);
9411 else if (modifiers
& double_modifier
)
9412 modifiers
&= ~double_modifier
;
9413 else if (modifiers
& drag_modifier
)
9414 modifiers
&= ~drag_modifier
;
9417 /* Dispose of this `down' event by simply jumping
9418 back to replay_key, to get another event.
9420 Note that if this event came from mock input,
9421 then just jumping back to replay_key will just
9422 hand it to us again. So we have to wipe out any
9425 We could delete keybuf[t] and shift everything
9426 after that to the left by one spot, but we'd also
9427 have to fix up any variable that points into
9428 keybuf, and shifting isn't really necessary
9431 Adding prefixes for non-textual mouse clicks
9432 creates two characters of mock input, and both
9433 must be thrown away. If we're only looking at
9434 the prefix now, we can just jump back to
9435 replay_key. On the other hand, if we've already
9436 processed the prefix, and now the actual click
9437 itself is giving us trouble, then we've lost the
9438 state of the keymaps we want to backtrack to, and
9439 we need to replay the whole sequence to rebuild
9442 Beyond that, only function key expansion could
9443 create more than two keys, but that should never
9444 generate mouse events, so it's okay to zero
9445 mock_input in that case too.
9447 FIXME: The above paragraph seems just plain
9448 wrong, if you consider things like
9449 xterm-mouse-mode. -stef
9451 Isn't this just the most wonderful code ever? */
9453 /* If mock_input > t + 1, the above simplification
9454 will actually end up dropping keys on the floor.
9455 This is probably OK for now, but even
9456 if mock_input <= t + 1, we need to adjust indec,
9458 Typical case [header-line down-mouse-N]:
9459 mock_input = 2, t = 1, fkey.end = 1,
9460 last_real_key_start = 0. */
9461 if (indec
.end
> last_real_key_start
)
9463 indec
.end
= indec
.start
9464 = min (last_real_key_start
, indec
.start
);
9465 indec
.map
= indec
.parent
;
9466 if (fkey
.end
> last_real_key_start
)
9468 fkey
.end
= fkey
.start
9469 = min (last_real_key_start
, fkey
.start
);
9470 fkey
.map
= fkey
.parent
;
9471 if (keytran
.end
> last_real_key_start
)
9473 keytran
.end
= keytran
.start
9474 = min (last_real_key_start
, keytran
.start
);
9475 keytran
.map
= keytran
.parent
;
9479 if (t
== last_real_key_start
)
9486 mock_input
= last_real_key_start
;
9487 goto replay_sequence
;
9492 = apply_modifiers (modifiers
, XCAR (breakdown
));
9493 new_click
= list2 (new_head
, EVENT_START (key
));
9495 /* Look for a binding for this new key. */
9496 new_binding
= follow_key (current_binding
, new_click
);
9498 /* If that click is bound, go for it. */
9499 if (!NILP (new_binding
))
9501 current_binding
= new_binding
;
9505 /* Otherwise, we'll leave key set to the drag event. */
9510 current_binding
= new_binding
;
9513 /* Normally, last_nonmenu_event gets the previous key we read.
9514 But when a mouse popup menu is being used,
9515 we don't update last_nonmenu_event; it continues to hold the mouse
9516 event that preceded the first level of menu. */
9517 if (!used_mouse_menu
)
9518 last_nonmenu_event
= key
;
9520 /* Record what part of this_command_keys is the current key sequence. */
9521 this_single_command_key_start
= this_command_key_count
- t
;
9523 /* Look for this sequence in input-decode-map.
9524 Scan from indec.end until we find a bound suffix. */
9525 while (indec
.end
< t
)
9527 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9531 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9532 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9537 mock_input
= diff
+ max (t
, mock_input
);
9538 goto replay_sequence
;
9542 if (!KEYMAPP (current_binding
)
9543 && !test_undefined (current_binding
)
9544 && indec
.start
>= t
)
9545 /* There is a binding and it's not a prefix.
9546 (and it doesn't have any input-decode-map translation pending).
9547 There is thus no function-key in this sequence.
9548 Moving fkey.start is important in this case to allow keytran.start
9549 to go over the sequence before we return (since we keep the
9550 invariant that keytran.end <= fkey.start). */
9553 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9556 /* If the sequence is unbound, see if we can hang a function key
9557 off the end of it. */
9558 /* Continue scan from fkey.end until we find a bound suffix. */
9559 while (fkey
.end
< indec
.start
)
9561 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9565 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9566 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9567 max (t
, mock_input
),
9568 /* If there's a binding (i.e.
9569 first_binding >= nmaps) we don't want
9570 to apply this function-key-mapping. */
9572 && (test_undefined (current_binding
)),
9577 mock_input
= diff
+ max (t
, mock_input
);
9578 /* Adjust the input-decode-map counters. */
9580 indec
.start
+= diff
;
9582 goto replay_sequence
;
9586 /* Look for this sequence in key-translation-map.
9587 Scan from keytran.end until we find a bound suffix. */
9588 while (keytran
.end
< fkey
.start
)
9590 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9594 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9595 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9600 mock_input
= diff
+ max (t
, mock_input
);
9601 /* Adjust the function-key-map and input-decode-map counters. */
9603 indec
.start
+= diff
;
9607 goto replay_sequence
;
9611 /* If KEY is not defined in any of the keymaps,
9612 and cannot be part of a function key or translation,
9613 and is an upper case letter
9614 use the corresponding lower-case letter instead. */
9615 if (NILP (current_binding
)
9616 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9618 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9619 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9620 || (XINT (key
) & shift_modifier
)))
9622 Lisp_Object new_key
;
9624 original_uppercase
= key
;
9625 original_uppercase_position
= t
- 1;
9627 if (XINT (key
) & shift_modifier
)
9628 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9630 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9631 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9633 /* We have to do this unconditionally, regardless of whether
9634 the lower-case char is defined in the keymaps, because they
9635 might get translated through function-key-map. */
9636 keybuf
[t
- 1] = new_key
;
9637 mock_input
= max (t
, mock_input
);
9638 shift_translated
= 1;
9640 goto replay_sequence
;
9642 /* If KEY is not defined in any of the keymaps,
9643 and cannot be part of a function key or translation,
9644 and is a shifted function key,
9645 use the corresponding unshifted function key instead. */
9646 if (NILP (current_binding
)
9647 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9649 Lisp_Object breakdown
= parse_modifiers (key
);
9651 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9653 if (modifiers
& shift_modifier
9654 /* Treat uppercase keys as shifted. */
9656 && (KEY_TO_CHAR (key
)
9657 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9658 && uppercasep (KEY_TO_CHAR (key
))))
9661 = (modifiers
& shift_modifier
9662 ? apply_modifiers (modifiers
& ~shift_modifier
,
9664 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9666 original_uppercase
= key
;
9667 original_uppercase_position
= t
- 1;
9669 /* We have to do this unconditionally, regardless of whether
9670 the lower-case char is defined in the keymaps, because they
9671 might get translated through function-key-map. */
9672 keybuf
[t
- 1] = new_key
;
9673 mock_input
= max (t
, mock_input
);
9674 /* Reset fkey (and consequently keytran) to apply
9675 function-key-map on the result, so that S-backspace is
9676 correctly mapped to DEL (via backspace). OTOH,
9677 input-decode-map doesn't need to go through it again. */
9678 fkey
.start
= fkey
.end
= 0;
9679 keytran
.start
= keytran
.end
= 0;
9680 shift_translated
= 1;
9682 goto replay_sequence
;
9687 read_key_sequence_cmd
= current_binding
;
9688 read_key_sequence_remapped
9689 /* Remap command through active keymaps.
9690 Do the remapping here, before the unbind_to so it uses the keymaps
9691 of the appropriate buffer. */
9692 = SYMBOLP (read_key_sequence_cmd
)
9693 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9696 unread_switch_frame
= delayed_switch_frame
;
9697 unbind_to (count
, Qnil
);
9699 /* Don't downcase the last character if the caller says don't.
9700 Don't downcase it if the result is undefined, either. */
9701 if ((dont_downcase_last
|| NILP (current_binding
))
9703 && t
- 1 == original_uppercase_position
)
9705 keybuf
[t
- 1] = original_uppercase
;
9706 shift_translated
= 0;
9709 if (shift_translated
)
9710 Vthis_command_keys_shift_translated
= Qt
;
9712 /* Occasionally we fabricate events, perhaps by expanding something
9713 according to function-key-map, or by adding a prefix symbol to a
9714 mouse click in the scroll bar or modeline. In this cases, return
9715 the entire generated key sequence, even if we hit an unbound
9716 prefix or a definition before the end. This means that you will
9717 be able to push back the event properly, and also means that
9718 read-key-sequence will always return a logical unit.
9721 for (; t
< mock_input
; t
++)
9723 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9724 && NILP (Fzerop (Vecho_keystrokes
)))
9725 echo_char (keybuf
[t
]);
9726 add_command_key (keybuf
[t
]);
9734 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9735 Lisp_Object dont_downcase_last
,
9736 Lisp_Object can_return_switch_frame
,
9737 Lisp_Object cmd_loop
, bool allow_string
)
9739 Lisp_Object keybuf
[30];
9741 struct gcpro gcpro1
;
9742 ptrdiff_t count
= SPECPDL_INDEX ();
9745 CHECK_STRING (prompt
);
9748 specbind (Qinput_method_exit_on_first_char
,
9749 (NILP (cmd_loop
) ? Qt
: Qnil
));
9750 specbind (Qinput_method_use_echo_area
,
9751 (NILP (cmd_loop
) ? Qt
: Qnil
));
9753 memset (keybuf
, 0, sizeof keybuf
);
9755 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9757 if (NILP (continue_echo
))
9759 this_command_key_count
= 0;
9760 this_command_key_count_reset
= 0;
9761 this_single_command_key_start
= 0;
9764 #ifdef HAVE_WINDOW_SYSTEM
9765 if (display_hourglass_p
)
9766 cancel_hourglass ();
9769 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9770 prompt
, ! NILP (dont_downcase_last
),
9771 ! NILP (can_return_switch_frame
), 0, 0);
9773 #if 0 /* The following is fine for code reading a key sequence and
9774 then proceeding with a lengthy computation, but it's not good
9775 for code reading keys in a loop, like an input method. */
9776 #ifdef HAVE_WINDOW_SYSTEM
9777 if (display_hourglass_p
)
9788 return unbind_to (count
,
9789 ((allow_string
? make_event_array
: Fvector
)
9793 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9794 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9795 The sequence is sufficient to specify a non-prefix command in the
9796 current local and global maps.
9798 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9799 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9800 as a continuation of the previous key.
9802 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9803 convert the last event to lower case. (Normally any upper case event
9804 is converted to lower case if the original event is undefined and the lower
9805 case equivalent is defined.) A non-nil value is appropriate for reading
9806 a key sequence to be defined.
9808 A C-g typed while in this function is treated like any other character,
9809 and `quit-flag' is not set.
9811 If the key sequence starts with a mouse click, then the sequence is read
9812 using the keymaps of the buffer of the window clicked in, not the buffer
9813 of the selected window as normal.
9815 `read-key-sequence' drops unbound button-down events, since you normally
9816 only care about the click or drag events which follow them. If a drag
9817 or multi-click event is unbound, but the corresponding click event would
9818 be bound, `read-key-sequence' turns the event into a click event at the
9819 drag's starting position. This means that you don't have to distinguish
9820 between click and drag, double, or triple events unless you want to.
9822 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9823 lines separating windows, and scroll bars with imaginary keys
9824 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9826 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9827 function will process a switch-frame event if the user switches frames
9828 before typing anything. If the user switches frames in the middle of a
9829 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9830 is nil, then the event will be put off until after the current key sequence.
9832 `read-key-sequence' checks `function-key-map' for function key
9833 sequences, where they wouldn't conflict with ordinary bindings. See
9834 `function-key-map' for more details.
9836 The optional fifth argument CMD-LOOP, if non-nil, means
9837 that this key sequence is being read by something that will
9838 read commands one after another. It should be nil if the caller
9839 will read just one key sequence. */)
9840 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9842 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9843 can_return_switch_frame
, cmd_loop
, true);
9846 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9847 Sread_key_sequence_vector
, 1, 5, 0,
9848 doc
: /* Like `read-key-sequence' but always return a vector. */)
9849 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9851 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9852 can_return_switch_frame
, cmd_loop
, false);
9855 /* Return true if input events are pending. */
9858 detect_input_pending (void)
9860 return input_pending
|| get_input_pending (0);
9863 /* Return true if input events other than mouse movements are
9867 detect_input_pending_ignore_squeezables (void)
9869 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9872 /* Return true if input events are pending, and run any pending timers. */
9875 detect_input_pending_run_timers (bool do_display
)
9877 unsigned old_timers_run
= timers_run
;
9880 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9882 if (old_timers_run
!= timers_run
&& do_display
)
9883 redisplay_preserve_echo_area (8);
9885 return input_pending
;
9888 /* This is called in some cases before a possible quit.
9889 It cases the next call to detect_input_pending to recompute input_pending.
9890 So calling this function unnecessarily can't do any harm. */
9893 clear_input_pending (void)
9898 /* Return true if there are pending requeued events.
9899 This isn't used yet. The hope is to make wait_reading_process_output
9900 call it, and return if it runs Lisp code that unreads something.
9901 The problem is, kbd_buffer_get_event needs to be fixed to know what
9902 to do in that case. It isn't trivial. */
9905 requeued_events_pending_p (void)
9907 return (!NILP (Vunread_command_events
));
9910 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9911 doc
: /* Return t if command input is currently available with no wait.
9912 Actually, the value is nil only if we can be sure that no input is available;
9913 if there is a doubt, the value is t.
9915 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9916 (Lisp_Object check_timers
)
9918 if (!NILP (Vunread_command_events
)
9919 || !NILP (Vunread_post_input_method_events
)
9920 || !NILP (Vunread_input_method_events
))
9923 /* Process non-user-visible events (Bug#10195). */
9924 process_special_events ();
9926 return (get_input_pending ((NILP (check_timers
)
9927 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9928 | READABLE_EVENTS_FILTER_EVENTS
)
9932 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9933 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9936 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9939 if (total_keys
< NUM_RECENT_KEYS
)
9940 return Fvector (total_keys
, keys
);
9943 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9944 vcopy (val
, 0, keys
+ recent_keys_index
,
9945 NUM_RECENT_KEYS
- recent_keys_index
);
9946 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9947 keys
, recent_keys_index
);
9952 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9953 doc
: /* Return the key sequence that invoked this command.
9954 However, if the command has called `read-key-sequence', it returns
9955 the last key sequence that has been read.
9956 The value is a string or a vector.
9958 See also `this-command-keys-vector'. */)
9961 return make_event_array (this_command_key_count
,
9962 XVECTOR (this_command_keys
)->contents
);
9965 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9966 doc
: /* Return the key sequence that invoked this command, as a vector.
9967 However, if the command has called `read-key-sequence', it returns
9968 the last key sequence that has been read.
9970 See also `this-command-keys'. */)
9973 return Fvector (this_command_key_count
,
9974 XVECTOR (this_command_keys
)->contents
);
9977 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9978 Sthis_single_command_keys
, 0, 0, 0,
9979 doc
: /* Return the key sequence that invoked this command.
9980 More generally, it returns the last key sequence read, either by
9981 the command loop or by `read-key-sequence'.
9982 Unlike `this-command-keys', this function's value
9983 does not include prefix arguments.
9984 The value is always a vector. */)
9987 return Fvector (this_command_key_count
9988 - this_single_command_key_start
,
9989 (XVECTOR (this_command_keys
)->contents
9990 + this_single_command_key_start
));
9993 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9994 Sthis_single_command_raw_keys
, 0, 0, 0,
9995 doc
: /* Return the raw events that were read for this command.
9996 More generally, it returns the last key sequence read, either by
9997 the command loop or by `read-key-sequence'.
9998 Unlike `this-single-command-keys', this function's value
9999 shows the events before all translations (except for input methods).
10000 The value is always a vector. */)
10003 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10006 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10007 Sreset_this_command_lengths
, 0, 0, 0,
10008 doc
: /* Make the unread events replace the last command and echo.
10009 Used in `universal-argument-other-key'.
10011 `universal-argument-other-key' rereads the event just typed.
10012 It then gets translated through `function-key-map'.
10013 The translated event has to replace the real events,
10014 both in the value of (this-command-keys) and in echoing.
10015 To achieve this, `universal-argument-other-key' calls
10016 `reset-this-command-lengths', which discards the record of reading
10017 these events the first time. */)
10020 this_command_key_count
= before_command_key_count
;
10021 if (this_command_key_count
< this_single_command_key_start
)
10022 this_single_command_key_start
= this_command_key_count
;
10024 echo_truncate (before_command_echo_length
);
10026 /* Cause whatever we put into unread-command-events
10027 to echo as if it were being freshly read from the keyboard. */
10028 this_command_key_count_reset
= 1;
10033 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10034 Sclear_this_command_keys
, 0, 1, 0,
10035 doc
: /* Clear out the vector that `this-command-keys' returns.
10036 Also clear the record of the last 100 events, unless optional arg
10037 KEEP-RECORD is non-nil. */)
10038 (Lisp_Object keep_record
)
10042 this_command_key_count
= 0;
10043 this_command_key_count_reset
= 0;
10045 if (NILP (keep_record
))
10047 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10048 ASET (recent_keys
, i
, Qnil
);
10050 recent_keys_index
= 0;
10055 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10056 doc
: /* Return the current depth in recursive edits. */)
10060 /* Wrap around reliably on integer overflow. */
10061 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10062 XSETINT (temp
, sum
);
10066 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10067 "FOpen dribble file: ",
10068 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10069 If FILE is nil, close any open dribble file.
10070 The file will be closed when Emacs exits. */)
10082 file
= Fexpand_file_name (file
, Qnil
);
10083 dribble
= emacs_fopen (SSDATA (file
), "w");
10085 report_file_error ("Opening dribble", file
);
10090 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10091 doc
: /* Discard the contents of the terminal input buffer.
10092 Also end any kbd macro being defined. */)
10095 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10097 /* Discard the last command from the macro. */
10098 Fcancel_kbd_macro_events ();
10102 Vunread_command_events
= Qnil
;
10104 discard_tty_input ();
10106 kbd_fetch_ptr
= kbd_store_ptr
;
10112 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10113 doc
: /* Stop Emacs and return to superior process. You can resume later.
10114 If `cannot-suspend' is non-nil, or if the system doesn't support job
10115 control, run a subshell instead.
10117 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10118 to be read as terminal input by Emacs's parent, after suspension.
10120 Before suspending, run the normal hook `suspend-hook'.
10121 After resumption run the normal hook `suspend-resume-hook'.
10123 Some operating systems cannot stop the Emacs process and resume it later.
10124 On such systems, Emacs starts a subshell instead of suspending. */)
10125 (Lisp_Object stuffstring
)
10127 ptrdiff_t count
= SPECPDL_INDEX ();
10128 int old_height
, old_width
;
10130 struct gcpro gcpro1
;
10133 if (tty_list
&& tty_list
->next
)
10134 error ("There are other tty frames open; close them before suspending Emacs");
10136 if (!NILP (stuffstring
))
10137 CHECK_STRING (stuffstring
);
10139 /* Run the functions in suspend-hook. */
10140 hook
= intern ("suspend-hook");
10141 Frun_hooks (1, &hook
);
10143 GCPRO1 (stuffstring
);
10144 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10145 reset_all_sys_modes ();
10146 /* sys_suspend can get an error if it tries to fork a subshell
10147 and the system resources aren't available for that. */
10148 record_unwind_protect_void (init_all_sys_modes
);
10149 stuff_buffered_input (stuffstring
);
10150 if (cannot_suspend
)
10154 unbind_to (count
, Qnil
);
10156 /* Check if terminal/window size has changed.
10157 Note that this is not useful when we are running directly
10158 with a window system; but suspend should be disabled in that case. */
10159 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10160 if (width
!= old_width
|| height
!= old_height
)
10161 change_frame_size (SELECTED_FRAME (), width
, height
, 0, 0, 0, 0);
10163 /* Run suspend-resume-hook. */
10164 hook
= intern ("suspend-resume-hook");
10165 Frun_hooks (1, &hook
);
10171 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10172 Then in any case stuff anything Emacs has read ahead and not used. */
10175 stuff_buffered_input (Lisp_Object stuffstring
)
10177 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10178 register unsigned char *p
;
10180 if (STRINGP (stuffstring
))
10182 register ptrdiff_t count
;
10184 p
= SDATA (stuffstring
);
10185 count
= SBYTES (stuffstring
);
10186 while (count
-- > 0)
10191 /* Anything we have read ahead, put back for the shell to read. */
10192 /* ?? What should this do when we have multiple keyboards??
10193 Should we ignore anything that was typed in at the "wrong" kboard?
10195 rms: we should stuff everything back into the kboard
10197 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10200 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10201 kbd_fetch_ptr
= kbd_buffer
;
10202 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10203 stuff_char (kbd_fetch_ptr
->code
);
10205 clear_event (kbd_fetch_ptr
);
10209 #endif /* SIGTSTP */
10213 set_waiting_for_input (struct timespec
*time_to_clear
)
10215 input_available_clear_time
= time_to_clear
;
10217 /* Tell handle_interrupt to throw back to read_char, */
10218 waiting_for_input
= 1;
10220 /* If handle_interrupt was called before and buffered a C-g,
10221 make it run again now, to avoid timing error. */
10222 if (!NILP (Vquit_flag
))
10223 quit_throw_to_read_char (0);
10227 clear_waiting_for_input (void)
10229 /* Tell handle_interrupt not to throw back to read_char, */
10230 waiting_for_input
= 0;
10231 input_available_clear_time
= 0;
10234 /* The SIGINT handler.
10236 If we have a frame on the controlling tty, we assume that the
10237 SIGINT was generated by C-g, so we call handle_interrupt.
10238 Otherwise, tell QUIT to kill Emacs. */
10241 handle_interrupt_signal (int sig
)
10243 /* See if we have an active terminal on our controlling tty. */
10244 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10247 /* If there are no frames there, let's pretend that we are a
10248 well-behaving UN*X program and quit. We must not call Lisp
10249 in a signal handler, so tell QUIT to exit when it is
10251 Vquit_flag
= Qkill_emacs
;
10255 /* Otherwise, the SIGINT was probably generated by C-g. */
10257 /* Set internal_last_event_frame to the top frame of the
10258 controlling tty, if we have a frame there. We disable the
10259 interrupt key on secondary ttys, so the SIGINT must have come
10260 from the controlling tty. */
10261 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10263 handle_interrupt (1);
10268 deliver_interrupt_signal (int sig
)
10270 deliver_process_signal (sig
, handle_interrupt_signal
);
10274 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10275 of the number of times C-g has been requested. If C-g is pressed
10276 enough times, then quit anyway. See bug#6585. */
10277 static int volatile force_quit_count
;
10279 /* This routine is called at interrupt level in response to C-g.
10281 It is called from the SIGINT handler or kbd_buffer_store_event.
10283 If `waiting_for_input' is non zero, then unless `echoing' is
10284 nonzero, immediately throw back to read_char.
10286 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10287 eval to throw, when it gets a chance. If quit-flag is already
10288 non-nil, it stops the job right away. */
10291 handle_interrupt (bool in_signal_handler
)
10295 sigemptyset (&blocked
);
10296 sigaddset (&blocked
, SIGINT
);
10300 /* XXX This code needs to be revised for multi-tty support. */
10301 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10303 if (! in_signal_handler
)
10305 /* If SIGINT isn't blocked, don't let us be interrupted by
10306 a SIGINT. It might be harmful due to non-reentrancy
10307 in I/O functions. */
10308 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10312 reset_all_sys_modes ();
10316 * On systems which can suspend the current process and return to the original
10317 * shell, this command causes the user to end up back at the shell.
10318 * The "Auto-save" and "Abort" questions are not asked until
10319 * the user elects to return to emacs, at which point he can save the current
10320 * job and either dump core or continue.
10324 /* Perhaps should really fork an inferior shell?
10325 But that would not provide any way to get back
10326 to the original shell, ever. */
10327 printf ("No support for stopping a process on this operating system;\n");
10328 printf ("you can continue or abort.\n");
10329 #endif /* not SIGTSTP */
10331 /* We must remain inside the screen area when the internal terminal
10332 is used. Note that [Enter] is not echoed by dos. */
10333 cursor_to (SELECTED_FRAME (), 0, 0);
10335 /* It doesn't work to autosave while GC is in progress;
10336 the code used for auto-saving doesn't cope with the mark bit. */
10337 if (!gc_in_progress
)
10339 printf ("Auto-save? (y or n) ");
10341 if (((c
= getchar ()) & ~040) == 'Y')
10343 Fdo_auto_save (Qt
, Qnil
);
10345 printf ("\r\nAuto-save done");
10346 #else /* not MSDOS */
10347 printf ("Auto-save done\n");
10348 #endif /* not MSDOS */
10350 while (c
!= '\n') c
= getchar ();
10354 /* During GC, it must be safe to reenable quitting again. */
10355 Vinhibit_quit
= Qnil
;
10358 #endif /* not MSDOS */
10359 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10360 printf ("but will instead do a real quit after garbage collection ends\r\n");
10365 printf ("\r\nAbort? (y or n) ");
10366 #else /* not MSDOS */
10367 printf ("Abort (and dump core)? (y or n) ");
10368 #endif /* not MSDOS */
10370 if (((c
= getchar ()) & ~040) == 'Y')
10372 while (c
!= '\n') c
= getchar ();
10374 printf ("\r\nContinuing...\r\n");
10375 #else /* not MSDOS */
10376 printf ("Continuing...\n");
10377 #endif /* not MSDOS */
10379 init_all_sys_modes ();
10383 /* If executing a function that wants to be interrupted out of
10384 and the user has not deferred quitting by binding `inhibit-quit'
10385 then quit right away. */
10386 if (immediate_quit
&& NILP (Vinhibit_quit
))
10388 struct gl_state_s saved
;
10389 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10391 immediate_quit
= 0;
10392 pthread_sigmask (SIG_UNBLOCK
, &blocked
, 0);
10394 GCPRO4 (saved
.object
, saved
.global_code
,
10395 saved
.current_syntax_table
, saved
.old_prop
);
10396 Fsignal (Qquit
, Qnil
);
10401 { /* Else request quit when it's safe. */
10402 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10403 force_quit_count
= count
;
10406 immediate_quit
= 1;
10407 Vinhibit_quit
= Qnil
;
10413 pthread_sigmask (SIG_UNBLOCK
, &blocked
, 0);
10415 /* TODO: The longjmp in this call throws the NS event loop integration off,
10416 and it seems to do fine without this. Probably some attention
10417 needs to be paid to the setting of waiting_for_input in
10418 wait_reading_process_output() under HAVE_NS because of the call
10419 to ns_select there (needed because otherwise events aren't picked up
10420 outside of polling since we don't get SIGIO like X and we don't have a
10421 separate event loop thread like W32. */
10423 if (waiting_for_input
&& !echoing
)
10424 quit_throw_to_read_char (in_signal_handler
);
10428 /* Handle a C-g by making read_char return C-g. */
10431 quit_throw_to_read_char (bool from_signal
)
10433 /* When not called from a signal handler it is safe to call
10435 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10436 Fkill_emacs (Qnil
);
10438 /* Prevent another signal from doing this before we finish. */
10439 clear_waiting_for_input ();
10442 Vunread_command_events
= Qnil
;
10444 if (FRAMEP (internal_last_event_frame
)
10445 && !EQ (internal_last_event_frame
, selected_frame
))
10446 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10449 sys_longjmp (getcjmp
, 1);
10452 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10453 Sset_input_interrupt_mode
, 1, 1, 0,
10454 doc
: /* Set interrupt mode of reading keyboard input.
10455 If INTERRUPT is non-nil, Emacs will use input interrupts;
10456 otherwise Emacs uses CBREAK mode.
10458 See also `current-input-mode'. */)
10459 (Lisp_Object interrupt
)
10461 bool new_interrupt_input
;
10462 #ifdef USABLE_SIGIO
10463 #ifdef HAVE_X_WINDOWS
10464 if (x_display_list
!= NULL
)
10466 /* When using X, don't give the user a real choice,
10467 because we haven't implemented the mechanisms to support it. */
10468 new_interrupt_input
= 1;
10471 #endif /* HAVE_X_WINDOWS */
10472 new_interrupt_input
= !NILP (interrupt
);
10473 #else /* not USABLE_SIGIO */
10474 new_interrupt_input
= 0;
10475 #endif /* not USABLE_SIGIO */
10477 if (new_interrupt_input
!= interrupt_input
)
10479 #ifdef POLL_FOR_INPUT
10483 /* this causes startup screen to be restored and messes with the mouse */
10484 reset_all_sys_modes ();
10485 interrupt_input
= new_interrupt_input
;
10486 init_all_sys_modes ();
10488 interrupt_input
= new_interrupt_input
;
10491 #ifdef POLL_FOR_INPUT
10492 poll_suppress_count
= 1;
10499 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10500 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10501 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10502 C-q in key sequences.
10504 This setting only has an effect on tty terminals and only when
10505 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10507 See also `current-input-mode'. */)
10508 (Lisp_Object flow
, Lisp_Object terminal
)
10510 struct terminal
*t
= get_terminal (terminal
, 1);
10511 struct tty_display_info
*tty
;
10512 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10514 tty
= t
->display_info
.tty
;
10516 if (tty
->flow_control
!= !NILP (flow
))
10519 /* This causes startup screen to be restored and messes with the mouse. */
10520 reset_sys_modes (tty
);
10523 tty
->flow_control
= !NILP (flow
);
10526 init_sys_modes (tty
);
10532 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10533 doc
: /* Enable or disable 8-bit input on TERMINAL.
10534 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10535 bit as the Meta modifier.
10537 If META is nil, Emacs will ignore the top bit, on the assumption it is
10540 Otherwise, Emacs will accept and pass through 8-bit input without
10541 specially interpreting the top bit.
10543 This setting only has an effect on tty terminal devices.
10545 Optional parameter TERMINAL specifies the tty terminal device to use.
10546 It may be a terminal object, a frame, or nil for the terminal used by
10547 the currently selected frame.
10549 See also `current-input-mode'. */)
10550 (Lisp_Object meta
, Lisp_Object terminal
)
10552 struct terminal
*t
= get_terminal (terminal
, 1);
10553 struct tty_display_info
*tty
;
10556 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10558 tty
= t
->display_info
.tty
;
10562 else if (EQ (meta
, Qt
))
10567 if (tty
->meta_key
!= new_meta
)
10570 /* this causes startup screen to be restored and messes with the mouse */
10571 reset_sys_modes (tty
);
10574 tty
->meta_key
= new_meta
;
10577 init_sys_modes (tty
);
10583 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10584 doc
: /* Specify character used for quitting.
10585 QUIT must be an ASCII character.
10587 This function only has an effect on the controlling tty of the Emacs
10590 See also `current-input-mode'. */)
10593 struct terminal
*t
= get_named_tty ("/dev/tty");
10594 struct tty_display_info
*tty
;
10595 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10597 tty
= t
->display_info
.tty
;
10599 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10600 error ("QUIT must be an ASCII character");
10603 /* this causes startup screen to be restored and messes with the mouse */
10604 reset_sys_modes (tty
);
10607 /* Don't let this value be out of range. */
10608 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10611 init_sys_modes (tty
);
10617 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10618 doc
: /* Set mode of reading keyboard input.
10619 First arg INTERRUPT non-nil means use input interrupts;
10620 nil means use CBREAK mode.
10621 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10622 (no effect except in CBREAK mode).
10623 Third arg META t means accept 8-bit input (for a Meta key).
10624 META nil means ignore the top bit, on the assumption it is parity.
10625 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10626 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10627 See also `current-input-mode'. */)
10628 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10630 Fset_input_interrupt_mode (interrupt
);
10631 Fset_output_flow_control (flow
, Qnil
);
10632 Fset_input_meta_mode (meta
, Qnil
);
10634 Fset_quit_char (quit
);
10638 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10639 doc
: /* Return information about the way Emacs currently reads keyboard input.
10640 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10641 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10642 nil, Emacs is using CBREAK mode.
10643 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10644 terminal; this does not apply if Emacs uses interrupt-driven input.
10645 META is t if accepting 8-bit input with 8th bit as Meta flag.
10646 META nil means ignoring the top bit, on the assumption it is parity.
10647 META is neither t nor nil if accepting 8-bit input and using
10648 all 8 bits as the character code.
10649 QUIT is the character Emacs currently uses to quit.
10650 The elements of this list correspond to the arguments of
10651 `set-input-mode'. */)
10654 Lisp_Object val
[4];
10655 struct frame
*sf
= XFRAME (selected_frame
);
10657 val
[0] = interrupt_input
? Qt
: Qnil
;
10658 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10660 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10661 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10663 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10670 XSETFASTINT (val
[3], quit_char
);
10672 return Flist (ARRAYELTS (val
), val
);
10675 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10676 doc
: /* Return position information for pixel coordinates X and Y.
10677 By default, X and Y are relative to text area of the selected window.
10678 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10679 If optional fourth arg WHOLE is non-nil, X is relative to the left
10680 edge of the window.
10682 The return value is similar to a mouse click position:
10683 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10684 IMAGE (DX . DY) (WIDTH . HEIGHT))
10685 The `posn-' functions access elements of such lists. */)
10686 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10691 if (NILP (frame_or_window
))
10692 frame_or_window
= selected_window
;
10694 if (WINDOWP (frame_or_window
))
10696 struct window
*w
= decode_live_window (frame_or_window
);
10698 XSETINT (x
, (XINT (x
)
10699 + WINDOW_LEFT_EDGE_X (w
)
10701 ? window_box_left_offset (w
, TEXT_AREA
)
10703 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10704 frame_or_window
= w
->frame
;
10707 CHECK_LIVE_FRAME (frame_or_window
);
10709 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10712 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10713 doc
: /* Return position information for buffer POS in WINDOW.
10714 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10716 Return nil if position is not visible in window. Otherwise,
10717 the return value is similar to that returned by `event-start' for
10718 a mouse click at the upper left corner of the glyph corresponding
10719 to the given buffer position:
10720 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10721 IMAGE (DX . DY) (WIDTH . HEIGHT))
10722 The `posn-' functions access elements of such lists. */)
10723 (Lisp_Object pos
, Lisp_Object window
)
10728 window
= selected_window
;
10730 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10733 Lisp_Object x
= XCAR (tem
);
10734 Lisp_Object y
= XCAR (XCDR (tem
));
10736 /* Point invisible due to hscrolling? */
10739 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10745 /* Set up a new kboard object with reasonable initial values.
10746 TYPE is a window system for which this keyboard is used. */
10749 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10751 kset_overriding_terminal_local_map (kb
, Qnil
);
10752 kset_last_command (kb
, Qnil
);
10753 kset_real_last_command (kb
, Qnil
);
10754 kset_keyboard_translate_table (kb
, Qnil
);
10755 kset_last_repeatable_command (kb
, Qnil
);
10756 kset_prefix_arg (kb
, Qnil
);
10757 kset_last_prefix_arg (kb
, Qnil
);
10758 kset_kbd_queue (kb
, Qnil
);
10759 kb
->kbd_queue_has_data
= 0;
10760 kb
->immediate_echo
= 0;
10761 kset_echo_string (kb
, Qnil
);
10762 kb
->echo_after_prompt
= -1;
10763 kb
->kbd_macro_buffer
= 0;
10764 kb
->kbd_macro_bufsize
= 0;
10765 kset_defining_kbd_macro (kb
, Qnil
);
10766 kset_last_kbd_macro (kb
, Qnil
);
10767 kb
->reference_count
= 0;
10768 kset_system_key_alist (kb
, Qnil
);
10769 kset_system_key_syms (kb
, Qnil
);
10770 kset_window_system (kb
, type
);
10771 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10772 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10773 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10774 kset_default_minibuffer_frame (kb
, Qnil
);
10777 /* Allocate and basically initialize keyboard
10778 object to use with window system TYPE. */
10781 allocate_kboard (Lisp_Object type
)
10783 KBOARD
*kb
= xmalloc (sizeof *kb
);
10785 init_kboard (kb
, type
);
10786 kb
->next_kboard
= all_kboards
;
10792 * Destroy the contents of a kboard object, but not the object itself.
10793 * We use this just before deleting it, or if we're going to initialize
10794 * it a second time.
10797 wipe_kboard (KBOARD
*kb
)
10799 xfree (kb
->kbd_macro_buffer
);
10802 /* Free KB and memory referenced from it. */
10805 delete_kboard (KBOARD
*kb
)
10809 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10812 *kbp
= kb
->next_kboard
;
10814 /* Prevent a dangling reference to KB. */
10815 if (kb
== current_kboard
10816 && FRAMEP (selected_frame
)
10817 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10819 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10821 if (current_kboard
== kb
)
10830 init_keyboard (void)
10832 /* This is correct before outermost invocation of the editor loop. */
10833 command_loop_level
= -1;
10834 immediate_quit
= 0;
10835 quit_char
= Ctl ('g');
10836 Vunread_command_events
= Qnil
;
10837 timer_idleness_start_time
= invalid_timespec ();
10839 recent_keys_index
= 0;
10840 kbd_fetch_ptr
= kbd_buffer
;
10841 kbd_store_ptr
= kbd_buffer
;
10842 do_mouse_tracking
= Qnil
;
10844 interrupt_input_blocked
= 0;
10845 pending_signals
= 0;
10847 /* This means that command_loop_1 won't try to select anything the first
10849 internal_last_event_frame
= Qnil
;
10850 Vlast_event_frame
= internal_last_event_frame
;
10852 current_kboard
= initial_kboard
;
10853 /* Re-initialize the keyboard again. */
10854 wipe_kboard (current_kboard
);
10855 /* A value of nil for Vwindow_system normally means a tty, but we also use
10856 it for the initial terminal since there is no window system there. */
10857 init_kboard (current_kboard
, Qnil
);
10859 if (!noninteractive
)
10861 /* Before multi-tty support, these handlers used to be installed
10862 only if the current session was a tty session. Now an Emacs
10863 session may have multiple display types, so we always handle
10864 SIGINT. There is special code in handle_interrupt_signal to exit
10865 Emacs on SIGINT when there are no termcap frames on the
10866 controlling terminal. */
10867 struct sigaction action
;
10868 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10869 sigaction (SIGINT
, &action
, 0);
10871 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10872 SIGQUIT and we can't tell which one it will give us. */
10873 sigaction (SIGQUIT
, &action
, 0);
10874 #endif /* not DOS_NT */
10876 #ifdef USABLE_SIGIO
10877 if (!noninteractive
)
10879 struct sigaction action
;
10880 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10881 sigaction (SIGIO
, &action
, 0);
10885 /* Use interrupt input by default, if it works and noninterrupt input
10886 has deficiencies. */
10888 #ifdef INTERRUPT_INPUT
10889 interrupt_input
= 1;
10891 interrupt_input
= 0;
10894 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10897 if (keyboard_init_hook
)
10898 (*keyboard_init_hook
) ();
10900 #ifdef POLL_FOR_INPUT
10902 poll_suppress_count
= 1;
10907 /* This type's only use is in syms_of_keyboard, to initialize the
10908 event header symbols and put properties on them. */
10909 struct event_head
{
10915 static const struct event_head head_table
[] = {
10916 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10917 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10918 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10919 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10920 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10921 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10922 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10923 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10924 /* `select-window' should be handled just like `switch-frame'
10925 in read_key_sequence. */
10926 {&Qselect_window
, "select-window", &Qswitch_frame
}
10930 syms_of_keyboard (void)
10932 pending_funcalls
= Qnil
;
10933 staticpro (&pending_funcalls
);
10935 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10936 staticpro (&Vlispy_mouse_stem
);
10939 DEFSYM (QCimage
, ":image");
10940 DEFSYM (Qhelp_echo
, "help-echo");
10941 DEFSYM (QCrtl
, ":rtl");
10943 staticpro (&item_properties
);
10944 item_properties
= Qnil
;
10946 staticpro (&tool_bar_item_properties
);
10947 tool_bar_item_properties
= Qnil
;
10948 staticpro (&tool_bar_items_vector
);
10949 tool_bar_items_vector
= Qnil
;
10951 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10952 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10953 DEFSYM (Qself_insert_command
, "self-insert-command");
10954 DEFSYM (Qforward_char
, "forward-char");
10955 DEFSYM (Qbackward_char
, "backward-char");
10956 DEFSYM (Qdisabled
, "disabled");
10957 DEFSYM (Qundefined
, "undefined");
10958 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10959 DEFSYM (Qpost_command_hook
, "post-command-hook");
10960 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10961 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10962 DEFSYM (Qfunction_key
, "function-key");
10963 DEFSYM (Qmouse_click
, "mouse-click");
10964 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10965 DEFSYM (Qsave_session
, "save-session");
10966 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10967 DEFSYM (Qmenu_enable
, "menu-enable");
10970 DEFSYM (Qlanguage_change
, "language-change");
10974 DEFSYM (Qdbus_event
, "dbus-event");
10977 #ifdef USE_FILE_NOTIFY
10978 DEFSYM (Qfile_notify
, "file-notify");
10979 #endif /* USE_FILE_NOTIFY */
10981 DEFSYM (QCenable
, ":enable");
10982 DEFSYM (QCvisible
, ":visible");
10983 DEFSYM (QChelp
, ":help");
10984 DEFSYM (QCfilter
, ":filter");
10985 DEFSYM (QCbutton
, ":button");
10986 DEFSYM (QCkeys
, ":keys");
10987 DEFSYM (QCkey_sequence
, ":key-sequence");
10988 DEFSYM (QCtoggle
, ":toggle");
10989 DEFSYM (QCradio
, ":radio");
10990 DEFSYM (QClabel
, ":label");
10991 DEFSYM (QCvert_only
, ":vert-only");
10993 DEFSYM (Qmode_line
, "mode-line");
10994 DEFSYM (Qvertical_line
, "vertical-line");
10995 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
10996 DEFSYM (Qmenu_bar
, "menu-bar");
10997 DEFSYM (Qright_divider
, "right-divider");
10998 DEFSYM (Qbottom_divider
, "bottom-divider");
11000 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11002 DEFSYM (Qabove_handle
, "above-handle");
11003 DEFSYM (Qhandle
, "handle");
11004 DEFSYM (Qbelow_handle
, "below-handle");
11005 DEFSYM (Qup
, "up");
11006 DEFSYM (Qdown
, "down");
11007 DEFSYM (Qtop
, "top");
11008 DEFSYM (Qbottom
, "bottom");
11009 DEFSYM (Qend_scroll
, "end-scroll");
11010 DEFSYM (Qratio
, "ratio");
11012 DEFSYM (Qevent_kind
, "event-kind");
11013 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11014 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11015 DEFSYM (Qmodifier_cache
, "modifier-cache");
11017 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11018 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11020 DEFSYM (Qpolling_period
, "polling-period");
11022 DEFSYM (Qx_set_selection
, "x-set-selection");
11023 DEFSYM (QPRIMARY
, "PRIMARY");
11024 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11025 DEFSYM (Qhandle_select_window
, "handle-select-window");
11027 DEFSYM (Qinput_method_function
, "input-method-function");
11028 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11029 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11031 DEFSYM (Qhelp_form_show
, "help-form-show");
11033 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11035 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11036 Fset (Qinput_method_use_echo_area
, Qnil
);
11040 int len
= ARRAYELTS (head_table
);
11042 for (i
= 0; i
< len
; i
++)
11044 const struct event_head
*p
= &head_table
[i
];
11045 *p
->var
= intern_c_string (p
->name
);
11046 staticpro (p
->var
);
11047 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11048 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11052 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11053 staticpro (&button_down_location
);
11054 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11055 staticpro (&mouse_syms
);
11056 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11058 staticpro (&wheel_syms
);
11062 int len
= ARRAYELTS (modifier_names
);
11064 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11065 for (i
= 0; i
< len
; i
++)
11066 if (modifier_names
[i
])
11067 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11068 staticpro (&modifier_symbols
);
11071 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11072 staticpro (&recent_keys
);
11074 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11075 staticpro (&this_command_keys
);
11077 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11078 staticpro (&raw_keybuf
);
11080 DEFSYM (Qcommand_execute
, "command-execute");
11082 accent_key_syms
= Qnil
;
11083 staticpro (&accent_key_syms
);
11085 func_key_syms
= Qnil
;
11086 staticpro (&func_key_syms
);
11088 drag_n_drop_syms
= Qnil
;
11089 staticpro (&drag_n_drop_syms
);
11091 unread_switch_frame
= Qnil
;
11092 staticpro (&unread_switch_frame
);
11094 internal_last_event_frame
= Qnil
;
11095 staticpro (&internal_last_event_frame
);
11097 read_key_sequence_cmd
= Qnil
;
11098 staticpro (&read_key_sequence_cmd
);
11099 read_key_sequence_remapped
= Qnil
;
11100 staticpro (&read_key_sequence_remapped
);
11102 menu_bar_one_keymap_changed_items
= Qnil
;
11103 staticpro (&menu_bar_one_keymap_changed_items
);
11105 menu_bar_items_vector
= Qnil
;
11106 staticpro (&menu_bar_items_vector
);
11108 help_form_saved_window_configs
= Qnil
;
11109 staticpro (&help_form_saved_window_configs
);
11111 defsubr (&Scurrent_idle_time
);
11112 defsubr (&Sevent_symbol_parse_modifiers
);
11113 defsubr (&Sevent_convert_list
);
11114 defsubr (&Sread_key_sequence
);
11115 defsubr (&Sread_key_sequence_vector
);
11116 defsubr (&Srecursive_edit
);
11117 defsubr (&Strack_mouse
);
11118 defsubr (&Sinput_pending_p
);
11119 defsubr (&Srecent_keys
);
11120 defsubr (&Sthis_command_keys
);
11121 defsubr (&Sthis_command_keys_vector
);
11122 defsubr (&Sthis_single_command_keys
);
11123 defsubr (&Sthis_single_command_raw_keys
);
11124 defsubr (&Sreset_this_command_lengths
);
11125 defsubr (&Sclear_this_command_keys
);
11126 defsubr (&Ssuspend_emacs
);
11127 defsubr (&Sabort_recursive_edit
);
11128 defsubr (&Sexit_recursive_edit
);
11129 defsubr (&Srecursion_depth
);
11130 defsubr (&Scommand_error_default_function
);
11131 defsubr (&Stop_level
);
11132 defsubr (&Sdiscard_input
);
11133 defsubr (&Sopen_dribble_file
);
11134 defsubr (&Sset_input_interrupt_mode
);
11135 defsubr (&Sset_output_flow_control
);
11136 defsubr (&Sset_input_meta_mode
);
11137 defsubr (&Sset_quit_char
);
11138 defsubr (&Sset_input_mode
);
11139 defsubr (&Scurrent_input_mode
);
11140 defsubr (&Sposn_at_point
);
11141 defsubr (&Sposn_at_x_y
);
11143 DEFVAR_LISP ("last-command-event", last_command_event
,
11144 doc
: /* Last input event that was part of a command. */);
11146 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11147 doc
: /* Last input event in a command, except for mouse menu events.
11148 Mouse menus give back keys that don't look like mouse events;
11149 this variable holds the actual mouse event that led to the menu,
11150 so that you can determine whether the command was run by mouse or not. */);
11152 DEFVAR_LISP ("last-input-event", last_input_event
,
11153 doc
: /* Last input event. */);
11155 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11156 doc
: /* List of events to be read as the command input.
11157 These events are processed first, before actual keyboard input.
11158 Events read from this list are not normally added to `this-command-keys',
11159 as they will already have been added once as they were read for the first time.
11160 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11161 Vunread_command_events
= Qnil
;
11163 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11164 doc
: /* List of events to be processed as input by input methods.
11165 These events are processed before `unread-command-events'
11166 and actual keyboard input, but are not given to `input-method-function'. */);
11167 Vunread_post_input_method_events
= Qnil
;
11169 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11170 doc
: /* List of events to be processed as input by input methods.
11171 These events are processed after `unread-command-events', but
11172 before actual keyboard input.
11173 If there's an active input method, the events are given to
11174 `input-method-function'. */);
11175 Vunread_input_method_events
= Qnil
;
11177 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11178 doc
: /* Meta-prefix character code.
11179 Meta-foo as command input turns into this character followed by foo. */);
11180 XSETINT (meta_prefix_char
, 033);
11182 DEFVAR_KBOARD ("last-command", Vlast_command
,
11183 doc
: /* The last command executed.
11184 Normally a symbol with a function definition, but can be whatever was found
11185 in the keymap, or whatever the variable `this-command' was set to by that
11188 The value `mode-exit' is special; it means that the previous command
11189 read an event that told it to exit, and it did so and unread that event.
11190 In other words, the present command is the event that made the previous
11193 The value `kill-region' is special; it means that the previous command
11194 was a kill command.
11196 `last-command' has a separate binding for each terminal device.
11197 See Info node `(elisp)Multiple Terminals'. */);
11199 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11200 doc
: /* Same as `last-command', but never altered by Lisp code.
11201 Taken from the previous value of `real-this-command'. */);
11203 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11204 doc
: /* Last command that may be repeated.
11205 The last command executed that was not bound to an input event.
11206 This is the command `repeat' will try to repeat.
11207 Taken from a previous value of `real-this-command'. */);
11209 DEFVAR_LISP ("this-command", Vthis_command
,
11210 doc
: /* The command now being executed.
11211 The command can set this variable; whatever is put here
11212 will be in `last-command' during the following command. */);
11213 Vthis_command
= Qnil
;
11215 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11216 doc
: /* This is like `this-command', except that commands should never modify it. */);
11217 Vreal_this_command
= Qnil
;
11219 DEFVAR_LISP ("this-command-keys-shift-translated",
11220 Vthis_command_keys_shift_translated
,
11221 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11222 Shift-translation occurs when there is no binding for the key sequence
11223 as entered, but a binding was found by changing an upper-case letter
11224 to lower-case, or a shifted function key to an unshifted one. */);
11225 Vthis_command_keys_shift_translated
= Qnil
;
11227 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11228 doc
: /* The command bound to the current key sequence before remapping.
11229 It equals `this-command' if the original command was not remapped through
11230 any of the active keymaps. Otherwise, the value of `this-command' is the
11231 result of looking up the original command in the active keymaps. */);
11232 Vthis_original_command
= Qnil
;
11234 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11235 doc
: /* Number of input events between auto-saves.
11236 Zero means disable autosaving due to number of characters typed. */);
11237 auto_save_interval
= 300;
11239 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11240 doc
: /* Number of seconds idle time before auto-save.
11241 Zero or nil means disable auto-saving due to idleness.
11242 After auto-saving due to this many seconds of idle time,
11243 Emacs also does a garbage collection if that seems to be warranted. */);
11244 XSETFASTINT (Vauto_save_timeout
, 30);
11246 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11247 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11248 The value may be integer or floating point.
11249 If the value is zero, don't echo at all. */);
11250 Vecho_keystrokes
= make_number (1);
11252 DEFVAR_INT ("polling-period", polling_period
,
11253 doc
: /* Interval between polling for input during Lisp execution.
11254 The reason for polling is to make C-g work to stop a running program.
11255 Polling is needed only when using X windows and SIGIO does not work.
11256 Polling is automatically disabled in all other cases. */);
11257 polling_period
= 2;
11259 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11260 doc
: /* Maximum time between mouse clicks to make a double-click.
11261 Measured in milliseconds. The value nil means disable double-click
11262 recognition; t means double-clicks have no time limit and are detected
11263 by position only. */);
11264 Vdouble_click_time
= make_number (500);
11266 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11267 doc
: /* Maximum mouse movement between clicks to make a double-click.
11268 On window-system frames, value is the number of pixels the mouse may have
11269 moved horizontally or vertically between two clicks to make a double-click.
11270 On non window-system frames, value is interpreted in units of 1/8 characters
11273 This variable is also the threshold for motion of the mouse
11274 to count as a drag. */);
11275 double_click_fuzz
= 3;
11277 DEFVAR_INT ("num-input-keys", num_input_keys
,
11278 doc
: /* Number of complete key sequences read as input so far.
11279 This includes key sequences read from keyboard macros.
11280 The number is effectively the number of interactive command invocations. */);
11281 num_input_keys
= 0;
11283 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11284 doc
: /* Number of input events read from the keyboard so far.
11285 This does not include events generated by keyboard macros. */);
11286 num_nonmacro_input_events
= 0;
11288 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11289 doc
: /* The frame in which the most recently read event occurred.
11290 If the last event came from a keyboard macro, this is set to `macro'. */);
11291 Vlast_event_frame
= Qnil
;
11293 /* This variable is set up in sysdep.c. */
11294 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11295 doc
: /* The ERASE character as set by the user with stty. */);
11297 DEFVAR_LISP ("help-char", Vhelp_char
,
11298 doc
: /* Character to recognize as meaning Help.
11299 When it is read, do `(eval help-form)', and display result if it's a string.
11300 If the value of `help-form' is nil, this char can be read normally. */);
11301 XSETINT (Vhelp_char
, Ctl ('H'));
11303 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11304 doc
: /* List of input events to recognize as meaning Help.
11305 These work just like the value of `help-char' (see that). */);
11306 Vhelp_event_list
= Qnil
;
11308 DEFVAR_LISP ("help-form", Vhelp_form
,
11309 doc
: /* Form to execute when character `help-char' is read.
11310 If the form returns a string, that string is displayed.
11311 If `help-form' is nil, the help char is not recognized. */);
11314 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11315 doc
: /* Command to run when `help-char' character follows a prefix key.
11316 This command is used only when there is no actual binding
11317 for that character after that prefix key. */);
11318 Vprefix_help_command
= Qnil
;
11320 DEFVAR_LISP ("top-level", Vtop_level
,
11321 doc
: /* Form to evaluate when Emacs starts up.
11322 Useful to set before you dump a modified Emacs. */);
11325 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11326 doc
: /* Translate table for local keyboard input, or nil.
11327 If non-nil, the value should be a char-table. Each character read
11328 from the keyboard is looked up in this char-table. If the value found
11329 there is non-nil, then it is used instead of the actual input character.
11331 The value can also be a string or vector, but this is considered obsolete.
11332 If it is a string or vector of length N, character codes N and up are left
11333 untranslated. In a vector, an element which is nil means "no translation".
11335 This is applied to the characters supplied to input methods, not their
11336 output. See also `translation-table-for-input'.
11338 This variable has a separate binding for each terminal.
11339 See Info node `(elisp)Multiple Terminals'. */);
11341 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11342 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11343 \(Even if the operating system has support for stopping a process.\) */);
11344 cannot_suspend
= 0;
11346 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11347 doc
: /* Non-nil means prompt with menus when appropriate.
11348 This is done when reading from a keymap that has a prompt string,
11349 for elements that have prompt strings.
11350 The menu is displayed on the screen
11351 if X menus were enabled at configuration
11352 time and the previous event was a mouse click prefix key.
11353 Otherwise, menu prompting uses the echo area. */);
11354 menu_prompting
= 1;
11356 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11357 doc
: /* Character to see next line of menu prompt.
11358 Type this character while in a menu prompt to rotate around the lines of it. */);
11359 XSETINT (menu_prompt_more_char
, ' ');
11361 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11362 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11363 Emacs applies the modifiers of the character stored here to each keyboard
11364 character it reads. For example, after evaluating the expression
11365 (setq extra-keyboard-modifiers ?\\C-x)
11366 all input characters will have the control modifier applied to them.
11368 Note that the character ?\\C-@, equivalent to the integer zero, does
11369 not count as a control character; rather, it counts as a character
11370 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11371 cancels any modification. */);
11372 extra_keyboard_modifiers
= 0;
11374 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11375 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11376 The command loop sets this to nil before each command,
11377 and tests the value when the command returns.
11378 Buffer modification stores t in this variable. */);
11379 Vdeactivate_mark
= Qnil
;
11380 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11382 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11383 doc
: /* Normal hook run before each command is executed.
11384 If an unhandled error happens in running this hook,
11385 the function in which the error occurred is unconditionally removed, since
11386 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11387 Vpre_command_hook
= Qnil
;
11389 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11390 doc
: /* Normal hook run after each command is executed.
11391 If an unhandled error happens in running this hook,
11392 the function in which the error occurred is unconditionally removed, since
11393 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11394 Vpost_command_hook
= Qnil
;
11397 DEFVAR_LISP ("echo-area-clear-hook", ...,
11398 doc
: /* Normal hook run when clearing the echo area. */);
11400 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11401 Fset (Qecho_area_clear_hook
, Qnil
);
11403 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11404 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11405 Vlucid_menu_bar_dirty_flag
= Qnil
;
11407 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11408 doc
: /* List of menu bar items to move to the end of the menu bar.
11409 The elements of the list are event types that may have menu bar bindings. */);
11410 Vmenu_bar_final_items
= Qnil
;
11412 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11413 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11414 This is used internally by graphical displays that do not render
11415 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11416 Vtool_bar_separator_image_expression
= Qnil
;
11418 DEFVAR_KBOARD ("overriding-terminal-local-map",
11419 Voverriding_terminal_local_map
,
11420 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11421 This variable is intended to let commands such as `universal-argument'
11422 set up a different keymap for reading the next command.
11424 `overriding-terminal-local-map' has a separate binding for each
11425 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11427 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11428 doc
: /* Keymap that replaces (overrides) local keymaps.
11429 If this variable is non-nil, Emacs looks up key bindings in this
11430 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11431 buffer's local map. Hence, the only active keymaps would be
11432 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11433 order of precedence. */);
11434 Voverriding_local_map
= Qnil
;
11436 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11437 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11438 Otherwise, the menu bar continues to reflect the buffer's local map
11439 and the minor mode maps regardless of `overriding-local-map'. */);
11440 Voverriding_local_map_menu_flag
= Qnil
;
11442 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11443 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11444 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11446 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11447 doc
: /* Non-nil means generate motion events for mouse motion. */);
11449 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11450 doc
: /* Alist of system-specific X windows key symbols.
11451 Each element should have the form (N . SYMBOL) where N is the
11452 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11453 and SYMBOL is its name.
11455 `system-key-alist' has a separate binding for each terminal device.
11456 See Info node `(elisp)Multiple Terminals'. */);
11458 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11459 doc
: /* Keymap that translates key sequences to key sequences during input.
11460 This is used mainly for mapping key sequences into some preferred
11461 key events (symbols).
11463 The `read-key-sequence' function replaces any subsequence bound by
11464 `local-function-key-map' with its binding. More precisely, when the
11465 active keymaps have no binding for the current key sequence but
11466 `local-function-key-map' binds a suffix of the sequence to a vector or
11467 string, `read-key-sequence' replaces the matching suffix with its
11468 binding, and continues with the new sequence.
11470 If the binding is a function, it is called with one argument (the prompt)
11471 and its return value (a key sequence) is used.
11473 The events that come from bindings in `local-function-key-map' are not
11474 themselves looked up in `local-function-key-map'.
11476 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11477 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11478 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11479 typing `ESC O P x' would return [f1 x].
11481 `local-function-key-map' has a separate binding for each terminal
11482 device. See Info node `(elisp)Multiple Terminals'. If you need to
11483 define a binding on all terminals, change `function-key-map'
11484 instead. Initially, `local-function-key-map' is an empty keymap that
11485 has `function-key-map' as its parent on all terminal devices. */);
11487 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11488 doc
: /* Keymap that decodes input escape sequences.
11489 This is used mainly for mapping ASCII function key sequences into
11490 real Emacs function key events (symbols).
11492 The `read-key-sequence' function replaces any subsequence bound by
11493 `input-decode-map' with its binding. Contrary to `function-key-map',
11494 this map applies its rebinding regardless of the presence of an ordinary
11495 binding. So it is more like `key-translation-map' except that it applies
11496 before `function-key-map' rather than after.
11498 If the binding is a function, it is called with one argument (the prompt)
11499 and its return value (a key sequence) is used.
11501 The events that come from bindings in `input-decode-map' are not
11502 themselves looked up in `input-decode-map'. */);
11504 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11505 doc
: /* The parent keymap of all `local-function-key-map' instances.
11506 Function key definitions that apply to all terminal devices should go
11507 here. If a mapping is defined in both the current
11508 `local-function-key-map' binding and this variable, then the local
11509 definition will take precedence. */);
11510 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11512 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11513 doc
: /* Keymap of key translations that can override keymaps.
11514 This keymap works like `input-decode-map', but comes after `function-key-map'.
11515 Another difference is that it is global rather than terminal-local. */);
11516 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11518 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11519 doc
: /* List of deferred actions to be performed at a later time.
11520 The precise format isn't relevant here; we just check whether it is nil. */);
11521 Vdeferred_action_list
= Qnil
;
11523 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11524 doc
: /* Function to call to handle deferred actions, after each command.
11525 This function is called with no arguments after each command
11526 whenever `deferred-action-list' is non-nil. */);
11527 Vdeferred_action_function
= Qnil
;
11529 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11530 doc
: /* List of warnings to be displayed after this command.
11531 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11532 as per the args of `display-warning' (which see).
11533 If this variable is non-nil, `delayed-warnings-hook' will be run
11534 immediately after running `post-command-hook'. */);
11535 Vdelayed_warnings_list
= Qnil
;
11537 DEFVAR_LISP ("timer-list", Vtimer_list
,
11538 doc
: /* List of active absolute time timers in order of increasing time. */);
11539 Vtimer_list
= Qnil
;
11541 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11542 doc
: /* List of active idle-time timers in order of increasing time. */);
11543 Vtimer_idle_list
= Qnil
;
11545 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11546 doc
: /* If non-nil, the function that implements the current input method.
11547 It's called with one argument, a printing character that was just read.
11548 \(That means a character with code 040...0176.)
11549 Typically this function uses `read-event' to read additional events.
11550 When it does so, it should first bind `input-method-function' to nil
11551 so it will not be called recursively.
11553 The function should return a list of zero or more events
11554 to be used as input. If it wants to put back some events
11555 to be reconsidered, separately, by the input method,
11556 it can add them to the beginning of `unread-command-events'.
11558 The input method function can find in `input-method-previous-message'
11559 the previous echo area message.
11561 The input method function should refer to the variables
11562 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11563 for guidance on what to do. */);
11564 Vinput_method_function
= Qnil
;
11566 DEFVAR_LISP ("input-method-previous-message",
11567 Vinput_method_previous_message
,
11568 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11569 This variable exists because `read-event' clears the echo area
11570 before running the input method. It is nil if there was no message. */);
11571 Vinput_method_previous_message
= Qnil
;
11573 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11574 doc
: /* If non-nil, the function that implements the display of help.
11575 It's called with one argument, the help string to display. */);
11576 Vshow_help_function
= Qnil
;
11578 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11579 doc
: /* If non-nil, suppress point adjustment after executing a command.
11581 After a command is executed, if point is moved into a region that has
11582 special properties (e.g. composition, display), we adjust point to
11583 the boundary of the region. But, when a command sets this variable to
11584 non-nil, we suppress the point adjustment.
11586 This variable is set to nil before reading a command, and is checked
11587 just after executing the command. */);
11588 Vdisable_point_adjustment
= Qnil
;
11590 DEFVAR_LISP ("global-disable-point-adjustment",
11591 Vglobal_disable_point_adjustment
,
11592 doc
: /* If non-nil, always suppress point adjustment.
11594 The default value is nil, in which case, point adjustment are
11595 suppressed only after special commands that set
11596 `disable-point-adjustment' (which see) to non-nil. */);
11597 Vglobal_disable_point_adjustment
= Qnil
;
11599 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11600 doc
: /* How long to display an echo-area message when the minibuffer is active.
11601 If the value is not a number, such messages don't time out. */);
11602 Vminibuffer_message_timeout
= make_number (2);
11604 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11605 doc
: /* If non-nil, any keyboard input throws to this symbol.
11606 The value of that variable is passed to `quit-flag' and later causes a
11607 peculiar kind of quitting. */);
11608 Vthrow_on_input
= Qnil
;
11610 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11611 doc
: /* Function to output error messages.
11612 Called with three arguments:
11613 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11614 such as what `condition-case' would bind its variable to,
11615 - the context (a string which normally goes at the start of the message),
11616 - the Lisp function within which the error was signaled. */);
11617 Vcommand_error_function
= intern ("command-error-default-function");
11619 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11620 Venable_disabled_menus_and_buttons
,
11621 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11623 Help functions bind this to allow help on disabled menu items
11624 and tool-bar buttons. */);
11625 Venable_disabled_menus_and_buttons
= Qnil
;
11627 DEFVAR_LISP ("select-active-regions",
11628 Vselect_active_regions
,
11629 doc
: /* If non-nil, an active region automatically sets the primary selection.
11630 If the value is `only', only temporarily active regions (usually made
11631 by mouse-dragging or shift-selection) set the window selection.
11633 This takes effect only when Transient Mark mode is enabled. */);
11634 Vselect_active_regions
= Qt
;
11636 DEFVAR_LISP ("saved-region-selection",
11637 Vsaved_region_selection
,
11638 doc
: /* Contents of active region prior to buffer modification.
11639 If `select-active-regions' is non-nil, Emacs sets this to the
11640 text in the region before modifying the buffer. The next call to
11641 the function `deactivate-mark' uses this to set the window selection. */);
11642 Vsaved_region_selection
= Qnil
;
11644 DEFVAR_LISP ("selection-inhibit-update-commands",
11645 Vselection_inhibit_update_commands
,
11646 doc
: /* List of commands which should not update the selection.
11647 Normally, if `select-active-regions' is non-nil and the mark remains
11648 active after a command (i.e. the mark was not deactivated), the Emacs
11649 command loop sets the selection to the text in the region. However,
11650 if the command is in this list, the selection is not updated. */);
11651 Vselection_inhibit_update_commands
11652 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11654 DEFVAR_LISP ("debug-on-event",
11656 doc
: /* Enter debugger on this event. When Emacs
11657 receives the special event specified by this variable, it will try to
11658 break into the debugger as soon as possible instead of processing the
11659 event normally through `special-event-map'.
11661 Currently, the only supported values for this
11662 variable are `sigusr1' and `sigusr2'. */);
11663 Vdebug_on_event
= intern_c_string ("sigusr2");
11665 /* Create the initial keyboard. Qt means 'unset'. */
11666 initial_kboard
= allocate_kboard (Qt
);
11670 keys_of_keyboard (void)
11672 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11673 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11674 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11675 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11676 initial_define_key (meta_map
, 'x', "execute-extended-command");
11678 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11679 "handle-delete-frame");
11680 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11681 "ns-put-working-text");
11682 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11683 "ns-unput-working-text");
11684 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11685 current-prefix-arg, as is done in `handle-switch-frame'.
11686 But `handle-switch-frame is not run from the special-map.
11687 Commands from that map are run in a special way that automatically
11688 preserves the prefix-arg. Restoring the prefix arg here is not just
11689 redundant but harmful:
11691 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11692 - after the first prompt, the exit-minibuffer-hook is run which may
11693 iconify a frame and thus push a `iconify-frame' event.
11694 - after running exit-minibuffer-hook, current-prefix-arg is
11695 restored to the non-nil value it had before the prompt.
11696 - we enter the second prompt.
11697 current-prefix-arg is non-nil, prefix-arg is nil.
11698 - before running the first real event, we run the special iconify-frame
11699 event, but we pass the `special' arg to execute-command so
11700 current-prefix-arg and prefix-arg are left untouched.
11701 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11702 - the next key event will have a spuriously non-nil current-prefix-arg. */
11703 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11705 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11707 /* Handling it at such a low-level causes read_key_sequence to get
11708 * confused because it doesn't realize that the current_buffer was
11709 * changed by read_char.
11711 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11712 * "handle-select-window"); */
11713 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11714 "handle-save-session");
11717 /* Define a special event which is raised for dbus callback
11719 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11720 "dbus-handle-event");
11723 #ifdef USE_FILE_NOTIFY
11724 /* Define a special event which is raised for notification callback
11726 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11727 "file-notify-handle-event");
11728 #endif /* USE_FILE_NOTIFY */
11730 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11732 #if defined (WINDOWSNT)
11733 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11736 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11737 "handle-focus-in");
11738 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11739 "handle-focus-out");
11742 /* Mark the pointers in the kboard objects.
11743 Called by Fgarbage_collect. */
11745 mark_kboards (void)
11749 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11751 if (kb
->kbd_macro_buffer
)
11752 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11754 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11755 mark_object (KVAR (kb
, Vlast_command
));
11756 mark_object (KVAR (kb
, Vreal_last_command
));
11757 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11758 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11759 mark_object (KVAR (kb
, Vprefix_arg
));
11760 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11761 mark_object (KVAR (kb
, kbd_queue
));
11762 mark_object (KVAR (kb
, defining_kbd_macro
));
11763 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11764 mark_object (KVAR (kb
, Vsystem_key_alist
));
11765 mark_object (KVAR (kb
, system_key_syms
));
11766 mark_object (KVAR (kb
, Vwindow_system
));
11767 mark_object (KVAR (kb
, Vinput_decode_map
));
11768 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11769 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11770 mark_object (KVAR (kb
, echo_string
));
11773 struct input_event
*event
;
11774 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11776 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11777 event
= kbd_buffer
;
11778 /* These two special event types has no Lisp_Objects to mark. */
11779 if (event
->kind
!= SELECTION_REQUEST_EVENT
11780 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11782 mark_object (event
->x
);
11783 mark_object (event
->y
);
11784 mark_object (event
->frame_or_window
);
11785 mark_object (event
->arg
);