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 buffer that was current when the last command was started. */
214 static Lisp_Object last_point_position_buffer
;
216 /* The window that was selected when the last command was started. */
217 static Lisp_Object last_point_position_window
;
219 /* The frame in which the last input event occurred, or Qmacro if the
220 last event came from a macro. We use this to determine when to
221 generate switch-frame events. This may be cleared by functions
222 like Fselect_frame, to make sure that a switch-frame event is
223 generated by the next character.
225 FIXME: This is modified by a signal handler so it should be volatile.
226 It's exported to Lisp, though, so it can't simply be marked
228 Lisp_Object internal_last_event_frame
;
230 /* The timestamp of the last input event we received from the X server.
231 X Windows wants this for selection ownership. */
232 Time last_event_timestamp
;
234 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
235 static Lisp_Object Qhandle_select_window
;
236 Lisp_Object QPRIMARY
;
238 static Lisp_Object Qself_insert_command
;
239 static Lisp_Object Qforward_char
;
240 static Lisp_Object Qbackward_char
;
241 Lisp_Object Qundefined
;
242 static Lisp_Object Qtimer_event_handler
;
244 /* read_key_sequence stores here the command definition of the
245 key sequence that it reads. */
246 static Lisp_Object read_key_sequence_cmd
;
247 static Lisp_Object read_key_sequence_remapped
;
249 static Lisp_Object Qinput_method_function
;
251 static Lisp_Object Qdeactivate_mark
;
253 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
255 static Lisp_Object Qecho_area_clear_hook
;
257 /* Hooks to run before and after each command. */
258 static Lisp_Object Qpre_command_hook
;
259 static Lisp_Object Qpost_command_hook
;
261 static Lisp_Object Qdeferred_action_function
;
263 static Lisp_Object Qdelayed_warnings_hook
;
265 static Lisp_Object Qinput_method_exit_on_first_char
;
266 static Lisp_Object Qinput_method_use_echo_area
;
268 static Lisp_Object Qhelp_form_show
;
270 /* File in which we write all commands we read. */
271 static FILE *dribble
;
273 /* Nonzero if input is available. */
276 /* Circular buffer for pre-read keyboard input. */
278 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
280 /* Pointer to next available character in kbd_buffer.
281 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
282 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
283 next available char is in kbd_buffer[0]. */
284 static struct input_event
*kbd_fetch_ptr
;
286 /* Pointer to next place to store character in kbd_buffer. This
287 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
288 character should go in kbd_buffer[0]. */
289 static struct input_event
* volatile kbd_store_ptr
;
291 /* The above pair of variables forms a "queue empty" flag. When we
292 enqueue a non-hook event, we increment kbd_store_ptr. When we
293 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
294 there is input available if the two pointers are not equal.
296 Why not just have a flag set and cleared by the enqueuing and
297 dequeuing functions? Such a flag could be screwed up by interrupts
298 at inopportune times. */
300 /* Symbols to head events. */
301 static Lisp_Object Qmouse_movement
;
302 static Lisp_Object Qscroll_bar_movement
;
303 Lisp_Object Qswitch_frame
;
304 static Lisp_Object Qdelete_frame
;
305 static Lisp_Object Qiconify_frame
;
306 static Lisp_Object Qmake_frame_visible
;
307 static Lisp_Object Qselect_window
;
308 Lisp_Object Qhelp_echo
;
310 static Lisp_Object Qmouse_fixup_help_message
;
312 /* Symbols to denote kinds of events. */
313 static Lisp_Object Qfunction_key
;
314 Lisp_Object Qmouse_click
;
316 Lisp_Object Qlanguage_change
;
318 Lisp_Object Qfile_w32notify
;
321 static Lisp_Object Qdrag_n_drop
;
322 static Lisp_Object Qsave_session
;
324 static Lisp_Object Qdbus_event
;
327 static Lisp_Object Qfile_inotify
;
328 #endif /* HAVE_INOTIFY */
329 static Lisp_Object Qconfig_changed_event
;
331 /* Lisp_Object Qmouse_movement; - also an event header */
333 /* Properties of event headers. */
334 Lisp_Object Qevent_kind
;
335 static Lisp_Object Qevent_symbol_elements
;
337 /* Menu and tool bar item parts. */
338 static Lisp_Object Qmenu_enable
;
339 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
340 Lisp_Object QCfilter
;
342 /* Non-nil disable property on a command means
343 do not execute it; call disabled-command-function's value instead. */
344 Lisp_Object QCtoggle
, QCradio
;
345 static Lisp_Object QCbutton
, QClabel
;
347 static Lisp_Object QCvert_only
;
349 /* An event header symbol HEAD may have a property named
350 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
351 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
352 mask of modifiers applied to it. If present, this is used to help
353 speed up parse_modifiers. */
354 Lisp_Object Qevent_symbol_element_mask
;
356 /* An unmodified event header BASE may have a property named
357 Qmodifier_cache, which is an alist mapping modifier masks onto
358 modified versions of BASE. If present, this helps speed up
360 static Lisp_Object Qmodifier_cache
;
362 /* Symbols to use for parts of windows. */
363 Lisp_Object Qmode_line
;
364 Lisp_Object Qvertical_line
;
365 static Lisp_Object Qvertical_scroll_bar
;
366 Lisp_Object Qmenu_bar
;
368 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
369 static Lisp_Object
command_loop (void);
370 static Lisp_Object Qcommand_execute
;
371 EMACS_TIME
timer_check (void);
373 static void echo_now (void);
374 static ptrdiff_t echo_length (void);
376 static Lisp_Object Qpolling_period
;
378 /* Incremented whenever a timer is run. */
381 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
383 EMACS_TIME
*input_available_clear_time
;
385 /* True means use SIGIO interrupts; false means use CBREAK mode.
386 Default is true if INTERRUPT_INPUT is defined. */
387 bool interrupt_input
;
389 /* Nonzero while interrupts are temporarily deferred during redisplay. */
390 bool interrupts_deferred
;
392 /* If we support a window system, turn on the code to poll periodically
393 to detect C-g. It isn't actually used when doing interrupt input. */
394 #ifdef HAVE_WINDOW_SYSTEM
395 #define POLL_FOR_INPUT
398 /* The time when Emacs started being idle. */
400 static EMACS_TIME timer_idleness_start_time
;
402 /* After Emacs stops being idle, this saves the last value
403 of timer_idleness_start_time from when it was idle. */
405 static EMACS_TIME timer_last_idleness_start_time
;
408 /* Global variable declarations. */
410 /* Flags for readable_events. */
411 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
412 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
413 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
415 /* Function for init_keyboard to call with no args (if nonzero). */
416 static void (*keyboard_init_hook
) (void);
418 static bool get_input_pending (int);
419 static bool readable_events (int);
420 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
421 Lisp_Object
, bool *);
422 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
423 static Lisp_Object
make_lispy_event (struct input_event
*);
424 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
425 enum scroll_bar_part
,
426 Lisp_Object
, Lisp_Object
,
428 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
429 Lisp_Object
, const char *const *,
430 Lisp_Object
*, ptrdiff_t);
431 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
432 static bool help_char_p (Lisp_Object
);
433 static void save_getcjmp (sys_jmp_buf
);
434 static void restore_getcjmp (sys_jmp_buf
);
435 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
436 static void clear_event (struct input_event
*);
437 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
439 static void deliver_input_available_signal (int signo
);
441 static void handle_interrupt (bool);
442 static _Noreturn
void quit_throw_to_read_char (bool);
443 static void process_special_events (void);
444 static void timer_start_idle (void);
445 static void timer_stop_idle (void);
446 static void timer_resume_idle (void);
447 static void deliver_user_signal (int);
448 static char *find_user_signal_name (int);
449 static void store_user_signal_events (void);
451 /* These setters are used only in this file, so they can be private. */
453 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
455 kb
->INTERNAL_FIELD (echo_string
) = val
;
458 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
460 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
463 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
465 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
468 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
470 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
473 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
475 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
478 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
480 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
483 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
485 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
488 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
490 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
493 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
495 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
499 /* Add C to the echo string, without echoing it immediately. C can be
500 a character, which is pretty-printed, or a symbol, whose name is
504 echo_add_key (Lisp_Object c
)
506 int size
= KEY_DESCRIPTION_SIZE
+ 100;
507 char *buffer
= alloca (size
);
509 Lisp_Object echo_string
;
511 echo_string
= KVAR (current_kboard
, echo_string
);
513 /* If someone has passed us a composite event, use its head symbol. */
517 ptr
= push_key_description (XINT (c
), ptr
);
518 else if (SYMBOLP (c
))
520 Lisp_Object name
= SYMBOL_NAME (c
);
521 int nbytes
= SBYTES (name
);
523 if (size
- (ptr
- buffer
) < nbytes
)
525 int offset
= ptr
- buffer
;
526 size
= max (2 * size
, size
+ nbytes
);
527 buffer
= alloca (size
);
528 ptr
= buffer
+ offset
;
531 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
532 STRING_MULTIBYTE (name
), 1);
535 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
538 const char *text
= " (Type ? for further options)";
539 int len
= strlen (text
);
541 if (size
- (ptr
- buffer
) < len
)
543 int offset
= ptr
- buffer
;
545 buffer
= alloca (size
);
546 ptr
= buffer
+ offset
;
549 memcpy (ptr
, text
, len
);
553 /* Replace a dash from echo_dash with a space, otherwise add a space
554 at the end as a separator between keys. */
555 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
557 Lisp_Object last_char
, prev_char
, idx
;
559 idx
= make_number (SCHARS (echo_string
) - 2);
560 prev_char
= Faref (echo_string
, idx
);
562 idx
= make_number (SCHARS (echo_string
) - 1);
563 last_char
= Faref (echo_string
, idx
);
565 /* We test PREV_CHAR to make sure this isn't the echoing of a
567 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
568 Faset (echo_string
, idx
, make_number (' '));
570 echo_string
= concat2 (echo_string
, build_string (" "));
572 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
573 echo_string
= concat2 (echo_string
, build_string (" "));
577 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
580 /* Add C to the echo string, if echoing is going on. C can be a
581 character or a symbol. */
584 echo_char (Lisp_Object c
)
586 if (current_kboard
->immediate_echo
)
593 /* Temporarily add a dash to the end of the echo string if it's not
594 empty, so that it serves as a mini-prompt for the very next
600 /* Do nothing if not echoing at all. */
601 if (NILP (KVAR (current_kboard
, echo_string
)))
604 if (this_command_key_count
== 0)
607 if (!current_kboard
->immediate_echo
608 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
611 /* Do nothing if we just printed a prompt. */
612 if (current_kboard
->echo_after_prompt
613 == SCHARS (KVAR (current_kboard
, echo_string
)))
616 /* Do nothing if we have already put a dash at the end. */
617 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
619 Lisp_Object last_char
, prev_char
, idx
;
621 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
622 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
624 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
625 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
627 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
631 /* Put a dash at the end of the buffer temporarily,
632 but make it go away when the next character is added. */
635 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
639 /* Display the current echo string, and begin echoing if not already
645 if (!current_kboard
->immediate_echo
)
648 current_kboard
->immediate_echo
= 1;
650 for (i
= 0; i
< this_command_key_count
; i
++)
654 /* Set before_command_echo_length to the value that would
655 have been saved before the start of this subcommand in
656 command_loop_1, if we had already been echoing then. */
657 if (i
== this_single_command_key_start
)
658 before_command_echo_length
= echo_length ();
660 c
= AREF (this_command_keys
, i
);
661 if (! (EVENT_HAS_PARAMETERS (c
)
662 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
666 /* Set before_command_echo_length to the value that would
667 have been saved before the start of this subcommand in
668 command_loop_1, if we had already been echoing then. */
669 if (this_command_key_count
== this_single_command_key_start
)
670 before_command_echo_length
= echo_length ();
672 /* Put a dash at the end to invite the user to type more. */
677 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
678 message3_nolog (KVAR (current_kboard
, echo_string
));
681 /* Record in what buffer we echoed, and from which kboard. */
682 echo_message_buffer
= echo_area_buffer
[0];
683 echo_kboard
= current_kboard
;
685 if (waiting_for_input
&& !NILP (Vquit_flag
))
686 quit_throw_to_read_char (0);
689 /* Turn off echoing, for the start of a new command. */
692 cancel_echoing (void)
694 current_kboard
->immediate_echo
= 0;
695 current_kboard
->echo_after_prompt
= -1;
696 kset_echo_string (current_kboard
, Qnil
);
697 ok_to_echo_at_next_pause
= NULL
;
699 echo_message_buffer
= Qnil
;
702 /* Return the length of the current echo string. */
707 return (STRINGP (KVAR (current_kboard
, echo_string
))
708 ? SCHARS (KVAR (current_kboard
, echo_string
))
712 /* Truncate the current echo message to its first LEN chars.
713 This and echo_char get used by read_key_sequence when the user
714 switches frames while entering a key sequence. */
717 echo_truncate (ptrdiff_t nchars
)
719 if (STRINGP (KVAR (current_kboard
, echo_string
)))
720 kset_echo_string (current_kboard
,
721 Fsubstring (KVAR (current_kboard
, echo_string
),
722 make_number (0), make_number (nchars
)));
723 truncate_echo_area (nchars
);
727 /* Functions for manipulating this_command_keys. */
729 add_command_key (Lisp_Object key
)
731 #if 0 /* Not needed after we made Freset_this_command_lengths
732 do the job immediately. */
733 /* If reset-this-command-length was called recently, obey it now.
734 See the doc string of that function for an explanation of why. */
735 if (before_command_restore_flag
)
737 this_command_key_count
= before_command_key_count_1
;
738 if (this_command_key_count
< this_single_command_key_start
)
739 this_single_command_key_start
= this_command_key_count
;
740 echo_truncate (before_command_echo_length_1
);
741 before_command_restore_flag
= 0;
745 if (this_command_key_count
>= ASIZE (this_command_keys
))
746 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
748 ASET (this_command_keys
, this_command_key_count
, key
);
749 ++this_command_key_count
;
754 recursive_edit_1 (void)
756 ptrdiff_t count
= SPECPDL_INDEX ();
759 if (command_loop_level
> 0)
761 specbind (Qstandard_output
, Qt
);
762 specbind (Qstandard_input
, Qt
);
765 #ifdef HAVE_WINDOW_SYSTEM
766 /* The command loop has started an hourglass timer, so we have to
767 cancel it here, otherwise it will fire because the recursive edit
768 can take some time. Do not check for display_hourglass_p here,
769 because it could already be nil. */
773 /* This function may have been called from a debugger called from
774 within redisplay, for instance by Edebugging a function called
775 from fontification-functions. We want to allow redisplay in
776 the debugging session.
778 The recursive edit is left with a `(throw exit ...)'. The `exit'
779 tag is not caught anywhere in redisplay, i.e. when we leave the
780 recursive edit, the original redisplay leading to the recursive
781 edit will be unwound. The outcome should therefore be safe. */
782 specbind (Qinhibit_redisplay
, Qnil
);
785 val
= command_loop ();
787 Fsignal (Qquit
, Qnil
);
788 /* Handle throw from read_minibuf when using minibuffer
789 while it's active but we're in another window. */
791 xsignal1 (Qerror
, val
);
793 return unbind_to (count
, Qnil
);
796 /* When an auto-save happens, record the "time", and don't do again soon. */
799 record_auto_save (void)
801 last_auto_save
= num_nonmacro_input_events
;
804 /* Make an auto save happen as soon as possible at command level. */
808 force_auto_save_soon (void)
810 last_auto_save
= - auto_save_interval
- 1;
812 record_asynch_buffer_change ();
816 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
817 doc
: /* Invoke the editor command loop recursively.
818 To get out of the recursive edit, a command can do `(throw 'exit nil)';
819 that tells this function to return.
820 Alternatively, `(throw 'exit t)' makes this function signal an error.
821 This function is called by the editor initialization to begin editing. */)
824 ptrdiff_t count
= SPECPDL_INDEX ();
827 /* If we enter while input is blocked, don't lock up here.
828 This may happen through the debugger during redisplay. */
829 if (input_blocked_p ())
832 command_loop_level
++;
833 update_mode_lines
= 1;
835 if (command_loop_level
836 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
837 buffer
= Fcurrent_buffer ();
841 /* If we leave recursive_edit_1 below with a `throw' for instance,
842 like it is done in the splash screen display, we have to
843 make sure that we restore single_kboard as command_loop_1
844 would have done if it were left normally. */
845 if (command_loop_level
> 0)
846 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
847 record_unwind_protect (recursive_edit_unwind
, buffer
);
850 return unbind_to (count
, Qnil
);
854 recursive_edit_unwind (Lisp_Object buffer
)
856 if (BUFFERP (buffer
))
857 Fset_buffer (buffer
);
859 command_loop_level
--;
860 update_mode_lines
= 1;
865 #if 0 /* These two functions are now replaced with
866 temporarily_switch_to_single_kboard. */
870 #if 0 /* Theory: if there's anything in Vunread_command_events,
871 it will right away be read by read_key_sequence,
872 and then if we do switch KBOARDS, it will go into the side
873 queue then. So we don't need to do anything special here -- rms. */
874 if (CONSP (Vunread_command_events
))
876 current_kboard
->kbd_queue
877 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
878 current_kboard
->kbd_queue_has_data
= 1;
880 Vunread_command_events
= Qnil
;
885 /* Switch to the single-kboard state, making current_kboard
886 the only KBOARD from which further input is accepted. */
889 single_kboard_state ()
895 /* If we're in single_kboard state for kboard KBOARD,
899 not_single_kboard_state (KBOARD
*kboard
)
901 if (kboard
== current_kboard
)
905 /* Maintain a stack of kboards, so other parts of Emacs
906 can switch temporarily to the kboard of a given frame
907 and then revert to the previous status. */
912 struct kboard_stack
*next
;
915 static struct kboard_stack
*kboard_stack
;
918 push_kboard (struct kboard
*k
)
920 struct kboard_stack
*p
= xmalloc (sizeof *p
);
922 p
->next
= kboard_stack
;
923 p
->kboard
= current_kboard
;
933 struct kboard_stack
*p
= kboard_stack
;
935 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
937 if (t
->kboard
== p
->kboard
)
939 current_kboard
= p
->kboard
;
946 /* The terminal we remembered has been deleted. */
947 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
950 kboard_stack
= p
->next
;
954 /* Switch to single_kboard mode, making current_kboard the only KBOARD
955 from which further input is accepted. If F is non-nil, set its
956 KBOARD as the current keyboard.
958 This function uses record_unwind_protect to return to the previous
961 If Emacs is already in single_kboard mode, and F's keyboard is
962 locked, then this function will throw an error. */
965 temporarily_switch_to_single_kboard (struct frame
*f
)
967 bool was_locked
= single_kboard
;
970 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
971 /* We can not switch keyboards while in single_kboard mode.
972 In rare cases, Lisp code may call `recursive-edit' (or
973 `read-minibuffer' or `y-or-n-p') after it switched to a
974 locked frame. For example, this is likely to happen
975 when server.el connects to a new terminal while Emacs is in
976 single_kboard mode. It is best to throw an error instead
977 of presenting the user with a frozen screen. */
978 error ("Terminal %d is locked, cannot read from it",
979 FRAME_TERMINAL (f
)->id
);
981 /* This call is unnecessary, but helps
982 `restore_kboard_configuration' discover if somebody changed
983 `current_kboard' behind our back. */
984 push_kboard (current_kboard
);
987 current_kboard
= FRAME_KBOARD (f
);
989 record_unwind_protect (restore_kboard_configuration
,
990 (was_locked
? Qt
: Qnil
));
993 #if 0 /* This function is not needed anymore. */
995 record_single_kboard_state ()
998 push_kboard (current_kboard
);
999 record_unwind_protect (restore_kboard_configuration
,
1000 (single_kboard
? Qt
: Qnil
));
1005 restore_kboard_configuration (Lisp_Object was_locked
)
1007 if (NILP (was_locked
))
1011 struct kboard
*prev
= current_kboard
;
1014 /* The pop should not change the kboard. */
1015 if (single_kboard
&& current_kboard
!= prev
)
1022 /* Handle errors that are not handled at inner levels
1023 by printing an error message and returning to the editor command loop. */
1026 cmd_error (Lisp_Object data
)
1028 Lisp_Object old_level
, old_length
;
1029 char macroerror
[sizeof "After..kbd macro iterations: "
1030 + INT_STRLEN_BOUND (EMACS_INT
)];
1032 #ifdef HAVE_WINDOW_SYSTEM
1033 if (display_hourglass_p
)
1034 cancel_hourglass ();
1037 if (!NILP (executing_kbd_macro
))
1039 if (executing_kbd_macro_iterations
== 1)
1040 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1042 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1043 executing_kbd_macro_iterations
);
1048 Vstandard_output
= Qt
;
1049 Vstandard_input
= Qt
;
1050 Vexecuting_kbd_macro
= Qnil
;
1051 executing_kbd_macro
= Qnil
;
1052 kset_prefix_arg (current_kboard
, Qnil
);
1053 kset_last_prefix_arg (current_kboard
, Qnil
);
1056 /* Avoid unquittable loop if data contains a circular list. */
1057 old_level
= Vprint_level
;
1058 old_length
= Vprint_length
;
1059 XSETFASTINT (Vprint_level
, 10);
1060 XSETFASTINT (Vprint_length
, 10);
1061 cmd_error_internal (data
, macroerror
);
1062 Vprint_level
= old_level
;
1063 Vprint_length
= old_length
;
1066 Vinhibit_quit
= Qnil
;
1068 return make_number (0);
1071 /* Take actions on handling an error. DATA is the data that describes
1074 CONTEXT is a C-string containing ASCII characters only which
1075 describes the context in which the error happened. If we need to
1076 generalize CONTEXT to allow multibyte characters, make it a Lisp
1080 cmd_error_internal (Lisp_Object data
, const char *context
)
1082 struct frame
*sf
= SELECTED_FRAME ();
1084 /* The immediate context is not interesting for Quits,
1085 since they are asynchronous. */
1086 if (EQ (XCAR (data
), Qquit
))
1087 Vsignaling_function
= Qnil
;
1092 /* Use user's specified output function if any. */
1093 if (!NILP (Vcommand_error_function
))
1094 call3 (Vcommand_error_function
, data
,
1095 context
? build_string (context
) : empty_unibyte_string
,
1096 Vsignaling_function
);
1097 /* If the window system or terminal frame hasn't been initialized
1098 yet, or we're not interactive, write the message to stderr and exit. */
1099 else if (!sf
->glyphs_initialized_p
1100 /* The initial frame is a special non-displaying frame. It
1101 will be current in daemon mode when there are no frames
1102 to display, and in non-daemon mode before the real frame
1103 has finished initializing. If an error is thrown in the
1104 latter case while creating the frame, then the frame
1105 will never be displayed, so the safest thing to do is
1106 write to stderr and quit. In daemon mode, there are
1107 many other potential errors that do not prevent frames
1108 from being created, so continuing as normal is better in
1110 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1113 print_error_message (data
, Qexternal_debugging_output
,
1114 context
, Vsignaling_function
);
1115 Fterpri (Qexternal_debugging_output
);
1116 Fkill_emacs (make_number (-1));
1120 clear_message (1, 0);
1122 message_log_maybe_newline ();
1125 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1128 Vsignaling_function
= Qnil
;
1131 static Lisp_Object
command_loop_2 (Lisp_Object
);
1132 static Lisp_Object
top_level_1 (Lisp_Object
);
1134 /* Entry to editor-command-loop.
1135 This level has the catches for exiting/returning to editor command loop.
1136 It returns nil to exit recursive edit, t to abort it. */
1141 if (command_loop_level
> 0 || minibuf_level
> 0)
1144 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1145 executing_kbd_macro
= Qnil
;
1151 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1152 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1153 executing_kbd_macro
= Qnil
;
1155 /* End of file in -batch run causes exit here. */
1161 /* Here we catch errors in execution of commands within the
1162 editing loop, and reenter the editing loop.
1163 When there is an error, cmd_error runs and returns a non-nil
1164 value to us. A value of nil means that command_loop_1 itself
1165 returned due to end of file (or end of kbd macro). */
1168 command_loop_2 (Lisp_Object ignore
)
1170 register Lisp_Object val
;
1173 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1174 while (!NILP (val
));
1182 return Feval (Vtop_level
, Qnil
);
1186 top_level_1 (Lisp_Object ignore
)
1188 /* On entry to the outer level, run the startup file. */
1189 if (!NILP (Vtop_level
))
1190 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1191 else if (!NILP (Vpurify_flag
))
1192 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1194 message1 ("Bare Emacs (standard Lisp code not loaded)");
1198 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1199 doc
: /* Exit all recursive editing levels.
1200 This also exits all active minibuffers. */)
1203 #ifdef HAVE_WINDOW_SYSTEM
1204 if (display_hourglass_p
)
1205 cancel_hourglass ();
1208 /* Unblock input if we enter with input blocked. This may happen if
1209 redisplay traps e.g. during tool-bar update with input blocked. */
1210 totally_unblock_input ();
1212 Fthrow (Qtop_level
, Qnil
);
1215 static _Noreturn
void
1216 user_error (const char *msg
)
1218 xsignal1 (Quser_error
, build_string (msg
));
1222 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1223 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1226 if (command_loop_level
> 0 || minibuf_level
> 0)
1227 Fthrow (Qexit
, Qnil
);
1229 user_error ("No recursive edit is in progress");
1233 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1234 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1237 if (command_loop_level
> 0 || minibuf_level
> 0)
1240 user_error ("No recursive edit is in progress");
1243 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1244 of this function. */
1247 tracking_off (Lisp_Object old_value
)
1249 do_mouse_tracking
= old_value
;
1250 if (NILP (old_value
))
1252 /* Redisplay may have been preempted because there was input
1253 available, and it assumes it will be called again after the
1254 input has been processed. If the only input available was
1255 the sort that we have just disabled, then we need to call
1257 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1259 redisplay_preserve_echo_area (6);
1260 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1266 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1267 doc
: /* Evaluate BODY with mouse movement events enabled.
1268 Within a `track-mouse' form, mouse motion generates input events that
1269 you can read with `read-event'.
1270 Normally, mouse motion is ignored.
1271 usage: (track-mouse BODY...) */)
1274 ptrdiff_t count
= SPECPDL_INDEX ();
1277 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1279 do_mouse_tracking
= Qt
;
1281 val
= Fprogn (args
);
1282 return unbind_to (count
, val
);
1285 /* If mouse has moved on some frame, return one of those frames.
1289 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1290 after resizing the tool-bar window. */
1292 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1295 bool ignore_mouse_drag_p
;
1298 some_mouse_moved (void)
1300 Lisp_Object tail
, frame
;
1302 if (ignore_mouse_drag_p
)
1304 /* ignore_mouse_drag_p = 0; */
1308 FOR_EACH_FRAME (tail
, frame
)
1310 if (XFRAME (frame
)->mouse_moved
)
1311 return XFRAME (frame
);
1318 /* This is the actual command reading loop,
1319 sans error-handling encapsulation. */
1321 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1323 void safe_run_hooks (Lisp_Object
);
1324 static void adjust_point_for_property (ptrdiff_t, bool);
1326 /* Cancel hourglass from protect_unwind.
1328 #ifdef HAVE_WINDOW_SYSTEM
1330 cancel_hourglass_unwind (Lisp_Object arg
)
1332 cancel_hourglass ();
1337 /* The last boundary auto-added to buffer-undo-list. */
1338 Lisp_Object last_undo_boundary
;
1340 /* FIXME: This is wrong rather than test window-system, we should call
1341 a new set-selection, which will then dispatch to x-set-selection, or
1342 tty-set-selection, or w32-set-selection, ... */
1345 command_loop_1 (void)
1348 Lisp_Object keybuf
[30];
1350 EMACS_INT prev_modiff
= 0;
1351 struct buffer
*prev_buffer
= NULL
;
1352 bool already_adjusted
= 0;
1354 kset_prefix_arg (current_kboard
, Qnil
);
1355 kset_last_prefix_arg (current_kboard
, Qnil
);
1356 Vdeactivate_mark
= Qnil
;
1357 waiting_for_input
= 0;
1360 this_command_key_count
= 0;
1361 this_command_key_count_reset
= 0;
1362 this_single_command_key_start
= 0;
1364 if (NILP (Vmemory_full
))
1366 /* Make sure this hook runs after commands that get errors and
1367 throw to top level. */
1368 /* Note that the value cell will never directly contain nil
1369 if the symbol is a local variable. */
1370 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1371 safe_run_hooks (Qpost_command_hook
);
1373 /* If displaying a message, resize the echo area window to fit
1374 that message's size exactly. */
1375 if (!NILP (echo_area_buffer
[0]))
1376 resize_echo_area_exactly ();
1378 /* If there are warnings waiting, process them. */
1379 if (!NILP (Vdelayed_warnings_list
))
1380 safe_run_hooks (Qdelayed_warnings_hook
);
1382 if (!NILP (Vdeferred_action_list
))
1383 safe_run_hooks (Qdeferred_action_function
);
1386 /* Do this after running Vpost_command_hook, for consistency. */
1387 kset_last_command (current_kboard
, Vthis_command
);
1388 kset_real_last_command (current_kboard
, Vreal_this_command
);
1389 if (!CONSP (last_command_event
))
1390 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1394 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1397 /* Make sure the current window's buffer is selected. */
1398 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1400 /* Display any malloc warning that just came out. Use while because
1401 displaying one warning can cause another. */
1403 while (pending_malloc_warning
)
1404 display_malloc_warning ();
1406 Vdeactivate_mark
= Qnil
;
1408 /* Don't ignore mouse movements for more than a single command
1409 loop. (This flag is set in xdisp.c whenever the tool bar is
1410 resized, because the resize moves text up or down, and would
1411 generate false mouse drag events if we don't ignore them.) */
1412 ignore_mouse_drag_p
= 0;
1414 /* If minibuffer on and echo area in use,
1415 wait a short time and redraw minibuffer. */
1418 && !NILP (echo_area_buffer
[0])
1419 && EQ (minibuf_window
, echo_area_window
)
1420 && NUMBERP (Vminibuffer_message_timeout
))
1422 /* Bind inhibit-quit to t so that C-g gets read in
1423 rather than quitting back to the minibuffer. */
1424 ptrdiff_t count
= SPECPDL_INDEX ();
1425 specbind (Qinhibit_quit
, Qt
);
1427 sit_for (Vminibuffer_message_timeout
, 0, 2);
1429 /* Clear the echo area. */
1431 safe_run_hooks (Qecho_area_clear_hook
);
1433 unbind_to (count
, Qnil
);
1435 /* If a C-g came in before, treat it as input now. */
1436 if (!NILP (Vquit_flag
))
1439 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1443 /* If it has changed current-menubar from previous value,
1444 really recompute the menubar from the value. */
1445 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1446 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1447 call0 (Qrecompute_lucid_menubar
);
1449 before_command_key_count
= this_command_key_count
;
1450 before_command_echo_length
= echo_length ();
1452 Vthis_command
= Qnil
;
1453 Vreal_this_command
= Qnil
;
1454 Vthis_original_command
= Qnil
;
1455 Vthis_command_keys_shift_translated
= Qnil
;
1457 /* Read next key sequence; i gets its length. */
1458 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1461 /* A filter may have run while we were reading the input. */
1462 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1464 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1468 /* Now we have read a key sequence of length I,
1469 or else I is 0 and we found end of file. */
1471 if (i
== 0) /* End of file -- happens only in */
1472 return Qnil
; /* a kbd macro, at the end. */
1473 /* -1 means read_key_sequence got a menu that was rejected.
1474 Just loop around and read another command. */
1478 this_command_key_count
= 0;
1479 this_command_key_count_reset
= 0;
1480 this_single_command_key_start
= 0;
1484 last_command_event
= keybuf
[i
- 1];
1486 /* If the previous command tried to force a specific window-start,
1487 forget about that, in case this command moves point far away
1488 from that position. But also throw away beg_unchanged and
1489 end_unchanged information in that case, so that redisplay will
1490 update the whole window properly. */
1491 if (XWINDOW (selected_window
)->force_start
)
1494 XWINDOW (selected_window
)->force_start
= 0;
1495 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1496 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1499 cmd
= read_key_sequence_cmd
;
1500 if (!NILP (Vexecuting_kbd_macro
))
1502 if (!NILP (Vquit_flag
))
1504 Vexecuting_kbd_macro
= Qt
;
1505 QUIT
; /* Make some noise. */
1506 /* Will return since macro now empty. */
1510 /* Do redisplay processing after this command except in special
1511 cases identified below. */
1512 prev_buffer
= current_buffer
;
1513 prev_modiff
= MODIFF
;
1514 last_point_position
= PT
;
1515 last_point_position_window
= selected_window
;
1516 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1518 /* By default, we adjust point to a boundary of a region that
1519 has such a property that should be treated intangible
1520 (e.g. composition, display). But, some commands will set
1521 this variable differently. */
1522 Vdisable_point_adjustment
= Qnil
;
1524 /* Process filters and timers may have messed with deactivate-mark.
1525 reset it before we execute the command. */
1526 Vdeactivate_mark
= Qnil
;
1528 /* Remap command through active keymaps. */
1529 Vthis_original_command
= cmd
;
1530 if (!NILP (read_key_sequence_remapped
))
1531 cmd
= read_key_sequence_remapped
;
1533 /* Execute the command. */
1535 Vthis_command
= cmd
;
1536 Vreal_this_command
= cmd
;
1537 safe_run_hooks (Qpre_command_hook
);
1539 already_adjusted
= 0;
1541 if (NILP (Vthis_command
))
1543 /* nil means key is undefined. */
1544 Lisp_Object keys
= Fvector (i
, keybuf
);
1545 keys
= Fkey_description (keys
, Qnil
);
1547 message_with_string ("%s is undefined", keys
, 0);
1548 kset_defining_kbd_macro (current_kboard
, Qnil
);
1549 update_mode_lines
= 1;
1550 /* If this is a down-mouse event, don't reset prefix-arg;
1551 pass it to the command run by the up event. */
1552 if (EVENT_HAS_PARAMETERS (last_command_event
))
1554 Lisp_Object breakdown
1555 = parse_modifiers (EVENT_HEAD (last_command_event
));
1556 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1557 if (!(modifiers
& down_modifier
))
1558 kset_prefix_arg (current_kboard
, Qnil
);
1561 kset_prefix_arg (current_kboard
, Qnil
);
1565 /* Here for a command that isn't executed directly. */
1567 #ifdef HAVE_WINDOW_SYSTEM
1568 ptrdiff_t scount
= SPECPDL_INDEX ();
1570 if (display_hourglass_p
1571 && NILP (Vexecuting_kbd_macro
))
1573 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1578 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1580 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1583 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1584 ? Qnil
: BVAR (current_buffer
, undo_list
));
1586 call1 (Qcommand_execute
, Vthis_command
);
1588 #ifdef HAVE_WINDOW_SYSTEM
1589 /* Do not check display_hourglass_p here, because
1590 `command-execute' could change it, but we should cancel
1591 hourglass cursor anyway.
1592 But don't cancel the hourglass within a macro
1593 just because a command in the macro finishes. */
1594 if (NILP (Vexecuting_kbd_macro
))
1595 unbind_to (scount
, Qnil
);
1598 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1600 safe_run_hooks (Qpost_command_hook
);
1602 /* If displaying a message, resize the echo area window to fit
1603 that message's size exactly. */
1604 if (!NILP (echo_area_buffer
[0]))
1605 resize_echo_area_exactly ();
1607 /* If there are warnings waiting, process them. */
1608 if (!NILP (Vdelayed_warnings_list
))
1609 safe_run_hooks (Qdelayed_warnings_hook
);
1611 safe_run_hooks (Qdeferred_action_function
);
1613 /* If there is a prefix argument,
1614 1) We don't want Vlast_command to be ``universal-argument''
1615 (that would be dumb), so don't set Vlast_command,
1616 2) we want to leave echoing on so that the prefix will be
1617 echoed as part of this key sequence, so don't call
1619 3) we want to leave this_command_key_count non-zero, so that
1620 read_char will realize that it is re-reading a character, and
1621 not echo it a second time.
1623 If the command didn't actually create a prefix arg,
1624 but is merely a frame event that is transparent to prefix args,
1625 then the above doesn't apply. */
1626 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1627 || CONSP (last_command_event
))
1629 kset_last_command (current_kboard
, Vthis_command
);
1630 kset_real_last_command (current_kboard
, Vreal_this_command
);
1631 if (!CONSP (last_command_event
))
1632 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1634 this_command_key_count
= 0;
1635 this_command_key_count_reset
= 0;
1636 this_single_command_key_start
= 0;
1639 if (!NILP (BVAR (current_buffer
, mark_active
))
1640 && !NILP (Vrun_hooks
))
1642 /* In Emacs 22, setting transient-mark-mode to `only' was a
1643 way of turning it on for just one command. This usage is
1644 obsolete, but support it anyway. */
1645 if (EQ (Vtransient_mark_mode
, Qidentity
))
1646 Vtransient_mark_mode
= Qnil
;
1647 else if (EQ (Vtransient_mark_mode
, Qonly
))
1648 Vtransient_mark_mode
= Qidentity
;
1650 if (!NILP (Vdeactivate_mark
))
1651 /* If `select-active-regions' is non-nil, this call to
1652 `deactivate-mark' also sets the PRIMARY selection. */
1653 call0 (Qdeactivate_mark
);
1656 /* Even if not deactivating the mark, set PRIMARY if
1657 `select-active-regions' is non-nil. */
1658 if (!NILP (Fwindow_system (Qnil
))
1659 /* Even if mark_active is non-nil, the actual buffer
1660 marker may not have been set yet (Bug#7044). */
1661 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1662 && (EQ (Vselect_active_regions
, Qonly
)
1663 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1664 : (!NILP (Vselect_active_regions
)
1665 && !NILP (Vtransient_mark_mode
)))
1666 && NILP (Fmemq (Vthis_command
,
1667 Vselection_inhibit_update_commands
)))
1670 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1673 call2 (Qx_set_selection
, QPRIMARY
,
1674 make_buffer_string (beg
, end
, 0));
1676 call2 (Qx_set_selection
, QPRIMARY
,
1677 make_buffer_string (end
, beg
, 0));
1678 /* Don't set empty selections. */
1681 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1683 Lisp_Object hook
= intern ("activate-mark-hook");
1684 Frun_hooks (1, &hook
);
1688 Vsaved_region_selection
= Qnil
;
1693 if (current_buffer
== prev_buffer
1694 && last_point_position
!= PT
1695 && NILP (Vdisable_point_adjustment
)
1696 && NILP (Vglobal_disable_point_adjustment
))
1698 if (last_point_position
> BEGV
1699 && last_point_position
< ZV
1700 && (composition_adjust_point (last_point_position
,
1701 last_point_position
)
1702 != last_point_position
))
1703 /* The last point was temporarily set within a grapheme
1704 cluster to prevent automatic composition. To recover
1705 the automatic composition, we must update the
1707 windows_or_buffers_changed
++;
1708 if (!already_adjusted
)
1709 adjust_point_for_property (last_point_position
,
1710 MODIFF
!= prev_modiff
);
1713 /* Install chars successfully executed in kbd macro. */
1715 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1716 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1717 finalize_kbd_macro_chars ();
1721 /* Adjust point to a boundary of a region that has such a property
1722 that should be treated intangible. For the moment, we check
1723 `composition', `display' and `invisible' properties.
1724 LAST_PT is the last position of point. */
1727 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1730 Lisp_Object val
, overlay
, tmp
;
1731 /* When called after buffer modification, we should temporarily
1732 suppress the point adjustment for automatic composition so that a
1733 user can keep inserting another character at point or keep
1734 deleting characters around point. */
1735 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1736 ptrdiff_t orig_pt
= PT
;
1738 /* FIXME: cycling is probably not necessary because these properties
1739 can't be usefully combined anyway. */
1740 while (check_composition
|| check_display
|| check_invisible
)
1742 /* FIXME: check `intangible'. */
1743 if (check_composition
1744 && PT
> BEGV
&& PT
< ZV
1745 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1748 check_display
= check_invisible
= 1;
1750 check_composition
= 0;
1752 && PT
> BEGV
&& PT
< ZV
1753 && !NILP (val
= get_char_property_and_overlay
1754 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1755 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1756 && (!OVERLAYP (overlay
)
1757 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1758 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1759 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1760 && (beg
< PT
/* && end > PT <- It's always the case. */
1761 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1764 SET_PT (PT
< last_pt
1765 ? (STRINGP (val
) && SCHARS (val
) == 0
1766 ? max (beg
- 1, BEGV
)
1769 check_composition
= check_invisible
= 1;
1772 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1778 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1781 /* FIXME: We should stop if we find a spot between
1782 two runs of `invisible' where inserted text would
1783 be visible. This is important when we have two
1784 invisible boundaries that enclose an area: if the
1785 area is empty, we need this test in order to make
1786 it possible to place point in the middle rather
1787 than skip both boundaries. However, this code
1788 also stops anywhere in a non-sticky text-property,
1789 which breaks (e.g.) Org mode. */
1790 && (val
= get_pos_property (make_number (end
),
1792 TEXT_PROP_MEANS_INVISIBLE (val
))
1794 && !NILP (val
= get_char_property_and_overlay
1795 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1796 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1798 ellipsis
= ellipsis
|| inv
> 1
1799 || (OVERLAYP (overlay
)
1800 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1801 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1802 tmp
= Fnext_single_char_property_change
1803 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1804 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1808 && (val
= get_pos_property (make_number (beg
),
1810 TEXT_PROP_MEANS_INVISIBLE (val
))
1812 && !NILP (val
= get_char_property_and_overlay
1813 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1814 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1816 ellipsis
= ellipsis
|| inv
> 1
1817 || (OVERLAYP (overlay
)
1818 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1819 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1820 tmp
= Fprevious_single_char_property_change
1821 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1822 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1825 /* Move away from the inside area. */
1826 if (beg
< PT
&& end
> PT
)
1828 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1829 /* We haven't moved yet (so we don't need to fear
1830 infinite-looping) and we were outside the range
1831 before (so either end of the range still corresponds
1832 to a move in the right direction): pretend we moved
1833 less than we actually did, so that we still have
1834 more freedom below in choosing which end of the range
1836 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1837 /* We either have moved already or the last point
1838 was already in the range: we don't get to choose
1839 which end of the range we have to go to. */
1840 : (PT
< last_pt
? beg
: end
));
1841 check_composition
= check_display
= 1;
1843 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1844 the point to something other than its argument, due to
1845 point-motion hooks, intangibility, etc. */
1846 eassert (PT
== beg
|| PT
== end
);
1849 /* Pretend the area doesn't exist if the buffer is not
1851 if (!modified
&& !ellipsis
&& beg
< end
)
1853 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1854 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1855 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1856 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1857 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1858 /* We've already moved as far as we can. Trying to go
1859 to the other end would mean moving backwards and thus
1860 could lead to an infinite loop. */
1862 else if (val
= get_pos_property (make_number (PT
),
1864 TEXT_PROP_MEANS_INVISIBLE (val
)
1865 && (val
= get_pos_property
1866 (make_number (PT
== beg
? end
: beg
),
1868 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1869 (check_composition
= check_display
= 1,
1870 SET_PT (PT
== beg
? end
: beg
));
1873 check_invisible
= 0;
1877 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1880 safe_run_hooks_1 (void)
1882 eassert (CONSP (Vinhibit_quit
));
1883 return call0 (XCDR (Vinhibit_quit
));
1886 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1890 safe_run_hooks_error (Lisp_Object error_data
)
1893 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1894 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1895 Lisp_Object args
[4];
1896 args
[0] = build_string ("Error in %s (%s): %S");
1899 args
[3] = error_data
;
1905 Lisp_Object newval
= Qnil
;
1906 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1907 if (EQ (fun
, XCAR (val
)))
1910 newval
= Fcons (XCAR (val
), newval
);
1912 return Fset (hook
, Fnreverse (newval
));
1913 /* Not found in the local part of the hook. Let's look at the global
1916 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1917 : Fdefault_value (hook
));
1918 CONSP (val
); val
= XCDR (val
))
1919 if (EQ (fun
, XCAR (val
)))
1922 newval
= Fcons (XCAR (val
), newval
);
1924 return Fset_default (hook
, Fnreverse (newval
));
1930 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1932 eassert (nargs
== 1);
1933 if (CONSP (Vinhibit_quit
))
1934 XSETCDR (Vinhibit_quit
, args
[0]);
1936 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1938 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1942 /* If we get an error while running the hook, cause the hook variable
1943 to be nil. Also inhibit quits, so that C-g won't cause the hook
1944 to mysteriously evaporate. */
1947 safe_run_hooks (Lisp_Object hook
)
1949 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1950 to its body or to its handlers other than via globals such as
1951 dynamically-bound variables ;-) */
1952 ptrdiff_t count
= SPECPDL_INDEX ();
1953 specbind (Qinhibit_quit
, hook
);
1955 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1957 unbind_to (count
, Qnil
);
1961 /* Nonzero means polling for input is temporarily suppressed. */
1963 int poll_suppress_count
;
1966 #ifdef POLL_FOR_INPUT
1968 /* Asynchronous timer for polling. */
1970 static struct atimer
*poll_timer
;
1972 /* Poll for input, so that we catch a C-g if it comes in. This
1973 function is called from x_make_frame_visible, see comment
1977 poll_for_input_1 (void)
1979 if (! input_blocked_p ()
1980 && !waiting_for_input
)
1984 /* Timer callback function for poll_timer. TIMER is equal to
1988 poll_for_input (struct atimer
*timer
)
1990 if (poll_suppress_count
== 0)
1991 pending_signals
= 1;
1994 #endif /* POLL_FOR_INPUT */
1996 /* Begin signals to poll for input, if they are appropriate.
1997 This function is called unconditionally from various places. */
2000 start_polling (void)
2002 #ifdef POLL_FOR_INPUT
2003 /* XXX This condition was (read_socket_hook && !interrupt_input),
2004 but read_socket_hook is not global anymore. Let's pretend that
2006 if (!interrupt_input
)
2008 /* Turn alarm handling on unconditionally. It might have
2009 been turned off in process.c. */
2010 turn_on_atimers (1);
2012 /* If poll timer doesn't exist, are we need one with
2013 a different interval, start a new one. */
2014 if (poll_timer
== NULL
2015 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2017 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2018 EMACS_TIME interval
= make_emacs_time (period
, 0);
2021 cancel_atimer (poll_timer
);
2023 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2024 poll_for_input
, NULL
);
2027 /* Let the timer's callback function poll for input
2028 if this becomes zero. */
2029 --poll_suppress_count
;
2034 /* True if we are using polling to handle input asynchronously. */
2037 input_polling_used (void)
2039 #ifdef POLL_FOR_INPUT
2040 /* XXX This condition was (read_socket_hook && !interrupt_input),
2041 but read_socket_hook is not global anymore. Let's pretend that
2043 return !interrupt_input
;
2049 /* Turn off polling. */
2054 #ifdef POLL_FOR_INPUT
2055 /* XXX This condition was (read_socket_hook && !interrupt_input),
2056 but read_socket_hook is not global anymore. Let's pretend that
2058 if (!interrupt_input
)
2059 ++poll_suppress_count
;
2063 /* Set the value of poll_suppress_count to COUNT
2064 and start or stop polling accordingly. */
2067 set_poll_suppress_count (int count
)
2069 #ifdef POLL_FOR_INPUT
2070 if (count
== 0 && poll_suppress_count
!= 0)
2072 poll_suppress_count
= 1;
2075 else if (count
!= 0 && poll_suppress_count
== 0)
2079 poll_suppress_count
= count
;
2083 /* Bind polling_period to a value at least N.
2084 But don't decrease it. */
2087 bind_polling_period (int n
)
2089 #ifdef POLL_FOR_INPUT
2090 EMACS_INT
new = polling_period
;
2095 stop_other_atimers (poll_timer
);
2097 specbind (Qpolling_period
, make_number (new));
2098 /* Start a new alarm with the new period. */
2103 /* Apply the control modifier to CHARACTER. */
2106 make_ctrl_char (int c
)
2108 /* Save the upper bits here. */
2109 int upper
= c
& ~0177;
2111 if (! ASCII_BYTE_P (c
))
2112 return c
|= ctrl_modifier
;
2116 /* Everything in the columns containing the upper-case letters
2117 denotes a control character. */
2118 if (c
>= 0100 && c
< 0140)
2122 /* Set the shift modifier for a control char
2123 made from a shifted letter. But only for letters! */
2124 if (oc
>= 'A' && oc
<= 'Z')
2125 c
|= shift_modifier
;
2128 /* The lower-case letters denote control characters too. */
2129 else if (c
>= 'a' && c
<= 'z')
2132 /* Include the bits for control and shift
2133 only if the basic ASCII code can't indicate them. */
2137 /* Replace the high bits. */
2138 c
|= (upper
& ~ctrl_modifier
);
2143 /* Display the help-echo property of the character after the mouse pointer.
2144 Either show it in the echo area, or call show-help-function to display
2145 it by other means (maybe in a tooltip).
2147 If HELP is nil, that means clear the previous help echo.
2149 If HELP is a string, display that string. If HELP is a function,
2150 call it with OBJECT and POS as arguments; the function should
2151 return a help string or nil for none. For all other types of HELP,
2152 evaluate it to obtain a string.
2154 WINDOW is the window in which the help was generated, if any.
2155 It is nil if not in a window.
2157 If OBJECT is a buffer, POS is the position in the buffer where the
2158 `help-echo' text property was found.
2160 If OBJECT is an overlay, that overlay has a `help-echo' property,
2161 and POS is the position in the overlay's buffer under the mouse.
2163 If OBJECT is a string (an overlay string or a string displayed with
2164 the `display' property). POS is the position in that string under
2167 Note: this function may only be called with HELP nil or a string
2168 from X code running asynchronously. */
2171 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2174 if (!NILP (help
) && !STRINGP (help
))
2176 if (FUNCTIONP (help
))
2177 help
= safe_call (4, help
, window
, object
, pos
);
2179 help
= safe_eval (help
);
2181 if (!STRINGP (help
))
2185 if (!noninteractive
&& STRINGP (help
))
2187 /* The mouse-fixup-help-message Lisp function can call
2188 mouse_position_hook, which resets the mouse_moved flags.
2189 This causes trouble if we are trying to read a mouse motion
2190 event (i.e., if we are inside a `track-mouse' form), so we
2191 restore the mouse_moved flag. */
2192 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2193 help
= call1 (Qmouse_fixup_help_message
, help
);
2198 if (STRINGP (help
) || NILP (help
))
2200 if (!NILP (Vshow_help_function
))
2201 call1 (Vshow_help_function
, help
);
2202 help_echo_showing_p
= STRINGP (help
);
2208 /* Input of single characters from keyboard */
2210 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2211 EMACS_TIME
*end_time
);
2212 static void record_char (Lisp_Object c
);
2214 static Lisp_Object help_form_saved_window_configs
;
2216 read_char_help_form_unwind (Lisp_Object arg
)
2218 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2219 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2220 if (!NILP (window_config
))
2221 Fset_window_configuration (window_config
);
2225 #define STOP_POLLING \
2226 do { if (! polling_stopped_here) stop_polling (); \
2227 polling_stopped_here = 1; } while (0)
2229 #define RESUME_POLLING \
2230 do { if (polling_stopped_here) start_polling (); \
2231 polling_stopped_here = 0; } while (0)
2233 /* Read a character from the keyboard; call the redisplay if needed. */
2234 /* commandflag 0 means do not autosave, but do redisplay.
2235 -1 means do not redisplay, but do autosave.
2238 /* The arguments MAP is for menu prompting. MAP is a keymap.
2240 PREV_EVENT is the previous input event, or nil if we are reading
2241 the first event of a key sequence (or not reading a key sequence).
2242 If PREV_EVENT is t, that is a "magic" value that says
2243 not to run input methods, but in other respects to act as if
2244 not reading a key sequence.
2246 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2247 if we used a mouse menu to read the input, or false otherwise. If
2248 USED_MOUSE_MENU is null, don't dereference it.
2250 Value is -2 when we find input on another keyboard. A second call
2251 to read_char will read it.
2253 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2254 specifying the maximum time to wait until. If no input arrives by
2255 that time, stop waiting and return nil.
2257 Value is t if we showed a menu and the user rejected it. */
2260 read_char (int commandflag
, Lisp_Object map
,
2261 Lisp_Object prev_event
,
2262 bool *used_mouse_menu
, EMACS_TIME
*end_time
)
2266 sys_jmp_buf local_getcjmp
;
2267 sys_jmp_buf save_jump
;
2268 Lisp_Object tem
, save
;
2269 volatile Lisp_Object previous_echo_area_message
;
2270 volatile Lisp_Object also_record
;
2271 volatile bool reread
;
2272 struct gcpro gcpro1
, gcpro2
;
2273 bool volatile polling_stopped_here
= 0;
2274 struct kboard
*orig_kboard
= current_kboard
;
2278 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2279 before_command_key_count
= this_command_key_count
;
2280 before_command_echo_length
= echo_length ();
2283 previous_echo_area_message
= Qnil
;
2285 GCPRO2 (c
, previous_echo_area_message
);
2290 if (CONSP (Vunread_post_input_method_events
))
2292 c
= XCAR (Vunread_post_input_method_events
);
2293 Vunread_post_input_method_events
2294 = XCDR (Vunread_post_input_method_events
);
2296 /* Undo what read_char_x_menu_prompt did when it unread
2297 additional keys returned by Fx_popup_menu. */
2299 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2307 if (CONSP (Vunread_command_events
))
2309 bool was_disabled
= 0;
2311 c
= XCAR (Vunread_command_events
);
2312 Vunread_command_events
= XCDR (Vunread_command_events
);
2316 /* Undo what sit-for did when it unread additional keys
2317 inside universal-argument. */
2320 && EQ (XCAR (c
), Qt
))
2326 /* Undo what read_char_x_menu_prompt did when it unread
2327 additional keys returned by Fx_popup_menu. */
2329 && EQ (XCDR (c
), Qdisabled
)
2330 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2336 /* If the queued event is something that used the mouse,
2337 set used_mouse_menu accordingly. */
2339 /* Also check was_disabled so last-nonmenu-event won't return
2340 a bad value when submenus are involved. (Bug#447) */
2341 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2342 *used_mouse_menu
= 1;
2344 goto reread_for_input_method
;
2347 if (CONSP (Vunread_input_method_events
))
2349 c
= XCAR (Vunread_input_method_events
);
2350 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2352 /* Undo what read_char_x_menu_prompt did when it unread
2353 additional keys returned by Fx_popup_menu. */
2355 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2359 goto reread_for_input_method
;
2362 this_command_key_count_reset
= 0;
2364 if (!NILP (Vexecuting_kbd_macro
))
2366 /* We set this to Qmacro; since that's not a frame, nobody will
2367 try to switch frames on us, and the selected window will
2370 Since this event came from a macro, it would be misleading to
2371 leave internal_last_event_frame set to wherever the last
2372 real event came from. Normally, a switch-frame event selects
2373 internal_last_event_frame after each command is read, but
2374 events read from a macro should never cause a new frame to be
2376 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2378 /* Exit the macro if we are at the end.
2379 Also, some things replace the macro with t
2380 to force an early exit. */
2381 if (EQ (Vexecuting_kbd_macro
, Qt
)
2382 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2388 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2389 if (STRINGP (Vexecuting_kbd_macro
)
2390 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2391 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2393 executing_kbd_macro_index
++;
2398 if (!NILP (unread_switch_frame
))
2400 c
= unread_switch_frame
;
2401 unread_switch_frame
= Qnil
;
2403 /* This event should make it into this_command_keys, and get echoed
2404 again, so we do not set `reread'. */
2408 /* If redisplay was requested. */
2409 if (commandflag
>= 0)
2411 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2413 /* If there is pending input, process any events which are not
2414 user-visible, such as X selection_request events. */
2416 || detect_input_pending_run_timers (0))
2417 swallow_events (0); /* May clear input_pending. */
2419 /* Redisplay if no pending input. */
2420 while (!input_pending
)
2422 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2423 redisplay_preserve_echo_area (5);
2428 /* Normal case: no input arrived during redisplay. */
2431 /* Input arrived and pre-empted redisplay.
2432 Process any events which are not user-visible. */
2434 /* If that cleared input_pending, try again to redisplay. */
2437 /* Prevent the redisplay we just did
2438 from messing up echoing of the input after the prompt. */
2439 if (commandflag
== 0 && echo_current
)
2440 echo_message_buffer
= echo_area_buffer
[0];
2444 /* Message turns off echoing unless more keystrokes turn it on again.
2446 The code in 20.x for the condition was
2448 1. echo_area_glyphs && *echo_area_glyphs
2449 2. && echo_area_glyphs != current_kboard->echobuf
2450 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2452 (1) means there's a current message displayed
2454 (2) means it's not the message from echoing from the current
2457 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2458 is set to a non-null value. This is done in read_char and it is
2459 set to echo_area_glyphs after a call to echo_char. That means
2460 ok_to_echo_at_next_pause is either null or
2461 current_kboard->echobuf with the appropriate current_kboard at
2464 So, condition (3) means in clear text ok_to_echo_at_next_pause
2465 must be either null, or the current message isn't from echoing at
2466 all, or it's from echoing from a different kboard than the
2469 if (/* There currently is something in the echo area. */
2470 !NILP (echo_area_buffer
[0])
2471 && (/* And it's either not from echoing. */
2472 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2473 /* Or it's an echo from a different kboard. */
2474 || echo_kboard
!= current_kboard
2475 /* Or we explicitly allow overwriting whatever there is. */
2476 || ok_to_echo_at_next_pause
== NULL
))
2481 /* Try reading a character via menu prompting in the minibuf.
2482 Try this before the sit-for, because the sit-for
2483 would do the wrong thing if we are supposed to do
2484 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2485 after a mouse event so don't try a minibuf menu. */
2487 if (KEYMAPP (map
) && INTERACTIVE
2488 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2489 /* Don't bring up a menu if we already have another event. */
2490 && NILP (Vunread_command_events
)
2491 && !detect_input_pending_run_timers (0))
2493 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2495 if (INTEGERP (c
) && XINT (c
) == -2)
2496 return c
; /* wrong_kboard_jmpbuf */
2502 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2503 We will do that below, temporarily for short sections of code,
2504 when appropriate. local_getcjmp must be in effect
2505 around any call to sit_for or kbd_buffer_get_event;
2506 it *must not* be in effect when we call redisplay. */
2508 jmpcount
= SPECPDL_INDEX ();
2509 if (sys_setjmp (local_getcjmp
))
2511 /* Handle quits while reading the keyboard. */
2512 /* We must have saved the outer value of getcjmp here,
2513 so restore it now. */
2514 restore_getcjmp (save_jump
);
2515 unbind_to (jmpcount
, Qnil
);
2516 XSETINT (c
, quit_char
);
2517 internal_last_event_frame
= selected_frame
;
2518 Vlast_event_frame
= internal_last_event_frame
;
2519 /* If we report the quit char as an event,
2520 don't do so more than once. */
2521 if (!NILP (Vinhibit_quit
))
2525 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2526 if (kb
!= current_kboard
)
2528 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2529 /* We shouldn't get here if we were in single-kboard mode! */
2534 while (CONSP (XCDR (last
)))
2536 if (!NILP (XCDR (last
)))
2540 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2542 XSETCDR (last
, Fcons (c
, Qnil
));
2543 kb
->kbd_queue_has_data
= 1;
2544 current_kboard
= kb
;
2545 /* This is going to exit from read_char
2546 so we had better get rid of this frame's stuff. */
2548 return make_number (-2); /* wrong_kboard_jmpbuf */
2554 /* Start idle timers if no time limit is supplied. We don't do it
2555 if a time limit is supplied to avoid an infinite recursion in the
2556 situation where an idle timer calls `sit-for'. */
2559 timer_start_idle ();
2561 /* If in middle of key sequence and minibuffer not active,
2562 start echoing if enough time elapses. */
2564 if (minibuf_level
== 0
2566 && !current_kboard
->immediate_echo
2567 && this_command_key_count
> 0
2569 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2570 && NILP (Fzerop (Vecho_keystrokes
))
2571 && (/* No message. */
2572 NILP (echo_area_buffer
[0])
2573 /* Or empty message. */
2574 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2575 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2576 /* Or already echoing from same kboard. */
2577 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2578 /* Or not echoing before and echoing allowed. */
2579 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2581 /* After a mouse event, start echoing right away.
2582 This is because we are probably about to display a menu,
2583 and we don't want to delay before doing so. */
2584 if (EVENT_HAS_PARAMETERS (prev_event
))
2590 save_getcjmp (save_jump
);
2591 restore_getcjmp (local_getcjmp
);
2592 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2593 restore_getcjmp (save_jump
);
2595 && ! CONSP (Vunread_command_events
))
2600 /* Maybe auto save due to number of keystrokes. */
2602 if (commandflag
!= 0
2603 && auto_save_interval
> 0
2604 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2605 && !detect_input_pending_run_timers (0))
2607 Fdo_auto_save (Qnil
, Qnil
);
2608 /* Hooks can actually change some buffers in auto save. */
2612 /* Try reading using an X menu.
2613 This is never confused with reading using the minibuf
2614 because the recursive call of read_char in read_char_minibuf_menu_prompt
2615 does not pass on any keymaps. */
2617 if (KEYMAPP (map
) && INTERACTIVE
2618 && !NILP (prev_event
)
2619 && EVENT_HAS_PARAMETERS (prev_event
)
2620 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2621 && !EQ (XCAR (prev_event
), Qtool_bar
)
2622 /* Don't bring up a menu if we already have another event. */
2623 && NILP (Vunread_command_events
))
2625 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2627 /* Now that we have read an event, Emacs is not idle. */
2634 /* Maybe autosave and/or garbage collect due to idleness. */
2636 if (INTERACTIVE
&& NILP (c
))
2639 ptrdiff_t buffer_size
;
2641 /* Slow down auto saves logarithmically in size of current buffer,
2642 and garbage collect while we're at it. */
2643 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2644 last_non_minibuf_size
= Z
- BEG
;
2645 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2647 while (buffer_size
> 64)
2648 delay_level
++, buffer_size
-= buffer_size
>> 2;
2649 if (delay_level
< 4) delay_level
= 4;
2650 /* delay_level is 4 for files under around 50k, 7 at 100k,
2651 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2653 /* Auto save if enough time goes by without input. */
2654 if (commandflag
!= 0
2655 && num_nonmacro_input_events
> last_auto_save
2656 && INTEGERP (Vauto_save_timeout
)
2657 && XINT (Vauto_save_timeout
) > 0)
2660 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2662 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2663 timeout
= delay_level
* timeout
/ 4;
2664 save_getcjmp (save_jump
);
2665 restore_getcjmp (local_getcjmp
);
2666 tem0
= sit_for (make_number (timeout
), 1, 1);
2667 restore_getcjmp (save_jump
);
2670 && ! CONSP (Vunread_command_events
))
2672 Fdo_auto_save (Qnil
, Qnil
);
2677 /* If there is still no input available, ask for GC. */
2678 if (!detect_input_pending_run_timers (0))
2682 /* Notify the caller if an autosave hook, or a timer, sentinel or
2683 filter in the sit_for calls above have changed the current
2684 kboard. This could happen if they use the minibuffer or start a
2685 recursive edit, like the fancy splash screen in server.el's
2686 filter. If this longjmp wasn't here, read_key_sequence would
2687 interpret the next key sequence using the wrong translation
2688 tables and function keymaps. */
2689 if (NILP (c
) && current_kboard
!= orig_kboard
)
2692 return make_number (-2); /* wrong_kboard_jmpbuf */
2695 /* If this has become non-nil here, it has been set by a timer
2696 or sentinel or filter. */
2697 if (CONSP (Vunread_command_events
))
2699 c
= XCAR (Vunread_command_events
);
2700 Vunread_command_events
= XCDR (Vunread_command_events
);
2703 /* Read something from current KBOARD's side queue, if possible. */
2707 if (current_kboard
->kbd_queue_has_data
)
2709 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2711 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2712 kset_kbd_queue (current_kboard
,
2713 XCDR (KVAR (current_kboard
, kbd_queue
)));
2714 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2715 current_kboard
->kbd_queue_has_data
= 0;
2716 input_pending
= readable_events (0);
2717 if (EVENT_HAS_PARAMETERS (c
)
2718 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2719 internal_last_event_frame
= XCAR (XCDR (c
));
2720 Vlast_event_frame
= internal_last_event_frame
;
2724 /* If current_kboard's side queue is empty check the other kboards.
2725 If one of them has data that we have not yet seen here,
2726 switch to it and process the data waiting for it.
2728 Note: if the events queued up for another kboard
2729 have already been seen here, and therefore are not a complete command,
2730 the kbd_queue_has_data field is 0, so we skip that kboard here.
2731 That's to avoid an infinite loop switching between kboards here. */
2732 if (NILP (c
) && !single_kboard
)
2735 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2736 if (kb
->kbd_queue_has_data
)
2738 current_kboard
= kb
;
2739 /* This is going to exit from read_char
2740 so we had better get rid of this frame's stuff. */
2742 return make_number (-2); /* wrong_kboard_jmpbuf */
2750 /* Finally, we read from the main queue,
2751 and if that gives us something we can't use yet, we put it on the
2752 appropriate side queue and try again. */
2756 KBOARD
*kb
IF_LINT (= NULL
);
2758 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2761 /* Actually read a character, waiting if necessary. */
2762 save_getcjmp (save_jump
);
2763 restore_getcjmp (local_getcjmp
);
2765 timer_start_idle ();
2766 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2767 restore_getcjmp (save_jump
);
2769 if (! NILP (c
) && (kb
!= current_kboard
))
2771 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2774 while (CONSP (XCDR (last
)))
2776 if (!NILP (XCDR (last
)))
2780 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2782 XSETCDR (last
, Fcons (c
, Qnil
));
2783 kb
->kbd_queue_has_data
= 1;
2787 current_kboard
= kb
;
2788 /* This is going to exit from read_char
2789 so we had better get rid of this frame's stuff. */
2791 return make_number (-2);
2795 /* Terminate Emacs in batch mode if at eof. */
2796 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2797 Fkill_emacs (make_number (1));
2801 /* Add in any extra modifiers, where appropriate. */
2802 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2803 || ((extra_keyboard_modifiers
& 0177) < ' '
2804 && (extra_keyboard_modifiers
& 0177) != 0))
2805 XSETINT (c
, make_ctrl_char (XINT (c
)));
2807 /* Transfer any other modifier bits directly from
2808 extra_keyboard_modifiers to c. Ignore the actual character code
2809 in the low 16 bits of extra_keyboard_modifiers. */
2810 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2821 if (commandflag
>= 0
2822 && !input_pending
&& !detect_input_pending_run_timers (0))
2828 /* Buffer switch events are only for internal wakeups
2829 so don't show them to the user.
2830 Also, don't record a key if we already did. */
2834 /* Process special events within read_char
2835 and loop around to read another event. */
2838 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2843 struct buffer
*prev_buffer
= current_buffer
;
2844 last_input_event
= c
;
2845 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2847 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2848 /* We stopped being idle for this event; undo that. This
2849 prevents automatic window selection (under
2850 mouse_autoselect_window from acting as a real input event, for
2851 example banishing the mouse under mouse-avoidance-mode. */
2852 timer_resume_idle ();
2854 if (current_buffer
!= prev_buffer
)
2856 /* The command may have changed the keymaps. Pretend there
2857 is input in another keyboard and return. This will
2858 recalculate keymaps. */
2859 c
= make_number (-2);
2866 /* Handle things that only apply to characters. */
2869 /* If kbd_buffer_get_event gave us an EOF, return that. */
2873 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2874 && UNSIGNED_CMP (XFASTINT (c
), <,
2875 SCHARS (KVAR (current_kboard
,
2876 Vkeyboard_translate_table
))))
2877 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2878 && UNSIGNED_CMP (XFASTINT (c
), <,
2879 ASIZE (KVAR (current_kboard
,
2880 Vkeyboard_translate_table
))))
2881 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2885 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2886 /* nil in keyboard-translate-table means no translation. */
2892 /* If this event is a mouse click in the menu bar,
2893 return just menu-bar for now. Modify the mouse click event
2894 so we won't do this twice, then queue it up. */
2895 if (EVENT_HAS_PARAMETERS (c
)
2897 && CONSP (EVENT_START (c
))
2898 && CONSP (XCDR (EVENT_START (c
))))
2902 posn
= POSN_POSN (EVENT_START (c
));
2903 /* Handle menu-bar events:
2904 insert the dummy prefix event `menu-bar'. */
2905 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2907 /* Change menu-bar to (menu-bar) as the event "position". */
2908 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2911 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2916 /* Store these characters into recent_keys, the dribble file if any,
2917 and the keyboard macro being defined, if any. */
2919 if (! NILP (also_record
))
2920 record_char (also_record
);
2922 /* Wipe the echo area.
2923 But first, if we are about to use an input method,
2924 save the echo area contents for it to refer to. */
2926 && ! NILP (Vinput_method_function
)
2927 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2929 previous_echo_area_message
= Fcurrent_message ();
2930 Vinput_method_previous_message
= previous_echo_area_message
;
2933 /* Now wipe the echo area, except for help events which do their
2934 own stuff with the echo area. */
2936 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2937 && !(EQ (Qswitch_frame
, XCAR (c
)))
2938 /* Don't wipe echo area for select window events: These might
2939 get delayed via `mouse-autoselect-window' (Bug#11304). */
2940 && !(EQ (Qselect_window
, XCAR (c
)))))
2942 if (!NILP (echo_area_buffer
[0]))
2944 safe_run_hooks (Qecho_area_clear_hook
);
2945 clear_message (1, 0);
2949 reread_for_input_method
:
2951 /* Pass this to the input method, if appropriate. */
2953 && ! NILP (Vinput_method_function
)
2954 /* Don't run the input method within a key sequence,
2955 after the first event of the key sequence. */
2956 && NILP (prev_event
)
2957 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2960 ptrdiff_t key_count
;
2961 bool key_count_reset
;
2962 struct gcpro gcpro1
;
2963 ptrdiff_t count
= SPECPDL_INDEX ();
2965 /* Save the echo status. */
2966 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2967 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2968 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2969 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2972 if (before_command_restore_flag
)
2974 this_command_key_count
= before_command_key_count_1
;
2975 if (this_command_key_count
< this_single_command_key_start
)
2976 this_single_command_key_start
= this_command_key_count
;
2977 echo_truncate (before_command_echo_length_1
);
2978 before_command_restore_flag
= 0;
2982 /* Save the this_command_keys status. */
2983 key_count
= this_command_key_count
;
2984 key_count_reset
= this_command_key_count_reset
;
2987 keys
= Fcopy_sequence (this_command_keys
);
2992 /* Clear out this_command_keys. */
2993 this_command_key_count
= 0;
2994 this_command_key_count_reset
= 0;
2996 /* Now wipe the echo area. */
2997 if (!NILP (echo_area_buffer
[0]))
2998 safe_run_hooks (Qecho_area_clear_hook
);
2999 clear_message (1, 0);
3002 /* If we are not reading a key sequence,
3003 never use the echo area. */
3006 specbind (Qinput_method_use_echo_area
, Qt
);
3009 /* Call the input method. */
3010 tem
= call1 (Vinput_method_function
, c
);
3012 tem
= unbind_to (count
, tem
);
3014 /* Restore the saved echoing state
3015 and this_command_keys state. */
3016 this_command_key_count
= key_count
;
3017 this_command_key_count_reset
= key_count_reset
;
3019 this_command_keys
= keys
;
3022 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3023 kset_echo_string (current_kboard
, saved_echo_string
);
3024 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3025 if (saved_immediate_echo
)
3030 /* The input method can return no events. */
3033 /* Bring back the previous message, if any. */
3034 if (! NILP (previous_echo_area_message
))
3035 message_with_string ("%s", previous_echo_area_message
, 0);
3038 /* It returned one event or more. */
3040 Vunread_post_input_method_events
3041 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3046 /* Display help if not echoing. */
3047 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3049 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3050 Lisp_Object help
, object
, position
, window
, htem
;
3052 htem
= Fcdr (XCDR (c
));
3055 window
= Fcar (htem
);
3057 object
= Fcar (htem
);
3059 position
= Fcar (htem
);
3061 show_help_echo (help
, window
, object
, position
);
3063 /* We stopped being idle for this event; undo that. */
3065 timer_resume_idle ();
3069 if ((! reread
|| this_command_key_count
== 0
3070 || this_command_key_count_reset
)
3074 /* Don't echo mouse motion events. */
3075 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3076 && NILP (Fzerop (Vecho_keystrokes
))
3077 && ! (EVENT_HAS_PARAMETERS (c
)
3078 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3081 if (! NILP (also_record
))
3082 echo_char (also_record
);
3083 /* Once we reread a character, echoing can happen
3084 the next time we pause to read a new one. */
3085 ok_to_echo_at_next_pause
= current_kboard
;
3088 /* Record this character as part of the current key. */
3089 add_command_key (c
);
3090 if (! NILP (also_record
))
3091 add_command_key (also_record
);
3094 last_input_event
= c
;
3097 /* Process the help character specially if enabled. */
3098 if (!NILP (Vhelp_form
) && help_char_p (c
))
3100 ptrdiff_t count
= SPECPDL_INDEX ();
3102 help_form_saved_window_configs
3103 = Fcons (Fcurrent_window_configuration (Qnil
),
3104 help_form_saved_window_configs
);
3105 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3106 call0 (Qhelp_form_show
);
3111 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3112 if (EVENT_HAS_PARAMETERS (c
)
3113 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3114 XSETCAR (help_form_saved_window_configs
, Qnil
);
3116 while (BUFFERP (c
));
3117 /* Remove the help from the frame. */
3118 unbind_to (count
, Qnil
);
3121 if (EQ (c
, make_number (040)))
3125 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3126 while (BUFFERP (c
));
3135 /* Record a key that came from a mouse menu.
3136 Record it for echoing, for this-command-keys, and so on. */
3139 record_menu_key (Lisp_Object c
)
3141 /* Wipe the echo area. */
3142 clear_message (1, 0);
3147 before_command_key_count
= this_command_key_count
;
3148 before_command_echo_length
= echo_length ();
3151 /* Don't echo mouse motion events. */
3152 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3153 && NILP (Fzerop (Vecho_keystrokes
)))
3157 /* Once we reread a character, echoing can happen
3158 the next time we pause to read a new one. */
3159 ok_to_echo_at_next_pause
= 0;
3162 /* Record this character as part of the current key. */
3163 add_command_key (c
);
3165 /* Re-reading in the middle of a command */
3166 last_input_event
= c
;
3170 /* Return true if should recognize C as "the help character". */
3173 help_char_p (Lisp_Object c
)
3177 if (EQ (c
, Vhelp_char
))
3179 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3180 if (EQ (c
, XCAR (tail
)))
3185 /* Record the input event C in various ways. */
3188 record_char (Lisp_Object c
)
3192 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3194 /* To avoid filling recent_keys with help-echo and mouse-movement
3195 events, we filter out repeated help-echo events, only store the
3196 first and last in a series of mouse-movement events, and don't
3197 store repeated help-echo events which are only separated by
3198 mouse-movement events. */
3200 Lisp_Object ev1
, ev2
, ev3
;
3203 if ((ix1
= recent_keys_index
- 1) < 0)
3204 ix1
= NUM_RECENT_KEYS
- 1;
3205 ev1
= AREF (recent_keys
, ix1
);
3207 if ((ix2
= ix1
- 1) < 0)
3208 ix2
= NUM_RECENT_KEYS
- 1;
3209 ev2
= AREF (recent_keys
, ix2
);
3211 if ((ix3
= ix2
- 1) < 0)
3212 ix3
= NUM_RECENT_KEYS
- 1;
3213 ev3
= AREF (recent_keys
, ix3
);
3215 if (EQ (XCAR (c
), Qhelp_echo
))
3217 /* Don't record `help-echo' in recent_keys unless it shows some help
3218 message, and a different help than the previously recorded
3220 Lisp_Object help
, last_help
;
3222 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3223 if (!STRINGP (help
))
3225 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3226 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3228 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3229 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3230 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3232 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3233 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3234 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3235 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3238 else if (EQ (XCAR (c
), Qmouse_movement
))
3240 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3241 So additional mouse movement events replace the last element. */
3242 Lisp_Object last_window
, window
;
3244 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3245 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3246 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3247 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3248 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3250 ASET (recent_keys
, ix1
, c
);
3256 store_kbd_macro_char (c
);
3260 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3261 ASET (recent_keys
, recent_keys_index
, c
);
3262 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3263 recent_keys_index
= 0;
3265 else if (recorded
< 0)
3267 /* We need to remove one or two events from recent_keys.
3268 To do this, we simply put nil at those events and move the
3269 recent_keys_index backwards over those events. Usually,
3270 users will never see those nil events, as they will be
3271 overwritten by the command keys entered to see recent_keys
3274 while (recorded
++ < 0 && total_keys
> 0)
3276 if (total_keys
< NUM_RECENT_KEYS
)
3278 if (--recent_keys_index
< 0)
3279 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3280 ASET (recent_keys
, recent_keys_index
, Qnil
);
3284 num_nonmacro_input_events
++;
3286 /* Write c to the dribble file. If c is a lispy event, write
3287 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3288 If you, dear reader, have a better idea, you've got the source. :-) */
3294 if (XUINT (c
) < 0x100)
3295 putc (XUINT (c
), dribble
);
3297 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3301 Lisp_Object dribblee
;
3303 /* If it's a structured event, take the event header. */
3304 dribblee
= EVENT_HEAD (c
);
3306 if (SYMBOLP (dribblee
))
3308 putc ('<', dribble
);
3309 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3310 SBYTES (SYMBOL_NAME (dribblee
)),
3312 putc ('>', dribble
);
3321 /* Copy out or in the info on where C-g should throw to.
3322 This is used when running Lisp code from within get_char,
3323 in case get_char is called recursively.
3324 See read_process_output. */
3327 save_getcjmp (sys_jmp_buf temp
)
3329 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3333 restore_getcjmp (sys_jmp_buf temp
)
3335 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3338 /* Low level keyboard/mouse input.
3339 kbd_buffer_store_event places events in kbd_buffer, and
3340 kbd_buffer_get_event retrieves them. */
3342 /* Return true if there are any events in the queue that read-char
3343 would return. If this returns false, a read-char would block. */
3345 readable_events (int flags
)
3347 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3350 /* If the buffer contains only FOCUS_IN_EVENT events, and
3351 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3352 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3354 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3355 #ifdef USE_TOOLKIT_SCROLL_BARS
3356 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3360 struct input_event
*event
;
3362 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3369 #ifdef USE_TOOLKIT_SCROLL_BARS
3370 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3372 event
->kind
== FOCUS_IN_EVENT
)
3373 #ifdef USE_TOOLKIT_SCROLL_BARS
3374 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3375 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3376 && event
->part
== scroll_bar_handle
3377 && event
->modifiers
== 0)
3382 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3385 while (event
!= kbd_store_ptr
);
3391 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3392 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3396 if (current_kboard
->kbd_queue_has_data
)
3402 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3403 if (kb
->kbd_queue_has_data
)
3409 /* Set this for debugging, to have a way to get out */
3410 int stop_character EXTERNALLY_VISIBLE
;
3413 event_to_kboard (struct input_event
*event
)
3415 /* Not applicable for these special events. */
3416 if (event
->kind
== SELECTION_REQUEST_EVENT
3417 || event
->kind
== SELECTION_CLEAR_EVENT
)
3421 Lisp_Object obj
= event
->frame_or_window
;
3422 /* There are some events that set this field to nil or string. */
3424 obj
= WINDOW_FRAME (XWINDOW (obj
));
3425 /* Also ignore dead frames here. */
3426 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3427 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3432 /* Return the number of slots occupied in kbd_buffer. */
3435 kbd_buffer_nr_stored (void)
3437 return kbd_fetch_ptr
== kbd_store_ptr
3439 : (kbd_fetch_ptr
< kbd_store_ptr
3440 ? kbd_store_ptr
- kbd_fetch_ptr
3441 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3442 + (kbd_store_ptr
- kbd_buffer
)));
3444 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3447 kbd_buffer_store_event (register struct input_event
*event
)
3449 kbd_buffer_store_event_hold (event
, 0);
3452 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3454 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3455 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3456 Else, if EVENT is a quit event, store the quit event
3457 in HOLD_QUIT, and return (thus ignoring further events).
3459 This is used to postpone the processing of the quit event until all
3460 subsequent input events have been parsed (and discarded). */
3463 kbd_buffer_store_event_hold (register struct input_event
*event
,
3464 struct input_event
*hold_quit
)
3466 if (event
->kind
== NO_EVENT
)
3469 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3472 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3474 register int c
= event
->code
& 0377;
3476 if (event
->modifiers
& ctrl_modifier
)
3477 c
= make_ctrl_char (c
);
3479 c
|= (event
->modifiers
3480 & (meta_modifier
| alt_modifier
3481 | hyper_modifier
| super_modifier
));
3485 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3486 struct input_event
*sp
;
3488 if (single_kboard
&& kb
!= current_kboard
)
3491 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3492 Fcons (make_number (c
), Qnil
)));
3493 kb
->kbd_queue_has_data
= 1;
3494 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3496 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3499 if (event_to_kboard (sp
) == kb
)
3501 sp
->kind
= NO_EVENT
;
3502 sp
->frame_or_window
= Qnil
;
3511 *hold_quit
= *event
;
3515 /* If this results in a quit_char being returned to Emacs as
3516 input, set Vlast_event_frame properly. If this doesn't
3517 get returned to Emacs as an event, the next event read
3518 will set Vlast_event_frame again, so this is safe to do. */
3522 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3524 focus
= event
->frame_or_window
;
3525 internal_last_event_frame
= focus
;
3526 Vlast_event_frame
= focus
;
3529 last_event_timestamp
= event
->timestamp
;
3531 handle_interrupt (0);
3535 if (c
&& c
== stop_character
)
3541 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3542 Just ignore the second one. */
3543 else if (event
->kind
== BUFFER_SWITCH_EVENT
3544 && kbd_fetch_ptr
!= kbd_store_ptr
3545 && ((kbd_store_ptr
== kbd_buffer
3546 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3547 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3550 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3551 kbd_store_ptr
= kbd_buffer
;
3553 /* Don't let the very last slot in the buffer become full,
3554 since that would make the two pointers equal,
3555 and that is indistinguishable from an empty buffer.
3556 Discard the event if it would fill the last slot. */
3557 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3559 *kbd_store_ptr
= *event
;
3562 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3564 /* Don't read keyboard input until we have processed kbd_buffer.
3565 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3566 hold_keyboard_input ();
3567 if (!noninteractive
)
3571 #endif /* subprocesses */
3574 /* If we're inside while-no-input, and this event qualifies
3575 as input, set quit-flag to cause an interrupt. */
3576 if (!NILP (Vthrow_on_input
)
3577 && event
->kind
!= FOCUS_IN_EVENT
3578 && event
->kind
!= HELP_EVENT
3579 && event
->kind
!= DEICONIFY_EVENT
)
3581 Vquit_flag
= Vthrow_on_input
;
3582 /* If we're inside a function that wants immediate quits,
3584 if (immediate_quit
&& NILP (Vinhibit_quit
))
3593 /* Put an input event back in the head of the event queue. */
3596 kbd_buffer_unget_event (register struct input_event
*event
)
3598 if (kbd_fetch_ptr
== kbd_buffer
)
3599 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3601 /* Don't let the very last slot in the buffer become full, */
3602 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3605 *kbd_fetch_ptr
= *event
;
3610 /* Generate a HELP_EVENT input_event and store it in the keyboard
3613 HELP is the help form.
3615 FRAME and WINDOW are the frame and window where the help is
3616 generated. OBJECT is the Lisp object where the help was found (a
3617 buffer, a string, an overlay, or nil if neither from a string nor
3618 from a buffer). POS is the position within OBJECT where the help
3622 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3623 Lisp_Object object
, ptrdiff_t pos
)
3625 struct input_event event
;
3629 event
.kind
= HELP_EVENT
;
3630 event
.frame_or_window
= frame
;
3632 event
.x
= WINDOWP (window
) ? window
: frame
;
3635 kbd_buffer_store_event (&event
);
3639 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3642 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3644 struct input_event event
;
3646 event
.kind
= HELP_EVENT
;
3647 event
.frame_or_window
= frame
;
3652 kbd_buffer_store_event (&event
);
3656 /* Discard any mouse events in the event buffer by setting them to
3659 discard_mouse_events (void)
3661 struct input_event
*sp
;
3662 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3664 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3667 if (sp
->kind
== MOUSE_CLICK_EVENT
3668 || sp
->kind
== WHEEL_EVENT
3669 || sp
->kind
== HORIZ_WHEEL_EVENT
3671 || sp
->kind
== GPM_CLICK_EVENT
3673 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3675 sp
->kind
= NO_EVENT
;
3681 /* Return true if there are any real events waiting in the event
3682 buffer, not counting `NO_EVENT's.
3684 Discard NO_EVENT events at the front of the input queue, possibly
3685 leaving the input queue empty if there are no real input events. */
3688 kbd_buffer_events_waiting (void)
3690 struct input_event
*sp
;
3692 for (sp
= kbd_fetch_ptr
;
3693 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3696 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3701 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3705 /* Clear input event EVENT. */
3708 clear_event (struct input_event
*event
)
3710 event
->kind
= NO_EVENT
;
3714 /* Read one event from the event buffer, waiting if necessary.
3715 The value is a Lisp object representing the event.
3716 The value is nil for an event that should be ignored,
3717 or that was handled here.
3718 We always read and discard one event. */
3721 kbd_buffer_get_event (KBOARD
**kbp
,
3722 bool *used_mouse_menu
,
3723 EMACS_TIME
*end_time
)
3728 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3730 /* Start reading input again because we have processed enough to
3731 be able to accept new events again. */
3732 unhold_keyboard_input ();
3735 #endif /* subprocesses */
3737 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3739 /* In case we are running as a daemon, only do this before
3740 detaching from the terminal. */
3741 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3745 *kbp
= current_kboard
;
3748 #endif /* ! HAVE_DBUS */
3750 /* Wait until there is input available. */
3753 /* Break loop if there's an unread command event. Needed in
3754 moused window autoselection which uses a timer to insert such
3756 if (CONSP (Vunread_command_events
))
3759 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3761 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3764 /* If the quit flag is set, then read_char will return
3765 quit_char, so that counts as "available input." */
3766 if (!NILP (Vquit_flag
))
3767 quit_throw_to_read_char (0);
3769 /* One way or another, wait until input is available; then, if
3770 interrupt handlers have not read it, read it now. */
3775 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3777 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3781 EMACS_TIME now
= current_emacs_time ();
3782 if (EMACS_TIME_LE (*end_time
, now
))
3783 return Qnil
; /* Finished waiting. */
3786 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3787 wait_reading_process_output (min (EMACS_SECS (duration
),
3789 EMACS_NSECS (duration
),
3790 -1, 1, Qnil
, NULL
, 0);
3794 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3796 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3800 if (CONSP (Vunread_command_events
))
3803 first
= XCAR (Vunread_command_events
);
3804 Vunread_command_events
= XCDR (Vunread_command_events
);
3805 *kbp
= current_kboard
;
3809 /* At this point, we know that there is a readable event available
3810 somewhere. If the event queue is empty, then there must be a
3811 mouse movement enabled and available. */
3812 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3814 struct input_event
*event
;
3816 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3820 last_event_timestamp
= event
->timestamp
;
3822 *kbp
= event_to_kboard (event
);
3824 *kbp
= current_kboard
; /* Better than returning null ptr? */
3828 /* These two kinds of events get special handling
3829 and don't actually appear to the command loop.
3830 We return nil for them. */
3831 if (event
->kind
== SELECTION_REQUEST_EVENT
3832 || event
->kind
== SELECTION_CLEAR_EVENT
)
3835 struct input_event copy
;
3837 /* Remove it from the buffer before processing it,
3838 since otherwise swallow_events will see it
3839 and process it again. */
3841 kbd_fetch_ptr
= event
+ 1;
3842 input_pending
= readable_events (0);
3843 x_handle_selection_event (©
);
3845 /* We're getting selection request events, but we don't have
3851 #if defined (HAVE_NS)
3852 else if (event
->kind
== NS_TEXT_EVENT
)
3854 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3855 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3857 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3858 kbd_fetch_ptr
= event
+ 1;
3859 if (used_mouse_menu
)
3860 *used_mouse_menu
= 1;
3864 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3865 || defined (HAVE_NS)
3866 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3868 /* Make an event (delete-frame (FRAME)). */
3869 obj
= Fcons (event
->frame_or_window
, Qnil
);
3870 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3871 kbd_fetch_ptr
= event
+ 1;
3874 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3875 || defined (HAVE_NS)
3876 else if (event
->kind
== ICONIFY_EVENT
)
3878 /* Make an event (iconify-frame (FRAME)). */
3879 obj
= Fcons (event
->frame_or_window
, Qnil
);
3880 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3881 kbd_fetch_ptr
= event
+ 1;
3883 else if (event
->kind
== DEICONIFY_EVENT
)
3885 /* Make an event (make-frame-visible (FRAME)). */
3886 obj
= Fcons (event
->frame_or_window
, Qnil
);
3887 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3888 kbd_fetch_ptr
= event
+ 1;
3891 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3893 /* The value doesn't matter here; only the type is tested. */
3894 XSETBUFFER (obj
, current_buffer
);
3895 kbd_fetch_ptr
= event
+ 1;
3897 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3898 || defined (HAVE_NS) || defined (USE_GTK)
3899 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3901 kbd_fetch_ptr
= event
+ 1;
3902 input_pending
= readable_events (0);
3903 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3904 x_activate_menubar (XFRAME (event
->frame_or_window
));
3908 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3910 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3911 obj
= Fcons (Qlanguage_change
,
3912 list3 (event
->frame_or_window
,
3913 make_number (event
->code
),
3914 make_number (event
->modifiers
)));
3915 kbd_fetch_ptr
= event
+ 1;
3919 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3921 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3922 obj
= Fcons (Qfile_w32notify
,
3923 list2 (list3 (make_number (event
->code
),
3926 event
->frame_or_window
));
3927 kbd_fetch_ptr
= event
+ 1;
3930 else if (event
->kind
== SAVE_SESSION_EVENT
)
3932 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3933 kbd_fetch_ptr
= event
+ 1;
3935 /* Just discard these, by returning nil.
3936 With MULTI_KBOARD, these events are used as placeholders
3937 when we need to randomly delete events from the queue.
3938 (They shouldn't otherwise be found in the buffer,
3939 but on some machines it appears they do show up
3940 even without MULTI_KBOARD.) */
3941 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3942 mouse events during a popup-menu call. */
3943 else if (event
->kind
== NO_EVENT
)
3944 kbd_fetch_ptr
= event
+ 1;
3945 else if (event
->kind
== HELP_EVENT
)
3947 Lisp_Object object
, position
, help
, frame
, window
;
3949 frame
= event
->frame_or_window
;
3950 object
= event
->arg
;
3951 position
= make_number (event
->code
);
3954 clear_event (event
);
3956 kbd_fetch_ptr
= event
+ 1;
3957 if (!WINDOWP (window
))
3959 obj
= Fcons (Qhelp_echo
,
3960 list5 (frame
, help
, window
, object
, position
));
3962 else if (event
->kind
== FOCUS_IN_EVENT
)
3964 /* Notification of a FocusIn event. The frame receiving the
3965 focus is in event->frame_or_window. Generate a
3966 switch-frame event if necessary. */
3967 Lisp_Object frame
, focus
;
3969 frame
= event
->frame_or_window
;
3970 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3974 if (!EQ (frame
, internal_last_event_frame
)
3975 && !EQ (frame
, selected_frame
))
3976 obj
= make_lispy_switch_frame (frame
);
3977 internal_last_event_frame
= frame
;
3978 kbd_fetch_ptr
= event
+ 1;
3981 else if (event
->kind
== DBUS_EVENT
)
3983 obj
= make_lispy_event (event
);
3984 kbd_fetch_ptr
= event
+ 1;
3988 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3990 obj
= make_lispy_event (event
);
3991 kbd_fetch_ptr
= event
+ 1;
3994 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3996 obj
= make_lispy_event (event
);
3997 kbd_fetch_ptr
= event
+ 1;
4001 /* If this event is on a different frame, return a switch-frame this
4002 time, and leave the event in the queue for next time. */
4006 frame
= event
->frame_or_window
;
4008 frame
= XCAR (frame
);
4009 else if (WINDOWP (frame
))
4010 frame
= WINDOW_FRAME (XWINDOW (frame
));
4012 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4016 if (! EQ (frame
, internal_last_event_frame
)
4017 && !EQ (frame
, selected_frame
))
4018 obj
= make_lispy_switch_frame (frame
);
4019 internal_last_event_frame
= frame
;
4021 /* If we didn't decide to make a switch-frame event, go ahead
4022 and build a real event from the queue entry. */
4026 obj
= make_lispy_event (event
);
4028 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4029 || defined (HAVE_NS) || defined (USE_GTK)
4030 /* If this was a menu selection, then set the flag to inhibit
4031 writing to last_nonmenu_event. Don't do this if the event
4032 we're returning is (menu-bar), though; that indicates the
4033 beginning of the menu sequence, and we might as well leave
4034 that as the `event with parameters' for this selection. */
4036 && !EQ (event
->frame_or_window
, event
->arg
)
4037 && (event
->kind
== MENU_BAR_EVENT
4038 || event
->kind
== TOOL_BAR_EVENT
))
4039 *used_mouse_menu
= 1;
4042 /* Certain system events are non-key events. */
4044 && event
->kind
== NS_NONKEY_EVENT
)
4045 *used_mouse_menu
= 1;
4048 /* Wipe out this event, to catch bugs. */
4049 clear_event (event
);
4050 kbd_fetch_ptr
= event
+ 1;
4054 /* Try generating a mouse motion event. */
4055 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4057 FRAME_PTR f
= some_mouse_moved ();
4058 Lisp_Object bar_window
;
4059 enum scroll_bar_part part
;
4063 *kbp
= current_kboard
;
4064 /* Note that this uses F to determine which terminal to look at.
4065 If there is no valid info, it does not store anything
4066 so x remains nil. */
4069 /* XXX Can f or mouse_position_hook be NULL here? */
4070 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4071 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4076 /* Decide if we should generate a switch-frame event. Don't
4077 generate switch-frame events for motion outside of all Emacs
4083 frame
= FRAME_FOCUS_FRAME (f
);
4085 XSETFRAME (frame
, f
);
4087 if (! EQ (frame
, internal_last_event_frame
)
4088 && !EQ (frame
, selected_frame
))
4089 obj
= make_lispy_switch_frame (frame
);
4090 internal_last_event_frame
= frame
;
4093 /* If we didn't decide to make a switch-frame event, go ahead and
4094 return a mouse-motion event. */
4095 if (!NILP (x
) && NILP (obj
))
4096 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4099 /* We were promised by the above while loop that there was
4100 something for us to read! */
4103 input_pending
= readable_events (0);
4105 Vlast_event_frame
= internal_last_event_frame
;
4110 /* Process any non-user-visible events (currently X selection events),
4111 without reading any user-visible events. */
4114 process_special_events (void)
4116 struct input_event
*event
;
4118 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4120 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4123 if (event
== kbd_store_ptr
)
4127 /* If we find a stored X selection request, handle it now. */
4128 if (event
->kind
== SELECTION_REQUEST_EVENT
4129 || event
->kind
== SELECTION_CLEAR_EVENT
)
4133 /* Remove the event from the fifo buffer before processing;
4134 otherwise swallow_events called recursively could see it
4135 and process it again. To do this, we move the events
4136 between kbd_fetch_ptr and EVENT one slot to the right,
4139 struct input_event copy
= *event
;
4140 struct input_event
*beg
4141 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4142 ? kbd_buffer
: kbd_fetch_ptr
;
4145 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4146 else if (event
< beg
)
4148 if (event
> kbd_buffer
)
4149 memmove (kbd_buffer
+ 1, kbd_buffer
,
4150 (event
- kbd_buffer
) * sizeof (struct input_event
));
4151 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4152 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4153 memmove (beg
+ 1, beg
,
4154 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4155 * sizeof (struct input_event
));
4158 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4159 kbd_fetch_ptr
= kbd_buffer
+ 1;
4163 /* X wants last_event_timestamp for selection ownership. */
4164 last_event_timestamp
= copy
.timestamp
;
4165 input_pending
= readable_events (0);
4166 x_handle_selection_event (©
);
4168 /* We're getting selection request events, but we don't have
4176 /* Process any events that are not user-visible, run timer events that
4177 are ripe, and return, without reading any user-visible events. */
4180 swallow_events (bool do_display
)
4182 unsigned old_timers_run
;
4184 process_special_events ();
4186 old_timers_run
= timers_run
;
4187 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4189 if (timers_run
!= old_timers_run
&& do_display
)
4190 redisplay_preserve_echo_area (7);
4193 /* Record the start of when Emacs is idle,
4194 for the sake of running idle-time timers. */
4197 timer_start_idle (void)
4201 /* If we are already in the idle state, do nothing. */
4202 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4205 timer_idleness_start_time
= current_emacs_time ();
4206 timer_last_idleness_start_time
= timer_idleness_start_time
;
4208 /* Mark all idle-time timers as once again candidates for running. */
4209 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4213 timer
= XCAR (timers
);
4215 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4217 ASET (timer
, 0, Qnil
);
4221 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4224 timer_stop_idle (void)
4226 timer_idleness_start_time
= invalid_emacs_time ();
4229 /* Resume idle timer from last idle start time. */
4232 timer_resume_idle (void)
4234 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4237 timer_idleness_start_time
= timer_last_idleness_start_time
;
4240 /* This is only for debugging. */
4241 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4243 /* List of elisp functions to call, delayed because they were generated in
4244 a context where Elisp could not be safely run (e.g. redisplay, signal,
4245 ...). Each element has the form (FUN . ARGS). */
4246 Lisp_Object pending_funcalls
;
4248 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4250 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4252 Lisp_Object
*vector
;
4254 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4256 vector
= XVECTOR (timer
)->contents
;
4257 if (! NILP (vector
[0]))
4260 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4265 /* Check whether a timer has fired. To prevent larger problems we simply
4266 disregard elements that are not proper timers. Do not make a circular
4267 timer list for the time being.
4269 Returns the time to wait until the next timer fires. If a
4270 timer is triggering now, return zero.
4271 If no timer is active, return -1.
4273 If a timer is ripe, we run it, with quitting turned off.
4274 In that case we return 0 to indicate that a new timer_check_2 call
4278 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4280 EMACS_TIME nexttime
;
4282 EMACS_TIME idleness_now
;
4283 Lisp_Object chosen_timer
;
4284 struct gcpro gcpro1
;
4286 nexttime
= invalid_emacs_time ();
4288 chosen_timer
= Qnil
;
4289 GCPRO1 (chosen_timer
);
4291 /* First run the code that was delayed. */
4292 while (CONSP (pending_funcalls
))
4294 Lisp_Object funcall
= XCAR (pending_funcalls
);
4295 pending_funcalls
= XCDR (pending_funcalls
);
4296 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4299 if (CONSP (timers
) || CONSP (idle_timers
))
4301 now
= current_emacs_time ();
4302 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4303 ? sub_emacs_time (now
, timer_idleness_start_time
)
4304 : make_emacs_time (0, 0));
4307 while (CONSP (timers
) || CONSP (idle_timers
))
4309 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4310 EMACS_TIME timer_time
, idle_timer_time
;
4311 EMACS_TIME difference
;
4312 EMACS_TIME timer_difference
= invalid_emacs_time ();
4313 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4314 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4316 /* Set TIMER and TIMER_DIFFERENCE
4317 based on the next ordinary timer.
4318 TIMER_DIFFERENCE is the distance in time from NOW to when
4319 this timer becomes ripe (negative if it's already ripe).
4320 Skip past invalid timers and timers already handled. */
4323 timer
= XCAR (timers
);
4324 if (! decode_timer (timer
, &timer_time
))
4326 timers
= XCDR (timers
);
4330 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4331 timer_difference
= (timer_ripe
4332 ? sub_emacs_time (now
, timer_time
)
4333 : sub_emacs_time (timer_time
, now
));
4336 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4337 based on the next idle timer. */
4338 if (CONSP (idle_timers
))
4340 idle_timer
= XCAR (idle_timers
);
4341 if (! decode_timer (idle_timer
, &idle_timer_time
))
4343 idle_timers
= XCDR (idle_timers
);
4347 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4348 idle_timer_difference
=
4350 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4351 : sub_emacs_time (idle_timer_time
, idleness_now
));
4354 /* Decide which timer is the next timer,
4355 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4356 Also step down the list where we found that timer. */
4358 if (EMACS_TIME_VALID_P (timer_difference
)
4359 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4360 || idle_timer_ripe
< timer_ripe
4361 || (idle_timer_ripe
== timer_ripe
4363 ? EMACS_TIME_LT (idle_timer_difference
,
4365 : EMACS_TIME_LT (timer_difference
,
4366 idle_timer_difference
)))))
4368 chosen_timer
= timer
;
4369 timers
= XCDR (timers
);
4370 difference
= timer_difference
;
4375 chosen_timer
= idle_timer
;
4376 idle_timers
= XCDR (idle_timers
);
4377 difference
= idle_timer_difference
;
4378 ripe
= idle_timer_ripe
;
4381 /* If timer is ripe, run it if it hasn't been run. */
4384 if (NILP (AREF (chosen_timer
, 0)))
4386 ptrdiff_t count
= SPECPDL_INDEX ();
4387 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4389 /* Mark the timer as triggered to prevent problems if the lisp
4390 code fails to reschedule it right. */
4391 ASET (chosen_timer
, 0, Qt
);
4393 specbind (Qinhibit_quit
, Qt
);
4395 call1 (Qtimer_event_handler
, chosen_timer
);
4396 Vdeactivate_mark
= old_deactivate_mark
;
4398 unbind_to (count
, Qnil
);
4400 /* Since we have handled the event,
4401 we don't need to tell the caller to wake up and do it. */
4402 /* But the caller must still wait for the next timer, so
4403 return 0 to indicate that. */
4406 nexttime
= make_emacs_time (0, 0);
4410 /* When we encounter a timer that is still waiting,
4411 return the amount of time to wait before it is ripe. */
4418 /* No timers are pending in the future. */
4419 /* Return 0 if we generated an event, and -1 if not. */
4425 /* Check whether a timer has fired. To prevent larger problems we simply
4426 disregard elements that are not proper timers. Do not make a circular
4427 timer list for the time being.
4429 Returns the time to wait until the next timer fires.
4430 If no timer is active, return an invalid value.
4432 As long as any timer is ripe, we run it. */
4437 EMACS_TIME nexttime
;
4438 Lisp_Object timers
, idle_timers
;
4439 struct gcpro gcpro1
, gcpro2
;
4441 Lisp_Object tem
= Vinhibit_quit
;
4444 /* We use copies of the timers' lists to allow a timer to add itself
4445 again, without locking up Emacs if the newly added timer is
4446 already ripe when added. */
4448 /* Always consider the ordinary timers. */
4449 timers
= Fcopy_sequence (Vtimer_list
);
4450 /* Consider the idle timers only if Emacs is idle. */
4451 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4452 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4456 Vinhibit_quit
= tem
;
4458 GCPRO2 (timers
, idle_timers
);
4462 nexttime
= timer_check_2 (timers
, idle_timers
);
4464 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4470 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4471 doc
: /* Return the current length of Emacs idleness, or nil.
4472 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4473 in the same style as (current-time).
4475 The value when Emacs is not idle is nil.
4477 PSEC is a multiple of the system clock resolution. */)
4480 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4481 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4482 timer_idleness_start_time
));
4487 /* Caches for modify_event_symbol. */
4488 static Lisp_Object accent_key_syms
;
4489 static Lisp_Object func_key_syms
;
4490 static Lisp_Object mouse_syms
;
4491 static Lisp_Object wheel_syms
;
4492 static Lisp_Object drag_n_drop_syms
;
4494 /* This is a list of keysym codes for special "accent" characters.
4495 It parallels lispy_accent_keys. */
4497 static const int lispy_accent_codes
[] =
4499 #ifdef XK_dead_circumflex
4504 #ifdef XK_dead_grave
4509 #ifdef XK_dead_tilde
4514 #ifdef XK_dead_diaeresis
4519 #ifdef XK_dead_macron
4524 #ifdef XK_dead_degree
4529 #ifdef XK_dead_acute
4534 #ifdef XK_dead_cedilla
4539 #ifdef XK_dead_breve
4544 #ifdef XK_dead_ogonek
4549 #ifdef XK_dead_caron
4554 #ifdef XK_dead_doubleacute
4555 XK_dead_doubleacute
,
4559 #ifdef XK_dead_abovedot
4564 #ifdef XK_dead_abovering
4574 #ifdef XK_dead_belowdot
4579 #ifdef XK_dead_voiced_sound
4580 XK_dead_voiced_sound
,
4584 #ifdef XK_dead_semivoiced_sound
4585 XK_dead_semivoiced_sound
,
4601 /* This is a list of Lisp names for special "accent" characters.
4602 It parallels lispy_accent_codes. */
4604 static const char *const lispy_accent_keys
[] =
4622 "dead-voiced-sound",
4623 "dead-semivoiced-sound",
4629 #define FUNCTION_KEY_OFFSET 0x0
4631 const char *const lispy_function_keys
[] =
4635 0, /* VK_LBUTTON 0x01 */
4636 0, /* VK_RBUTTON 0x02 */
4637 "cancel", /* VK_CANCEL 0x03 */
4638 0, /* VK_MBUTTON 0x04 */
4640 0, 0, 0, /* 0x05 .. 0x07 */
4642 "backspace", /* VK_BACK 0x08 */
4643 "tab", /* VK_TAB 0x09 */
4645 0, 0, /* 0x0A .. 0x0B */
4647 "clear", /* VK_CLEAR 0x0C */
4648 "return", /* VK_RETURN 0x0D */
4650 0, 0, /* 0x0E .. 0x0F */
4652 0, /* VK_SHIFT 0x10 */
4653 0, /* VK_CONTROL 0x11 */
4654 0, /* VK_MENU 0x12 */
4655 "pause", /* VK_PAUSE 0x13 */
4656 "capslock", /* VK_CAPITAL 0x14 */
4657 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4659 "junja", /* VK_JUNJA 0x17 */
4660 "final", /* VK_FINAL 0x18 */
4661 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4663 "escape", /* VK_ESCAPE 0x1B */
4664 "convert", /* VK_CONVERT 0x1C */
4665 "non-convert", /* VK_NONCONVERT 0x1D */
4666 "accept", /* VK_ACCEPT 0x1E */
4667 "mode-change", /* VK_MODECHANGE 0x1F */
4668 0, /* VK_SPACE 0x20 */
4669 "prior", /* VK_PRIOR 0x21 */
4670 "next", /* VK_NEXT 0x22 */
4671 "end", /* VK_END 0x23 */
4672 "home", /* VK_HOME 0x24 */
4673 "left", /* VK_LEFT 0x25 */
4674 "up", /* VK_UP 0x26 */
4675 "right", /* VK_RIGHT 0x27 */
4676 "down", /* VK_DOWN 0x28 */
4677 "select", /* VK_SELECT 0x29 */
4678 "print", /* VK_PRINT 0x2A */
4679 "execute", /* VK_EXECUTE 0x2B */
4680 "snapshot", /* VK_SNAPSHOT 0x2C */
4681 "insert", /* VK_INSERT 0x2D */
4682 "delete", /* VK_DELETE 0x2E */
4683 "help", /* VK_HELP 0x2F */
4685 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4687 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4689 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4691 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4693 0, 0, 0, 0, 0, 0, 0, 0, 0,
4694 0, 0, 0, 0, 0, 0, 0, 0, 0,
4695 0, 0, 0, 0, 0, 0, 0, 0,
4697 "lwindow", /* VK_LWIN 0x5B */
4698 "rwindow", /* VK_RWIN 0x5C */
4699 "apps", /* VK_APPS 0x5D */
4702 "kp-0", /* VK_NUMPAD0 0x60 */
4703 "kp-1", /* VK_NUMPAD1 0x61 */
4704 "kp-2", /* VK_NUMPAD2 0x62 */
4705 "kp-3", /* VK_NUMPAD3 0x63 */
4706 "kp-4", /* VK_NUMPAD4 0x64 */
4707 "kp-5", /* VK_NUMPAD5 0x65 */
4708 "kp-6", /* VK_NUMPAD6 0x66 */
4709 "kp-7", /* VK_NUMPAD7 0x67 */
4710 "kp-8", /* VK_NUMPAD8 0x68 */
4711 "kp-9", /* VK_NUMPAD9 0x69 */
4712 "kp-multiply", /* VK_MULTIPLY 0x6A */
4713 "kp-add", /* VK_ADD 0x6B */
4714 "kp-separator", /* VK_SEPARATOR 0x6C */
4715 "kp-subtract", /* VK_SUBTRACT 0x6D */
4716 "kp-decimal", /* VK_DECIMAL 0x6E */
4717 "kp-divide", /* VK_DIVIDE 0x6F */
4718 "f1", /* VK_F1 0x70 */
4719 "f2", /* VK_F2 0x71 */
4720 "f3", /* VK_F3 0x72 */
4721 "f4", /* VK_F4 0x73 */
4722 "f5", /* VK_F5 0x74 */
4723 "f6", /* VK_F6 0x75 */
4724 "f7", /* VK_F7 0x76 */
4725 "f8", /* VK_F8 0x77 */
4726 "f9", /* VK_F9 0x78 */
4727 "f10", /* VK_F10 0x79 */
4728 "f11", /* VK_F11 0x7A */
4729 "f12", /* VK_F12 0x7B */
4730 "f13", /* VK_F13 0x7C */
4731 "f14", /* VK_F14 0x7D */
4732 "f15", /* VK_F15 0x7E */
4733 "f16", /* VK_F16 0x7F */
4734 "f17", /* VK_F17 0x80 */
4735 "f18", /* VK_F18 0x81 */
4736 "f19", /* VK_F19 0x82 */
4737 "f20", /* VK_F20 0x83 */
4738 "f21", /* VK_F21 0x84 */
4739 "f22", /* VK_F22 0x85 */
4740 "f23", /* VK_F23 0x86 */
4741 "f24", /* VK_F24 0x87 */
4743 0, 0, 0, 0, /* 0x88 .. 0x8B */
4744 0, 0, 0, 0, /* 0x8C .. 0x8F */
4746 "kp-numlock", /* VK_NUMLOCK 0x90 */
4747 "scroll", /* VK_SCROLL 0x91 */
4748 /* Not sure where the following block comes from.
4749 Windows headers have NEC and Fujitsu specific keys in
4750 this block, but nothing generic. */
4751 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4752 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4753 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4754 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4755 "kp-end", /* VK_NUMPAD_END 0x96 */
4756 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4757 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4758 "kp-up", /* VK_NUMPAD_UP 0x99 */
4759 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4760 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4761 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4762 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4764 0, 0, /* 0x9E .. 0x9F */
4767 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4768 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4769 * No other API or message will distinguish left and right keys this way.
4774 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4775 to enable them selectively, and gives access to a few more functions.
4776 See lispy_multimedia_keys below. */
4777 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4778 0, 0, 0, /* 0xAD .. 0xAF Volume */
4779 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4780 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4782 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4783 0, 0, 0, 0, 0, 0, 0, 0, 0,
4785 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4786 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4787 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4790 "ax", /* VK_OEM_AX 0xE1 */
4791 0, /* VK_OEM_102 0xE2 */
4792 "ico-help", /* VK_ICO_HELP 0xE3 */
4793 "ico-00", /* VK_ICO_00 0xE4 */
4794 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4795 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4796 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4798 "reset", /* VK_OEM_RESET 0xE9 */
4799 "jump", /* VK_OEM_JUMP 0xEA */
4800 "oem-pa1", /* VK_OEM_PA1 0xEB */
4801 "oem-pa2", /* VK_OEM_PA2 0xEC */
4802 "oem-pa3", /* VK_OEM_PA3 0xED */
4803 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4804 "cusel", /* VK_OEM_CUSEL 0xEF */
4805 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4806 "finish", /* VK_OEM_FINISH 0xF1 */
4807 "copy", /* VK_OEM_COPY 0xF2 */
4808 "auto", /* VK_OEM_AUTO 0xF3 */
4809 "enlw", /* VK_OEM_ENLW 0xF4 */
4810 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4811 "attn", /* VK_ATTN 0xF6 */
4812 "crsel", /* VK_CRSEL 0xF7 */
4813 "exsel", /* VK_EXSEL 0xF8 */
4814 "ereof", /* VK_EREOF 0xF9 */
4815 "play", /* VK_PLAY 0xFA */
4816 "zoom", /* VK_ZOOM 0xFB */
4817 "noname", /* VK_NONAME 0xFC */
4818 "pa1", /* VK_PA1 0xFD */
4819 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4823 /* Some of these duplicate the "Media keys" on newer keyboards,
4824 but they are delivered to the application in a different way. */
4825 static const char *const lispy_multimedia_keys
[] =
4833 "browser-favorites",
4870 "toggle-dictate-command",
4876 "media-fast-forward",
4879 "media-channel-down"
4882 #else /* not HAVE_NTGUI */
4884 /* This should be dealt with in XTread_socket now, and that doesn't
4885 depend on the client system having the Kana syms defined. See also
4886 the XK_kana_A case below. */
4889 static const char *const lispy_kana_keys
[] =
4891 /* X Keysym value */
4892 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4893 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4894 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4895 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4896 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4897 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4898 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4899 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4900 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4901 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4902 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4903 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4904 "kana-i", "kana-u", "kana-e", "kana-o",
4905 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4906 "prolongedsound", "kana-A", "kana-I", "kana-U",
4907 "kana-E", "kana-O", "kana-KA", "kana-KI",
4908 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4909 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4910 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4911 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4912 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4913 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4914 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4915 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4916 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4917 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4918 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4919 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4921 #endif /* XK_kana_A */
4924 #define FUNCTION_KEY_OFFSET 0xff00
4926 /* You'll notice that this table is arranged to be conveniently
4927 indexed by X Windows keysym values. */
4928 static const char *const lispy_function_keys
[] =
4930 /* X Keysym value */
4932 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4933 "backspace", "tab", "linefeed", "clear",
4935 0, 0, 0, "pause", /* 0xff10...1f */
4936 0, 0, 0, 0, 0, 0, 0, "escape",
4938 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4939 "romaji", "hiragana", "katakana", "hiragana-katakana",
4940 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4941 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4942 "eisu-toggle", /* 0xff30...3f */
4943 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4944 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4946 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4947 "down", "prior", "next", "end",
4948 "begin", 0, 0, 0, 0, 0, 0, 0,
4949 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4960 "break", /* 0xff6b */
4963 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4964 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4965 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4966 0, 0, 0, 0, 0, 0, 0, 0,
4967 "kp-tab", /* 0xff89 */
4969 "kp-enter", /* 0xff8d */
4971 "kp-f1", /* 0xff91 */
4975 "kp-home", /* 0xff95 */
4980 "kp-prior", /* kp-page-up */
4981 "kp-next", /* kp-page-down */
4987 0, 0, 0, 0, 0, 0, 0, 0, 0,
4988 "kp-multiply", /* 0xffaa */
4993 "kp-divide", /* 0xffaf */
4994 "kp-0", /* 0xffb0 */
4995 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4998 "kp-equal", /* 0xffbd */
4999 "f1", /* 0xffbe */ /* IsFunctionKey */
5001 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5002 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5003 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5004 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5005 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5006 0, 0, 0, 0, 0, 0, 0, 0,
5007 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5008 0, 0, 0, 0, 0, 0, 0, "delete"
5011 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5012 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5014 static const char *const iso_lispy_function_keys
[] =
5016 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5017 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5018 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5019 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5020 "iso-lefttab", /* 0xfe20 */
5021 "iso-move-line-up", "iso-move-line-down",
5022 "iso-partial-line-up", "iso-partial-line-down",
5023 "iso-partial-space-left", "iso-partial-space-right",
5024 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5025 "iso-release-margin-left", "iso-release-margin-right",
5026 "iso-release-both-margins",
5027 "iso-fast-cursor-left", "iso-fast-cursor-right",
5028 "iso-fast-cursor-up", "iso-fast-cursor-down",
5029 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5030 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5033 #endif /* not HAVE_NTGUI */
5035 static Lisp_Object Vlispy_mouse_stem
;
5037 static const char *const lispy_wheel_names
[] =
5039 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5042 /* drag-n-drop events are generated when a set of selected files are
5043 dragged from another application and dropped onto an Emacs window. */
5044 static const char *const lispy_drag_n_drop_names
[] =
5049 /* Scroll bar parts. */
5050 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5051 Lisp_Object Qup
, Qdown
, Qbottom
;
5052 static Lisp_Object Qend_scroll
;
5054 static Lisp_Object Qratio
;
5056 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5057 static Lisp_Object
*const scroll_bar_parts
[] = {
5058 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5059 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5062 /* A vector, indexed by button number, giving the down-going location
5063 of currently depressed buttons, both scroll bar and non-scroll bar.
5065 The elements have the form
5066 (BUTTON-NUMBER MODIFIER-MASK . REST)
5067 where REST is the cdr of a position as it would be reported in the event.
5069 The make_lispy_event function stores positions here to tell the
5070 difference between click and drag events, and to store the starting
5071 location to be included in drag events. */
5073 static Lisp_Object button_down_location
;
5075 /* Information about the most recent up-going button event: Which
5076 button, what location, and what time. */
5078 static int last_mouse_button
;
5079 static int last_mouse_x
;
5080 static int last_mouse_y
;
5081 static Time button_down_time
;
5083 /* The number of clicks in this multiple-click. */
5085 static int double_click_count
;
5087 /* X and Y are frame-relative coordinates for a click or wheel event.
5088 Return a Lisp-style event list. */
5091 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5094 enum window_part part
;
5095 Lisp_Object posn
= Qnil
;
5096 Lisp_Object extra_info
= Qnil
;
5097 /* Coordinate pixel positions to return. */
5098 int xret
= 0, yret
= 0;
5099 /* The window under frame pixel coordinates (x,y) */
5100 Lisp_Object window
= f
5101 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5104 if (WINDOWP (window
))
5106 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5107 struct window
*w
= XWINDOW (window
);
5108 Lisp_Object string_info
= Qnil
;
5109 ptrdiff_t textpos
= -1;
5110 int col
= -1, row
= -1;
5111 int dx
= -1, dy
= -1;
5112 int width
= -1, height
= -1;
5113 Lisp_Object object
= Qnil
;
5115 /* Pixel coordinates relative to the window corner. */
5116 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5117 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5119 /* For text area clicks, return X, Y relative to the corner of
5120 this text area. Note that dX, dY etc are set below, by
5121 buffer_posn_from_coords. */
5122 if (part
== ON_TEXT
)
5124 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5125 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5127 /* For mode line and header line clicks, return X, Y relative to
5128 the left window edge. Use mode_line_string to look for a
5129 string on the click position. */
5130 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5135 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5136 /* Note that mode_line_string takes COL, ROW as pixels and
5137 converts them to characters. */
5140 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5141 &object
, &dx
, &dy
, &width
, &height
);
5142 if (STRINGP (string
))
5143 string_info
= Fcons (string
, make_number (charpos
));
5144 textpos
= (w
== XWINDOW (selected_window
)
5145 && current_buffer
== XBUFFER (w
->buffer
))
5146 ? PT
: marker_position (w
->pointm
);
5151 /* For fringes and margins, Y is relative to the area's (and the
5152 window's) top edge, while X is meaningless. */
5153 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5158 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5161 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5162 &object
, &dx
, &dy
, &width
, &height
);
5163 if (STRINGP (string
))
5164 string_info
= Fcons (string
, make_number (charpos
));
5165 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5167 else if (part
== ON_LEFT_FRINGE
)
5169 posn
= Qleft_fringe
;
5172 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5173 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5174 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5176 else if (part
== ON_RIGHT_FRINGE
)
5178 posn
= Qright_fringe
;
5181 - window_box_width (w
, LEFT_MARGIN_AREA
)
5182 - window_box_width (w
, TEXT_AREA
)
5183 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5184 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5186 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5188 else if (part
== ON_VERTICAL_BORDER
)
5190 posn
= Qvertical_line
;
5195 /* Nothing special for part == ON_SCROLL_BAR. */
5197 /* For clicks in the text area, fringes, or margins, call
5198 buffer_posn_from_coords to extract TEXTPOS, the buffer
5199 position nearest to the click. */
5202 Lisp_Object string2
, object2
= Qnil
;
5203 struct display_pos p
;
5205 int width2
, height2
;
5206 /* The pixel X coordinate passed to buffer_posn_from_coords
5207 is the X coordinate relative to the text area for
5208 text-area and right-margin clicks, zero otherwise. */
5210 = (part
== ON_TEXT
) ? xret
5211 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5212 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5216 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5217 &object2
, &dx2
, &dy2
,
5219 textpos
= CHARPOS (p
.pos
);
5220 if (col
< 0) col
= x2
;
5221 if (row
< 0) row
= y2
;
5222 if (dx
< 0) dx
= dx2
;
5223 if (dy
< 0) dy
= dy2
;
5224 if (width
< 0) width
= width2
;
5225 if (height
< 0) height
= height2
;
5229 posn
= make_number (textpos
);
5230 if (STRINGP (string2
))
5231 string_info
= Fcons (string2
,
5232 make_number (CHARPOS (p
.string_pos
)));
5238 #ifdef HAVE_WINDOW_SYSTEM
5239 if (IMAGEP (object
))
5241 Lisp_Object image_map
, hotspot
;
5242 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5244 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5246 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5247 posn
= XCAR (hotspot
);
5254 Fcons (make_number (dx
), make_number (dy
)),
5255 Fcons (make_number (width
), make_number (height
)));
5258 extra_info
= Fcons (string_info
,
5259 Fcons (make_number (textpos
),
5260 Fcons (Fcons (make_number (col
),
5265 XSETFRAME (window
, f
);
5269 return Fcons (window
,
5271 Fcons (Fcons (make_number (xret
),
5272 make_number (yret
)),
5273 Fcons (make_number (t
),
5277 /* Given a struct input_event, build the lisp event which represents
5278 it. If EVENT is 0, build a mouse movement event from the mouse
5279 movement buffer, which should have a movement event in it.
5281 Note that events must be passed to this function in the order they
5282 are received; this function stores the location of button presses
5283 in order to build drag events when the button is released. */
5286 make_lispy_event (struct input_event
*event
)
5290 switch (event
->kind
)
5292 /* A simple keystroke. */
5293 case ASCII_KEYSTROKE_EVENT
:
5294 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5296 Lisp_Object lispy_c
;
5297 EMACS_INT c
= event
->code
;
5298 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5301 eassert (c
== event
->code
);
5302 /* Turn ASCII characters into control characters
5304 if (event
->modifiers
& ctrl_modifier
)
5306 c
= make_ctrl_char (c
);
5307 event
->modifiers
&= ~ctrl_modifier
;
5311 /* Add in the other modifier bits. The shift key was taken care
5312 of by the X code. */
5313 c
|= (event
->modifiers
5314 & (meta_modifier
| alt_modifier
5315 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5316 /* Distinguish Shift-SPC from SPC. */
5317 if ((event
->code
) == 040
5318 && event
->modifiers
& shift_modifier
)
5319 c
|= shift_modifier
;
5320 button_down_time
= 0;
5321 XSETFASTINT (lispy_c
, c
);
5326 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5327 except that they are non-key events (last-nonmenu-event is nil). */
5328 case NS_NONKEY_EVENT
:
5331 /* A function key. The symbol may need to have modifier prefixes
5333 case NON_ASCII_KEYSTROKE_EVENT
:
5334 button_down_time
= 0;
5336 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5337 if (event
->code
== lispy_accent_codes
[i
])
5338 return modify_event_symbol (i
,
5340 Qfunction_key
, Qnil
,
5341 lispy_accent_keys
, &accent_key_syms
,
5342 (sizeof (lispy_accent_keys
)
5343 / sizeof (lispy_accent_keys
[0])));
5347 if (event
->code
>= 0x400 && event
->code
< 0x500)
5348 return modify_event_symbol (event
->code
- 0x400,
5349 event
->modifiers
& ~shift_modifier
,
5350 Qfunction_key
, Qnil
,
5351 lispy_kana_keys
, &func_key_syms
,
5352 (sizeof (lispy_kana_keys
)
5353 / sizeof (lispy_kana_keys
[0])));
5354 #endif /* XK_kana_A */
5357 #ifdef ISO_FUNCTION_KEY_OFFSET
5358 if (event
->code
< FUNCTION_KEY_OFFSET
5359 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5360 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5362 Qfunction_key
, Qnil
,
5363 iso_lispy_function_keys
, &func_key_syms
,
5364 (sizeof (iso_lispy_function_keys
)
5365 / sizeof (iso_lispy_function_keys
[0])));
5368 /* Handle system-specific or unknown keysyms. */
5369 if (event
->code
& (1 << 28)
5370 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5371 || (event
->code
- FUNCTION_KEY_OFFSET
5372 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5373 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5375 /* We need to use an alist rather than a vector as the cache
5376 since we can't make a vector long enough. */
5377 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5378 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5379 return modify_event_symbol (event
->code
,
5382 KVAR (current_kboard
, Vsystem_key_alist
),
5383 0, &KVAR (current_kboard
, system_key_syms
),
5387 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5389 Qfunction_key
, Qnil
,
5390 lispy_function_keys
, &func_key_syms
,
5391 (sizeof (lispy_function_keys
)
5392 / sizeof (lispy_function_keys
[0])));
5395 case MULTIMEDIA_KEY_EVENT
:
5396 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5397 / sizeof (lispy_multimedia_keys
[0]))
5398 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5400 return modify_event_symbol (event
->code
, event
->modifiers
,
5401 Qfunction_key
, Qnil
,
5402 lispy_multimedia_keys
, &func_key_syms
,
5403 (sizeof (lispy_multimedia_keys
)
5404 / sizeof (lispy_multimedia_keys
[0])));
5409 /* A mouse click. Figure out where it is, decide whether it's
5410 a press, click or drag, and build the appropriate structure. */
5411 case MOUSE_CLICK_EVENT
:
5412 #ifndef USE_TOOLKIT_SCROLL_BARS
5413 case SCROLL_BAR_CLICK_EVENT
:
5416 int button
= event
->code
;
5418 Lisp_Object position
;
5419 Lisp_Object
*start_pos_ptr
;
5420 Lisp_Object start_pos
;
5424 /* Build the position as appropriate for this mouse click. */
5425 if (event
->kind
== MOUSE_CLICK_EVENT
)
5427 struct frame
*f
= XFRAME (event
->frame_or_window
);
5428 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5432 /* Ignore mouse events that were made on frame that
5433 have been deleted. */
5434 if (! FRAME_LIVE_P (f
))
5437 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5438 /* EVENT->x and EVENT->y are frame-relative pixel
5439 coordinates at this place. Under old redisplay, COLUMN
5440 and ROW are set to frame relative glyph coordinates
5441 which are then used to determine whether this click is
5442 in a menu (non-toolkit version). */
5443 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5444 &column
, &row
, NULL
, 1);
5446 /* In the non-toolkit version, clicks on the menu bar
5447 are ordinary button events in the event buffer.
5448 Distinguish them, and invoke the menu.
5450 (In the toolkit version, the toolkit handles the menu bar
5451 and Emacs doesn't know about it until after the user
5452 makes a selection.) */
5453 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5454 && (event
->modifiers
& down_modifier
))
5456 Lisp_Object items
, item
;
5458 /* Find the menu bar item under `column'. */
5460 items
= FRAME_MENU_BAR_ITEMS (f
);
5461 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5463 Lisp_Object pos
, string
;
5464 string
= AREF (items
, i
+ 1);
5465 pos
= AREF (items
, i
+ 3);
5468 if (column
>= XINT (pos
)
5469 && column
< XINT (pos
) + SCHARS (string
))
5471 item
= AREF (items
, i
);
5476 /* ELisp manual 2.4b says (x y) are window relative but
5477 code says they are frame-relative. */
5479 = Fcons (event
->frame_or_window
,
5481 Fcons (Fcons (event
->x
, event
->y
),
5482 Fcons (make_number (event
->timestamp
),
5485 return Fcons (item
, Fcons (position
, Qnil
));
5487 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5489 position
= make_lispy_position (f
, event
->x
, event
->y
,
5492 #ifndef USE_TOOLKIT_SCROLL_BARS
5495 /* It's a scrollbar click. */
5497 Lisp_Object portion_whole
;
5500 window
= event
->frame_or_window
;
5501 portion_whole
= Fcons (event
->x
, event
->y
);
5502 part
= *scroll_bar_parts
[(int) event
->part
];
5506 Fcons (Qvertical_scroll_bar
,
5507 Fcons (portion_whole
,
5508 Fcons (make_number (event
->timestamp
),
5509 Fcons (part
, Qnil
)))));
5511 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5513 if (button
>= ASIZE (button_down_location
))
5515 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5516 button_down_location
= larger_vector (button_down_location
,
5518 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5521 start_pos_ptr
= aref_addr (button_down_location
, button
);
5522 start_pos
= *start_pos_ptr
;
5523 *start_pos_ptr
= Qnil
;
5526 /* On window-system frames, use the value of
5527 double-click-fuzz as is. On other frames, interpret it
5528 as a multiple of 1/8 characters. */
5532 if (WINDOWP (event
->frame_or_window
))
5533 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5534 else if (FRAMEP (event
->frame_or_window
))
5535 f
= XFRAME (event
->frame_or_window
);
5539 if (FRAME_WINDOW_P (f
))
5540 fuzz
= double_click_fuzz
;
5542 fuzz
= double_click_fuzz
/ 8;
5544 is_double
= (button
== last_mouse_button
5545 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5546 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5547 && button_down_time
!= 0
5548 && (EQ (Vdouble_click_time
, Qt
)
5549 || (NATNUMP (Vdouble_click_time
)
5550 && (event
->timestamp
- button_down_time
5551 < XFASTINT (Vdouble_click_time
)))));
5554 last_mouse_button
= button
;
5555 last_mouse_x
= XINT (event
->x
);
5556 last_mouse_y
= XINT (event
->y
);
5558 /* If this is a button press, squirrel away the location, so
5559 we can decide later whether it was a click or a drag. */
5560 if (event
->modifiers
& down_modifier
)
5564 double_click_count
++;
5565 event
->modifiers
|= ((double_click_count
> 2)
5570 double_click_count
= 1;
5571 button_down_time
= event
->timestamp
;
5572 *start_pos_ptr
= Fcopy_alist (position
);
5573 ignore_mouse_drag_p
= 0;
5576 /* Now we're releasing a button - check the co-ordinates to
5577 see if this was a click or a drag. */
5578 else if (event
->modifiers
& up_modifier
)
5580 /* If we did not see a down before this up, ignore the up.
5581 Probably this happened because the down event chose a
5582 menu item. It would be an annoyance to treat the
5583 release of the button that chose the menu item as a
5586 if (!CONSP (start_pos
))
5589 event
->modifiers
&= ~up_modifier
;
5592 Lisp_Object new_down
, down
;
5593 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5595 /* The third element of every position
5596 should be the (x,y) pair. */
5597 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5598 new_down
= Fcar (Fcdr (Fcdr (position
)));
5601 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5603 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5604 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5607 if (ignore_mouse_drag_p
)
5609 event
->modifiers
|= click_modifier
;
5610 ignore_mouse_drag_p
= 0;
5612 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5613 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5614 /* Maybe the mouse has moved a lot, caused scrolling, and
5615 eventually ended up at the same screen position (but
5616 not buffer position) in which case it is a drag, not
5618 /* FIXME: OTOH if the buffer position has changed
5619 because of a timer or process filter rather than
5620 because of mouse movement, it should be considered as
5621 a click. But mouse-drag-region completely ignores
5622 this case and it hasn't caused any real problem, so
5623 it's probably OK to ignore it as well. */
5624 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5625 /* Mouse hasn't moved (much). */
5626 event
->modifiers
|= click_modifier
;
5629 button_down_time
= 0;
5630 event
->modifiers
|= drag_modifier
;
5633 /* Don't check is_double; treat this as multiple
5634 if the down-event was multiple. */
5635 if (double_click_count
> 1)
5636 event
->modifiers
|= ((double_click_count
> 2)
5642 /* Every mouse event should either have the down_modifier or
5643 the up_modifier set. */
5647 /* Get the symbol we should use for the mouse click. */
5650 head
= modify_event_symbol (button
,
5652 Qmouse_click
, Vlispy_mouse_stem
,
5655 ASIZE (mouse_syms
));
5656 if (event
->modifiers
& drag_modifier
)
5661 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5664 Fcons (make_number (double_click_count
),
5674 case HORIZ_WHEEL_EVENT
:
5676 Lisp_Object position
;
5679 /* Build the position as appropriate for this mouse click. */
5680 struct frame
*f
= XFRAME (event
->frame_or_window
);
5682 /* Ignore wheel events that were made on frame that have been
5684 if (! FRAME_LIVE_P (f
))
5687 position
= make_lispy_position (f
, event
->x
, event
->y
,
5690 /* Set double or triple modifiers to indicate the wheel speed. */
5692 /* On window-system frames, use the value of
5693 double-click-fuzz as is. On other frames, interpret it
5694 as a multiple of 1/8 characters. */
5700 if (WINDOWP (event
->frame_or_window
))
5701 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5702 else if (FRAMEP (event
->frame_or_window
))
5703 fr
= XFRAME (event
->frame_or_window
);
5707 fuzz
= FRAME_WINDOW_P (fr
)
5708 ? double_click_fuzz
: double_click_fuzz
/ 8;
5710 if (event
->modifiers
& up_modifier
)
5712 /* Emit a wheel-up event. */
5713 event
->modifiers
&= ~up_modifier
;
5716 else if (event
->modifiers
& down_modifier
)
5718 /* Emit a wheel-down event. */
5719 event
->modifiers
&= ~down_modifier
;
5723 /* Every wheel event should either have the down_modifier or
5724 the up_modifier set. */
5727 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5730 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5731 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5732 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5733 && button_down_time
!= 0
5734 && (EQ (Vdouble_click_time
, Qt
)
5735 || (NATNUMP (Vdouble_click_time
)
5736 && (event
->timestamp
- button_down_time
5737 < XFASTINT (Vdouble_click_time
)))));
5740 double_click_count
++;
5741 event
->modifiers
|= ((double_click_count
> 2)
5747 double_click_count
= 1;
5748 event
->modifiers
|= click_modifier
;
5751 button_down_time
= event
->timestamp
;
5752 /* Use a negative value to distinguish wheel from mouse button. */
5753 last_mouse_button
= - (1 + symbol_num
);
5754 last_mouse_x
= XINT (event
->x
);
5755 last_mouse_y
= XINT (event
->y
);
5757 /* Get the symbol we should use for the wheel event. */
5758 head
= modify_event_symbol (symbol_num
,
5764 ASIZE (wheel_syms
));
5767 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5770 Fcons (make_number (double_click_count
),
5779 #ifdef USE_TOOLKIT_SCROLL_BARS
5781 /* We don't have down and up events if using toolkit scroll bars,
5782 so make this always a click event. Store in the `part' of
5783 the Lisp event a symbol which maps to the following actions:
5785 `above_handle' page up
5786 `below_handle' page down
5790 `bottom' bottom of buffer
5791 `handle' thumb has been dragged.
5792 `end-scroll' end of interaction with scroll bar
5794 The incoming input_event contains in its `part' member an
5795 index of type `enum scroll_bar_part' which we can use as an
5796 index in scroll_bar_parts to get the appropriate symbol. */
5798 case SCROLL_BAR_CLICK_EVENT
:
5800 Lisp_Object position
, head
, window
, portion_whole
, part
;
5802 window
= event
->frame_or_window
;
5803 portion_whole
= Fcons (event
->x
, event
->y
);
5804 part
= *scroll_bar_parts
[(int) event
->part
];
5808 Fcons (Qvertical_scroll_bar
,
5809 Fcons (portion_whole
,
5810 Fcons (make_number (event
->timestamp
),
5811 Fcons (part
, Qnil
)))));
5813 /* Always treat scroll bar events as clicks. */
5814 event
->modifiers
|= click_modifier
;
5815 event
->modifiers
&= ~up_modifier
;
5817 if (event
->code
>= ASIZE (mouse_syms
))
5818 mouse_syms
= larger_vector (mouse_syms
,
5819 event
->code
- ASIZE (mouse_syms
) + 1,
5822 /* Get the symbol we should use for the mouse click. */
5823 head
= modify_event_symbol (event
->code
,
5828 ASIZE (mouse_syms
));
5829 return Fcons (head
, Fcons (position
, Qnil
));
5832 #endif /* USE_TOOLKIT_SCROLL_BARS */
5834 case DRAG_N_DROP_EVENT
:
5837 Lisp_Object head
, position
;
5840 f
= XFRAME (event
->frame_or_window
);
5843 /* Ignore mouse events that were made on frames that
5844 have been deleted. */
5845 if (! FRAME_LIVE_P (f
))
5848 position
= make_lispy_position (f
, event
->x
, event
->y
,
5851 head
= modify_event_symbol (0, event
->modifiers
,
5853 lispy_drag_n_drop_names
,
5854 &drag_n_drop_syms
, 1);
5861 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5862 || defined (HAVE_NS) || defined (USE_GTK)
5863 case MENU_BAR_EVENT
:
5864 if (EQ (event
->arg
, event
->frame_or_window
))
5865 /* This is the prefix key. We translate this to
5866 `(menu_bar)' because the code in keyboard.c for menu
5867 events, which we use, relies on this. */
5868 return Fcons (Qmenu_bar
, Qnil
);
5872 case SELECT_WINDOW_EVENT
:
5873 /* Make an event (select-window (WINDOW)). */
5874 return Fcons (Qselect_window
,
5875 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5878 case TOOL_BAR_EVENT
:
5879 if (EQ (event
->arg
, event
->frame_or_window
))
5880 /* This is the prefix key. We translate this to
5881 `(tool_bar)' because the code in keyboard.c for tool bar
5882 events, which we use, relies on this. */
5883 return Fcons (Qtool_bar
, Qnil
);
5884 else if (SYMBOLP (event
->arg
))
5885 return apply_modifiers (event
->modifiers
, event
->arg
);
5888 case USER_SIGNAL_EVENT
:
5889 /* A user signal. */
5891 char *name
= find_user_signal_name (event
->code
);
5894 return intern (name
);
5897 case SAVE_SESSION_EVENT
:
5898 return Qsave_session
;
5903 return Fcons (Qdbus_event
, event
->arg
);
5905 #endif /* HAVE_DBUS */
5908 case FILE_NOTIFY_EVENT
:
5910 return Fcons (Qfile_inotify
, event
->arg
);
5912 #endif /* HAVE_INOTIFY */
5914 case CONFIG_CHANGED_EVENT
:
5915 return Fcons (Qconfig_changed_event
,
5917 Fcons (event
->frame_or_window
, Qnil
)));
5919 case GPM_CLICK_EVENT
:
5921 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5922 Lisp_Object head
, position
;
5923 Lisp_Object
*start_pos_ptr
;
5924 Lisp_Object start_pos
;
5925 int button
= event
->code
;
5927 if (button
>= ASIZE (button_down_location
))
5929 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5930 button_down_location
= larger_vector (button_down_location
,
5932 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5935 start_pos_ptr
= aref_addr (button_down_location
, button
);
5936 start_pos
= *start_pos_ptr
;
5938 position
= make_lispy_position (f
, event
->x
, event
->y
,
5941 if (event
->modifiers
& down_modifier
)
5942 *start_pos_ptr
= Fcopy_alist (position
);
5943 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5945 if (!CONSP (start_pos
))
5947 event
->modifiers
&= ~up_modifier
;
5950 head
= modify_event_symbol (button
,
5952 Qmouse_click
, Vlispy_mouse_stem
,
5955 ASIZE (mouse_syms
));
5957 if (event
->modifiers
& drag_modifier
)
5962 else if (event
->modifiers
& double_modifier
)
5965 Fcons (make_number (2),
5967 else if (event
->modifiers
& triple_modifier
)
5970 Fcons (make_number (3),
5977 #endif /* HAVE_GPM */
5979 /* The 'kind' field of the event is something we don't recognize. */
5986 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5987 Lisp_Object x
, Lisp_Object y
, Time t
)
5989 /* Is it a scroll bar movement? */
5990 if (frame
&& ! NILP (bar_window
))
5992 Lisp_Object part_sym
;
5994 part_sym
= *scroll_bar_parts
[(int) part
];
5995 return Fcons (Qscroll_bar_movement
,
5996 Fcons (list5 (bar_window
,
5997 Qvertical_scroll_bar
,
6003 /* Or is it an ordinary mouse movement? */
6006 Lisp_Object position
;
6007 position
= make_lispy_position (frame
, x
, y
, t
);
6008 return list2 (Qmouse_movement
, position
);
6012 /* Construct a switch frame event. */
6014 make_lispy_switch_frame (Lisp_Object frame
)
6016 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6019 /* Manipulating modifiers. */
6021 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6023 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6024 SYMBOL's name of the end of the modifiers; the string from this
6025 position is the unmodified symbol name.
6027 This doesn't use any caches. */
6030 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6036 CHECK_SYMBOL (symbol
);
6039 name
= SYMBOL_NAME (symbol
);
6041 for (i
= 0; i
< SBYTES (name
) - 1; )
6043 ptrdiff_t this_mod_end
= 0;
6046 /* See if the name continues with a modifier word.
6047 Check that the word appears, but don't check what follows it.
6048 Set this_mod and this_mod_end to record what we find. */
6050 switch (SREF (name
, i
))
6052 #define SINGLE_LETTER_MOD(BIT) \
6053 (this_mod_end = i + 1, this_mod = BIT)
6056 SINGLE_LETTER_MOD (alt_modifier
);
6060 SINGLE_LETTER_MOD (ctrl_modifier
);
6064 SINGLE_LETTER_MOD (hyper_modifier
);
6068 SINGLE_LETTER_MOD (meta_modifier
);
6072 SINGLE_LETTER_MOD (shift_modifier
);
6076 SINGLE_LETTER_MOD (super_modifier
);
6079 #undef SINGLE_LETTER_MOD
6081 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6082 if (i + LEN + 1 <= SBYTES (name) \
6083 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6085 this_mod_end = i + LEN; \
6090 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6091 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6092 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6096 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6098 #undef MULTI_LETTER_MOD
6102 /* If we found no modifier, stop looking for them. */
6103 if (this_mod_end
== 0)
6106 /* Check there is a dash after the modifier, so that it
6107 really is a modifier. */
6108 if (this_mod_end
>= SBYTES (name
)
6109 || SREF (name
, this_mod_end
) != '-')
6112 /* This modifier is real; look for another. */
6113 modifiers
|= this_mod
;
6114 i
= this_mod_end
+ 1;
6117 /* Should we include the `click' modifier? */
6118 if (! (modifiers
& (down_modifier
| drag_modifier
6119 | double_modifier
| triple_modifier
))
6120 && i
+ 7 == SBYTES (name
)
6121 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6122 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6123 modifiers
|= click_modifier
;
6125 if (! (modifiers
& (double_modifier
| triple_modifier
))
6126 && i
+ 6 < SBYTES (name
)
6127 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6128 modifiers
|= click_modifier
;
6136 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6137 prepended to the string BASE[0..BASE_LEN-1].
6138 This doesn't use any caches. */
6140 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6142 /* Since BASE could contain nulls, we can't use intern here; we have
6143 to use Fintern, which expects a genuine Lisp_String, and keeps a
6145 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6151 /* Only the event queue may use the `up' modifier; it should always
6152 be turned into a click or drag event before presented to lisp code. */
6153 if (modifiers
& up_modifier
)
6156 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6157 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6158 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6159 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6160 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6161 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6162 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6163 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6164 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6165 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6166 /* The click modifier is denoted by the absence of other modifiers. */
6170 mod_len
= p
- new_mods
;
6174 Lisp_Object new_name
;
6176 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6177 mod_len
+ base_len_byte
);
6178 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6179 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6181 return Fintern (new_name
, Qnil
);
6186 static const char *const modifier_names
[] =
6188 "up", "down", "drag", "click", "double", "triple", 0, 0,
6189 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6190 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6192 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6194 static Lisp_Object modifier_symbols
;
6196 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6198 lispy_modifier_list (int modifiers
)
6200 Lisp_Object modifier_list
;
6203 modifier_list
= Qnil
;
6204 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6205 if (modifiers
& (1<<i
))
6206 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6209 return modifier_list
;
6213 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6214 where UNMODIFIED is the unmodified form of SYMBOL,
6215 MASK is the set of modifiers present in SYMBOL's name.
6216 This is similar to parse_modifiers_uncached, but uses the cache in
6217 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6218 Qevent_symbol_elements property. */
6220 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6223 parse_modifiers (Lisp_Object symbol
)
6225 Lisp_Object elements
;
6227 if (INTEGERP (symbol
))
6228 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6229 else if (!SYMBOLP (symbol
))
6232 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6233 if (CONSP (elements
))
6238 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6239 Lisp_Object unmodified
;
6242 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6243 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6246 if (modifiers
& ~INTMASK
)
6248 XSETFASTINT (mask
, modifiers
);
6249 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6251 /* Cache the parsing results on SYMBOL. */
6252 Fput (symbol
, Qevent_symbol_element_mask
,
6254 Fput (symbol
, Qevent_symbol_elements
,
6255 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6257 /* Since we know that SYMBOL is modifiers applied to unmodified,
6258 it would be nice to put that in unmodified's cache.
6259 But we can't, since we're not sure that parse_modifiers is
6266 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6267 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6268 doc
: /* Parse the event symbol. For internal use. */)
6269 (Lisp_Object symbol
)
6271 /* Fill the cache if needed. */
6272 parse_modifiers (symbol
);
6273 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6274 and use the Lispier representation stored on Qevent_symbol_elements
6276 return Fget (symbol
, Qevent_symbol_elements
);
6279 /* Apply the modifiers MODIFIERS to the symbol BASE.
6280 BASE must be unmodified.
6282 This is like apply_modifiers_uncached, but uses BASE's
6283 Qmodifier_cache property, if present. It also builds
6284 Qevent_symbol_elements properties, since it has that info anyway.
6286 apply_modifiers copies the value of BASE's Qevent_kind property to
6287 the modified symbol. */
6289 apply_modifiers (int modifiers
, Lisp_Object base
)
6291 Lisp_Object cache
, idx
, entry
, new_symbol
;
6293 /* Mask out upper bits. We don't know where this value's been. */
6294 modifiers
&= INTMASK
;
6296 if (INTEGERP (base
))
6297 return make_number (XINT (base
) | modifiers
);
6299 /* The click modifier never figures into cache indices. */
6300 cache
= Fget (base
, Qmodifier_cache
);
6301 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6302 entry
= assq_no_quit (idx
, cache
);
6305 new_symbol
= XCDR (entry
);
6308 /* We have to create the symbol ourselves. */
6309 new_symbol
= apply_modifiers_uncached (modifiers
,
6310 SSDATA (SYMBOL_NAME (base
)),
6311 SCHARS (SYMBOL_NAME (base
)),
6312 SBYTES (SYMBOL_NAME (base
)));
6314 /* Add the new symbol to the base's cache. */
6315 entry
= Fcons (idx
, new_symbol
);
6316 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6318 /* We have the parsing info now for free, so we could add it to
6320 XSETFASTINT (idx, modifiers);
6321 Fput (new_symbol, Qevent_symbol_element_mask,
6322 Fcons (base, Fcons (idx, Qnil)));
6323 Fput (new_symbol, Qevent_symbol_elements,
6324 Fcons (base, lispy_modifier_list (modifiers)));
6325 Sadly, this is only correct if `base' is indeed a base event,
6326 which is not necessarily the case. -stef */
6329 /* Make sure this symbol is of the same kind as BASE.
6331 You'd think we could just set this once and for all when we
6332 intern the symbol above, but reorder_modifiers may call us when
6333 BASE's property isn't set right; we can't assume that just
6334 because it has a Qmodifier_cache property it must have its
6335 Qevent_kind set right as well. */
6336 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6340 kind
= Fget (base
, Qevent_kind
);
6342 Fput (new_symbol
, Qevent_kind
, kind
);
6349 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6350 return a symbol with the modifiers placed in the canonical order.
6351 Canonical order is alphabetical, except for down and drag, which
6352 always come last. The 'click' modifier is never written out.
6354 Fdefine_key calls this to make sure that (for example) C-M-foo
6355 and M-C-foo end up being equivalent in the keymap. */
6358 reorder_modifiers (Lisp_Object symbol
)
6360 /* It's hopefully okay to write the code this way, since everything
6361 will soon be in caches, and no consing will be done at all. */
6364 parsed
= parse_modifiers (symbol
);
6365 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6370 /* For handling events, we often want to produce a symbol whose name
6371 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6372 to some base, like the name of a function key or mouse button.
6373 modify_event_symbol produces symbols of this sort.
6375 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6376 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6379 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6380 into symbol names, or a string specifying a name stem used to
6381 construct a symbol name or the form `STEM-N', where N is the decimal
6382 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6383 non-nil; otherwise NAME_TABLE is used.
6385 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6386 persist between calls to modify_event_symbol that it can use to
6387 store a cache of the symbols it's generated for this NAME_TABLE
6388 before. The object stored there may be a vector or an alist.
6390 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6392 MODIFIERS is a set of modifier bits (as given in struct input_events)
6393 whose prefixes should be applied to the symbol name.
6395 SYMBOL_KIND is the value to be placed in the event_kind property of
6396 the returned symbol.
6398 The symbols we create are supposed to have an
6399 `event-symbol-elements' property, which lists the modifiers present
6400 in the symbol's name. */
6403 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6404 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6405 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6408 Lisp_Object symbol_int
;
6410 /* Get rid of the "vendor-specific" bit here. */
6411 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6413 /* Is this a request for a valid symbol? */
6414 if (symbol_num
< 0 || symbol_num
>= table_size
)
6417 if (CONSP (*symbol_table
))
6418 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6420 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6421 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6422 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6423 we've never used that symbol before. */
6426 if (! VECTORP (*symbol_table
)
6427 || ASIZE (*symbol_table
) != table_size
)
6431 XSETFASTINT (size
, table_size
);
6432 *symbol_table
= Fmake_vector (size
, Qnil
);
6435 value
= AREF (*symbol_table
, symbol_num
);
6438 /* Have we already used this symbol before? */
6441 /* No; let's create it. */
6442 if (CONSP (name_alist_or_stem
))
6443 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6444 else if (STRINGP (name_alist_or_stem
))
6447 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6448 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6450 buf
= SAFE_ALLOCA (len
);
6451 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6452 XINT (symbol_int
) + 1);
6453 value
= intern (buf
);
6456 else if (name_table
!= 0 && name_table
[symbol_num
])
6457 value
= intern (name_table
[symbol_num
]);
6459 #ifdef HAVE_WINDOW_SYSTEM
6462 char *name
= x_get_keysym_name (symbol_num
);
6464 value
= intern (name
);
6470 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6471 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6472 value
= intern (buf
);
6475 if (CONSP (*symbol_table
))
6476 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6478 ASET (*symbol_table
, symbol_num
, value
);
6480 /* Fill in the cache entries for this symbol; this also
6481 builds the Qevent_symbol_elements property, which the user
6483 apply_modifiers (modifiers
& click_modifier
, value
);
6484 Fput (value
, Qevent_kind
, symbol_kind
);
6487 /* Apply modifiers to that symbol. */
6488 return apply_modifiers (modifiers
, value
);
6491 /* Convert a list that represents an event type,
6492 such as (ctrl meta backspace), into the usual representation of that
6493 event type as a number or a symbol. */
6495 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6496 doc
: /* Convert the event description list EVENT-DESC to an event type.
6497 EVENT-DESC should contain one base event type (a character or symbol)
6498 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6499 drag, down, double or triple). The base must be last.
6500 The return value is an event type (a character or symbol) which
6501 has the same base event type and all the specified modifiers. */)
6502 (Lisp_Object event_desc
)
6510 while (CONSP (rest
))
6518 /* Given a symbol, see if it is a modifier name. */
6519 if (SYMBOLP (elt
) && CONSP (rest
))
6520 this = parse_solitary_modifier (elt
);
6524 else if (!NILP (base
))
6525 error ("Two bases given in one event");
6531 /* Let the symbol A refer to the character A. */
6532 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6533 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6535 if (INTEGERP (base
))
6537 /* Turn (shift a) into A. */
6538 if ((modifiers
& shift_modifier
) != 0
6539 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6541 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6542 modifiers
&= ~shift_modifier
;
6545 /* Turn (control a) into C-a. */
6546 if (modifiers
& ctrl_modifier
)
6547 return make_number ((modifiers
& ~ctrl_modifier
)
6548 | make_ctrl_char (XINT (base
)));
6550 return make_number (modifiers
| XINT (base
));
6552 else if (SYMBOLP (base
))
6553 return apply_modifiers (modifiers
, base
);
6555 error ("Invalid base event");
6558 /* Try to recognize SYMBOL as a modifier name.
6559 Return the modifier flag bit, or 0 if not recognized. */
6562 parse_solitary_modifier (Lisp_Object symbol
)
6564 Lisp_Object name
= SYMBOL_NAME (symbol
);
6566 switch (SREF (name
, 0))
6568 #define SINGLE_LETTER_MOD(BIT) \
6569 if (SBYTES (name) == 1) \
6572 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6573 if (LEN == SBYTES (name) \
6574 && ! memcmp (SDATA (name), NAME, LEN)) \
6578 SINGLE_LETTER_MOD (alt_modifier
);
6582 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6586 SINGLE_LETTER_MOD (ctrl_modifier
);
6590 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6591 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6595 SINGLE_LETTER_MOD (hyper_modifier
);
6599 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6603 SINGLE_LETTER_MOD (meta_modifier
);
6607 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6611 SINGLE_LETTER_MOD (shift_modifier
);
6615 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6616 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6617 SINGLE_LETTER_MOD (super_modifier
);
6621 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6622 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6623 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6627 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6630 #undef SINGLE_LETTER_MOD
6631 #undef MULTI_LETTER_MOD
6637 /* Return true if EVENT is a list whose elements are all integers or symbols.
6638 Such a list is not valid as an event,
6639 but it can be a Lucid-style event type list. */
6642 lucid_event_type_list_p (Lisp_Object object
)
6646 if (! CONSP (object
))
6649 if (EQ (XCAR (object
), Qhelp_echo
)
6650 || EQ (XCAR (object
), Qvertical_line
)
6651 || EQ (XCAR (object
), Qmode_line
)
6652 || EQ (XCAR (object
), Qheader_line
))
6655 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6659 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6666 /* Return true if terminal input chars are available.
6667 Also, store the return value into INPUT_PENDING.
6669 Serves the purpose of ioctl (0, FIONREAD, ...)
6670 but works even if FIONREAD does not exist.
6671 (In fact, this may actually read some input.)
6673 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6674 timer events that are ripe.
6675 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6676 events (FOCUS_IN_EVENT).
6677 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6678 movements and toolkit scroll bar thumb drags. */
6681 get_input_pending (int flags
)
6683 /* First of all, have we already counted some input? */
6684 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6686 /* If input is being read as it arrives, and we have none, there is none. */
6687 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6689 /* Try to read some input and see how much we get. */
6691 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6694 return input_pending
;
6697 /* Put a BUFFER_SWITCH_EVENT in the buffer
6698 so that read_key_sequence will notice the new current buffer. */
6701 record_asynch_buffer_change (void)
6703 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6704 The purpose of the event is to make read_key_sequence look up the
6705 keymaps again. If we aren't in read_key_sequence, we don't need one,
6706 and the event could cause trouble by messing up (input-pending-p).
6707 Note: Fwaiting_for_user_input_p always returns nil when async
6708 subprocesses aren't supported. */
6709 if (!NILP (Fwaiting_for_user_input_p ()))
6711 struct input_event event
;
6714 event
.kind
= BUFFER_SWITCH_EVENT
;
6715 event
.frame_or_window
= Qnil
;
6718 /* Make sure no interrupt happens while storing the event. */
6720 if (interrupt_input
)
6721 kbd_buffer_store_event (&event
);
6726 kbd_buffer_store_event (&event
);
6732 /* Read any terminal input already buffered up by the system
6733 into the kbd_buffer, but do not wait.
6735 Return the number of keyboard chars read, or -1 meaning
6736 this is a bad time to try to read input. */
6745 /* Store pending user signal events, if any. */
6746 store_user_signal_events ();
6748 /* Loop through the available terminals, and call their input hooks. */
6752 struct terminal
*next
= t
->next_terminal
;
6754 if (t
->read_socket_hook
)
6757 struct input_event hold_quit
;
6759 if (input_blocked_p ())
6761 pending_signals
= 1;
6765 EVENT_INIT (hold_quit
);
6766 hold_quit
.kind
= NO_EVENT
;
6768 /* No need for FIONREAD or fcntl; just say don't wait. */
6769 while (0 < (nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)))
6772 if (nr
== -1) /* Not OK to read input now. */
6776 else if (nr
== -2) /* Non-transient error. */
6778 /* The terminal device terminated; it should be closed. */
6780 /* Kill Emacs if this was our last terminal. */
6781 if (!terminal_list
->next_terminal
)
6782 /* Formerly simply reported no input, but that
6783 sometimes led to a failure of Emacs to terminate.
6784 SIGHUP seems appropriate if we can't reach the
6786 /* ??? Is it really right to send the signal just to
6787 this process rather than to the whole process
6788 group? Perhaps on systems with FIONREAD Emacs is
6789 alone in its group. */
6790 terminate_due_to_signal (SIGHUP
, 10);
6792 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6795 XSETTERMINAL (tmp
, t
);
6796 Fdelete_terminal (tmp
, Qnoelisp
);
6800 if (hold_quit
.kind
!= NO_EVENT
)
6801 kbd_buffer_store_event (&hold_quit
);
6810 frame_make_pointer_visible ();
6815 /* This is the tty way of reading available input.
6817 Note that each terminal device has its own `struct terminal' object,
6818 and so this function is called once for each individual termcap
6819 terminal. The first parameter indicates which terminal to read from. */
6822 tty_read_avail_input (struct terminal
*terminal
,
6823 struct input_event
*hold_quit
)
6825 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6826 the kbd_buffer can really hold. That may prevent loss
6827 of characters on some systems when input is stuffed at us. */
6828 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6830 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6833 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6835 if (kbd_on_hold_p () || buffer_free
<= 0)
6837 #endif /* subprocesses */
6839 if (!terminal
->name
) /* Don't read from a dead terminal. */
6842 if (terminal
->type
!= output_termcap
6843 && terminal
->type
!= output_msdos_raw
)
6846 /* XXX I think the following code should be moved to separate hook
6847 functions in system-dependent files. */
6850 #else /* not WINDOWSNT */
6851 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6855 return 0; /* The terminal is suspended. */
6858 n_to_read
= dos_keysns ();
6862 cbuf
[0] = dos_keyread ();
6865 #else /* not MSDOS */
6870 struct input_event gpm_hold_quit
;
6871 int gpm
, fd
= gpm_fd
;
6873 EVENT_INIT (gpm_hold_quit
);
6874 gpm_hold_quit
.kind
= NO_EVENT
;
6876 /* gpm==1 if event received.
6877 gpm==0 if the GPM daemon has closed the connection, in which case
6878 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6879 we save it in `fd' so close_gpm can remove it from the
6881 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6882 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6883 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6886 /* Presumably the GPM daemon has closed the connection. */
6888 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6889 kbd_buffer_store_event (&gpm_hold_quit
);
6893 #endif /* HAVE_GPM */
6895 /* Determine how many characters we should *try* to read. */
6896 #ifdef USABLE_FIONREAD
6897 /* Find out how much input is available. */
6898 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6900 if (! noninteractive
)
6901 return -2; /* Close this terminal. */
6907 if (n_to_read
> sizeof cbuf
)
6908 n_to_read
= sizeof cbuf
;
6909 #elif defined USG || defined CYGWIN
6910 /* Read some input if available, but don't wait. */
6911 n_to_read
= sizeof cbuf
;
6912 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6914 # error "Cannot read without possibly delaying"
6918 /* Don't read more than we can store. */
6919 if (n_to_read
> buffer_free
)
6920 n_to_read
= buffer_free
;
6921 #endif /* subprocesses */
6923 /* Now read; for one reason or another, this will not block.
6924 NREAD is set to the number of chars read. */
6927 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6928 /* POSIX infers that processes which are not in the session leader's
6929 process group won't get SIGHUP's at logout time. BSDI adheres to
6930 this part standard and returns -1 from read (0) with errno==EIO
6931 when the control tty is taken away.
6932 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6933 if (nread
== -1 && errno
== EIO
)
6934 return -2; /* Close this terminal. */
6935 #if defined (AIX) && defined (_BSD)
6936 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6937 This looks incorrect, but it isn't, because _BSD causes
6938 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6939 and that causes a value other than 0 when there is no input. */
6941 return -2; /* Close this terminal. */
6945 /* We used to retry the read if it was interrupted.
6946 But this does the wrong thing when O_NONBLOCK causes
6947 an EAGAIN error. Does anybody know of a situation
6948 where a retry is actually needed? */
6950 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
6960 #ifndef USABLE_FIONREAD
6961 #if defined (USG) || defined (CYGWIN)
6962 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6963 #endif /* USG or CYGWIN */
6964 #endif /* no FIONREAD */
6969 #endif /* not MSDOS */
6970 #endif /* not WINDOWSNT */
6972 for (i
= 0; i
< nread
; i
++)
6974 struct input_event buf
;
6976 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6978 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6979 buf
.modifiers
= meta_modifier
;
6980 if (tty
->meta_key
!= 2)
6984 /* Set the frame corresponding to the active tty. Note that the
6985 value of selected_frame is not reliable here, redisplay tends
6986 to temporarily change it. */
6987 buf
.frame_or_window
= tty
->top_frame
;
6990 kbd_buffer_store_event (&buf
);
6991 /* Don't look at input that follows a C-g too closely.
6992 This reduces lossage due to autorepeat on C-g. */
6993 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
6994 && buf
.code
== quit_char
)
7002 handle_async_input (void)
7007 int nread
= gobble_input ();
7008 /* -1 means it's not ok to read the input now.
7009 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7010 0 means there was no keyboard input available. */
7018 process_pending_signals (void)
7020 pending_signals
= 0;
7021 handle_async_input ();
7022 do_pending_atimers ();
7025 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7026 and also (if the level is now 0) reinvoke any pending signal. */
7029 unblock_input_to (int level
)
7031 interrupt_input_blocked
= level
;
7034 if (pending_signals
)
7035 process_pending_signals ();
7041 /* End critical section.
7043 If doing signal-driven input, and a signal came in when input was
7044 blocked, reinvoke the signal handler now to deal with it. */
7047 unblock_input (void)
7049 unblock_input_to (interrupt_input_blocked
- 1);
7052 /* Undo any number of BLOCK_INPUT calls,
7053 and also reinvoke any pending signal. */
7056 totally_unblock_input (void)
7058 unblock_input_to (0);
7064 handle_input_available_signal (int sig
)
7066 pending_signals
= 1;
7068 if (input_available_clear_time
)
7069 *input_available_clear_time
= make_emacs_time (0, 0);
7073 deliver_input_available_signal (int sig
)
7075 deliver_process_signal (sig
, handle_input_available_signal
);
7077 #endif /* USABLE_SIGIO */
7080 /* User signal events. */
7082 struct user_signal_info
7084 /* Signal number. */
7087 /* Name of the signal. */
7090 /* Number of pending signals. */
7093 struct user_signal_info
*next
;
7096 /* List of user signals. */
7097 static struct user_signal_info
*user_signals
= NULL
;
7100 add_user_signal (int sig
, const char *name
)
7102 struct sigaction action
;
7103 struct user_signal_info
*p
;
7105 for (p
= user_signals
; p
; p
= p
->next
)
7107 /* Already added. */
7110 p
= xmalloc (sizeof *p
);
7112 p
->name
= xstrdup (name
);
7114 p
->next
= user_signals
;
7117 emacs_sigaction_init (&action
, deliver_user_signal
);
7118 sigaction (sig
, &action
, 0);
7122 handle_user_signal (int sig
)
7124 struct user_signal_info
*p
;
7125 const char *special_event_name
= NULL
;
7127 if (SYMBOLP (Vdebug_on_event
))
7128 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7130 for (p
= user_signals
; p
; p
= p
->next
)
7133 if (special_event_name
7134 && strcmp (special_event_name
, p
->name
) == 0)
7136 /* Enter the debugger in many ways. */
7137 debug_on_next_call
= 1;
7140 Vinhibit_quit
= Qnil
;
7142 /* Eat the event. */
7148 if (interrupt_input
)
7149 handle_input_available_signal (sig
);
7153 /* Tell wait_reading_process_output that it needs to wake
7154 up and look around. */
7155 if (input_available_clear_time
)
7156 *input_available_clear_time
= make_emacs_time (0, 0);
7163 deliver_user_signal (int sig
)
7165 deliver_process_signal (sig
, handle_user_signal
);
7169 find_user_signal_name (int sig
)
7171 struct user_signal_info
*p
;
7173 for (p
= user_signals
; p
; p
= p
->next
)
7181 store_user_signal_events (void)
7183 struct user_signal_info
*p
;
7184 struct input_event buf
;
7185 bool buf_initialized
= 0;
7187 for (p
= user_signals
; p
; p
= p
->next
)
7188 if (p
->npending
> 0)
7190 if (! buf_initialized
)
7192 memset (&buf
, 0, sizeof buf
);
7193 buf
.kind
= USER_SIGNAL_EVENT
;
7194 buf
.frame_or_window
= selected_frame
;
7195 buf_initialized
= 1;
7201 kbd_buffer_store_event (&buf
);
7204 while (p
->npending
> 0);
7209 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7210 static Lisp_Object menu_bar_one_keymap_changed_items
;
7212 /* These variables hold the vector under construction within
7213 menu_bar_items and its subroutines, and the current index
7214 for storing into that vector. */
7215 static Lisp_Object menu_bar_items_vector
;
7216 static int menu_bar_items_index
;
7219 static const char* separator_names
[] = {
7224 "single-dashed-line",
7225 "double-dashed-line",
7227 "shadow-etched-out",
7228 "shadow-etched-in-dash",
7229 "shadow-etched-out-dash",
7230 "shadow-double-etched-in",
7231 "shadow-double-etched-out",
7232 "shadow-double-etched-in-dash",
7233 "shadow-double-etched-out-dash",
7237 /* Return true if LABEL specifies a separator. */
7240 menu_separator_name_p (const char *label
)
7244 else if (strlen (label
) > 3
7245 && memcmp (label
, "--", 2) == 0
7250 for (i
= 0; separator_names
[i
]; ++i
)
7251 if (strcmp (label
, separator_names
[i
]) == 0)
7256 /* It's a separator if it contains only dashes. */
7257 while (*label
== '-')
7259 return (*label
== 0);
7266 /* Return a vector of menu items for a menu bar, appropriate
7267 to the current buffer. Each item has three elements in the vector:
7270 OLD is an old vector we can optionally reuse, or nil. */
7273 menu_bar_items (Lisp_Object old
)
7275 /* The number of keymaps we're scanning right now, and the number of
7276 keymaps we have allocated space for. */
7279 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7280 in the current keymaps, or nil where it is not a prefix. */
7283 Lisp_Object def
, tail
;
7288 /* In order to build the menus, we need to call the keymap
7289 accessors. They all call QUIT. But this function is called
7290 during redisplay, during which a quit is fatal. So inhibit
7291 quitting while building the menus.
7292 We do this instead of specbind because (1) errors will clear it anyway
7293 and (2) this avoids risk of specpdl overflow. */
7294 oquit
= Vinhibit_quit
;
7298 menu_bar_items_vector
= old
;
7300 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7301 menu_bar_items_index
= 0;
7303 /* Build our list of keymaps.
7304 If we recognize a function key and replace its escape sequence in
7305 keybuf with its symbol, or if the sequence starts with a mouse
7306 click and we need to switch buffers, we jump back here to rebuild
7307 the initial keymaps from the current buffer. */
7311 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7312 if (!NILP (Voverriding_local_map_menu_flag
))
7314 /* Yes, use them (if non-nil) as well as the global map. */
7315 maps
= alloca (3 * sizeof (maps
[0]));
7317 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7318 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7319 if (!NILP (Voverriding_local_map
))
7320 maps
[nmaps
++] = Voverriding_local_map
;
7324 /* No, so use major and minor mode keymaps and keymap property.
7325 Note that menu-bar bindings in the local-map and keymap
7326 properties may not work reliable, as they are only
7327 recognized when the menu-bar (or mode-line) is updated,
7328 which does not normally happen after every command. */
7331 nminor
= current_minor_maps (NULL
, &tmaps
);
7332 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7334 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7335 maps
[nmaps
++] = tem
;
7336 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7338 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7340 maps
[nmaps
++] = current_global_map
;
7343 /* Look up in each map the dummy prefix key `menu-bar'. */
7345 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7346 if (!NILP (maps
[mapno
]))
7348 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7352 menu_bar_one_keymap_changed_items
= Qnil
;
7353 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7357 /* Move to the end those items that should be at the end. */
7359 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7362 int end
= menu_bar_items_index
;
7364 for (i
= 0; i
< end
; i
+= 4)
7365 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7367 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7368 /* Move the item at index I to the end,
7369 shifting all the others forward. */
7370 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7371 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7372 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7373 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7375 memmove (aref_addr (menu_bar_items_vector
, i
),
7376 aref_addr (menu_bar_items_vector
, i
+ 4),
7377 (end
- i
- 4) * word_size
);
7378 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7379 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7380 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7381 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7386 /* Add nil, nil, nil, nil at the end. */
7388 int i
= menu_bar_items_index
;
7389 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7390 menu_bar_items_vector
=
7391 larger_vector (menu_bar_items_vector
, 4, -1);
7392 /* Add this item. */
7393 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7394 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7395 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7396 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7397 menu_bar_items_index
= i
;
7400 Vinhibit_quit
= oquit
;
7401 return menu_bar_items_vector
;
7404 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7405 If there's already an item for KEY, add this DEF to it. */
7407 Lisp_Object item_properties
;
7410 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7412 struct gcpro gcpro1
;
7417 if (EQ (item
, Qundefined
))
7419 /* If a map has an explicit `undefined' as definition,
7420 discard any previously made menu bar item. */
7422 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7423 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7425 if (menu_bar_items_index
> i
+ 4)
7426 memmove (aref_addr (menu_bar_items_vector
, i
),
7427 aref_addr (menu_bar_items_vector
, i
+ 4),
7428 (menu_bar_items_index
- i
- 4) * word_size
);
7429 menu_bar_items_index
-= 4;
7433 /* If this keymap has already contributed to this KEY,
7434 don't contribute to it a second time. */
7435 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7436 if (!NILP (tem
) || NILP (item
))
7439 menu_bar_one_keymap_changed_items
7440 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7442 /* We add to menu_bar_one_keymap_changed_items before doing the
7443 parse_menu_item, so that if it turns out it wasn't a menu item,
7444 it still correctly hides any further menu item. */
7446 parsed
= parse_menu_item (item
, 1);
7451 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7453 /* Find any existing item for this KEY. */
7454 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7455 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7458 /* If we did not find this KEY, add it at the end. */
7459 if (i
== menu_bar_items_index
)
7461 /* If vector is too small, get a bigger one. */
7462 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7463 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7464 /* Add this item. */
7465 ASET (menu_bar_items_vector
, i
, key
); i
++;
7466 ASET (menu_bar_items_vector
, i
,
7467 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7468 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7469 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7470 menu_bar_items_index
= i
;
7472 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7476 old
= AREF (menu_bar_items_vector
, i
+ 2);
7477 /* If the new and the old items are not both keymaps,
7478 the lookup will only find `item'. */
7479 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7480 ASET (menu_bar_items_vector
, i
+ 2, item
);
7484 /* This is used as the handler when calling menu_item_eval_property. */
7486 menu_item_eval_property_1 (Lisp_Object arg
)
7488 /* If we got a quit from within the menu computation,
7489 quit all the way out of it. This takes care of C-] in the debugger. */
7490 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7491 Fsignal (Qquit
, Qnil
);
7497 eval_dyn (Lisp_Object form
)
7499 return Feval (form
, Qnil
);
7502 /* Evaluate an expression and return the result (or nil if something
7503 went wrong). Used to evaluate dynamic parts of menu items. */
7505 menu_item_eval_property (Lisp_Object sexpr
)
7507 ptrdiff_t count
= SPECPDL_INDEX ();
7509 specbind (Qinhibit_redisplay
, Qt
);
7510 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7511 menu_item_eval_property_1
);
7512 return unbind_to (count
, val
);
7515 /* This function parses a menu item and leaves the result in the
7516 vector item_properties.
7517 ITEM is a key binding, a possible menu item.
7518 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7520 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7521 parse_menu_item returns true if the item is a menu item and false
7525 parse_menu_item (Lisp_Object item
, int inmenubar
)
7527 Lisp_Object def
, tem
, item_string
, start
;
7529 Lisp_Object keyhint
;
7538 /* Create item_properties vector if necessary. */
7539 if (NILP (item_properties
))
7541 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7543 /* Initialize optional entries. */
7544 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7545 ASET (item_properties
, i
, Qnil
);
7546 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7548 /* Save the item here to protect it from GC. */
7549 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7551 item_string
= XCAR (item
);
7555 if (STRINGP (item_string
))
7557 /* Old format menu item. */
7558 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7560 /* Maybe help string. */
7561 if (CONSP (item
) && STRINGP (XCAR (item
)))
7563 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7568 /* Maybe an obsolete key binding cache. */
7569 if (CONSP (item
) && CONSP (XCAR (item
))
7570 && (NILP (XCAR (XCAR (item
)))
7571 || VECTORP (XCAR (XCAR (item
)))))
7574 /* This is the real definition--the function to run. */
7575 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7577 /* Get enable property, if any. */
7580 tem
= Fget (item
, Qmenu_enable
);
7581 if (!NILP (Venable_disabled_menus_and_buttons
))
7582 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7583 else if (!NILP (tem
))
7584 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7587 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7589 /* New format menu item. */
7590 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7591 start
= XCDR (item
);
7594 /* We have a real binding. */
7595 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7597 item
= XCDR (start
);
7598 /* Is there an obsolete cache list with key equivalences. */
7599 if (CONSP (item
) && CONSP (XCAR (item
)))
7602 /* Parse properties. */
7603 while (CONSP (item
) && CONSP (XCDR (item
)))
7608 if (EQ (tem
, QCenable
))
7610 if (!NILP (Venable_disabled_menus_and_buttons
))
7611 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7613 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7615 else if (EQ (tem
, QCvisible
))
7617 /* If got a visible property and that evaluates to nil
7618 then ignore this item. */
7619 tem
= menu_item_eval_property (XCAR (item
));
7623 else if (EQ (tem
, QChelp
))
7624 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7625 else if (EQ (tem
, QCfilter
))
7627 else if (EQ (tem
, QCkey_sequence
))
7630 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7631 /* Be GC protected. Set keyhint to item instead of tem. */
7634 else if (EQ (tem
, QCkeys
))
7637 if (CONSP (tem
) || STRINGP (tem
))
7638 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7640 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7645 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7647 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7649 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7655 else if (inmenubar
|| !NILP (start
))
7659 return 0; /* not a menu item */
7661 /* If item string is not a string, evaluate it to get string.
7662 If we don't get a string, skip this item. */
7663 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7664 if (!(STRINGP (item_string
)))
7666 item_string
= menu_item_eval_property (item_string
);
7667 if (!STRINGP (item_string
))
7669 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7672 /* If got a filter apply it on definition. */
7673 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7676 def
= menu_item_eval_property (list2 (XCAR (filter
),
7677 list2 (Qquote
, def
)));
7679 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7682 /* Enable or disable selection of item. */
7683 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7686 tem
= menu_item_eval_property (tem
);
7687 if (inmenubar
&& NILP (tem
))
7688 return 0; /* Ignore disabled items in menu bar. */
7689 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7692 /* If we got no definition, this item is just unselectable text which
7693 is OK in a submenu but not in the menubar. */
7695 return (!inmenubar
);
7697 /* See if this is a separate pane or a submenu. */
7698 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7699 tem
= get_keymap (def
, 0, 1);
7700 /* For a subkeymap, just record its details and exit. */
7703 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7704 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7708 /* At the top level in the menu bar, do likewise for commands also.
7709 The menu bar does not display equivalent key bindings anyway.
7710 ITEM_PROPERTY_DEF is already set up properly. */
7714 { /* This is a command. See if there is an equivalent key binding. */
7715 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7717 /* The previous code preferred :key-sequence to :keys, so we
7718 preserve this behavior. */
7719 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7720 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7723 Lisp_Object prefix
= keyeq
;
7724 Lisp_Object keys
= Qnil
;
7728 def
= XCAR (prefix
);
7729 prefix
= XCDR (prefix
);
7732 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7734 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7736 keys
= XCAR (keyhint
);
7737 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7739 /* We have a suggested key. Is it bound to the command? */
7742 /* If the command is an alias for another
7743 (such as lmenu.el set it up), check if the
7744 original command matches the cached command. */
7746 && EQ (tem
, XSYMBOL (def
)->function
))))
7751 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7755 tem
= Fkey_description (keys
, Qnil
);
7758 if (STRINGP (XCAR (prefix
)))
7759 tem
= concat2 (XCAR (prefix
), tem
);
7760 if (STRINGP (XCDR (prefix
)))
7761 tem
= concat2 (tem
, XCDR (prefix
));
7763 keyeq
= concat2 (build_string (" "), tem
);
7764 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7770 /* If we have an equivalent key binding, use that. */
7771 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7774 /* Include this when menu help is implemented.
7775 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7776 if (!(NILP (tem) || STRINGP (tem)))
7778 tem = menu_item_eval_property (tem);
7781 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7785 /* Handle radio buttons or toggle boxes. */
7786 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7788 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7789 menu_item_eval_property (tem
));
7796 /***********************************************************************
7798 ***********************************************************************/
7800 /* A vector holding tool bar items while they are parsed in function
7801 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7804 static Lisp_Object tool_bar_items_vector
;
7806 /* A vector holding the result of parse_tool_bar_item. Layout is like
7807 the one for a single item in tool_bar_items_vector. */
7809 static Lisp_Object tool_bar_item_properties
;
7811 /* Next free index in tool_bar_items_vector. */
7813 static int ntool_bar_items
;
7815 /* The symbols `:image' and `:rtl'. */
7817 static Lisp_Object QCimage
;
7818 static Lisp_Object QCrtl
;
7820 /* Function prototypes. */
7822 static void init_tool_bar_items (Lisp_Object
);
7823 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7824 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7825 static void append_tool_bar_item (void);
7828 /* Return a vector of tool bar items for keymaps currently in effect.
7829 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7830 tool bar items found. */
7833 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7842 /* In order to build the menus, we need to call the keymap
7843 accessors. They all call QUIT. But this function is called
7844 during redisplay, during which a quit is fatal. So inhibit
7845 quitting while building the menus. We do this instead of
7846 specbind because (1) errors will clear it anyway and (2) this
7847 avoids risk of specpdl overflow. */
7848 oquit
= Vinhibit_quit
;
7851 /* Initialize tool_bar_items_vector and protect it from GC. */
7852 init_tool_bar_items (reuse
);
7854 /* Build list of keymaps in maps. Set nmaps to the number of maps
7857 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7858 if (!NILP (Voverriding_local_map_menu_flag
))
7860 /* Yes, use them (if non-nil) as well as the global map. */
7861 maps
= alloca (3 * sizeof *maps
);
7863 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7864 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7865 if (!NILP (Voverriding_local_map
))
7866 maps
[nmaps
++] = Voverriding_local_map
;
7870 /* No, so use major and minor mode keymaps and keymap property.
7871 Note that tool-bar bindings in the local-map and keymap
7872 properties may not work reliable, as they are only
7873 recognized when the tool-bar (or mode-line) is updated,
7874 which does not normally happen after every command. */
7877 nminor
= current_minor_maps (NULL
, &tmaps
);
7878 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7880 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7881 maps
[nmaps
++] = tem
;
7882 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7884 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7887 /* Add global keymap at the end. */
7888 maps
[nmaps
++] = current_global_map
;
7890 /* Process maps in reverse order and look up in each map the prefix
7892 for (i
= nmaps
- 1; i
>= 0; --i
)
7893 if (!NILP (maps
[i
]))
7897 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7899 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7902 Vinhibit_quit
= oquit
;
7903 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7904 return tool_bar_items_vector
;
7908 /* Process the definition of KEY which is DEF. */
7911 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7914 struct gcpro gcpro1
, gcpro2
;
7916 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7920 if (EQ (def
, Qundefined
))
7922 /* If a map has an explicit `undefined' as definition,
7923 discard any previously made item. */
7924 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7926 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7928 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7930 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7931 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
7932 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7934 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7939 else if (parse_tool_bar_item (key
, def
))
7940 /* Append a new tool bar item to tool_bar_items_vector. Accept
7941 more than one definition for the same key. */
7942 append_tool_bar_item ();
7947 /* Access slot with index IDX of vector tool_bar_item_properties. */
7948 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
7950 set_prop (ptrdiff_t idx
, Lisp_Object val
)
7952 ASET (tool_bar_item_properties
, idx
, val
);
7956 /* Parse a tool bar item specification ITEM for key KEY and return the
7957 result in tool_bar_item_properties. Value is false if ITEM is
7960 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7962 CAPTION is the caption of the item, If it's not a string, it is
7963 evaluated to get a string.
7965 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7966 as binding are currently ignored.
7968 The following properties are recognized:
7972 FORM is evaluated and specifies whether the tool bar item is
7973 enabled or disabled.
7977 FORM is evaluated and specifies whether the tool bar item is visible.
7979 - `:filter FUNCTION'
7981 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
7982 result is stored as the new binding.
7984 - `:button (TYPE SELECTED)'
7986 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
7987 and specifies whether the button is selected (pressed) or not.
7991 IMAGES is either a single image specification or a vector of four
7992 image specifications. See enum tool_bar_item_images.
7994 - `:help HELP-STRING'.
7996 Gives a help string to display for the tool bar item.
7998 - `:label LABEL-STRING'.
8000 A text label to show with the tool bar button if labels are enabled. */
8003 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8005 Lisp_Object filter
= Qnil
;
8006 Lisp_Object caption
;
8008 bool have_label
= 0;
8010 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8011 Rule out items that aren't lists, don't start with
8012 `menu-item' or whose rest following `tool-bar-item' is not a
8017 /* As an exception, allow old-style menu separators. */
8018 if (STRINGP (XCAR (item
)))
8019 item
= Fcons (XCAR (item
), Qnil
);
8020 else if (!EQ (XCAR (item
), Qmenu_item
)
8021 || (item
= XCDR (item
), !CONSP (item
)))
8024 /* Create tool_bar_item_properties vector if necessary. Reset it to
8026 if (VECTORP (tool_bar_item_properties
))
8028 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8032 tool_bar_item_properties
8033 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8036 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8037 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8039 /* Get the caption of the item. If the caption is not a string,
8040 evaluate it to get a string. If we don't get a string, skip this
8042 caption
= XCAR (item
);
8043 if (!STRINGP (caption
))
8045 caption
= menu_item_eval_property (caption
);
8046 if (!STRINGP (caption
))
8049 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8051 /* If the rest following the caption is not a list, the menu item is
8052 either a separator, or invalid. */
8056 if (menu_separator_name_p (SSDATA (caption
)))
8058 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8059 #if !defined (USE_GTK) && !defined (HAVE_NS)
8060 /* If we use build_desired_tool_bar_string to render the
8061 tool bar, the separator is rendered as an image. */
8062 PROP (TOOL_BAR_ITEM_IMAGES
)
8063 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8064 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8065 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8066 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8073 /* Store the binding. */
8074 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8077 /* Ignore cached key binding, if any. */
8078 if (CONSP (item
) && CONSP (XCAR (item
)))
8081 /* Process the rest of the properties. */
8082 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8084 Lisp_Object ikey
, value
;
8087 value
= XCAR (XCDR (item
));
8089 if (EQ (ikey
, QCenable
))
8091 /* `:enable FORM'. */
8092 if (!NILP (Venable_disabled_menus_and_buttons
))
8093 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8095 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8097 else if (EQ (ikey
, QCvisible
))
8099 /* `:visible FORM'. If got a visible property and that
8100 evaluates to nil then ignore this item. */
8101 if (NILP (menu_item_eval_property (value
)))
8104 else if (EQ (ikey
, QChelp
))
8105 /* `:help HELP-STRING'. */
8106 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8107 else if (EQ (ikey
, QCvert_only
))
8108 /* `:vert-only t/nil'. */
8109 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8110 else if (EQ (ikey
, QClabel
))
8112 const char *bad_label
= "!!?GARBLED ITEM?!!";
8113 /* `:label LABEL-STRING'. */
8114 set_prop (TOOL_BAR_ITEM_LABEL
,
8115 STRINGP (value
) ? value
: build_string (bad_label
));
8118 else if (EQ (ikey
, QCfilter
))
8119 /* ':filter FORM'. */
8121 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8123 /* `:button (TYPE . SELECTED)'. */
8124 Lisp_Object type
, selected
;
8126 type
= XCAR (value
);
8127 selected
= XCDR (value
);
8128 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8130 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8131 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8134 else if (EQ (ikey
, QCimage
)
8136 || (VECTORP (value
) && ASIZE (value
) == 4)))
8137 /* Value is either a single image specification or a vector
8138 of 4 such specifications for the different button states. */
8139 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8140 else if (EQ (ikey
, QCrtl
))
8142 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8148 /* Try to make one from caption and key. */
8149 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8150 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8151 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8152 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8154 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8155 char *buf
= xmalloc (max_lbl
+ 1);
8156 Lisp_Object new_lbl
;
8157 ptrdiff_t caption_len
= strlen (capt
);
8159 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8162 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8164 buf
[caption_len
] = '\0';
8168 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8172 strcpy (buf
, label
);
8174 for (j
= 0; buf
[j
] != '\0'; ++j
)
8182 new_lbl
= Fupcase_initials (build_string (label
));
8183 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8184 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8186 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8190 /* If got a filter apply it on binding. */
8192 set_prop (TOOL_BAR_ITEM_BINDING
,
8193 (menu_item_eval_property
8196 PROP (TOOL_BAR_ITEM_BINDING
))))));
8198 /* See if the binding is a keymap. Give up if it is. */
8199 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8202 /* Enable or disable selection of item. */
8203 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8204 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8205 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8207 /* Handle radio buttons or toggle boxes. */
8208 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8209 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8210 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8218 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8219 that can be reused. */
8222 init_tool_bar_items (Lisp_Object reuse
)
8224 if (VECTORP (reuse
))
8225 tool_bar_items_vector
= reuse
;
8227 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8228 ntool_bar_items
= 0;
8232 /* Append parsed tool bar item properties from
8233 tool_bar_item_properties */
8236 append_tool_bar_item (void)
8240 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8242 /* Enlarge tool_bar_items_vector if necessary. */
8244 tool_bar_items_vector
8245 = larger_vector (tool_bar_items_vector
, incr
, -1);
8247 /* Append entries from tool_bar_item_properties to the end of
8248 tool_bar_items_vector. */
8249 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8250 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8251 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8258 /* Read a character using menus based on the keymap MAP.
8259 Return nil if there are no menus in the maps.
8260 Return t if we displayed a menu but the user rejected it.
8262 PREV_EVENT is the previous input event, or nil if we are reading
8263 the first event of a key sequence.
8265 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8266 if we used a mouse menu to read the input, or false otherwise. If
8267 USED_MOUSE_MENU is null, don't dereference it.
8269 The prompting is done based on the prompt-string of the map
8270 and the strings associated with various map elements.
8272 This can be done with X menus or with menus put in the minibuf.
8273 These are done in different ways, depending on how the input will be read.
8274 Menus using X are done after auto-saving in read-char, getting the input
8275 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8276 and do auto-saving in the inner call of read_char. */
8279 read_char_x_menu_prompt (Lisp_Object map
,
8280 Lisp_Object prev_event
, bool *used_mouse_menu
)
8282 if (used_mouse_menu
)
8283 *used_mouse_menu
= 0;
8285 /* Use local over global Menu maps. */
8287 if (! menu_prompting
)
8291 /* If we got to this point via a mouse click,
8292 use a real menu for mouse selection. */
8293 if (EVENT_HAS_PARAMETERS (prev_event
)
8294 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8295 && !EQ (XCAR (prev_event
), Qtool_bar
))
8297 /* Display the menu and get the selection. */
8300 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8305 record_menu_key (XCAR (value
));
8307 /* If we got multiple events, unread all but
8309 There is no way to prevent those unread events
8310 from showing up later in last_nonmenu_event.
8311 So turn symbol and integer events into lists,
8312 to indicate that they came from a mouse menu,
8313 so that when present in last_nonmenu_event
8314 they won't confuse things. */
8315 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8317 record_menu_key (XCAR (tem
));
8318 if (SYMBOLP (XCAR (tem
))
8319 || INTEGERP (XCAR (tem
)))
8320 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8323 /* If we got more than one event, put all but the first
8324 onto this list to be read later.
8325 Return just the first event now. */
8326 Vunread_command_events
8327 = nconc2 (XCDR (value
), Vunread_command_events
);
8328 value
= XCAR (value
);
8330 else if (NILP (value
))
8332 if (used_mouse_menu
)
8333 *used_mouse_menu
= 1;
8336 #endif /* HAVE_MENUS */
8341 read_char_minibuf_menu_prompt (int commandflag
,
8344 register Lisp_Object name
;
8346 /* FIXME: Use the minibuffer's frame width. */
8347 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8349 bool nobindings
= 1;
8350 Lisp_Object rest
, vector
;
8351 Lisp_Object prompt_strings
= Qnil
;
8355 if (! menu_prompting
)
8358 map
= get_keymap (map
, 0, 1);
8359 name
= Fkeymap_prompt (map
);
8361 /* If we don't have any menus, just read a character normally. */
8362 if (!STRINGP (name
))
8365 #define PUSH_C_STR(str, listvar) \
8366 listvar = Fcons (make_unibyte_string (str, strlen (str)), listvar)
8368 /* Prompt string always starts with map's prompt, and a space. */
8369 prompt_strings
= Fcons (name
, prompt_strings
);
8370 PUSH_C_STR (": ", prompt_strings
);
8371 nlength
= SCHARS (name
) + 2;
8375 /* Present the documented bindings, a line at a time. */
8379 Lisp_Object menu_strings
= prompt_strings
;
8380 ptrdiff_t i
= nlength
;
8382 Lisp_Object orig_defn_macro
;
8384 /* Loop over elements of map. */
8389 /* FIXME: Use map_keymap to handle new keymap formats. */
8391 /* At end of map, wrap around if just starting,
8392 or end this line if already have something on it. */
8395 if (notfirst
|| nobindings
)
8401 /* Look at the next element of the map. */
8403 elt
= AREF (vector
, idx
);
8405 elt
= Fcar_safe (rest
);
8407 if (idx
< 0 && VECTORP (elt
))
8409 /* If we found a dense table in the keymap,
8410 advanced past it, but start scanning its contents. */
8411 rest
= Fcdr_safe (rest
);
8417 /* An ordinary element. */
8418 Lisp_Object event
, tem
;
8422 event
= Fcar_safe (elt
); /* alist */
8423 elt
= Fcdr_safe (elt
);
8427 XSETINT (event
, idx
); /* vector */
8430 /* Ignore the element if it has no prompt string. */
8431 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8433 /* True if the char to type matches the string. */
8435 Lisp_Object upcased_event
, downcased_event
;
8436 Lisp_Object desc
= Qnil
;
8438 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8440 upcased_event
= Fupcase (event
);
8441 downcased_event
= Fdowncase (event
);
8442 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8443 || XINT (downcased_event
) == SREF (s
, 0));
8445 desc
= Fsingle_key_description (event
, Qnil
);
8447 #if 0 /* It is redundant to list the equivalent key bindings because
8448 the prefix is what the user has already typed. */
8450 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8452 /* Insert equivalent keybinding. */
8453 s
= concat2 (s
, tem
);
8456 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8457 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8459 /* Insert button prefix. */
8460 Lisp_Object selected
8461 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8462 if (EQ (tem
, QCradio
))
8463 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8465 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8466 s
= concat2 (tem
, s
);
8470 /* If we have room for the prompt string, add it to this line.
8471 If this is the first on the line, always add it. */
8472 if ((SCHARS (s
) + i
+ 2
8473 + (char_matches
? 0 : SCHARS (desc
) + 3))
8477 ptrdiff_t thiswidth
;
8479 /* Punctuate between strings. */
8482 PUSH_C_STR (", ", menu_strings
);
8488 /* If the char to type doesn't match the string's
8489 first char, explicitly show what char to type. */
8492 /* Add as much of string as fits. */
8493 thiswidth
= min (SCHARS (desc
), width
- i
);
8495 = Fcons (Fsubstring (desc
, make_number (0),
8496 make_number (thiswidth
)),
8499 PUSH_C_STR (" = ", menu_strings
);
8503 /* Add as much of string as fits. */
8504 thiswidth
= min (SCHARS (s
), width
- i
);
8506 = Fcons (Fsubstring (s
, make_number (0),
8507 make_number (thiswidth
)),
8513 /* If this element does not fit, end the line now,
8514 and save the element for the next line. */
8515 PUSH_C_STR ("...", menu_strings
);
8520 /* Move past this element. */
8521 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8522 /* Handle reaching end of dense table. */
8527 rest
= Fcdr_safe (rest
);
8531 /* Prompt with that and read response. */
8532 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8534 /* Make believe it's not a keyboard macro in case the help char
8535 is pressed. Help characters are not recorded because menu prompting
8536 is not used on replay. */
8537 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8538 kset_defining_kbd_macro (current_kboard
, Qnil
);
8540 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8541 while (BUFFERP (obj
));
8542 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8544 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8547 if (! EQ (obj
, menu_prompt_more_char
)
8548 && (!INTEGERP (menu_prompt_more_char
)
8549 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8551 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8552 store_kbd_macro_char (obj
);
8555 /* Help char - go round again. */
8559 /* Reading key sequences. */
8562 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8564 return access_keymap (get_keymap (keymap
, 0, 1),
8569 active_maps (Lisp_Object first_event
)
8571 Lisp_Object position
8572 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8573 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8576 /* Structure used to keep track of partial application of key remapping
8577 such as Vfunction_key_map and Vkey_translation_map. */
8578 typedef struct keyremap
8580 /* This is the map originally specified for this use. */
8582 /* This is a submap reached by looking up, in PARENT,
8583 the events from START to END. */
8585 /* Positions [START, END) in the key sequence buffer
8586 are the key that we have scanned so far.
8587 Those events are the ones that we will replace
8588 if PARENT maps them into a key sequence. */
8592 /* Lookup KEY in MAP.
8593 MAP is a keymap mapping keys to key vectors or functions.
8594 If the mapping is a function and DO_FUNCALL is true,
8595 the function is called with PROMPT as parameter and its return
8596 value is used as the return value of this function (after checking
8597 that it is indeed a vector). */
8600 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8605 next
= access_keymap (map
, key
, 1, 0, 1);
8607 /* Handle a symbol whose function definition is a keymap
8609 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8610 && (ARRAYP (XSYMBOL (next
)->function
)
8611 || KEYMAPP (XSYMBOL (next
)->function
)))
8612 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8614 /* If the keymap gives a function, not an
8615 array, then call the function with one arg and use
8616 its value instead. */
8617 if (do_funcall
&& FUNCTIONP (next
))
8622 next
= call1 (next
, prompt
);
8623 /* If the function returned something invalid,
8624 barf--don't ignore it.
8625 (To ignore it safely, we would need to gcpro a bunch of
8626 other variables.) */
8627 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8628 error ("Function %s returns invalid key sequence",
8629 SSDATA (SYMBOL_NAME (tem
)));
8634 /* Do one step of the key remapping used for function-key-map and
8635 key-translation-map:
8636 KEYBUF is the buffer holding the input events.
8637 BUFSIZE is its maximum size.
8638 FKEY is a pointer to the keyremap structure to use.
8639 INPUT is the index of the last element in KEYBUF.
8640 DOIT if true says that the remapping can actually take place.
8641 DIFF is used to return the number of keys added/removed by the remapping.
8642 PARENT is the root of the keymap.
8643 PROMPT is the prompt to use if the remapping happens through a function.
8644 Return true if the remapping actually took place. */
8647 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8648 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8650 Lisp_Object next
, key
;
8652 key
= keybuf
[fkey
->end
++];
8654 if (KEYMAPP (fkey
->parent
))
8655 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8659 /* If keybuf[fkey->start..fkey->end] is bound in the
8660 map and we're in a position to do the key remapping, replace it with
8661 the binding and restart with fkey->start at the end. */
8662 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8664 int len
= XFASTINT (Flength (next
));
8667 *diff
= len
- (fkey
->end
- fkey
->start
);
8669 if (bufsize
- input
<= *diff
)
8670 error ("Key sequence too long");
8672 /* Shift the keys that follow fkey->end. */
8674 for (i
= fkey
->end
; i
< input
; i
++)
8675 keybuf
[i
+ *diff
] = keybuf
[i
];
8677 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8678 keybuf
[i
+ *diff
] = keybuf
[i
];
8679 /* Overwrite the old keys with the new ones. */
8680 for (i
= 0; i
< len
; i
++)
8681 keybuf
[fkey
->start
+ i
]
8682 = Faref (next
, make_number (i
));
8684 fkey
->start
= fkey
->end
+= *diff
;
8685 fkey
->map
= fkey
->parent
;
8690 fkey
->map
= get_keymap (next
, 0, 1);
8692 /* If we no longer have a bound suffix, try a new position for
8694 if (!CONSP (fkey
->map
))
8696 fkey
->end
= ++fkey
->start
;
8697 fkey
->map
= fkey
->parent
;
8703 test_undefined (Lisp_Object binding
)
8705 return (NILP (binding
)
8706 || EQ (binding
, Qundefined
)
8707 || (SYMBOLP (binding
)
8708 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8711 /* Like `read_char' but applies keyboard-coding-system to tty input. */
8713 read_decoded_char (int commandflag
, Lisp_Object map
,
8714 Lisp_Object prev_event
, bool *used_mouse_menu
)
8716 #define MAX_ENCODED_BYTES 16
8717 Lisp_Object events
[MAX_ENCODED_BYTES
];
8722 = read_char (commandflag
, map
, prev_event
, used_mouse_menu
, NULL
);
8723 struct frame
*frame
= XFRAME (selected_frame
);
8724 struct terminal
*terminal
= frame
->terminal
;
8725 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
8726 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
8727 & CODING_REQUIRE_DECODING_MASK
)))
8728 return nextevt
; /* No decoding needed. */
8731 int meta_key
= terminal
->display_info
.tty
->meta_key
;
8732 eassert (n
< MAX_ENCODED_BYTES
);
8733 events
[n
++] = nextevt
;
8734 if (NATNUMP (nextevt
)
8735 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
8736 { /* An encoded byte sequence, let's try to decode it. */
8737 struct coding_system
*coding
8738 = TERMINAL_KEYBOARD_CODING (terminal
);
8739 unsigned char *src
= alloca (n
);
8741 for (i
= 0; i
< n
; i
++)
8742 src
[i
] = XINT (events
[i
]);
8744 for (i
= 0; i
< n
; i
++)
8746 coding
->destination
= alloca (n
* 4);
8747 coding
->dst_bytes
= n
* 4;
8748 decode_coding_c_string (coding
, src
, n
, Qnil
);
8749 eassert (coding
->produced_char
<= n
);
8750 if (coding
->produced_char
== 0)
8751 { /* The encoded sequence is incomplete. */
8752 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
8753 continue; /* Read on! */
8757 const unsigned char *p
= coding
->destination
;
8758 eassert (coding
->carryover_bytes
== 0);
8760 while (n
< coding
->produced_char
)
8761 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
8764 /* Now `events' should hold decoded events.
8765 Normally, n should be equal to 1, but better not rely on it.
8766 We can only return one event here, so return the first we
8767 had and keep the others (if any) for later. */
8769 Vunread_command_events
8770 = Fcons (events
[--n
], Vunread_command_events
);
8776 /* Read a sequence of keys that ends with a non prefix character,
8777 storing it in KEYBUF, a buffer of size BUFSIZE.
8779 Return the length of the key sequence stored.
8780 Return -1 if the user rejected a command menu.
8782 Echo starting immediately unless `prompt' is 0.
8784 Where a key sequence ends depends on the currently active keymaps.
8785 These include any minor mode keymaps active in the current buffer,
8786 the current buffer's local map, and the global map.
8788 If a key sequence has no other bindings, we check Vfunction_key_map
8789 to see if some trailing subsequence might be the beginning of a
8790 function key's sequence. If so, we try to read the whole function
8791 key, and substitute its symbolic name into the key sequence.
8793 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8794 `double-' events into similar click events, if that would make them
8795 bound. We try to turn `triple-' events first into `double-' events,
8798 If we get a mouse click in a mode line, vertical divider, or other
8799 non-text area, we treat the click as if it were prefixed by the
8800 symbol denoting that area - `mode-line', `vertical-line', or
8803 If the sequence starts with a mouse click, we read the key sequence
8804 with respect to the buffer clicked on, not the current buffer.
8806 If the user switches frames in the midst of a key sequence, we put
8807 off the switch-frame event until later; the next call to
8808 read_char will return it.
8810 If FIX_CURRENT_BUFFER, we restore current_buffer
8811 from the selected window's buffer. */
8814 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8815 bool dont_downcase_last
, bool can_return_switch_frame
,
8816 bool fix_current_buffer
)
8818 ptrdiff_t count
= SPECPDL_INDEX ();
8820 /* How many keys there are in the current key sequence. */
8823 /* The length of the echo buffer when we started reading, and
8824 the length of this_command_keys when we started reading. */
8825 ptrdiff_t echo_start
IF_LINT (= 0);
8826 ptrdiff_t keys_start
;
8828 Lisp_Object current_binding
= Qnil
;
8829 Lisp_Object first_event
= Qnil
;
8831 /* Index of the first key that has no binding.
8832 It is useless to try fkey.start larger than that. */
8835 /* If t < mock_input, then KEYBUF[t] should be read as the next
8838 We use this to recover after recognizing a function key. Once we
8839 realize that a suffix of the current key sequence is actually a
8840 function key's escape sequence, we replace the suffix with the
8841 function key's binding from Vfunction_key_map. Now keybuf
8842 contains a new and different key sequence, so the echo area,
8843 this_command_keys, and the submaps and defs arrays are wrong. In
8844 this situation, we set mock_input to t, set t to 0, and jump to
8845 restart_sequence; the loop will read keys from keybuf up until
8846 mock_input, thus rebuilding the state; and then it will resume
8847 reading characters from the keyboard. */
8850 /* If the sequence is unbound in submaps[], then
8851 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8852 and fkey.map is its binding.
8854 These might be > t, indicating that all function key scanning
8855 should hold off until t reaches them. We do this when we've just
8856 recognized a function key, to avoid searching for the function
8857 key's again in Vfunction_key_map. */
8860 /* Likewise, for key_translation_map and input-decode-map. */
8861 keyremap keytran
, indec
;
8863 /* True if we are trying to map a key by changing an upper-case
8864 letter to lower case, or a shifted function key to an unshifted
8866 bool shift_translated
= 0;
8868 /* If we receive a `switch-frame' or `select-window' event in the middle of
8869 a key sequence, we put it off for later.
8870 While we're reading, we keep the event here. */
8871 Lisp_Object delayed_switch_frame
;
8873 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8874 int original_uppercase_position
= -1;
8876 /* Gets around Microsoft compiler limitations. */
8879 struct buffer
*starting_buffer
;
8881 /* List of events for which a fake prefix key has been generated. */
8882 Lisp_Object fake_prefixed_keys
= Qnil
;
8884 struct gcpro gcpro1
;
8886 GCPRO1 (fake_prefixed_keys
);
8887 raw_keybuf_count
= 0;
8889 last_nonmenu_event
= Qnil
;
8891 delayed_switch_frame
= Qnil
;
8897 /* Install the string STR as the beginning of the string of
8898 echoing, so that it serves as a prompt for the next
8900 kset_echo_string (current_kboard
, prompt
);
8901 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8904 else if (cursor_in_echo_area
8905 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8906 && NILP (Fzerop (Vecho_keystrokes
)))
8907 /* This doesn't put in a dash if the echo buffer is empty, so
8908 you don't always see a dash hanging out in the minibuffer. */
8912 /* Record the initial state of the echo area and this_command_keys;
8913 we will need to restore them if we replay a key sequence. */
8915 echo_start
= echo_length ();
8916 keys_start
= this_command_key_count
;
8917 this_single_command_key_start
= keys_start
;
8919 /* We jump here when we need to reinitialize fkey and keytran; this
8920 happens if we switch keyboards between rescans. */
8921 replay_entire_sequence
:
8923 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8924 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8925 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8926 indec
.start
= indec
.end
= 0;
8927 fkey
.start
= fkey
.end
= 0;
8928 keytran
.start
= keytran
.end
= 0;
8930 /* We jump here when the key sequence has been thoroughly changed, and
8931 we need to rescan it starting from the beginning. When we jump here,
8932 keybuf[0..mock_input] holds the sequence we should reread. */
8935 starting_buffer
= current_buffer
;
8936 first_unbound
= bufsize
+ 1;
8938 /* Build our list of keymaps.
8939 If we recognize a function key and replace its escape sequence in
8940 keybuf with its symbol, or if the sequence starts with a mouse
8941 click and we need to switch buffers, we jump back here to rebuild
8942 the initial keymaps from the current buffer. */
8943 current_binding
= active_maps (first_event
);
8945 /* Start from the beginning in keybuf. */
8948 /* These are no-ops the first time through, but if we restart, they
8949 revert the echo area and this_command_keys to their original state. */
8950 this_command_key_count
= keys_start
;
8951 if (INTERACTIVE
&& t
< mock_input
)
8952 echo_truncate (echo_start
);
8954 /* If the best binding for the current key sequence is a keymap, or
8955 we may be looking at a function key's escape sequence, keep on
8957 while (!NILP (current_binding
)
8958 /* Keep reading as long as there's a prefix binding. */
8959 ? KEYMAPP (current_binding
)
8960 /* Don't return in the middle of a possible function key sequence,
8961 if the only bindings we found were via case conversion.
8962 Thus, if ESC O a has a function-key-map translation
8963 and ESC o has a binding, don't return after ESC O,
8964 so that we can translate ESC O plus the next character. */
8965 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8968 bool used_mouse_menu
= 0;
8970 /* Where the last real key started. If we need to throw away a
8971 key that has expanded into more than one element of keybuf
8972 (say, a mouse click on the mode line which is being treated
8973 as [mode-line (mouse-...)], then we backtrack to this point
8975 int last_real_key_start
;
8977 /* These variables are analogous to echo_start and keys_start;
8978 while those allow us to restart the entire key sequence,
8979 echo_local_start and keys_local_start allow us to throw away
8981 ptrdiff_t echo_local_start
IF_LINT (= 0);
8982 int keys_local_start
;
8983 Lisp_Object new_binding
;
8985 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
8986 eassert (indec
.start
<= indec
.end
);
8987 eassert (fkey
.start
<= fkey
.end
);
8988 eassert (keytran
.start
<= keytran
.end
);
8989 /* key-translation-map is applied *after* function-key-map
8990 which is itself applied *after* input-decode-map. */
8991 eassert (fkey
.end
<= indec
.start
);
8992 eassert (keytran
.end
<= fkey
.start
);
8994 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
8995 first_unbound
< keytran
.start
)
8996 { /* The prefix upto first_unbound has no binding and has
8997 no translation left to do either, so we know it's unbound.
8998 If we don't stop now, we risk staying here indefinitely
8999 (if the user keeps entering fkey or keytran prefixes
9000 like C-c ESC ESC ESC ESC ...) */
9002 for (i
= first_unbound
+ 1; i
< t
; i
++)
9003 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9004 mock_input
= t
- first_unbound
- 1;
9005 indec
.end
= indec
.start
-= first_unbound
+ 1;
9006 indec
.map
= indec
.parent
;
9007 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9008 fkey
.map
= fkey
.parent
;
9009 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9010 keytran
.map
= keytran
.parent
;
9011 goto replay_sequence
;
9015 error ("Key sequence too long");
9018 echo_local_start
= echo_length ();
9019 keys_local_start
= this_command_key_count
;
9022 /* These are no-ops, unless we throw away a keystroke below and
9023 jumped back up to replay_key; in that case, these restore the
9024 variables to their original state, allowing us to replay the
9026 if (INTERACTIVE
&& t
< mock_input
)
9027 echo_truncate (echo_local_start
);
9028 this_command_key_count
= keys_local_start
;
9030 /* By default, assume each event is "real". */
9031 last_real_key_start
= t
;
9033 /* Does mock_input indicate that we are re-reading a key sequence? */
9037 add_command_key (key
);
9038 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9039 && NILP (Fzerop (Vecho_keystrokes
))
9040 && current_kboard
->immediate_echo
)
9047 /* If not, we should actually read a character. */
9051 KBOARD
*interrupted_kboard
= current_kboard
;
9052 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9053 key
= read_decoded_char (NILP (prompt
),
9054 current_binding
, last_nonmenu_event
,
9056 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9057 /* When switching to a new tty (with a new keyboard),
9058 read_char returns the new buffer, rather than -2
9059 (Bug#5095). This is because `terminal-init-xterm'
9060 calls read-char, which eats the wrong_kboard_jmpbuf
9061 return. Any better way to fix this? -- cyd */
9062 || (interrupted_kboard
!= current_kboard
))
9067 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9068 if (k
== interrupted_kboard
)
9073 /* Don't touch interrupted_kboard when it's been
9075 delayed_switch_frame
= Qnil
;
9076 goto replay_entire_sequence
;
9079 if (!NILP (delayed_switch_frame
))
9082 (interrupted_kboard
,
9083 Fcons (delayed_switch_frame
,
9084 KVAR (interrupted_kboard
, kbd_queue
)));
9085 delayed_switch_frame
= Qnil
;
9090 (interrupted_kboard
,
9091 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9093 /* If the side queue is non-empty, ensure it begins with a
9094 switch-frame, so we'll replay it in the right context. */
9095 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9096 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9097 !(EVENT_HAS_PARAMETERS (key
)
9098 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9102 XSETFRAME (frame
, interrupted_frame
);
9104 (interrupted_kboard
,
9105 Fcons (make_lispy_switch_frame (frame
),
9106 KVAR (interrupted_kboard
, kbd_queue
)));
9109 goto replay_entire_sequence
;
9113 /* read_char returns t when it shows a menu and the user rejects it.
9117 unbind_to (count
, Qnil
);
9122 /* read_char returns -1 at the end of a macro.
9123 Emacs 18 handles this by returning immediately with a
9124 zero, so that's what we'll do. */
9125 if (INTEGERP (key
) && XINT (key
) == -1)
9128 /* The Microsoft C compiler can't handle the goto that
9134 /* If the current buffer has been changed from under us, the
9135 keymap may have changed, so replay the sequence. */
9138 timer_resume_idle ();
9141 /* Reset the current buffer from the selected window
9142 in case something changed the former and not the latter.
9143 This is to be more consistent with the behavior
9144 of the command_loop_1. */
9145 if (fix_current_buffer
)
9147 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9149 if (XBUFFER (XWINDOW (selected_window
)->buffer
)
9151 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9154 goto replay_sequence
;
9157 /* If we have a quit that was typed in another frame, and
9158 quit_throw_to_read_char switched buffers,
9159 replay to get the right keymap. */
9161 && XINT (key
) == quit_char
9162 && current_buffer
!= starting_buffer
)
9165 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9170 goto replay_sequence
;
9175 if (EVENT_HAS_PARAMETERS (key
)
9176 /* Either a `switch-frame' or a `select-window' event. */
9177 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9179 /* If we're at the beginning of a key sequence, and the caller
9180 says it's okay, go ahead and return this event. If we're
9181 in the midst of a key sequence, delay it until the end. */
9182 if (t
> 0 || !can_return_switch_frame
)
9184 delayed_switch_frame
= key
;
9189 if (NILP (first_event
))
9192 /* Even if first_event does not specify a particular
9193 window/position, it's important to recompute the maps here
9194 since a long time might have passed since we entered
9195 read_key_sequence, and a timer (or process-filter or
9196 special-event-map, ...) might have switched the current buffer
9197 or the selected window from under us in the mean time. */
9198 if (fix_current_buffer
9199 && (XBUFFER (XWINDOW (selected_window
)->buffer
)
9201 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9202 current_binding
= active_maps (first_event
);
9206 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9210 /* Clicks in non-text areas get prefixed by the symbol
9211 in their CHAR-ADDRESS field. For example, a click on
9212 the mode line is prefixed by the symbol `mode-line'.
9214 Furthermore, key sequences beginning with mouse clicks
9215 are read using the keymaps of the buffer clicked on, not
9216 the current buffer. So we may have to switch the buffer
9219 When we turn one event into two events, we must make sure
9220 that neither of the two looks like the original--so that,
9221 if we replay the events, they won't be expanded again.
9222 If not for this, such reexpansion could happen either here
9223 or when user programs play with this-command-keys. */
9224 if (EVENT_HAS_PARAMETERS (key
))
9226 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9227 if (EQ (kind
, Qmouse_click
))
9229 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9230 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9233 || (!NILP (fake_prefixed_keys
)
9234 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9236 /* We're looking a second time at an event for which
9237 we generated a fake prefix key. Set
9238 last_real_key_start appropriately. */
9240 last_real_key_start
= t
- 1;
9243 if (last_real_key_start
== 0)
9245 /* Key sequences beginning with mouse clicks are
9246 read using the keymaps in the buffer clicked on,
9247 not the current buffer. If we're at the
9248 beginning of a key sequence, switch buffers. */
9249 if (WINDOWP (window
)
9250 && BUFFERP (XWINDOW (window
)->buffer
)
9251 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9253 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9258 /* Arrange to go back to the original buffer once we're
9259 done reading the key sequence. Note that we can't
9260 use save_excursion_{save,restore} here, because they
9261 save point as well as the current buffer; we don't
9262 want to save point, because redisplay may change it,
9263 to accommodate a Fset_window_start or something. We
9264 don't want to do this at the top of the function,
9265 because we may get input from a subprocess which
9266 wants to change the selected window and stuff (say,
9268 record_unwind_current_buffer ();
9270 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9272 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9273 goto replay_sequence
;
9277 /* Expand mode-line and scroll-bar events into two events:
9278 use posn as a fake prefix key. */
9280 && (NILP (fake_prefixed_keys
)
9281 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9283 if (bufsize
- t
<= 1)
9284 error ("Key sequence too long");
9287 keybuf
[t
+ 1] = key
;
9290 /* Record that a fake prefix key has been generated
9291 for KEY. Don't modify the event; this would
9292 prevent proper action when the event is pushed
9293 back into unread-command-events. */
9294 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9298 else if (CONSP (XCDR (key
))
9299 && CONSP (EVENT_START (key
))
9300 && CONSP (XCDR (EVENT_START (key
))))
9304 posn
= POSN_POSN (EVENT_START (key
));
9305 /* Handle menu-bar events:
9306 insert the dummy prefix event `menu-bar'. */
9307 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9309 if (bufsize
- t
<= 1)
9310 error ("Key sequence too long");
9312 keybuf
[t
+ 1] = key
;
9314 /* Zap the position in key, so we know that we've
9315 expanded it, and don't try to do so again. */
9316 POSN_SET_POSN (EVENT_START (key
),
9317 Fcons (posn
, Qnil
));
9320 goto replay_sequence
;
9322 else if (CONSP (posn
))
9324 /* We're looking at the second event of a
9325 sequence which we expanded before. Set
9326 last_real_key_start appropriately. */
9327 if (last_real_key_start
== t
&& t
> 0)
9328 last_real_key_start
= t
- 1;
9333 /* We have finally decided that KEY is something we might want
9335 new_binding
= follow_key (current_binding
, key
);
9337 /* If KEY wasn't bound, we'll try some fallbacks. */
9338 if (!NILP (new_binding
))
9339 /* This is needed for the following scenario:
9340 event 0: a down-event that gets dropped by calling replay_key.
9341 event 1: some normal prefix like C-h.
9342 After event 0, first_unbound is 0, after event 1 indec.start,
9343 fkey.start, and keytran.start are all 1, so when we see that
9344 C-h is bound, we need to update first_unbound. */
9345 first_unbound
= max (t
+ 1, first_unbound
);
9350 /* Remember the position to put an upper bound on indec.start. */
9351 first_unbound
= min (t
, first_unbound
);
9353 head
= EVENT_HEAD (key
);
9354 if (help_char_p (head
) && t
> 0)
9356 read_key_sequence_cmd
= Vprefix_help_command
;
9358 last_nonmenu_event
= key
;
9359 /* The Microsoft C compiler can't handle the goto that
9367 Lisp_Object breakdown
;
9370 breakdown
= parse_modifiers (head
);
9371 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9372 /* Attempt to reduce an unbound mouse event to a simpler
9373 event that is bound:
9374 Drags reduce to clicks.
9375 Double-clicks reduce to clicks.
9376 Triple-clicks reduce to double-clicks, then to clicks.
9377 Down-clicks are eliminated.
9378 Double-downs reduce to downs, then are eliminated.
9379 Triple-downs reduce to double-downs, then to downs,
9380 then are eliminated. */
9381 if (modifiers
& (down_modifier
| drag_modifier
9382 | double_modifier
| triple_modifier
))
9384 while (modifiers
& (down_modifier
| drag_modifier
9385 | double_modifier
| triple_modifier
))
9387 Lisp_Object new_head
, new_click
;
9388 if (modifiers
& triple_modifier
)
9389 modifiers
^= (double_modifier
| triple_modifier
);
9390 else if (modifiers
& double_modifier
)
9391 modifiers
&= ~double_modifier
;
9392 else if (modifiers
& drag_modifier
)
9393 modifiers
&= ~drag_modifier
;
9396 /* Dispose of this `down' event by simply jumping
9397 back to replay_key, to get another event.
9399 Note that if this event came from mock input,
9400 then just jumping back to replay_key will just
9401 hand it to us again. So we have to wipe out any
9404 We could delete keybuf[t] and shift everything
9405 after that to the left by one spot, but we'd also
9406 have to fix up any variable that points into
9407 keybuf, and shifting isn't really necessary
9410 Adding prefixes for non-textual mouse clicks
9411 creates two characters of mock input, and both
9412 must be thrown away. If we're only looking at
9413 the prefix now, we can just jump back to
9414 replay_key. On the other hand, if we've already
9415 processed the prefix, and now the actual click
9416 itself is giving us trouble, then we've lost the
9417 state of the keymaps we want to backtrack to, and
9418 we need to replay the whole sequence to rebuild
9421 Beyond that, only function key expansion could
9422 create more than two keys, but that should never
9423 generate mouse events, so it's okay to zero
9424 mock_input in that case too.
9426 FIXME: The above paragraph seems just plain
9427 wrong, if you consider things like
9428 xterm-mouse-mode. -stef
9430 Isn't this just the most wonderful code ever? */
9432 /* If mock_input > t + 1, the above simplification
9433 will actually end up dropping keys on the floor.
9434 This is probably OK for now, but even
9435 if mock_input <= t + 1, we need to adjust indec,
9437 Typical case [header-line down-mouse-N]:
9438 mock_input = 2, t = 1, fkey.end = 1,
9439 last_real_key_start = 0. */
9440 if (indec
.end
> last_real_key_start
)
9442 indec
.end
= indec
.start
9443 = min (last_real_key_start
, indec
.start
);
9444 indec
.map
= indec
.parent
;
9445 if (fkey
.end
> last_real_key_start
)
9447 fkey
.end
= fkey
.start
9448 = min (last_real_key_start
, fkey
.start
);
9449 fkey
.map
= fkey
.parent
;
9450 if (keytran
.end
> last_real_key_start
)
9452 keytran
.end
= keytran
.start
9453 = min (last_real_key_start
, keytran
.start
);
9454 keytran
.map
= keytran
.parent
;
9458 if (t
== last_real_key_start
)
9465 mock_input
= last_real_key_start
;
9466 goto replay_sequence
;
9471 = apply_modifiers (modifiers
, XCAR (breakdown
));
9473 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9475 /* Look for a binding for this new key. */
9476 new_binding
= follow_key (current_binding
, new_click
);
9478 /* If that click is bound, go for it. */
9479 if (!NILP (new_binding
))
9481 current_binding
= new_binding
;
9485 /* Otherwise, we'll leave key set to the drag event. */
9490 current_binding
= new_binding
;
9493 /* Normally, last_nonmenu_event gets the previous key we read.
9494 But when a mouse popup menu is being used,
9495 we don't update last_nonmenu_event; it continues to hold the mouse
9496 event that preceded the first level of menu. */
9497 if (!used_mouse_menu
)
9498 last_nonmenu_event
= key
;
9500 /* Record what part of this_command_keys is the current key sequence. */
9501 this_single_command_key_start
= this_command_key_count
- t
;
9503 /* Look for this sequence in input-decode-map.
9504 Scan from indec.end until we find a bound suffix. */
9505 while (indec
.end
< t
)
9507 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9511 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9512 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9517 mock_input
= diff
+ max (t
, mock_input
);
9518 goto replay_sequence
;
9522 if (!KEYMAPP (current_binding
)
9523 && !test_undefined (current_binding
)
9524 && indec
.start
>= t
)
9525 /* There is a binding and it's not a prefix.
9526 (and it doesn't have any input-decode-map translation pending).
9527 There is thus no function-key in this sequence.
9528 Moving fkey.start is important in this case to allow keytran.start
9529 to go over the sequence before we return (since we keep the
9530 invariant that keytran.end <= fkey.start). */
9533 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9536 /* If the sequence is unbound, see if we can hang a function key
9537 off the end of it. */
9538 /* Continue scan from fkey.end until we find a bound suffix. */
9539 while (fkey
.end
< indec
.start
)
9541 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9545 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9546 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9547 max (t
, mock_input
),
9548 /* If there's a binding (i.e.
9549 first_binding >= nmaps) we don't want
9550 to apply this function-key-mapping. */
9552 && (test_undefined (current_binding
)),
9557 mock_input
= diff
+ max (t
, mock_input
);
9558 /* Adjust the input-decode-map counters. */
9560 indec
.start
+= diff
;
9562 goto replay_sequence
;
9566 /* Look for this sequence in key-translation-map.
9567 Scan from keytran.end until we find a bound suffix. */
9568 while (keytran
.end
< fkey
.start
)
9570 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9574 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9575 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9580 mock_input
= diff
+ max (t
, mock_input
);
9581 /* Adjust the function-key-map and input-decode-map counters. */
9583 indec
.start
+= diff
;
9587 goto replay_sequence
;
9591 /* If KEY is not defined in any of the keymaps,
9592 and cannot be part of a function key or translation,
9593 and is an upper case letter
9594 use the corresponding lower-case letter instead. */
9595 if (NILP (current_binding
)
9596 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9598 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9599 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9600 || (XINT (key
) & shift_modifier
)))
9602 Lisp_Object new_key
;
9604 original_uppercase
= key
;
9605 original_uppercase_position
= t
- 1;
9607 if (XINT (key
) & shift_modifier
)
9608 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9610 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9611 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9613 /* We have to do this unconditionally, regardless of whether
9614 the lower-case char is defined in the keymaps, because they
9615 might get translated through function-key-map. */
9616 keybuf
[t
- 1] = new_key
;
9617 mock_input
= max (t
, mock_input
);
9618 shift_translated
= 1;
9620 goto replay_sequence
;
9622 /* If KEY is not defined in any of the keymaps,
9623 and cannot be part of a function key or translation,
9624 and is a shifted function key,
9625 use the corresponding unshifted function key instead. */
9626 if (NILP (current_binding
)
9627 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9629 Lisp_Object breakdown
= parse_modifiers (key
);
9631 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9633 if (modifiers
& shift_modifier
9634 /* Treat uppercase keys as shifted. */
9636 && (KEY_TO_CHAR (key
)
9637 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9638 && uppercasep (KEY_TO_CHAR (key
))))
9641 = (modifiers
& shift_modifier
9642 ? apply_modifiers (modifiers
& ~shift_modifier
,
9644 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9646 original_uppercase
= key
;
9647 original_uppercase_position
= t
- 1;
9649 /* We have to do this unconditionally, regardless of whether
9650 the lower-case char is defined in the keymaps, because they
9651 might get translated through function-key-map. */
9652 keybuf
[t
- 1] = new_key
;
9653 mock_input
= max (t
, mock_input
);
9654 /* Reset fkey (and consequently keytran) to apply
9655 function-key-map on the result, so that S-backspace is
9656 correctly mapped to DEL (via backspace). OTOH,
9657 input-decode-map doesn't need to go through it again. */
9658 fkey
.start
= fkey
.end
= 0;
9659 keytran
.start
= keytran
.end
= 0;
9660 shift_translated
= 1;
9662 goto replay_sequence
;
9667 read_key_sequence_cmd
= current_binding
;
9668 read_key_sequence_remapped
9669 /* Remap command through active keymaps.
9670 Do the remapping here, before the unbind_to so it uses the keymaps
9671 of the appropriate buffer. */
9672 = SYMBOLP (read_key_sequence_cmd
)
9673 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9676 unread_switch_frame
= delayed_switch_frame
;
9677 unbind_to (count
, Qnil
);
9679 /* Don't downcase the last character if the caller says don't.
9680 Don't downcase it if the result is undefined, either. */
9681 if ((dont_downcase_last
|| NILP (current_binding
))
9683 && t
- 1 == original_uppercase_position
)
9685 keybuf
[t
- 1] = original_uppercase
;
9686 shift_translated
= 0;
9689 if (shift_translated
)
9690 Vthis_command_keys_shift_translated
= Qt
;
9692 /* Occasionally we fabricate events, perhaps by expanding something
9693 according to function-key-map, or by adding a prefix symbol to a
9694 mouse click in the scroll bar or modeline. In this cases, return
9695 the entire generated key sequence, even if we hit an unbound
9696 prefix or a definition before the end. This means that you will
9697 be able to push back the event properly, and also means that
9698 read-key-sequence will always return a logical unit.
9701 for (; t
< mock_input
; t
++)
9703 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9704 && NILP (Fzerop (Vecho_keystrokes
)))
9705 echo_char (keybuf
[t
]);
9706 add_command_key (keybuf
[t
]);
9713 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9714 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9715 The sequence is sufficient to specify a non-prefix command in the
9716 current local and global maps.
9718 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9719 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9720 as a continuation of the previous key.
9722 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9723 convert the last event to lower case. (Normally any upper case event
9724 is converted to lower case if the original event is undefined and the lower
9725 case equivalent is defined.) A non-nil value is appropriate for reading
9726 a key sequence to be defined.
9728 A C-g typed while in this function is treated like any other character,
9729 and `quit-flag' is not set.
9731 If the key sequence starts with a mouse click, then the sequence is read
9732 using the keymaps of the buffer of the window clicked in, not the buffer
9733 of the selected window as normal.
9735 `read-key-sequence' drops unbound button-down events, since you normally
9736 only care about the click or drag events which follow them. If a drag
9737 or multi-click event is unbound, but the corresponding click event would
9738 be bound, `read-key-sequence' turns the event into a click event at the
9739 drag's starting position. This means that you don't have to distinguish
9740 between click and drag, double, or triple events unless you want to.
9742 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9743 lines separating windows, and scroll bars with imaginary keys
9744 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9746 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9747 function will process a switch-frame event if the user switches frames
9748 before typing anything. If the user switches frames in the middle of a
9749 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9750 is nil, then the event will be put off until after the current key sequence.
9752 `read-key-sequence' checks `function-key-map' for function key
9753 sequences, where they wouldn't conflict with ordinary bindings. See
9754 `function-key-map' for more details.
9756 The optional fifth argument CMD-LOOP, if non-nil, means
9757 that this key sequence is being read by something that will
9758 read commands one after another. It should be nil if the caller
9759 will read just one key sequence. */)
9760 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9762 Lisp_Object keybuf
[30];
9764 struct gcpro gcpro1
;
9765 ptrdiff_t count
= SPECPDL_INDEX ();
9768 CHECK_STRING (prompt
);
9771 specbind (Qinput_method_exit_on_first_char
,
9772 (NILP (cmd_loop
) ? Qt
: Qnil
));
9773 specbind (Qinput_method_use_echo_area
,
9774 (NILP (cmd_loop
) ? Qt
: Qnil
));
9776 memset (keybuf
, 0, sizeof keybuf
);
9778 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9780 if (NILP (continue_echo
))
9782 this_command_key_count
= 0;
9783 this_command_key_count_reset
= 0;
9784 this_single_command_key_start
= 0;
9787 #ifdef HAVE_WINDOW_SYSTEM
9788 if (display_hourglass_p
)
9789 cancel_hourglass ();
9792 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9793 prompt
, ! NILP (dont_downcase_last
),
9794 ! NILP (can_return_switch_frame
), 0);
9796 #if 0 /* The following is fine for code reading a key sequence and
9797 then proceeding with a lengthy computation, but it's not good
9798 for code reading keys in a loop, like an input method. */
9799 #ifdef HAVE_WINDOW_SYSTEM
9800 if (display_hourglass_p
)
9811 return unbind_to (count
, make_event_array (i
, keybuf
));
9814 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9815 Sread_key_sequence_vector
, 1, 5, 0,
9816 doc
: /* Like `read-key-sequence' but always return a vector. */)
9817 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9819 Lisp_Object keybuf
[30];
9821 struct gcpro gcpro1
;
9822 ptrdiff_t count
= SPECPDL_INDEX ();
9825 CHECK_STRING (prompt
);
9828 specbind (Qinput_method_exit_on_first_char
,
9829 (NILP (cmd_loop
) ? Qt
: Qnil
));
9830 specbind (Qinput_method_use_echo_area
,
9831 (NILP (cmd_loop
) ? Qt
: Qnil
));
9833 memset (keybuf
, 0, sizeof keybuf
);
9835 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9837 if (NILP (continue_echo
))
9839 this_command_key_count
= 0;
9840 this_command_key_count_reset
= 0;
9841 this_single_command_key_start
= 0;
9844 #ifdef HAVE_WINDOW_SYSTEM
9845 if (display_hourglass_p
)
9846 cancel_hourglass ();
9849 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9850 prompt
, ! NILP (dont_downcase_last
),
9851 ! NILP (can_return_switch_frame
), 0);
9853 #ifdef HAVE_WINDOW_SYSTEM
9854 if (display_hourglass_p
)
9864 return unbind_to (count
, Fvector (i
, keybuf
));
9867 /* Return true if input events are pending. */
9870 detect_input_pending (void)
9872 return input_pending
|| get_input_pending (0);
9875 /* Return true if input events other than mouse movements are
9879 detect_input_pending_ignore_squeezables (void)
9881 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9884 /* Return true if input events are pending, and run any pending timers. */
9887 detect_input_pending_run_timers (bool do_display
)
9889 unsigned old_timers_run
= timers_run
;
9892 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9894 if (old_timers_run
!= timers_run
&& do_display
)
9896 redisplay_preserve_echo_area (8);
9897 /* The following fixes a bug when using lazy-lock with
9898 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9899 from an idle timer function. The symptom of the bug is that
9900 the cursor sometimes doesn't become visible until the next X
9901 event is processed. --gerd. */
9903 Lisp_Object tail
, frame
;
9904 FOR_EACH_FRAME (tail
, frame
)
9905 if (FRAME_RIF (XFRAME (frame
)))
9906 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
9910 return input_pending
;
9913 /* This is called in some cases before a possible quit.
9914 It cases the next call to detect_input_pending to recompute input_pending.
9915 So calling this function unnecessarily can't do any harm. */
9918 clear_input_pending (void)
9923 /* Return true if there are pending requeued events.
9924 This isn't used yet. The hope is to make wait_reading_process_output
9925 call it, and return if it runs Lisp code that unreads something.
9926 The problem is, kbd_buffer_get_event needs to be fixed to know what
9927 to do in that case. It isn't trivial. */
9930 requeued_events_pending_p (void)
9932 return (!NILP (Vunread_command_events
));
9936 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9937 doc
: /* Return t if command input is currently available with no wait.
9938 Actually, the value is nil only if we can be sure that no input is available;
9939 if there is a doubt, the value is t. */)
9942 if (!NILP (Vunread_command_events
)
9943 || !NILP (Vunread_post_input_method_events
)
9944 || !NILP (Vunread_input_method_events
))
9947 /* Process non-user-visible events (Bug#10195). */
9948 process_special_events ();
9950 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
9951 | READABLE_EVENTS_FILTER_EVENTS
)
9955 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9956 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9959 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9962 if (total_keys
< NUM_RECENT_KEYS
)
9963 return Fvector (total_keys
, keys
);
9966 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9967 vcopy (val
, 0, keys
+ recent_keys_index
,
9968 NUM_RECENT_KEYS
- recent_keys_index
);
9969 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9970 keys
, recent_keys_index
);
9975 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9976 doc
: /* Return the key sequence that invoked this command.
9977 However, if the command has called `read-key-sequence', it returns
9978 the last key sequence that has been read.
9979 The value is a string or a vector.
9981 See also `this-command-keys-vector'. */)
9984 return make_event_array (this_command_key_count
,
9985 XVECTOR (this_command_keys
)->contents
);
9988 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9989 doc
: /* Return the key sequence that invoked this command, as a vector.
9990 However, if the command has called `read-key-sequence', it returns
9991 the last key sequence that has been read.
9993 See also `this-command-keys'. */)
9996 return Fvector (this_command_key_count
,
9997 XVECTOR (this_command_keys
)->contents
);
10000 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10001 Sthis_single_command_keys
, 0, 0, 0,
10002 doc
: /* Return the key sequence that invoked this command.
10003 More generally, it returns the last key sequence read, either by
10004 the command loop or by `read-key-sequence'.
10005 Unlike `this-command-keys', this function's value
10006 does not include prefix arguments.
10007 The value is always a vector. */)
10010 return Fvector (this_command_key_count
10011 - this_single_command_key_start
,
10012 (XVECTOR (this_command_keys
)->contents
10013 + this_single_command_key_start
));
10016 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10017 Sthis_single_command_raw_keys
, 0, 0, 0,
10018 doc
: /* Return the raw events that were read for this command.
10019 More generally, it returns the last key sequence read, either by
10020 the command loop or by `read-key-sequence'.
10021 Unlike `this-single-command-keys', this function's value
10022 shows the events before all translations (except for input methods).
10023 The value is always a vector. */)
10026 return Fvector (raw_keybuf_count
,
10027 (XVECTOR (raw_keybuf
)->contents
));
10030 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10031 Sreset_this_command_lengths
, 0, 0, 0,
10032 doc
: /* Make the unread events replace the last command and echo.
10033 Used in `universal-argument-other-key'.
10035 `universal-argument-other-key' rereads the event just typed.
10036 It then gets translated through `function-key-map'.
10037 The translated event has to replace the real events,
10038 both in the value of (this-command-keys) and in echoing.
10039 To achieve this, `universal-argument-other-key' calls
10040 `reset-this-command-lengths', which discards the record of reading
10041 these events the first time. */)
10044 this_command_key_count
= before_command_key_count
;
10045 if (this_command_key_count
< this_single_command_key_start
)
10046 this_single_command_key_start
= this_command_key_count
;
10048 echo_truncate (before_command_echo_length
);
10050 /* Cause whatever we put into unread-command-events
10051 to echo as if it were being freshly read from the keyboard. */
10052 this_command_key_count_reset
= 1;
10057 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10058 Sclear_this_command_keys
, 0, 1, 0,
10059 doc
: /* Clear out the vector that `this-command-keys' returns.
10060 Also clear the record of the last 100 events, unless optional arg
10061 KEEP-RECORD is non-nil. */)
10062 (Lisp_Object keep_record
)
10066 this_command_key_count
= 0;
10067 this_command_key_count_reset
= 0;
10069 if (NILP (keep_record
))
10071 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10072 ASET (recent_keys
, i
, Qnil
);
10074 recent_keys_index
= 0;
10079 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10080 doc
: /* Return the current depth in recursive edits. */)
10084 /* Wrap around reliably on integer overflow. */
10085 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10086 XSETINT (temp
, sum
);
10090 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10091 "FOpen dribble file: ",
10092 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10093 If FILE is nil, close any open dribble file.
10094 The file will be closed when Emacs exits. */)
10106 file
= Fexpand_file_name (file
, Qnil
);
10107 dribble
= fopen (SSDATA (file
), "w");
10109 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10114 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10115 doc
: /* Discard the contents of the terminal input buffer.
10116 Also end any kbd macro being defined. */)
10119 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10121 /* Discard the last command from the macro. */
10122 Fcancel_kbd_macro_events ();
10126 update_mode_lines
++;
10128 Vunread_command_events
= Qnil
;
10130 discard_tty_input ();
10132 kbd_fetch_ptr
= kbd_store_ptr
;
10138 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10139 doc
: /* Stop Emacs and return to superior process. You can resume later.
10140 If `cannot-suspend' is non-nil, or if the system doesn't support job
10141 control, run a subshell instead.
10143 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10144 to be read as terminal input by Emacs's parent, after suspension.
10146 Before suspending, run the normal hook `suspend-hook'.
10147 After resumption run the normal hook `suspend-resume-hook'.
10149 Some operating systems cannot stop the Emacs process and resume it later.
10150 On such systems, Emacs starts a subshell instead of suspending. */)
10151 (Lisp_Object stuffstring
)
10153 ptrdiff_t count
= SPECPDL_INDEX ();
10154 int old_height
, old_width
;
10156 struct gcpro gcpro1
;
10159 if (tty_list
&& tty_list
->next
)
10160 error ("There are other tty frames open; close them before suspending Emacs");
10162 if (!NILP (stuffstring
))
10163 CHECK_STRING (stuffstring
);
10165 /* Run the functions in suspend-hook. */
10166 hook
= intern ("suspend-hook");
10167 Frun_hooks (1, &hook
);
10169 GCPRO1 (stuffstring
);
10170 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10171 reset_all_sys_modes ();
10172 /* sys_suspend can get an error if it tries to fork a subshell
10173 and the system resources aren't available for that. */
10174 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10176 stuff_buffered_input (stuffstring
);
10177 if (cannot_suspend
)
10181 unbind_to (count
, Qnil
);
10183 /* Check if terminal/window size has changed.
10184 Note that this is not useful when we are running directly
10185 with a window system; but suspend should be disabled in that case. */
10186 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10187 if (width
!= old_width
|| height
!= old_height
)
10188 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10190 /* Run suspend-resume-hook. */
10191 hook
= intern ("suspend-resume-hook");
10192 Frun_hooks (1, &hook
);
10198 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10199 Then in any case stuff anything Emacs has read ahead and not used. */
10202 stuff_buffered_input (Lisp_Object stuffstring
)
10204 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10205 register unsigned char *p
;
10207 if (STRINGP (stuffstring
))
10209 register ptrdiff_t count
;
10211 p
= SDATA (stuffstring
);
10212 count
= SBYTES (stuffstring
);
10213 while (count
-- > 0)
10218 /* Anything we have read ahead, put back for the shell to read. */
10219 /* ?? What should this do when we have multiple keyboards??
10220 Should we ignore anything that was typed in at the "wrong" kboard?
10222 rms: we should stuff everything back into the kboard
10224 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10227 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10228 kbd_fetch_ptr
= kbd_buffer
;
10229 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10230 stuff_char (kbd_fetch_ptr
->code
);
10232 clear_event (kbd_fetch_ptr
);
10236 #endif /* SIGTSTP */
10240 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10242 input_available_clear_time
= time_to_clear
;
10244 /* Tell handle_interrupt to throw back to read_char, */
10245 waiting_for_input
= 1;
10247 /* If handle_interrupt was called before and buffered a C-g,
10248 make it run again now, to avoid timing error. */
10249 if (!NILP (Vquit_flag
))
10250 quit_throw_to_read_char (0);
10254 clear_waiting_for_input (void)
10256 /* Tell handle_interrupt not to throw back to read_char, */
10257 waiting_for_input
= 0;
10258 input_available_clear_time
= 0;
10261 /* The SIGINT handler.
10263 If we have a frame on the controlling tty, we assume that the
10264 SIGINT was generated by C-g, so we call handle_interrupt.
10265 Otherwise, tell QUIT to kill Emacs. */
10268 handle_interrupt_signal (int sig
)
10270 /* See if we have an active terminal on our controlling tty. */
10271 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10274 /* If there are no frames there, let's pretend that we are a
10275 well-behaving UN*X program and quit. We must not call Lisp
10276 in a signal handler, so tell QUIT to exit when it is
10278 Vquit_flag
= Qkill_emacs
;
10282 /* Otherwise, the SIGINT was probably generated by C-g. */
10284 /* Set internal_last_event_frame to the top frame of the
10285 controlling tty, if we have a frame there. We disable the
10286 interrupt key on secondary ttys, so the SIGINT must have come
10287 from the controlling tty. */
10288 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10290 handle_interrupt (1);
10295 deliver_interrupt_signal (int sig
)
10297 deliver_process_signal (sig
, handle_interrupt_signal
);
10301 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10302 of the number of times C-g has been requested. If C-g is pressed
10303 enough times, then quit anyway. See bug#6585. */
10304 static int volatile force_quit_count
;
10306 /* This routine is called at interrupt level in response to C-g.
10308 It is called from the SIGINT handler or kbd_buffer_store_event.
10310 If `waiting_for_input' is non zero, then unless `echoing' is
10311 nonzero, immediately throw back to read_char.
10313 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10314 eval to throw, when it gets a chance. If quit-flag is already
10315 non-nil, it stops the job right away. */
10318 handle_interrupt (bool in_signal_handler
)
10324 /* XXX This code needs to be revised for multi-tty support. */
10325 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10327 if (! in_signal_handler
)
10329 /* If SIGINT isn't blocked, don't let us be interrupted by
10330 a SIGINT. It might be harmful due to non-reentrancy
10331 in I/O functions. */
10333 sigemptyset (&blocked
);
10334 sigaddset (&blocked
, SIGINT
);
10335 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10339 reset_all_sys_modes ();
10343 * On systems which can suspend the current process and return to the original
10344 * shell, this command causes the user to end up back at the shell.
10345 * The "Auto-save" and "Abort" questions are not asked until
10346 * the user elects to return to emacs, at which point he can save the current
10347 * job and either dump core or continue.
10351 /* Perhaps should really fork an inferior shell?
10352 But that would not provide any way to get back
10353 to the original shell, ever. */
10354 printf ("No support for stopping a process on this operating system;\n");
10355 printf ("you can continue or abort.\n");
10356 #endif /* not SIGTSTP */
10358 /* We must remain inside the screen area when the internal terminal
10359 is used. Note that [Enter] is not echoed by dos. */
10360 cursor_to (SELECTED_FRAME (), 0, 0);
10362 /* It doesn't work to autosave while GC is in progress;
10363 the code used for auto-saving doesn't cope with the mark bit. */
10364 if (!gc_in_progress
)
10366 printf ("Auto-save? (y or n) ");
10368 if (((c
= getchar ()) & ~040) == 'Y')
10370 Fdo_auto_save (Qt
, Qnil
);
10372 printf ("\r\nAuto-save done");
10373 #else /* not MSDOS */
10374 printf ("Auto-save done\n");
10375 #endif /* not MSDOS */
10377 while (c
!= '\n') c
= getchar ();
10381 /* During GC, it must be safe to reenable quitting again. */
10382 Vinhibit_quit
= Qnil
;
10385 #endif /* not MSDOS */
10386 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10387 printf ("but will instead do a real quit after garbage collection ends\r\n");
10392 printf ("\r\nAbort? (y or n) ");
10393 #else /* not MSDOS */
10394 printf ("Abort (and dump core)? (y or n) ");
10395 #endif /* not MSDOS */
10397 if (((c
= getchar ()) & ~040) == 'Y')
10399 while (c
!= '\n') c
= getchar ();
10401 printf ("\r\nContinuing...\r\n");
10402 #else /* not MSDOS */
10403 printf ("Continuing...\n");
10404 #endif /* not MSDOS */
10406 init_all_sys_modes ();
10410 /* If executing a function that wants to be interrupted out of
10411 and the user has not deferred quitting by binding `inhibit-quit'
10412 then quit right away. */
10413 if (immediate_quit
&& NILP (Vinhibit_quit
))
10415 struct gl_state_s saved
;
10416 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10418 immediate_quit
= 0;
10419 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10421 GCPRO4 (saved
.object
, saved
.global_code
,
10422 saved
.current_syntax_table
, saved
.old_prop
);
10423 Fsignal (Qquit
, Qnil
);
10428 { /* Else request quit when it's safe. */
10429 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10430 force_quit_count
= count
;
10433 immediate_quit
= 1;
10434 Vinhibit_quit
= Qnil
;
10440 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10442 /* TODO: The longjmp in this call throws the NS event loop integration off,
10443 and it seems to do fine without this. Probably some attention
10444 needs to be paid to the setting of waiting_for_input in
10445 wait_reading_process_output() under HAVE_NS because of the call
10446 to ns_select there (needed because otherwise events aren't picked up
10447 outside of polling since we don't get SIGIO like X and we don't have a
10448 separate event loop thread like W32. */
10450 if (waiting_for_input
&& !echoing
)
10451 quit_throw_to_read_char (in_signal_handler
);
10455 /* Handle a C-g by making read_char return C-g. */
10458 quit_throw_to_read_char (bool from_signal
)
10460 /* When not called from a signal handler it is safe to call
10462 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10463 Fkill_emacs (Qnil
);
10465 /* Prevent another signal from doing this before we finish. */
10466 clear_waiting_for_input ();
10469 Vunread_command_events
= Qnil
;
10471 if (FRAMEP (internal_last_event_frame
)
10472 && !EQ (internal_last_event_frame
, selected_frame
))
10473 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10476 sys_longjmp (getcjmp
, 1);
10479 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10480 Sset_input_interrupt_mode
, 1, 1, 0,
10481 doc
: /* Set interrupt mode of reading keyboard input.
10482 If INTERRUPT is non-nil, Emacs will use input interrupts;
10483 otherwise Emacs uses CBREAK mode.
10485 See also `current-input-mode'. */)
10486 (Lisp_Object interrupt
)
10488 bool new_interrupt_input
;
10489 #ifdef USABLE_SIGIO
10490 #ifdef HAVE_X_WINDOWS
10491 if (x_display_list
!= NULL
)
10493 /* When using X, don't give the user a real choice,
10494 because we haven't implemented the mechanisms to support it. */
10495 new_interrupt_input
= 1;
10498 #endif /* HAVE_X_WINDOWS */
10499 new_interrupt_input
= !NILP (interrupt
);
10500 #else /* not USABLE_SIGIO */
10501 new_interrupt_input
= 0;
10502 #endif /* not USABLE_SIGIO */
10504 if (new_interrupt_input
!= interrupt_input
)
10506 #ifdef POLL_FOR_INPUT
10510 /* this causes startup screen to be restored and messes with the mouse */
10511 reset_all_sys_modes ();
10512 interrupt_input
= new_interrupt_input
;
10513 init_all_sys_modes ();
10515 interrupt_input
= new_interrupt_input
;
10518 #ifdef POLL_FOR_INPUT
10519 poll_suppress_count
= 1;
10526 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10527 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10528 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10529 C-q in key sequences.
10531 This setting only has an effect on tty terminals and only when
10532 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10534 See also `current-input-mode'. */)
10535 (Lisp_Object flow
, Lisp_Object terminal
)
10537 struct terminal
*t
= get_terminal (terminal
, 1);
10538 struct tty_display_info
*tty
;
10539 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10541 tty
= t
->display_info
.tty
;
10543 if (tty
->flow_control
!= !NILP (flow
))
10546 /* This causes startup screen to be restored and messes with the mouse. */
10547 reset_sys_modes (tty
);
10550 tty
->flow_control
= !NILP (flow
);
10553 init_sys_modes (tty
);
10559 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10560 doc
: /* Enable or disable 8-bit input on TERMINAL.
10561 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10562 bit as the Meta modifier.
10564 If META is nil, Emacs will ignore the top bit, on the assumption it is
10567 Otherwise, Emacs will accept and pass through 8-bit input without
10568 specially interpreting the top bit.
10570 This setting only has an effect on tty terminal devices.
10572 Optional parameter TERMINAL specifies the tty terminal device to use.
10573 It may be a terminal object, a frame, or nil for the terminal used by
10574 the currently selected frame.
10576 See also `current-input-mode'. */)
10577 (Lisp_Object meta
, Lisp_Object terminal
)
10579 struct terminal
*t
= get_terminal (terminal
, 1);
10580 struct tty_display_info
*tty
;
10583 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10585 tty
= t
->display_info
.tty
;
10589 else if (EQ (meta
, Qt
))
10594 if (tty
->meta_key
!= new_meta
)
10597 /* this causes startup screen to be restored and messes with the mouse */
10598 reset_sys_modes (tty
);
10601 tty
->meta_key
= new_meta
;
10604 init_sys_modes (tty
);
10610 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10611 doc
: /* Specify character used for quitting.
10612 QUIT must be an ASCII character.
10614 This function only has an effect on the controlling tty of the Emacs
10617 See also `current-input-mode'. */)
10620 struct terminal
*t
= get_named_tty ("/dev/tty");
10621 struct tty_display_info
*tty
;
10622 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10624 tty
= t
->display_info
.tty
;
10626 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10627 error ("QUIT must be an ASCII character");
10630 /* this causes startup screen to be restored and messes with the mouse */
10631 reset_sys_modes (tty
);
10634 /* Don't let this value be out of range. */
10635 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10638 init_sys_modes (tty
);
10644 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10645 doc
: /* Set mode of reading keyboard input.
10646 First arg INTERRUPT non-nil means use input interrupts;
10647 nil means use CBREAK mode.
10648 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10649 (no effect except in CBREAK mode).
10650 Third arg META t means accept 8-bit input (for a Meta key).
10651 META nil means ignore the top bit, on the assumption it is parity.
10652 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10653 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10654 See also `current-input-mode'. */)
10655 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10657 Fset_input_interrupt_mode (interrupt
);
10658 Fset_output_flow_control (flow
, Qnil
);
10659 Fset_input_meta_mode (meta
, Qnil
);
10661 Fset_quit_char (quit
);
10665 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10666 doc
: /* Return information about the way Emacs currently reads keyboard input.
10667 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10668 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10669 nil, Emacs is using CBREAK mode.
10670 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10671 terminal; this does not apply if Emacs uses interrupt-driven input.
10672 META is t if accepting 8-bit input with 8th bit as Meta flag.
10673 META nil means ignoring the top bit, on the assumption it is parity.
10674 META is neither t nor nil if accepting 8-bit input and using
10675 all 8 bits as the character code.
10676 QUIT is the character Emacs currently uses to quit.
10677 The elements of this list correspond to the arguments of
10678 `set-input-mode'. */)
10681 Lisp_Object val
[4];
10682 struct frame
*sf
= XFRAME (selected_frame
);
10684 val
[0] = interrupt_input
? Qt
: Qnil
;
10685 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10687 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10688 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10690 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10697 XSETFASTINT (val
[3], quit_char
);
10699 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10702 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10703 doc
: /* Return position information for pixel coordinates X and Y.
10704 By default, X and Y are relative to text area of the selected window.
10705 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10706 If optional fourth arg WHOLE is non-nil, X is relative to the left
10707 edge of the window.
10709 The return value is similar to a mouse click 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 x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10718 if (NILP (frame_or_window
))
10719 frame_or_window
= selected_window
;
10721 if (WINDOWP (frame_or_window
))
10723 struct window
*w
= decode_live_window (frame_or_window
);
10725 XSETINT (x
, (XINT (x
)
10726 + WINDOW_LEFT_EDGE_X (w
)
10728 ? window_box_left_offset (w
, TEXT_AREA
)
10730 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10731 frame_or_window
= w
->frame
;
10734 CHECK_LIVE_FRAME (frame_or_window
);
10736 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10739 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10740 doc
: /* Return position information for buffer POS in WINDOW.
10741 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10743 Return nil if position is not visible in window. Otherwise,
10744 the return value is similar to that returned by `event-start' for
10745 a mouse click at the upper left corner of the glyph corresponding
10746 to the given buffer position:
10747 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10748 IMAGE (DX . DY) (WIDTH . HEIGHT))
10749 The `posn-' functions access elements of such lists. */)
10750 (Lisp_Object pos
, Lisp_Object window
)
10755 window
= selected_window
;
10757 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10760 Lisp_Object x
= XCAR (tem
);
10761 Lisp_Object y
= XCAR (XCDR (tem
));
10763 /* Point invisible due to hscrolling? */
10766 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10774 * Set up a new kboard object with reasonable initial values.
10777 init_kboard (KBOARD
*kb
)
10779 kset_overriding_terminal_local_map (kb
, Qnil
);
10780 kset_last_command (kb
, Qnil
);
10781 kset_real_last_command (kb
, Qnil
);
10782 kset_keyboard_translate_table (kb
, Qnil
);
10783 kset_last_repeatable_command (kb
, Qnil
);
10784 kset_prefix_arg (kb
, Qnil
);
10785 kset_last_prefix_arg (kb
, Qnil
);
10786 kset_kbd_queue (kb
, Qnil
);
10787 kb
->kbd_queue_has_data
= 0;
10788 kb
->immediate_echo
= 0;
10789 kset_echo_string (kb
, Qnil
);
10790 kb
->echo_after_prompt
= -1;
10791 kb
->kbd_macro_buffer
= 0;
10792 kb
->kbd_macro_bufsize
= 0;
10793 kset_defining_kbd_macro (kb
, Qnil
);
10794 kset_last_kbd_macro (kb
, Qnil
);
10795 kb
->reference_count
= 0;
10796 kset_system_key_alist (kb
, Qnil
);
10797 kset_system_key_syms (kb
, Qnil
);
10798 kset_window_system (kb
, Qt
); /* Unset. */
10799 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10800 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10801 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10802 kset_default_minibuffer_frame (kb
, Qnil
);
10806 * Destroy the contents of a kboard object, but not the object itself.
10807 * We use this just before deleting it, or if we're going to initialize
10808 * it a second time.
10811 wipe_kboard (KBOARD
*kb
)
10813 xfree (kb
->kbd_macro_buffer
);
10816 /* Free KB and memory referenced from it. */
10819 delete_kboard (KBOARD
*kb
)
10823 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10826 *kbp
= kb
->next_kboard
;
10828 /* Prevent a dangling reference to KB. */
10829 if (kb
== current_kboard
10830 && FRAMEP (selected_frame
)
10831 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10833 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10835 if (current_kboard
== kb
)
10844 init_keyboard (void)
10846 /* This is correct before outermost invocation of the editor loop. */
10847 command_loop_level
= -1;
10848 immediate_quit
= 0;
10849 quit_char
= Ctl ('g');
10850 Vunread_command_events
= Qnil
;
10851 timer_idleness_start_time
= invalid_emacs_time ();
10853 recent_keys_index
= 0;
10854 kbd_fetch_ptr
= kbd_buffer
;
10855 kbd_store_ptr
= kbd_buffer
;
10856 do_mouse_tracking
= Qnil
;
10858 interrupt_input_blocked
= 0;
10859 pending_signals
= 0;
10861 /* This means that command_loop_1 won't try to select anything the first
10863 internal_last_event_frame
= Qnil
;
10864 Vlast_event_frame
= internal_last_event_frame
;
10866 current_kboard
= initial_kboard
;
10867 /* Re-initialize the keyboard again. */
10868 wipe_kboard (current_kboard
);
10869 init_kboard (current_kboard
);
10870 /* A value of nil for Vwindow_system normally means a tty, but we also use
10871 it for the initial terminal since there is no window system there. */
10872 kset_window_system (current_kboard
, Qnil
);
10874 if (!noninteractive
)
10876 /* Before multi-tty support, these handlers used to be installed
10877 only if the current session was a tty session. Now an Emacs
10878 session may have multiple display types, so we always handle
10879 SIGINT. There is special code in handle_interrupt_signal to exit
10880 Emacs on SIGINT when there are no termcap frames on the
10881 controlling terminal. */
10882 struct sigaction action
;
10883 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10884 sigaction (SIGINT
, &action
, 0);
10886 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10887 SIGQUIT and we can't tell which one it will give us. */
10888 sigaction (SIGQUIT
, &action
, 0);
10889 #endif /* not DOS_NT */
10891 #ifdef USABLE_SIGIO
10892 if (!noninteractive
)
10894 struct sigaction action
;
10895 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10896 sigaction (SIGIO
, &action
, 0);
10900 /* Use interrupt input by default, if it works and noninterrupt input
10901 has deficiencies. */
10903 #ifdef INTERRUPT_INPUT
10904 interrupt_input
= 1;
10906 interrupt_input
= 0;
10909 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10912 if (keyboard_init_hook
)
10913 (*keyboard_init_hook
) ();
10915 #ifdef POLL_FOR_INPUT
10917 poll_suppress_count
= 1;
10922 /* This type's only use is in syms_of_keyboard, to initialize the
10923 event header symbols and put properties on them. */
10924 struct event_head
{
10930 static const struct event_head head_table
[] = {
10931 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10932 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10933 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10934 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10935 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10936 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10937 /* `select-window' should be handled just like `switch-frame'
10938 in read_key_sequence. */
10939 {&Qselect_window
, "select-window", &Qswitch_frame
}
10943 syms_of_keyboard (void)
10945 pending_funcalls
= Qnil
;
10946 staticpro (&pending_funcalls
);
10948 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10949 staticpro (&Vlispy_mouse_stem
);
10952 DEFSYM (QCimage
, ":image");
10953 DEFSYM (Qhelp_echo
, "help-echo");
10954 DEFSYM (QCrtl
, ":rtl");
10956 staticpro (&item_properties
);
10957 item_properties
= Qnil
;
10959 staticpro (&tool_bar_item_properties
);
10960 tool_bar_item_properties
= Qnil
;
10961 staticpro (&tool_bar_items_vector
);
10962 tool_bar_items_vector
= Qnil
;
10964 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10965 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10966 DEFSYM (Qself_insert_command
, "self-insert-command");
10967 DEFSYM (Qforward_char
, "forward-char");
10968 DEFSYM (Qbackward_char
, "backward-char");
10969 DEFSYM (Qdisabled
, "disabled");
10970 DEFSYM (Qundefined
, "undefined");
10971 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10972 DEFSYM (Qpost_command_hook
, "post-command-hook");
10973 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10974 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10975 DEFSYM (Qfunction_key
, "function-key");
10976 DEFSYM (Qmouse_click
, "mouse-click");
10977 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10978 DEFSYM (Qsave_session
, "save-session");
10979 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10980 DEFSYM (Qmenu_enable
, "menu-enable");
10983 DEFSYM (Qlanguage_change
, "language-change");
10987 DEFSYM (Qfile_w32notify
, "file-w32notify");
10991 DEFSYM (Qdbus_event
, "dbus-event");
10994 #ifdef HAVE_INOTIFY
10995 DEFSYM (Qfile_inotify
, "file-inotify");
10996 #endif /* HAVE_INOTIFY */
10998 DEFSYM (QCenable
, ":enable");
10999 DEFSYM (QCvisible
, ":visible");
11000 DEFSYM (QChelp
, ":help");
11001 DEFSYM (QCfilter
, ":filter");
11002 DEFSYM (QCbutton
, ":button");
11003 DEFSYM (QCkeys
, ":keys");
11004 DEFSYM (QCkey_sequence
, ":key-sequence");
11005 DEFSYM (QCtoggle
, ":toggle");
11006 DEFSYM (QCradio
, ":radio");
11007 DEFSYM (QClabel
, ":label");
11008 DEFSYM (QCvert_only
, ":vert-only");
11010 DEFSYM (Qmode_line
, "mode-line");
11011 DEFSYM (Qvertical_line
, "vertical-line");
11012 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11013 DEFSYM (Qmenu_bar
, "menu-bar");
11015 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11017 DEFSYM (Qabove_handle
, "above-handle");
11018 DEFSYM (Qhandle
, "handle");
11019 DEFSYM (Qbelow_handle
, "below-handle");
11020 DEFSYM (Qup
, "up");
11021 DEFSYM (Qdown
, "down");
11022 DEFSYM (Qtop
, "top");
11023 DEFSYM (Qbottom
, "bottom");
11024 DEFSYM (Qend_scroll
, "end-scroll");
11025 DEFSYM (Qratio
, "ratio");
11027 DEFSYM (Qevent_kind
, "event-kind");
11028 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11029 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11030 DEFSYM (Qmodifier_cache
, "modifier-cache");
11032 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11033 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11035 DEFSYM (Qpolling_period
, "polling-period");
11037 DEFSYM (Qx_set_selection
, "x-set-selection");
11038 DEFSYM (QPRIMARY
, "PRIMARY");
11039 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11040 DEFSYM (Qhandle_select_window
, "handle-select-window");
11042 DEFSYM (Qinput_method_function
, "input-method-function");
11043 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11044 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11046 DEFSYM (Qhelp_form_show
, "help-form-show");
11048 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11049 Fset (Qinput_method_use_echo_area
, Qnil
);
11051 last_point_position_buffer
= Qnil
;
11052 last_point_position_window
= Qnil
;
11056 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11058 for (i
= 0; i
< len
; i
++)
11060 const struct event_head
*p
= &head_table
[i
];
11061 *p
->var
= intern_c_string (p
->name
);
11062 staticpro (p
->var
);
11063 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11064 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11068 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11069 staticpro (&button_down_location
);
11070 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11071 staticpro (&mouse_syms
);
11072 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11073 / sizeof (lispy_wheel_names
[0])),
11075 staticpro (&wheel_syms
);
11079 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11081 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11082 for (i
= 0; i
< len
; i
++)
11083 if (modifier_names
[i
])
11084 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11085 staticpro (&modifier_symbols
);
11088 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11089 staticpro (&recent_keys
);
11091 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11092 staticpro (&this_command_keys
);
11094 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11095 staticpro (&raw_keybuf
);
11097 DEFSYM (Qcommand_execute
, "command-execute");
11099 accent_key_syms
= Qnil
;
11100 staticpro (&accent_key_syms
);
11102 func_key_syms
= Qnil
;
11103 staticpro (&func_key_syms
);
11105 drag_n_drop_syms
= Qnil
;
11106 staticpro (&drag_n_drop_syms
);
11108 unread_switch_frame
= Qnil
;
11109 staticpro (&unread_switch_frame
);
11111 internal_last_event_frame
= Qnil
;
11112 staticpro (&internal_last_event_frame
);
11114 read_key_sequence_cmd
= Qnil
;
11115 staticpro (&read_key_sequence_cmd
);
11116 read_key_sequence_remapped
= Qnil
;
11117 staticpro (&read_key_sequence_remapped
);
11119 menu_bar_one_keymap_changed_items
= Qnil
;
11120 staticpro (&menu_bar_one_keymap_changed_items
);
11122 menu_bar_items_vector
= Qnil
;
11123 staticpro (&menu_bar_items_vector
);
11125 help_form_saved_window_configs
= Qnil
;
11126 staticpro (&help_form_saved_window_configs
);
11128 defsubr (&Scurrent_idle_time
);
11129 defsubr (&Sevent_symbol_parse_modifiers
);
11130 defsubr (&Sevent_convert_list
);
11131 defsubr (&Sread_key_sequence
);
11132 defsubr (&Sread_key_sequence_vector
);
11133 defsubr (&Srecursive_edit
);
11134 defsubr (&Strack_mouse
);
11135 defsubr (&Sinput_pending_p
);
11136 defsubr (&Srecent_keys
);
11137 defsubr (&Sthis_command_keys
);
11138 defsubr (&Sthis_command_keys_vector
);
11139 defsubr (&Sthis_single_command_keys
);
11140 defsubr (&Sthis_single_command_raw_keys
);
11141 defsubr (&Sreset_this_command_lengths
);
11142 defsubr (&Sclear_this_command_keys
);
11143 defsubr (&Ssuspend_emacs
);
11144 defsubr (&Sabort_recursive_edit
);
11145 defsubr (&Sexit_recursive_edit
);
11146 defsubr (&Srecursion_depth
);
11147 defsubr (&Stop_level
);
11148 defsubr (&Sdiscard_input
);
11149 defsubr (&Sopen_dribble_file
);
11150 defsubr (&Sset_input_interrupt_mode
);
11151 defsubr (&Sset_output_flow_control
);
11152 defsubr (&Sset_input_meta_mode
);
11153 defsubr (&Sset_quit_char
);
11154 defsubr (&Sset_input_mode
);
11155 defsubr (&Scurrent_input_mode
);
11156 defsubr (&Sposn_at_point
);
11157 defsubr (&Sposn_at_x_y
);
11159 DEFVAR_LISP ("last-command-event", last_command_event
,
11160 doc
: /* Last input event that was part of a command. */);
11162 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11163 doc
: /* Last input event in a command, except for mouse menu events.
11164 Mouse menus give back keys that don't look like mouse events;
11165 this variable holds the actual mouse event that led to the menu,
11166 so that you can determine whether the command was run by mouse or not. */);
11168 DEFVAR_LISP ("last-input-event", last_input_event
,
11169 doc
: /* Last input event. */);
11171 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11172 doc
: /* List of events to be read as the command input.
11173 These events are processed first, before actual keyboard input.
11174 Events read from this list are not normally added to `this-command-keys',
11175 as they will already have been added once as they were read for the first time.
11176 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11177 Vunread_command_events
= Qnil
;
11179 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11180 doc
: /* List of events to be processed as input by input methods.
11181 These events are processed before `unread-command-events'
11182 and actual keyboard input, but are not given to `input-method-function'. */);
11183 Vunread_post_input_method_events
= Qnil
;
11185 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11186 doc
: /* List of events to be processed as input by input methods.
11187 These events are processed after `unread-command-events', but
11188 before actual keyboard input.
11189 If there's an active input method, the events are given to
11190 `input-method-function'. */);
11191 Vunread_input_method_events
= Qnil
;
11193 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11194 doc
: /* Meta-prefix character code.
11195 Meta-foo as command input turns into this character followed by foo. */);
11196 XSETINT (meta_prefix_char
, 033);
11198 DEFVAR_KBOARD ("last-command", Vlast_command
,
11199 doc
: /* The last command executed.
11200 Normally a symbol with a function definition, but can be whatever was found
11201 in the keymap, or whatever the variable `this-command' was set to by that
11204 The value `mode-exit' is special; it means that the previous command
11205 read an event that told it to exit, and it did so and unread that event.
11206 In other words, the present command is the event that made the previous
11209 The value `kill-region' is special; it means that the previous command
11210 was a kill command.
11212 `last-command' has a separate binding for each terminal device.
11213 See Info node `(elisp)Multiple Terminals'. */);
11215 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11216 doc
: /* Same as `last-command', but never altered by Lisp code.
11217 Taken from the previous value of `real-this-command'. */);
11219 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11220 doc
: /* Last command that may be repeated.
11221 The last command executed that was not bound to an input event.
11222 This is the command `repeat' will try to repeat.
11223 Taken from a previous value of `real-this-command'. */);
11225 DEFVAR_LISP ("this-command", Vthis_command
,
11226 doc
: /* The command now being executed.
11227 The command can set this variable; whatever is put here
11228 will be in `last-command' during the following command. */);
11229 Vthis_command
= Qnil
;
11231 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11232 doc
: /* This is like `this-command', except that commands should never modify it. */);
11233 Vreal_this_command
= Qnil
;
11235 DEFVAR_LISP ("this-command-keys-shift-translated",
11236 Vthis_command_keys_shift_translated
,
11237 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11238 Shift-translation occurs when there is no binding for the key sequence
11239 as entered, but a binding was found by changing an upper-case letter
11240 to lower-case, or a shifted function key to an unshifted one. */);
11241 Vthis_command_keys_shift_translated
= Qnil
;
11243 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11244 doc
: /* The command bound to the current key sequence before remapping.
11245 It equals `this-command' if the original command was not remapped through
11246 any of the active keymaps. Otherwise, the value of `this-command' is the
11247 result of looking up the original command in the active keymaps. */);
11248 Vthis_original_command
= Qnil
;
11250 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11251 doc
: /* Number of input events between auto-saves.
11252 Zero means disable autosaving due to number of characters typed. */);
11253 auto_save_interval
= 300;
11255 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11256 doc
: /* Number of seconds idle time before auto-save.
11257 Zero or nil means disable auto-saving due to idleness.
11258 After auto-saving due to this many seconds of idle time,
11259 Emacs also does a garbage collection if that seems to be warranted. */);
11260 XSETFASTINT (Vauto_save_timeout
, 30);
11262 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11263 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11264 The value may be integer or floating point.
11265 If the value is zero, don't echo at all. */);
11266 Vecho_keystrokes
= make_number (1);
11268 DEFVAR_INT ("polling-period", polling_period
,
11269 doc
: /* Interval between polling for input during Lisp execution.
11270 The reason for polling is to make C-g work to stop a running program.
11271 Polling is needed only when using X windows and SIGIO does not work.
11272 Polling is automatically disabled in all other cases. */);
11273 polling_period
= 2;
11275 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11276 doc
: /* Maximum time between mouse clicks to make a double-click.
11277 Measured in milliseconds. The value nil means disable double-click
11278 recognition; t means double-clicks have no time limit and are detected
11279 by position only. */);
11280 Vdouble_click_time
= make_number (500);
11282 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11283 doc
: /* Maximum mouse movement between clicks to make a double-click.
11284 On window-system frames, value is the number of pixels the mouse may have
11285 moved horizontally or vertically between two clicks to make a double-click.
11286 On non window-system frames, value is interpreted in units of 1/8 characters
11289 This variable is also the threshold for motion of the mouse
11290 to count as a drag. */);
11291 double_click_fuzz
= 3;
11293 DEFVAR_INT ("num-input-keys", num_input_keys
,
11294 doc
: /* Number of complete key sequences read as input so far.
11295 This includes key sequences read from keyboard macros.
11296 The number is effectively the number of interactive command invocations. */);
11297 num_input_keys
= 0;
11299 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11300 doc
: /* Number of input events read from the keyboard so far.
11301 This does not include events generated by keyboard macros. */);
11302 num_nonmacro_input_events
= 0;
11304 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11305 doc
: /* The frame in which the most recently read event occurred.
11306 If the last event came from a keyboard macro, this is set to `macro'. */);
11307 Vlast_event_frame
= Qnil
;
11309 /* This variable is set up in sysdep.c. */
11310 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11311 doc
: /* The ERASE character as set by the user with stty. */);
11313 DEFVAR_LISP ("help-char", Vhelp_char
,
11314 doc
: /* Character to recognize as meaning Help.
11315 When it is read, do `(eval help-form)', and display result if it's a string.
11316 If the value of `help-form' is nil, this char can be read normally. */);
11317 XSETINT (Vhelp_char
, Ctl ('H'));
11319 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11320 doc
: /* List of input events to recognize as meaning Help.
11321 These work just like the value of `help-char' (see that). */);
11322 Vhelp_event_list
= Qnil
;
11324 DEFVAR_LISP ("help-form", Vhelp_form
,
11325 doc
: /* Form to execute when character `help-char' is read.
11326 If the form returns a string, that string is displayed.
11327 If `help-form' is nil, the help char is not recognized. */);
11330 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11331 doc
: /* Command to run when `help-char' character follows a prefix key.
11332 This command is used only when there is no actual binding
11333 for that character after that prefix key. */);
11334 Vprefix_help_command
= Qnil
;
11336 DEFVAR_LISP ("top-level", Vtop_level
,
11337 doc
: /* Form to evaluate when Emacs starts up.
11338 Useful to set before you dump a modified Emacs. */);
11341 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11342 doc
: /* Translate table for local keyboard input, or nil.
11343 If non-nil, the value should be a char-table. Each character read
11344 from the keyboard is looked up in this char-table. If the value found
11345 there is non-nil, then it is used instead of the actual input character.
11347 The value can also be a string or vector, but this is considered obsolete.
11348 If it is a string or vector of length N, character codes N and up are left
11349 untranslated. In a vector, an element which is nil means "no translation".
11351 This is applied to the characters supplied to input methods, not their
11352 output. See also `translation-table-for-input'.
11354 This variable has a separate binding for each terminal.
11355 See Info node `(elisp)Multiple Terminals'. */);
11357 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11358 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11359 \(Even if the operating system has support for stopping a process.\) */);
11360 cannot_suspend
= 0;
11362 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11363 doc
: /* Non-nil means prompt with menus when appropriate.
11364 This is done when reading from a keymap that has a prompt string,
11365 for elements that have prompt strings.
11366 The menu is displayed on the screen
11367 if X menus were enabled at configuration
11368 time and the previous event was a mouse click prefix key.
11369 Otherwise, menu prompting uses the echo area. */);
11370 menu_prompting
= 1;
11372 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11373 doc
: /* Character to see next line of menu prompt.
11374 Type this character while in a menu prompt to rotate around the lines of it. */);
11375 XSETINT (menu_prompt_more_char
, ' ');
11377 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11378 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11379 Emacs applies the modifiers of the character stored here to each keyboard
11380 character it reads. For example, after evaluating the expression
11381 (setq extra-keyboard-modifiers ?\\C-x)
11382 all input characters will have the control modifier applied to them.
11384 Note that the character ?\\C-@, equivalent to the integer zero, does
11385 not count as a control character; rather, it counts as a character
11386 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11387 cancels any modification. */);
11388 extra_keyboard_modifiers
= 0;
11390 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11391 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11392 The command loop sets this to nil before each command,
11393 and tests the value when the command returns.
11394 Buffer modification stores t in this variable. */);
11395 Vdeactivate_mark
= Qnil
;
11396 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11398 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11399 doc
: /* Normal hook run before each command is executed.
11400 If an unhandled error happens in running this hook,
11401 the function in which the error occurred is unconditionally removed, since
11402 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11403 Vpre_command_hook
= Qnil
;
11405 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11406 doc
: /* Normal hook run after each command is executed.
11407 If an unhandled error happens in running this hook,
11408 the function in which the error occurred is unconditionally removed, since
11409 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11410 Vpost_command_hook
= Qnil
;
11413 DEFVAR_LISP ("echo-area-clear-hook", ...,
11414 doc
: /* Normal hook run when clearing the echo area. */);
11416 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11417 Fset (Qecho_area_clear_hook
, Qnil
);
11419 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11420 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11421 Vlucid_menu_bar_dirty_flag
= Qnil
;
11423 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11424 doc
: /* List of menu bar items to move to the end of the menu bar.
11425 The elements of the list are event types that may have menu bar bindings. */);
11426 Vmenu_bar_final_items
= Qnil
;
11428 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11429 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11430 This is used internally by graphical displays that do not render
11431 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11432 Vtool_bar_separator_image_expression
= Qnil
;
11434 DEFVAR_KBOARD ("overriding-terminal-local-map",
11435 Voverriding_terminal_local_map
,
11436 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11437 If this variable is non-nil, it is used as a keymap instead of the
11438 buffer's local map, and the minor mode keymaps and text property keymaps.
11439 It also replaces `overriding-local-map'.
11441 This variable is intended to let commands such as `universal-argument'
11442 set up a different keymap for reading the next command.
11444 `overriding-terminal-local-map' has a separate binding for each
11446 See Info node `(elisp)Multiple Terminals'. */);
11448 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11449 doc
: /* Keymap that overrides all other local keymaps.
11450 If this variable is non-nil, it is used as a keymap--replacing the
11451 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11452 Voverriding_local_map
= Qnil
;
11454 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11455 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11456 Otherwise, the menu bar continues to reflect the buffer's local map
11457 and the minor mode maps regardless of `overriding-local-map'. */);
11458 Voverriding_local_map_menu_flag
= Qnil
;
11460 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11461 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11462 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11464 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11465 doc
: /* Non-nil means generate motion events for mouse motion. */);
11467 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11468 doc
: /* Alist of system-specific X windows key symbols.
11469 Each element should have the form (N . SYMBOL) where N is the
11470 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11471 and SYMBOL is its name.
11473 `system-key-alist' has a separate binding for each terminal device.
11474 See Info node `(elisp)Multiple Terminals'. */);
11476 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11477 doc
: /* Keymap that translates key sequences to key sequences during input.
11478 This is used mainly for mapping key sequences into some preferred
11479 key events (symbols).
11481 The `read-key-sequence' function replaces any subsequence bound by
11482 `local-function-key-map' with its binding. More precisely, when the
11483 active keymaps have no binding for the current key sequence but
11484 `local-function-key-map' binds a suffix of the sequence to a vector or
11485 string, `read-key-sequence' replaces the matching suffix with its
11486 binding, and continues with the new sequence.
11488 If the binding is a function, it is called with one argument (the prompt)
11489 and its return value (a key sequence) is used.
11491 The events that come from bindings in `local-function-key-map' are not
11492 themselves looked up in `local-function-key-map'.
11494 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11495 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11496 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11497 typing `ESC O P x' would return [f1 x].
11499 `local-function-key-map' has a separate binding for each terminal
11500 device. See Info node `(elisp)Multiple Terminals'. If you need to
11501 define a binding on all terminals, change `function-key-map'
11502 instead. Initially, `local-function-key-map' is an empty keymap that
11503 has `function-key-map' as its parent on all terminal devices. */);
11505 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11506 doc
: /* Keymap that decodes input escape sequences.
11507 This is used mainly for mapping ASCII function key sequences into
11508 real Emacs function key events (symbols).
11510 The `read-key-sequence' function replaces any subsequence bound by
11511 `input-decode-map' with its binding. Contrary to `function-key-map',
11512 this map applies its rebinding regardless of the presence of an ordinary
11513 binding. So it is more like `key-translation-map' except that it applies
11514 before `function-key-map' rather than after.
11516 If the binding is a function, it is called with one argument (the prompt)
11517 and its return value (a key sequence) is used.
11519 The events that come from bindings in `input-decode-map' are not
11520 themselves looked up in `input-decode-map'. */);
11522 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11523 doc
: /* The parent keymap of all `local-function-key-map' instances.
11524 Function key definitions that apply to all terminal devices should go
11525 here. If a mapping is defined in both the current
11526 `local-function-key-map' binding and this variable, then the local
11527 definition will take precedence. */);
11528 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11530 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11531 doc
: /* Keymap of key translations that can override keymaps.
11532 This keymap works like `input-decode-map', but comes after `function-key-map'.
11533 Another difference is that it is global rather than terminal-local. */);
11534 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11536 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11537 doc
: /* List of deferred actions to be performed at a later time.
11538 The precise format isn't relevant here; we just check whether it is nil. */);
11539 Vdeferred_action_list
= Qnil
;
11541 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11542 doc
: /* Function to call to handle deferred actions, after each command.
11543 This function is called with no arguments after each command
11544 whenever `deferred-action-list' is non-nil. */);
11545 Vdeferred_action_function
= Qnil
;
11547 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11548 doc
: /* List of warnings to be displayed after this command.
11549 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11550 as per the args of `display-warning' (which see).
11551 If this variable is non-nil, `delayed-warnings-hook' will be run
11552 immediately after running `post-command-hook'. */);
11553 Vdelayed_warnings_list
= Qnil
;
11555 DEFVAR_LISP ("timer-list", Vtimer_list
,
11556 doc
: /* List of active absolute time timers in order of increasing time. */);
11557 Vtimer_list
= Qnil
;
11559 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11560 doc
: /* List of active idle-time timers in order of increasing time. */);
11561 Vtimer_idle_list
= Qnil
;
11563 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11564 doc
: /* If non-nil, the function that implements the current input method.
11565 It's called with one argument, a printing character that was just read.
11566 \(That means a character with code 040...0176.)
11567 Typically this function uses `read-event' to read additional events.
11568 When it does so, it should first bind `input-method-function' to nil
11569 so it will not be called recursively.
11571 The function should return a list of zero or more events
11572 to be used as input. If it wants to put back some events
11573 to be reconsidered, separately, by the input method,
11574 it can add them to the beginning of `unread-command-events'.
11576 The input method function can find in `input-method-previous-message'
11577 the previous echo area message.
11579 The input method function should refer to the variables
11580 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11581 for guidance on what to do. */);
11582 Vinput_method_function
= Qnil
;
11584 DEFVAR_LISP ("input-method-previous-message",
11585 Vinput_method_previous_message
,
11586 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11587 This variable exists because `read-event' clears the echo area
11588 before running the input method. It is nil if there was no message. */);
11589 Vinput_method_previous_message
= Qnil
;
11591 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11592 doc
: /* If non-nil, the function that implements the display of help.
11593 It's called with one argument, the help string to display. */);
11594 Vshow_help_function
= Qnil
;
11596 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11597 doc
: /* If non-nil, suppress point adjustment after executing a command.
11599 After a command is executed, if point is moved into a region that has
11600 special properties (e.g. composition, display), we adjust point to
11601 the boundary of the region. But, when a command sets this variable to
11602 non-nil, we suppress the point adjustment.
11604 This variable is set to nil before reading a command, and is checked
11605 just after executing the command. */);
11606 Vdisable_point_adjustment
= Qnil
;
11608 DEFVAR_LISP ("global-disable-point-adjustment",
11609 Vglobal_disable_point_adjustment
,
11610 doc
: /* If non-nil, always suppress point adjustment.
11612 The default value is nil, in which case, point adjustment are
11613 suppressed only after special commands that set
11614 `disable-point-adjustment' (which see) to non-nil. */);
11615 Vglobal_disable_point_adjustment
= Qnil
;
11617 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11618 doc
: /* How long to display an echo-area message when the minibuffer is active.
11619 If the value is not a number, such messages don't time out. */);
11620 Vminibuffer_message_timeout
= make_number (2);
11622 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11623 doc
: /* If non-nil, any keyboard input throws to this symbol.
11624 The value of that variable is passed to `quit-flag' and later causes a
11625 peculiar kind of quitting. */);
11626 Vthrow_on_input
= Qnil
;
11628 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11629 doc
: /* If non-nil, function to output error messages.
11630 The arguments are the error data, a list of the form
11631 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11632 such as just as `condition-case' would bind its variable to,
11633 the context (a string which normally goes at the start of the message),
11634 and the Lisp function within which the error was signaled. */);
11635 Vcommand_error_function
= Qnil
;
11637 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11638 Venable_disabled_menus_and_buttons
,
11639 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11641 Help functions bind this to allow help on disabled menu items
11642 and tool-bar buttons. */);
11643 Venable_disabled_menus_and_buttons
= Qnil
;
11645 DEFVAR_LISP ("select-active-regions",
11646 Vselect_active_regions
,
11647 doc
: /* If non-nil, an active region automatically sets the primary selection.
11648 If the value is `only', only temporarily active regions (usually made
11649 by mouse-dragging or shift-selection) set the window selection.
11651 This takes effect only when Transient Mark mode is enabled. */);
11652 Vselect_active_regions
= Qt
;
11654 DEFVAR_LISP ("saved-region-selection",
11655 Vsaved_region_selection
,
11656 doc
: /* Contents of active region prior to buffer modification.
11657 If `select-active-regions' is non-nil, Emacs sets this to the
11658 text in the region before modifying the buffer. The next call to
11659 the function `deactivate-mark' uses this to set the window selection. */);
11660 Vsaved_region_selection
= Qnil
;
11662 DEFVAR_LISP ("selection-inhibit-update-commands",
11663 Vselection_inhibit_update_commands
,
11664 doc
: /* List of commands which should not update the selection.
11665 Normally, if `select-active-regions' is non-nil and the mark remains
11666 active after a command (i.e. the mark was not deactivated), the Emacs
11667 command loop sets the selection to the text in the region. However,
11668 if the command is in this list, the selection is not updated. */);
11669 Vselection_inhibit_update_commands
11670 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11672 DEFVAR_LISP ("debug-on-event",
11674 doc
: /* Enter debugger on this event. When Emacs
11675 receives the special event specified by this variable, it will try to
11676 break into the debugger as soon as possible instead of processing the
11677 event normally through `special-event-map'.
11679 Currently, the only supported values for this
11680 variable are `sigusr1' and `sigusr2'. */);
11681 Vdebug_on_event
= intern_c_string ("sigusr2");
11683 /* Create the initial keyboard. */
11684 initial_kboard
= xmalloc (sizeof *initial_kboard
);
11685 init_kboard (initial_kboard
);
11686 /* Vwindow_system is left at t for now. */
11687 initial_kboard
->next_kboard
= all_kboards
;
11688 all_kboards
= initial_kboard
;
11692 keys_of_keyboard (void)
11694 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11695 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11696 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11697 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11698 initial_define_key (meta_map
, 'x', "execute-extended-command");
11700 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11701 "handle-delete-frame");
11702 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11703 "ns-put-working-text");
11704 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11705 "ns-unput-working-text");
11706 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11707 current-prefix-arg, as is done in `handle-switch-frame'.
11708 But `handle-switch-frame is not run from the special-map.
11709 Commands from that map are run in a special way that automatically
11710 preserves the prefix-arg. Restoring the prefix arg here is not just
11711 redundant but harmful:
11713 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11714 - after the first prompt, the exit-minibuffer-hook is run which may
11715 iconify a frame and thus push a `iconify-frame' event.
11716 - after running exit-minibuffer-hook, current-prefix-arg is
11717 restored to the non-nil value it had before the prompt.
11718 - we enter the second prompt.
11719 current-prefix-arg is non-nil, prefix-arg is nil.
11720 - before running the first real event, we run the special iconify-frame
11721 event, but we pass the `special' arg to execute-command so
11722 current-prefix-arg and prefix-arg are left untouched.
11723 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11724 - the next key event will have a spuriously non-nil current-prefix-arg. */
11725 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11727 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11729 /* Handling it at such a low-level causes read_key_sequence to get
11730 * confused because it doesn't realize that the current_buffer was
11731 * changed by read_char.
11733 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11734 * "handle-select-window"); */
11735 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11736 "handle-save-session");
11739 /* Define a special event which is raised for dbus callback
11741 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11742 "dbus-handle-event");
11745 #ifdef HAVE_INOTIFY
11746 /* Define a special event which is raised for inotify callback
11748 initial_define_lispy_key (Vspecial_event_map
, "file-inotify",
11749 "inotify-handle-event");
11750 #endif /* HAVE_INOTIFY */
11752 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11754 #if defined (WINDOWSNT)
11755 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11757 initial_define_lispy_key (Vspecial_event_map
, "file-w32notify",
11758 "w32notify-handle-event");
11762 /* Mark the pointers in the kboard objects.
11763 Called by Fgarbage_collect. */
11765 mark_kboards (void)
11769 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11771 if (kb
->kbd_macro_buffer
)
11772 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11774 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11775 mark_object (KVAR (kb
, Vlast_command
));
11776 mark_object (KVAR (kb
, Vreal_last_command
));
11777 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11778 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11779 mark_object (KVAR (kb
, Vprefix_arg
));
11780 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11781 mark_object (KVAR (kb
, kbd_queue
));
11782 mark_object (KVAR (kb
, defining_kbd_macro
));
11783 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11784 mark_object (KVAR (kb
, Vsystem_key_alist
));
11785 mark_object (KVAR (kb
, system_key_syms
));
11786 mark_object (KVAR (kb
, Vwindow_system
));
11787 mark_object (KVAR (kb
, Vinput_decode_map
));
11788 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11789 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11790 mark_object (KVAR (kb
, echo_string
));
11793 struct input_event
*event
;
11794 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11796 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11797 event
= kbd_buffer
;
11798 /* These two special event types has no Lisp_Objects to mark. */
11799 if (event
->kind
!= SELECTION_REQUEST_EVENT
11800 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11802 mark_object (event
->x
);
11803 mark_object (event
->y
);
11804 mark_object (event
->frame_or_window
);
11805 mark_object (event
->arg
);