1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2013 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/>. */
23 #define BLOCKINPUT_INLINE EXTERN_INLINE
24 #define KEYBOARD_INLINE EXTERN_INLINE
32 #include "termhooks.h"
37 #include "character.h"
40 #include "dispextern.h"
42 #include "intervals.h"
44 #include "blockinput.h"
58 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #if defined USABLE_FIONREAD && defined USG5_4
62 # include <sys/filio.h>
65 #include "syssignal.h"
67 #include <sys/types.h>
71 #ifdef HAVE_WINDOW_SYSTEM
73 #endif /* HAVE_WINDOW_SYSTEM */
75 /* Variables for blockinput.h: */
77 /* Positive if interrupt input is blocked right now. */
78 volatile int interrupt_input_blocked
;
80 /* True means an input interrupt or alarm signal has arrived.
81 The QUIT macro checks this. */
82 volatile bool pending_signals
;
84 #define KBD_BUFFER_SIZE 4096
86 KBOARD
*initial_kboard
;
87 KBOARD
*current_kboard
;
90 /* True in the single-kboard state, false in the any-kboard state. */
91 static bool single_kboard
;
93 /* Non-nil disable property on a command means
94 do not execute it; call disabled-command-function's value instead. */
95 Lisp_Object Qdisabled
;
96 static Lisp_Object Qdisabled_command_function
;
98 #define NUM_RECENT_KEYS (300)
100 /* Index for storing next element into recent_keys. */
101 static int recent_keys_index
;
103 /* Total number of elements stored into recent_keys. */
104 static int total_keys
;
106 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
107 static Lisp_Object recent_keys
;
109 /* Vector holding the key sequence that invoked the current command.
110 It is reused for each command, and it may be longer than the current
111 sequence; this_command_key_count indicates how many elements
112 actually mean something.
113 It's easier to staticpro a single Lisp_Object than an array. */
114 Lisp_Object this_command_keys
;
115 ptrdiff_t this_command_key_count
;
117 /* True after calling Freset_this_command_lengths.
118 Usually it is false. */
119 static bool this_command_key_count_reset
;
121 /* This vector is used as a buffer to record the events that were actually read
122 by read_key_sequence. */
123 static Lisp_Object raw_keybuf
;
124 static int raw_keybuf_count
;
126 #define GROW_RAW_KEYBUF \
127 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
128 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
130 /* Number of elements of this_command_keys
131 that precede this key sequence. */
132 static ptrdiff_t this_single_command_key_start
;
134 /* Record values of this_command_key_count and echo_length ()
135 before this command was read. */
136 static ptrdiff_t before_command_key_count
;
137 static ptrdiff_t before_command_echo_length
;
139 /* For longjmp to where kbd input is being done. */
141 static sys_jmp_buf getcjmp
;
143 /* True while doing kbd input. */
144 bool waiting_for_input
;
146 /* True while displaying for echoing. Delays C-g throwing. */
150 /* Non-null means we can start echoing at the next input pause even
151 though there is something in the echo area. */
153 static struct kboard
*ok_to_echo_at_next_pause
;
155 /* The kboard last echoing, or null for none. Reset to 0 in
156 cancel_echoing. If non-null, and a current echo area message
157 exists, and echo_message_buffer is eq to the current message
158 buffer, we know that the message comes from echo_kboard. */
160 struct kboard
*echo_kboard
;
162 /* The buffer used for echoing. Set in echo_now, reset in
165 Lisp_Object echo_message_buffer
;
167 /* True means C-g should cause immediate error-signal. */
170 /* Character that causes a quit. Normally C-g.
172 If we are running on an ordinary terminal, this must be an ordinary
173 ASCII char, since we want to make it our interrupt character.
175 If we are not running on an ordinary terminal, it still needs to be
176 an ordinary ASCII char. This character needs to be recognized in
177 the input interrupt handler. At this point, the keystroke is
178 represented as a struct input_event, while the desired quit
179 character is specified as a lispy event. The mapping from struct
180 input_events to lispy events cannot run in an interrupt handler,
181 and the reverse mapping is difficult for anything but ASCII
184 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
188 /* Current depth in recursive edits. */
189 EMACS_INT command_loop_level
;
191 /* If not Qnil, this is a switch-frame event which we decided to put
192 off until the end of a key sequence. This should be read as the
193 next command input, after any unread_command_events.
195 read_key_sequence uses this to delay switch-frame events until the
196 end of the key sequence; Fread_char uses it to put off switch-frame
197 events until a non-ASCII event is acceptable as input. */
198 Lisp_Object unread_switch_frame
;
200 /* Last size recorded for a current buffer which is not a minibuffer. */
201 static ptrdiff_t last_non_minibuf_size
;
203 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
204 uintmax_t num_input_events
;
206 /* Value of num_nonmacro_input_events as of last auto save. */
208 static EMACS_INT last_auto_save
;
210 /* The value of point when the last command was started. */
211 static ptrdiff_t last_point_position
;
213 /* The frame in which the last input event occurred, or Qmacro if the
214 last event came from a macro. We use this to determine when to
215 generate switch-frame events. This may be cleared by functions
216 like Fselect_frame, to make sure that a switch-frame event is
217 generated by the next character.
219 FIXME: This is modified by a signal handler so it should be volatile.
220 It's exported to Lisp, though, so it can't simply be marked
222 Lisp_Object internal_last_event_frame
;
224 /* The timestamp of the last input event we received from the X server.
225 X Windows wants this for selection ownership. */
226 Time last_event_timestamp
;
228 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
229 static Lisp_Object Qhandle_select_window
;
230 Lisp_Object QPRIMARY
;
232 static Lisp_Object Qself_insert_command
;
233 static Lisp_Object Qforward_char
;
234 static Lisp_Object Qbackward_char
;
235 Lisp_Object Qundefined
;
236 static Lisp_Object Qtimer_event_handler
;
238 /* read_key_sequence stores here the command definition of the
239 key sequence that it reads. */
240 static Lisp_Object read_key_sequence_cmd
;
241 static Lisp_Object read_key_sequence_remapped
;
243 static Lisp_Object Qinput_method_function
;
245 static Lisp_Object Qdeactivate_mark
;
247 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
249 static Lisp_Object Qecho_area_clear_hook
;
251 /* Hooks to run before and after each command. */
252 static Lisp_Object Qpre_command_hook
;
253 static Lisp_Object Qpost_command_hook
;
255 static Lisp_Object Qdeferred_action_function
;
257 static Lisp_Object Qdelayed_warnings_hook
;
259 static Lisp_Object Qinput_method_exit_on_first_char
;
260 static Lisp_Object Qinput_method_use_echo_area
;
262 static Lisp_Object Qhelp_form_show
;
264 /* File in which we write all commands we read. */
265 static FILE *dribble
;
267 /* Nonzero if input is available. */
270 /* Circular buffer for pre-read keyboard input. */
272 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
274 /* Pointer to next available character in kbd_buffer.
275 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
276 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
277 next available char is in kbd_buffer[0]. */
278 static struct input_event
*kbd_fetch_ptr
;
280 /* Pointer to next place to store character in kbd_buffer. This
281 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
282 character should go in kbd_buffer[0]. */
283 static struct input_event
* volatile kbd_store_ptr
;
285 /* The above pair of variables forms a "queue empty" flag. When we
286 enqueue a non-hook event, we increment kbd_store_ptr. When we
287 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
288 there is input available if the two pointers are not equal.
290 Why not just have a flag set and cleared by the enqueuing and
291 dequeuing functions? Such a flag could be screwed up by interrupts
292 at inopportune times. */
294 /* Symbols to head events. */
295 static Lisp_Object Qmouse_movement
;
296 static Lisp_Object Qscroll_bar_movement
;
297 Lisp_Object Qswitch_frame
;
298 static Lisp_Object Qfocus_in
, Qfocus_out
;
299 static Lisp_Object Qdelete_frame
;
300 static Lisp_Object Qiconify_frame
;
301 static Lisp_Object Qmake_frame_visible
;
302 static Lisp_Object Qselect_window
;
303 Lisp_Object Qhelp_echo
;
305 static Lisp_Object Qmouse_fixup_help_message
;
307 /* Symbols to denote kinds of events. */
308 static Lisp_Object Qfunction_key
;
309 Lisp_Object Qmouse_click
;
311 Lisp_Object Qlanguage_change
;
313 static Lisp_Object Qdrag_n_drop
;
314 static Lisp_Object Qsave_session
;
316 static Lisp_Object Qdbus_event
;
318 #ifdef USE_FILE_NOTIFY
319 static Lisp_Object Qfile_notify
;
320 #endif /* USE_FILE_NOTIFY */
321 static Lisp_Object Qconfig_changed_event
;
323 /* Lisp_Object Qmouse_movement; - also an event header */
325 /* Properties of event headers. */
326 Lisp_Object Qevent_kind
;
327 static Lisp_Object Qevent_symbol_elements
;
329 /* Menu and tool bar item parts. */
330 static Lisp_Object Qmenu_enable
;
331 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
332 Lisp_Object QCfilter
;
334 /* Non-nil disable property on a command means
335 do not execute it; call disabled-command-function's value instead. */
336 Lisp_Object QCtoggle
, QCradio
;
337 static Lisp_Object QCbutton
, QClabel
;
339 static Lisp_Object QCvert_only
;
341 /* An event header symbol HEAD may have a property named
342 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
343 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
344 mask of modifiers applied to it. If present, this is used to help
345 speed up parse_modifiers. */
346 Lisp_Object Qevent_symbol_element_mask
;
348 /* An unmodified event header BASE may have a property named
349 Qmodifier_cache, which is an alist mapping modifier masks onto
350 modified versions of BASE. If present, this helps speed up
352 static Lisp_Object Qmodifier_cache
;
354 /* Symbols to use for parts of windows. */
355 Lisp_Object Qmode_line
;
356 Lisp_Object Qvertical_line
;
357 static Lisp_Object Qvertical_scroll_bar
;
358 Lisp_Object Qmenu_bar
;
360 static void recursive_edit_unwind (Lisp_Object buffer
);
361 static Lisp_Object
command_loop (void);
362 static Lisp_Object Qcommand_execute
;
363 struct timespec
timer_check (void);
365 static void echo_now (void);
366 static ptrdiff_t echo_length (void);
368 static Lisp_Object Qpolling_period
;
370 /* Incremented whenever a timer is run. */
373 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
375 struct timespec
*input_available_clear_time
;
377 /* True means use SIGIO interrupts; false means use CBREAK mode.
378 Default is true if INTERRUPT_INPUT is defined. */
379 bool interrupt_input
;
381 /* Nonzero while interrupts are temporarily deferred during redisplay. */
382 bool interrupts_deferred
;
384 /* If we support a window system, turn on the code to poll periodically
385 to detect C-g. It isn't actually used when doing interrupt input. */
386 #ifdef HAVE_WINDOW_SYSTEM
387 #define POLL_FOR_INPUT
390 /* The time when Emacs started being idle. */
392 static struct timespec timer_idleness_start_time
;
394 /* After Emacs stops being idle, this saves the last value
395 of timer_idleness_start_time from when it was idle. */
397 static struct timespec timer_last_idleness_start_time
;
400 /* Global variable declarations. */
402 /* Flags for readable_events. */
403 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
404 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
405 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
407 /* Function for init_keyboard to call with no args (if nonzero). */
408 static void (*keyboard_init_hook
) (void);
410 static bool get_input_pending (int);
411 static bool readable_events (int);
412 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
413 Lisp_Object
, bool *);
414 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
415 static Lisp_Object
make_lispy_event (struct input_event
*);
416 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
417 enum scroll_bar_part
,
418 Lisp_Object
, Lisp_Object
,
420 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
421 Lisp_Object
, const char *const *,
422 Lisp_Object
*, ptrdiff_t);
423 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
424 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
425 #ifdef HAVE_WINDOW_SYSTEM
426 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
427 #endif /* HAVE_WINDOW_SYSTEM */
428 static bool help_char_p (Lisp_Object
);
429 static void save_getcjmp (sys_jmp_buf
);
430 static void restore_getcjmp (sys_jmp_buf
);
431 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
432 static void clear_event (struct input_event
*);
433 static void restore_kboard_configuration (int);
435 static void deliver_input_available_signal (int signo
);
437 static void handle_interrupt (bool);
438 static _Noreturn
void quit_throw_to_read_char (bool);
439 static void process_special_events (void);
440 static void timer_start_idle (void);
441 static void timer_stop_idle (void);
442 static void timer_resume_idle (void);
443 static void deliver_user_signal (int);
444 static char *find_user_signal_name (int);
445 static void store_user_signal_events (void);
447 /* These setters are used only in this file, so they can be private. */
449 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
451 kb
->INTERNAL_FIELD (echo_string
) = val
;
454 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
456 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
459 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
461 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
464 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
466 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
469 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
471 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
474 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
476 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
479 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
481 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
484 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
486 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
489 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
491 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
495 /* Add C to the echo string, without echoing it immediately. C can be
496 a character, which is pretty-printed, or a symbol, whose name is
500 echo_add_key (Lisp_Object c
)
502 int size
= KEY_DESCRIPTION_SIZE
+ 100;
503 char *buffer
= alloca (size
);
505 Lisp_Object echo_string
;
507 echo_string
= KVAR (current_kboard
, echo_string
);
509 /* If someone has passed us a composite event, use its head symbol. */
513 ptr
= push_key_description (XINT (c
), ptr
);
514 else if (SYMBOLP (c
))
516 Lisp_Object name
= SYMBOL_NAME (c
);
517 int nbytes
= SBYTES (name
);
519 if (size
- (ptr
- buffer
) < nbytes
)
521 int offset
= ptr
- buffer
;
522 size
= max (2 * size
, size
+ nbytes
);
523 buffer
= alloca (size
);
524 ptr
= buffer
+ offset
;
527 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
528 STRING_MULTIBYTE (name
), 1);
531 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
534 const char *text
= " (Type ? for further options)";
535 int len
= strlen (text
);
537 if (size
- (ptr
- buffer
) < len
)
539 int offset
= ptr
- buffer
;
541 buffer
= alloca (size
);
542 ptr
= buffer
+ offset
;
545 memcpy (ptr
, text
, len
);
549 /* Replace a dash from echo_dash with a space, otherwise add a space
550 at the end as a separator between keys. */
551 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
553 Lisp_Object last_char
, prev_char
, idx
;
555 idx
= make_number (SCHARS (echo_string
) - 2);
556 prev_char
= Faref (echo_string
, idx
);
558 idx
= make_number (SCHARS (echo_string
) - 1);
559 last_char
= Faref (echo_string
, idx
);
561 /* We test PREV_CHAR to make sure this isn't the echoing of a
563 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
564 Faset (echo_string
, idx
, make_number (' '));
566 echo_string
= concat2 (echo_string
, build_string (" "));
568 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
569 echo_string
= concat2 (echo_string
, build_string (" "));
573 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
576 /* Add C to the echo string, if echoing is going on. C can be a
577 character or a symbol. */
580 echo_char (Lisp_Object c
)
582 if (current_kboard
->immediate_echo
)
589 /* Temporarily add a dash to the end of the echo string if it's not
590 empty, so that it serves as a mini-prompt for the very next
596 /* Do nothing if not echoing at all. */
597 if (NILP (KVAR (current_kboard
, echo_string
)))
600 if (this_command_key_count
== 0)
603 if (!current_kboard
->immediate_echo
604 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
607 /* Do nothing if we just printed a prompt. */
608 if (current_kboard
->echo_after_prompt
609 == SCHARS (KVAR (current_kboard
, echo_string
)))
612 /* Do nothing if we have already put a dash at the end. */
613 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
615 Lisp_Object last_char
, prev_char
, idx
;
617 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
618 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
620 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
621 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
623 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
627 /* Put a dash at the end of the buffer temporarily,
628 but make it go away when the next character is added. */
631 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
635 /* Display the current echo string, and begin echoing if not already
641 if (!current_kboard
->immediate_echo
)
644 current_kboard
->immediate_echo
= 1;
646 for (i
= 0; i
< this_command_key_count
; i
++)
650 /* Set before_command_echo_length to the value that would
651 have been saved before the start of this subcommand in
652 command_loop_1, if we had already been echoing then. */
653 if (i
== this_single_command_key_start
)
654 before_command_echo_length
= echo_length ();
656 c
= AREF (this_command_keys
, i
);
657 if (! (EVENT_HAS_PARAMETERS (c
)
658 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
662 /* Set before_command_echo_length to the value that would
663 have been saved before the start of this subcommand in
664 command_loop_1, if we had already been echoing then. */
665 if (this_command_key_count
== this_single_command_key_start
)
666 before_command_echo_length
= echo_length ();
668 /* Put a dash at the end to invite the user to type more. */
673 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
674 message3_nolog (KVAR (current_kboard
, echo_string
));
677 /* Record in what buffer we echoed, and from which kboard. */
678 echo_message_buffer
= echo_area_buffer
[0];
679 echo_kboard
= current_kboard
;
681 if (waiting_for_input
&& !NILP (Vquit_flag
))
682 quit_throw_to_read_char (0);
685 /* Turn off echoing, for the start of a new command. */
688 cancel_echoing (void)
690 current_kboard
->immediate_echo
= 0;
691 current_kboard
->echo_after_prompt
= -1;
692 kset_echo_string (current_kboard
, Qnil
);
693 ok_to_echo_at_next_pause
= NULL
;
695 echo_message_buffer
= Qnil
;
698 /* Return the length of the current echo string. */
703 return (STRINGP (KVAR (current_kboard
, echo_string
))
704 ? SCHARS (KVAR (current_kboard
, echo_string
))
708 /* Truncate the current echo message to its first LEN chars.
709 This and echo_char get used by read_key_sequence when the user
710 switches frames while entering a key sequence. */
713 echo_truncate (ptrdiff_t nchars
)
715 if (STRINGP (KVAR (current_kboard
, echo_string
)))
716 kset_echo_string (current_kboard
,
717 Fsubstring (KVAR (current_kboard
, echo_string
),
718 make_number (0), make_number (nchars
)));
719 truncate_echo_area (nchars
);
723 /* Functions for manipulating this_command_keys. */
725 add_command_key (Lisp_Object key
)
727 #if 0 /* Not needed after we made Freset_this_command_lengths
728 do the job immediately. */
729 /* If reset-this-command-length was called recently, obey it now.
730 See the doc string of that function for an explanation of why. */
731 if (before_command_restore_flag
)
733 this_command_key_count
= before_command_key_count_1
;
734 if (this_command_key_count
< this_single_command_key_start
)
735 this_single_command_key_start
= this_command_key_count
;
736 echo_truncate (before_command_echo_length_1
);
737 before_command_restore_flag
= 0;
741 if (this_command_key_count
>= ASIZE (this_command_keys
))
742 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
744 ASET (this_command_keys
, this_command_key_count
, key
);
745 ++this_command_key_count
;
750 recursive_edit_1 (void)
752 ptrdiff_t count
= SPECPDL_INDEX ();
755 if (command_loop_level
> 0)
757 specbind (Qstandard_output
, Qt
);
758 specbind (Qstandard_input
, Qt
);
761 #ifdef HAVE_WINDOW_SYSTEM
762 /* The command loop has started an hourglass timer, so we have to
763 cancel it here, otherwise it will fire because the recursive edit
764 can take some time. Do not check for display_hourglass_p here,
765 because it could already be nil. */
769 /* This function may have been called from a debugger called from
770 within redisplay, for instance by Edebugging a function called
771 from fontification-functions. We want to allow redisplay in
772 the debugging session.
774 The recursive edit is left with a `(throw exit ...)'. The `exit'
775 tag is not caught anywhere in redisplay, i.e. when we leave the
776 recursive edit, the original redisplay leading to the recursive
777 edit will be unwound. The outcome should therefore be safe. */
778 specbind (Qinhibit_redisplay
, Qnil
);
781 val
= command_loop ();
783 Fsignal (Qquit
, Qnil
);
784 /* Handle throw from read_minibuf when using minibuffer
785 while it's active but we're in another window. */
787 xsignal1 (Qerror
, val
);
789 return unbind_to (count
, Qnil
);
792 /* When an auto-save happens, record the "time", and don't do again soon. */
795 record_auto_save (void)
797 last_auto_save
= num_nonmacro_input_events
;
800 /* Make an auto save happen as soon as possible at command level. */
804 force_auto_save_soon (void)
806 last_auto_save
= - auto_save_interval
- 1;
808 record_asynch_buffer_change ();
812 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
813 doc
: /* Invoke the editor command loop recursively.
814 To get out of the recursive edit, a command can do `(throw 'exit nil)';
815 that tells this function to return.
816 Alternatively, `(throw 'exit t)' makes this function signal an error.
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
= 1;
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
= 1;
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 struct frame
*sf
= SELECTED_FRAME ();
1074 /* The immediate context is not interesting for Quits,
1075 since they are asynchronous. */
1076 if (EQ (XCAR (data
), Qquit
))
1077 Vsignaling_function
= Qnil
;
1082 /* Use user's specified output function if any. */
1083 if (!NILP (Vcommand_error_function
))
1084 call3 (Vcommand_error_function
, data
,
1085 context
? build_string (context
) : empty_unibyte_string
,
1086 Vsignaling_function
);
1087 /* If the window system or terminal frame hasn't been initialized
1088 yet, or we're not interactive, write the message to stderr and exit. */
1089 else if (!sf
->glyphs_initialized_p
1090 /* The initial frame is a special non-displaying frame. It
1091 will be current in daemon mode when there are no frames
1092 to display, and in non-daemon mode before the real frame
1093 has finished initializing. If an error is thrown in the
1094 latter case while creating the frame, then the frame
1095 will never be displayed, so the safest thing to do is
1096 write to stderr and quit. In daemon mode, there are
1097 many other potential errors that do not prevent frames
1098 from being created, so continuing as normal is better in
1100 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1103 print_error_message (data
, Qexternal_debugging_output
,
1104 context
, Vsignaling_function
);
1105 Fterpri (Qexternal_debugging_output
);
1106 Fkill_emacs (make_number (-1));
1110 clear_message (1, 0);
1112 message_log_maybe_newline ();
1115 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1118 Vsignaling_function
= Qnil
;
1121 static Lisp_Object
command_loop_2 (Lisp_Object
);
1122 static Lisp_Object
top_level_1 (Lisp_Object
);
1124 /* Entry to editor-command-loop.
1125 This level has the catches for exiting/returning to editor command loop.
1126 It returns nil to exit recursive edit, t to abort it. */
1131 if (command_loop_level
> 0 || minibuf_level
> 0)
1134 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1135 executing_kbd_macro
= Qnil
;
1141 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1142 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1143 executing_kbd_macro
= Qnil
;
1145 /* End of file in -batch run causes exit here. */
1151 /* Here we catch errors in execution of commands within the
1152 editing loop, and reenter the editing loop.
1153 When there is an error, cmd_error runs and returns a non-nil
1154 value to us. A value of nil means that command_loop_1 itself
1155 returned due to end of file (or end of kbd macro). */
1158 command_loop_2 (Lisp_Object ignore
)
1160 register Lisp_Object val
;
1163 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1164 while (!NILP (val
));
1172 return Feval (Vtop_level
, Qnil
);
1176 top_level_1 (Lisp_Object ignore
)
1178 /* On entry to the outer level, run the startup file. */
1179 if (!NILP (Vtop_level
))
1180 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1181 else if (!NILP (Vpurify_flag
))
1182 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1184 message1 ("Bare Emacs (standard Lisp code not loaded)");
1188 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1189 doc
: /* Exit all recursive editing levels.
1190 This also exits all active minibuffers. */)
1193 #ifdef HAVE_WINDOW_SYSTEM
1194 if (display_hourglass_p
)
1195 cancel_hourglass ();
1198 /* Unblock input if we enter with input blocked. This may happen if
1199 redisplay traps e.g. during tool-bar update with input blocked. */
1200 totally_unblock_input ();
1202 Fthrow (Qtop_level
, Qnil
);
1205 static _Noreturn
void
1206 user_error (const char *msg
)
1208 xsignal1 (Quser_error
, build_string (msg
));
1212 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1213 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1216 if (command_loop_level
> 0 || minibuf_level
> 0)
1217 Fthrow (Qexit
, Qnil
);
1219 user_error ("No recursive edit is in progress");
1223 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1224 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1227 if (command_loop_level
> 0 || minibuf_level
> 0)
1230 user_error ("No recursive edit is in progress");
1233 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1234 of this function. */
1237 tracking_off (Lisp_Object old_value
)
1239 do_mouse_tracking
= old_value
;
1240 if (NILP (old_value
))
1242 /* Redisplay may have been preempted because there was input
1243 available, and it assumes it will be called again after the
1244 input has been processed. If the only input available was
1245 the sort that we have just disabled, then we need to call
1247 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1249 redisplay_preserve_echo_area (6);
1250 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1255 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1256 doc
: /* Evaluate BODY with mouse movement events enabled.
1257 Within a `track-mouse' form, mouse motion generates input events that
1258 you can read with `read-event'.
1259 Normally, mouse motion is ignored.
1260 usage: (track-mouse BODY...) */)
1263 ptrdiff_t count
= SPECPDL_INDEX ();
1266 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1268 do_mouse_tracking
= Qt
;
1270 val
= Fprogn (args
);
1271 return unbind_to (count
, val
);
1274 /* If mouse has moved on some frame, return one of those frames.
1278 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1279 after resizing the tool-bar window. */
1281 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1284 bool ignore_mouse_drag_p
;
1286 static struct frame
*
1287 some_mouse_moved (void)
1289 Lisp_Object tail
, frame
;
1291 if (ignore_mouse_drag_p
)
1293 /* ignore_mouse_drag_p = 0; */
1297 FOR_EACH_FRAME (tail
, frame
)
1299 if (XFRAME (frame
)->mouse_moved
)
1300 return XFRAME (frame
);
1307 /* This is the actual command reading loop,
1308 sans error-handling encapsulation. */
1310 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1312 void safe_run_hooks (Lisp_Object
);
1313 static void adjust_point_for_property (ptrdiff_t, bool);
1315 /* The last boundary auto-added to buffer-undo-list. */
1316 Lisp_Object last_undo_boundary
;
1318 /* FIXME: This is wrong rather than test window-system, we should call
1319 a new set-selection, which will then dispatch to x-set-selection, or
1320 tty-set-selection, or w32-set-selection, ... */
1323 command_loop_1 (void)
1326 Lisp_Object keybuf
[30];
1328 EMACS_INT prev_modiff
= 0;
1329 struct buffer
*prev_buffer
= NULL
;
1330 bool already_adjusted
= 0;
1332 kset_prefix_arg (current_kboard
, Qnil
);
1333 kset_last_prefix_arg (current_kboard
, Qnil
);
1334 Vdeactivate_mark
= Qnil
;
1335 waiting_for_input
= 0;
1338 this_command_key_count
= 0;
1339 this_command_key_count_reset
= 0;
1340 this_single_command_key_start
= 0;
1342 if (NILP (Vmemory_full
))
1344 /* Make sure this hook runs after commands that get errors and
1345 throw to top level. */
1346 /* Note that the value cell will never directly contain nil
1347 if the symbol is a local variable. */
1348 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1349 safe_run_hooks (Qpost_command_hook
);
1351 /* If displaying a message, resize the echo area window to fit
1352 that message's size exactly. */
1353 if (!NILP (echo_area_buffer
[0]))
1354 resize_echo_area_exactly ();
1356 /* If there are warnings waiting, process them. */
1357 if (!NILP (Vdelayed_warnings_list
))
1358 safe_run_hooks (Qdelayed_warnings_hook
);
1360 if (!NILP (Vdeferred_action_list
))
1361 safe_run_hooks (Qdeferred_action_function
);
1364 /* Do this after running Vpost_command_hook, for consistency. */
1365 kset_last_command (current_kboard
, Vthis_command
);
1366 kset_real_last_command (current_kboard
, Vreal_this_command
);
1367 if (!CONSP (last_command_event
))
1368 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1372 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1375 /* Make sure the current window's buffer is selected. */
1376 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1378 /* Display any malloc warning that just came out. Use while because
1379 displaying one warning can cause another. */
1381 while (pending_malloc_warning
)
1382 display_malloc_warning ();
1384 Vdeactivate_mark
= Qnil
;
1386 /* Don't ignore mouse movements for more than a single command
1387 loop. (This flag is set in xdisp.c whenever the tool bar is
1388 resized, because the resize moves text up or down, and would
1389 generate false mouse drag events if we don't ignore them.) */
1390 ignore_mouse_drag_p
= 0;
1392 /* If minibuffer on and echo area in use,
1393 wait a short time and redraw minibuffer. */
1396 && !NILP (echo_area_buffer
[0])
1397 && EQ (minibuf_window
, echo_area_window
)
1398 && NUMBERP (Vminibuffer_message_timeout
))
1400 /* Bind inhibit-quit to t so that C-g gets read in
1401 rather than quitting back to the minibuffer. */
1402 ptrdiff_t count
= SPECPDL_INDEX ();
1403 specbind (Qinhibit_quit
, Qt
);
1405 sit_for (Vminibuffer_message_timeout
, 0, 2);
1407 /* Clear the echo area. */
1409 safe_run_hooks (Qecho_area_clear_hook
);
1411 unbind_to (count
, Qnil
);
1413 /* If a C-g came in before, treat it as input now. */
1414 if (!NILP (Vquit_flag
))
1417 Vunread_command_events
= list1 (make_number (quit_char
));
1421 /* If it has changed current-menubar from previous value,
1422 really recompute the menubar from the value. */
1423 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1424 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1425 call0 (Qrecompute_lucid_menubar
);
1427 before_command_key_count
= this_command_key_count
;
1428 before_command_echo_length
= echo_length ();
1430 Vthis_command
= Qnil
;
1431 Vreal_this_command
= Qnil
;
1432 Vthis_original_command
= Qnil
;
1433 Vthis_command_keys_shift_translated
= Qnil
;
1435 /* Read next key sequence; i gets its length. */
1436 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1439 /* A filter may have run while we were reading the input. */
1440 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1442 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1446 /* Now we have read a key sequence of length I,
1447 or else I is 0 and we found end of file. */
1449 if (i
== 0) /* End of file -- happens only in */
1450 return Qnil
; /* a kbd macro, at the end. */
1451 /* -1 means read_key_sequence got a menu that was rejected.
1452 Just loop around and read another command. */
1456 this_command_key_count
= 0;
1457 this_command_key_count_reset
= 0;
1458 this_single_command_key_start
= 0;
1462 last_command_event
= keybuf
[i
- 1];
1464 /* If the previous command tried to force a specific window-start,
1465 forget about that, in case this command moves point far away
1466 from that position. But also throw away beg_unchanged and
1467 end_unchanged information in that case, so that redisplay will
1468 update the whole window properly. */
1469 if (XWINDOW (selected_window
)->force_start
)
1472 XWINDOW (selected_window
)->force_start
= 0;
1473 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1474 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1477 cmd
= read_key_sequence_cmd
;
1478 if (!NILP (Vexecuting_kbd_macro
))
1480 if (!NILP (Vquit_flag
))
1482 Vexecuting_kbd_macro
= Qt
;
1483 QUIT
; /* Make some noise. */
1484 /* Will return since macro now empty. */
1488 /* Do redisplay processing after this command except in special
1489 cases identified below. */
1490 prev_buffer
= current_buffer
;
1491 prev_modiff
= MODIFF
;
1492 last_point_position
= PT
;
1494 /* By default, we adjust point to a boundary of a region that
1495 has such a property that should be treated intangible
1496 (e.g. composition, display). But, some commands will set
1497 this variable differently. */
1498 Vdisable_point_adjustment
= Qnil
;
1500 /* Process filters and timers may have messed with deactivate-mark.
1501 reset it before we execute the command. */
1502 Vdeactivate_mark
= Qnil
;
1504 /* Remap command through active keymaps. */
1505 Vthis_original_command
= cmd
;
1506 if (!NILP (read_key_sequence_remapped
))
1507 cmd
= read_key_sequence_remapped
;
1509 /* Execute the command. */
1511 Vthis_command
= cmd
;
1512 Vreal_this_command
= cmd
;
1513 safe_run_hooks (Qpre_command_hook
);
1515 already_adjusted
= 0;
1517 if (NILP (Vthis_command
))
1519 /* nil means key is undefined. */
1520 Lisp_Object keys
= Fvector (i
, keybuf
);
1521 keys
= Fkey_description (keys
, Qnil
);
1523 message_with_string ("%s is undefined", keys
, 0);
1524 kset_defining_kbd_macro (current_kboard
, Qnil
);
1525 update_mode_lines
= 1;
1526 /* If this is a down-mouse event, don't reset prefix-arg;
1527 pass it to the command run by the up event. */
1528 if (EVENT_HAS_PARAMETERS (last_command_event
))
1530 Lisp_Object breakdown
1531 = parse_modifiers (EVENT_HEAD (last_command_event
));
1532 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1533 if (!(modifiers
& down_modifier
))
1534 kset_prefix_arg (current_kboard
, Qnil
);
1537 kset_prefix_arg (current_kboard
, Qnil
);
1541 /* Here for a command that isn't executed directly. */
1543 #ifdef HAVE_WINDOW_SYSTEM
1544 ptrdiff_t scount
= SPECPDL_INDEX ();
1546 if (display_hourglass_p
1547 && NILP (Vexecuting_kbd_macro
))
1549 record_unwind_protect_void (cancel_hourglass
);
1554 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1556 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1559 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1560 ? Qnil
: BVAR (current_buffer
, undo_list
));
1562 call1 (Qcommand_execute
, Vthis_command
);
1564 #ifdef HAVE_WINDOW_SYSTEM
1565 /* Do not check display_hourglass_p here, because
1566 `command-execute' could change it, but we should cancel
1567 hourglass cursor anyway.
1568 But don't cancel the hourglass within a macro
1569 just because a command in the macro finishes. */
1570 if (NILP (Vexecuting_kbd_macro
))
1571 unbind_to (scount
, Qnil
);
1574 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1576 safe_run_hooks (Qpost_command_hook
);
1578 /* If displaying a message, resize the echo area window to fit
1579 that message's size exactly. */
1580 if (!NILP (echo_area_buffer
[0]))
1581 resize_echo_area_exactly ();
1583 /* If there are warnings waiting, process them. */
1584 if (!NILP (Vdelayed_warnings_list
))
1585 safe_run_hooks (Qdelayed_warnings_hook
);
1587 safe_run_hooks (Qdeferred_action_function
);
1589 /* If there is a prefix argument,
1590 1) We don't want Vlast_command to be ``universal-argument''
1591 (that would be dumb), so don't set Vlast_command,
1592 2) we want to leave echoing on so that the prefix will be
1593 echoed as part of this key sequence, so don't call
1595 3) we want to leave this_command_key_count non-zero, so that
1596 read_char will realize that it is re-reading a character, and
1597 not echo it a second time.
1599 If the command didn't actually create a prefix arg,
1600 but is merely a frame event that is transparent to prefix args,
1601 then the above doesn't apply. */
1602 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1603 || CONSP (last_command_event
))
1605 kset_last_command (current_kboard
, Vthis_command
);
1606 kset_real_last_command (current_kboard
, Vreal_this_command
);
1607 if (!CONSP (last_command_event
))
1608 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1610 this_command_key_count
= 0;
1611 this_command_key_count_reset
= 0;
1612 this_single_command_key_start
= 0;
1615 if (!NILP (BVAR (current_buffer
, mark_active
))
1616 && !NILP (Vrun_hooks
))
1618 /* In Emacs 22, setting transient-mark-mode to `only' was a
1619 way of turning it on for just one command. This usage is
1620 obsolete, but support it anyway. */
1621 if (EQ (Vtransient_mark_mode
, Qidentity
))
1622 Vtransient_mark_mode
= Qnil
;
1623 else if (EQ (Vtransient_mark_mode
, Qonly
))
1624 Vtransient_mark_mode
= Qidentity
;
1626 if (!NILP (Vdeactivate_mark
))
1627 /* If `select-active-regions' is non-nil, this call to
1628 `deactivate-mark' also sets the PRIMARY selection. */
1629 call0 (Qdeactivate_mark
);
1632 /* Even if not deactivating the mark, set PRIMARY if
1633 `select-active-regions' is non-nil. */
1634 if (!NILP (Fwindow_system (Qnil
))
1635 /* Even if mark_active is non-nil, the actual buffer
1636 marker may not have been set yet (Bug#7044). */
1637 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1638 && (EQ (Vselect_active_regions
, Qonly
)
1639 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1640 : (!NILP (Vselect_active_regions
)
1641 && !NILP (Vtransient_mark_mode
)))
1642 && NILP (Fmemq (Vthis_command
,
1643 Vselection_inhibit_update_commands
)))
1646 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1649 call2 (Qx_set_selection
, QPRIMARY
,
1650 make_buffer_string (beg
, end
, 0));
1652 call2 (Qx_set_selection
, QPRIMARY
,
1653 make_buffer_string (end
, beg
, 0));
1654 /* Don't set empty selections. */
1657 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1659 Lisp_Object hook
= intern ("activate-mark-hook");
1660 Frun_hooks (1, &hook
);
1664 Vsaved_region_selection
= Qnil
;
1669 if (current_buffer
== prev_buffer
1670 && last_point_position
!= PT
1671 && NILP (Vdisable_point_adjustment
)
1672 && NILP (Vglobal_disable_point_adjustment
))
1674 if (last_point_position
> BEGV
1675 && last_point_position
< ZV
1676 && (composition_adjust_point (last_point_position
,
1677 last_point_position
)
1678 != last_point_position
))
1679 /* The last point was temporarily set within a grapheme
1680 cluster to prevent automatic composition. To recover
1681 the automatic composition, we must update the
1683 windows_or_buffers_changed
++;
1684 if (!already_adjusted
)
1685 adjust_point_for_property (last_point_position
,
1686 MODIFF
!= prev_modiff
);
1689 /* Install chars successfully executed in kbd macro. */
1691 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1692 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1693 finalize_kbd_macro_chars ();
1697 /* Adjust point to a boundary of a region that has such a property
1698 that should be treated intangible. For the moment, we check
1699 `composition', `display' and `invisible' properties.
1700 LAST_PT is the last position of point. */
1703 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1706 Lisp_Object val
, overlay
, tmp
;
1707 /* When called after buffer modification, we should temporarily
1708 suppress the point adjustment for automatic composition so that a
1709 user can keep inserting another character at point or keep
1710 deleting characters around point. */
1711 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1712 ptrdiff_t orig_pt
= PT
;
1714 /* FIXME: cycling is probably not necessary because these properties
1715 can't be usefully combined anyway. */
1716 while (check_composition
|| check_display
|| check_invisible
)
1718 /* FIXME: check `intangible'. */
1719 if (check_composition
1720 && PT
> BEGV
&& PT
< ZV
1721 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1724 check_display
= check_invisible
= 1;
1726 check_composition
= 0;
1728 && PT
> BEGV
&& PT
< ZV
1729 && !NILP (val
= get_char_property_and_overlay
1730 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1731 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1732 && (!OVERLAYP (overlay
)
1733 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1734 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1735 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1736 && (beg
< PT
/* && end > PT <- It's always the case. */
1737 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1740 SET_PT (PT
< last_pt
1741 ? (STRINGP (val
) && SCHARS (val
) == 0
1742 ? max (beg
- 1, BEGV
)
1745 check_composition
= check_invisible
= 1;
1748 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1754 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1757 /* FIXME: We should stop if we find a spot between
1758 two runs of `invisible' where inserted text would
1759 be visible. This is important when we have two
1760 invisible boundaries that enclose an area: if the
1761 area is empty, we need this test in order to make
1762 it possible to place point in the middle rather
1763 than skip both boundaries. However, this code
1764 also stops anywhere in a non-sticky text-property,
1765 which breaks (e.g.) Org mode. */
1766 && (val
= get_pos_property (make_number (end
),
1768 TEXT_PROP_MEANS_INVISIBLE (val
))
1770 && !NILP (val
= get_char_property_and_overlay
1771 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1772 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1774 ellipsis
= ellipsis
|| inv
> 1
1775 || (OVERLAYP (overlay
)
1776 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1777 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1778 tmp
= Fnext_single_char_property_change
1779 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1780 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1784 && (val
= get_pos_property (make_number (beg
),
1786 TEXT_PROP_MEANS_INVISIBLE (val
))
1788 && !NILP (val
= get_char_property_and_overlay
1789 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1790 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1792 ellipsis
= ellipsis
|| inv
> 1
1793 || (OVERLAYP (overlay
)
1794 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1795 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1796 tmp
= Fprevious_single_char_property_change
1797 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1798 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1801 /* Move away from the inside area. */
1802 if (beg
< PT
&& end
> PT
)
1804 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1805 /* We haven't moved yet (so we don't need to fear
1806 infinite-looping) and we were outside the range
1807 before (so either end of the range still corresponds
1808 to a move in the right direction): pretend we moved
1809 less than we actually did, so that we still have
1810 more freedom below in choosing which end of the range
1812 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1813 /* We either have moved already or the last point
1814 was already in the range: we don't get to choose
1815 which end of the range we have to go to. */
1816 : (PT
< last_pt
? beg
: end
));
1817 check_composition
= check_display
= 1;
1819 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1820 the point to something other than its argument, due to
1821 point-motion hooks, intangibility, etc. */
1822 eassert (PT
== beg
|| PT
== end
);
1825 /* Pretend the area doesn't exist if the buffer is not
1827 if (!modified
&& !ellipsis
&& beg
< end
)
1829 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1830 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1831 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1832 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1833 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1834 /* We've already moved as far as we can. Trying to go
1835 to the other end would mean moving backwards and thus
1836 could lead to an infinite loop. */
1838 else if (val
= get_pos_property (make_number (PT
),
1840 TEXT_PROP_MEANS_INVISIBLE (val
)
1841 && (val
= get_pos_property
1842 (make_number (PT
== beg
? end
: beg
),
1844 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1845 (check_composition
= check_display
= 1,
1846 SET_PT (PT
== beg
? end
: beg
));
1849 check_invisible
= 0;
1853 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1856 safe_run_hooks_1 (void)
1858 eassert (CONSP (Vinhibit_quit
));
1859 return call0 (XCDR (Vinhibit_quit
));
1862 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1866 safe_run_hooks_error (Lisp_Object error_data
)
1869 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1870 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1871 Lisp_Object args
[4];
1872 args
[0] = build_string ("Error in %s (%S): %S");
1875 args
[3] = error_data
;
1881 Lisp_Object newval
= Qnil
;
1882 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1883 if (EQ (fun
, XCAR (val
)))
1886 newval
= Fcons (XCAR (val
), newval
);
1888 return Fset (hook
, Fnreverse (newval
));
1889 /* Not found in the local part of the hook. Let's look at the global
1892 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1893 : Fdefault_value (hook
));
1894 CONSP (val
); val
= XCDR (val
))
1895 if (EQ (fun
, XCAR (val
)))
1898 newval
= Fcons (XCAR (val
), newval
);
1900 return Fset_default (hook
, Fnreverse (newval
));
1906 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1908 eassert (nargs
== 1);
1909 if (CONSP (Vinhibit_quit
))
1910 XSETCDR (Vinhibit_quit
, args
[0]);
1912 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1914 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1918 /* If we get an error while running the hook, cause the hook variable
1919 to be nil. Also inhibit quits, so that C-g won't cause the hook
1920 to mysteriously evaporate. */
1923 safe_run_hooks (Lisp_Object hook
)
1925 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1926 to its body or to its handlers other than via globals such as
1927 dynamically-bound variables ;-) */
1928 ptrdiff_t count
= SPECPDL_INDEX ();
1929 specbind (Qinhibit_quit
, hook
);
1931 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1933 unbind_to (count
, Qnil
);
1937 /* Nonzero means polling for input is temporarily suppressed. */
1939 int poll_suppress_count
;
1942 #ifdef POLL_FOR_INPUT
1944 /* Asynchronous timer for polling. */
1946 static struct atimer
*poll_timer
;
1948 /* Poll for input, so that we catch a C-g if it comes in. This
1949 function is called from x_make_frame_visible, see comment
1953 poll_for_input_1 (void)
1955 if (! input_blocked_p ()
1956 && !waiting_for_input
)
1960 /* Timer callback function for poll_timer. TIMER is equal to
1964 poll_for_input (struct atimer
*timer
)
1966 if (poll_suppress_count
== 0)
1967 pending_signals
= 1;
1970 #endif /* POLL_FOR_INPUT */
1972 /* Begin signals to poll for input, if they are appropriate.
1973 This function is called unconditionally from various places. */
1976 start_polling (void)
1978 #ifdef POLL_FOR_INPUT
1979 /* XXX This condition was (read_socket_hook && !interrupt_input),
1980 but read_socket_hook is not global anymore. Let's pretend that
1982 if (!interrupt_input
)
1984 /* Turn alarm handling on unconditionally. It might have
1985 been turned off in process.c. */
1986 turn_on_atimers (1);
1988 /* If poll timer doesn't exist, are we need one with
1989 a different interval, start a new one. */
1990 if (poll_timer
== NULL
1991 || poll_timer
->interval
.tv_sec
!= polling_period
)
1993 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1994 struct timespec interval
= make_timespec (period
, 0);
1997 cancel_atimer (poll_timer
);
1999 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2000 poll_for_input
, NULL
);
2003 /* Let the timer's callback function poll for input
2004 if this becomes zero. */
2005 --poll_suppress_count
;
2010 /* True if we are using polling to handle input asynchronously. */
2013 input_polling_used (void)
2015 #ifdef POLL_FOR_INPUT
2016 /* XXX This condition was (read_socket_hook && !interrupt_input),
2017 but read_socket_hook is not global anymore. Let's pretend that
2019 return !interrupt_input
;
2025 /* Turn off polling. */
2030 #ifdef POLL_FOR_INPUT
2031 /* XXX This condition was (read_socket_hook && !interrupt_input),
2032 but read_socket_hook is not global anymore. Let's pretend that
2034 if (!interrupt_input
)
2035 ++poll_suppress_count
;
2039 /* Set the value of poll_suppress_count to COUNT
2040 and start or stop polling accordingly. */
2043 set_poll_suppress_count (int count
)
2045 #ifdef POLL_FOR_INPUT
2046 if (count
== 0 && poll_suppress_count
!= 0)
2048 poll_suppress_count
= 1;
2051 else if (count
!= 0 && poll_suppress_count
== 0)
2055 poll_suppress_count
= count
;
2059 /* Bind polling_period to a value at least N.
2060 But don't decrease it. */
2063 bind_polling_period (int n
)
2065 #ifdef POLL_FOR_INPUT
2066 EMACS_INT
new = polling_period
;
2071 stop_other_atimers (poll_timer
);
2073 specbind (Qpolling_period
, make_number (new));
2074 /* Start a new alarm with the new period. */
2079 /* Apply the control modifier to CHARACTER. */
2082 make_ctrl_char (int c
)
2084 /* Save the upper bits here. */
2085 int upper
= c
& ~0177;
2087 if (! ASCII_BYTE_P (c
))
2088 return c
|= ctrl_modifier
;
2092 /* Everything in the columns containing the upper-case letters
2093 denotes a control character. */
2094 if (c
>= 0100 && c
< 0140)
2098 /* Set the shift modifier for a control char
2099 made from a shifted letter. But only for letters! */
2100 if (oc
>= 'A' && oc
<= 'Z')
2101 c
|= shift_modifier
;
2104 /* The lower-case letters denote control characters too. */
2105 else if (c
>= 'a' && c
<= 'z')
2108 /* Include the bits for control and shift
2109 only if the basic ASCII code can't indicate them. */
2113 /* Replace the high bits. */
2114 c
|= (upper
& ~ctrl_modifier
);
2119 /* Display the help-echo property of the character after the mouse pointer.
2120 Either show it in the echo area, or call show-help-function to display
2121 it by other means (maybe in a tooltip).
2123 If HELP is nil, that means clear the previous help echo.
2125 If HELP is a string, display that string. If HELP is a function,
2126 call it with OBJECT and POS as arguments; the function should
2127 return a help string or nil for none. For all other types of HELP,
2128 evaluate it to obtain a string.
2130 WINDOW is the window in which the help was generated, if any.
2131 It is nil if not in a window.
2133 If OBJECT is a buffer, POS is the position in the buffer where the
2134 `help-echo' text property was found.
2136 If OBJECT is an overlay, that overlay has a `help-echo' property,
2137 and POS is the position in the overlay's buffer under the mouse.
2139 If OBJECT is a string (an overlay string or a string displayed with
2140 the `display' property). POS is the position in that string under
2143 Note: this function may only be called with HELP nil or a string
2144 from X code running asynchronously. */
2147 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2150 if (!NILP (help
) && !STRINGP (help
))
2152 if (FUNCTIONP (help
))
2153 help
= safe_call (4, help
, window
, object
, pos
);
2155 help
= safe_eval (help
);
2157 if (!STRINGP (help
))
2161 if (!noninteractive
&& STRINGP (help
))
2163 /* The mouse-fixup-help-message Lisp function can call
2164 mouse_position_hook, which resets the mouse_moved flags.
2165 This causes trouble if we are trying to read a mouse motion
2166 event (i.e., if we are inside a `track-mouse' form), so we
2167 restore the mouse_moved flag. */
2168 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2169 help
= call1 (Qmouse_fixup_help_message
, help
);
2174 if (STRINGP (help
) || NILP (help
))
2176 if (!NILP (Vshow_help_function
))
2177 call1 (Vshow_help_function
, help
);
2178 help_echo_showing_p
= STRINGP (help
);
2184 /* Input of single characters from keyboard */
2186 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2187 struct timespec
*end_time
);
2188 static void record_char (Lisp_Object c
);
2190 static Lisp_Object help_form_saved_window_configs
;
2192 read_char_help_form_unwind (void)
2194 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2195 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2196 if (!NILP (window_config
))
2197 Fset_window_configuration (window_config
);
2200 #define STOP_POLLING \
2201 do { if (! polling_stopped_here) stop_polling (); \
2202 polling_stopped_here = 1; } while (0)
2204 #define RESUME_POLLING \
2205 do { if (polling_stopped_here) start_polling (); \
2206 polling_stopped_here = 0; } while (0)
2209 read_event_from_main_queue (struct timespec
*end_time
,
2210 sys_jmp_buf local_getcjmp
,
2211 bool *used_mouse_menu
)
2213 Lisp_Object c
= Qnil
;
2214 sys_jmp_buf save_jump
;
2215 KBOARD
*kb
IF_LINT (= NULL
);
2219 /* Read from the main queue, and if that gives us something we can't use yet,
2220 we put it on the appropriate side queue and try again. */
2222 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2225 /* Actually read a character, waiting if necessary. */
2226 save_getcjmp (save_jump
);
2227 restore_getcjmp (local_getcjmp
);
2229 timer_start_idle ();
2230 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2231 restore_getcjmp (save_jump
);
2233 if (! NILP (c
) && (kb
!= current_kboard
))
2235 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2238 while (CONSP (XCDR (last
)))
2240 if (!NILP (XCDR (last
)))
2244 kset_kbd_queue (kb
, list1 (c
));
2246 XSETCDR (last
, list1 (c
));
2247 kb
->kbd_queue_has_data
= 1;
2251 current_kboard
= kb
;
2252 /* This is going to exit from read_char
2253 so we had better get rid of this frame's stuff. */
2254 return make_number (-2);
2257 /* Terminate Emacs in batch mode if at eof. */
2258 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2259 Fkill_emacs (make_number (1));
2263 /* Add in any extra modifiers, where appropriate. */
2264 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2265 || ((extra_keyboard_modifiers
& 0177) < ' '
2266 && (extra_keyboard_modifiers
& 0177) != 0))
2267 XSETINT (c
, make_ctrl_char (XINT (c
)));
2269 /* Transfer any other modifier bits directly from
2270 extra_keyboard_modifiers to c. Ignore the actual character code
2271 in the low 16 bits of extra_keyboard_modifiers. */
2272 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2280 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2283 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2284 sys_jmp_buf local_getcjmp
,
2285 Lisp_Object prev_event
,
2286 bool *used_mouse_menu
)
2288 #define MAX_ENCODED_BYTES 16
2289 Lisp_Object events
[MAX_ENCODED_BYTES
];
2294 = read_event_from_main_queue (end_time
, local_getcjmp
,
2297 /* w32_console already returns decoded events. It either reads
2298 Unicode characters from the Windows keyboard input, or
2299 converts characters encoded in the current codepage into
2300 Unicode. See w32inevt.c:key_event, near its end. */
2303 struct frame
*frame
= XFRAME (selected_frame
);
2304 struct terminal
*terminal
= frame
->terminal
;
2305 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2306 /* Don't apply decoding if we're just reading a raw event
2307 (e.g. reading bytes sent by the xterm to specify the position
2308 of a mouse click). */
2309 && (!EQ (prev_event
, Qt
))
2310 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2311 & CODING_REQUIRE_DECODING_MASK
)))
2312 return nextevt
; /* No decoding needed. */
2315 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2316 eassert (n
< MAX_ENCODED_BYTES
);
2317 events
[n
++] = nextevt
;
2318 if (NATNUMP (nextevt
)
2319 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2320 { /* An encoded byte sequence, let's try to decode it. */
2321 struct coding_system
*coding
2322 = TERMINAL_KEYBOARD_CODING (terminal
);
2323 unsigned char *src
= alloca (n
);
2325 for (i
= 0; i
< n
; i
++)
2326 src
[i
] = XINT (events
[i
]);
2328 for (i
= 0; i
< n
; i
++)
2330 coding
->destination
= alloca (n
* 4);
2331 coding
->dst_bytes
= n
* 4;
2332 decode_coding_c_string (coding
, src
, n
, Qnil
);
2333 eassert (coding
->produced_char
<= n
);
2334 if (coding
->produced_char
== 0)
2335 { /* The encoded sequence is incomplete. */
2336 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2337 continue; /* Read on! */
2341 const unsigned char *p
= coding
->destination
;
2342 eassert (coding
->carryover_bytes
== 0);
2344 while (n
< coding
->produced_char
)
2345 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2348 /* Now `events' should hold decoded events.
2349 Normally, n should be equal to 1, but better not rely on it.
2350 We can only return one event here, so return the first we
2351 had and keep the others (if any) for later. */
2353 Vunread_command_events
2354 = Fcons (events
[--n
], Vunread_command_events
);
2361 /* Read a character from the keyboard; call the redisplay if needed. */
2362 /* commandflag 0 means do not autosave, but do redisplay.
2363 -1 means do not redisplay, but do autosave.
2364 -2 means do neither.
2367 /* The arguments MAP is for menu prompting. MAP is a keymap.
2369 PREV_EVENT is the previous input event, or nil if we are reading
2370 the first event of a key sequence (or not reading a key sequence).
2371 If PREV_EVENT is t, that is a "magic" value that says
2372 not to run input methods, but in other respects to act as if
2373 not reading a key sequence.
2375 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2376 if we used a mouse menu to read the input, or false otherwise. If
2377 USED_MOUSE_MENU is null, don't dereference it.
2379 Value is -2 when we find input on another keyboard. A second call
2380 to read_char will read it.
2382 If END_TIME is non-null, it is a pointer to a struct timespec
2383 specifying the maximum time to wait until. If no input arrives by
2384 that time, stop waiting and return nil.
2386 Value is t if we showed a menu and the user rejected it. */
2389 read_char (int commandflag
, Lisp_Object map
,
2390 Lisp_Object prev_event
,
2391 bool *used_mouse_menu
, struct timespec
*end_time
)
2395 sys_jmp_buf local_getcjmp
;
2396 sys_jmp_buf save_jump
;
2397 Lisp_Object tem
, save
;
2398 volatile Lisp_Object previous_echo_area_message
;
2399 volatile Lisp_Object also_record
;
2400 volatile bool reread
;
2401 struct gcpro gcpro1
, gcpro2
;
2402 bool volatile polling_stopped_here
= 0;
2403 struct kboard
*orig_kboard
= current_kboard
;
2407 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2408 before_command_key_count
= this_command_key_count
;
2409 before_command_echo_length
= echo_length ();
2412 previous_echo_area_message
= Qnil
;
2414 GCPRO2 (c
, previous_echo_area_message
);
2419 if (CONSP (Vunread_post_input_method_events
))
2421 c
= XCAR (Vunread_post_input_method_events
);
2422 Vunread_post_input_method_events
2423 = XCDR (Vunread_post_input_method_events
);
2425 /* Undo what read_char_x_menu_prompt did when it unread
2426 additional keys returned by Fx_popup_menu. */
2428 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2436 if (CONSP (Vunread_command_events
))
2438 bool was_disabled
= 0;
2440 c
= XCAR (Vunread_command_events
);
2441 Vunread_command_events
= XCDR (Vunread_command_events
);
2445 /* Undo what sit-for did when it unread additional keys
2446 inside universal-argument. */
2449 && EQ (XCAR (c
), Qt
))
2455 /* Undo what read_char_x_menu_prompt did when it unread
2456 additional keys returned by Fx_popup_menu. */
2458 && EQ (XCDR (c
), Qdisabled
)
2459 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2465 /* If the queued event is something that used the mouse,
2466 set used_mouse_menu accordingly. */
2468 /* Also check was_disabled so last-nonmenu-event won't return
2469 a bad value when submenus are involved. (Bug#447) */
2470 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2471 *used_mouse_menu
= 1;
2473 goto reread_for_input_method
;
2476 if (CONSP (Vunread_input_method_events
))
2478 c
= XCAR (Vunread_input_method_events
);
2479 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2481 /* Undo what read_char_x_menu_prompt did when it unread
2482 additional keys returned by Fx_popup_menu. */
2484 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2488 goto reread_for_input_method
;
2491 this_command_key_count_reset
= 0;
2493 if (!NILP (Vexecuting_kbd_macro
))
2495 /* We set this to Qmacro; since that's not a frame, nobody will
2496 try to switch frames on us, and the selected window will
2499 Since this event came from a macro, it would be misleading to
2500 leave internal_last_event_frame set to wherever the last
2501 real event came from. Normally, a switch-frame event selects
2502 internal_last_event_frame after each command is read, but
2503 events read from a macro should never cause a new frame to be
2505 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2507 /* Exit the macro if we are at the end.
2508 Also, some things replace the macro with t
2509 to force an early exit. */
2510 if (EQ (Vexecuting_kbd_macro
, Qt
)
2511 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2517 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2518 if (STRINGP (Vexecuting_kbd_macro
)
2519 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2520 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2522 executing_kbd_macro_index
++;
2527 if (!NILP (unread_switch_frame
))
2529 c
= unread_switch_frame
;
2530 unread_switch_frame
= Qnil
;
2532 /* This event should make it into this_command_keys, and get echoed
2533 again, so we do not set `reread'. */
2537 /* If redisplay was requested. */
2538 if (commandflag
>= 0)
2540 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2542 /* If there is pending input, process any events which are not
2543 user-visible, such as X selection_request events. */
2545 || detect_input_pending_run_timers (0))
2546 swallow_events (0); /* May clear input_pending. */
2548 /* Redisplay if no pending input. */
2549 while (!input_pending
)
2551 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2552 redisplay_preserve_echo_area (5);
2557 /* Normal case: no input arrived during redisplay. */
2560 /* Input arrived and pre-empted redisplay.
2561 Process any events which are not user-visible. */
2563 /* If that cleared input_pending, try again to redisplay. */
2566 /* Prevent the redisplay we just did
2567 from messing up echoing of the input after the prompt. */
2568 if (commandflag
== 0 && echo_current
)
2569 echo_message_buffer
= echo_area_buffer
[0];
2573 /* Message turns off echoing unless more keystrokes turn it on again.
2575 The code in 20.x for the condition was
2577 1. echo_area_glyphs && *echo_area_glyphs
2578 2. && echo_area_glyphs != current_kboard->echobuf
2579 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2581 (1) means there's a current message displayed
2583 (2) means it's not the message from echoing from the current
2586 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2587 is set to a non-null value. This is done in read_char and it is
2588 set to echo_area_glyphs after a call to echo_char. That means
2589 ok_to_echo_at_next_pause is either null or
2590 current_kboard->echobuf with the appropriate current_kboard at
2593 So, condition (3) means in clear text ok_to_echo_at_next_pause
2594 must be either null, or the current message isn't from echoing at
2595 all, or it's from echoing from a different kboard than the
2598 if (/* There currently is something in the echo area. */
2599 !NILP (echo_area_buffer
[0])
2600 && (/* And it's either not from echoing. */
2601 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2602 /* Or it's an echo from a different kboard. */
2603 || echo_kboard
!= current_kboard
2604 /* Or we explicitly allow overwriting whatever there is. */
2605 || ok_to_echo_at_next_pause
== NULL
))
2610 /* Try reading a character via menu prompting in the minibuf.
2611 Try this before the sit-for, because the sit-for
2612 would do the wrong thing if we are supposed to do
2613 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2614 after a mouse event so don't try a minibuf menu. */
2616 if (KEYMAPP (map
) && INTERACTIVE
2617 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2618 /* Don't bring up a menu if we already have another event. */
2619 && NILP (Vunread_command_events
)
2620 && !detect_input_pending_run_timers (0))
2622 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2624 if (INTEGERP (c
) && XINT (c
) == -2)
2625 return c
; /* wrong_kboard_jmpbuf */
2631 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2632 We will do that below, temporarily for short sections of code,
2633 when appropriate. local_getcjmp must be in effect
2634 around any call to sit_for or kbd_buffer_get_event;
2635 it *must not* be in effect when we call redisplay. */
2637 jmpcount
= SPECPDL_INDEX ();
2638 if (sys_setjmp (local_getcjmp
))
2640 /* Handle quits while reading the keyboard. */
2641 /* We must have saved the outer value of getcjmp here,
2642 so restore it now. */
2643 restore_getcjmp (save_jump
);
2644 unbind_to (jmpcount
, Qnil
);
2645 XSETINT (c
, quit_char
);
2646 internal_last_event_frame
= selected_frame
;
2647 Vlast_event_frame
= internal_last_event_frame
;
2648 /* If we report the quit char as an event,
2649 don't do so more than once. */
2650 if (!NILP (Vinhibit_quit
))
2654 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2655 if (kb
!= current_kboard
)
2657 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2658 /* We shouldn't get here if we were in single-kboard mode! */
2663 while (CONSP (XCDR (last
)))
2665 if (!NILP (XCDR (last
)))
2669 kset_kbd_queue (kb
, list1 (c
));
2671 XSETCDR (last
, list1 (c
));
2672 kb
->kbd_queue_has_data
= 1;
2673 current_kboard
= kb
;
2674 /* This is going to exit from read_char
2675 so we had better get rid of this frame's stuff. */
2677 return make_number (-2); /* wrong_kboard_jmpbuf */
2683 /* Start idle timers if no time limit is supplied. We don't do it
2684 if a time limit is supplied to avoid an infinite recursion in the
2685 situation where an idle timer calls `sit-for'. */
2688 timer_start_idle ();
2690 /* If in middle of key sequence and minibuffer not active,
2691 start echoing if enough time elapses. */
2693 if (minibuf_level
== 0
2695 && !current_kboard
->immediate_echo
2696 && this_command_key_count
> 0
2698 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2699 && NILP (Fzerop (Vecho_keystrokes
))
2700 && (/* No message. */
2701 NILP (echo_area_buffer
[0])
2702 /* Or empty message. */
2703 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2704 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2705 /* Or already echoing from same kboard. */
2706 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2707 /* Or not echoing before and echoing allowed. */
2708 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2710 /* After a mouse event, start echoing right away.
2711 This is because we are probably about to display a menu,
2712 and we don't want to delay before doing so. */
2713 if (EVENT_HAS_PARAMETERS (prev_event
))
2719 save_getcjmp (save_jump
);
2720 restore_getcjmp (local_getcjmp
);
2721 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2722 restore_getcjmp (save_jump
);
2724 && ! CONSP (Vunread_command_events
))
2729 /* Maybe auto save due to number of keystrokes. */
2731 if (commandflag
!= 0 && commandflag
!= -2
2732 && auto_save_interval
> 0
2733 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2734 && !detect_input_pending_run_timers (0))
2736 Fdo_auto_save (Qnil
, Qnil
);
2737 /* Hooks can actually change some buffers in auto save. */
2741 /* Try reading using an X menu.
2742 This is never confused with reading using the minibuf
2743 because the recursive call of read_char in read_char_minibuf_menu_prompt
2744 does not pass on any keymaps. */
2746 if (KEYMAPP (map
) && INTERACTIVE
2747 && !NILP (prev_event
)
2748 && EVENT_HAS_PARAMETERS (prev_event
)
2749 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2750 && !EQ (XCAR (prev_event
), Qtool_bar
)
2751 /* Don't bring up a menu if we already have another event. */
2752 && NILP (Vunread_command_events
))
2754 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2756 /* Now that we have read an event, Emacs is not idle. */
2763 /* Maybe autosave and/or garbage collect due to idleness. */
2765 if (INTERACTIVE
&& NILP (c
))
2768 ptrdiff_t buffer_size
;
2770 /* Slow down auto saves logarithmically in size of current buffer,
2771 and garbage collect while we're at it. */
2772 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2773 last_non_minibuf_size
= Z
- BEG
;
2774 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2776 while (buffer_size
> 64)
2777 delay_level
++, buffer_size
-= buffer_size
>> 2;
2778 if (delay_level
< 4) delay_level
= 4;
2779 /* delay_level is 4 for files under around 50k, 7 at 100k,
2780 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2782 /* Auto save if enough time goes by without input. */
2783 if (commandflag
!= 0 && commandflag
!= -2
2784 && num_nonmacro_input_events
> last_auto_save
2785 && INTEGERP (Vauto_save_timeout
)
2786 && XINT (Vauto_save_timeout
) > 0)
2789 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2791 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2792 timeout
= delay_level
* timeout
/ 4;
2793 save_getcjmp (save_jump
);
2794 restore_getcjmp (local_getcjmp
);
2795 tem0
= sit_for (make_number (timeout
), 1, 1);
2796 restore_getcjmp (save_jump
);
2799 && ! CONSP (Vunread_command_events
))
2801 Fdo_auto_save (Qnil
, Qnil
);
2806 /* If there is still no input available, ask for GC. */
2807 if (!detect_input_pending_run_timers (0))
2811 /* Notify the caller if an autosave hook, or a timer, sentinel or
2812 filter in the sit_for calls above have changed the current
2813 kboard. This could happen if they use the minibuffer or start a
2814 recursive edit, like the fancy splash screen in server.el's
2815 filter. If this longjmp wasn't here, read_key_sequence would
2816 interpret the next key sequence using the wrong translation
2817 tables and function keymaps. */
2818 if (NILP (c
) && current_kboard
!= orig_kboard
)
2821 return make_number (-2); /* wrong_kboard_jmpbuf */
2824 /* If this has become non-nil here, it has been set by a timer
2825 or sentinel or filter. */
2826 if (CONSP (Vunread_command_events
))
2828 c
= XCAR (Vunread_command_events
);
2829 Vunread_command_events
= XCDR (Vunread_command_events
);
2832 /* Read something from current KBOARD's side queue, if possible. */
2836 if (current_kboard
->kbd_queue_has_data
)
2838 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2840 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2841 kset_kbd_queue (current_kboard
,
2842 XCDR (KVAR (current_kboard
, kbd_queue
)));
2843 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2844 current_kboard
->kbd_queue_has_data
= 0;
2845 input_pending
= readable_events (0);
2846 if (EVENT_HAS_PARAMETERS (c
)
2847 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2848 internal_last_event_frame
= XCAR (XCDR (c
));
2849 Vlast_event_frame
= internal_last_event_frame
;
2853 /* If current_kboard's side queue is empty check the other kboards.
2854 If one of them has data that we have not yet seen here,
2855 switch to it and process the data waiting for it.
2857 Note: if the events queued up for another kboard
2858 have already been seen here, and therefore are not a complete command,
2859 the kbd_queue_has_data field is 0, so we skip that kboard here.
2860 That's to avoid an infinite loop switching between kboards here. */
2861 if (NILP (c
) && !single_kboard
)
2864 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2865 if (kb
->kbd_queue_has_data
)
2867 current_kboard
= kb
;
2868 /* This is going to exit from read_char
2869 so we had better get rid of this frame's stuff. */
2871 return make_number (-2); /* wrong_kboard_jmpbuf */
2881 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2882 prev_event
, used_mouse_menu
);
2883 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2885 if (EQ (c
, make_number (-2)))
2887 /* This is going to exit from read_char
2888 so we had better get rid of this frame's stuff. */
2902 if (commandflag
>= 0
2903 && !input_pending
&& !detect_input_pending_run_timers (0))
2909 /* Buffer switch events are only for internal wakeups
2910 so don't show them to the user.
2911 Also, don't record a key if we already did. */
2915 /* Process special events within read_char
2916 and loop around to read another event. */
2919 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2924 struct buffer
*prev_buffer
= current_buffer
;
2925 last_input_event
= c
;
2926 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2928 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2929 /* We stopped being idle for this event; undo that. This
2930 prevents automatic window selection (under
2931 mouse_autoselect_window from acting as a real input event, for
2932 example banishing the mouse under mouse-avoidance-mode. */
2933 timer_resume_idle ();
2935 if (current_buffer
!= prev_buffer
)
2937 /* The command may have changed the keymaps. Pretend there
2938 is input in another keyboard and return. This will
2939 recalculate keymaps. */
2940 c
= make_number (-2);
2947 /* Handle things that only apply to characters. */
2950 /* If kbd_buffer_get_event gave us an EOF, return that. */
2954 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2955 && UNSIGNED_CMP (XFASTINT (c
), <,
2956 SCHARS (KVAR (current_kboard
,
2957 Vkeyboard_translate_table
))))
2958 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2959 && UNSIGNED_CMP (XFASTINT (c
), <,
2960 ASIZE (KVAR (current_kboard
,
2961 Vkeyboard_translate_table
))))
2962 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2966 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2967 /* nil in keyboard-translate-table means no translation. */
2973 /* If this event is a mouse click in the menu bar,
2974 return just menu-bar for now. Modify the mouse click event
2975 so we won't do this twice, then queue it up. */
2976 if (EVENT_HAS_PARAMETERS (c
)
2978 && CONSP (EVENT_START (c
))
2979 && CONSP (XCDR (EVENT_START (c
))))
2983 posn
= POSN_POSN (EVENT_START (c
));
2984 /* Handle menu-bar events:
2985 insert the dummy prefix event `menu-bar'. */
2986 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2988 /* Change menu-bar to (menu-bar) as the event "position". */
2989 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2992 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2997 /* Store these characters into recent_keys, the dribble file if any,
2998 and the keyboard macro being defined, if any. */
3000 if (! NILP (also_record
))
3001 record_char (also_record
);
3003 /* Wipe the echo area.
3004 But first, if we are about to use an input method,
3005 save the echo area contents for it to refer to. */
3007 && ! NILP (Vinput_method_function
)
3008 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3010 previous_echo_area_message
= Fcurrent_message ();
3011 Vinput_method_previous_message
= previous_echo_area_message
;
3014 /* Now wipe the echo area, except for help events which do their
3015 own stuff with the echo area. */
3017 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3018 && !(EQ (Qswitch_frame
, XCAR (c
)))
3019 /* Don't wipe echo area for select window events: These might
3020 get delayed via `mouse-autoselect-window' (Bug#11304). */
3021 && !(EQ (Qselect_window
, XCAR (c
)))))
3023 if (!NILP (echo_area_buffer
[0]))
3025 safe_run_hooks (Qecho_area_clear_hook
);
3026 clear_message (1, 0);
3030 reread_for_input_method
:
3032 /* Pass this to the input method, if appropriate. */
3034 && ! NILP (Vinput_method_function
)
3035 /* Don't run the input method within a key sequence,
3036 after the first event of the key sequence. */
3037 && NILP (prev_event
)
3038 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3041 ptrdiff_t key_count
;
3042 bool key_count_reset
;
3043 struct gcpro gcpro1
;
3044 ptrdiff_t count
= SPECPDL_INDEX ();
3046 /* Save the echo status. */
3047 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3048 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3049 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3050 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3053 if (before_command_restore_flag
)
3055 this_command_key_count
= before_command_key_count_1
;
3056 if (this_command_key_count
< this_single_command_key_start
)
3057 this_single_command_key_start
= this_command_key_count
;
3058 echo_truncate (before_command_echo_length_1
);
3059 before_command_restore_flag
= 0;
3063 /* Save the this_command_keys status. */
3064 key_count
= this_command_key_count
;
3065 key_count_reset
= this_command_key_count_reset
;
3068 keys
= Fcopy_sequence (this_command_keys
);
3073 /* Clear out this_command_keys. */
3074 this_command_key_count
= 0;
3075 this_command_key_count_reset
= 0;
3077 /* Now wipe the echo area. */
3078 if (!NILP (echo_area_buffer
[0]))
3079 safe_run_hooks (Qecho_area_clear_hook
);
3080 clear_message (1, 0);
3083 /* If we are not reading a key sequence,
3084 never use the echo area. */
3087 specbind (Qinput_method_use_echo_area
, Qt
);
3090 /* Call the input method. */
3091 tem
= call1 (Vinput_method_function
, c
);
3093 tem
= unbind_to (count
, tem
);
3095 /* Restore the saved echoing state
3096 and this_command_keys state. */
3097 this_command_key_count
= key_count
;
3098 this_command_key_count_reset
= key_count_reset
;
3100 this_command_keys
= keys
;
3103 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3104 kset_echo_string (current_kboard
, saved_echo_string
);
3105 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3106 if (saved_immediate_echo
)
3111 /* The input method can return no events. */
3114 /* Bring back the previous message, if any. */
3115 if (! NILP (previous_echo_area_message
))
3116 message_with_string ("%s", previous_echo_area_message
, 0);
3119 /* It returned one event or more. */
3121 Vunread_post_input_method_events
3122 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3127 /* Display help if not echoing. */
3128 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3130 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3131 Lisp_Object help
, object
, position
, window
, htem
;
3133 htem
= Fcdr (XCDR (c
));
3136 window
= Fcar (htem
);
3138 object
= Fcar (htem
);
3140 position
= Fcar (htem
);
3142 show_help_echo (help
, window
, object
, position
);
3144 /* We stopped being idle for this event; undo that. */
3146 timer_resume_idle ();
3150 if ((! reread
|| this_command_key_count
== 0
3151 || this_command_key_count_reset
)
3155 /* Don't echo mouse motion events. */
3156 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3157 && NILP (Fzerop (Vecho_keystrokes
))
3158 && ! (EVENT_HAS_PARAMETERS (c
)
3159 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3162 if (! NILP (also_record
))
3163 echo_char (also_record
);
3164 /* Once we reread a character, echoing can happen
3165 the next time we pause to read a new one. */
3166 ok_to_echo_at_next_pause
= current_kboard
;
3169 /* Record this character as part of the current key. */
3170 add_command_key (c
);
3171 if (! NILP (also_record
))
3172 add_command_key (also_record
);
3175 last_input_event
= c
;
3178 /* Process the help character specially if enabled. */
3179 if (!NILP (Vhelp_form
) && help_char_p (c
))
3181 ptrdiff_t count
= SPECPDL_INDEX ();
3183 help_form_saved_window_configs
3184 = Fcons (Fcurrent_window_configuration (Qnil
),
3185 help_form_saved_window_configs
);
3186 record_unwind_protect_void (read_char_help_form_unwind
);
3187 call0 (Qhelp_form_show
);
3192 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3193 if (EVENT_HAS_PARAMETERS (c
)
3194 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3195 XSETCAR (help_form_saved_window_configs
, Qnil
);
3197 while (BUFFERP (c
));
3198 /* Remove the help from the frame. */
3199 unbind_to (count
, Qnil
);
3202 if (EQ (c
, make_number (040)))
3206 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3207 while (BUFFERP (c
));
3218 /* Record a key that came from a mouse menu.
3219 Record it for echoing, for this-command-keys, and so on. */
3222 record_menu_key (Lisp_Object c
)
3224 /* Wipe the echo area. */
3225 clear_message (1, 0);
3230 before_command_key_count
= this_command_key_count
;
3231 before_command_echo_length
= echo_length ();
3234 /* Don't echo mouse motion events. */
3235 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3236 && NILP (Fzerop (Vecho_keystrokes
)))
3240 /* Once we reread a character, echoing can happen
3241 the next time we pause to read a new one. */
3242 ok_to_echo_at_next_pause
= 0;
3245 /* Record this character as part of the current key. */
3246 add_command_key (c
);
3248 /* Re-reading in the middle of a command */
3249 last_input_event
= c
;
3253 #endif /* HAVE_MENUS */
3255 /* Return true if should recognize C as "the help character". */
3258 help_char_p (Lisp_Object c
)
3262 if (EQ (c
, Vhelp_char
))
3264 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3265 if (EQ (c
, XCAR (tail
)))
3270 /* Record the input event C in various ways. */
3273 record_char (Lisp_Object c
)
3277 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3279 /* To avoid filling recent_keys with help-echo and mouse-movement
3280 events, we filter out repeated help-echo events, only store the
3281 first and last in a series of mouse-movement events, and don't
3282 store repeated help-echo events which are only separated by
3283 mouse-movement events. */
3285 Lisp_Object ev1
, ev2
, ev3
;
3288 if ((ix1
= recent_keys_index
- 1) < 0)
3289 ix1
= NUM_RECENT_KEYS
- 1;
3290 ev1
= AREF (recent_keys
, ix1
);
3292 if ((ix2
= ix1
- 1) < 0)
3293 ix2
= NUM_RECENT_KEYS
- 1;
3294 ev2
= AREF (recent_keys
, ix2
);
3296 if ((ix3
= ix2
- 1) < 0)
3297 ix3
= NUM_RECENT_KEYS
- 1;
3298 ev3
= AREF (recent_keys
, ix3
);
3300 if (EQ (XCAR (c
), Qhelp_echo
))
3302 /* Don't record `help-echo' in recent_keys unless it shows some help
3303 message, and a different help than the previously recorded
3305 Lisp_Object help
, last_help
;
3307 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3308 if (!STRINGP (help
))
3310 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3311 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3313 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3314 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3315 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3317 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3318 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3319 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3320 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3323 else if (EQ (XCAR (c
), Qmouse_movement
))
3325 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3326 So additional mouse movement events replace the last element. */
3327 Lisp_Object last_window
, window
;
3329 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3330 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3331 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3332 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3333 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3335 ASET (recent_keys
, ix1
, c
);
3341 store_kbd_macro_char (c
);
3345 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3346 ASET (recent_keys
, recent_keys_index
, c
);
3347 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3348 recent_keys_index
= 0;
3350 else if (recorded
< 0)
3352 /* We need to remove one or two events from recent_keys.
3353 To do this, we simply put nil at those events and move the
3354 recent_keys_index backwards over those events. Usually,
3355 users will never see those nil events, as they will be
3356 overwritten by the command keys entered to see recent_keys
3359 while (recorded
++ < 0 && total_keys
> 0)
3361 if (total_keys
< NUM_RECENT_KEYS
)
3363 if (--recent_keys_index
< 0)
3364 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3365 ASET (recent_keys
, recent_keys_index
, Qnil
);
3369 num_nonmacro_input_events
++;
3371 /* Write c to the dribble file. If c is a lispy event, write
3372 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3373 If you, dear reader, have a better idea, you've got the source. :-) */
3379 if (XUINT (c
) < 0x100)
3380 putc (XUINT (c
), dribble
);
3382 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3386 Lisp_Object dribblee
;
3388 /* If it's a structured event, take the event header. */
3389 dribblee
= EVENT_HEAD (c
);
3391 if (SYMBOLP (dribblee
))
3393 putc ('<', dribble
);
3394 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3395 SBYTES (SYMBOL_NAME (dribblee
)),
3397 putc ('>', dribble
);
3406 /* Copy out or in the info on where C-g should throw to.
3407 This is used when running Lisp code from within get_char,
3408 in case get_char is called recursively.
3409 See read_process_output. */
3412 save_getcjmp (sys_jmp_buf temp
)
3414 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3418 restore_getcjmp (sys_jmp_buf temp
)
3420 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3423 /* Low level keyboard/mouse input.
3424 kbd_buffer_store_event places events in kbd_buffer, and
3425 kbd_buffer_get_event retrieves them. */
3427 /* Return true if there are any events in the queue that read-char
3428 would return. If this returns false, a read-char would block. */
3430 readable_events (int flags
)
3432 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3435 /* If the buffer contains only FOCUS_IN_EVENT events, and
3436 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3437 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3439 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3440 #ifdef USE_TOOLKIT_SCROLL_BARS
3441 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3445 struct input_event
*event
;
3447 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3454 #ifdef USE_TOOLKIT_SCROLL_BARS
3455 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3457 event
->kind
== FOCUS_IN_EVENT
)
3458 #ifdef USE_TOOLKIT_SCROLL_BARS
3459 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3460 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3461 && event
->part
== scroll_bar_handle
3462 && event
->modifiers
== 0)
3467 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3470 while (event
!= kbd_store_ptr
);
3476 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3477 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3481 if (current_kboard
->kbd_queue_has_data
)
3487 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3488 if (kb
->kbd_queue_has_data
)
3494 /* Set this for debugging, to have a way to get out */
3495 int stop_character EXTERNALLY_VISIBLE
;
3498 event_to_kboard (struct input_event
*event
)
3500 /* Not applicable for these special events. */
3501 if (event
->kind
== SELECTION_REQUEST_EVENT
3502 || event
->kind
== SELECTION_CLEAR_EVENT
)
3506 Lisp_Object obj
= event
->frame_or_window
;
3507 /* There are some events that set this field to nil or string. */
3509 obj
= WINDOW_FRAME (XWINDOW (obj
));
3510 /* Also ignore dead frames here. */
3511 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3512 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3517 /* Return the number of slots occupied in kbd_buffer. */
3520 kbd_buffer_nr_stored (void)
3522 return kbd_fetch_ptr
== kbd_store_ptr
3524 : (kbd_fetch_ptr
< kbd_store_ptr
3525 ? kbd_store_ptr
- kbd_fetch_ptr
3526 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3527 + (kbd_store_ptr
- kbd_buffer
)));
3529 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3532 kbd_buffer_store_event (register struct input_event
*event
)
3534 kbd_buffer_store_event_hold (event
, 0);
3537 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3539 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3540 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3541 Else, if EVENT is a quit event, store the quit event
3542 in HOLD_QUIT, and return (thus ignoring further events).
3544 This is used to postpone the processing of the quit event until all
3545 subsequent input events have been parsed (and discarded). */
3548 kbd_buffer_store_event_hold (register struct input_event
*event
,
3549 struct input_event
*hold_quit
)
3551 if (event
->kind
== NO_EVENT
)
3554 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3557 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3559 register int c
= event
->code
& 0377;
3561 if (event
->modifiers
& ctrl_modifier
)
3562 c
= make_ctrl_char (c
);
3564 c
|= (event
->modifiers
3565 & (meta_modifier
| alt_modifier
3566 | hyper_modifier
| super_modifier
));
3570 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3571 struct input_event
*sp
;
3573 if (single_kboard
&& kb
!= current_kboard
)
3576 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3578 kb
->kbd_queue_has_data
= 1;
3579 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3581 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3584 if (event_to_kboard (sp
) == kb
)
3586 sp
->kind
= NO_EVENT
;
3587 sp
->frame_or_window
= Qnil
;
3596 *hold_quit
= *event
;
3600 /* If this results in a quit_char being returned to Emacs as
3601 input, set Vlast_event_frame properly. If this doesn't
3602 get returned to Emacs as an event, the next event read
3603 will set Vlast_event_frame again, so this is safe to do. */
3607 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3609 focus
= event
->frame_or_window
;
3610 internal_last_event_frame
= focus
;
3611 Vlast_event_frame
= focus
;
3614 last_event_timestamp
= event
->timestamp
;
3616 handle_interrupt (0);
3620 if (c
&& c
== stop_character
)
3626 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3627 Just ignore the second one. */
3628 else if (event
->kind
== BUFFER_SWITCH_EVENT
3629 && kbd_fetch_ptr
!= kbd_store_ptr
3630 && ((kbd_store_ptr
== kbd_buffer
3631 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3632 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3635 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3636 kbd_store_ptr
= kbd_buffer
;
3638 /* Don't let the very last slot in the buffer become full,
3639 since that would make the two pointers equal,
3640 and that is indistinguishable from an empty buffer.
3641 Discard the event if it would fill the last slot. */
3642 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3644 *kbd_store_ptr
= *event
;
3647 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3649 /* Don't read keyboard input until we have processed kbd_buffer.
3650 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3651 hold_keyboard_input ();
3652 if (!noninteractive
)
3656 #endif /* subprocesses */
3659 /* If we're inside while-no-input, and this event qualifies
3660 as input, set quit-flag to cause an interrupt. */
3661 if (!NILP (Vthrow_on_input
)
3662 && event
->kind
!= FOCUS_IN_EVENT
3663 && event
->kind
!= HELP_EVENT
3664 && event
->kind
!= DEICONIFY_EVENT
)
3666 Vquit_flag
= Vthrow_on_input
;
3667 /* If we're inside a function that wants immediate quits,
3669 if (immediate_quit
&& NILP (Vinhibit_quit
))
3678 /* Put an input event back in the head of the event queue. */
3681 kbd_buffer_unget_event (register struct input_event
*event
)
3683 if (kbd_fetch_ptr
== kbd_buffer
)
3684 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3686 /* Don't let the very last slot in the buffer become full, */
3687 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3690 *kbd_fetch_ptr
= *event
;
3695 /* Generate a HELP_EVENT input_event and store it in the keyboard
3698 HELP is the help form.
3700 FRAME and WINDOW are the frame and window where the help is
3701 generated. OBJECT is the Lisp object where the help was found (a
3702 buffer, a string, an overlay, or nil if neither from a string nor
3703 from a buffer). POS is the position within OBJECT where the help
3707 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3708 Lisp_Object object
, ptrdiff_t pos
)
3710 struct input_event event
;
3714 event
.kind
= HELP_EVENT
;
3715 event
.frame_or_window
= frame
;
3717 event
.x
= WINDOWP (window
) ? window
: frame
;
3720 kbd_buffer_store_event (&event
);
3724 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3727 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3729 struct input_event event
;
3731 event
.kind
= HELP_EVENT
;
3732 event
.frame_or_window
= frame
;
3737 kbd_buffer_store_event (&event
);
3741 /* Discard any mouse events in the event buffer by setting them to
3744 discard_mouse_events (void)
3746 struct input_event
*sp
;
3747 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3749 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3752 if (sp
->kind
== MOUSE_CLICK_EVENT
3753 || sp
->kind
== WHEEL_EVENT
3754 || sp
->kind
== HORIZ_WHEEL_EVENT
3756 || sp
->kind
== GPM_CLICK_EVENT
3758 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3760 sp
->kind
= NO_EVENT
;
3766 /* Return true if there are any real events waiting in the event
3767 buffer, not counting `NO_EVENT's.
3769 Discard NO_EVENT events at the front of the input queue, possibly
3770 leaving the input queue empty if there are no real input events. */
3773 kbd_buffer_events_waiting (void)
3775 struct input_event
*sp
;
3777 for (sp
= kbd_fetch_ptr
;
3778 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3781 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3786 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3790 /* Clear input event EVENT. */
3793 clear_event (struct input_event
*event
)
3795 event
->kind
= NO_EVENT
;
3799 /* Read one event from the event buffer, waiting if necessary.
3800 The value is a Lisp object representing the event.
3801 The value is nil for an event that should be ignored,
3802 or that was handled here.
3803 We always read and discard one event. */
3806 kbd_buffer_get_event (KBOARD
**kbp
,
3807 bool *used_mouse_menu
,
3808 struct timespec
*end_time
)
3813 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3815 /* Start reading input again because we have processed enough to
3816 be able to accept new events again. */
3817 unhold_keyboard_input ();
3820 #endif /* subprocesses */
3822 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3824 /* In case we are running as a daemon, only do this before
3825 detaching from the terminal. */
3826 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3830 *kbp
= current_kboard
;
3833 #endif /* ! HAVE_DBUS */
3835 /* Wait until there is input available. */
3838 /* Break loop if there's an unread command event. Needed in
3839 moused window autoselection which uses a timer to insert such
3841 if (CONSP (Vunread_command_events
))
3844 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3846 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3849 /* If the quit flag is set, then read_char will return
3850 quit_char, so that counts as "available input." */
3851 if (!NILP (Vquit_flag
))
3852 quit_throw_to_read_char (0);
3854 /* One way or another, wait until input is available; then, if
3855 interrupt handlers have not read it, read it now. */
3860 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3862 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3866 struct timespec now
= current_timespec ();
3867 if (timespec_cmp (*end_time
, now
) <= 0)
3868 return Qnil
; /* Finished waiting. */
3871 struct timespec duration
= timespec_sub (*end_time
, now
);
3872 wait_reading_process_output (min (duration
.tv_sec
,
3875 -1, 1, Qnil
, NULL
, 0);
3879 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3881 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3885 if (CONSP (Vunread_command_events
))
3888 first
= XCAR (Vunread_command_events
);
3889 Vunread_command_events
= XCDR (Vunread_command_events
);
3890 *kbp
= current_kboard
;
3894 /* At this point, we know that there is a readable event available
3895 somewhere. If the event queue is empty, then there must be a
3896 mouse movement enabled and available. */
3897 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3899 struct input_event
*event
;
3901 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3905 last_event_timestamp
= event
->timestamp
;
3907 *kbp
= event_to_kboard (event
);
3909 *kbp
= current_kboard
; /* Better than returning null ptr? */
3913 /* These two kinds of events get special handling
3914 and don't actually appear to the command loop.
3915 We return nil for them. */
3916 if (event
->kind
== SELECTION_REQUEST_EVENT
3917 || event
->kind
== SELECTION_CLEAR_EVENT
)
3920 struct input_event copy
;
3922 /* Remove it from the buffer before processing it,
3923 since otherwise swallow_events will see it
3924 and process it again. */
3926 kbd_fetch_ptr
= event
+ 1;
3927 input_pending
= readable_events (0);
3928 x_handle_selection_event (©
);
3930 /* We're getting selection request events, but we don't have
3936 #if defined (HAVE_NS)
3937 else if (event
->kind
== NS_TEXT_EVENT
)
3939 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3940 obj
= list1 (intern ("ns-put-working-text"));
3942 obj
= list1 (intern ("ns-unput-working-text"));
3943 kbd_fetch_ptr
= event
+ 1;
3944 if (used_mouse_menu
)
3945 *used_mouse_menu
= 1;
3949 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3950 || defined (HAVE_NS)
3951 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3953 /* Make an event (delete-frame (FRAME)). */
3954 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3955 kbd_fetch_ptr
= event
+ 1;
3958 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3959 || defined (HAVE_NS)
3960 else if (event
->kind
== ICONIFY_EVENT
)
3962 /* Make an event (iconify-frame (FRAME)). */
3963 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3964 kbd_fetch_ptr
= event
+ 1;
3966 else if (event
->kind
== DEICONIFY_EVENT
)
3968 /* Make an event (make-frame-visible (FRAME)). */
3969 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3970 kbd_fetch_ptr
= event
+ 1;
3973 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3975 /* The value doesn't matter here; only the type is tested. */
3976 XSETBUFFER (obj
, current_buffer
);
3977 kbd_fetch_ptr
= event
+ 1;
3979 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3980 || defined (HAVE_NS) || defined (USE_GTK)
3981 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3983 kbd_fetch_ptr
= event
+ 1;
3984 input_pending
= readable_events (0);
3985 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3986 x_activate_menubar (XFRAME (event
->frame_or_window
));
3990 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3992 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3993 obj
= list4 (Qlanguage_change
,
3994 event
->frame_or_window
,
3995 make_number (event
->code
),
3996 make_number (event
->modifiers
));
3997 kbd_fetch_ptr
= event
+ 1;
4000 #ifdef USE_FILE_NOTIFY
4001 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4003 #ifdef HAVE_W32NOTIFY
4004 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4005 obj
= list3 (Qfile_notify
,
4006 list3 (make_number (event
->code
),
4009 event
->frame_or_window
);
4011 obj
= make_lispy_event (event
);
4013 kbd_fetch_ptr
= event
+ 1;
4015 #endif /* USE_FILE_NOTIFY */
4016 else if (event
->kind
== SAVE_SESSION_EVENT
)
4018 obj
= list2 (Qsave_session
, event
->arg
);
4019 kbd_fetch_ptr
= event
+ 1;
4021 /* Just discard these, by returning nil.
4022 With MULTI_KBOARD, these events are used as placeholders
4023 when we need to randomly delete events from the queue.
4024 (They shouldn't otherwise be found in the buffer,
4025 but on some machines it appears they do show up
4026 even without MULTI_KBOARD.) */
4027 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4028 mouse events during a popup-menu call. */
4029 else if (event
->kind
== NO_EVENT
)
4030 kbd_fetch_ptr
= event
+ 1;
4031 else if (event
->kind
== HELP_EVENT
)
4033 Lisp_Object object
, position
, help
, frame
, window
;
4035 frame
= event
->frame_or_window
;
4036 object
= event
->arg
;
4037 position
= make_number (event
->code
);
4040 clear_event (event
);
4042 kbd_fetch_ptr
= event
+ 1;
4043 if (!WINDOWP (window
))
4045 obj
= Fcons (Qhelp_echo
,
4046 list5 (frame
, help
, window
, object
, position
));
4048 else if (event
->kind
== FOCUS_IN_EVENT
)
4050 /* Notification of a FocusIn event. The frame receiving the
4051 focus is in event->frame_or_window. Generate a
4052 switch-frame event if necessary. */
4053 Lisp_Object frame
, focus
;
4055 frame
= event
->frame_or_window
;
4056 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4065 !EQ (frame
, internal_last_event_frame
)
4066 && !EQ (frame
, selected_frame
))
4067 obj
= make_lispy_switch_frame (frame
);
4069 obj
= make_lispy_focus_in (frame
);
4071 internal_last_event_frame
= frame
;
4072 kbd_fetch_ptr
= event
+ 1;
4074 else if (event
->kind
== FOCUS_OUT_EVENT
)
4076 #ifdef HAVE_WINDOW_SYSTEM
4079 Lisp_Object frame
= event
->frame_or_window
;
4080 bool focused
= false;
4082 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4083 focused
= di
->x_highlight_frame
!= 0;
4086 obj
= make_lispy_focus_out (frame
);
4088 #endif /* HAVE_WINDOW_SYSTEM */
4090 kbd_fetch_ptr
= event
+ 1;
4093 else if (event
->kind
== DBUS_EVENT
)
4095 obj
= make_lispy_event (event
);
4096 kbd_fetch_ptr
= event
+ 1;
4099 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4101 obj
= make_lispy_event (event
);
4102 kbd_fetch_ptr
= event
+ 1;
4106 /* If this event is on a different frame, return a switch-frame this
4107 time, and leave the event in the queue for next time. */
4111 frame
= event
->frame_or_window
;
4113 frame
= XCAR (frame
);
4114 else if (WINDOWP (frame
))
4115 frame
= WINDOW_FRAME (XWINDOW (frame
));
4117 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4121 if (! EQ (frame
, internal_last_event_frame
)
4122 && !EQ (frame
, selected_frame
))
4123 obj
= make_lispy_switch_frame (frame
);
4124 internal_last_event_frame
= frame
;
4126 /* If we didn't decide to make a switch-frame event, go ahead
4127 and build a real event from the queue entry. */
4131 obj
= make_lispy_event (event
);
4133 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4134 || defined (HAVE_NS) || defined (USE_GTK)
4135 /* If this was a menu selection, then set the flag to inhibit
4136 writing to last_nonmenu_event. Don't do this if the event
4137 we're returning is (menu-bar), though; that indicates the
4138 beginning of the menu sequence, and we might as well leave
4139 that as the `event with parameters' for this selection. */
4141 && !EQ (event
->frame_or_window
, event
->arg
)
4142 && (event
->kind
== MENU_BAR_EVENT
4143 || event
->kind
== TOOL_BAR_EVENT
))
4144 *used_mouse_menu
= 1;
4147 /* Certain system events are non-key events. */
4149 && event
->kind
== NS_NONKEY_EVENT
)
4150 *used_mouse_menu
= 1;
4153 /* Wipe out this event, to catch bugs. */
4154 clear_event (event
);
4155 kbd_fetch_ptr
= event
+ 1;
4159 /* Try generating a mouse motion event. */
4160 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4162 struct frame
*f
= some_mouse_moved ();
4163 Lisp_Object bar_window
;
4164 enum scroll_bar_part part
;
4168 *kbp
= current_kboard
;
4169 /* Note that this uses F to determine which terminal to look at.
4170 If there is no valid info, it does not store anything
4171 so x remains nil. */
4174 /* XXX Can f or mouse_position_hook be NULL here? */
4175 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4176 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4181 /* Decide if we should generate a switch-frame event. Don't
4182 generate switch-frame events for motion outside of all Emacs
4188 frame
= FRAME_FOCUS_FRAME (f
);
4190 XSETFRAME (frame
, f
);
4192 if (! EQ (frame
, internal_last_event_frame
)
4193 && !EQ (frame
, selected_frame
))
4194 obj
= make_lispy_switch_frame (frame
);
4195 internal_last_event_frame
= frame
;
4198 /* If we didn't decide to make a switch-frame event, go ahead and
4199 return a mouse-motion event. */
4200 if (!NILP (x
) && NILP (obj
))
4201 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4204 /* We were promised by the above while loop that there was
4205 something for us to read! */
4208 input_pending
= readable_events (0);
4210 Vlast_event_frame
= internal_last_event_frame
;
4215 /* Process any non-user-visible events (currently X selection events),
4216 without reading any user-visible events. */
4219 process_special_events (void)
4221 struct input_event
*event
;
4223 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4225 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4228 if (event
== kbd_store_ptr
)
4232 /* If we find a stored X selection request, handle it now. */
4233 if (event
->kind
== SELECTION_REQUEST_EVENT
4234 || event
->kind
== SELECTION_CLEAR_EVENT
)
4238 /* Remove the event from the fifo buffer before processing;
4239 otherwise swallow_events called recursively could see it
4240 and process it again. To do this, we move the events
4241 between kbd_fetch_ptr and EVENT one slot to the right,
4244 struct input_event copy
= *event
;
4245 struct input_event
*beg
4246 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4247 ? kbd_buffer
: kbd_fetch_ptr
;
4250 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4251 else if (event
< beg
)
4253 if (event
> kbd_buffer
)
4254 memmove (kbd_buffer
+ 1, kbd_buffer
,
4255 (event
- kbd_buffer
) * sizeof (struct input_event
));
4256 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4257 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4258 memmove (beg
+ 1, beg
,
4259 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4260 * sizeof (struct input_event
));
4263 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4264 kbd_fetch_ptr
= kbd_buffer
+ 1;
4268 /* X wants last_event_timestamp for selection ownership. */
4269 last_event_timestamp
= copy
.timestamp
;
4270 input_pending
= readable_events (0);
4271 x_handle_selection_event (©
);
4273 /* We're getting selection request events, but we don't have
4281 /* Process any events that are not user-visible, run timer events that
4282 are ripe, and return, without reading any user-visible events. */
4285 swallow_events (bool do_display
)
4287 unsigned old_timers_run
;
4289 process_special_events ();
4291 old_timers_run
= timers_run
;
4292 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4294 if (timers_run
!= old_timers_run
&& do_display
)
4295 redisplay_preserve_echo_area (7);
4298 /* Record the start of when Emacs is idle,
4299 for the sake of running idle-time timers. */
4302 timer_start_idle (void)
4304 /* If we are already in the idle state, do nothing. */
4305 if (timespec_valid_p (timer_idleness_start_time
))
4308 timer_idleness_start_time
= current_timespec ();
4309 timer_last_idleness_start_time
= timer_idleness_start_time
;
4311 /* Mark all idle-time timers as once again candidates for running. */
4312 call0 (intern ("internal-timer-start-idle"));
4315 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4318 timer_stop_idle (void)
4320 timer_idleness_start_time
= invalid_timespec ();
4323 /* Resume idle timer from last idle start time. */
4326 timer_resume_idle (void)
4328 if (timespec_valid_p (timer_idleness_start_time
))
4331 timer_idleness_start_time
= timer_last_idleness_start_time
;
4334 /* This is only for debugging. */
4335 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4337 /* List of elisp functions to call, delayed because they were generated in
4338 a context where Elisp could not be safely run (e.g. redisplay, signal,
4339 ...). Each element has the form (FUN . ARGS). */
4340 Lisp_Object pending_funcalls
;
4342 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4344 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4346 Lisp_Object
*vector
;
4348 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4350 vector
= XVECTOR (timer
)->contents
;
4351 if (! NILP (vector
[0]))
4354 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4359 /* Check whether a timer has fired. To prevent larger problems we simply
4360 disregard elements that are not proper timers. Do not make a circular
4361 timer list for the time being.
4363 Returns the time to wait until the next timer fires. If a
4364 timer is triggering now, return zero.
4365 If no timer is active, return -1.
4367 If a timer is ripe, we run it, with quitting turned off.
4368 In that case we return 0 to indicate that a new timer_check_2 call
4371 static struct timespec
4372 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4374 struct timespec nexttime
;
4375 struct timespec now
;
4376 struct timespec idleness_now
;
4377 Lisp_Object chosen_timer
;
4378 struct gcpro gcpro1
;
4380 nexttime
= invalid_timespec ();
4382 chosen_timer
= Qnil
;
4383 GCPRO1 (chosen_timer
);
4385 /* First run the code that was delayed. */
4386 while (CONSP (pending_funcalls
))
4388 Lisp_Object funcall
= XCAR (pending_funcalls
);
4389 pending_funcalls
= XCDR (pending_funcalls
);
4390 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4393 if (CONSP (timers
) || CONSP (idle_timers
))
4395 now
= current_timespec ();
4396 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4397 ? timespec_sub (now
, timer_idleness_start_time
)
4398 : make_timespec (0, 0));
4401 while (CONSP (timers
) || CONSP (idle_timers
))
4403 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4404 struct timespec timer_time
, idle_timer_time
;
4405 struct timespec difference
;
4406 struct timespec timer_difference
= invalid_timespec ();
4407 struct timespec idle_timer_difference
= invalid_timespec ();
4408 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4410 /* Set TIMER and TIMER_DIFFERENCE
4411 based on the next ordinary timer.
4412 TIMER_DIFFERENCE is the distance in time from NOW to when
4413 this timer becomes ripe (negative if it's already ripe).
4414 Skip past invalid timers and timers already handled. */
4417 timer
= XCAR (timers
);
4418 if (! decode_timer (timer
, &timer_time
))
4420 timers
= XCDR (timers
);
4424 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4425 timer_difference
= (timer_ripe
4426 ? timespec_sub (now
, timer_time
)
4427 : timespec_sub (timer_time
, now
));
4430 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4431 based on the next idle timer. */
4432 if (CONSP (idle_timers
))
4434 idle_timer
= XCAR (idle_timers
);
4435 if (! decode_timer (idle_timer
, &idle_timer_time
))
4437 idle_timers
= XCDR (idle_timers
);
4441 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4442 idle_timer_difference
4444 ? timespec_sub (idleness_now
, idle_timer_time
)
4445 : timespec_sub (idle_timer_time
, idleness_now
));
4448 /* Decide which timer is the next timer,
4449 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4450 Also step down the list where we found that timer. */
4452 if (timespec_valid_p (timer_difference
)
4453 && (! timespec_valid_p (idle_timer_difference
)
4454 || idle_timer_ripe
< timer_ripe
4455 || (idle_timer_ripe
== timer_ripe
4457 ? timespec_cmp (idle_timer_difference
,
4459 : timespec_cmp (timer_difference
,
4460 idle_timer_difference
))
4463 chosen_timer
= timer
;
4464 timers
= XCDR (timers
);
4465 difference
= timer_difference
;
4470 chosen_timer
= idle_timer
;
4471 idle_timers
= XCDR (idle_timers
);
4472 difference
= idle_timer_difference
;
4473 ripe
= idle_timer_ripe
;
4476 /* If timer is ripe, run it if it hasn't been run. */
4479 if (NILP (AREF (chosen_timer
, 0)))
4481 ptrdiff_t count
= SPECPDL_INDEX ();
4482 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4484 /* Mark the timer as triggered to prevent problems if the lisp
4485 code fails to reschedule it right. */
4486 ASET (chosen_timer
, 0, Qt
);
4488 specbind (Qinhibit_quit
, Qt
);
4490 call1 (Qtimer_event_handler
, chosen_timer
);
4491 Vdeactivate_mark
= old_deactivate_mark
;
4493 unbind_to (count
, Qnil
);
4495 /* Since we have handled the event,
4496 we don't need to tell the caller to wake up and do it. */
4497 /* But the caller must still wait for the next timer, so
4498 return 0 to indicate that. */
4501 nexttime
= make_timespec (0, 0);
4505 /* When we encounter a timer that is still waiting,
4506 return the amount of time to wait before it is ripe. */
4513 /* No timers are pending in the future. */
4514 /* Return 0 if we generated an event, and -1 if not. */
4520 /* Check whether a timer has fired. To prevent larger problems we simply
4521 disregard elements that are not proper timers. Do not make a circular
4522 timer list for the time being.
4524 Returns the time to wait until the next timer fires.
4525 If no timer is active, return an invalid value.
4527 As long as any timer is ripe, we run it. */
4532 struct timespec nexttime
;
4533 Lisp_Object timers
, idle_timers
;
4534 struct gcpro gcpro1
, gcpro2
;
4536 Lisp_Object tem
= Vinhibit_quit
;
4539 /* We use copies of the timers' lists to allow a timer to add itself
4540 again, without locking up Emacs if the newly added timer is
4541 already ripe when added. */
4543 /* Always consider the ordinary timers. */
4544 timers
= Fcopy_sequence (Vtimer_list
);
4545 /* Consider the idle timers only if Emacs is idle. */
4546 if (timespec_valid_p (timer_idleness_start_time
))
4547 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4551 Vinhibit_quit
= tem
;
4553 GCPRO2 (timers
, idle_timers
);
4557 nexttime
= timer_check_2 (timers
, idle_timers
);
4559 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4565 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4566 doc
: /* Return the current length of Emacs idleness, or nil.
4567 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4568 in the same style as (current-time).
4570 The value when Emacs is not idle is nil.
4572 PSEC is a multiple of the system clock resolution. */)
4575 if (timespec_valid_p (timer_idleness_start_time
))
4576 return make_lisp_time (timespec_sub (current_timespec (),
4577 timer_idleness_start_time
));
4582 /* Caches for modify_event_symbol. */
4583 static Lisp_Object accent_key_syms
;
4584 static Lisp_Object func_key_syms
;
4585 static Lisp_Object mouse_syms
;
4586 static Lisp_Object wheel_syms
;
4587 static Lisp_Object drag_n_drop_syms
;
4589 /* This is a list of keysym codes for special "accent" characters.
4590 It parallels lispy_accent_keys. */
4592 static const int lispy_accent_codes
[] =
4594 #ifdef XK_dead_circumflex
4599 #ifdef XK_dead_grave
4604 #ifdef XK_dead_tilde
4609 #ifdef XK_dead_diaeresis
4614 #ifdef XK_dead_macron
4619 #ifdef XK_dead_degree
4624 #ifdef XK_dead_acute
4629 #ifdef XK_dead_cedilla
4634 #ifdef XK_dead_breve
4639 #ifdef XK_dead_ogonek
4644 #ifdef XK_dead_caron
4649 #ifdef XK_dead_doubleacute
4650 XK_dead_doubleacute
,
4654 #ifdef XK_dead_abovedot
4659 #ifdef XK_dead_abovering
4669 #ifdef XK_dead_belowdot
4674 #ifdef XK_dead_voiced_sound
4675 XK_dead_voiced_sound
,
4679 #ifdef XK_dead_semivoiced_sound
4680 XK_dead_semivoiced_sound
,
4696 /* This is a list of Lisp names for special "accent" characters.
4697 It parallels lispy_accent_codes. */
4699 static const char *const lispy_accent_keys
[] =
4717 "dead-voiced-sound",
4718 "dead-semivoiced-sound",
4724 #define FUNCTION_KEY_OFFSET 0x0
4726 const char *const lispy_function_keys
[] =
4730 0, /* VK_LBUTTON 0x01 */
4731 0, /* VK_RBUTTON 0x02 */
4732 "cancel", /* VK_CANCEL 0x03 */
4733 0, /* VK_MBUTTON 0x04 */
4735 0, 0, 0, /* 0x05 .. 0x07 */
4737 "backspace", /* VK_BACK 0x08 */
4738 "tab", /* VK_TAB 0x09 */
4740 0, 0, /* 0x0A .. 0x0B */
4742 "clear", /* VK_CLEAR 0x0C */
4743 "return", /* VK_RETURN 0x0D */
4745 0, 0, /* 0x0E .. 0x0F */
4747 0, /* VK_SHIFT 0x10 */
4748 0, /* VK_CONTROL 0x11 */
4749 0, /* VK_MENU 0x12 */
4750 "pause", /* VK_PAUSE 0x13 */
4751 "capslock", /* VK_CAPITAL 0x14 */
4752 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4754 "junja", /* VK_JUNJA 0x17 */
4755 "final", /* VK_FINAL 0x18 */
4756 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4758 "escape", /* VK_ESCAPE 0x1B */
4759 "convert", /* VK_CONVERT 0x1C */
4760 "non-convert", /* VK_NONCONVERT 0x1D */
4761 "accept", /* VK_ACCEPT 0x1E */
4762 "mode-change", /* VK_MODECHANGE 0x1F */
4763 0, /* VK_SPACE 0x20 */
4764 "prior", /* VK_PRIOR 0x21 */
4765 "next", /* VK_NEXT 0x22 */
4766 "end", /* VK_END 0x23 */
4767 "home", /* VK_HOME 0x24 */
4768 "left", /* VK_LEFT 0x25 */
4769 "up", /* VK_UP 0x26 */
4770 "right", /* VK_RIGHT 0x27 */
4771 "down", /* VK_DOWN 0x28 */
4772 "select", /* VK_SELECT 0x29 */
4773 "print", /* VK_PRINT 0x2A */
4774 "execute", /* VK_EXECUTE 0x2B */
4775 "snapshot", /* VK_SNAPSHOT 0x2C */
4776 "insert", /* VK_INSERT 0x2D */
4777 "delete", /* VK_DELETE 0x2E */
4778 "help", /* VK_HELP 0x2F */
4780 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4782 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4784 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4786 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4788 0, 0, 0, 0, 0, 0, 0, 0, 0,
4789 0, 0, 0, 0, 0, 0, 0, 0, 0,
4790 0, 0, 0, 0, 0, 0, 0, 0,
4792 "lwindow", /* VK_LWIN 0x5B */
4793 "rwindow", /* VK_RWIN 0x5C */
4794 "apps", /* VK_APPS 0x5D */
4797 "kp-0", /* VK_NUMPAD0 0x60 */
4798 "kp-1", /* VK_NUMPAD1 0x61 */
4799 "kp-2", /* VK_NUMPAD2 0x62 */
4800 "kp-3", /* VK_NUMPAD3 0x63 */
4801 "kp-4", /* VK_NUMPAD4 0x64 */
4802 "kp-5", /* VK_NUMPAD5 0x65 */
4803 "kp-6", /* VK_NUMPAD6 0x66 */
4804 "kp-7", /* VK_NUMPAD7 0x67 */
4805 "kp-8", /* VK_NUMPAD8 0x68 */
4806 "kp-9", /* VK_NUMPAD9 0x69 */
4807 "kp-multiply", /* VK_MULTIPLY 0x6A */
4808 "kp-add", /* VK_ADD 0x6B */
4809 "kp-separator", /* VK_SEPARATOR 0x6C */
4810 "kp-subtract", /* VK_SUBTRACT 0x6D */
4811 "kp-decimal", /* VK_DECIMAL 0x6E */
4812 "kp-divide", /* VK_DIVIDE 0x6F */
4813 "f1", /* VK_F1 0x70 */
4814 "f2", /* VK_F2 0x71 */
4815 "f3", /* VK_F3 0x72 */
4816 "f4", /* VK_F4 0x73 */
4817 "f5", /* VK_F5 0x74 */
4818 "f6", /* VK_F6 0x75 */
4819 "f7", /* VK_F7 0x76 */
4820 "f8", /* VK_F8 0x77 */
4821 "f9", /* VK_F9 0x78 */
4822 "f10", /* VK_F10 0x79 */
4823 "f11", /* VK_F11 0x7A */
4824 "f12", /* VK_F12 0x7B */
4825 "f13", /* VK_F13 0x7C */
4826 "f14", /* VK_F14 0x7D */
4827 "f15", /* VK_F15 0x7E */
4828 "f16", /* VK_F16 0x7F */
4829 "f17", /* VK_F17 0x80 */
4830 "f18", /* VK_F18 0x81 */
4831 "f19", /* VK_F19 0x82 */
4832 "f20", /* VK_F20 0x83 */
4833 "f21", /* VK_F21 0x84 */
4834 "f22", /* VK_F22 0x85 */
4835 "f23", /* VK_F23 0x86 */
4836 "f24", /* VK_F24 0x87 */
4838 0, 0, 0, 0, /* 0x88 .. 0x8B */
4839 0, 0, 0, 0, /* 0x8C .. 0x8F */
4841 "kp-numlock", /* VK_NUMLOCK 0x90 */
4842 "scroll", /* VK_SCROLL 0x91 */
4843 /* Not sure where the following block comes from.
4844 Windows headers have NEC and Fujitsu specific keys in
4845 this block, but nothing generic. */
4846 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4847 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4848 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4849 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4850 "kp-end", /* VK_NUMPAD_END 0x96 */
4851 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4852 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4853 "kp-up", /* VK_NUMPAD_UP 0x99 */
4854 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4855 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4856 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4857 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4859 0, 0, /* 0x9E .. 0x9F */
4862 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4863 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4864 * No other API or message will distinguish left and right keys this way.
4869 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4870 to enable them selectively, and gives access to a few more functions.
4871 See lispy_multimedia_keys below. */
4872 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4873 0, 0, 0, /* 0xAD .. 0xAF Volume */
4874 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4875 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4877 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4878 0, 0, 0, 0, 0, 0, 0, 0, 0,
4880 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4881 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4882 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4885 "ax", /* VK_OEM_AX 0xE1 */
4886 0, /* VK_OEM_102 0xE2 */
4887 "ico-help", /* VK_ICO_HELP 0xE3 */
4888 "ico-00", /* VK_ICO_00 0xE4 */
4889 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4890 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4891 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4893 "reset", /* VK_OEM_RESET 0xE9 */
4894 "jump", /* VK_OEM_JUMP 0xEA */
4895 "oem-pa1", /* VK_OEM_PA1 0xEB */
4896 "oem-pa2", /* VK_OEM_PA2 0xEC */
4897 "oem-pa3", /* VK_OEM_PA3 0xED */
4898 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4899 "cusel", /* VK_OEM_CUSEL 0xEF */
4900 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4901 "finish", /* VK_OEM_FINISH 0xF1 */
4902 "copy", /* VK_OEM_COPY 0xF2 */
4903 "auto", /* VK_OEM_AUTO 0xF3 */
4904 "enlw", /* VK_OEM_ENLW 0xF4 */
4905 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4906 "attn", /* VK_ATTN 0xF6 */
4907 "crsel", /* VK_CRSEL 0xF7 */
4908 "exsel", /* VK_EXSEL 0xF8 */
4909 "ereof", /* VK_EREOF 0xF9 */
4910 "play", /* VK_PLAY 0xFA */
4911 "zoom", /* VK_ZOOM 0xFB */
4912 "noname", /* VK_NONAME 0xFC */
4913 "pa1", /* VK_PA1 0xFD */
4914 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4918 /* Some of these duplicate the "Media keys" on newer keyboards,
4919 but they are delivered to the application in a different way. */
4920 static const char *const lispy_multimedia_keys
[] =
4928 "browser-favorites",
4965 "toggle-dictate-command",
4971 "media-fast-forward",
4974 "media-channel-down"
4977 #else /* not HAVE_NTGUI */
4979 /* This should be dealt with in XTread_socket now, and that doesn't
4980 depend on the client system having the Kana syms defined. See also
4981 the XK_kana_A case below. */
4984 static const char *const lispy_kana_keys
[] =
4986 /* X Keysym value */
4987 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4988 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4989 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4990 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4991 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4992 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4993 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4994 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4995 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4996 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4997 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4998 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4999 "kana-i", "kana-u", "kana-e", "kana-o",
5000 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5001 "prolongedsound", "kana-A", "kana-I", "kana-U",
5002 "kana-E", "kana-O", "kana-KA", "kana-KI",
5003 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5004 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5005 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5006 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5007 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5008 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5009 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5010 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5011 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5012 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5013 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5014 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5016 #endif /* XK_kana_A */
5019 #define FUNCTION_KEY_OFFSET 0xff00
5021 /* You'll notice that this table is arranged to be conveniently
5022 indexed by X Windows keysym values. */
5023 static const char *const lispy_function_keys
[] =
5025 /* X Keysym value */
5027 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5028 "backspace", "tab", "linefeed", "clear",
5030 0, 0, 0, "pause", /* 0xff10...1f */
5031 0, 0, 0, 0, 0, 0, 0, "escape",
5033 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5034 "romaji", "hiragana", "katakana", "hiragana-katakana",
5035 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5036 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5037 "eisu-toggle", /* 0xff30...3f */
5038 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5039 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5041 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5042 "down", "prior", "next", "end",
5043 "begin", 0, 0, 0, 0, 0, 0, 0,
5044 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5055 "break", /* 0xff6b */
5058 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5059 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5060 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5061 0, 0, 0, 0, 0, 0, 0, 0,
5062 "kp-tab", /* 0xff89 */
5064 "kp-enter", /* 0xff8d */
5066 "kp-f1", /* 0xff91 */
5070 "kp-home", /* 0xff95 */
5075 "kp-prior", /* kp-page-up */
5076 "kp-next", /* kp-page-down */
5082 0, 0, 0, 0, 0, 0, 0, 0, 0,
5083 "kp-multiply", /* 0xffaa */
5088 "kp-divide", /* 0xffaf */
5089 "kp-0", /* 0xffb0 */
5090 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5093 "kp-equal", /* 0xffbd */
5094 "f1", /* 0xffbe */ /* IsFunctionKey */
5096 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5097 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5098 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5099 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5100 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5101 0, 0, 0, 0, 0, 0, 0, 0,
5102 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5103 0, 0, 0, 0, 0, 0, 0, "delete"
5106 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5107 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5109 static const char *const iso_lispy_function_keys
[] =
5111 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5112 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5113 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5114 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5115 "iso-lefttab", /* 0xfe20 */
5116 "iso-move-line-up", "iso-move-line-down",
5117 "iso-partial-line-up", "iso-partial-line-down",
5118 "iso-partial-space-left", "iso-partial-space-right",
5119 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5120 "iso-release-margin-left", "iso-release-margin-right",
5121 "iso-release-both-margins",
5122 "iso-fast-cursor-left", "iso-fast-cursor-right",
5123 "iso-fast-cursor-up", "iso-fast-cursor-down",
5124 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5125 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5128 #endif /* not HAVE_NTGUI */
5130 static Lisp_Object Vlispy_mouse_stem
;
5132 static const char *const lispy_wheel_names
[] =
5134 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5137 /* drag-n-drop events are generated when a set of selected files are
5138 dragged from another application and dropped onto an Emacs window. */
5139 static const char *const lispy_drag_n_drop_names
[] =
5144 /* Scroll bar parts. */
5145 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5146 Lisp_Object Qup
, Qdown
, Qbottom
;
5147 static Lisp_Object Qend_scroll
;
5149 static Lisp_Object Qratio
;
5151 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5152 static Lisp_Object
*const scroll_bar_parts
[] = {
5153 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5154 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5157 /* A vector, indexed by button number, giving the down-going location
5158 of currently depressed buttons, both scroll bar and non-scroll bar.
5160 The elements have the form
5161 (BUTTON-NUMBER MODIFIER-MASK . REST)
5162 where REST is the cdr of a position as it would be reported in the event.
5164 The make_lispy_event function stores positions here to tell the
5165 difference between click and drag events, and to store the starting
5166 location to be included in drag events. */
5168 static Lisp_Object button_down_location
;
5170 /* Information about the most recent up-going button event: Which
5171 button, what location, and what time. */
5173 static int last_mouse_button
;
5174 static int last_mouse_x
;
5175 static int last_mouse_y
;
5176 static Time button_down_time
;
5178 /* The number of clicks in this multiple-click. */
5180 static int double_click_count
;
5182 /* X and Y are frame-relative coordinates for a click or wheel event.
5183 Return a Lisp-style event list. */
5186 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5189 enum window_part part
;
5190 Lisp_Object posn
= Qnil
;
5191 Lisp_Object extra_info
= Qnil
;
5192 /* Coordinate pixel positions to return. */
5193 int xret
= 0, yret
= 0;
5194 /* The window under frame pixel coordinates (x,y) */
5195 Lisp_Object window
= f
5196 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5199 if (WINDOWP (window
))
5201 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5202 struct window
*w
= XWINDOW (window
);
5203 Lisp_Object string_info
= Qnil
;
5204 ptrdiff_t textpos
= -1;
5205 int col
= -1, row
= -1;
5206 int dx
= -1, dy
= -1;
5207 int width
= -1, height
= -1;
5208 Lisp_Object object
= Qnil
;
5210 /* Pixel coordinates relative to the window corner. */
5211 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5212 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5214 /* For text area clicks, return X, Y relative to the corner of
5215 this text area. Note that dX, dY etc are set below, by
5216 buffer_posn_from_coords. */
5217 if (part
== ON_TEXT
)
5219 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5220 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5222 /* For mode line and header line clicks, return X, Y relative to
5223 the left window edge. Use mode_line_string to look for a
5224 string on the click position. */
5225 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5230 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5231 /* Note that mode_line_string takes COL, ROW as pixels and
5232 converts them to characters. */
5235 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5236 &object
, &dx
, &dy
, &width
, &height
);
5237 if (STRINGP (string
))
5238 string_info
= Fcons (string
, make_number (charpos
));
5239 textpos
= (w
== XWINDOW (selected_window
)
5240 && current_buffer
== XBUFFER (w
->contents
))
5241 ? PT
: marker_position (w
->pointm
);
5246 /* For fringes and margins, Y is relative to the area's (and the
5247 window's) top edge, while X is meaningless. */
5248 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5253 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5256 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5257 &object
, &dx
, &dy
, &width
, &height
);
5258 if (STRINGP (string
))
5259 string_info
= Fcons (string
, make_number (charpos
));
5260 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5262 else if (part
== ON_LEFT_FRINGE
)
5264 posn
= Qleft_fringe
;
5267 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5268 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5269 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5271 else if (part
== ON_RIGHT_FRINGE
)
5273 posn
= Qright_fringe
;
5276 - window_box_width (w
, LEFT_MARGIN_AREA
)
5277 - window_box_width (w
, TEXT_AREA
)
5278 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5279 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5281 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5283 else if (part
== ON_VERTICAL_BORDER
)
5285 posn
= Qvertical_line
;
5290 /* Nothing special for part == ON_SCROLL_BAR. */
5292 /* For clicks in the text area, fringes, or margins, call
5293 buffer_posn_from_coords to extract TEXTPOS, the buffer
5294 position nearest to the click. */
5297 Lisp_Object string2
, object2
= Qnil
;
5298 struct display_pos p
;
5300 int width2
, height2
;
5301 /* The pixel X coordinate passed to buffer_posn_from_coords
5302 is the X coordinate relative to the text area for
5303 text-area and right-margin clicks, zero otherwise. */
5305 = (part
== ON_TEXT
) ? xret
5306 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5307 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5311 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5312 &object2
, &dx2
, &dy2
,
5314 textpos
= CHARPOS (p
.pos
);
5315 if (col
< 0) col
= x2
;
5316 if (row
< 0) row
= y2
;
5317 if (dx
< 0) dx
= dx2
;
5318 if (dy
< 0) dy
= dy2
;
5319 if (width
< 0) width
= width2
;
5320 if (height
< 0) height
= height2
;
5324 posn
= make_number (textpos
);
5325 if (STRINGP (string2
))
5326 string_info
= Fcons (string2
,
5327 make_number (CHARPOS (p
.string_pos
)));
5333 #ifdef HAVE_WINDOW_SYSTEM
5334 if (IMAGEP (object
))
5336 Lisp_Object image_map
, hotspot
;
5337 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5339 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5341 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5342 posn
= XCAR (hotspot
);
5349 Fcons (make_number (dx
), make_number (dy
)),
5350 Fcons (make_number (width
), make_number (height
)));
5353 extra_info
= Fcons (string_info
,
5354 Fcons (make_number (textpos
),
5355 Fcons (Fcons (make_number (col
),
5360 XSETFRAME (window
, f
);
5364 return Fcons (window
,
5366 Fcons (Fcons (make_number (xret
),
5367 make_number (yret
)),
5368 Fcons (make_number (t
),
5372 /* Given a struct input_event, build the lisp event which represents
5373 it. If EVENT is 0, build a mouse movement event from the mouse
5374 movement buffer, which should have a movement event in it.
5376 Note that events must be passed to this function in the order they
5377 are received; this function stores the location of button presses
5378 in order to build drag events when the button is released. */
5381 make_lispy_event (struct input_event
*event
)
5385 switch (event
->kind
)
5387 /* A simple keystroke. */
5388 case ASCII_KEYSTROKE_EVENT
:
5389 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5391 Lisp_Object lispy_c
;
5392 EMACS_INT c
= event
->code
;
5393 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5396 eassert (c
== event
->code
);
5397 /* Turn ASCII characters into control characters
5399 if (event
->modifiers
& ctrl_modifier
)
5401 c
= make_ctrl_char (c
);
5402 event
->modifiers
&= ~ctrl_modifier
;
5406 /* Add in the other modifier bits. The shift key was taken care
5407 of by the X code. */
5408 c
|= (event
->modifiers
5409 & (meta_modifier
| alt_modifier
5410 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5411 /* Distinguish Shift-SPC from SPC. */
5412 if ((event
->code
) == 040
5413 && event
->modifiers
& shift_modifier
)
5414 c
|= shift_modifier
;
5415 button_down_time
= 0;
5416 XSETFASTINT (lispy_c
, c
);
5421 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5422 except that they are non-key events (last-nonmenu-event is nil). */
5423 case NS_NONKEY_EVENT
:
5426 /* A function key. The symbol may need to have modifier prefixes
5428 case NON_ASCII_KEYSTROKE_EVENT
:
5429 button_down_time
= 0;
5431 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5432 if (event
->code
== lispy_accent_codes
[i
])
5433 return modify_event_symbol (i
,
5435 Qfunction_key
, Qnil
,
5436 lispy_accent_keys
, &accent_key_syms
,
5437 (sizeof (lispy_accent_keys
)
5438 / sizeof (lispy_accent_keys
[0])));
5442 if (event
->code
>= 0x400 && event
->code
< 0x500)
5443 return modify_event_symbol (event
->code
- 0x400,
5444 event
->modifiers
& ~shift_modifier
,
5445 Qfunction_key
, Qnil
,
5446 lispy_kana_keys
, &func_key_syms
,
5447 (sizeof (lispy_kana_keys
)
5448 / sizeof (lispy_kana_keys
[0])));
5449 #endif /* XK_kana_A */
5452 #ifdef ISO_FUNCTION_KEY_OFFSET
5453 if (event
->code
< FUNCTION_KEY_OFFSET
5454 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5455 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5457 Qfunction_key
, Qnil
,
5458 iso_lispy_function_keys
, &func_key_syms
,
5459 (sizeof (iso_lispy_function_keys
)
5460 / sizeof (iso_lispy_function_keys
[0])));
5463 /* Handle system-specific or unknown keysyms. */
5464 if (event
->code
& (1 << 28)
5465 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5466 || (event
->code
- FUNCTION_KEY_OFFSET
5467 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5468 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5470 /* We need to use an alist rather than a vector as the cache
5471 since we can't make a vector long enough. */
5472 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5473 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5474 return modify_event_symbol (event
->code
,
5477 KVAR (current_kboard
, Vsystem_key_alist
),
5478 0, &KVAR (current_kboard
, system_key_syms
),
5482 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5484 Qfunction_key
, Qnil
,
5485 lispy_function_keys
, &func_key_syms
,
5486 (sizeof (lispy_function_keys
)
5487 / sizeof (lispy_function_keys
[0])));
5490 case MULTIMEDIA_KEY_EVENT
:
5491 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5492 / sizeof (lispy_multimedia_keys
[0]))
5493 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5495 return modify_event_symbol (event
->code
, event
->modifiers
,
5496 Qfunction_key
, Qnil
,
5497 lispy_multimedia_keys
, &func_key_syms
,
5498 (sizeof (lispy_multimedia_keys
)
5499 / sizeof (lispy_multimedia_keys
[0])));
5504 /* A mouse click. Figure out where it is, decide whether it's
5505 a press, click or drag, and build the appropriate structure. */
5506 case MOUSE_CLICK_EVENT
:
5507 #ifndef USE_TOOLKIT_SCROLL_BARS
5508 case SCROLL_BAR_CLICK_EVENT
:
5511 int button
= event
->code
;
5513 Lisp_Object position
;
5514 Lisp_Object
*start_pos_ptr
;
5515 Lisp_Object start_pos
;
5519 /* Build the position as appropriate for this mouse click. */
5520 if (event
->kind
== MOUSE_CLICK_EVENT
)
5522 struct frame
*f
= XFRAME (event
->frame_or_window
);
5523 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5527 /* Ignore mouse events that were made on frame that
5528 have been deleted. */
5529 if (! FRAME_LIVE_P (f
))
5532 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5533 /* EVENT->x and EVENT->y are frame-relative pixel
5534 coordinates at this place. Under old redisplay, COLUMN
5535 and ROW are set to frame relative glyph coordinates
5536 which are then used to determine whether this click is
5537 in a menu (non-toolkit version). */
5538 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5539 &column
, &row
, NULL
, 1);
5541 /* In the non-toolkit version, clicks on the menu bar
5542 are ordinary button events in the event buffer.
5543 Distinguish them, and invoke the menu.
5545 (In the toolkit version, the toolkit handles the menu bar
5546 and Emacs doesn't know about it until after the user
5547 makes a selection.) */
5548 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5549 && (event
->modifiers
& down_modifier
))
5551 Lisp_Object items
, item
;
5553 /* Find the menu bar item under `column'. */
5555 items
= FRAME_MENU_BAR_ITEMS (f
);
5556 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5558 Lisp_Object pos
, string
;
5559 string
= AREF (items
, i
+ 1);
5560 pos
= AREF (items
, i
+ 3);
5563 if (column
>= XINT (pos
)
5564 && column
< XINT (pos
) + SCHARS (string
))
5566 item
= AREF (items
, i
);
5571 /* ELisp manual 2.4b says (x y) are window relative but
5572 code says they are frame-relative. */
5573 position
= list4 (event
->frame_or_window
,
5575 Fcons (event
->x
, event
->y
),
5576 make_number (event
->timestamp
));
5578 return list2 (item
, position
);
5580 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5582 position
= make_lispy_position (f
, event
->x
, event
->y
,
5585 #ifndef USE_TOOLKIT_SCROLL_BARS
5588 /* It's a scrollbar click. */
5590 Lisp_Object portion_whole
;
5593 window
= event
->frame_or_window
;
5594 portion_whole
= Fcons (event
->x
, event
->y
);
5595 part
= *scroll_bar_parts
[(int) event
->part
];
5597 position
= list5 (window
, Qvertical_scroll_bar
,
5598 portion_whole
, make_number (event
->timestamp
),
5601 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5603 if (button
>= ASIZE (button_down_location
))
5605 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5606 button_down_location
= larger_vector (button_down_location
,
5608 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5611 start_pos_ptr
= aref_addr (button_down_location
, button
);
5612 start_pos
= *start_pos_ptr
;
5613 *start_pos_ptr
= Qnil
;
5616 /* On window-system frames, use the value of
5617 double-click-fuzz as is. On other frames, interpret it
5618 as a multiple of 1/8 characters. */
5622 if (WINDOWP (event
->frame_or_window
))
5623 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5624 else if (FRAMEP (event
->frame_or_window
))
5625 f
= XFRAME (event
->frame_or_window
);
5629 if (FRAME_WINDOW_P (f
))
5630 fuzz
= double_click_fuzz
;
5632 fuzz
= double_click_fuzz
/ 8;
5634 is_double
= (button
== last_mouse_button
5635 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5636 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5637 && button_down_time
!= 0
5638 && (EQ (Vdouble_click_time
, Qt
)
5639 || (NATNUMP (Vdouble_click_time
)
5640 && (event
->timestamp
- button_down_time
5641 < XFASTINT (Vdouble_click_time
)))));
5644 last_mouse_button
= button
;
5645 last_mouse_x
= XINT (event
->x
);
5646 last_mouse_y
= XINT (event
->y
);
5648 /* If this is a button press, squirrel away the location, so
5649 we can decide later whether it was a click or a drag. */
5650 if (event
->modifiers
& down_modifier
)
5654 double_click_count
++;
5655 event
->modifiers
|= ((double_click_count
> 2)
5660 double_click_count
= 1;
5661 button_down_time
= event
->timestamp
;
5662 *start_pos_ptr
= Fcopy_alist (position
);
5663 ignore_mouse_drag_p
= 0;
5666 /* Now we're releasing a button - check the co-ordinates to
5667 see if this was a click or a drag. */
5668 else if (event
->modifiers
& up_modifier
)
5670 /* If we did not see a down before this up, ignore the up.
5671 Probably this happened because the down event chose a
5672 menu item. It would be an annoyance to treat the
5673 release of the button that chose the menu item as a
5676 if (!CONSP (start_pos
))
5679 event
->modifiers
&= ~up_modifier
;
5682 Lisp_Object new_down
, down
;
5683 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5685 /* The third element of every position
5686 should be the (x,y) pair. */
5687 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5688 new_down
= Fcar (Fcdr (Fcdr (position
)));
5691 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5693 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5694 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5697 if (ignore_mouse_drag_p
)
5699 event
->modifiers
|= click_modifier
;
5700 ignore_mouse_drag_p
= 0;
5702 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5703 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5704 /* Maybe the mouse has moved a lot, caused scrolling, and
5705 eventually ended up at the same screen position (but
5706 not buffer position) in which case it is a drag, not
5708 /* FIXME: OTOH if the buffer position has changed
5709 because of a timer or process filter rather than
5710 because of mouse movement, it should be considered as
5711 a click. But mouse-drag-region completely ignores
5712 this case and it hasn't caused any real problem, so
5713 it's probably OK to ignore it as well. */
5714 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5715 /* Mouse hasn't moved (much). */
5716 event
->modifiers
|= click_modifier
;
5719 button_down_time
= 0;
5720 event
->modifiers
|= drag_modifier
;
5723 /* Don't check is_double; treat this as multiple
5724 if the down-event was multiple. */
5725 if (double_click_count
> 1)
5726 event
->modifiers
|= ((double_click_count
> 2)
5732 /* Every mouse event should either have the down_modifier or
5733 the up_modifier set. */
5737 /* Get the symbol we should use for the mouse click. */
5740 head
= modify_event_symbol (button
,
5742 Qmouse_click
, Vlispy_mouse_stem
,
5745 ASIZE (mouse_syms
));
5746 if (event
->modifiers
& drag_modifier
)
5747 return list3 (head
, start_pos
, position
);
5748 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5749 return list3 (head
, position
, make_number (double_click_count
));
5751 return list2 (head
, position
);
5756 case HORIZ_WHEEL_EVENT
:
5758 Lisp_Object position
;
5761 /* Build the position as appropriate for this mouse click. */
5762 struct frame
*f
= XFRAME (event
->frame_or_window
);
5764 /* Ignore wheel events that were made on frame that have been
5766 if (! FRAME_LIVE_P (f
))
5769 position
= make_lispy_position (f
, event
->x
, event
->y
,
5772 /* Set double or triple modifiers to indicate the wheel speed. */
5774 /* On window-system frames, use the value of
5775 double-click-fuzz as is. On other frames, interpret it
5776 as a multiple of 1/8 characters. */
5782 if (WINDOWP (event
->frame_or_window
))
5783 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5784 else if (FRAMEP (event
->frame_or_window
))
5785 fr
= XFRAME (event
->frame_or_window
);
5789 fuzz
= FRAME_WINDOW_P (fr
)
5790 ? double_click_fuzz
: double_click_fuzz
/ 8;
5792 if (event
->modifiers
& up_modifier
)
5794 /* Emit a wheel-up event. */
5795 event
->modifiers
&= ~up_modifier
;
5798 else if (event
->modifiers
& down_modifier
)
5800 /* Emit a wheel-down event. */
5801 event
->modifiers
&= ~down_modifier
;
5805 /* Every wheel event should either have the down_modifier or
5806 the up_modifier set. */
5809 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5812 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5813 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5814 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5815 && button_down_time
!= 0
5816 && (EQ (Vdouble_click_time
, Qt
)
5817 || (NATNUMP (Vdouble_click_time
)
5818 && (event
->timestamp
- button_down_time
5819 < XFASTINT (Vdouble_click_time
)))));
5822 double_click_count
++;
5823 event
->modifiers
|= ((double_click_count
> 2)
5829 double_click_count
= 1;
5830 event
->modifiers
|= click_modifier
;
5833 button_down_time
= event
->timestamp
;
5834 /* Use a negative value to distinguish wheel from mouse button. */
5835 last_mouse_button
= - (1 + symbol_num
);
5836 last_mouse_x
= XINT (event
->x
);
5837 last_mouse_y
= XINT (event
->y
);
5839 /* Get the symbol we should use for the wheel event. */
5840 head
= modify_event_symbol (symbol_num
,
5846 ASIZE (wheel_syms
));
5849 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5850 return list3 (head
, position
, make_number (double_click_count
));
5852 return list2 (head
, position
);
5856 #ifdef USE_TOOLKIT_SCROLL_BARS
5858 /* We don't have down and up events if using toolkit scroll bars,
5859 so make this always a click event. Store in the `part' of
5860 the Lisp event a symbol which maps to the following actions:
5862 `above_handle' page up
5863 `below_handle' page down
5867 `bottom' bottom of buffer
5868 `handle' thumb has been dragged.
5869 `end-scroll' end of interaction with scroll bar
5871 The incoming input_event contains in its `part' member an
5872 index of type `enum scroll_bar_part' which we can use as an
5873 index in scroll_bar_parts to get the appropriate symbol. */
5875 case SCROLL_BAR_CLICK_EVENT
:
5877 Lisp_Object position
, head
, window
, portion_whole
, part
;
5879 window
= event
->frame_or_window
;
5880 portion_whole
= Fcons (event
->x
, event
->y
);
5881 part
= *scroll_bar_parts
[(int) event
->part
];
5883 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5884 make_number (event
->timestamp
), part
);
5886 /* Always treat scroll bar events as clicks. */
5887 event
->modifiers
|= click_modifier
;
5888 event
->modifiers
&= ~up_modifier
;
5890 if (event
->code
>= ASIZE (mouse_syms
))
5891 mouse_syms
= larger_vector (mouse_syms
,
5892 event
->code
- ASIZE (mouse_syms
) + 1,
5895 /* Get the symbol we should use for the mouse click. */
5896 head
= modify_event_symbol (event
->code
,
5901 ASIZE (mouse_syms
));
5902 return list2 (head
, position
);
5905 #endif /* USE_TOOLKIT_SCROLL_BARS */
5907 case DRAG_N_DROP_EVENT
:
5910 Lisp_Object head
, position
;
5913 f
= XFRAME (event
->frame_or_window
);
5916 /* Ignore mouse events that were made on frames that
5917 have been deleted. */
5918 if (! FRAME_LIVE_P (f
))
5921 position
= make_lispy_position (f
, event
->x
, event
->y
,
5924 head
= modify_event_symbol (0, event
->modifiers
,
5926 lispy_drag_n_drop_names
,
5927 &drag_n_drop_syms
, 1);
5928 return list3 (head
, position
, files
);
5931 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5932 || defined (HAVE_NS) || defined (USE_GTK)
5933 case MENU_BAR_EVENT
:
5934 if (EQ (event
->arg
, event
->frame_or_window
))
5935 /* This is the prefix key. We translate this to
5936 `(menu_bar)' because the code in keyboard.c for menu
5937 events, which we use, relies on this. */
5938 return list1 (Qmenu_bar
);
5942 case SELECT_WINDOW_EVENT
:
5943 /* Make an event (select-window (WINDOW)). */
5944 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5946 case TOOL_BAR_EVENT
:
5947 if (EQ (event
->arg
, event
->frame_or_window
))
5948 /* This is the prefix key. We translate this to
5949 `(tool_bar)' because the code in keyboard.c for tool bar
5950 events, which we use, relies on this. */
5951 return list1 (Qtool_bar
);
5952 else if (SYMBOLP (event
->arg
))
5953 return apply_modifiers (event
->modifiers
, event
->arg
);
5956 case USER_SIGNAL_EVENT
:
5957 /* A user signal. */
5959 char *name
= find_user_signal_name (event
->code
);
5962 return intern (name
);
5965 case SAVE_SESSION_EVENT
:
5966 return Qsave_session
;
5971 return Fcons (Qdbus_event
, event
->arg
);
5973 #endif /* HAVE_DBUS */
5975 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
5976 case FILE_NOTIFY_EVENT
:
5978 return Fcons (Qfile_notify
, event
->arg
);
5980 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
5982 case CONFIG_CHANGED_EVENT
:
5983 return list3 (Qconfig_changed_event
,
5984 event
->arg
, event
->frame_or_window
);
5986 case GPM_CLICK_EVENT
:
5988 struct frame
*f
= XFRAME (event
->frame_or_window
);
5989 Lisp_Object head
, position
;
5990 Lisp_Object
*start_pos_ptr
;
5991 Lisp_Object start_pos
;
5992 int button
= event
->code
;
5994 if (button
>= ASIZE (button_down_location
))
5996 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5997 button_down_location
= larger_vector (button_down_location
,
5999 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
6002 start_pos_ptr
= aref_addr (button_down_location
, button
);
6003 start_pos
= *start_pos_ptr
;
6005 position
= make_lispy_position (f
, event
->x
, event
->y
,
6008 if (event
->modifiers
& down_modifier
)
6009 *start_pos_ptr
= Fcopy_alist (position
);
6010 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6012 if (!CONSP (start_pos
))
6014 event
->modifiers
&= ~up_modifier
;
6017 head
= modify_event_symbol (button
,
6019 Qmouse_click
, Vlispy_mouse_stem
,
6022 ASIZE (mouse_syms
));
6024 if (event
->modifiers
& drag_modifier
)
6025 return list3 (head
, start_pos
, position
);
6026 else if (event
->modifiers
& double_modifier
)
6027 return list3 (head
, position
, make_number (2));
6028 else if (event
->modifiers
& triple_modifier
)
6029 return list3 (head
, position
, make_number (3));
6031 return list2 (head
, position
);
6033 #endif /* HAVE_GPM */
6035 /* The 'kind' field of the event is something we don't recognize. */
6042 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6043 Lisp_Object x
, Lisp_Object y
, Time t
)
6045 /* Is it a scroll bar movement? */
6046 if (frame
&& ! NILP (bar_window
))
6048 Lisp_Object part_sym
;
6050 part_sym
= *scroll_bar_parts
[(int) part
];
6051 return list2 (Qscroll_bar_movement
,
6053 Qvertical_scroll_bar
,
6058 /* Or is it an ordinary mouse movement? */
6061 Lisp_Object position
;
6062 position
= make_lispy_position (frame
, x
, y
, t
);
6063 return list2 (Qmouse_movement
, position
);
6067 /* Construct a switch frame event. */
6069 make_lispy_switch_frame (Lisp_Object frame
)
6071 return list2 (Qswitch_frame
, frame
);
6075 make_lispy_focus_in (Lisp_Object frame
)
6077 return list2 (Qfocus_in
, frame
);
6080 #ifdef HAVE_WINDOW_SYSTEM
6083 make_lispy_focus_out (Lisp_Object frame
)
6085 return list2 (Qfocus_out
, frame
);
6088 #endif /* HAVE_WINDOW_SYSTEM */
6090 /* Manipulating modifiers. */
6092 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6094 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6095 SYMBOL's name of the end of the modifiers; the string from this
6096 position is the unmodified symbol name.
6098 This doesn't use any caches. */
6101 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6107 CHECK_SYMBOL (symbol
);
6110 name
= SYMBOL_NAME (symbol
);
6112 for (i
= 0; i
< SBYTES (name
) - 1; )
6114 ptrdiff_t this_mod_end
= 0;
6117 /* See if the name continues with a modifier word.
6118 Check that the word appears, but don't check what follows it.
6119 Set this_mod and this_mod_end to record what we find. */
6121 switch (SREF (name
, i
))
6123 #define SINGLE_LETTER_MOD(BIT) \
6124 (this_mod_end = i + 1, this_mod = BIT)
6127 SINGLE_LETTER_MOD (alt_modifier
);
6131 SINGLE_LETTER_MOD (ctrl_modifier
);
6135 SINGLE_LETTER_MOD (hyper_modifier
);
6139 SINGLE_LETTER_MOD (meta_modifier
);
6143 SINGLE_LETTER_MOD (shift_modifier
);
6147 SINGLE_LETTER_MOD (super_modifier
);
6150 #undef SINGLE_LETTER_MOD
6152 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6153 if (i + LEN + 1 <= SBYTES (name) \
6154 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6156 this_mod_end = i + LEN; \
6161 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6162 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6163 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6167 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6169 #undef MULTI_LETTER_MOD
6173 /* If we found no modifier, stop looking for them. */
6174 if (this_mod_end
== 0)
6177 /* Check there is a dash after the modifier, so that it
6178 really is a modifier. */
6179 if (this_mod_end
>= SBYTES (name
)
6180 || SREF (name
, this_mod_end
) != '-')
6183 /* This modifier is real; look for another. */
6184 modifiers
|= this_mod
;
6185 i
= this_mod_end
+ 1;
6188 /* Should we include the `click' modifier? */
6189 if (! (modifiers
& (down_modifier
| drag_modifier
6190 | double_modifier
| triple_modifier
))
6191 && i
+ 7 == SBYTES (name
)
6192 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6193 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6194 modifiers
|= click_modifier
;
6196 if (! (modifiers
& (double_modifier
| triple_modifier
))
6197 && i
+ 6 < SBYTES (name
)
6198 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6199 modifiers
|= click_modifier
;
6207 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6208 prepended to the string BASE[0..BASE_LEN-1].
6209 This doesn't use any caches. */
6211 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6213 /* Since BASE could contain nulls, we can't use intern here; we have
6214 to use Fintern, which expects a genuine Lisp_String, and keeps a
6216 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6222 /* Only the event queue may use the `up' modifier; it should always
6223 be turned into a click or drag event before presented to lisp code. */
6224 if (modifiers
& up_modifier
)
6227 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6228 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6229 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6230 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6231 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6232 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6233 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6234 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6235 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6236 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6237 /* The click modifier is denoted by the absence of other modifiers. */
6241 mod_len
= p
- new_mods
;
6245 Lisp_Object new_name
;
6247 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6248 mod_len
+ base_len_byte
);
6249 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6250 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6252 return Fintern (new_name
, Qnil
);
6257 static const char *const modifier_names
[] =
6259 "up", "down", "drag", "click", "double", "triple", 0, 0,
6260 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6261 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6263 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6265 static Lisp_Object modifier_symbols
;
6267 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6269 lispy_modifier_list (int modifiers
)
6271 Lisp_Object modifier_list
;
6274 modifier_list
= Qnil
;
6275 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6276 if (modifiers
& (1<<i
))
6277 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6280 return modifier_list
;
6284 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6285 where UNMODIFIED is the unmodified form of SYMBOL,
6286 MASK is the set of modifiers present in SYMBOL's name.
6287 This is similar to parse_modifiers_uncached, but uses the cache in
6288 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6289 Qevent_symbol_elements property. */
6291 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6294 parse_modifiers (Lisp_Object symbol
)
6296 Lisp_Object elements
;
6298 if (INTEGERP (symbol
))
6299 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6300 else if (!SYMBOLP (symbol
))
6303 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6304 if (CONSP (elements
))
6309 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6310 Lisp_Object unmodified
;
6313 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6314 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6317 if (modifiers
& ~INTMASK
)
6319 XSETFASTINT (mask
, modifiers
);
6320 elements
= list2 (unmodified
, mask
);
6322 /* Cache the parsing results on SYMBOL. */
6323 Fput (symbol
, Qevent_symbol_element_mask
,
6325 Fput (symbol
, Qevent_symbol_elements
,
6326 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6328 /* Since we know that SYMBOL is modifiers applied to unmodified,
6329 it would be nice to put that in unmodified's cache.
6330 But we can't, since we're not sure that parse_modifiers is
6337 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6338 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6339 doc
: /* Parse the event symbol. For internal use. */)
6340 (Lisp_Object symbol
)
6342 /* Fill the cache if needed. */
6343 parse_modifiers (symbol
);
6344 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6345 and use the Lispier representation stored on Qevent_symbol_elements
6347 return Fget (symbol
, Qevent_symbol_elements
);
6350 /* Apply the modifiers MODIFIERS to the symbol BASE.
6351 BASE must be unmodified.
6353 This is like apply_modifiers_uncached, but uses BASE's
6354 Qmodifier_cache property, if present. It also builds
6355 Qevent_symbol_elements properties, since it has that info anyway.
6357 apply_modifiers copies the value of BASE's Qevent_kind property to
6358 the modified symbol. */
6360 apply_modifiers (int modifiers
, Lisp_Object base
)
6362 Lisp_Object cache
, idx
, entry
, new_symbol
;
6364 /* Mask out upper bits. We don't know where this value's been. */
6365 modifiers
&= INTMASK
;
6367 if (INTEGERP (base
))
6368 return make_number (XINT (base
) | modifiers
);
6370 /* The click modifier never figures into cache indices. */
6371 cache
= Fget (base
, Qmodifier_cache
);
6372 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6373 entry
= assq_no_quit (idx
, cache
);
6376 new_symbol
= XCDR (entry
);
6379 /* We have to create the symbol ourselves. */
6380 new_symbol
= apply_modifiers_uncached (modifiers
,
6381 SSDATA (SYMBOL_NAME (base
)),
6382 SCHARS (SYMBOL_NAME (base
)),
6383 SBYTES (SYMBOL_NAME (base
)));
6385 /* Add the new symbol to the base's cache. */
6386 entry
= Fcons (idx
, new_symbol
);
6387 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6389 /* We have the parsing info now for free, so we could add it to
6391 XSETFASTINT (idx, modifiers);
6392 Fput (new_symbol, Qevent_symbol_element_mask,
6394 Fput (new_symbol, Qevent_symbol_elements,
6395 Fcons (base, lispy_modifier_list (modifiers)));
6396 Sadly, this is only correct if `base' is indeed a base event,
6397 which is not necessarily the case. -stef */
6400 /* Make sure this symbol is of the same kind as BASE.
6402 You'd think we could just set this once and for all when we
6403 intern the symbol above, but reorder_modifiers may call us when
6404 BASE's property isn't set right; we can't assume that just
6405 because it has a Qmodifier_cache property it must have its
6406 Qevent_kind set right as well. */
6407 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6411 kind
= Fget (base
, Qevent_kind
);
6413 Fput (new_symbol
, Qevent_kind
, kind
);
6420 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6421 return a symbol with the modifiers placed in the canonical order.
6422 Canonical order is alphabetical, except for down and drag, which
6423 always come last. The 'click' modifier is never written out.
6425 Fdefine_key calls this to make sure that (for example) C-M-foo
6426 and M-C-foo end up being equivalent in the keymap. */
6429 reorder_modifiers (Lisp_Object symbol
)
6431 /* It's hopefully okay to write the code this way, since everything
6432 will soon be in caches, and no consing will be done at all. */
6435 parsed
= parse_modifiers (symbol
);
6436 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6441 /* For handling events, we often want to produce a symbol whose name
6442 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6443 to some base, like the name of a function key or mouse button.
6444 modify_event_symbol produces symbols of this sort.
6446 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6447 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6450 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6451 into symbol names, or a string specifying a name stem used to
6452 construct a symbol name or the form `STEM-N', where N is the decimal
6453 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6454 non-nil; otherwise NAME_TABLE is used.
6456 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6457 persist between calls to modify_event_symbol that it can use to
6458 store a cache of the symbols it's generated for this NAME_TABLE
6459 before. The object stored there may be a vector or an alist.
6461 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6463 MODIFIERS is a set of modifier bits (as given in struct input_events)
6464 whose prefixes should be applied to the symbol name.
6466 SYMBOL_KIND is the value to be placed in the event_kind property of
6467 the returned symbol.
6469 The symbols we create are supposed to have an
6470 `event-symbol-elements' property, which lists the modifiers present
6471 in the symbol's name. */
6474 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6475 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6476 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6479 Lisp_Object symbol_int
;
6481 /* Get rid of the "vendor-specific" bit here. */
6482 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6484 /* Is this a request for a valid symbol? */
6485 if (symbol_num
< 0 || symbol_num
>= table_size
)
6488 if (CONSP (*symbol_table
))
6489 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6491 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6492 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6493 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6494 we've never used that symbol before. */
6497 if (! VECTORP (*symbol_table
)
6498 || ASIZE (*symbol_table
) != table_size
)
6502 XSETFASTINT (size
, table_size
);
6503 *symbol_table
= Fmake_vector (size
, Qnil
);
6506 value
= AREF (*symbol_table
, symbol_num
);
6509 /* Have we already used this symbol before? */
6512 /* No; let's create it. */
6513 if (CONSP (name_alist_or_stem
))
6514 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6515 else if (STRINGP (name_alist_or_stem
))
6518 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6519 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6521 buf
= SAFE_ALLOCA (len
);
6522 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6523 XINT (symbol_int
) + 1);
6524 value
= intern (buf
);
6527 else if (name_table
!= 0 && name_table
[symbol_num
])
6528 value
= intern (name_table
[symbol_num
]);
6530 #ifdef HAVE_WINDOW_SYSTEM
6533 char *name
= x_get_keysym_name (symbol_num
);
6535 value
= intern (name
);
6541 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6542 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6543 value
= intern (buf
);
6546 if (CONSP (*symbol_table
))
6547 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6549 ASET (*symbol_table
, symbol_num
, value
);
6551 /* Fill in the cache entries for this symbol; this also
6552 builds the Qevent_symbol_elements property, which the user
6554 apply_modifiers (modifiers
& click_modifier
, value
);
6555 Fput (value
, Qevent_kind
, symbol_kind
);
6558 /* Apply modifiers to that symbol. */
6559 return apply_modifiers (modifiers
, value
);
6562 /* Convert a list that represents an event type,
6563 such as (ctrl meta backspace), into the usual representation of that
6564 event type as a number or a symbol. */
6566 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6567 doc
: /* Convert the event description list EVENT-DESC to an event type.
6568 EVENT-DESC should contain one base event type (a character or symbol)
6569 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6570 drag, down, double or triple). The base must be last.
6571 The return value is an event type (a character or symbol) which
6572 has the same base event type and all the specified modifiers. */)
6573 (Lisp_Object event_desc
)
6581 while (CONSP (rest
))
6589 /* Given a symbol, see if it is a modifier name. */
6590 if (SYMBOLP (elt
) && CONSP (rest
))
6591 this = parse_solitary_modifier (elt
);
6595 else if (!NILP (base
))
6596 error ("Two bases given in one event");
6602 /* Let the symbol A refer to the character A. */
6603 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6604 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6606 if (INTEGERP (base
))
6608 /* Turn (shift a) into A. */
6609 if ((modifiers
& shift_modifier
) != 0
6610 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6612 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6613 modifiers
&= ~shift_modifier
;
6616 /* Turn (control a) into C-a. */
6617 if (modifiers
& ctrl_modifier
)
6618 return make_number ((modifiers
& ~ctrl_modifier
)
6619 | make_ctrl_char (XINT (base
)));
6621 return make_number (modifiers
| XINT (base
));
6623 else if (SYMBOLP (base
))
6624 return apply_modifiers (modifiers
, base
);
6626 error ("Invalid base event");
6629 /* Try to recognize SYMBOL as a modifier name.
6630 Return the modifier flag bit, or 0 if not recognized. */
6633 parse_solitary_modifier (Lisp_Object symbol
)
6635 Lisp_Object name
= SYMBOL_NAME (symbol
);
6637 switch (SREF (name
, 0))
6639 #define SINGLE_LETTER_MOD(BIT) \
6640 if (SBYTES (name) == 1) \
6643 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6644 if (LEN == SBYTES (name) \
6645 && ! memcmp (SDATA (name), NAME, LEN)) \
6649 SINGLE_LETTER_MOD (alt_modifier
);
6653 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6657 SINGLE_LETTER_MOD (ctrl_modifier
);
6661 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6662 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6666 SINGLE_LETTER_MOD (hyper_modifier
);
6670 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6674 SINGLE_LETTER_MOD (meta_modifier
);
6678 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6682 SINGLE_LETTER_MOD (shift_modifier
);
6686 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6687 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6688 SINGLE_LETTER_MOD (super_modifier
);
6692 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6693 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6694 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6698 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6701 #undef SINGLE_LETTER_MOD
6702 #undef MULTI_LETTER_MOD
6708 /* Return true if EVENT is a list whose elements are all integers or symbols.
6709 Such a list is not valid as an event,
6710 but it can be a Lucid-style event type list. */
6713 lucid_event_type_list_p (Lisp_Object object
)
6717 if (! CONSP (object
))
6720 if (EQ (XCAR (object
), Qhelp_echo
)
6721 || EQ (XCAR (object
), Qvertical_line
)
6722 || EQ (XCAR (object
), Qmode_line
)
6723 || EQ (XCAR (object
), Qheader_line
))
6726 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6730 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6737 /* Return true if terminal input chars are available.
6738 Also, store the return value into INPUT_PENDING.
6740 Serves the purpose of ioctl (0, FIONREAD, ...)
6741 but works even if FIONREAD does not exist.
6742 (In fact, this may actually read some input.)
6744 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6745 timer events that are ripe.
6746 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6747 events (FOCUS_IN_EVENT).
6748 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6749 movements and toolkit scroll bar thumb drags. */
6752 get_input_pending (int flags
)
6754 /* First of all, have we already counted some input? */
6755 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6757 /* If input is being read as it arrives, and we have none, there is none. */
6758 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6760 /* Try to read some input and see how much we get. */
6762 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6765 return input_pending
;
6768 /* Put a BUFFER_SWITCH_EVENT in the buffer
6769 so that read_key_sequence will notice the new current buffer. */
6772 record_asynch_buffer_change (void)
6774 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6775 The purpose of the event is to make read_key_sequence look up the
6776 keymaps again. If we aren't in read_key_sequence, we don't need one,
6777 and the event could cause trouble by messing up (input-pending-p).
6778 Note: Fwaiting_for_user_input_p always returns nil when async
6779 subprocesses aren't supported. */
6780 if (!NILP (Fwaiting_for_user_input_p ()))
6782 struct input_event event
;
6785 event
.kind
= BUFFER_SWITCH_EVENT
;
6786 event
.frame_or_window
= Qnil
;
6789 /* Make sure no interrupt happens while storing the event. */
6791 if (interrupt_input
)
6792 kbd_buffer_store_event (&event
);
6797 kbd_buffer_store_event (&event
);
6803 /* Read any terminal input already buffered up by the system
6804 into the kbd_buffer, but do not wait.
6806 Return the number of keyboard chars read, or -1 meaning
6807 this is a bad time to try to read input. */
6816 /* Store pending user signal events, if any. */
6817 store_user_signal_events ();
6819 /* Loop through the available terminals, and call their input hooks. */
6823 struct terminal
*next
= t
->next_terminal
;
6825 if (t
->read_socket_hook
)
6828 struct input_event hold_quit
;
6830 if (input_blocked_p ())
6832 pending_signals
= 1;
6836 EVENT_INIT (hold_quit
);
6837 hold_quit
.kind
= NO_EVENT
;
6839 /* No need for FIONREAD or fcntl; just say don't wait. */
6840 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6843 if (nr
== -1) /* Not OK to read input now. */
6847 else if (nr
== -2) /* Non-transient error. */
6849 /* The terminal device terminated; it should be closed. */
6851 /* Kill Emacs if this was our last terminal. */
6852 if (!terminal_list
->next_terminal
)
6853 /* Formerly simply reported no input, but that
6854 sometimes led to a failure of Emacs to terminate.
6855 SIGHUP seems appropriate if we can't reach the
6857 /* ??? Is it really right to send the signal just to
6858 this process rather than to the whole process
6859 group? Perhaps on systems with FIONREAD Emacs is
6860 alone in its group. */
6861 terminate_due_to_signal (SIGHUP
, 10);
6863 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6866 XSETTERMINAL (tmp
, t
);
6867 Fdelete_terminal (tmp
, Qnoelisp
);
6871 if (hold_quit
.kind
!= NO_EVENT
)
6872 kbd_buffer_store_event (&hold_quit
);
6881 frame_make_pointer_visible ();
6886 /* This is the tty way of reading available input.
6888 Note that each terminal device has its own `struct terminal' object,
6889 and so this function is called once for each individual termcap
6890 terminal. The first parameter indicates which terminal to read from. */
6893 tty_read_avail_input (struct terminal
*terminal
,
6894 struct input_event
*hold_quit
)
6896 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6897 the kbd_buffer can really hold. That may prevent loss
6898 of characters on some systems when input is stuffed at us. */
6899 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6901 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6904 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6906 if (kbd_on_hold_p () || buffer_free
<= 0)
6908 #endif /* subprocesses */
6910 if (!terminal
->name
) /* Don't read from a dead terminal. */
6913 if (terminal
->type
!= output_termcap
6914 && terminal
->type
!= output_msdos_raw
)
6917 /* XXX I think the following code should be moved to separate hook
6918 functions in system-dependent files. */
6920 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6921 code sets read_socket_hook to w32_console_read_socket instead! */
6923 #else /* not WINDOWSNT */
6924 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6928 return 0; /* The terminal is suspended. */
6931 n_to_read
= dos_keysns ();
6935 cbuf
[0] = dos_keyread ();
6938 #else /* not MSDOS */
6943 struct input_event gpm_hold_quit
;
6944 int gpm
, fd
= gpm_fd
;
6946 EVENT_INIT (gpm_hold_quit
);
6947 gpm_hold_quit
.kind
= NO_EVENT
;
6949 /* gpm==1 if event received.
6950 gpm==0 if the GPM daemon has closed the connection, in which case
6951 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6952 we save it in `fd' so close_gpm can remove it from the
6954 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6955 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6956 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6959 /* Presumably the GPM daemon has closed the connection. */
6961 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6962 kbd_buffer_store_event (&gpm_hold_quit
);
6966 #endif /* HAVE_GPM */
6968 /* Determine how many characters we should *try* to read. */
6969 #ifdef USABLE_FIONREAD
6970 /* Find out how much input is available. */
6971 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6973 if (! noninteractive
)
6974 return -2; /* Close this terminal. */
6980 if (n_to_read
> sizeof cbuf
)
6981 n_to_read
= sizeof cbuf
;
6982 #elif defined USG || defined CYGWIN
6983 /* Read some input if available, but don't wait. */
6984 n_to_read
= sizeof cbuf
;
6985 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6987 # error "Cannot read without possibly delaying"
6991 /* Don't read more than we can store. */
6992 if (n_to_read
> buffer_free
)
6993 n_to_read
= buffer_free
;
6994 #endif /* subprocesses */
6996 /* Now read; for one reason or another, this will not block.
6997 NREAD is set to the number of chars read. */
7000 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7001 /* POSIX infers that processes which are not in the session leader's
7002 process group won't get SIGHUPs at logout time. BSDI adheres to
7003 this part standard and returns -1 from read (0) with errno==EIO
7004 when the control tty is taken away.
7005 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7006 if (nread
== -1 && errno
== EIO
)
7007 return -2; /* Close this terminal. */
7008 #if defined (AIX) && defined (_BSD)
7009 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7010 This looks incorrect, but it isn't, because _BSD causes
7011 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7012 and that causes a value other than 0 when there is no input. */
7014 return -2; /* Close this terminal. */
7018 /* We used to retry the read if it was interrupted.
7019 But this does the wrong thing when O_NONBLOCK causes
7020 an EAGAIN error. Does anybody know of a situation
7021 where a retry is actually needed? */
7023 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7033 #ifndef USABLE_FIONREAD
7034 #if defined (USG) || defined (CYGWIN)
7035 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7036 #endif /* USG or CYGWIN */
7037 #endif /* no FIONREAD */
7042 #endif /* not MSDOS */
7043 #endif /* not WINDOWSNT */
7045 for (i
= 0; i
< nread
; i
++)
7047 struct input_event buf
;
7049 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7051 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7052 buf
.modifiers
= meta_modifier
;
7053 if (tty
->meta_key
!= 2)
7057 /* Set the frame corresponding to the active tty. Note that the
7058 value of selected_frame is not reliable here, redisplay tends
7059 to temporarily change it. */
7060 buf
.frame_or_window
= tty
->top_frame
;
7063 kbd_buffer_store_event (&buf
);
7064 /* Don't look at input that follows a C-g too closely.
7065 This reduces lossage due to autorepeat on C-g. */
7066 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7067 && buf
.code
== quit_char
)
7075 handle_async_input (void)
7080 int nread
= gobble_input ();
7081 /* -1 means it's not ok to read the input now.
7082 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7083 0 means there was no keyboard input available. */
7091 process_pending_signals (void)
7093 pending_signals
= 0;
7094 handle_async_input ();
7095 do_pending_atimers ();
7098 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7099 and also (if the level is now 0) reinvoke any pending signal. */
7102 unblock_input_to (int level
)
7104 interrupt_input_blocked
= level
;
7107 if (pending_signals
)
7108 process_pending_signals ();
7114 /* End critical section.
7116 If doing signal-driven input, and a signal came in when input was
7117 blocked, reinvoke the signal handler now to deal with it. */
7120 unblock_input (void)
7122 unblock_input_to (interrupt_input_blocked
- 1);
7125 /* Undo any number of BLOCK_INPUT calls,
7126 and also reinvoke any pending signal. */
7129 totally_unblock_input (void)
7131 unblock_input_to (0);
7137 handle_input_available_signal (int sig
)
7139 pending_signals
= 1;
7141 if (input_available_clear_time
)
7142 *input_available_clear_time
= make_timespec (0, 0);
7146 deliver_input_available_signal (int sig
)
7148 deliver_process_signal (sig
, handle_input_available_signal
);
7150 #endif /* USABLE_SIGIO */
7153 /* User signal events. */
7155 struct user_signal_info
7157 /* Signal number. */
7160 /* Name of the signal. */
7163 /* Number of pending signals. */
7166 struct user_signal_info
*next
;
7169 /* List of user signals. */
7170 static struct user_signal_info
*user_signals
= NULL
;
7173 add_user_signal (int sig
, const char *name
)
7175 struct sigaction action
;
7176 struct user_signal_info
*p
;
7178 for (p
= user_signals
; p
; p
= p
->next
)
7180 /* Already added. */
7183 p
= xmalloc (sizeof *p
);
7185 p
->name
= xstrdup (name
);
7187 p
->next
= user_signals
;
7190 emacs_sigaction_init (&action
, deliver_user_signal
);
7191 sigaction (sig
, &action
, 0);
7195 handle_user_signal (int sig
)
7197 struct user_signal_info
*p
;
7198 const char *special_event_name
= NULL
;
7200 if (SYMBOLP (Vdebug_on_event
))
7201 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7203 for (p
= user_signals
; p
; p
= p
->next
)
7206 if (special_event_name
7207 && strcmp (special_event_name
, p
->name
) == 0)
7209 /* Enter the debugger in many ways. */
7210 debug_on_next_call
= 1;
7213 Vinhibit_quit
= Qnil
;
7215 /* Eat the event. */
7221 if (interrupt_input
)
7222 handle_input_available_signal (sig
);
7226 /* Tell wait_reading_process_output that it needs to wake
7227 up and look around. */
7228 if (input_available_clear_time
)
7229 *input_available_clear_time
= make_timespec (0, 0);
7236 deliver_user_signal (int sig
)
7238 deliver_process_signal (sig
, handle_user_signal
);
7242 find_user_signal_name (int sig
)
7244 struct user_signal_info
*p
;
7246 for (p
= user_signals
; p
; p
= p
->next
)
7254 store_user_signal_events (void)
7256 struct user_signal_info
*p
;
7257 struct input_event buf
;
7258 bool buf_initialized
= 0;
7260 for (p
= user_signals
; p
; p
= p
->next
)
7261 if (p
->npending
> 0)
7263 if (! buf_initialized
)
7265 memset (&buf
, 0, sizeof buf
);
7266 buf
.kind
= USER_SIGNAL_EVENT
;
7267 buf
.frame_or_window
= selected_frame
;
7268 buf_initialized
= 1;
7274 kbd_buffer_store_event (&buf
);
7277 while (p
->npending
> 0);
7282 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7283 static Lisp_Object menu_bar_one_keymap_changed_items
;
7285 /* These variables hold the vector under construction within
7286 menu_bar_items and its subroutines, and the current index
7287 for storing into that vector. */
7288 static Lisp_Object menu_bar_items_vector
;
7289 static int menu_bar_items_index
;
7292 static const char* separator_names
[] = {
7297 "single-dashed-line",
7298 "double-dashed-line",
7300 "shadow-etched-out",
7301 "shadow-etched-in-dash",
7302 "shadow-etched-out-dash",
7303 "shadow-double-etched-in",
7304 "shadow-double-etched-out",
7305 "shadow-double-etched-in-dash",
7306 "shadow-double-etched-out-dash",
7310 /* Return true if LABEL specifies a separator. */
7313 menu_separator_name_p (const char *label
)
7317 else if (strlen (label
) > 3
7318 && memcmp (label
, "--", 2) == 0
7323 for (i
= 0; separator_names
[i
]; ++i
)
7324 if (strcmp (label
, separator_names
[i
]) == 0)
7329 /* It's a separator if it contains only dashes. */
7330 while (*label
== '-')
7332 return (*label
== 0);
7339 /* Return a vector of menu items for a menu bar, appropriate
7340 to the current buffer. Each item has three elements in the vector:
7343 OLD is an old vector we can optionally reuse, or nil. */
7346 menu_bar_items (Lisp_Object old
)
7348 /* The number of keymaps we're scanning right now, and the number of
7349 keymaps we have allocated space for. */
7352 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7353 in the current keymaps, or nil where it is not a prefix. */
7356 Lisp_Object def
, tail
;
7361 /* In order to build the menus, we need to call the keymap
7362 accessors. They all call QUIT. But this function is called
7363 during redisplay, during which a quit is fatal. So inhibit
7364 quitting while building the menus.
7365 We do this instead of specbind because (1) errors will clear it anyway
7366 and (2) this avoids risk of specpdl overflow. */
7367 oquit
= Vinhibit_quit
;
7371 menu_bar_items_vector
= old
;
7373 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7374 menu_bar_items_index
= 0;
7376 /* Build our list of keymaps.
7377 If we recognize a function key and replace its escape sequence in
7378 keybuf with its symbol, or if the sequence starts with a mouse
7379 click and we need to switch buffers, we jump back here to rebuild
7380 the initial keymaps from the current buffer. */
7384 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7385 if (!NILP (Voverriding_local_map_menu_flag
)
7386 && !NILP (Voverriding_local_map
))
7388 /* Yes, use them (if non-nil) as well as the global map. */
7389 maps
= alloca (3 * sizeof (maps
[0]));
7391 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7392 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7393 if (!NILP (Voverriding_local_map
))
7394 maps
[nmaps
++] = Voverriding_local_map
;
7398 /* No, so use major and minor mode keymaps and keymap property.
7399 Note that menu-bar bindings in the local-map and keymap
7400 properties may not work reliable, as they are only
7401 recognized when the menu-bar (or mode-line) is updated,
7402 which does not normally happen after every command. */
7405 nminor
= current_minor_maps (NULL
, &tmaps
);
7406 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7408 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7409 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7410 maps
[nmaps
++] = tem
;
7411 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7412 maps
[nmaps
++] = tem
;
7413 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7415 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7417 maps
[nmaps
++] = current_global_map
;
7420 /* Look up in each map the dummy prefix key `menu-bar'. */
7422 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7423 if (!NILP (maps
[mapno
]))
7425 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7429 menu_bar_one_keymap_changed_items
= Qnil
;
7430 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7434 /* Move to the end those items that should be at the end. */
7436 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7439 int end
= menu_bar_items_index
;
7441 for (i
= 0; i
< end
; i
+= 4)
7442 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7444 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7445 /* Move the item at index I to the end,
7446 shifting all the others forward. */
7447 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7448 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7449 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7450 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7452 memmove (aref_addr (menu_bar_items_vector
, i
),
7453 aref_addr (menu_bar_items_vector
, i
+ 4),
7454 (end
- i
- 4) * word_size
);
7455 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7456 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7457 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7458 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7463 /* Add nil, nil, nil, nil at the end. */
7465 int i
= menu_bar_items_index
;
7466 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7467 menu_bar_items_vector
=
7468 larger_vector (menu_bar_items_vector
, 4, -1);
7469 /* Add this item. */
7470 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7471 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7472 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7473 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7474 menu_bar_items_index
= i
;
7477 Vinhibit_quit
= oquit
;
7478 return menu_bar_items_vector
;
7481 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7482 If there's already an item for KEY, add this DEF to it. */
7484 Lisp_Object item_properties
;
7487 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7489 struct gcpro gcpro1
;
7494 if (EQ (item
, Qundefined
))
7496 /* If a map has an explicit `undefined' as definition,
7497 discard any previously made menu bar item. */
7499 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7500 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7502 if (menu_bar_items_index
> i
+ 4)
7503 memmove (aref_addr (menu_bar_items_vector
, i
),
7504 aref_addr (menu_bar_items_vector
, i
+ 4),
7505 (menu_bar_items_index
- i
- 4) * word_size
);
7506 menu_bar_items_index
-= 4;
7510 /* If this keymap has already contributed to this KEY,
7511 don't contribute to it a second time. */
7512 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7513 if (!NILP (tem
) || NILP (item
))
7516 menu_bar_one_keymap_changed_items
7517 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7519 /* We add to menu_bar_one_keymap_changed_items before doing the
7520 parse_menu_item, so that if it turns out it wasn't a menu item,
7521 it still correctly hides any further menu item. */
7523 parsed
= parse_menu_item (item
, 1);
7528 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7530 /* Find any existing item for this KEY. */
7531 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7532 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7535 /* If we did not find this KEY, add it at the end. */
7536 if (i
== menu_bar_items_index
)
7538 /* If vector is too small, get a bigger one. */
7539 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7540 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7541 /* Add this item. */
7542 ASET (menu_bar_items_vector
, i
, key
); i
++;
7543 ASET (menu_bar_items_vector
, i
,
7544 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7545 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7546 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7547 menu_bar_items_index
= i
;
7549 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7553 old
= AREF (menu_bar_items_vector
, i
+ 2);
7554 /* If the new and the old items are not both keymaps,
7555 the lookup will only find `item'. */
7556 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7557 ASET (menu_bar_items_vector
, i
+ 2, item
);
7561 /* This is used as the handler when calling menu_item_eval_property. */
7563 menu_item_eval_property_1 (Lisp_Object arg
)
7565 /* If we got a quit from within the menu computation,
7566 quit all the way out of it. This takes care of C-] in the debugger. */
7567 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7568 Fsignal (Qquit
, Qnil
);
7574 eval_dyn (Lisp_Object form
)
7576 return Feval (form
, Qnil
);
7579 /* Evaluate an expression and return the result (or nil if something
7580 went wrong). Used to evaluate dynamic parts of menu items. */
7582 menu_item_eval_property (Lisp_Object sexpr
)
7584 ptrdiff_t count
= SPECPDL_INDEX ();
7586 specbind (Qinhibit_redisplay
, Qt
);
7587 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7588 menu_item_eval_property_1
);
7589 return unbind_to (count
, val
);
7592 /* This function parses a menu item and leaves the result in the
7593 vector item_properties.
7594 ITEM is a key binding, a possible menu item.
7595 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7597 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7598 parse_menu_item returns true if the item is a menu item and false
7602 parse_menu_item (Lisp_Object item
, int inmenubar
)
7604 Lisp_Object def
, tem
, item_string
, start
;
7606 Lisp_Object keyhint
;
7615 /* Create item_properties vector if necessary. */
7616 if (NILP (item_properties
))
7618 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7620 /* Initialize optional entries. */
7621 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7622 ASET (item_properties
, i
, Qnil
);
7623 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7625 /* Save the item here to protect it from GC. */
7626 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7628 item_string
= XCAR (item
);
7632 if (STRINGP (item_string
))
7634 /* Old format menu item. */
7635 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7637 /* Maybe help string. */
7638 if (CONSP (item
) && STRINGP (XCAR (item
)))
7640 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7645 /* Maybe an obsolete key binding cache. */
7646 if (CONSP (item
) && CONSP (XCAR (item
))
7647 && (NILP (XCAR (XCAR (item
)))
7648 || VECTORP (XCAR (XCAR (item
)))))
7651 /* This is the real definition--the function to run. */
7652 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7654 /* Get enable property, if any. */
7657 tem
= Fget (item
, Qmenu_enable
);
7658 if (!NILP (Venable_disabled_menus_and_buttons
))
7659 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7660 else if (!NILP (tem
))
7661 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7664 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7666 /* New format menu item. */
7667 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7668 start
= XCDR (item
);
7671 /* We have a real binding. */
7672 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7674 item
= XCDR (start
);
7675 /* Is there an obsolete cache list with key equivalences. */
7676 if (CONSP (item
) && CONSP (XCAR (item
)))
7679 /* Parse properties. */
7680 while (CONSP (item
) && CONSP (XCDR (item
)))
7685 if (EQ (tem
, QCenable
))
7687 if (!NILP (Venable_disabled_menus_and_buttons
))
7688 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7690 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7692 else if (EQ (tem
, QCvisible
))
7694 /* If got a visible property and that evaluates to nil
7695 then ignore this item. */
7696 tem
= menu_item_eval_property (XCAR (item
));
7700 else if (EQ (tem
, QChelp
))
7701 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7702 else if (EQ (tem
, QCfilter
))
7704 else if (EQ (tem
, QCkey_sequence
))
7707 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7708 /* Be GC protected. Set keyhint to item instead of tem. */
7711 else if (EQ (tem
, QCkeys
))
7714 if (CONSP (tem
) || STRINGP (tem
))
7715 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7717 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7722 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7724 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7726 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7732 else if (inmenubar
|| !NILP (start
))
7736 return 0; /* not a menu item */
7738 /* If item string is not a string, evaluate it to get string.
7739 If we don't get a string, skip this item. */
7740 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7741 if (!(STRINGP (item_string
)))
7743 item_string
= menu_item_eval_property (item_string
);
7744 if (!STRINGP (item_string
))
7746 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7749 /* If got a filter apply it on definition. */
7750 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7753 def
= menu_item_eval_property (list2 (XCAR (filter
),
7754 list2 (Qquote
, def
)));
7756 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7759 /* Enable or disable selection of item. */
7760 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7763 tem
= menu_item_eval_property (tem
);
7764 if (inmenubar
&& NILP (tem
))
7765 return 0; /* Ignore disabled items in menu bar. */
7766 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7769 /* If we got no definition, this item is just unselectable text which
7770 is OK in a submenu but not in the menubar. */
7772 return (!inmenubar
);
7774 /* See if this is a separate pane or a submenu. */
7775 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7776 tem
= get_keymap (def
, 0, 1);
7777 /* For a subkeymap, just record its details and exit. */
7780 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7781 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7785 /* At the top level in the menu bar, do likewise for commands also.
7786 The menu bar does not display equivalent key bindings anyway.
7787 ITEM_PROPERTY_DEF is already set up properly. */
7791 { /* This is a command. See if there is an equivalent key binding. */
7792 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7794 /* The previous code preferred :key-sequence to :keys, so we
7795 preserve this behavior. */
7796 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7797 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7800 Lisp_Object prefix
= keyeq
;
7801 Lisp_Object keys
= Qnil
;
7805 def
= XCAR (prefix
);
7806 prefix
= XCDR (prefix
);
7809 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7811 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7813 keys
= XCAR (keyhint
);
7814 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7816 /* We have a suggested key. Is it bound to the command? */
7819 /* If the command is an alias for another
7820 (such as lmenu.el set it up), check if the
7821 original command matches the cached command. */
7823 && EQ (tem
, XSYMBOL (def
)->function
))))
7828 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7832 tem
= Fkey_description (keys
, Qnil
);
7835 if (STRINGP (XCAR (prefix
)))
7836 tem
= concat2 (XCAR (prefix
), tem
);
7837 if (STRINGP (XCDR (prefix
)))
7838 tem
= concat2 (tem
, XCDR (prefix
));
7840 keyeq
= concat2 (build_string (" "), tem
);
7841 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7847 /* If we have an equivalent key binding, use that. */
7848 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7851 /* Include this when menu help is implemented.
7852 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7853 if (!(NILP (tem) || STRINGP (tem)))
7855 tem = menu_item_eval_property (tem);
7858 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7862 /* Handle radio buttons or toggle boxes. */
7863 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7865 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7866 menu_item_eval_property (tem
));
7873 /***********************************************************************
7875 ***********************************************************************/
7877 /* A vector holding tool bar items while they are parsed in function
7878 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7881 static Lisp_Object tool_bar_items_vector
;
7883 /* A vector holding the result of parse_tool_bar_item. Layout is like
7884 the one for a single item in tool_bar_items_vector. */
7886 static Lisp_Object tool_bar_item_properties
;
7888 /* Next free index in tool_bar_items_vector. */
7890 static int ntool_bar_items
;
7892 /* The symbols `:image' and `:rtl'. */
7894 static Lisp_Object QCimage
;
7895 static Lisp_Object QCrtl
;
7897 /* Function prototypes. */
7899 static void init_tool_bar_items (Lisp_Object
);
7900 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7901 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7902 static void append_tool_bar_item (void);
7905 /* Return a vector of tool bar items for keymaps currently in effect.
7906 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7907 tool bar items found. */
7910 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7919 /* In order to build the menus, we need to call the keymap
7920 accessors. They all call QUIT. But this function is called
7921 during redisplay, during which a quit is fatal. So inhibit
7922 quitting while building the menus. We do this instead of
7923 specbind because (1) errors will clear it anyway and (2) this
7924 avoids risk of specpdl overflow. */
7925 oquit
= Vinhibit_quit
;
7928 /* Initialize tool_bar_items_vector and protect it from GC. */
7929 init_tool_bar_items (reuse
);
7931 /* Build list of keymaps in maps. Set nmaps to the number of maps
7934 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7935 if (!NILP (Voverriding_local_map_menu_flag
)
7936 && !NILP (Voverriding_local_map
))
7938 /* Yes, use them (if non-nil) as well as the global map. */
7939 maps
= alloca (3 * sizeof *maps
);
7941 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7942 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7943 if (!NILP (Voverriding_local_map
))
7944 maps
[nmaps
++] = Voverriding_local_map
;
7948 /* No, so use major and minor mode keymaps and keymap property.
7949 Note that tool-bar bindings in the local-map and keymap
7950 properties may not work reliable, as they are only
7951 recognized when the tool-bar (or mode-line) is updated,
7952 which does not normally happen after every command. */
7955 nminor
= current_minor_maps (NULL
, &tmaps
);
7956 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7958 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7959 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7960 maps
[nmaps
++] = tem
;
7961 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7962 maps
[nmaps
++] = tem
;
7963 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7965 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7968 /* Add global keymap at the end. */
7969 maps
[nmaps
++] = current_global_map
;
7971 /* Process maps in reverse order and look up in each map the prefix
7973 for (i
= nmaps
- 1; i
>= 0; --i
)
7974 if (!NILP (maps
[i
]))
7978 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7980 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7983 Vinhibit_quit
= oquit
;
7984 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7985 return tool_bar_items_vector
;
7989 /* Process the definition of KEY which is DEF. */
7992 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7995 struct gcpro gcpro1
, gcpro2
;
7997 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8001 if (EQ (def
, Qundefined
))
8003 /* If a map has an explicit `undefined' as definition,
8004 discard any previously made item. */
8005 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8007 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8009 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8011 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8012 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8013 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8015 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8020 else if (parse_tool_bar_item (key
, def
))
8021 /* Append a new tool bar item to tool_bar_items_vector. Accept
8022 more than one definition for the same key. */
8023 append_tool_bar_item ();
8028 /* Access slot with index IDX of vector tool_bar_item_properties. */
8029 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8031 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8033 ASET (tool_bar_item_properties
, idx
, val
);
8037 /* Parse a tool bar item specification ITEM for key KEY and return the
8038 result in tool_bar_item_properties. Value is false if ITEM is
8041 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8043 CAPTION is the caption of the item, If it's not a string, it is
8044 evaluated to get a string.
8046 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8047 as binding are currently ignored.
8049 The following properties are recognized:
8053 FORM is evaluated and specifies whether the tool bar item is
8054 enabled or disabled.
8058 FORM is evaluated and specifies whether the tool bar item is visible.
8060 - `:filter FUNCTION'
8062 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8063 result is stored as the new binding.
8065 - `:button (TYPE SELECTED)'
8067 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8068 and specifies whether the button is selected (pressed) or not.
8072 IMAGES is either a single image specification or a vector of four
8073 image specifications. See enum tool_bar_item_images.
8075 - `:help HELP-STRING'.
8077 Gives a help string to display for the tool bar item.
8079 - `:label LABEL-STRING'.
8081 A text label to show with the tool bar button if labels are enabled. */
8084 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8086 Lisp_Object filter
= Qnil
;
8087 Lisp_Object caption
;
8089 bool have_label
= 0;
8091 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8092 Rule out items that aren't lists, don't start with
8093 `menu-item' or whose rest following `tool-bar-item' is not a
8098 /* As an exception, allow old-style menu separators. */
8099 if (STRINGP (XCAR (item
)))
8100 item
= list1 (XCAR (item
));
8101 else if (!EQ (XCAR (item
), Qmenu_item
)
8102 || (item
= XCDR (item
), !CONSP (item
)))
8105 /* Create tool_bar_item_properties vector if necessary. Reset it to
8107 if (VECTORP (tool_bar_item_properties
))
8109 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8113 tool_bar_item_properties
8114 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8117 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8118 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8120 /* Get the caption of the item. If the caption is not a string,
8121 evaluate it to get a string. If we don't get a string, skip this
8123 caption
= XCAR (item
);
8124 if (!STRINGP (caption
))
8126 caption
= menu_item_eval_property (caption
);
8127 if (!STRINGP (caption
))
8130 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8132 /* If the rest following the caption is not a list, the menu item is
8133 either a separator, or invalid. */
8137 if (menu_separator_name_p (SSDATA (caption
)))
8139 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8140 #if !defined (USE_GTK) && !defined (HAVE_NS)
8141 /* If we use build_desired_tool_bar_string to render the
8142 tool bar, the separator is rendered as an image. */
8143 set_prop (TOOL_BAR_ITEM_IMAGES
,
8144 (menu_item_eval_property
8145 (Vtool_bar_separator_image_expression
)));
8146 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8147 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8148 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8155 /* Store the binding. */
8156 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8159 /* Ignore cached key binding, if any. */
8160 if (CONSP (item
) && CONSP (XCAR (item
)))
8163 /* Process the rest of the properties. */
8164 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8166 Lisp_Object ikey
, value
;
8169 value
= XCAR (XCDR (item
));
8171 if (EQ (ikey
, QCenable
))
8173 /* `:enable FORM'. */
8174 if (!NILP (Venable_disabled_menus_and_buttons
))
8175 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8177 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8179 else if (EQ (ikey
, QCvisible
))
8181 /* `:visible FORM'. If got a visible property and that
8182 evaluates to nil then ignore this item. */
8183 if (NILP (menu_item_eval_property (value
)))
8186 else if (EQ (ikey
, QChelp
))
8187 /* `:help HELP-STRING'. */
8188 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8189 else if (EQ (ikey
, QCvert_only
))
8190 /* `:vert-only t/nil'. */
8191 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8192 else if (EQ (ikey
, QClabel
))
8194 const char *bad_label
= "!!?GARBLED ITEM?!!";
8195 /* `:label LABEL-STRING'. */
8196 set_prop (TOOL_BAR_ITEM_LABEL
,
8197 STRINGP (value
) ? value
: build_string (bad_label
));
8200 else if (EQ (ikey
, QCfilter
))
8201 /* ':filter FORM'. */
8203 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8205 /* `:button (TYPE . SELECTED)'. */
8206 Lisp_Object type
, selected
;
8208 type
= XCAR (value
);
8209 selected
= XCDR (value
);
8210 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8212 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8213 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8216 else if (EQ (ikey
, QCimage
)
8218 || (VECTORP (value
) && ASIZE (value
) == 4)))
8219 /* Value is either a single image specification or a vector
8220 of 4 such specifications for the different button states. */
8221 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8222 else if (EQ (ikey
, QCrtl
))
8224 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8230 /* Try to make one from caption and key. */
8231 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8232 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8233 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8234 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8236 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8237 char *buf
= xmalloc (max_lbl
+ 1);
8238 Lisp_Object new_lbl
;
8239 ptrdiff_t caption_len
= strlen (capt
);
8241 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8244 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8246 buf
[caption_len
] = '\0';
8250 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8254 strcpy (buf
, label
);
8256 for (j
= 0; buf
[j
] != '\0'; ++j
)
8264 new_lbl
= Fupcase_initials (build_string (label
));
8265 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8266 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8268 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8272 /* If got a filter apply it on binding. */
8274 set_prop (TOOL_BAR_ITEM_BINDING
,
8275 (menu_item_eval_property
8278 PROP (TOOL_BAR_ITEM_BINDING
))))));
8280 /* See if the binding is a keymap. Give up if it is. */
8281 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8284 /* Enable or disable selection of item. */
8285 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8286 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8287 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8289 /* Handle radio buttons or toggle boxes. */
8290 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8291 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8292 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8300 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8301 that can be reused. */
8304 init_tool_bar_items (Lisp_Object reuse
)
8306 if (VECTORP (reuse
))
8307 tool_bar_items_vector
= reuse
;
8309 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8310 ntool_bar_items
= 0;
8314 /* Append parsed tool bar item properties from
8315 tool_bar_item_properties */
8318 append_tool_bar_item (void)
8322 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8324 /* Enlarge tool_bar_items_vector if necessary. */
8326 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8328 /* Append entries from tool_bar_item_properties to the end of
8329 tool_bar_items_vector. */
8330 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8331 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8332 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8339 /* Read a character using menus based on the keymap MAP.
8340 Return nil if there are no menus in the maps.
8341 Return t if we displayed a menu but the user rejected it.
8343 PREV_EVENT is the previous input event, or nil if we are reading
8344 the first event of a key sequence.
8346 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8347 if we used a mouse menu to read the input, or false otherwise. If
8348 USED_MOUSE_MENU is null, don't dereference it.
8350 The prompting is done based on the prompt-string of the map
8351 and the strings associated with various map elements.
8353 This can be done with X menus or with menus put in the minibuf.
8354 These are done in different ways, depending on how the input will be read.
8355 Menus using X are done after auto-saving in read-char, getting the input
8356 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8357 and do auto-saving in the inner call of read_char. */
8360 read_char_x_menu_prompt (Lisp_Object map
,
8361 Lisp_Object prev_event
, bool *used_mouse_menu
)
8363 if (used_mouse_menu
)
8364 *used_mouse_menu
= 0;
8366 /* Use local over global Menu maps. */
8368 if (! menu_prompting
)
8372 /* If we got to this point via a mouse click,
8373 use a real menu for mouse selection. */
8374 if (EVENT_HAS_PARAMETERS (prev_event
)
8375 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8376 && !EQ (XCAR (prev_event
), Qtool_bar
))
8378 /* Display the menu and get the selection. */
8381 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8386 record_menu_key (XCAR (value
));
8388 /* If we got multiple events, unread all but
8390 There is no way to prevent those unread events
8391 from showing up later in last_nonmenu_event.
8392 So turn symbol and integer events into lists,
8393 to indicate that they came from a mouse menu,
8394 so that when present in last_nonmenu_event
8395 they won't confuse things. */
8396 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8398 record_menu_key (XCAR (tem
));
8399 if (SYMBOLP (XCAR (tem
))
8400 || INTEGERP (XCAR (tem
)))
8401 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8404 /* If we got more than one event, put all but the first
8405 onto this list to be read later.
8406 Return just the first event now. */
8407 Vunread_command_events
8408 = nconc2 (XCDR (value
), Vunread_command_events
);
8409 value
= XCAR (value
);
8411 else if (NILP (value
))
8413 if (used_mouse_menu
)
8414 *used_mouse_menu
= 1;
8417 #endif /* HAVE_MENUS */
8422 read_char_minibuf_menu_prompt (int commandflag
,
8425 register Lisp_Object name
;
8427 /* FIXME: Use the minibuffer's frame width. */
8428 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8430 bool nobindings
= 1;
8431 Lisp_Object rest
, vector
;
8432 Lisp_Object prompt_strings
= Qnil
;
8436 if (! menu_prompting
)
8439 map
= get_keymap (map
, 0, 1);
8440 name
= Fkeymap_prompt (map
);
8442 /* If we don't have any menus, just read a character normally. */
8443 if (!STRINGP (name
))
8446 #define PUSH_C_STR(str, listvar) \
8447 listvar = Fcons (build_unibyte_string (str), listvar)
8449 /* Prompt string always starts with map's prompt, and a space. */
8450 prompt_strings
= Fcons (name
, prompt_strings
);
8451 PUSH_C_STR (": ", prompt_strings
);
8452 nlength
= SCHARS (name
) + 2;
8456 /* Present the documented bindings, a line at a time. */
8460 Lisp_Object menu_strings
= prompt_strings
;
8461 ptrdiff_t i
= nlength
;
8463 Lisp_Object orig_defn_macro
;
8465 /* Loop over elements of map. */
8470 /* FIXME: Use map_keymap to handle new keymap formats. */
8472 /* At end of map, wrap around if just starting,
8473 or end this line if already have something on it. */
8476 if (notfirst
|| nobindings
)
8482 /* Look at the next element of the map. */
8484 elt
= AREF (vector
, idx
);
8486 elt
= Fcar_safe (rest
);
8488 if (idx
< 0 && VECTORP (elt
))
8490 /* If we found a dense table in the keymap,
8491 advanced past it, but start scanning its contents. */
8492 rest
= Fcdr_safe (rest
);
8498 /* An ordinary element. */
8499 Lisp_Object event
, tem
;
8503 event
= Fcar_safe (elt
); /* alist */
8504 elt
= Fcdr_safe (elt
);
8508 XSETINT (event
, idx
); /* vector */
8511 /* Ignore the element if it has no prompt string. */
8512 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8514 /* True if the char to type matches the string. */
8516 Lisp_Object upcased_event
, downcased_event
;
8517 Lisp_Object desc
= Qnil
;
8519 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8521 upcased_event
= Fupcase (event
);
8522 downcased_event
= Fdowncase (event
);
8523 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8524 || XINT (downcased_event
) == SREF (s
, 0));
8526 desc
= Fsingle_key_description (event
, Qnil
);
8528 #if 0 /* It is redundant to list the equivalent key bindings because
8529 the prefix is what the user has already typed. */
8531 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8533 /* Insert equivalent keybinding. */
8534 s
= concat2 (s
, tem
);
8537 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8538 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8540 /* Insert button prefix. */
8541 Lisp_Object selected
8542 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8543 if (EQ (tem
, QCradio
))
8544 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8546 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8547 s
= concat2 (tem
, s
);
8551 /* If we have room for the prompt string, add it to this line.
8552 If this is the first on the line, always add it. */
8553 if ((SCHARS (s
) + i
+ 2
8554 + (char_matches
? 0 : SCHARS (desc
) + 3))
8558 ptrdiff_t thiswidth
;
8560 /* Punctuate between strings. */
8563 PUSH_C_STR (", ", menu_strings
);
8569 /* If the char to type doesn't match the string's
8570 first char, explicitly show what char to type. */
8573 /* Add as much of string as fits. */
8574 thiswidth
= min (SCHARS (desc
), width
- i
);
8576 = Fcons (Fsubstring (desc
, make_number (0),
8577 make_number (thiswidth
)),
8580 PUSH_C_STR (" = ", menu_strings
);
8584 /* Add as much of string as fits. */
8585 thiswidth
= min (SCHARS (s
), width
- i
);
8587 = Fcons (Fsubstring (s
, make_number (0),
8588 make_number (thiswidth
)),
8594 /* If this element does not fit, end the line now,
8595 and save the element for the next line. */
8596 PUSH_C_STR ("...", menu_strings
);
8601 /* Move past this element. */
8602 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8603 /* Handle reaching end of dense table. */
8608 rest
= Fcdr_safe (rest
);
8612 /* Prompt with that and read response. */
8613 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8615 /* Make believe it's not a keyboard macro in case the help char
8616 is pressed. Help characters are not recorded because menu prompting
8617 is not used on replay. */
8618 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8619 kset_defining_kbd_macro (current_kboard
, Qnil
);
8621 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8622 while (BUFFERP (obj
));
8623 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8625 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8628 if (! EQ (obj
, menu_prompt_more_char
)
8629 && (!INTEGERP (menu_prompt_more_char
)
8630 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8632 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8633 store_kbd_macro_char (obj
);
8636 /* Help char - go round again. */
8640 /* Reading key sequences. */
8643 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8645 return access_keymap (get_keymap (keymap
, 0, 1),
8650 active_maps (Lisp_Object first_event
)
8652 Lisp_Object position
8653 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8654 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8657 /* Structure used to keep track of partial application of key remapping
8658 such as Vfunction_key_map and Vkey_translation_map. */
8659 typedef struct keyremap
8661 /* This is the map originally specified for this use. */
8663 /* This is a submap reached by looking up, in PARENT,
8664 the events from START to END. */
8666 /* Positions [START, END) in the key sequence buffer
8667 are the key that we have scanned so far.
8668 Those events are the ones that we will replace
8669 if PARENT maps them into a key sequence. */
8673 /* Lookup KEY in MAP.
8674 MAP is a keymap mapping keys to key vectors or functions.
8675 If the mapping is a function and DO_FUNCALL is true,
8676 the function is called with PROMPT as parameter and its return
8677 value is used as the return value of this function (after checking
8678 that it is indeed a vector). */
8681 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8686 next
= access_keymap (map
, key
, 1, 0, 1);
8688 /* Handle a symbol whose function definition is a keymap
8690 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8691 && (ARRAYP (XSYMBOL (next
)->function
)
8692 || KEYMAPP (XSYMBOL (next
)->function
)))
8693 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8695 /* If the keymap gives a function, not an
8696 array, then call the function with one arg and use
8697 its value instead. */
8698 if (do_funcall
&& FUNCTIONP (next
))
8703 next
= call1 (next
, prompt
);
8704 /* If the function returned something invalid,
8705 barf--don't ignore it.
8706 (To ignore it safely, we would need to gcpro a bunch of
8707 other variables.) */
8708 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8709 error ("Function %s returns invalid key sequence",
8710 SSDATA (SYMBOL_NAME (tem
)));
8715 /* Do one step of the key remapping used for function-key-map and
8716 key-translation-map:
8717 KEYBUF is the buffer holding the input events.
8718 BUFSIZE is its maximum size.
8719 FKEY is a pointer to the keyremap structure to use.
8720 INPUT is the index of the last element in KEYBUF.
8721 DOIT if true says that the remapping can actually take place.
8722 DIFF is used to return the number of keys added/removed by the remapping.
8723 PARENT is the root of the keymap.
8724 PROMPT is the prompt to use if the remapping happens through a function.
8725 Return true if the remapping actually took place. */
8728 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8729 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8731 Lisp_Object next
, key
;
8733 key
= keybuf
[fkey
->end
++];
8735 if (KEYMAPP (fkey
->parent
))
8736 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8740 /* If keybuf[fkey->start..fkey->end] is bound in the
8741 map and we're in a position to do the key remapping, replace it with
8742 the binding and restart with fkey->start at the end. */
8743 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8745 int len
= XFASTINT (Flength (next
));
8748 *diff
= len
- (fkey
->end
- fkey
->start
);
8750 if (bufsize
- input
<= *diff
)
8751 error ("Key sequence too long");
8753 /* Shift the keys that follow fkey->end. */
8755 for (i
= fkey
->end
; i
< input
; i
++)
8756 keybuf
[i
+ *diff
] = keybuf
[i
];
8758 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8759 keybuf
[i
+ *diff
] = keybuf
[i
];
8760 /* Overwrite the old keys with the new ones. */
8761 for (i
= 0; i
< len
; i
++)
8762 keybuf
[fkey
->start
+ i
]
8763 = Faref (next
, make_number (i
));
8765 fkey
->start
= fkey
->end
+= *diff
;
8766 fkey
->map
= fkey
->parent
;
8771 fkey
->map
= get_keymap (next
, 0, 1);
8773 /* If we no longer have a bound suffix, try a new position for
8775 if (!CONSP (fkey
->map
))
8777 fkey
->end
= ++fkey
->start
;
8778 fkey
->map
= fkey
->parent
;
8784 test_undefined (Lisp_Object binding
)
8786 return (NILP (binding
)
8787 || EQ (binding
, Qundefined
)
8788 || (SYMBOLP (binding
)
8789 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8792 /* Read a sequence of keys that ends with a non prefix character,
8793 storing it in KEYBUF, a buffer of size BUFSIZE.
8795 Return the length of the key sequence stored.
8796 Return -1 if the user rejected a command menu.
8798 Echo starting immediately unless `prompt' is 0.
8800 Where a key sequence ends depends on the currently active keymaps.
8801 These include any minor mode keymaps active in the current buffer,
8802 the current buffer's local map, and the global map.
8804 If a key sequence has no other bindings, we check Vfunction_key_map
8805 to see if some trailing subsequence might be the beginning of a
8806 function key's sequence. If so, we try to read the whole function
8807 key, and substitute its symbolic name into the key sequence.
8809 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8810 `double-' events into similar click events, if that would make them
8811 bound. We try to turn `triple-' events first into `double-' events,
8814 If we get a mouse click in a mode line, vertical divider, or other
8815 non-text area, we treat the click as if it were prefixed by the
8816 symbol denoting that area - `mode-line', `vertical-line', or
8819 If the sequence starts with a mouse click, we read the key sequence
8820 with respect to the buffer clicked on, not the current buffer.
8822 If the user switches frames in the midst of a key sequence, we put
8823 off the switch-frame event until later; the next call to
8824 read_char will return it.
8826 If FIX_CURRENT_BUFFER, we restore current_buffer
8827 from the selected window's buffer. */
8830 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8831 bool dont_downcase_last
, bool can_return_switch_frame
,
8832 bool fix_current_buffer
)
8834 ptrdiff_t count
= SPECPDL_INDEX ();
8836 /* How many keys there are in the current key sequence. */
8839 /* The length of the echo buffer when we started reading, and
8840 the length of this_command_keys when we started reading. */
8841 ptrdiff_t echo_start
IF_LINT (= 0);
8842 ptrdiff_t keys_start
;
8844 Lisp_Object current_binding
= Qnil
;
8845 Lisp_Object first_event
= Qnil
;
8847 /* Index of the first key that has no binding.
8848 It is useless to try fkey.start larger than that. */
8851 /* If t < mock_input, then KEYBUF[t] should be read as the next
8854 We use this to recover after recognizing a function key. Once we
8855 realize that a suffix of the current key sequence is actually a
8856 function key's escape sequence, we replace the suffix with the
8857 function key's binding from Vfunction_key_map. Now keybuf
8858 contains a new and different key sequence, so the echo area,
8859 this_command_keys, and the submaps and defs arrays are wrong. In
8860 this situation, we set mock_input to t, set t to 0, and jump to
8861 restart_sequence; the loop will read keys from keybuf up until
8862 mock_input, thus rebuilding the state; and then it will resume
8863 reading characters from the keyboard. */
8866 /* If the sequence is unbound in submaps[], then
8867 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8868 and fkey.map is its binding.
8870 These might be > t, indicating that all function key scanning
8871 should hold off until t reaches them. We do this when we've just
8872 recognized a function key, to avoid searching for the function
8873 key's again in Vfunction_key_map. */
8876 /* Likewise, for key_translation_map and input-decode-map. */
8877 keyremap keytran
, indec
;
8879 /* True if we are trying to map a key by changing an upper-case
8880 letter to lower case, or a shifted function key to an unshifted
8882 bool shift_translated
= 0;
8884 /* If we receive a `switch-frame' or `select-window' event in the middle of
8885 a key sequence, we put it off for later.
8886 While we're reading, we keep the event here. */
8887 Lisp_Object delayed_switch_frame
;
8889 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8890 int original_uppercase_position
= -1;
8892 /* Gets around Microsoft compiler limitations. */
8895 struct buffer
*starting_buffer
;
8897 /* List of events for which a fake prefix key has been generated. */
8898 Lisp_Object fake_prefixed_keys
= Qnil
;
8900 struct gcpro gcpro1
;
8902 GCPRO1 (fake_prefixed_keys
);
8903 raw_keybuf_count
= 0;
8905 last_nonmenu_event
= Qnil
;
8907 delayed_switch_frame
= Qnil
;
8913 /* Install the string STR as the beginning of the string of
8914 echoing, so that it serves as a prompt for the next
8916 kset_echo_string (current_kboard
, prompt
);
8917 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8920 else if (cursor_in_echo_area
8921 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8922 && NILP (Fzerop (Vecho_keystrokes
)))
8923 /* This doesn't put in a dash if the echo buffer is empty, so
8924 you don't always see a dash hanging out in the minibuffer. */
8928 /* Record the initial state of the echo area and this_command_keys;
8929 we will need to restore them if we replay a key sequence. */
8931 echo_start
= echo_length ();
8932 keys_start
= this_command_key_count
;
8933 this_single_command_key_start
= keys_start
;
8935 /* We jump here when we need to reinitialize fkey and keytran; this
8936 happens if we switch keyboards between rescans. */
8937 replay_entire_sequence
:
8939 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8940 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8941 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8942 indec
.start
= indec
.end
= 0;
8943 fkey
.start
= fkey
.end
= 0;
8944 keytran
.start
= keytran
.end
= 0;
8946 /* We jump here when the key sequence has been thoroughly changed, and
8947 we need to rescan it starting from the beginning. When we jump here,
8948 keybuf[0..mock_input] holds the sequence we should reread. */
8951 starting_buffer
= current_buffer
;
8952 first_unbound
= bufsize
+ 1;
8954 /* Build our list of keymaps.
8955 If we recognize a function key and replace its escape sequence in
8956 keybuf with its symbol, or if the sequence starts with a mouse
8957 click and we need to switch buffers, we jump back here to rebuild
8958 the initial keymaps from the current buffer. */
8959 current_binding
= active_maps (first_event
);
8961 /* Start from the beginning in keybuf. */
8964 /* These are no-ops the first time through, but if we restart, they
8965 revert the echo area and this_command_keys to their original state. */
8966 this_command_key_count
= keys_start
;
8967 if (INTERACTIVE
&& t
< mock_input
)
8968 echo_truncate (echo_start
);
8970 /* If the best binding for the current key sequence is a keymap, or
8971 we may be looking at a function key's escape sequence, keep on
8973 while (!NILP (current_binding
)
8974 /* Keep reading as long as there's a prefix binding. */
8975 ? KEYMAPP (current_binding
)
8976 /* Don't return in the middle of a possible function key sequence,
8977 if the only bindings we found were via case conversion.
8978 Thus, if ESC O a has a function-key-map translation
8979 and ESC o has a binding, don't return after ESC O,
8980 so that we can translate ESC O plus the next character. */
8981 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8984 bool used_mouse_menu
= 0;
8986 /* Where the last real key started. If we need to throw away a
8987 key that has expanded into more than one element of keybuf
8988 (say, a mouse click on the mode line which is being treated
8989 as [mode-line (mouse-...)], then we backtrack to this point
8991 int last_real_key_start
;
8993 /* These variables are analogous to echo_start and keys_start;
8994 while those allow us to restart the entire key sequence,
8995 echo_local_start and keys_local_start allow us to throw away
8997 ptrdiff_t echo_local_start
IF_LINT (= 0);
8998 int keys_local_start
;
8999 Lisp_Object new_binding
;
9001 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9002 eassert (indec
.start
<= indec
.end
);
9003 eassert (fkey
.start
<= fkey
.end
);
9004 eassert (keytran
.start
<= keytran
.end
);
9005 /* key-translation-map is applied *after* function-key-map
9006 which is itself applied *after* input-decode-map. */
9007 eassert (fkey
.end
<= indec
.start
);
9008 eassert (keytran
.end
<= fkey
.start
);
9010 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9011 first_unbound
< keytran
.start
)
9012 { /* The prefix upto first_unbound has no binding and has
9013 no translation left to do either, so we know it's unbound.
9014 If we don't stop now, we risk staying here indefinitely
9015 (if the user keeps entering fkey or keytran prefixes
9016 like C-c ESC ESC ESC ESC ...) */
9018 for (i
= first_unbound
+ 1; i
< t
; i
++)
9019 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9020 mock_input
= t
- first_unbound
- 1;
9021 indec
.end
= indec
.start
-= first_unbound
+ 1;
9022 indec
.map
= indec
.parent
;
9023 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9024 fkey
.map
= fkey
.parent
;
9025 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9026 keytran
.map
= keytran
.parent
;
9027 goto replay_sequence
;
9031 error ("Key sequence too long");
9034 echo_local_start
= echo_length ();
9035 keys_local_start
= this_command_key_count
;
9038 /* These are no-ops, unless we throw away a keystroke below and
9039 jumped back up to replay_key; in that case, these restore the
9040 variables to their original state, allowing us to replay the
9042 if (INTERACTIVE
&& t
< mock_input
)
9043 echo_truncate (echo_local_start
);
9044 this_command_key_count
= keys_local_start
;
9046 /* By default, assume each event is "real". */
9047 last_real_key_start
= t
;
9049 /* Does mock_input indicate that we are re-reading a key sequence? */
9053 add_command_key (key
);
9054 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9055 && NILP (Fzerop (Vecho_keystrokes
))
9056 && current_kboard
->immediate_echo
)
9063 /* If not, we should actually read a character. */
9067 KBOARD
*interrupted_kboard
= current_kboard
;
9068 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9069 key
= read_char (NILP (prompt
),
9070 current_binding
, last_nonmenu_event
,
9071 &used_mouse_menu
, NULL
);
9072 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9073 /* When switching to a new tty (with a new keyboard),
9074 read_char returns the new buffer, rather than -2
9075 (Bug#5095). This is because `terminal-init-xterm'
9076 calls read-char, which eats the wrong_kboard_jmpbuf
9077 return. Any better way to fix this? -- cyd */
9078 || (interrupted_kboard
!= current_kboard
))
9083 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9084 if (k
== interrupted_kboard
)
9089 /* Don't touch interrupted_kboard when it's been
9091 delayed_switch_frame
= Qnil
;
9092 goto replay_entire_sequence
;
9095 if (!NILP (delayed_switch_frame
))
9098 (interrupted_kboard
,
9099 Fcons (delayed_switch_frame
,
9100 KVAR (interrupted_kboard
, kbd_queue
)));
9101 delayed_switch_frame
= Qnil
;
9106 (interrupted_kboard
,
9107 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9109 /* If the side queue is non-empty, ensure it begins with a
9110 switch-frame, so we'll replay it in the right context. */
9111 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9112 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9113 !(EVENT_HAS_PARAMETERS (key
)
9114 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9118 XSETFRAME (frame
, interrupted_frame
);
9120 (interrupted_kboard
,
9121 Fcons (make_lispy_switch_frame (frame
),
9122 KVAR (interrupted_kboard
, kbd_queue
)));
9125 goto replay_entire_sequence
;
9129 /* read_char returns t when it shows a menu and the user rejects it.
9133 unbind_to (count
, Qnil
);
9138 /* read_char returns -1 at the end of a macro.
9139 Emacs 18 handles this by returning immediately with a
9140 zero, so that's what we'll do. */
9141 if (INTEGERP (key
) && XINT (key
) == -1)
9144 /* The Microsoft C compiler can't handle the goto that
9150 /* If the current buffer has been changed from under us, the
9151 keymap may have changed, so replay the sequence. */
9154 timer_resume_idle ();
9157 /* Reset the current buffer from the selected window
9158 in case something changed the former and not the latter.
9159 This is to be more consistent with the behavior
9160 of the command_loop_1. */
9161 if (fix_current_buffer
)
9163 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9165 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9167 Fset_buffer (XWINDOW (selected_window
)->contents
);
9170 goto replay_sequence
;
9173 /* If we have a quit that was typed in another frame, and
9174 quit_throw_to_read_char switched buffers,
9175 replay to get the right keymap. */
9177 && XINT (key
) == quit_char
9178 && current_buffer
!= starting_buffer
)
9181 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9186 goto replay_sequence
;
9191 if (EVENT_HAS_PARAMETERS (key
)
9192 /* Either a `switch-frame' or a `select-window' event. */
9193 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9195 /* If we're at the beginning of a key sequence, and the caller
9196 says it's okay, go ahead and return this event. If we're
9197 in the midst of a key sequence, delay it until the end. */
9198 if (t
> 0 || !can_return_switch_frame
)
9200 delayed_switch_frame
= key
;
9205 if (NILP (first_event
))
9208 /* Even if first_event does not specify a particular
9209 window/position, it's important to recompute the maps here
9210 since a long time might have passed since we entered
9211 read_key_sequence, and a timer (or process-filter or
9212 special-event-map, ...) might have switched the current buffer
9213 or the selected window from under us in the mean time. */
9214 if (fix_current_buffer
9215 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9217 Fset_buffer (XWINDOW (selected_window
)->contents
);
9218 current_binding
= active_maps (first_event
);
9222 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9226 /* Clicks in non-text areas get prefixed by the symbol
9227 in their CHAR-ADDRESS field. For example, a click on
9228 the mode line is prefixed by the symbol `mode-line'.
9230 Furthermore, key sequences beginning with mouse clicks
9231 are read using the keymaps of the buffer clicked on, not
9232 the current buffer. So we may have to switch the buffer
9235 When we turn one event into two events, we must make sure
9236 that neither of the two looks like the original--so that,
9237 if we replay the events, they won't be expanded again.
9238 If not for this, such reexpansion could happen either here
9239 or when user programs play with this-command-keys. */
9240 if (EVENT_HAS_PARAMETERS (key
))
9242 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9243 if (EQ (kind
, Qmouse_click
))
9245 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9246 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9249 || (!NILP (fake_prefixed_keys
)
9250 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9252 /* We're looking a second time at an event for which
9253 we generated a fake prefix key. Set
9254 last_real_key_start appropriately. */
9256 last_real_key_start
= t
- 1;
9259 if (last_real_key_start
== 0)
9261 /* Key sequences beginning with mouse clicks are
9262 read using the keymaps in the buffer clicked on,
9263 not the current buffer. If we're at the
9264 beginning of a key sequence, switch buffers. */
9265 if (WINDOWP (window
)
9266 && BUFFERP (XWINDOW (window
)->contents
)
9267 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9269 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9274 /* Arrange to go back to the original buffer once we're
9275 done reading the key sequence. Note that we can't
9276 use save_excursion_{save,restore} here, because they
9277 save point as well as the current buffer; we don't
9278 want to save point, because redisplay may change it,
9279 to accommodate a Fset_window_start or something. We
9280 don't want to do this at the top of the function,
9281 because we may get input from a subprocess which
9282 wants to change the selected window and stuff (say,
9284 record_unwind_current_buffer ();
9286 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9288 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9289 goto replay_sequence
;
9293 /* Expand mode-line and scroll-bar events into two events:
9294 use posn as a fake prefix key. */
9296 && (NILP (fake_prefixed_keys
)
9297 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9299 if (bufsize
- t
<= 1)
9300 error ("Key sequence too long");
9303 keybuf
[t
+ 1] = key
;
9306 /* Record that a fake prefix key has been generated
9307 for KEY. Don't modify the event; this would
9308 prevent proper action when the event is pushed
9309 back into unread-command-events. */
9310 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9314 else if (CONSP (XCDR (key
))
9315 && CONSP (EVENT_START (key
))
9316 && CONSP (XCDR (EVENT_START (key
))))
9320 posn
= POSN_POSN (EVENT_START (key
));
9321 /* Handle menu-bar events:
9322 insert the dummy prefix event `menu-bar'. */
9323 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9325 if (bufsize
- t
<= 1)
9326 error ("Key sequence too long");
9328 keybuf
[t
+ 1] = key
;
9330 /* Zap the position in key, so we know that we've
9331 expanded it, and don't try to do so again. */
9332 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9335 goto replay_sequence
;
9337 else if (CONSP (posn
))
9339 /* We're looking at the second event of a
9340 sequence which we expanded before. Set
9341 last_real_key_start appropriately. */
9342 if (last_real_key_start
== t
&& t
> 0)
9343 last_real_key_start
= t
- 1;
9348 /* We have finally decided that KEY is something we might want
9350 new_binding
= follow_key (current_binding
, key
);
9352 /* If KEY wasn't bound, we'll try some fallbacks. */
9353 if (!NILP (new_binding
))
9354 /* This is needed for the following scenario:
9355 event 0: a down-event that gets dropped by calling replay_key.
9356 event 1: some normal prefix like C-h.
9357 After event 0, first_unbound is 0, after event 1 indec.start,
9358 fkey.start, and keytran.start are all 1, so when we see that
9359 C-h is bound, we need to update first_unbound. */
9360 first_unbound
= max (t
+ 1, first_unbound
);
9365 /* Remember the position to put an upper bound on indec.start. */
9366 first_unbound
= min (t
, first_unbound
);
9368 head
= EVENT_HEAD (key
);
9369 if (help_char_p (head
) && t
> 0)
9371 read_key_sequence_cmd
= Vprefix_help_command
;
9373 last_nonmenu_event
= key
;
9374 /* The Microsoft C compiler can't handle the goto that
9382 Lisp_Object breakdown
;
9385 breakdown
= parse_modifiers (head
);
9386 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9387 /* Attempt to reduce an unbound mouse event to a simpler
9388 event that is bound:
9389 Drags reduce to clicks.
9390 Double-clicks reduce to clicks.
9391 Triple-clicks reduce to double-clicks, then to clicks.
9392 Down-clicks are eliminated.
9393 Double-downs reduce to downs, then are eliminated.
9394 Triple-downs reduce to double-downs, then to downs,
9395 then are eliminated. */
9396 if (modifiers
& (down_modifier
| drag_modifier
9397 | double_modifier
| triple_modifier
))
9399 while (modifiers
& (down_modifier
| drag_modifier
9400 | double_modifier
| triple_modifier
))
9402 Lisp_Object new_head
, new_click
;
9403 if (modifiers
& triple_modifier
)
9404 modifiers
^= (double_modifier
| triple_modifier
);
9405 else if (modifiers
& double_modifier
)
9406 modifiers
&= ~double_modifier
;
9407 else if (modifiers
& drag_modifier
)
9408 modifiers
&= ~drag_modifier
;
9411 /* Dispose of this `down' event by simply jumping
9412 back to replay_key, to get another event.
9414 Note that if this event came from mock input,
9415 then just jumping back to replay_key will just
9416 hand it to us again. So we have to wipe out any
9419 We could delete keybuf[t] and shift everything
9420 after that to the left by one spot, but we'd also
9421 have to fix up any variable that points into
9422 keybuf, and shifting isn't really necessary
9425 Adding prefixes for non-textual mouse clicks
9426 creates two characters of mock input, and both
9427 must be thrown away. If we're only looking at
9428 the prefix now, we can just jump back to
9429 replay_key. On the other hand, if we've already
9430 processed the prefix, and now the actual click
9431 itself is giving us trouble, then we've lost the
9432 state of the keymaps we want to backtrack to, and
9433 we need to replay the whole sequence to rebuild
9436 Beyond that, only function key expansion could
9437 create more than two keys, but that should never
9438 generate mouse events, so it's okay to zero
9439 mock_input in that case too.
9441 FIXME: The above paragraph seems just plain
9442 wrong, if you consider things like
9443 xterm-mouse-mode. -stef
9445 Isn't this just the most wonderful code ever? */
9447 /* If mock_input > t + 1, the above simplification
9448 will actually end up dropping keys on the floor.
9449 This is probably OK for now, but even
9450 if mock_input <= t + 1, we need to adjust indec,
9452 Typical case [header-line down-mouse-N]:
9453 mock_input = 2, t = 1, fkey.end = 1,
9454 last_real_key_start = 0. */
9455 if (indec
.end
> last_real_key_start
)
9457 indec
.end
= indec
.start
9458 = min (last_real_key_start
, indec
.start
);
9459 indec
.map
= indec
.parent
;
9460 if (fkey
.end
> last_real_key_start
)
9462 fkey
.end
= fkey
.start
9463 = min (last_real_key_start
, fkey
.start
);
9464 fkey
.map
= fkey
.parent
;
9465 if (keytran
.end
> last_real_key_start
)
9467 keytran
.end
= keytran
.start
9468 = min (last_real_key_start
, keytran
.start
);
9469 keytran
.map
= keytran
.parent
;
9473 if (t
== last_real_key_start
)
9480 mock_input
= last_real_key_start
;
9481 goto replay_sequence
;
9486 = apply_modifiers (modifiers
, XCAR (breakdown
));
9487 new_click
= list2 (new_head
, EVENT_START (key
));
9489 /* Look for a binding for this new key. */
9490 new_binding
= follow_key (current_binding
, new_click
);
9492 /* If that click is bound, go for it. */
9493 if (!NILP (new_binding
))
9495 current_binding
= new_binding
;
9499 /* Otherwise, we'll leave key set to the drag event. */
9504 current_binding
= new_binding
;
9507 /* Normally, last_nonmenu_event gets the previous key we read.
9508 But when a mouse popup menu is being used,
9509 we don't update last_nonmenu_event; it continues to hold the mouse
9510 event that preceded the first level of menu. */
9511 if (!used_mouse_menu
)
9512 last_nonmenu_event
= key
;
9514 /* Record what part of this_command_keys is the current key sequence. */
9515 this_single_command_key_start
= this_command_key_count
- t
;
9517 /* Look for this sequence in input-decode-map.
9518 Scan from indec.end until we find a bound suffix. */
9519 while (indec
.end
< t
)
9521 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9525 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9526 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9531 mock_input
= diff
+ max (t
, mock_input
);
9532 goto replay_sequence
;
9536 if (!KEYMAPP (current_binding
)
9537 && !test_undefined (current_binding
)
9538 && indec
.start
>= t
)
9539 /* There is a binding and it's not a prefix.
9540 (and it doesn't have any input-decode-map translation pending).
9541 There is thus no function-key in this sequence.
9542 Moving fkey.start is important in this case to allow keytran.start
9543 to go over the sequence before we return (since we keep the
9544 invariant that keytran.end <= fkey.start). */
9547 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9550 /* If the sequence is unbound, see if we can hang a function key
9551 off the end of it. */
9552 /* Continue scan from fkey.end until we find a bound suffix. */
9553 while (fkey
.end
< indec
.start
)
9555 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9559 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9560 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9561 max (t
, mock_input
),
9562 /* If there's a binding (i.e.
9563 first_binding >= nmaps) we don't want
9564 to apply this function-key-mapping. */
9566 && (test_undefined (current_binding
)),
9571 mock_input
= diff
+ max (t
, mock_input
);
9572 /* Adjust the input-decode-map counters. */
9574 indec
.start
+= diff
;
9576 goto replay_sequence
;
9580 /* Look for this sequence in key-translation-map.
9581 Scan from keytran.end until we find a bound suffix. */
9582 while (keytran
.end
< fkey
.start
)
9584 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9588 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9589 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9594 mock_input
= diff
+ max (t
, mock_input
);
9595 /* Adjust the function-key-map and input-decode-map counters. */
9597 indec
.start
+= diff
;
9601 goto replay_sequence
;
9605 /* If KEY is not defined in any of the keymaps,
9606 and cannot be part of a function key or translation,
9607 and is an upper case letter
9608 use the corresponding lower-case letter instead. */
9609 if (NILP (current_binding
)
9610 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9612 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9613 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9614 || (XINT (key
) & shift_modifier
)))
9616 Lisp_Object new_key
;
9618 original_uppercase
= key
;
9619 original_uppercase_position
= t
- 1;
9621 if (XINT (key
) & shift_modifier
)
9622 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9624 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9625 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9627 /* We have to do this unconditionally, regardless of whether
9628 the lower-case char is defined in the keymaps, because they
9629 might get translated through function-key-map. */
9630 keybuf
[t
- 1] = new_key
;
9631 mock_input
= max (t
, mock_input
);
9632 shift_translated
= 1;
9634 goto replay_sequence
;
9636 /* If KEY is not defined in any of the keymaps,
9637 and cannot be part of a function key or translation,
9638 and is a shifted function key,
9639 use the corresponding unshifted function key instead. */
9640 if (NILP (current_binding
)
9641 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9643 Lisp_Object breakdown
= parse_modifiers (key
);
9645 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9647 if (modifiers
& shift_modifier
9648 /* Treat uppercase keys as shifted. */
9650 && (KEY_TO_CHAR (key
)
9651 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9652 && uppercasep (KEY_TO_CHAR (key
))))
9655 = (modifiers
& shift_modifier
9656 ? apply_modifiers (modifiers
& ~shift_modifier
,
9658 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9660 original_uppercase
= key
;
9661 original_uppercase_position
= t
- 1;
9663 /* We have to do this unconditionally, regardless of whether
9664 the lower-case char is defined in the keymaps, because they
9665 might get translated through function-key-map. */
9666 keybuf
[t
- 1] = new_key
;
9667 mock_input
= max (t
, mock_input
);
9668 /* Reset fkey (and consequently keytran) to apply
9669 function-key-map on the result, so that S-backspace is
9670 correctly mapped to DEL (via backspace). OTOH,
9671 input-decode-map doesn't need to go through it again. */
9672 fkey
.start
= fkey
.end
= 0;
9673 keytran
.start
= keytran
.end
= 0;
9674 shift_translated
= 1;
9676 goto replay_sequence
;
9681 read_key_sequence_cmd
= current_binding
;
9682 read_key_sequence_remapped
9683 /* Remap command through active keymaps.
9684 Do the remapping here, before the unbind_to so it uses the keymaps
9685 of the appropriate buffer. */
9686 = SYMBOLP (read_key_sequence_cmd
)
9687 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9690 unread_switch_frame
= delayed_switch_frame
;
9691 unbind_to (count
, Qnil
);
9693 /* Don't downcase the last character if the caller says don't.
9694 Don't downcase it if the result is undefined, either. */
9695 if ((dont_downcase_last
|| NILP (current_binding
))
9697 && t
- 1 == original_uppercase_position
)
9699 keybuf
[t
- 1] = original_uppercase
;
9700 shift_translated
= 0;
9703 if (shift_translated
)
9704 Vthis_command_keys_shift_translated
= Qt
;
9706 /* Occasionally we fabricate events, perhaps by expanding something
9707 according to function-key-map, or by adding a prefix symbol to a
9708 mouse click in the scroll bar or modeline. In this cases, return
9709 the entire generated key sequence, even if we hit an unbound
9710 prefix or a definition before the end. This means that you will
9711 be able to push back the event properly, and also means that
9712 read-key-sequence will always return a logical unit.
9715 for (; t
< mock_input
; t
++)
9717 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9718 && NILP (Fzerop (Vecho_keystrokes
)))
9719 echo_char (keybuf
[t
]);
9720 add_command_key (keybuf
[t
]);
9728 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9729 Lisp_Object dont_downcase_last
,
9730 Lisp_Object can_return_switch_frame
,
9731 Lisp_Object cmd_loop
, bool allow_string
)
9733 Lisp_Object keybuf
[30];
9735 struct gcpro gcpro1
;
9736 ptrdiff_t count
= SPECPDL_INDEX ();
9739 CHECK_STRING (prompt
);
9742 specbind (Qinput_method_exit_on_first_char
,
9743 (NILP (cmd_loop
) ? Qt
: Qnil
));
9744 specbind (Qinput_method_use_echo_area
,
9745 (NILP (cmd_loop
) ? Qt
: Qnil
));
9747 memset (keybuf
, 0, sizeof keybuf
);
9749 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9751 if (NILP (continue_echo
))
9753 this_command_key_count
= 0;
9754 this_command_key_count_reset
= 0;
9755 this_single_command_key_start
= 0;
9758 #ifdef HAVE_WINDOW_SYSTEM
9759 if (display_hourglass_p
)
9760 cancel_hourglass ();
9763 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9764 prompt
, ! NILP (dont_downcase_last
),
9765 ! NILP (can_return_switch_frame
), 0);
9767 #if 0 /* The following is fine for code reading a key sequence and
9768 then proceeding with a lengthy computation, but it's not good
9769 for code reading keys in a loop, like an input method. */
9770 #ifdef HAVE_WINDOW_SYSTEM
9771 if (display_hourglass_p
)
9782 return unbind_to (count
,
9783 ((allow_string
? make_event_array
: Fvector
)
9787 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9788 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9789 The sequence is sufficient to specify a non-prefix command in the
9790 current local and global maps.
9792 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9793 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9794 as a continuation of the previous key.
9796 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9797 convert the last event to lower case. (Normally any upper case event
9798 is converted to lower case if the original event is undefined and the lower
9799 case equivalent is defined.) A non-nil value is appropriate for reading
9800 a key sequence to be defined.
9802 A C-g typed while in this function is treated like any other character,
9803 and `quit-flag' is not set.
9805 If the key sequence starts with a mouse click, then the sequence is read
9806 using the keymaps of the buffer of the window clicked in, not the buffer
9807 of the selected window as normal.
9809 `read-key-sequence' drops unbound button-down events, since you normally
9810 only care about the click or drag events which follow them. If a drag
9811 or multi-click event is unbound, but the corresponding click event would
9812 be bound, `read-key-sequence' turns the event into a click event at the
9813 drag's starting position. This means that you don't have to distinguish
9814 between click and drag, double, or triple events unless you want to.
9816 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9817 lines separating windows, and scroll bars with imaginary keys
9818 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9820 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9821 function will process a switch-frame event if the user switches frames
9822 before typing anything. If the user switches frames in the middle of a
9823 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9824 is nil, then the event will be put off until after the current key sequence.
9826 `read-key-sequence' checks `function-key-map' for function key
9827 sequences, where they wouldn't conflict with ordinary bindings. See
9828 `function-key-map' for more details.
9830 The optional fifth argument CMD-LOOP, if non-nil, means
9831 that this key sequence is being read by something that will
9832 read commands one after another. It should be nil if the caller
9833 will read just one key sequence. */)
9834 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9836 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9837 can_return_switch_frame
, cmd_loop
, true);
9840 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9841 Sread_key_sequence_vector
, 1, 5, 0,
9842 doc
: /* Like `read-key-sequence' but always return a vector. */)
9843 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9845 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9846 can_return_switch_frame
, cmd_loop
, false);
9849 /* Return true if input events are pending. */
9852 detect_input_pending (void)
9854 return input_pending
|| get_input_pending (0);
9857 /* Return true if input events other than mouse movements are
9861 detect_input_pending_ignore_squeezables (void)
9863 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9866 /* Return true if input events are pending, and run any pending timers. */
9869 detect_input_pending_run_timers (bool do_display
)
9871 unsigned old_timers_run
= timers_run
;
9874 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9876 if (old_timers_run
!= timers_run
&& do_display
)
9878 redisplay_preserve_echo_area (8);
9879 /* The following fixes a bug when using lazy-lock with
9880 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9881 from an idle timer function. The symptom of the bug is that
9882 the cursor sometimes doesn't become visible until the next X
9883 event is processed. --gerd. */
9885 Lisp_Object tail
, frame
;
9886 FOR_EACH_FRAME (tail
, frame
)
9887 if (FRAME_RIF (XFRAME (frame
)))
9888 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
9892 return input_pending
;
9895 /* This is called in some cases before a possible quit.
9896 It cases the next call to detect_input_pending to recompute input_pending.
9897 So calling this function unnecessarily can't do any harm. */
9900 clear_input_pending (void)
9905 /* Return true if there are pending requeued events.
9906 This isn't used yet. The hope is to make wait_reading_process_output
9907 call it, and return if it runs Lisp code that unreads something.
9908 The problem is, kbd_buffer_get_event needs to be fixed to know what
9909 to do in that case. It isn't trivial. */
9912 requeued_events_pending_p (void)
9914 return (!NILP (Vunread_command_events
));
9918 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9919 doc
: /* Return t if command input is currently available with no wait.
9920 Actually, the value is nil only if we can be sure that no input is available;
9921 if there is a doubt, the value is t. */)
9924 if (!NILP (Vunread_command_events
)
9925 || !NILP (Vunread_post_input_method_events
)
9926 || !NILP (Vunread_input_method_events
))
9929 /* Process non-user-visible events (Bug#10195). */
9930 process_special_events ();
9932 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
9933 | READABLE_EVENTS_FILTER_EVENTS
)
9937 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9938 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9941 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9944 if (total_keys
< NUM_RECENT_KEYS
)
9945 return Fvector (total_keys
, keys
);
9948 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9949 vcopy (val
, 0, keys
+ recent_keys_index
,
9950 NUM_RECENT_KEYS
- recent_keys_index
);
9951 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9952 keys
, recent_keys_index
);
9957 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9958 doc
: /* Return the key sequence that invoked this command.
9959 However, if the command has called `read-key-sequence', it returns
9960 the last key sequence that has been read.
9961 The value is a string or a vector.
9963 See also `this-command-keys-vector'. */)
9966 return make_event_array (this_command_key_count
,
9967 XVECTOR (this_command_keys
)->contents
);
9970 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9971 doc
: /* Return the key sequence that invoked this command, as a vector.
9972 However, if the command has called `read-key-sequence', it returns
9973 the last key sequence that has been read.
9975 See also `this-command-keys'. */)
9978 return Fvector (this_command_key_count
,
9979 XVECTOR (this_command_keys
)->contents
);
9982 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9983 Sthis_single_command_keys
, 0, 0, 0,
9984 doc
: /* Return the key sequence that invoked this command.
9985 More generally, it returns the last key sequence read, either by
9986 the command loop or by `read-key-sequence'.
9987 Unlike `this-command-keys', this function's value
9988 does not include prefix arguments.
9989 The value is always a vector. */)
9992 return Fvector (this_command_key_count
9993 - this_single_command_key_start
,
9994 (XVECTOR (this_command_keys
)->contents
9995 + this_single_command_key_start
));
9998 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9999 Sthis_single_command_raw_keys
, 0, 0, 0,
10000 doc
: /* Return the raw events that were read for this command.
10001 More generally, it returns the last key sequence read, either by
10002 the command loop or by `read-key-sequence'.
10003 Unlike `this-single-command-keys', this function's value
10004 shows the events before all translations (except for input methods).
10005 The value is always a vector. */)
10008 return Fvector (raw_keybuf_count
,
10009 (XVECTOR (raw_keybuf
)->contents
));
10012 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10013 Sreset_this_command_lengths
, 0, 0, 0,
10014 doc
: /* Make the unread events replace the last command and echo.
10015 Used in `universal-argument-other-key'.
10017 `universal-argument-other-key' rereads the event just typed.
10018 It then gets translated through `function-key-map'.
10019 The translated event has to replace the real events,
10020 both in the value of (this-command-keys) and in echoing.
10021 To achieve this, `universal-argument-other-key' calls
10022 `reset-this-command-lengths', which discards the record of reading
10023 these events the first time. */)
10026 this_command_key_count
= before_command_key_count
;
10027 if (this_command_key_count
< this_single_command_key_start
)
10028 this_single_command_key_start
= this_command_key_count
;
10030 echo_truncate (before_command_echo_length
);
10032 /* Cause whatever we put into unread-command-events
10033 to echo as if it were being freshly read from the keyboard. */
10034 this_command_key_count_reset
= 1;
10039 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10040 Sclear_this_command_keys
, 0, 1, 0,
10041 doc
: /* Clear out the vector that `this-command-keys' returns.
10042 Also clear the record of the last 100 events, unless optional arg
10043 KEEP-RECORD is non-nil. */)
10044 (Lisp_Object keep_record
)
10048 this_command_key_count
= 0;
10049 this_command_key_count_reset
= 0;
10051 if (NILP (keep_record
))
10053 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10054 ASET (recent_keys
, i
, Qnil
);
10056 recent_keys_index
= 0;
10061 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10062 doc
: /* Return the current depth in recursive edits. */)
10066 /* Wrap around reliably on integer overflow. */
10067 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10068 XSETINT (temp
, sum
);
10072 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10073 "FOpen dribble file: ",
10074 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10075 If FILE is nil, close any open dribble file.
10076 The file will be closed when Emacs exits. */)
10088 file
= Fexpand_file_name (file
, Qnil
);
10089 dribble
= emacs_fopen (SSDATA (file
), "w");
10091 report_file_error ("Opening dribble", file
);
10096 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10097 doc
: /* Discard the contents of the terminal input buffer.
10098 Also end any kbd macro being defined. */)
10101 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10103 /* Discard the last command from the macro. */
10104 Fcancel_kbd_macro_events ();
10108 Vunread_command_events
= Qnil
;
10110 discard_tty_input ();
10112 kbd_fetch_ptr
= kbd_store_ptr
;
10118 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10119 doc
: /* Stop Emacs and return to superior process. You can resume later.
10120 If `cannot-suspend' is non-nil, or if the system doesn't support job
10121 control, run a subshell instead.
10123 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10124 to be read as terminal input by Emacs's parent, after suspension.
10126 Before suspending, run the normal hook `suspend-hook'.
10127 After resumption run the normal hook `suspend-resume-hook'.
10129 Some operating systems cannot stop the Emacs process and resume it later.
10130 On such systems, Emacs starts a subshell instead of suspending. */)
10131 (Lisp_Object stuffstring
)
10133 ptrdiff_t count
= SPECPDL_INDEX ();
10134 int old_height
, old_width
;
10136 struct gcpro gcpro1
;
10139 if (tty_list
&& tty_list
->next
)
10140 error ("There are other tty frames open; close them before suspending Emacs");
10142 if (!NILP (stuffstring
))
10143 CHECK_STRING (stuffstring
);
10145 /* Run the functions in suspend-hook. */
10146 hook
= intern ("suspend-hook");
10147 Frun_hooks (1, &hook
);
10149 GCPRO1 (stuffstring
);
10150 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10151 reset_all_sys_modes ();
10152 /* sys_suspend can get an error if it tries to fork a subshell
10153 and the system resources aren't available for that. */
10154 record_unwind_protect_void (init_all_sys_modes
);
10155 stuff_buffered_input (stuffstring
);
10156 if (cannot_suspend
)
10160 unbind_to (count
, Qnil
);
10162 /* Check if terminal/window size has changed.
10163 Note that this is not useful when we are running directly
10164 with a window system; but suspend should be disabled in that case. */
10165 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10166 if (width
!= old_width
|| height
!= old_height
)
10167 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10169 /* Run suspend-resume-hook. */
10170 hook
= intern ("suspend-resume-hook");
10171 Frun_hooks (1, &hook
);
10177 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10178 Then in any case stuff anything Emacs has read ahead and not used. */
10181 stuff_buffered_input (Lisp_Object stuffstring
)
10183 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10184 register unsigned char *p
;
10186 if (STRINGP (stuffstring
))
10188 register ptrdiff_t count
;
10190 p
= SDATA (stuffstring
);
10191 count
= SBYTES (stuffstring
);
10192 while (count
-- > 0)
10197 /* Anything we have read ahead, put back for the shell to read. */
10198 /* ?? What should this do when we have multiple keyboards??
10199 Should we ignore anything that was typed in at the "wrong" kboard?
10201 rms: we should stuff everything back into the kboard
10203 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10206 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10207 kbd_fetch_ptr
= kbd_buffer
;
10208 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10209 stuff_char (kbd_fetch_ptr
->code
);
10211 clear_event (kbd_fetch_ptr
);
10215 #endif /* SIGTSTP */
10219 set_waiting_for_input (struct timespec
*time_to_clear
)
10221 input_available_clear_time
= time_to_clear
;
10223 /* Tell handle_interrupt to throw back to read_char, */
10224 waiting_for_input
= 1;
10226 /* If handle_interrupt was called before and buffered a C-g,
10227 make it run again now, to avoid timing error. */
10228 if (!NILP (Vquit_flag
))
10229 quit_throw_to_read_char (0);
10233 clear_waiting_for_input (void)
10235 /* Tell handle_interrupt not to throw back to read_char, */
10236 waiting_for_input
= 0;
10237 input_available_clear_time
= 0;
10240 /* The SIGINT handler.
10242 If we have a frame on the controlling tty, we assume that the
10243 SIGINT was generated by C-g, so we call handle_interrupt.
10244 Otherwise, tell QUIT to kill Emacs. */
10247 handle_interrupt_signal (int sig
)
10249 /* See if we have an active terminal on our controlling tty. */
10250 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10253 /* If there are no frames there, let's pretend that we are a
10254 well-behaving UN*X program and quit. We must not call Lisp
10255 in a signal handler, so tell QUIT to exit when it is
10257 Vquit_flag
= Qkill_emacs
;
10261 /* Otherwise, the SIGINT was probably generated by C-g. */
10263 /* Set internal_last_event_frame to the top frame of the
10264 controlling tty, if we have a frame there. We disable the
10265 interrupt key on secondary ttys, so the SIGINT must have come
10266 from the controlling tty. */
10267 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10269 handle_interrupt (1);
10274 deliver_interrupt_signal (int sig
)
10276 deliver_process_signal (sig
, handle_interrupt_signal
);
10280 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10281 of the number of times C-g has been requested. If C-g is pressed
10282 enough times, then quit anyway. See bug#6585. */
10283 static int volatile force_quit_count
;
10285 /* This routine is called at interrupt level in response to C-g.
10287 It is called from the SIGINT handler or kbd_buffer_store_event.
10289 If `waiting_for_input' is non zero, then unless `echoing' is
10290 nonzero, immediately throw back to read_char.
10292 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10293 eval to throw, when it gets a chance. If quit-flag is already
10294 non-nil, it stops the job right away. */
10297 handle_interrupt (bool in_signal_handler
)
10303 /* XXX This code needs to be revised for multi-tty support. */
10304 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10306 if (! in_signal_handler
)
10308 /* If SIGINT isn't blocked, don't let us be interrupted by
10309 a SIGINT. It might be harmful due to non-reentrancy
10310 in I/O functions. */
10312 sigemptyset (&blocked
);
10313 sigaddset (&blocked
, SIGINT
);
10314 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10318 reset_all_sys_modes ();
10322 * On systems which can suspend the current process and return to the original
10323 * shell, this command causes the user to end up back at the shell.
10324 * The "Auto-save" and "Abort" questions are not asked until
10325 * the user elects to return to emacs, at which point he can save the current
10326 * job and either dump core or continue.
10330 /* Perhaps should really fork an inferior shell?
10331 But that would not provide any way to get back
10332 to the original shell, ever. */
10333 printf ("No support for stopping a process on this operating system;\n");
10334 printf ("you can continue or abort.\n");
10335 #endif /* not SIGTSTP */
10337 /* We must remain inside the screen area when the internal terminal
10338 is used. Note that [Enter] is not echoed by dos. */
10339 cursor_to (SELECTED_FRAME (), 0, 0);
10341 /* It doesn't work to autosave while GC is in progress;
10342 the code used for auto-saving doesn't cope with the mark bit. */
10343 if (!gc_in_progress
)
10345 printf ("Auto-save? (y or n) ");
10347 if (((c
= getchar ()) & ~040) == 'Y')
10349 Fdo_auto_save (Qt
, Qnil
);
10351 printf ("\r\nAuto-save done");
10352 #else /* not MSDOS */
10353 printf ("Auto-save done\n");
10354 #endif /* not MSDOS */
10356 while (c
!= '\n') c
= getchar ();
10360 /* During GC, it must be safe to reenable quitting again. */
10361 Vinhibit_quit
= Qnil
;
10364 #endif /* not MSDOS */
10365 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10366 printf ("but will instead do a real quit after garbage collection ends\r\n");
10371 printf ("\r\nAbort? (y or n) ");
10372 #else /* not MSDOS */
10373 printf ("Abort (and dump core)? (y or n) ");
10374 #endif /* not MSDOS */
10376 if (((c
= getchar ()) & ~040) == 'Y')
10378 while (c
!= '\n') c
= getchar ();
10380 printf ("\r\nContinuing...\r\n");
10381 #else /* not MSDOS */
10382 printf ("Continuing...\n");
10383 #endif /* not MSDOS */
10385 init_all_sys_modes ();
10389 /* If executing a function that wants to be interrupted out of
10390 and the user has not deferred quitting by binding `inhibit-quit'
10391 then quit right away. */
10392 if (immediate_quit
&& NILP (Vinhibit_quit
))
10394 struct gl_state_s saved
;
10395 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10397 immediate_quit
= 0;
10398 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10400 GCPRO4 (saved
.object
, saved
.global_code
,
10401 saved
.current_syntax_table
, saved
.old_prop
);
10402 Fsignal (Qquit
, Qnil
);
10407 { /* Else request quit when it's safe. */
10408 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10409 force_quit_count
= count
;
10412 immediate_quit
= 1;
10413 Vinhibit_quit
= Qnil
;
10419 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10421 /* TODO: The longjmp in this call throws the NS event loop integration off,
10422 and it seems to do fine without this. Probably some attention
10423 needs to be paid to the setting of waiting_for_input in
10424 wait_reading_process_output() under HAVE_NS because of the call
10425 to ns_select there (needed because otherwise events aren't picked up
10426 outside of polling since we don't get SIGIO like X and we don't have a
10427 separate event loop thread like W32. */
10429 if (waiting_for_input
&& !echoing
)
10430 quit_throw_to_read_char (in_signal_handler
);
10434 /* Handle a C-g by making read_char return C-g. */
10437 quit_throw_to_read_char (bool from_signal
)
10439 /* When not called from a signal handler it is safe to call
10441 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10442 Fkill_emacs (Qnil
);
10444 /* Prevent another signal from doing this before we finish. */
10445 clear_waiting_for_input ();
10448 Vunread_command_events
= Qnil
;
10450 if (FRAMEP (internal_last_event_frame
)
10451 && !EQ (internal_last_event_frame
, selected_frame
))
10452 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10455 sys_longjmp (getcjmp
, 1);
10458 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10459 Sset_input_interrupt_mode
, 1, 1, 0,
10460 doc
: /* Set interrupt mode of reading keyboard input.
10461 If INTERRUPT is non-nil, Emacs will use input interrupts;
10462 otherwise Emacs uses CBREAK mode.
10464 See also `current-input-mode'. */)
10465 (Lisp_Object interrupt
)
10467 bool new_interrupt_input
;
10468 #ifdef USABLE_SIGIO
10469 #ifdef HAVE_X_WINDOWS
10470 if (x_display_list
!= NULL
)
10472 /* When using X, don't give the user a real choice,
10473 because we haven't implemented the mechanisms to support it. */
10474 new_interrupt_input
= 1;
10477 #endif /* HAVE_X_WINDOWS */
10478 new_interrupt_input
= !NILP (interrupt
);
10479 #else /* not USABLE_SIGIO */
10480 new_interrupt_input
= 0;
10481 #endif /* not USABLE_SIGIO */
10483 if (new_interrupt_input
!= interrupt_input
)
10485 #ifdef POLL_FOR_INPUT
10489 /* this causes startup screen to be restored and messes with the mouse */
10490 reset_all_sys_modes ();
10491 interrupt_input
= new_interrupt_input
;
10492 init_all_sys_modes ();
10494 interrupt_input
= new_interrupt_input
;
10497 #ifdef POLL_FOR_INPUT
10498 poll_suppress_count
= 1;
10505 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10506 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10507 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10508 C-q in key sequences.
10510 This setting only has an effect on tty terminals and only when
10511 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10513 See also `current-input-mode'. */)
10514 (Lisp_Object flow
, Lisp_Object terminal
)
10516 struct terminal
*t
= get_terminal (terminal
, 1);
10517 struct tty_display_info
*tty
;
10518 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10520 tty
= t
->display_info
.tty
;
10522 if (tty
->flow_control
!= !NILP (flow
))
10525 /* This causes startup screen to be restored and messes with the mouse. */
10526 reset_sys_modes (tty
);
10529 tty
->flow_control
= !NILP (flow
);
10532 init_sys_modes (tty
);
10538 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10539 doc
: /* Enable or disable 8-bit input on TERMINAL.
10540 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10541 bit as the Meta modifier.
10543 If META is nil, Emacs will ignore the top bit, on the assumption it is
10546 Otherwise, Emacs will accept and pass through 8-bit input without
10547 specially interpreting the top bit.
10549 This setting only has an effect on tty terminal devices.
10551 Optional parameter TERMINAL specifies the tty terminal device to use.
10552 It may be a terminal object, a frame, or nil for the terminal used by
10553 the currently selected frame.
10555 See also `current-input-mode'. */)
10556 (Lisp_Object meta
, Lisp_Object terminal
)
10558 struct terminal
*t
= get_terminal (terminal
, 1);
10559 struct tty_display_info
*tty
;
10562 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10564 tty
= t
->display_info
.tty
;
10568 else if (EQ (meta
, Qt
))
10573 if (tty
->meta_key
!= new_meta
)
10576 /* this causes startup screen to be restored and messes with the mouse */
10577 reset_sys_modes (tty
);
10580 tty
->meta_key
= new_meta
;
10583 init_sys_modes (tty
);
10589 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10590 doc
: /* Specify character used for quitting.
10591 QUIT must be an ASCII character.
10593 This function only has an effect on the controlling tty of the Emacs
10596 See also `current-input-mode'. */)
10599 struct terminal
*t
= get_named_tty ("/dev/tty");
10600 struct tty_display_info
*tty
;
10601 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10603 tty
= t
->display_info
.tty
;
10605 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10606 error ("QUIT must be an ASCII character");
10609 /* this causes startup screen to be restored and messes with the mouse */
10610 reset_sys_modes (tty
);
10613 /* Don't let this value be out of range. */
10614 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10617 init_sys_modes (tty
);
10623 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10624 doc
: /* Set mode of reading keyboard input.
10625 First arg INTERRUPT non-nil means use input interrupts;
10626 nil means use CBREAK mode.
10627 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10628 (no effect except in CBREAK mode).
10629 Third arg META t means accept 8-bit input (for a Meta key).
10630 META nil means ignore the top bit, on the assumption it is parity.
10631 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10632 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10633 See also `current-input-mode'. */)
10634 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10636 Fset_input_interrupt_mode (interrupt
);
10637 Fset_output_flow_control (flow
, Qnil
);
10638 Fset_input_meta_mode (meta
, Qnil
);
10640 Fset_quit_char (quit
);
10644 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10645 doc
: /* Return information about the way Emacs currently reads keyboard input.
10646 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10647 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10648 nil, Emacs is using CBREAK mode.
10649 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10650 terminal; this does not apply if Emacs uses interrupt-driven input.
10651 META is t if accepting 8-bit input with 8th bit as Meta flag.
10652 META nil means ignoring the top bit, on the assumption it is parity.
10653 META is neither t nor nil if accepting 8-bit input and using
10654 all 8 bits as the character code.
10655 QUIT is the character Emacs currently uses to quit.
10656 The elements of this list correspond to the arguments of
10657 `set-input-mode'. */)
10660 Lisp_Object val
[4];
10661 struct frame
*sf
= XFRAME (selected_frame
);
10663 val
[0] = interrupt_input
? Qt
: Qnil
;
10664 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10666 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10667 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10669 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10676 XSETFASTINT (val
[3], quit_char
);
10678 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10681 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10682 doc
: /* Return position information for pixel coordinates X and Y.
10683 By default, X and Y are relative to text area of the selected window.
10684 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10685 If optional fourth arg WHOLE is non-nil, X is relative to the left
10686 edge of the window.
10688 The return value is similar to a mouse click position:
10689 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10690 IMAGE (DX . DY) (WIDTH . HEIGHT))
10691 The `posn-' functions access elements of such lists. */)
10692 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10697 if (NILP (frame_or_window
))
10698 frame_or_window
= selected_window
;
10700 if (WINDOWP (frame_or_window
))
10702 struct window
*w
= decode_live_window (frame_or_window
);
10704 XSETINT (x
, (XINT (x
)
10705 + WINDOW_LEFT_EDGE_X (w
)
10707 ? window_box_left_offset (w
, TEXT_AREA
)
10709 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10710 frame_or_window
= w
->frame
;
10713 CHECK_LIVE_FRAME (frame_or_window
);
10715 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10718 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10719 doc
: /* Return position information for buffer POS in WINDOW.
10720 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10722 Return nil if position is not visible in window. Otherwise,
10723 the return value is similar to that returned by `event-start' for
10724 a mouse click at the upper left corner of the glyph corresponding
10725 to the given buffer position:
10726 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10727 IMAGE (DX . DY) (WIDTH . HEIGHT))
10728 The `posn-' functions access elements of such lists. */)
10729 (Lisp_Object pos
, Lisp_Object window
)
10734 window
= selected_window
;
10736 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10739 Lisp_Object x
= XCAR (tem
);
10740 Lisp_Object y
= XCAR (XCDR (tem
));
10742 /* Point invisible due to hscrolling? */
10745 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10753 * Set up a new kboard object with reasonable initial values.
10756 init_kboard (KBOARD
*kb
)
10758 kset_overriding_terminal_local_map (kb
, Qnil
);
10759 kset_last_command (kb
, Qnil
);
10760 kset_real_last_command (kb
, Qnil
);
10761 kset_keyboard_translate_table (kb
, Qnil
);
10762 kset_last_repeatable_command (kb
, Qnil
);
10763 kset_prefix_arg (kb
, Qnil
);
10764 kset_last_prefix_arg (kb
, Qnil
);
10765 kset_kbd_queue (kb
, Qnil
);
10766 kb
->kbd_queue_has_data
= 0;
10767 kb
->immediate_echo
= 0;
10768 kset_echo_string (kb
, Qnil
);
10769 kb
->echo_after_prompt
= -1;
10770 kb
->kbd_macro_buffer
= 0;
10771 kb
->kbd_macro_bufsize
= 0;
10772 kset_defining_kbd_macro (kb
, Qnil
);
10773 kset_last_kbd_macro (kb
, Qnil
);
10774 kb
->reference_count
= 0;
10775 kset_system_key_alist (kb
, Qnil
);
10776 kset_system_key_syms (kb
, Qnil
);
10777 kset_window_system (kb
, Qt
); /* Unset. */
10778 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10779 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10780 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10781 kset_default_minibuffer_frame (kb
, Qnil
);
10785 * Destroy the contents of a kboard object, but not the object itself.
10786 * We use this just before deleting it, or if we're going to initialize
10787 * it a second time.
10790 wipe_kboard (KBOARD
*kb
)
10792 xfree (kb
->kbd_macro_buffer
);
10795 /* Free KB and memory referenced from it. */
10798 delete_kboard (KBOARD
*kb
)
10802 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10805 *kbp
= kb
->next_kboard
;
10807 /* Prevent a dangling reference to KB. */
10808 if (kb
== current_kboard
10809 && FRAMEP (selected_frame
)
10810 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10812 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10814 if (current_kboard
== kb
)
10823 init_keyboard (void)
10825 /* This is correct before outermost invocation of the editor loop. */
10826 command_loop_level
= -1;
10827 immediate_quit
= 0;
10828 quit_char
= Ctl ('g');
10829 Vunread_command_events
= Qnil
;
10830 timer_idleness_start_time
= invalid_timespec ();
10832 recent_keys_index
= 0;
10833 kbd_fetch_ptr
= kbd_buffer
;
10834 kbd_store_ptr
= kbd_buffer
;
10835 do_mouse_tracking
= Qnil
;
10837 interrupt_input_blocked
= 0;
10838 pending_signals
= 0;
10840 /* This means that command_loop_1 won't try to select anything the first
10842 internal_last_event_frame
= Qnil
;
10843 Vlast_event_frame
= internal_last_event_frame
;
10845 current_kboard
= initial_kboard
;
10846 /* Re-initialize the keyboard again. */
10847 wipe_kboard (current_kboard
);
10848 init_kboard (current_kboard
);
10849 /* A value of nil for Vwindow_system normally means a tty, but we also use
10850 it for the initial terminal since there is no window system there. */
10851 kset_window_system (current_kboard
, Qnil
);
10853 if (!noninteractive
)
10855 /* Before multi-tty support, these handlers used to be installed
10856 only if the current session was a tty session. Now an Emacs
10857 session may have multiple display types, so we always handle
10858 SIGINT. There is special code in handle_interrupt_signal to exit
10859 Emacs on SIGINT when there are no termcap frames on the
10860 controlling terminal. */
10861 struct sigaction action
;
10862 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10863 sigaction (SIGINT
, &action
, 0);
10865 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10866 SIGQUIT and we can't tell which one it will give us. */
10867 sigaction (SIGQUIT
, &action
, 0);
10868 #endif /* not DOS_NT */
10870 #ifdef USABLE_SIGIO
10871 if (!noninteractive
)
10873 struct sigaction action
;
10874 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10875 sigaction (SIGIO
, &action
, 0);
10879 /* Use interrupt input by default, if it works and noninterrupt input
10880 has deficiencies. */
10882 #ifdef INTERRUPT_INPUT
10883 interrupt_input
= 1;
10885 interrupt_input
= 0;
10888 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10891 if (keyboard_init_hook
)
10892 (*keyboard_init_hook
) ();
10894 #ifdef POLL_FOR_INPUT
10896 poll_suppress_count
= 1;
10901 /* This type's only use is in syms_of_keyboard, to initialize the
10902 event header symbols and put properties on them. */
10903 struct event_head
{
10909 static const struct event_head head_table
[] = {
10910 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10911 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10912 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10913 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10914 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10915 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10916 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10917 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10918 /* `select-window' should be handled just like `switch-frame'
10919 in read_key_sequence. */
10920 {&Qselect_window
, "select-window", &Qswitch_frame
}
10924 syms_of_keyboard (void)
10926 pending_funcalls
= Qnil
;
10927 staticpro (&pending_funcalls
);
10929 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10930 staticpro (&Vlispy_mouse_stem
);
10933 DEFSYM (QCimage
, ":image");
10934 DEFSYM (Qhelp_echo
, "help-echo");
10935 DEFSYM (QCrtl
, ":rtl");
10937 staticpro (&item_properties
);
10938 item_properties
= Qnil
;
10940 staticpro (&tool_bar_item_properties
);
10941 tool_bar_item_properties
= Qnil
;
10942 staticpro (&tool_bar_items_vector
);
10943 tool_bar_items_vector
= Qnil
;
10945 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10946 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10947 DEFSYM (Qself_insert_command
, "self-insert-command");
10948 DEFSYM (Qforward_char
, "forward-char");
10949 DEFSYM (Qbackward_char
, "backward-char");
10950 DEFSYM (Qdisabled
, "disabled");
10951 DEFSYM (Qundefined
, "undefined");
10952 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10953 DEFSYM (Qpost_command_hook
, "post-command-hook");
10954 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10955 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10956 DEFSYM (Qfunction_key
, "function-key");
10957 DEFSYM (Qmouse_click
, "mouse-click");
10958 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10959 DEFSYM (Qsave_session
, "save-session");
10960 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10961 DEFSYM (Qmenu_enable
, "menu-enable");
10964 DEFSYM (Qlanguage_change
, "language-change");
10968 DEFSYM (Qdbus_event
, "dbus-event");
10971 #ifdef USE_FILE_NOTIFY
10972 DEFSYM (Qfile_notify
, "file-notify");
10973 #endif /* USE_FILE_NOTIFY */
10975 DEFSYM (QCenable
, ":enable");
10976 DEFSYM (QCvisible
, ":visible");
10977 DEFSYM (QChelp
, ":help");
10978 DEFSYM (QCfilter
, ":filter");
10979 DEFSYM (QCbutton
, ":button");
10980 DEFSYM (QCkeys
, ":keys");
10981 DEFSYM (QCkey_sequence
, ":key-sequence");
10982 DEFSYM (QCtoggle
, ":toggle");
10983 DEFSYM (QCradio
, ":radio");
10984 DEFSYM (QClabel
, ":label");
10985 DEFSYM (QCvert_only
, ":vert-only");
10987 DEFSYM (Qmode_line
, "mode-line");
10988 DEFSYM (Qvertical_line
, "vertical-line");
10989 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
10990 DEFSYM (Qmenu_bar
, "menu-bar");
10992 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
10994 DEFSYM (Qabove_handle
, "above-handle");
10995 DEFSYM (Qhandle
, "handle");
10996 DEFSYM (Qbelow_handle
, "below-handle");
10997 DEFSYM (Qup
, "up");
10998 DEFSYM (Qdown
, "down");
10999 DEFSYM (Qtop
, "top");
11000 DEFSYM (Qbottom
, "bottom");
11001 DEFSYM (Qend_scroll
, "end-scroll");
11002 DEFSYM (Qratio
, "ratio");
11004 DEFSYM (Qevent_kind
, "event-kind");
11005 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11006 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11007 DEFSYM (Qmodifier_cache
, "modifier-cache");
11009 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11010 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11012 DEFSYM (Qpolling_period
, "polling-period");
11014 DEFSYM (Qx_set_selection
, "x-set-selection");
11015 DEFSYM (QPRIMARY
, "PRIMARY");
11016 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11017 DEFSYM (Qhandle_select_window
, "handle-select-window");
11019 DEFSYM (Qinput_method_function
, "input-method-function");
11020 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11021 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11023 DEFSYM (Qhelp_form_show
, "help-form-show");
11025 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11026 Fset (Qinput_method_use_echo_area
, Qnil
);
11030 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11032 for (i
= 0; i
< len
; i
++)
11034 const struct event_head
*p
= &head_table
[i
];
11035 *p
->var
= intern_c_string (p
->name
);
11036 staticpro (p
->var
);
11037 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11038 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11042 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11043 staticpro (&button_down_location
);
11044 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11045 staticpro (&mouse_syms
);
11046 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11047 / sizeof (lispy_wheel_names
[0])),
11049 staticpro (&wheel_syms
);
11053 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11055 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11056 for (i
= 0; i
< len
; i
++)
11057 if (modifier_names
[i
])
11058 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11059 staticpro (&modifier_symbols
);
11062 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11063 staticpro (&recent_keys
);
11065 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11066 staticpro (&this_command_keys
);
11068 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11069 staticpro (&raw_keybuf
);
11071 DEFSYM (Qcommand_execute
, "command-execute");
11073 accent_key_syms
= Qnil
;
11074 staticpro (&accent_key_syms
);
11076 func_key_syms
= Qnil
;
11077 staticpro (&func_key_syms
);
11079 drag_n_drop_syms
= Qnil
;
11080 staticpro (&drag_n_drop_syms
);
11082 unread_switch_frame
= Qnil
;
11083 staticpro (&unread_switch_frame
);
11085 internal_last_event_frame
= Qnil
;
11086 staticpro (&internal_last_event_frame
);
11088 read_key_sequence_cmd
= Qnil
;
11089 staticpro (&read_key_sequence_cmd
);
11090 read_key_sequence_remapped
= Qnil
;
11091 staticpro (&read_key_sequence_remapped
);
11093 menu_bar_one_keymap_changed_items
= Qnil
;
11094 staticpro (&menu_bar_one_keymap_changed_items
);
11096 menu_bar_items_vector
= Qnil
;
11097 staticpro (&menu_bar_items_vector
);
11099 help_form_saved_window_configs
= Qnil
;
11100 staticpro (&help_form_saved_window_configs
);
11102 defsubr (&Scurrent_idle_time
);
11103 defsubr (&Sevent_symbol_parse_modifiers
);
11104 defsubr (&Sevent_convert_list
);
11105 defsubr (&Sread_key_sequence
);
11106 defsubr (&Sread_key_sequence_vector
);
11107 defsubr (&Srecursive_edit
);
11108 defsubr (&Strack_mouse
);
11109 defsubr (&Sinput_pending_p
);
11110 defsubr (&Srecent_keys
);
11111 defsubr (&Sthis_command_keys
);
11112 defsubr (&Sthis_command_keys_vector
);
11113 defsubr (&Sthis_single_command_keys
);
11114 defsubr (&Sthis_single_command_raw_keys
);
11115 defsubr (&Sreset_this_command_lengths
);
11116 defsubr (&Sclear_this_command_keys
);
11117 defsubr (&Ssuspend_emacs
);
11118 defsubr (&Sabort_recursive_edit
);
11119 defsubr (&Sexit_recursive_edit
);
11120 defsubr (&Srecursion_depth
);
11121 defsubr (&Stop_level
);
11122 defsubr (&Sdiscard_input
);
11123 defsubr (&Sopen_dribble_file
);
11124 defsubr (&Sset_input_interrupt_mode
);
11125 defsubr (&Sset_output_flow_control
);
11126 defsubr (&Sset_input_meta_mode
);
11127 defsubr (&Sset_quit_char
);
11128 defsubr (&Sset_input_mode
);
11129 defsubr (&Scurrent_input_mode
);
11130 defsubr (&Sposn_at_point
);
11131 defsubr (&Sposn_at_x_y
);
11133 DEFVAR_LISP ("last-command-event", last_command_event
,
11134 doc
: /* Last input event that was part of a command. */);
11136 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11137 doc
: /* Last input event in a command, except for mouse menu events.
11138 Mouse menus give back keys that don't look like mouse events;
11139 this variable holds the actual mouse event that led to the menu,
11140 so that you can determine whether the command was run by mouse or not. */);
11142 DEFVAR_LISP ("last-input-event", last_input_event
,
11143 doc
: /* Last input event. */);
11145 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11146 doc
: /* List of events to be read as the command input.
11147 These events are processed first, before actual keyboard input.
11148 Events read from this list are not normally added to `this-command-keys',
11149 as they will already have been added once as they were read for the first time.
11150 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11151 Vunread_command_events
= Qnil
;
11153 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11154 doc
: /* List of events to be processed as input by input methods.
11155 These events are processed before `unread-command-events'
11156 and actual keyboard input, but are not given to `input-method-function'. */);
11157 Vunread_post_input_method_events
= Qnil
;
11159 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11160 doc
: /* List of events to be processed as input by input methods.
11161 These events are processed after `unread-command-events', but
11162 before actual keyboard input.
11163 If there's an active input method, the events are given to
11164 `input-method-function'. */);
11165 Vunread_input_method_events
= Qnil
;
11167 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11168 doc
: /* Meta-prefix character code.
11169 Meta-foo as command input turns into this character followed by foo. */);
11170 XSETINT (meta_prefix_char
, 033);
11172 DEFVAR_KBOARD ("last-command", Vlast_command
,
11173 doc
: /* The last command executed.
11174 Normally a symbol with a function definition, but can be whatever was found
11175 in the keymap, or whatever the variable `this-command' was set to by that
11178 The value `mode-exit' is special; it means that the previous command
11179 read an event that told it to exit, and it did so and unread that event.
11180 In other words, the present command is the event that made the previous
11183 The value `kill-region' is special; it means that the previous command
11184 was a kill command.
11186 `last-command' has a separate binding for each terminal device.
11187 See Info node `(elisp)Multiple Terminals'. */);
11189 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11190 doc
: /* Same as `last-command', but never altered by Lisp code.
11191 Taken from the previous value of `real-this-command'. */);
11193 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11194 doc
: /* Last command that may be repeated.
11195 The last command executed that was not bound to an input event.
11196 This is the command `repeat' will try to repeat.
11197 Taken from a previous value of `real-this-command'. */);
11199 DEFVAR_LISP ("this-command", Vthis_command
,
11200 doc
: /* The command now being executed.
11201 The command can set this variable; whatever is put here
11202 will be in `last-command' during the following command. */);
11203 Vthis_command
= Qnil
;
11205 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11206 doc
: /* This is like `this-command', except that commands should never modify it. */);
11207 Vreal_this_command
= Qnil
;
11209 DEFVAR_LISP ("this-command-keys-shift-translated",
11210 Vthis_command_keys_shift_translated
,
11211 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11212 Shift-translation occurs when there is no binding for the key sequence
11213 as entered, but a binding was found by changing an upper-case letter
11214 to lower-case, or a shifted function key to an unshifted one. */);
11215 Vthis_command_keys_shift_translated
= Qnil
;
11217 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11218 doc
: /* The command bound to the current key sequence before remapping.
11219 It equals `this-command' if the original command was not remapped through
11220 any of the active keymaps. Otherwise, the value of `this-command' is the
11221 result of looking up the original command in the active keymaps. */);
11222 Vthis_original_command
= Qnil
;
11224 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11225 doc
: /* Number of input events between auto-saves.
11226 Zero means disable autosaving due to number of characters typed. */);
11227 auto_save_interval
= 300;
11229 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11230 doc
: /* Number of seconds idle time before auto-save.
11231 Zero or nil means disable auto-saving due to idleness.
11232 After auto-saving due to this many seconds of idle time,
11233 Emacs also does a garbage collection if that seems to be warranted. */);
11234 XSETFASTINT (Vauto_save_timeout
, 30);
11236 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11237 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11238 The value may be integer or floating point.
11239 If the value is zero, don't echo at all. */);
11240 Vecho_keystrokes
= make_number (1);
11242 DEFVAR_INT ("polling-period", polling_period
,
11243 doc
: /* Interval between polling for input during Lisp execution.
11244 The reason for polling is to make C-g work to stop a running program.
11245 Polling is needed only when using X windows and SIGIO does not work.
11246 Polling is automatically disabled in all other cases. */);
11247 polling_period
= 2;
11249 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11250 doc
: /* Maximum time between mouse clicks to make a double-click.
11251 Measured in milliseconds. The value nil means disable double-click
11252 recognition; t means double-clicks have no time limit and are detected
11253 by position only. */);
11254 Vdouble_click_time
= make_number (500);
11256 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11257 doc
: /* Maximum mouse movement between clicks to make a double-click.
11258 On window-system frames, value is the number of pixels the mouse may have
11259 moved horizontally or vertically between two clicks to make a double-click.
11260 On non window-system frames, value is interpreted in units of 1/8 characters
11263 This variable is also the threshold for motion of the mouse
11264 to count as a drag. */);
11265 double_click_fuzz
= 3;
11267 DEFVAR_INT ("num-input-keys", num_input_keys
,
11268 doc
: /* Number of complete key sequences read as input so far.
11269 This includes key sequences read from keyboard macros.
11270 The number is effectively the number of interactive command invocations. */);
11271 num_input_keys
= 0;
11273 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11274 doc
: /* Number of input events read from the keyboard so far.
11275 This does not include events generated by keyboard macros. */);
11276 num_nonmacro_input_events
= 0;
11278 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11279 doc
: /* The frame in which the most recently read event occurred.
11280 If the last event came from a keyboard macro, this is set to `macro'. */);
11281 Vlast_event_frame
= Qnil
;
11283 /* This variable is set up in sysdep.c. */
11284 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11285 doc
: /* The ERASE character as set by the user with stty. */);
11287 DEFVAR_LISP ("help-char", Vhelp_char
,
11288 doc
: /* Character to recognize as meaning Help.
11289 When it is read, do `(eval help-form)', and display result if it's a string.
11290 If the value of `help-form' is nil, this char can be read normally. */);
11291 XSETINT (Vhelp_char
, Ctl ('H'));
11293 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11294 doc
: /* List of input events to recognize as meaning Help.
11295 These work just like the value of `help-char' (see that). */);
11296 Vhelp_event_list
= Qnil
;
11298 DEFVAR_LISP ("help-form", Vhelp_form
,
11299 doc
: /* Form to execute when character `help-char' is read.
11300 If the form returns a string, that string is displayed.
11301 If `help-form' is nil, the help char is not recognized. */);
11304 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11305 doc
: /* Command to run when `help-char' character follows a prefix key.
11306 This command is used only when there is no actual binding
11307 for that character after that prefix key. */);
11308 Vprefix_help_command
= Qnil
;
11310 DEFVAR_LISP ("top-level", Vtop_level
,
11311 doc
: /* Form to evaluate when Emacs starts up.
11312 Useful to set before you dump a modified Emacs. */);
11315 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11316 doc
: /* Translate table for local keyboard input, or nil.
11317 If non-nil, the value should be a char-table. Each character read
11318 from the keyboard is looked up in this char-table. If the value found
11319 there is non-nil, then it is used instead of the actual input character.
11321 The value can also be a string or vector, but this is considered obsolete.
11322 If it is a string or vector of length N, character codes N and up are left
11323 untranslated. In a vector, an element which is nil means "no translation".
11325 This is applied to the characters supplied to input methods, not their
11326 output. See also `translation-table-for-input'.
11328 This variable has a separate binding for each terminal.
11329 See Info node `(elisp)Multiple Terminals'. */);
11331 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11332 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11333 \(Even if the operating system has support for stopping a process.\) */);
11334 cannot_suspend
= 0;
11336 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11337 doc
: /* Non-nil means prompt with menus when appropriate.
11338 This is done when reading from a keymap that has a prompt string,
11339 for elements that have prompt strings.
11340 The menu is displayed on the screen
11341 if X menus were enabled at configuration
11342 time and the previous event was a mouse click prefix key.
11343 Otherwise, menu prompting uses the echo area. */);
11344 menu_prompting
= 1;
11346 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11347 doc
: /* Character to see next line of menu prompt.
11348 Type this character while in a menu prompt to rotate around the lines of it. */);
11349 XSETINT (menu_prompt_more_char
, ' ');
11351 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11352 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11353 Emacs applies the modifiers of the character stored here to each keyboard
11354 character it reads. For example, after evaluating the expression
11355 (setq extra-keyboard-modifiers ?\\C-x)
11356 all input characters will have the control modifier applied to them.
11358 Note that the character ?\\C-@, equivalent to the integer zero, does
11359 not count as a control character; rather, it counts as a character
11360 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11361 cancels any modification. */);
11362 extra_keyboard_modifiers
= 0;
11364 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11365 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11366 The command loop sets this to nil before each command,
11367 and tests the value when the command returns.
11368 Buffer modification stores t in this variable. */);
11369 Vdeactivate_mark
= Qnil
;
11370 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11372 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11373 doc
: /* Normal hook run before each command is executed.
11374 If an unhandled error happens in running this hook,
11375 the function in which the error occurred is unconditionally removed, since
11376 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11377 Vpre_command_hook
= Qnil
;
11379 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11380 doc
: /* Normal hook run after each command is executed.
11381 If an unhandled error happens in running this hook,
11382 the function in which the error occurred is unconditionally removed, since
11383 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11384 Vpost_command_hook
= Qnil
;
11387 DEFVAR_LISP ("echo-area-clear-hook", ...,
11388 doc
: /* Normal hook run when clearing the echo area. */);
11390 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11391 Fset (Qecho_area_clear_hook
, Qnil
);
11393 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11394 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11395 Vlucid_menu_bar_dirty_flag
= Qnil
;
11397 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11398 doc
: /* List of menu bar items to move to the end of the menu bar.
11399 The elements of the list are event types that may have menu bar bindings. */);
11400 Vmenu_bar_final_items
= Qnil
;
11402 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11403 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11404 This is used internally by graphical displays that do not render
11405 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11406 Vtool_bar_separator_image_expression
= Qnil
;
11408 DEFVAR_KBOARD ("overriding-terminal-local-map",
11409 Voverriding_terminal_local_map
,
11410 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11412 This variable is intended to let commands such as `universal-argument'
11413 set up a different keymap for reading the next command.
11415 `overriding-terminal-local-map' has a separate binding for each
11417 See Info node `(elisp)Multiple Terminals'. */);
11419 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11420 doc
: /* Keymap that overrides almost all other local keymaps.
11421 If this variable is non-nil, it is used as a keymap--replacing the
11422 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11423 Voverriding_local_map
= Qnil
;
11425 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11426 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11427 Otherwise, the menu bar continues to reflect the buffer's local map
11428 and the minor mode maps regardless of `overriding-local-map'. */);
11429 Voverriding_local_map_menu_flag
= Qnil
;
11431 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11432 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11433 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11435 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11436 doc
: /* Non-nil means generate motion events for mouse motion. */);
11438 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11439 doc
: /* Alist of system-specific X windows key symbols.
11440 Each element should have the form (N . SYMBOL) where N is the
11441 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11442 and SYMBOL is its name.
11444 `system-key-alist' has a separate binding for each terminal device.
11445 See Info node `(elisp)Multiple Terminals'. */);
11447 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11448 doc
: /* Keymap that translates key sequences to key sequences during input.
11449 This is used mainly for mapping key sequences into some preferred
11450 key events (symbols).
11452 The `read-key-sequence' function replaces any subsequence bound by
11453 `local-function-key-map' with its binding. More precisely, when the
11454 active keymaps have no binding for the current key sequence but
11455 `local-function-key-map' binds a suffix of the sequence to a vector or
11456 string, `read-key-sequence' replaces the matching suffix with its
11457 binding, and continues with the new sequence.
11459 If the binding is a function, it is called with one argument (the prompt)
11460 and its return value (a key sequence) is used.
11462 The events that come from bindings in `local-function-key-map' are not
11463 themselves looked up in `local-function-key-map'.
11465 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11466 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11467 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11468 typing `ESC O P x' would return [f1 x].
11470 `local-function-key-map' has a separate binding for each terminal
11471 device. See Info node `(elisp)Multiple Terminals'. If you need to
11472 define a binding on all terminals, change `function-key-map'
11473 instead. Initially, `local-function-key-map' is an empty keymap that
11474 has `function-key-map' as its parent on all terminal devices. */);
11476 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11477 doc
: /* Keymap that decodes input escape sequences.
11478 This is used mainly for mapping ASCII function key sequences into
11479 real Emacs function key events (symbols).
11481 The `read-key-sequence' function replaces any subsequence bound by
11482 `input-decode-map' with its binding. Contrary to `function-key-map',
11483 this map applies its rebinding regardless of the presence of an ordinary
11484 binding. So it is more like `key-translation-map' except that it applies
11485 before `function-key-map' rather than after.
11487 If the binding is a function, it is called with one argument (the prompt)
11488 and its return value (a key sequence) is used.
11490 The events that come from bindings in `input-decode-map' are not
11491 themselves looked up in `input-decode-map'. */);
11493 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11494 doc
: /* The parent keymap of all `local-function-key-map' instances.
11495 Function key definitions that apply to all terminal devices should go
11496 here. If a mapping is defined in both the current
11497 `local-function-key-map' binding and this variable, then the local
11498 definition will take precedence. */);
11499 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11501 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11502 doc
: /* Keymap of key translations that can override keymaps.
11503 This keymap works like `input-decode-map', but comes after `function-key-map'.
11504 Another difference is that it is global rather than terminal-local. */);
11505 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11507 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11508 doc
: /* List of deferred actions to be performed at a later time.
11509 The precise format isn't relevant here; we just check whether it is nil. */);
11510 Vdeferred_action_list
= Qnil
;
11512 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11513 doc
: /* Function to call to handle deferred actions, after each command.
11514 This function is called with no arguments after each command
11515 whenever `deferred-action-list' is non-nil. */);
11516 Vdeferred_action_function
= Qnil
;
11518 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11519 doc
: /* List of warnings to be displayed after this command.
11520 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11521 as per the args of `display-warning' (which see).
11522 If this variable is non-nil, `delayed-warnings-hook' will be run
11523 immediately after running `post-command-hook'. */);
11524 Vdelayed_warnings_list
= Qnil
;
11526 DEFVAR_LISP ("timer-list", Vtimer_list
,
11527 doc
: /* List of active absolute time timers in order of increasing time. */);
11528 Vtimer_list
= Qnil
;
11530 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11531 doc
: /* List of active idle-time timers in order of increasing time. */);
11532 Vtimer_idle_list
= Qnil
;
11534 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11535 doc
: /* If non-nil, the function that implements the current input method.
11536 It's called with one argument, a printing character that was just read.
11537 \(That means a character with code 040...0176.)
11538 Typically this function uses `read-event' to read additional events.
11539 When it does so, it should first bind `input-method-function' to nil
11540 so it will not be called recursively.
11542 The function should return a list of zero or more events
11543 to be used as input. If it wants to put back some events
11544 to be reconsidered, separately, by the input method,
11545 it can add them to the beginning of `unread-command-events'.
11547 The input method function can find in `input-method-previous-message'
11548 the previous echo area message.
11550 The input method function should refer to the variables
11551 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11552 for guidance on what to do. */);
11553 Vinput_method_function
= Qnil
;
11555 DEFVAR_LISP ("input-method-previous-message",
11556 Vinput_method_previous_message
,
11557 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11558 This variable exists because `read-event' clears the echo area
11559 before running the input method. It is nil if there was no message. */);
11560 Vinput_method_previous_message
= Qnil
;
11562 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11563 doc
: /* If non-nil, the function that implements the display of help.
11564 It's called with one argument, the help string to display. */);
11565 Vshow_help_function
= Qnil
;
11567 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11568 doc
: /* If non-nil, suppress point adjustment after executing a command.
11570 After a command is executed, if point is moved into a region that has
11571 special properties (e.g. composition, display), we adjust point to
11572 the boundary of the region. But, when a command sets this variable to
11573 non-nil, we suppress the point adjustment.
11575 This variable is set to nil before reading a command, and is checked
11576 just after executing the command. */);
11577 Vdisable_point_adjustment
= Qnil
;
11579 DEFVAR_LISP ("global-disable-point-adjustment",
11580 Vglobal_disable_point_adjustment
,
11581 doc
: /* If non-nil, always suppress point adjustment.
11583 The default value is nil, in which case, point adjustment are
11584 suppressed only after special commands that set
11585 `disable-point-adjustment' (which see) to non-nil. */);
11586 Vglobal_disable_point_adjustment
= Qnil
;
11588 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11589 doc
: /* How long to display an echo-area message when the minibuffer is active.
11590 If the value is not a number, such messages don't time out. */);
11591 Vminibuffer_message_timeout
= make_number (2);
11593 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11594 doc
: /* If non-nil, any keyboard input throws to this symbol.
11595 The value of that variable is passed to `quit-flag' and later causes a
11596 peculiar kind of quitting. */);
11597 Vthrow_on_input
= Qnil
;
11599 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11600 doc
: /* If non-nil, function to output error messages.
11601 The arguments are the error data, a list of the form
11602 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11603 such as just as `condition-case' would bind its variable to,
11604 the context (a string which normally goes at the start of the message),
11605 and the Lisp function within which the error was signaled. */);
11606 Vcommand_error_function
= Qnil
;
11608 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11609 Venable_disabled_menus_and_buttons
,
11610 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11612 Help functions bind this to allow help on disabled menu items
11613 and tool-bar buttons. */);
11614 Venable_disabled_menus_and_buttons
= Qnil
;
11616 DEFVAR_LISP ("select-active-regions",
11617 Vselect_active_regions
,
11618 doc
: /* If non-nil, an active region automatically sets the primary selection.
11619 If the value is `only', only temporarily active regions (usually made
11620 by mouse-dragging or shift-selection) set the window selection.
11622 This takes effect only when Transient Mark mode is enabled. */);
11623 Vselect_active_regions
= Qt
;
11625 DEFVAR_LISP ("saved-region-selection",
11626 Vsaved_region_selection
,
11627 doc
: /* Contents of active region prior to buffer modification.
11628 If `select-active-regions' is non-nil, Emacs sets this to the
11629 text in the region before modifying the buffer. The next call to
11630 the function `deactivate-mark' uses this to set the window selection. */);
11631 Vsaved_region_selection
= Qnil
;
11633 DEFVAR_LISP ("selection-inhibit-update-commands",
11634 Vselection_inhibit_update_commands
,
11635 doc
: /* List of commands which should not update the selection.
11636 Normally, if `select-active-regions' is non-nil and the mark remains
11637 active after a command (i.e. the mark was not deactivated), the Emacs
11638 command loop sets the selection to the text in the region. However,
11639 if the command is in this list, the selection is not updated. */);
11640 Vselection_inhibit_update_commands
11641 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11643 DEFVAR_LISP ("debug-on-event",
11645 doc
: /* Enter debugger on this event. When Emacs
11646 receives the special event specified by this variable, it will try to
11647 break into the debugger as soon as possible instead of processing the
11648 event normally through `special-event-map'.
11650 Currently, the only supported values for this
11651 variable are `sigusr1' and `sigusr2'. */);
11652 Vdebug_on_event
= intern_c_string ("sigusr2");
11654 /* Create the initial keyboard. */
11655 initial_kboard
= xmalloc (sizeof *initial_kboard
);
11656 init_kboard (initial_kboard
);
11657 /* Vwindow_system is left at t for now. */
11658 initial_kboard
->next_kboard
= all_kboards
;
11659 all_kboards
= initial_kboard
;
11663 keys_of_keyboard (void)
11665 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11666 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11667 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11668 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11669 initial_define_key (meta_map
, 'x', "execute-extended-command");
11671 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11672 "handle-delete-frame");
11673 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11674 "ns-put-working-text");
11675 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11676 "ns-unput-working-text");
11677 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11678 current-prefix-arg, as is done in `handle-switch-frame'.
11679 But `handle-switch-frame is not run from the special-map.
11680 Commands from that map are run in a special way that automatically
11681 preserves the prefix-arg. Restoring the prefix arg here is not just
11682 redundant but harmful:
11684 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11685 - after the first prompt, the exit-minibuffer-hook is run which may
11686 iconify a frame and thus push a `iconify-frame' event.
11687 - after running exit-minibuffer-hook, current-prefix-arg is
11688 restored to the non-nil value it had before the prompt.
11689 - we enter the second prompt.
11690 current-prefix-arg is non-nil, prefix-arg is nil.
11691 - before running the first real event, we run the special iconify-frame
11692 event, but we pass the `special' arg to execute-command so
11693 current-prefix-arg and prefix-arg are left untouched.
11694 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11695 - the next key event will have a spuriously non-nil current-prefix-arg. */
11696 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11698 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11700 /* Handling it at such a low-level causes read_key_sequence to get
11701 * confused because it doesn't realize that the current_buffer was
11702 * changed by read_char.
11704 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11705 * "handle-select-window"); */
11706 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11707 "handle-save-session");
11710 /* Define a special event which is raised for dbus callback
11712 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11713 "dbus-handle-event");
11716 #ifdef USE_FILE_NOTIFY
11717 /* Define a special event which is raised for notification callback
11719 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11720 "file-notify-handle-event");
11721 #endif /* USE_FILE_NOTIFY */
11723 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11725 #if defined (WINDOWSNT)
11726 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11729 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11730 "handle-focus-in");
11731 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11732 "handle-focus-out");
11735 /* Mark the pointers in the kboard objects.
11736 Called by Fgarbage_collect. */
11738 mark_kboards (void)
11742 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11744 if (kb
->kbd_macro_buffer
)
11745 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11747 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11748 mark_object (KVAR (kb
, Vlast_command
));
11749 mark_object (KVAR (kb
, Vreal_last_command
));
11750 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11751 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11752 mark_object (KVAR (kb
, Vprefix_arg
));
11753 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11754 mark_object (KVAR (kb
, kbd_queue
));
11755 mark_object (KVAR (kb
, defining_kbd_macro
));
11756 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11757 mark_object (KVAR (kb
, Vsystem_key_alist
));
11758 mark_object (KVAR (kb
, system_key_syms
));
11759 mark_object (KVAR (kb
, Vwindow_system
));
11760 mark_object (KVAR (kb
, Vinput_decode_map
));
11761 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11762 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11763 mark_object (KVAR (kb
, echo_string
));
11766 struct input_event
*event
;
11767 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11769 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11770 event
= kbd_buffer
;
11771 /* These two special event types has no Lisp_Objects to mark. */
11772 if (event
->kind
!= SELECTION_REQUEST_EVENT
11773 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11775 mark_object (event
->x
);
11776 mark_object (event
->y
);
11777 mark_object (event
->frame_or_window
);
11778 mark_object (event
->arg
);