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 Lisp_Object Qxwidget_event
;
330 static Lisp_Object Qfile_inotify
;
331 #endif /* HAVE_INOTIFY */
332 static Lisp_Object Qconfig_changed_event
;
334 /* Lisp_Object Qmouse_movement; - also an event header */
336 /* Properties of event headers. */
337 Lisp_Object Qevent_kind
;
338 static Lisp_Object Qevent_symbol_elements
;
340 /* Menu and tool bar item parts. */
341 static Lisp_Object Qmenu_enable
;
342 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
343 Lisp_Object QCfilter
;
345 /* Non-nil disable property on a command means
346 do not execute it; call disabled-command-function's value instead. */
347 Lisp_Object QCtoggle
, QCradio
;
348 static Lisp_Object QCbutton
, QClabel
;
350 static Lisp_Object QCvert_only
;
352 /* An event header symbol HEAD may have a property named
353 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
354 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
355 mask of modifiers applied to it. If present, this is used to help
356 speed up parse_modifiers. */
357 Lisp_Object Qevent_symbol_element_mask
;
359 /* An unmodified event header BASE may have a property named
360 Qmodifier_cache, which is an alist mapping modifier masks onto
361 modified versions of BASE. If present, this helps speed up
363 static Lisp_Object Qmodifier_cache
;
365 /* Symbols to use for parts of windows. */
366 Lisp_Object Qmode_line
;
367 Lisp_Object Qvertical_line
;
368 static Lisp_Object Qvertical_scroll_bar
;
369 Lisp_Object Qmenu_bar
;
371 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
372 static Lisp_Object
command_loop (void);
373 static Lisp_Object Qcommand_execute
;
374 EMACS_TIME
timer_check (void);
376 static void echo_now (void);
377 static ptrdiff_t echo_length (void);
379 static Lisp_Object Qpolling_period
;
381 /* Incremented whenever a timer is run. */
384 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
386 EMACS_TIME
*input_available_clear_time
;
388 /* True means use SIGIO interrupts; false means use CBREAK mode.
389 Default is true if INTERRUPT_INPUT is defined. */
390 bool interrupt_input
;
392 /* Nonzero while interrupts are temporarily deferred during redisplay. */
393 bool interrupts_deferred
;
395 /* If we support a window system, turn on the code to poll periodically
396 to detect C-g. It isn't actually used when doing interrupt input. */
397 #ifdef HAVE_WINDOW_SYSTEM
398 #define POLL_FOR_INPUT
401 /* The time when Emacs started being idle. */
403 static EMACS_TIME timer_idleness_start_time
;
405 /* After Emacs stops being idle, this saves the last value
406 of timer_idleness_start_time from when it was idle. */
408 static EMACS_TIME timer_last_idleness_start_time
;
411 /* Global variable declarations. */
413 /* Flags for readable_events. */
414 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
415 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
416 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
418 /* Function for init_keyboard to call with no args (if nonzero). */
419 static void (*keyboard_init_hook
) (void);
421 static bool get_input_pending (int);
422 static bool readable_events (int);
423 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
424 Lisp_Object
, bool *);
425 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
426 static Lisp_Object
make_lispy_event (struct input_event
*);
427 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
428 enum scroll_bar_part
,
429 Lisp_Object
, Lisp_Object
,
431 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
432 Lisp_Object
, const char *const *,
433 Lisp_Object
*, ptrdiff_t);
434 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
435 static bool help_char_p (Lisp_Object
);
436 static void save_getcjmp (sys_jmp_buf
);
437 static void restore_getcjmp (sys_jmp_buf
);
438 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
439 static void clear_event (struct input_event
*);
440 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
442 static void deliver_input_available_signal (int signo
);
444 static void handle_interrupt (bool);
445 static _Noreturn
void quit_throw_to_read_char (bool);
446 static void process_special_events (void);
447 static void timer_start_idle (void);
448 static void timer_stop_idle (void);
449 static void timer_resume_idle (void);
450 static void deliver_user_signal (int);
451 static char *find_user_signal_name (int);
452 static void store_user_signal_events (void);
454 /* These setters are used only in this file, so they can be private. */
456 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
458 kb
->INTERNAL_FIELD (echo_string
) = val
;
461 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
463 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
466 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
468 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
471 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
473 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
476 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
478 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
481 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
483 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
486 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
488 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
491 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
493 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
496 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
498 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
502 /* Add C to the echo string, without echoing it immediately. C can be
503 a character, which is pretty-printed, or a symbol, whose name is
507 echo_add_key (Lisp_Object c
)
509 int size
= KEY_DESCRIPTION_SIZE
+ 100;
510 char *buffer
= alloca (size
);
512 Lisp_Object echo_string
;
514 echo_string
= KVAR (current_kboard
, echo_string
);
516 /* If someone has passed us a composite event, use its head symbol. */
520 ptr
= push_key_description (XINT (c
), ptr
);
521 else if (SYMBOLP (c
))
523 Lisp_Object name
= SYMBOL_NAME (c
);
524 int nbytes
= SBYTES (name
);
526 if (size
- (ptr
- buffer
) < nbytes
)
528 int offset
= ptr
- buffer
;
529 size
= max (2 * size
, size
+ nbytes
);
530 buffer
= alloca (size
);
531 ptr
= buffer
+ offset
;
534 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
535 STRING_MULTIBYTE (name
), 1);
538 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
541 const char *text
= " (Type ? for further options)";
542 int len
= strlen (text
);
544 if (size
- (ptr
- buffer
) < len
)
546 int offset
= ptr
- buffer
;
548 buffer
= alloca (size
);
549 ptr
= buffer
+ offset
;
552 memcpy (ptr
, text
, len
);
556 /* Replace a dash from echo_dash with a space, otherwise add a space
557 at the end as a separator between keys. */
558 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
560 Lisp_Object last_char
, prev_char
, idx
;
562 idx
= make_number (SCHARS (echo_string
) - 2);
563 prev_char
= Faref (echo_string
, idx
);
565 idx
= make_number (SCHARS (echo_string
) - 1);
566 last_char
= Faref (echo_string
, idx
);
568 /* We test PREV_CHAR to make sure this isn't the echoing of a
570 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
571 Faset (echo_string
, idx
, make_number (' '));
573 echo_string
= concat2 (echo_string
, build_string (" "));
575 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
576 echo_string
= concat2 (echo_string
, build_string (" "));
580 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
583 /* Add C to the echo string, if echoing is going on. C can be a
584 character or a symbol. */
587 echo_char (Lisp_Object c
)
589 if (current_kboard
->immediate_echo
)
596 /* Temporarily add a dash to the end of the echo string if it's not
597 empty, so that it serves as a mini-prompt for the very next
603 /* Do nothing if not echoing at all. */
604 if (NILP (KVAR (current_kboard
, echo_string
)))
607 if (this_command_key_count
== 0)
610 if (!current_kboard
->immediate_echo
611 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
614 /* Do nothing if we just printed a prompt. */
615 if (current_kboard
->echo_after_prompt
616 == SCHARS (KVAR (current_kboard
, echo_string
)))
619 /* Do nothing if we have already put a dash at the end. */
620 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
622 Lisp_Object last_char
, prev_char
, idx
;
624 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
625 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
627 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
628 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
630 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
634 /* Put a dash at the end of the buffer temporarily,
635 but make it go away when the next character is added. */
638 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
642 /* Display the current echo string, and begin echoing if not already
648 if (!current_kboard
->immediate_echo
)
651 current_kboard
->immediate_echo
= 1;
653 for (i
= 0; i
< this_command_key_count
; i
++)
657 /* Set before_command_echo_length to the value that would
658 have been saved before the start of this subcommand in
659 command_loop_1, if we had already been echoing then. */
660 if (i
== this_single_command_key_start
)
661 before_command_echo_length
= echo_length ();
663 c
= AREF (this_command_keys
, i
);
664 if (! (EVENT_HAS_PARAMETERS (c
)
665 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
669 /* Set before_command_echo_length to the value that would
670 have been saved before the start of this subcommand in
671 command_loop_1, if we had already been echoing then. */
672 if (this_command_key_count
== this_single_command_key_start
)
673 before_command_echo_length
= echo_length ();
675 /* Put a dash at the end to invite the user to type more. */
680 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
681 message3_nolog (KVAR (current_kboard
, echo_string
));
684 /* Record in what buffer we echoed, and from which kboard. */
685 echo_message_buffer
= echo_area_buffer
[0];
686 echo_kboard
= current_kboard
;
688 if (waiting_for_input
&& !NILP (Vquit_flag
))
689 quit_throw_to_read_char (0);
692 /* Turn off echoing, for the start of a new command. */
695 cancel_echoing (void)
697 current_kboard
->immediate_echo
= 0;
698 current_kboard
->echo_after_prompt
= -1;
699 kset_echo_string (current_kboard
, Qnil
);
700 ok_to_echo_at_next_pause
= NULL
;
702 echo_message_buffer
= Qnil
;
705 /* Return the length of the current echo string. */
710 return (STRINGP (KVAR (current_kboard
, echo_string
))
711 ? SCHARS (KVAR (current_kboard
, echo_string
))
715 /* Truncate the current echo message to its first LEN chars.
716 This and echo_char get used by read_key_sequence when the user
717 switches frames while entering a key sequence. */
720 echo_truncate (ptrdiff_t nchars
)
722 if (STRINGP (KVAR (current_kboard
, echo_string
)))
723 kset_echo_string (current_kboard
,
724 Fsubstring (KVAR (current_kboard
, echo_string
),
725 make_number (0), make_number (nchars
)));
726 truncate_echo_area (nchars
);
730 /* Functions for manipulating this_command_keys. */
732 add_command_key (Lisp_Object key
)
734 #if 0 /* Not needed after we made Freset_this_command_lengths
735 do the job immediately. */
736 /* If reset-this-command-length was called recently, obey it now.
737 See the doc string of that function for an explanation of why. */
738 if (before_command_restore_flag
)
740 this_command_key_count
= before_command_key_count_1
;
741 if (this_command_key_count
< this_single_command_key_start
)
742 this_single_command_key_start
= this_command_key_count
;
743 echo_truncate (before_command_echo_length_1
);
744 before_command_restore_flag
= 0;
748 if (this_command_key_count
>= ASIZE (this_command_keys
))
749 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
751 ASET (this_command_keys
, this_command_key_count
, key
);
752 ++this_command_key_count
;
757 recursive_edit_1 (void)
759 ptrdiff_t count
= SPECPDL_INDEX ();
762 if (command_loop_level
> 0)
764 specbind (Qstandard_output
, Qt
);
765 specbind (Qstandard_input
, Qt
);
768 #ifdef HAVE_WINDOW_SYSTEM
769 /* The command loop has started an hourglass timer, so we have to
770 cancel it here, otherwise it will fire because the recursive edit
771 can take some time. Do not check for display_hourglass_p here,
772 because it could already be nil. */
776 /* This function may have been called from a debugger called from
777 within redisplay, for instance by Edebugging a function called
778 from fontification-functions. We want to allow redisplay in
779 the debugging session.
781 The recursive edit is left with a `(throw exit ...)'. The `exit'
782 tag is not caught anywhere in redisplay, i.e. when we leave the
783 recursive edit, the original redisplay leading to the recursive
784 edit will be unwound. The outcome should therefore be safe. */
785 specbind (Qinhibit_redisplay
, Qnil
);
788 val
= command_loop ();
790 Fsignal (Qquit
, Qnil
);
791 /* Handle throw from read_minibuf when using minibuffer
792 while it's active but we're in another window. */
794 xsignal1 (Qerror
, val
);
796 return unbind_to (count
, Qnil
);
799 /* When an auto-save happens, record the "time", and don't do again soon. */
802 record_auto_save (void)
804 last_auto_save
= num_nonmacro_input_events
;
807 /* Make an auto save happen as soon as possible at command level. */
811 force_auto_save_soon (void)
813 last_auto_save
= - auto_save_interval
- 1;
815 record_asynch_buffer_change ();
819 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
820 doc
: /* Invoke the editor command loop recursively.
821 To get out of the recursive edit, a command can do `(throw 'exit nil)';
822 that tells this function to return.
823 Alternatively, `(throw 'exit t)' makes this function signal an error.
824 This function is called by the editor initialization to begin editing. */)
827 ptrdiff_t count
= SPECPDL_INDEX ();
830 /* If we enter while input is blocked, don't lock up here.
831 This may happen through the debugger during redisplay. */
832 if (input_blocked_p ())
835 command_loop_level
++;
836 update_mode_lines
= 1;
838 if (command_loop_level
839 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
840 buffer
= Fcurrent_buffer ();
844 /* If we leave recursive_edit_1 below with a `throw' for instance,
845 like it is done in the splash screen display, we have to
846 make sure that we restore single_kboard as command_loop_1
847 would have done if it were left normally. */
848 if (command_loop_level
> 0)
849 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
850 record_unwind_protect (recursive_edit_unwind
, buffer
);
853 return unbind_to (count
, Qnil
);
857 recursive_edit_unwind (Lisp_Object buffer
)
859 if (BUFFERP (buffer
))
860 Fset_buffer (buffer
);
862 command_loop_level
--;
863 update_mode_lines
= 1;
868 #if 0 /* These two functions are now replaced with
869 temporarily_switch_to_single_kboard. */
873 #if 0 /* Theory: if there's anything in Vunread_command_events,
874 it will right away be read by read_key_sequence,
875 and then if we do switch KBOARDS, it will go into the side
876 queue then. So we don't need to do anything special here -- rms. */
877 if (CONSP (Vunread_command_events
))
879 current_kboard
->kbd_queue
880 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
881 current_kboard
->kbd_queue_has_data
= 1;
883 Vunread_command_events
= Qnil
;
888 /* Switch to the single-kboard state, making current_kboard
889 the only KBOARD from which further input is accepted. */
892 single_kboard_state ()
898 /* If we're in single_kboard state for kboard KBOARD,
902 not_single_kboard_state (KBOARD
*kboard
)
904 if (kboard
== current_kboard
)
908 /* Maintain a stack of kboards, so other parts of Emacs
909 can switch temporarily to the kboard of a given frame
910 and then revert to the previous status. */
915 struct kboard_stack
*next
;
918 static struct kboard_stack
*kboard_stack
;
921 push_kboard (struct kboard
*k
)
923 struct kboard_stack
*p
= xmalloc (sizeof *p
);
925 p
->next
= kboard_stack
;
926 p
->kboard
= current_kboard
;
936 struct kboard_stack
*p
= kboard_stack
;
938 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
940 if (t
->kboard
== p
->kboard
)
942 current_kboard
= p
->kboard
;
949 /* The terminal we remembered has been deleted. */
950 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
953 kboard_stack
= p
->next
;
957 /* Switch to single_kboard mode, making current_kboard the only KBOARD
958 from which further input is accepted. If F is non-nil, set its
959 KBOARD as the current keyboard.
961 This function uses record_unwind_protect to return to the previous
964 If Emacs is already in single_kboard mode, and F's keyboard is
965 locked, then this function will throw an error. */
968 temporarily_switch_to_single_kboard (struct frame
*f
)
970 bool was_locked
= single_kboard
;
973 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
974 /* We can not switch keyboards while in single_kboard mode.
975 In rare cases, Lisp code may call `recursive-edit' (or
976 `read-minibuffer' or `y-or-n-p') after it switched to a
977 locked frame. For example, this is likely to happen
978 when server.el connects to a new terminal while Emacs is in
979 single_kboard mode. It is best to throw an error instead
980 of presenting the user with a frozen screen. */
981 error ("Terminal %d is locked, cannot read from it",
982 FRAME_TERMINAL (f
)->id
);
984 /* This call is unnecessary, but helps
985 `restore_kboard_configuration' discover if somebody changed
986 `current_kboard' behind our back. */
987 push_kboard (current_kboard
);
990 current_kboard
= FRAME_KBOARD (f
);
992 record_unwind_protect (restore_kboard_configuration
,
993 (was_locked
? Qt
: Qnil
));
996 #if 0 /* This function is not needed anymore. */
998 record_single_kboard_state ()
1001 push_kboard (current_kboard
);
1002 record_unwind_protect (restore_kboard_configuration
,
1003 (single_kboard
? Qt
: Qnil
));
1008 restore_kboard_configuration (Lisp_Object was_locked
)
1010 if (NILP (was_locked
))
1014 struct kboard
*prev
= current_kboard
;
1017 /* The pop should not change the kboard. */
1018 if (single_kboard
&& current_kboard
!= prev
)
1025 /* Handle errors that are not handled at inner levels
1026 by printing an error message and returning to the editor command loop. */
1029 cmd_error (Lisp_Object data
)
1031 Lisp_Object old_level
, old_length
;
1032 char macroerror
[sizeof "After..kbd macro iterations: "
1033 + INT_STRLEN_BOUND (EMACS_INT
)];
1035 #ifdef HAVE_WINDOW_SYSTEM
1036 if (display_hourglass_p
)
1037 cancel_hourglass ();
1040 if (!NILP (executing_kbd_macro
))
1042 if (executing_kbd_macro_iterations
== 1)
1043 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1045 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1046 executing_kbd_macro_iterations
);
1051 Vstandard_output
= Qt
;
1052 Vstandard_input
= Qt
;
1053 Vexecuting_kbd_macro
= Qnil
;
1054 executing_kbd_macro
= Qnil
;
1055 kset_prefix_arg (current_kboard
, Qnil
);
1056 kset_last_prefix_arg (current_kboard
, Qnil
);
1059 /* Avoid unquittable loop if data contains a circular list. */
1060 old_level
= Vprint_level
;
1061 old_length
= Vprint_length
;
1062 XSETFASTINT (Vprint_level
, 10);
1063 XSETFASTINT (Vprint_length
, 10);
1064 cmd_error_internal (data
, macroerror
);
1065 Vprint_level
= old_level
;
1066 Vprint_length
= old_length
;
1069 Vinhibit_quit
= Qnil
;
1071 return make_number (0);
1074 /* Take actions on handling an error. DATA is the data that describes
1077 CONTEXT is a C-string containing ASCII characters only which
1078 describes the context in which the error happened. If we need to
1079 generalize CONTEXT to allow multibyte characters, make it a Lisp
1083 cmd_error_internal (Lisp_Object data
, const char *context
)
1085 struct frame
*sf
= SELECTED_FRAME ();
1087 /* The immediate context is not interesting for Quits,
1088 since they are asynchronous. */
1089 if (EQ (XCAR (data
), Qquit
))
1090 Vsignaling_function
= Qnil
;
1095 /* Use user's specified output function if any. */
1096 if (!NILP (Vcommand_error_function
))
1097 call3 (Vcommand_error_function
, data
,
1098 context
? build_string (context
) : empty_unibyte_string
,
1099 Vsignaling_function
);
1100 /* If the window system or terminal frame hasn't been initialized
1101 yet, or we're not interactive, write the message to stderr and exit. */
1102 else if (!sf
->glyphs_initialized_p
1103 /* The initial frame is a special non-displaying frame. It
1104 will be current in daemon mode when there are no frames
1105 to display, and in non-daemon mode before the real frame
1106 has finished initializing. If an error is thrown in the
1107 latter case while creating the frame, then the frame
1108 will never be displayed, so the safest thing to do is
1109 write to stderr and quit. In daemon mode, there are
1110 many other potential errors that do not prevent frames
1111 from being created, so continuing as normal is better in
1113 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1116 print_error_message (data
, Qexternal_debugging_output
,
1117 context
, Vsignaling_function
);
1118 Fterpri (Qexternal_debugging_output
);
1119 Fkill_emacs (make_number (-1));
1123 clear_message (1, 0);
1125 message_log_maybe_newline ();
1128 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1131 Vsignaling_function
= Qnil
;
1134 static Lisp_Object
command_loop_2 (Lisp_Object
);
1135 static Lisp_Object
top_level_1 (Lisp_Object
);
1137 /* Entry to editor-command-loop.
1138 This level has the catches for exiting/returning to editor command loop.
1139 It returns nil to exit recursive edit, t to abort it. */
1144 if (command_loop_level
> 0 || minibuf_level
> 0)
1147 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1148 executing_kbd_macro
= Qnil
;
1154 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1155 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1156 executing_kbd_macro
= Qnil
;
1158 /* End of file in -batch run causes exit here. */
1164 /* Here we catch errors in execution of commands within the
1165 editing loop, and reenter the editing loop.
1166 When there is an error, cmd_error runs and returns a non-nil
1167 value to us. A value of nil means that command_loop_1 itself
1168 returned due to end of file (or end of kbd macro). */
1171 command_loop_2 (Lisp_Object ignore
)
1173 register Lisp_Object val
;
1176 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1177 while (!NILP (val
));
1185 return Feval (Vtop_level
, Qnil
);
1189 top_level_1 (Lisp_Object ignore
)
1191 /* On entry to the outer level, run the startup file. */
1192 if (!NILP (Vtop_level
))
1193 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1194 else if (!NILP (Vpurify_flag
))
1195 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1197 message1 ("Bare Emacs (standard Lisp code not loaded)");
1201 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1202 doc
: /* Exit all recursive editing levels.
1203 This also exits all active minibuffers. */)
1206 #ifdef HAVE_WINDOW_SYSTEM
1207 if (display_hourglass_p
)
1208 cancel_hourglass ();
1211 /* Unblock input if we enter with input blocked. This may happen if
1212 redisplay traps e.g. during tool-bar update with input blocked. */
1213 totally_unblock_input ();
1215 Fthrow (Qtop_level
, Qnil
);
1218 static _Noreturn
void
1219 user_error (const char *msg
)
1221 xsignal1 (Quser_error
, build_string (msg
));
1225 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1226 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1229 if (command_loop_level
> 0 || minibuf_level
> 0)
1230 Fthrow (Qexit
, Qnil
);
1232 user_error ("No recursive edit is in progress");
1236 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1237 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1240 if (command_loop_level
> 0 || minibuf_level
> 0)
1243 user_error ("No recursive edit is in progress");
1246 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1247 of this function. */
1250 tracking_off (Lisp_Object old_value
)
1252 do_mouse_tracking
= old_value
;
1253 if (NILP (old_value
))
1255 /* Redisplay may have been preempted because there was input
1256 available, and it assumes it will be called again after the
1257 input has been processed. If the only input available was
1258 the sort that we have just disabled, then we need to call
1260 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1262 redisplay_preserve_echo_area (6);
1263 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1269 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1270 doc
: /* Evaluate BODY with mouse movement events enabled.
1271 Within a `track-mouse' form, mouse motion generates input events that
1272 you can read with `read-event'.
1273 Normally, mouse motion is ignored.
1274 usage: (track-mouse BODY...) */)
1277 ptrdiff_t count
= SPECPDL_INDEX ();
1280 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1282 do_mouse_tracking
= Qt
;
1284 val
= Fprogn (args
);
1285 return unbind_to (count
, val
);
1288 /* If mouse has moved on some frame, return one of those frames.
1292 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1293 after resizing the tool-bar window. */
1295 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1298 bool ignore_mouse_drag_p
;
1301 some_mouse_moved (void)
1303 Lisp_Object tail
, frame
;
1305 if (ignore_mouse_drag_p
)
1307 /* ignore_mouse_drag_p = 0; */
1311 FOR_EACH_FRAME (tail
, frame
)
1313 if (XFRAME (frame
)->mouse_moved
)
1314 return XFRAME (frame
);
1321 /* This is the actual command reading loop,
1322 sans error-handling encapsulation. */
1324 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1326 void safe_run_hooks (Lisp_Object
);
1327 static void adjust_point_for_property (ptrdiff_t, bool);
1329 /* Cancel hourglass from protect_unwind.
1331 #ifdef HAVE_WINDOW_SYSTEM
1333 cancel_hourglass_unwind (Lisp_Object arg
)
1335 cancel_hourglass ();
1340 /* The last boundary auto-added to buffer-undo-list. */
1341 Lisp_Object last_undo_boundary
;
1343 /* FIXME: This is wrong rather than test window-system, we should call
1344 a new set-selection, which will then dispatch to x-set-selection, or
1345 tty-set-selection, or w32-set-selection, ... */
1348 command_loop_1 (void)
1351 Lisp_Object keybuf
[30];
1353 EMACS_INT prev_modiff
= 0;
1354 struct buffer
*prev_buffer
= NULL
;
1355 bool already_adjusted
= 0;
1357 kset_prefix_arg (current_kboard
, Qnil
);
1358 kset_last_prefix_arg (current_kboard
, Qnil
);
1359 Vdeactivate_mark
= Qnil
;
1360 waiting_for_input
= 0;
1363 this_command_key_count
= 0;
1364 this_command_key_count_reset
= 0;
1365 this_single_command_key_start
= 0;
1367 if (NILP (Vmemory_full
))
1369 /* Make sure this hook runs after commands that get errors and
1370 throw to top level. */
1371 /* Note that the value cell will never directly contain nil
1372 if the symbol is a local variable. */
1373 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1374 safe_run_hooks (Qpost_command_hook
);
1376 /* If displaying a message, resize the echo area window to fit
1377 that message's size exactly. */
1378 if (!NILP (echo_area_buffer
[0]))
1379 resize_echo_area_exactly ();
1381 /* If there are warnings waiting, process them. */
1382 if (!NILP (Vdelayed_warnings_list
))
1383 safe_run_hooks (Qdelayed_warnings_hook
);
1385 if (!NILP (Vdeferred_action_list
))
1386 safe_run_hooks (Qdeferred_action_function
);
1389 /* Do this after running Vpost_command_hook, for consistency. */
1390 kset_last_command (current_kboard
, Vthis_command
);
1391 kset_real_last_command (current_kboard
, Vreal_this_command
);
1392 if (!CONSP (last_command_event
))
1393 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1397 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1400 /* Make sure the current window's buffer is selected. */
1401 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1403 /* Display any malloc warning that just came out. Use while because
1404 displaying one warning can cause another. */
1406 while (pending_malloc_warning
)
1407 display_malloc_warning ();
1409 Vdeactivate_mark
= Qnil
;
1411 /* Don't ignore mouse movements for more than a single command
1412 loop. (This flag is set in xdisp.c whenever the tool bar is
1413 resized, because the resize moves text up or down, and would
1414 generate false mouse drag events if we don't ignore them.) */
1415 ignore_mouse_drag_p
= 0;
1417 /* If minibuffer on and echo area in use,
1418 wait a short time and redraw minibuffer. */
1421 && !NILP (echo_area_buffer
[0])
1422 && EQ (minibuf_window
, echo_area_window
)
1423 && NUMBERP (Vminibuffer_message_timeout
))
1425 /* Bind inhibit-quit to t so that C-g gets read in
1426 rather than quitting back to the minibuffer. */
1427 ptrdiff_t count
= SPECPDL_INDEX ();
1428 specbind (Qinhibit_quit
, Qt
);
1430 sit_for (Vminibuffer_message_timeout
, 0, 2);
1432 /* Clear the echo area. */
1434 safe_run_hooks (Qecho_area_clear_hook
);
1436 unbind_to (count
, Qnil
);
1438 /* If a C-g came in before, treat it as input now. */
1439 if (!NILP (Vquit_flag
))
1442 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1446 /* If it has changed current-menubar from previous value,
1447 really recompute the menubar from the value. */
1448 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1449 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1450 call0 (Qrecompute_lucid_menubar
);
1452 before_command_key_count
= this_command_key_count
;
1453 before_command_echo_length
= echo_length ();
1455 Vthis_command
= Qnil
;
1456 Vreal_this_command
= Qnil
;
1457 Vthis_original_command
= Qnil
;
1458 Vthis_command_keys_shift_translated
= Qnil
;
1460 /* Read next key sequence; i gets its length. */
1461 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1464 /* A filter may have run while we were reading the input. */
1465 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1467 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1471 /* Now we have read a key sequence of length I,
1472 or else I is 0 and we found end of file. */
1474 if (i
== 0) /* End of file -- happens only in */
1475 return Qnil
; /* a kbd macro, at the end. */
1476 /* -1 means read_key_sequence got a menu that was rejected.
1477 Just loop around and read another command. */
1481 this_command_key_count
= 0;
1482 this_command_key_count_reset
= 0;
1483 this_single_command_key_start
= 0;
1487 last_command_event
= keybuf
[i
- 1];
1489 /* If the previous command tried to force a specific window-start,
1490 forget about that, in case this command moves point far away
1491 from that position. But also throw away beg_unchanged and
1492 end_unchanged information in that case, so that redisplay will
1493 update the whole window properly. */
1494 if (XWINDOW (selected_window
)->force_start
)
1497 XWINDOW (selected_window
)->force_start
= 0;
1498 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1499 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1502 cmd
= read_key_sequence_cmd
;
1503 if (!NILP (Vexecuting_kbd_macro
))
1505 if (!NILP (Vquit_flag
))
1507 Vexecuting_kbd_macro
= Qt
;
1508 QUIT
; /* Make some noise. */
1509 /* Will return since macro now empty. */
1513 /* Do redisplay processing after this command except in special
1514 cases identified below. */
1515 prev_buffer
= current_buffer
;
1516 prev_modiff
= MODIFF
;
1517 last_point_position
= PT
;
1518 last_point_position_window
= selected_window
;
1519 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1521 /* By default, we adjust point to a boundary of a region that
1522 has such a property that should be treated intangible
1523 (e.g. composition, display). But, some commands will set
1524 this variable differently. */
1525 Vdisable_point_adjustment
= Qnil
;
1527 /* Process filters and timers may have messed with deactivate-mark.
1528 reset it before we execute the command. */
1529 Vdeactivate_mark
= Qnil
;
1531 /* Remap command through active keymaps. */
1532 Vthis_original_command
= cmd
;
1533 if (!NILP (read_key_sequence_remapped
))
1534 cmd
= read_key_sequence_remapped
;
1536 /* Execute the command. */
1538 Vthis_command
= cmd
;
1539 Vreal_this_command
= cmd
;
1540 safe_run_hooks (Qpre_command_hook
);
1542 already_adjusted
= 0;
1544 if (NILP (Vthis_command
))
1546 /* nil means key is undefined. */
1547 Lisp_Object keys
= Fvector (i
, keybuf
);
1548 keys
= Fkey_description (keys
, Qnil
);
1550 message_with_string ("%s is undefined", keys
, 0);
1551 kset_defining_kbd_macro (current_kboard
, Qnil
);
1552 update_mode_lines
= 1;
1553 /* If this is a down-mouse event, don't reset prefix-arg;
1554 pass it to the command run by the up event. */
1555 if (EVENT_HAS_PARAMETERS (last_command_event
))
1557 Lisp_Object breakdown
1558 = parse_modifiers (EVENT_HEAD (last_command_event
));
1559 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1560 if (!(modifiers
& down_modifier
))
1561 kset_prefix_arg (current_kboard
, Qnil
);
1564 kset_prefix_arg (current_kboard
, Qnil
);
1568 /* Here for a command that isn't executed directly. */
1570 #ifdef HAVE_WINDOW_SYSTEM
1571 ptrdiff_t scount
= SPECPDL_INDEX ();
1573 if (display_hourglass_p
1574 && NILP (Vexecuting_kbd_macro
))
1576 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1581 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1583 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1586 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1587 ? Qnil
: BVAR (current_buffer
, undo_list
));
1589 call1 (Qcommand_execute
, Vthis_command
);
1591 #ifdef HAVE_WINDOW_SYSTEM
1592 /* Do not check display_hourglass_p here, because
1593 `command-execute' could change it, but we should cancel
1594 hourglass cursor anyway.
1595 But don't cancel the hourglass within a macro
1596 just because a command in the macro finishes. */
1597 if (NILP (Vexecuting_kbd_macro
))
1598 unbind_to (scount
, Qnil
);
1601 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1603 safe_run_hooks (Qpost_command_hook
);
1605 /* If displaying a message, resize the echo area window to fit
1606 that message's size exactly. */
1607 if (!NILP (echo_area_buffer
[0]))
1608 resize_echo_area_exactly ();
1610 /* If there are warnings waiting, process them. */
1611 if (!NILP (Vdelayed_warnings_list
))
1612 safe_run_hooks (Qdelayed_warnings_hook
);
1614 safe_run_hooks (Qdeferred_action_function
);
1616 /* If there is a prefix argument,
1617 1) We don't want Vlast_command to be ``universal-argument''
1618 (that would be dumb), so don't set Vlast_command,
1619 2) we want to leave echoing on so that the prefix will be
1620 echoed as part of this key sequence, so don't call
1622 3) we want to leave this_command_key_count non-zero, so that
1623 read_char will realize that it is re-reading a character, and
1624 not echo it a second time.
1626 If the command didn't actually create a prefix arg,
1627 but is merely a frame event that is transparent to prefix args,
1628 then the above doesn't apply. */
1629 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1630 || CONSP (last_command_event
))
1632 kset_last_command (current_kboard
, Vthis_command
);
1633 kset_real_last_command (current_kboard
, Vreal_this_command
);
1634 if (!CONSP (last_command_event
))
1635 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1637 this_command_key_count
= 0;
1638 this_command_key_count_reset
= 0;
1639 this_single_command_key_start
= 0;
1642 if (!NILP (BVAR (current_buffer
, mark_active
))
1643 && !NILP (Vrun_hooks
))
1645 /* In Emacs 22, setting transient-mark-mode to `only' was a
1646 way of turning it on for just one command. This usage is
1647 obsolete, but support it anyway. */
1648 if (EQ (Vtransient_mark_mode
, Qidentity
))
1649 Vtransient_mark_mode
= Qnil
;
1650 else if (EQ (Vtransient_mark_mode
, Qonly
))
1651 Vtransient_mark_mode
= Qidentity
;
1653 if (!NILP (Vdeactivate_mark
))
1654 /* If `select-active-regions' is non-nil, this call to
1655 `deactivate-mark' also sets the PRIMARY selection. */
1656 call0 (Qdeactivate_mark
);
1659 /* Even if not deactivating the mark, set PRIMARY if
1660 `select-active-regions' is non-nil. */
1661 if (!NILP (Fwindow_system (Qnil
))
1662 /* Even if mark_active is non-nil, the actual buffer
1663 marker may not have been set yet (Bug#7044). */
1664 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1665 && (EQ (Vselect_active_regions
, Qonly
)
1666 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1667 : (!NILP (Vselect_active_regions
)
1668 && !NILP (Vtransient_mark_mode
)))
1669 && NILP (Fmemq (Vthis_command
,
1670 Vselection_inhibit_update_commands
)))
1673 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1676 call2 (Qx_set_selection
, QPRIMARY
,
1677 make_buffer_string (beg
, end
, 0));
1679 call2 (Qx_set_selection
, QPRIMARY
,
1680 make_buffer_string (end
, beg
, 0));
1681 /* Don't set empty selections. */
1684 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1686 Lisp_Object hook
= intern ("activate-mark-hook");
1687 Frun_hooks (1, &hook
);
1691 Vsaved_region_selection
= Qnil
;
1696 if (current_buffer
== prev_buffer
1697 && last_point_position
!= PT
1698 && NILP (Vdisable_point_adjustment
)
1699 && NILP (Vglobal_disable_point_adjustment
))
1701 if (last_point_position
> BEGV
1702 && last_point_position
< ZV
1703 && (composition_adjust_point (last_point_position
,
1704 last_point_position
)
1705 != last_point_position
))
1706 /* The last point was temporarily set within a grapheme
1707 cluster to prevent automatic composition. To recover
1708 the automatic composition, we must update the
1710 windows_or_buffers_changed
++;
1711 if (!already_adjusted
)
1712 adjust_point_for_property (last_point_position
,
1713 MODIFF
!= prev_modiff
);
1716 /* Install chars successfully executed in kbd macro. */
1718 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1719 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1720 finalize_kbd_macro_chars ();
1724 /* Adjust point to a boundary of a region that has such a property
1725 that should be treated intangible. For the moment, we check
1726 `composition', `display' and `invisible' properties.
1727 LAST_PT is the last position of point. */
1730 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1733 Lisp_Object val
, overlay
, tmp
;
1734 /* When called after buffer modification, we should temporarily
1735 suppress the point adjustment for automatic composition so that a
1736 user can keep inserting another character at point or keep
1737 deleting characters around point. */
1738 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1739 ptrdiff_t orig_pt
= PT
;
1741 /* FIXME: cycling is probably not necessary because these properties
1742 can't be usefully combined anyway. */
1743 while (check_composition
|| check_display
|| check_invisible
)
1745 /* FIXME: check `intangible'. */
1746 if (check_composition
1747 && PT
> BEGV
&& PT
< ZV
1748 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1751 check_display
= check_invisible
= 1;
1753 check_composition
= 0;
1755 && PT
> BEGV
&& PT
< ZV
1756 && !NILP (val
= get_char_property_and_overlay
1757 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1758 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1759 && (!OVERLAYP (overlay
)
1760 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1761 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1762 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1763 && (beg
< PT
/* && end > PT <- It's always the case. */
1764 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1767 SET_PT (PT
< last_pt
1768 ? (STRINGP (val
) && SCHARS (val
) == 0
1769 ? max (beg
- 1, BEGV
)
1772 check_composition
= check_invisible
= 1;
1775 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1781 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1784 /* FIXME: We should stop if we find a spot between
1785 two runs of `invisible' where inserted text would
1786 be visible. This is important when we have two
1787 invisible boundaries that enclose an area: if the
1788 area is empty, we need this test in order to make
1789 it possible to place point in the middle rather
1790 than skip both boundaries. However, this code
1791 also stops anywhere in a non-sticky text-property,
1792 which breaks (e.g.) Org mode. */
1793 && (val
= get_pos_property (make_number (end
),
1795 TEXT_PROP_MEANS_INVISIBLE (val
))
1797 && !NILP (val
= get_char_property_and_overlay
1798 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1799 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1801 ellipsis
= ellipsis
|| inv
> 1
1802 || (OVERLAYP (overlay
)
1803 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1804 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1805 tmp
= Fnext_single_char_property_change
1806 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1807 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1811 && (val
= get_pos_property (make_number (beg
),
1813 TEXT_PROP_MEANS_INVISIBLE (val
))
1815 && !NILP (val
= get_char_property_and_overlay
1816 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1817 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1819 ellipsis
= ellipsis
|| inv
> 1
1820 || (OVERLAYP (overlay
)
1821 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1822 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1823 tmp
= Fprevious_single_char_property_change
1824 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1825 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1828 /* Move away from the inside area. */
1829 if (beg
< PT
&& end
> PT
)
1831 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1832 /* We haven't moved yet (so we don't need to fear
1833 infinite-looping) and we were outside the range
1834 before (so either end of the range still corresponds
1835 to a move in the right direction): pretend we moved
1836 less than we actually did, so that we still have
1837 more freedom below in choosing which end of the range
1839 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1840 /* We either have moved already or the last point
1841 was already in the range: we don't get to choose
1842 which end of the range we have to go to. */
1843 : (PT
< last_pt
? beg
: end
));
1844 check_composition
= check_display
= 1;
1846 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1847 the point to something other than its argument, due to
1848 point-motion hooks, intangibility, etc. */
1849 eassert (PT
== beg
|| PT
== end
);
1852 /* Pretend the area doesn't exist if the buffer is not
1854 if (!modified
&& !ellipsis
&& beg
< end
)
1856 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1857 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1858 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1859 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1860 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1861 /* We've already moved as far as we can. Trying to go
1862 to the other end would mean moving backwards and thus
1863 could lead to an infinite loop. */
1865 else if (val
= get_pos_property (make_number (PT
),
1867 TEXT_PROP_MEANS_INVISIBLE (val
)
1868 && (val
= get_pos_property
1869 (make_number (PT
== beg
? end
: beg
),
1871 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1872 (check_composition
= check_display
= 1,
1873 SET_PT (PT
== beg
? end
: beg
));
1876 check_invisible
= 0;
1880 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1883 safe_run_hooks_1 (void)
1885 eassert (CONSP (Vinhibit_quit
));
1886 return call0 (XCDR (Vinhibit_quit
));
1889 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1893 safe_run_hooks_error (Lisp_Object error_data
)
1896 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1897 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1898 Lisp_Object args
[4];
1899 args
[0] = build_string ("Error in %s (%s): %S");
1902 args
[3] = error_data
;
1908 Lisp_Object newval
= Qnil
;
1909 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1910 if (EQ (fun
, XCAR (val
)))
1913 newval
= Fcons (XCAR (val
), newval
);
1915 return Fset (hook
, Fnreverse (newval
));
1916 /* Not found in the local part of the hook. Let's look at the global
1919 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1920 : Fdefault_value (hook
));
1921 CONSP (val
); val
= XCDR (val
))
1922 if (EQ (fun
, XCAR (val
)))
1925 newval
= Fcons (XCAR (val
), newval
);
1927 return Fset_default (hook
, Fnreverse (newval
));
1933 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1935 eassert (nargs
== 1);
1936 if (CONSP (Vinhibit_quit
))
1937 XSETCDR (Vinhibit_quit
, args
[0]);
1939 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1941 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1945 /* If we get an error while running the hook, cause the hook variable
1946 to be nil. Also inhibit quits, so that C-g won't cause the hook
1947 to mysteriously evaporate. */
1950 safe_run_hooks (Lisp_Object hook
)
1952 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1953 to its body or to its handlers other than via globals such as
1954 dynamically-bound variables ;-) */
1955 ptrdiff_t count
= SPECPDL_INDEX ();
1956 specbind (Qinhibit_quit
, hook
);
1958 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1960 unbind_to (count
, Qnil
);
1964 /* Nonzero means polling for input is temporarily suppressed. */
1966 int poll_suppress_count
;
1969 #ifdef POLL_FOR_INPUT
1971 /* Asynchronous timer for polling. */
1973 static struct atimer
*poll_timer
;
1975 /* Poll for input, so that we catch a C-g if it comes in. This
1976 function is called from x_make_frame_visible, see comment
1980 poll_for_input_1 (void)
1982 if (! input_blocked_p ()
1983 && !waiting_for_input
)
1987 /* Timer callback function for poll_timer. TIMER is equal to
1991 poll_for_input (struct atimer
*timer
)
1993 if (poll_suppress_count
== 0)
1994 pending_signals
= 1;
1997 #endif /* POLL_FOR_INPUT */
1999 /* Begin signals to poll for input, if they are appropriate.
2000 This function is called unconditionally from various places. */
2003 start_polling (void)
2005 #ifdef POLL_FOR_INPUT
2006 /* XXX This condition was (read_socket_hook && !interrupt_input),
2007 but read_socket_hook is not global anymore. Let's pretend that
2009 if (!interrupt_input
)
2011 /* Turn alarm handling on unconditionally. It might have
2012 been turned off in process.c. */
2013 turn_on_atimers (1);
2015 /* If poll timer doesn't exist, are we need one with
2016 a different interval, start a new one. */
2017 if (poll_timer
== NULL
2018 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2020 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2021 EMACS_TIME interval
= make_emacs_time (period
, 0);
2024 cancel_atimer (poll_timer
);
2026 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2027 poll_for_input
, NULL
);
2030 /* Let the timer's callback function poll for input
2031 if this becomes zero. */
2032 --poll_suppress_count
;
2037 /* True if we are using polling to handle input asynchronously. */
2040 input_polling_used (void)
2042 #ifdef POLL_FOR_INPUT
2043 /* XXX This condition was (read_socket_hook && !interrupt_input),
2044 but read_socket_hook is not global anymore. Let's pretend that
2046 return !interrupt_input
;
2052 /* Turn off polling. */
2057 #ifdef POLL_FOR_INPUT
2058 /* XXX This condition was (read_socket_hook && !interrupt_input),
2059 but read_socket_hook is not global anymore. Let's pretend that
2061 if (!interrupt_input
)
2062 ++poll_suppress_count
;
2066 /* Set the value of poll_suppress_count to COUNT
2067 and start or stop polling accordingly. */
2070 set_poll_suppress_count (int count
)
2072 #ifdef POLL_FOR_INPUT
2073 if (count
== 0 && poll_suppress_count
!= 0)
2075 poll_suppress_count
= 1;
2078 else if (count
!= 0 && poll_suppress_count
== 0)
2082 poll_suppress_count
= count
;
2086 /* Bind polling_period to a value at least N.
2087 But don't decrease it. */
2090 bind_polling_period (int n
)
2092 #ifdef POLL_FOR_INPUT
2093 EMACS_INT
new = polling_period
;
2098 stop_other_atimers (poll_timer
);
2100 specbind (Qpolling_period
, make_number (new));
2101 /* Start a new alarm with the new period. */
2106 /* Apply the control modifier to CHARACTER. */
2109 make_ctrl_char (int c
)
2111 /* Save the upper bits here. */
2112 int upper
= c
& ~0177;
2114 if (! ASCII_BYTE_P (c
))
2115 return c
|= ctrl_modifier
;
2119 /* Everything in the columns containing the upper-case letters
2120 denotes a control character. */
2121 if (c
>= 0100 && c
< 0140)
2125 /* Set the shift modifier for a control char
2126 made from a shifted letter. But only for letters! */
2127 if (oc
>= 'A' && oc
<= 'Z')
2128 c
|= shift_modifier
;
2131 /* The lower-case letters denote control characters too. */
2132 else if (c
>= 'a' && c
<= 'z')
2135 /* Include the bits for control and shift
2136 only if the basic ASCII code can't indicate them. */
2140 /* Replace the high bits. */
2141 c
|= (upper
& ~ctrl_modifier
);
2146 /* Display the help-echo property of the character after the mouse pointer.
2147 Either show it in the echo area, or call show-help-function to display
2148 it by other means (maybe in a tooltip).
2150 If HELP is nil, that means clear the previous help echo.
2152 If HELP is a string, display that string. If HELP is a function,
2153 call it with OBJECT and POS as arguments; the function should
2154 return a help string or nil for none. For all other types of HELP,
2155 evaluate it to obtain a string.
2157 WINDOW is the window in which the help was generated, if any.
2158 It is nil if not in a window.
2160 If OBJECT is a buffer, POS is the position in the buffer where the
2161 `help-echo' text property was found.
2163 If OBJECT is an overlay, that overlay has a `help-echo' property,
2164 and POS is the position in the overlay's buffer under the mouse.
2166 If OBJECT is a string (an overlay string or a string displayed with
2167 the `display' property). POS is the position in that string under
2170 Note: this function may only be called with HELP nil or a string
2171 from X code running asynchronously. */
2174 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2177 if (!NILP (help
) && !STRINGP (help
))
2179 if (FUNCTIONP (help
))
2180 help
= safe_call (4, help
, window
, object
, pos
);
2182 help
= safe_eval (help
);
2184 if (!STRINGP (help
))
2188 if (!noninteractive
&& STRINGP (help
))
2190 /* The mouse-fixup-help-message Lisp function can call
2191 mouse_position_hook, which resets the mouse_moved flags.
2192 This causes trouble if we are trying to read a mouse motion
2193 event (i.e., if we are inside a `track-mouse' form), so we
2194 restore the mouse_moved flag. */
2195 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2196 help
= call1 (Qmouse_fixup_help_message
, help
);
2201 if (STRINGP (help
) || NILP (help
))
2203 if (!NILP (Vshow_help_function
))
2204 call1 (Vshow_help_function
, help
);
2205 help_echo_showing_p
= STRINGP (help
);
2211 /* Input of single characters from keyboard */
2213 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2214 EMACS_TIME
*end_time
);
2215 static void record_char (Lisp_Object c
);
2217 static Lisp_Object help_form_saved_window_configs
;
2219 read_char_help_form_unwind (Lisp_Object arg
)
2221 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2222 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2223 if (!NILP (window_config
))
2224 Fset_window_configuration (window_config
);
2228 #define STOP_POLLING \
2229 do { if (! polling_stopped_here) stop_polling (); \
2230 polling_stopped_here = 1; } while (0)
2232 #define RESUME_POLLING \
2233 do { if (polling_stopped_here) start_polling (); \
2234 polling_stopped_here = 0; } while (0)
2236 /* Read a character from the keyboard; call the redisplay if needed. */
2237 /* commandflag 0 means do not autosave, but do redisplay.
2238 -1 means do not redisplay, but do autosave.
2241 /* The arguments MAP is for menu prompting. MAP is a keymap.
2243 PREV_EVENT is the previous input event, or nil if we are reading
2244 the first event of a key sequence (or not reading a key sequence).
2245 If PREV_EVENT is t, that is a "magic" value that says
2246 not to run input methods, but in other respects to act as if
2247 not reading a key sequence.
2249 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2250 if we used a mouse menu to read the input, or false otherwise. If
2251 USED_MOUSE_MENU is null, don't dereference it.
2253 Value is -2 when we find input on another keyboard. A second call
2254 to read_char will read it.
2256 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2257 specifying the maximum time to wait until. If no input arrives by
2258 that time, stop waiting and return nil.
2260 Value is t if we showed a menu and the user rejected it. */
2263 read_char (int commandflag
, Lisp_Object map
,
2264 Lisp_Object prev_event
,
2265 bool *used_mouse_menu
, EMACS_TIME
*end_time
)
2269 sys_jmp_buf local_getcjmp
;
2270 sys_jmp_buf save_jump
;
2271 Lisp_Object tem
, save
;
2272 volatile Lisp_Object previous_echo_area_message
;
2273 volatile Lisp_Object also_record
;
2274 volatile bool reread
;
2275 struct gcpro gcpro1
, gcpro2
;
2276 bool volatile polling_stopped_here
= 0;
2277 struct kboard
*orig_kboard
= current_kboard
;
2281 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2282 before_command_key_count
= this_command_key_count
;
2283 before_command_echo_length
= echo_length ();
2286 previous_echo_area_message
= Qnil
;
2288 GCPRO2 (c
, previous_echo_area_message
);
2293 if (CONSP (Vunread_post_input_method_events
))
2295 c
= XCAR (Vunread_post_input_method_events
);
2296 Vunread_post_input_method_events
2297 = XCDR (Vunread_post_input_method_events
);
2299 /* Undo what read_char_x_menu_prompt did when it unread
2300 additional keys returned by Fx_popup_menu. */
2302 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2310 if (CONSP (Vunread_command_events
))
2312 bool was_disabled
= 0;
2314 c
= XCAR (Vunread_command_events
);
2315 Vunread_command_events
= XCDR (Vunread_command_events
);
2319 /* Undo what sit-for did when it unread additional keys
2320 inside universal-argument. */
2323 && EQ (XCAR (c
), Qt
))
2329 /* Undo what read_char_x_menu_prompt did when it unread
2330 additional keys returned by Fx_popup_menu. */
2332 && EQ (XCDR (c
), Qdisabled
)
2333 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2339 /* If the queued event is something that used the mouse,
2340 set used_mouse_menu accordingly. */
2342 /* Also check was_disabled so last-nonmenu-event won't return
2343 a bad value when submenus are involved. (Bug#447) */
2344 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2345 *used_mouse_menu
= 1;
2347 goto reread_for_input_method
;
2350 if (CONSP (Vunread_input_method_events
))
2352 c
= XCAR (Vunread_input_method_events
);
2353 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2355 /* Undo what read_char_x_menu_prompt did when it unread
2356 additional keys returned by Fx_popup_menu. */
2358 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2362 goto reread_for_input_method
;
2365 this_command_key_count_reset
= 0;
2367 if (!NILP (Vexecuting_kbd_macro
))
2369 /* We set this to Qmacro; since that's not a frame, nobody will
2370 try to switch frames on us, and the selected window will
2373 Since this event came from a macro, it would be misleading to
2374 leave internal_last_event_frame set to wherever the last
2375 real event came from. Normally, a switch-frame event selects
2376 internal_last_event_frame after each command is read, but
2377 events read from a macro should never cause a new frame to be
2379 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2381 /* Exit the macro if we are at the end.
2382 Also, some things replace the macro with t
2383 to force an early exit. */
2384 if (EQ (Vexecuting_kbd_macro
, Qt
)
2385 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2391 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2392 if (STRINGP (Vexecuting_kbd_macro
)
2393 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2394 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2396 executing_kbd_macro_index
++;
2401 if (!NILP (unread_switch_frame
))
2403 c
= unread_switch_frame
;
2404 unread_switch_frame
= Qnil
;
2406 /* This event should make it into this_command_keys, and get echoed
2407 again, so we do not set `reread'. */
2411 /* If redisplay was requested. */
2412 if (commandflag
>= 0)
2414 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2416 /* If there is pending input, process any events which are not
2417 user-visible, such as X selection_request events. */
2419 || detect_input_pending_run_timers (0))
2420 swallow_events (0); /* May clear input_pending. */
2422 /* Redisplay if no pending input. */
2423 while (!input_pending
)
2425 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2426 redisplay_preserve_echo_area (5);
2431 /* Normal case: no input arrived during redisplay. */
2434 /* Input arrived and pre-empted redisplay.
2435 Process any events which are not user-visible. */
2437 /* If that cleared input_pending, try again to redisplay. */
2440 /* Prevent the redisplay we just did
2441 from messing up echoing of the input after the prompt. */
2442 if (commandflag
== 0 && echo_current
)
2443 echo_message_buffer
= echo_area_buffer
[0];
2447 /* Message turns off echoing unless more keystrokes turn it on again.
2449 The code in 20.x for the condition was
2451 1. echo_area_glyphs && *echo_area_glyphs
2452 2. && echo_area_glyphs != current_kboard->echobuf
2453 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2455 (1) means there's a current message displayed
2457 (2) means it's not the message from echoing from the current
2460 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2461 is set to a non-null value. This is done in read_char and it is
2462 set to echo_area_glyphs after a call to echo_char. That means
2463 ok_to_echo_at_next_pause is either null or
2464 current_kboard->echobuf with the appropriate current_kboard at
2467 So, condition (3) means in clear text ok_to_echo_at_next_pause
2468 must be either null, or the current message isn't from echoing at
2469 all, or it's from echoing from a different kboard than the
2472 if (/* There currently is something in the echo area. */
2473 !NILP (echo_area_buffer
[0])
2474 && (/* And it's either not from echoing. */
2475 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2476 /* Or it's an echo from a different kboard. */
2477 || echo_kboard
!= current_kboard
2478 /* Or we explicitly allow overwriting whatever there is. */
2479 || ok_to_echo_at_next_pause
== NULL
))
2484 /* Try reading a character via menu prompting in the minibuf.
2485 Try this before the sit-for, because the sit-for
2486 would do the wrong thing if we are supposed to do
2487 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2488 after a mouse event so don't try a minibuf menu. */
2490 if (KEYMAPP (map
) && INTERACTIVE
2491 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2492 /* Don't bring up a menu if we already have another event. */
2493 && NILP (Vunread_command_events
)
2494 && !detect_input_pending_run_timers (0))
2496 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2498 if (INTEGERP (c
) && XINT (c
) == -2)
2499 return c
; /* wrong_kboard_jmpbuf */
2505 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2506 We will do that below, temporarily for short sections of code,
2507 when appropriate. local_getcjmp must be in effect
2508 around any call to sit_for or kbd_buffer_get_event;
2509 it *must not* be in effect when we call redisplay. */
2511 jmpcount
= SPECPDL_INDEX ();
2512 if (sys_setjmp (local_getcjmp
))
2514 /* Handle quits while reading the keyboard. */
2515 /* We must have saved the outer value of getcjmp here,
2516 so restore it now. */
2517 restore_getcjmp (save_jump
);
2518 unbind_to (jmpcount
, Qnil
);
2519 XSETINT (c
, quit_char
);
2520 internal_last_event_frame
= selected_frame
;
2521 Vlast_event_frame
= internal_last_event_frame
;
2522 /* If we report the quit char as an event,
2523 don't do so more than once. */
2524 if (!NILP (Vinhibit_quit
))
2528 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2529 if (kb
!= current_kboard
)
2531 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2532 /* We shouldn't get here if we were in single-kboard mode! */
2537 while (CONSP (XCDR (last
)))
2539 if (!NILP (XCDR (last
)))
2543 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2545 XSETCDR (last
, Fcons (c
, Qnil
));
2546 kb
->kbd_queue_has_data
= 1;
2547 current_kboard
= kb
;
2548 /* This is going to exit from read_char
2549 so we had better get rid of this frame's stuff. */
2551 return make_number (-2); /* wrong_kboard_jmpbuf */
2557 /* Start idle timers if no time limit is supplied. We don't do it
2558 if a time limit is supplied to avoid an infinite recursion in the
2559 situation where an idle timer calls `sit-for'. */
2562 timer_start_idle ();
2564 /* If in middle of key sequence and minibuffer not active,
2565 start echoing if enough time elapses. */
2567 if (minibuf_level
== 0
2569 && !current_kboard
->immediate_echo
2570 && this_command_key_count
> 0
2572 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2573 && NILP (Fzerop (Vecho_keystrokes
))
2574 && (/* No message. */
2575 NILP (echo_area_buffer
[0])
2576 /* Or empty message. */
2577 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2578 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2579 /* Or already echoing from same kboard. */
2580 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2581 /* Or not echoing before and echoing allowed. */
2582 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2584 /* After a mouse event, start echoing right away.
2585 This is because we are probably about to display a menu,
2586 and we don't want to delay before doing so. */
2587 if (EVENT_HAS_PARAMETERS (prev_event
))
2593 save_getcjmp (save_jump
);
2594 restore_getcjmp (local_getcjmp
);
2595 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2596 restore_getcjmp (save_jump
);
2598 && ! CONSP (Vunread_command_events
))
2603 /* Maybe auto save due to number of keystrokes. */
2605 if (commandflag
!= 0
2606 && auto_save_interval
> 0
2607 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2608 && !detect_input_pending_run_timers (0))
2610 Fdo_auto_save (Qnil
, Qnil
);
2611 /* Hooks can actually change some buffers in auto save. */
2615 /* Try reading using an X menu.
2616 This is never confused with reading using the minibuf
2617 because the recursive call of read_char in read_char_minibuf_menu_prompt
2618 does not pass on any keymaps. */
2620 if (KEYMAPP (map
) && INTERACTIVE
2621 && !NILP (prev_event
)
2622 && EVENT_HAS_PARAMETERS (prev_event
)
2623 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2624 && !EQ (XCAR (prev_event
), Qtool_bar
)
2625 /* Don't bring up a menu if we already have another event. */
2626 && NILP (Vunread_command_events
))
2628 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2630 /* Now that we have read an event, Emacs is not idle. */
2637 /* Maybe autosave and/or garbage collect due to idleness. */
2639 if (INTERACTIVE
&& NILP (c
))
2642 ptrdiff_t buffer_size
;
2644 /* Slow down auto saves logarithmically in size of current buffer,
2645 and garbage collect while we're at it. */
2646 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2647 last_non_minibuf_size
= Z
- BEG
;
2648 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2650 while (buffer_size
> 64)
2651 delay_level
++, buffer_size
-= buffer_size
>> 2;
2652 if (delay_level
< 4) delay_level
= 4;
2653 /* delay_level is 4 for files under around 50k, 7 at 100k,
2654 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2656 /* Auto save if enough time goes by without input. */
2657 if (commandflag
!= 0
2658 && num_nonmacro_input_events
> last_auto_save
2659 && INTEGERP (Vauto_save_timeout
)
2660 && XINT (Vauto_save_timeout
) > 0)
2663 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2665 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2666 timeout
= delay_level
* timeout
/ 4;
2667 save_getcjmp (save_jump
);
2668 restore_getcjmp (local_getcjmp
);
2669 tem0
= sit_for (make_number (timeout
), 1, 1);
2670 restore_getcjmp (save_jump
);
2673 && ! CONSP (Vunread_command_events
))
2675 Fdo_auto_save (Qnil
, Qnil
);
2680 /* If there is still no input available, ask for GC. */
2681 if (!detect_input_pending_run_timers (0))
2685 /* Notify the caller if an autosave hook, or a timer, sentinel or
2686 filter in the sit_for calls above have changed the current
2687 kboard. This could happen if they use the minibuffer or start a
2688 recursive edit, like the fancy splash screen in server.el's
2689 filter. If this longjmp wasn't here, read_key_sequence would
2690 interpret the next key sequence using the wrong translation
2691 tables and function keymaps. */
2692 if (NILP (c
) && current_kboard
!= orig_kboard
)
2695 return make_number (-2); /* wrong_kboard_jmpbuf */
2698 /* If this has become non-nil here, it has been set by a timer
2699 or sentinel or filter. */
2700 if (CONSP (Vunread_command_events
))
2702 c
= XCAR (Vunread_command_events
);
2703 Vunread_command_events
= XCDR (Vunread_command_events
);
2706 /* Read something from current KBOARD's side queue, if possible. */
2710 if (current_kboard
->kbd_queue_has_data
)
2712 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2714 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2715 kset_kbd_queue (current_kboard
,
2716 XCDR (KVAR (current_kboard
, kbd_queue
)));
2717 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2718 current_kboard
->kbd_queue_has_data
= 0;
2719 input_pending
= readable_events (0);
2720 if (EVENT_HAS_PARAMETERS (c
)
2721 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2722 internal_last_event_frame
= XCAR (XCDR (c
));
2723 Vlast_event_frame
= internal_last_event_frame
;
2727 /* If current_kboard's side queue is empty check the other kboards.
2728 If one of them has data that we have not yet seen here,
2729 switch to it and process the data waiting for it.
2731 Note: if the events queued up for another kboard
2732 have already been seen here, and therefore are not a complete command,
2733 the kbd_queue_has_data field is 0, so we skip that kboard here.
2734 That's to avoid an infinite loop switching between kboards here. */
2735 if (NILP (c
) && !single_kboard
)
2738 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2739 if (kb
->kbd_queue_has_data
)
2741 current_kboard
= kb
;
2742 /* This is going to exit from read_char
2743 so we had better get rid of this frame's stuff. */
2745 return make_number (-2); /* wrong_kboard_jmpbuf */
2753 /* Finally, we read from the main queue,
2754 and if that gives us something we can't use yet, we put it on the
2755 appropriate side queue and try again. */
2759 KBOARD
*kb
IF_LINT (= NULL
);
2761 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2764 /* Actually read a character, waiting if necessary. */
2765 save_getcjmp (save_jump
);
2766 restore_getcjmp (local_getcjmp
);
2768 timer_start_idle ();
2769 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2770 restore_getcjmp (save_jump
);
2772 if (! NILP (c
) && (kb
!= current_kboard
))
2774 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2777 while (CONSP (XCDR (last
)))
2779 if (!NILP (XCDR (last
)))
2783 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2785 XSETCDR (last
, Fcons (c
, Qnil
));
2786 kb
->kbd_queue_has_data
= 1;
2790 current_kboard
= kb
;
2791 /* This is going to exit from read_char
2792 so we had better get rid of this frame's stuff. */
2794 return make_number (-2);
2798 /* Terminate Emacs in batch mode if at eof. */
2799 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2800 Fkill_emacs (make_number (1));
2804 /* Add in any extra modifiers, where appropriate. */
2805 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2806 || ((extra_keyboard_modifiers
& 0177) < ' '
2807 && (extra_keyboard_modifiers
& 0177) != 0))
2808 XSETINT (c
, make_ctrl_char (XINT (c
)));
2810 /* Transfer any other modifier bits directly from
2811 extra_keyboard_modifiers to c. Ignore the actual character code
2812 in the low 16 bits of extra_keyboard_modifiers. */
2813 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2824 if (commandflag
>= 0
2825 && !input_pending
&& !detect_input_pending_run_timers (0))
2831 /* Buffer switch events are only for internal wakeups
2832 so don't show them to the user.
2833 Also, don't record a key if we already did. */
2837 /* Process special events within read_char
2838 and loop around to read another event. */
2841 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2846 struct buffer
*prev_buffer
= current_buffer
;
2847 last_input_event
= c
;
2848 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2850 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2851 /* We stopped being idle for this event; undo that. This
2852 prevents automatic window selection (under
2853 mouse_autoselect_window from acting as a real input event, for
2854 example banishing the mouse under mouse-avoidance-mode. */
2855 timer_resume_idle ();
2857 if (current_buffer
!= prev_buffer
)
2859 /* The command may have changed the keymaps. Pretend there
2860 is input in another keyboard and return. This will
2861 recalculate keymaps. */
2862 c
= make_number (-2);
2869 /* Handle things that only apply to characters. */
2872 /* If kbd_buffer_get_event gave us an EOF, return that. */
2876 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2877 && UNSIGNED_CMP (XFASTINT (c
), <,
2878 SCHARS (KVAR (current_kboard
,
2879 Vkeyboard_translate_table
))))
2880 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2881 && UNSIGNED_CMP (XFASTINT (c
), <,
2882 ASIZE (KVAR (current_kboard
,
2883 Vkeyboard_translate_table
))))
2884 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2888 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2889 /* nil in keyboard-translate-table means no translation. */
2895 /* If this event is a mouse click in the menu bar,
2896 return just menu-bar for now. Modify the mouse click event
2897 so we won't do this twice, then queue it up. */
2898 if (EVENT_HAS_PARAMETERS (c
)
2900 && CONSP (EVENT_START (c
))
2901 && CONSP (XCDR (EVENT_START (c
))))
2905 posn
= POSN_POSN (EVENT_START (c
));
2906 /* Handle menu-bar events:
2907 insert the dummy prefix event `menu-bar'. */
2908 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2910 /* Change menu-bar to (menu-bar) as the event "position". */
2911 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2914 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2919 /* Store these characters into recent_keys, the dribble file if any,
2920 and the keyboard macro being defined, if any. */
2922 if (! NILP (also_record
))
2923 record_char (also_record
);
2925 /* Wipe the echo area.
2926 But first, if we are about to use an input method,
2927 save the echo area contents for it to refer to. */
2929 && ! NILP (Vinput_method_function
)
2930 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2932 previous_echo_area_message
= Fcurrent_message ();
2933 Vinput_method_previous_message
= previous_echo_area_message
;
2936 /* Now wipe the echo area, except for help events which do their
2937 own stuff with the echo area. */
2939 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2940 && !(EQ (Qswitch_frame
, XCAR (c
)))
2941 /* Don't wipe echo area for select window events: These might
2942 get delayed via `mouse-autoselect-window' (Bug#11304). */
2943 && !(EQ (Qselect_window
, XCAR (c
)))))
2945 if (!NILP (echo_area_buffer
[0]))
2947 safe_run_hooks (Qecho_area_clear_hook
);
2948 clear_message (1, 0);
2952 reread_for_input_method
:
2954 /* Pass this to the input method, if appropriate. */
2956 && ! NILP (Vinput_method_function
)
2957 /* Don't run the input method within a key sequence,
2958 after the first event of the key sequence. */
2959 && NILP (prev_event
)
2960 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2963 ptrdiff_t key_count
;
2964 bool key_count_reset
;
2965 struct gcpro gcpro1
;
2966 ptrdiff_t count
= SPECPDL_INDEX ();
2968 /* Save the echo status. */
2969 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2970 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2971 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2972 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2975 if (before_command_restore_flag
)
2977 this_command_key_count
= before_command_key_count_1
;
2978 if (this_command_key_count
< this_single_command_key_start
)
2979 this_single_command_key_start
= this_command_key_count
;
2980 echo_truncate (before_command_echo_length_1
);
2981 before_command_restore_flag
= 0;
2985 /* Save the this_command_keys status. */
2986 key_count
= this_command_key_count
;
2987 key_count_reset
= this_command_key_count_reset
;
2990 keys
= Fcopy_sequence (this_command_keys
);
2995 /* Clear out this_command_keys. */
2996 this_command_key_count
= 0;
2997 this_command_key_count_reset
= 0;
2999 /* Now wipe the echo area. */
3000 if (!NILP (echo_area_buffer
[0]))
3001 safe_run_hooks (Qecho_area_clear_hook
);
3002 clear_message (1, 0);
3005 /* If we are not reading a key sequence,
3006 never use the echo area. */
3009 specbind (Qinput_method_use_echo_area
, Qt
);
3012 /* Call the input method. */
3013 tem
= call1 (Vinput_method_function
, c
);
3015 tem
= unbind_to (count
, tem
);
3017 /* Restore the saved echoing state
3018 and this_command_keys state. */
3019 this_command_key_count
= key_count
;
3020 this_command_key_count_reset
= key_count_reset
;
3022 this_command_keys
= keys
;
3025 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3026 kset_echo_string (current_kboard
, saved_echo_string
);
3027 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3028 if (saved_immediate_echo
)
3033 /* The input method can return no events. */
3036 /* Bring back the previous message, if any. */
3037 if (! NILP (previous_echo_area_message
))
3038 message_with_string ("%s", previous_echo_area_message
, 0);
3041 /* It returned one event or more. */
3043 Vunread_post_input_method_events
3044 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3049 /* Display help if not echoing. */
3050 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3052 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3053 Lisp_Object help
, object
, position
, window
, htem
;
3055 htem
= Fcdr (XCDR (c
));
3058 window
= Fcar (htem
);
3060 object
= Fcar (htem
);
3062 position
= Fcar (htem
);
3064 show_help_echo (help
, window
, object
, position
);
3066 /* We stopped being idle for this event; undo that. */
3068 timer_resume_idle ();
3072 if ((! reread
|| this_command_key_count
== 0
3073 || this_command_key_count_reset
)
3077 /* Don't echo mouse motion events. */
3078 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3079 && NILP (Fzerop (Vecho_keystrokes
))
3080 && ! (EVENT_HAS_PARAMETERS (c
)
3081 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3084 if (! NILP (also_record
))
3085 echo_char (also_record
);
3086 /* Once we reread a character, echoing can happen
3087 the next time we pause to read a new one. */
3088 ok_to_echo_at_next_pause
= current_kboard
;
3091 /* Record this character as part of the current key. */
3092 add_command_key (c
);
3093 if (! NILP (also_record
))
3094 add_command_key (also_record
);
3097 last_input_event
= c
;
3100 /* Process the help character specially if enabled. */
3101 if (!NILP (Vhelp_form
) && help_char_p (c
))
3103 ptrdiff_t count
= SPECPDL_INDEX ();
3105 help_form_saved_window_configs
3106 = Fcons (Fcurrent_window_configuration (Qnil
),
3107 help_form_saved_window_configs
);
3108 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3109 call0 (Qhelp_form_show
);
3114 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3115 if (EVENT_HAS_PARAMETERS (c
)
3116 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3117 XSETCAR (help_form_saved_window_configs
, Qnil
);
3119 while (BUFFERP (c
));
3120 /* Remove the help from the frame. */
3121 unbind_to (count
, Qnil
);
3124 if (EQ (c
, make_number (040)))
3128 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3129 while (BUFFERP (c
));
3138 /* Record a key that came from a mouse menu.
3139 Record it for echoing, for this-command-keys, and so on. */
3142 record_menu_key (Lisp_Object c
)
3144 /* Wipe the echo area. */
3145 clear_message (1, 0);
3150 before_command_key_count
= this_command_key_count
;
3151 before_command_echo_length
= echo_length ();
3154 /* Don't echo mouse motion events. */
3155 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3156 && NILP (Fzerop (Vecho_keystrokes
)))
3160 /* Once we reread a character, echoing can happen
3161 the next time we pause to read a new one. */
3162 ok_to_echo_at_next_pause
= 0;
3165 /* Record this character as part of the current key. */
3166 add_command_key (c
);
3168 /* Re-reading in the middle of a command */
3169 last_input_event
= c
;
3173 /* Return true if should recognize C as "the help character". */
3176 help_char_p (Lisp_Object c
)
3180 if (EQ (c
, Vhelp_char
))
3182 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3183 if (EQ (c
, XCAR (tail
)))
3188 /* Record the input event C in various ways. */
3191 record_char (Lisp_Object c
)
3195 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3197 /* To avoid filling recent_keys with help-echo and mouse-movement
3198 events, we filter out repeated help-echo events, only store the
3199 first and last in a series of mouse-movement events, and don't
3200 store repeated help-echo events which are only separated by
3201 mouse-movement events. */
3203 Lisp_Object ev1
, ev2
, ev3
;
3206 if ((ix1
= recent_keys_index
- 1) < 0)
3207 ix1
= NUM_RECENT_KEYS
- 1;
3208 ev1
= AREF (recent_keys
, ix1
);
3210 if ((ix2
= ix1
- 1) < 0)
3211 ix2
= NUM_RECENT_KEYS
- 1;
3212 ev2
= AREF (recent_keys
, ix2
);
3214 if ((ix3
= ix2
- 1) < 0)
3215 ix3
= NUM_RECENT_KEYS
- 1;
3216 ev3
= AREF (recent_keys
, ix3
);
3218 if (EQ (XCAR (c
), Qhelp_echo
))
3220 /* Don't record `help-echo' in recent_keys unless it shows some help
3221 message, and a different help than the previously recorded
3223 Lisp_Object help
, last_help
;
3225 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3226 if (!STRINGP (help
))
3228 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3229 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3231 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3232 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3233 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3235 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3236 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3237 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3238 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3241 else if (EQ (XCAR (c
), Qmouse_movement
))
3243 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3244 So additional mouse movement events replace the last element. */
3245 Lisp_Object last_window
, window
;
3247 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3248 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3249 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3250 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3251 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3253 ASET (recent_keys
, ix1
, c
);
3259 store_kbd_macro_char (c
);
3263 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3264 ASET (recent_keys
, recent_keys_index
, c
);
3265 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3266 recent_keys_index
= 0;
3268 else if (recorded
< 0)
3270 /* We need to remove one or two events from recent_keys.
3271 To do this, we simply put nil at those events and move the
3272 recent_keys_index backwards over those events. Usually,
3273 users will never see those nil events, as they will be
3274 overwritten by the command keys entered to see recent_keys
3277 while (recorded
++ < 0 && total_keys
> 0)
3279 if (total_keys
< NUM_RECENT_KEYS
)
3281 if (--recent_keys_index
< 0)
3282 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3283 ASET (recent_keys
, recent_keys_index
, Qnil
);
3287 num_nonmacro_input_events
++;
3289 /* Write c to the dribble file. If c is a lispy event, write
3290 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3291 If you, dear reader, have a better idea, you've got the source. :-) */
3297 if (XUINT (c
) < 0x100)
3298 putc (XUINT (c
), dribble
);
3300 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3304 Lisp_Object dribblee
;
3306 /* If it's a structured event, take the event header. */
3307 dribblee
= EVENT_HEAD (c
);
3309 if (SYMBOLP (dribblee
))
3311 putc ('<', dribble
);
3312 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3313 SBYTES (SYMBOL_NAME (dribblee
)),
3315 putc ('>', dribble
);
3324 /* Copy out or in the info on where C-g should throw to.
3325 This is used when running Lisp code from within get_char,
3326 in case get_char is called recursively.
3327 See read_process_output. */
3330 save_getcjmp (sys_jmp_buf temp
)
3332 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3336 restore_getcjmp (sys_jmp_buf temp
)
3338 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3341 /* Low level keyboard/mouse input.
3342 kbd_buffer_store_event places events in kbd_buffer, and
3343 kbd_buffer_get_event retrieves them. */
3345 /* Return true if there are any events in the queue that read-char
3346 would return. If this returns false, a read-char would block. */
3348 readable_events (int flags
)
3350 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3353 /* If the buffer contains only FOCUS_IN_EVENT events, and
3354 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3355 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3357 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3358 #ifdef USE_TOOLKIT_SCROLL_BARS
3359 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3363 struct input_event
*event
;
3365 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3372 #ifdef USE_TOOLKIT_SCROLL_BARS
3373 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3375 event
->kind
== FOCUS_IN_EVENT
)
3376 #ifdef USE_TOOLKIT_SCROLL_BARS
3377 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3378 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3379 && event
->part
== scroll_bar_handle
3380 && event
->modifiers
== 0)
3385 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3388 while (event
!= kbd_store_ptr
);
3394 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3395 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3399 if (current_kboard
->kbd_queue_has_data
)
3405 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3406 if (kb
->kbd_queue_has_data
)
3412 /* Set this for debugging, to have a way to get out */
3413 int stop_character EXTERNALLY_VISIBLE
;
3416 event_to_kboard (struct input_event
*event
)
3418 /* Not applicable for these special events. */
3419 if (event
->kind
== SELECTION_REQUEST_EVENT
3420 || event
->kind
== SELECTION_CLEAR_EVENT
)
3424 Lisp_Object obj
= event
->frame_or_window
;
3425 /* There are some events that set this field to nil or string. */
3427 obj
= WINDOW_FRAME (XWINDOW (obj
));
3428 /* Also ignore dead frames here. */
3429 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3430 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3435 /* Return the number of slots occupied in kbd_buffer. */
3438 kbd_buffer_nr_stored (void)
3440 return kbd_fetch_ptr
== kbd_store_ptr
3442 : (kbd_fetch_ptr
< kbd_store_ptr
3443 ? kbd_store_ptr
- kbd_fetch_ptr
3444 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3445 + (kbd_store_ptr
- kbd_buffer
)));
3447 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3450 kbd_buffer_store_event (register struct input_event
*event
)
3452 kbd_buffer_store_event_hold (event
, 0);
3455 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3457 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3458 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3459 Else, if EVENT is a quit event, store the quit event
3460 in HOLD_QUIT, and return (thus ignoring further events).
3462 This is used to postpone the processing of the quit event until all
3463 subsequent input events have been parsed (and discarded). */
3466 kbd_buffer_store_event_hold (register struct input_event
*event
,
3467 struct input_event
*hold_quit
)
3469 if (event
->kind
== NO_EVENT
)
3472 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3475 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3477 register int c
= event
->code
& 0377;
3479 if (event
->modifiers
& ctrl_modifier
)
3480 c
= make_ctrl_char (c
);
3482 c
|= (event
->modifiers
3483 & (meta_modifier
| alt_modifier
3484 | hyper_modifier
| super_modifier
));
3488 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3489 struct input_event
*sp
;
3491 if (single_kboard
&& kb
!= current_kboard
)
3494 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3495 Fcons (make_number (c
), Qnil
)));
3496 kb
->kbd_queue_has_data
= 1;
3497 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3499 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3502 if (event_to_kboard (sp
) == kb
)
3504 sp
->kind
= NO_EVENT
;
3505 sp
->frame_or_window
= Qnil
;
3514 *hold_quit
= *event
;
3518 /* If this results in a quit_char being returned to Emacs as
3519 input, set Vlast_event_frame properly. If this doesn't
3520 get returned to Emacs as an event, the next event read
3521 will set Vlast_event_frame again, so this is safe to do. */
3525 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3527 focus
= event
->frame_or_window
;
3528 internal_last_event_frame
= focus
;
3529 Vlast_event_frame
= focus
;
3532 last_event_timestamp
= event
->timestamp
;
3534 handle_interrupt (0);
3538 if (c
&& c
== stop_character
)
3544 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3545 Just ignore the second one. */
3546 else if (event
->kind
== BUFFER_SWITCH_EVENT
3547 && kbd_fetch_ptr
!= kbd_store_ptr
3548 && ((kbd_store_ptr
== kbd_buffer
3549 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3550 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3553 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3554 kbd_store_ptr
= kbd_buffer
;
3556 /* Don't let the very last slot in the buffer become full,
3557 since that would make the two pointers equal,
3558 and that is indistinguishable from an empty buffer.
3559 Discard the event if it would fill the last slot. */
3560 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3562 *kbd_store_ptr
= *event
;
3565 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3567 /* Don't read keyboard input until we have processed kbd_buffer.
3568 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3569 hold_keyboard_input ();
3570 if (!noninteractive
)
3574 #endif /* subprocesses */
3577 /* If we're inside while-no-input, and this event qualifies
3578 as input, set quit-flag to cause an interrupt. */
3579 if (!NILP (Vthrow_on_input
)
3580 && event
->kind
!= FOCUS_IN_EVENT
3581 && event
->kind
!= HELP_EVENT
3582 && event
->kind
!= DEICONIFY_EVENT
)
3584 Vquit_flag
= Vthrow_on_input
;
3585 /* If we're inside a function that wants immediate quits,
3587 if (immediate_quit
&& NILP (Vinhibit_quit
))
3596 /* Put an input event back in the head of the event queue. */
3599 kbd_buffer_unget_event (register struct input_event
*event
)
3601 if (kbd_fetch_ptr
== kbd_buffer
)
3602 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3604 /* Don't let the very last slot in the buffer become full, */
3605 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3608 *kbd_fetch_ptr
= *event
;
3613 /* Generate a HELP_EVENT input_event and store it in the keyboard
3616 HELP is the help form.
3618 FRAME and WINDOW are the frame and window where the help is
3619 generated. OBJECT is the Lisp object where the help was found (a
3620 buffer, a string, an overlay, or nil if neither from a string nor
3621 from a buffer). POS is the position within OBJECT where the help
3625 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3626 Lisp_Object object
, ptrdiff_t pos
)
3628 struct input_event event
;
3632 event
.kind
= HELP_EVENT
;
3633 event
.frame_or_window
= frame
;
3635 event
.x
= WINDOWP (window
) ? window
: frame
;
3638 kbd_buffer_store_event (&event
);
3642 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3645 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3647 struct input_event event
;
3649 event
.kind
= HELP_EVENT
;
3650 event
.frame_or_window
= frame
;
3655 kbd_buffer_store_event (&event
);
3659 /* Discard any mouse events in the event buffer by setting them to
3662 discard_mouse_events (void)
3664 struct input_event
*sp
;
3665 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3667 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3670 if (sp
->kind
== MOUSE_CLICK_EVENT
3671 || sp
->kind
== WHEEL_EVENT
3672 || sp
->kind
== HORIZ_WHEEL_EVENT
3674 || sp
->kind
== GPM_CLICK_EVENT
3676 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3678 sp
->kind
= NO_EVENT
;
3684 /* Return true if there are any real events waiting in the event
3685 buffer, not counting `NO_EVENT's.
3687 Discard NO_EVENT events at the front of the input queue, possibly
3688 leaving the input queue empty if there are no real input events. */
3691 kbd_buffer_events_waiting (void)
3693 struct input_event
*sp
;
3695 for (sp
= kbd_fetch_ptr
;
3696 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3699 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3704 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3708 /* Clear input event EVENT. */
3711 clear_event (struct input_event
*event
)
3713 event
->kind
= NO_EVENT
;
3717 /* Read one event from the event buffer, waiting if necessary.
3718 The value is a Lisp object representing the event.
3719 The value is nil for an event that should be ignored,
3720 or that was handled here.
3721 We always read and discard one event. */
3724 kbd_buffer_get_event (KBOARD
**kbp
,
3725 bool *used_mouse_menu
,
3726 EMACS_TIME
*end_time
)
3731 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3733 /* Start reading input again because we have processed enough to
3734 be able to accept new events again. */
3735 unhold_keyboard_input ();
3738 #endif /* subprocesses */
3740 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3742 /* In case we are running as a daemon, only do this before
3743 detaching from the terminal. */
3744 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3748 *kbp
= current_kboard
;
3751 #endif /* ! HAVE_DBUS */
3753 /* Wait until there is input available. */
3756 /* Break loop if there's an unread command event. Needed in
3757 moused window autoselection which uses a timer to insert such
3759 if (CONSP (Vunread_command_events
))
3762 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3764 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3767 /* If the quit flag is set, then read_char will return
3768 quit_char, so that counts as "available input." */
3769 if (!NILP (Vquit_flag
))
3770 quit_throw_to_read_char (0);
3772 /* One way or another, wait until input is available; then, if
3773 interrupt handlers have not read it, read it now. */
3778 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3780 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3784 EMACS_TIME now
= current_emacs_time ();
3785 if (EMACS_TIME_LE (*end_time
, now
))
3786 return Qnil
; /* Finished waiting. */
3789 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3790 wait_reading_process_output (min (EMACS_SECS (duration
),
3792 EMACS_NSECS (duration
),
3793 -1, 1, Qnil
, NULL
, 0);
3797 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3799 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3803 if (CONSP (Vunread_command_events
))
3806 first
= XCAR (Vunread_command_events
);
3807 Vunread_command_events
= XCDR (Vunread_command_events
);
3808 *kbp
= current_kboard
;
3812 /* At this point, we know that there is a readable event available
3813 somewhere. If the event queue is empty, then there must be a
3814 mouse movement enabled and available. */
3815 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3817 struct input_event
*event
;
3819 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3823 last_event_timestamp
= event
->timestamp
;
3825 *kbp
= event_to_kboard (event
);
3827 *kbp
= current_kboard
; /* Better than returning null ptr? */
3831 /* These two kinds of events get special handling
3832 and don't actually appear to the command loop.
3833 We return nil for them. */
3834 if (event
->kind
== SELECTION_REQUEST_EVENT
3835 || event
->kind
== SELECTION_CLEAR_EVENT
)
3838 struct input_event copy
;
3840 /* Remove it from the buffer before processing it,
3841 since otherwise swallow_events will see it
3842 and process it again. */
3844 kbd_fetch_ptr
= event
+ 1;
3845 input_pending
= readable_events (0);
3846 x_handle_selection_event (©
);
3848 /* We're getting selection request events, but we don't have
3854 #if defined (HAVE_NS)
3855 else if (event
->kind
== NS_TEXT_EVENT
)
3857 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3858 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3860 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3861 kbd_fetch_ptr
= event
+ 1;
3862 if (used_mouse_menu
)
3863 *used_mouse_menu
= 1;
3867 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3868 || defined (HAVE_NS)
3869 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3871 /* Make an event (delete-frame (FRAME)). */
3872 obj
= Fcons (event
->frame_or_window
, Qnil
);
3873 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3874 kbd_fetch_ptr
= event
+ 1;
3877 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3878 || defined (HAVE_NS)
3879 else if (event
->kind
== ICONIFY_EVENT
)
3881 /* Make an event (iconify-frame (FRAME)). */
3882 obj
= Fcons (event
->frame_or_window
, Qnil
);
3883 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3884 kbd_fetch_ptr
= event
+ 1;
3886 else if (event
->kind
== DEICONIFY_EVENT
)
3888 /* Make an event (make-frame-visible (FRAME)). */
3889 obj
= Fcons (event
->frame_or_window
, Qnil
);
3890 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3891 kbd_fetch_ptr
= event
+ 1;
3894 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3896 /* The value doesn't matter here; only the type is tested. */
3897 XSETBUFFER (obj
, current_buffer
);
3898 kbd_fetch_ptr
= event
+ 1;
3900 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3901 || defined (HAVE_NS) || defined (USE_GTK)
3902 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3904 kbd_fetch_ptr
= event
+ 1;
3905 input_pending
= readable_events (0);
3906 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3907 x_activate_menubar (XFRAME (event
->frame_or_window
));
3911 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3913 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3914 obj
= Fcons (Qlanguage_change
,
3915 list3 (event
->frame_or_window
,
3916 make_number (event
->code
),
3917 make_number (event
->modifiers
)));
3918 kbd_fetch_ptr
= event
+ 1;
3922 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3924 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3925 obj
= Fcons (Qfile_w32notify
,
3926 list2 (list3 (make_number (event
->code
),
3929 event
->frame_or_window
));
3930 kbd_fetch_ptr
= event
+ 1;
3933 else if (event
->kind
== SAVE_SESSION_EVENT
)
3935 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3936 kbd_fetch_ptr
= event
+ 1;
3938 /* Just discard these, by returning nil.
3939 With MULTI_KBOARD, these events are used as placeholders
3940 when we need to randomly delete events from the queue.
3941 (They shouldn't otherwise be found in the buffer,
3942 but on some machines it appears they do show up
3943 even without MULTI_KBOARD.) */
3944 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3945 mouse events during a popup-menu call. */
3946 else if (event
->kind
== NO_EVENT
)
3947 kbd_fetch_ptr
= event
+ 1;
3948 else if (event
->kind
== HELP_EVENT
)
3950 Lisp_Object object
, position
, help
, frame
, window
;
3952 frame
= event
->frame_or_window
;
3953 object
= event
->arg
;
3954 position
= make_number (event
->code
);
3957 clear_event (event
);
3959 kbd_fetch_ptr
= event
+ 1;
3960 if (!WINDOWP (window
))
3962 obj
= Fcons (Qhelp_echo
,
3963 list5 (frame
, help
, window
, object
, position
));
3965 else if (event
->kind
== FOCUS_IN_EVENT
)
3967 /* Notification of a FocusIn event. The frame receiving the
3968 focus is in event->frame_or_window. Generate a
3969 switch-frame event if necessary. */
3970 Lisp_Object frame
, focus
;
3972 frame
= event
->frame_or_window
;
3973 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3977 if (!EQ (frame
, internal_last_event_frame
)
3978 && !EQ (frame
, selected_frame
))
3979 obj
= make_lispy_switch_frame (frame
);
3980 internal_last_event_frame
= frame
;
3981 kbd_fetch_ptr
= event
+ 1;
3984 else if (event
->kind
== DBUS_EVENT
)
3986 obj
= make_lispy_event (event
);
3987 kbd_fetch_ptr
= event
+ 1;
3990 #ifdef HAVE_XWIDGETS
3991 else if (event
->kind
== XWIDGET_EVENT
)
3993 obj
= make_lispy_event (event
);
3994 kbd_fetch_ptr
= event
+ 1;
3998 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4000 obj
= make_lispy_event (event
);
4001 kbd_fetch_ptr
= event
+ 1;
4004 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4006 obj
= make_lispy_event (event
);
4007 kbd_fetch_ptr
= event
+ 1;
4011 /* If this event is on a different frame, return a switch-frame this
4012 time, and leave the event in the queue for next time. */
4016 frame
= event
->frame_or_window
;
4018 frame
= XCAR (frame
);
4019 else if (WINDOWP (frame
))
4020 frame
= WINDOW_FRAME (XWINDOW (frame
));
4022 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4026 if (! EQ (frame
, internal_last_event_frame
)
4027 && !EQ (frame
, selected_frame
))
4028 obj
= make_lispy_switch_frame (frame
);
4029 internal_last_event_frame
= frame
;
4031 /* If we didn't decide to make a switch-frame event, go ahead
4032 and build a real event from the queue entry. */
4036 obj
= make_lispy_event (event
);
4038 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4039 || defined (HAVE_NS) || defined (USE_GTK)
4040 /* If this was a menu selection, then set the flag to inhibit
4041 writing to last_nonmenu_event. Don't do this if the event
4042 we're returning is (menu-bar), though; that indicates the
4043 beginning of the menu sequence, and we might as well leave
4044 that as the `event with parameters' for this selection. */
4046 && !EQ (event
->frame_or_window
, event
->arg
)
4047 && (event
->kind
== MENU_BAR_EVENT
4048 || event
->kind
== TOOL_BAR_EVENT
))
4049 *used_mouse_menu
= 1;
4052 /* Certain system events are non-key events. */
4054 && event
->kind
== NS_NONKEY_EVENT
)
4055 *used_mouse_menu
= 1;
4058 /* Wipe out this event, to catch bugs. */
4059 clear_event (event
);
4060 kbd_fetch_ptr
= event
+ 1;
4064 /* Try generating a mouse motion event. */
4065 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4067 FRAME_PTR f
= some_mouse_moved ();
4068 Lisp_Object bar_window
;
4069 enum scroll_bar_part part
;
4073 *kbp
= current_kboard
;
4074 /* Note that this uses F to determine which terminal to look at.
4075 If there is no valid info, it does not store anything
4076 so x remains nil. */
4079 /* XXX Can f or mouse_position_hook be NULL here? */
4080 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4081 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4086 /* Decide if we should generate a switch-frame event. Don't
4087 generate switch-frame events for motion outside of all Emacs
4093 frame
= FRAME_FOCUS_FRAME (f
);
4095 XSETFRAME (frame
, f
);
4097 if (! EQ (frame
, internal_last_event_frame
)
4098 && !EQ (frame
, selected_frame
))
4099 obj
= make_lispy_switch_frame (frame
);
4100 internal_last_event_frame
= frame
;
4103 /* If we didn't decide to make a switch-frame event, go ahead and
4104 return a mouse-motion event. */
4105 if (!NILP (x
) && NILP (obj
))
4106 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4109 /* We were promised by the above while loop that there was
4110 something for us to read! */
4113 input_pending
= readable_events (0);
4115 Vlast_event_frame
= internal_last_event_frame
;
4120 /* Process any non-user-visible events (currently X selection events),
4121 without reading any user-visible events. */
4124 process_special_events (void)
4126 struct input_event
*event
;
4128 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4130 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4133 if (event
== kbd_store_ptr
)
4137 /* If we find a stored X selection request, handle it now. */
4138 if (event
->kind
== SELECTION_REQUEST_EVENT
4139 || event
->kind
== SELECTION_CLEAR_EVENT
)
4143 /* Remove the event from the fifo buffer before processing;
4144 otherwise swallow_events called recursively could see it
4145 and process it again. To do this, we move the events
4146 between kbd_fetch_ptr and EVENT one slot to the right,
4149 struct input_event copy
= *event
;
4150 struct input_event
*beg
4151 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4152 ? kbd_buffer
: kbd_fetch_ptr
;
4155 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4156 else if (event
< beg
)
4158 if (event
> kbd_buffer
)
4159 memmove (kbd_buffer
+ 1, kbd_buffer
,
4160 (event
- kbd_buffer
) * sizeof (struct input_event
));
4161 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4162 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4163 memmove (beg
+ 1, beg
,
4164 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4165 * sizeof (struct input_event
));
4168 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4169 kbd_fetch_ptr
= kbd_buffer
+ 1;
4173 /* X wants last_event_timestamp for selection ownership. */
4174 last_event_timestamp
= copy
.timestamp
;
4175 input_pending
= readable_events (0);
4176 x_handle_selection_event (©
);
4178 /* We're getting selection request events, but we don't have
4186 /* Process any events that are not user-visible, run timer events that
4187 are ripe, and return, without reading any user-visible events. */
4190 swallow_events (bool do_display
)
4192 unsigned old_timers_run
;
4194 process_special_events ();
4196 old_timers_run
= timers_run
;
4197 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4199 if (timers_run
!= old_timers_run
&& do_display
)
4200 redisplay_preserve_echo_area (7);
4203 /* Record the start of when Emacs is idle,
4204 for the sake of running idle-time timers. */
4207 timer_start_idle (void)
4211 /* If we are already in the idle state, do nothing. */
4212 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4215 timer_idleness_start_time
= current_emacs_time ();
4216 timer_last_idleness_start_time
= timer_idleness_start_time
;
4218 /* Mark all idle-time timers as once again candidates for running. */
4219 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4223 timer
= XCAR (timers
);
4225 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4227 ASET (timer
, 0, Qnil
);
4231 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4234 timer_stop_idle (void)
4236 timer_idleness_start_time
= invalid_emacs_time ();
4239 /* Resume idle timer from last idle start time. */
4242 timer_resume_idle (void)
4244 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4247 timer_idleness_start_time
= timer_last_idleness_start_time
;
4250 /* This is only for debugging. */
4251 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4253 /* List of elisp functions to call, delayed because they were generated in
4254 a context where Elisp could not be safely run (e.g. redisplay, signal,
4255 ...). Each element has the form (FUN . ARGS). */
4256 Lisp_Object pending_funcalls
;
4258 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4260 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4262 Lisp_Object
*vector
;
4264 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4266 vector
= XVECTOR (timer
)->contents
;
4267 if (! NILP (vector
[0]))
4270 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4275 /* Check whether a timer has fired. To prevent larger problems we simply
4276 disregard elements that are not proper timers. Do not make a circular
4277 timer list for the time being.
4279 Returns the time to wait until the next timer fires. If a
4280 timer is triggering now, return zero.
4281 If no timer is active, return -1.
4283 If a timer is ripe, we run it, with quitting turned off.
4284 In that case we return 0 to indicate that a new timer_check_2 call
4288 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4290 EMACS_TIME nexttime
;
4292 EMACS_TIME idleness_now
;
4293 Lisp_Object chosen_timer
;
4294 struct gcpro gcpro1
;
4296 nexttime
= invalid_emacs_time ();
4298 chosen_timer
= Qnil
;
4299 GCPRO1 (chosen_timer
);
4301 /* First run the code that was delayed. */
4302 while (CONSP (pending_funcalls
))
4304 Lisp_Object funcall
= XCAR (pending_funcalls
);
4305 pending_funcalls
= XCDR (pending_funcalls
);
4306 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4309 if (CONSP (timers
) || CONSP (idle_timers
))
4311 now
= current_emacs_time ();
4312 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4313 ? sub_emacs_time (now
, timer_idleness_start_time
)
4314 : make_emacs_time (0, 0));
4317 while (CONSP (timers
) || CONSP (idle_timers
))
4319 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4320 EMACS_TIME timer_time
, idle_timer_time
;
4321 EMACS_TIME difference
;
4322 EMACS_TIME timer_difference
= invalid_emacs_time ();
4323 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4324 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4326 /* Set TIMER and TIMER_DIFFERENCE
4327 based on the next ordinary timer.
4328 TIMER_DIFFERENCE is the distance in time from NOW to when
4329 this timer becomes ripe (negative if it's already ripe).
4330 Skip past invalid timers and timers already handled. */
4333 timer
= XCAR (timers
);
4334 if (! decode_timer (timer
, &timer_time
))
4336 timers
= XCDR (timers
);
4340 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4341 timer_difference
= (timer_ripe
4342 ? sub_emacs_time (now
, timer_time
)
4343 : sub_emacs_time (timer_time
, now
));
4346 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4347 based on the next idle timer. */
4348 if (CONSP (idle_timers
))
4350 idle_timer
= XCAR (idle_timers
);
4351 if (! decode_timer (idle_timer
, &idle_timer_time
))
4353 idle_timers
= XCDR (idle_timers
);
4357 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4358 idle_timer_difference
=
4360 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4361 : sub_emacs_time (idle_timer_time
, idleness_now
));
4364 /* Decide which timer is the next timer,
4365 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4366 Also step down the list where we found that timer. */
4368 if (EMACS_TIME_VALID_P (timer_difference
)
4369 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4370 || idle_timer_ripe
< timer_ripe
4371 || (idle_timer_ripe
== timer_ripe
4373 ? EMACS_TIME_LT (idle_timer_difference
,
4375 : EMACS_TIME_LT (timer_difference
,
4376 idle_timer_difference
)))))
4378 chosen_timer
= timer
;
4379 timers
= XCDR (timers
);
4380 difference
= timer_difference
;
4385 chosen_timer
= idle_timer
;
4386 idle_timers
= XCDR (idle_timers
);
4387 difference
= idle_timer_difference
;
4388 ripe
= idle_timer_ripe
;
4391 /* If timer is ripe, run it if it hasn't been run. */
4394 if (NILP (AREF (chosen_timer
, 0)))
4396 ptrdiff_t count
= SPECPDL_INDEX ();
4397 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4399 /* Mark the timer as triggered to prevent problems if the lisp
4400 code fails to reschedule it right. */
4401 ASET (chosen_timer
, 0, Qt
);
4403 specbind (Qinhibit_quit
, Qt
);
4405 call1 (Qtimer_event_handler
, chosen_timer
);
4406 Vdeactivate_mark
= old_deactivate_mark
;
4408 unbind_to (count
, Qnil
);
4410 /* Since we have handled the event,
4411 we don't need to tell the caller to wake up and do it. */
4412 /* But the caller must still wait for the next timer, so
4413 return 0 to indicate that. */
4416 nexttime
= make_emacs_time (0, 0);
4420 /* When we encounter a timer that is still waiting,
4421 return the amount of time to wait before it is ripe. */
4428 /* No timers are pending in the future. */
4429 /* Return 0 if we generated an event, and -1 if not. */
4435 /* Check whether a timer has fired. To prevent larger problems we simply
4436 disregard elements that are not proper timers. Do not make a circular
4437 timer list for the time being.
4439 Returns the time to wait until the next timer fires.
4440 If no timer is active, return an invalid value.
4442 As long as any timer is ripe, we run it. */
4447 EMACS_TIME nexttime
;
4448 Lisp_Object timers
, idle_timers
;
4449 struct gcpro gcpro1
, gcpro2
;
4451 Lisp_Object tem
= Vinhibit_quit
;
4454 /* We use copies of the timers' lists to allow a timer to add itself
4455 again, without locking up Emacs if the newly added timer is
4456 already ripe when added. */
4458 /* Always consider the ordinary timers. */
4459 timers
= Fcopy_sequence (Vtimer_list
);
4460 /* Consider the idle timers only if Emacs is idle. */
4461 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4462 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4466 Vinhibit_quit
= tem
;
4468 GCPRO2 (timers
, idle_timers
);
4472 nexttime
= timer_check_2 (timers
, idle_timers
);
4474 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4480 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4481 doc
: /* Return the current length of Emacs idleness, or nil.
4482 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4483 in the same style as (current-time).
4485 The value when Emacs is not idle is nil.
4487 PSEC is a multiple of the system clock resolution. */)
4490 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4491 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4492 timer_idleness_start_time
));
4497 /* Caches for modify_event_symbol. */
4498 static Lisp_Object accent_key_syms
;
4499 static Lisp_Object func_key_syms
;
4500 static Lisp_Object mouse_syms
;
4501 static Lisp_Object wheel_syms
;
4502 static Lisp_Object drag_n_drop_syms
;
4504 /* This is a list of keysym codes for special "accent" characters.
4505 It parallels lispy_accent_keys. */
4507 static const int lispy_accent_codes
[] =
4509 #ifdef XK_dead_circumflex
4514 #ifdef XK_dead_grave
4519 #ifdef XK_dead_tilde
4524 #ifdef XK_dead_diaeresis
4529 #ifdef XK_dead_macron
4534 #ifdef XK_dead_degree
4539 #ifdef XK_dead_acute
4544 #ifdef XK_dead_cedilla
4549 #ifdef XK_dead_breve
4554 #ifdef XK_dead_ogonek
4559 #ifdef XK_dead_caron
4564 #ifdef XK_dead_doubleacute
4565 XK_dead_doubleacute
,
4569 #ifdef XK_dead_abovedot
4574 #ifdef XK_dead_abovering
4584 #ifdef XK_dead_belowdot
4589 #ifdef XK_dead_voiced_sound
4590 XK_dead_voiced_sound
,
4594 #ifdef XK_dead_semivoiced_sound
4595 XK_dead_semivoiced_sound
,
4611 /* This is a list of Lisp names for special "accent" characters.
4612 It parallels lispy_accent_codes. */
4614 static const char *const lispy_accent_keys
[] =
4632 "dead-voiced-sound",
4633 "dead-semivoiced-sound",
4639 #define FUNCTION_KEY_OFFSET 0x0
4641 const char *const lispy_function_keys
[] =
4645 0, /* VK_LBUTTON 0x01 */
4646 0, /* VK_RBUTTON 0x02 */
4647 "cancel", /* VK_CANCEL 0x03 */
4648 0, /* VK_MBUTTON 0x04 */
4650 0, 0, 0, /* 0x05 .. 0x07 */
4652 "backspace", /* VK_BACK 0x08 */
4653 "tab", /* VK_TAB 0x09 */
4655 0, 0, /* 0x0A .. 0x0B */
4657 "clear", /* VK_CLEAR 0x0C */
4658 "return", /* VK_RETURN 0x0D */
4660 0, 0, /* 0x0E .. 0x0F */
4662 0, /* VK_SHIFT 0x10 */
4663 0, /* VK_CONTROL 0x11 */
4664 0, /* VK_MENU 0x12 */
4665 "pause", /* VK_PAUSE 0x13 */
4666 "capslock", /* VK_CAPITAL 0x14 */
4667 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4669 "junja", /* VK_JUNJA 0x17 */
4670 "final", /* VK_FINAL 0x18 */
4671 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4673 "escape", /* VK_ESCAPE 0x1B */
4674 "convert", /* VK_CONVERT 0x1C */
4675 "non-convert", /* VK_NONCONVERT 0x1D */
4676 "accept", /* VK_ACCEPT 0x1E */
4677 "mode-change", /* VK_MODECHANGE 0x1F */
4678 0, /* VK_SPACE 0x20 */
4679 "prior", /* VK_PRIOR 0x21 */
4680 "next", /* VK_NEXT 0x22 */
4681 "end", /* VK_END 0x23 */
4682 "home", /* VK_HOME 0x24 */
4683 "left", /* VK_LEFT 0x25 */
4684 "up", /* VK_UP 0x26 */
4685 "right", /* VK_RIGHT 0x27 */
4686 "down", /* VK_DOWN 0x28 */
4687 "select", /* VK_SELECT 0x29 */
4688 "print", /* VK_PRINT 0x2A */
4689 "execute", /* VK_EXECUTE 0x2B */
4690 "snapshot", /* VK_SNAPSHOT 0x2C */
4691 "insert", /* VK_INSERT 0x2D */
4692 "delete", /* VK_DELETE 0x2E */
4693 "help", /* VK_HELP 0x2F */
4695 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4697 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4699 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4701 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4703 0, 0, 0, 0, 0, 0, 0, 0, 0,
4704 0, 0, 0, 0, 0, 0, 0, 0, 0,
4705 0, 0, 0, 0, 0, 0, 0, 0,
4707 "lwindow", /* VK_LWIN 0x5B */
4708 "rwindow", /* VK_RWIN 0x5C */
4709 "apps", /* VK_APPS 0x5D */
4712 "kp-0", /* VK_NUMPAD0 0x60 */
4713 "kp-1", /* VK_NUMPAD1 0x61 */
4714 "kp-2", /* VK_NUMPAD2 0x62 */
4715 "kp-3", /* VK_NUMPAD3 0x63 */
4716 "kp-4", /* VK_NUMPAD4 0x64 */
4717 "kp-5", /* VK_NUMPAD5 0x65 */
4718 "kp-6", /* VK_NUMPAD6 0x66 */
4719 "kp-7", /* VK_NUMPAD7 0x67 */
4720 "kp-8", /* VK_NUMPAD8 0x68 */
4721 "kp-9", /* VK_NUMPAD9 0x69 */
4722 "kp-multiply", /* VK_MULTIPLY 0x6A */
4723 "kp-add", /* VK_ADD 0x6B */
4724 "kp-separator", /* VK_SEPARATOR 0x6C */
4725 "kp-subtract", /* VK_SUBTRACT 0x6D */
4726 "kp-decimal", /* VK_DECIMAL 0x6E */
4727 "kp-divide", /* VK_DIVIDE 0x6F */
4728 "f1", /* VK_F1 0x70 */
4729 "f2", /* VK_F2 0x71 */
4730 "f3", /* VK_F3 0x72 */
4731 "f4", /* VK_F4 0x73 */
4732 "f5", /* VK_F5 0x74 */
4733 "f6", /* VK_F6 0x75 */
4734 "f7", /* VK_F7 0x76 */
4735 "f8", /* VK_F8 0x77 */
4736 "f9", /* VK_F9 0x78 */
4737 "f10", /* VK_F10 0x79 */
4738 "f11", /* VK_F11 0x7A */
4739 "f12", /* VK_F12 0x7B */
4740 "f13", /* VK_F13 0x7C */
4741 "f14", /* VK_F14 0x7D */
4742 "f15", /* VK_F15 0x7E */
4743 "f16", /* VK_F16 0x7F */
4744 "f17", /* VK_F17 0x80 */
4745 "f18", /* VK_F18 0x81 */
4746 "f19", /* VK_F19 0x82 */
4747 "f20", /* VK_F20 0x83 */
4748 "f21", /* VK_F21 0x84 */
4749 "f22", /* VK_F22 0x85 */
4750 "f23", /* VK_F23 0x86 */
4751 "f24", /* VK_F24 0x87 */
4753 0, 0, 0, 0, /* 0x88 .. 0x8B */
4754 0, 0, 0, 0, /* 0x8C .. 0x8F */
4756 "kp-numlock", /* VK_NUMLOCK 0x90 */
4757 "scroll", /* VK_SCROLL 0x91 */
4758 /* Not sure where the following block comes from.
4759 Windows headers have NEC and Fujitsu specific keys in
4760 this block, but nothing generic. */
4761 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4762 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4763 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4764 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4765 "kp-end", /* VK_NUMPAD_END 0x96 */
4766 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4767 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4768 "kp-up", /* VK_NUMPAD_UP 0x99 */
4769 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4770 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4771 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4772 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4774 0, 0, /* 0x9E .. 0x9F */
4777 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4778 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4779 * No other API or message will distinguish left and right keys this way.
4784 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4785 to enable them selectively, and gives access to a few more functions.
4786 See lispy_multimedia_keys below. */
4787 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4788 0, 0, 0, /* 0xAD .. 0xAF Volume */
4789 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4790 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4792 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4793 0, 0, 0, 0, 0, 0, 0, 0, 0,
4795 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4796 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4797 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4800 "ax", /* VK_OEM_AX 0xE1 */
4801 0, /* VK_OEM_102 0xE2 */
4802 "ico-help", /* VK_ICO_HELP 0xE3 */
4803 "ico-00", /* VK_ICO_00 0xE4 */
4804 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4805 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4806 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4808 "reset", /* VK_OEM_RESET 0xE9 */
4809 "jump", /* VK_OEM_JUMP 0xEA */
4810 "oem-pa1", /* VK_OEM_PA1 0xEB */
4811 "oem-pa2", /* VK_OEM_PA2 0xEC */
4812 "oem-pa3", /* VK_OEM_PA3 0xED */
4813 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4814 "cusel", /* VK_OEM_CUSEL 0xEF */
4815 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4816 "finish", /* VK_OEM_FINISH 0xF1 */
4817 "copy", /* VK_OEM_COPY 0xF2 */
4818 "auto", /* VK_OEM_AUTO 0xF3 */
4819 "enlw", /* VK_OEM_ENLW 0xF4 */
4820 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4821 "attn", /* VK_ATTN 0xF6 */
4822 "crsel", /* VK_CRSEL 0xF7 */
4823 "exsel", /* VK_EXSEL 0xF8 */
4824 "ereof", /* VK_EREOF 0xF9 */
4825 "play", /* VK_PLAY 0xFA */
4826 "zoom", /* VK_ZOOM 0xFB */
4827 "noname", /* VK_NONAME 0xFC */
4828 "pa1", /* VK_PA1 0xFD */
4829 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4833 /* Some of these duplicate the "Media keys" on newer keyboards,
4834 but they are delivered to the application in a different way. */
4835 static const char *const lispy_multimedia_keys
[] =
4843 "browser-favorites",
4880 "toggle-dictate-command",
4886 "media-fast-forward",
4889 "media-channel-down"
4892 #else /* not HAVE_NTGUI */
4894 /* This should be dealt with in XTread_socket now, and that doesn't
4895 depend on the client system having the Kana syms defined. See also
4896 the XK_kana_A case below. */
4899 static const char *const lispy_kana_keys
[] =
4901 /* X Keysym value */
4902 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4903 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4904 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4905 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4906 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4907 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4908 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4909 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4910 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4911 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4912 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4913 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4914 "kana-i", "kana-u", "kana-e", "kana-o",
4915 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4916 "prolongedsound", "kana-A", "kana-I", "kana-U",
4917 "kana-E", "kana-O", "kana-KA", "kana-KI",
4918 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4919 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4920 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4921 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4922 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4923 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4924 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4925 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4926 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4927 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4928 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4929 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4931 #endif /* XK_kana_A */
4934 #define FUNCTION_KEY_OFFSET 0xff00
4936 /* You'll notice that this table is arranged to be conveniently
4937 indexed by X Windows keysym values. */
4938 static const char *const lispy_function_keys
[] =
4940 /* X Keysym value */
4942 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4943 "backspace", "tab", "linefeed", "clear",
4945 0, 0, 0, "pause", /* 0xff10...1f */
4946 0, 0, 0, 0, 0, 0, 0, "escape",
4948 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4949 "romaji", "hiragana", "katakana", "hiragana-katakana",
4950 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4951 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4952 "eisu-toggle", /* 0xff30...3f */
4953 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4954 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4956 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4957 "down", "prior", "next", "end",
4958 "begin", 0, 0, 0, 0, 0, 0, 0,
4959 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4970 "break", /* 0xff6b */
4973 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4974 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4975 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4976 0, 0, 0, 0, 0, 0, 0, 0,
4977 "kp-tab", /* 0xff89 */
4979 "kp-enter", /* 0xff8d */
4981 "kp-f1", /* 0xff91 */
4985 "kp-home", /* 0xff95 */
4990 "kp-prior", /* kp-page-up */
4991 "kp-next", /* kp-page-down */
4997 0, 0, 0, 0, 0, 0, 0, 0, 0,
4998 "kp-multiply", /* 0xffaa */
5003 "kp-divide", /* 0xffaf */
5004 "kp-0", /* 0xffb0 */
5005 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5008 "kp-equal", /* 0xffbd */
5009 "f1", /* 0xffbe */ /* IsFunctionKey */
5011 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5012 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5013 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5014 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5015 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5016 0, 0, 0, 0, 0, 0, 0, 0,
5017 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5018 0, 0, 0, 0, 0, 0, 0, "delete"
5021 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5022 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5024 static const char *const iso_lispy_function_keys
[] =
5026 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5027 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5028 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5029 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5030 "iso-lefttab", /* 0xfe20 */
5031 "iso-move-line-up", "iso-move-line-down",
5032 "iso-partial-line-up", "iso-partial-line-down",
5033 "iso-partial-space-left", "iso-partial-space-right",
5034 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5035 "iso-release-margin-left", "iso-release-margin-right",
5036 "iso-release-both-margins",
5037 "iso-fast-cursor-left", "iso-fast-cursor-right",
5038 "iso-fast-cursor-up", "iso-fast-cursor-down",
5039 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5040 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5043 #endif /* not HAVE_NTGUI */
5045 static Lisp_Object Vlispy_mouse_stem
;
5047 static const char *const lispy_wheel_names
[] =
5049 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5052 /* drag-n-drop events are generated when a set of selected files are
5053 dragged from another application and dropped onto an Emacs window. */
5054 static const char *const lispy_drag_n_drop_names
[] =
5059 /* Scroll bar parts. */
5060 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5061 Lisp_Object Qup
, Qdown
, Qbottom
;
5062 static Lisp_Object Qend_scroll
;
5064 static Lisp_Object Qratio
;
5066 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5067 static Lisp_Object
*const scroll_bar_parts
[] = {
5068 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5069 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5072 /* A vector, indexed by button number, giving the down-going location
5073 of currently depressed buttons, both scroll bar and non-scroll bar.
5075 The elements have the form
5076 (BUTTON-NUMBER MODIFIER-MASK . REST)
5077 where REST is the cdr of a position as it would be reported in the event.
5079 The make_lispy_event function stores positions here to tell the
5080 difference between click and drag events, and to store the starting
5081 location to be included in drag events. */
5083 static Lisp_Object button_down_location
;
5085 /* Information about the most recent up-going button event: Which
5086 button, what location, and what time. */
5088 static int last_mouse_button
;
5089 static int last_mouse_x
;
5090 static int last_mouse_y
;
5091 static Time button_down_time
;
5093 /* The number of clicks in this multiple-click. */
5095 static int double_click_count
;
5097 /* X and Y are frame-relative coordinates for a click or wheel event.
5098 Return a Lisp-style event list. */
5101 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5104 enum window_part part
;
5105 Lisp_Object posn
= Qnil
;
5106 Lisp_Object extra_info
= Qnil
;
5107 /* Coordinate pixel positions to return. */
5108 int xret
= 0, yret
= 0;
5109 /* The window under frame pixel coordinates (x,y) */
5110 Lisp_Object window
= f
5111 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5114 if (WINDOWP (window
))
5116 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5117 struct window
*w
= XWINDOW (window
);
5118 Lisp_Object string_info
= Qnil
;
5119 ptrdiff_t textpos
= -1;
5120 int col
= -1, row
= -1;
5121 int dx
= -1, dy
= -1;
5122 int width
= -1, height
= -1;
5123 Lisp_Object object
= Qnil
;
5125 /* Pixel coordinates relative to the window corner. */
5126 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5127 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5129 /* For text area clicks, return X, Y relative to the corner of
5130 this text area. Note that dX, dY etc are set below, by
5131 buffer_posn_from_coords. */
5132 if (part
== ON_TEXT
)
5134 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5135 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5137 /* For mode line and header line clicks, return X, Y relative to
5138 the left window edge. Use mode_line_string to look for a
5139 string on the click position. */
5140 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5145 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5146 /* Note that mode_line_string takes COL, ROW as pixels and
5147 converts them to characters. */
5150 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5151 &object
, &dx
, &dy
, &width
, &height
);
5152 if (STRINGP (string
))
5153 string_info
= Fcons (string
, make_number (charpos
));
5154 textpos
= (w
== XWINDOW (selected_window
)
5155 && current_buffer
== XBUFFER (w
->buffer
))
5156 ? PT
: marker_position (w
->pointm
);
5161 /* For fringes and margins, Y is relative to the area's (and the
5162 window's) top edge, while X is meaningless. */
5163 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5168 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5171 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5172 &object
, &dx
, &dy
, &width
, &height
);
5173 if (STRINGP (string
))
5174 string_info
= Fcons (string
, make_number (charpos
));
5175 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5177 else if (part
== ON_LEFT_FRINGE
)
5179 posn
= Qleft_fringe
;
5182 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5183 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5184 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5186 else if (part
== ON_RIGHT_FRINGE
)
5188 posn
= Qright_fringe
;
5191 - window_box_width (w
, LEFT_MARGIN_AREA
)
5192 - window_box_width (w
, TEXT_AREA
)
5193 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5194 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5196 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5198 else if (part
== ON_VERTICAL_BORDER
)
5200 posn
= Qvertical_line
;
5205 /* Nothing special for part == ON_SCROLL_BAR. */
5207 /* For clicks in the text area, fringes, or margins, call
5208 buffer_posn_from_coords to extract TEXTPOS, the buffer
5209 position nearest to the click. */
5212 Lisp_Object string2
, object2
= Qnil
;
5213 struct display_pos p
;
5215 int width2
, height2
;
5216 /* The pixel X coordinate passed to buffer_posn_from_coords
5217 is the X coordinate relative to the text area for
5218 text-area and right-margin clicks, zero otherwise. */
5220 = (part
== ON_TEXT
) ? xret
5221 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5222 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5226 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5227 &object2
, &dx2
, &dy2
,
5229 textpos
= CHARPOS (p
.pos
);
5230 if (col
< 0) col
= x2
;
5231 if (row
< 0) row
= y2
;
5232 if (dx
< 0) dx
= dx2
;
5233 if (dy
< 0) dy
= dy2
;
5234 if (width
< 0) width
= width2
;
5235 if (height
< 0) height
= height2
;
5239 posn
= make_number (textpos
);
5240 if (STRINGP (string2
))
5241 string_info
= Fcons (string2
,
5242 make_number (CHARPOS (p
.string_pos
)));
5248 #ifdef HAVE_WINDOW_SYSTEM
5249 if (IMAGEP (object
))
5251 Lisp_Object image_map
, hotspot
;
5252 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5254 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5256 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5257 posn
= XCAR (hotspot
);
5264 Fcons (make_number (dx
), make_number (dy
)),
5265 Fcons (make_number (width
), make_number (height
)));
5268 extra_info
= Fcons (string_info
,
5269 Fcons (make_number (textpos
),
5270 Fcons (Fcons (make_number (col
),
5275 XSETFRAME (window
, f
);
5279 return Fcons (window
,
5281 Fcons (Fcons (make_number (xret
),
5282 make_number (yret
)),
5283 Fcons (make_number (t
),
5287 /* Given a struct input_event, build the lisp event which represents
5288 it. If EVENT is 0, build a mouse movement event from the mouse
5289 movement buffer, which should have a movement event in it.
5291 Note that events must be passed to this function in the order they
5292 are received; this function stores the location of button presses
5293 in order to build drag events when the button is released. */
5296 make_lispy_event (struct input_event
*event
)
5300 switch (event
->kind
)
5302 /* A simple keystroke. */
5303 case ASCII_KEYSTROKE_EVENT
:
5304 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5306 Lisp_Object lispy_c
;
5307 EMACS_INT c
= event
->code
;
5308 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5311 eassert (c
== event
->code
);
5312 /* Turn ASCII characters into control characters
5314 if (event
->modifiers
& ctrl_modifier
)
5316 c
= make_ctrl_char (c
);
5317 event
->modifiers
&= ~ctrl_modifier
;
5321 /* Add in the other modifier bits. The shift key was taken care
5322 of by the X code. */
5323 c
|= (event
->modifiers
5324 & (meta_modifier
| alt_modifier
5325 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5326 /* Distinguish Shift-SPC from SPC. */
5327 if ((event
->code
) == 040
5328 && event
->modifiers
& shift_modifier
)
5329 c
|= shift_modifier
;
5330 button_down_time
= 0;
5331 XSETFASTINT (lispy_c
, c
);
5336 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5337 except that they are non-key events (last-nonmenu-event is nil). */
5338 case NS_NONKEY_EVENT
:
5341 /* A function key. The symbol may need to have modifier prefixes
5343 case NON_ASCII_KEYSTROKE_EVENT
:
5344 button_down_time
= 0;
5346 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5347 if (event
->code
== lispy_accent_codes
[i
])
5348 return modify_event_symbol (i
,
5350 Qfunction_key
, Qnil
,
5351 lispy_accent_keys
, &accent_key_syms
,
5352 (sizeof (lispy_accent_keys
)
5353 / sizeof (lispy_accent_keys
[0])));
5357 if (event
->code
>= 0x400 && event
->code
< 0x500)
5358 return modify_event_symbol (event
->code
- 0x400,
5359 event
->modifiers
& ~shift_modifier
,
5360 Qfunction_key
, Qnil
,
5361 lispy_kana_keys
, &func_key_syms
,
5362 (sizeof (lispy_kana_keys
)
5363 / sizeof (lispy_kana_keys
[0])));
5364 #endif /* XK_kana_A */
5367 #ifdef ISO_FUNCTION_KEY_OFFSET
5368 if (event
->code
< FUNCTION_KEY_OFFSET
5369 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5370 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5372 Qfunction_key
, Qnil
,
5373 iso_lispy_function_keys
, &func_key_syms
,
5374 (sizeof (iso_lispy_function_keys
)
5375 / sizeof (iso_lispy_function_keys
[0])));
5378 /* Handle system-specific or unknown keysyms. */
5379 if (event
->code
& (1 << 28)
5380 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5381 || (event
->code
- FUNCTION_KEY_OFFSET
5382 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5383 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5385 /* We need to use an alist rather than a vector as the cache
5386 since we can't make a vector long enough. */
5387 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5388 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5389 return modify_event_symbol (event
->code
,
5392 KVAR (current_kboard
, Vsystem_key_alist
),
5393 0, &KVAR (current_kboard
, system_key_syms
),
5397 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5399 Qfunction_key
, Qnil
,
5400 lispy_function_keys
, &func_key_syms
,
5401 (sizeof (lispy_function_keys
)
5402 / sizeof (lispy_function_keys
[0])));
5405 case MULTIMEDIA_KEY_EVENT
:
5406 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5407 / sizeof (lispy_multimedia_keys
[0]))
5408 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5410 return modify_event_symbol (event
->code
, event
->modifiers
,
5411 Qfunction_key
, Qnil
,
5412 lispy_multimedia_keys
, &func_key_syms
,
5413 (sizeof (lispy_multimedia_keys
)
5414 / sizeof (lispy_multimedia_keys
[0])));
5419 /* A mouse click. Figure out where it is, decide whether it's
5420 a press, click or drag, and build the appropriate structure. */
5421 case MOUSE_CLICK_EVENT
:
5422 #ifndef USE_TOOLKIT_SCROLL_BARS
5423 case SCROLL_BAR_CLICK_EVENT
:
5426 int button
= event
->code
;
5428 Lisp_Object position
;
5429 Lisp_Object
*start_pos_ptr
;
5430 Lisp_Object start_pos
;
5434 /* Build the position as appropriate for this mouse click. */
5435 if (event
->kind
== MOUSE_CLICK_EVENT
)
5437 struct frame
*f
= XFRAME (event
->frame_or_window
);
5438 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5442 /* Ignore mouse events that were made on frame that
5443 have been deleted. */
5444 if (! FRAME_LIVE_P (f
))
5447 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5448 /* EVENT->x and EVENT->y are frame-relative pixel
5449 coordinates at this place. Under old redisplay, COLUMN
5450 and ROW are set to frame relative glyph coordinates
5451 which are then used to determine whether this click is
5452 in a menu (non-toolkit version). */
5453 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5454 &column
, &row
, NULL
, 1);
5456 /* In the non-toolkit version, clicks on the menu bar
5457 are ordinary button events in the event buffer.
5458 Distinguish them, and invoke the menu.
5460 (In the toolkit version, the toolkit handles the menu bar
5461 and Emacs doesn't know about it until after the user
5462 makes a selection.) */
5463 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5464 && (event
->modifiers
& down_modifier
))
5466 Lisp_Object items
, item
;
5468 /* Find the menu bar item under `column'. */
5470 items
= FRAME_MENU_BAR_ITEMS (f
);
5471 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5473 Lisp_Object pos
, string
;
5474 string
= AREF (items
, i
+ 1);
5475 pos
= AREF (items
, i
+ 3);
5478 if (column
>= XINT (pos
)
5479 && column
< XINT (pos
) + SCHARS (string
))
5481 item
= AREF (items
, i
);
5486 /* ELisp manual 2.4b says (x y) are window relative but
5487 code says they are frame-relative. */
5489 = Fcons (event
->frame_or_window
,
5491 Fcons (Fcons (event
->x
, event
->y
),
5492 Fcons (make_number (event
->timestamp
),
5495 return Fcons (item
, Fcons (position
, Qnil
));
5497 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5499 position
= make_lispy_position (f
, event
->x
, event
->y
,
5502 #ifndef USE_TOOLKIT_SCROLL_BARS
5505 /* It's a scrollbar click. */
5507 Lisp_Object portion_whole
;
5510 window
= event
->frame_or_window
;
5511 portion_whole
= Fcons (event
->x
, event
->y
);
5512 part
= *scroll_bar_parts
[(int) event
->part
];
5516 Fcons (Qvertical_scroll_bar
,
5517 Fcons (portion_whole
,
5518 Fcons (make_number (event
->timestamp
),
5519 Fcons (part
, Qnil
)))));
5521 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5523 if (button
>= ASIZE (button_down_location
))
5525 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5526 button_down_location
= larger_vector (button_down_location
,
5528 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5531 start_pos_ptr
= aref_addr (button_down_location
, button
);
5532 start_pos
= *start_pos_ptr
;
5533 *start_pos_ptr
= Qnil
;
5536 /* On window-system frames, use the value of
5537 double-click-fuzz as is. On other frames, interpret it
5538 as a multiple of 1/8 characters. */
5542 if (WINDOWP (event
->frame_or_window
))
5543 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5544 else if (FRAMEP (event
->frame_or_window
))
5545 f
= XFRAME (event
->frame_or_window
);
5549 if (FRAME_WINDOW_P (f
))
5550 fuzz
= double_click_fuzz
;
5552 fuzz
= double_click_fuzz
/ 8;
5554 is_double
= (button
== last_mouse_button
5555 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5556 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5557 && button_down_time
!= 0
5558 && (EQ (Vdouble_click_time
, Qt
)
5559 || (NATNUMP (Vdouble_click_time
)
5560 && (event
->timestamp
- button_down_time
5561 < XFASTINT (Vdouble_click_time
)))));
5564 last_mouse_button
= button
;
5565 last_mouse_x
= XINT (event
->x
);
5566 last_mouse_y
= XINT (event
->y
);
5568 /* If this is a button press, squirrel away the location, so
5569 we can decide later whether it was a click or a drag. */
5570 if (event
->modifiers
& down_modifier
)
5574 double_click_count
++;
5575 event
->modifiers
|= ((double_click_count
> 2)
5580 double_click_count
= 1;
5581 button_down_time
= event
->timestamp
;
5582 *start_pos_ptr
= Fcopy_alist (position
);
5583 ignore_mouse_drag_p
= 0;
5586 /* Now we're releasing a button - check the co-ordinates to
5587 see if this was a click or a drag. */
5588 else if (event
->modifiers
& up_modifier
)
5590 /* If we did not see a down before this up, ignore the up.
5591 Probably this happened because the down event chose a
5592 menu item. It would be an annoyance to treat the
5593 release of the button that chose the menu item as a
5596 if (!CONSP (start_pos
))
5599 event
->modifiers
&= ~up_modifier
;
5602 Lisp_Object new_down
, down
;
5603 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5605 /* The third element of every position
5606 should be the (x,y) pair. */
5607 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5608 new_down
= Fcar (Fcdr (Fcdr (position
)));
5611 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5613 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5614 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5617 if (ignore_mouse_drag_p
)
5619 event
->modifiers
|= click_modifier
;
5620 ignore_mouse_drag_p
= 0;
5622 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5623 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5624 /* Maybe the mouse has moved a lot, caused scrolling, and
5625 eventually ended up at the same screen position (but
5626 not buffer position) in which case it is a drag, not
5628 /* FIXME: OTOH if the buffer position has changed
5629 because of a timer or process filter rather than
5630 because of mouse movement, it should be considered as
5631 a click. But mouse-drag-region completely ignores
5632 this case and it hasn't caused any real problem, so
5633 it's probably OK to ignore it as well. */
5634 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5635 /* Mouse hasn't moved (much). */
5636 event
->modifiers
|= click_modifier
;
5639 button_down_time
= 0;
5640 event
->modifiers
|= drag_modifier
;
5643 /* Don't check is_double; treat this as multiple
5644 if the down-event was multiple. */
5645 if (double_click_count
> 1)
5646 event
->modifiers
|= ((double_click_count
> 2)
5652 /* Every mouse event should either have the down_modifier or
5653 the up_modifier set. */
5657 /* Get the symbol we should use for the mouse click. */
5660 head
= modify_event_symbol (button
,
5662 Qmouse_click
, Vlispy_mouse_stem
,
5665 ASIZE (mouse_syms
));
5666 if (event
->modifiers
& drag_modifier
)
5671 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5674 Fcons (make_number (double_click_count
),
5684 case HORIZ_WHEEL_EVENT
:
5686 Lisp_Object position
;
5689 /* Build the position as appropriate for this mouse click. */
5690 struct frame
*f
= XFRAME (event
->frame_or_window
);
5692 /* Ignore wheel events that were made on frame that have been
5694 if (! FRAME_LIVE_P (f
))
5697 position
= make_lispy_position (f
, event
->x
, event
->y
,
5700 /* Set double or triple modifiers to indicate the wheel speed. */
5702 /* On window-system frames, use the value of
5703 double-click-fuzz as is. On other frames, interpret it
5704 as a multiple of 1/8 characters. */
5710 if (WINDOWP (event
->frame_or_window
))
5711 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5712 else if (FRAMEP (event
->frame_or_window
))
5713 fr
= XFRAME (event
->frame_or_window
);
5717 fuzz
= FRAME_WINDOW_P (fr
)
5718 ? double_click_fuzz
: double_click_fuzz
/ 8;
5720 if (event
->modifiers
& up_modifier
)
5722 /* Emit a wheel-up event. */
5723 event
->modifiers
&= ~up_modifier
;
5726 else if (event
->modifiers
& down_modifier
)
5728 /* Emit a wheel-down event. */
5729 event
->modifiers
&= ~down_modifier
;
5733 /* Every wheel event should either have the down_modifier or
5734 the up_modifier set. */
5737 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5740 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5741 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5742 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5743 && button_down_time
!= 0
5744 && (EQ (Vdouble_click_time
, Qt
)
5745 || (NATNUMP (Vdouble_click_time
)
5746 && (event
->timestamp
- button_down_time
5747 < XFASTINT (Vdouble_click_time
)))));
5750 double_click_count
++;
5751 event
->modifiers
|= ((double_click_count
> 2)
5757 double_click_count
= 1;
5758 event
->modifiers
|= click_modifier
;
5761 button_down_time
= event
->timestamp
;
5762 /* Use a negative value to distinguish wheel from mouse button. */
5763 last_mouse_button
= - (1 + symbol_num
);
5764 last_mouse_x
= XINT (event
->x
);
5765 last_mouse_y
= XINT (event
->y
);
5767 /* Get the symbol we should use for the wheel event. */
5768 head
= modify_event_symbol (symbol_num
,
5774 ASIZE (wheel_syms
));
5777 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5780 Fcons (make_number (double_click_count
),
5789 #ifdef USE_TOOLKIT_SCROLL_BARS
5791 /* We don't have down and up events if using toolkit scroll bars,
5792 so make this always a click event. Store in the `part' of
5793 the Lisp event a symbol which maps to the following actions:
5795 `above_handle' page up
5796 `below_handle' page down
5800 `bottom' bottom of buffer
5801 `handle' thumb has been dragged.
5802 `end-scroll' end of interaction with scroll bar
5804 The incoming input_event contains in its `part' member an
5805 index of type `enum scroll_bar_part' which we can use as an
5806 index in scroll_bar_parts to get the appropriate symbol. */
5808 case SCROLL_BAR_CLICK_EVENT
:
5810 Lisp_Object position
, head
, window
, portion_whole
, part
;
5812 window
= event
->frame_or_window
;
5813 portion_whole
= Fcons (event
->x
, event
->y
);
5814 part
= *scroll_bar_parts
[(int) event
->part
];
5818 Fcons (Qvertical_scroll_bar
,
5819 Fcons (portion_whole
,
5820 Fcons (make_number (event
->timestamp
),
5821 Fcons (part
, Qnil
)))));
5823 /* Always treat scroll bar events as clicks. */
5824 event
->modifiers
|= click_modifier
;
5825 event
->modifiers
&= ~up_modifier
;
5827 if (event
->code
>= ASIZE (mouse_syms
))
5828 mouse_syms
= larger_vector (mouse_syms
,
5829 event
->code
- ASIZE (mouse_syms
) + 1,
5832 /* Get the symbol we should use for the mouse click. */
5833 head
= modify_event_symbol (event
->code
,
5838 ASIZE (mouse_syms
));
5839 return Fcons (head
, Fcons (position
, Qnil
));
5842 #endif /* USE_TOOLKIT_SCROLL_BARS */
5844 case DRAG_N_DROP_EVENT
:
5847 Lisp_Object head
, position
;
5850 f
= XFRAME (event
->frame_or_window
);
5853 /* Ignore mouse events that were made on frames that
5854 have been deleted. */
5855 if (! FRAME_LIVE_P (f
))
5858 position
= make_lispy_position (f
, event
->x
, event
->y
,
5861 head
= modify_event_symbol (0, event
->modifiers
,
5863 lispy_drag_n_drop_names
,
5864 &drag_n_drop_syms
, 1);
5871 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5872 || defined (HAVE_NS) || defined (USE_GTK)
5873 case MENU_BAR_EVENT
:
5874 if (EQ (event
->arg
, event
->frame_or_window
))
5875 /* This is the prefix key. We translate this to
5876 `(menu_bar)' because the code in keyboard.c for menu
5877 events, which we use, relies on this. */
5878 return Fcons (Qmenu_bar
, Qnil
);
5882 case SELECT_WINDOW_EVENT
:
5883 /* Make an event (select-window (WINDOW)). */
5884 return Fcons (Qselect_window
,
5885 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5888 case TOOL_BAR_EVENT
:
5889 if (EQ (event
->arg
, event
->frame_or_window
))
5890 /* This is the prefix key. We translate this to
5891 `(tool_bar)' because the code in keyboard.c for tool bar
5892 events, which we use, relies on this. */
5893 return Fcons (Qtool_bar
, Qnil
);
5894 else if (SYMBOLP (event
->arg
))
5895 return apply_modifiers (event
->modifiers
, event
->arg
);
5898 case USER_SIGNAL_EVENT
:
5899 /* A user signal. */
5901 char *name
= find_user_signal_name (event
->code
);
5904 return intern (name
);
5907 case SAVE_SESSION_EVENT
:
5908 return Qsave_session
;
5913 return Fcons (Qdbus_event
, event
->arg
);
5915 #endif /* HAVE_DBUS */
5917 #ifdef HAVE_XWIDGETS
5920 printf("cool, an xwidget event arrived in make_lispy_event!\n");
5921 return Fcons (Qxwidget_event
,event
->arg
);
5923 #endif /* HAVE_XWIDGETS */
5927 case FILE_NOTIFY_EVENT
:
5929 return Fcons (Qfile_inotify
, event
->arg
);
5931 #endif /* HAVE_INOTIFY */
5933 case CONFIG_CHANGED_EVENT
:
5934 return Fcons (Qconfig_changed_event
,
5936 Fcons (event
->frame_or_window
, Qnil
)));
5938 case GPM_CLICK_EVENT
:
5940 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5941 Lisp_Object head
, position
;
5942 Lisp_Object
*start_pos_ptr
;
5943 Lisp_Object start_pos
;
5944 int button
= event
->code
;
5946 if (button
>= ASIZE (button_down_location
))
5948 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5949 button_down_location
= larger_vector (button_down_location
,
5951 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5954 start_pos_ptr
= aref_addr (button_down_location
, button
);
5955 start_pos
= *start_pos_ptr
;
5957 position
= make_lispy_position (f
, event
->x
, event
->y
,
5960 if (event
->modifiers
& down_modifier
)
5961 *start_pos_ptr
= Fcopy_alist (position
);
5962 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5964 if (!CONSP (start_pos
))
5966 event
->modifiers
&= ~up_modifier
;
5969 head
= modify_event_symbol (button
,
5971 Qmouse_click
, Vlispy_mouse_stem
,
5974 ASIZE (mouse_syms
));
5976 if (event
->modifiers
& drag_modifier
)
5981 else if (event
->modifiers
& double_modifier
)
5984 Fcons (make_number (2),
5986 else if (event
->modifiers
& triple_modifier
)
5989 Fcons (make_number (3),
5996 #endif /* HAVE_GPM */
5998 /* The 'kind' field of the event is something we don't recognize. */
6005 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6006 Lisp_Object x
, Lisp_Object y
, Time t
)
6008 /* Is it a scroll bar movement? */
6009 if (frame
&& ! NILP (bar_window
))
6011 Lisp_Object part_sym
;
6013 part_sym
= *scroll_bar_parts
[(int) part
];
6014 return Fcons (Qscroll_bar_movement
,
6015 Fcons (list5 (bar_window
,
6016 Qvertical_scroll_bar
,
6022 /* Or is it an ordinary mouse movement? */
6025 Lisp_Object position
;
6026 position
= make_lispy_position (frame
, x
, y
, t
);
6027 return list2 (Qmouse_movement
, position
);
6031 /* Construct a switch frame event. */
6033 make_lispy_switch_frame (Lisp_Object frame
)
6035 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6038 /* Manipulating modifiers. */
6040 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6042 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6043 SYMBOL's name of the end of the modifiers; the string from this
6044 position is the unmodified symbol name.
6046 This doesn't use any caches. */
6049 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6055 CHECK_SYMBOL (symbol
);
6058 name
= SYMBOL_NAME (symbol
);
6060 for (i
= 0; i
< SBYTES (name
) - 1; )
6062 ptrdiff_t this_mod_end
= 0;
6065 /* See if the name continues with a modifier word.
6066 Check that the word appears, but don't check what follows it.
6067 Set this_mod and this_mod_end to record what we find. */
6069 switch (SREF (name
, i
))
6071 #define SINGLE_LETTER_MOD(BIT) \
6072 (this_mod_end = i + 1, this_mod = BIT)
6075 SINGLE_LETTER_MOD (alt_modifier
);
6079 SINGLE_LETTER_MOD (ctrl_modifier
);
6083 SINGLE_LETTER_MOD (hyper_modifier
);
6087 SINGLE_LETTER_MOD (meta_modifier
);
6091 SINGLE_LETTER_MOD (shift_modifier
);
6095 SINGLE_LETTER_MOD (super_modifier
);
6098 #undef SINGLE_LETTER_MOD
6100 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6101 if (i + LEN + 1 <= SBYTES (name) \
6102 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6104 this_mod_end = i + LEN; \
6109 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6110 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6111 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6115 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6117 #undef MULTI_LETTER_MOD
6121 /* If we found no modifier, stop looking for them. */
6122 if (this_mod_end
== 0)
6125 /* Check there is a dash after the modifier, so that it
6126 really is a modifier. */
6127 if (this_mod_end
>= SBYTES (name
)
6128 || SREF (name
, this_mod_end
) != '-')
6131 /* This modifier is real; look for another. */
6132 modifiers
|= this_mod
;
6133 i
= this_mod_end
+ 1;
6136 /* Should we include the `click' modifier? */
6137 if (! (modifiers
& (down_modifier
| drag_modifier
6138 | double_modifier
| triple_modifier
))
6139 && i
+ 7 == SBYTES (name
)
6140 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6141 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6142 modifiers
|= click_modifier
;
6144 if (! (modifiers
& (double_modifier
| triple_modifier
))
6145 && i
+ 6 < SBYTES (name
)
6146 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6147 modifiers
|= click_modifier
;
6155 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6156 prepended to the string BASE[0..BASE_LEN-1].
6157 This doesn't use any caches. */
6159 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6161 /* Since BASE could contain nulls, we can't use intern here; we have
6162 to use Fintern, which expects a genuine Lisp_String, and keeps a
6164 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6170 /* Only the event queue may use the `up' modifier; it should always
6171 be turned into a click or drag event before presented to lisp code. */
6172 if (modifiers
& up_modifier
)
6175 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6176 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6177 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6178 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6179 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6180 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6181 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6182 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6183 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6184 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6185 /* The click modifier is denoted by the absence of other modifiers. */
6189 mod_len
= p
- new_mods
;
6193 Lisp_Object new_name
;
6195 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6196 mod_len
+ base_len_byte
);
6197 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6198 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6200 return Fintern (new_name
, Qnil
);
6205 static const char *const modifier_names
[] =
6207 "up", "down", "drag", "click", "double", "triple", 0, 0,
6208 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6209 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6211 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6213 static Lisp_Object modifier_symbols
;
6215 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6217 lispy_modifier_list (int modifiers
)
6219 Lisp_Object modifier_list
;
6222 modifier_list
= Qnil
;
6223 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6224 if (modifiers
& (1<<i
))
6225 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6228 return modifier_list
;
6232 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6233 where UNMODIFIED is the unmodified form of SYMBOL,
6234 MASK is the set of modifiers present in SYMBOL's name.
6235 This is similar to parse_modifiers_uncached, but uses the cache in
6236 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6237 Qevent_symbol_elements property. */
6239 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6242 parse_modifiers (Lisp_Object symbol
)
6244 Lisp_Object elements
;
6246 if (INTEGERP (symbol
))
6247 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6248 else if (!SYMBOLP (symbol
))
6251 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6252 if (CONSP (elements
))
6257 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6258 Lisp_Object unmodified
;
6261 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6262 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6265 if (modifiers
& ~INTMASK
)
6267 XSETFASTINT (mask
, modifiers
);
6268 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6270 /* Cache the parsing results on SYMBOL. */
6271 Fput (symbol
, Qevent_symbol_element_mask
,
6273 Fput (symbol
, Qevent_symbol_elements
,
6274 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6276 /* Since we know that SYMBOL is modifiers applied to unmodified,
6277 it would be nice to put that in unmodified's cache.
6278 But we can't, since we're not sure that parse_modifiers is
6285 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6286 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6287 doc
: /* Parse the event symbol. For internal use. */)
6288 (Lisp_Object symbol
)
6290 /* Fill the cache if needed. */
6291 parse_modifiers (symbol
);
6292 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6293 and use the Lispier representation stored on Qevent_symbol_elements
6295 return Fget (symbol
, Qevent_symbol_elements
);
6298 /* Apply the modifiers MODIFIERS to the symbol BASE.
6299 BASE must be unmodified.
6301 This is like apply_modifiers_uncached, but uses BASE's
6302 Qmodifier_cache property, if present. It also builds
6303 Qevent_symbol_elements properties, since it has that info anyway.
6305 apply_modifiers copies the value of BASE's Qevent_kind property to
6306 the modified symbol. */
6308 apply_modifiers (int modifiers
, Lisp_Object base
)
6310 Lisp_Object cache
, idx
, entry
, new_symbol
;
6312 /* Mask out upper bits. We don't know where this value's been. */
6313 modifiers
&= INTMASK
;
6315 if (INTEGERP (base
))
6316 return make_number (XINT (base
) | modifiers
);
6318 /* The click modifier never figures into cache indices. */
6319 cache
= Fget (base
, Qmodifier_cache
);
6320 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6321 entry
= assq_no_quit (idx
, cache
);
6324 new_symbol
= XCDR (entry
);
6327 /* We have to create the symbol ourselves. */
6328 new_symbol
= apply_modifiers_uncached (modifiers
,
6329 SSDATA (SYMBOL_NAME (base
)),
6330 SCHARS (SYMBOL_NAME (base
)),
6331 SBYTES (SYMBOL_NAME (base
)));
6333 /* Add the new symbol to the base's cache. */
6334 entry
= Fcons (idx
, new_symbol
);
6335 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6337 /* We have the parsing info now for free, so we could add it to
6339 XSETFASTINT (idx, modifiers);
6340 Fput (new_symbol, Qevent_symbol_element_mask,
6341 Fcons (base, Fcons (idx, Qnil)));
6342 Fput (new_symbol, Qevent_symbol_elements,
6343 Fcons (base, lispy_modifier_list (modifiers)));
6344 Sadly, this is only correct if `base' is indeed a base event,
6345 which is not necessarily the case. -stef */
6348 /* Make sure this symbol is of the same kind as BASE.
6350 You'd think we could just set this once and for all when we
6351 intern the symbol above, but reorder_modifiers may call us when
6352 BASE's property isn't set right; we can't assume that just
6353 because it has a Qmodifier_cache property it must have its
6354 Qevent_kind set right as well. */
6355 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6359 kind
= Fget (base
, Qevent_kind
);
6361 Fput (new_symbol
, Qevent_kind
, kind
);
6368 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6369 return a symbol with the modifiers placed in the canonical order.
6370 Canonical order is alphabetical, except for down and drag, which
6371 always come last. The 'click' modifier is never written out.
6373 Fdefine_key calls this to make sure that (for example) C-M-foo
6374 and M-C-foo end up being equivalent in the keymap. */
6377 reorder_modifiers (Lisp_Object symbol
)
6379 /* It's hopefully okay to write the code this way, since everything
6380 will soon be in caches, and no consing will be done at all. */
6383 parsed
= parse_modifiers (symbol
);
6384 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6389 /* For handling events, we often want to produce a symbol whose name
6390 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6391 to some base, like the name of a function key or mouse button.
6392 modify_event_symbol produces symbols of this sort.
6394 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6395 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6398 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6399 into symbol names, or a string specifying a name stem used to
6400 construct a symbol name or the form `STEM-N', where N is the decimal
6401 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6402 non-nil; otherwise NAME_TABLE is used.
6404 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6405 persist between calls to modify_event_symbol that it can use to
6406 store a cache of the symbols it's generated for this NAME_TABLE
6407 before. The object stored there may be a vector or an alist.
6409 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6411 MODIFIERS is a set of modifier bits (as given in struct input_events)
6412 whose prefixes should be applied to the symbol name.
6414 SYMBOL_KIND is the value to be placed in the event_kind property of
6415 the returned symbol.
6417 The symbols we create are supposed to have an
6418 `event-symbol-elements' property, which lists the modifiers present
6419 in the symbol's name. */
6422 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6423 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6424 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6427 Lisp_Object symbol_int
;
6429 /* Get rid of the "vendor-specific" bit here. */
6430 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6432 /* Is this a request for a valid symbol? */
6433 if (symbol_num
< 0 || symbol_num
>= table_size
)
6436 if (CONSP (*symbol_table
))
6437 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6439 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6440 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6441 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6442 we've never used that symbol before. */
6445 if (! VECTORP (*symbol_table
)
6446 || ASIZE (*symbol_table
) != table_size
)
6450 XSETFASTINT (size
, table_size
);
6451 *symbol_table
= Fmake_vector (size
, Qnil
);
6454 value
= AREF (*symbol_table
, symbol_num
);
6457 /* Have we already used this symbol before? */
6460 /* No; let's create it. */
6461 if (CONSP (name_alist_or_stem
))
6462 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6463 else if (STRINGP (name_alist_or_stem
))
6466 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6467 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6469 buf
= SAFE_ALLOCA (len
);
6470 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6471 XINT (symbol_int
) + 1);
6472 value
= intern (buf
);
6475 else if (name_table
!= 0 && name_table
[symbol_num
])
6476 value
= intern (name_table
[symbol_num
]);
6478 #ifdef HAVE_WINDOW_SYSTEM
6481 char *name
= x_get_keysym_name (symbol_num
);
6483 value
= intern (name
);
6489 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6490 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6491 value
= intern (buf
);
6494 if (CONSP (*symbol_table
))
6495 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6497 ASET (*symbol_table
, symbol_num
, value
);
6499 /* Fill in the cache entries for this symbol; this also
6500 builds the Qevent_symbol_elements property, which the user
6502 apply_modifiers (modifiers
& click_modifier
, value
);
6503 Fput (value
, Qevent_kind
, symbol_kind
);
6506 /* Apply modifiers to that symbol. */
6507 return apply_modifiers (modifiers
, value
);
6510 /* Convert a list that represents an event type,
6511 such as (ctrl meta backspace), into the usual representation of that
6512 event type as a number or a symbol. */
6514 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6515 doc
: /* Convert the event description list EVENT-DESC to an event type.
6516 EVENT-DESC should contain one base event type (a character or symbol)
6517 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6518 drag, down, double or triple). The base must be last.
6519 The return value is an event type (a character or symbol) which
6520 has the same base event type and all the specified modifiers. */)
6521 (Lisp_Object event_desc
)
6529 while (CONSP (rest
))
6537 /* Given a symbol, see if it is a modifier name. */
6538 if (SYMBOLP (elt
) && CONSP (rest
))
6539 this = parse_solitary_modifier (elt
);
6543 else if (!NILP (base
))
6544 error ("Two bases given in one event");
6550 /* Let the symbol A refer to the character A. */
6551 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6552 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6554 if (INTEGERP (base
))
6556 /* Turn (shift a) into A. */
6557 if ((modifiers
& shift_modifier
) != 0
6558 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6560 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6561 modifiers
&= ~shift_modifier
;
6564 /* Turn (control a) into C-a. */
6565 if (modifiers
& ctrl_modifier
)
6566 return make_number ((modifiers
& ~ctrl_modifier
)
6567 | make_ctrl_char (XINT (base
)));
6569 return make_number (modifiers
| XINT (base
));
6571 else if (SYMBOLP (base
))
6572 return apply_modifiers (modifiers
, base
);
6574 error ("Invalid base event");
6577 /* Try to recognize SYMBOL as a modifier name.
6578 Return the modifier flag bit, or 0 if not recognized. */
6581 parse_solitary_modifier (Lisp_Object symbol
)
6583 Lisp_Object name
= SYMBOL_NAME (symbol
);
6585 switch (SREF (name
, 0))
6587 #define SINGLE_LETTER_MOD(BIT) \
6588 if (SBYTES (name) == 1) \
6591 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6592 if (LEN == SBYTES (name) \
6593 && ! memcmp (SDATA (name), NAME, LEN)) \
6597 SINGLE_LETTER_MOD (alt_modifier
);
6601 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6605 SINGLE_LETTER_MOD (ctrl_modifier
);
6609 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6610 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6614 SINGLE_LETTER_MOD (hyper_modifier
);
6618 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6622 SINGLE_LETTER_MOD (meta_modifier
);
6626 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6630 SINGLE_LETTER_MOD (shift_modifier
);
6634 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6635 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6636 SINGLE_LETTER_MOD (super_modifier
);
6640 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6641 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6642 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6646 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6649 #undef SINGLE_LETTER_MOD
6650 #undef MULTI_LETTER_MOD
6656 /* Return true if EVENT is a list whose elements are all integers or symbols.
6657 Such a list is not valid as an event,
6658 but it can be a Lucid-style event type list. */
6661 lucid_event_type_list_p (Lisp_Object object
)
6665 if (! CONSP (object
))
6668 if (EQ (XCAR (object
), Qhelp_echo
)
6669 || EQ (XCAR (object
), Qvertical_line
)
6670 || EQ (XCAR (object
), Qmode_line
)
6671 || EQ (XCAR (object
), Qheader_line
))
6674 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6678 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6685 /* Return true if terminal input chars are available.
6686 Also, store the return value into INPUT_PENDING.
6688 Serves the purpose of ioctl (0, FIONREAD, ...)
6689 but works even if FIONREAD does not exist.
6690 (In fact, this may actually read some input.)
6692 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6693 timer events that are ripe.
6694 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6695 events (FOCUS_IN_EVENT).
6696 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6697 movements and toolkit scroll bar thumb drags. */
6700 get_input_pending (int flags
)
6702 /* First of all, have we already counted some input? */
6703 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6705 /* If input is being read as it arrives, and we have none, there is none. */
6706 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6708 /* Try to read some input and see how much we get. */
6710 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6713 return input_pending
;
6716 /* Put a BUFFER_SWITCH_EVENT in the buffer
6717 so that read_key_sequence will notice the new current buffer. */
6720 record_asynch_buffer_change (void)
6722 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6723 The purpose of the event is to make read_key_sequence look up the
6724 keymaps again. If we aren't in read_key_sequence, we don't need one,
6725 and the event could cause trouble by messing up (input-pending-p).
6726 Note: Fwaiting_for_user_input_p always returns nil when async
6727 subprocesses aren't supported. */
6728 if (!NILP (Fwaiting_for_user_input_p ()))
6730 struct input_event event
;
6733 event
.kind
= BUFFER_SWITCH_EVENT
;
6734 event
.frame_or_window
= Qnil
;
6737 /* Make sure no interrupt happens while storing the event. */
6739 if (interrupt_input
)
6740 kbd_buffer_store_event (&event
);
6745 kbd_buffer_store_event (&event
);
6751 /* Read any terminal input already buffered up by the system
6752 into the kbd_buffer, but do not wait.
6754 Return the number of keyboard chars read, or -1 meaning
6755 this is a bad time to try to read input. */
6764 /* Store pending user signal events, if any. */
6765 store_user_signal_events ();
6767 /* Loop through the available terminals, and call their input hooks. */
6771 struct terminal
*next
= t
->next_terminal
;
6773 if (t
->read_socket_hook
)
6776 struct input_event hold_quit
;
6778 if (input_blocked_p ())
6780 pending_signals
= 1;
6784 EVENT_INIT (hold_quit
);
6785 hold_quit
.kind
= NO_EVENT
;
6787 /* No need for FIONREAD or fcntl; just say don't wait. */
6788 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6791 if (nr
== -1) /* Not OK to read input now. */
6795 else if (nr
== -2) /* Non-transient error. */
6797 /* The terminal device terminated; it should be closed. */
6799 /* Kill Emacs if this was our last terminal. */
6800 if (!terminal_list
->next_terminal
)
6801 /* Formerly simply reported no input, but that
6802 sometimes led to a failure of Emacs to terminate.
6803 SIGHUP seems appropriate if we can't reach the
6805 /* ??? Is it really right to send the signal just to
6806 this process rather than to the whole process
6807 group? Perhaps on systems with FIONREAD Emacs is
6808 alone in its group. */
6809 terminate_due_to_signal (SIGHUP
, 10);
6811 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6814 XSETTERMINAL (tmp
, t
);
6815 Fdelete_terminal (tmp
, Qnoelisp
);
6819 if (hold_quit
.kind
!= NO_EVENT
)
6820 kbd_buffer_store_event (&hold_quit
);
6829 frame_make_pointer_visible ();
6834 /* This is the tty way of reading available input.
6836 Note that each terminal device has its own `struct terminal' object,
6837 and so this function is called once for each individual termcap
6838 terminal. The first parameter indicates which terminal to read from. */
6841 tty_read_avail_input (struct terminal
*terminal
,
6842 struct input_event
*hold_quit
)
6844 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6845 the kbd_buffer can really hold. That may prevent loss
6846 of characters on some systems when input is stuffed at us. */
6847 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6849 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6852 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6854 if (kbd_on_hold_p () || buffer_free
<= 0)
6856 #endif /* subprocesses */
6858 if (!terminal
->name
) /* Don't read from a dead terminal. */
6861 if (terminal
->type
!= output_termcap
6862 && terminal
->type
!= output_msdos_raw
)
6865 /* XXX I think the following code should be moved to separate hook
6866 functions in system-dependent files. */
6869 #else /* not WINDOWSNT */
6870 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6874 return 0; /* The terminal is suspended. */
6877 n_to_read
= dos_keysns ();
6881 cbuf
[0] = dos_keyread ();
6884 #else /* not MSDOS */
6889 struct input_event gpm_hold_quit
;
6890 int gpm
, fd
= gpm_fd
;
6892 EVENT_INIT (gpm_hold_quit
);
6893 gpm_hold_quit
.kind
= NO_EVENT
;
6895 /* gpm==1 if event received.
6896 gpm==0 if the GPM daemon has closed the connection, in which case
6897 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6898 we save it in `fd' so close_gpm can remove it from the
6900 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6901 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6902 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6905 /* Presumably the GPM daemon has closed the connection. */
6907 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6908 kbd_buffer_store_event (&gpm_hold_quit
);
6912 #endif /* HAVE_GPM */
6914 /* Determine how many characters we should *try* to read. */
6915 #ifdef USABLE_FIONREAD
6916 /* Find out how much input is available. */
6917 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6919 if (! noninteractive
)
6920 return -2; /* Close this terminal. */
6926 if (n_to_read
> sizeof cbuf
)
6927 n_to_read
= sizeof cbuf
;
6928 #elif defined USG || defined CYGWIN
6929 /* Read some input if available, but don't wait. */
6930 n_to_read
= sizeof cbuf
;
6931 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6933 # error "Cannot read without possibly delaying"
6937 /* Don't read more than we can store. */
6938 if (n_to_read
> buffer_free
)
6939 n_to_read
= buffer_free
;
6940 #endif /* subprocesses */
6942 /* Now read; for one reason or another, this will not block.
6943 NREAD is set to the number of chars read. */
6946 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6947 /* POSIX infers that processes which are not in the session leader's
6948 process group won't get SIGHUP's at logout time. BSDI adheres to
6949 this part standard and returns -1 from read (0) with errno==EIO
6950 when the control tty is taken away.
6951 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6952 if (nread
== -1 && errno
== EIO
)
6953 return -2; /* Close this terminal. */
6954 #if defined (AIX) && defined (_BSD)
6955 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6956 This looks incorrect, but it isn't, because _BSD causes
6957 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6958 and that causes a value other than 0 when there is no input. */
6960 return -2; /* Close this terminal. */
6964 /* We used to retry the read if it was interrupted.
6965 But this does the wrong thing when O_NONBLOCK causes
6966 an EAGAIN error. Does anybody know of a situation
6967 where a retry is actually needed? */
6969 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
6979 #ifndef USABLE_FIONREAD
6980 #if defined (USG) || defined (CYGWIN)
6981 fcntl (fileno (tty
->input
), F_SETFL
, 0);
6982 #endif /* USG or CYGWIN */
6983 #endif /* no FIONREAD */
6988 #endif /* not MSDOS */
6989 #endif /* not WINDOWSNT */
6991 for (i
= 0; i
< nread
; i
++)
6993 struct input_event buf
;
6995 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
6997 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
6998 buf
.modifiers
= meta_modifier
;
6999 if (tty
->meta_key
!= 2)
7003 /* Set the frame corresponding to the active tty. Note that the
7004 value of selected_frame is not reliable here, redisplay tends
7005 to temporarily change it. */
7006 buf
.frame_or_window
= tty
->top_frame
;
7009 kbd_buffer_store_event (&buf
);
7010 /* Don't look at input that follows a C-g too closely.
7011 This reduces lossage due to autorepeat on C-g. */
7012 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7013 && buf
.code
== quit_char
)
7021 handle_async_input (void)
7026 int nread
= gobble_input ();
7027 /* -1 means it's not ok to read the input now.
7028 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7029 0 means there was no keyboard input available. */
7037 process_pending_signals (void)
7039 pending_signals
= 0;
7040 handle_async_input ();
7041 do_pending_atimers ();
7044 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7045 and also (if the level is now 0) reinvoke any pending signal. */
7048 unblock_input_to (int level
)
7050 interrupt_input_blocked
= level
;
7053 if (pending_signals
)
7054 process_pending_signals ();
7060 /* End critical section.
7062 If doing signal-driven input, and a signal came in when input was
7063 blocked, reinvoke the signal handler now to deal with it. */
7066 unblock_input (void)
7068 unblock_input_to (interrupt_input_blocked
- 1);
7071 /* Undo any number of BLOCK_INPUT calls,
7072 and also reinvoke any pending signal. */
7075 totally_unblock_input (void)
7077 unblock_input_to (0);
7083 handle_input_available_signal (int sig
)
7085 pending_signals
= 1;
7087 if (input_available_clear_time
)
7088 *input_available_clear_time
= make_emacs_time (0, 0);
7092 deliver_input_available_signal (int sig
)
7094 deliver_process_signal (sig
, handle_input_available_signal
);
7096 #endif /* USABLE_SIGIO */
7099 /* User signal events. */
7101 struct user_signal_info
7103 /* Signal number. */
7106 /* Name of the signal. */
7109 /* Number of pending signals. */
7112 struct user_signal_info
*next
;
7115 /* List of user signals. */
7116 static struct user_signal_info
*user_signals
= NULL
;
7119 add_user_signal (int sig
, const char *name
)
7121 struct sigaction action
;
7122 struct user_signal_info
*p
;
7124 for (p
= user_signals
; p
; p
= p
->next
)
7126 /* Already added. */
7129 p
= xmalloc (sizeof *p
);
7131 p
->name
= xstrdup (name
);
7133 p
->next
= user_signals
;
7136 emacs_sigaction_init (&action
, deliver_user_signal
);
7137 sigaction (sig
, &action
, 0);
7141 handle_user_signal (int sig
)
7143 struct user_signal_info
*p
;
7144 const char *special_event_name
= NULL
;
7146 if (SYMBOLP (Vdebug_on_event
))
7147 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7149 for (p
= user_signals
; p
; p
= p
->next
)
7152 if (special_event_name
7153 && strcmp (special_event_name
, p
->name
) == 0)
7155 /* Enter the debugger in many ways. */
7156 debug_on_next_call
= 1;
7159 Vinhibit_quit
= Qnil
;
7161 /* Eat the event. */
7167 if (interrupt_input
)
7168 handle_input_available_signal (sig
);
7172 /* Tell wait_reading_process_output that it needs to wake
7173 up and look around. */
7174 if (input_available_clear_time
)
7175 *input_available_clear_time
= make_emacs_time (0, 0);
7182 deliver_user_signal (int sig
)
7184 deliver_process_signal (sig
, handle_user_signal
);
7188 find_user_signal_name (int sig
)
7190 struct user_signal_info
*p
;
7192 for (p
= user_signals
; p
; p
= p
->next
)
7200 store_user_signal_events (void)
7202 struct user_signal_info
*p
;
7203 struct input_event buf
;
7204 bool buf_initialized
= 0;
7206 for (p
= user_signals
; p
; p
= p
->next
)
7207 if (p
->npending
> 0)
7209 if (! buf_initialized
)
7211 memset (&buf
, 0, sizeof buf
);
7212 buf
.kind
= USER_SIGNAL_EVENT
;
7213 buf
.frame_or_window
= selected_frame
;
7214 buf_initialized
= 1;
7220 kbd_buffer_store_event (&buf
);
7223 while (p
->npending
> 0);
7228 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7229 static Lisp_Object menu_bar_one_keymap_changed_items
;
7231 /* These variables hold the vector under construction within
7232 menu_bar_items and its subroutines, and the current index
7233 for storing into that vector. */
7234 static Lisp_Object menu_bar_items_vector
;
7235 static int menu_bar_items_index
;
7238 static const char* separator_names
[] = {
7243 "single-dashed-line",
7244 "double-dashed-line",
7246 "shadow-etched-out",
7247 "shadow-etched-in-dash",
7248 "shadow-etched-out-dash",
7249 "shadow-double-etched-in",
7250 "shadow-double-etched-out",
7251 "shadow-double-etched-in-dash",
7252 "shadow-double-etched-out-dash",
7256 /* Return true if LABEL specifies a separator. */
7259 menu_separator_name_p (const char *label
)
7263 else if (strlen (label
) > 3
7264 && memcmp (label
, "--", 2) == 0
7269 for (i
= 0; separator_names
[i
]; ++i
)
7270 if (strcmp (label
, separator_names
[i
]) == 0)
7275 /* It's a separator if it contains only dashes. */
7276 while (*label
== '-')
7278 return (*label
== 0);
7285 /* Return a vector of menu items for a menu bar, appropriate
7286 to the current buffer. Each item has three elements in the vector:
7289 OLD is an old vector we can optionally reuse, or nil. */
7292 menu_bar_items (Lisp_Object old
)
7294 /* The number of keymaps we're scanning right now, and the number of
7295 keymaps we have allocated space for. */
7298 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7299 in the current keymaps, or nil where it is not a prefix. */
7302 Lisp_Object def
, tail
;
7307 /* In order to build the menus, we need to call the keymap
7308 accessors. They all call QUIT. But this function is called
7309 during redisplay, during which a quit is fatal. So inhibit
7310 quitting while building the menus.
7311 We do this instead of specbind because (1) errors will clear it anyway
7312 and (2) this avoids risk of specpdl overflow. */
7313 oquit
= Vinhibit_quit
;
7317 menu_bar_items_vector
= old
;
7319 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7320 menu_bar_items_index
= 0;
7322 /* Build our list of keymaps.
7323 If we recognize a function key and replace its escape sequence in
7324 keybuf with its symbol, or if the sequence starts with a mouse
7325 click and we need to switch buffers, we jump back here to rebuild
7326 the initial keymaps from the current buffer. */
7330 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7331 if (!NILP (Voverriding_local_map_menu_flag
))
7333 /* Yes, use them (if non-nil) as well as the global map. */
7334 maps
= alloca (3 * sizeof (maps
[0]));
7336 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7337 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7338 if (!NILP (Voverriding_local_map
))
7339 maps
[nmaps
++] = Voverriding_local_map
;
7343 /* No, so use major and minor mode keymaps and keymap property.
7344 Note that menu-bar bindings in the local-map and keymap
7345 properties may not work reliable, as they are only
7346 recognized when the menu-bar (or mode-line) is updated,
7347 which does not normally happen after every command. */
7350 nminor
= current_minor_maps (NULL
, &tmaps
);
7351 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7353 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7354 maps
[nmaps
++] = tem
;
7355 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7357 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7359 maps
[nmaps
++] = current_global_map
;
7362 /* Look up in each map the dummy prefix key `menu-bar'. */
7364 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7365 if (!NILP (maps
[mapno
]))
7367 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7371 menu_bar_one_keymap_changed_items
= Qnil
;
7372 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7376 /* Move to the end those items that should be at the end. */
7378 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7381 int end
= menu_bar_items_index
;
7383 for (i
= 0; i
< end
; i
+= 4)
7384 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7386 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7387 /* Move the item at index I to the end,
7388 shifting all the others forward. */
7389 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7390 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7391 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7392 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7394 memmove (aref_addr (menu_bar_items_vector
, i
),
7395 aref_addr (menu_bar_items_vector
, i
+ 4),
7396 (end
- i
- 4) * word_size
);
7397 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7398 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7399 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7400 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7405 /* Add nil, nil, nil, nil at the end. */
7407 int i
= menu_bar_items_index
;
7408 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7409 menu_bar_items_vector
=
7410 larger_vector (menu_bar_items_vector
, 4, -1);
7411 /* Add this item. */
7412 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7413 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7414 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7415 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7416 menu_bar_items_index
= i
;
7419 Vinhibit_quit
= oquit
;
7420 return menu_bar_items_vector
;
7423 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7424 If there's already an item for KEY, add this DEF to it. */
7426 Lisp_Object item_properties
;
7429 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7431 struct gcpro gcpro1
;
7436 if (EQ (item
, Qundefined
))
7438 /* If a map has an explicit `undefined' as definition,
7439 discard any previously made menu bar item. */
7441 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7442 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7444 if (menu_bar_items_index
> i
+ 4)
7445 memmove (aref_addr (menu_bar_items_vector
, i
),
7446 aref_addr (menu_bar_items_vector
, i
+ 4),
7447 (menu_bar_items_index
- i
- 4) * word_size
);
7448 menu_bar_items_index
-= 4;
7452 /* If this keymap has already contributed to this KEY,
7453 don't contribute to it a second time. */
7454 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7455 if (!NILP (tem
) || NILP (item
))
7458 menu_bar_one_keymap_changed_items
7459 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7461 /* We add to menu_bar_one_keymap_changed_items before doing the
7462 parse_menu_item, so that if it turns out it wasn't a menu item,
7463 it still correctly hides any further menu item. */
7465 parsed
= parse_menu_item (item
, 1);
7470 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7472 /* Find any existing item for this KEY. */
7473 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7474 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7477 /* If we did not find this KEY, add it at the end. */
7478 if (i
== menu_bar_items_index
)
7480 /* If vector is too small, get a bigger one. */
7481 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7482 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7483 /* Add this item. */
7484 ASET (menu_bar_items_vector
, i
, key
); i
++;
7485 ASET (menu_bar_items_vector
, i
,
7486 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7487 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7488 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7489 menu_bar_items_index
= i
;
7491 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7495 old
= AREF (menu_bar_items_vector
, i
+ 2);
7496 /* If the new and the old items are not both keymaps,
7497 the lookup will only find `item'. */
7498 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7499 ASET (menu_bar_items_vector
, i
+ 2, item
);
7503 /* This is used as the handler when calling menu_item_eval_property. */
7505 menu_item_eval_property_1 (Lisp_Object arg
)
7507 /* If we got a quit from within the menu computation,
7508 quit all the way out of it. This takes care of C-] in the debugger. */
7509 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7510 Fsignal (Qquit
, Qnil
);
7516 eval_dyn (Lisp_Object form
)
7518 return Feval (form
, Qnil
);
7521 /* Evaluate an expression and return the result (or nil if something
7522 went wrong). Used to evaluate dynamic parts of menu items. */
7524 menu_item_eval_property (Lisp_Object sexpr
)
7526 ptrdiff_t count
= SPECPDL_INDEX ();
7528 specbind (Qinhibit_redisplay
, Qt
);
7529 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7530 menu_item_eval_property_1
);
7531 return unbind_to (count
, val
);
7534 /* This function parses a menu item and leaves the result in the
7535 vector item_properties.
7536 ITEM is a key binding, a possible menu item.
7537 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7539 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7540 parse_menu_item returns true if the item is a menu item and false
7544 parse_menu_item (Lisp_Object item
, int inmenubar
)
7546 Lisp_Object def
, tem
, item_string
, start
;
7548 Lisp_Object keyhint
;
7557 /* Create item_properties vector if necessary. */
7558 if (NILP (item_properties
))
7560 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7562 /* Initialize optional entries. */
7563 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7564 ASET (item_properties
, i
, Qnil
);
7565 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7567 /* Save the item here to protect it from GC. */
7568 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7570 item_string
= XCAR (item
);
7574 if (STRINGP (item_string
))
7576 /* Old format menu item. */
7577 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7579 /* Maybe help string. */
7580 if (CONSP (item
) && STRINGP (XCAR (item
)))
7582 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7587 /* Maybe an obsolete key binding cache. */
7588 if (CONSP (item
) && CONSP (XCAR (item
))
7589 && (NILP (XCAR (XCAR (item
)))
7590 || VECTORP (XCAR (XCAR (item
)))))
7593 /* This is the real definition--the function to run. */
7594 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7596 /* Get enable property, if any. */
7599 tem
= Fget (item
, Qmenu_enable
);
7600 if (!NILP (Venable_disabled_menus_and_buttons
))
7601 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7602 else if (!NILP (tem
))
7603 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7606 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7608 /* New format menu item. */
7609 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7610 start
= XCDR (item
);
7613 /* We have a real binding. */
7614 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7616 item
= XCDR (start
);
7617 /* Is there an obsolete cache list with key equivalences. */
7618 if (CONSP (item
) && CONSP (XCAR (item
)))
7621 /* Parse properties. */
7622 while (CONSP (item
) && CONSP (XCDR (item
)))
7627 if (EQ (tem
, QCenable
))
7629 if (!NILP (Venable_disabled_menus_and_buttons
))
7630 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7632 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7634 else if (EQ (tem
, QCvisible
))
7636 /* If got a visible property and that evaluates to nil
7637 then ignore this item. */
7638 tem
= menu_item_eval_property (XCAR (item
));
7642 else if (EQ (tem
, QChelp
))
7643 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7644 else if (EQ (tem
, QCfilter
))
7646 else if (EQ (tem
, QCkey_sequence
))
7649 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7650 /* Be GC protected. Set keyhint to item instead of tem. */
7653 else if (EQ (tem
, QCkeys
))
7656 if (CONSP (tem
) || STRINGP (tem
))
7657 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7659 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7664 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7666 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7668 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7674 else if (inmenubar
|| !NILP (start
))
7678 return 0; /* not a menu item */
7680 /* If item string is not a string, evaluate it to get string.
7681 If we don't get a string, skip this item. */
7682 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7683 if (!(STRINGP (item_string
)))
7685 item_string
= menu_item_eval_property (item_string
);
7686 if (!STRINGP (item_string
))
7688 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7691 /* If got a filter apply it on definition. */
7692 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7695 def
= menu_item_eval_property (list2 (XCAR (filter
),
7696 list2 (Qquote
, def
)));
7698 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7701 /* Enable or disable selection of item. */
7702 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7705 tem
= menu_item_eval_property (tem
);
7706 if (inmenubar
&& NILP (tem
))
7707 return 0; /* Ignore disabled items in menu bar. */
7708 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7711 /* If we got no definition, this item is just unselectable text which
7712 is OK in a submenu but not in the menubar. */
7714 return (!inmenubar
);
7716 /* See if this is a separate pane or a submenu. */
7717 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7718 tem
= get_keymap (def
, 0, 1);
7719 /* For a subkeymap, just record its details and exit. */
7722 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7723 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7727 /* At the top level in the menu bar, do likewise for commands also.
7728 The menu bar does not display equivalent key bindings anyway.
7729 ITEM_PROPERTY_DEF is already set up properly. */
7733 { /* This is a command. See if there is an equivalent key binding. */
7734 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7736 /* The previous code preferred :key-sequence to :keys, so we
7737 preserve this behavior. */
7738 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7739 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7742 Lisp_Object prefix
= keyeq
;
7743 Lisp_Object keys
= Qnil
;
7747 def
= XCAR (prefix
);
7748 prefix
= XCDR (prefix
);
7751 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7753 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7755 keys
= XCAR (keyhint
);
7756 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7758 /* We have a suggested key. Is it bound to the command? */
7761 /* If the command is an alias for another
7762 (such as lmenu.el set it up), check if the
7763 original command matches the cached command. */
7765 && EQ (tem
, XSYMBOL (def
)->function
))))
7770 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7774 tem
= Fkey_description (keys
, Qnil
);
7777 if (STRINGP (XCAR (prefix
)))
7778 tem
= concat2 (XCAR (prefix
), tem
);
7779 if (STRINGP (XCDR (prefix
)))
7780 tem
= concat2 (tem
, XCDR (prefix
));
7782 keyeq
= concat2 (build_string (" "), tem
);
7783 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7789 /* If we have an equivalent key binding, use that. */
7790 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7793 /* Include this when menu help is implemented.
7794 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7795 if (!(NILP (tem) || STRINGP (tem)))
7797 tem = menu_item_eval_property (tem);
7800 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7804 /* Handle radio buttons or toggle boxes. */
7805 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7807 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7808 menu_item_eval_property (tem
));
7815 /***********************************************************************
7817 ***********************************************************************/
7819 /* A vector holding tool bar items while they are parsed in function
7820 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7823 static Lisp_Object tool_bar_items_vector
;
7825 /* A vector holding the result of parse_tool_bar_item. Layout is like
7826 the one for a single item in tool_bar_items_vector. */
7828 static Lisp_Object tool_bar_item_properties
;
7830 /* Next free index in tool_bar_items_vector. */
7832 static int ntool_bar_items
;
7834 /* The symbols `:image' and `:rtl'. */
7836 static Lisp_Object QCimage
;
7837 static Lisp_Object QCrtl
;
7839 /* Function prototypes. */
7841 static void init_tool_bar_items (Lisp_Object
);
7842 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7843 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7844 static void append_tool_bar_item (void);
7847 /* Return a vector of tool bar items for keymaps currently in effect.
7848 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7849 tool bar items found. */
7852 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7861 /* In order to build the menus, we need to call the keymap
7862 accessors. They all call QUIT. But this function is called
7863 during redisplay, during which a quit is fatal. So inhibit
7864 quitting while building the menus. We do this instead of
7865 specbind because (1) errors will clear it anyway and (2) this
7866 avoids risk of specpdl overflow. */
7867 oquit
= Vinhibit_quit
;
7870 /* Initialize tool_bar_items_vector and protect it from GC. */
7871 init_tool_bar_items (reuse
);
7873 /* Build list of keymaps in maps. Set nmaps to the number of maps
7876 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7877 if (!NILP (Voverriding_local_map_menu_flag
))
7879 /* Yes, use them (if non-nil) as well as the global map. */
7880 maps
= alloca (3 * sizeof *maps
);
7882 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7883 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7884 if (!NILP (Voverriding_local_map
))
7885 maps
[nmaps
++] = Voverriding_local_map
;
7889 /* No, so use major and minor mode keymaps and keymap property.
7890 Note that tool-bar bindings in the local-map and keymap
7891 properties may not work reliable, as they are only
7892 recognized when the tool-bar (or mode-line) is updated,
7893 which does not normally happen after every command. */
7896 nminor
= current_minor_maps (NULL
, &tmaps
);
7897 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7899 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7900 maps
[nmaps
++] = tem
;
7901 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7903 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7906 /* Add global keymap at the end. */
7907 maps
[nmaps
++] = current_global_map
;
7909 /* Process maps in reverse order and look up in each map the prefix
7911 for (i
= nmaps
- 1; i
>= 0; --i
)
7912 if (!NILP (maps
[i
]))
7916 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7918 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7921 Vinhibit_quit
= oquit
;
7922 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7923 return tool_bar_items_vector
;
7927 /* Process the definition of KEY which is DEF. */
7930 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7933 struct gcpro gcpro1
, gcpro2
;
7935 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7939 if (EQ (def
, Qundefined
))
7941 /* If a map has an explicit `undefined' as definition,
7942 discard any previously made item. */
7943 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7945 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
7947 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
7949 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
7950 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
7951 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
7953 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
7958 else if (parse_tool_bar_item (key
, def
))
7959 /* Append a new tool bar item to tool_bar_items_vector. Accept
7960 more than one definition for the same key. */
7961 append_tool_bar_item ();
7966 /* Access slot with index IDX of vector tool_bar_item_properties. */
7967 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
7969 set_prop (ptrdiff_t idx
, Lisp_Object val
)
7971 ASET (tool_bar_item_properties
, idx
, val
);
7975 /* Parse a tool bar item specification ITEM for key KEY and return the
7976 result in tool_bar_item_properties. Value is false if ITEM is
7979 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
7981 CAPTION is the caption of the item, If it's not a string, it is
7982 evaluated to get a string.
7984 BINDING is the tool bar item's binding. Tool-bar items with keymaps
7985 as binding are currently ignored.
7987 The following properties are recognized:
7991 FORM is evaluated and specifies whether the tool bar item is
7992 enabled or disabled.
7996 FORM is evaluated and specifies whether the tool bar item is visible.
7998 - `:filter FUNCTION'
8000 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8001 result is stored as the new binding.
8003 - `:button (TYPE SELECTED)'
8005 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8006 and specifies whether the button is selected (pressed) or not.
8010 IMAGES is either a single image specification or a vector of four
8011 image specifications. See enum tool_bar_item_images.
8013 - `:help HELP-STRING'.
8015 Gives a help string to display for the tool bar item.
8017 - `:label LABEL-STRING'.
8019 A text label to show with the tool bar button if labels are enabled. */
8022 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8024 Lisp_Object filter
= Qnil
;
8025 Lisp_Object caption
;
8027 bool have_label
= 0;
8029 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8030 Rule out items that aren't lists, don't start with
8031 `menu-item' or whose rest following `tool-bar-item' is not a
8036 /* As an exception, allow old-style menu separators. */
8037 if (STRINGP (XCAR (item
)))
8038 item
= Fcons (XCAR (item
), Qnil
);
8039 else if (!EQ (XCAR (item
), Qmenu_item
)
8040 || (item
= XCDR (item
), !CONSP (item
)))
8043 /* Create tool_bar_item_properties vector if necessary. Reset it to
8045 if (VECTORP (tool_bar_item_properties
))
8047 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8051 tool_bar_item_properties
8052 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8055 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8056 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8058 /* Get the caption of the item. If the caption is not a string,
8059 evaluate it to get a string. If we don't get a string, skip this
8061 caption
= XCAR (item
);
8062 if (!STRINGP (caption
))
8064 caption
= menu_item_eval_property (caption
);
8065 if (!STRINGP (caption
))
8068 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8070 /* If the rest following the caption is not a list, the menu item is
8071 either a separator, or invalid. */
8075 if (menu_separator_name_p (SSDATA (caption
)))
8077 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8078 #if !defined (USE_GTK) && !defined (HAVE_NS)
8079 /* If we use build_desired_tool_bar_string to render the
8080 tool bar, the separator is rendered as an image. */
8081 PROP (TOOL_BAR_ITEM_IMAGES
)
8082 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8083 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8084 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8085 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8092 /* Store the binding. */
8093 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8096 /* Ignore cached key binding, if any. */
8097 if (CONSP (item
) && CONSP (XCAR (item
)))
8100 /* Process the rest of the properties. */
8101 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8103 Lisp_Object ikey
, value
;
8106 value
= XCAR (XCDR (item
));
8108 if (EQ (ikey
, QCenable
))
8110 /* `:enable FORM'. */
8111 if (!NILP (Venable_disabled_menus_and_buttons
))
8112 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8114 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8116 else if (EQ (ikey
, QCvisible
))
8118 /* `:visible FORM'. If got a visible property and that
8119 evaluates to nil then ignore this item. */
8120 if (NILP (menu_item_eval_property (value
)))
8123 else if (EQ (ikey
, QChelp
))
8124 /* `:help HELP-STRING'. */
8125 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8126 else if (EQ (ikey
, QCvert_only
))
8127 /* `:vert-only t/nil'. */
8128 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8129 else if (EQ (ikey
, QClabel
))
8131 const char *bad_label
= "!!?GARBLED ITEM?!!";
8132 /* `:label LABEL-STRING'. */
8133 set_prop (TOOL_BAR_ITEM_LABEL
,
8134 STRINGP (value
) ? value
: build_string (bad_label
));
8137 else if (EQ (ikey
, QCfilter
))
8138 /* ':filter FORM'. */
8140 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8142 /* `:button (TYPE . SELECTED)'. */
8143 Lisp_Object type
, selected
;
8145 type
= XCAR (value
);
8146 selected
= XCDR (value
);
8147 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8149 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8150 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8153 else if (EQ (ikey
, QCimage
)
8155 || (VECTORP (value
) && ASIZE (value
) == 4)))
8156 /* Value is either a single image specification or a vector
8157 of 4 such specifications for the different button states. */
8158 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8159 else if (EQ (ikey
, QCrtl
))
8161 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8167 /* Try to make one from caption and key. */
8168 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8169 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8170 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8171 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8173 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8174 char *buf
= xmalloc (max_lbl
+ 1);
8175 Lisp_Object new_lbl
;
8176 ptrdiff_t caption_len
= strlen (capt
);
8178 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8181 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8183 buf
[caption_len
] = '\0';
8187 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8191 strcpy (buf
, label
);
8193 for (j
= 0; buf
[j
] != '\0'; ++j
)
8201 new_lbl
= Fupcase_initials (build_string (label
));
8202 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8203 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8205 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8209 /* If got a filter apply it on binding. */
8211 set_prop (TOOL_BAR_ITEM_BINDING
,
8212 (menu_item_eval_property
8215 PROP (TOOL_BAR_ITEM_BINDING
))))));
8217 /* See if the binding is a keymap. Give up if it is. */
8218 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8221 /* Enable or disable selection of item. */
8222 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8223 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8224 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8226 /* Handle radio buttons or toggle boxes. */
8227 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8228 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8229 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8237 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8238 that can be reused. */
8241 init_tool_bar_items (Lisp_Object reuse
)
8243 if (VECTORP (reuse
))
8244 tool_bar_items_vector
= reuse
;
8246 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8247 ntool_bar_items
= 0;
8251 /* Append parsed tool bar item properties from
8252 tool_bar_item_properties */
8255 append_tool_bar_item (void)
8259 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8261 /* Enlarge tool_bar_items_vector if necessary. */
8263 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8265 /* Append entries from tool_bar_item_properties to the end of
8266 tool_bar_items_vector. */
8267 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8268 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8269 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8276 /* Read a character using menus based on the keymap MAP.
8277 Return nil if there are no menus in the maps.
8278 Return t if we displayed a menu but the user rejected it.
8280 PREV_EVENT is the previous input event, or nil if we are reading
8281 the first event of a key sequence.
8283 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8284 if we used a mouse menu to read the input, or false otherwise. If
8285 USED_MOUSE_MENU is null, don't dereference it.
8287 The prompting is done based on the prompt-string of the map
8288 and the strings associated with various map elements.
8290 This can be done with X menus or with menus put in the minibuf.
8291 These are done in different ways, depending on how the input will be read.
8292 Menus using X are done after auto-saving in read-char, getting the input
8293 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8294 and do auto-saving in the inner call of read_char. */
8297 read_char_x_menu_prompt (Lisp_Object map
,
8298 Lisp_Object prev_event
, bool *used_mouse_menu
)
8300 if (used_mouse_menu
)
8301 *used_mouse_menu
= 0;
8303 /* Use local over global Menu maps. */
8305 if (! menu_prompting
)
8309 /* If we got to this point via a mouse click,
8310 use a real menu for mouse selection. */
8311 if (EVENT_HAS_PARAMETERS (prev_event
)
8312 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8313 && !EQ (XCAR (prev_event
), Qtool_bar
))
8315 /* Display the menu and get the selection. */
8318 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8323 record_menu_key (XCAR (value
));
8325 /* If we got multiple events, unread all but
8327 There is no way to prevent those unread events
8328 from showing up later in last_nonmenu_event.
8329 So turn symbol and integer events into lists,
8330 to indicate that they came from a mouse menu,
8331 so that when present in last_nonmenu_event
8332 they won't confuse things. */
8333 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8335 record_menu_key (XCAR (tem
));
8336 if (SYMBOLP (XCAR (tem
))
8337 || INTEGERP (XCAR (tem
)))
8338 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8341 /* If we got more than one event, put all but the first
8342 onto this list to be read later.
8343 Return just the first event now. */
8344 Vunread_command_events
8345 = nconc2 (XCDR (value
), Vunread_command_events
);
8346 value
= XCAR (value
);
8348 else if (NILP (value
))
8350 if (used_mouse_menu
)
8351 *used_mouse_menu
= 1;
8354 #endif /* HAVE_MENUS */
8359 read_char_minibuf_menu_prompt (int commandflag
,
8362 register Lisp_Object name
;
8364 /* FIXME: Use the minibuffer's frame width. */
8365 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8367 bool nobindings
= 1;
8368 Lisp_Object rest
, vector
;
8369 Lisp_Object prompt_strings
= Qnil
;
8373 if (! menu_prompting
)
8376 map
= get_keymap (map
, 0, 1);
8377 name
= Fkeymap_prompt (map
);
8379 /* If we don't have any menus, just read a character normally. */
8380 if (!STRINGP (name
))
8383 #define PUSH_C_STR(str, listvar) \
8384 listvar = Fcons (make_unibyte_string (str, strlen (str)), listvar)
8386 /* Prompt string always starts with map's prompt, and a space. */
8387 prompt_strings
= Fcons (name
, prompt_strings
);
8388 PUSH_C_STR (": ", prompt_strings
);
8389 nlength
= SCHARS (name
) + 2;
8393 /* Present the documented bindings, a line at a time. */
8397 Lisp_Object menu_strings
= prompt_strings
;
8398 ptrdiff_t i
= nlength
;
8400 Lisp_Object orig_defn_macro
;
8402 /* Loop over elements of map. */
8407 /* FIXME: Use map_keymap to handle new keymap formats. */
8409 /* At end of map, wrap around if just starting,
8410 or end this line if already have something on it. */
8413 if (notfirst
|| nobindings
)
8419 /* Look at the next element of the map. */
8421 elt
= AREF (vector
, idx
);
8423 elt
= Fcar_safe (rest
);
8425 if (idx
< 0 && VECTORP (elt
))
8427 /* If we found a dense table in the keymap,
8428 advanced past it, but start scanning its contents. */
8429 rest
= Fcdr_safe (rest
);
8435 /* An ordinary element. */
8436 Lisp_Object event
, tem
;
8440 event
= Fcar_safe (elt
); /* alist */
8441 elt
= Fcdr_safe (elt
);
8445 XSETINT (event
, idx
); /* vector */
8448 /* Ignore the element if it has no prompt string. */
8449 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8451 /* True if the char to type matches the string. */
8453 Lisp_Object upcased_event
, downcased_event
;
8454 Lisp_Object desc
= Qnil
;
8456 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8458 upcased_event
= Fupcase (event
);
8459 downcased_event
= Fdowncase (event
);
8460 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8461 || XINT (downcased_event
) == SREF (s
, 0));
8463 desc
= Fsingle_key_description (event
, Qnil
);
8465 #if 0 /* It is redundant to list the equivalent key bindings because
8466 the prefix is what the user has already typed. */
8468 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8470 /* Insert equivalent keybinding. */
8471 s
= concat2 (s
, tem
);
8474 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8475 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8477 /* Insert button prefix. */
8478 Lisp_Object selected
8479 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8480 if (EQ (tem
, QCradio
))
8481 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8483 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8484 s
= concat2 (tem
, s
);
8488 /* If we have room for the prompt string, add it to this line.
8489 If this is the first on the line, always add it. */
8490 if ((SCHARS (s
) + i
+ 2
8491 + (char_matches
? 0 : SCHARS (desc
) + 3))
8495 ptrdiff_t thiswidth
;
8497 /* Punctuate between strings. */
8500 PUSH_C_STR (", ", menu_strings
);
8506 /* If the char to type doesn't match the string's
8507 first char, explicitly show what char to type. */
8510 /* Add as much of string as fits. */
8511 thiswidth
= min (SCHARS (desc
), width
- i
);
8513 = Fcons (Fsubstring (desc
, make_number (0),
8514 make_number (thiswidth
)),
8517 PUSH_C_STR (" = ", menu_strings
);
8521 /* Add as much of string as fits. */
8522 thiswidth
= min (SCHARS (s
), width
- i
);
8524 = Fcons (Fsubstring (s
, make_number (0),
8525 make_number (thiswidth
)),
8531 /* If this element does not fit, end the line now,
8532 and save the element for the next line. */
8533 PUSH_C_STR ("...", menu_strings
);
8538 /* Move past this element. */
8539 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8540 /* Handle reaching end of dense table. */
8545 rest
= Fcdr_safe (rest
);
8549 /* Prompt with that and read response. */
8550 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8552 /* Make believe it's not a keyboard macro in case the help char
8553 is pressed. Help characters are not recorded because menu prompting
8554 is not used on replay. */
8555 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8556 kset_defining_kbd_macro (current_kboard
, Qnil
);
8558 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8559 while (BUFFERP (obj
));
8560 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8562 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8565 if (! EQ (obj
, menu_prompt_more_char
)
8566 && (!INTEGERP (menu_prompt_more_char
)
8567 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8569 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8570 store_kbd_macro_char (obj
);
8573 /* Help char - go round again. */
8577 /* Reading key sequences. */
8580 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8582 return access_keymap (get_keymap (keymap
, 0, 1),
8587 active_maps (Lisp_Object first_event
)
8589 Lisp_Object position
8590 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8591 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8594 /* Structure used to keep track of partial application of key remapping
8595 such as Vfunction_key_map and Vkey_translation_map. */
8596 typedef struct keyremap
8598 /* This is the map originally specified for this use. */
8600 /* This is a submap reached by looking up, in PARENT,
8601 the events from START to END. */
8603 /* Positions [START, END) in the key sequence buffer
8604 are the key that we have scanned so far.
8605 Those events are the ones that we will replace
8606 if PARENT maps them into a key sequence. */
8610 /* Lookup KEY in MAP.
8611 MAP is a keymap mapping keys to key vectors or functions.
8612 If the mapping is a function and DO_FUNCALL is true,
8613 the function is called with PROMPT as parameter and its return
8614 value is used as the return value of this function (after checking
8615 that it is indeed a vector). */
8618 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8623 next
= access_keymap (map
, key
, 1, 0, 1);
8625 /* Handle a symbol whose function definition is a keymap
8627 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8628 && (ARRAYP (XSYMBOL (next
)->function
)
8629 || KEYMAPP (XSYMBOL (next
)->function
)))
8630 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8632 /* If the keymap gives a function, not an
8633 array, then call the function with one arg and use
8634 its value instead. */
8635 if (do_funcall
&& FUNCTIONP (next
))
8640 next
= call1 (next
, prompt
);
8641 /* If the function returned something invalid,
8642 barf--don't ignore it.
8643 (To ignore it safely, we would need to gcpro a bunch of
8644 other variables.) */
8645 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8646 error ("Function %s returns invalid key sequence",
8647 SSDATA (SYMBOL_NAME (tem
)));
8652 /* Do one step of the key remapping used for function-key-map and
8653 key-translation-map:
8654 KEYBUF is the buffer holding the input events.
8655 BUFSIZE is its maximum size.
8656 FKEY is a pointer to the keyremap structure to use.
8657 INPUT is the index of the last element in KEYBUF.
8658 DOIT if true says that the remapping can actually take place.
8659 DIFF is used to return the number of keys added/removed by the remapping.
8660 PARENT is the root of the keymap.
8661 PROMPT is the prompt to use if the remapping happens through a function.
8662 Return true if the remapping actually took place. */
8665 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8666 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8668 Lisp_Object next
, key
;
8670 key
= keybuf
[fkey
->end
++];
8672 if (KEYMAPP (fkey
->parent
))
8673 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8677 /* If keybuf[fkey->start..fkey->end] is bound in the
8678 map and we're in a position to do the key remapping, replace it with
8679 the binding and restart with fkey->start at the end. */
8680 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8682 int len
= XFASTINT (Flength (next
));
8685 *diff
= len
- (fkey
->end
- fkey
->start
);
8687 if (bufsize
- input
<= *diff
)
8688 error ("Key sequence too long");
8690 /* Shift the keys that follow fkey->end. */
8692 for (i
= fkey
->end
; i
< input
; i
++)
8693 keybuf
[i
+ *diff
] = keybuf
[i
];
8695 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8696 keybuf
[i
+ *diff
] = keybuf
[i
];
8697 /* Overwrite the old keys with the new ones. */
8698 for (i
= 0; i
< len
; i
++)
8699 keybuf
[fkey
->start
+ i
]
8700 = Faref (next
, make_number (i
));
8702 fkey
->start
= fkey
->end
+= *diff
;
8703 fkey
->map
= fkey
->parent
;
8708 fkey
->map
= get_keymap (next
, 0, 1);
8710 /* If we no longer have a bound suffix, try a new position for
8712 if (!CONSP (fkey
->map
))
8714 fkey
->end
= ++fkey
->start
;
8715 fkey
->map
= fkey
->parent
;
8721 test_undefined (Lisp_Object binding
)
8723 return (NILP (binding
)
8724 || EQ (binding
, Qundefined
)
8725 || (SYMBOLP (binding
)
8726 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8729 /* Like `read_char' but applies keyboard-coding-system to tty input. */
8731 read_decoded_char (int commandflag
, Lisp_Object map
,
8732 Lisp_Object prev_event
, bool *used_mouse_menu
)
8734 #define MAX_ENCODED_BYTES 16
8735 Lisp_Object events
[MAX_ENCODED_BYTES
];
8740 = read_char (commandflag
, map
, prev_event
, used_mouse_menu
, NULL
);
8741 struct frame
*frame
= XFRAME (selected_frame
);
8742 struct terminal
*terminal
= frame
->terminal
;
8743 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
8744 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
8745 & CODING_REQUIRE_DECODING_MASK
)))
8746 return nextevt
; /* No decoding needed. */
8749 int meta_key
= terminal
->display_info
.tty
->meta_key
;
8750 eassert (n
< MAX_ENCODED_BYTES
);
8751 events
[n
++] = nextevt
;
8752 if (NATNUMP (nextevt
)
8753 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
8754 { /* An encoded byte sequence, let's try to decode it. */
8755 struct coding_system
*coding
8756 = TERMINAL_KEYBOARD_CODING (terminal
);
8757 unsigned char *src
= alloca (n
);
8759 for (i
= 0; i
< n
; i
++)
8760 src
[i
] = XINT (events
[i
]);
8762 for (i
= 0; i
< n
; i
++)
8764 coding
->destination
= alloca (n
* 4);
8765 coding
->dst_bytes
= n
* 4;
8766 decode_coding_c_string (coding
, src
, n
, Qnil
);
8767 eassert (coding
->produced_char
<= n
);
8768 if (coding
->produced_char
== 0)
8769 { /* The encoded sequence is incomplete. */
8770 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
8771 continue; /* Read on! */
8775 const unsigned char *p
= coding
->destination
;
8776 eassert (coding
->carryover_bytes
== 0);
8778 while (n
< coding
->produced_char
)
8779 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
8782 /* Now `events' should hold decoded events.
8783 Normally, n should be equal to 1, but better not rely on it.
8784 We can only return one event here, so return the first we
8785 had and keep the others (if any) for later. */
8787 Vunread_command_events
8788 = Fcons (events
[--n
], Vunread_command_events
);
8794 /* Read a sequence of keys that ends with a non prefix character,
8795 storing it in KEYBUF, a buffer of size BUFSIZE.
8797 Return the length of the key sequence stored.
8798 Return -1 if the user rejected a command menu.
8800 Echo starting immediately unless `prompt' is 0.
8802 Where a key sequence ends depends on the currently active keymaps.
8803 These include any minor mode keymaps active in the current buffer,
8804 the current buffer's local map, and the global map.
8806 If a key sequence has no other bindings, we check Vfunction_key_map
8807 to see if some trailing subsequence might be the beginning of a
8808 function key's sequence. If so, we try to read the whole function
8809 key, and substitute its symbolic name into the key sequence.
8811 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8812 `double-' events into similar click events, if that would make them
8813 bound. We try to turn `triple-' events first into `double-' events,
8816 If we get a mouse click in a mode line, vertical divider, or other
8817 non-text area, we treat the click as if it were prefixed by the
8818 symbol denoting that area - `mode-line', `vertical-line', or
8821 If the sequence starts with a mouse click, we read the key sequence
8822 with respect to the buffer clicked on, not the current buffer.
8824 If the user switches frames in the midst of a key sequence, we put
8825 off the switch-frame event until later; the next call to
8826 read_char will return it.
8828 If FIX_CURRENT_BUFFER, we restore current_buffer
8829 from the selected window's buffer. */
8832 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8833 bool dont_downcase_last
, bool can_return_switch_frame
,
8834 bool fix_current_buffer
)
8836 ptrdiff_t count
= SPECPDL_INDEX ();
8838 /* How many keys there are in the current key sequence. */
8841 /* The length of the echo buffer when we started reading, and
8842 the length of this_command_keys when we started reading. */
8843 ptrdiff_t echo_start
IF_LINT (= 0);
8844 ptrdiff_t keys_start
;
8846 Lisp_Object current_binding
= Qnil
;
8847 Lisp_Object first_event
= Qnil
;
8849 /* Index of the first key that has no binding.
8850 It is useless to try fkey.start larger than that. */
8853 /* If t < mock_input, then KEYBUF[t] should be read as the next
8856 We use this to recover after recognizing a function key. Once we
8857 realize that a suffix of the current key sequence is actually a
8858 function key's escape sequence, we replace the suffix with the
8859 function key's binding from Vfunction_key_map. Now keybuf
8860 contains a new and different key sequence, so the echo area,
8861 this_command_keys, and the submaps and defs arrays are wrong. In
8862 this situation, we set mock_input to t, set t to 0, and jump to
8863 restart_sequence; the loop will read keys from keybuf up until
8864 mock_input, thus rebuilding the state; and then it will resume
8865 reading characters from the keyboard. */
8868 /* If the sequence is unbound in submaps[], then
8869 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8870 and fkey.map is its binding.
8872 These might be > t, indicating that all function key scanning
8873 should hold off until t reaches them. We do this when we've just
8874 recognized a function key, to avoid searching for the function
8875 key's again in Vfunction_key_map. */
8878 /* Likewise, for key_translation_map and input-decode-map. */
8879 keyremap keytran
, indec
;
8881 /* True if we are trying to map a key by changing an upper-case
8882 letter to lower case, or a shifted function key to an unshifted
8884 bool shift_translated
= 0;
8886 /* If we receive a `switch-frame' or `select-window' event in the middle of
8887 a key sequence, we put it off for later.
8888 While we're reading, we keep the event here. */
8889 Lisp_Object delayed_switch_frame
;
8891 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8892 int original_uppercase_position
= -1;
8894 /* Gets around Microsoft compiler limitations. */
8897 struct buffer
*starting_buffer
;
8899 /* List of events for which a fake prefix key has been generated. */
8900 Lisp_Object fake_prefixed_keys
= Qnil
;
8902 struct gcpro gcpro1
;
8904 GCPRO1 (fake_prefixed_keys
);
8905 raw_keybuf_count
= 0;
8907 last_nonmenu_event
= Qnil
;
8909 delayed_switch_frame
= Qnil
;
8915 /* Install the string STR as the beginning of the string of
8916 echoing, so that it serves as a prompt for the next
8918 kset_echo_string (current_kboard
, prompt
);
8919 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8922 else if (cursor_in_echo_area
8923 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8924 && NILP (Fzerop (Vecho_keystrokes
)))
8925 /* This doesn't put in a dash if the echo buffer is empty, so
8926 you don't always see a dash hanging out in the minibuffer. */
8930 /* Record the initial state of the echo area and this_command_keys;
8931 we will need to restore them if we replay a key sequence. */
8933 echo_start
= echo_length ();
8934 keys_start
= this_command_key_count
;
8935 this_single_command_key_start
= keys_start
;
8937 /* We jump here when we need to reinitialize fkey and keytran; this
8938 happens if we switch keyboards between rescans. */
8939 replay_entire_sequence
:
8941 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8942 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8943 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8944 indec
.start
= indec
.end
= 0;
8945 fkey
.start
= fkey
.end
= 0;
8946 keytran
.start
= keytran
.end
= 0;
8948 /* We jump here when the key sequence has been thoroughly changed, and
8949 we need to rescan it starting from the beginning. When we jump here,
8950 keybuf[0..mock_input] holds the sequence we should reread. */
8953 starting_buffer
= current_buffer
;
8954 first_unbound
= bufsize
+ 1;
8956 /* Build our list of keymaps.
8957 If we recognize a function key and replace its escape sequence in
8958 keybuf with its symbol, or if the sequence starts with a mouse
8959 click and we need to switch buffers, we jump back here to rebuild
8960 the initial keymaps from the current buffer. */
8961 current_binding
= active_maps (first_event
);
8963 /* Start from the beginning in keybuf. */
8966 /* These are no-ops the first time through, but if we restart, they
8967 revert the echo area and this_command_keys to their original state. */
8968 this_command_key_count
= keys_start
;
8969 if (INTERACTIVE
&& t
< mock_input
)
8970 echo_truncate (echo_start
);
8972 /* If the best binding for the current key sequence is a keymap, or
8973 we may be looking at a function key's escape sequence, keep on
8975 while (!NILP (current_binding
)
8976 /* Keep reading as long as there's a prefix binding. */
8977 ? KEYMAPP (current_binding
)
8978 /* Don't return in the middle of a possible function key sequence,
8979 if the only bindings we found were via case conversion.
8980 Thus, if ESC O a has a function-key-map translation
8981 and ESC o has a binding, don't return after ESC O,
8982 so that we can translate ESC O plus the next character. */
8983 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8986 bool used_mouse_menu
= 0;
8988 /* Where the last real key started. If we need to throw away a
8989 key that has expanded into more than one element of keybuf
8990 (say, a mouse click on the mode line which is being treated
8991 as [mode-line (mouse-...)], then we backtrack to this point
8993 int last_real_key_start
;
8995 /* These variables are analogous to echo_start and keys_start;
8996 while those allow us to restart the entire key sequence,
8997 echo_local_start and keys_local_start allow us to throw away
8999 ptrdiff_t echo_local_start
IF_LINT (= 0);
9000 int keys_local_start
;
9001 Lisp_Object new_binding
;
9003 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9004 eassert (indec
.start
<= indec
.end
);
9005 eassert (fkey
.start
<= fkey
.end
);
9006 eassert (keytran
.start
<= keytran
.end
);
9007 /* key-translation-map is applied *after* function-key-map
9008 which is itself applied *after* input-decode-map. */
9009 eassert (fkey
.end
<= indec
.start
);
9010 eassert (keytran
.end
<= fkey
.start
);
9012 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9013 first_unbound
< keytran
.start
)
9014 { /* The prefix upto first_unbound has no binding and has
9015 no translation left to do either, so we know it's unbound.
9016 If we don't stop now, we risk staying here indefinitely
9017 (if the user keeps entering fkey or keytran prefixes
9018 like C-c ESC ESC ESC ESC ...) */
9020 for (i
= first_unbound
+ 1; i
< t
; i
++)
9021 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9022 mock_input
= t
- first_unbound
- 1;
9023 indec
.end
= indec
.start
-= first_unbound
+ 1;
9024 indec
.map
= indec
.parent
;
9025 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9026 fkey
.map
= fkey
.parent
;
9027 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9028 keytran
.map
= keytran
.parent
;
9029 goto replay_sequence
;
9033 error ("Key sequence too long");
9036 echo_local_start
= echo_length ();
9037 keys_local_start
= this_command_key_count
;
9040 /* These are no-ops, unless we throw away a keystroke below and
9041 jumped back up to replay_key; in that case, these restore the
9042 variables to their original state, allowing us to replay the
9044 if (INTERACTIVE
&& t
< mock_input
)
9045 echo_truncate (echo_local_start
);
9046 this_command_key_count
= keys_local_start
;
9048 /* By default, assume each event is "real". */
9049 last_real_key_start
= t
;
9051 /* Does mock_input indicate that we are re-reading a key sequence? */
9055 add_command_key (key
);
9056 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9057 && NILP (Fzerop (Vecho_keystrokes
))
9058 && current_kboard
->immediate_echo
)
9065 /* If not, we should actually read a character. */
9069 KBOARD
*interrupted_kboard
= current_kboard
;
9070 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9071 key
= read_decoded_char (NILP (prompt
),
9072 current_binding
, last_nonmenu_event
,
9074 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9075 /* When switching to a new tty (with a new keyboard),
9076 read_char returns the new buffer, rather than -2
9077 (Bug#5095). This is because `terminal-init-xterm'
9078 calls read-char, which eats the wrong_kboard_jmpbuf
9079 return. Any better way to fix this? -- cyd */
9080 || (interrupted_kboard
!= current_kboard
))
9085 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9086 if (k
== interrupted_kboard
)
9091 /* Don't touch interrupted_kboard when it's been
9093 delayed_switch_frame
= Qnil
;
9094 goto replay_entire_sequence
;
9097 if (!NILP (delayed_switch_frame
))
9100 (interrupted_kboard
,
9101 Fcons (delayed_switch_frame
,
9102 KVAR (interrupted_kboard
, kbd_queue
)));
9103 delayed_switch_frame
= Qnil
;
9108 (interrupted_kboard
,
9109 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9111 /* If the side queue is non-empty, ensure it begins with a
9112 switch-frame, so we'll replay it in the right context. */
9113 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9114 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9115 !(EVENT_HAS_PARAMETERS (key
)
9116 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9120 XSETFRAME (frame
, interrupted_frame
);
9122 (interrupted_kboard
,
9123 Fcons (make_lispy_switch_frame (frame
),
9124 KVAR (interrupted_kboard
, kbd_queue
)));
9127 goto replay_entire_sequence
;
9131 /* read_char returns t when it shows a menu and the user rejects it.
9135 unbind_to (count
, Qnil
);
9140 /* read_char returns -1 at the end of a macro.
9141 Emacs 18 handles this by returning immediately with a
9142 zero, so that's what we'll do. */
9143 if (INTEGERP (key
) && XINT (key
) == -1)
9146 /* The Microsoft C compiler can't handle the goto that
9152 /* If the current buffer has been changed from under us, the
9153 keymap may have changed, so replay the sequence. */
9156 timer_resume_idle ();
9159 /* Reset the current buffer from the selected window
9160 in case something changed the former and not the latter.
9161 This is to be more consistent with the behavior
9162 of the command_loop_1. */
9163 if (fix_current_buffer
)
9165 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9167 if (XBUFFER (XWINDOW (selected_window
)->buffer
)
9169 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9172 goto replay_sequence
;
9175 /* If we have a quit that was typed in another frame, and
9176 quit_throw_to_read_char switched buffers,
9177 replay to get the right keymap. */
9179 && XINT (key
) == quit_char
9180 && current_buffer
!= starting_buffer
)
9183 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9188 goto replay_sequence
;
9193 if (EVENT_HAS_PARAMETERS (key
)
9194 /* Either a `switch-frame' or a `select-window' event. */
9195 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9197 /* If we're at the beginning of a key sequence, and the caller
9198 says it's okay, go ahead and return this event. If we're
9199 in the midst of a key sequence, delay it until the end. */
9200 if (t
> 0 || !can_return_switch_frame
)
9202 delayed_switch_frame
= key
;
9207 if (NILP (first_event
))
9210 /* Even if first_event does not specify a particular
9211 window/position, it's important to recompute the maps here
9212 since a long time might have passed since we entered
9213 read_key_sequence, and a timer (or process-filter or
9214 special-event-map, ...) might have switched the current buffer
9215 or the selected window from under us in the mean time. */
9216 if (fix_current_buffer
9217 && (XBUFFER (XWINDOW (selected_window
)->buffer
)
9219 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9220 current_binding
= active_maps (first_event
);
9224 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9228 /* Clicks in non-text areas get prefixed by the symbol
9229 in their CHAR-ADDRESS field. For example, a click on
9230 the mode line is prefixed by the symbol `mode-line'.
9232 Furthermore, key sequences beginning with mouse clicks
9233 are read using the keymaps of the buffer clicked on, not
9234 the current buffer. So we may have to switch the buffer
9237 When we turn one event into two events, we must make sure
9238 that neither of the two looks like the original--so that,
9239 if we replay the events, they won't be expanded again.
9240 If not for this, such reexpansion could happen either here
9241 or when user programs play with this-command-keys. */
9242 if (EVENT_HAS_PARAMETERS (key
))
9244 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9245 if (EQ (kind
, Qmouse_click
))
9247 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9248 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9251 || (!NILP (fake_prefixed_keys
)
9252 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9254 /* We're looking a second time at an event for which
9255 we generated a fake prefix key. Set
9256 last_real_key_start appropriately. */
9258 last_real_key_start
= t
- 1;
9261 if (last_real_key_start
== 0)
9263 /* Key sequences beginning with mouse clicks are
9264 read using the keymaps in the buffer clicked on,
9265 not the current buffer. If we're at the
9266 beginning of a key sequence, switch buffers. */
9267 if (WINDOWP (window
)
9268 && BUFFERP (XWINDOW (window
)->buffer
)
9269 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9271 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9276 /* Arrange to go back to the original buffer once we're
9277 done reading the key sequence. Note that we can't
9278 use save_excursion_{save,restore} here, because they
9279 save point as well as the current buffer; we don't
9280 want to save point, because redisplay may change it,
9281 to accommodate a Fset_window_start or something. We
9282 don't want to do this at the top of the function,
9283 because we may get input from a subprocess which
9284 wants to change the selected window and stuff (say,
9286 record_unwind_current_buffer ();
9288 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9290 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9291 goto replay_sequence
;
9295 /* Expand mode-line and scroll-bar events into two events:
9296 use posn as a fake prefix key. */
9298 && (NILP (fake_prefixed_keys
)
9299 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9301 if (bufsize
- t
<= 1)
9302 error ("Key sequence too long");
9305 keybuf
[t
+ 1] = key
;
9308 /* Record that a fake prefix key has been generated
9309 for KEY. Don't modify the event; this would
9310 prevent proper action when the event is pushed
9311 back into unread-command-events. */
9312 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9316 else if (CONSP (XCDR (key
))
9317 && CONSP (EVENT_START (key
))
9318 && CONSP (XCDR (EVENT_START (key
))))
9322 posn
= POSN_POSN (EVENT_START (key
));
9323 /* Handle menu-bar events:
9324 insert the dummy prefix event `menu-bar'. */
9325 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9327 if (bufsize
- t
<= 1)
9328 error ("Key sequence too long");
9330 keybuf
[t
+ 1] = key
;
9332 /* Zap the position in key, so we know that we've
9333 expanded it, and don't try to do so again. */
9334 POSN_SET_POSN (EVENT_START (key
),
9335 Fcons (posn
, Qnil
));
9338 goto replay_sequence
;
9340 else if (CONSP (posn
))
9342 /* We're looking at the second event of a
9343 sequence which we expanded before. Set
9344 last_real_key_start appropriately. */
9345 if (last_real_key_start
== t
&& t
> 0)
9346 last_real_key_start
= t
- 1;
9351 /* We have finally decided that KEY is something we might want
9353 new_binding
= follow_key (current_binding
, key
);
9355 /* If KEY wasn't bound, we'll try some fallbacks. */
9356 if (!NILP (new_binding
))
9357 /* This is needed for the following scenario:
9358 event 0: a down-event that gets dropped by calling replay_key.
9359 event 1: some normal prefix like C-h.
9360 After event 0, first_unbound is 0, after event 1 indec.start,
9361 fkey.start, and keytran.start are all 1, so when we see that
9362 C-h is bound, we need to update first_unbound. */
9363 first_unbound
= max (t
+ 1, first_unbound
);
9368 /* Remember the position to put an upper bound on indec.start. */
9369 first_unbound
= min (t
, first_unbound
);
9371 head
= EVENT_HEAD (key
);
9372 if (help_char_p (head
) && t
> 0)
9374 read_key_sequence_cmd
= Vprefix_help_command
;
9376 last_nonmenu_event
= key
;
9377 /* The Microsoft C compiler can't handle the goto that
9385 Lisp_Object breakdown
;
9388 breakdown
= parse_modifiers (head
);
9389 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9390 /* Attempt to reduce an unbound mouse event to a simpler
9391 event that is bound:
9392 Drags reduce to clicks.
9393 Double-clicks reduce to clicks.
9394 Triple-clicks reduce to double-clicks, then to clicks.
9395 Down-clicks are eliminated.
9396 Double-downs reduce to downs, then are eliminated.
9397 Triple-downs reduce to double-downs, then to downs,
9398 then are eliminated. */
9399 if (modifiers
& (down_modifier
| drag_modifier
9400 | double_modifier
| triple_modifier
))
9402 while (modifiers
& (down_modifier
| drag_modifier
9403 | double_modifier
| triple_modifier
))
9405 Lisp_Object new_head
, new_click
;
9406 if (modifiers
& triple_modifier
)
9407 modifiers
^= (double_modifier
| triple_modifier
);
9408 else if (modifiers
& double_modifier
)
9409 modifiers
&= ~double_modifier
;
9410 else if (modifiers
& drag_modifier
)
9411 modifiers
&= ~drag_modifier
;
9414 /* Dispose of this `down' event by simply jumping
9415 back to replay_key, to get another event.
9417 Note that if this event came from mock input,
9418 then just jumping back to replay_key will just
9419 hand it to us again. So we have to wipe out any
9422 We could delete keybuf[t] and shift everything
9423 after that to the left by one spot, but we'd also
9424 have to fix up any variable that points into
9425 keybuf, and shifting isn't really necessary
9428 Adding prefixes for non-textual mouse clicks
9429 creates two characters of mock input, and both
9430 must be thrown away. If we're only looking at
9431 the prefix now, we can just jump back to
9432 replay_key. On the other hand, if we've already
9433 processed the prefix, and now the actual click
9434 itself is giving us trouble, then we've lost the
9435 state of the keymaps we want to backtrack to, and
9436 we need to replay the whole sequence to rebuild
9439 Beyond that, only function key expansion could
9440 create more than two keys, but that should never
9441 generate mouse events, so it's okay to zero
9442 mock_input in that case too.
9444 FIXME: The above paragraph seems just plain
9445 wrong, if you consider things like
9446 xterm-mouse-mode. -stef
9448 Isn't this just the most wonderful code ever? */
9450 /* If mock_input > t + 1, the above simplification
9451 will actually end up dropping keys on the floor.
9452 This is probably OK for now, but even
9453 if mock_input <= t + 1, we need to adjust indec,
9455 Typical case [header-line down-mouse-N]:
9456 mock_input = 2, t = 1, fkey.end = 1,
9457 last_real_key_start = 0. */
9458 if (indec
.end
> last_real_key_start
)
9460 indec
.end
= indec
.start
9461 = min (last_real_key_start
, indec
.start
);
9462 indec
.map
= indec
.parent
;
9463 if (fkey
.end
> last_real_key_start
)
9465 fkey
.end
= fkey
.start
9466 = min (last_real_key_start
, fkey
.start
);
9467 fkey
.map
= fkey
.parent
;
9468 if (keytran
.end
> last_real_key_start
)
9470 keytran
.end
= keytran
.start
9471 = min (last_real_key_start
, keytran
.start
);
9472 keytran
.map
= keytran
.parent
;
9476 if (t
== last_real_key_start
)
9483 mock_input
= last_real_key_start
;
9484 goto replay_sequence
;
9489 = apply_modifiers (modifiers
, XCAR (breakdown
));
9491 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9493 /* Look for a binding for this new key. */
9494 new_binding
= follow_key (current_binding
, new_click
);
9496 /* If that click is bound, go for it. */
9497 if (!NILP (new_binding
))
9499 current_binding
= new_binding
;
9503 /* Otherwise, we'll leave key set to the drag event. */
9508 current_binding
= new_binding
;
9511 /* Normally, last_nonmenu_event gets the previous key we read.
9512 But when a mouse popup menu is being used,
9513 we don't update last_nonmenu_event; it continues to hold the mouse
9514 event that preceded the first level of menu. */
9515 if (!used_mouse_menu
)
9516 last_nonmenu_event
= key
;
9518 /* Record what part of this_command_keys is the current key sequence. */
9519 this_single_command_key_start
= this_command_key_count
- t
;
9521 /* Look for this sequence in input-decode-map.
9522 Scan from indec.end until we find a bound suffix. */
9523 while (indec
.end
< t
)
9525 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9529 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9530 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9535 mock_input
= diff
+ max (t
, mock_input
);
9536 goto replay_sequence
;
9540 if (!KEYMAPP (current_binding
)
9541 && !test_undefined (current_binding
)
9542 && indec
.start
>= t
)
9543 /* There is a binding and it's not a prefix.
9544 (and it doesn't have any input-decode-map translation pending).
9545 There is thus no function-key in this sequence.
9546 Moving fkey.start is important in this case to allow keytran.start
9547 to go over the sequence before we return (since we keep the
9548 invariant that keytran.end <= fkey.start). */
9551 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9554 /* If the sequence is unbound, see if we can hang a function key
9555 off the end of it. */
9556 /* Continue scan from fkey.end until we find a bound suffix. */
9557 while (fkey
.end
< indec
.start
)
9559 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9563 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9564 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9565 max (t
, mock_input
),
9566 /* If there's a binding (i.e.
9567 first_binding >= nmaps) we don't want
9568 to apply this function-key-mapping. */
9570 && (test_undefined (current_binding
)),
9575 mock_input
= diff
+ max (t
, mock_input
);
9576 /* Adjust the input-decode-map counters. */
9578 indec
.start
+= diff
;
9580 goto replay_sequence
;
9584 /* Look for this sequence in key-translation-map.
9585 Scan from keytran.end until we find a bound suffix. */
9586 while (keytran
.end
< fkey
.start
)
9588 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9592 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9593 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9598 mock_input
= diff
+ max (t
, mock_input
);
9599 /* Adjust the function-key-map and input-decode-map counters. */
9601 indec
.start
+= diff
;
9605 goto replay_sequence
;
9609 /* If KEY is not defined in any of the keymaps,
9610 and cannot be part of a function key or translation,
9611 and is an upper case letter
9612 use the corresponding lower-case letter instead. */
9613 if (NILP (current_binding
)
9614 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9616 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9617 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9618 || (XINT (key
) & shift_modifier
)))
9620 Lisp_Object new_key
;
9622 original_uppercase
= key
;
9623 original_uppercase_position
= t
- 1;
9625 if (XINT (key
) & shift_modifier
)
9626 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9628 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9629 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9631 /* We have to do this unconditionally, regardless of whether
9632 the lower-case char is defined in the keymaps, because they
9633 might get translated through function-key-map. */
9634 keybuf
[t
- 1] = new_key
;
9635 mock_input
= max (t
, mock_input
);
9636 shift_translated
= 1;
9638 goto replay_sequence
;
9640 /* If KEY is not defined in any of the keymaps,
9641 and cannot be part of a function key or translation,
9642 and is a shifted function key,
9643 use the corresponding unshifted function key instead. */
9644 if (NILP (current_binding
)
9645 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9647 Lisp_Object breakdown
= parse_modifiers (key
);
9649 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9651 if (modifiers
& shift_modifier
9652 /* Treat uppercase keys as shifted. */
9654 && (KEY_TO_CHAR (key
)
9655 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9656 && uppercasep (KEY_TO_CHAR (key
))))
9659 = (modifiers
& shift_modifier
9660 ? apply_modifiers (modifiers
& ~shift_modifier
,
9662 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9664 original_uppercase
= key
;
9665 original_uppercase_position
= t
- 1;
9667 /* We have to do this unconditionally, regardless of whether
9668 the lower-case char is defined in the keymaps, because they
9669 might get translated through function-key-map. */
9670 keybuf
[t
- 1] = new_key
;
9671 mock_input
= max (t
, mock_input
);
9672 /* Reset fkey (and consequently keytran) to apply
9673 function-key-map on the result, so that S-backspace is
9674 correctly mapped to DEL (via backspace). OTOH,
9675 input-decode-map doesn't need to go through it again. */
9676 fkey
.start
= fkey
.end
= 0;
9677 keytran
.start
= keytran
.end
= 0;
9678 shift_translated
= 1;
9680 goto replay_sequence
;
9685 read_key_sequence_cmd
= current_binding
;
9686 read_key_sequence_remapped
9687 /* Remap command through active keymaps.
9688 Do the remapping here, before the unbind_to so it uses the keymaps
9689 of the appropriate buffer. */
9690 = SYMBOLP (read_key_sequence_cmd
)
9691 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9694 unread_switch_frame
= delayed_switch_frame
;
9695 unbind_to (count
, Qnil
);
9697 /* Don't downcase the last character if the caller says don't.
9698 Don't downcase it if the result is undefined, either. */
9699 if ((dont_downcase_last
|| NILP (current_binding
))
9701 && t
- 1 == original_uppercase_position
)
9703 keybuf
[t
- 1] = original_uppercase
;
9704 shift_translated
= 0;
9707 if (shift_translated
)
9708 Vthis_command_keys_shift_translated
= Qt
;
9710 /* Occasionally we fabricate events, perhaps by expanding something
9711 according to function-key-map, or by adding a prefix symbol to a
9712 mouse click in the scroll bar or modeline. In this cases, return
9713 the entire generated key sequence, even if we hit an unbound
9714 prefix or a definition before the end. This means that you will
9715 be able to push back the event properly, and also means that
9716 read-key-sequence will always return a logical unit.
9719 for (; t
< mock_input
; t
++)
9721 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9722 && NILP (Fzerop (Vecho_keystrokes
)))
9723 echo_char (keybuf
[t
]);
9724 add_command_key (keybuf
[t
]);
9731 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9732 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9733 The sequence is sufficient to specify a non-prefix command in the
9734 current local and global maps.
9736 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9737 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9738 as a continuation of the previous key.
9740 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9741 convert the last event to lower case. (Normally any upper case event
9742 is converted to lower case if the original event is undefined and the lower
9743 case equivalent is defined.) A non-nil value is appropriate for reading
9744 a key sequence to be defined.
9746 A C-g typed while in this function is treated like any other character,
9747 and `quit-flag' is not set.
9749 If the key sequence starts with a mouse click, then the sequence is read
9750 using the keymaps of the buffer of the window clicked in, not the buffer
9751 of the selected window as normal.
9753 `read-key-sequence' drops unbound button-down events, since you normally
9754 only care about the click or drag events which follow them. If a drag
9755 or multi-click event is unbound, but the corresponding click event would
9756 be bound, `read-key-sequence' turns the event into a click event at the
9757 drag's starting position. This means that you don't have to distinguish
9758 between click and drag, double, or triple events unless you want to.
9760 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9761 lines separating windows, and scroll bars with imaginary keys
9762 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9764 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9765 function will process a switch-frame event if the user switches frames
9766 before typing anything. If the user switches frames in the middle of a
9767 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9768 is nil, then the event will be put off until after the current key sequence.
9770 `read-key-sequence' checks `function-key-map' for function key
9771 sequences, where they wouldn't conflict with ordinary bindings. See
9772 `function-key-map' for more details.
9774 The optional fifth argument CMD-LOOP, if non-nil, means
9775 that this key sequence is being read by something that will
9776 read commands one after another. It should be nil if the caller
9777 will read just one key sequence. */)
9778 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9780 Lisp_Object keybuf
[30];
9782 struct gcpro gcpro1
;
9783 ptrdiff_t count
= SPECPDL_INDEX ();
9786 CHECK_STRING (prompt
);
9789 specbind (Qinput_method_exit_on_first_char
,
9790 (NILP (cmd_loop
) ? Qt
: Qnil
));
9791 specbind (Qinput_method_use_echo_area
,
9792 (NILP (cmd_loop
) ? Qt
: Qnil
));
9794 memset (keybuf
, 0, sizeof keybuf
);
9796 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9798 if (NILP (continue_echo
))
9800 this_command_key_count
= 0;
9801 this_command_key_count_reset
= 0;
9802 this_single_command_key_start
= 0;
9805 #ifdef HAVE_WINDOW_SYSTEM
9806 if (display_hourglass_p
)
9807 cancel_hourglass ();
9810 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9811 prompt
, ! NILP (dont_downcase_last
),
9812 ! NILP (can_return_switch_frame
), 0);
9814 #if 0 /* The following is fine for code reading a key sequence and
9815 then proceeding with a lengthy computation, but it's not good
9816 for code reading keys in a loop, like an input method. */
9817 #ifdef HAVE_WINDOW_SYSTEM
9818 if (display_hourglass_p
)
9829 return unbind_to (count
, make_event_array (i
, keybuf
));
9832 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9833 Sread_key_sequence_vector
, 1, 5, 0,
9834 doc
: /* Like `read-key-sequence' but always return a vector. */)
9835 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9837 Lisp_Object keybuf
[30];
9839 struct gcpro gcpro1
;
9840 ptrdiff_t count
= SPECPDL_INDEX ();
9843 CHECK_STRING (prompt
);
9846 specbind (Qinput_method_exit_on_first_char
,
9847 (NILP (cmd_loop
) ? Qt
: Qnil
));
9848 specbind (Qinput_method_use_echo_area
,
9849 (NILP (cmd_loop
) ? Qt
: Qnil
));
9851 memset (keybuf
, 0, sizeof keybuf
);
9853 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9855 if (NILP (continue_echo
))
9857 this_command_key_count
= 0;
9858 this_command_key_count_reset
= 0;
9859 this_single_command_key_start
= 0;
9862 #ifdef HAVE_WINDOW_SYSTEM
9863 if (display_hourglass_p
)
9864 cancel_hourglass ();
9867 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9868 prompt
, ! NILP (dont_downcase_last
),
9869 ! NILP (can_return_switch_frame
), 0);
9871 #ifdef HAVE_WINDOW_SYSTEM
9872 if (display_hourglass_p
)
9882 return unbind_to (count
, Fvector (i
, keybuf
));
9885 /* Return true if input events are pending. */
9888 detect_input_pending (void)
9890 return input_pending
|| get_input_pending (0);
9893 /* Return true if input events other than mouse movements are
9897 detect_input_pending_ignore_squeezables (void)
9899 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9902 /* Return true if input events are pending, and run any pending timers. */
9905 detect_input_pending_run_timers (bool do_display
)
9907 unsigned old_timers_run
= timers_run
;
9910 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9912 if (old_timers_run
!= timers_run
&& do_display
)
9914 redisplay_preserve_echo_area (8);
9915 /* The following fixes a bug when using lazy-lock with
9916 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9917 from an idle timer function. The symptom of the bug is that
9918 the cursor sometimes doesn't become visible until the next X
9919 event is processed. --gerd. */
9921 Lisp_Object tail
, frame
;
9922 FOR_EACH_FRAME (tail
, frame
)
9923 if (FRAME_RIF (XFRAME (frame
)))
9924 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
9928 return input_pending
;
9931 /* This is called in some cases before a possible quit.
9932 It cases the next call to detect_input_pending to recompute input_pending.
9933 So calling this function unnecessarily can't do any harm. */
9936 clear_input_pending (void)
9941 /* Return true if there are pending requeued events.
9942 This isn't used yet. The hope is to make wait_reading_process_output
9943 call it, and return if it runs Lisp code that unreads something.
9944 The problem is, kbd_buffer_get_event needs to be fixed to know what
9945 to do in that case. It isn't trivial. */
9948 requeued_events_pending_p (void)
9950 return (!NILP (Vunread_command_events
));
9954 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9955 doc
: /* Return t if command input is currently available with no wait.
9956 Actually, the value is nil only if we can be sure that no input is available;
9957 if there is a doubt, the value is t. */)
9960 if (!NILP (Vunread_command_events
)
9961 || !NILP (Vunread_post_input_method_events
)
9962 || !NILP (Vunread_input_method_events
))
9965 /* Process non-user-visible events (Bug#10195). */
9966 process_special_events ();
9968 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
9969 | READABLE_EVENTS_FILTER_EVENTS
)
9973 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9974 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9977 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9980 if (total_keys
< NUM_RECENT_KEYS
)
9981 return Fvector (total_keys
, keys
);
9984 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9985 vcopy (val
, 0, keys
+ recent_keys_index
,
9986 NUM_RECENT_KEYS
- recent_keys_index
);
9987 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9988 keys
, recent_keys_index
);
9993 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9994 doc
: /* Return the key sequence that invoked this command.
9995 However, if the command has called `read-key-sequence', it returns
9996 the last key sequence that has been read.
9997 The value is a string or a vector.
9999 See also `this-command-keys-vector'. */)
10002 return make_event_array (this_command_key_count
,
10003 XVECTOR (this_command_keys
)->contents
);
10006 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10007 doc
: /* Return the key sequence that invoked this command, as a vector.
10008 However, if the command has called `read-key-sequence', it returns
10009 the last key sequence that has been read.
10011 See also `this-command-keys'. */)
10014 return Fvector (this_command_key_count
,
10015 XVECTOR (this_command_keys
)->contents
);
10018 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10019 Sthis_single_command_keys
, 0, 0, 0,
10020 doc
: /* Return the key sequence that invoked this command.
10021 More generally, it returns the last key sequence read, either by
10022 the command loop or by `read-key-sequence'.
10023 Unlike `this-command-keys', this function's value
10024 does not include prefix arguments.
10025 The value is always a vector. */)
10028 return Fvector (this_command_key_count
10029 - this_single_command_key_start
,
10030 (XVECTOR (this_command_keys
)->contents
10031 + this_single_command_key_start
));
10034 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10035 Sthis_single_command_raw_keys
, 0, 0, 0,
10036 doc
: /* Return the raw events that were read for this command.
10037 More generally, it returns the last key sequence read, either by
10038 the command loop or by `read-key-sequence'.
10039 Unlike `this-single-command-keys', this function's value
10040 shows the events before all translations (except for input methods).
10041 The value is always a vector. */)
10044 return Fvector (raw_keybuf_count
,
10045 (XVECTOR (raw_keybuf
)->contents
));
10048 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10049 Sreset_this_command_lengths
, 0, 0, 0,
10050 doc
: /* Make the unread events replace the last command and echo.
10051 Used in `universal-argument-other-key'.
10053 `universal-argument-other-key' rereads the event just typed.
10054 It then gets translated through `function-key-map'.
10055 The translated event has to replace the real events,
10056 both in the value of (this-command-keys) and in echoing.
10057 To achieve this, `universal-argument-other-key' calls
10058 `reset-this-command-lengths', which discards the record of reading
10059 these events the first time. */)
10062 this_command_key_count
= before_command_key_count
;
10063 if (this_command_key_count
< this_single_command_key_start
)
10064 this_single_command_key_start
= this_command_key_count
;
10066 echo_truncate (before_command_echo_length
);
10068 /* Cause whatever we put into unread-command-events
10069 to echo as if it were being freshly read from the keyboard. */
10070 this_command_key_count_reset
= 1;
10075 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10076 Sclear_this_command_keys
, 0, 1, 0,
10077 doc
: /* Clear out the vector that `this-command-keys' returns.
10078 Also clear the record of the last 100 events, unless optional arg
10079 KEEP-RECORD is non-nil. */)
10080 (Lisp_Object keep_record
)
10084 this_command_key_count
= 0;
10085 this_command_key_count_reset
= 0;
10087 if (NILP (keep_record
))
10089 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10090 ASET (recent_keys
, i
, Qnil
);
10092 recent_keys_index
= 0;
10097 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10098 doc
: /* Return the current depth in recursive edits. */)
10102 /* Wrap around reliably on integer overflow. */
10103 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10104 XSETINT (temp
, sum
);
10108 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10109 "FOpen dribble file: ",
10110 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10111 If FILE is nil, close any open dribble file.
10112 The file will be closed when Emacs exits. */)
10124 file
= Fexpand_file_name (file
, Qnil
);
10125 dribble
= fopen (SSDATA (file
), "w");
10127 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10132 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10133 doc
: /* Discard the contents of the terminal input buffer.
10134 Also end any kbd macro being defined. */)
10137 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10139 /* Discard the last command from the macro. */
10140 Fcancel_kbd_macro_events ();
10144 update_mode_lines
++;
10146 Vunread_command_events
= Qnil
;
10148 discard_tty_input ();
10150 kbd_fetch_ptr
= kbd_store_ptr
;
10156 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10157 doc
: /* Stop Emacs and return to superior process. You can resume later.
10158 If `cannot-suspend' is non-nil, or if the system doesn't support job
10159 control, run a subshell instead.
10161 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10162 to be read as terminal input by Emacs's parent, after suspension.
10164 Before suspending, run the normal hook `suspend-hook'.
10165 After resumption run the normal hook `suspend-resume-hook'.
10167 Some operating systems cannot stop the Emacs process and resume it later.
10168 On such systems, Emacs starts a subshell instead of suspending. */)
10169 (Lisp_Object stuffstring
)
10171 ptrdiff_t count
= SPECPDL_INDEX ();
10172 int old_height
, old_width
;
10174 struct gcpro gcpro1
;
10177 if (tty_list
&& tty_list
->next
)
10178 error ("There are other tty frames open; close them before suspending Emacs");
10180 if (!NILP (stuffstring
))
10181 CHECK_STRING (stuffstring
);
10183 /* Run the functions in suspend-hook. */
10184 hook
= intern ("suspend-hook");
10185 Frun_hooks (1, &hook
);
10187 GCPRO1 (stuffstring
);
10188 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10189 reset_all_sys_modes ();
10190 /* sys_suspend can get an error if it tries to fork a subshell
10191 and the system resources aren't available for that. */
10192 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10194 stuff_buffered_input (stuffstring
);
10195 if (cannot_suspend
)
10199 unbind_to (count
, Qnil
);
10201 /* Check if terminal/window size has changed.
10202 Note that this is not useful when we are running directly
10203 with a window system; but suspend should be disabled in that case. */
10204 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10205 if (width
!= old_width
|| height
!= old_height
)
10206 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10208 /* Run suspend-resume-hook. */
10209 hook
= intern ("suspend-resume-hook");
10210 Frun_hooks (1, &hook
);
10216 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10217 Then in any case stuff anything Emacs has read ahead and not used. */
10220 stuff_buffered_input (Lisp_Object stuffstring
)
10222 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10223 register unsigned char *p
;
10225 if (STRINGP (stuffstring
))
10227 register ptrdiff_t count
;
10229 p
= SDATA (stuffstring
);
10230 count
= SBYTES (stuffstring
);
10231 while (count
-- > 0)
10236 /* Anything we have read ahead, put back for the shell to read. */
10237 /* ?? What should this do when we have multiple keyboards??
10238 Should we ignore anything that was typed in at the "wrong" kboard?
10240 rms: we should stuff everything back into the kboard
10242 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10245 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10246 kbd_fetch_ptr
= kbd_buffer
;
10247 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10248 stuff_char (kbd_fetch_ptr
->code
);
10250 clear_event (kbd_fetch_ptr
);
10254 #endif /* SIGTSTP */
10258 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10260 input_available_clear_time
= time_to_clear
;
10262 /* Tell handle_interrupt to throw back to read_char, */
10263 waiting_for_input
= 1;
10265 /* If handle_interrupt was called before and buffered a C-g,
10266 make it run again now, to avoid timing error. */
10267 if (!NILP (Vquit_flag
))
10268 quit_throw_to_read_char (0);
10272 clear_waiting_for_input (void)
10274 /* Tell handle_interrupt not to throw back to read_char, */
10275 waiting_for_input
= 0;
10276 input_available_clear_time
= 0;
10279 /* The SIGINT handler.
10281 If we have a frame on the controlling tty, we assume that the
10282 SIGINT was generated by C-g, so we call handle_interrupt.
10283 Otherwise, tell QUIT to kill Emacs. */
10286 handle_interrupt_signal (int sig
)
10288 /* See if we have an active terminal on our controlling tty. */
10289 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10292 /* If there are no frames there, let's pretend that we are a
10293 well-behaving UN*X program and quit. We must not call Lisp
10294 in a signal handler, so tell QUIT to exit when it is
10296 Vquit_flag
= Qkill_emacs
;
10300 /* Otherwise, the SIGINT was probably generated by C-g. */
10302 /* Set internal_last_event_frame to the top frame of the
10303 controlling tty, if we have a frame there. We disable the
10304 interrupt key on secondary ttys, so the SIGINT must have come
10305 from the controlling tty. */
10306 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10308 handle_interrupt (1);
10313 deliver_interrupt_signal (int sig
)
10315 deliver_process_signal (sig
, handle_interrupt_signal
);
10319 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10320 of the number of times C-g has been requested. If C-g is pressed
10321 enough times, then quit anyway. See bug#6585. */
10322 static int volatile force_quit_count
;
10324 /* This routine is called at interrupt level in response to C-g.
10326 It is called from the SIGINT handler or kbd_buffer_store_event.
10328 If `waiting_for_input' is non zero, then unless `echoing' is
10329 nonzero, immediately throw back to read_char.
10331 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10332 eval to throw, when it gets a chance. If quit-flag is already
10333 non-nil, it stops the job right away. */
10336 handle_interrupt (bool in_signal_handler
)
10342 /* XXX This code needs to be revised for multi-tty support. */
10343 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10345 if (! in_signal_handler
)
10347 /* If SIGINT isn't blocked, don't let us be interrupted by
10348 a SIGINT. It might be harmful due to non-reentrancy
10349 in I/O functions. */
10351 sigemptyset (&blocked
);
10352 sigaddset (&blocked
, SIGINT
);
10353 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10357 reset_all_sys_modes ();
10361 * On systems which can suspend the current process and return to the original
10362 * shell, this command causes the user to end up back at the shell.
10363 * The "Auto-save" and "Abort" questions are not asked until
10364 * the user elects to return to emacs, at which point he can save the current
10365 * job and either dump core or continue.
10369 /* Perhaps should really fork an inferior shell?
10370 But that would not provide any way to get back
10371 to the original shell, ever. */
10372 printf ("No support for stopping a process on this operating system;\n");
10373 printf ("you can continue or abort.\n");
10374 #endif /* not SIGTSTP */
10376 /* We must remain inside the screen area when the internal terminal
10377 is used. Note that [Enter] is not echoed by dos. */
10378 cursor_to (SELECTED_FRAME (), 0, 0);
10380 /* It doesn't work to autosave while GC is in progress;
10381 the code used for auto-saving doesn't cope with the mark bit. */
10382 if (!gc_in_progress
)
10384 printf ("Auto-save? (y or n) ");
10386 if (((c
= getchar ()) & ~040) == 'Y')
10388 Fdo_auto_save (Qt
, Qnil
);
10390 printf ("\r\nAuto-save done");
10391 #else /* not MSDOS */
10392 printf ("Auto-save done\n");
10393 #endif /* not MSDOS */
10395 while (c
!= '\n') c
= getchar ();
10399 /* During GC, it must be safe to reenable quitting again. */
10400 Vinhibit_quit
= Qnil
;
10403 #endif /* not MSDOS */
10404 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10405 printf ("but will instead do a real quit after garbage collection ends\r\n");
10410 printf ("\r\nAbort? (y or n) ");
10411 #else /* not MSDOS */
10412 printf ("Abort (and dump core)? (y or n) ");
10413 #endif /* not MSDOS */
10415 if (((c
= getchar ()) & ~040) == 'Y')
10417 while (c
!= '\n') c
= getchar ();
10419 printf ("\r\nContinuing...\r\n");
10420 #else /* not MSDOS */
10421 printf ("Continuing...\n");
10422 #endif /* not MSDOS */
10424 init_all_sys_modes ();
10428 /* If executing a function that wants to be interrupted out of
10429 and the user has not deferred quitting by binding `inhibit-quit'
10430 then quit right away. */
10431 if (immediate_quit
&& NILP (Vinhibit_quit
))
10433 struct gl_state_s saved
;
10434 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10436 immediate_quit
= 0;
10437 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10439 GCPRO4 (saved
.object
, saved
.global_code
,
10440 saved
.current_syntax_table
, saved
.old_prop
);
10441 Fsignal (Qquit
, Qnil
);
10446 { /* Else request quit when it's safe. */
10447 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10448 force_quit_count
= count
;
10451 immediate_quit
= 1;
10452 Vinhibit_quit
= Qnil
;
10458 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10460 /* TODO: The longjmp in this call throws the NS event loop integration off,
10461 and it seems to do fine without this. Probably some attention
10462 needs to be paid to the setting of waiting_for_input in
10463 wait_reading_process_output() under HAVE_NS because of the call
10464 to ns_select there (needed because otherwise events aren't picked up
10465 outside of polling since we don't get SIGIO like X and we don't have a
10466 separate event loop thread like W32. */
10468 if (waiting_for_input
&& !echoing
)
10469 quit_throw_to_read_char (in_signal_handler
);
10473 /* Handle a C-g by making read_char return C-g. */
10476 quit_throw_to_read_char (bool from_signal
)
10478 /* When not called from a signal handler it is safe to call
10480 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10481 Fkill_emacs (Qnil
);
10483 /* Prevent another signal from doing this before we finish. */
10484 clear_waiting_for_input ();
10487 Vunread_command_events
= Qnil
;
10489 if (FRAMEP (internal_last_event_frame
)
10490 && !EQ (internal_last_event_frame
, selected_frame
))
10491 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10494 sys_longjmp (getcjmp
, 1);
10497 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10498 Sset_input_interrupt_mode
, 1, 1, 0,
10499 doc
: /* Set interrupt mode of reading keyboard input.
10500 If INTERRUPT is non-nil, Emacs will use input interrupts;
10501 otherwise Emacs uses CBREAK mode.
10503 See also `current-input-mode'. */)
10504 (Lisp_Object interrupt
)
10506 bool new_interrupt_input
;
10507 #ifdef USABLE_SIGIO
10508 #ifdef HAVE_X_WINDOWS
10509 if (x_display_list
!= NULL
)
10511 /* When using X, don't give the user a real choice,
10512 because we haven't implemented the mechanisms to support it. */
10513 new_interrupt_input
= 1;
10516 #endif /* HAVE_X_WINDOWS */
10517 new_interrupt_input
= !NILP (interrupt
);
10518 #else /* not USABLE_SIGIO */
10519 new_interrupt_input
= 0;
10520 #endif /* not USABLE_SIGIO */
10522 if (new_interrupt_input
!= interrupt_input
)
10524 #ifdef POLL_FOR_INPUT
10528 /* this causes startup screen to be restored and messes with the mouse */
10529 reset_all_sys_modes ();
10530 interrupt_input
= new_interrupt_input
;
10531 init_all_sys_modes ();
10533 interrupt_input
= new_interrupt_input
;
10536 #ifdef POLL_FOR_INPUT
10537 poll_suppress_count
= 1;
10544 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10545 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10546 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10547 C-q in key sequences.
10549 This setting only has an effect on tty terminals and only when
10550 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10552 See also `current-input-mode'. */)
10553 (Lisp_Object flow
, Lisp_Object terminal
)
10555 struct terminal
*t
= get_terminal (terminal
, 1);
10556 struct tty_display_info
*tty
;
10557 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10559 tty
= t
->display_info
.tty
;
10561 if (tty
->flow_control
!= !NILP (flow
))
10564 /* This causes startup screen to be restored and messes with the mouse. */
10565 reset_sys_modes (tty
);
10568 tty
->flow_control
= !NILP (flow
);
10571 init_sys_modes (tty
);
10577 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10578 doc
: /* Enable or disable 8-bit input on TERMINAL.
10579 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10580 bit as the Meta modifier.
10582 If META is nil, Emacs will ignore the top bit, on the assumption it is
10585 Otherwise, Emacs will accept and pass through 8-bit input without
10586 specially interpreting the top bit.
10588 This setting only has an effect on tty terminal devices.
10590 Optional parameter TERMINAL specifies the tty terminal device to use.
10591 It may be a terminal object, a frame, or nil for the terminal used by
10592 the currently selected frame.
10594 See also `current-input-mode'. */)
10595 (Lisp_Object meta
, Lisp_Object terminal
)
10597 struct terminal
*t
= get_terminal (terminal
, 1);
10598 struct tty_display_info
*tty
;
10601 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10603 tty
= t
->display_info
.tty
;
10607 else if (EQ (meta
, Qt
))
10612 if (tty
->meta_key
!= new_meta
)
10615 /* this causes startup screen to be restored and messes with the mouse */
10616 reset_sys_modes (tty
);
10619 tty
->meta_key
= new_meta
;
10622 init_sys_modes (tty
);
10628 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10629 doc
: /* Specify character used for quitting.
10630 QUIT must be an ASCII character.
10632 This function only has an effect on the controlling tty of the Emacs
10635 See also `current-input-mode'. */)
10638 struct terminal
*t
= get_named_tty ("/dev/tty");
10639 struct tty_display_info
*tty
;
10640 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10642 tty
= t
->display_info
.tty
;
10644 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10645 error ("QUIT must be an ASCII character");
10648 /* this causes startup screen to be restored and messes with the mouse */
10649 reset_sys_modes (tty
);
10652 /* Don't let this value be out of range. */
10653 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10656 init_sys_modes (tty
);
10662 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10663 doc
: /* Set mode of reading keyboard input.
10664 First arg INTERRUPT non-nil means use input interrupts;
10665 nil means use CBREAK mode.
10666 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10667 (no effect except in CBREAK mode).
10668 Third arg META t means accept 8-bit input (for a Meta key).
10669 META nil means ignore the top bit, on the assumption it is parity.
10670 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10671 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10672 See also `current-input-mode'. */)
10673 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10675 Fset_input_interrupt_mode (interrupt
);
10676 Fset_output_flow_control (flow
, Qnil
);
10677 Fset_input_meta_mode (meta
, Qnil
);
10679 Fset_quit_char (quit
);
10683 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10684 doc
: /* Return information about the way Emacs currently reads keyboard input.
10685 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10686 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10687 nil, Emacs is using CBREAK mode.
10688 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10689 terminal; this does not apply if Emacs uses interrupt-driven input.
10690 META is t if accepting 8-bit input with 8th bit as Meta flag.
10691 META nil means ignoring the top bit, on the assumption it is parity.
10692 META is neither t nor nil if accepting 8-bit input and using
10693 all 8 bits as the character code.
10694 QUIT is the character Emacs currently uses to quit.
10695 The elements of this list correspond to the arguments of
10696 `set-input-mode'. */)
10699 Lisp_Object val
[4];
10700 struct frame
*sf
= XFRAME (selected_frame
);
10702 val
[0] = interrupt_input
? Qt
: Qnil
;
10703 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10705 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10706 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10708 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10715 XSETFASTINT (val
[3], quit_char
);
10717 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10720 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10721 doc
: /* Return position information for pixel coordinates X and Y.
10722 By default, X and Y are relative to text area of the selected window.
10723 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10724 If optional fourth arg WHOLE is non-nil, X is relative to the left
10725 edge of the window.
10727 The return value is similar to a mouse click position:
10728 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10729 IMAGE (DX . DY) (WIDTH . HEIGHT))
10730 The `posn-' functions access elements of such lists. */)
10731 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10736 if (NILP (frame_or_window
))
10737 frame_or_window
= selected_window
;
10739 if (WINDOWP (frame_or_window
))
10741 struct window
*w
= decode_live_window (frame_or_window
);
10743 XSETINT (x
, (XINT (x
)
10744 + WINDOW_LEFT_EDGE_X (w
)
10746 ? window_box_left_offset (w
, TEXT_AREA
)
10748 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10749 frame_or_window
= w
->frame
;
10752 CHECK_LIVE_FRAME (frame_or_window
);
10754 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10757 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10758 doc
: /* Return position information for buffer POS in WINDOW.
10759 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10761 Return nil if position is not visible in window. Otherwise,
10762 the return value is similar to that returned by `event-start' for
10763 a mouse click at the upper left corner of the glyph corresponding
10764 to the given buffer position:
10765 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10766 IMAGE (DX . DY) (WIDTH . HEIGHT))
10767 The `posn-' functions access elements of such lists. */)
10768 (Lisp_Object pos
, Lisp_Object window
)
10773 window
= selected_window
;
10775 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10778 Lisp_Object x
= XCAR (tem
);
10779 Lisp_Object y
= XCAR (XCDR (tem
));
10781 /* Point invisible due to hscrolling? */
10784 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10792 * Set up a new kboard object with reasonable initial values.
10795 init_kboard (KBOARD
*kb
)
10797 kset_overriding_terminal_local_map (kb
, Qnil
);
10798 kset_last_command (kb
, Qnil
);
10799 kset_real_last_command (kb
, Qnil
);
10800 kset_keyboard_translate_table (kb
, Qnil
);
10801 kset_last_repeatable_command (kb
, Qnil
);
10802 kset_prefix_arg (kb
, Qnil
);
10803 kset_last_prefix_arg (kb
, Qnil
);
10804 kset_kbd_queue (kb
, Qnil
);
10805 kb
->kbd_queue_has_data
= 0;
10806 kb
->immediate_echo
= 0;
10807 kset_echo_string (kb
, Qnil
);
10808 kb
->echo_after_prompt
= -1;
10809 kb
->kbd_macro_buffer
= 0;
10810 kb
->kbd_macro_bufsize
= 0;
10811 kset_defining_kbd_macro (kb
, Qnil
);
10812 kset_last_kbd_macro (kb
, Qnil
);
10813 kb
->reference_count
= 0;
10814 kset_system_key_alist (kb
, Qnil
);
10815 kset_system_key_syms (kb
, Qnil
);
10816 kset_window_system (kb
, Qt
); /* Unset. */
10817 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10818 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10819 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10820 kset_default_minibuffer_frame (kb
, Qnil
);
10824 * Destroy the contents of a kboard object, but not the object itself.
10825 * We use this just before deleting it, or if we're going to initialize
10826 * it a second time.
10829 wipe_kboard (KBOARD
*kb
)
10831 xfree (kb
->kbd_macro_buffer
);
10834 /* Free KB and memory referenced from it. */
10837 delete_kboard (KBOARD
*kb
)
10841 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10844 *kbp
= kb
->next_kboard
;
10846 /* Prevent a dangling reference to KB. */
10847 if (kb
== current_kboard
10848 && FRAMEP (selected_frame
)
10849 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10851 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10853 if (current_kboard
== kb
)
10862 init_keyboard (void)
10864 /* This is correct before outermost invocation of the editor loop. */
10865 command_loop_level
= -1;
10866 immediate_quit
= 0;
10867 quit_char
= Ctl ('g');
10868 Vunread_command_events
= Qnil
;
10869 timer_idleness_start_time
= invalid_emacs_time ();
10871 recent_keys_index
= 0;
10872 kbd_fetch_ptr
= kbd_buffer
;
10873 kbd_store_ptr
= kbd_buffer
;
10874 do_mouse_tracking
= Qnil
;
10876 interrupt_input_blocked
= 0;
10877 pending_signals
= 0;
10879 /* This means that command_loop_1 won't try to select anything the first
10881 internal_last_event_frame
= Qnil
;
10882 Vlast_event_frame
= internal_last_event_frame
;
10884 current_kboard
= initial_kboard
;
10885 /* Re-initialize the keyboard again. */
10886 wipe_kboard (current_kboard
);
10887 init_kboard (current_kboard
);
10888 /* A value of nil for Vwindow_system normally means a tty, but we also use
10889 it for the initial terminal since there is no window system there. */
10890 kset_window_system (current_kboard
, Qnil
);
10892 if (!noninteractive
)
10894 /* Before multi-tty support, these handlers used to be installed
10895 only if the current session was a tty session. Now an Emacs
10896 session may have multiple display types, so we always handle
10897 SIGINT. There is special code in handle_interrupt_signal to exit
10898 Emacs on SIGINT when there are no termcap frames on the
10899 controlling terminal. */
10900 struct sigaction action
;
10901 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10902 sigaction (SIGINT
, &action
, 0);
10904 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10905 SIGQUIT and we can't tell which one it will give us. */
10906 sigaction (SIGQUIT
, &action
, 0);
10907 #endif /* not DOS_NT */
10909 #ifdef USABLE_SIGIO
10910 if (!noninteractive
)
10912 struct sigaction action
;
10913 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10914 sigaction (SIGIO
, &action
, 0);
10918 /* Use interrupt input by default, if it works and noninterrupt input
10919 has deficiencies. */
10921 #ifdef INTERRUPT_INPUT
10922 interrupt_input
= 1;
10924 interrupt_input
= 0;
10927 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10930 if (keyboard_init_hook
)
10931 (*keyboard_init_hook
) ();
10933 #ifdef POLL_FOR_INPUT
10935 poll_suppress_count
= 1;
10940 /* This type's only use is in syms_of_keyboard, to initialize the
10941 event header symbols and put properties on them. */
10942 struct event_head
{
10948 static const struct event_head head_table
[] = {
10949 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10950 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10951 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10952 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10953 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10954 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10955 /* `select-window' should be handled just like `switch-frame'
10956 in read_key_sequence. */
10957 {&Qselect_window
, "select-window", &Qswitch_frame
}
10961 syms_of_keyboard (void)
10963 pending_funcalls
= Qnil
;
10964 staticpro (&pending_funcalls
);
10966 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10967 staticpro (&Vlispy_mouse_stem
);
10970 DEFSYM (QCimage
, ":image");
10971 DEFSYM (Qhelp_echo
, "help-echo");
10972 DEFSYM (QCrtl
, ":rtl");
10974 staticpro (&item_properties
);
10975 item_properties
= Qnil
;
10977 staticpro (&tool_bar_item_properties
);
10978 tool_bar_item_properties
= Qnil
;
10979 staticpro (&tool_bar_items_vector
);
10980 tool_bar_items_vector
= Qnil
;
10982 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10983 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10984 DEFSYM (Qself_insert_command
, "self-insert-command");
10985 DEFSYM (Qforward_char
, "forward-char");
10986 DEFSYM (Qbackward_char
, "backward-char");
10987 DEFSYM (Qdisabled
, "disabled");
10988 DEFSYM (Qundefined
, "undefined");
10989 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10990 DEFSYM (Qpost_command_hook
, "post-command-hook");
10991 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10992 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10993 DEFSYM (Qfunction_key
, "function-key");
10994 DEFSYM (Qmouse_click
, "mouse-click");
10995 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10996 DEFSYM (Qsave_session
, "save-session");
10997 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10998 DEFSYM (Qmenu_enable
, "menu-enable");
11001 DEFSYM (Qlanguage_change
, "language-change");
11005 DEFSYM (Qfile_w32notify
, "file-w32notify");
11009 DEFSYM (Qdbus_event
, "dbus-event");
11012 #ifdef HAVE_XWIDGETS
11013 Qxwidget_event
= intern ("xwidget-event");
11014 staticpro (&Qxwidget_event
);
11015 #endif /* HAVE_XWIDGETS */
11016 #ifdef HAVE_INOTIFY
11017 DEFSYM (Qfile_inotify
, "file-inotify");
11018 #endif /* HAVE_INOTIFY */
11020 DEFSYM (QCenable
, ":enable");
11021 DEFSYM (QCvisible
, ":visible");
11022 DEFSYM (QChelp
, ":help");
11023 DEFSYM (QCfilter
, ":filter");
11024 DEFSYM (QCbutton
, ":button");
11025 DEFSYM (QCkeys
, ":keys");
11026 DEFSYM (QCkey_sequence
, ":key-sequence");
11027 DEFSYM (QCtoggle
, ":toggle");
11028 DEFSYM (QCradio
, ":radio");
11029 DEFSYM (QClabel
, ":label");
11030 DEFSYM (QCvert_only
, ":vert-only");
11032 DEFSYM (Qmode_line
, "mode-line");
11033 DEFSYM (Qvertical_line
, "vertical-line");
11034 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11035 DEFSYM (Qmenu_bar
, "menu-bar");
11037 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11039 DEFSYM (Qabove_handle
, "above-handle");
11040 DEFSYM (Qhandle
, "handle");
11041 DEFSYM (Qbelow_handle
, "below-handle");
11042 DEFSYM (Qup
, "up");
11043 DEFSYM (Qdown
, "down");
11044 DEFSYM (Qtop
, "top");
11045 DEFSYM (Qbottom
, "bottom");
11046 DEFSYM (Qend_scroll
, "end-scroll");
11047 DEFSYM (Qratio
, "ratio");
11049 DEFSYM (Qevent_kind
, "event-kind");
11050 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11051 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11052 DEFSYM (Qmodifier_cache
, "modifier-cache");
11054 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11055 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11057 DEFSYM (Qpolling_period
, "polling-period");
11059 DEFSYM (Qx_set_selection
, "x-set-selection");
11060 DEFSYM (QPRIMARY
, "PRIMARY");
11061 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11062 DEFSYM (Qhandle_select_window
, "handle-select-window");
11064 DEFSYM (Qinput_method_function
, "input-method-function");
11065 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11066 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11068 DEFSYM (Qhelp_form_show
, "help-form-show");
11070 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11071 Fset (Qinput_method_use_echo_area
, Qnil
);
11073 last_point_position_buffer
= Qnil
;
11074 last_point_position_window
= Qnil
;
11078 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11080 for (i
= 0; i
< len
; i
++)
11082 const struct event_head
*p
= &head_table
[i
];
11083 *p
->var
= intern_c_string (p
->name
);
11084 staticpro (p
->var
);
11085 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11086 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11090 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11091 staticpro (&button_down_location
);
11092 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11093 staticpro (&mouse_syms
);
11094 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11095 / sizeof (lispy_wheel_names
[0])),
11097 staticpro (&wheel_syms
);
11101 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11103 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11104 for (i
= 0; i
< len
; i
++)
11105 if (modifier_names
[i
])
11106 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11107 staticpro (&modifier_symbols
);
11110 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11111 staticpro (&recent_keys
);
11113 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11114 staticpro (&this_command_keys
);
11116 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11117 staticpro (&raw_keybuf
);
11119 DEFSYM (Qcommand_execute
, "command-execute");
11121 accent_key_syms
= Qnil
;
11122 staticpro (&accent_key_syms
);
11124 func_key_syms
= Qnil
;
11125 staticpro (&func_key_syms
);
11127 drag_n_drop_syms
= Qnil
;
11128 staticpro (&drag_n_drop_syms
);
11130 unread_switch_frame
= Qnil
;
11131 staticpro (&unread_switch_frame
);
11133 internal_last_event_frame
= Qnil
;
11134 staticpro (&internal_last_event_frame
);
11136 read_key_sequence_cmd
= Qnil
;
11137 staticpro (&read_key_sequence_cmd
);
11138 read_key_sequence_remapped
= Qnil
;
11139 staticpro (&read_key_sequence_remapped
);
11141 menu_bar_one_keymap_changed_items
= Qnil
;
11142 staticpro (&menu_bar_one_keymap_changed_items
);
11144 menu_bar_items_vector
= Qnil
;
11145 staticpro (&menu_bar_items_vector
);
11147 help_form_saved_window_configs
= Qnil
;
11148 staticpro (&help_form_saved_window_configs
);
11150 defsubr (&Scurrent_idle_time
);
11151 defsubr (&Sevent_symbol_parse_modifiers
);
11152 defsubr (&Sevent_convert_list
);
11153 defsubr (&Sread_key_sequence
);
11154 defsubr (&Sread_key_sequence_vector
);
11155 defsubr (&Srecursive_edit
);
11156 defsubr (&Strack_mouse
);
11157 defsubr (&Sinput_pending_p
);
11158 defsubr (&Srecent_keys
);
11159 defsubr (&Sthis_command_keys
);
11160 defsubr (&Sthis_command_keys_vector
);
11161 defsubr (&Sthis_single_command_keys
);
11162 defsubr (&Sthis_single_command_raw_keys
);
11163 defsubr (&Sreset_this_command_lengths
);
11164 defsubr (&Sclear_this_command_keys
);
11165 defsubr (&Ssuspend_emacs
);
11166 defsubr (&Sabort_recursive_edit
);
11167 defsubr (&Sexit_recursive_edit
);
11168 defsubr (&Srecursion_depth
);
11169 defsubr (&Stop_level
);
11170 defsubr (&Sdiscard_input
);
11171 defsubr (&Sopen_dribble_file
);
11172 defsubr (&Sset_input_interrupt_mode
);
11173 defsubr (&Sset_output_flow_control
);
11174 defsubr (&Sset_input_meta_mode
);
11175 defsubr (&Sset_quit_char
);
11176 defsubr (&Sset_input_mode
);
11177 defsubr (&Scurrent_input_mode
);
11178 defsubr (&Sposn_at_point
);
11179 defsubr (&Sposn_at_x_y
);
11181 DEFVAR_LISP ("last-command-event", last_command_event
,
11182 doc
: /* Last input event that was part of a command. */);
11184 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11185 doc
: /* Last input event in a command, except for mouse menu events.
11186 Mouse menus give back keys that don't look like mouse events;
11187 this variable holds the actual mouse event that led to the menu,
11188 so that you can determine whether the command was run by mouse or not. */);
11190 DEFVAR_LISP ("last-input-event", last_input_event
,
11191 doc
: /* Last input event. */);
11193 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11194 doc
: /* List of events to be read as the command input.
11195 These events are processed first, before actual keyboard input.
11196 Events read from this list are not normally added to `this-command-keys',
11197 as they will already have been added once as they were read for the first time.
11198 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11199 Vunread_command_events
= Qnil
;
11201 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11202 doc
: /* List of events to be processed as input by input methods.
11203 These events are processed before `unread-command-events'
11204 and actual keyboard input, but are not given to `input-method-function'. */);
11205 Vunread_post_input_method_events
= Qnil
;
11207 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11208 doc
: /* List of events to be processed as input by input methods.
11209 These events are processed after `unread-command-events', but
11210 before actual keyboard input.
11211 If there's an active input method, the events are given to
11212 `input-method-function'. */);
11213 Vunread_input_method_events
= Qnil
;
11215 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11216 doc
: /* Meta-prefix character code.
11217 Meta-foo as command input turns into this character followed by foo. */);
11218 XSETINT (meta_prefix_char
, 033);
11220 DEFVAR_KBOARD ("last-command", Vlast_command
,
11221 doc
: /* The last command executed.
11222 Normally a symbol with a function definition, but can be whatever was found
11223 in the keymap, or whatever the variable `this-command' was set to by that
11226 The value `mode-exit' is special; it means that the previous command
11227 read an event that told it to exit, and it did so and unread that event.
11228 In other words, the present command is the event that made the previous
11231 The value `kill-region' is special; it means that the previous command
11232 was a kill command.
11234 `last-command' has a separate binding for each terminal device.
11235 See Info node `(elisp)Multiple Terminals'. */);
11237 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11238 doc
: /* Same as `last-command', but never altered by Lisp code.
11239 Taken from the previous value of `real-this-command'. */);
11241 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11242 doc
: /* Last command that may be repeated.
11243 The last command executed that was not bound to an input event.
11244 This is the command `repeat' will try to repeat.
11245 Taken from a previous value of `real-this-command'. */);
11247 DEFVAR_LISP ("this-command", Vthis_command
,
11248 doc
: /* The command now being executed.
11249 The command can set this variable; whatever is put here
11250 will be in `last-command' during the following command. */);
11251 Vthis_command
= Qnil
;
11253 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11254 doc
: /* This is like `this-command', except that commands should never modify it. */);
11255 Vreal_this_command
= Qnil
;
11257 DEFVAR_LISP ("this-command-keys-shift-translated",
11258 Vthis_command_keys_shift_translated
,
11259 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11260 Shift-translation occurs when there is no binding for the key sequence
11261 as entered, but a binding was found by changing an upper-case letter
11262 to lower-case, or a shifted function key to an unshifted one. */);
11263 Vthis_command_keys_shift_translated
= Qnil
;
11265 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11266 doc
: /* The command bound to the current key sequence before remapping.
11267 It equals `this-command' if the original command was not remapped through
11268 any of the active keymaps. Otherwise, the value of `this-command' is the
11269 result of looking up the original command in the active keymaps. */);
11270 Vthis_original_command
= Qnil
;
11272 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11273 doc
: /* Number of input events between auto-saves.
11274 Zero means disable autosaving due to number of characters typed. */);
11275 auto_save_interval
= 300;
11277 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11278 doc
: /* Number of seconds idle time before auto-save.
11279 Zero or nil means disable auto-saving due to idleness.
11280 After auto-saving due to this many seconds of idle time,
11281 Emacs also does a garbage collection if that seems to be warranted. */);
11282 XSETFASTINT (Vauto_save_timeout
, 30);
11284 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11285 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11286 The value may be integer or floating point.
11287 If the value is zero, don't echo at all. */);
11288 Vecho_keystrokes
= make_number (1);
11290 DEFVAR_INT ("polling-period", polling_period
,
11291 doc
: /* Interval between polling for input during Lisp execution.
11292 The reason for polling is to make C-g work to stop a running program.
11293 Polling is needed only when using X windows and SIGIO does not work.
11294 Polling is automatically disabled in all other cases. */);
11295 polling_period
= 2;
11297 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11298 doc
: /* Maximum time between mouse clicks to make a double-click.
11299 Measured in milliseconds. The value nil means disable double-click
11300 recognition; t means double-clicks have no time limit and are detected
11301 by position only. */);
11302 Vdouble_click_time
= make_number (500);
11304 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11305 doc
: /* Maximum mouse movement between clicks to make a double-click.
11306 On window-system frames, value is the number of pixels the mouse may have
11307 moved horizontally or vertically between two clicks to make a double-click.
11308 On non window-system frames, value is interpreted in units of 1/8 characters
11311 This variable is also the threshold for motion of the mouse
11312 to count as a drag. */);
11313 double_click_fuzz
= 3;
11315 DEFVAR_INT ("num-input-keys", num_input_keys
,
11316 doc
: /* Number of complete key sequences read as input so far.
11317 This includes key sequences read from keyboard macros.
11318 The number is effectively the number of interactive command invocations. */);
11319 num_input_keys
= 0;
11321 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11322 doc
: /* Number of input events read from the keyboard so far.
11323 This does not include events generated by keyboard macros. */);
11324 num_nonmacro_input_events
= 0;
11326 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11327 doc
: /* The frame in which the most recently read event occurred.
11328 If the last event came from a keyboard macro, this is set to `macro'. */);
11329 Vlast_event_frame
= Qnil
;
11331 /* This variable is set up in sysdep.c. */
11332 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11333 doc
: /* The ERASE character as set by the user with stty. */);
11335 DEFVAR_LISP ("help-char", Vhelp_char
,
11336 doc
: /* Character to recognize as meaning Help.
11337 When it is read, do `(eval help-form)', and display result if it's a string.
11338 If the value of `help-form' is nil, this char can be read normally. */);
11339 XSETINT (Vhelp_char
, Ctl ('H'));
11341 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11342 doc
: /* List of input events to recognize as meaning Help.
11343 These work just like the value of `help-char' (see that). */);
11344 Vhelp_event_list
= Qnil
;
11346 DEFVAR_LISP ("help-form", Vhelp_form
,
11347 doc
: /* Form to execute when character `help-char' is read.
11348 If the form returns a string, that string is displayed.
11349 If `help-form' is nil, the help char is not recognized. */);
11352 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11353 doc
: /* Command to run when `help-char' character follows a prefix key.
11354 This command is used only when there is no actual binding
11355 for that character after that prefix key. */);
11356 Vprefix_help_command
= Qnil
;
11358 DEFVAR_LISP ("top-level", Vtop_level
,
11359 doc
: /* Form to evaluate when Emacs starts up.
11360 Useful to set before you dump a modified Emacs. */);
11363 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11364 doc
: /* Translate table for local keyboard input, or nil.
11365 If non-nil, the value should be a char-table. Each character read
11366 from the keyboard is looked up in this char-table. If the value found
11367 there is non-nil, then it is used instead of the actual input character.
11369 The value can also be a string or vector, but this is considered obsolete.
11370 If it is a string or vector of length N, character codes N and up are left
11371 untranslated. In a vector, an element which is nil means "no translation".
11373 This is applied to the characters supplied to input methods, not their
11374 output. See also `translation-table-for-input'.
11376 This variable has a separate binding for each terminal.
11377 See Info node `(elisp)Multiple Terminals'. */);
11379 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11380 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11381 \(Even if the operating system has support for stopping a process.\) */);
11382 cannot_suspend
= 0;
11384 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11385 doc
: /* Non-nil means prompt with menus when appropriate.
11386 This is done when reading from a keymap that has a prompt string,
11387 for elements that have prompt strings.
11388 The menu is displayed on the screen
11389 if X menus were enabled at configuration
11390 time and the previous event was a mouse click prefix key.
11391 Otherwise, menu prompting uses the echo area. */);
11392 menu_prompting
= 1;
11394 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11395 doc
: /* Character to see next line of menu prompt.
11396 Type this character while in a menu prompt to rotate around the lines of it. */);
11397 XSETINT (menu_prompt_more_char
, ' ');
11399 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11400 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11401 Emacs applies the modifiers of the character stored here to each keyboard
11402 character it reads. For example, after evaluating the expression
11403 (setq extra-keyboard-modifiers ?\\C-x)
11404 all input characters will have the control modifier applied to them.
11406 Note that the character ?\\C-@, equivalent to the integer zero, does
11407 not count as a control character; rather, it counts as a character
11408 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11409 cancels any modification. */);
11410 extra_keyboard_modifiers
= 0;
11412 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11413 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11414 The command loop sets this to nil before each command,
11415 and tests the value when the command returns.
11416 Buffer modification stores t in this variable. */);
11417 Vdeactivate_mark
= Qnil
;
11418 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11420 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11421 doc
: /* Normal hook run before each command is executed.
11422 If an unhandled error happens in running this hook,
11423 the function in which the error occurred is unconditionally removed, since
11424 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11425 Vpre_command_hook
= Qnil
;
11427 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11428 doc
: /* Normal hook run after each command is executed.
11429 If an unhandled error happens in running this hook,
11430 the function in which the error occurred is unconditionally removed, since
11431 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11432 Vpost_command_hook
= Qnil
;
11435 DEFVAR_LISP ("echo-area-clear-hook", ...,
11436 doc
: /* Normal hook run when clearing the echo area. */);
11438 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11439 Fset (Qecho_area_clear_hook
, Qnil
);
11441 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11442 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11443 Vlucid_menu_bar_dirty_flag
= Qnil
;
11445 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11446 doc
: /* List of menu bar items to move to the end of the menu bar.
11447 The elements of the list are event types that may have menu bar bindings. */);
11448 Vmenu_bar_final_items
= Qnil
;
11450 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11451 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11452 This is used internally by graphical displays that do not render
11453 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11454 Vtool_bar_separator_image_expression
= Qnil
;
11456 DEFVAR_KBOARD ("overriding-terminal-local-map",
11457 Voverriding_terminal_local_map
,
11458 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11459 If this variable is non-nil, it is used as a keymap instead of the
11460 buffer's local map, and the minor mode keymaps and text property keymaps.
11461 It also replaces `overriding-local-map'.
11463 This variable is intended to let commands such as `universal-argument'
11464 set up a different keymap for reading the next command.
11466 `overriding-terminal-local-map' has a separate binding for each
11468 See Info node `(elisp)Multiple Terminals'. */);
11470 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11471 doc
: /* Keymap that overrides all other local keymaps.
11472 If this variable is non-nil, it is used as a keymap--replacing the
11473 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11474 Voverriding_local_map
= Qnil
;
11476 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11477 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11478 Otherwise, the menu bar continues to reflect the buffer's local map
11479 and the minor mode maps regardless of `overriding-local-map'. */);
11480 Voverriding_local_map_menu_flag
= Qnil
;
11482 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11483 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11484 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11486 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11487 doc
: /* Non-nil means generate motion events for mouse motion. */);
11489 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11490 doc
: /* Alist of system-specific X windows key symbols.
11491 Each element should have the form (N . SYMBOL) where N is the
11492 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11493 and SYMBOL is its name.
11495 `system-key-alist' has a separate binding for each terminal device.
11496 See Info node `(elisp)Multiple Terminals'. */);
11498 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11499 doc
: /* Keymap that translates key sequences to key sequences during input.
11500 This is used mainly for mapping key sequences into some preferred
11501 key events (symbols).
11503 The `read-key-sequence' function replaces any subsequence bound by
11504 `local-function-key-map' with its binding. More precisely, when the
11505 active keymaps have no binding for the current key sequence but
11506 `local-function-key-map' binds a suffix of the sequence to a vector or
11507 string, `read-key-sequence' replaces the matching suffix with its
11508 binding, and continues with the new sequence.
11510 If the binding is a function, it is called with one argument (the prompt)
11511 and its return value (a key sequence) is used.
11513 The events that come from bindings in `local-function-key-map' are not
11514 themselves looked up in `local-function-key-map'.
11516 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11517 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11518 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11519 typing `ESC O P x' would return [f1 x].
11521 `local-function-key-map' has a separate binding for each terminal
11522 device. See Info node `(elisp)Multiple Terminals'. If you need to
11523 define a binding on all terminals, change `function-key-map'
11524 instead. Initially, `local-function-key-map' is an empty keymap that
11525 has `function-key-map' as its parent on all terminal devices. */);
11527 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11528 doc
: /* Keymap that decodes input escape sequences.
11529 This is used mainly for mapping ASCII function key sequences into
11530 real Emacs function key events (symbols).
11532 The `read-key-sequence' function replaces any subsequence bound by
11533 `input-decode-map' with its binding. Contrary to `function-key-map',
11534 this map applies its rebinding regardless of the presence of an ordinary
11535 binding. So it is more like `key-translation-map' except that it applies
11536 before `function-key-map' rather than after.
11538 If the binding is a function, it is called with one argument (the prompt)
11539 and its return value (a key sequence) is used.
11541 The events that come from bindings in `input-decode-map' are not
11542 themselves looked up in `input-decode-map'. */);
11544 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11545 doc
: /* The parent keymap of all `local-function-key-map' instances.
11546 Function key definitions that apply to all terminal devices should go
11547 here. If a mapping is defined in both the current
11548 `local-function-key-map' binding and this variable, then the local
11549 definition will take precedence. */);
11550 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11552 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11553 doc
: /* Keymap of key translations that can override keymaps.
11554 This keymap works like `input-decode-map', but comes after `function-key-map'.
11555 Another difference is that it is global rather than terminal-local. */);
11556 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11558 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11559 doc
: /* List of deferred actions to be performed at a later time.
11560 The precise format isn't relevant here; we just check whether it is nil. */);
11561 Vdeferred_action_list
= Qnil
;
11563 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11564 doc
: /* Function to call to handle deferred actions, after each command.
11565 This function is called with no arguments after each command
11566 whenever `deferred-action-list' is non-nil. */);
11567 Vdeferred_action_function
= Qnil
;
11569 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11570 doc
: /* List of warnings to be displayed after this command.
11571 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11572 as per the args of `display-warning' (which see).
11573 If this variable is non-nil, `delayed-warnings-hook' will be run
11574 immediately after running `post-command-hook'. */);
11575 Vdelayed_warnings_list
= Qnil
;
11577 DEFVAR_LISP ("timer-list", Vtimer_list
,
11578 doc
: /* List of active absolute time timers in order of increasing time. */);
11579 Vtimer_list
= Qnil
;
11581 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11582 doc
: /* List of active idle-time timers in order of increasing time. */);
11583 Vtimer_idle_list
= Qnil
;
11585 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11586 doc
: /* If non-nil, the function that implements the current input method.
11587 It's called with one argument, a printing character that was just read.
11588 \(That means a character with code 040...0176.)
11589 Typically this function uses `read-event' to read additional events.
11590 When it does so, it should first bind `input-method-function' to nil
11591 so it will not be called recursively.
11593 The function should return a list of zero or more events
11594 to be used as input. If it wants to put back some events
11595 to be reconsidered, separately, by the input method,
11596 it can add them to the beginning of `unread-command-events'.
11598 The input method function can find in `input-method-previous-message'
11599 the previous echo area message.
11601 The input method function should refer to the variables
11602 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11603 for guidance on what to do. */);
11604 Vinput_method_function
= Qnil
;
11606 DEFVAR_LISP ("input-method-previous-message",
11607 Vinput_method_previous_message
,
11608 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11609 This variable exists because `read-event' clears the echo area
11610 before running the input method. It is nil if there was no message. */);
11611 Vinput_method_previous_message
= Qnil
;
11613 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11614 doc
: /* If non-nil, the function that implements the display of help.
11615 It's called with one argument, the help string to display. */);
11616 Vshow_help_function
= Qnil
;
11618 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11619 doc
: /* If non-nil, suppress point adjustment after executing a command.
11621 After a command is executed, if point is moved into a region that has
11622 special properties (e.g. composition, display), we adjust point to
11623 the boundary of the region. But, when a command sets this variable to
11624 non-nil, we suppress the point adjustment.
11626 This variable is set to nil before reading a command, and is checked
11627 just after executing the command. */);
11628 Vdisable_point_adjustment
= Qnil
;
11630 DEFVAR_LISP ("global-disable-point-adjustment",
11631 Vglobal_disable_point_adjustment
,
11632 doc
: /* If non-nil, always suppress point adjustment.
11634 The default value is nil, in which case, point adjustment are
11635 suppressed only after special commands that set
11636 `disable-point-adjustment' (which see) to non-nil. */);
11637 Vglobal_disable_point_adjustment
= Qnil
;
11639 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11640 doc
: /* How long to display an echo-area message when the minibuffer is active.
11641 If the value is not a number, such messages don't time out. */);
11642 Vminibuffer_message_timeout
= make_number (2);
11644 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11645 doc
: /* If non-nil, any keyboard input throws to this symbol.
11646 The value of that variable is passed to `quit-flag' and later causes a
11647 peculiar kind of quitting. */);
11648 Vthrow_on_input
= Qnil
;
11650 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11651 doc
: /* If non-nil, function to output error messages.
11652 The arguments are the error data, a list of the form
11653 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11654 such as just as `condition-case' would bind its variable to,
11655 the context (a string which normally goes at the start of the message),
11656 and the Lisp function within which the error was signaled. */);
11657 Vcommand_error_function
= Qnil
;
11659 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11660 Venable_disabled_menus_and_buttons
,
11661 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11663 Help functions bind this to allow help on disabled menu items
11664 and tool-bar buttons. */);
11665 Venable_disabled_menus_and_buttons
= Qnil
;
11667 DEFVAR_LISP ("select-active-regions",
11668 Vselect_active_regions
,
11669 doc
: /* If non-nil, an active region automatically sets the primary selection.
11670 If the value is `only', only temporarily active regions (usually made
11671 by mouse-dragging or shift-selection) set the window selection.
11673 This takes effect only when Transient Mark mode is enabled. */);
11674 Vselect_active_regions
= Qt
;
11676 DEFVAR_LISP ("saved-region-selection",
11677 Vsaved_region_selection
,
11678 doc
: /* Contents of active region prior to buffer modification.
11679 If `select-active-regions' is non-nil, Emacs sets this to the
11680 text in the region before modifying the buffer. The next call to
11681 the function `deactivate-mark' uses this to set the window selection. */);
11682 Vsaved_region_selection
= Qnil
;
11684 DEFVAR_LISP ("selection-inhibit-update-commands",
11685 Vselection_inhibit_update_commands
,
11686 doc
: /* List of commands which should not update the selection.
11687 Normally, if `select-active-regions' is non-nil and the mark remains
11688 active after a command (i.e. the mark was not deactivated), the Emacs
11689 command loop sets the selection to the text in the region. However,
11690 if the command is in this list, the selection is not updated. */);
11691 Vselection_inhibit_update_commands
11692 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11694 DEFVAR_LISP ("debug-on-event",
11696 doc
: /* Enter debugger on this event. When Emacs
11697 receives the special event specified by this variable, it will try to
11698 break into the debugger as soon as possible instead of processing the
11699 event normally through `special-event-map'.
11701 Currently, the only supported values for this
11702 variable are `sigusr1' and `sigusr2'. */);
11703 Vdebug_on_event
= intern_c_string ("sigusr2");
11705 /* Create the initial keyboard. */
11706 initial_kboard
= xmalloc (sizeof *initial_kboard
);
11707 init_kboard (initial_kboard
);
11708 /* Vwindow_system is left at t for now. */
11709 initial_kboard
->next_kboard
= all_kboards
;
11710 all_kboards
= initial_kboard
;
11714 keys_of_keyboard (void)
11716 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11717 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11718 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11719 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11720 initial_define_key (meta_map
, 'x', "execute-extended-command");
11722 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11723 "handle-delete-frame");
11724 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11725 "ns-put-working-text");
11726 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11727 "ns-unput-working-text");
11728 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11729 current-prefix-arg, as is done in `handle-switch-frame'.
11730 But `handle-switch-frame is not run from the special-map.
11731 Commands from that map are run in a special way that automatically
11732 preserves the prefix-arg. Restoring the prefix arg here is not just
11733 redundant but harmful:
11735 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11736 - after the first prompt, the exit-minibuffer-hook is run which may
11737 iconify a frame and thus push a `iconify-frame' event.
11738 - after running exit-minibuffer-hook, current-prefix-arg is
11739 restored to the non-nil value it had before the prompt.
11740 - we enter the second prompt.
11741 current-prefix-arg is non-nil, prefix-arg is nil.
11742 - before running the first real event, we run the special iconify-frame
11743 event, but we pass the `special' arg to execute-command so
11744 current-prefix-arg and prefix-arg are left untouched.
11745 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11746 - the next key event will have a spuriously non-nil current-prefix-arg. */
11747 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11749 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11751 /* Handling it at such a low-level causes read_key_sequence to get
11752 * confused because it doesn't realize that the current_buffer was
11753 * changed by read_char.
11755 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11756 * "handle-select-window"); */
11757 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11758 "handle-save-session");
11761 /* Define a special event which is raised for dbus callback
11763 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11764 "dbus-handle-event");
11767 #ifdef HAVE_INOTIFY
11768 /* Define a special event which is raised for inotify callback
11770 initial_define_lispy_key (Vspecial_event_map
, "file-inotify",
11771 "inotify-handle-event");
11772 #endif /* HAVE_INOTIFY */
11774 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11776 #if defined (WINDOWSNT)
11777 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11779 initial_define_lispy_key (Vspecial_event_map
, "file-w32notify",
11780 "w32notify-handle-event");
11784 /* Mark the pointers in the kboard objects.
11785 Called by Fgarbage_collect. */
11787 mark_kboards (void)
11791 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11793 if (kb
->kbd_macro_buffer
)
11794 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11796 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11797 mark_object (KVAR (kb
, Vlast_command
));
11798 mark_object (KVAR (kb
, Vreal_last_command
));
11799 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11800 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11801 mark_object (KVAR (kb
, Vprefix_arg
));
11802 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11803 mark_object (KVAR (kb
, kbd_queue
));
11804 mark_object (KVAR (kb
, defining_kbd_macro
));
11805 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11806 mark_object (KVAR (kb
, Vsystem_key_alist
));
11807 mark_object (KVAR (kb
, system_key_syms
));
11808 mark_object (KVAR (kb
, Vwindow_system
));
11809 mark_object (KVAR (kb
, Vinput_decode_map
));
11810 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11811 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11812 mark_object (KVAR (kb
, echo_string
));
11815 struct input_event
*event
;
11816 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11818 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11819 event
= kbd_buffer
;
11820 /* These two special event types has no Lisp_Objects to mark. */
11821 if (event
->kind
!= SELECTION_REQUEST_EVENT
11822 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11824 mark_object (event
->x
);
11825 mark_object (event
->y
);
11826 mark_object (event
->frame_or_window
);
11827 mark_object (event
->arg
);