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.
2366 /* The arguments MAP is for menu prompting. MAP is a keymap.
2368 PREV_EVENT is the previous input event, or nil if we are reading
2369 the first event of a key sequence (or not reading a key sequence).
2370 If PREV_EVENT is t, that is a "magic" value that says
2371 not to run input methods, but in other respects to act as if
2372 not reading a key sequence.
2374 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2375 if we used a mouse menu to read the input, or false otherwise. If
2376 USED_MOUSE_MENU is null, don't dereference it.
2378 Value is -2 when we find input on another keyboard. A second call
2379 to read_char will read it.
2381 If END_TIME is non-null, it is a pointer to a struct timespec
2382 specifying the maximum time to wait until. If no input arrives by
2383 that time, stop waiting and return nil.
2385 Value is t if we showed a menu and the user rejected it. */
2388 read_char (int commandflag
, Lisp_Object map
,
2389 Lisp_Object prev_event
,
2390 bool *used_mouse_menu
, struct timespec
*end_time
)
2394 sys_jmp_buf local_getcjmp
;
2395 sys_jmp_buf save_jump
;
2396 Lisp_Object tem
, save
;
2397 volatile Lisp_Object previous_echo_area_message
;
2398 volatile Lisp_Object also_record
;
2399 volatile bool reread
;
2400 struct gcpro gcpro1
, gcpro2
;
2401 bool volatile polling_stopped_here
= 0;
2402 struct kboard
*orig_kboard
= current_kboard
;
2406 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2407 before_command_key_count
= this_command_key_count
;
2408 before_command_echo_length
= echo_length ();
2411 previous_echo_area_message
= Qnil
;
2413 GCPRO2 (c
, previous_echo_area_message
);
2418 if (CONSP (Vunread_post_input_method_events
))
2420 c
= XCAR (Vunread_post_input_method_events
);
2421 Vunread_post_input_method_events
2422 = XCDR (Vunread_post_input_method_events
);
2424 /* Undo what read_char_x_menu_prompt did when it unread
2425 additional keys returned by Fx_popup_menu. */
2427 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2435 if (CONSP (Vunread_command_events
))
2437 bool was_disabled
= 0;
2439 c
= XCAR (Vunread_command_events
);
2440 Vunread_command_events
= XCDR (Vunread_command_events
);
2444 /* Undo what sit-for did when it unread additional keys
2445 inside universal-argument. */
2448 && EQ (XCAR (c
), Qt
))
2454 /* Undo what read_char_x_menu_prompt did when it unread
2455 additional keys returned by Fx_popup_menu. */
2457 && EQ (XCDR (c
), Qdisabled
)
2458 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2464 /* If the queued event is something that used the mouse,
2465 set used_mouse_menu accordingly. */
2467 /* Also check was_disabled so last-nonmenu-event won't return
2468 a bad value when submenus are involved. (Bug#447) */
2469 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2470 *used_mouse_menu
= 1;
2472 goto reread_for_input_method
;
2475 if (CONSP (Vunread_input_method_events
))
2477 c
= XCAR (Vunread_input_method_events
);
2478 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2480 /* Undo what read_char_x_menu_prompt did when it unread
2481 additional keys returned by Fx_popup_menu. */
2483 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2487 goto reread_for_input_method
;
2490 this_command_key_count_reset
= 0;
2492 if (!NILP (Vexecuting_kbd_macro
))
2494 /* We set this to Qmacro; since that's not a frame, nobody will
2495 try to switch frames on us, and the selected window will
2498 Since this event came from a macro, it would be misleading to
2499 leave internal_last_event_frame set to wherever the last
2500 real event came from. Normally, a switch-frame event selects
2501 internal_last_event_frame after each command is read, but
2502 events read from a macro should never cause a new frame to be
2504 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2506 /* Exit the macro if we are at the end.
2507 Also, some things replace the macro with t
2508 to force an early exit. */
2509 if (EQ (Vexecuting_kbd_macro
, Qt
)
2510 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2516 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2517 if (STRINGP (Vexecuting_kbd_macro
)
2518 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2519 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2521 executing_kbd_macro_index
++;
2526 if (!NILP (unread_switch_frame
))
2528 c
= unread_switch_frame
;
2529 unread_switch_frame
= Qnil
;
2531 /* This event should make it into this_command_keys, and get echoed
2532 again, so we do not set `reread'. */
2536 /* If redisplay was requested. */
2537 if (commandflag
>= 0)
2539 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2541 /* If there is pending input, process any events which are not
2542 user-visible, such as X selection_request events. */
2544 || detect_input_pending_run_timers (0))
2545 swallow_events (0); /* May clear input_pending. */
2547 /* Redisplay if no pending input. */
2548 while (!input_pending
)
2550 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2551 redisplay_preserve_echo_area (5);
2556 /* Normal case: no input arrived during redisplay. */
2559 /* Input arrived and pre-empted redisplay.
2560 Process any events which are not user-visible. */
2562 /* If that cleared input_pending, try again to redisplay. */
2565 /* Prevent the redisplay we just did
2566 from messing up echoing of the input after the prompt. */
2567 if (commandflag
== 0 && echo_current
)
2568 echo_message_buffer
= echo_area_buffer
[0];
2572 /* Message turns off echoing unless more keystrokes turn it on again.
2574 The code in 20.x for the condition was
2576 1. echo_area_glyphs && *echo_area_glyphs
2577 2. && echo_area_glyphs != current_kboard->echobuf
2578 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2580 (1) means there's a current message displayed
2582 (2) means it's not the message from echoing from the current
2585 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2586 is set to a non-null value. This is done in read_char and it is
2587 set to echo_area_glyphs after a call to echo_char. That means
2588 ok_to_echo_at_next_pause is either null or
2589 current_kboard->echobuf with the appropriate current_kboard at
2592 So, condition (3) means in clear text ok_to_echo_at_next_pause
2593 must be either null, or the current message isn't from echoing at
2594 all, or it's from echoing from a different kboard than the
2597 if (/* There currently is something in the echo area. */
2598 !NILP (echo_area_buffer
[0])
2599 && (/* It's an echo from a different kboard. */
2600 echo_kboard
!= current_kboard
2601 /* Or we explicitly allow overwriting whatever there is. */
2602 || ok_to_echo_at_next_pause
== NULL
))
2607 /* Try reading a character via menu prompting in the minibuf.
2608 Try this before the sit-for, because the sit-for
2609 would do the wrong thing if we are supposed to do
2610 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2611 after a mouse event so don't try a minibuf menu. */
2613 if (KEYMAPP (map
) && INTERACTIVE
2614 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2615 /* Don't bring up a menu if we already have another event. */
2616 && NILP (Vunread_command_events
)
2617 && !detect_input_pending_run_timers (0))
2619 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2621 if (INTEGERP (c
) && XINT (c
) == -2)
2622 return c
; /* wrong_kboard_jmpbuf */
2628 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2629 We will do that below, temporarily for short sections of code,
2630 when appropriate. local_getcjmp must be in effect
2631 around any call to sit_for or kbd_buffer_get_event;
2632 it *must not* be in effect when we call redisplay. */
2634 jmpcount
= SPECPDL_INDEX ();
2635 if (sys_setjmp (local_getcjmp
))
2637 /* Handle quits while reading the keyboard. */
2638 /* We must have saved the outer value of getcjmp here,
2639 so restore it now. */
2640 restore_getcjmp (save_jump
);
2641 unbind_to (jmpcount
, Qnil
);
2642 XSETINT (c
, quit_char
);
2643 internal_last_event_frame
= selected_frame
;
2644 Vlast_event_frame
= internal_last_event_frame
;
2645 /* If we report the quit char as an event,
2646 don't do so more than once. */
2647 if (!NILP (Vinhibit_quit
))
2651 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2652 if (kb
!= current_kboard
)
2654 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2655 /* We shouldn't get here if we were in single-kboard mode! */
2660 while (CONSP (XCDR (last
)))
2662 if (!NILP (XCDR (last
)))
2666 kset_kbd_queue (kb
, list1 (c
));
2668 XSETCDR (last
, list1 (c
));
2669 kb
->kbd_queue_has_data
= 1;
2670 current_kboard
= kb
;
2671 /* This is going to exit from read_char
2672 so we had better get rid of this frame's stuff. */
2674 return make_number (-2); /* wrong_kboard_jmpbuf */
2680 /* Start idle timers if no time limit is supplied. We don't do it
2681 if a time limit is supplied to avoid an infinite recursion in the
2682 situation where an idle timer calls `sit-for'. */
2685 timer_start_idle ();
2687 /* If in middle of key sequence and minibuffer not active,
2688 start echoing if enough time elapses. */
2690 if (minibuf_level
== 0
2692 && !current_kboard
->immediate_echo
2693 && this_command_key_count
> 0
2695 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2696 && NILP (Fzerop (Vecho_keystrokes
))
2697 && (/* No message. */
2698 NILP (echo_area_buffer
[0])
2699 /* Or empty message. */
2700 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2701 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2702 /* Or already echoing from same kboard. */
2703 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2704 /* Or not echoing before and echoing allowed. */
2705 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2707 /* After a mouse event, start echoing right away.
2708 This is because we are probably about to display a menu,
2709 and we don't want to delay before doing so. */
2710 if (EVENT_HAS_PARAMETERS (prev_event
))
2716 save_getcjmp (save_jump
);
2717 restore_getcjmp (local_getcjmp
);
2718 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2719 restore_getcjmp (save_jump
);
2721 && ! CONSP (Vunread_command_events
))
2726 /* Maybe auto save due to number of keystrokes. */
2728 if (commandflag
!= 0
2729 && auto_save_interval
> 0
2730 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2731 && !detect_input_pending_run_timers (0))
2733 Fdo_auto_save (Qnil
, Qnil
);
2734 /* Hooks can actually change some buffers in auto save. */
2738 /* Try reading using an X menu.
2739 This is never confused with reading using the minibuf
2740 because the recursive call of read_char in read_char_minibuf_menu_prompt
2741 does not pass on any keymaps. */
2743 if (KEYMAPP (map
) && INTERACTIVE
2744 && !NILP (prev_event
)
2745 && EVENT_HAS_PARAMETERS (prev_event
)
2746 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2747 && !EQ (XCAR (prev_event
), Qtool_bar
)
2748 /* Don't bring up a menu if we already have another event. */
2749 && NILP (Vunread_command_events
))
2751 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2753 /* Now that we have read an event, Emacs is not idle. */
2760 /* Maybe autosave and/or garbage collect due to idleness. */
2762 if (INTERACTIVE
&& NILP (c
))
2765 ptrdiff_t buffer_size
;
2767 /* Slow down auto saves logarithmically in size of current buffer,
2768 and garbage collect while we're at it. */
2769 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2770 last_non_minibuf_size
= Z
- BEG
;
2771 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2773 while (buffer_size
> 64)
2774 delay_level
++, buffer_size
-= buffer_size
>> 2;
2775 if (delay_level
< 4) delay_level
= 4;
2776 /* delay_level is 4 for files under around 50k, 7 at 100k,
2777 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2779 /* Auto save if enough time goes by without input. */
2780 if (commandflag
!= 0
2781 && num_nonmacro_input_events
> last_auto_save
2782 && INTEGERP (Vauto_save_timeout
)
2783 && XINT (Vauto_save_timeout
) > 0)
2786 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2788 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2789 timeout
= delay_level
* timeout
/ 4;
2790 save_getcjmp (save_jump
);
2791 restore_getcjmp (local_getcjmp
);
2792 tem0
= sit_for (make_number (timeout
), 1, 1);
2793 restore_getcjmp (save_jump
);
2796 && ! CONSP (Vunread_command_events
))
2798 Fdo_auto_save (Qnil
, Qnil
);
2803 /* If there is still no input available, ask for GC. */
2804 if (!detect_input_pending_run_timers (0))
2808 /* Notify the caller if an autosave hook, or a timer, sentinel or
2809 filter in the sit_for calls above have changed the current
2810 kboard. This could happen if they use the minibuffer or start a
2811 recursive edit, like the fancy splash screen in server.el's
2812 filter. If this longjmp wasn't here, read_key_sequence would
2813 interpret the next key sequence using the wrong translation
2814 tables and function keymaps. */
2815 if (NILP (c
) && current_kboard
!= orig_kboard
)
2818 return make_number (-2); /* wrong_kboard_jmpbuf */
2821 /* If this has become non-nil here, it has been set by a timer
2822 or sentinel or filter. */
2823 if (CONSP (Vunread_command_events
))
2825 c
= XCAR (Vunread_command_events
);
2826 Vunread_command_events
= XCDR (Vunread_command_events
);
2829 /* Read something from current KBOARD's side queue, if possible. */
2833 if (current_kboard
->kbd_queue_has_data
)
2835 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2837 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2838 kset_kbd_queue (current_kboard
,
2839 XCDR (KVAR (current_kboard
, kbd_queue
)));
2840 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2841 current_kboard
->kbd_queue_has_data
= 0;
2842 input_pending
= readable_events (0);
2843 if (EVENT_HAS_PARAMETERS (c
)
2844 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2845 internal_last_event_frame
= XCAR (XCDR (c
));
2846 Vlast_event_frame
= internal_last_event_frame
;
2850 /* If current_kboard's side queue is empty check the other kboards.
2851 If one of them has data that we have not yet seen here,
2852 switch to it and process the data waiting for it.
2854 Note: if the events queued up for another kboard
2855 have already been seen here, and therefore are not a complete command,
2856 the kbd_queue_has_data field is 0, so we skip that kboard here.
2857 That's to avoid an infinite loop switching between kboards here. */
2858 if (NILP (c
) && !single_kboard
)
2861 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2862 if (kb
->kbd_queue_has_data
)
2864 current_kboard
= kb
;
2865 /* This is going to exit from read_char
2866 so we had better get rid of this frame's stuff. */
2868 return make_number (-2); /* wrong_kboard_jmpbuf */
2878 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2879 prev_event
, used_mouse_menu
);
2880 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2882 if (EQ (c
, make_number (-2)))
2884 /* This is going to exit from read_char
2885 so we had better get rid of this frame's stuff. */
2899 if (commandflag
>= 0
2900 && !input_pending
&& !detect_input_pending_run_timers (0))
2906 /* Buffer switch events are only for internal wakeups
2907 so don't show them to the user.
2908 Also, don't record a key if we already did. */
2912 /* Process special events within read_char
2913 and loop around to read another event. */
2916 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2921 struct buffer
*prev_buffer
= current_buffer
;
2922 last_input_event
= c
;
2923 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2925 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2926 /* We stopped being idle for this event; undo that. This
2927 prevents automatic window selection (under
2928 mouse_autoselect_window from acting as a real input event, for
2929 example banishing the mouse under mouse-avoidance-mode. */
2930 timer_resume_idle ();
2932 if (current_buffer
!= prev_buffer
)
2934 /* The command may have changed the keymaps. Pretend there
2935 is input in another keyboard and return. This will
2936 recalculate keymaps. */
2937 c
= make_number (-2);
2944 /* Handle things that only apply to characters. */
2947 /* If kbd_buffer_get_event gave us an EOF, return that. */
2951 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2952 && UNSIGNED_CMP (XFASTINT (c
), <,
2953 SCHARS (KVAR (current_kboard
,
2954 Vkeyboard_translate_table
))))
2955 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2956 && UNSIGNED_CMP (XFASTINT (c
), <,
2957 ASIZE (KVAR (current_kboard
,
2958 Vkeyboard_translate_table
))))
2959 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2963 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2964 /* nil in keyboard-translate-table means no translation. */
2970 /* If this event is a mouse click in the menu bar,
2971 return just menu-bar for now. Modify the mouse click event
2972 so we won't do this twice, then queue it up. */
2973 if (EVENT_HAS_PARAMETERS (c
)
2975 && CONSP (EVENT_START (c
))
2976 && CONSP (XCDR (EVENT_START (c
))))
2980 posn
= POSN_POSN (EVENT_START (c
));
2981 /* Handle menu-bar events:
2982 insert the dummy prefix event `menu-bar'. */
2983 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2985 /* Change menu-bar to (menu-bar) as the event "position". */
2986 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2989 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2994 /* Store these characters into recent_keys, the dribble file if any,
2995 and the keyboard macro being defined, if any. */
2997 if (! NILP (also_record
))
2998 record_char (also_record
);
3000 /* Wipe the echo area.
3001 But first, if we are about to use an input method,
3002 save the echo area contents for it to refer to. */
3004 && ! NILP (Vinput_method_function
)
3005 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3007 previous_echo_area_message
= Fcurrent_message ();
3008 Vinput_method_previous_message
= previous_echo_area_message
;
3011 /* Now wipe the echo area, except for help events which do their
3012 own stuff with the echo area. */
3014 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3015 && !(EQ (Qswitch_frame
, XCAR (c
)))
3016 /* Don't wipe echo area for select window events: These might
3017 get delayed via `mouse-autoselect-window' (Bug#11304). */
3018 && !(EQ (Qselect_window
, XCAR (c
)))))
3020 if (!NILP (echo_area_buffer
[0]))
3022 safe_run_hooks (Qecho_area_clear_hook
);
3023 clear_message (1, 0);
3027 reread_for_input_method
:
3029 /* Pass this to the input method, if appropriate. */
3031 && ! NILP (Vinput_method_function
)
3032 /* Don't run the input method within a key sequence,
3033 after the first event of the key sequence. */
3034 && NILP (prev_event
)
3035 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3038 ptrdiff_t key_count
;
3039 bool key_count_reset
;
3040 struct gcpro gcpro1
;
3041 ptrdiff_t count
= SPECPDL_INDEX ();
3043 /* Save the echo status. */
3044 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3045 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3046 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3047 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3050 if (before_command_restore_flag
)
3052 this_command_key_count
= before_command_key_count_1
;
3053 if (this_command_key_count
< this_single_command_key_start
)
3054 this_single_command_key_start
= this_command_key_count
;
3055 echo_truncate (before_command_echo_length_1
);
3056 before_command_restore_flag
= 0;
3060 /* Save the this_command_keys status. */
3061 key_count
= this_command_key_count
;
3062 key_count_reset
= this_command_key_count_reset
;
3065 keys
= Fcopy_sequence (this_command_keys
);
3070 /* Clear out this_command_keys. */
3071 this_command_key_count
= 0;
3072 this_command_key_count_reset
= 0;
3074 /* Now wipe the echo area. */
3075 if (!NILP (echo_area_buffer
[0]))
3076 safe_run_hooks (Qecho_area_clear_hook
);
3077 clear_message (1, 0);
3080 /* If we are not reading a key sequence,
3081 never use the echo area. */
3084 specbind (Qinput_method_use_echo_area
, Qt
);
3087 /* Call the input method. */
3088 tem
= call1 (Vinput_method_function
, c
);
3090 tem
= unbind_to (count
, tem
);
3092 /* Restore the saved echoing state
3093 and this_command_keys state. */
3094 this_command_key_count
= key_count
;
3095 this_command_key_count_reset
= key_count_reset
;
3097 this_command_keys
= keys
;
3100 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3101 kset_echo_string (current_kboard
, saved_echo_string
);
3102 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3103 if (saved_immediate_echo
)
3108 /* The input method can return no events. */
3111 /* Bring back the previous message, if any. */
3112 if (! NILP (previous_echo_area_message
))
3113 message_with_string ("%s", previous_echo_area_message
, 0);
3116 /* It returned one event or more. */
3118 Vunread_post_input_method_events
3119 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3124 /* Display help if not echoing. */
3125 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3127 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3128 Lisp_Object help
, object
, position
, window
, htem
;
3130 htem
= Fcdr (XCDR (c
));
3133 window
= Fcar (htem
);
3135 object
= Fcar (htem
);
3137 position
= Fcar (htem
);
3139 show_help_echo (help
, window
, object
, position
);
3141 /* We stopped being idle for this event; undo that. */
3143 timer_resume_idle ();
3147 if ((! reread
|| this_command_key_count
== 0
3148 || this_command_key_count_reset
)
3152 /* Don't echo mouse motion events. */
3153 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3154 && NILP (Fzerop (Vecho_keystrokes
))
3155 && ! (EVENT_HAS_PARAMETERS (c
)
3156 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3159 if (! NILP (also_record
))
3160 echo_char (also_record
);
3161 /* Once we reread a character, echoing can happen
3162 the next time we pause to read a new one. */
3163 ok_to_echo_at_next_pause
= current_kboard
;
3166 /* Record this character as part of the current key. */
3167 add_command_key (c
);
3168 if (! NILP (also_record
))
3169 add_command_key (also_record
);
3172 last_input_event
= c
;
3175 /* Process the help character specially if enabled. */
3176 if (!NILP (Vhelp_form
) && help_char_p (c
))
3178 ptrdiff_t count
= SPECPDL_INDEX ();
3180 help_form_saved_window_configs
3181 = Fcons (Fcurrent_window_configuration (Qnil
),
3182 help_form_saved_window_configs
);
3183 record_unwind_protect_void (read_char_help_form_unwind
);
3184 call0 (Qhelp_form_show
);
3189 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3190 if (EVENT_HAS_PARAMETERS (c
)
3191 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3192 XSETCAR (help_form_saved_window_configs
, Qnil
);
3194 while (BUFFERP (c
));
3195 /* Remove the help from the frame. */
3196 unbind_to (count
, Qnil
);
3199 if (EQ (c
, make_number (040)))
3203 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3204 while (BUFFERP (c
));
3215 /* Record a key that came from a mouse menu.
3216 Record it for echoing, for this-command-keys, and so on. */
3219 record_menu_key (Lisp_Object c
)
3221 /* Wipe the echo area. */
3222 clear_message (1, 0);
3227 before_command_key_count
= this_command_key_count
;
3228 before_command_echo_length
= echo_length ();
3231 /* Don't echo mouse motion events. */
3232 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3233 && NILP (Fzerop (Vecho_keystrokes
)))
3237 /* Once we reread a character, echoing can happen
3238 the next time we pause to read a new one. */
3239 ok_to_echo_at_next_pause
= 0;
3242 /* Record this character as part of the current key. */
3243 add_command_key (c
);
3245 /* Re-reading in the middle of a command */
3246 last_input_event
= c
;
3250 #endif /* HAVE_MENUS */
3252 /* Return true if should recognize C as "the help character". */
3255 help_char_p (Lisp_Object c
)
3259 if (EQ (c
, Vhelp_char
))
3261 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3262 if (EQ (c
, XCAR (tail
)))
3267 /* Record the input event C in various ways. */
3270 record_char (Lisp_Object c
)
3274 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3276 /* To avoid filling recent_keys with help-echo and mouse-movement
3277 events, we filter out repeated help-echo events, only store the
3278 first and last in a series of mouse-movement events, and don't
3279 store repeated help-echo events which are only separated by
3280 mouse-movement events. */
3282 Lisp_Object ev1
, ev2
, ev3
;
3285 if ((ix1
= recent_keys_index
- 1) < 0)
3286 ix1
= NUM_RECENT_KEYS
- 1;
3287 ev1
= AREF (recent_keys
, ix1
);
3289 if ((ix2
= ix1
- 1) < 0)
3290 ix2
= NUM_RECENT_KEYS
- 1;
3291 ev2
= AREF (recent_keys
, ix2
);
3293 if ((ix3
= ix2
- 1) < 0)
3294 ix3
= NUM_RECENT_KEYS
- 1;
3295 ev3
= AREF (recent_keys
, ix3
);
3297 if (EQ (XCAR (c
), Qhelp_echo
))
3299 /* Don't record `help-echo' in recent_keys unless it shows some help
3300 message, and a different help than the previously recorded
3302 Lisp_Object help
, last_help
;
3304 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3305 if (!STRINGP (help
))
3307 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3308 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3310 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3311 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3312 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3314 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3315 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3316 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3317 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3320 else if (EQ (XCAR (c
), Qmouse_movement
))
3322 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3323 So additional mouse movement events replace the last element. */
3324 Lisp_Object last_window
, window
;
3326 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3327 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3328 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3329 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3330 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3332 ASET (recent_keys
, ix1
, c
);
3338 store_kbd_macro_char (c
);
3342 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3343 ASET (recent_keys
, recent_keys_index
, c
);
3344 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3345 recent_keys_index
= 0;
3347 else if (recorded
< 0)
3349 /* We need to remove one or two events from recent_keys.
3350 To do this, we simply put nil at those events and move the
3351 recent_keys_index backwards over those events. Usually,
3352 users will never see those nil events, as they will be
3353 overwritten by the command keys entered to see recent_keys
3356 while (recorded
++ < 0 && total_keys
> 0)
3358 if (total_keys
< NUM_RECENT_KEYS
)
3360 if (--recent_keys_index
< 0)
3361 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3362 ASET (recent_keys
, recent_keys_index
, Qnil
);
3366 num_nonmacro_input_events
++;
3368 /* Write c to the dribble file. If c is a lispy event, write
3369 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3370 If you, dear reader, have a better idea, you've got the source. :-) */
3376 if (XUINT (c
) < 0x100)
3377 putc (XUINT (c
), dribble
);
3379 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3383 Lisp_Object dribblee
;
3385 /* If it's a structured event, take the event header. */
3386 dribblee
= EVENT_HEAD (c
);
3388 if (SYMBOLP (dribblee
))
3390 putc ('<', dribble
);
3391 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3392 SBYTES (SYMBOL_NAME (dribblee
)),
3394 putc ('>', dribble
);
3403 /* Copy out or in the info on where C-g should throw to.
3404 This is used when running Lisp code from within get_char,
3405 in case get_char is called recursively.
3406 See read_process_output. */
3409 save_getcjmp (sys_jmp_buf temp
)
3411 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3415 restore_getcjmp (sys_jmp_buf temp
)
3417 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3420 /* Low level keyboard/mouse input.
3421 kbd_buffer_store_event places events in kbd_buffer, and
3422 kbd_buffer_get_event retrieves them. */
3424 /* Return true if there are any events in the queue that read-char
3425 would return. If this returns false, a read-char would block. */
3427 readable_events (int flags
)
3429 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3432 /* If the buffer contains only FOCUS_IN_EVENT events, and
3433 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3434 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3436 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3437 #ifdef USE_TOOLKIT_SCROLL_BARS
3438 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3442 struct input_event
*event
;
3444 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3451 #ifdef USE_TOOLKIT_SCROLL_BARS
3452 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3454 event
->kind
== FOCUS_IN_EVENT
)
3455 #ifdef USE_TOOLKIT_SCROLL_BARS
3456 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3457 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3458 && event
->part
== scroll_bar_handle
3459 && event
->modifiers
== 0)
3464 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3467 while (event
!= kbd_store_ptr
);
3473 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3474 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3478 if (current_kboard
->kbd_queue_has_data
)
3484 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3485 if (kb
->kbd_queue_has_data
)
3491 /* Set this for debugging, to have a way to get out */
3492 int stop_character EXTERNALLY_VISIBLE
;
3495 event_to_kboard (struct input_event
*event
)
3497 /* Not applicable for these special events. */
3498 if (event
->kind
== SELECTION_REQUEST_EVENT
3499 || event
->kind
== SELECTION_CLEAR_EVENT
)
3503 Lisp_Object obj
= event
->frame_or_window
;
3504 /* There are some events that set this field to nil or string. */
3506 obj
= WINDOW_FRAME (XWINDOW (obj
));
3507 /* Also ignore dead frames here. */
3508 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3509 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3514 /* Return the number of slots occupied in kbd_buffer. */
3517 kbd_buffer_nr_stored (void)
3519 return kbd_fetch_ptr
== kbd_store_ptr
3521 : (kbd_fetch_ptr
< kbd_store_ptr
3522 ? kbd_store_ptr
- kbd_fetch_ptr
3523 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3524 + (kbd_store_ptr
- kbd_buffer
)));
3526 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3529 kbd_buffer_store_event (register struct input_event
*event
)
3531 kbd_buffer_store_event_hold (event
, 0);
3534 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3536 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3537 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3538 Else, if EVENT is a quit event, store the quit event
3539 in HOLD_QUIT, and return (thus ignoring further events).
3541 This is used to postpone the processing of the quit event until all
3542 subsequent input events have been parsed (and discarded). */
3545 kbd_buffer_store_event_hold (register struct input_event
*event
,
3546 struct input_event
*hold_quit
)
3548 if (event
->kind
== NO_EVENT
)
3551 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3554 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3556 register int c
= event
->code
& 0377;
3558 if (event
->modifiers
& ctrl_modifier
)
3559 c
= make_ctrl_char (c
);
3561 c
|= (event
->modifiers
3562 & (meta_modifier
| alt_modifier
3563 | hyper_modifier
| super_modifier
));
3567 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3568 struct input_event
*sp
;
3570 if (single_kboard
&& kb
!= current_kboard
)
3573 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3575 kb
->kbd_queue_has_data
= 1;
3576 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3578 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3581 if (event_to_kboard (sp
) == kb
)
3583 sp
->kind
= NO_EVENT
;
3584 sp
->frame_or_window
= Qnil
;
3593 *hold_quit
= *event
;
3597 /* If this results in a quit_char being returned to Emacs as
3598 input, set Vlast_event_frame properly. If this doesn't
3599 get returned to Emacs as an event, the next event read
3600 will set Vlast_event_frame again, so this is safe to do. */
3604 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3606 focus
= event
->frame_or_window
;
3607 internal_last_event_frame
= focus
;
3608 Vlast_event_frame
= focus
;
3611 last_event_timestamp
= event
->timestamp
;
3613 handle_interrupt (0);
3617 if (c
&& c
== stop_character
)
3623 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3624 Just ignore the second one. */
3625 else if (event
->kind
== BUFFER_SWITCH_EVENT
3626 && kbd_fetch_ptr
!= kbd_store_ptr
3627 && ((kbd_store_ptr
== kbd_buffer
3628 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3629 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3632 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3633 kbd_store_ptr
= kbd_buffer
;
3635 /* Don't let the very last slot in the buffer become full,
3636 since that would make the two pointers equal,
3637 and that is indistinguishable from an empty buffer.
3638 Discard the event if it would fill the last slot. */
3639 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3641 *kbd_store_ptr
= *event
;
3644 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3646 /* Don't read keyboard input until we have processed kbd_buffer.
3647 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3648 hold_keyboard_input ();
3649 if (!noninteractive
)
3653 #endif /* subprocesses */
3656 /* If we're inside while-no-input, and this event qualifies
3657 as input, set quit-flag to cause an interrupt. */
3658 if (!NILP (Vthrow_on_input
)
3659 && event
->kind
!= FOCUS_IN_EVENT
3660 && event
->kind
!= HELP_EVENT
3661 && event
->kind
!= DEICONIFY_EVENT
)
3663 Vquit_flag
= Vthrow_on_input
;
3664 /* If we're inside a function that wants immediate quits,
3666 if (immediate_quit
&& NILP (Vinhibit_quit
))
3675 /* Put an input event back in the head of the event queue. */
3678 kbd_buffer_unget_event (register struct input_event
*event
)
3680 if (kbd_fetch_ptr
== kbd_buffer
)
3681 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3683 /* Don't let the very last slot in the buffer become full, */
3684 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3687 *kbd_fetch_ptr
= *event
;
3692 /* Generate a HELP_EVENT input_event and store it in the keyboard
3695 HELP is the help form.
3697 FRAME and WINDOW are the frame and window where the help is
3698 generated. OBJECT is the Lisp object where the help was found (a
3699 buffer, a string, an overlay, or nil if neither from a string nor
3700 from a buffer). POS is the position within OBJECT where the help
3704 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3705 Lisp_Object object
, ptrdiff_t pos
)
3707 struct input_event event
;
3711 event
.kind
= HELP_EVENT
;
3712 event
.frame_or_window
= frame
;
3714 event
.x
= WINDOWP (window
) ? window
: frame
;
3717 kbd_buffer_store_event (&event
);
3721 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3724 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3726 struct input_event event
;
3728 event
.kind
= HELP_EVENT
;
3729 event
.frame_or_window
= frame
;
3734 kbd_buffer_store_event (&event
);
3738 /* Discard any mouse events in the event buffer by setting them to
3741 discard_mouse_events (void)
3743 struct input_event
*sp
;
3744 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3746 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3749 if (sp
->kind
== MOUSE_CLICK_EVENT
3750 || sp
->kind
== WHEEL_EVENT
3751 || sp
->kind
== HORIZ_WHEEL_EVENT
3753 || sp
->kind
== GPM_CLICK_EVENT
3755 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3757 sp
->kind
= NO_EVENT
;
3763 /* Return true if there are any real events waiting in the event
3764 buffer, not counting `NO_EVENT's.
3766 Discard NO_EVENT events at the front of the input queue, possibly
3767 leaving the input queue empty if there are no real input events. */
3770 kbd_buffer_events_waiting (void)
3772 struct input_event
*sp
;
3774 for (sp
= kbd_fetch_ptr
;
3775 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3778 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3783 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3787 /* Clear input event EVENT. */
3790 clear_event (struct input_event
*event
)
3792 event
->kind
= NO_EVENT
;
3796 /* Read one event from the event buffer, waiting if necessary.
3797 The value is a Lisp object representing the event.
3798 The value is nil for an event that should be ignored,
3799 or that was handled here.
3800 We always read and discard one event. */
3803 kbd_buffer_get_event (KBOARD
**kbp
,
3804 bool *used_mouse_menu
,
3805 struct timespec
*end_time
)
3810 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3812 /* Start reading input again because we have processed enough to
3813 be able to accept new events again. */
3814 unhold_keyboard_input ();
3817 #endif /* subprocesses */
3819 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3821 /* In case we are running as a daemon, only do this before
3822 detaching from the terminal. */
3823 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3827 *kbp
= current_kboard
;
3830 #endif /* ! HAVE_DBUS */
3832 /* Wait until there is input available. */
3835 /* Break loop if there's an unread command event. Needed in
3836 moused window autoselection which uses a timer to insert such
3838 if (CONSP (Vunread_command_events
))
3841 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3843 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3846 /* If the quit flag is set, then read_char will return
3847 quit_char, so that counts as "available input." */
3848 if (!NILP (Vquit_flag
))
3849 quit_throw_to_read_char (0);
3851 /* One way or another, wait until input is available; then, if
3852 interrupt handlers have not read it, read it now. */
3857 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3859 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3863 struct timespec now
= current_timespec ();
3864 if (timespec_cmp (*end_time
, now
) <= 0)
3865 return Qnil
; /* Finished waiting. */
3868 struct timespec duration
= timespec_sub (*end_time
, now
);
3869 wait_reading_process_output (min (duration
.tv_sec
,
3872 -1, 1, Qnil
, NULL
, 0);
3876 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3878 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3882 if (CONSP (Vunread_command_events
))
3885 first
= XCAR (Vunread_command_events
);
3886 Vunread_command_events
= XCDR (Vunread_command_events
);
3887 *kbp
= current_kboard
;
3891 /* At this point, we know that there is a readable event available
3892 somewhere. If the event queue is empty, then there must be a
3893 mouse movement enabled and available. */
3894 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3896 struct input_event
*event
;
3898 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3902 last_event_timestamp
= event
->timestamp
;
3904 *kbp
= event_to_kboard (event
);
3906 *kbp
= current_kboard
; /* Better than returning null ptr? */
3910 /* These two kinds of events get special handling
3911 and don't actually appear to the command loop.
3912 We return nil for them. */
3913 if (event
->kind
== SELECTION_REQUEST_EVENT
3914 || event
->kind
== SELECTION_CLEAR_EVENT
)
3917 struct input_event copy
;
3919 /* Remove it from the buffer before processing it,
3920 since otherwise swallow_events will see it
3921 and process it again. */
3923 kbd_fetch_ptr
= event
+ 1;
3924 input_pending
= readable_events (0);
3925 x_handle_selection_event (©
);
3927 /* We're getting selection request events, but we don't have
3933 #if defined (HAVE_NS)
3934 else if (event
->kind
== NS_TEXT_EVENT
)
3936 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3937 obj
= list1 (intern ("ns-put-working-text"));
3939 obj
= list1 (intern ("ns-unput-working-text"));
3940 kbd_fetch_ptr
= event
+ 1;
3941 if (used_mouse_menu
)
3942 *used_mouse_menu
= 1;
3946 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3947 || defined (HAVE_NS)
3948 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3950 /* Make an event (delete-frame (FRAME)). */
3951 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3952 kbd_fetch_ptr
= event
+ 1;
3955 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3956 || defined (HAVE_NS)
3957 else if (event
->kind
== ICONIFY_EVENT
)
3959 /* Make an event (iconify-frame (FRAME)). */
3960 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3961 kbd_fetch_ptr
= event
+ 1;
3963 else if (event
->kind
== DEICONIFY_EVENT
)
3965 /* Make an event (make-frame-visible (FRAME)). */
3966 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3967 kbd_fetch_ptr
= event
+ 1;
3970 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3972 /* The value doesn't matter here; only the type is tested. */
3973 XSETBUFFER (obj
, current_buffer
);
3974 kbd_fetch_ptr
= event
+ 1;
3976 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3977 || defined (HAVE_NS) || defined (USE_GTK)
3978 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3980 kbd_fetch_ptr
= event
+ 1;
3981 input_pending
= readable_events (0);
3982 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3983 x_activate_menubar (XFRAME (event
->frame_or_window
));
3987 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3989 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3990 obj
= list4 (Qlanguage_change
,
3991 event
->frame_or_window
,
3992 make_number (event
->code
),
3993 make_number (event
->modifiers
));
3994 kbd_fetch_ptr
= event
+ 1;
3997 #ifdef USE_FILE_NOTIFY
3998 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4000 #ifdef HAVE_W32NOTIFY
4001 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4002 obj
= list3 (Qfile_notify
,
4003 list3 (make_number (event
->code
),
4006 event
->frame_or_window
);
4008 obj
= make_lispy_event (event
);
4010 kbd_fetch_ptr
= event
+ 1;
4012 #endif /* USE_FILE_NOTIFY */
4013 else if (event
->kind
== SAVE_SESSION_EVENT
)
4015 obj
= list2 (Qsave_session
, event
->arg
);
4016 kbd_fetch_ptr
= event
+ 1;
4018 /* Just discard these, by returning nil.
4019 With MULTI_KBOARD, these events are used as placeholders
4020 when we need to randomly delete events from the queue.
4021 (They shouldn't otherwise be found in the buffer,
4022 but on some machines it appears they do show up
4023 even without MULTI_KBOARD.) */
4024 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4025 mouse events during a popup-menu call. */
4026 else if (event
->kind
== NO_EVENT
)
4027 kbd_fetch_ptr
= event
+ 1;
4028 else if (event
->kind
== HELP_EVENT
)
4030 Lisp_Object object
, position
, help
, frame
, window
;
4032 frame
= event
->frame_or_window
;
4033 object
= event
->arg
;
4034 position
= make_number (event
->code
);
4037 clear_event (event
);
4039 kbd_fetch_ptr
= event
+ 1;
4040 if (!WINDOWP (window
))
4042 obj
= Fcons (Qhelp_echo
,
4043 list5 (frame
, help
, window
, object
, position
));
4045 else if (event
->kind
== FOCUS_IN_EVENT
)
4047 /* Notification of a FocusIn event. The frame receiving the
4048 focus is in event->frame_or_window. Generate a
4049 switch-frame event if necessary. */
4050 Lisp_Object frame
, focus
;
4052 frame
= event
->frame_or_window
;
4053 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4062 !EQ (frame
, internal_last_event_frame
)
4063 && !EQ (frame
, selected_frame
))
4064 obj
= make_lispy_switch_frame (frame
);
4066 obj
= make_lispy_focus_in (frame
);
4068 internal_last_event_frame
= frame
;
4069 kbd_fetch_ptr
= event
+ 1;
4071 else if (event
->kind
== FOCUS_OUT_EVENT
)
4073 #ifdef HAVE_WINDOW_SYSTEM
4076 Lisp_Object frame
= event
->frame_or_window
;
4077 bool focused
= false;
4079 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4080 focused
= di
->x_highlight_frame
!= 0;
4083 obj
= make_lispy_focus_out (frame
);
4085 #endif /* HAVE_WINDOW_SYSTEM */
4087 kbd_fetch_ptr
= event
+ 1;
4090 else if (event
->kind
== DBUS_EVENT
)
4092 obj
= make_lispy_event (event
);
4093 kbd_fetch_ptr
= event
+ 1;
4096 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4098 obj
= make_lispy_event (event
);
4099 kbd_fetch_ptr
= event
+ 1;
4103 /* If this event is on a different frame, return a switch-frame this
4104 time, and leave the event in the queue for next time. */
4108 frame
= event
->frame_or_window
;
4110 frame
= XCAR (frame
);
4111 else if (WINDOWP (frame
))
4112 frame
= WINDOW_FRAME (XWINDOW (frame
));
4114 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4118 if (! EQ (frame
, internal_last_event_frame
)
4119 && !EQ (frame
, selected_frame
))
4120 obj
= make_lispy_switch_frame (frame
);
4121 internal_last_event_frame
= frame
;
4123 /* If we didn't decide to make a switch-frame event, go ahead
4124 and build a real event from the queue entry. */
4128 obj
= make_lispy_event (event
);
4130 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4131 || defined (HAVE_NS) || defined (USE_GTK)
4132 /* If this was a menu selection, then set the flag to inhibit
4133 writing to last_nonmenu_event. Don't do this if the event
4134 we're returning is (menu-bar), though; that indicates the
4135 beginning of the menu sequence, and we might as well leave
4136 that as the `event with parameters' for this selection. */
4138 && !EQ (event
->frame_or_window
, event
->arg
)
4139 && (event
->kind
== MENU_BAR_EVENT
4140 || event
->kind
== TOOL_BAR_EVENT
))
4141 *used_mouse_menu
= 1;
4144 /* Certain system events are non-key events. */
4146 && event
->kind
== NS_NONKEY_EVENT
)
4147 *used_mouse_menu
= 1;
4150 /* Wipe out this event, to catch bugs. */
4151 clear_event (event
);
4152 kbd_fetch_ptr
= event
+ 1;
4156 /* Try generating a mouse motion event. */
4157 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4159 struct frame
*f
= some_mouse_moved ();
4160 Lisp_Object bar_window
;
4161 enum scroll_bar_part part
;
4165 *kbp
= current_kboard
;
4166 /* Note that this uses F to determine which terminal to look at.
4167 If there is no valid info, it does not store anything
4168 so x remains nil. */
4171 /* XXX Can f or mouse_position_hook be NULL here? */
4172 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4173 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4178 /* Decide if we should generate a switch-frame event. Don't
4179 generate switch-frame events for motion outside of all Emacs
4185 frame
= FRAME_FOCUS_FRAME (f
);
4187 XSETFRAME (frame
, f
);
4189 if (! EQ (frame
, internal_last_event_frame
)
4190 && !EQ (frame
, selected_frame
))
4191 obj
= make_lispy_switch_frame (frame
);
4192 internal_last_event_frame
= frame
;
4195 /* If we didn't decide to make a switch-frame event, go ahead and
4196 return a mouse-motion event. */
4197 if (!NILP (x
) && NILP (obj
))
4198 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4201 /* We were promised by the above while loop that there was
4202 something for us to read! */
4205 input_pending
= readable_events (0);
4207 Vlast_event_frame
= internal_last_event_frame
;
4212 /* Process any non-user-visible events (currently X selection events),
4213 without reading any user-visible events. */
4216 process_special_events (void)
4218 struct input_event
*event
;
4220 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4222 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4225 if (event
== kbd_store_ptr
)
4229 /* If we find a stored X selection request, handle it now. */
4230 if (event
->kind
== SELECTION_REQUEST_EVENT
4231 || event
->kind
== SELECTION_CLEAR_EVENT
)
4235 /* Remove the event from the fifo buffer before processing;
4236 otherwise swallow_events called recursively could see it
4237 and process it again. To do this, we move the events
4238 between kbd_fetch_ptr and EVENT one slot to the right,
4241 struct input_event copy
= *event
;
4242 struct input_event
*beg
4243 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4244 ? kbd_buffer
: kbd_fetch_ptr
;
4247 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4248 else if (event
< beg
)
4250 if (event
> kbd_buffer
)
4251 memmove (kbd_buffer
+ 1, kbd_buffer
,
4252 (event
- kbd_buffer
) * sizeof (struct input_event
));
4253 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4254 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4255 memmove (beg
+ 1, beg
,
4256 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4257 * sizeof (struct input_event
));
4260 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4261 kbd_fetch_ptr
= kbd_buffer
+ 1;
4265 /* X wants last_event_timestamp for selection ownership. */
4266 last_event_timestamp
= copy
.timestamp
;
4267 input_pending
= readable_events (0);
4268 x_handle_selection_event (©
);
4270 /* We're getting selection request events, but we don't have
4278 /* Process any events that are not user-visible, run timer events that
4279 are ripe, and return, without reading any user-visible events. */
4282 swallow_events (bool do_display
)
4284 unsigned old_timers_run
;
4286 process_special_events ();
4288 old_timers_run
= timers_run
;
4289 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4291 if (timers_run
!= old_timers_run
&& do_display
)
4292 redisplay_preserve_echo_area (7);
4295 /* Record the start of when Emacs is idle,
4296 for the sake of running idle-time timers. */
4299 timer_start_idle (void)
4301 /* If we are already in the idle state, do nothing. */
4302 if (timespec_valid_p (timer_idleness_start_time
))
4305 timer_idleness_start_time
= current_timespec ();
4306 timer_last_idleness_start_time
= timer_idleness_start_time
;
4308 /* Mark all idle-time timers as once again candidates for running. */
4309 call0 (intern ("internal-timer-start-idle"));
4312 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4315 timer_stop_idle (void)
4317 timer_idleness_start_time
= invalid_timespec ();
4320 /* Resume idle timer from last idle start time. */
4323 timer_resume_idle (void)
4325 if (timespec_valid_p (timer_idleness_start_time
))
4328 timer_idleness_start_time
= timer_last_idleness_start_time
;
4331 /* This is only for debugging. */
4332 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4334 /* List of elisp functions to call, delayed because they were generated in
4335 a context where Elisp could not be safely run (e.g. redisplay, signal,
4336 ...). Each element has the form (FUN . ARGS). */
4337 Lisp_Object pending_funcalls
;
4339 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4341 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4343 Lisp_Object
*vector
;
4345 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4347 vector
= XVECTOR (timer
)->contents
;
4348 if (! NILP (vector
[0]))
4351 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4356 /* Check whether a timer has fired. To prevent larger problems we simply
4357 disregard elements that are not proper timers. Do not make a circular
4358 timer list for the time being.
4360 Returns the time to wait until the next timer fires. If a
4361 timer is triggering now, return zero.
4362 If no timer is active, return -1.
4364 If a timer is ripe, we run it, with quitting turned off.
4365 In that case we return 0 to indicate that a new timer_check_2 call
4368 static struct timespec
4369 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4371 struct timespec nexttime
;
4372 struct timespec now
;
4373 struct timespec idleness_now
;
4374 Lisp_Object chosen_timer
;
4375 struct gcpro gcpro1
;
4377 nexttime
= invalid_timespec ();
4379 chosen_timer
= Qnil
;
4380 GCPRO1 (chosen_timer
);
4382 /* First run the code that was delayed. */
4383 while (CONSP (pending_funcalls
))
4385 Lisp_Object funcall
= XCAR (pending_funcalls
);
4386 pending_funcalls
= XCDR (pending_funcalls
);
4387 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4390 if (CONSP (timers
) || CONSP (idle_timers
))
4392 now
= current_timespec ();
4393 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4394 ? timespec_sub (now
, timer_idleness_start_time
)
4395 : make_timespec (0, 0));
4398 while (CONSP (timers
) || CONSP (idle_timers
))
4400 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4401 struct timespec timer_time
, idle_timer_time
;
4402 struct timespec difference
;
4403 struct timespec timer_difference
= invalid_timespec ();
4404 struct timespec idle_timer_difference
= invalid_timespec ();
4405 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4407 /* Set TIMER and TIMER_DIFFERENCE
4408 based on the next ordinary timer.
4409 TIMER_DIFFERENCE is the distance in time from NOW to when
4410 this timer becomes ripe (negative if it's already ripe).
4411 Skip past invalid timers and timers already handled. */
4414 timer
= XCAR (timers
);
4415 if (! decode_timer (timer
, &timer_time
))
4417 timers
= XCDR (timers
);
4421 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4422 timer_difference
= (timer_ripe
4423 ? timespec_sub (now
, timer_time
)
4424 : timespec_sub (timer_time
, now
));
4427 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4428 based on the next idle timer. */
4429 if (CONSP (idle_timers
))
4431 idle_timer
= XCAR (idle_timers
);
4432 if (! decode_timer (idle_timer
, &idle_timer_time
))
4434 idle_timers
= XCDR (idle_timers
);
4438 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4439 idle_timer_difference
4441 ? timespec_sub (idleness_now
, idle_timer_time
)
4442 : timespec_sub (idle_timer_time
, idleness_now
));
4445 /* Decide which timer is the next timer,
4446 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4447 Also step down the list where we found that timer. */
4449 if (timespec_valid_p (timer_difference
)
4450 && (! timespec_valid_p (idle_timer_difference
)
4451 || idle_timer_ripe
< timer_ripe
4452 || (idle_timer_ripe
== timer_ripe
4454 ? timespec_cmp (idle_timer_difference
,
4456 : timespec_cmp (timer_difference
,
4457 idle_timer_difference
))
4460 chosen_timer
= timer
;
4461 timers
= XCDR (timers
);
4462 difference
= timer_difference
;
4467 chosen_timer
= idle_timer
;
4468 idle_timers
= XCDR (idle_timers
);
4469 difference
= idle_timer_difference
;
4470 ripe
= idle_timer_ripe
;
4473 /* If timer is ripe, run it if it hasn't been run. */
4476 if (NILP (AREF (chosen_timer
, 0)))
4478 ptrdiff_t count
= SPECPDL_INDEX ();
4479 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4481 /* Mark the timer as triggered to prevent problems if the lisp
4482 code fails to reschedule it right. */
4483 ASET (chosen_timer
, 0, Qt
);
4485 specbind (Qinhibit_quit
, Qt
);
4487 call1 (Qtimer_event_handler
, chosen_timer
);
4488 Vdeactivate_mark
= old_deactivate_mark
;
4490 unbind_to (count
, Qnil
);
4492 /* Since we have handled the event,
4493 we don't need to tell the caller to wake up and do it. */
4494 /* But the caller must still wait for the next timer, so
4495 return 0 to indicate that. */
4498 nexttime
= make_timespec (0, 0);
4502 /* When we encounter a timer that is still waiting,
4503 return the amount of time to wait before it is ripe. */
4510 /* No timers are pending in the future. */
4511 /* Return 0 if we generated an event, and -1 if not. */
4517 /* Check whether a timer has fired. To prevent larger problems we simply
4518 disregard elements that are not proper timers. Do not make a circular
4519 timer list for the time being.
4521 Returns the time to wait until the next timer fires.
4522 If no timer is active, return an invalid value.
4524 As long as any timer is ripe, we run it. */
4529 struct timespec nexttime
;
4530 Lisp_Object timers
, idle_timers
;
4531 struct gcpro gcpro1
, gcpro2
;
4533 Lisp_Object tem
= Vinhibit_quit
;
4536 /* We use copies of the timers' lists to allow a timer to add itself
4537 again, without locking up Emacs if the newly added timer is
4538 already ripe when added. */
4540 /* Always consider the ordinary timers. */
4541 timers
= Fcopy_sequence (Vtimer_list
);
4542 /* Consider the idle timers only if Emacs is idle. */
4543 if (timespec_valid_p (timer_idleness_start_time
))
4544 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4548 Vinhibit_quit
= tem
;
4550 GCPRO2 (timers
, idle_timers
);
4554 nexttime
= timer_check_2 (timers
, idle_timers
);
4556 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4562 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4563 doc
: /* Return the current length of Emacs idleness, or nil.
4564 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4565 in the same style as (current-time).
4567 The value when Emacs is not idle is nil.
4569 PSEC is a multiple of the system clock resolution. */)
4572 if (timespec_valid_p (timer_idleness_start_time
))
4573 return make_lisp_time (timespec_sub (current_timespec (),
4574 timer_idleness_start_time
));
4579 /* Caches for modify_event_symbol. */
4580 static Lisp_Object accent_key_syms
;
4581 static Lisp_Object func_key_syms
;
4582 static Lisp_Object mouse_syms
;
4583 static Lisp_Object wheel_syms
;
4584 static Lisp_Object drag_n_drop_syms
;
4586 /* This is a list of keysym codes for special "accent" characters.
4587 It parallels lispy_accent_keys. */
4589 static const int lispy_accent_codes
[] =
4591 #ifdef XK_dead_circumflex
4596 #ifdef XK_dead_grave
4601 #ifdef XK_dead_tilde
4606 #ifdef XK_dead_diaeresis
4611 #ifdef XK_dead_macron
4616 #ifdef XK_dead_degree
4621 #ifdef XK_dead_acute
4626 #ifdef XK_dead_cedilla
4631 #ifdef XK_dead_breve
4636 #ifdef XK_dead_ogonek
4641 #ifdef XK_dead_caron
4646 #ifdef XK_dead_doubleacute
4647 XK_dead_doubleacute
,
4651 #ifdef XK_dead_abovedot
4656 #ifdef XK_dead_abovering
4666 #ifdef XK_dead_belowdot
4671 #ifdef XK_dead_voiced_sound
4672 XK_dead_voiced_sound
,
4676 #ifdef XK_dead_semivoiced_sound
4677 XK_dead_semivoiced_sound
,
4693 /* This is a list of Lisp names for special "accent" characters.
4694 It parallels lispy_accent_codes. */
4696 static const char *const lispy_accent_keys
[] =
4714 "dead-voiced-sound",
4715 "dead-semivoiced-sound",
4721 #define FUNCTION_KEY_OFFSET 0x0
4723 const char *const lispy_function_keys
[] =
4727 0, /* VK_LBUTTON 0x01 */
4728 0, /* VK_RBUTTON 0x02 */
4729 "cancel", /* VK_CANCEL 0x03 */
4730 0, /* VK_MBUTTON 0x04 */
4732 0, 0, 0, /* 0x05 .. 0x07 */
4734 "backspace", /* VK_BACK 0x08 */
4735 "tab", /* VK_TAB 0x09 */
4737 0, 0, /* 0x0A .. 0x0B */
4739 "clear", /* VK_CLEAR 0x0C */
4740 "return", /* VK_RETURN 0x0D */
4742 0, 0, /* 0x0E .. 0x0F */
4744 0, /* VK_SHIFT 0x10 */
4745 0, /* VK_CONTROL 0x11 */
4746 0, /* VK_MENU 0x12 */
4747 "pause", /* VK_PAUSE 0x13 */
4748 "capslock", /* VK_CAPITAL 0x14 */
4749 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4751 "junja", /* VK_JUNJA 0x17 */
4752 "final", /* VK_FINAL 0x18 */
4753 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4755 "escape", /* VK_ESCAPE 0x1B */
4756 "convert", /* VK_CONVERT 0x1C */
4757 "non-convert", /* VK_NONCONVERT 0x1D */
4758 "accept", /* VK_ACCEPT 0x1E */
4759 "mode-change", /* VK_MODECHANGE 0x1F */
4760 0, /* VK_SPACE 0x20 */
4761 "prior", /* VK_PRIOR 0x21 */
4762 "next", /* VK_NEXT 0x22 */
4763 "end", /* VK_END 0x23 */
4764 "home", /* VK_HOME 0x24 */
4765 "left", /* VK_LEFT 0x25 */
4766 "up", /* VK_UP 0x26 */
4767 "right", /* VK_RIGHT 0x27 */
4768 "down", /* VK_DOWN 0x28 */
4769 "select", /* VK_SELECT 0x29 */
4770 "print", /* VK_PRINT 0x2A */
4771 "execute", /* VK_EXECUTE 0x2B */
4772 "snapshot", /* VK_SNAPSHOT 0x2C */
4773 "insert", /* VK_INSERT 0x2D */
4774 "delete", /* VK_DELETE 0x2E */
4775 "help", /* VK_HELP 0x2F */
4777 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4779 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4781 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4783 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4785 0, 0, 0, 0, 0, 0, 0, 0, 0,
4786 0, 0, 0, 0, 0, 0, 0, 0, 0,
4787 0, 0, 0, 0, 0, 0, 0, 0,
4789 "lwindow", /* VK_LWIN 0x5B */
4790 "rwindow", /* VK_RWIN 0x5C */
4791 "apps", /* VK_APPS 0x5D */
4794 "kp-0", /* VK_NUMPAD0 0x60 */
4795 "kp-1", /* VK_NUMPAD1 0x61 */
4796 "kp-2", /* VK_NUMPAD2 0x62 */
4797 "kp-3", /* VK_NUMPAD3 0x63 */
4798 "kp-4", /* VK_NUMPAD4 0x64 */
4799 "kp-5", /* VK_NUMPAD5 0x65 */
4800 "kp-6", /* VK_NUMPAD6 0x66 */
4801 "kp-7", /* VK_NUMPAD7 0x67 */
4802 "kp-8", /* VK_NUMPAD8 0x68 */
4803 "kp-9", /* VK_NUMPAD9 0x69 */
4804 "kp-multiply", /* VK_MULTIPLY 0x6A */
4805 "kp-add", /* VK_ADD 0x6B */
4806 "kp-separator", /* VK_SEPARATOR 0x6C */
4807 "kp-subtract", /* VK_SUBTRACT 0x6D */
4808 "kp-decimal", /* VK_DECIMAL 0x6E */
4809 "kp-divide", /* VK_DIVIDE 0x6F */
4810 "f1", /* VK_F1 0x70 */
4811 "f2", /* VK_F2 0x71 */
4812 "f3", /* VK_F3 0x72 */
4813 "f4", /* VK_F4 0x73 */
4814 "f5", /* VK_F5 0x74 */
4815 "f6", /* VK_F6 0x75 */
4816 "f7", /* VK_F7 0x76 */
4817 "f8", /* VK_F8 0x77 */
4818 "f9", /* VK_F9 0x78 */
4819 "f10", /* VK_F10 0x79 */
4820 "f11", /* VK_F11 0x7A */
4821 "f12", /* VK_F12 0x7B */
4822 "f13", /* VK_F13 0x7C */
4823 "f14", /* VK_F14 0x7D */
4824 "f15", /* VK_F15 0x7E */
4825 "f16", /* VK_F16 0x7F */
4826 "f17", /* VK_F17 0x80 */
4827 "f18", /* VK_F18 0x81 */
4828 "f19", /* VK_F19 0x82 */
4829 "f20", /* VK_F20 0x83 */
4830 "f21", /* VK_F21 0x84 */
4831 "f22", /* VK_F22 0x85 */
4832 "f23", /* VK_F23 0x86 */
4833 "f24", /* VK_F24 0x87 */
4835 0, 0, 0, 0, /* 0x88 .. 0x8B */
4836 0, 0, 0, 0, /* 0x8C .. 0x8F */
4838 "kp-numlock", /* VK_NUMLOCK 0x90 */
4839 "scroll", /* VK_SCROLL 0x91 */
4840 /* Not sure where the following block comes from.
4841 Windows headers have NEC and Fujitsu specific keys in
4842 this block, but nothing generic. */
4843 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4844 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4845 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4846 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4847 "kp-end", /* VK_NUMPAD_END 0x96 */
4848 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4849 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4850 "kp-up", /* VK_NUMPAD_UP 0x99 */
4851 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4852 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4853 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4854 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4856 0, 0, /* 0x9E .. 0x9F */
4859 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4860 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4861 * No other API or message will distinguish left and right keys this way.
4866 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4867 to enable them selectively, and gives access to a few more functions.
4868 See lispy_multimedia_keys below. */
4869 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4870 0, 0, 0, /* 0xAD .. 0xAF Volume */
4871 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4872 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4874 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4875 0, 0, 0, 0, 0, 0, 0, 0, 0,
4877 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4878 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4879 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4882 "ax", /* VK_OEM_AX 0xE1 */
4883 0, /* VK_OEM_102 0xE2 */
4884 "ico-help", /* VK_ICO_HELP 0xE3 */
4885 "ico-00", /* VK_ICO_00 0xE4 */
4886 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4887 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4888 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4890 "reset", /* VK_OEM_RESET 0xE9 */
4891 "jump", /* VK_OEM_JUMP 0xEA */
4892 "oem-pa1", /* VK_OEM_PA1 0xEB */
4893 "oem-pa2", /* VK_OEM_PA2 0xEC */
4894 "oem-pa3", /* VK_OEM_PA3 0xED */
4895 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4896 "cusel", /* VK_OEM_CUSEL 0xEF */
4897 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4898 "finish", /* VK_OEM_FINISH 0xF1 */
4899 "copy", /* VK_OEM_COPY 0xF2 */
4900 "auto", /* VK_OEM_AUTO 0xF3 */
4901 "enlw", /* VK_OEM_ENLW 0xF4 */
4902 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4903 "attn", /* VK_ATTN 0xF6 */
4904 "crsel", /* VK_CRSEL 0xF7 */
4905 "exsel", /* VK_EXSEL 0xF8 */
4906 "ereof", /* VK_EREOF 0xF9 */
4907 "play", /* VK_PLAY 0xFA */
4908 "zoom", /* VK_ZOOM 0xFB */
4909 "noname", /* VK_NONAME 0xFC */
4910 "pa1", /* VK_PA1 0xFD */
4911 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4915 /* Some of these duplicate the "Media keys" on newer keyboards,
4916 but they are delivered to the application in a different way. */
4917 static const char *const lispy_multimedia_keys
[] =
4925 "browser-favorites",
4962 "toggle-dictate-command",
4968 "media-fast-forward",
4971 "media-channel-down"
4974 #else /* not HAVE_NTGUI */
4976 /* This should be dealt with in XTread_socket now, and that doesn't
4977 depend on the client system having the Kana syms defined. See also
4978 the XK_kana_A case below. */
4981 static const char *const lispy_kana_keys
[] =
4983 /* X Keysym value */
4984 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4985 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4986 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4987 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4988 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4989 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4990 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4991 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4992 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4993 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4994 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4995 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4996 "kana-i", "kana-u", "kana-e", "kana-o",
4997 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4998 "prolongedsound", "kana-A", "kana-I", "kana-U",
4999 "kana-E", "kana-O", "kana-KA", "kana-KI",
5000 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5001 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5002 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5003 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5004 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5005 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5006 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5007 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5008 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5009 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5010 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5011 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5013 #endif /* XK_kana_A */
5016 #define FUNCTION_KEY_OFFSET 0xff00
5018 /* You'll notice that this table is arranged to be conveniently
5019 indexed by X Windows keysym values. */
5020 static const char *const lispy_function_keys
[] =
5022 /* X Keysym value */
5024 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5025 "backspace", "tab", "linefeed", "clear",
5027 0, 0, 0, "pause", /* 0xff10...1f */
5028 0, 0, 0, 0, 0, 0, 0, "escape",
5030 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5031 "romaji", "hiragana", "katakana", "hiragana-katakana",
5032 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5033 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5034 "eisu-toggle", /* 0xff30...3f */
5035 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5036 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5038 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5039 "down", "prior", "next", "end",
5040 "begin", 0, 0, 0, 0, 0, 0, 0,
5041 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5052 "break", /* 0xff6b */
5055 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5056 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5057 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5058 0, 0, 0, 0, 0, 0, 0, 0,
5059 "kp-tab", /* 0xff89 */
5061 "kp-enter", /* 0xff8d */
5063 "kp-f1", /* 0xff91 */
5067 "kp-home", /* 0xff95 */
5072 "kp-prior", /* kp-page-up */
5073 "kp-next", /* kp-page-down */
5079 0, 0, 0, 0, 0, 0, 0, 0, 0,
5080 "kp-multiply", /* 0xffaa */
5085 "kp-divide", /* 0xffaf */
5086 "kp-0", /* 0xffb0 */
5087 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5090 "kp-equal", /* 0xffbd */
5091 "f1", /* 0xffbe */ /* IsFunctionKey */
5093 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5094 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5095 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5096 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5097 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5098 0, 0, 0, 0, 0, 0, 0, 0,
5099 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5100 0, 0, 0, 0, 0, 0, 0, "delete"
5103 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5104 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5106 static const char *const iso_lispy_function_keys
[] =
5108 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5109 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5110 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5111 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5112 "iso-lefttab", /* 0xfe20 */
5113 "iso-move-line-up", "iso-move-line-down",
5114 "iso-partial-line-up", "iso-partial-line-down",
5115 "iso-partial-space-left", "iso-partial-space-right",
5116 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5117 "iso-release-margin-left", "iso-release-margin-right",
5118 "iso-release-both-margins",
5119 "iso-fast-cursor-left", "iso-fast-cursor-right",
5120 "iso-fast-cursor-up", "iso-fast-cursor-down",
5121 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5122 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5125 #endif /* not HAVE_NTGUI */
5127 static Lisp_Object Vlispy_mouse_stem
;
5129 static const char *const lispy_wheel_names
[] =
5131 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5134 /* drag-n-drop events are generated when a set of selected files are
5135 dragged from another application and dropped onto an Emacs window. */
5136 static const char *const lispy_drag_n_drop_names
[] =
5141 /* Scroll bar parts. */
5142 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5143 Lisp_Object Qup
, Qdown
, Qbottom
;
5144 static Lisp_Object Qend_scroll
;
5146 static Lisp_Object Qratio
;
5148 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5149 static Lisp_Object
*const scroll_bar_parts
[] = {
5150 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5151 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5154 /* A vector, indexed by button number, giving the down-going location
5155 of currently depressed buttons, both scroll bar and non-scroll bar.
5157 The elements have the form
5158 (BUTTON-NUMBER MODIFIER-MASK . REST)
5159 where REST is the cdr of a position as it would be reported in the event.
5161 The make_lispy_event function stores positions here to tell the
5162 difference between click and drag events, and to store the starting
5163 location to be included in drag events. */
5165 static Lisp_Object button_down_location
;
5167 /* Information about the most recent up-going button event: Which
5168 button, what location, and what time. */
5170 static int last_mouse_button
;
5171 static int last_mouse_x
;
5172 static int last_mouse_y
;
5173 static Time button_down_time
;
5175 /* The number of clicks in this multiple-click. */
5177 static int double_click_count
;
5179 /* X and Y are frame-relative coordinates for a click or wheel event.
5180 Return a Lisp-style event list. */
5183 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5186 enum window_part part
;
5187 Lisp_Object posn
= Qnil
;
5188 Lisp_Object extra_info
= Qnil
;
5189 /* Coordinate pixel positions to return. */
5190 int xret
= 0, yret
= 0;
5191 /* The window under frame pixel coordinates (x,y) */
5192 Lisp_Object window
= f
5193 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5196 if (WINDOWP (window
))
5198 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5199 struct window
*w
= XWINDOW (window
);
5200 Lisp_Object string_info
= Qnil
;
5201 ptrdiff_t textpos
= -1;
5202 int col
= -1, row
= -1;
5203 int dx
= -1, dy
= -1;
5204 int width
= -1, height
= -1;
5205 Lisp_Object object
= Qnil
;
5207 /* Pixel coordinates relative to the window corner. */
5208 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5209 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5211 /* For text area clicks, return X, Y relative to the corner of
5212 this text area. Note that dX, dY etc are set below, by
5213 buffer_posn_from_coords. */
5214 if (part
== ON_TEXT
)
5216 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5217 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5219 /* For mode line and header line clicks, return X, Y relative to
5220 the left window edge. Use mode_line_string to look for a
5221 string on the click position. */
5222 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5227 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5228 /* Note that mode_line_string takes COL, ROW as pixels and
5229 converts them to characters. */
5232 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5233 &object
, &dx
, &dy
, &width
, &height
);
5234 if (STRINGP (string
))
5235 string_info
= Fcons (string
, make_number (charpos
));
5236 textpos
= (w
== XWINDOW (selected_window
)
5237 && current_buffer
== XBUFFER (w
->contents
))
5238 ? PT
: marker_position (w
->pointm
);
5243 /* For fringes and margins, Y is relative to the area's (and the
5244 window's) top edge, while X is meaningless. */
5245 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5250 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5253 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5254 &object
, &dx
, &dy
, &width
, &height
);
5255 if (STRINGP (string
))
5256 string_info
= Fcons (string
, make_number (charpos
));
5257 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5259 else if (part
== ON_LEFT_FRINGE
)
5261 posn
= Qleft_fringe
;
5264 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5265 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5266 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5268 else if (part
== ON_RIGHT_FRINGE
)
5270 posn
= Qright_fringe
;
5273 - window_box_width (w
, LEFT_MARGIN_AREA
)
5274 - window_box_width (w
, TEXT_AREA
)
5275 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5276 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5278 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5280 else if (part
== ON_VERTICAL_BORDER
)
5282 posn
= Qvertical_line
;
5287 /* Nothing special for part == ON_SCROLL_BAR. */
5289 /* For clicks in the text area, fringes, or margins, call
5290 buffer_posn_from_coords to extract TEXTPOS, the buffer
5291 position nearest to the click. */
5294 Lisp_Object string2
, object2
= Qnil
;
5295 struct display_pos p
;
5297 int width2
, height2
;
5298 /* The pixel X coordinate passed to buffer_posn_from_coords
5299 is the X coordinate relative to the text area for
5300 text-area and right-margin clicks, zero otherwise. */
5302 = (part
== ON_TEXT
) ? xret
5303 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5304 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5308 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5309 &object2
, &dx2
, &dy2
,
5311 textpos
= CHARPOS (p
.pos
);
5312 if (col
< 0) col
= x2
;
5313 if (row
< 0) row
= y2
;
5314 if (dx
< 0) dx
= dx2
;
5315 if (dy
< 0) dy
= dy2
;
5316 if (width
< 0) width
= width2
;
5317 if (height
< 0) height
= height2
;
5321 posn
= make_number (textpos
);
5322 if (STRINGP (string2
))
5323 string_info
= Fcons (string2
,
5324 make_number (CHARPOS (p
.string_pos
)));
5330 #ifdef HAVE_WINDOW_SYSTEM
5331 if (IMAGEP (object
))
5333 Lisp_Object image_map
, hotspot
;
5334 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5336 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5338 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5339 posn
= XCAR (hotspot
);
5346 Fcons (make_number (dx
), make_number (dy
)),
5347 Fcons (make_number (width
), make_number (height
)));
5350 extra_info
= Fcons (string_info
,
5351 Fcons (make_number (textpos
),
5352 Fcons (Fcons (make_number (col
),
5357 XSETFRAME (window
, f
);
5361 return Fcons (window
,
5363 Fcons (Fcons (make_number (xret
),
5364 make_number (yret
)),
5365 Fcons (make_number (t
),
5369 /* Given a struct input_event, build the lisp event which represents
5370 it. If EVENT is 0, build a mouse movement event from the mouse
5371 movement buffer, which should have a movement event in it.
5373 Note that events must be passed to this function in the order they
5374 are received; this function stores the location of button presses
5375 in order to build drag events when the button is released. */
5378 make_lispy_event (struct input_event
*event
)
5382 switch (event
->kind
)
5384 /* A simple keystroke. */
5385 case ASCII_KEYSTROKE_EVENT
:
5386 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5388 Lisp_Object lispy_c
;
5389 EMACS_INT c
= event
->code
;
5390 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5393 eassert (c
== event
->code
);
5394 /* Turn ASCII characters into control characters
5396 if (event
->modifiers
& ctrl_modifier
)
5398 c
= make_ctrl_char (c
);
5399 event
->modifiers
&= ~ctrl_modifier
;
5403 /* Add in the other modifier bits. The shift key was taken care
5404 of by the X code. */
5405 c
|= (event
->modifiers
5406 & (meta_modifier
| alt_modifier
5407 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5408 /* Distinguish Shift-SPC from SPC. */
5409 if ((event
->code
) == 040
5410 && event
->modifiers
& shift_modifier
)
5411 c
|= shift_modifier
;
5412 button_down_time
= 0;
5413 XSETFASTINT (lispy_c
, c
);
5418 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5419 except that they are non-key events (last-nonmenu-event is nil). */
5420 case NS_NONKEY_EVENT
:
5423 /* A function key. The symbol may need to have modifier prefixes
5425 case NON_ASCII_KEYSTROKE_EVENT
:
5426 button_down_time
= 0;
5428 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5429 if (event
->code
== lispy_accent_codes
[i
])
5430 return modify_event_symbol (i
,
5432 Qfunction_key
, Qnil
,
5433 lispy_accent_keys
, &accent_key_syms
,
5434 (sizeof (lispy_accent_keys
)
5435 / sizeof (lispy_accent_keys
[0])));
5439 if (event
->code
>= 0x400 && event
->code
< 0x500)
5440 return modify_event_symbol (event
->code
- 0x400,
5441 event
->modifiers
& ~shift_modifier
,
5442 Qfunction_key
, Qnil
,
5443 lispy_kana_keys
, &func_key_syms
,
5444 (sizeof (lispy_kana_keys
)
5445 / sizeof (lispy_kana_keys
[0])));
5446 #endif /* XK_kana_A */
5449 #ifdef ISO_FUNCTION_KEY_OFFSET
5450 if (event
->code
< FUNCTION_KEY_OFFSET
5451 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5452 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5454 Qfunction_key
, Qnil
,
5455 iso_lispy_function_keys
, &func_key_syms
,
5456 (sizeof (iso_lispy_function_keys
)
5457 / sizeof (iso_lispy_function_keys
[0])));
5460 /* Handle system-specific or unknown keysyms. */
5461 if (event
->code
& (1 << 28)
5462 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5463 || (event
->code
- FUNCTION_KEY_OFFSET
5464 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5465 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5467 /* We need to use an alist rather than a vector as the cache
5468 since we can't make a vector long enough. */
5469 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5470 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5471 return modify_event_symbol (event
->code
,
5474 KVAR (current_kboard
, Vsystem_key_alist
),
5475 0, &KVAR (current_kboard
, system_key_syms
),
5479 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5481 Qfunction_key
, Qnil
,
5482 lispy_function_keys
, &func_key_syms
,
5483 (sizeof (lispy_function_keys
)
5484 / sizeof (lispy_function_keys
[0])));
5487 case MULTIMEDIA_KEY_EVENT
:
5488 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5489 / sizeof (lispy_multimedia_keys
[0]))
5490 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5492 return modify_event_symbol (event
->code
, event
->modifiers
,
5493 Qfunction_key
, Qnil
,
5494 lispy_multimedia_keys
, &func_key_syms
,
5495 (sizeof (lispy_multimedia_keys
)
5496 / sizeof (lispy_multimedia_keys
[0])));
5501 /* A mouse click. Figure out where it is, decide whether it's
5502 a press, click or drag, and build the appropriate structure. */
5503 case MOUSE_CLICK_EVENT
:
5504 #ifndef USE_TOOLKIT_SCROLL_BARS
5505 case SCROLL_BAR_CLICK_EVENT
:
5508 int button
= event
->code
;
5510 Lisp_Object position
;
5511 Lisp_Object
*start_pos_ptr
;
5512 Lisp_Object start_pos
;
5516 /* Build the position as appropriate for this mouse click. */
5517 if (event
->kind
== MOUSE_CLICK_EVENT
)
5519 struct frame
*f
= XFRAME (event
->frame_or_window
);
5520 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5524 /* Ignore mouse events that were made on frame that
5525 have been deleted. */
5526 if (! FRAME_LIVE_P (f
))
5529 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5530 /* EVENT->x and EVENT->y are frame-relative pixel
5531 coordinates at this place. Under old redisplay, COLUMN
5532 and ROW are set to frame relative glyph coordinates
5533 which are then used to determine whether this click is
5534 in a menu (non-toolkit version). */
5535 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5536 &column
, &row
, NULL
, 1);
5538 /* In the non-toolkit version, clicks on the menu bar
5539 are ordinary button events in the event buffer.
5540 Distinguish them, and invoke the menu.
5542 (In the toolkit version, the toolkit handles the menu bar
5543 and Emacs doesn't know about it until after the user
5544 makes a selection.) */
5545 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5546 && (event
->modifiers
& down_modifier
))
5548 Lisp_Object items
, item
;
5550 /* Find the menu bar item under `column'. */
5552 items
= FRAME_MENU_BAR_ITEMS (f
);
5553 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5555 Lisp_Object pos
, string
;
5556 string
= AREF (items
, i
+ 1);
5557 pos
= AREF (items
, i
+ 3);
5560 if (column
>= XINT (pos
)
5561 && column
< XINT (pos
) + SCHARS (string
))
5563 item
= AREF (items
, i
);
5568 /* ELisp manual 2.4b says (x y) are window relative but
5569 code says they are frame-relative. */
5570 position
= list4 (event
->frame_or_window
,
5572 Fcons (event
->x
, event
->y
),
5573 make_number (event
->timestamp
));
5575 return list2 (item
, position
);
5577 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5579 position
= make_lispy_position (f
, event
->x
, event
->y
,
5582 #ifndef USE_TOOLKIT_SCROLL_BARS
5585 /* It's a scrollbar click. */
5587 Lisp_Object portion_whole
;
5590 window
= event
->frame_or_window
;
5591 portion_whole
= Fcons (event
->x
, event
->y
);
5592 part
= *scroll_bar_parts
[(int) event
->part
];
5594 position
= list5 (window
, Qvertical_scroll_bar
,
5595 portion_whole
, make_number (event
->timestamp
),
5598 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5600 if (button
>= ASIZE (button_down_location
))
5602 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5603 button_down_location
= larger_vector (button_down_location
,
5605 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5608 start_pos_ptr
= aref_addr (button_down_location
, button
);
5609 start_pos
= *start_pos_ptr
;
5610 *start_pos_ptr
= Qnil
;
5613 /* On window-system frames, use the value of
5614 double-click-fuzz as is. On other frames, interpret it
5615 as a multiple of 1/8 characters. */
5619 if (WINDOWP (event
->frame_or_window
))
5620 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5621 else if (FRAMEP (event
->frame_or_window
))
5622 f
= XFRAME (event
->frame_or_window
);
5626 if (FRAME_WINDOW_P (f
))
5627 fuzz
= double_click_fuzz
;
5629 fuzz
= double_click_fuzz
/ 8;
5631 is_double
= (button
== last_mouse_button
5632 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5633 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5634 && button_down_time
!= 0
5635 && (EQ (Vdouble_click_time
, Qt
)
5636 || (NATNUMP (Vdouble_click_time
)
5637 && (event
->timestamp
- button_down_time
5638 < XFASTINT (Vdouble_click_time
)))));
5641 last_mouse_button
= button
;
5642 last_mouse_x
= XINT (event
->x
);
5643 last_mouse_y
= XINT (event
->y
);
5645 /* If this is a button press, squirrel away the location, so
5646 we can decide later whether it was a click or a drag. */
5647 if (event
->modifiers
& down_modifier
)
5651 double_click_count
++;
5652 event
->modifiers
|= ((double_click_count
> 2)
5657 double_click_count
= 1;
5658 button_down_time
= event
->timestamp
;
5659 *start_pos_ptr
= Fcopy_alist (position
);
5660 ignore_mouse_drag_p
= 0;
5663 /* Now we're releasing a button - check the co-ordinates to
5664 see if this was a click or a drag. */
5665 else if (event
->modifiers
& up_modifier
)
5667 /* If we did not see a down before this up, ignore the up.
5668 Probably this happened because the down event chose a
5669 menu item. It would be an annoyance to treat the
5670 release of the button that chose the menu item as a
5673 if (!CONSP (start_pos
))
5676 event
->modifiers
&= ~up_modifier
;
5679 Lisp_Object new_down
, down
;
5680 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5682 /* The third element of every position
5683 should be the (x,y) pair. */
5684 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5685 new_down
= Fcar (Fcdr (Fcdr (position
)));
5688 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5690 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5691 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5694 if (ignore_mouse_drag_p
)
5696 event
->modifiers
|= click_modifier
;
5697 ignore_mouse_drag_p
= 0;
5699 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5700 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5701 /* Maybe the mouse has moved a lot, caused scrolling, and
5702 eventually ended up at the same screen position (but
5703 not buffer position) in which case it is a drag, not
5705 /* FIXME: OTOH if the buffer position has changed
5706 because of a timer or process filter rather than
5707 because of mouse movement, it should be considered as
5708 a click. But mouse-drag-region completely ignores
5709 this case and it hasn't caused any real problem, so
5710 it's probably OK to ignore it as well. */
5711 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5712 /* Mouse hasn't moved (much). */
5713 event
->modifiers
|= click_modifier
;
5716 button_down_time
= 0;
5717 event
->modifiers
|= drag_modifier
;
5720 /* Don't check is_double; treat this as multiple
5721 if the down-event was multiple. */
5722 if (double_click_count
> 1)
5723 event
->modifiers
|= ((double_click_count
> 2)
5729 /* Every mouse event should either have the down_modifier or
5730 the up_modifier set. */
5734 /* Get the symbol we should use for the mouse click. */
5737 head
= modify_event_symbol (button
,
5739 Qmouse_click
, Vlispy_mouse_stem
,
5742 ASIZE (mouse_syms
));
5743 if (event
->modifiers
& drag_modifier
)
5744 return list3 (head
, start_pos
, position
);
5745 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5746 return list3 (head
, position
, make_number (double_click_count
));
5748 return list2 (head
, position
);
5753 case HORIZ_WHEEL_EVENT
:
5755 Lisp_Object position
;
5758 /* Build the position as appropriate for this mouse click. */
5759 struct frame
*f
= XFRAME (event
->frame_or_window
);
5761 /* Ignore wheel events that were made on frame that have been
5763 if (! FRAME_LIVE_P (f
))
5766 position
= make_lispy_position (f
, event
->x
, event
->y
,
5769 /* Set double or triple modifiers to indicate the wheel speed. */
5771 /* On window-system frames, use the value of
5772 double-click-fuzz as is. On other frames, interpret it
5773 as a multiple of 1/8 characters. */
5779 if (WINDOWP (event
->frame_or_window
))
5780 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5781 else if (FRAMEP (event
->frame_or_window
))
5782 fr
= XFRAME (event
->frame_or_window
);
5786 fuzz
= FRAME_WINDOW_P (fr
)
5787 ? double_click_fuzz
: double_click_fuzz
/ 8;
5789 if (event
->modifiers
& up_modifier
)
5791 /* Emit a wheel-up event. */
5792 event
->modifiers
&= ~up_modifier
;
5795 else if (event
->modifiers
& down_modifier
)
5797 /* Emit a wheel-down event. */
5798 event
->modifiers
&= ~down_modifier
;
5802 /* Every wheel event should either have the down_modifier or
5803 the up_modifier set. */
5806 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5809 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5810 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5811 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5812 && button_down_time
!= 0
5813 && (EQ (Vdouble_click_time
, Qt
)
5814 || (NATNUMP (Vdouble_click_time
)
5815 && (event
->timestamp
- button_down_time
5816 < XFASTINT (Vdouble_click_time
)))));
5819 double_click_count
++;
5820 event
->modifiers
|= ((double_click_count
> 2)
5826 double_click_count
= 1;
5827 event
->modifiers
|= click_modifier
;
5830 button_down_time
= event
->timestamp
;
5831 /* Use a negative value to distinguish wheel from mouse button. */
5832 last_mouse_button
= - (1 + symbol_num
);
5833 last_mouse_x
= XINT (event
->x
);
5834 last_mouse_y
= XINT (event
->y
);
5836 /* Get the symbol we should use for the wheel event. */
5837 head
= modify_event_symbol (symbol_num
,
5843 ASIZE (wheel_syms
));
5846 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5847 return list3 (head
, position
, make_number (double_click_count
));
5849 return list2 (head
, position
);
5853 #ifdef USE_TOOLKIT_SCROLL_BARS
5855 /* We don't have down and up events if using toolkit scroll bars,
5856 so make this always a click event. Store in the `part' of
5857 the Lisp event a symbol which maps to the following actions:
5859 `above_handle' page up
5860 `below_handle' page down
5864 `bottom' bottom of buffer
5865 `handle' thumb has been dragged.
5866 `end-scroll' end of interaction with scroll bar
5868 The incoming input_event contains in its `part' member an
5869 index of type `enum scroll_bar_part' which we can use as an
5870 index in scroll_bar_parts to get the appropriate symbol. */
5872 case SCROLL_BAR_CLICK_EVENT
:
5874 Lisp_Object position
, head
, window
, portion_whole
, part
;
5876 window
= event
->frame_or_window
;
5877 portion_whole
= Fcons (event
->x
, event
->y
);
5878 part
= *scroll_bar_parts
[(int) event
->part
];
5880 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5881 make_number (event
->timestamp
), part
);
5883 /* Always treat scroll bar events as clicks. */
5884 event
->modifiers
|= click_modifier
;
5885 event
->modifiers
&= ~up_modifier
;
5887 if (event
->code
>= ASIZE (mouse_syms
))
5888 mouse_syms
= larger_vector (mouse_syms
,
5889 event
->code
- ASIZE (mouse_syms
) + 1,
5892 /* Get the symbol we should use for the mouse click. */
5893 head
= modify_event_symbol (event
->code
,
5898 ASIZE (mouse_syms
));
5899 return list2 (head
, position
);
5902 #endif /* USE_TOOLKIT_SCROLL_BARS */
5904 case DRAG_N_DROP_EVENT
:
5907 Lisp_Object head
, position
;
5910 f
= XFRAME (event
->frame_or_window
);
5913 /* Ignore mouse events that were made on frames that
5914 have been deleted. */
5915 if (! FRAME_LIVE_P (f
))
5918 position
= make_lispy_position (f
, event
->x
, event
->y
,
5921 head
= modify_event_symbol (0, event
->modifiers
,
5923 lispy_drag_n_drop_names
,
5924 &drag_n_drop_syms
, 1);
5925 return list3 (head
, position
, files
);
5928 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5929 || defined (HAVE_NS) || defined (USE_GTK)
5930 case MENU_BAR_EVENT
:
5931 if (EQ (event
->arg
, event
->frame_or_window
))
5932 /* This is the prefix key. We translate this to
5933 `(menu_bar)' because the code in keyboard.c for menu
5934 events, which we use, relies on this. */
5935 return list1 (Qmenu_bar
);
5939 case SELECT_WINDOW_EVENT
:
5940 /* Make an event (select-window (WINDOW)). */
5941 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5943 case TOOL_BAR_EVENT
:
5944 if (EQ (event
->arg
, event
->frame_or_window
))
5945 /* This is the prefix key. We translate this to
5946 `(tool_bar)' because the code in keyboard.c for tool bar
5947 events, which we use, relies on this. */
5948 return list1 (Qtool_bar
);
5949 else if (SYMBOLP (event
->arg
))
5950 return apply_modifiers (event
->modifiers
, event
->arg
);
5953 case USER_SIGNAL_EVENT
:
5954 /* A user signal. */
5956 char *name
= find_user_signal_name (event
->code
);
5959 return intern (name
);
5962 case SAVE_SESSION_EVENT
:
5963 return Qsave_session
;
5968 return Fcons (Qdbus_event
, event
->arg
);
5970 #endif /* HAVE_DBUS */
5972 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
5973 case FILE_NOTIFY_EVENT
:
5975 return Fcons (Qfile_notify
, event
->arg
);
5977 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
5979 case CONFIG_CHANGED_EVENT
:
5980 return list3 (Qconfig_changed_event
,
5981 event
->arg
, event
->frame_or_window
);
5983 case GPM_CLICK_EVENT
:
5985 struct frame
*f
= XFRAME (event
->frame_or_window
);
5986 Lisp_Object head
, position
;
5987 Lisp_Object
*start_pos_ptr
;
5988 Lisp_Object start_pos
;
5989 int button
= event
->code
;
5991 if (button
>= ASIZE (button_down_location
))
5993 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5994 button_down_location
= larger_vector (button_down_location
,
5996 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5999 start_pos_ptr
= aref_addr (button_down_location
, button
);
6000 start_pos
= *start_pos_ptr
;
6002 position
= make_lispy_position (f
, event
->x
, event
->y
,
6005 if (event
->modifiers
& down_modifier
)
6006 *start_pos_ptr
= Fcopy_alist (position
);
6007 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6009 if (!CONSP (start_pos
))
6011 event
->modifiers
&= ~up_modifier
;
6014 head
= modify_event_symbol (button
,
6016 Qmouse_click
, Vlispy_mouse_stem
,
6019 ASIZE (mouse_syms
));
6021 if (event
->modifiers
& drag_modifier
)
6022 return list3 (head
, start_pos
, position
);
6023 else if (event
->modifiers
& double_modifier
)
6024 return list3 (head
, position
, make_number (2));
6025 else if (event
->modifiers
& triple_modifier
)
6026 return list3 (head
, position
, make_number (3));
6028 return list2 (head
, position
);
6030 #endif /* HAVE_GPM */
6032 /* The 'kind' field of the event is something we don't recognize. */
6039 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6040 Lisp_Object x
, Lisp_Object y
, Time t
)
6042 /* Is it a scroll bar movement? */
6043 if (frame
&& ! NILP (bar_window
))
6045 Lisp_Object part_sym
;
6047 part_sym
= *scroll_bar_parts
[(int) part
];
6048 return list2 (Qscroll_bar_movement
,
6050 Qvertical_scroll_bar
,
6055 /* Or is it an ordinary mouse movement? */
6058 Lisp_Object position
;
6059 position
= make_lispy_position (frame
, x
, y
, t
);
6060 return list2 (Qmouse_movement
, position
);
6064 /* Construct a switch frame event. */
6066 make_lispy_switch_frame (Lisp_Object frame
)
6068 return list2 (Qswitch_frame
, frame
);
6072 make_lispy_focus_in (Lisp_Object frame
)
6074 return list2 (Qfocus_in
, frame
);
6077 #ifdef HAVE_WINDOW_SYSTEM
6080 make_lispy_focus_out (Lisp_Object frame
)
6082 return list2 (Qfocus_out
, frame
);
6085 #endif /* HAVE_WINDOW_SYSTEM */
6087 /* Manipulating modifiers. */
6089 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6091 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6092 SYMBOL's name of the end of the modifiers; the string from this
6093 position is the unmodified symbol name.
6095 This doesn't use any caches. */
6098 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6104 CHECK_SYMBOL (symbol
);
6107 name
= SYMBOL_NAME (symbol
);
6109 for (i
= 0; i
< SBYTES (name
) - 1; )
6111 ptrdiff_t this_mod_end
= 0;
6114 /* See if the name continues with a modifier word.
6115 Check that the word appears, but don't check what follows it.
6116 Set this_mod and this_mod_end to record what we find. */
6118 switch (SREF (name
, i
))
6120 #define SINGLE_LETTER_MOD(BIT) \
6121 (this_mod_end = i + 1, this_mod = BIT)
6124 SINGLE_LETTER_MOD (alt_modifier
);
6128 SINGLE_LETTER_MOD (ctrl_modifier
);
6132 SINGLE_LETTER_MOD (hyper_modifier
);
6136 SINGLE_LETTER_MOD (meta_modifier
);
6140 SINGLE_LETTER_MOD (shift_modifier
);
6144 SINGLE_LETTER_MOD (super_modifier
);
6147 #undef SINGLE_LETTER_MOD
6149 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6150 if (i + LEN + 1 <= SBYTES (name) \
6151 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6153 this_mod_end = i + LEN; \
6158 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6159 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6160 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6164 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6166 #undef MULTI_LETTER_MOD
6170 /* If we found no modifier, stop looking for them. */
6171 if (this_mod_end
== 0)
6174 /* Check there is a dash after the modifier, so that it
6175 really is a modifier. */
6176 if (this_mod_end
>= SBYTES (name
)
6177 || SREF (name
, this_mod_end
) != '-')
6180 /* This modifier is real; look for another. */
6181 modifiers
|= this_mod
;
6182 i
= this_mod_end
+ 1;
6185 /* Should we include the `click' modifier? */
6186 if (! (modifiers
& (down_modifier
| drag_modifier
6187 | double_modifier
| triple_modifier
))
6188 && i
+ 7 == SBYTES (name
)
6189 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6190 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6191 modifiers
|= click_modifier
;
6193 if (! (modifiers
& (double_modifier
| triple_modifier
))
6194 && i
+ 6 < SBYTES (name
)
6195 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6196 modifiers
|= click_modifier
;
6204 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6205 prepended to the string BASE[0..BASE_LEN-1].
6206 This doesn't use any caches. */
6208 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6210 /* Since BASE could contain nulls, we can't use intern here; we have
6211 to use Fintern, which expects a genuine Lisp_String, and keeps a
6213 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6219 /* Only the event queue may use the `up' modifier; it should always
6220 be turned into a click or drag event before presented to lisp code. */
6221 if (modifiers
& up_modifier
)
6224 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6225 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6226 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6227 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6228 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6229 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6230 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6231 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6232 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6233 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6234 /* The click modifier is denoted by the absence of other modifiers. */
6238 mod_len
= p
- new_mods
;
6242 Lisp_Object new_name
;
6244 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6245 mod_len
+ base_len_byte
);
6246 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6247 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6249 return Fintern (new_name
, Qnil
);
6254 static const char *const modifier_names
[] =
6256 "up", "down", "drag", "click", "double", "triple", 0, 0,
6257 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6258 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6260 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6262 static Lisp_Object modifier_symbols
;
6264 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6266 lispy_modifier_list (int modifiers
)
6268 Lisp_Object modifier_list
;
6271 modifier_list
= Qnil
;
6272 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6273 if (modifiers
& (1<<i
))
6274 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6277 return modifier_list
;
6281 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6282 where UNMODIFIED is the unmodified form of SYMBOL,
6283 MASK is the set of modifiers present in SYMBOL's name.
6284 This is similar to parse_modifiers_uncached, but uses the cache in
6285 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6286 Qevent_symbol_elements property. */
6288 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6291 parse_modifiers (Lisp_Object symbol
)
6293 Lisp_Object elements
;
6295 if (INTEGERP (symbol
))
6296 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6297 else if (!SYMBOLP (symbol
))
6300 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6301 if (CONSP (elements
))
6306 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6307 Lisp_Object unmodified
;
6310 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6311 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6314 if (modifiers
& ~INTMASK
)
6316 XSETFASTINT (mask
, modifiers
);
6317 elements
= list2 (unmodified
, mask
);
6319 /* Cache the parsing results on SYMBOL. */
6320 Fput (symbol
, Qevent_symbol_element_mask
,
6322 Fput (symbol
, Qevent_symbol_elements
,
6323 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6325 /* Since we know that SYMBOL is modifiers applied to unmodified,
6326 it would be nice to put that in unmodified's cache.
6327 But we can't, since we're not sure that parse_modifiers is
6334 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6335 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6336 doc
: /* Parse the event symbol. For internal use. */)
6337 (Lisp_Object symbol
)
6339 /* Fill the cache if needed. */
6340 parse_modifiers (symbol
);
6341 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6342 and use the Lispier representation stored on Qevent_symbol_elements
6344 return Fget (symbol
, Qevent_symbol_elements
);
6347 /* Apply the modifiers MODIFIERS to the symbol BASE.
6348 BASE must be unmodified.
6350 This is like apply_modifiers_uncached, but uses BASE's
6351 Qmodifier_cache property, if present. It also builds
6352 Qevent_symbol_elements properties, since it has that info anyway.
6354 apply_modifiers copies the value of BASE's Qevent_kind property to
6355 the modified symbol. */
6357 apply_modifiers (int modifiers
, Lisp_Object base
)
6359 Lisp_Object cache
, idx
, entry
, new_symbol
;
6361 /* Mask out upper bits. We don't know where this value's been. */
6362 modifiers
&= INTMASK
;
6364 if (INTEGERP (base
))
6365 return make_number (XINT (base
) | modifiers
);
6367 /* The click modifier never figures into cache indices. */
6368 cache
= Fget (base
, Qmodifier_cache
);
6369 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6370 entry
= assq_no_quit (idx
, cache
);
6373 new_symbol
= XCDR (entry
);
6376 /* We have to create the symbol ourselves. */
6377 new_symbol
= apply_modifiers_uncached (modifiers
,
6378 SSDATA (SYMBOL_NAME (base
)),
6379 SCHARS (SYMBOL_NAME (base
)),
6380 SBYTES (SYMBOL_NAME (base
)));
6382 /* Add the new symbol to the base's cache. */
6383 entry
= Fcons (idx
, new_symbol
);
6384 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6386 /* We have the parsing info now for free, so we could add it to
6388 XSETFASTINT (idx, modifiers);
6389 Fput (new_symbol, Qevent_symbol_element_mask,
6391 Fput (new_symbol, Qevent_symbol_elements,
6392 Fcons (base, lispy_modifier_list (modifiers)));
6393 Sadly, this is only correct if `base' is indeed a base event,
6394 which is not necessarily the case. -stef */
6397 /* Make sure this symbol is of the same kind as BASE.
6399 You'd think we could just set this once and for all when we
6400 intern the symbol above, but reorder_modifiers may call us when
6401 BASE's property isn't set right; we can't assume that just
6402 because it has a Qmodifier_cache property it must have its
6403 Qevent_kind set right as well. */
6404 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6408 kind
= Fget (base
, Qevent_kind
);
6410 Fput (new_symbol
, Qevent_kind
, kind
);
6417 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6418 return a symbol with the modifiers placed in the canonical order.
6419 Canonical order is alphabetical, except for down and drag, which
6420 always come last. The 'click' modifier is never written out.
6422 Fdefine_key calls this to make sure that (for example) C-M-foo
6423 and M-C-foo end up being equivalent in the keymap. */
6426 reorder_modifiers (Lisp_Object symbol
)
6428 /* It's hopefully okay to write the code this way, since everything
6429 will soon be in caches, and no consing will be done at all. */
6432 parsed
= parse_modifiers (symbol
);
6433 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6438 /* For handling events, we often want to produce a symbol whose name
6439 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6440 to some base, like the name of a function key or mouse button.
6441 modify_event_symbol produces symbols of this sort.
6443 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6444 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6447 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6448 into symbol names, or a string specifying a name stem used to
6449 construct a symbol name or the form `STEM-N', where N is the decimal
6450 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6451 non-nil; otherwise NAME_TABLE is used.
6453 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6454 persist between calls to modify_event_symbol that it can use to
6455 store a cache of the symbols it's generated for this NAME_TABLE
6456 before. The object stored there may be a vector or an alist.
6458 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6460 MODIFIERS is a set of modifier bits (as given in struct input_events)
6461 whose prefixes should be applied to the symbol name.
6463 SYMBOL_KIND is the value to be placed in the event_kind property of
6464 the returned symbol.
6466 The symbols we create are supposed to have an
6467 `event-symbol-elements' property, which lists the modifiers present
6468 in the symbol's name. */
6471 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6472 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6473 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6476 Lisp_Object symbol_int
;
6478 /* Get rid of the "vendor-specific" bit here. */
6479 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6481 /* Is this a request for a valid symbol? */
6482 if (symbol_num
< 0 || symbol_num
>= table_size
)
6485 if (CONSP (*symbol_table
))
6486 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6488 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6489 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6490 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6491 we've never used that symbol before. */
6494 if (! VECTORP (*symbol_table
)
6495 || ASIZE (*symbol_table
) != table_size
)
6499 XSETFASTINT (size
, table_size
);
6500 *symbol_table
= Fmake_vector (size
, Qnil
);
6503 value
= AREF (*symbol_table
, symbol_num
);
6506 /* Have we already used this symbol before? */
6509 /* No; let's create it. */
6510 if (CONSP (name_alist_or_stem
))
6511 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6512 else if (STRINGP (name_alist_or_stem
))
6515 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6516 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6518 buf
= SAFE_ALLOCA (len
);
6519 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6520 XINT (symbol_int
) + 1);
6521 value
= intern (buf
);
6524 else if (name_table
!= 0 && name_table
[symbol_num
])
6525 value
= intern (name_table
[symbol_num
]);
6527 #ifdef HAVE_WINDOW_SYSTEM
6530 char *name
= x_get_keysym_name (symbol_num
);
6532 value
= intern (name
);
6538 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6539 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6540 value
= intern (buf
);
6543 if (CONSP (*symbol_table
))
6544 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6546 ASET (*symbol_table
, symbol_num
, value
);
6548 /* Fill in the cache entries for this symbol; this also
6549 builds the Qevent_symbol_elements property, which the user
6551 apply_modifiers (modifiers
& click_modifier
, value
);
6552 Fput (value
, Qevent_kind
, symbol_kind
);
6555 /* Apply modifiers to that symbol. */
6556 return apply_modifiers (modifiers
, value
);
6559 /* Convert a list that represents an event type,
6560 such as (ctrl meta backspace), into the usual representation of that
6561 event type as a number or a symbol. */
6563 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6564 doc
: /* Convert the event description list EVENT-DESC to an event type.
6565 EVENT-DESC should contain one base event type (a character or symbol)
6566 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6567 drag, down, double or triple). The base must be last.
6568 The return value is an event type (a character or symbol) which
6569 has the same base event type and all the specified modifiers. */)
6570 (Lisp_Object event_desc
)
6578 while (CONSP (rest
))
6586 /* Given a symbol, see if it is a modifier name. */
6587 if (SYMBOLP (elt
) && CONSP (rest
))
6588 this = parse_solitary_modifier (elt
);
6592 else if (!NILP (base
))
6593 error ("Two bases given in one event");
6599 /* Let the symbol A refer to the character A. */
6600 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6601 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6603 if (INTEGERP (base
))
6605 /* Turn (shift a) into A. */
6606 if ((modifiers
& shift_modifier
) != 0
6607 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6609 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6610 modifiers
&= ~shift_modifier
;
6613 /* Turn (control a) into C-a. */
6614 if (modifiers
& ctrl_modifier
)
6615 return make_number ((modifiers
& ~ctrl_modifier
)
6616 | make_ctrl_char (XINT (base
)));
6618 return make_number (modifiers
| XINT (base
));
6620 else if (SYMBOLP (base
))
6621 return apply_modifiers (modifiers
, base
);
6623 error ("Invalid base event");
6626 /* Try to recognize SYMBOL as a modifier name.
6627 Return the modifier flag bit, or 0 if not recognized. */
6630 parse_solitary_modifier (Lisp_Object symbol
)
6632 Lisp_Object name
= SYMBOL_NAME (symbol
);
6634 switch (SREF (name
, 0))
6636 #define SINGLE_LETTER_MOD(BIT) \
6637 if (SBYTES (name) == 1) \
6640 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6641 if (LEN == SBYTES (name) \
6642 && ! memcmp (SDATA (name), NAME, LEN)) \
6646 SINGLE_LETTER_MOD (alt_modifier
);
6650 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6654 SINGLE_LETTER_MOD (ctrl_modifier
);
6658 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6659 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6663 SINGLE_LETTER_MOD (hyper_modifier
);
6667 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6671 SINGLE_LETTER_MOD (meta_modifier
);
6675 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6679 SINGLE_LETTER_MOD (shift_modifier
);
6683 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6684 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6685 SINGLE_LETTER_MOD (super_modifier
);
6689 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6690 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6691 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6695 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6698 #undef SINGLE_LETTER_MOD
6699 #undef MULTI_LETTER_MOD
6705 /* Return true if EVENT is a list whose elements are all integers or symbols.
6706 Such a list is not valid as an event,
6707 but it can be a Lucid-style event type list. */
6710 lucid_event_type_list_p (Lisp_Object object
)
6714 if (! CONSP (object
))
6717 if (EQ (XCAR (object
), Qhelp_echo
)
6718 || EQ (XCAR (object
), Qvertical_line
)
6719 || EQ (XCAR (object
), Qmode_line
)
6720 || EQ (XCAR (object
), Qheader_line
))
6723 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6727 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6734 /* Return true if terminal input chars are available.
6735 Also, store the return value into INPUT_PENDING.
6737 Serves the purpose of ioctl (0, FIONREAD, ...)
6738 but works even if FIONREAD does not exist.
6739 (In fact, this may actually read some input.)
6741 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6742 timer events that are ripe.
6743 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6744 events (FOCUS_IN_EVENT).
6745 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6746 movements and toolkit scroll bar thumb drags. */
6749 get_input_pending (int flags
)
6751 /* First of all, have we already counted some input? */
6752 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6754 /* If input is being read as it arrives, and we have none, there is none. */
6755 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6757 /* Try to read some input and see how much we get. */
6759 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6762 return input_pending
;
6765 /* Put a BUFFER_SWITCH_EVENT in the buffer
6766 so that read_key_sequence will notice the new current buffer. */
6769 record_asynch_buffer_change (void)
6771 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6772 The purpose of the event is to make read_key_sequence look up the
6773 keymaps again. If we aren't in read_key_sequence, we don't need one,
6774 and the event could cause trouble by messing up (input-pending-p).
6775 Note: Fwaiting_for_user_input_p always returns nil when async
6776 subprocesses aren't supported. */
6777 if (!NILP (Fwaiting_for_user_input_p ()))
6779 struct input_event event
;
6782 event
.kind
= BUFFER_SWITCH_EVENT
;
6783 event
.frame_or_window
= Qnil
;
6786 /* Make sure no interrupt happens while storing the event. */
6788 if (interrupt_input
)
6789 kbd_buffer_store_event (&event
);
6794 kbd_buffer_store_event (&event
);
6800 /* Read any terminal input already buffered up by the system
6801 into the kbd_buffer, but do not wait.
6803 Return the number of keyboard chars read, or -1 meaning
6804 this is a bad time to try to read input. */
6813 /* Store pending user signal events, if any. */
6814 store_user_signal_events ();
6816 /* Loop through the available terminals, and call their input hooks. */
6820 struct terminal
*next
= t
->next_terminal
;
6822 if (t
->read_socket_hook
)
6825 struct input_event hold_quit
;
6827 if (input_blocked_p ())
6829 pending_signals
= 1;
6833 EVENT_INIT (hold_quit
);
6834 hold_quit
.kind
= NO_EVENT
;
6836 /* No need for FIONREAD or fcntl; just say don't wait. */
6837 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6840 if (nr
== -1) /* Not OK to read input now. */
6844 else if (nr
== -2) /* Non-transient error. */
6846 /* The terminal device terminated; it should be closed. */
6848 /* Kill Emacs if this was our last terminal. */
6849 if (!terminal_list
->next_terminal
)
6850 /* Formerly simply reported no input, but that
6851 sometimes led to a failure of Emacs to terminate.
6852 SIGHUP seems appropriate if we can't reach the
6854 /* ??? Is it really right to send the signal just to
6855 this process rather than to the whole process
6856 group? Perhaps on systems with FIONREAD Emacs is
6857 alone in its group. */
6858 terminate_due_to_signal (SIGHUP
, 10);
6860 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6863 XSETTERMINAL (tmp
, t
);
6864 Fdelete_terminal (tmp
, Qnoelisp
);
6868 if (hold_quit
.kind
!= NO_EVENT
)
6869 kbd_buffer_store_event (&hold_quit
);
6878 frame_make_pointer_visible ();
6883 /* This is the tty way of reading available input.
6885 Note that each terminal device has its own `struct terminal' object,
6886 and so this function is called once for each individual termcap
6887 terminal. The first parameter indicates which terminal to read from. */
6890 tty_read_avail_input (struct terminal
*terminal
,
6891 struct input_event
*hold_quit
)
6893 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6894 the kbd_buffer can really hold. That may prevent loss
6895 of characters on some systems when input is stuffed at us. */
6896 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6898 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6901 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6903 if (kbd_on_hold_p () || buffer_free
<= 0)
6905 #endif /* subprocesses */
6907 if (!terminal
->name
) /* Don't read from a dead terminal. */
6910 if (terminal
->type
!= output_termcap
6911 && terminal
->type
!= output_msdos_raw
)
6914 /* XXX I think the following code should be moved to separate hook
6915 functions in system-dependent files. */
6917 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6918 code sets read_socket_hook to w32_console_read_socket instead! */
6920 #else /* not WINDOWSNT */
6921 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6925 return 0; /* The terminal is suspended. */
6928 n_to_read
= dos_keysns ();
6932 cbuf
[0] = dos_keyread ();
6935 #else /* not MSDOS */
6940 struct input_event gpm_hold_quit
;
6941 int gpm
, fd
= gpm_fd
;
6943 EVENT_INIT (gpm_hold_quit
);
6944 gpm_hold_quit
.kind
= NO_EVENT
;
6946 /* gpm==1 if event received.
6947 gpm==0 if the GPM daemon has closed the connection, in which case
6948 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6949 we save it in `fd' so close_gpm can remove it from the
6951 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6952 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6953 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6956 /* Presumably the GPM daemon has closed the connection. */
6958 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6959 kbd_buffer_store_event (&gpm_hold_quit
);
6963 #endif /* HAVE_GPM */
6965 /* Determine how many characters we should *try* to read. */
6966 #ifdef USABLE_FIONREAD
6967 /* Find out how much input is available. */
6968 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6970 if (! noninteractive
)
6971 return -2; /* Close this terminal. */
6977 if (n_to_read
> sizeof cbuf
)
6978 n_to_read
= sizeof cbuf
;
6979 #elif defined USG || defined CYGWIN
6980 /* Read some input if available, but don't wait. */
6981 n_to_read
= sizeof cbuf
;
6982 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6984 # error "Cannot read without possibly delaying"
6988 /* Don't read more than we can store. */
6989 if (n_to_read
> buffer_free
)
6990 n_to_read
= buffer_free
;
6991 #endif /* subprocesses */
6993 /* Now read; for one reason or another, this will not block.
6994 NREAD is set to the number of chars read. */
6997 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6998 /* POSIX infers that processes which are not in the session leader's
6999 process group won't get SIGHUPs at logout time. BSDI adheres to
7000 this part standard and returns -1 from read (0) with errno==EIO
7001 when the control tty is taken away.
7002 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7003 if (nread
== -1 && errno
== EIO
)
7004 return -2; /* Close this terminal. */
7005 #if defined (AIX) && defined (_BSD)
7006 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7007 This looks incorrect, but it isn't, because _BSD causes
7008 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7009 and that causes a value other than 0 when there is no input. */
7011 return -2; /* Close this terminal. */
7015 /* We used to retry the read if it was interrupted.
7016 But this does the wrong thing when O_NONBLOCK causes
7017 an EAGAIN error. Does anybody know of a situation
7018 where a retry is actually needed? */
7020 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7030 #ifndef USABLE_FIONREAD
7031 #if defined (USG) || defined (CYGWIN)
7032 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7033 #endif /* USG or CYGWIN */
7034 #endif /* no FIONREAD */
7039 #endif /* not MSDOS */
7040 #endif /* not WINDOWSNT */
7042 for (i
= 0; i
< nread
; i
++)
7044 struct input_event buf
;
7046 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7048 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7049 buf
.modifiers
= meta_modifier
;
7050 if (tty
->meta_key
!= 2)
7054 /* Set the frame corresponding to the active tty. Note that the
7055 value of selected_frame is not reliable here, redisplay tends
7056 to temporarily change it. */
7057 buf
.frame_or_window
= tty
->top_frame
;
7060 kbd_buffer_store_event (&buf
);
7061 /* Don't look at input that follows a C-g too closely.
7062 This reduces lossage due to autorepeat on C-g. */
7063 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7064 && buf
.code
== quit_char
)
7072 handle_async_input (void)
7077 int nread
= gobble_input ();
7078 /* -1 means it's not ok to read the input now.
7079 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7080 0 means there was no keyboard input available. */
7088 process_pending_signals (void)
7090 pending_signals
= 0;
7091 handle_async_input ();
7092 do_pending_atimers ();
7095 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7096 and also (if the level is now 0) reinvoke any pending signal. */
7099 unblock_input_to (int level
)
7101 interrupt_input_blocked
= level
;
7104 if (pending_signals
)
7105 process_pending_signals ();
7111 /* End critical section.
7113 If doing signal-driven input, and a signal came in when input was
7114 blocked, reinvoke the signal handler now to deal with it. */
7117 unblock_input (void)
7119 unblock_input_to (interrupt_input_blocked
- 1);
7122 /* Undo any number of BLOCK_INPUT calls,
7123 and also reinvoke any pending signal. */
7126 totally_unblock_input (void)
7128 unblock_input_to (0);
7134 handle_input_available_signal (int sig
)
7136 pending_signals
= 1;
7138 if (input_available_clear_time
)
7139 *input_available_clear_time
= make_timespec (0, 0);
7143 deliver_input_available_signal (int sig
)
7145 deliver_process_signal (sig
, handle_input_available_signal
);
7147 #endif /* USABLE_SIGIO */
7150 /* User signal events. */
7152 struct user_signal_info
7154 /* Signal number. */
7157 /* Name of the signal. */
7160 /* Number of pending signals. */
7163 struct user_signal_info
*next
;
7166 /* List of user signals. */
7167 static struct user_signal_info
*user_signals
= NULL
;
7170 add_user_signal (int sig
, const char *name
)
7172 struct sigaction action
;
7173 struct user_signal_info
*p
;
7175 for (p
= user_signals
; p
; p
= p
->next
)
7177 /* Already added. */
7180 p
= xmalloc (sizeof *p
);
7182 p
->name
= xstrdup (name
);
7184 p
->next
= user_signals
;
7187 emacs_sigaction_init (&action
, deliver_user_signal
);
7188 sigaction (sig
, &action
, 0);
7192 handle_user_signal (int sig
)
7194 struct user_signal_info
*p
;
7195 const char *special_event_name
= NULL
;
7197 if (SYMBOLP (Vdebug_on_event
))
7198 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7200 for (p
= user_signals
; p
; p
= p
->next
)
7203 if (special_event_name
7204 && strcmp (special_event_name
, p
->name
) == 0)
7206 /* Enter the debugger in many ways. */
7207 debug_on_next_call
= 1;
7210 Vinhibit_quit
= Qnil
;
7212 /* Eat the event. */
7218 if (interrupt_input
)
7219 handle_input_available_signal (sig
);
7223 /* Tell wait_reading_process_output that it needs to wake
7224 up and look around. */
7225 if (input_available_clear_time
)
7226 *input_available_clear_time
= make_timespec (0, 0);
7233 deliver_user_signal (int sig
)
7235 deliver_process_signal (sig
, handle_user_signal
);
7239 find_user_signal_name (int sig
)
7241 struct user_signal_info
*p
;
7243 for (p
= user_signals
; p
; p
= p
->next
)
7251 store_user_signal_events (void)
7253 struct user_signal_info
*p
;
7254 struct input_event buf
;
7255 bool buf_initialized
= 0;
7257 for (p
= user_signals
; p
; p
= p
->next
)
7258 if (p
->npending
> 0)
7260 if (! buf_initialized
)
7262 memset (&buf
, 0, sizeof buf
);
7263 buf
.kind
= USER_SIGNAL_EVENT
;
7264 buf
.frame_or_window
= selected_frame
;
7265 buf_initialized
= 1;
7271 kbd_buffer_store_event (&buf
);
7274 while (p
->npending
> 0);
7279 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7280 static Lisp_Object menu_bar_one_keymap_changed_items
;
7282 /* These variables hold the vector under construction within
7283 menu_bar_items and its subroutines, and the current index
7284 for storing into that vector. */
7285 static Lisp_Object menu_bar_items_vector
;
7286 static int menu_bar_items_index
;
7289 static const char* separator_names
[] = {
7294 "single-dashed-line",
7295 "double-dashed-line",
7297 "shadow-etched-out",
7298 "shadow-etched-in-dash",
7299 "shadow-etched-out-dash",
7300 "shadow-double-etched-in",
7301 "shadow-double-etched-out",
7302 "shadow-double-etched-in-dash",
7303 "shadow-double-etched-out-dash",
7307 /* Return true if LABEL specifies a separator. */
7310 menu_separator_name_p (const char *label
)
7314 else if (strlen (label
) > 3
7315 && memcmp (label
, "--", 2) == 0
7320 for (i
= 0; separator_names
[i
]; ++i
)
7321 if (strcmp (label
, separator_names
[i
]) == 0)
7326 /* It's a separator if it contains only dashes. */
7327 while (*label
== '-')
7329 return (*label
== 0);
7336 /* Return a vector of menu items for a menu bar, appropriate
7337 to the current buffer. Each item has three elements in the vector:
7340 OLD is an old vector we can optionally reuse, or nil. */
7343 menu_bar_items (Lisp_Object old
)
7345 /* The number of keymaps we're scanning right now, and the number of
7346 keymaps we have allocated space for. */
7349 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7350 in the current keymaps, or nil where it is not a prefix. */
7353 Lisp_Object def
, tail
;
7358 /* In order to build the menus, we need to call the keymap
7359 accessors. They all call QUIT. But this function is called
7360 during redisplay, during which a quit is fatal. So inhibit
7361 quitting while building the menus.
7362 We do this instead of specbind because (1) errors will clear it anyway
7363 and (2) this avoids risk of specpdl overflow. */
7364 oquit
= Vinhibit_quit
;
7368 menu_bar_items_vector
= old
;
7370 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7371 menu_bar_items_index
= 0;
7373 /* Build our list of keymaps.
7374 If we recognize a function key and replace its escape sequence in
7375 keybuf with its symbol, or if the sequence starts with a mouse
7376 click and we need to switch buffers, we jump back here to rebuild
7377 the initial keymaps from the current buffer. */
7381 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7382 if (!NILP (Voverriding_local_map_menu_flag
)
7383 && !NILP (Voverriding_local_map
))
7385 /* Yes, use them (if non-nil) as well as the global map. */
7386 maps
= alloca (3 * sizeof (maps
[0]));
7388 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7389 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7390 if (!NILP (Voverriding_local_map
))
7391 maps
[nmaps
++] = Voverriding_local_map
;
7395 /* No, so use major and minor mode keymaps and keymap property.
7396 Note that menu-bar bindings in the local-map and keymap
7397 properties may not work reliable, as they are only
7398 recognized when the menu-bar (or mode-line) is updated,
7399 which does not normally happen after every command. */
7402 nminor
= current_minor_maps (NULL
, &tmaps
);
7403 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7405 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7406 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7407 maps
[nmaps
++] = tem
;
7408 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7409 maps
[nmaps
++] = tem
;
7410 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7412 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7414 maps
[nmaps
++] = current_global_map
;
7417 /* Look up in each map the dummy prefix key `menu-bar'. */
7419 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7420 if (!NILP (maps
[mapno
]))
7422 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7426 menu_bar_one_keymap_changed_items
= Qnil
;
7427 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7431 /* Move to the end those items that should be at the end. */
7433 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7436 int end
= menu_bar_items_index
;
7438 for (i
= 0; i
< end
; i
+= 4)
7439 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7441 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7442 /* Move the item at index I to the end,
7443 shifting all the others forward. */
7444 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7445 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7446 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7447 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7449 memmove (aref_addr (menu_bar_items_vector
, i
),
7450 aref_addr (menu_bar_items_vector
, i
+ 4),
7451 (end
- i
- 4) * word_size
);
7452 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7453 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7454 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7455 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7460 /* Add nil, nil, nil, nil at the end. */
7462 int i
= menu_bar_items_index
;
7463 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7464 menu_bar_items_vector
=
7465 larger_vector (menu_bar_items_vector
, 4, -1);
7466 /* Add this item. */
7467 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7468 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7469 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7470 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7471 menu_bar_items_index
= i
;
7474 Vinhibit_quit
= oquit
;
7475 return menu_bar_items_vector
;
7478 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7479 If there's already an item for KEY, add this DEF to it. */
7481 Lisp_Object item_properties
;
7484 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7486 struct gcpro gcpro1
;
7491 if (EQ (item
, Qundefined
))
7493 /* If a map has an explicit `undefined' as definition,
7494 discard any previously made menu bar item. */
7496 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7497 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7499 if (menu_bar_items_index
> i
+ 4)
7500 memmove (aref_addr (menu_bar_items_vector
, i
),
7501 aref_addr (menu_bar_items_vector
, i
+ 4),
7502 (menu_bar_items_index
- i
- 4) * word_size
);
7503 menu_bar_items_index
-= 4;
7507 /* If this keymap has already contributed to this KEY,
7508 don't contribute to it a second time. */
7509 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7510 if (!NILP (tem
) || NILP (item
))
7513 menu_bar_one_keymap_changed_items
7514 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7516 /* We add to menu_bar_one_keymap_changed_items before doing the
7517 parse_menu_item, so that if it turns out it wasn't a menu item,
7518 it still correctly hides any further menu item. */
7520 parsed
= parse_menu_item (item
, 1);
7525 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7527 /* Find any existing item for this KEY. */
7528 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7529 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7532 /* If we did not find this KEY, add it at the end. */
7533 if (i
== menu_bar_items_index
)
7535 /* If vector is too small, get a bigger one. */
7536 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7537 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7538 /* Add this item. */
7539 ASET (menu_bar_items_vector
, i
, key
); i
++;
7540 ASET (menu_bar_items_vector
, i
,
7541 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7542 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7543 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7544 menu_bar_items_index
= i
;
7546 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7550 old
= AREF (menu_bar_items_vector
, i
+ 2);
7551 /* If the new and the old items are not both keymaps,
7552 the lookup will only find `item'. */
7553 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7554 ASET (menu_bar_items_vector
, i
+ 2, item
);
7558 /* This is used as the handler when calling menu_item_eval_property. */
7560 menu_item_eval_property_1 (Lisp_Object arg
)
7562 /* If we got a quit from within the menu computation,
7563 quit all the way out of it. This takes care of C-] in the debugger. */
7564 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7565 Fsignal (Qquit
, Qnil
);
7571 eval_dyn (Lisp_Object form
)
7573 return Feval (form
, Qnil
);
7576 /* Evaluate an expression and return the result (or nil if something
7577 went wrong). Used to evaluate dynamic parts of menu items. */
7579 menu_item_eval_property (Lisp_Object sexpr
)
7581 ptrdiff_t count
= SPECPDL_INDEX ();
7583 specbind (Qinhibit_redisplay
, Qt
);
7584 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7585 menu_item_eval_property_1
);
7586 return unbind_to (count
, val
);
7589 /* This function parses a menu item and leaves the result in the
7590 vector item_properties.
7591 ITEM is a key binding, a possible menu item.
7592 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7594 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7595 parse_menu_item returns true if the item is a menu item and false
7599 parse_menu_item (Lisp_Object item
, int inmenubar
)
7601 Lisp_Object def
, tem
, item_string
, start
;
7603 Lisp_Object keyhint
;
7612 /* Create item_properties vector if necessary. */
7613 if (NILP (item_properties
))
7615 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7617 /* Initialize optional entries. */
7618 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7619 ASET (item_properties
, i
, Qnil
);
7620 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7622 /* Save the item here to protect it from GC. */
7623 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7625 item_string
= XCAR (item
);
7629 if (STRINGP (item_string
))
7631 /* Old format menu item. */
7632 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7634 /* Maybe help string. */
7635 if (CONSP (item
) && STRINGP (XCAR (item
)))
7637 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7642 /* Maybe an obsolete key binding cache. */
7643 if (CONSP (item
) && CONSP (XCAR (item
))
7644 && (NILP (XCAR (XCAR (item
)))
7645 || VECTORP (XCAR (XCAR (item
)))))
7648 /* This is the real definition--the function to run. */
7649 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7651 /* Get enable property, if any. */
7654 tem
= Fget (item
, Qmenu_enable
);
7655 if (!NILP (Venable_disabled_menus_and_buttons
))
7656 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7657 else if (!NILP (tem
))
7658 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7661 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7663 /* New format menu item. */
7664 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7665 start
= XCDR (item
);
7668 /* We have a real binding. */
7669 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7671 item
= XCDR (start
);
7672 /* Is there an obsolete cache list with key equivalences. */
7673 if (CONSP (item
) && CONSP (XCAR (item
)))
7676 /* Parse properties. */
7677 while (CONSP (item
) && CONSP (XCDR (item
)))
7682 if (EQ (tem
, QCenable
))
7684 if (!NILP (Venable_disabled_menus_and_buttons
))
7685 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7687 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7689 else if (EQ (tem
, QCvisible
))
7691 /* If got a visible property and that evaluates to nil
7692 then ignore this item. */
7693 tem
= menu_item_eval_property (XCAR (item
));
7697 else if (EQ (tem
, QChelp
))
7698 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7699 else if (EQ (tem
, QCfilter
))
7701 else if (EQ (tem
, QCkey_sequence
))
7704 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7705 /* Be GC protected. Set keyhint to item instead of tem. */
7708 else if (EQ (tem
, QCkeys
))
7711 if (CONSP (tem
) || STRINGP (tem
))
7712 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7714 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7719 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7721 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7723 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7729 else if (inmenubar
|| !NILP (start
))
7733 return 0; /* not a menu item */
7735 /* If item string is not a string, evaluate it to get string.
7736 If we don't get a string, skip this item. */
7737 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7738 if (!(STRINGP (item_string
)))
7740 item_string
= menu_item_eval_property (item_string
);
7741 if (!STRINGP (item_string
))
7743 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7746 /* If got a filter apply it on definition. */
7747 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7750 def
= menu_item_eval_property (list2 (XCAR (filter
),
7751 list2 (Qquote
, def
)));
7753 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7756 /* Enable or disable selection of item. */
7757 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7760 tem
= menu_item_eval_property (tem
);
7761 if (inmenubar
&& NILP (tem
))
7762 return 0; /* Ignore disabled items in menu bar. */
7763 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7766 /* If we got no definition, this item is just unselectable text which
7767 is OK in a submenu but not in the menubar. */
7769 return (!inmenubar
);
7771 /* See if this is a separate pane or a submenu. */
7772 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7773 tem
= get_keymap (def
, 0, 1);
7774 /* For a subkeymap, just record its details and exit. */
7777 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7778 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7782 /* At the top level in the menu bar, do likewise for commands also.
7783 The menu bar does not display equivalent key bindings anyway.
7784 ITEM_PROPERTY_DEF is already set up properly. */
7788 { /* This is a command. See if there is an equivalent key binding. */
7789 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7791 /* The previous code preferred :key-sequence to :keys, so we
7792 preserve this behavior. */
7793 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7794 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7797 Lisp_Object prefix
= keyeq
;
7798 Lisp_Object keys
= Qnil
;
7802 def
= XCAR (prefix
);
7803 prefix
= XCDR (prefix
);
7806 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7808 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7810 keys
= XCAR (keyhint
);
7811 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7813 /* We have a suggested key. Is it bound to the command? */
7816 /* If the command is an alias for another
7817 (such as lmenu.el set it up), check if the
7818 original command matches the cached command. */
7820 && EQ (tem
, XSYMBOL (def
)->function
))))
7825 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7829 tem
= Fkey_description (keys
, Qnil
);
7832 if (STRINGP (XCAR (prefix
)))
7833 tem
= concat2 (XCAR (prefix
), tem
);
7834 if (STRINGP (XCDR (prefix
)))
7835 tem
= concat2 (tem
, XCDR (prefix
));
7837 keyeq
= concat2 (build_string (" "), tem
);
7838 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7844 /* If we have an equivalent key binding, use that. */
7845 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7848 /* Include this when menu help is implemented.
7849 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7850 if (!(NILP (tem) || STRINGP (tem)))
7852 tem = menu_item_eval_property (tem);
7855 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7859 /* Handle radio buttons or toggle boxes. */
7860 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7862 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7863 menu_item_eval_property (tem
));
7870 /***********************************************************************
7872 ***********************************************************************/
7874 /* A vector holding tool bar items while they are parsed in function
7875 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7878 static Lisp_Object tool_bar_items_vector
;
7880 /* A vector holding the result of parse_tool_bar_item. Layout is like
7881 the one for a single item in tool_bar_items_vector. */
7883 static Lisp_Object tool_bar_item_properties
;
7885 /* Next free index in tool_bar_items_vector. */
7887 static int ntool_bar_items
;
7889 /* The symbols `:image' and `:rtl'. */
7891 static Lisp_Object QCimage
;
7892 static Lisp_Object QCrtl
;
7894 /* Function prototypes. */
7896 static void init_tool_bar_items (Lisp_Object
);
7897 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7898 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7899 static void append_tool_bar_item (void);
7902 /* Return a vector of tool bar items for keymaps currently in effect.
7903 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7904 tool bar items found. */
7907 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7916 /* In order to build the menus, we need to call the keymap
7917 accessors. They all call QUIT. But this function is called
7918 during redisplay, during which a quit is fatal. So inhibit
7919 quitting while building the menus. We do this instead of
7920 specbind because (1) errors will clear it anyway and (2) this
7921 avoids risk of specpdl overflow. */
7922 oquit
= Vinhibit_quit
;
7925 /* Initialize tool_bar_items_vector and protect it from GC. */
7926 init_tool_bar_items (reuse
);
7928 /* Build list of keymaps in maps. Set nmaps to the number of maps
7931 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7932 if (!NILP (Voverriding_local_map_menu_flag
)
7933 && !NILP (Voverriding_local_map
))
7935 /* Yes, use them (if non-nil) as well as the global map. */
7936 maps
= alloca (3 * sizeof *maps
);
7938 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7939 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7940 if (!NILP (Voverriding_local_map
))
7941 maps
[nmaps
++] = Voverriding_local_map
;
7945 /* No, so use major and minor mode keymaps and keymap property.
7946 Note that tool-bar bindings in the local-map and keymap
7947 properties may not work reliable, as they are only
7948 recognized when the tool-bar (or mode-line) is updated,
7949 which does not normally happen after every command. */
7952 nminor
= current_minor_maps (NULL
, &tmaps
);
7953 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7955 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7956 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7957 maps
[nmaps
++] = tem
;
7958 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7959 maps
[nmaps
++] = tem
;
7960 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7962 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7965 /* Add global keymap at the end. */
7966 maps
[nmaps
++] = current_global_map
;
7968 /* Process maps in reverse order and look up in each map the prefix
7970 for (i
= nmaps
- 1; i
>= 0; --i
)
7971 if (!NILP (maps
[i
]))
7975 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7977 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7980 Vinhibit_quit
= oquit
;
7981 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7982 return tool_bar_items_vector
;
7986 /* Process the definition of KEY which is DEF. */
7989 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7992 struct gcpro gcpro1
, gcpro2
;
7994 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7998 if (EQ (def
, Qundefined
))
8000 /* If a map has an explicit `undefined' as definition,
8001 discard any previously made item. */
8002 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8004 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8006 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8008 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8009 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8010 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8012 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8017 else if (parse_tool_bar_item (key
, def
))
8018 /* Append a new tool bar item to tool_bar_items_vector. Accept
8019 more than one definition for the same key. */
8020 append_tool_bar_item ();
8025 /* Access slot with index IDX of vector tool_bar_item_properties. */
8026 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8028 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8030 ASET (tool_bar_item_properties
, idx
, val
);
8034 /* Parse a tool bar item specification ITEM for key KEY and return the
8035 result in tool_bar_item_properties. Value is false if ITEM is
8038 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8040 CAPTION is the caption of the item, If it's not a string, it is
8041 evaluated to get a string.
8043 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8044 as binding are currently ignored.
8046 The following properties are recognized:
8050 FORM is evaluated and specifies whether the tool bar item is
8051 enabled or disabled.
8055 FORM is evaluated and specifies whether the tool bar item is visible.
8057 - `:filter FUNCTION'
8059 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8060 result is stored as the new binding.
8062 - `:button (TYPE SELECTED)'
8064 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8065 and specifies whether the button is selected (pressed) or not.
8069 IMAGES is either a single image specification or a vector of four
8070 image specifications. See enum tool_bar_item_images.
8072 - `:help HELP-STRING'.
8074 Gives a help string to display for the tool bar item.
8076 - `:label LABEL-STRING'.
8078 A text label to show with the tool bar button if labels are enabled. */
8081 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8083 Lisp_Object filter
= Qnil
;
8084 Lisp_Object caption
;
8086 bool have_label
= 0;
8088 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8089 Rule out items that aren't lists, don't start with
8090 `menu-item' or whose rest following `tool-bar-item' is not a
8095 /* As an exception, allow old-style menu separators. */
8096 if (STRINGP (XCAR (item
)))
8097 item
= list1 (XCAR (item
));
8098 else if (!EQ (XCAR (item
), Qmenu_item
)
8099 || (item
= XCDR (item
), !CONSP (item
)))
8102 /* Create tool_bar_item_properties vector if necessary. Reset it to
8104 if (VECTORP (tool_bar_item_properties
))
8106 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8110 tool_bar_item_properties
8111 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8114 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8115 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8117 /* Get the caption of the item. If the caption is not a string,
8118 evaluate it to get a string. If we don't get a string, skip this
8120 caption
= XCAR (item
);
8121 if (!STRINGP (caption
))
8123 caption
= menu_item_eval_property (caption
);
8124 if (!STRINGP (caption
))
8127 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8129 /* If the rest following the caption is not a list, the menu item is
8130 either a separator, or invalid. */
8134 if (menu_separator_name_p (SSDATA (caption
)))
8136 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8137 #if !defined (USE_GTK) && !defined (HAVE_NS)
8138 /* If we use build_desired_tool_bar_string to render the
8139 tool bar, the separator is rendered as an image. */
8140 set_prop (TOOL_BAR_ITEM_IMAGES
,
8141 (menu_item_eval_property
8142 (Vtool_bar_separator_image_expression
)));
8143 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8144 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8145 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8152 /* Store the binding. */
8153 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8156 /* Ignore cached key binding, if any. */
8157 if (CONSP (item
) && CONSP (XCAR (item
)))
8160 /* Process the rest of the properties. */
8161 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8163 Lisp_Object ikey
, value
;
8166 value
= XCAR (XCDR (item
));
8168 if (EQ (ikey
, QCenable
))
8170 /* `:enable FORM'. */
8171 if (!NILP (Venable_disabled_menus_and_buttons
))
8172 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8174 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8176 else if (EQ (ikey
, QCvisible
))
8178 /* `:visible FORM'. If got a visible property and that
8179 evaluates to nil then ignore this item. */
8180 if (NILP (menu_item_eval_property (value
)))
8183 else if (EQ (ikey
, QChelp
))
8184 /* `:help HELP-STRING'. */
8185 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8186 else if (EQ (ikey
, QCvert_only
))
8187 /* `:vert-only t/nil'. */
8188 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8189 else if (EQ (ikey
, QClabel
))
8191 const char *bad_label
= "!!?GARBLED ITEM?!!";
8192 /* `:label LABEL-STRING'. */
8193 set_prop (TOOL_BAR_ITEM_LABEL
,
8194 STRINGP (value
) ? value
: build_string (bad_label
));
8197 else if (EQ (ikey
, QCfilter
))
8198 /* ':filter FORM'. */
8200 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8202 /* `:button (TYPE . SELECTED)'. */
8203 Lisp_Object type
, selected
;
8205 type
= XCAR (value
);
8206 selected
= XCDR (value
);
8207 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8209 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8210 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8213 else if (EQ (ikey
, QCimage
)
8215 || (VECTORP (value
) && ASIZE (value
) == 4)))
8216 /* Value is either a single image specification or a vector
8217 of 4 such specifications for the different button states. */
8218 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8219 else if (EQ (ikey
, QCrtl
))
8221 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8227 /* Try to make one from caption and key. */
8228 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8229 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8230 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8231 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8233 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8234 char *buf
= xmalloc (max_lbl
+ 1);
8235 Lisp_Object new_lbl
;
8236 ptrdiff_t caption_len
= strlen (capt
);
8238 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8241 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8243 buf
[caption_len
] = '\0';
8247 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8251 strcpy (buf
, label
);
8253 for (j
= 0; buf
[j
] != '\0'; ++j
)
8261 new_lbl
= Fupcase_initials (build_string (label
));
8262 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8263 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8265 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8269 /* If got a filter apply it on binding. */
8271 set_prop (TOOL_BAR_ITEM_BINDING
,
8272 (menu_item_eval_property
8275 PROP (TOOL_BAR_ITEM_BINDING
))))));
8277 /* See if the binding is a keymap. Give up if it is. */
8278 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8281 /* Enable or disable selection of item. */
8282 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8283 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8284 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8286 /* Handle radio buttons or toggle boxes. */
8287 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8288 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8289 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8297 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8298 that can be reused. */
8301 init_tool_bar_items (Lisp_Object reuse
)
8303 if (VECTORP (reuse
))
8304 tool_bar_items_vector
= reuse
;
8306 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8307 ntool_bar_items
= 0;
8311 /* Append parsed tool bar item properties from
8312 tool_bar_item_properties */
8315 append_tool_bar_item (void)
8319 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8321 /* Enlarge tool_bar_items_vector if necessary. */
8323 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8325 /* Append entries from tool_bar_item_properties to the end of
8326 tool_bar_items_vector. */
8327 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8328 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8329 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8336 /* Read a character using menus based on the keymap MAP.
8337 Return nil if there are no menus in the maps.
8338 Return t if we displayed a menu but the user rejected it.
8340 PREV_EVENT is the previous input event, or nil if we are reading
8341 the first event of a key sequence.
8343 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8344 if we used a mouse menu to read the input, or false otherwise. If
8345 USED_MOUSE_MENU is null, don't dereference it.
8347 The prompting is done based on the prompt-string of the map
8348 and the strings associated with various map elements.
8350 This can be done with X menus or with menus put in the minibuf.
8351 These are done in different ways, depending on how the input will be read.
8352 Menus using X are done after auto-saving in read-char, getting the input
8353 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8354 and do auto-saving in the inner call of read_char. */
8357 read_char_x_menu_prompt (Lisp_Object map
,
8358 Lisp_Object prev_event
, bool *used_mouse_menu
)
8360 if (used_mouse_menu
)
8361 *used_mouse_menu
= 0;
8363 /* Use local over global Menu maps. */
8365 if (! menu_prompting
)
8369 /* If we got to this point via a mouse click,
8370 use a real menu for mouse selection. */
8371 if (EVENT_HAS_PARAMETERS (prev_event
)
8372 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8373 && !EQ (XCAR (prev_event
), Qtool_bar
))
8375 /* Display the menu and get the selection. */
8378 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8383 record_menu_key (XCAR (value
));
8385 /* If we got multiple events, unread all but
8387 There is no way to prevent those unread events
8388 from showing up later in last_nonmenu_event.
8389 So turn symbol and integer events into lists,
8390 to indicate that they came from a mouse menu,
8391 so that when present in last_nonmenu_event
8392 they won't confuse things. */
8393 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8395 record_menu_key (XCAR (tem
));
8396 if (SYMBOLP (XCAR (tem
))
8397 || INTEGERP (XCAR (tem
)))
8398 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8401 /* If we got more than one event, put all but the first
8402 onto this list to be read later.
8403 Return just the first event now. */
8404 Vunread_command_events
8405 = nconc2 (XCDR (value
), Vunread_command_events
);
8406 value
= XCAR (value
);
8408 else if (NILP (value
))
8410 if (used_mouse_menu
)
8411 *used_mouse_menu
= 1;
8414 #endif /* HAVE_MENUS */
8419 read_char_minibuf_menu_prompt (int commandflag
,
8422 register Lisp_Object name
;
8424 /* FIXME: Use the minibuffer's frame width. */
8425 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8427 bool nobindings
= 1;
8428 Lisp_Object rest
, vector
;
8429 Lisp_Object prompt_strings
= Qnil
;
8433 if (! menu_prompting
)
8436 map
= get_keymap (map
, 0, 1);
8437 name
= Fkeymap_prompt (map
);
8439 /* If we don't have any menus, just read a character normally. */
8440 if (!STRINGP (name
))
8443 #define PUSH_C_STR(str, listvar) \
8444 listvar = Fcons (build_unibyte_string (str), listvar)
8446 /* Prompt string always starts with map's prompt, and a space. */
8447 prompt_strings
= Fcons (name
, prompt_strings
);
8448 PUSH_C_STR (": ", prompt_strings
);
8449 nlength
= SCHARS (name
) + 2;
8453 /* Present the documented bindings, a line at a time. */
8457 Lisp_Object menu_strings
= prompt_strings
;
8458 ptrdiff_t i
= nlength
;
8460 Lisp_Object orig_defn_macro
;
8462 /* Loop over elements of map. */
8467 /* FIXME: Use map_keymap to handle new keymap formats. */
8469 /* At end of map, wrap around if just starting,
8470 or end this line if already have something on it. */
8473 if (notfirst
|| nobindings
)
8479 /* Look at the next element of the map. */
8481 elt
= AREF (vector
, idx
);
8483 elt
= Fcar_safe (rest
);
8485 if (idx
< 0 && VECTORP (elt
))
8487 /* If we found a dense table in the keymap,
8488 advanced past it, but start scanning its contents. */
8489 rest
= Fcdr_safe (rest
);
8495 /* An ordinary element. */
8496 Lisp_Object event
, tem
;
8500 event
= Fcar_safe (elt
); /* alist */
8501 elt
= Fcdr_safe (elt
);
8505 XSETINT (event
, idx
); /* vector */
8508 /* Ignore the element if it has no prompt string. */
8509 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8511 /* True if the char to type matches the string. */
8513 Lisp_Object upcased_event
, downcased_event
;
8514 Lisp_Object desc
= Qnil
;
8516 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8518 upcased_event
= Fupcase (event
);
8519 downcased_event
= Fdowncase (event
);
8520 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8521 || XINT (downcased_event
) == SREF (s
, 0));
8523 desc
= Fsingle_key_description (event
, Qnil
);
8525 #if 0 /* It is redundant to list the equivalent key bindings because
8526 the prefix is what the user has already typed. */
8528 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8530 /* Insert equivalent keybinding. */
8531 s
= concat2 (s
, tem
);
8534 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8535 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8537 /* Insert button prefix. */
8538 Lisp_Object selected
8539 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8540 if (EQ (tem
, QCradio
))
8541 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8543 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8544 s
= concat2 (tem
, s
);
8548 /* If we have room for the prompt string, add it to this line.
8549 If this is the first on the line, always add it. */
8550 if ((SCHARS (s
) + i
+ 2
8551 + (char_matches
? 0 : SCHARS (desc
) + 3))
8555 ptrdiff_t thiswidth
;
8557 /* Punctuate between strings. */
8560 PUSH_C_STR (", ", menu_strings
);
8566 /* If the char to type doesn't match the string's
8567 first char, explicitly show what char to type. */
8570 /* Add as much of string as fits. */
8571 thiswidth
= min (SCHARS (desc
), width
- i
);
8573 = Fcons (Fsubstring (desc
, make_number (0),
8574 make_number (thiswidth
)),
8577 PUSH_C_STR (" = ", menu_strings
);
8581 /* Add as much of string as fits. */
8582 thiswidth
= min (SCHARS (s
), width
- i
);
8584 = Fcons (Fsubstring (s
, make_number (0),
8585 make_number (thiswidth
)),
8591 /* If this element does not fit, end the line now,
8592 and save the element for the next line. */
8593 PUSH_C_STR ("...", menu_strings
);
8598 /* Move past this element. */
8599 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8600 /* Handle reaching end of dense table. */
8605 rest
= Fcdr_safe (rest
);
8609 /* Prompt with that and read response. */
8610 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8612 /* Make believe it's not a keyboard macro in case the help char
8613 is pressed. Help characters are not recorded because menu prompting
8614 is not used on replay. */
8615 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8616 kset_defining_kbd_macro (current_kboard
, Qnil
);
8618 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8619 while (BUFFERP (obj
));
8620 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8622 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8625 if (! EQ (obj
, menu_prompt_more_char
)
8626 && (!INTEGERP (menu_prompt_more_char
)
8627 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8629 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8630 store_kbd_macro_char (obj
);
8633 /* Help char - go round again. */
8637 /* Reading key sequences. */
8640 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8642 return access_keymap (get_keymap (keymap
, 0, 1),
8647 active_maps (Lisp_Object first_event
)
8649 Lisp_Object position
8650 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8651 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8654 /* Structure used to keep track of partial application of key remapping
8655 such as Vfunction_key_map and Vkey_translation_map. */
8656 typedef struct keyremap
8658 /* This is the map originally specified for this use. */
8660 /* This is a submap reached by looking up, in PARENT,
8661 the events from START to END. */
8663 /* Positions [START, END) in the key sequence buffer
8664 are the key that we have scanned so far.
8665 Those events are the ones that we will replace
8666 if PARENT maps them into a key sequence. */
8670 /* Lookup KEY in MAP.
8671 MAP is a keymap mapping keys to key vectors or functions.
8672 If the mapping is a function and DO_FUNCALL is true,
8673 the function is called with PROMPT as parameter and its return
8674 value is used as the return value of this function (after checking
8675 that it is indeed a vector). */
8678 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8683 next
= access_keymap (map
, key
, 1, 0, 1);
8685 /* Handle a symbol whose function definition is a keymap
8687 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8688 && (ARRAYP (XSYMBOL (next
)->function
)
8689 || KEYMAPP (XSYMBOL (next
)->function
)))
8690 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8692 /* If the keymap gives a function, not an
8693 array, then call the function with one arg and use
8694 its value instead. */
8695 if (do_funcall
&& FUNCTIONP (next
))
8700 next
= call1 (next
, prompt
);
8701 /* If the function returned something invalid,
8702 barf--don't ignore it.
8703 (To ignore it safely, we would need to gcpro a bunch of
8704 other variables.) */
8705 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8706 error ("Function %s returns invalid key sequence",
8707 SSDATA (SYMBOL_NAME (tem
)));
8712 /* Do one step of the key remapping used for function-key-map and
8713 key-translation-map:
8714 KEYBUF is the buffer holding the input events.
8715 BUFSIZE is its maximum size.
8716 FKEY is a pointer to the keyremap structure to use.
8717 INPUT is the index of the last element in KEYBUF.
8718 DOIT if true says that the remapping can actually take place.
8719 DIFF is used to return the number of keys added/removed by the remapping.
8720 PARENT is the root of the keymap.
8721 PROMPT is the prompt to use if the remapping happens through a function.
8722 Return true if the remapping actually took place. */
8725 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8726 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8728 Lisp_Object next
, key
;
8730 key
= keybuf
[fkey
->end
++];
8732 if (KEYMAPP (fkey
->parent
))
8733 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8737 /* If keybuf[fkey->start..fkey->end] is bound in the
8738 map and we're in a position to do the key remapping, replace it with
8739 the binding and restart with fkey->start at the end. */
8740 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8742 int len
= XFASTINT (Flength (next
));
8745 *diff
= len
- (fkey
->end
- fkey
->start
);
8747 if (bufsize
- input
<= *diff
)
8748 error ("Key sequence too long");
8750 /* Shift the keys that follow fkey->end. */
8752 for (i
= fkey
->end
; i
< input
; i
++)
8753 keybuf
[i
+ *diff
] = keybuf
[i
];
8755 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8756 keybuf
[i
+ *diff
] = keybuf
[i
];
8757 /* Overwrite the old keys with the new ones. */
8758 for (i
= 0; i
< len
; i
++)
8759 keybuf
[fkey
->start
+ i
]
8760 = Faref (next
, make_number (i
));
8762 fkey
->start
= fkey
->end
+= *diff
;
8763 fkey
->map
= fkey
->parent
;
8768 fkey
->map
= get_keymap (next
, 0, 1);
8770 /* If we no longer have a bound suffix, try a new position for
8772 if (!CONSP (fkey
->map
))
8774 fkey
->end
= ++fkey
->start
;
8775 fkey
->map
= fkey
->parent
;
8781 test_undefined (Lisp_Object binding
)
8783 return (NILP (binding
)
8784 || EQ (binding
, Qundefined
)
8785 || (SYMBOLP (binding
)
8786 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8789 /* Read a sequence of keys that ends with a non prefix character,
8790 storing it in KEYBUF, a buffer of size BUFSIZE.
8792 Return the length of the key sequence stored.
8793 Return -1 if the user rejected a command menu.
8795 Echo starting immediately unless `prompt' is 0.
8797 Where a key sequence ends depends on the currently active keymaps.
8798 These include any minor mode keymaps active in the current buffer,
8799 the current buffer's local map, and the global map.
8801 If a key sequence has no other bindings, we check Vfunction_key_map
8802 to see if some trailing subsequence might be the beginning of a
8803 function key's sequence. If so, we try to read the whole function
8804 key, and substitute its symbolic name into the key sequence.
8806 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8807 `double-' events into similar click events, if that would make them
8808 bound. We try to turn `triple-' events first into `double-' events,
8811 If we get a mouse click in a mode line, vertical divider, or other
8812 non-text area, we treat the click as if it were prefixed by the
8813 symbol denoting that area - `mode-line', `vertical-line', or
8816 If the sequence starts with a mouse click, we read the key sequence
8817 with respect to the buffer clicked on, not the current buffer.
8819 If the user switches frames in the midst of a key sequence, we put
8820 off the switch-frame event until later; the next call to
8821 read_char will return it.
8823 If FIX_CURRENT_BUFFER, we restore current_buffer
8824 from the selected window's buffer. */
8827 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8828 bool dont_downcase_last
, bool can_return_switch_frame
,
8829 bool fix_current_buffer
)
8831 ptrdiff_t count
= SPECPDL_INDEX ();
8833 /* How many keys there are in the current key sequence. */
8836 /* The length of the echo buffer when we started reading, and
8837 the length of this_command_keys when we started reading. */
8838 ptrdiff_t echo_start
IF_LINT (= 0);
8839 ptrdiff_t keys_start
;
8841 Lisp_Object current_binding
= Qnil
;
8842 Lisp_Object first_event
= Qnil
;
8844 /* Index of the first key that has no binding.
8845 It is useless to try fkey.start larger than that. */
8848 /* If t < mock_input, then KEYBUF[t] should be read as the next
8851 We use this to recover after recognizing a function key. Once we
8852 realize that a suffix of the current key sequence is actually a
8853 function key's escape sequence, we replace the suffix with the
8854 function key's binding from Vfunction_key_map. Now keybuf
8855 contains a new and different key sequence, so the echo area,
8856 this_command_keys, and the submaps and defs arrays are wrong. In
8857 this situation, we set mock_input to t, set t to 0, and jump to
8858 restart_sequence; the loop will read keys from keybuf up until
8859 mock_input, thus rebuilding the state; and then it will resume
8860 reading characters from the keyboard. */
8863 /* If the sequence is unbound in submaps[], then
8864 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8865 and fkey.map is its binding.
8867 These might be > t, indicating that all function key scanning
8868 should hold off until t reaches them. We do this when we've just
8869 recognized a function key, to avoid searching for the function
8870 key's again in Vfunction_key_map. */
8873 /* Likewise, for key_translation_map and input-decode-map. */
8874 keyremap keytran
, indec
;
8876 /* True if we are trying to map a key by changing an upper-case
8877 letter to lower case, or a shifted function key to an unshifted
8879 bool shift_translated
= 0;
8881 /* If we receive a `switch-frame' or `select-window' event in the middle of
8882 a key sequence, we put it off for later.
8883 While we're reading, we keep the event here. */
8884 Lisp_Object delayed_switch_frame
;
8886 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8887 int original_uppercase_position
= -1;
8889 /* Gets around Microsoft compiler limitations. */
8892 struct buffer
*starting_buffer
;
8894 /* List of events for which a fake prefix key has been generated. */
8895 Lisp_Object fake_prefixed_keys
= Qnil
;
8897 struct gcpro gcpro1
;
8899 GCPRO1 (fake_prefixed_keys
);
8900 raw_keybuf_count
= 0;
8902 last_nonmenu_event
= Qnil
;
8904 delayed_switch_frame
= Qnil
;
8910 /* Install the string STR as the beginning of the string of
8911 echoing, so that it serves as a prompt for the next
8913 kset_echo_string (current_kboard
, prompt
);
8914 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8917 else if (cursor_in_echo_area
8918 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8919 && NILP (Fzerop (Vecho_keystrokes
)))
8920 /* This doesn't put in a dash if the echo buffer is empty, so
8921 you don't always see a dash hanging out in the minibuffer. */
8925 /* Record the initial state of the echo area and this_command_keys;
8926 we will need to restore them if we replay a key sequence. */
8928 echo_start
= echo_length ();
8929 keys_start
= this_command_key_count
;
8930 this_single_command_key_start
= keys_start
;
8932 /* We jump here when we need to reinitialize fkey and keytran; this
8933 happens if we switch keyboards between rescans. */
8934 replay_entire_sequence
:
8936 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8937 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8938 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8939 indec
.start
= indec
.end
= 0;
8940 fkey
.start
= fkey
.end
= 0;
8941 keytran
.start
= keytran
.end
= 0;
8943 /* We jump here when the key sequence has been thoroughly changed, and
8944 we need to rescan it starting from the beginning. When we jump here,
8945 keybuf[0..mock_input] holds the sequence we should reread. */
8948 starting_buffer
= current_buffer
;
8949 first_unbound
= bufsize
+ 1;
8951 /* Build our list of keymaps.
8952 If we recognize a function key and replace its escape sequence in
8953 keybuf with its symbol, or if the sequence starts with a mouse
8954 click and we need to switch buffers, we jump back here to rebuild
8955 the initial keymaps from the current buffer. */
8956 current_binding
= active_maps (first_event
);
8958 /* Start from the beginning in keybuf. */
8961 /* These are no-ops the first time through, but if we restart, they
8962 revert the echo area and this_command_keys to their original state. */
8963 this_command_key_count
= keys_start
;
8964 if (INTERACTIVE
&& t
< mock_input
)
8965 echo_truncate (echo_start
);
8967 /* If the best binding for the current key sequence is a keymap, or
8968 we may be looking at a function key's escape sequence, keep on
8970 while (!NILP (current_binding
)
8971 /* Keep reading as long as there's a prefix binding. */
8972 ? KEYMAPP (current_binding
)
8973 /* Don't return in the middle of a possible function key sequence,
8974 if the only bindings we found were via case conversion.
8975 Thus, if ESC O a has a function-key-map translation
8976 and ESC o has a binding, don't return after ESC O,
8977 so that we can translate ESC O plus the next character. */
8978 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8981 bool used_mouse_menu
= 0;
8983 /* Where the last real key started. If we need to throw away a
8984 key that has expanded into more than one element of keybuf
8985 (say, a mouse click on the mode line which is being treated
8986 as [mode-line (mouse-...)], then we backtrack to this point
8988 int last_real_key_start
;
8990 /* These variables are analogous to echo_start and keys_start;
8991 while those allow us to restart the entire key sequence,
8992 echo_local_start and keys_local_start allow us to throw away
8994 ptrdiff_t echo_local_start
IF_LINT (= 0);
8995 int keys_local_start
;
8996 Lisp_Object new_binding
;
8998 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
8999 eassert (indec
.start
<= indec
.end
);
9000 eassert (fkey
.start
<= fkey
.end
);
9001 eassert (keytran
.start
<= keytran
.end
);
9002 /* key-translation-map is applied *after* function-key-map
9003 which is itself applied *after* input-decode-map. */
9004 eassert (fkey
.end
<= indec
.start
);
9005 eassert (keytran
.end
<= fkey
.start
);
9007 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9008 first_unbound
< keytran
.start
)
9009 { /* The prefix upto first_unbound has no binding and has
9010 no translation left to do either, so we know it's unbound.
9011 If we don't stop now, we risk staying here indefinitely
9012 (if the user keeps entering fkey or keytran prefixes
9013 like C-c ESC ESC ESC ESC ...) */
9015 for (i
= first_unbound
+ 1; i
< t
; i
++)
9016 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9017 mock_input
= t
- first_unbound
- 1;
9018 indec
.end
= indec
.start
-= first_unbound
+ 1;
9019 indec
.map
= indec
.parent
;
9020 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9021 fkey
.map
= fkey
.parent
;
9022 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9023 keytran
.map
= keytran
.parent
;
9024 goto replay_sequence
;
9028 error ("Key sequence too long");
9031 echo_local_start
= echo_length ();
9032 keys_local_start
= this_command_key_count
;
9035 /* These are no-ops, unless we throw away a keystroke below and
9036 jumped back up to replay_key; in that case, these restore the
9037 variables to their original state, allowing us to replay the
9039 if (INTERACTIVE
&& t
< mock_input
)
9040 echo_truncate (echo_local_start
);
9041 this_command_key_count
= keys_local_start
;
9043 /* By default, assume each event is "real". */
9044 last_real_key_start
= t
;
9046 /* Does mock_input indicate that we are re-reading a key sequence? */
9050 add_command_key (key
);
9051 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9052 && NILP (Fzerop (Vecho_keystrokes
))
9053 && current_kboard
->immediate_echo
)
9060 /* If not, we should actually read a character. */
9064 KBOARD
*interrupted_kboard
= current_kboard
;
9065 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9066 key
= read_char (NILP (prompt
),
9067 current_binding
, last_nonmenu_event
,
9068 &used_mouse_menu
, NULL
);
9069 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9070 /* When switching to a new tty (with a new keyboard),
9071 read_char returns the new buffer, rather than -2
9072 (Bug#5095). This is because `terminal-init-xterm'
9073 calls read-char, which eats the wrong_kboard_jmpbuf
9074 return. Any better way to fix this? -- cyd */
9075 || (interrupted_kboard
!= current_kboard
))
9080 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9081 if (k
== interrupted_kboard
)
9086 /* Don't touch interrupted_kboard when it's been
9088 delayed_switch_frame
= Qnil
;
9089 goto replay_entire_sequence
;
9092 if (!NILP (delayed_switch_frame
))
9095 (interrupted_kboard
,
9096 Fcons (delayed_switch_frame
,
9097 KVAR (interrupted_kboard
, kbd_queue
)));
9098 delayed_switch_frame
= Qnil
;
9103 (interrupted_kboard
,
9104 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9106 /* If the side queue is non-empty, ensure it begins with a
9107 switch-frame, so we'll replay it in the right context. */
9108 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9109 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9110 !(EVENT_HAS_PARAMETERS (key
)
9111 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9115 XSETFRAME (frame
, interrupted_frame
);
9117 (interrupted_kboard
,
9118 Fcons (make_lispy_switch_frame (frame
),
9119 KVAR (interrupted_kboard
, kbd_queue
)));
9122 goto replay_entire_sequence
;
9126 /* read_char returns t when it shows a menu and the user rejects it.
9130 unbind_to (count
, Qnil
);
9135 /* read_char returns -1 at the end of a macro.
9136 Emacs 18 handles this by returning immediately with a
9137 zero, so that's what we'll do. */
9138 if (INTEGERP (key
) && XINT (key
) == -1)
9141 /* The Microsoft C compiler can't handle the goto that
9147 /* If the current buffer has been changed from under us, the
9148 keymap may have changed, so replay the sequence. */
9151 timer_resume_idle ();
9154 /* Reset the current buffer from the selected window
9155 in case something changed the former and not the latter.
9156 This is to be more consistent with the behavior
9157 of the command_loop_1. */
9158 if (fix_current_buffer
)
9160 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9162 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9164 Fset_buffer (XWINDOW (selected_window
)->contents
);
9167 goto replay_sequence
;
9170 /* If we have a quit that was typed in another frame, and
9171 quit_throw_to_read_char switched buffers,
9172 replay to get the right keymap. */
9174 && XINT (key
) == quit_char
9175 && current_buffer
!= starting_buffer
)
9178 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9183 goto replay_sequence
;
9188 if (EVENT_HAS_PARAMETERS (key
)
9189 /* Either a `switch-frame' or a `select-window' event. */
9190 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9192 /* If we're at the beginning of a key sequence, and the caller
9193 says it's okay, go ahead and return this event. If we're
9194 in the midst of a key sequence, delay it until the end. */
9195 if (t
> 0 || !can_return_switch_frame
)
9197 delayed_switch_frame
= key
;
9202 if (NILP (first_event
))
9205 /* Even if first_event does not specify a particular
9206 window/position, it's important to recompute the maps here
9207 since a long time might have passed since we entered
9208 read_key_sequence, and a timer (or process-filter or
9209 special-event-map, ...) might have switched the current buffer
9210 or the selected window from under us in the mean time. */
9211 if (fix_current_buffer
9212 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9214 Fset_buffer (XWINDOW (selected_window
)->contents
);
9215 current_binding
= active_maps (first_event
);
9219 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9223 /* Clicks in non-text areas get prefixed by the symbol
9224 in their CHAR-ADDRESS field. For example, a click on
9225 the mode line is prefixed by the symbol `mode-line'.
9227 Furthermore, key sequences beginning with mouse clicks
9228 are read using the keymaps of the buffer clicked on, not
9229 the current buffer. So we may have to switch the buffer
9232 When we turn one event into two events, we must make sure
9233 that neither of the two looks like the original--so that,
9234 if we replay the events, they won't be expanded again.
9235 If not for this, such reexpansion could happen either here
9236 or when user programs play with this-command-keys. */
9237 if (EVENT_HAS_PARAMETERS (key
))
9239 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9240 if (EQ (kind
, Qmouse_click
))
9242 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9243 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9246 || (!NILP (fake_prefixed_keys
)
9247 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9249 /* We're looking a second time at an event for which
9250 we generated a fake prefix key. Set
9251 last_real_key_start appropriately. */
9253 last_real_key_start
= t
- 1;
9256 if (last_real_key_start
== 0)
9258 /* Key sequences beginning with mouse clicks are
9259 read using the keymaps in the buffer clicked on,
9260 not the current buffer. If we're at the
9261 beginning of a key sequence, switch buffers. */
9262 if (WINDOWP (window
)
9263 && BUFFERP (XWINDOW (window
)->contents
)
9264 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9266 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9271 /* Arrange to go back to the original buffer once we're
9272 done reading the key sequence. Note that we can't
9273 use save_excursion_{save,restore} here, because they
9274 save point as well as the current buffer; we don't
9275 want to save point, because redisplay may change it,
9276 to accommodate a Fset_window_start or something. We
9277 don't want to do this at the top of the function,
9278 because we may get input from a subprocess which
9279 wants to change the selected window and stuff (say,
9281 record_unwind_current_buffer ();
9283 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9285 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9286 goto replay_sequence
;
9290 /* Expand mode-line and scroll-bar events into two events:
9291 use posn as a fake prefix key. */
9293 && (NILP (fake_prefixed_keys
)
9294 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9296 if (bufsize
- t
<= 1)
9297 error ("Key sequence too long");
9300 keybuf
[t
+ 1] = key
;
9303 /* Record that a fake prefix key has been generated
9304 for KEY. Don't modify the event; this would
9305 prevent proper action when the event is pushed
9306 back into unread-command-events. */
9307 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9311 else if (CONSP (XCDR (key
))
9312 && CONSP (EVENT_START (key
))
9313 && CONSP (XCDR (EVENT_START (key
))))
9317 posn
= POSN_POSN (EVENT_START (key
));
9318 /* Handle menu-bar events:
9319 insert the dummy prefix event `menu-bar'. */
9320 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9322 if (bufsize
- t
<= 1)
9323 error ("Key sequence too long");
9325 keybuf
[t
+ 1] = key
;
9327 /* Zap the position in key, so we know that we've
9328 expanded it, and don't try to do so again. */
9329 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9332 goto replay_sequence
;
9334 else if (CONSP (posn
))
9336 /* We're looking at the second event of a
9337 sequence which we expanded before. Set
9338 last_real_key_start appropriately. */
9339 if (last_real_key_start
== t
&& t
> 0)
9340 last_real_key_start
= t
- 1;
9345 /* We have finally decided that KEY is something we might want
9347 new_binding
= follow_key (current_binding
, key
);
9349 /* If KEY wasn't bound, we'll try some fallbacks. */
9350 if (!NILP (new_binding
))
9351 /* This is needed for the following scenario:
9352 event 0: a down-event that gets dropped by calling replay_key.
9353 event 1: some normal prefix like C-h.
9354 After event 0, first_unbound is 0, after event 1 indec.start,
9355 fkey.start, and keytran.start are all 1, so when we see that
9356 C-h is bound, we need to update first_unbound. */
9357 first_unbound
= max (t
+ 1, first_unbound
);
9362 /* Remember the position to put an upper bound on indec.start. */
9363 first_unbound
= min (t
, first_unbound
);
9365 head
= EVENT_HEAD (key
);
9366 if (help_char_p (head
) && t
> 0)
9368 read_key_sequence_cmd
= Vprefix_help_command
;
9370 last_nonmenu_event
= key
;
9371 /* The Microsoft C compiler can't handle the goto that
9379 Lisp_Object breakdown
;
9382 breakdown
= parse_modifiers (head
);
9383 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9384 /* Attempt to reduce an unbound mouse event to a simpler
9385 event that is bound:
9386 Drags reduce to clicks.
9387 Double-clicks reduce to clicks.
9388 Triple-clicks reduce to double-clicks, then to clicks.
9389 Down-clicks are eliminated.
9390 Double-downs reduce to downs, then are eliminated.
9391 Triple-downs reduce to double-downs, then to downs,
9392 then are eliminated. */
9393 if (modifiers
& (down_modifier
| drag_modifier
9394 | double_modifier
| triple_modifier
))
9396 while (modifiers
& (down_modifier
| drag_modifier
9397 | double_modifier
| triple_modifier
))
9399 Lisp_Object new_head
, new_click
;
9400 if (modifiers
& triple_modifier
)
9401 modifiers
^= (double_modifier
| triple_modifier
);
9402 else if (modifiers
& double_modifier
)
9403 modifiers
&= ~double_modifier
;
9404 else if (modifiers
& drag_modifier
)
9405 modifiers
&= ~drag_modifier
;
9408 /* Dispose of this `down' event by simply jumping
9409 back to replay_key, to get another event.
9411 Note that if this event came from mock input,
9412 then just jumping back to replay_key will just
9413 hand it to us again. So we have to wipe out any
9416 We could delete keybuf[t] and shift everything
9417 after that to the left by one spot, but we'd also
9418 have to fix up any variable that points into
9419 keybuf, and shifting isn't really necessary
9422 Adding prefixes for non-textual mouse clicks
9423 creates two characters of mock input, and both
9424 must be thrown away. If we're only looking at
9425 the prefix now, we can just jump back to
9426 replay_key. On the other hand, if we've already
9427 processed the prefix, and now the actual click
9428 itself is giving us trouble, then we've lost the
9429 state of the keymaps we want to backtrack to, and
9430 we need to replay the whole sequence to rebuild
9433 Beyond that, only function key expansion could
9434 create more than two keys, but that should never
9435 generate mouse events, so it's okay to zero
9436 mock_input in that case too.
9438 FIXME: The above paragraph seems just plain
9439 wrong, if you consider things like
9440 xterm-mouse-mode. -stef
9442 Isn't this just the most wonderful code ever? */
9444 /* If mock_input > t + 1, the above simplification
9445 will actually end up dropping keys on the floor.
9446 This is probably OK for now, but even
9447 if mock_input <= t + 1, we need to adjust indec,
9449 Typical case [header-line down-mouse-N]:
9450 mock_input = 2, t = 1, fkey.end = 1,
9451 last_real_key_start = 0. */
9452 if (indec
.end
> last_real_key_start
)
9454 indec
.end
= indec
.start
9455 = min (last_real_key_start
, indec
.start
);
9456 indec
.map
= indec
.parent
;
9457 if (fkey
.end
> last_real_key_start
)
9459 fkey
.end
= fkey
.start
9460 = min (last_real_key_start
, fkey
.start
);
9461 fkey
.map
= fkey
.parent
;
9462 if (keytran
.end
> last_real_key_start
)
9464 keytran
.end
= keytran
.start
9465 = min (last_real_key_start
, keytran
.start
);
9466 keytran
.map
= keytran
.parent
;
9470 if (t
== last_real_key_start
)
9477 mock_input
= last_real_key_start
;
9478 goto replay_sequence
;
9483 = apply_modifiers (modifiers
, XCAR (breakdown
));
9484 new_click
= list2 (new_head
, EVENT_START (key
));
9486 /* Look for a binding for this new key. */
9487 new_binding
= follow_key (current_binding
, new_click
);
9489 /* If that click is bound, go for it. */
9490 if (!NILP (new_binding
))
9492 current_binding
= new_binding
;
9496 /* Otherwise, we'll leave key set to the drag event. */
9501 current_binding
= new_binding
;
9504 /* Normally, last_nonmenu_event gets the previous key we read.
9505 But when a mouse popup menu is being used,
9506 we don't update last_nonmenu_event; it continues to hold the mouse
9507 event that preceded the first level of menu. */
9508 if (!used_mouse_menu
)
9509 last_nonmenu_event
= key
;
9511 /* Record what part of this_command_keys is the current key sequence. */
9512 this_single_command_key_start
= this_command_key_count
- t
;
9514 /* Look for this sequence in input-decode-map.
9515 Scan from indec.end until we find a bound suffix. */
9516 while (indec
.end
< t
)
9518 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9522 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9523 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9528 mock_input
= diff
+ max (t
, mock_input
);
9529 goto replay_sequence
;
9533 if (!KEYMAPP (current_binding
)
9534 && !test_undefined (current_binding
)
9535 && indec
.start
>= t
)
9536 /* There is a binding and it's not a prefix.
9537 (and it doesn't have any input-decode-map translation pending).
9538 There is thus no function-key in this sequence.
9539 Moving fkey.start is important in this case to allow keytran.start
9540 to go over the sequence before we return (since we keep the
9541 invariant that keytran.end <= fkey.start). */
9544 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9547 /* If the sequence is unbound, see if we can hang a function key
9548 off the end of it. */
9549 /* Continue scan from fkey.end until we find a bound suffix. */
9550 while (fkey
.end
< indec
.start
)
9552 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9556 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9557 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9558 max (t
, mock_input
),
9559 /* If there's a binding (i.e.
9560 first_binding >= nmaps) we don't want
9561 to apply this function-key-mapping. */
9563 && (test_undefined (current_binding
)),
9568 mock_input
= diff
+ max (t
, mock_input
);
9569 /* Adjust the input-decode-map counters. */
9571 indec
.start
+= diff
;
9573 goto replay_sequence
;
9577 /* Look for this sequence in key-translation-map.
9578 Scan from keytran.end until we find a bound suffix. */
9579 while (keytran
.end
< fkey
.start
)
9581 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9585 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9586 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9591 mock_input
= diff
+ max (t
, mock_input
);
9592 /* Adjust the function-key-map and input-decode-map counters. */
9594 indec
.start
+= diff
;
9598 goto replay_sequence
;
9602 /* If KEY is not defined in any of the keymaps,
9603 and cannot be part of a function key or translation,
9604 and is an upper case letter
9605 use the corresponding lower-case letter instead. */
9606 if (NILP (current_binding
)
9607 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9609 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9610 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9611 || (XINT (key
) & shift_modifier
)))
9613 Lisp_Object new_key
;
9615 original_uppercase
= key
;
9616 original_uppercase_position
= t
- 1;
9618 if (XINT (key
) & shift_modifier
)
9619 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9621 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9622 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9624 /* We have to do this unconditionally, regardless of whether
9625 the lower-case char is defined in the keymaps, because they
9626 might get translated through function-key-map. */
9627 keybuf
[t
- 1] = new_key
;
9628 mock_input
= max (t
, mock_input
);
9629 shift_translated
= 1;
9631 goto replay_sequence
;
9633 /* If KEY is not defined in any of the keymaps,
9634 and cannot be part of a function key or translation,
9635 and is a shifted function key,
9636 use the corresponding unshifted function key instead. */
9637 if (NILP (current_binding
)
9638 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9640 Lisp_Object breakdown
= parse_modifiers (key
);
9642 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9644 if (modifiers
& shift_modifier
9645 /* Treat uppercase keys as shifted. */
9647 && (KEY_TO_CHAR (key
)
9648 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9649 && uppercasep (KEY_TO_CHAR (key
))))
9652 = (modifiers
& shift_modifier
9653 ? apply_modifiers (modifiers
& ~shift_modifier
,
9655 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9657 original_uppercase
= key
;
9658 original_uppercase_position
= t
- 1;
9660 /* We have to do this unconditionally, regardless of whether
9661 the lower-case char is defined in the keymaps, because they
9662 might get translated through function-key-map. */
9663 keybuf
[t
- 1] = new_key
;
9664 mock_input
= max (t
, mock_input
);
9665 /* Reset fkey (and consequently keytran) to apply
9666 function-key-map on the result, so that S-backspace is
9667 correctly mapped to DEL (via backspace). OTOH,
9668 input-decode-map doesn't need to go through it again. */
9669 fkey
.start
= fkey
.end
= 0;
9670 keytran
.start
= keytran
.end
= 0;
9671 shift_translated
= 1;
9673 goto replay_sequence
;
9678 read_key_sequence_cmd
= current_binding
;
9679 read_key_sequence_remapped
9680 /* Remap command through active keymaps.
9681 Do the remapping here, before the unbind_to so it uses the keymaps
9682 of the appropriate buffer. */
9683 = SYMBOLP (read_key_sequence_cmd
)
9684 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9687 unread_switch_frame
= delayed_switch_frame
;
9688 unbind_to (count
, Qnil
);
9690 /* Don't downcase the last character if the caller says don't.
9691 Don't downcase it if the result is undefined, either. */
9692 if ((dont_downcase_last
|| NILP (current_binding
))
9694 && t
- 1 == original_uppercase_position
)
9696 keybuf
[t
- 1] = original_uppercase
;
9697 shift_translated
= 0;
9700 if (shift_translated
)
9701 Vthis_command_keys_shift_translated
= Qt
;
9703 /* Occasionally we fabricate events, perhaps by expanding something
9704 according to function-key-map, or by adding a prefix symbol to a
9705 mouse click in the scroll bar or modeline. In this cases, return
9706 the entire generated key sequence, even if we hit an unbound
9707 prefix or a definition before the end. This means that you will
9708 be able to push back the event properly, and also means that
9709 read-key-sequence will always return a logical unit.
9712 for (; t
< mock_input
; t
++)
9714 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9715 && NILP (Fzerop (Vecho_keystrokes
)))
9716 echo_char (keybuf
[t
]);
9717 add_command_key (keybuf
[t
]);
9725 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9726 Lisp_Object dont_downcase_last
,
9727 Lisp_Object can_return_switch_frame
,
9728 Lisp_Object cmd_loop
, bool allow_string
)
9730 Lisp_Object keybuf
[30];
9732 struct gcpro gcpro1
;
9733 ptrdiff_t count
= SPECPDL_INDEX ();
9736 CHECK_STRING (prompt
);
9739 specbind (Qinput_method_exit_on_first_char
,
9740 (NILP (cmd_loop
) ? Qt
: Qnil
));
9741 specbind (Qinput_method_use_echo_area
,
9742 (NILP (cmd_loop
) ? Qt
: Qnil
));
9744 memset (keybuf
, 0, sizeof keybuf
);
9746 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9748 if (NILP (continue_echo
))
9750 this_command_key_count
= 0;
9751 this_command_key_count_reset
= 0;
9752 this_single_command_key_start
= 0;
9755 #ifdef HAVE_WINDOW_SYSTEM
9756 if (display_hourglass_p
)
9757 cancel_hourglass ();
9760 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9761 prompt
, ! NILP (dont_downcase_last
),
9762 ! NILP (can_return_switch_frame
), 0);
9764 #if 0 /* The following is fine for code reading a key sequence and
9765 then proceeding with a lengthy computation, but it's not good
9766 for code reading keys in a loop, like an input method. */
9767 #ifdef HAVE_WINDOW_SYSTEM
9768 if (display_hourglass_p
)
9779 return unbind_to (count
,
9780 ((allow_string
? make_event_array
: Fvector
)
9784 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9785 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9786 The sequence is sufficient to specify a non-prefix command in the
9787 current local and global maps.
9789 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9790 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9791 as a continuation of the previous key.
9793 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9794 convert the last event to lower case. (Normally any upper case event
9795 is converted to lower case if the original event is undefined and the lower
9796 case equivalent is defined.) A non-nil value is appropriate for reading
9797 a key sequence to be defined.
9799 A C-g typed while in this function is treated like any other character,
9800 and `quit-flag' is not set.
9802 If the key sequence starts with a mouse click, then the sequence is read
9803 using the keymaps of the buffer of the window clicked in, not the buffer
9804 of the selected window as normal.
9806 `read-key-sequence' drops unbound button-down events, since you normally
9807 only care about the click or drag events which follow them. If a drag
9808 or multi-click event is unbound, but the corresponding click event would
9809 be bound, `read-key-sequence' turns the event into a click event at the
9810 drag's starting position. This means that you don't have to distinguish
9811 between click and drag, double, or triple events unless you want to.
9813 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9814 lines separating windows, and scroll bars with imaginary keys
9815 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9817 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9818 function will process a switch-frame event if the user switches frames
9819 before typing anything. If the user switches frames in the middle of a
9820 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9821 is nil, then the event will be put off until after the current key sequence.
9823 `read-key-sequence' checks `function-key-map' for function key
9824 sequences, where they wouldn't conflict with ordinary bindings. See
9825 `function-key-map' for more details.
9827 The optional fifth argument CMD-LOOP, if non-nil, means
9828 that this key sequence is being read by something that will
9829 read commands one after another. It should be nil if the caller
9830 will read just one key sequence. */)
9831 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9833 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9834 can_return_switch_frame
, cmd_loop
, true);
9837 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9838 Sread_key_sequence_vector
, 1, 5, 0,
9839 doc
: /* Like `read-key-sequence' but always return a vector. */)
9840 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9842 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9843 can_return_switch_frame
, cmd_loop
, false);
9846 /* Return true if input events are pending. */
9849 detect_input_pending (void)
9851 return input_pending
|| get_input_pending (0);
9854 /* Return true if input events other than mouse movements are
9858 detect_input_pending_ignore_squeezables (void)
9860 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9863 /* Return true if input events are pending, and run any pending timers. */
9866 detect_input_pending_run_timers (bool do_display
)
9868 unsigned old_timers_run
= timers_run
;
9871 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9873 if (old_timers_run
!= timers_run
&& do_display
)
9874 redisplay_preserve_echo_area (8);
9876 return input_pending
;
9879 /* This is called in some cases before a possible quit.
9880 It cases the next call to detect_input_pending to recompute input_pending.
9881 So calling this function unnecessarily can't do any harm. */
9884 clear_input_pending (void)
9889 /* Return true if there are pending requeued events.
9890 This isn't used yet. The hope is to make wait_reading_process_output
9891 call it, and return if it runs Lisp code that unreads something.
9892 The problem is, kbd_buffer_get_event needs to be fixed to know what
9893 to do in that case. It isn't trivial. */
9896 requeued_events_pending_p (void)
9898 return (!NILP (Vunread_command_events
));
9902 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9903 doc
: /* Return t if command input is currently available with no wait.
9904 Actually, the value is nil only if we can be sure that no input is available;
9905 if there is a doubt, the value is t. */)
9908 if (!NILP (Vunread_command_events
)
9909 || !NILP (Vunread_post_input_method_events
)
9910 || !NILP (Vunread_input_method_events
))
9913 /* Process non-user-visible events (Bug#10195). */
9914 process_special_events ();
9916 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
9917 | READABLE_EVENTS_FILTER_EVENTS
)
9921 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9922 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9925 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9928 if (total_keys
< NUM_RECENT_KEYS
)
9929 return Fvector (total_keys
, keys
);
9932 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9933 vcopy (val
, 0, keys
+ recent_keys_index
,
9934 NUM_RECENT_KEYS
- recent_keys_index
);
9935 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9936 keys
, recent_keys_index
);
9941 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9942 doc
: /* Return the key sequence that invoked this command.
9943 However, if the command has called `read-key-sequence', it returns
9944 the last key sequence that has been read.
9945 The value is a string or a vector.
9947 See also `this-command-keys-vector'. */)
9950 return make_event_array (this_command_key_count
,
9951 XVECTOR (this_command_keys
)->contents
);
9954 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9955 doc
: /* Return the key sequence that invoked this command, as a vector.
9956 However, if the command has called `read-key-sequence', it returns
9957 the last key sequence that has been read.
9959 See also `this-command-keys'. */)
9962 return Fvector (this_command_key_count
,
9963 XVECTOR (this_command_keys
)->contents
);
9966 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9967 Sthis_single_command_keys
, 0, 0, 0,
9968 doc
: /* Return the key sequence that invoked this command.
9969 More generally, it returns the last key sequence read, either by
9970 the command loop or by `read-key-sequence'.
9971 Unlike `this-command-keys', this function's value
9972 does not include prefix arguments.
9973 The value is always a vector. */)
9976 return Fvector (this_command_key_count
9977 - this_single_command_key_start
,
9978 (XVECTOR (this_command_keys
)->contents
9979 + this_single_command_key_start
));
9982 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9983 Sthis_single_command_raw_keys
, 0, 0, 0,
9984 doc
: /* Return the raw events that were read for 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-single-command-keys', this function's value
9988 shows the events before all translations (except for input methods).
9989 The value is always a vector. */)
9992 return Fvector (raw_keybuf_count
,
9993 (XVECTOR (raw_keybuf
)->contents
));
9996 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9997 Sreset_this_command_lengths
, 0, 0, 0,
9998 doc
: /* Make the unread events replace the last command and echo.
9999 Used in `universal-argument-other-key'.
10001 `universal-argument-other-key' rereads the event just typed.
10002 It then gets translated through `function-key-map'.
10003 The translated event has to replace the real events,
10004 both in the value of (this-command-keys) and in echoing.
10005 To achieve this, `universal-argument-other-key' calls
10006 `reset-this-command-lengths', which discards the record of reading
10007 these events the first time. */)
10010 this_command_key_count
= before_command_key_count
;
10011 if (this_command_key_count
< this_single_command_key_start
)
10012 this_single_command_key_start
= this_command_key_count
;
10014 echo_truncate (before_command_echo_length
);
10016 /* Cause whatever we put into unread-command-events
10017 to echo as if it were being freshly read from the keyboard. */
10018 this_command_key_count_reset
= 1;
10023 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10024 Sclear_this_command_keys
, 0, 1, 0,
10025 doc
: /* Clear out the vector that `this-command-keys' returns.
10026 Also clear the record of the last 100 events, unless optional arg
10027 KEEP-RECORD is non-nil. */)
10028 (Lisp_Object keep_record
)
10032 this_command_key_count
= 0;
10033 this_command_key_count_reset
= 0;
10035 if (NILP (keep_record
))
10037 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10038 ASET (recent_keys
, i
, Qnil
);
10040 recent_keys_index
= 0;
10045 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10046 doc
: /* Return the current depth in recursive edits. */)
10050 /* Wrap around reliably on integer overflow. */
10051 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10052 XSETINT (temp
, sum
);
10056 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10057 "FOpen dribble file: ",
10058 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10059 If FILE is nil, close any open dribble file.
10060 The file will be closed when Emacs exits. */)
10072 file
= Fexpand_file_name (file
, Qnil
);
10073 dribble
= emacs_fopen (SSDATA (file
), "w");
10075 report_file_error ("Opening dribble", file
);
10080 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10081 doc
: /* Discard the contents of the terminal input buffer.
10082 Also end any kbd macro being defined. */)
10085 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10087 /* Discard the last command from the macro. */
10088 Fcancel_kbd_macro_events ();
10092 Vunread_command_events
= Qnil
;
10094 discard_tty_input ();
10096 kbd_fetch_ptr
= kbd_store_ptr
;
10102 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10103 doc
: /* Stop Emacs and return to superior process. You can resume later.
10104 If `cannot-suspend' is non-nil, or if the system doesn't support job
10105 control, run a subshell instead.
10107 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10108 to be read as terminal input by Emacs's parent, after suspension.
10110 Before suspending, run the normal hook `suspend-hook'.
10111 After resumption run the normal hook `suspend-resume-hook'.
10113 Some operating systems cannot stop the Emacs process and resume it later.
10114 On such systems, Emacs starts a subshell instead of suspending. */)
10115 (Lisp_Object stuffstring
)
10117 ptrdiff_t count
= SPECPDL_INDEX ();
10118 int old_height
, old_width
;
10120 struct gcpro gcpro1
;
10123 if (tty_list
&& tty_list
->next
)
10124 error ("There are other tty frames open; close them before suspending Emacs");
10126 if (!NILP (stuffstring
))
10127 CHECK_STRING (stuffstring
);
10129 /* Run the functions in suspend-hook. */
10130 hook
= intern ("suspend-hook");
10131 Frun_hooks (1, &hook
);
10133 GCPRO1 (stuffstring
);
10134 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10135 reset_all_sys_modes ();
10136 /* sys_suspend can get an error if it tries to fork a subshell
10137 and the system resources aren't available for that. */
10138 record_unwind_protect_void (init_all_sys_modes
);
10139 stuff_buffered_input (stuffstring
);
10140 if (cannot_suspend
)
10144 unbind_to (count
, Qnil
);
10146 /* Check if terminal/window size has changed.
10147 Note that this is not useful when we are running directly
10148 with a window system; but suspend should be disabled in that case. */
10149 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10150 if (width
!= old_width
|| height
!= old_height
)
10151 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10153 /* Run suspend-resume-hook. */
10154 hook
= intern ("suspend-resume-hook");
10155 Frun_hooks (1, &hook
);
10161 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10162 Then in any case stuff anything Emacs has read ahead and not used. */
10165 stuff_buffered_input (Lisp_Object stuffstring
)
10167 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10168 register unsigned char *p
;
10170 if (STRINGP (stuffstring
))
10172 register ptrdiff_t count
;
10174 p
= SDATA (stuffstring
);
10175 count
= SBYTES (stuffstring
);
10176 while (count
-- > 0)
10181 /* Anything we have read ahead, put back for the shell to read. */
10182 /* ?? What should this do when we have multiple keyboards??
10183 Should we ignore anything that was typed in at the "wrong" kboard?
10185 rms: we should stuff everything back into the kboard
10187 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10190 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10191 kbd_fetch_ptr
= kbd_buffer
;
10192 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10193 stuff_char (kbd_fetch_ptr
->code
);
10195 clear_event (kbd_fetch_ptr
);
10199 #endif /* SIGTSTP */
10203 set_waiting_for_input (struct timespec
*time_to_clear
)
10205 input_available_clear_time
= time_to_clear
;
10207 /* Tell handle_interrupt to throw back to read_char, */
10208 waiting_for_input
= 1;
10210 /* If handle_interrupt was called before and buffered a C-g,
10211 make it run again now, to avoid timing error. */
10212 if (!NILP (Vquit_flag
))
10213 quit_throw_to_read_char (0);
10217 clear_waiting_for_input (void)
10219 /* Tell handle_interrupt not to throw back to read_char, */
10220 waiting_for_input
= 0;
10221 input_available_clear_time
= 0;
10224 /* The SIGINT handler.
10226 If we have a frame on the controlling tty, we assume that the
10227 SIGINT was generated by C-g, so we call handle_interrupt.
10228 Otherwise, tell QUIT to kill Emacs. */
10231 handle_interrupt_signal (int sig
)
10233 /* See if we have an active terminal on our controlling tty. */
10234 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10237 /* If there are no frames there, let's pretend that we are a
10238 well-behaving UN*X program and quit. We must not call Lisp
10239 in a signal handler, so tell QUIT to exit when it is
10241 Vquit_flag
= Qkill_emacs
;
10245 /* Otherwise, the SIGINT was probably generated by C-g. */
10247 /* Set internal_last_event_frame to the top frame of the
10248 controlling tty, if we have a frame there. We disable the
10249 interrupt key on secondary ttys, so the SIGINT must have come
10250 from the controlling tty. */
10251 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10253 handle_interrupt (1);
10258 deliver_interrupt_signal (int sig
)
10260 deliver_process_signal (sig
, handle_interrupt_signal
);
10264 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10265 of the number of times C-g has been requested. If C-g is pressed
10266 enough times, then quit anyway. See bug#6585. */
10267 static int volatile force_quit_count
;
10269 /* This routine is called at interrupt level in response to C-g.
10271 It is called from the SIGINT handler or kbd_buffer_store_event.
10273 If `waiting_for_input' is non zero, then unless `echoing' is
10274 nonzero, immediately throw back to read_char.
10276 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10277 eval to throw, when it gets a chance. If quit-flag is already
10278 non-nil, it stops the job right away. */
10281 handle_interrupt (bool in_signal_handler
)
10287 /* XXX This code needs to be revised for multi-tty support. */
10288 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10290 if (! in_signal_handler
)
10292 /* If SIGINT isn't blocked, don't let us be interrupted by
10293 a SIGINT. It might be harmful due to non-reentrancy
10294 in I/O functions. */
10296 sigemptyset (&blocked
);
10297 sigaddset (&blocked
, SIGINT
);
10298 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10302 reset_all_sys_modes ();
10306 * On systems which can suspend the current process and return to the original
10307 * shell, this command causes the user to end up back at the shell.
10308 * The "Auto-save" and "Abort" questions are not asked until
10309 * the user elects to return to emacs, at which point he can save the current
10310 * job and either dump core or continue.
10314 /* Perhaps should really fork an inferior shell?
10315 But that would not provide any way to get back
10316 to the original shell, ever. */
10317 printf ("No support for stopping a process on this operating system;\n");
10318 printf ("you can continue or abort.\n");
10319 #endif /* not SIGTSTP */
10321 /* We must remain inside the screen area when the internal terminal
10322 is used. Note that [Enter] is not echoed by dos. */
10323 cursor_to (SELECTED_FRAME (), 0, 0);
10325 /* It doesn't work to autosave while GC is in progress;
10326 the code used for auto-saving doesn't cope with the mark bit. */
10327 if (!gc_in_progress
)
10329 printf ("Auto-save? (y or n) ");
10331 if (((c
= getchar ()) & ~040) == 'Y')
10333 Fdo_auto_save (Qt
, Qnil
);
10335 printf ("\r\nAuto-save done");
10336 #else /* not MSDOS */
10337 printf ("Auto-save done\n");
10338 #endif /* not MSDOS */
10340 while (c
!= '\n') c
= getchar ();
10344 /* During GC, it must be safe to reenable quitting again. */
10345 Vinhibit_quit
= Qnil
;
10348 #endif /* not MSDOS */
10349 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10350 printf ("but will instead do a real quit after garbage collection ends\r\n");
10355 printf ("\r\nAbort? (y or n) ");
10356 #else /* not MSDOS */
10357 printf ("Abort (and dump core)? (y or n) ");
10358 #endif /* not MSDOS */
10360 if (((c
= getchar ()) & ~040) == 'Y')
10362 while (c
!= '\n') c
= getchar ();
10364 printf ("\r\nContinuing...\r\n");
10365 #else /* not MSDOS */
10366 printf ("Continuing...\n");
10367 #endif /* not MSDOS */
10369 init_all_sys_modes ();
10373 /* If executing a function that wants to be interrupted out of
10374 and the user has not deferred quitting by binding `inhibit-quit'
10375 then quit right away. */
10376 if (immediate_quit
&& NILP (Vinhibit_quit
))
10378 struct gl_state_s saved
;
10379 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10381 immediate_quit
= 0;
10382 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10384 GCPRO4 (saved
.object
, saved
.global_code
,
10385 saved
.current_syntax_table
, saved
.old_prop
);
10386 Fsignal (Qquit
, Qnil
);
10391 { /* Else request quit when it's safe. */
10392 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10393 force_quit_count
= count
;
10396 immediate_quit
= 1;
10397 Vinhibit_quit
= Qnil
;
10403 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10405 /* TODO: The longjmp in this call throws the NS event loop integration off,
10406 and it seems to do fine without this. Probably some attention
10407 needs to be paid to the setting of waiting_for_input in
10408 wait_reading_process_output() under HAVE_NS because of the call
10409 to ns_select there (needed because otherwise events aren't picked up
10410 outside of polling since we don't get SIGIO like X and we don't have a
10411 separate event loop thread like W32. */
10413 if (waiting_for_input
&& !echoing
)
10414 quit_throw_to_read_char (in_signal_handler
);
10418 /* Handle a C-g by making read_char return C-g. */
10421 quit_throw_to_read_char (bool from_signal
)
10423 /* When not called from a signal handler it is safe to call
10425 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10426 Fkill_emacs (Qnil
);
10428 /* Prevent another signal from doing this before we finish. */
10429 clear_waiting_for_input ();
10432 Vunread_command_events
= Qnil
;
10434 if (FRAMEP (internal_last_event_frame
)
10435 && !EQ (internal_last_event_frame
, selected_frame
))
10436 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10439 sys_longjmp (getcjmp
, 1);
10442 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10443 Sset_input_interrupt_mode
, 1, 1, 0,
10444 doc
: /* Set interrupt mode of reading keyboard input.
10445 If INTERRUPT is non-nil, Emacs will use input interrupts;
10446 otherwise Emacs uses CBREAK mode.
10448 See also `current-input-mode'. */)
10449 (Lisp_Object interrupt
)
10451 bool new_interrupt_input
;
10452 #ifdef USABLE_SIGIO
10453 #ifdef HAVE_X_WINDOWS
10454 if (x_display_list
!= NULL
)
10456 /* When using X, don't give the user a real choice,
10457 because we haven't implemented the mechanisms to support it. */
10458 new_interrupt_input
= 1;
10461 #endif /* HAVE_X_WINDOWS */
10462 new_interrupt_input
= !NILP (interrupt
);
10463 #else /* not USABLE_SIGIO */
10464 new_interrupt_input
= 0;
10465 #endif /* not USABLE_SIGIO */
10467 if (new_interrupt_input
!= interrupt_input
)
10469 #ifdef POLL_FOR_INPUT
10473 /* this causes startup screen to be restored and messes with the mouse */
10474 reset_all_sys_modes ();
10475 interrupt_input
= new_interrupt_input
;
10476 init_all_sys_modes ();
10478 interrupt_input
= new_interrupt_input
;
10481 #ifdef POLL_FOR_INPUT
10482 poll_suppress_count
= 1;
10489 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10490 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10491 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10492 C-q in key sequences.
10494 This setting only has an effect on tty terminals and only when
10495 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10497 See also `current-input-mode'. */)
10498 (Lisp_Object flow
, Lisp_Object terminal
)
10500 struct terminal
*t
= get_terminal (terminal
, 1);
10501 struct tty_display_info
*tty
;
10502 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10504 tty
= t
->display_info
.tty
;
10506 if (tty
->flow_control
!= !NILP (flow
))
10509 /* This causes startup screen to be restored and messes with the mouse. */
10510 reset_sys_modes (tty
);
10513 tty
->flow_control
= !NILP (flow
);
10516 init_sys_modes (tty
);
10522 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10523 doc
: /* Enable or disable 8-bit input on TERMINAL.
10524 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10525 bit as the Meta modifier.
10527 If META is nil, Emacs will ignore the top bit, on the assumption it is
10530 Otherwise, Emacs will accept and pass through 8-bit input without
10531 specially interpreting the top bit.
10533 This setting only has an effect on tty terminal devices.
10535 Optional parameter TERMINAL specifies the tty terminal device to use.
10536 It may be a terminal object, a frame, or nil for the terminal used by
10537 the currently selected frame.
10539 See also `current-input-mode'. */)
10540 (Lisp_Object meta
, Lisp_Object terminal
)
10542 struct terminal
*t
= get_terminal (terminal
, 1);
10543 struct tty_display_info
*tty
;
10546 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10548 tty
= t
->display_info
.tty
;
10552 else if (EQ (meta
, Qt
))
10557 if (tty
->meta_key
!= new_meta
)
10560 /* this causes startup screen to be restored and messes with the mouse */
10561 reset_sys_modes (tty
);
10564 tty
->meta_key
= new_meta
;
10567 init_sys_modes (tty
);
10573 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10574 doc
: /* Specify character used for quitting.
10575 QUIT must be an ASCII character.
10577 This function only has an effect on the controlling tty of the Emacs
10580 See also `current-input-mode'. */)
10583 struct terminal
*t
= get_named_tty ("/dev/tty");
10584 struct tty_display_info
*tty
;
10585 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10587 tty
= t
->display_info
.tty
;
10589 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10590 error ("QUIT must be an ASCII character");
10593 /* this causes startup screen to be restored and messes with the mouse */
10594 reset_sys_modes (tty
);
10597 /* Don't let this value be out of range. */
10598 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10601 init_sys_modes (tty
);
10607 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10608 doc
: /* Set mode of reading keyboard input.
10609 First arg INTERRUPT non-nil means use input interrupts;
10610 nil means use CBREAK mode.
10611 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10612 (no effect except in CBREAK mode).
10613 Third arg META t means accept 8-bit input (for a Meta key).
10614 META nil means ignore the top bit, on the assumption it is parity.
10615 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10616 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10617 See also `current-input-mode'. */)
10618 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10620 Fset_input_interrupt_mode (interrupt
);
10621 Fset_output_flow_control (flow
, Qnil
);
10622 Fset_input_meta_mode (meta
, Qnil
);
10624 Fset_quit_char (quit
);
10628 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10629 doc
: /* Return information about the way Emacs currently reads keyboard input.
10630 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10631 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10632 nil, Emacs is using CBREAK mode.
10633 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10634 terminal; this does not apply if Emacs uses interrupt-driven input.
10635 META is t if accepting 8-bit input with 8th bit as Meta flag.
10636 META nil means ignoring the top bit, on the assumption it is parity.
10637 META is neither t nor nil if accepting 8-bit input and using
10638 all 8 bits as the character code.
10639 QUIT is the character Emacs currently uses to quit.
10640 The elements of this list correspond to the arguments of
10641 `set-input-mode'. */)
10644 Lisp_Object val
[4];
10645 struct frame
*sf
= XFRAME (selected_frame
);
10647 val
[0] = interrupt_input
? Qt
: Qnil
;
10648 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10650 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10651 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10653 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10660 XSETFASTINT (val
[3], quit_char
);
10662 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10665 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10666 doc
: /* Return position information for pixel coordinates X and Y.
10667 By default, X and Y are relative to text area of the selected window.
10668 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10669 If optional fourth arg WHOLE is non-nil, X is relative to the left
10670 edge of the window.
10672 The return value is similar to a mouse click position:
10673 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10674 IMAGE (DX . DY) (WIDTH . HEIGHT))
10675 The `posn-' functions access elements of such lists. */)
10676 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10681 if (NILP (frame_or_window
))
10682 frame_or_window
= selected_window
;
10684 if (WINDOWP (frame_or_window
))
10686 struct window
*w
= decode_live_window (frame_or_window
);
10688 XSETINT (x
, (XINT (x
)
10689 + WINDOW_LEFT_EDGE_X (w
)
10691 ? window_box_left_offset (w
, TEXT_AREA
)
10693 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10694 frame_or_window
= w
->frame
;
10697 CHECK_LIVE_FRAME (frame_or_window
);
10699 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10702 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10703 doc
: /* Return position information for buffer POS in WINDOW.
10704 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10706 Return nil if position is not visible in window. Otherwise,
10707 the return value is similar to that returned by `event-start' for
10708 a mouse click at the upper left corner of the glyph corresponding
10709 to the given buffer position:
10710 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10711 IMAGE (DX . DY) (WIDTH . HEIGHT))
10712 The `posn-' functions access elements of such lists. */)
10713 (Lisp_Object pos
, Lisp_Object window
)
10718 window
= selected_window
;
10720 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10723 Lisp_Object x
= XCAR (tem
);
10724 Lisp_Object y
= XCAR (XCDR (tem
));
10726 /* Point invisible due to hscrolling? */
10729 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10737 * Set up a new kboard object with reasonable initial values.
10740 init_kboard (KBOARD
*kb
)
10742 kset_overriding_terminal_local_map (kb
, Qnil
);
10743 kset_last_command (kb
, Qnil
);
10744 kset_real_last_command (kb
, Qnil
);
10745 kset_keyboard_translate_table (kb
, Qnil
);
10746 kset_last_repeatable_command (kb
, Qnil
);
10747 kset_prefix_arg (kb
, Qnil
);
10748 kset_last_prefix_arg (kb
, Qnil
);
10749 kset_kbd_queue (kb
, Qnil
);
10750 kb
->kbd_queue_has_data
= 0;
10751 kb
->immediate_echo
= 0;
10752 kset_echo_string (kb
, Qnil
);
10753 kb
->echo_after_prompt
= -1;
10754 kb
->kbd_macro_buffer
= 0;
10755 kb
->kbd_macro_bufsize
= 0;
10756 kset_defining_kbd_macro (kb
, Qnil
);
10757 kset_last_kbd_macro (kb
, Qnil
);
10758 kb
->reference_count
= 0;
10759 kset_system_key_alist (kb
, Qnil
);
10760 kset_system_key_syms (kb
, Qnil
);
10761 kset_window_system (kb
, Qt
); /* Unset. */
10762 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10763 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10764 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10765 kset_default_minibuffer_frame (kb
, Qnil
);
10769 * Destroy the contents of a kboard object, but not the object itself.
10770 * We use this just before deleting it, or if we're going to initialize
10771 * it a second time.
10774 wipe_kboard (KBOARD
*kb
)
10776 xfree (kb
->kbd_macro_buffer
);
10779 /* Free KB and memory referenced from it. */
10782 delete_kboard (KBOARD
*kb
)
10786 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10789 *kbp
= kb
->next_kboard
;
10791 /* Prevent a dangling reference to KB. */
10792 if (kb
== current_kboard
10793 && FRAMEP (selected_frame
)
10794 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10796 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10798 if (current_kboard
== kb
)
10807 init_keyboard (void)
10809 /* This is correct before outermost invocation of the editor loop. */
10810 command_loop_level
= -1;
10811 immediate_quit
= 0;
10812 quit_char
= Ctl ('g');
10813 Vunread_command_events
= Qnil
;
10814 timer_idleness_start_time
= invalid_timespec ();
10816 recent_keys_index
= 0;
10817 kbd_fetch_ptr
= kbd_buffer
;
10818 kbd_store_ptr
= kbd_buffer
;
10819 do_mouse_tracking
= Qnil
;
10821 interrupt_input_blocked
= 0;
10822 pending_signals
= 0;
10824 /* This means that command_loop_1 won't try to select anything the first
10826 internal_last_event_frame
= Qnil
;
10827 Vlast_event_frame
= internal_last_event_frame
;
10829 current_kboard
= initial_kboard
;
10830 /* Re-initialize the keyboard again. */
10831 wipe_kboard (current_kboard
);
10832 init_kboard (current_kboard
);
10833 /* A value of nil for Vwindow_system normally means a tty, but we also use
10834 it for the initial terminal since there is no window system there. */
10835 kset_window_system (current_kboard
, Qnil
);
10837 if (!noninteractive
)
10839 /* Before multi-tty support, these handlers used to be installed
10840 only if the current session was a tty session. Now an Emacs
10841 session may have multiple display types, so we always handle
10842 SIGINT. There is special code in handle_interrupt_signal to exit
10843 Emacs on SIGINT when there are no termcap frames on the
10844 controlling terminal. */
10845 struct sigaction action
;
10846 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10847 sigaction (SIGINT
, &action
, 0);
10849 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10850 SIGQUIT and we can't tell which one it will give us. */
10851 sigaction (SIGQUIT
, &action
, 0);
10852 #endif /* not DOS_NT */
10854 #ifdef USABLE_SIGIO
10855 if (!noninteractive
)
10857 struct sigaction action
;
10858 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10859 sigaction (SIGIO
, &action
, 0);
10863 /* Use interrupt input by default, if it works and noninterrupt input
10864 has deficiencies. */
10866 #ifdef INTERRUPT_INPUT
10867 interrupt_input
= 1;
10869 interrupt_input
= 0;
10872 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10875 if (keyboard_init_hook
)
10876 (*keyboard_init_hook
) ();
10878 #ifdef POLL_FOR_INPUT
10880 poll_suppress_count
= 1;
10885 /* This type's only use is in syms_of_keyboard, to initialize the
10886 event header symbols and put properties on them. */
10887 struct event_head
{
10893 static const struct event_head head_table
[] = {
10894 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10895 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10896 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10897 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10898 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10899 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10900 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10901 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10902 /* `select-window' should be handled just like `switch-frame'
10903 in read_key_sequence. */
10904 {&Qselect_window
, "select-window", &Qswitch_frame
}
10908 syms_of_keyboard (void)
10910 pending_funcalls
= Qnil
;
10911 staticpro (&pending_funcalls
);
10913 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10914 staticpro (&Vlispy_mouse_stem
);
10917 DEFSYM (QCimage
, ":image");
10918 DEFSYM (Qhelp_echo
, "help-echo");
10919 DEFSYM (QCrtl
, ":rtl");
10921 staticpro (&item_properties
);
10922 item_properties
= Qnil
;
10924 staticpro (&tool_bar_item_properties
);
10925 tool_bar_item_properties
= Qnil
;
10926 staticpro (&tool_bar_items_vector
);
10927 tool_bar_items_vector
= Qnil
;
10929 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10930 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10931 DEFSYM (Qself_insert_command
, "self-insert-command");
10932 DEFSYM (Qforward_char
, "forward-char");
10933 DEFSYM (Qbackward_char
, "backward-char");
10934 DEFSYM (Qdisabled
, "disabled");
10935 DEFSYM (Qundefined
, "undefined");
10936 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10937 DEFSYM (Qpost_command_hook
, "post-command-hook");
10938 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10939 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10940 DEFSYM (Qfunction_key
, "function-key");
10941 DEFSYM (Qmouse_click
, "mouse-click");
10942 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10943 DEFSYM (Qsave_session
, "save-session");
10944 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10945 DEFSYM (Qmenu_enable
, "menu-enable");
10948 DEFSYM (Qlanguage_change
, "language-change");
10952 DEFSYM (Qdbus_event
, "dbus-event");
10955 #ifdef USE_FILE_NOTIFY
10956 DEFSYM (Qfile_notify
, "file-notify");
10957 #endif /* USE_FILE_NOTIFY */
10959 DEFSYM (QCenable
, ":enable");
10960 DEFSYM (QCvisible
, ":visible");
10961 DEFSYM (QChelp
, ":help");
10962 DEFSYM (QCfilter
, ":filter");
10963 DEFSYM (QCbutton
, ":button");
10964 DEFSYM (QCkeys
, ":keys");
10965 DEFSYM (QCkey_sequence
, ":key-sequence");
10966 DEFSYM (QCtoggle
, ":toggle");
10967 DEFSYM (QCradio
, ":radio");
10968 DEFSYM (QClabel
, ":label");
10969 DEFSYM (QCvert_only
, ":vert-only");
10971 DEFSYM (Qmode_line
, "mode-line");
10972 DEFSYM (Qvertical_line
, "vertical-line");
10973 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
10974 DEFSYM (Qmenu_bar
, "menu-bar");
10976 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
10978 DEFSYM (Qabove_handle
, "above-handle");
10979 DEFSYM (Qhandle
, "handle");
10980 DEFSYM (Qbelow_handle
, "below-handle");
10981 DEFSYM (Qup
, "up");
10982 DEFSYM (Qdown
, "down");
10983 DEFSYM (Qtop
, "top");
10984 DEFSYM (Qbottom
, "bottom");
10985 DEFSYM (Qend_scroll
, "end-scroll");
10986 DEFSYM (Qratio
, "ratio");
10988 DEFSYM (Qevent_kind
, "event-kind");
10989 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
10990 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
10991 DEFSYM (Qmodifier_cache
, "modifier-cache");
10993 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
10994 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
10996 DEFSYM (Qpolling_period
, "polling-period");
10998 DEFSYM (Qx_set_selection
, "x-set-selection");
10999 DEFSYM (QPRIMARY
, "PRIMARY");
11000 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11001 DEFSYM (Qhandle_select_window
, "handle-select-window");
11003 DEFSYM (Qinput_method_function
, "input-method-function");
11004 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11005 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11007 DEFSYM (Qhelp_form_show
, "help-form-show");
11009 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11010 Fset (Qinput_method_use_echo_area
, Qnil
);
11014 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11016 for (i
= 0; i
< len
; i
++)
11018 const struct event_head
*p
= &head_table
[i
];
11019 *p
->var
= intern_c_string (p
->name
);
11020 staticpro (p
->var
);
11021 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11022 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11026 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11027 staticpro (&button_down_location
);
11028 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11029 staticpro (&mouse_syms
);
11030 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11031 / sizeof (lispy_wheel_names
[0])),
11033 staticpro (&wheel_syms
);
11037 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11039 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11040 for (i
= 0; i
< len
; i
++)
11041 if (modifier_names
[i
])
11042 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11043 staticpro (&modifier_symbols
);
11046 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11047 staticpro (&recent_keys
);
11049 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11050 staticpro (&this_command_keys
);
11052 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11053 staticpro (&raw_keybuf
);
11055 DEFSYM (Qcommand_execute
, "command-execute");
11057 accent_key_syms
= Qnil
;
11058 staticpro (&accent_key_syms
);
11060 func_key_syms
= Qnil
;
11061 staticpro (&func_key_syms
);
11063 drag_n_drop_syms
= Qnil
;
11064 staticpro (&drag_n_drop_syms
);
11066 unread_switch_frame
= Qnil
;
11067 staticpro (&unread_switch_frame
);
11069 internal_last_event_frame
= Qnil
;
11070 staticpro (&internal_last_event_frame
);
11072 read_key_sequence_cmd
= Qnil
;
11073 staticpro (&read_key_sequence_cmd
);
11074 read_key_sequence_remapped
= Qnil
;
11075 staticpro (&read_key_sequence_remapped
);
11077 menu_bar_one_keymap_changed_items
= Qnil
;
11078 staticpro (&menu_bar_one_keymap_changed_items
);
11080 menu_bar_items_vector
= Qnil
;
11081 staticpro (&menu_bar_items_vector
);
11083 help_form_saved_window_configs
= Qnil
;
11084 staticpro (&help_form_saved_window_configs
);
11086 defsubr (&Scurrent_idle_time
);
11087 defsubr (&Sevent_symbol_parse_modifiers
);
11088 defsubr (&Sevent_convert_list
);
11089 defsubr (&Sread_key_sequence
);
11090 defsubr (&Sread_key_sequence_vector
);
11091 defsubr (&Srecursive_edit
);
11092 defsubr (&Strack_mouse
);
11093 defsubr (&Sinput_pending_p
);
11094 defsubr (&Srecent_keys
);
11095 defsubr (&Sthis_command_keys
);
11096 defsubr (&Sthis_command_keys_vector
);
11097 defsubr (&Sthis_single_command_keys
);
11098 defsubr (&Sthis_single_command_raw_keys
);
11099 defsubr (&Sreset_this_command_lengths
);
11100 defsubr (&Sclear_this_command_keys
);
11101 defsubr (&Ssuspend_emacs
);
11102 defsubr (&Sabort_recursive_edit
);
11103 defsubr (&Sexit_recursive_edit
);
11104 defsubr (&Srecursion_depth
);
11105 defsubr (&Stop_level
);
11106 defsubr (&Sdiscard_input
);
11107 defsubr (&Sopen_dribble_file
);
11108 defsubr (&Sset_input_interrupt_mode
);
11109 defsubr (&Sset_output_flow_control
);
11110 defsubr (&Sset_input_meta_mode
);
11111 defsubr (&Sset_quit_char
);
11112 defsubr (&Sset_input_mode
);
11113 defsubr (&Scurrent_input_mode
);
11114 defsubr (&Sposn_at_point
);
11115 defsubr (&Sposn_at_x_y
);
11117 DEFVAR_LISP ("last-command-event", last_command_event
,
11118 doc
: /* Last input event that was part of a command. */);
11120 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11121 doc
: /* Last input event in a command, except for mouse menu events.
11122 Mouse menus give back keys that don't look like mouse events;
11123 this variable holds the actual mouse event that led to the menu,
11124 so that you can determine whether the command was run by mouse or not. */);
11126 DEFVAR_LISP ("last-input-event", last_input_event
,
11127 doc
: /* Last input event. */);
11129 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11130 doc
: /* List of events to be read as the command input.
11131 These events are processed first, before actual keyboard input.
11132 Events read from this list are not normally added to `this-command-keys',
11133 as they will already have been added once as they were read for the first time.
11134 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11135 Vunread_command_events
= Qnil
;
11137 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11138 doc
: /* List of events to be processed as input by input methods.
11139 These events are processed before `unread-command-events'
11140 and actual keyboard input, but are not given to `input-method-function'. */);
11141 Vunread_post_input_method_events
= Qnil
;
11143 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11144 doc
: /* List of events to be processed as input by input methods.
11145 These events are processed after `unread-command-events', but
11146 before actual keyboard input.
11147 If there's an active input method, the events are given to
11148 `input-method-function'. */);
11149 Vunread_input_method_events
= Qnil
;
11151 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11152 doc
: /* Meta-prefix character code.
11153 Meta-foo as command input turns into this character followed by foo. */);
11154 XSETINT (meta_prefix_char
, 033);
11156 DEFVAR_KBOARD ("last-command", Vlast_command
,
11157 doc
: /* The last command executed.
11158 Normally a symbol with a function definition, but can be whatever was found
11159 in the keymap, or whatever the variable `this-command' was set to by that
11162 The value `mode-exit' is special; it means that the previous command
11163 read an event that told it to exit, and it did so and unread that event.
11164 In other words, the present command is the event that made the previous
11167 The value `kill-region' is special; it means that the previous command
11168 was a kill command.
11170 `last-command' has a separate binding for each terminal device.
11171 See Info node `(elisp)Multiple Terminals'. */);
11173 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11174 doc
: /* Same as `last-command', but never altered by Lisp code.
11175 Taken from the previous value of `real-this-command'. */);
11177 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11178 doc
: /* Last command that may be repeated.
11179 The last command executed that was not bound to an input event.
11180 This is the command `repeat' will try to repeat.
11181 Taken from a previous value of `real-this-command'. */);
11183 DEFVAR_LISP ("this-command", Vthis_command
,
11184 doc
: /* The command now being executed.
11185 The command can set this variable; whatever is put here
11186 will be in `last-command' during the following command. */);
11187 Vthis_command
= Qnil
;
11189 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11190 doc
: /* This is like `this-command', except that commands should never modify it. */);
11191 Vreal_this_command
= Qnil
;
11193 DEFVAR_LISP ("this-command-keys-shift-translated",
11194 Vthis_command_keys_shift_translated
,
11195 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11196 Shift-translation occurs when there is no binding for the key sequence
11197 as entered, but a binding was found by changing an upper-case letter
11198 to lower-case, or a shifted function key to an unshifted one. */);
11199 Vthis_command_keys_shift_translated
= Qnil
;
11201 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11202 doc
: /* The command bound to the current key sequence before remapping.
11203 It equals `this-command' if the original command was not remapped through
11204 any of the active keymaps. Otherwise, the value of `this-command' is the
11205 result of looking up the original command in the active keymaps. */);
11206 Vthis_original_command
= Qnil
;
11208 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11209 doc
: /* Number of input events between auto-saves.
11210 Zero means disable autosaving due to number of characters typed. */);
11211 auto_save_interval
= 300;
11213 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11214 doc
: /* Number of seconds idle time before auto-save.
11215 Zero or nil means disable auto-saving due to idleness.
11216 After auto-saving due to this many seconds of idle time,
11217 Emacs also does a garbage collection if that seems to be warranted. */);
11218 XSETFASTINT (Vauto_save_timeout
, 30);
11220 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11221 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11222 The value may be integer or floating point.
11223 If the value is zero, don't echo at all. */);
11224 Vecho_keystrokes
= make_number (1);
11226 DEFVAR_INT ("polling-period", polling_period
,
11227 doc
: /* Interval between polling for input during Lisp execution.
11228 The reason for polling is to make C-g work to stop a running program.
11229 Polling is needed only when using X windows and SIGIO does not work.
11230 Polling is automatically disabled in all other cases. */);
11231 polling_period
= 2;
11233 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11234 doc
: /* Maximum time between mouse clicks to make a double-click.
11235 Measured in milliseconds. The value nil means disable double-click
11236 recognition; t means double-clicks have no time limit and are detected
11237 by position only. */);
11238 Vdouble_click_time
= make_number (500);
11240 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11241 doc
: /* Maximum mouse movement between clicks to make a double-click.
11242 On window-system frames, value is the number of pixels the mouse may have
11243 moved horizontally or vertically between two clicks to make a double-click.
11244 On non window-system frames, value is interpreted in units of 1/8 characters
11247 This variable is also the threshold for motion of the mouse
11248 to count as a drag. */);
11249 double_click_fuzz
= 3;
11251 DEFVAR_INT ("num-input-keys", num_input_keys
,
11252 doc
: /* Number of complete key sequences read as input so far.
11253 This includes key sequences read from keyboard macros.
11254 The number is effectively the number of interactive command invocations. */);
11255 num_input_keys
= 0;
11257 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11258 doc
: /* Number of input events read from the keyboard so far.
11259 This does not include events generated by keyboard macros. */);
11260 num_nonmacro_input_events
= 0;
11262 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11263 doc
: /* The frame in which the most recently read event occurred.
11264 If the last event came from a keyboard macro, this is set to `macro'. */);
11265 Vlast_event_frame
= Qnil
;
11267 /* This variable is set up in sysdep.c. */
11268 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11269 doc
: /* The ERASE character as set by the user with stty. */);
11271 DEFVAR_LISP ("help-char", Vhelp_char
,
11272 doc
: /* Character to recognize as meaning Help.
11273 When it is read, do `(eval help-form)', and display result if it's a string.
11274 If the value of `help-form' is nil, this char can be read normally. */);
11275 XSETINT (Vhelp_char
, Ctl ('H'));
11277 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11278 doc
: /* List of input events to recognize as meaning Help.
11279 These work just like the value of `help-char' (see that). */);
11280 Vhelp_event_list
= Qnil
;
11282 DEFVAR_LISP ("help-form", Vhelp_form
,
11283 doc
: /* Form to execute when character `help-char' is read.
11284 If the form returns a string, that string is displayed.
11285 If `help-form' is nil, the help char is not recognized. */);
11288 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11289 doc
: /* Command to run when `help-char' character follows a prefix key.
11290 This command is used only when there is no actual binding
11291 for that character after that prefix key. */);
11292 Vprefix_help_command
= Qnil
;
11294 DEFVAR_LISP ("top-level", Vtop_level
,
11295 doc
: /* Form to evaluate when Emacs starts up.
11296 Useful to set before you dump a modified Emacs. */);
11299 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11300 doc
: /* Translate table for local keyboard input, or nil.
11301 If non-nil, the value should be a char-table. Each character read
11302 from the keyboard is looked up in this char-table. If the value found
11303 there is non-nil, then it is used instead of the actual input character.
11305 The value can also be a string or vector, but this is considered obsolete.
11306 If it is a string or vector of length N, character codes N and up are left
11307 untranslated. In a vector, an element which is nil means "no translation".
11309 This is applied to the characters supplied to input methods, not their
11310 output. See also `translation-table-for-input'.
11312 This variable has a separate binding for each terminal.
11313 See Info node `(elisp)Multiple Terminals'. */);
11315 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11316 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11317 \(Even if the operating system has support for stopping a process.\) */);
11318 cannot_suspend
= 0;
11320 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11321 doc
: /* Non-nil means prompt with menus when appropriate.
11322 This is done when reading from a keymap that has a prompt string,
11323 for elements that have prompt strings.
11324 The menu is displayed on the screen
11325 if X menus were enabled at configuration
11326 time and the previous event was a mouse click prefix key.
11327 Otherwise, menu prompting uses the echo area. */);
11328 menu_prompting
= 1;
11330 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11331 doc
: /* Character to see next line of menu prompt.
11332 Type this character while in a menu prompt to rotate around the lines of it. */);
11333 XSETINT (menu_prompt_more_char
, ' ');
11335 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11336 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11337 Emacs applies the modifiers of the character stored here to each keyboard
11338 character it reads. For example, after evaluating the expression
11339 (setq extra-keyboard-modifiers ?\\C-x)
11340 all input characters will have the control modifier applied to them.
11342 Note that the character ?\\C-@, equivalent to the integer zero, does
11343 not count as a control character; rather, it counts as a character
11344 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11345 cancels any modification. */);
11346 extra_keyboard_modifiers
= 0;
11348 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11349 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11350 The command loop sets this to nil before each command,
11351 and tests the value when the command returns.
11352 Buffer modification stores t in this variable. */);
11353 Vdeactivate_mark
= Qnil
;
11354 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11356 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11357 doc
: /* Normal hook run before each command is executed.
11358 If an unhandled error happens in running this hook,
11359 the function in which the error occurred is unconditionally removed, since
11360 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11361 Vpre_command_hook
= Qnil
;
11363 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11364 doc
: /* Normal hook run after each command is executed.
11365 If an unhandled error happens in running this hook,
11366 the function in which the error occurred is unconditionally removed, since
11367 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11368 Vpost_command_hook
= Qnil
;
11371 DEFVAR_LISP ("echo-area-clear-hook", ...,
11372 doc
: /* Normal hook run when clearing the echo area. */);
11374 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11375 Fset (Qecho_area_clear_hook
, Qnil
);
11377 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11378 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11379 Vlucid_menu_bar_dirty_flag
= Qnil
;
11381 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11382 doc
: /* List of menu bar items to move to the end of the menu bar.
11383 The elements of the list are event types that may have menu bar bindings. */);
11384 Vmenu_bar_final_items
= Qnil
;
11386 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11387 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11388 This is used internally by graphical displays that do not render
11389 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11390 Vtool_bar_separator_image_expression
= Qnil
;
11392 DEFVAR_KBOARD ("overriding-terminal-local-map",
11393 Voverriding_terminal_local_map
,
11394 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11396 This variable is intended to let commands such as `universal-argument'
11397 set up a different keymap for reading the next command.
11399 `overriding-terminal-local-map' has a separate binding for each
11401 See Info node `(elisp)Multiple Terminals'. */);
11403 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11404 doc
: /* Keymap that overrides almost all other local keymaps.
11405 If this variable is non-nil, it is used as a keymap--replacing the
11406 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11407 Voverriding_local_map
= Qnil
;
11409 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11410 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11411 Otherwise, the menu bar continues to reflect the buffer's local map
11412 and the minor mode maps regardless of `overriding-local-map'. */);
11413 Voverriding_local_map_menu_flag
= Qnil
;
11415 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11416 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11417 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11419 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11420 doc
: /* Non-nil means generate motion events for mouse motion. */);
11422 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11423 doc
: /* Alist of system-specific X windows key symbols.
11424 Each element should have the form (N . SYMBOL) where N is the
11425 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11426 and SYMBOL is its name.
11428 `system-key-alist' has a separate binding for each terminal device.
11429 See Info node `(elisp)Multiple Terminals'. */);
11431 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11432 doc
: /* Keymap that translates key sequences to key sequences during input.
11433 This is used mainly for mapping key sequences into some preferred
11434 key events (symbols).
11436 The `read-key-sequence' function replaces any subsequence bound by
11437 `local-function-key-map' with its binding. More precisely, when the
11438 active keymaps have no binding for the current key sequence but
11439 `local-function-key-map' binds a suffix of the sequence to a vector or
11440 string, `read-key-sequence' replaces the matching suffix with its
11441 binding, and continues with the new sequence.
11443 If the binding is a function, it is called with one argument (the prompt)
11444 and its return value (a key sequence) is used.
11446 The events that come from bindings in `local-function-key-map' are not
11447 themselves looked up in `local-function-key-map'.
11449 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11450 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11451 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11452 typing `ESC O P x' would return [f1 x].
11454 `local-function-key-map' has a separate binding for each terminal
11455 device. See Info node `(elisp)Multiple Terminals'. If you need to
11456 define a binding on all terminals, change `function-key-map'
11457 instead. Initially, `local-function-key-map' is an empty keymap that
11458 has `function-key-map' as its parent on all terminal devices. */);
11460 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11461 doc
: /* Keymap that decodes input escape sequences.
11462 This is used mainly for mapping ASCII function key sequences into
11463 real Emacs function key events (symbols).
11465 The `read-key-sequence' function replaces any subsequence bound by
11466 `input-decode-map' with its binding. Contrary to `function-key-map',
11467 this map applies its rebinding regardless of the presence of an ordinary
11468 binding. So it is more like `key-translation-map' except that it applies
11469 before `function-key-map' rather than after.
11471 If the binding is a function, it is called with one argument (the prompt)
11472 and its return value (a key sequence) is used.
11474 The events that come from bindings in `input-decode-map' are not
11475 themselves looked up in `input-decode-map'. */);
11477 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11478 doc
: /* The parent keymap of all `local-function-key-map' instances.
11479 Function key definitions that apply to all terminal devices should go
11480 here. If a mapping is defined in both the current
11481 `local-function-key-map' binding and this variable, then the local
11482 definition will take precedence. */);
11483 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11485 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11486 doc
: /* Keymap of key translations that can override keymaps.
11487 This keymap works like `input-decode-map', but comes after `function-key-map'.
11488 Another difference is that it is global rather than terminal-local. */);
11489 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11491 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11492 doc
: /* List of deferred actions to be performed at a later time.
11493 The precise format isn't relevant here; we just check whether it is nil. */);
11494 Vdeferred_action_list
= Qnil
;
11496 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11497 doc
: /* Function to call to handle deferred actions, after each command.
11498 This function is called with no arguments after each command
11499 whenever `deferred-action-list' is non-nil. */);
11500 Vdeferred_action_function
= Qnil
;
11502 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11503 doc
: /* List of warnings to be displayed after this command.
11504 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11505 as per the args of `display-warning' (which see).
11506 If this variable is non-nil, `delayed-warnings-hook' will be run
11507 immediately after running `post-command-hook'. */);
11508 Vdelayed_warnings_list
= Qnil
;
11510 DEFVAR_LISP ("timer-list", Vtimer_list
,
11511 doc
: /* List of active absolute time timers in order of increasing time. */);
11512 Vtimer_list
= Qnil
;
11514 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11515 doc
: /* List of active idle-time timers in order of increasing time. */);
11516 Vtimer_idle_list
= Qnil
;
11518 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11519 doc
: /* If non-nil, the function that implements the current input method.
11520 It's called with one argument, a printing character that was just read.
11521 \(That means a character with code 040...0176.)
11522 Typically this function uses `read-event' to read additional events.
11523 When it does so, it should first bind `input-method-function' to nil
11524 so it will not be called recursively.
11526 The function should return a list of zero or more events
11527 to be used as input. If it wants to put back some events
11528 to be reconsidered, separately, by the input method,
11529 it can add them to the beginning of `unread-command-events'.
11531 The input method function can find in `input-method-previous-message'
11532 the previous echo area message.
11534 The input method function should refer to the variables
11535 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11536 for guidance on what to do. */);
11537 Vinput_method_function
= Qnil
;
11539 DEFVAR_LISP ("input-method-previous-message",
11540 Vinput_method_previous_message
,
11541 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11542 This variable exists because `read-event' clears the echo area
11543 before running the input method. It is nil if there was no message. */);
11544 Vinput_method_previous_message
= Qnil
;
11546 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11547 doc
: /* If non-nil, the function that implements the display of help.
11548 It's called with one argument, the help string to display. */);
11549 Vshow_help_function
= Qnil
;
11551 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11552 doc
: /* If non-nil, suppress point adjustment after executing a command.
11554 After a command is executed, if point is moved into a region that has
11555 special properties (e.g. composition, display), we adjust point to
11556 the boundary of the region. But, when a command sets this variable to
11557 non-nil, we suppress the point adjustment.
11559 This variable is set to nil before reading a command, and is checked
11560 just after executing the command. */);
11561 Vdisable_point_adjustment
= Qnil
;
11563 DEFVAR_LISP ("global-disable-point-adjustment",
11564 Vglobal_disable_point_adjustment
,
11565 doc
: /* If non-nil, always suppress point adjustment.
11567 The default value is nil, in which case, point adjustment are
11568 suppressed only after special commands that set
11569 `disable-point-adjustment' (which see) to non-nil. */);
11570 Vglobal_disable_point_adjustment
= Qnil
;
11572 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11573 doc
: /* How long to display an echo-area message when the minibuffer is active.
11574 If the value is not a number, such messages don't time out. */);
11575 Vminibuffer_message_timeout
= make_number (2);
11577 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11578 doc
: /* If non-nil, any keyboard input throws to this symbol.
11579 The value of that variable is passed to `quit-flag' and later causes a
11580 peculiar kind of quitting. */);
11581 Vthrow_on_input
= Qnil
;
11583 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11584 doc
: /* If non-nil, function to output error messages.
11585 The arguments are the error data, a list of the form
11586 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11587 such as just as `condition-case' would bind its variable to,
11588 the context (a string which normally goes at the start of the message),
11589 and the Lisp function within which the error was signaled. */);
11590 Vcommand_error_function
= Qnil
;
11592 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11593 Venable_disabled_menus_and_buttons
,
11594 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11596 Help functions bind this to allow help on disabled menu items
11597 and tool-bar buttons. */);
11598 Venable_disabled_menus_and_buttons
= Qnil
;
11600 DEFVAR_LISP ("select-active-regions",
11601 Vselect_active_regions
,
11602 doc
: /* If non-nil, an active region automatically sets the primary selection.
11603 If the value is `only', only temporarily active regions (usually made
11604 by mouse-dragging or shift-selection) set the window selection.
11606 This takes effect only when Transient Mark mode is enabled. */);
11607 Vselect_active_regions
= Qt
;
11609 DEFVAR_LISP ("saved-region-selection",
11610 Vsaved_region_selection
,
11611 doc
: /* Contents of active region prior to buffer modification.
11612 If `select-active-regions' is non-nil, Emacs sets this to the
11613 text in the region before modifying the buffer. The next call to
11614 the function `deactivate-mark' uses this to set the window selection. */);
11615 Vsaved_region_selection
= Qnil
;
11617 DEFVAR_LISP ("selection-inhibit-update-commands",
11618 Vselection_inhibit_update_commands
,
11619 doc
: /* List of commands which should not update the selection.
11620 Normally, if `select-active-regions' is non-nil and the mark remains
11621 active after a command (i.e. the mark was not deactivated), the Emacs
11622 command loop sets the selection to the text in the region. However,
11623 if the command is in this list, the selection is not updated. */);
11624 Vselection_inhibit_update_commands
11625 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11627 DEFVAR_LISP ("debug-on-event",
11629 doc
: /* Enter debugger on this event. When Emacs
11630 receives the special event specified by this variable, it will try to
11631 break into the debugger as soon as possible instead of processing the
11632 event normally through `special-event-map'.
11634 Currently, the only supported values for this
11635 variable are `sigusr1' and `sigusr2'. */);
11636 Vdebug_on_event
= intern_c_string ("sigusr2");
11638 /* Create the initial keyboard. */
11639 initial_kboard
= xmalloc (sizeof *initial_kboard
);
11640 init_kboard (initial_kboard
);
11641 /* Vwindow_system is left at t for now. */
11642 initial_kboard
->next_kboard
= all_kboards
;
11643 all_kboards
= initial_kboard
;
11647 keys_of_keyboard (void)
11649 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11650 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11651 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11652 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11653 initial_define_key (meta_map
, 'x', "execute-extended-command");
11655 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11656 "handle-delete-frame");
11657 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11658 "ns-put-working-text");
11659 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11660 "ns-unput-working-text");
11661 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11662 current-prefix-arg, as is done in `handle-switch-frame'.
11663 But `handle-switch-frame is not run from the special-map.
11664 Commands from that map are run in a special way that automatically
11665 preserves the prefix-arg. Restoring the prefix arg here is not just
11666 redundant but harmful:
11668 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11669 - after the first prompt, the exit-minibuffer-hook is run which may
11670 iconify a frame and thus push a `iconify-frame' event.
11671 - after running exit-minibuffer-hook, current-prefix-arg is
11672 restored to the non-nil value it had before the prompt.
11673 - we enter the second prompt.
11674 current-prefix-arg is non-nil, prefix-arg is nil.
11675 - before running the first real event, we run the special iconify-frame
11676 event, but we pass the `special' arg to execute-command so
11677 current-prefix-arg and prefix-arg are left untouched.
11678 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11679 - the next key event will have a spuriously non-nil current-prefix-arg. */
11680 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11682 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11684 /* Handling it at such a low-level causes read_key_sequence to get
11685 * confused because it doesn't realize that the current_buffer was
11686 * changed by read_char.
11688 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11689 * "handle-select-window"); */
11690 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11691 "handle-save-session");
11694 /* Define a special event which is raised for dbus callback
11696 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11697 "dbus-handle-event");
11700 #ifdef USE_FILE_NOTIFY
11701 /* Define a special event which is raised for notification callback
11703 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11704 "file-notify-handle-event");
11705 #endif /* USE_FILE_NOTIFY */
11707 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11709 #if defined (WINDOWSNT)
11710 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11713 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11714 "handle-focus-in");
11715 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11716 "handle-focus-out");
11719 /* Mark the pointers in the kboard objects.
11720 Called by Fgarbage_collect. */
11722 mark_kboards (void)
11726 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11728 if (kb
->kbd_macro_buffer
)
11729 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11731 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11732 mark_object (KVAR (kb
, Vlast_command
));
11733 mark_object (KVAR (kb
, Vreal_last_command
));
11734 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11735 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11736 mark_object (KVAR (kb
, Vprefix_arg
));
11737 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11738 mark_object (KVAR (kb
, kbd_queue
));
11739 mark_object (KVAR (kb
, defining_kbd_macro
));
11740 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11741 mark_object (KVAR (kb
, Vsystem_key_alist
));
11742 mark_object (KVAR (kb
, system_key_syms
));
11743 mark_object (KVAR (kb
, Vwindow_system
));
11744 mark_object (KVAR (kb
, Vinput_decode_map
));
11745 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11746 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11747 mark_object (KVAR (kb
, echo_string
));
11750 struct input_event
*event
;
11751 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11753 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11754 event
= kbd_buffer
;
11755 /* These two special event types has no Lisp_Objects to mark. */
11756 if (event
->kind
!= SELECTION_REQUEST_EVENT
11757 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11759 mark_object (event
->x
);
11760 mark_object (event
->y
);
11761 mark_object (event
->frame_or_window
);
11762 mark_object (event
->arg
);