1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2014 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include "termhooks.h"
34 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #if defined USABLE_FIONREAD && defined USG5_4
59 # include <sys/filio.h>
62 #include "syssignal.h"
64 #include <sys/types.h>
68 #ifdef HAVE_WINDOW_SYSTEM
70 #endif /* HAVE_WINDOW_SYSTEM */
72 /* Variables for blockinput.h: */
74 /* Positive if interrupt input is blocked right now. */
75 volatile int interrupt_input_blocked
;
77 /* True means an input interrupt or alarm signal has arrived.
78 The QUIT macro checks this. */
79 volatile bool pending_signals
;
81 #define KBD_BUFFER_SIZE 4096
83 KBOARD
*initial_kboard
;
84 KBOARD
*current_kboard
;
85 static KBOARD
*all_kboards
;
87 /* True in the single-kboard state, false in the any-kboard state. */
88 static bool single_kboard
;
90 /* Non-nil disable property on a command means
91 do not execute it; call disabled-command-function's value instead. */
92 Lisp_Object Qdisabled
;
93 static Lisp_Object Qdisabled_command_function
;
95 #define NUM_RECENT_KEYS (300)
97 /* Index for storing next element into recent_keys. */
98 static int recent_keys_index
;
100 /* Total number of elements stored into recent_keys. */
101 static int total_keys
;
103 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
104 static Lisp_Object recent_keys
;
106 /* Vector holding the key sequence that invoked the current command.
107 It is reused for each command, and it may be longer than the current
108 sequence; this_command_key_count indicates how many elements
109 actually mean something.
110 It's easier to staticpro a single Lisp_Object than an array. */
111 Lisp_Object this_command_keys
;
112 ptrdiff_t this_command_key_count
;
114 /* True after calling Freset_this_command_lengths.
115 Usually it is false. */
116 static bool this_command_key_count_reset
;
118 /* This vector is used as a buffer to record the events that were actually read
119 by read_key_sequence. */
120 static Lisp_Object raw_keybuf
;
121 static int raw_keybuf_count
;
123 #define GROW_RAW_KEYBUF \
124 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
125 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
127 /* Number of elements of this_command_keys
128 that precede this key sequence. */
129 static ptrdiff_t this_single_command_key_start
;
131 /* Record values of this_command_key_count and echo_length ()
132 before this command was read. */
133 static ptrdiff_t before_command_key_count
;
134 static ptrdiff_t before_command_echo_length
;
136 /* For longjmp to where kbd input is being done. */
138 static sys_jmp_buf getcjmp
;
140 /* True while doing kbd input. */
141 bool waiting_for_input
;
143 /* True while displaying for echoing. Delays C-g throwing. */
147 /* Non-null means we can start echoing at the next input pause even
148 though there is something in the echo area. */
150 static struct kboard
*ok_to_echo_at_next_pause
;
152 /* The kboard last echoing, or null for none. Reset to 0 in
153 cancel_echoing. If non-null, and a current echo area message
154 exists, and echo_message_buffer is eq to the current message
155 buffer, we know that the message comes from echo_kboard. */
157 struct kboard
*echo_kboard
;
159 /* The buffer used for echoing. Set in echo_now, reset in
162 Lisp_Object echo_message_buffer
;
164 /* True means C-g should cause immediate error-signal. */
167 /* Character that causes a quit. Normally C-g.
169 If we are running on an ordinary terminal, this must be an ordinary
170 ASCII char, since we want to make it our interrupt character.
172 If we are not running on an ordinary terminal, it still needs to be
173 an ordinary ASCII char. This character needs to be recognized in
174 the input interrupt handler. At this point, the keystroke is
175 represented as a struct input_event, while the desired quit
176 character is specified as a lispy event. The mapping from struct
177 input_events to lispy events cannot run in an interrupt handler,
178 and the reverse mapping is difficult for anything but ASCII
181 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
185 /* Current depth in recursive edits. */
186 EMACS_INT command_loop_level
;
188 /* If not Qnil, this is a switch-frame event which we decided to put
189 off until the end of a key sequence. This should be read as the
190 next command input, after any unread_command_events.
192 read_key_sequence uses this to delay switch-frame events until the
193 end of the key sequence; Fread_char uses it to put off switch-frame
194 events until a non-ASCII event is acceptable as input. */
195 Lisp_Object unread_switch_frame
;
197 /* Last size recorded for a current buffer which is not a minibuffer. */
198 static ptrdiff_t last_non_minibuf_size
;
200 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
201 uintmax_t num_input_events
;
203 /* Value of num_nonmacro_input_events as of last auto save. */
205 static EMACS_INT last_auto_save
;
207 /* The value of point when the last command was started. */
208 static ptrdiff_t last_point_position
;
210 /* The frame in which the last input event occurred, or Qmacro if the
211 last event came from a macro. We use this to determine when to
212 generate switch-frame events. This may be cleared by functions
213 like Fselect_frame, to make sure that a switch-frame event is
214 generated by the next character.
216 FIXME: This is modified by a signal handler so it should be volatile.
217 It's exported to Lisp, though, so it can't simply be marked
219 Lisp_Object internal_last_event_frame
;
221 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
222 static Lisp_Object Qhandle_select_window
;
223 Lisp_Object QPRIMARY
;
225 static Lisp_Object Qself_insert_command
;
226 static Lisp_Object Qforward_char
;
227 static Lisp_Object Qbackward_char
;
228 Lisp_Object Qundefined
;
229 static Lisp_Object Qtimer_event_handler
;
231 /* `read_key_sequence' stores here the command definition of the
232 key sequence that it reads. */
233 static Lisp_Object read_key_sequence_cmd
;
234 static Lisp_Object read_key_sequence_remapped
;
236 static Lisp_Object Qinput_method_function
;
238 static Lisp_Object Qdeactivate_mark
;
240 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
242 static Lisp_Object Qecho_area_clear_hook
;
244 /* Hooks to run before and after each command. */
245 static Lisp_Object Qpre_command_hook
;
246 static Lisp_Object Qpost_command_hook
;
248 static Lisp_Object Qdeferred_action_function
;
250 static Lisp_Object Qdelayed_warnings_hook
;
252 static Lisp_Object Qinput_method_exit_on_first_char
;
253 static Lisp_Object Qinput_method_use_echo_area
;
255 static Lisp_Object Qhelp_form_show
;
257 /* File in which we write all commands we read. */
258 static FILE *dribble
;
260 /* Nonzero if input is available. */
263 /* Circular buffer for pre-read keyboard input. */
265 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
267 /* Pointer to next available character in kbd_buffer.
268 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
269 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
270 next available char is in kbd_buffer[0]. */
271 static struct input_event
*kbd_fetch_ptr
;
273 /* Pointer to next place to store character in kbd_buffer. This
274 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
275 character should go in kbd_buffer[0]. */
276 static struct input_event
* volatile kbd_store_ptr
;
278 /* The above pair of variables forms a "queue empty" flag. When we
279 enqueue a non-hook event, we increment kbd_store_ptr. When we
280 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
281 there is input available if the two pointers are not equal.
283 Why not just have a flag set and cleared by the enqueuing and
284 dequeuing functions? Such a flag could be screwed up by interrupts
285 at inopportune times. */
287 /* Symbols to head events. */
288 static Lisp_Object Qmouse_movement
;
289 static Lisp_Object Qscroll_bar_movement
;
290 Lisp_Object Qswitch_frame
;
291 static Lisp_Object Qfocus_in
, Qfocus_out
;
292 static Lisp_Object Qdelete_frame
;
293 static Lisp_Object Qiconify_frame
;
294 static Lisp_Object Qmake_frame_visible
;
295 static Lisp_Object Qselect_window
;
296 Lisp_Object Qhelp_echo
;
298 static Lisp_Object Qmouse_fixup_help_message
;
300 /* Symbols to denote kinds of events. */
301 static Lisp_Object Qfunction_key
;
302 Lisp_Object Qmouse_click
;
304 Lisp_Object Qlanguage_change
;
306 static Lisp_Object Qdrag_n_drop
;
307 static Lisp_Object Qsave_session
;
309 static Lisp_Object Qdbus_event
;
311 #ifdef USE_FILE_NOTIFY
312 static Lisp_Object Qfile_notify
;
313 #endif /* USE_FILE_NOTIFY */
314 static Lisp_Object Qconfig_changed_event
;
316 /* Lisp_Object Qmouse_movement; - also an event header */
318 /* Properties of event headers. */
319 Lisp_Object Qevent_kind
;
320 static Lisp_Object Qevent_symbol_elements
;
322 /* Menu and tool bar item parts. */
323 static Lisp_Object Qmenu_enable
;
324 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
325 Lisp_Object QCfilter
;
327 /* Non-nil disable property on a command means
328 do not execute it; call disabled-command-function's value instead. */
329 Lisp_Object QCtoggle
, QCradio
;
330 static Lisp_Object QCbutton
, QClabel
;
332 static Lisp_Object QCvert_only
;
334 /* An event header symbol HEAD may have a property named
335 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
336 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
337 mask of modifiers applied to it. If present, this is used to help
338 speed up parse_modifiers. */
339 Lisp_Object Qevent_symbol_element_mask
;
341 /* An unmodified event header BASE may have a property named
342 Qmodifier_cache, which is an alist mapping modifier masks onto
343 modified versions of BASE. If present, this helps speed up
345 static Lisp_Object Qmodifier_cache
;
347 /* Symbols to use for parts of windows. */
348 Lisp_Object Qmode_line
;
349 Lisp_Object Qvertical_line
;
350 Lisp_Object Qright_divider
, Qbottom_divider
;
351 static Lisp_Object Qvertical_scroll_bar
;
352 Lisp_Object Qmenu_bar
;
354 static Lisp_Object Qecho_keystrokes
;
356 static void recursive_edit_unwind (Lisp_Object buffer
);
357 static Lisp_Object
command_loop (void);
358 static Lisp_Object Qcommand_execute
;
359 struct timespec
timer_check (void);
361 static void echo_now (void);
362 static ptrdiff_t echo_length (void);
364 static Lisp_Object Qpolling_period
;
366 /* Incremented whenever a timer is run. */
369 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
371 struct timespec
*input_available_clear_time
;
373 /* True means use SIGIO interrupts; false means use CBREAK mode.
374 Default is true if INTERRUPT_INPUT is defined. */
375 bool interrupt_input
;
377 /* Nonzero while interrupts are temporarily deferred during redisplay. */
378 bool interrupts_deferred
;
380 /* If we support a window system, turn on the code to poll periodically
381 to detect C-g. It isn't actually used when doing interrupt input. */
382 #ifdef HAVE_WINDOW_SYSTEM
383 #define POLL_FOR_INPUT
386 /* The time when Emacs started being idle. */
388 static struct timespec timer_idleness_start_time
;
390 /* After Emacs stops being idle, this saves the last value
391 of timer_idleness_start_time from when it was idle. */
393 static struct timespec timer_last_idleness_start_time
;
396 /* Global variable declarations. */
398 /* Flags for readable_events. */
399 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
400 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
401 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
403 /* Function for init_keyboard to call with no args (if nonzero). */
404 static void (*keyboard_init_hook
) (void);
406 static bool get_input_pending (int);
407 static bool readable_events (int);
408 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
409 Lisp_Object
, bool *);
410 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
411 static Lisp_Object
make_lispy_event (struct input_event
*);
412 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
413 enum scroll_bar_part
,
414 Lisp_Object
, Lisp_Object
,
416 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
417 Lisp_Object
, const char *const *,
418 Lisp_Object
*, ptrdiff_t);
419 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
420 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
421 #ifdef HAVE_WINDOW_SYSTEM
422 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
423 #endif /* HAVE_WINDOW_SYSTEM */
424 static bool help_char_p (Lisp_Object
);
425 static void save_getcjmp (sys_jmp_buf
);
426 static void restore_getcjmp (sys_jmp_buf
);
427 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
428 static void clear_event (struct input_event
*);
429 static void restore_kboard_configuration (int);
431 static void deliver_input_available_signal (int signo
);
433 static void handle_interrupt (bool);
434 static _Noreturn
void quit_throw_to_read_char (bool);
435 static void process_special_events (void);
436 static void timer_start_idle (void);
437 static void timer_stop_idle (void);
438 static void timer_resume_idle (void);
439 static void deliver_user_signal (int);
440 static char *find_user_signal_name (int);
441 static void store_user_signal_events (void);
443 /* These setters are used only in this file, so they can be private. */
445 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
447 kb
->INTERNAL_FIELD (echo_string
) = val
;
450 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
452 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
455 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
457 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
460 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
462 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
465 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
467 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
470 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
472 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
475 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
477 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
480 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
482 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
485 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
487 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
491 /* Add C to the echo string, without echoing it immediately. C can be
492 a character, which is pretty-printed, or a symbol, whose name is
496 echo_add_key (Lisp_Object c
)
498 int size
= KEY_DESCRIPTION_SIZE
+ 100;
499 char *buffer
= alloca (size
);
501 Lisp_Object echo_string
;
503 echo_string
= KVAR (current_kboard
, echo_string
);
505 /* If someone has passed us a composite event, use its head symbol. */
509 ptr
= push_key_description (XINT (c
), ptr
);
510 else if (SYMBOLP (c
))
512 Lisp_Object name
= SYMBOL_NAME (c
);
513 int nbytes
= SBYTES (name
);
515 if (size
- (ptr
- buffer
) < nbytes
)
517 int offset
= ptr
- buffer
;
518 size
= max (2 * size
, size
+ nbytes
);
519 buffer
= alloca (size
);
520 ptr
= buffer
+ offset
;
523 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
524 STRING_MULTIBYTE (name
), 1);
527 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
530 const char *text
= " (Type ? for further options)";
531 int len
= strlen (text
);
533 if (size
- (ptr
- buffer
) < len
)
535 int offset
= ptr
- buffer
;
537 buffer
= alloca (size
);
538 ptr
= buffer
+ offset
;
541 memcpy (ptr
, text
, len
);
545 /* Replace a dash from echo_dash with a space, otherwise add a space
546 at the end as a separator between keys. */
547 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
549 Lisp_Object last_char
, prev_char
, idx
;
551 idx
= make_number (SCHARS (echo_string
) - 2);
552 prev_char
= Faref (echo_string
, idx
);
554 idx
= make_number (SCHARS (echo_string
) - 1);
555 last_char
= Faref (echo_string
, idx
);
557 /* We test PREV_CHAR to make sure this isn't the echoing of a
559 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
560 Faset (echo_string
, idx
, make_number (' '));
562 echo_string
= concat2 (echo_string
, build_string (" "));
564 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
565 echo_string
= concat2 (echo_string
, build_string (" "));
569 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
572 /* Add C to the echo string, if echoing is going on. C can be a
573 character or a symbol. */
576 echo_char (Lisp_Object c
)
578 if (current_kboard
->immediate_echo
)
585 /* Temporarily add a dash to the end of the echo string if it's not
586 empty, so that it serves as a mini-prompt for the very next
592 /* Do nothing if not echoing at all. */
593 if (NILP (KVAR (current_kboard
, echo_string
)))
596 if (this_command_key_count
== 0)
599 if (!current_kboard
->immediate_echo
600 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
603 /* Do nothing if we just printed a prompt. */
604 if (current_kboard
->echo_after_prompt
605 == SCHARS (KVAR (current_kboard
, echo_string
)))
608 /* Do nothing if we have already put a dash at the end. */
609 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
611 Lisp_Object last_char
, prev_char
, idx
;
613 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
614 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
616 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
617 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
619 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
623 /* Put a dash at the end of the buffer temporarily,
624 but make it go away when the next character is added. */
627 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
631 /* Display the current echo string, and begin echoing if not already
637 if (!current_kboard
->immediate_echo
)
640 current_kboard
->immediate_echo
= 1;
642 for (i
= 0; i
< this_command_key_count
; i
++)
646 /* Set before_command_echo_length to the value that would
647 have been saved before the start of this subcommand in
648 command_loop_1, if we had already been echoing then. */
649 if (i
== this_single_command_key_start
)
650 before_command_echo_length
= echo_length ();
652 c
= AREF (this_command_keys
, i
);
653 if (! (EVENT_HAS_PARAMETERS (c
)
654 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
658 /* Set before_command_echo_length to the value that would
659 have been saved before the start of this subcommand in
660 command_loop_1, if we had already been echoing then. */
661 if (this_command_key_count
== this_single_command_key_start
)
662 before_command_echo_length
= echo_length ();
664 /* Put a dash at the end to invite the user to type more. */
669 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
670 message3_nolog (KVAR (current_kboard
, echo_string
));
673 /* Record in what buffer we echoed, and from which kboard. */
674 echo_message_buffer
= echo_area_buffer
[0];
675 echo_kboard
= current_kboard
;
677 if (waiting_for_input
&& !NILP (Vquit_flag
))
678 quit_throw_to_read_char (0);
681 /* Turn off echoing, for the start of a new command. */
684 cancel_echoing (void)
686 current_kboard
->immediate_echo
= 0;
687 current_kboard
->echo_after_prompt
= -1;
688 kset_echo_string (current_kboard
, Qnil
);
689 ok_to_echo_at_next_pause
= NULL
;
691 echo_message_buffer
= Qnil
;
694 /* Return the length of the current echo string. */
699 return (STRINGP (KVAR (current_kboard
, echo_string
))
700 ? SCHARS (KVAR (current_kboard
, echo_string
))
704 /* Truncate the current echo message to its first LEN chars.
705 This and echo_char get used by read_key_sequence when the user
706 switches frames while entering a key sequence. */
709 echo_truncate (ptrdiff_t nchars
)
711 if (STRINGP (KVAR (current_kboard
, echo_string
)))
712 kset_echo_string (current_kboard
,
713 Fsubstring (KVAR (current_kboard
, echo_string
),
714 make_number (0), make_number (nchars
)));
715 truncate_echo_area (nchars
);
719 /* Functions for manipulating this_command_keys. */
721 add_command_key (Lisp_Object key
)
723 #if 0 /* Not needed after we made Freset_this_command_lengths
724 do the job immediately. */
725 /* If reset-this-command-length was called recently, obey it now.
726 See the doc string of that function for an explanation of why. */
727 if (before_command_restore_flag
)
729 this_command_key_count
= before_command_key_count_1
;
730 if (this_command_key_count
< this_single_command_key_start
)
731 this_single_command_key_start
= this_command_key_count
;
732 echo_truncate (before_command_echo_length_1
);
733 before_command_restore_flag
= 0;
737 if (this_command_key_count
>= ASIZE (this_command_keys
))
738 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
740 ASET (this_command_keys
, this_command_key_count
, key
);
741 ++this_command_key_count
;
746 recursive_edit_1 (void)
748 ptrdiff_t count
= SPECPDL_INDEX ();
751 if (command_loop_level
> 0)
753 specbind (Qstandard_output
, Qt
);
754 specbind (Qstandard_input
, Qt
);
757 #ifdef HAVE_WINDOW_SYSTEM
758 /* The command loop has started an hourglass timer, so we have to
759 cancel it here, otherwise it will fire because the recursive edit
760 can take some time. Do not check for display_hourglass_p here,
761 because it could already be nil. */
765 /* This function may have been called from a debugger called from
766 within redisplay, for instance by Edebugging a function called
767 from fontification-functions. We want to allow redisplay in
768 the debugging session.
770 The recursive edit is left with a `(throw exit ...)'. The `exit'
771 tag is not caught anywhere in redisplay, i.e. when we leave the
772 recursive edit, the original redisplay leading to the recursive
773 edit will be unwound. The outcome should therefore be safe. */
774 specbind (Qinhibit_redisplay
, Qnil
);
777 val
= command_loop ();
779 Fsignal (Qquit
, Qnil
);
780 /* Handle throw from read_minibuf when using minibuffer
781 while it's active but we're in another window. */
783 xsignal1 (Qerror
, val
);
785 return unbind_to (count
, Qnil
);
788 /* When an auto-save happens, record the "time", and don't do again soon. */
791 record_auto_save (void)
793 last_auto_save
= num_nonmacro_input_events
;
796 /* Make an auto save happen as soon as possible at command level. */
800 force_auto_save_soon (void)
802 last_auto_save
= - auto_save_interval
- 1;
804 record_asynch_buffer_change ();
808 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
809 doc
: /* Invoke the editor command loop recursively.
810 To get out of the recursive edit, a command can throw to `exit' -- for
811 instance `(throw 'exit nil)'.
812 If you throw a value other than t, `recursive-edit' returns normally
813 to the function that called it. Throwing a t value causes
814 `recursive-edit' to quit, so that control returns to the command loop
817 This function is called by the editor initialization to begin editing. */)
820 ptrdiff_t count
= SPECPDL_INDEX ();
823 /* If we enter while input is blocked, don't lock up here.
824 This may happen through the debugger during redisplay. */
825 if (input_blocked_p ())
828 if (command_loop_level
>= 0
829 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
830 buffer
= Fcurrent_buffer ();
834 /* Don't do anything interesting between the increment and the
835 record_unwind_protect! Otherwise, we could get distracted and
836 never decrement the counter again. */
837 command_loop_level
++;
838 update_mode_lines
= 17;
839 record_unwind_protect (recursive_edit_unwind
, buffer
);
841 /* If we leave recursive_edit_1 below with a `throw' for instance,
842 like it is done in the splash screen display, we have to
843 make sure that we restore single_kboard as command_loop_1
844 would have done if it were left normally. */
845 if (command_loop_level
> 0)
846 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
849 return unbind_to (count
, Qnil
);
853 recursive_edit_unwind (Lisp_Object buffer
)
855 if (BUFFERP (buffer
))
856 Fset_buffer (buffer
);
858 command_loop_level
--;
859 update_mode_lines
= 18;
863 #if 0 /* These two functions are now replaced with
864 temporarily_switch_to_single_kboard. */
868 #if 0 /* Theory: if there's anything in Vunread_command_events,
869 it will right away be read by read_key_sequence,
870 and then if we do switch KBOARDS, it will go into the side
871 queue then. So we don't need to do anything special here -- rms. */
872 if (CONSP (Vunread_command_events
))
874 current_kboard
->kbd_queue
875 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
876 current_kboard
->kbd_queue_has_data
= 1;
878 Vunread_command_events
= Qnil
;
883 /* Switch to the single-kboard state, making current_kboard
884 the only KBOARD from which further input is accepted. */
887 single_kboard_state ()
893 /* If we're in single_kboard state for kboard KBOARD,
897 not_single_kboard_state (KBOARD
*kboard
)
899 if (kboard
== current_kboard
)
903 /* Maintain a stack of kboards, so other parts of Emacs
904 can switch temporarily to the kboard of a given frame
905 and then revert to the previous status. */
910 struct kboard_stack
*next
;
913 static struct kboard_stack
*kboard_stack
;
916 push_kboard (struct kboard
*k
)
918 struct kboard_stack
*p
= xmalloc (sizeof *p
);
920 p
->next
= kboard_stack
;
921 p
->kboard
= current_kboard
;
931 struct kboard_stack
*p
= kboard_stack
;
933 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
935 if (t
->kboard
== p
->kboard
)
937 current_kboard
= p
->kboard
;
944 /* The terminal we remembered has been deleted. */
945 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
948 kboard_stack
= p
->next
;
952 /* Switch to single_kboard mode, making current_kboard the only KBOARD
953 from which further input is accepted. If F is non-nil, set its
954 KBOARD as the current keyboard.
956 This function uses record_unwind_protect_int to return to the previous
959 If Emacs is already in single_kboard mode, and F's keyboard is
960 locked, then this function will throw an error. */
963 temporarily_switch_to_single_kboard (struct frame
*f
)
965 bool was_locked
= single_kboard
;
968 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
969 /* We can not switch keyboards while in single_kboard mode.
970 In rare cases, Lisp code may call `recursive-edit' (or
971 `read-minibuffer' or `y-or-n-p') after it switched to a
972 locked frame. For example, this is likely to happen
973 when server.el connects to a new terminal while Emacs is in
974 single_kboard mode. It is best to throw an error instead
975 of presenting the user with a frozen screen. */
976 error ("Terminal %d is locked, cannot read from it",
977 FRAME_TERMINAL (f
)->id
);
979 /* This call is unnecessary, but helps
980 `restore_kboard_configuration' discover if somebody changed
981 `current_kboard' behind our back. */
982 push_kboard (current_kboard
);
985 current_kboard
= FRAME_KBOARD (f
);
987 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
990 #if 0 /* This function is not needed anymore. */
992 record_single_kboard_state ()
995 push_kboard (current_kboard
);
996 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
1001 restore_kboard_configuration (int was_locked
)
1003 single_kboard
= was_locked
;
1006 struct kboard
*prev
= current_kboard
;
1008 /* The pop should not change the kboard. */
1009 if (single_kboard
&& current_kboard
!= prev
)
1015 /* Handle errors that are not handled at inner levels
1016 by printing an error message and returning to the editor command loop. */
1019 cmd_error (Lisp_Object data
)
1021 Lisp_Object old_level
, old_length
;
1022 char macroerror
[sizeof "After..kbd macro iterations: "
1023 + INT_STRLEN_BOUND (EMACS_INT
)];
1025 #ifdef HAVE_WINDOW_SYSTEM
1026 if (display_hourglass_p
)
1027 cancel_hourglass ();
1030 if (!NILP (executing_kbd_macro
))
1032 if (executing_kbd_macro_iterations
== 1)
1033 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1035 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1036 executing_kbd_macro_iterations
);
1041 Vstandard_output
= Qt
;
1042 Vstandard_input
= Qt
;
1043 Vexecuting_kbd_macro
= Qnil
;
1044 executing_kbd_macro
= Qnil
;
1045 kset_prefix_arg (current_kboard
, Qnil
);
1046 kset_last_prefix_arg (current_kboard
, Qnil
);
1049 /* Avoid unquittable loop if data contains a circular list. */
1050 old_level
= Vprint_level
;
1051 old_length
= Vprint_length
;
1052 XSETFASTINT (Vprint_level
, 10);
1053 XSETFASTINT (Vprint_length
, 10);
1054 cmd_error_internal (data
, macroerror
);
1055 Vprint_level
= old_level
;
1056 Vprint_length
= old_length
;
1059 Vinhibit_quit
= Qnil
;
1061 return make_number (0);
1064 /* Take actions on handling an error. DATA is the data that describes
1067 CONTEXT is a C-string containing ASCII characters only which
1068 describes the context in which the error happened. If we need to
1069 generalize CONTEXT to allow multibyte characters, make it a Lisp
1073 cmd_error_internal (Lisp_Object data
, const char *context
)
1075 /* The immediate context is not interesting for Quits,
1076 since they are asynchronous. */
1077 if (EQ (XCAR (data
), Qquit
))
1078 Vsignaling_function
= Qnil
;
1083 /* Use user's specified output function if any. */
1084 if (!NILP (Vcommand_error_function
))
1085 call3 (Vcommand_error_function
, data
,
1086 context
? build_string (context
) : empty_unibyte_string
,
1087 Vsignaling_function
);
1089 Vsignaling_function
= Qnil
;
1092 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1093 Scommand_error_default_function
, 3, 3, 0,
1094 doc
: /* Produce default output for unhandled error message.
1095 Default value of `command-error-function'. */)
1096 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1098 struct frame
*sf
= SELECTED_FRAME ();
1100 CHECK_STRING (context
);
1102 /* If the window system or terminal frame hasn't been initialized
1103 yet, or we're not interactive, write the message to stderr and exit. */
1104 if (!sf
->glyphs_initialized_p
1105 /* The initial frame is a special non-displaying frame. It
1106 will be current in daemon mode when there are no frames
1107 to display, and in non-daemon mode before the real frame
1108 has finished initializing. If an error is thrown in the
1109 latter case while creating the frame, then the frame
1110 will never be displayed, so the safest thing to do is
1111 write to stderr and quit. In daemon mode, there are
1112 many other potential errors that do not prevent frames
1113 from being created, so continuing as normal is better in
1115 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1118 print_error_message (data
, Qexternal_debugging_output
,
1119 SSDATA (context
), signal
);
1120 Fterpri (Qexternal_debugging_output
);
1121 Fkill_emacs (make_number (-1));
1125 clear_message (1, 0);
1127 message_log_maybe_newline ();
1130 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1135 static Lisp_Object
command_loop_2 (Lisp_Object
);
1136 static Lisp_Object
top_level_1 (Lisp_Object
);
1138 /* Entry to editor-command-loop.
1139 This level has the catches for exiting/returning to editor command loop.
1140 It returns nil to exit recursive edit, t to abort it. */
1145 if (command_loop_level
> 0 || minibuf_level
> 0)
1148 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1149 executing_kbd_macro
= Qnil
;
1155 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1156 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1157 executing_kbd_macro
= Qnil
;
1159 /* End of file in -batch run causes exit here. */
1165 /* Here we catch errors in execution of commands within the
1166 editing loop, and reenter the editing loop.
1167 When there is an error, cmd_error runs and returns a non-nil
1168 value to us. A value of nil means that command_loop_1 itself
1169 returned due to end of file (or end of kbd macro). */
1172 command_loop_2 (Lisp_Object ignore
)
1174 register Lisp_Object val
;
1177 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1178 while (!NILP (val
));
1186 return Feval (Vtop_level
, Qnil
);
1190 top_level_1 (Lisp_Object ignore
)
1192 /* On entry to the outer level, run the startup file. */
1193 if (!NILP (Vtop_level
))
1194 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1195 else if (!NILP (Vpurify_flag
))
1196 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1198 message1 ("Bare Emacs (standard Lisp code not loaded)");
1202 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1203 doc
: /* Exit all recursive editing levels.
1204 This also exits all active minibuffers. */)
1207 #ifdef HAVE_WINDOW_SYSTEM
1208 if (display_hourglass_p
)
1209 cancel_hourglass ();
1212 /* Unblock input if we enter with input blocked. This may happen if
1213 redisplay traps e.g. during tool-bar update with input blocked. */
1214 totally_unblock_input ();
1216 Fthrow (Qtop_level
, Qnil
);
1219 static _Noreturn
void
1220 user_error (const char *msg
)
1222 xsignal1 (Quser_error
, build_string (msg
));
1226 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1227 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1230 if (command_loop_level
> 0 || minibuf_level
> 0)
1231 Fthrow (Qexit
, Qnil
);
1233 user_error ("No recursive edit is in progress");
1237 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1238 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1241 if (command_loop_level
> 0 || minibuf_level
> 0)
1244 user_error ("No recursive edit is in progress");
1247 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1248 of this function. */
1251 tracking_off (Lisp_Object old_value
)
1253 do_mouse_tracking
= old_value
;
1254 if (NILP (old_value
))
1256 /* Redisplay may have been preempted because there was input
1257 available, and it assumes it will be called again after the
1258 input has been processed. If the only input available was
1259 the sort that we have just disabled, then we need to call
1261 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1263 redisplay_preserve_echo_area (6);
1264 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
;
1300 static struct frame
*
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
,
1325 bool, bool, bool, bool);
1326 void safe_run_hooks (Lisp_Object
);
1327 static void adjust_point_for_property (ptrdiff_t, bool);
1329 /* The last boundary auto-added to buffer-undo-list. */
1330 Lisp_Object last_undo_boundary
;
1332 extern Lisp_Object Qregion_extract_function
;
1334 /* FIXME: This is wrong rather than test window-system, we should call
1335 a new set-selection, which will then dispatch to x-set-selection, or
1336 tty-set-selection, or w32-set-selection, ... */
1339 command_loop_1 (void)
1342 Lisp_Object keybuf
[30];
1344 EMACS_INT prev_modiff
= 0;
1345 struct buffer
*prev_buffer
= NULL
;
1346 bool already_adjusted
= 0;
1348 kset_prefix_arg (current_kboard
, Qnil
);
1349 kset_last_prefix_arg (current_kboard
, Qnil
);
1350 Vdeactivate_mark
= Qnil
;
1351 waiting_for_input
= 0;
1354 this_command_key_count
= 0;
1355 this_command_key_count_reset
= 0;
1356 this_single_command_key_start
= 0;
1358 if (NILP (Vmemory_full
))
1360 /* Make sure this hook runs after commands that get errors and
1361 throw to top level. */
1362 /* Note that the value cell will never directly contain nil
1363 if the symbol is a local variable. */
1364 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1365 safe_run_hooks (Qpost_command_hook
);
1367 /* If displaying a message, resize the echo area window to fit
1368 that message's size exactly. */
1369 if (!NILP (echo_area_buffer
[0]))
1370 resize_echo_area_exactly ();
1372 /* If there are warnings waiting, process them. */
1373 if (!NILP (Vdelayed_warnings_list
))
1374 safe_run_hooks (Qdelayed_warnings_hook
);
1376 if (!NILP (Vdeferred_action_list
))
1377 safe_run_hooks (Qdeferred_action_function
);
1380 /* Do this after running Vpost_command_hook, for consistency. */
1381 kset_last_command (current_kboard
, Vthis_command
);
1382 kset_real_last_command (current_kboard
, Vreal_this_command
);
1383 if (!CONSP (last_command_event
))
1384 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1388 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1391 /* Make sure the current window's buffer is selected. */
1392 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1394 /* Display any malloc warning that just came out. Use while because
1395 displaying one warning can cause another. */
1397 while (pending_malloc_warning
)
1398 display_malloc_warning ();
1400 Vdeactivate_mark
= Qnil
;
1402 /* Don't ignore mouse movements for more than a single command
1403 loop. (This flag is set in xdisp.c whenever the tool bar is
1404 resized, because the resize moves text up or down, and would
1405 generate false mouse drag events if we don't ignore them.) */
1406 ignore_mouse_drag_p
= 0;
1408 /* If minibuffer on and echo area in use,
1409 wait a short time and redraw minibuffer. */
1412 && !NILP (echo_area_buffer
[0])
1413 && EQ (minibuf_window
, echo_area_window
)
1414 && NUMBERP (Vminibuffer_message_timeout
))
1416 /* Bind inhibit-quit to t so that C-g gets read in
1417 rather than quitting back to the minibuffer. */
1418 ptrdiff_t count
= SPECPDL_INDEX ();
1419 specbind (Qinhibit_quit
, Qt
);
1421 sit_for (Vminibuffer_message_timeout
, 0, 2);
1423 /* Clear the echo area. */
1425 safe_run_hooks (Qecho_area_clear_hook
);
1427 unbind_to (count
, Qnil
);
1429 /* If a C-g came in before, treat it as input now. */
1430 if (!NILP (Vquit_flag
))
1433 Vunread_command_events
= list1 (make_number (quit_char
));
1437 /* If it has changed current-menubar from previous value,
1438 really recompute the menubar from the value. */
1439 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1440 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1441 call0 (Qrecompute_lucid_menubar
);
1443 before_command_key_count
= this_command_key_count
;
1444 before_command_echo_length
= echo_length ();
1446 Vthis_command
= Qnil
;
1447 Vreal_this_command
= Qnil
;
1448 Vthis_original_command
= Qnil
;
1449 Vthis_command_keys_shift_translated
= Qnil
;
1451 /* Read next key sequence; i gets its length. */
1452 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1455 /* A filter may have run while we were reading the input. */
1456 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1458 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1462 /* Now we have read a key sequence of length I,
1463 or else I is 0 and we found end of file. */
1465 if (i
== 0) /* End of file -- happens only in */
1466 return Qnil
; /* a kbd macro, at the end. */
1467 /* -1 means read_key_sequence got a menu that was rejected.
1468 Just loop around and read another command. */
1472 this_command_key_count
= 0;
1473 this_command_key_count_reset
= 0;
1474 this_single_command_key_start
= 0;
1478 last_command_event
= keybuf
[i
- 1];
1480 /* If the previous command tried to force a specific window-start,
1481 forget about that, in case this command moves point far away
1482 from that position. But also throw away beg_unchanged and
1483 end_unchanged information in that case, so that redisplay will
1484 update the whole window properly. */
1485 if (XWINDOW (selected_window
)->force_start
)
1488 XWINDOW (selected_window
)->force_start
= 0;
1489 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1490 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1493 cmd
= read_key_sequence_cmd
;
1494 if (!NILP (Vexecuting_kbd_macro
))
1496 if (!NILP (Vquit_flag
))
1498 Vexecuting_kbd_macro
= Qt
;
1499 QUIT
; /* Make some noise. */
1500 /* Will return since macro now empty. */
1504 /* Do redisplay processing after this command except in special
1505 cases identified below. */
1506 prev_buffer
= current_buffer
;
1507 prev_modiff
= MODIFF
;
1508 last_point_position
= PT
;
1510 /* By default, we adjust point to a boundary of a region that
1511 has such a property that should be treated intangible
1512 (e.g. composition, display). But, some commands will set
1513 this variable differently. */
1514 Vdisable_point_adjustment
= Qnil
;
1516 /* Process filters and timers may have messed with deactivate-mark.
1517 reset it before we execute the command. */
1518 Vdeactivate_mark
= Qnil
;
1520 /* Remap command through active keymaps. */
1521 Vthis_original_command
= cmd
;
1522 if (!NILP (read_key_sequence_remapped
))
1523 cmd
= read_key_sequence_remapped
;
1525 /* Execute the command. */
1527 Vthis_command
= cmd
;
1528 Vreal_this_command
= cmd
;
1529 safe_run_hooks (Qpre_command_hook
);
1531 already_adjusted
= 0;
1533 if (NILP (Vthis_command
))
1534 /* nil means key is undefined. */
1538 /* Here for a command that isn't executed directly. */
1540 #ifdef HAVE_WINDOW_SYSTEM
1541 ptrdiff_t scount
= SPECPDL_INDEX ();
1543 if (display_hourglass_p
1544 && NILP (Vexecuting_kbd_macro
))
1546 record_unwind_protect_void (cancel_hourglass
);
1551 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1553 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1556 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1557 ? Qnil
: BVAR (current_buffer
, undo_list
));
1559 call1 (Qcommand_execute
, Vthis_command
);
1561 #ifdef HAVE_WINDOW_SYSTEM
1562 /* Do not check display_hourglass_p here, because
1563 `command-execute' could change it, but we should cancel
1564 hourglass cursor anyway.
1565 But don't cancel the hourglass within a macro
1566 just because a command in the macro finishes. */
1567 if (NILP (Vexecuting_kbd_macro
))
1568 unbind_to (scount
, Qnil
);
1571 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1573 safe_run_hooks (Qpost_command_hook
);
1575 /* If displaying a message, resize the echo area window to fit
1576 that message's size exactly. */
1577 if (!NILP (echo_area_buffer
[0]))
1578 resize_echo_area_exactly ();
1580 /* If there are warnings waiting, process them. */
1581 if (!NILP (Vdelayed_warnings_list
))
1582 safe_run_hooks (Qdelayed_warnings_hook
);
1584 safe_run_hooks (Qdeferred_action_function
);
1586 /* If there is a prefix argument,
1587 1) We don't want Vlast_command to be ``universal-argument''
1588 (that would be dumb), so don't set Vlast_command,
1589 2) we want to leave echoing on so that the prefix will be
1590 echoed as part of this key sequence, so don't call
1592 3) we want to leave this_command_key_count non-zero, so that
1593 read_char will realize that it is re-reading a character, and
1594 not echo it a second time.
1596 If the command didn't actually create a prefix arg,
1597 but is merely a frame event that is transparent to prefix args,
1598 then the above doesn't apply. */
1599 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1600 || CONSP (last_command_event
))
1602 kset_last_command (current_kboard
, Vthis_command
);
1603 kset_real_last_command (current_kboard
, Vreal_this_command
);
1604 if (!CONSP (last_command_event
))
1605 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1607 this_command_key_count
= 0;
1608 this_command_key_count_reset
= 0;
1609 this_single_command_key_start
= 0;
1612 if (!NILP (BVAR (current_buffer
, mark_active
))
1613 && !NILP (Vrun_hooks
))
1615 /* In Emacs 22, setting transient-mark-mode to `only' was a
1616 way of turning it on for just one command. This usage is
1617 obsolete, but support it anyway. */
1618 if (EQ (Vtransient_mark_mode
, Qidentity
))
1619 Vtransient_mark_mode
= Qnil
;
1620 else if (EQ (Vtransient_mark_mode
, Qonly
))
1621 Vtransient_mark_mode
= Qidentity
;
1623 if (!NILP (Vdeactivate_mark
))
1624 /* If `select-active-regions' is non-nil, this call to
1625 `deactivate-mark' also sets the PRIMARY selection. */
1626 call0 (Qdeactivate_mark
);
1629 /* Even if not deactivating the mark, set PRIMARY if
1630 `select-active-regions' is non-nil. */
1631 if (!NILP (Fwindow_system (Qnil
))
1632 /* Even if mark_active is non-nil, the actual buffer
1633 marker may not have been set yet (Bug#7044). */
1634 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1635 && (EQ (Vselect_active_regions
, Qonly
)
1636 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1637 : (!NILP (Vselect_active_regions
)
1638 && !NILP (Vtransient_mark_mode
)))
1639 && NILP (Fmemq (Vthis_command
,
1640 Vselection_inhibit_update_commands
)))
1643 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1644 if (XINT (Flength (txt
)) > 0)
1645 /* Don't set empty selections. */
1646 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1649 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1651 Lisp_Object hook
= intern ("activate-mark-hook");
1652 Frun_hooks (1, &hook
);
1656 Vsaved_region_selection
= Qnil
;
1661 if (current_buffer
== prev_buffer
1662 && last_point_position
!= PT
1663 && NILP (Vdisable_point_adjustment
)
1664 && NILP (Vglobal_disable_point_adjustment
))
1666 if (last_point_position
> BEGV
1667 && last_point_position
< ZV
1668 && (composition_adjust_point (last_point_position
,
1669 last_point_position
)
1670 != last_point_position
))
1671 /* The last point was temporarily set within a grapheme
1672 cluster to prevent automatic composition. To recover
1673 the automatic composition, we must update the
1675 windows_or_buffers_changed
= 21;
1676 if (!already_adjusted
)
1677 adjust_point_for_property (last_point_position
,
1678 MODIFF
!= prev_modiff
);
1681 /* Install chars successfully executed in kbd macro. */
1683 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1684 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1685 finalize_kbd_macro_chars ();
1690 read_menu_command (void)
1692 Lisp_Object keybuf
[30];
1693 ptrdiff_t count
= SPECPDL_INDEX ();
1696 /* We don't want to echo the keystrokes while navigating the
1698 specbind (Qecho_keystrokes
, make_number (0));
1700 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1703 unbind_to (count
, Qnil
);
1705 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1707 if (i
== 0 || i
== -1)
1710 return read_key_sequence_cmd
;
1713 /* Adjust point to a boundary of a region that has such a property
1714 that should be treated intangible. For the moment, we check
1715 `composition', `display' and `invisible' properties.
1716 LAST_PT is the last position of point. */
1719 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1722 Lisp_Object val
, overlay
, tmp
;
1723 /* When called after buffer modification, we should temporarily
1724 suppress the point adjustment for automatic composition so that a
1725 user can keep inserting another character at point or keep
1726 deleting characters around point. */
1727 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1728 ptrdiff_t orig_pt
= PT
;
1730 /* FIXME: cycling is probably not necessary because these properties
1731 can't be usefully combined anyway. */
1732 while (check_composition
|| check_display
|| check_invisible
)
1734 /* FIXME: check `intangible'. */
1735 if (check_composition
1736 && PT
> BEGV
&& PT
< ZV
1737 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1740 check_display
= check_invisible
= 1;
1742 check_composition
= 0;
1744 && PT
> BEGV
&& PT
< ZV
1745 && !NILP (val
= get_char_property_and_overlay
1746 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1747 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1748 && (!OVERLAYP (overlay
)
1749 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1750 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1751 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1752 && (beg
< PT
/* && end > PT <- It's always the case. */
1753 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1756 SET_PT (PT
< last_pt
1757 ? (STRINGP (val
) && SCHARS (val
) == 0
1758 ? max (beg
- 1, BEGV
)
1761 check_composition
= check_invisible
= 1;
1764 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1770 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1773 /* FIXME: We should stop if we find a spot between
1774 two runs of `invisible' where inserted text would
1775 be visible. This is important when we have two
1776 invisible boundaries that enclose an area: if the
1777 area is empty, we need this test in order to make
1778 it possible to place point in the middle rather
1779 than skip both boundaries. However, this code
1780 also stops anywhere in a non-sticky text-property,
1781 which breaks (e.g.) Org mode. */
1782 && (val
= Fget_pos_property (make_number (end
),
1784 TEXT_PROP_MEANS_INVISIBLE (val
))
1786 && !NILP (val
= get_char_property_and_overlay
1787 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1788 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1790 ellipsis
= ellipsis
|| inv
> 1
1791 || (OVERLAYP (overlay
)
1792 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1793 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1794 tmp
= Fnext_single_char_property_change
1795 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1796 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1800 && (val
= Fget_pos_property (make_number (beg
),
1802 TEXT_PROP_MEANS_INVISIBLE (val
))
1804 && !NILP (val
= get_char_property_and_overlay
1805 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1806 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1808 ellipsis
= ellipsis
|| inv
> 1
1809 || (OVERLAYP (overlay
)
1810 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1811 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1812 tmp
= Fprevious_single_char_property_change
1813 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1814 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1817 /* Move away from the inside area. */
1818 if (beg
< PT
&& end
> PT
)
1820 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1821 /* We haven't moved yet (so we don't need to fear
1822 infinite-looping) and we were outside the range
1823 before (so either end of the range still corresponds
1824 to a move in the right direction): pretend we moved
1825 less than we actually did, so that we still have
1826 more freedom below in choosing which end of the range
1828 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1829 /* We either have moved already or the last point
1830 was already in the range: we don't get to choose
1831 which end of the range we have to go to. */
1832 : (PT
< last_pt
? beg
: end
));
1833 check_composition
= check_display
= 1;
1835 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1836 the point to something other than its argument, due to
1837 point-motion hooks, intangibility, etc. */
1838 eassert (PT
== beg
|| PT
== end
);
1841 /* Pretend the area doesn't exist if the buffer is not
1843 if (!modified
&& !ellipsis
&& beg
< end
)
1845 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1846 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1847 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1848 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1849 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1850 /* We've already moved as far as we can. Trying to go
1851 to the other end would mean moving backwards and thus
1852 could lead to an infinite loop. */
1854 else if (val
= Fget_pos_property (make_number (PT
),
1856 TEXT_PROP_MEANS_INVISIBLE (val
)
1857 && (val
= (Fget_pos_property
1858 (make_number (PT
== beg
? end
: beg
),
1860 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1861 (check_composition
= check_display
= 1,
1862 SET_PT (PT
== beg
? end
: beg
));
1865 check_invisible
= 0;
1869 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1872 safe_run_hooks_1 (void)
1874 eassert (CONSP (Vinhibit_quit
));
1875 return call0 (XCDR (Vinhibit_quit
));
1878 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1882 safe_run_hooks_error (Lisp_Object error_data
)
1885 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1886 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1887 Lisp_Object args
[4];
1888 args
[0] = build_string ("Error in %s (%S): %S");
1891 args
[3] = error_data
;
1897 Lisp_Object newval
= Qnil
;
1898 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1899 if (EQ (fun
, XCAR (val
)))
1902 newval
= Fcons (XCAR (val
), newval
);
1904 return Fset (hook
, Fnreverse (newval
));
1905 /* Not found in the local part of the hook. Let's look at the global
1908 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1909 : Fdefault_value (hook
));
1910 CONSP (val
); val
= XCDR (val
))
1911 if (EQ (fun
, XCAR (val
)))
1914 newval
= Fcons (XCAR (val
), newval
);
1916 return Fset_default (hook
, Fnreverse (newval
));
1922 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1924 eassert (nargs
== 1);
1925 if (CONSP (Vinhibit_quit
))
1926 XSETCDR (Vinhibit_quit
, args
[0]);
1928 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1930 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1934 /* If we get an error while running the hook, cause the hook variable
1935 to be nil. Also inhibit quits, so that C-g won't cause the hook
1936 to mysteriously evaporate. */
1939 safe_run_hooks (Lisp_Object hook
)
1941 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1942 to its body or to its handlers other than via globals such as
1943 dynamically-bound variables ;-) */
1944 ptrdiff_t count
= SPECPDL_INDEX ();
1945 specbind (Qinhibit_quit
, hook
);
1947 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1949 unbind_to (count
, Qnil
);
1953 /* Nonzero means polling for input is temporarily suppressed. */
1955 int poll_suppress_count
;
1958 #ifdef POLL_FOR_INPUT
1960 /* Asynchronous timer for polling. */
1962 static struct atimer
*poll_timer
;
1964 /* Poll for input, so that we catch a C-g if it comes in. */
1966 poll_for_input_1 (void)
1968 if (! input_blocked_p ()
1969 && !waiting_for_input
)
1973 /* Timer callback function for poll_timer. TIMER is equal to
1977 poll_for_input (struct atimer
*timer
)
1979 if (poll_suppress_count
== 0)
1980 pending_signals
= 1;
1983 #endif /* POLL_FOR_INPUT */
1985 /* Begin signals to poll for input, if they are appropriate.
1986 This function is called unconditionally from various places. */
1989 start_polling (void)
1991 #ifdef POLL_FOR_INPUT
1992 /* XXX This condition was (read_socket_hook && !interrupt_input),
1993 but read_socket_hook is not global anymore. Let's pretend that
1995 if (!interrupt_input
)
1997 /* Turn alarm handling on unconditionally. It might have
1998 been turned off in process.c. */
1999 turn_on_atimers (1);
2001 /* If poll timer doesn't exist, or we need one with
2002 a different interval, start a new one. */
2003 if (poll_timer
== NULL
2004 || poll_timer
->interval
.tv_sec
!= polling_period
)
2006 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2007 struct timespec interval
= make_timespec (period
, 0);
2010 cancel_atimer (poll_timer
);
2012 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2013 poll_for_input
, NULL
);
2016 /* Let the timer's callback function poll for input
2017 if this becomes zero. */
2018 --poll_suppress_count
;
2023 /* True if we are using polling to handle input asynchronously. */
2026 input_polling_used (void)
2028 #ifdef POLL_FOR_INPUT
2029 /* XXX This condition was (read_socket_hook && !interrupt_input),
2030 but read_socket_hook is not global anymore. Let's pretend that
2032 return !interrupt_input
;
2038 /* Turn off polling. */
2043 #ifdef POLL_FOR_INPUT
2044 /* XXX This condition was (read_socket_hook && !interrupt_input),
2045 but read_socket_hook is not global anymore. Let's pretend that
2047 if (!interrupt_input
)
2048 ++poll_suppress_count
;
2052 /* Set the value of poll_suppress_count to COUNT
2053 and start or stop polling accordingly. */
2056 set_poll_suppress_count (int count
)
2058 #ifdef POLL_FOR_INPUT
2059 if (count
== 0 && poll_suppress_count
!= 0)
2061 poll_suppress_count
= 1;
2064 else if (count
!= 0 && poll_suppress_count
== 0)
2068 poll_suppress_count
= count
;
2072 /* Bind polling_period to a value at least N.
2073 But don't decrease it. */
2076 bind_polling_period (int n
)
2078 #ifdef POLL_FOR_INPUT
2079 EMACS_INT
new = polling_period
;
2084 stop_other_atimers (poll_timer
);
2086 specbind (Qpolling_period
, make_number (new));
2087 /* Start a new alarm with the new period. */
2092 /* Apply the control modifier to CHARACTER. */
2098 make_ctrl_char (int c
)
2100 /* Save the upper bits here. */
2101 int upper
= c
& ~0177;
2103 if (! ASCII_BYTE_P (c
))
2104 return c
|= ctrl_modifier
;
2108 /* Everything in the columns containing the upper-case letters
2109 denotes a control character. */
2110 if (c
>= 0100 && c
< 0140)
2114 /* Set the shift modifier for a control char
2115 made from a shifted letter. But only for letters! */
2116 if (oc
>= 'A' && oc
<= 'Z')
2117 c
|= shift_modifier
;
2120 /* The lower-case letters denote control characters too. */
2121 else if (c
>= 'a' && c
<= 'z')
2124 /* Include the bits for control and shift
2125 only if the basic ASCII code can't indicate them. */
2129 /* Replace the high bits. */
2130 c
|= (upper
& ~ctrl_modifier
);
2135 /* Display the help-echo property of the character after the mouse pointer.
2136 Either show it in the echo area, or call show-help-function to display
2137 it by other means (maybe in a tooltip).
2139 If HELP is nil, that means clear the previous help echo.
2141 If HELP is a string, display that string. If HELP is a function,
2142 call it with OBJECT and POS as arguments; the function should
2143 return a help string or nil for none. For all other types of HELP,
2144 evaluate it to obtain a string.
2146 WINDOW is the window in which the help was generated, if any.
2147 It is nil if not in a window.
2149 If OBJECT is a buffer, POS is the position in the buffer where the
2150 `help-echo' text property was found.
2152 If OBJECT is an overlay, that overlay has a `help-echo' property,
2153 and POS is the position in the overlay's buffer under the mouse.
2155 If OBJECT is a string (an overlay string or a string displayed with
2156 the `display' property). POS is the position in that string under
2159 Note: this function may only be called with HELP nil or a string
2160 from X code running asynchronously. */
2163 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2166 if (!NILP (help
) && !STRINGP (help
))
2168 if (FUNCTIONP (help
))
2169 help
= safe_call (4, help
, window
, object
, pos
);
2171 help
= safe_eval (help
);
2173 if (!STRINGP (help
))
2177 if (!noninteractive
&& STRINGP (help
))
2179 /* The mouse-fixup-help-message Lisp function can call
2180 mouse_position_hook, which resets the mouse_moved flags.
2181 This causes trouble if we are trying to read a mouse motion
2182 event (i.e., if we are inside a `track-mouse' form), so we
2183 restore the mouse_moved flag. */
2184 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2185 help
= call1 (Qmouse_fixup_help_message
, help
);
2190 if (STRINGP (help
) || NILP (help
))
2192 if (!NILP (Vshow_help_function
))
2193 call1 (Vshow_help_function
, help
);
2194 help_echo_showing_p
= STRINGP (help
);
2200 /* Input of single characters from keyboard */
2202 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2203 struct timespec
*end_time
);
2204 static void record_char (Lisp_Object c
);
2206 static Lisp_Object help_form_saved_window_configs
;
2208 read_char_help_form_unwind (void)
2210 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2211 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2212 if (!NILP (window_config
))
2213 Fset_window_configuration (window_config
);
2216 #define STOP_POLLING \
2217 do { if (! polling_stopped_here) stop_polling (); \
2218 polling_stopped_here = 1; } while (0)
2220 #define RESUME_POLLING \
2221 do { if (polling_stopped_here) start_polling (); \
2222 polling_stopped_here = 0; } while (0)
2225 read_event_from_main_queue (struct timespec
*end_time
,
2226 sys_jmp_buf local_getcjmp
,
2227 bool *used_mouse_menu
)
2229 Lisp_Object c
= Qnil
;
2230 sys_jmp_buf save_jump
;
2231 KBOARD
*kb
IF_LINT (= NULL
);
2235 /* Read from the main queue, and if that gives us something we can't use yet,
2236 we put it on the appropriate side queue and try again. */
2238 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2241 /* Actually read a character, waiting if necessary. */
2242 save_getcjmp (save_jump
);
2243 restore_getcjmp (local_getcjmp
);
2245 timer_start_idle ();
2246 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2247 restore_getcjmp (save_jump
);
2249 if (! NILP (c
) && (kb
!= current_kboard
))
2251 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2254 while (CONSP (XCDR (last
)))
2256 if (!NILP (XCDR (last
)))
2260 kset_kbd_queue (kb
, list1 (c
));
2262 XSETCDR (last
, list1 (c
));
2263 kb
->kbd_queue_has_data
= 1;
2267 current_kboard
= kb
;
2268 /* This is going to exit from read_char
2269 so we had better get rid of this frame's stuff. */
2270 return make_number (-2);
2273 /* Terminate Emacs in batch mode if at eof. */
2274 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2275 Fkill_emacs (make_number (1));
2279 /* Add in any extra modifiers, where appropriate. */
2280 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2281 || ((extra_keyboard_modifiers
& 0177) < ' '
2282 && (extra_keyboard_modifiers
& 0177) != 0))
2283 XSETINT (c
, make_ctrl_char (XINT (c
)));
2285 /* Transfer any other modifier bits directly from
2286 extra_keyboard_modifiers to c. Ignore the actual character code
2287 in the low 16 bits of extra_keyboard_modifiers. */
2288 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2296 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2299 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2300 sys_jmp_buf local_getcjmp
,
2301 Lisp_Object prev_event
,
2302 bool *used_mouse_menu
)
2304 #define MAX_ENCODED_BYTES 16
2306 Lisp_Object events
[MAX_ENCODED_BYTES
];
2312 = read_event_from_main_queue (end_time
, local_getcjmp
,
2315 /* w32_console already returns decoded events. It either reads
2316 Unicode characters from the Windows keyboard input, or
2317 converts characters encoded in the current codepage into
2318 Unicode. See w32inevt.c:key_event, near its end. */
2321 struct frame
*frame
= XFRAME (selected_frame
);
2322 struct terminal
*terminal
= frame
->terminal
;
2323 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2324 /* Don't apply decoding if we're just reading a raw event
2325 (e.g. reading bytes sent by the xterm to specify the position
2326 of a mouse click). */
2327 && (!EQ (prev_event
, Qt
))
2328 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2329 & CODING_REQUIRE_DECODING_MASK
)))
2330 return nextevt
; /* No decoding needed. */
2333 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2334 eassert (n
< MAX_ENCODED_BYTES
);
2335 events
[n
++] = nextevt
;
2336 if (NATNUMP (nextevt
)
2337 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2338 { /* An encoded byte sequence, let's try to decode it. */
2339 struct coding_system
*coding
2340 = TERMINAL_KEYBOARD_CODING (terminal
);
2341 unsigned char *src
= alloca (n
);
2343 for (i
= 0; i
< n
; i
++)
2344 src
[i
] = XINT (events
[i
]);
2346 for (i
= 0; i
< n
; i
++)
2348 coding
->destination
= alloca (n
* 4);
2349 coding
->dst_bytes
= n
* 4;
2350 decode_coding_c_string (coding
, src
, n
, Qnil
);
2351 eassert (coding
->produced_char
<= n
);
2352 if (coding
->produced_char
== 0)
2353 { /* The encoded sequence is incomplete. */
2354 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2355 continue; /* Read on! */
2359 const unsigned char *p
= coding
->destination
;
2360 eassert (coding
->carryover_bytes
== 0);
2362 while (n
< coding
->produced_char
)
2363 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2366 /* Now `events' should hold decoded events.
2367 Normally, n should be equal to 1, but better not rely on it.
2368 We can only return one event here, so return the first we
2369 had and keep the others (if any) for later. */
2371 Vunread_command_events
2372 = Fcons (events
[--n
], Vunread_command_events
);
2380 echo_keystrokes_p (void)
2382 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2383 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2386 /* Read a character from the keyboard; call the redisplay if needed. */
2387 /* commandflag 0 means do not autosave, but do redisplay.
2388 -1 means do not redisplay, but do autosave.
2389 -2 means do neither.
2392 /* The argument MAP is a keymap for menu prompting.
2394 PREV_EVENT is the previous input event, or nil if we are reading
2395 the first event of a key sequence (or not reading a key sequence).
2396 If PREV_EVENT is t, that is a "magic" value that says
2397 not to run input methods, but in other respects to act as if
2398 not reading a key sequence.
2400 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2401 if we used a mouse menu to read the input, or false otherwise. If
2402 USED_MOUSE_MENU is null, don't dereference it.
2404 Value is -2 when we find input on another keyboard. A second call
2405 to read_char will read it.
2407 If END_TIME is non-null, it is a pointer to a struct timespec
2408 specifying the maximum time to wait until. If no input arrives by
2409 that time, stop waiting and return nil.
2411 Value is t if we showed a menu and the user rejected it. */
2414 read_char (int commandflag
, Lisp_Object map
,
2415 Lisp_Object prev_event
,
2416 bool *used_mouse_menu
, struct timespec
*end_time
)
2420 sys_jmp_buf local_getcjmp
;
2421 sys_jmp_buf save_jump
;
2422 Lisp_Object tem
, save
;
2423 volatile Lisp_Object previous_echo_area_message
;
2424 volatile Lisp_Object also_record
;
2425 volatile bool reread
;
2426 struct gcpro gcpro1
, gcpro2
;
2427 bool volatile polling_stopped_here
= 0;
2428 struct kboard
*orig_kboard
= current_kboard
;
2432 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2433 before_command_key_count
= this_command_key_count
;
2434 before_command_echo_length
= echo_length ();
2437 previous_echo_area_message
= Qnil
;
2439 GCPRO2 (c
, previous_echo_area_message
);
2444 if (CONSP (Vunread_post_input_method_events
))
2446 c
= XCAR (Vunread_post_input_method_events
);
2447 Vunread_post_input_method_events
2448 = XCDR (Vunread_post_input_method_events
);
2450 /* Undo what read_char_x_menu_prompt did when it unread
2451 additional keys returned by Fx_popup_menu. */
2453 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2461 if (CONSP (Vunread_command_events
))
2463 bool was_disabled
= 0;
2465 c
= XCAR (Vunread_command_events
);
2466 Vunread_command_events
= XCDR (Vunread_command_events
);
2470 /* Undo what sit-for did when it unread additional keys
2471 inside universal-argument. */
2474 && EQ (XCAR (c
), Qt
))
2480 /* Undo what read_char_x_menu_prompt did when it unread
2481 additional keys returned by Fx_popup_menu. */
2483 && EQ (XCDR (c
), Qdisabled
)
2484 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2490 /* If the queued event is something that used the mouse,
2491 set used_mouse_menu accordingly. */
2493 /* Also check was_disabled so last-nonmenu-event won't return
2494 a bad value when submenus are involved. (Bug#447) */
2495 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2496 *used_mouse_menu
= 1;
2498 goto reread_for_input_method
;
2501 if (CONSP (Vunread_input_method_events
))
2503 c
= XCAR (Vunread_input_method_events
);
2504 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2506 /* Undo what read_char_x_menu_prompt did when it unread
2507 additional keys returned by Fx_popup_menu. */
2509 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2513 goto reread_for_input_method
;
2516 this_command_key_count_reset
= 0;
2518 if (!NILP (Vexecuting_kbd_macro
))
2520 /* We set this to Qmacro; since that's not a frame, nobody will
2521 try to switch frames on us, and the selected window will
2524 Since this event came from a macro, it would be misleading to
2525 leave internal_last_event_frame set to wherever the last
2526 real event came from. Normally, a switch-frame event selects
2527 internal_last_event_frame after each command is read, but
2528 events read from a macro should never cause a new frame to be
2530 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2532 /* Exit the macro if we are at the end.
2533 Also, some things replace the macro with t
2534 to force an early exit. */
2535 if (EQ (Vexecuting_kbd_macro
, Qt
)
2536 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2542 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2543 if (STRINGP (Vexecuting_kbd_macro
)
2544 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2545 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2547 executing_kbd_macro_index
++;
2552 if (!NILP (unread_switch_frame
))
2554 c
= unread_switch_frame
;
2555 unread_switch_frame
= Qnil
;
2557 /* This event should make it into this_command_keys, and get echoed
2558 again, so we do not set `reread'. */
2562 /* If redisplay was requested. */
2563 if (commandflag
>= 0)
2565 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2567 /* If there is pending input, process any events which are not
2568 user-visible, such as X selection_request events. */
2570 || detect_input_pending_run_timers (0))
2571 swallow_events (0); /* May clear input_pending. */
2573 /* Redisplay if no pending input. */
2574 while (!input_pending
)
2576 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2577 redisplay_preserve_echo_area (5);
2582 /* Normal case: no input arrived during redisplay. */
2585 /* Input arrived and pre-empted redisplay.
2586 Process any events which are not user-visible. */
2588 /* If that cleared input_pending, try again to redisplay. */
2591 /* Prevent the redisplay we just did
2592 from messing up echoing of the input after the prompt. */
2593 if (commandflag
== 0 && echo_current
)
2594 echo_message_buffer
= echo_area_buffer
[0];
2598 /* Message turns off echoing unless more keystrokes turn it on again.
2600 The code in 20.x for the condition was
2602 1. echo_area_glyphs && *echo_area_glyphs
2603 2. && echo_area_glyphs != current_kboard->echobuf
2604 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2606 (1) means there's a current message displayed
2608 (2) means it's not the message from echoing from the current
2611 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2612 is set to a non-null value. This is done in read_char and it is
2613 set to echo_area_glyphs after a call to echo_char. That means
2614 ok_to_echo_at_next_pause is either null or
2615 current_kboard->echobuf with the appropriate current_kboard at
2618 So, condition (3) means in clear text ok_to_echo_at_next_pause
2619 must be either null, or the current message isn't from echoing at
2620 all, or it's from echoing from a different kboard than the
2623 if (/* There currently is something in the echo area. */
2624 !NILP (echo_area_buffer
[0])
2625 && (/* It's an echo from a different kboard. */
2626 echo_kboard
!= current_kboard
2627 /* Or we explicitly allow overwriting whatever there is. */
2628 || ok_to_echo_at_next_pause
== NULL
))
2633 /* Try reading a character via menu prompting in the minibuf.
2634 Try this before the sit-for, because the sit-for
2635 would do the wrong thing if we are supposed to do
2636 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2637 after a mouse event so don't try a minibuf menu. */
2639 if (KEYMAPP (map
) && INTERACTIVE
2640 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2641 /* Don't bring up a menu if we already have another event. */
2642 && NILP (Vunread_command_events
)
2643 && !detect_input_pending_run_timers (0))
2645 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2647 if (INTEGERP (c
) && XINT (c
) == -2)
2648 return c
; /* wrong_kboard_jmpbuf */
2654 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2655 We will do that below, temporarily for short sections of code,
2656 when appropriate. local_getcjmp must be in effect
2657 around any call to sit_for or kbd_buffer_get_event;
2658 it *must not* be in effect when we call redisplay. */
2660 jmpcount
= SPECPDL_INDEX ();
2661 if (sys_setjmp (local_getcjmp
))
2663 /* Handle quits while reading the keyboard. */
2664 /* We must have saved the outer value of getcjmp here,
2665 so restore it now. */
2666 restore_getcjmp (save_jump
);
2667 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2668 unbind_to (jmpcount
, Qnil
);
2669 XSETINT (c
, quit_char
);
2670 internal_last_event_frame
= selected_frame
;
2671 Vlast_event_frame
= internal_last_event_frame
;
2672 /* If we report the quit char as an event,
2673 don't do so more than once. */
2674 if (!NILP (Vinhibit_quit
))
2678 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2679 if (kb
!= current_kboard
)
2681 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2682 /* We shouldn't get here if we were in single-kboard mode! */
2687 while (CONSP (XCDR (last
)))
2689 if (!NILP (XCDR (last
)))
2693 kset_kbd_queue (kb
, list1 (c
));
2695 XSETCDR (last
, list1 (c
));
2696 kb
->kbd_queue_has_data
= 1;
2697 current_kboard
= kb
;
2698 /* This is going to exit from read_char
2699 so we had better get rid of this frame's stuff. */
2701 return make_number (-2); /* wrong_kboard_jmpbuf */
2707 /* Start idle timers if no time limit is supplied. We don't do it
2708 if a time limit is supplied to avoid an infinite recursion in the
2709 situation where an idle timer calls `sit-for'. */
2712 timer_start_idle ();
2714 /* If in middle of key sequence and minibuffer not active,
2715 start echoing if enough time elapses. */
2717 if (minibuf_level
== 0
2719 && !current_kboard
->immediate_echo
2720 && this_command_key_count
> 0
2722 && echo_keystrokes_p ()
2723 && (/* No message. */
2724 NILP (echo_area_buffer
[0])
2725 /* Or empty message. */
2726 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2727 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2728 /* Or already echoing from same kboard. */
2729 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2730 /* Or not echoing before and echoing allowed. */
2731 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2733 /* After a mouse event, start echoing right away.
2734 This is because we are probably about to display a menu,
2735 and we don't want to delay before doing so. */
2736 if (EVENT_HAS_PARAMETERS (prev_event
))
2742 save_getcjmp (save_jump
);
2743 restore_getcjmp (local_getcjmp
);
2744 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2745 restore_getcjmp (save_jump
);
2747 && ! CONSP (Vunread_command_events
))
2752 /* Maybe auto save due to number of keystrokes. */
2754 if (commandflag
!= 0 && commandflag
!= -2
2755 && auto_save_interval
> 0
2756 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2757 && !detect_input_pending_run_timers (0))
2759 Fdo_auto_save (Qnil
, Qnil
);
2760 /* Hooks can actually change some buffers in auto save. */
2764 /* Try reading using an X menu.
2765 This is never confused with reading using the minibuf
2766 because the recursive call of read_char in read_char_minibuf_menu_prompt
2767 does not pass on any keymaps. */
2769 if (KEYMAPP (map
) && INTERACTIVE
2770 && !NILP (prev_event
)
2771 && EVENT_HAS_PARAMETERS (prev_event
)
2772 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2773 && !EQ (XCAR (prev_event
), Qtool_bar
)
2774 /* Don't bring up a menu if we already have another event. */
2775 && NILP (Vunread_command_events
))
2777 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2779 /* Now that we have read an event, Emacs is not idle. */
2786 /* Maybe autosave and/or garbage collect due to idleness. */
2788 if (INTERACTIVE
&& NILP (c
))
2791 ptrdiff_t buffer_size
;
2793 /* Slow down auto saves logarithmically in size of current buffer,
2794 and garbage collect while we're at it. */
2795 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2796 last_non_minibuf_size
= Z
- BEG
;
2797 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2799 while (buffer_size
> 64)
2800 delay_level
++, buffer_size
-= buffer_size
>> 2;
2801 if (delay_level
< 4) delay_level
= 4;
2802 /* delay_level is 4 for files under around 50k, 7 at 100k,
2803 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2805 /* Auto save if enough time goes by without input. */
2806 if (commandflag
!= 0 && commandflag
!= -2
2807 && num_nonmacro_input_events
> last_auto_save
2808 && INTEGERP (Vauto_save_timeout
)
2809 && XINT (Vauto_save_timeout
) > 0)
2812 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2814 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2815 timeout
= delay_level
* timeout
/ 4;
2816 save_getcjmp (save_jump
);
2817 restore_getcjmp (local_getcjmp
);
2818 tem0
= sit_for (make_number (timeout
), 1, 1);
2819 restore_getcjmp (save_jump
);
2822 && ! CONSP (Vunread_command_events
))
2824 Fdo_auto_save (Qnil
, Qnil
);
2829 /* If there is still no input available, ask for GC. */
2830 if (!detect_input_pending_run_timers (0))
2834 /* Notify the caller if an autosave hook, or a timer, sentinel or
2835 filter in the sit_for calls above have changed the current
2836 kboard. This could happen if they use the minibuffer or start a
2837 recursive edit, like the fancy splash screen in server.el's
2838 filter. If this longjmp wasn't here, read_key_sequence would
2839 interpret the next key sequence using the wrong translation
2840 tables and function keymaps. */
2841 if (NILP (c
) && current_kboard
!= orig_kboard
)
2844 return make_number (-2); /* wrong_kboard_jmpbuf */
2847 /* If this has become non-nil here, it has been set by a timer
2848 or sentinel or filter. */
2849 if (CONSP (Vunread_command_events
))
2851 c
= XCAR (Vunread_command_events
);
2852 Vunread_command_events
= XCDR (Vunread_command_events
);
2855 /* Read something from current KBOARD's side queue, if possible. */
2859 if (current_kboard
->kbd_queue_has_data
)
2861 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2863 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2864 kset_kbd_queue (current_kboard
,
2865 XCDR (KVAR (current_kboard
, kbd_queue
)));
2866 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2867 current_kboard
->kbd_queue_has_data
= 0;
2868 input_pending
= readable_events (0);
2869 if (EVENT_HAS_PARAMETERS (c
)
2870 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2871 internal_last_event_frame
= XCAR (XCDR (c
));
2872 Vlast_event_frame
= internal_last_event_frame
;
2876 /* If current_kboard's side queue is empty check the other kboards.
2877 If one of them has data that we have not yet seen here,
2878 switch to it and process the data waiting for it.
2880 Note: if the events queued up for another kboard
2881 have already been seen here, and therefore are not a complete command,
2882 the kbd_queue_has_data field is 0, so we skip that kboard here.
2883 That's to avoid an infinite loop switching between kboards here. */
2884 if (NILP (c
) && !single_kboard
)
2887 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2888 if (kb
->kbd_queue_has_data
)
2890 current_kboard
= kb
;
2891 /* This is going to exit from read_char
2892 so we had better get rid of this frame's stuff. */
2894 return make_number (-2); /* wrong_kboard_jmpbuf */
2904 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2905 prev_event
, used_mouse_menu
);
2906 if (NILP(c
) && end_time
&&
2907 timespec_cmp (*end_time
, current_timespec ()) <= 0)
2912 if (EQ (c
, make_number (-2)))
2914 /* This is going to exit from read_char
2915 so we had better get rid of this frame's stuff. */
2929 if (commandflag
>= 0
2930 && !input_pending
&& !detect_input_pending_run_timers (0))
2936 /* Buffer switch events are only for internal wakeups
2937 so don't show them to the user.
2938 Also, don't record a key if we already did. */
2942 /* Process special events within read_char
2943 and loop around to read another event. */
2946 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2951 struct buffer
*prev_buffer
= current_buffer
;
2952 last_input_event
= c
;
2953 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2955 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2956 /* We stopped being idle for this event; undo that. This
2957 prevents automatic window selection (under
2958 mouse_autoselect_window from acting as a real input event, for
2959 example banishing the mouse under mouse-avoidance-mode. */
2960 timer_resume_idle ();
2962 if (current_buffer
!= prev_buffer
)
2964 /* The command may have changed the keymaps. Pretend there
2965 is input in another keyboard and return. This will
2966 recalculate keymaps. */
2967 c
= make_number (-2);
2974 /* Handle things that only apply to characters. */
2977 /* If kbd_buffer_get_event gave us an EOF, return that. */
2981 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2982 && UNSIGNED_CMP (XFASTINT (c
), <,
2983 SCHARS (KVAR (current_kboard
,
2984 Vkeyboard_translate_table
))))
2985 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2986 && UNSIGNED_CMP (XFASTINT (c
), <,
2987 ASIZE (KVAR (current_kboard
,
2988 Vkeyboard_translate_table
))))
2989 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2993 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2994 /* nil in keyboard-translate-table means no translation. */
3000 /* If this event is a mouse click in the menu bar,
3001 return just menu-bar for now. Modify the mouse click event
3002 so we won't do this twice, then queue it up. */
3003 if (EVENT_HAS_PARAMETERS (c
)
3005 && CONSP (EVENT_START (c
))
3006 && CONSP (XCDR (EVENT_START (c
))))
3010 posn
= POSN_POSN (EVENT_START (c
));
3011 /* Handle menu-bar events:
3012 insert the dummy prefix event `menu-bar'. */
3013 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3015 /* Change menu-bar to (menu-bar) as the event "position". */
3016 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3019 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3024 /* Store these characters into recent_keys, the dribble file if any,
3025 and the keyboard macro being defined, if any. */
3027 if (! NILP (also_record
))
3028 record_char (also_record
);
3030 /* Wipe the echo area.
3031 But first, if we are about to use an input method,
3032 save the echo area contents for it to refer to. */
3034 && ! NILP (Vinput_method_function
)
3035 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3037 previous_echo_area_message
= Fcurrent_message ();
3038 Vinput_method_previous_message
= previous_echo_area_message
;
3041 /* Now wipe the echo area, except for help events which do their
3042 own stuff with the echo area. */
3044 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3045 && !(EQ (Qswitch_frame
, XCAR (c
)))
3046 /* Don't wipe echo area for select window events: These might
3047 get delayed via `mouse-autoselect-window' (Bug#11304). */
3048 && !(EQ (Qselect_window
, XCAR (c
)))))
3050 if (!NILP (echo_area_buffer
[0]))
3052 safe_run_hooks (Qecho_area_clear_hook
);
3053 clear_message (1, 0);
3057 reread_for_input_method
:
3059 /* Pass this to the input method, if appropriate. */
3061 && ! NILP (Vinput_method_function
)
3062 /* Don't run the input method within a key sequence,
3063 after the first event of the key sequence. */
3064 && NILP (prev_event
)
3065 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3068 ptrdiff_t key_count
;
3069 bool key_count_reset
;
3070 struct gcpro gcpro1
;
3071 ptrdiff_t count
= SPECPDL_INDEX ();
3073 /* Save the echo status. */
3074 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3075 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3076 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3077 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3080 if (before_command_restore_flag
)
3082 this_command_key_count
= before_command_key_count_1
;
3083 if (this_command_key_count
< this_single_command_key_start
)
3084 this_single_command_key_start
= this_command_key_count
;
3085 echo_truncate (before_command_echo_length_1
);
3086 before_command_restore_flag
= 0;
3090 /* Save the this_command_keys status. */
3091 key_count
= this_command_key_count
;
3092 key_count_reset
= this_command_key_count_reset
;
3095 keys
= Fcopy_sequence (this_command_keys
);
3100 /* Clear out this_command_keys. */
3101 this_command_key_count
= 0;
3102 this_command_key_count_reset
= 0;
3104 /* Now wipe the echo area. */
3105 if (!NILP (echo_area_buffer
[0]))
3106 safe_run_hooks (Qecho_area_clear_hook
);
3107 clear_message (1, 0);
3110 /* If we are not reading a key sequence,
3111 never use the echo area. */
3114 specbind (Qinput_method_use_echo_area
, Qt
);
3117 /* Call the input method. */
3118 tem
= call1 (Vinput_method_function
, c
);
3120 tem
= unbind_to (count
, tem
);
3122 /* Restore the saved echoing state
3123 and this_command_keys state. */
3124 this_command_key_count
= key_count
;
3125 this_command_key_count_reset
= key_count_reset
;
3127 this_command_keys
= keys
;
3130 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3131 kset_echo_string (current_kboard
, saved_echo_string
);
3132 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3133 if (saved_immediate_echo
)
3138 /* The input method can return no events. */
3141 /* Bring back the previous message, if any. */
3142 if (! NILP (previous_echo_area_message
))
3143 message_with_string ("%s", previous_echo_area_message
, 0);
3146 /* It returned one event or more. */
3148 Vunread_post_input_method_events
3149 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3154 /* Display help if not echoing. */
3155 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3157 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3158 Lisp_Object help
, object
, position
, window
, htem
;
3160 htem
= Fcdr (XCDR (c
));
3163 window
= Fcar (htem
);
3165 object
= Fcar (htem
);
3167 position
= Fcar (htem
);
3169 show_help_echo (help
, window
, object
, position
);
3171 /* We stopped being idle for this event; undo that. */
3173 timer_resume_idle ();
3177 if ((! reread
|| this_command_key_count
== 0
3178 || this_command_key_count_reset
)
3182 /* Don't echo mouse motion events. */
3183 if (echo_keystrokes_p ()
3184 && ! (EVENT_HAS_PARAMETERS (c
)
3185 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3188 if (! NILP (also_record
))
3189 echo_char (also_record
);
3190 /* Once we reread a character, echoing can happen
3191 the next time we pause to read a new one. */
3192 ok_to_echo_at_next_pause
= current_kboard
;
3195 /* Record this character as part of the current key. */
3196 add_command_key (c
);
3197 if (! NILP (also_record
))
3198 add_command_key (also_record
);
3201 last_input_event
= c
;
3204 /* Process the help character specially if enabled. */
3205 if (!NILP (Vhelp_form
) && help_char_p (c
))
3207 ptrdiff_t count
= SPECPDL_INDEX ();
3209 help_form_saved_window_configs
3210 = Fcons (Fcurrent_window_configuration (Qnil
),
3211 help_form_saved_window_configs
);
3212 record_unwind_protect_void (read_char_help_form_unwind
);
3213 call0 (Qhelp_form_show
);
3218 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3219 if (EVENT_HAS_PARAMETERS (c
)
3220 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3221 XSETCAR (help_form_saved_window_configs
, Qnil
);
3223 while (BUFFERP (c
));
3224 /* Remove the help from the frame. */
3225 unbind_to (count
, Qnil
);
3228 if (EQ (c
, make_number (040)))
3232 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3233 while (BUFFERP (c
));
3242 /* Record a key that came from a mouse menu.
3243 Record it for echoing, for this-command-keys, and so on. */
3246 record_menu_key (Lisp_Object c
)
3248 /* Wipe the echo area. */
3249 clear_message (1, 0);
3254 before_command_key_count
= this_command_key_count
;
3255 before_command_echo_length
= echo_length ();
3258 /* Don't echo mouse motion events. */
3259 if (echo_keystrokes_p ())
3263 /* Once we reread a character, echoing can happen
3264 the next time we pause to read a new one. */
3265 ok_to_echo_at_next_pause
= 0;
3268 /* Record this character as part of the current key. */
3269 add_command_key (c
);
3271 /* Re-reading in the middle of a command. */
3272 last_input_event
= c
;
3276 /* Return true if should recognize C as "the help character". */
3279 help_char_p (Lisp_Object c
)
3283 if (EQ (c
, Vhelp_char
))
3285 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3286 if (EQ (c
, XCAR (tail
)))
3291 /* Record the input event C in various ways. */
3294 record_char (Lisp_Object c
)
3298 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3300 /* To avoid filling recent_keys with help-echo and mouse-movement
3301 events, we filter out repeated help-echo events, only store the
3302 first and last in a series of mouse-movement events, and don't
3303 store repeated help-echo events which are only separated by
3304 mouse-movement events. */
3306 Lisp_Object ev1
, ev2
, ev3
;
3309 if ((ix1
= recent_keys_index
- 1) < 0)
3310 ix1
= NUM_RECENT_KEYS
- 1;
3311 ev1
= AREF (recent_keys
, ix1
);
3313 if ((ix2
= ix1
- 1) < 0)
3314 ix2
= NUM_RECENT_KEYS
- 1;
3315 ev2
= AREF (recent_keys
, ix2
);
3317 if ((ix3
= ix2
- 1) < 0)
3318 ix3
= NUM_RECENT_KEYS
- 1;
3319 ev3
= AREF (recent_keys
, ix3
);
3321 if (EQ (XCAR (c
), Qhelp_echo
))
3323 /* Don't record `help-echo' in recent_keys unless it shows some help
3324 message, and a different help than the previously recorded
3326 Lisp_Object help
, last_help
;
3328 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3329 if (!STRINGP (help
))
3331 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3332 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3334 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3335 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3336 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3338 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3339 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3340 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3341 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3344 else if (EQ (XCAR (c
), Qmouse_movement
))
3346 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3347 So additional mouse movement events replace the last element. */
3348 Lisp_Object last_window
, window
;
3350 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3351 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3352 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3353 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3354 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3356 ASET (recent_keys
, ix1
, c
);
3362 store_kbd_macro_char (c
);
3366 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3367 ASET (recent_keys
, recent_keys_index
, c
);
3368 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3369 recent_keys_index
= 0;
3371 else if (recorded
< 0)
3373 /* We need to remove one or two events from recent_keys.
3374 To do this, we simply put nil at those events and move the
3375 recent_keys_index backwards over those events. Usually,
3376 users will never see those nil events, as they will be
3377 overwritten by the command keys entered to see recent_keys
3380 while (recorded
++ < 0 && total_keys
> 0)
3382 if (total_keys
< NUM_RECENT_KEYS
)
3384 if (--recent_keys_index
< 0)
3385 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3386 ASET (recent_keys
, recent_keys_index
, Qnil
);
3390 num_nonmacro_input_events
++;
3392 /* Write c to the dribble file. If c is a lispy event, write
3393 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3394 If you, dear reader, have a better idea, you've got the source. :-) */
3400 if (XUINT (c
) < 0x100)
3401 putc (XUINT (c
), dribble
);
3403 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3407 Lisp_Object dribblee
;
3409 /* If it's a structured event, take the event header. */
3410 dribblee
= EVENT_HEAD (c
);
3412 if (SYMBOLP (dribblee
))
3414 putc ('<', dribble
);
3415 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3416 SBYTES (SYMBOL_NAME (dribblee
)),
3418 putc ('>', dribble
);
3427 /* Copy out or in the info on where C-g should throw to.
3428 This is used when running Lisp code from within get_char,
3429 in case get_char is called recursively.
3430 See read_process_output. */
3433 save_getcjmp (sys_jmp_buf temp
)
3435 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3439 restore_getcjmp (sys_jmp_buf temp
)
3441 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3444 /* Low level keyboard/mouse input.
3445 kbd_buffer_store_event places events in kbd_buffer, and
3446 kbd_buffer_get_event retrieves them. */
3448 /* Return true if there are any events in the queue that read-char
3449 would return. If this returns false, a read-char would block. */
3451 readable_events (int flags
)
3453 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3456 /* If the buffer contains only FOCUS_IN_EVENT events, and
3457 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3458 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3460 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3461 #ifdef USE_TOOLKIT_SCROLL_BARS
3462 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3466 struct input_event
*event
;
3468 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3475 #ifdef USE_TOOLKIT_SCROLL_BARS
3476 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3478 event
->kind
== FOCUS_IN_EVENT
)
3479 #ifdef USE_TOOLKIT_SCROLL_BARS
3480 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3481 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3482 && event
->part
== scroll_bar_handle
3483 && event
->modifiers
== 0)
3488 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3491 while (event
!= kbd_store_ptr
);
3497 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3498 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3502 if (current_kboard
->kbd_queue_has_data
)
3508 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3509 if (kb
->kbd_queue_has_data
)
3515 /* Set this for debugging, to have a way to get out */
3516 int stop_character EXTERNALLY_VISIBLE
;
3519 event_to_kboard (struct input_event
*event
)
3521 /* Not applicable for these special events. */
3522 if (event
->kind
== SELECTION_REQUEST_EVENT
3523 || event
->kind
== SELECTION_CLEAR_EVENT
)
3527 Lisp_Object obj
= event
->frame_or_window
;
3528 /* There are some events that set this field to nil or string. */
3530 obj
= WINDOW_FRAME (XWINDOW (obj
));
3531 /* Also ignore dead frames here. */
3532 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3533 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3538 /* Return the number of slots occupied in kbd_buffer. */
3541 kbd_buffer_nr_stored (void)
3543 return kbd_fetch_ptr
== kbd_store_ptr
3545 : (kbd_fetch_ptr
< kbd_store_ptr
3546 ? kbd_store_ptr
- kbd_fetch_ptr
3547 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3548 + (kbd_store_ptr
- kbd_buffer
)));
3550 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3553 kbd_buffer_store_event (register struct input_event
*event
)
3555 kbd_buffer_store_event_hold (event
, 0);
3558 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3560 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3561 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3562 Else, if EVENT is a quit event, store the quit event
3563 in HOLD_QUIT, and return (thus ignoring further events).
3565 This is used to postpone the processing of the quit event until all
3566 subsequent input events have been parsed (and discarded). */
3569 kbd_buffer_store_event_hold (register struct input_event
*event
,
3570 struct input_event
*hold_quit
)
3572 if (event
->kind
== NO_EVENT
)
3575 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3578 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3580 register int c
= event
->code
& 0377;
3582 if (event
->modifiers
& ctrl_modifier
)
3583 c
= make_ctrl_char (c
);
3585 c
|= (event
->modifiers
3586 & (meta_modifier
| alt_modifier
3587 | hyper_modifier
| super_modifier
));
3591 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3592 struct input_event
*sp
;
3594 if (single_kboard
&& kb
!= current_kboard
)
3597 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3599 kb
->kbd_queue_has_data
= 1;
3600 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3602 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3605 if (event_to_kboard (sp
) == kb
)
3607 sp
->kind
= NO_EVENT
;
3608 sp
->frame_or_window
= Qnil
;
3617 *hold_quit
= *event
;
3621 /* If this results in a quit_char being returned to Emacs as
3622 input, set Vlast_event_frame properly. If this doesn't
3623 get returned to Emacs as an event, the next event read
3624 will set Vlast_event_frame again, so this is safe to do. */
3628 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3630 focus
= event
->frame_or_window
;
3631 internal_last_event_frame
= focus
;
3632 Vlast_event_frame
= focus
;
3635 handle_interrupt (0);
3639 if (c
&& c
== stop_character
)
3645 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3646 Just ignore the second one. */
3647 else if (event
->kind
== BUFFER_SWITCH_EVENT
3648 && kbd_fetch_ptr
!= kbd_store_ptr
3649 && ((kbd_store_ptr
== kbd_buffer
3650 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3651 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3654 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3655 kbd_store_ptr
= kbd_buffer
;
3657 /* Don't let the very last slot in the buffer become full,
3658 since that would make the two pointers equal,
3659 and that is indistinguishable from an empty buffer.
3660 Discard the event if it would fill the last slot. */
3661 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3663 *kbd_store_ptr
= *event
;
3666 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3668 /* Don't read keyboard input until we have processed kbd_buffer.
3669 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3670 hold_keyboard_input ();
3671 if (!noninteractive
)
3675 #endif /* subprocesses */
3678 /* If we're inside while-no-input, and this event qualifies
3679 as input, set quit-flag to cause an interrupt. */
3680 if (!NILP (Vthrow_on_input
)
3681 && event
->kind
!= FOCUS_IN_EVENT
3682 && event
->kind
!= HELP_EVENT
3683 && event
->kind
!= DEICONIFY_EVENT
)
3685 Vquit_flag
= Vthrow_on_input
;
3686 /* If we're inside a function that wants immediate quits,
3688 if (immediate_quit
&& NILP (Vinhibit_quit
))
3697 /* Put an input event back in the head of the event queue. */
3700 kbd_buffer_unget_event (register struct input_event
*event
)
3702 if (kbd_fetch_ptr
== kbd_buffer
)
3703 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3705 /* Don't let the very last slot in the buffer become full, */
3706 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3709 *kbd_fetch_ptr
= *event
;
3714 /* Generate a HELP_EVENT input_event and store it in the keyboard
3717 HELP is the help form.
3719 FRAME and WINDOW are the frame and window where the help is
3720 generated. OBJECT is the Lisp object where the help was found (a
3721 buffer, a string, an overlay, or nil if neither from a string nor
3722 from a buffer). POS is the position within OBJECT where the help
3726 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3727 Lisp_Object object
, ptrdiff_t pos
)
3729 struct input_event event
;
3733 event
.kind
= HELP_EVENT
;
3734 event
.frame_or_window
= frame
;
3736 event
.x
= WINDOWP (window
) ? window
: frame
;
3739 kbd_buffer_store_event (&event
);
3743 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3746 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3748 struct input_event event
;
3750 event
.kind
= HELP_EVENT
;
3751 event
.frame_or_window
= frame
;
3756 kbd_buffer_store_event (&event
);
3760 /* Discard any mouse events in the event buffer by setting them to
3763 discard_mouse_events (void)
3765 struct input_event
*sp
;
3766 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3768 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3771 if (sp
->kind
== MOUSE_CLICK_EVENT
3772 || sp
->kind
== WHEEL_EVENT
3773 || sp
->kind
== HORIZ_WHEEL_EVENT
3775 || sp
->kind
== GPM_CLICK_EVENT
3777 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3779 sp
->kind
= NO_EVENT
;
3785 /* Return true if there are any real events waiting in the event
3786 buffer, not counting `NO_EVENT's.
3788 Discard NO_EVENT events at the front of the input queue, possibly
3789 leaving the input queue empty if there are no real input events. */
3792 kbd_buffer_events_waiting (void)
3794 struct input_event
*sp
;
3796 for (sp
= kbd_fetch_ptr
;
3797 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3800 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3805 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3809 /* Clear input event EVENT. */
3812 clear_event (struct input_event
*event
)
3814 event
->kind
= NO_EVENT
;
3818 /* Read one event from the event buffer, waiting if necessary.
3819 The value is a Lisp object representing the event.
3820 The value is nil for an event that should be ignored,
3821 or that was handled here.
3822 We always read and discard one event. */
3825 kbd_buffer_get_event (KBOARD
**kbp
,
3826 bool *used_mouse_menu
,
3827 struct timespec
*end_time
)
3832 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3834 /* Start reading input again because we have processed enough to
3835 be able to accept new events again. */
3836 unhold_keyboard_input ();
3839 #endif /* subprocesses */
3841 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3843 /* In case we are running as a daemon, only do this before
3844 detaching from the terminal. */
3845 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3849 *kbp
= current_kboard
;
3852 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3854 /* Wait until there is input available. */
3857 /* Break loop if there's an unread command event. Needed in
3858 moused window autoselection which uses a timer to insert such
3860 if (CONSP (Vunread_command_events
))
3863 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3865 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3868 /* If the quit flag is set, then read_char will return
3869 quit_char, so that counts as "available input." */
3870 if (!NILP (Vquit_flag
))
3871 quit_throw_to_read_char (0);
3873 /* One way or another, wait until input is available; then, if
3874 interrupt handlers have not read it, read it now. */
3879 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3881 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3885 struct timespec now
= current_timespec ();
3886 if (timespec_cmp (*end_time
, now
) <= 0)
3887 return Qnil
; /* Finished waiting. */
3890 struct timespec duration
= timespec_sub (*end_time
, now
);
3891 wait_reading_process_output (min (duration
.tv_sec
,
3894 -1, 1, Qnil
, NULL
, 0);
3899 bool do_display
= true;
3901 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3903 struct tty_display_info
*tty
= CURTTY ();
3905 /* When this TTY is displaying a menu, we must prevent
3906 any redisplay, because we modify the frame's glyph
3907 matrix behind the back of the display engine. */
3908 if (tty
->showing_menu
)
3912 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3915 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3919 if (CONSP (Vunread_command_events
))
3922 first
= XCAR (Vunread_command_events
);
3923 Vunread_command_events
= XCDR (Vunread_command_events
);
3924 *kbp
= current_kboard
;
3928 /* At this point, we know that there is a readable event available
3929 somewhere. If the event queue is empty, then there must be a
3930 mouse movement enabled and available. */
3931 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3933 struct input_event
*event
;
3935 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3939 *kbp
= event_to_kboard (event
);
3941 *kbp
= current_kboard
; /* Better than returning null ptr? */
3945 /* These two kinds of events get special handling
3946 and don't actually appear to the command loop.
3947 We return nil for them. */
3948 if (event
->kind
== SELECTION_REQUEST_EVENT
3949 || event
->kind
== SELECTION_CLEAR_EVENT
)
3952 struct input_event copy
;
3954 /* Remove it from the buffer before processing it,
3955 since otherwise swallow_events will see it
3956 and process it again. */
3958 kbd_fetch_ptr
= event
+ 1;
3959 input_pending
= readable_events (0);
3960 x_handle_selection_event (©
);
3962 /* We're getting selection request events, but we don't have
3968 #if defined (HAVE_NS)
3969 else if (event
->kind
== NS_TEXT_EVENT
)
3971 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3972 obj
= list1 (intern ("ns-put-working-text"));
3974 obj
= list1 (intern ("ns-unput-working-text"));
3975 kbd_fetch_ptr
= event
+ 1;
3976 if (used_mouse_menu
)
3977 *used_mouse_menu
= 1;
3981 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3982 || defined (HAVE_NS)
3983 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3985 /* Make an event (delete-frame (FRAME)). */
3986 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3987 kbd_fetch_ptr
= event
+ 1;
3990 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3991 || defined (HAVE_NS)
3992 else if (event
->kind
== ICONIFY_EVENT
)
3994 /* Make an event (iconify-frame (FRAME)). */
3995 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3996 kbd_fetch_ptr
= event
+ 1;
3998 else if (event
->kind
== DEICONIFY_EVENT
)
4000 /* Make an event (make-frame-visible (FRAME)). */
4001 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
4002 kbd_fetch_ptr
= event
+ 1;
4005 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4007 /* The value doesn't matter here; only the type is tested. */
4008 XSETBUFFER (obj
, current_buffer
);
4009 kbd_fetch_ptr
= event
+ 1;
4011 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4012 || defined (HAVE_NS) || defined (USE_GTK)
4013 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4015 kbd_fetch_ptr
= event
+ 1;
4016 input_pending
= readable_events (0);
4017 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4018 x_activate_menubar (XFRAME (event
->frame_or_window
));
4022 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4024 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4025 obj
= list4 (Qlanguage_change
,
4026 event
->frame_or_window
,
4027 make_number (event
->code
),
4028 make_number (event
->modifiers
));
4029 kbd_fetch_ptr
= event
+ 1;
4032 #ifdef USE_FILE_NOTIFY
4033 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4035 #ifdef HAVE_W32NOTIFY
4036 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4037 obj
= list3 (Qfile_notify
,
4038 list3 (make_number (event
->code
),
4041 event
->frame_or_window
);
4043 obj
= make_lispy_event (event
);
4045 kbd_fetch_ptr
= event
+ 1;
4047 #endif /* USE_FILE_NOTIFY */
4048 else if (event
->kind
== SAVE_SESSION_EVENT
)
4050 obj
= list2 (Qsave_session
, event
->arg
);
4051 kbd_fetch_ptr
= event
+ 1;
4053 /* Just discard these, by returning nil.
4054 With MULTI_KBOARD, these events are used as placeholders
4055 when we need to randomly delete events from the queue.
4056 (They shouldn't otherwise be found in the buffer,
4057 but on some machines it appears they do show up
4058 even without MULTI_KBOARD.) */
4059 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4060 mouse events during a popup-menu call. */
4061 else if (event
->kind
== NO_EVENT
)
4062 kbd_fetch_ptr
= event
+ 1;
4063 else if (event
->kind
== HELP_EVENT
)
4065 Lisp_Object object
, position
, help
, frame
, window
;
4067 frame
= event
->frame_or_window
;
4068 object
= event
->arg
;
4069 position
= make_number (event
->code
);
4072 clear_event (event
);
4074 kbd_fetch_ptr
= event
+ 1;
4075 if (!WINDOWP (window
))
4077 obj
= Fcons (Qhelp_echo
,
4078 list5 (frame
, help
, window
, object
, position
));
4080 else if (event
->kind
== FOCUS_IN_EVENT
)
4082 /* Notification of a FocusIn event. The frame receiving the
4083 focus is in event->frame_or_window. Generate a
4084 switch-frame event if necessary. */
4085 Lisp_Object frame
, focus
;
4087 frame
= event
->frame_or_window
;
4088 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4097 !EQ (frame
, internal_last_event_frame
)
4098 && !EQ (frame
, selected_frame
))
4099 obj
= make_lispy_switch_frame (frame
);
4101 obj
= make_lispy_focus_in (frame
);
4103 internal_last_event_frame
= frame
;
4104 kbd_fetch_ptr
= event
+ 1;
4106 else if (event
->kind
== FOCUS_OUT_EVENT
)
4108 #ifdef HAVE_WINDOW_SYSTEM
4111 Lisp_Object frame
= event
->frame_or_window
;
4112 bool focused
= false;
4114 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4115 focused
= di
->x_highlight_frame
!= 0;
4118 obj
= make_lispy_focus_out (frame
);
4120 #endif /* HAVE_WINDOW_SYSTEM */
4122 kbd_fetch_ptr
= event
+ 1;
4125 else if (event
->kind
== DBUS_EVENT
)
4127 obj
= make_lispy_event (event
);
4128 kbd_fetch_ptr
= event
+ 1;
4131 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4133 obj
= make_lispy_event (event
);
4134 kbd_fetch_ptr
= event
+ 1;
4138 /* If this event is on a different frame, return a switch-frame this
4139 time, and leave the event in the queue for next time. */
4143 frame
= event
->frame_or_window
;
4145 frame
= XCAR (frame
);
4146 else if (WINDOWP (frame
))
4147 frame
= WINDOW_FRAME (XWINDOW (frame
));
4149 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4153 if (! EQ (frame
, internal_last_event_frame
)
4154 && !EQ (frame
, selected_frame
))
4155 obj
= make_lispy_switch_frame (frame
);
4156 internal_last_event_frame
= frame
;
4158 /* If we didn't decide to make a switch-frame event, go ahead
4159 and build a real event from the queue entry. */
4163 obj
= make_lispy_event (event
);
4165 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4166 || defined (HAVE_NS) || defined (USE_GTK)
4167 /* If this was a menu selection, then set the flag to inhibit
4168 writing to last_nonmenu_event. Don't do this if the event
4169 we're returning is (menu-bar), though; that indicates the
4170 beginning of the menu sequence, and we might as well leave
4171 that as the `event with parameters' for this selection. */
4173 && !EQ (event
->frame_or_window
, event
->arg
)
4174 && (event
->kind
== MENU_BAR_EVENT
4175 || event
->kind
== TOOL_BAR_EVENT
))
4176 *used_mouse_menu
= 1;
4179 /* Certain system events are non-key events. */
4181 && event
->kind
== NS_NONKEY_EVENT
)
4182 *used_mouse_menu
= 1;
4185 /* Wipe out this event, to catch bugs. */
4186 clear_event (event
);
4187 kbd_fetch_ptr
= event
+ 1;
4191 /* Try generating a mouse motion event. */
4192 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4194 struct frame
*f
= some_mouse_moved ();
4195 Lisp_Object bar_window
;
4196 enum scroll_bar_part part
;
4200 *kbp
= current_kboard
;
4201 /* Note that this uses F to determine which terminal to look at.
4202 If there is no valid info, it does not store anything
4203 so x remains nil. */
4206 /* XXX Can f or mouse_position_hook be NULL here? */
4207 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4208 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4213 /* Decide if we should generate a switch-frame event. Don't
4214 generate switch-frame events for motion outside of all Emacs
4220 frame
= FRAME_FOCUS_FRAME (f
);
4222 XSETFRAME (frame
, f
);
4224 if (! EQ (frame
, internal_last_event_frame
)
4225 && !EQ (frame
, selected_frame
))
4226 obj
= make_lispy_switch_frame (frame
);
4227 internal_last_event_frame
= frame
;
4230 /* If we didn't decide to make a switch-frame event, go ahead and
4231 return a mouse-motion event. */
4232 if (!NILP (x
) && NILP (obj
))
4233 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4236 /* We were promised by the above while loop that there was
4237 something for us to read! */
4240 input_pending
= readable_events (0);
4242 Vlast_event_frame
= internal_last_event_frame
;
4247 /* Process any non-user-visible events (currently X selection events),
4248 without reading any user-visible events. */
4251 process_special_events (void)
4253 struct input_event
*event
;
4255 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4257 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4260 if (event
== kbd_store_ptr
)
4264 /* If we find a stored X selection request, handle it now. */
4265 if (event
->kind
== SELECTION_REQUEST_EVENT
4266 || event
->kind
== SELECTION_CLEAR_EVENT
)
4270 /* Remove the event from the fifo buffer before processing;
4271 otherwise swallow_events called recursively could see it
4272 and process it again. To do this, we move the events
4273 between kbd_fetch_ptr and EVENT one slot to the right,
4276 struct input_event copy
= *event
;
4277 struct input_event
*beg
4278 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4279 ? kbd_buffer
: kbd_fetch_ptr
;
4282 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4283 else if (event
< beg
)
4285 if (event
> kbd_buffer
)
4286 memmove (kbd_buffer
+ 1, kbd_buffer
,
4287 (event
- kbd_buffer
) * sizeof (struct input_event
));
4288 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4289 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4290 memmove (beg
+ 1, beg
,
4291 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4292 * sizeof (struct input_event
));
4295 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4296 kbd_fetch_ptr
= kbd_buffer
+ 1;
4300 input_pending
= readable_events (0);
4301 x_handle_selection_event (©
);
4303 /* We're getting selection request events, but we don't have
4311 /* Process any events that are not user-visible, run timer events that
4312 are ripe, and return, without reading any user-visible events. */
4315 swallow_events (bool do_display
)
4317 unsigned old_timers_run
;
4319 process_special_events ();
4321 old_timers_run
= timers_run
;
4322 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4324 if (timers_run
!= old_timers_run
&& do_display
)
4325 redisplay_preserve_echo_area (7);
4328 /* Record the start of when Emacs is idle,
4329 for the sake of running idle-time timers. */
4332 timer_start_idle (void)
4334 /* If we are already in the idle state, do nothing. */
4335 if (timespec_valid_p (timer_idleness_start_time
))
4338 timer_idleness_start_time
= current_timespec ();
4339 timer_last_idleness_start_time
= timer_idleness_start_time
;
4341 /* Mark all idle-time timers as once again candidates for running. */
4342 call0 (intern ("internal-timer-start-idle"));
4345 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4348 timer_stop_idle (void)
4350 timer_idleness_start_time
= invalid_timespec ();
4353 /* Resume idle timer from last idle start time. */
4356 timer_resume_idle (void)
4358 if (timespec_valid_p (timer_idleness_start_time
))
4361 timer_idleness_start_time
= timer_last_idleness_start_time
;
4364 /* This is only for debugging. */
4365 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4367 /* List of elisp functions to call, delayed because they were generated in
4368 a context where Elisp could not be safely run (e.g. redisplay, signal,
4369 ...). Each element has the form (FUN . ARGS). */
4370 Lisp_Object pending_funcalls
;
4372 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4374 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4376 Lisp_Object
*vector
;
4378 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4380 vector
= XVECTOR (timer
)->contents
;
4381 if (! NILP (vector
[0]))
4384 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4389 /* Check whether a timer has fired. To prevent larger problems we simply
4390 disregard elements that are not proper timers. Do not make a circular
4391 timer list for the time being.
4393 Returns the time to wait until the next timer fires. If a
4394 timer is triggering now, return zero.
4395 If no timer is active, return -1.
4397 If a timer is ripe, we run it, with quitting turned off.
4398 In that case we return 0 to indicate that a new timer_check_2 call
4401 static struct timespec
4402 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4404 struct timespec nexttime
;
4405 struct timespec now
;
4406 struct timespec idleness_now
;
4407 Lisp_Object chosen_timer
;
4408 struct gcpro gcpro1
;
4410 nexttime
= invalid_timespec ();
4412 chosen_timer
= Qnil
;
4413 GCPRO1 (chosen_timer
);
4415 /* First run the code that was delayed. */
4416 while (CONSP (pending_funcalls
))
4418 Lisp_Object funcall
= XCAR (pending_funcalls
);
4419 pending_funcalls
= XCDR (pending_funcalls
);
4420 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4423 if (CONSP (timers
) || CONSP (idle_timers
))
4425 now
= current_timespec ();
4426 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4427 ? timespec_sub (now
, timer_idleness_start_time
)
4428 : make_timespec (0, 0));
4431 while (CONSP (timers
) || CONSP (idle_timers
))
4433 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4434 struct timespec timer_time
, idle_timer_time
;
4435 struct timespec difference
;
4436 struct timespec timer_difference
= invalid_timespec ();
4437 struct timespec idle_timer_difference
= invalid_timespec ();
4438 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4440 /* Set TIMER and TIMER_DIFFERENCE
4441 based on the next ordinary timer.
4442 TIMER_DIFFERENCE is the distance in time from NOW to when
4443 this timer becomes ripe (negative if it's already ripe).
4444 Skip past invalid timers and timers already handled. */
4447 timer
= XCAR (timers
);
4448 if (! decode_timer (timer
, &timer_time
))
4450 timers
= XCDR (timers
);
4454 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4455 timer_difference
= (timer_ripe
4456 ? timespec_sub (now
, timer_time
)
4457 : timespec_sub (timer_time
, now
));
4460 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4461 based on the next idle timer. */
4462 if (CONSP (idle_timers
))
4464 idle_timer
= XCAR (idle_timers
);
4465 if (! decode_timer (idle_timer
, &idle_timer_time
))
4467 idle_timers
= XCDR (idle_timers
);
4471 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4472 idle_timer_difference
4474 ? timespec_sub (idleness_now
, idle_timer_time
)
4475 : timespec_sub (idle_timer_time
, idleness_now
));
4478 /* Decide which timer is the next timer,
4479 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4480 Also step down the list where we found that timer. */
4482 if (timespec_valid_p (timer_difference
)
4483 && (! timespec_valid_p (idle_timer_difference
)
4484 || idle_timer_ripe
< timer_ripe
4485 || (idle_timer_ripe
== timer_ripe
4487 ? timespec_cmp (idle_timer_difference
,
4489 : timespec_cmp (timer_difference
,
4490 idle_timer_difference
))
4493 chosen_timer
= timer
;
4494 timers
= XCDR (timers
);
4495 difference
= timer_difference
;
4500 chosen_timer
= idle_timer
;
4501 idle_timers
= XCDR (idle_timers
);
4502 difference
= idle_timer_difference
;
4503 ripe
= idle_timer_ripe
;
4506 /* If timer is ripe, run it if it hasn't been run. */
4509 if (NILP (AREF (chosen_timer
, 0)))
4511 ptrdiff_t count
= SPECPDL_INDEX ();
4512 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4514 /* Mark the timer as triggered to prevent problems if the lisp
4515 code fails to reschedule it right. */
4516 ASET (chosen_timer
, 0, Qt
);
4518 specbind (Qinhibit_quit
, Qt
);
4520 call1 (Qtimer_event_handler
, chosen_timer
);
4521 Vdeactivate_mark
= old_deactivate_mark
;
4523 unbind_to (count
, Qnil
);
4525 /* Since we have handled the event,
4526 we don't need to tell the caller to wake up and do it. */
4527 /* But the caller must still wait for the next timer, so
4528 return 0 to indicate that. */
4531 nexttime
= make_timespec (0, 0);
4535 /* When we encounter a timer that is still waiting,
4536 return the amount of time to wait before it is ripe. */
4543 /* No timers are pending in the future. */
4544 /* Return 0 if we generated an event, and -1 if not. */
4550 /* Check whether a timer has fired. To prevent larger problems we simply
4551 disregard elements that are not proper timers. Do not make a circular
4552 timer list for the time being.
4554 Returns the time to wait until the next timer fires.
4555 If no timer is active, return an invalid value.
4557 As long as any timer is ripe, we run it. */
4562 struct timespec nexttime
;
4563 Lisp_Object timers
, idle_timers
;
4564 struct gcpro gcpro1
, gcpro2
;
4566 Lisp_Object tem
= Vinhibit_quit
;
4569 /* We use copies of the timers' lists to allow a timer to add itself
4570 again, without locking up Emacs if the newly added timer is
4571 already ripe when added. */
4573 /* Always consider the ordinary timers. */
4574 timers
= Fcopy_sequence (Vtimer_list
);
4575 /* Consider the idle timers only if Emacs is idle. */
4576 if (timespec_valid_p (timer_idleness_start_time
))
4577 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4581 Vinhibit_quit
= tem
;
4583 GCPRO2 (timers
, idle_timers
);
4587 nexttime
= timer_check_2 (timers
, idle_timers
);
4589 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4595 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4596 doc
: /* Return the current length of Emacs idleness, or nil.
4597 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4598 in the same style as (current-time).
4600 The value when Emacs is not idle is nil.
4602 PSEC is a multiple of the system clock resolution. */)
4605 if (timespec_valid_p (timer_idleness_start_time
))
4606 return make_lisp_time (timespec_sub (current_timespec (),
4607 timer_idleness_start_time
));
4612 /* Caches for modify_event_symbol. */
4613 static Lisp_Object accent_key_syms
;
4614 static Lisp_Object func_key_syms
;
4615 static Lisp_Object mouse_syms
;
4616 static Lisp_Object wheel_syms
;
4617 static Lisp_Object drag_n_drop_syms
;
4619 /* This is a list of keysym codes for special "accent" characters.
4620 It parallels lispy_accent_keys. */
4622 static const int lispy_accent_codes
[] =
4624 #ifdef XK_dead_circumflex
4629 #ifdef XK_dead_grave
4634 #ifdef XK_dead_tilde
4639 #ifdef XK_dead_diaeresis
4644 #ifdef XK_dead_macron
4649 #ifdef XK_dead_degree
4654 #ifdef XK_dead_acute
4659 #ifdef XK_dead_cedilla
4664 #ifdef XK_dead_breve
4669 #ifdef XK_dead_ogonek
4674 #ifdef XK_dead_caron
4679 #ifdef XK_dead_doubleacute
4680 XK_dead_doubleacute
,
4684 #ifdef XK_dead_abovedot
4689 #ifdef XK_dead_abovering
4699 #ifdef XK_dead_belowdot
4704 #ifdef XK_dead_voiced_sound
4705 XK_dead_voiced_sound
,
4709 #ifdef XK_dead_semivoiced_sound
4710 XK_dead_semivoiced_sound
,
4726 /* This is a list of Lisp names for special "accent" characters.
4727 It parallels lispy_accent_codes. */
4729 static const char *const lispy_accent_keys
[] =
4747 "dead-voiced-sound",
4748 "dead-semivoiced-sound",
4754 #define FUNCTION_KEY_OFFSET 0x0
4756 const char *const lispy_function_keys
[] =
4760 0, /* VK_LBUTTON 0x01 */
4761 0, /* VK_RBUTTON 0x02 */
4762 "cancel", /* VK_CANCEL 0x03 */
4763 0, /* VK_MBUTTON 0x04 */
4765 0, 0, 0, /* 0x05 .. 0x07 */
4767 "backspace", /* VK_BACK 0x08 */
4768 "tab", /* VK_TAB 0x09 */
4770 0, 0, /* 0x0A .. 0x0B */
4772 "clear", /* VK_CLEAR 0x0C */
4773 "return", /* VK_RETURN 0x0D */
4775 0, 0, /* 0x0E .. 0x0F */
4777 0, /* VK_SHIFT 0x10 */
4778 0, /* VK_CONTROL 0x11 */
4779 0, /* VK_MENU 0x12 */
4780 "pause", /* VK_PAUSE 0x13 */
4781 "capslock", /* VK_CAPITAL 0x14 */
4782 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4784 "junja", /* VK_JUNJA 0x17 */
4785 "final", /* VK_FINAL 0x18 */
4786 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4788 "escape", /* VK_ESCAPE 0x1B */
4789 "convert", /* VK_CONVERT 0x1C */
4790 "non-convert", /* VK_NONCONVERT 0x1D */
4791 "accept", /* VK_ACCEPT 0x1E */
4792 "mode-change", /* VK_MODECHANGE 0x1F */
4793 0, /* VK_SPACE 0x20 */
4794 "prior", /* VK_PRIOR 0x21 */
4795 "next", /* VK_NEXT 0x22 */
4796 "end", /* VK_END 0x23 */
4797 "home", /* VK_HOME 0x24 */
4798 "left", /* VK_LEFT 0x25 */
4799 "up", /* VK_UP 0x26 */
4800 "right", /* VK_RIGHT 0x27 */
4801 "down", /* VK_DOWN 0x28 */
4802 "select", /* VK_SELECT 0x29 */
4803 "print", /* VK_PRINT 0x2A */
4804 "execute", /* VK_EXECUTE 0x2B */
4805 "snapshot", /* VK_SNAPSHOT 0x2C */
4806 "insert", /* VK_INSERT 0x2D */
4807 "delete", /* VK_DELETE 0x2E */
4808 "help", /* VK_HELP 0x2F */
4810 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4812 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4814 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4816 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4818 0, 0, 0, 0, 0, 0, 0, 0, 0,
4819 0, 0, 0, 0, 0, 0, 0, 0, 0,
4820 0, 0, 0, 0, 0, 0, 0, 0,
4822 "lwindow", /* VK_LWIN 0x5B */
4823 "rwindow", /* VK_RWIN 0x5C */
4824 "apps", /* VK_APPS 0x5D */
4827 "kp-0", /* VK_NUMPAD0 0x60 */
4828 "kp-1", /* VK_NUMPAD1 0x61 */
4829 "kp-2", /* VK_NUMPAD2 0x62 */
4830 "kp-3", /* VK_NUMPAD3 0x63 */
4831 "kp-4", /* VK_NUMPAD4 0x64 */
4832 "kp-5", /* VK_NUMPAD5 0x65 */
4833 "kp-6", /* VK_NUMPAD6 0x66 */
4834 "kp-7", /* VK_NUMPAD7 0x67 */
4835 "kp-8", /* VK_NUMPAD8 0x68 */
4836 "kp-9", /* VK_NUMPAD9 0x69 */
4837 "kp-multiply", /* VK_MULTIPLY 0x6A */
4838 "kp-add", /* VK_ADD 0x6B */
4839 "kp-separator", /* VK_SEPARATOR 0x6C */
4840 "kp-subtract", /* VK_SUBTRACT 0x6D */
4841 "kp-decimal", /* VK_DECIMAL 0x6E */
4842 "kp-divide", /* VK_DIVIDE 0x6F */
4843 "f1", /* VK_F1 0x70 */
4844 "f2", /* VK_F2 0x71 */
4845 "f3", /* VK_F3 0x72 */
4846 "f4", /* VK_F4 0x73 */
4847 "f5", /* VK_F5 0x74 */
4848 "f6", /* VK_F6 0x75 */
4849 "f7", /* VK_F7 0x76 */
4850 "f8", /* VK_F8 0x77 */
4851 "f9", /* VK_F9 0x78 */
4852 "f10", /* VK_F10 0x79 */
4853 "f11", /* VK_F11 0x7A */
4854 "f12", /* VK_F12 0x7B */
4855 "f13", /* VK_F13 0x7C */
4856 "f14", /* VK_F14 0x7D */
4857 "f15", /* VK_F15 0x7E */
4858 "f16", /* VK_F16 0x7F */
4859 "f17", /* VK_F17 0x80 */
4860 "f18", /* VK_F18 0x81 */
4861 "f19", /* VK_F19 0x82 */
4862 "f20", /* VK_F20 0x83 */
4863 "f21", /* VK_F21 0x84 */
4864 "f22", /* VK_F22 0x85 */
4865 "f23", /* VK_F23 0x86 */
4866 "f24", /* VK_F24 0x87 */
4868 0, 0, 0, 0, /* 0x88 .. 0x8B */
4869 0, 0, 0, 0, /* 0x8C .. 0x8F */
4871 "kp-numlock", /* VK_NUMLOCK 0x90 */
4872 "scroll", /* VK_SCROLL 0x91 */
4873 /* Not sure where the following block comes from.
4874 Windows headers have NEC and Fujitsu specific keys in
4875 this block, but nothing generic. */
4876 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4877 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4878 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4879 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4880 "kp-end", /* VK_NUMPAD_END 0x96 */
4881 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4882 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4883 "kp-up", /* VK_NUMPAD_UP 0x99 */
4884 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4885 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4886 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4887 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4889 0, 0, /* 0x9E .. 0x9F */
4892 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4893 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4894 * No other API or message will distinguish left and right keys this way.
4899 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4900 to enable them selectively, and gives access to a few more functions.
4901 See lispy_multimedia_keys below. */
4902 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4903 0, 0, 0, /* 0xAD .. 0xAF Volume */
4904 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4905 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4907 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4908 0, 0, 0, 0, 0, 0, 0, 0, 0,
4910 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4911 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4912 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4915 "ax", /* VK_OEM_AX 0xE1 */
4916 0, /* VK_OEM_102 0xE2 */
4917 "ico-help", /* VK_ICO_HELP 0xE3 */
4918 "ico-00", /* VK_ICO_00 0xE4 */
4919 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4920 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4921 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4923 "reset", /* VK_OEM_RESET 0xE9 */
4924 "jump", /* VK_OEM_JUMP 0xEA */
4925 "oem-pa1", /* VK_OEM_PA1 0xEB */
4926 "oem-pa2", /* VK_OEM_PA2 0xEC */
4927 "oem-pa3", /* VK_OEM_PA3 0xED */
4928 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4929 "cusel", /* VK_OEM_CUSEL 0xEF */
4930 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4931 "finish", /* VK_OEM_FINISH 0xF1 */
4932 "copy", /* VK_OEM_COPY 0xF2 */
4933 "auto", /* VK_OEM_AUTO 0xF3 */
4934 "enlw", /* VK_OEM_ENLW 0xF4 */
4935 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4936 "attn", /* VK_ATTN 0xF6 */
4937 "crsel", /* VK_CRSEL 0xF7 */
4938 "exsel", /* VK_EXSEL 0xF8 */
4939 "ereof", /* VK_EREOF 0xF9 */
4940 "play", /* VK_PLAY 0xFA */
4941 "zoom", /* VK_ZOOM 0xFB */
4942 "noname", /* VK_NONAME 0xFC */
4943 "pa1", /* VK_PA1 0xFD */
4944 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4948 /* Some of these duplicate the "Media keys" on newer keyboards,
4949 but they are delivered to the application in a different way. */
4950 static const char *const lispy_multimedia_keys
[] =
4958 "browser-favorites",
4995 "toggle-dictate-command",
5001 "media-fast-forward",
5004 "media-channel-down"
5007 #else /* not HAVE_NTGUI */
5009 /* This should be dealt with in XTread_socket now, and that doesn't
5010 depend on the client system having the Kana syms defined. See also
5011 the XK_kana_A case below. */
5014 static const char *const lispy_kana_keys
[] =
5016 /* X Keysym value */
5017 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5018 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5019 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5020 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5021 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5022 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5023 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5024 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5025 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5026 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5027 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5028 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5029 "kana-i", "kana-u", "kana-e", "kana-o",
5030 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5031 "prolongedsound", "kana-A", "kana-I", "kana-U",
5032 "kana-E", "kana-O", "kana-KA", "kana-KI",
5033 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5034 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5035 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5036 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5037 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5038 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5039 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5040 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5041 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5042 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5043 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5044 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5046 #endif /* XK_kana_A */
5049 #define FUNCTION_KEY_OFFSET 0xff00
5051 /* You'll notice that this table is arranged to be conveniently
5052 indexed by X Windows keysym values. */
5053 static const char *const lispy_function_keys
[] =
5055 /* X Keysym value */
5057 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5058 "backspace", "tab", "linefeed", "clear",
5060 0, 0, 0, "pause", /* 0xff10...1f */
5061 0, 0, 0, 0, 0, 0, 0, "escape",
5063 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5064 "romaji", "hiragana", "katakana", "hiragana-katakana",
5065 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5066 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5067 "eisu-toggle", /* 0xff30...3f */
5068 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5069 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5071 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5072 "down", "prior", "next", "end",
5073 "begin", 0, 0, 0, 0, 0, 0, 0,
5074 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5085 "break", /* 0xff6b */
5088 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5089 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5090 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5091 0, 0, 0, 0, 0, 0, 0, 0,
5092 "kp-tab", /* 0xff89 */
5094 "kp-enter", /* 0xff8d */
5096 "kp-f1", /* 0xff91 */
5100 "kp-home", /* 0xff95 */
5105 "kp-prior", /* kp-page-up */
5106 "kp-next", /* kp-page-down */
5112 0, 0, 0, 0, 0, 0, 0, 0, 0,
5113 "kp-multiply", /* 0xffaa */
5118 "kp-divide", /* 0xffaf */
5119 "kp-0", /* 0xffb0 */
5120 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5123 "kp-equal", /* 0xffbd */
5124 "f1", /* 0xffbe */ /* IsFunctionKey */
5126 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5127 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5128 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5129 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5130 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5131 0, 0, 0, 0, 0, 0, 0, 0,
5132 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5133 0, 0, 0, 0, 0, 0, 0, "delete"
5136 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5137 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5139 static const char *const iso_lispy_function_keys
[] =
5141 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5142 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5143 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5144 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5145 "iso-lefttab", /* 0xfe20 */
5146 "iso-move-line-up", "iso-move-line-down",
5147 "iso-partial-line-up", "iso-partial-line-down",
5148 "iso-partial-space-left", "iso-partial-space-right",
5149 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5150 "iso-release-margin-left", "iso-release-margin-right",
5151 "iso-release-both-margins",
5152 "iso-fast-cursor-left", "iso-fast-cursor-right",
5153 "iso-fast-cursor-up", "iso-fast-cursor-down",
5154 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5155 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5158 #endif /* not HAVE_NTGUI */
5160 static Lisp_Object Vlispy_mouse_stem
;
5162 static const char *const lispy_wheel_names
[] =
5164 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5167 /* drag-n-drop events are generated when a set of selected files are
5168 dragged from another application and dropped onto an Emacs window. */
5169 static const char *const lispy_drag_n_drop_names
[] =
5174 /* Scroll bar parts. */
5175 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5176 Lisp_Object Qup
, Qdown
, Qbottom
;
5177 static Lisp_Object Qend_scroll
;
5179 static Lisp_Object Qratio
;
5181 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5182 static Lisp_Object
*const scroll_bar_parts
[] = {
5183 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5184 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5187 /* A vector, indexed by button number, giving the down-going location
5188 of currently depressed buttons, both scroll bar and non-scroll bar.
5190 The elements have the form
5191 (BUTTON-NUMBER MODIFIER-MASK . REST)
5192 where REST is the cdr of a position as it would be reported in the event.
5194 The make_lispy_event function stores positions here to tell the
5195 difference between click and drag events, and to store the starting
5196 location to be included in drag events. */
5198 static Lisp_Object button_down_location
;
5200 /* Information about the most recent up-going button event: Which
5201 button, what location, and what time. */
5203 static int last_mouse_button
;
5204 static int last_mouse_x
;
5205 static int last_mouse_y
;
5206 static Time button_down_time
;
5208 /* The number of clicks in this multiple-click. */
5210 static int double_click_count
;
5212 /* X and Y are frame-relative coordinates for a click or wheel event.
5213 Return a Lisp-style event list. */
5216 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5219 enum window_part part
;
5220 Lisp_Object posn
= Qnil
;
5221 Lisp_Object extra_info
= Qnil
;
5222 /* Coordinate pixel positions to return. */
5223 int xret
= 0, yret
= 0;
5224 /* The window under frame pixel coordinates (x,y) */
5225 Lisp_Object window
= f
5226 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5229 if (WINDOWP (window
))
5231 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5232 struct window
*w
= XWINDOW (window
);
5233 Lisp_Object string_info
= Qnil
;
5234 ptrdiff_t textpos
= -1;
5235 int col
= -1, row
= -1;
5236 int dx
= -1, dy
= -1;
5237 int width
= -1, height
= -1;
5238 Lisp_Object object
= Qnil
;
5240 /* Pixel coordinates relative to the window corner. */
5241 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5242 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5244 /* For text area clicks, return X, Y relative to the corner of
5245 this text area. Note that dX, dY etc are set below, by
5246 buffer_posn_from_coords. */
5247 if (part
== ON_TEXT
)
5249 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5250 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5252 /* For mode line and header line clicks, return X, Y relative to
5253 the left window edge. Use mode_line_string to look for a
5254 string on the click position. */
5255 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5260 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5261 /* Note that mode_line_string takes COL, ROW as pixels and
5262 converts them to characters. */
5265 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5266 &object
, &dx
, &dy
, &width
, &height
);
5267 if (STRINGP (string
))
5268 string_info
= Fcons (string
, make_number (charpos
));
5269 textpos
= (w
== XWINDOW (selected_window
)
5270 && current_buffer
== XBUFFER (w
->contents
))
5271 ? PT
: marker_position (w
->pointm
);
5276 /* For fringes and margins, Y is relative to the area's (and the
5277 window's) top edge, while X is meaningless. */
5278 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5283 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5286 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5287 &object
, &dx
, &dy
, &width
, &height
);
5288 if (STRINGP (string
))
5289 string_info
= Fcons (string
, make_number (charpos
));
5290 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5292 else if (part
== ON_LEFT_FRINGE
)
5294 posn
= Qleft_fringe
;
5297 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5298 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5299 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5301 else if (part
== ON_RIGHT_FRINGE
)
5303 posn
= Qright_fringe
;
5306 - window_box_width (w
, LEFT_MARGIN_AREA
)
5307 - window_box_width (w
, TEXT_AREA
)
5308 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5309 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5311 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5313 else if (part
== ON_VERTICAL_BORDER
)
5315 posn
= Qvertical_line
;
5320 /* Nothing special for part == ON_SCROLL_BAR. */
5321 else if (part
== ON_RIGHT_DIVIDER
)
5323 posn
= Qright_divider
;
5324 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5328 else if (part
== ON_BOTTOM_DIVIDER
)
5330 posn
= Qbottom_divider
;
5331 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5336 /* For clicks in the text area, fringes, or margins, call
5337 buffer_posn_from_coords to extract TEXTPOS, the buffer
5338 position nearest to the click. */
5341 Lisp_Object string2
, object2
= Qnil
;
5342 struct display_pos p
;
5344 int width2
, height2
;
5345 /* The pixel X coordinate passed to buffer_posn_from_coords
5346 is the X coordinate relative to the text area for
5347 text-area and right-margin clicks, zero otherwise. */
5349 = (part
== ON_TEXT
) ? xret
5350 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5351 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5355 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5356 &object2
, &dx2
, &dy2
,
5358 textpos
= CHARPOS (p
.pos
);
5359 if (col
< 0) col
= x2
;
5360 if (row
< 0) row
= y2
;
5361 if (dx
< 0) dx
= dx2
;
5362 if (dy
< 0) dy
= dy2
;
5363 if (width
< 0) width
= width2
;
5364 if (height
< 0) height
= height2
;
5368 posn
= make_number (textpos
);
5369 if (STRINGP (string2
))
5370 string_info
= Fcons (string2
,
5371 make_number (CHARPOS (p
.string_pos
)));
5377 #ifdef HAVE_WINDOW_SYSTEM
5378 if (IMAGEP (object
))
5380 Lisp_Object image_map
, hotspot
;
5381 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5383 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5385 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5386 posn
= XCAR (hotspot
);
5393 Fcons (make_number (dx
), make_number (dy
)),
5394 Fcons (make_number (width
), make_number (height
)));
5397 extra_info
= Fcons (string_info
,
5398 Fcons (make_number (textpos
),
5399 Fcons (Fcons (make_number (col
),
5404 XSETFRAME (window
, f
);
5408 return Fcons (window
,
5410 Fcons (Fcons (make_number (xret
),
5411 make_number (yret
)),
5412 Fcons (make_number (t
),
5416 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5417 menu bar. This really means that Emacs draws and manages the menu
5418 bar as part of its normal display, and therefore can compute its
5421 toolkit_menubar_in_use (struct frame
*f
)
5423 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5424 return !(!FRAME_WINDOW_P (f
));
5430 /* Given a struct input_event, build the lisp event which represents
5431 it. If EVENT is 0, build a mouse movement event from the mouse
5432 movement buffer, which should have a movement event in it.
5434 Note that events must be passed to this function in the order they
5435 are received; this function stores the location of button presses
5436 in order to build drag events when the button is released. */
5439 make_lispy_event (struct input_event
*event
)
5443 switch (event
->kind
)
5445 /* A simple keystroke. */
5446 case ASCII_KEYSTROKE_EVENT
:
5447 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5449 Lisp_Object lispy_c
;
5450 EMACS_INT c
= event
->code
;
5451 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5454 eassert (c
== event
->code
);
5455 /* Turn ASCII characters into control characters
5457 if (event
->modifiers
& ctrl_modifier
)
5459 c
= make_ctrl_char (c
);
5460 event
->modifiers
&= ~ctrl_modifier
;
5464 /* Add in the other modifier bits. The shift key was taken care
5465 of by the X code. */
5466 c
|= (event
->modifiers
5467 & (meta_modifier
| alt_modifier
5468 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5469 /* Distinguish Shift-SPC from SPC. */
5470 if ((event
->code
) == 040
5471 && event
->modifiers
& shift_modifier
)
5472 c
|= shift_modifier
;
5473 button_down_time
= 0;
5474 XSETFASTINT (lispy_c
, c
);
5479 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5480 except that they are non-key events (last-nonmenu-event is nil). */
5481 case NS_NONKEY_EVENT
:
5484 /* A function key. The symbol may need to have modifier prefixes
5486 case NON_ASCII_KEYSTROKE_EVENT
:
5487 button_down_time
= 0;
5489 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5490 if (event
->code
== lispy_accent_codes
[i
])
5491 return modify_event_symbol (i
,
5493 Qfunction_key
, Qnil
,
5494 lispy_accent_keys
, &accent_key_syms
,
5495 ARRAYELTS (lispy_accent_keys
));
5499 if (event
->code
>= 0x400 && event
->code
< 0x500)
5500 return modify_event_symbol (event
->code
- 0x400,
5501 event
->modifiers
& ~shift_modifier
,
5502 Qfunction_key
, Qnil
,
5503 lispy_kana_keys
, &func_key_syms
,
5504 ARRAYELTS (lispy_kana_keys
));
5505 #endif /* XK_kana_A */
5508 #ifdef ISO_FUNCTION_KEY_OFFSET
5509 if (event
->code
< FUNCTION_KEY_OFFSET
5510 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5511 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5513 Qfunction_key
, Qnil
,
5514 iso_lispy_function_keys
, &func_key_syms
,
5515 ARRAYELTS (iso_lispy_function_keys
));
5518 /* Handle system-specific or unknown keysyms. */
5519 if (event
->code
& (1 << 28)
5520 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5521 || (event
->code
- FUNCTION_KEY_OFFSET
5522 >= ARRAYELTS (lispy_function_keys
))
5523 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5525 /* We need to use an alist rather than a vector as the cache
5526 since we can't make a vector long enough. */
5527 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5528 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5529 return modify_event_symbol (event
->code
,
5532 KVAR (current_kboard
, Vsystem_key_alist
),
5533 0, &KVAR (current_kboard
, system_key_syms
),
5537 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5539 Qfunction_key
, Qnil
,
5540 lispy_function_keys
, &func_key_syms
,
5541 ARRAYELTS (lispy_function_keys
));
5544 case MULTIMEDIA_KEY_EVENT
:
5545 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5546 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5548 return modify_event_symbol (event
->code
, event
->modifiers
,
5549 Qfunction_key
, Qnil
,
5550 lispy_multimedia_keys
, &func_key_syms
,
5551 ARRAYELTS (lispy_multimedia_keys
));
5556 /* A mouse click. Figure out where it is, decide whether it's
5557 a press, click or drag, and build the appropriate structure. */
5558 case MOUSE_CLICK_EVENT
:
5560 case GPM_CLICK_EVENT
:
5562 #ifndef USE_TOOLKIT_SCROLL_BARS
5563 case SCROLL_BAR_CLICK_EVENT
:
5566 int button
= event
->code
;
5568 Lisp_Object position
;
5569 Lisp_Object
*start_pos_ptr
;
5570 Lisp_Object start_pos
;
5574 /* Build the position as appropriate for this mouse click. */
5575 if (event
->kind
== MOUSE_CLICK_EVENT
5577 || event
->kind
== GPM_CLICK_EVENT
5581 struct frame
*f
= XFRAME (event
->frame_or_window
);
5584 /* Ignore mouse events that were made on frame that
5585 have been deleted. */
5586 if (! FRAME_LIVE_P (f
))
5589 /* EVENT->x and EVENT->y are frame-relative pixel
5590 coordinates at this place. Under old redisplay, COLUMN
5591 and ROW are set to frame relative glyph coordinates
5592 which are then used to determine whether this click is
5593 in a menu (non-toolkit version). */
5594 if (!toolkit_menubar_in_use (f
))
5596 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5597 &column
, &row
, NULL
, 1);
5599 /* In the non-toolkit version, clicks on the menu bar
5600 are ordinary button events in the event buffer.
5601 Distinguish them, and invoke the menu.
5603 (In the toolkit version, the toolkit handles the
5604 menu bar and Emacs doesn't know about it until
5605 after the user makes a selection.) */
5606 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5607 && (event
->modifiers
& down_modifier
))
5609 Lisp_Object items
, item
;
5611 /* Find the menu bar item under `column'. */
5613 items
= FRAME_MENU_BAR_ITEMS (f
);
5614 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5616 Lisp_Object pos
, string
;
5617 string
= AREF (items
, i
+ 1);
5618 pos
= AREF (items
, i
+ 3);
5621 if (column
>= XINT (pos
)
5622 && column
< XINT (pos
) + SCHARS (string
))
5624 item
= AREF (items
, i
);
5629 /* ELisp manual 2.4b says (x y) are window
5630 relative but code says they are
5632 position
= list4 (event
->frame_or_window
,
5634 Fcons (event
->x
, event
->y
),
5635 make_number (event
->timestamp
));
5637 return list2 (item
, position
);
5641 position
= make_lispy_position (f
, event
->x
, event
->y
,
5644 #ifndef USE_TOOLKIT_SCROLL_BARS
5647 /* It's a scrollbar click. */
5649 Lisp_Object portion_whole
;
5652 window
= event
->frame_or_window
;
5653 portion_whole
= Fcons (event
->x
, event
->y
);
5654 part
= *scroll_bar_parts
[(int) event
->part
];
5656 position
= list5 (window
, Qvertical_scroll_bar
,
5657 portion_whole
, make_number (event
->timestamp
),
5660 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5662 if (button
>= ASIZE (button_down_location
))
5664 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5665 button_down_location
= larger_vector (button_down_location
,
5667 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5670 start_pos_ptr
= aref_addr (button_down_location
, button
);
5671 start_pos
= *start_pos_ptr
;
5672 *start_pos_ptr
= Qnil
;
5675 /* On window-system frames, use the value of
5676 double-click-fuzz as is. On other frames, interpret it
5677 as a multiple of 1/8 characters. */
5681 if (WINDOWP (event
->frame_or_window
))
5682 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5683 else if (FRAMEP (event
->frame_or_window
))
5684 f
= XFRAME (event
->frame_or_window
);
5688 if (FRAME_WINDOW_P (f
))
5689 fuzz
= double_click_fuzz
;
5691 fuzz
= double_click_fuzz
/ 8;
5693 is_double
= (button
== last_mouse_button
5694 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5695 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5696 && button_down_time
!= 0
5697 && (EQ (Vdouble_click_time
, Qt
)
5698 || (NATNUMP (Vdouble_click_time
)
5699 && (event
->timestamp
- button_down_time
5700 < XFASTINT (Vdouble_click_time
)))));
5703 last_mouse_button
= button
;
5704 last_mouse_x
= XINT (event
->x
);
5705 last_mouse_y
= XINT (event
->y
);
5707 /* If this is a button press, squirrel away the location, so
5708 we can decide later whether it was a click or a drag. */
5709 if (event
->modifiers
& down_modifier
)
5713 double_click_count
++;
5714 event
->modifiers
|= ((double_click_count
> 2)
5719 double_click_count
= 1;
5720 button_down_time
= event
->timestamp
;
5721 *start_pos_ptr
= Fcopy_alist (position
);
5722 ignore_mouse_drag_p
= 0;
5725 /* Now we're releasing a button - check the co-ordinates to
5726 see if this was a click or a drag. */
5727 else if (event
->modifiers
& up_modifier
)
5729 /* If we did not see a down before this up, ignore the up.
5730 Probably this happened because the down event chose a
5731 menu item. It would be an annoyance to treat the
5732 release of the button that chose the menu item as a
5735 if (!CONSP (start_pos
))
5738 event
->modifiers
&= ~up_modifier
;
5741 Lisp_Object new_down
, down
;
5742 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5744 /* The third element of every position
5745 should be the (x,y) pair. */
5746 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5747 new_down
= Fcar (Fcdr (Fcdr (position
)));
5750 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5752 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5753 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5756 if (ignore_mouse_drag_p
)
5758 event
->modifiers
|= click_modifier
;
5759 ignore_mouse_drag_p
= 0;
5761 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5762 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5763 /* Maybe the mouse has moved a lot, caused scrolling, and
5764 eventually ended up at the same screen position (but
5765 not buffer position) in which case it is a drag, not
5767 /* FIXME: OTOH if the buffer position has changed
5768 because of a timer or process filter rather than
5769 because of mouse movement, it should be considered as
5770 a click. But mouse-drag-region completely ignores
5771 this case and it hasn't caused any real problem, so
5772 it's probably OK to ignore it as well. */
5773 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5774 /* Mouse hasn't moved (much). */
5775 event
->modifiers
|= click_modifier
;
5778 button_down_time
= 0;
5779 event
->modifiers
|= drag_modifier
;
5782 /* Don't check is_double; treat this as multiple
5783 if the down-event was multiple. */
5784 if (double_click_count
> 1)
5785 event
->modifiers
|= ((double_click_count
> 2)
5791 /* Every mouse event should either have the down_modifier or
5792 the up_modifier set. */
5796 /* Get the symbol we should use for the mouse click. */
5799 head
= modify_event_symbol (button
,
5801 Qmouse_click
, Vlispy_mouse_stem
,
5804 ASIZE (mouse_syms
));
5805 if (event
->modifiers
& drag_modifier
)
5806 return list3 (head
, start_pos
, position
);
5807 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5808 return list3 (head
, position
, make_number (double_click_count
));
5810 return list2 (head
, position
);
5815 case HORIZ_WHEEL_EVENT
:
5817 Lisp_Object position
;
5820 /* Build the position as appropriate for this mouse click. */
5821 struct frame
*f
= XFRAME (event
->frame_or_window
);
5823 /* Ignore wheel events that were made on frame that have been
5825 if (! FRAME_LIVE_P (f
))
5828 position
= make_lispy_position (f
, event
->x
, event
->y
,
5831 /* Set double or triple modifiers to indicate the wheel speed. */
5833 /* On window-system frames, use the value of
5834 double-click-fuzz as is. On other frames, interpret it
5835 as a multiple of 1/8 characters. */
5841 if (WINDOWP (event
->frame_or_window
))
5842 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5843 else if (FRAMEP (event
->frame_or_window
))
5844 fr
= XFRAME (event
->frame_or_window
);
5848 fuzz
= FRAME_WINDOW_P (fr
)
5849 ? double_click_fuzz
: double_click_fuzz
/ 8;
5851 if (event
->modifiers
& up_modifier
)
5853 /* Emit a wheel-up event. */
5854 event
->modifiers
&= ~up_modifier
;
5857 else if (event
->modifiers
& down_modifier
)
5859 /* Emit a wheel-down event. */
5860 event
->modifiers
&= ~down_modifier
;
5864 /* Every wheel event should either have the down_modifier or
5865 the up_modifier set. */
5868 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5871 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5872 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5873 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5874 && button_down_time
!= 0
5875 && (EQ (Vdouble_click_time
, Qt
)
5876 || (NATNUMP (Vdouble_click_time
)
5877 && (event
->timestamp
- button_down_time
5878 < XFASTINT (Vdouble_click_time
)))));
5881 double_click_count
++;
5882 event
->modifiers
|= ((double_click_count
> 2)
5888 double_click_count
= 1;
5889 event
->modifiers
|= click_modifier
;
5892 button_down_time
= event
->timestamp
;
5893 /* Use a negative value to distinguish wheel from mouse button. */
5894 last_mouse_button
= - (1 + symbol_num
);
5895 last_mouse_x
= XINT (event
->x
);
5896 last_mouse_y
= XINT (event
->y
);
5898 /* Get the symbol we should use for the wheel event. */
5899 head
= modify_event_symbol (symbol_num
,
5905 ASIZE (wheel_syms
));
5908 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5909 return list3 (head
, position
, make_number (double_click_count
));
5911 return list2 (head
, position
);
5915 #ifdef USE_TOOLKIT_SCROLL_BARS
5917 /* We don't have down and up events if using toolkit scroll bars,
5918 so make this always a click event. Store in the `part' of
5919 the Lisp event a symbol which maps to the following actions:
5921 `above_handle' page up
5922 `below_handle' page down
5926 `bottom' bottom of buffer
5927 `handle' thumb has been dragged.
5928 `end-scroll' end of interaction with scroll bar
5930 The incoming input_event contains in its `part' member an
5931 index of type `enum scroll_bar_part' which we can use as an
5932 index in scroll_bar_parts to get the appropriate symbol. */
5934 case SCROLL_BAR_CLICK_EVENT
:
5936 Lisp_Object position
, head
, window
, portion_whole
, part
;
5938 window
= event
->frame_or_window
;
5939 portion_whole
= Fcons (event
->x
, event
->y
);
5940 part
= *scroll_bar_parts
[(int) event
->part
];
5942 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5943 make_number (event
->timestamp
), part
);
5945 /* Always treat scroll bar events as clicks. */
5946 event
->modifiers
|= click_modifier
;
5947 event
->modifiers
&= ~up_modifier
;
5949 if (event
->code
>= ASIZE (mouse_syms
))
5950 mouse_syms
= larger_vector (mouse_syms
,
5951 event
->code
- ASIZE (mouse_syms
) + 1,
5954 /* Get the symbol we should use for the mouse click. */
5955 head
= modify_event_symbol (event
->code
,
5960 ASIZE (mouse_syms
));
5961 return list2 (head
, position
);
5964 #endif /* USE_TOOLKIT_SCROLL_BARS */
5966 case DRAG_N_DROP_EVENT
:
5969 Lisp_Object head
, position
;
5972 f
= XFRAME (event
->frame_or_window
);
5975 /* Ignore mouse events that were made on frames that
5976 have been deleted. */
5977 if (! FRAME_LIVE_P (f
))
5980 position
= make_lispy_position (f
, event
->x
, event
->y
,
5983 head
= modify_event_symbol (0, event
->modifiers
,
5985 lispy_drag_n_drop_names
,
5986 &drag_n_drop_syms
, 1);
5987 return list3 (head
, position
, files
);
5990 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5991 || defined (HAVE_NS) || defined (USE_GTK)
5992 case MENU_BAR_EVENT
:
5993 if (EQ (event
->arg
, event
->frame_or_window
))
5994 /* This is the prefix key. We translate this to
5995 `(menu_bar)' because the code in keyboard.c for menu
5996 events, which we use, relies on this. */
5997 return list1 (Qmenu_bar
);
6001 case SELECT_WINDOW_EVENT
:
6002 /* Make an event (select-window (WINDOW)). */
6003 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6005 case TOOL_BAR_EVENT
:
6006 if (EQ (event
->arg
, event
->frame_or_window
))
6007 /* This is the prefix key. We translate this to
6008 `(tool_bar)' because the code in keyboard.c for tool bar
6009 events, which we use, relies on this. */
6010 return list1 (Qtool_bar
);
6011 else if (SYMBOLP (event
->arg
))
6012 return apply_modifiers (event
->modifiers
, event
->arg
);
6015 case USER_SIGNAL_EVENT
:
6016 /* A user signal. */
6018 char *name
= find_user_signal_name (event
->code
);
6021 return intern (name
);
6024 case SAVE_SESSION_EVENT
:
6025 return Qsave_session
;
6030 return Fcons (Qdbus_event
, event
->arg
);
6032 #endif /* HAVE_DBUS */
6034 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6035 case FILE_NOTIFY_EVENT
:
6037 return Fcons (Qfile_notify
, event
->arg
);
6039 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6041 case CONFIG_CHANGED_EVENT
:
6042 return list3 (Qconfig_changed_event
,
6043 event
->arg
, event
->frame_or_window
);
6045 /* The 'kind' field of the event is something we don't recognize. */
6052 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6053 Lisp_Object x
, Lisp_Object y
, Time t
)
6055 /* Is it a scroll bar movement? */
6056 if (frame
&& ! NILP (bar_window
))
6058 Lisp_Object part_sym
;
6060 part_sym
= *scroll_bar_parts
[(int) part
];
6061 return list2 (Qscroll_bar_movement
,
6063 Qvertical_scroll_bar
,
6068 /* Or is it an ordinary mouse movement? */
6071 Lisp_Object position
;
6072 position
= make_lispy_position (frame
, x
, y
, t
);
6073 return list2 (Qmouse_movement
, position
);
6077 /* Construct a switch frame event. */
6079 make_lispy_switch_frame (Lisp_Object frame
)
6081 return list2 (Qswitch_frame
, frame
);
6085 make_lispy_focus_in (Lisp_Object frame
)
6087 return list2 (Qfocus_in
, frame
);
6090 #ifdef HAVE_WINDOW_SYSTEM
6093 make_lispy_focus_out (Lisp_Object frame
)
6095 return list2 (Qfocus_out
, frame
);
6098 #endif /* HAVE_WINDOW_SYSTEM */
6100 /* Manipulating modifiers. */
6102 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6104 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6105 SYMBOL's name of the end of the modifiers; the string from this
6106 position is the unmodified symbol name.
6108 This doesn't use any caches. */
6111 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6117 CHECK_SYMBOL (symbol
);
6120 name
= SYMBOL_NAME (symbol
);
6122 for (i
= 0; i
< SBYTES (name
) - 1; )
6124 ptrdiff_t this_mod_end
= 0;
6127 /* See if the name continues with a modifier word.
6128 Check that the word appears, but don't check what follows it.
6129 Set this_mod and this_mod_end to record what we find. */
6131 switch (SREF (name
, i
))
6133 #define SINGLE_LETTER_MOD(BIT) \
6134 (this_mod_end = i + 1, this_mod = BIT)
6137 SINGLE_LETTER_MOD (alt_modifier
);
6141 SINGLE_LETTER_MOD (ctrl_modifier
);
6145 SINGLE_LETTER_MOD (hyper_modifier
);
6149 SINGLE_LETTER_MOD (meta_modifier
);
6153 SINGLE_LETTER_MOD (shift_modifier
);
6157 SINGLE_LETTER_MOD (super_modifier
);
6160 #undef SINGLE_LETTER_MOD
6162 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6163 if (i + LEN + 1 <= SBYTES (name) \
6164 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6166 this_mod_end = i + LEN; \
6171 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6172 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6173 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6177 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6179 #undef MULTI_LETTER_MOD
6183 /* If we found no modifier, stop looking for them. */
6184 if (this_mod_end
== 0)
6187 /* Check there is a dash after the modifier, so that it
6188 really is a modifier. */
6189 if (this_mod_end
>= SBYTES (name
)
6190 || SREF (name
, this_mod_end
) != '-')
6193 /* This modifier is real; look for another. */
6194 modifiers
|= this_mod
;
6195 i
= this_mod_end
+ 1;
6198 /* Should we include the `click' modifier? */
6199 if (! (modifiers
& (down_modifier
| drag_modifier
6200 | double_modifier
| triple_modifier
))
6201 && i
+ 7 == SBYTES (name
)
6202 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6203 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6204 modifiers
|= click_modifier
;
6206 if (! (modifiers
& (double_modifier
| triple_modifier
))
6207 && i
+ 6 < SBYTES (name
)
6208 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6209 modifiers
|= click_modifier
;
6217 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6218 prepended to the string BASE[0..BASE_LEN-1].
6219 This doesn't use any caches. */
6221 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6223 /* Since BASE could contain nulls, we can't use intern here; we have
6224 to use Fintern, which expects a genuine Lisp_String, and keeps a
6226 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6232 /* Only the event queue may use the `up' modifier; it should always
6233 be turned into a click or drag event before presented to lisp code. */
6234 if (modifiers
& up_modifier
)
6237 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6238 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6239 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6240 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6241 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6242 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6243 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6244 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6245 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6246 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6247 /* The click modifier is denoted by the absence of other modifiers. */
6251 mod_len
= p
- new_mods
;
6255 Lisp_Object new_name
;
6257 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6258 mod_len
+ base_len_byte
);
6259 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6260 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6262 return Fintern (new_name
, Qnil
);
6267 static const char *const modifier_names
[] =
6269 "up", "down", "drag", "click", "double", "triple", 0, 0,
6270 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6271 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6273 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6275 static Lisp_Object modifier_symbols
;
6277 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6279 lispy_modifier_list (int modifiers
)
6281 Lisp_Object modifier_list
;
6284 modifier_list
= Qnil
;
6285 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6286 if (modifiers
& (1<<i
))
6287 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6290 return modifier_list
;
6294 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6295 where UNMODIFIED is the unmodified form of SYMBOL,
6296 MASK is the set of modifiers present in SYMBOL's name.
6297 This is similar to parse_modifiers_uncached, but uses the cache in
6298 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6299 Qevent_symbol_elements property. */
6301 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6304 parse_modifiers (Lisp_Object symbol
)
6306 Lisp_Object elements
;
6308 if (INTEGERP (symbol
))
6309 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6310 else if (!SYMBOLP (symbol
))
6313 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6314 if (CONSP (elements
))
6319 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6320 Lisp_Object unmodified
;
6323 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6324 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6327 if (modifiers
& ~INTMASK
)
6329 XSETFASTINT (mask
, modifiers
);
6330 elements
= list2 (unmodified
, mask
);
6332 /* Cache the parsing results on SYMBOL. */
6333 Fput (symbol
, Qevent_symbol_element_mask
,
6335 Fput (symbol
, Qevent_symbol_elements
,
6336 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6338 /* Since we know that SYMBOL is modifiers applied to unmodified,
6339 it would be nice to put that in unmodified's cache.
6340 But we can't, since we're not sure that parse_modifiers is
6347 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6348 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6349 doc
: /* Parse the event symbol. For internal use. */)
6350 (Lisp_Object symbol
)
6352 /* Fill the cache if needed. */
6353 parse_modifiers (symbol
);
6354 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6355 and use the Lispier representation stored on Qevent_symbol_elements
6357 return Fget (symbol
, Qevent_symbol_elements
);
6360 /* Apply the modifiers MODIFIERS to the symbol BASE.
6361 BASE must be unmodified.
6363 This is like apply_modifiers_uncached, but uses BASE's
6364 Qmodifier_cache property, if present. It also builds
6365 Qevent_symbol_elements properties, since it has that info anyway.
6367 apply_modifiers copies the value of BASE's Qevent_kind property to
6368 the modified symbol. */
6370 apply_modifiers (int modifiers
, Lisp_Object base
)
6372 Lisp_Object cache
, idx
, entry
, new_symbol
;
6374 /* Mask out upper bits. We don't know where this value's been. */
6375 modifiers
&= INTMASK
;
6377 if (INTEGERP (base
))
6378 return make_number (XINT (base
) | modifiers
);
6380 /* The click modifier never figures into cache indices. */
6381 cache
= Fget (base
, Qmodifier_cache
);
6382 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6383 entry
= assq_no_quit (idx
, cache
);
6386 new_symbol
= XCDR (entry
);
6389 /* We have to create the symbol ourselves. */
6390 new_symbol
= apply_modifiers_uncached (modifiers
,
6391 SSDATA (SYMBOL_NAME (base
)),
6392 SCHARS (SYMBOL_NAME (base
)),
6393 SBYTES (SYMBOL_NAME (base
)));
6395 /* Add the new symbol to the base's cache. */
6396 entry
= Fcons (idx
, new_symbol
);
6397 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6399 /* We have the parsing info now for free, so we could add it to
6401 XSETFASTINT (idx, modifiers);
6402 Fput (new_symbol, Qevent_symbol_element_mask,
6404 Fput (new_symbol, Qevent_symbol_elements,
6405 Fcons (base, lispy_modifier_list (modifiers)));
6406 Sadly, this is only correct if `base' is indeed a base event,
6407 which is not necessarily the case. -stef */
6410 /* Make sure this symbol is of the same kind as BASE.
6412 You'd think we could just set this once and for all when we
6413 intern the symbol above, but reorder_modifiers may call us when
6414 BASE's property isn't set right; we can't assume that just
6415 because it has a Qmodifier_cache property it must have its
6416 Qevent_kind set right as well. */
6417 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6421 kind
= Fget (base
, Qevent_kind
);
6423 Fput (new_symbol
, Qevent_kind
, kind
);
6430 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6431 return a symbol with the modifiers placed in the canonical order.
6432 Canonical order is alphabetical, except for down and drag, which
6433 always come last. The 'click' modifier is never written out.
6435 Fdefine_key calls this to make sure that (for example) C-M-foo
6436 and M-C-foo end up being equivalent in the keymap. */
6439 reorder_modifiers (Lisp_Object symbol
)
6441 /* It's hopefully okay to write the code this way, since everything
6442 will soon be in caches, and no consing will be done at all. */
6445 parsed
= parse_modifiers (symbol
);
6446 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6451 /* For handling events, we often want to produce a symbol whose name
6452 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6453 to some base, like the name of a function key or mouse button.
6454 modify_event_symbol produces symbols of this sort.
6456 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6457 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6460 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6461 into symbol names, or a string specifying a name stem used to
6462 construct a symbol name or the form `STEM-N', where N is the decimal
6463 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6464 non-nil; otherwise NAME_TABLE is used.
6466 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6467 persist between calls to modify_event_symbol that it can use to
6468 store a cache of the symbols it's generated for this NAME_TABLE
6469 before. The object stored there may be a vector or an alist.
6471 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6473 MODIFIERS is a set of modifier bits (as given in struct input_events)
6474 whose prefixes should be applied to the symbol name.
6476 SYMBOL_KIND is the value to be placed in the event_kind property of
6477 the returned symbol.
6479 The symbols we create are supposed to have an
6480 `event-symbol-elements' property, which lists the modifiers present
6481 in the symbol's name. */
6484 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6485 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6486 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6489 Lisp_Object symbol_int
;
6491 /* Get rid of the "vendor-specific" bit here. */
6492 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6494 /* Is this a request for a valid symbol? */
6495 if (symbol_num
< 0 || symbol_num
>= table_size
)
6498 if (CONSP (*symbol_table
))
6499 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6501 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6502 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6503 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6504 we've never used that symbol before. */
6507 if (! VECTORP (*symbol_table
)
6508 || ASIZE (*symbol_table
) != table_size
)
6512 XSETFASTINT (size
, table_size
);
6513 *symbol_table
= Fmake_vector (size
, Qnil
);
6516 value
= AREF (*symbol_table
, symbol_num
);
6519 /* Have we already used this symbol before? */
6522 /* No; let's create it. */
6523 if (CONSP (name_alist_or_stem
))
6524 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6525 else if (STRINGP (name_alist_or_stem
))
6528 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6529 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6531 buf
= SAFE_ALLOCA (len
);
6532 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6533 XINT (symbol_int
) + 1);
6534 value
= intern (buf
);
6537 else if (name_table
!= 0 && name_table
[symbol_num
])
6538 value
= intern (name_table
[symbol_num
]);
6540 #ifdef HAVE_WINDOW_SYSTEM
6543 char *name
= x_get_keysym_name (symbol_num
);
6545 value
= intern (name
);
6551 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6552 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6553 value
= intern (buf
);
6556 if (CONSP (*symbol_table
))
6557 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6559 ASET (*symbol_table
, symbol_num
, value
);
6561 /* Fill in the cache entries for this symbol; this also
6562 builds the Qevent_symbol_elements property, which the user
6564 apply_modifiers (modifiers
& click_modifier
, value
);
6565 Fput (value
, Qevent_kind
, symbol_kind
);
6568 /* Apply modifiers to that symbol. */
6569 return apply_modifiers (modifiers
, value
);
6572 /* Convert a list that represents an event type,
6573 such as (ctrl meta backspace), into the usual representation of that
6574 event type as a number or a symbol. */
6576 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6577 doc
: /* Convert the event description list EVENT-DESC to an event type.
6578 EVENT-DESC should contain one base event type (a character or symbol)
6579 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6580 drag, down, double or triple). The base must be last.
6581 The return value is an event type (a character or symbol) which
6582 has the same base event type and all the specified modifiers. */)
6583 (Lisp_Object event_desc
)
6591 while (CONSP (rest
))
6599 /* Given a symbol, see if it is a modifier name. */
6600 if (SYMBOLP (elt
) && CONSP (rest
))
6601 this = parse_solitary_modifier (elt
);
6605 else if (!NILP (base
))
6606 error ("Two bases given in one event");
6612 /* Let the symbol A refer to the character A. */
6613 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6614 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6616 if (INTEGERP (base
))
6618 /* Turn (shift a) into A. */
6619 if ((modifiers
& shift_modifier
) != 0
6620 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6622 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6623 modifiers
&= ~shift_modifier
;
6626 /* Turn (control a) into C-a. */
6627 if (modifiers
& ctrl_modifier
)
6628 return make_number ((modifiers
& ~ctrl_modifier
)
6629 | make_ctrl_char (XINT (base
)));
6631 return make_number (modifiers
| XINT (base
));
6633 else if (SYMBOLP (base
))
6634 return apply_modifiers (modifiers
, base
);
6636 error ("Invalid base event");
6639 /* Try to recognize SYMBOL as a modifier name.
6640 Return the modifier flag bit, or 0 if not recognized. */
6643 parse_solitary_modifier (Lisp_Object symbol
)
6645 Lisp_Object name
= SYMBOL_NAME (symbol
);
6647 switch (SREF (name
, 0))
6649 #define SINGLE_LETTER_MOD(BIT) \
6650 if (SBYTES (name) == 1) \
6653 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6654 if (LEN == SBYTES (name) \
6655 && ! memcmp (SDATA (name), NAME, LEN)) \
6659 SINGLE_LETTER_MOD (alt_modifier
);
6663 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6667 SINGLE_LETTER_MOD (ctrl_modifier
);
6671 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6672 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6676 SINGLE_LETTER_MOD (hyper_modifier
);
6680 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6684 SINGLE_LETTER_MOD (meta_modifier
);
6688 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6692 SINGLE_LETTER_MOD (shift_modifier
);
6696 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6697 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6698 SINGLE_LETTER_MOD (super_modifier
);
6702 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6703 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6704 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6708 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6711 #undef SINGLE_LETTER_MOD
6712 #undef MULTI_LETTER_MOD
6718 /* Return true if EVENT is a list whose elements are all integers or symbols.
6719 Such a list is not valid as an event,
6720 but it can be a Lucid-style event type list. */
6723 lucid_event_type_list_p (Lisp_Object object
)
6727 if (! CONSP (object
))
6730 if (EQ (XCAR (object
), Qhelp_echo
)
6731 || EQ (XCAR (object
), Qvertical_line
)
6732 || EQ (XCAR (object
), Qmode_line
)
6733 || EQ (XCAR (object
), Qheader_line
))
6736 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6740 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6747 /* Return true if terminal input chars are available.
6748 Also, store the return value into INPUT_PENDING.
6750 Serves the purpose of ioctl (0, FIONREAD, ...)
6751 but works even if FIONREAD does not exist.
6752 (In fact, this may actually read some input.)
6754 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6755 timer events that are ripe.
6756 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6757 events (FOCUS_IN_EVENT).
6758 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6759 movements and toolkit scroll bar thumb drags. */
6762 get_input_pending (int flags
)
6764 /* First of all, have we already counted some input? */
6765 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6767 /* If input is being read as it arrives, and we have none, there is none. */
6768 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6770 /* Try to read some input and see how much we get. */
6772 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6775 return input_pending
;
6778 /* Put a BUFFER_SWITCH_EVENT in the buffer
6779 so that read_key_sequence will notice the new current buffer. */
6782 record_asynch_buffer_change (void)
6784 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6785 The purpose of the event is to make read_key_sequence look up the
6786 keymaps again. If we aren't in read_key_sequence, we don't need one,
6787 and the event could cause trouble by messing up (input-pending-p).
6788 Note: Fwaiting_for_user_input_p always returns nil when async
6789 subprocesses aren't supported. */
6790 if (!NILP (Fwaiting_for_user_input_p ()))
6792 struct input_event event
;
6795 event
.kind
= BUFFER_SWITCH_EVENT
;
6796 event
.frame_or_window
= Qnil
;
6799 /* Make sure no interrupt happens while storing the event. */
6801 if (interrupt_input
)
6802 kbd_buffer_store_event (&event
);
6807 kbd_buffer_store_event (&event
);
6813 /* Read any terminal input already buffered up by the system
6814 into the kbd_buffer, but do not wait.
6816 Return the number of keyboard chars read, or -1 meaning
6817 this is a bad time to try to read input. */
6826 /* Store pending user signal events, if any. */
6827 store_user_signal_events ();
6829 /* Loop through the available terminals, and call their input hooks. */
6833 struct terminal
*next
= t
->next_terminal
;
6835 if (t
->read_socket_hook
)
6838 struct input_event hold_quit
;
6840 if (input_blocked_p ())
6842 pending_signals
= 1;
6846 EVENT_INIT (hold_quit
);
6847 hold_quit
.kind
= NO_EVENT
;
6849 /* No need for FIONREAD or fcntl; just say don't wait. */
6850 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6853 if (nr
== -1) /* Not OK to read input now. */
6857 else if (nr
== -2) /* Non-transient error. */
6859 /* The terminal device terminated; it should be closed. */
6861 /* Kill Emacs if this was our last terminal. */
6862 if (!terminal_list
->next_terminal
)
6863 /* Formerly simply reported no input, but that
6864 sometimes led to a failure of Emacs to terminate.
6865 SIGHUP seems appropriate if we can't reach the
6867 /* ??? Is it really right to send the signal just to
6868 this process rather than to the whole process
6869 group? Perhaps on systems with FIONREAD Emacs is
6870 alone in its group. */
6871 terminate_due_to_signal (SIGHUP
, 10);
6873 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6876 XSETTERMINAL (tmp
, t
);
6877 Fdelete_terminal (tmp
, Qnoelisp
);
6881 /* If there was no error, make sure the pointer
6882 is visible for all frames on this terminal. */
6885 Lisp_Object tail
, frame
;
6887 FOR_EACH_FRAME (tail
, frame
)
6889 struct frame
*f
= XFRAME (frame
);
6890 if (FRAME_TERMINAL (f
) == t
)
6891 frame_make_pointer_visible (f
);
6895 if (hold_quit
.kind
!= NO_EVENT
)
6896 kbd_buffer_store_event (&hold_quit
);
6908 /* This is the tty way of reading available input.
6910 Note that each terminal device has its own `struct terminal' object,
6911 and so this function is called once for each individual termcap
6912 terminal. The first parameter indicates which terminal to read from. */
6915 tty_read_avail_input (struct terminal
*terminal
,
6916 struct input_event
*hold_quit
)
6918 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6919 the kbd_buffer can really hold. That may prevent loss
6920 of characters on some systems when input is stuffed at us. */
6921 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6923 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6926 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6928 if (kbd_on_hold_p () || buffer_free
<= 0)
6930 #endif /* subprocesses */
6932 if (!terminal
->name
) /* Don't read from a dead terminal. */
6935 if (terminal
->type
!= output_termcap
6936 && terminal
->type
!= output_msdos_raw
)
6939 /* XXX I think the following code should be moved to separate hook
6940 functions in system-dependent files. */
6942 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6943 code sets read_socket_hook to w32_console_read_socket instead! */
6945 #else /* not WINDOWSNT */
6946 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6950 return 0; /* The terminal is suspended. */
6953 n_to_read
= dos_keysns ();
6957 cbuf
[0] = dos_keyread ();
6960 #else /* not MSDOS */
6965 struct input_event gpm_hold_quit
;
6966 int gpm
, fd
= gpm_fd
;
6968 EVENT_INIT (gpm_hold_quit
);
6969 gpm_hold_quit
.kind
= NO_EVENT
;
6971 /* gpm==1 if event received.
6972 gpm==0 if the GPM daemon has closed the connection, in which case
6973 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6974 we save it in `fd' so close_gpm can remove it from the
6976 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6977 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6978 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6981 /* Presumably the GPM daemon has closed the connection. */
6983 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6984 kbd_buffer_store_event (&gpm_hold_quit
);
6988 #endif /* HAVE_GPM */
6990 /* Determine how many characters we should *try* to read. */
6991 #ifdef USABLE_FIONREAD
6992 /* Find out how much input is available. */
6993 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6995 if (! noninteractive
)
6996 return -2; /* Close this terminal. */
7002 if (n_to_read
> sizeof cbuf
)
7003 n_to_read
= sizeof cbuf
;
7004 #elif defined USG || defined CYGWIN
7005 /* Read some input if available, but don't wait. */
7006 n_to_read
= sizeof cbuf
;
7007 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7009 # error "Cannot read without possibly delaying"
7013 /* Don't read more than we can store. */
7014 if (n_to_read
> buffer_free
)
7015 n_to_read
= buffer_free
;
7016 #endif /* subprocesses */
7018 /* Now read; for one reason or another, this will not block.
7019 NREAD is set to the number of chars read. */
7022 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7023 /* POSIX infers that processes which are not in the session leader's
7024 process group won't get SIGHUPs at logout time. BSDI adheres to
7025 this part standard and returns -1 from read (0) with errno==EIO
7026 when the control tty is taken away.
7027 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7028 if (nread
== -1 && errno
== EIO
)
7029 return -2; /* Close this terminal. */
7030 #if defined (AIX) && defined (_BSD)
7031 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7032 This looks incorrect, but it isn't, because _BSD causes
7033 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7034 and that causes a value other than 0 when there is no input. */
7036 return -2; /* Close this terminal. */
7040 /* We used to retry the read if it was interrupted.
7041 But this does the wrong thing when O_NONBLOCK causes
7042 an EAGAIN error. Does anybody know of a situation
7043 where a retry is actually needed? */
7045 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7055 #ifndef USABLE_FIONREAD
7056 #if defined (USG) || defined (CYGWIN)
7057 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7058 #endif /* USG or CYGWIN */
7059 #endif /* no FIONREAD */
7064 #endif /* not MSDOS */
7065 #endif /* not WINDOWSNT */
7067 for (i
= 0; i
< nread
; i
++)
7069 struct input_event buf
;
7071 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7073 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7074 buf
.modifiers
= meta_modifier
;
7075 if (tty
->meta_key
!= 2)
7079 /* Set the frame corresponding to the active tty. Note that the
7080 value of selected_frame is not reliable here, redisplay tends
7081 to temporarily change it. */
7082 buf
.frame_or_window
= tty
->top_frame
;
7085 kbd_buffer_store_event (&buf
);
7086 /* Don't look at input that follows a C-g too closely.
7087 This reduces lossage due to autorepeat on C-g. */
7088 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7089 && buf
.code
== quit_char
)
7097 handle_async_input (void)
7102 int nread
= gobble_input ();
7103 /* -1 means it's not ok to read the input now.
7104 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7105 0 means there was no keyboard input available. */
7113 process_pending_signals (void)
7115 pending_signals
= 0;
7116 handle_async_input ();
7117 do_pending_atimers ();
7120 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7121 and reinvoke any pending signal if the level is now 0 and
7122 a fatal error is not already in progress. */
7125 unblock_input_to (int level
)
7127 interrupt_input_blocked
= level
;
7130 if (pending_signals
&& !fatal_error_in_progress
)
7131 process_pending_signals ();
7137 /* End critical section.
7139 If doing signal-driven input, and a signal came in when input was
7140 blocked, reinvoke the signal handler now to deal with it.
7142 It will also process queued input, if it was not read before.
7143 When a longer code sequence does not use block/unblock input
7144 at all, the whole input gathered up to the next call to
7145 unblock_input will be processed inside that call. */
7148 unblock_input (void)
7150 unblock_input_to (interrupt_input_blocked
- 1);
7153 /* Undo any number of BLOCK_INPUT calls,
7154 and also reinvoke any pending signal. */
7157 totally_unblock_input (void)
7159 unblock_input_to (0);
7165 handle_input_available_signal (int sig
)
7167 pending_signals
= 1;
7169 if (input_available_clear_time
)
7170 *input_available_clear_time
= make_timespec (0, 0);
7174 deliver_input_available_signal (int sig
)
7176 deliver_process_signal (sig
, handle_input_available_signal
);
7178 #endif /* USABLE_SIGIO */
7181 /* User signal events. */
7183 struct user_signal_info
7185 /* Signal number. */
7188 /* Name of the signal. */
7191 /* Number of pending signals. */
7194 struct user_signal_info
*next
;
7197 /* List of user signals. */
7198 static struct user_signal_info
*user_signals
= NULL
;
7201 add_user_signal (int sig
, const char *name
)
7203 struct sigaction action
;
7204 struct user_signal_info
*p
;
7206 for (p
= user_signals
; p
; p
= p
->next
)
7208 /* Already added. */
7211 p
= xmalloc (sizeof *p
);
7213 p
->name
= xstrdup (name
);
7215 p
->next
= user_signals
;
7218 emacs_sigaction_init (&action
, deliver_user_signal
);
7219 sigaction (sig
, &action
, 0);
7223 handle_user_signal (int sig
)
7225 struct user_signal_info
*p
;
7226 const char *special_event_name
= NULL
;
7228 if (SYMBOLP (Vdebug_on_event
))
7229 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7231 for (p
= user_signals
; p
; p
= p
->next
)
7234 if (special_event_name
7235 && strcmp (special_event_name
, p
->name
) == 0)
7237 /* Enter the debugger in many ways. */
7238 debug_on_next_call
= 1;
7241 Vinhibit_quit
= Qnil
;
7243 /* Eat the event. */
7249 if (interrupt_input
)
7250 handle_input_available_signal (sig
);
7254 /* Tell wait_reading_process_output that it needs to wake
7255 up and look around. */
7256 if (input_available_clear_time
)
7257 *input_available_clear_time
= make_timespec (0, 0);
7264 deliver_user_signal (int sig
)
7266 deliver_process_signal (sig
, handle_user_signal
);
7270 find_user_signal_name (int sig
)
7272 struct user_signal_info
*p
;
7274 for (p
= user_signals
; p
; p
= p
->next
)
7282 store_user_signal_events (void)
7284 struct user_signal_info
*p
;
7285 struct input_event buf
;
7286 bool buf_initialized
= 0;
7288 for (p
= user_signals
; p
; p
= p
->next
)
7289 if (p
->npending
> 0)
7291 if (! buf_initialized
)
7293 memset (&buf
, 0, sizeof buf
);
7294 buf
.kind
= USER_SIGNAL_EVENT
;
7295 buf
.frame_or_window
= selected_frame
;
7296 buf_initialized
= 1;
7302 kbd_buffer_store_event (&buf
);
7305 while (p
->npending
> 0);
7310 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7311 static Lisp_Object menu_bar_one_keymap_changed_items
;
7313 /* These variables hold the vector under construction within
7314 menu_bar_items and its subroutines, and the current index
7315 for storing into that vector. */
7316 static Lisp_Object menu_bar_items_vector
;
7317 static int menu_bar_items_index
;
7320 static const char *separator_names
[] = {
7325 "single-dashed-line",
7326 "double-dashed-line",
7328 "shadow-etched-out",
7329 "shadow-etched-in-dash",
7330 "shadow-etched-out-dash",
7331 "shadow-double-etched-in",
7332 "shadow-double-etched-out",
7333 "shadow-double-etched-in-dash",
7334 "shadow-double-etched-out-dash",
7338 /* Return true if LABEL specifies a separator. */
7341 menu_separator_name_p (const char *label
)
7345 else if (strlen (label
) > 3
7346 && memcmp (label
, "--", 2) == 0
7351 for (i
= 0; separator_names
[i
]; ++i
)
7352 if (strcmp (label
, separator_names
[i
]) == 0)
7357 /* It's a separator if it contains only dashes. */
7358 while (*label
== '-')
7360 return (*label
== 0);
7367 /* Return a vector of menu items for a menu bar, appropriate
7368 to the current buffer. Each item has three elements in the vector:
7371 OLD is an old vector we can optionally reuse, or nil. */
7374 menu_bar_items (Lisp_Object old
)
7376 /* The number of keymaps we're scanning right now, and the number of
7377 keymaps we have allocated space for. */
7380 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7381 in the current keymaps, or nil where it is not a prefix. */
7384 Lisp_Object def
, tail
;
7389 /* In order to build the menus, we need to call the keymap
7390 accessors. They all call QUIT. But this function is called
7391 during redisplay, during which a quit is fatal. So inhibit
7392 quitting while building the menus.
7393 We do this instead of specbind because (1) errors will clear it anyway
7394 and (2) this avoids risk of specpdl overflow. */
7395 oquit
= Vinhibit_quit
;
7399 menu_bar_items_vector
= old
;
7401 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7402 menu_bar_items_index
= 0;
7404 /* Build our list of keymaps.
7405 If we recognize a function key and replace its escape sequence in
7406 keybuf with its symbol, or if the sequence starts with a mouse
7407 click and we need to switch buffers, we jump back here to rebuild
7408 the initial keymaps from the current buffer. */
7412 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7413 if (!NILP (Voverriding_local_map_menu_flag
)
7414 && !NILP (Voverriding_local_map
))
7416 /* Yes, use them (if non-nil) as well as the global map. */
7417 maps
= alloca (3 * sizeof (maps
[0]));
7419 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7420 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7421 if (!NILP (Voverriding_local_map
))
7422 maps
[nmaps
++] = Voverriding_local_map
;
7426 /* No, so use major and minor mode keymaps and keymap property.
7427 Note that menu-bar bindings in the local-map and keymap
7428 properties may not work reliable, as they are only
7429 recognized when the menu-bar (or mode-line) is updated,
7430 which does not normally happen after every command. */
7433 nminor
= current_minor_maps (NULL
, &tmaps
);
7434 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7436 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7437 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7438 maps
[nmaps
++] = tem
;
7439 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7440 maps
[nmaps
++] = tem
;
7441 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7443 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7445 maps
[nmaps
++] = current_global_map
;
7448 /* Look up in each map the dummy prefix key `menu-bar'. */
7450 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7451 if (!NILP (maps
[mapno
]))
7453 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7457 menu_bar_one_keymap_changed_items
= Qnil
;
7458 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7462 /* Move to the end those items that should be at the end. */
7464 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7467 int end
= menu_bar_items_index
;
7469 for (i
= 0; i
< end
; i
+= 4)
7470 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7472 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7473 /* Move the item at index I to the end,
7474 shifting all the others forward. */
7475 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7476 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7477 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7478 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7480 memmove (aref_addr (menu_bar_items_vector
, i
),
7481 aref_addr (menu_bar_items_vector
, i
+ 4),
7482 (end
- i
- 4) * word_size
);
7483 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7484 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7485 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7486 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7491 /* Add nil, nil, nil, nil at the end. */
7493 int i
= menu_bar_items_index
;
7494 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7495 menu_bar_items_vector
=
7496 larger_vector (menu_bar_items_vector
, 4, -1);
7497 /* Add this item. */
7498 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7499 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7500 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7501 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7502 menu_bar_items_index
= i
;
7505 Vinhibit_quit
= oquit
;
7506 return menu_bar_items_vector
;
7509 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7510 If there's already an item for KEY, add this DEF to it. */
7512 Lisp_Object item_properties
;
7515 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7517 struct gcpro gcpro1
;
7522 if (EQ (item
, Qundefined
))
7524 /* If a map has an explicit `undefined' as definition,
7525 discard any previously made menu bar item. */
7527 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7528 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7530 if (menu_bar_items_index
> i
+ 4)
7531 memmove (aref_addr (menu_bar_items_vector
, i
),
7532 aref_addr (menu_bar_items_vector
, i
+ 4),
7533 (menu_bar_items_index
- i
- 4) * word_size
);
7534 menu_bar_items_index
-= 4;
7538 /* If this keymap has already contributed to this KEY,
7539 don't contribute to it a second time. */
7540 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7541 if (!NILP (tem
) || NILP (item
))
7544 menu_bar_one_keymap_changed_items
7545 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7547 /* We add to menu_bar_one_keymap_changed_items before doing the
7548 parse_menu_item, so that if it turns out it wasn't a menu item,
7549 it still correctly hides any further menu item. */
7551 parsed
= parse_menu_item (item
, 1);
7556 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7558 /* Find any existing item for this KEY. */
7559 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7560 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7563 /* If we did not find this KEY, add it at the end. */
7564 if (i
== menu_bar_items_index
)
7566 /* If vector is too small, get a bigger one. */
7567 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7568 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7569 /* Add this item. */
7570 ASET (menu_bar_items_vector
, i
, key
); i
++;
7571 ASET (menu_bar_items_vector
, i
,
7572 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7573 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7574 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7575 menu_bar_items_index
= i
;
7577 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7581 old
= AREF (menu_bar_items_vector
, i
+ 2);
7582 /* If the new and the old items are not both keymaps,
7583 the lookup will only find `item'. */
7584 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7585 ASET (menu_bar_items_vector
, i
+ 2, item
);
7589 /* This is used as the handler when calling menu_item_eval_property. */
7591 menu_item_eval_property_1 (Lisp_Object arg
)
7593 /* If we got a quit from within the menu computation,
7594 quit all the way out of it. This takes care of C-] in the debugger. */
7595 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7596 Fsignal (Qquit
, Qnil
);
7602 eval_dyn (Lisp_Object form
)
7604 return Feval (form
, Qnil
);
7607 /* Evaluate an expression and return the result (or nil if something
7608 went wrong). Used to evaluate dynamic parts of menu items. */
7610 menu_item_eval_property (Lisp_Object sexpr
)
7612 ptrdiff_t count
= SPECPDL_INDEX ();
7614 specbind (Qinhibit_redisplay
, Qt
);
7615 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7616 menu_item_eval_property_1
);
7617 return unbind_to (count
, val
);
7620 /* This function parses a menu item and leaves the result in the
7621 vector item_properties.
7622 ITEM is a key binding, a possible menu item.
7623 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7625 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7626 parse_menu_item returns true if the item is a menu item and false
7630 parse_menu_item (Lisp_Object item
, int inmenubar
)
7632 Lisp_Object def
, tem
, item_string
, start
;
7634 Lisp_Object keyhint
;
7643 /* Create item_properties vector if necessary. */
7644 if (NILP (item_properties
))
7646 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7648 /* Initialize optional entries. */
7649 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7650 ASET (item_properties
, i
, Qnil
);
7651 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7653 /* Save the item here to protect it from GC. */
7654 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7656 item_string
= XCAR (item
);
7660 if (STRINGP (item_string
))
7662 /* Old format menu item. */
7663 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7665 /* Maybe help string. */
7666 if (CONSP (item
) && STRINGP (XCAR (item
)))
7668 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7673 /* Maybe an obsolete key binding cache. */
7674 if (CONSP (item
) && CONSP (XCAR (item
))
7675 && (NILP (XCAR (XCAR (item
)))
7676 || VECTORP (XCAR (XCAR (item
)))))
7679 /* This is the real definition--the function to run. */
7680 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7682 /* Get enable property, if any. */
7685 tem
= Fget (item
, Qmenu_enable
);
7686 if (!NILP (Venable_disabled_menus_and_buttons
))
7687 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7688 else if (!NILP (tem
))
7689 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7692 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7694 /* New format menu item. */
7695 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7696 start
= XCDR (item
);
7699 /* We have a real binding. */
7700 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7702 item
= XCDR (start
);
7703 /* Is there an obsolete cache list with key equivalences. */
7704 if (CONSP (item
) && CONSP (XCAR (item
)))
7707 /* Parse properties. */
7708 while (CONSP (item
) && CONSP (XCDR (item
)))
7713 if (EQ (tem
, QCenable
))
7715 if (!NILP (Venable_disabled_menus_and_buttons
))
7716 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7718 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7720 else if (EQ (tem
, QCvisible
))
7722 /* If got a visible property and that evaluates to nil
7723 then ignore this item. */
7724 tem
= menu_item_eval_property (XCAR (item
));
7728 else if (EQ (tem
, QChelp
))
7729 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7730 else if (EQ (tem
, QCfilter
))
7732 else if (EQ (tem
, QCkey_sequence
))
7735 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7736 /* Be GC protected. Set keyhint to item instead of tem. */
7739 else if (EQ (tem
, QCkeys
))
7742 if (CONSP (tem
) || STRINGP (tem
))
7743 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7745 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7750 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7752 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7754 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7760 else if (inmenubar
|| !NILP (start
))
7764 return 0; /* not a menu item */
7766 /* If item string is not a string, evaluate it to get string.
7767 If we don't get a string, skip this item. */
7768 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7769 if (!(STRINGP (item_string
)))
7771 item_string
= menu_item_eval_property (item_string
);
7772 if (!STRINGP (item_string
))
7774 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7777 /* If got a filter apply it on definition. */
7778 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7781 def
= menu_item_eval_property (list2 (XCAR (filter
),
7782 list2 (Qquote
, def
)));
7784 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7787 /* Enable or disable selection of item. */
7788 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7791 tem
= menu_item_eval_property (tem
);
7792 if (inmenubar
&& NILP (tem
))
7793 return 0; /* Ignore disabled items in menu bar. */
7794 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7797 /* If we got no definition, this item is just unselectable text which
7798 is OK in a submenu but not in the menubar. */
7800 return (!inmenubar
);
7802 /* See if this is a separate pane or a submenu. */
7803 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7804 tem
= get_keymap (def
, 0, 1);
7805 /* For a subkeymap, just record its details and exit. */
7808 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7809 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7813 /* At the top level in the menu bar, do likewise for commands also.
7814 The menu bar does not display equivalent key bindings anyway.
7815 ITEM_PROPERTY_DEF is already set up properly. */
7819 { /* This is a command. See if there is an equivalent key binding. */
7820 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7822 /* The previous code preferred :key-sequence to :keys, so we
7823 preserve this behavior. */
7824 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7825 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7828 Lisp_Object prefix
= keyeq
;
7829 Lisp_Object keys
= Qnil
;
7833 def
= XCAR (prefix
);
7834 prefix
= XCDR (prefix
);
7837 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7839 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7841 keys
= XCAR (keyhint
);
7842 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7844 /* We have a suggested key. Is it bound to the command? */
7847 /* If the command is an alias for another
7848 (such as lmenu.el set it up), check if the
7849 original command matches the cached command. */
7851 && EQ (tem
, XSYMBOL (def
)->function
))))
7856 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7860 tem
= Fkey_description (keys
, Qnil
);
7863 if (STRINGP (XCAR (prefix
)))
7864 tem
= concat2 (XCAR (prefix
), tem
);
7865 if (STRINGP (XCDR (prefix
)))
7866 tem
= concat2 (tem
, XCDR (prefix
));
7868 keyeq
= concat2 (build_string (" "), tem
);
7869 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7875 /* If we have an equivalent key binding, use that. */
7876 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7879 /* Include this when menu help is implemented.
7880 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7881 if (!(NILP (tem) || STRINGP (tem)))
7883 tem = menu_item_eval_property (tem);
7886 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7890 /* Handle radio buttons or toggle boxes. */
7891 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7893 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7894 menu_item_eval_property (tem
));
7901 /***********************************************************************
7903 ***********************************************************************/
7905 /* A vector holding tool bar items while they are parsed in function
7906 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7909 static Lisp_Object tool_bar_items_vector
;
7911 /* A vector holding the result of parse_tool_bar_item. Layout is like
7912 the one for a single item in tool_bar_items_vector. */
7914 static Lisp_Object tool_bar_item_properties
;
7916 /* Next free index in tool_bar_items_vector. */
7918 static int ntool_bar_items
;
7920 /* The symbols `:image' and `:rtl'. */
7922 static Lisp_Object QCimage
;
7923 static Lisp_Object QCrtl
;
7925 /* Function prototypes. */
7927 static void init_tool_bar_items (Lisp_Object
);
7928 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7930 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7931 static void append_tool_bar_item (void);
7934 /* Return a vector of tool bar items for keymaps currently in effect.
7935 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7936 tool bar items found. */
7939 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7948 /* In order to build the menus, we need to call the keymap
7949 accessors. They all call QUIT. But this function is called
7950 during redisplay, during which a quit is fatal. So inhibit
7951 quitting while building the menus. We do this instead of
7952 specbind because (1) errors will clear it anyway and (2) this
7953 avoids risk of specpdl overflow. */
7954 oquit
= Vinhibit_quit
;
7957 /* Initialize tool_bar_items_vector and protect it from GC. */
7958 init_tool_bar_items (reuse
);
7960 /* Build list of keymaps in maps. Set nmaps to the number of maps
7963 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7964 if (!NILP (Voverriding_local_map_menu_flag
)
7965 && !NILP (Voverriding_local_map
))
7967 /* Yes, use them (if non-nil) as well as the global map. */
7968 maps
= alloca (3 * sizeof *maps
);
7970 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7971 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7972 if (!NILP (Voverriding_local_map
))
7973 maps
[nmaps
++] = Voverriding_local_map
;
7977 /* No, so use major and minor mode keymaps and keymap property.
7978 Note that tool-bar bindings in the local-map and keymap
7979 properties may not work reliable, as they are only
7980 recognized when the tool-bar (or mode-line) is updated,
7981 which does not normally happen after every command. */
7984 nminor
= current_minor_maps (NULL
, &tmaps
);
7985 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7987 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7988 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7989 maps
[nmaps
++] = tem
;
7990 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7991 maps
[nmaps
++] = tem
;
7992 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7994 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7997 /* Add global keymap at the end. */
7998 maps
[nmaps
++] = current_global_map
;
8000 /* Process maps in reverse order and look up in each map the prefix
8002 for (i
= nmaps
- 1; i
>= 0; --i
)
8003 if (!NILP (maps
[i
]))
8007 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8009 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8012 Vinhibit_quit
= oquit
;
8013 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8014 return tool_bar_items_vector
;
8018 /* Process the definition of KEY which is DEF. */
8021 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8024 struct gcpro gcpro1
, gcpro2
;
8026 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8030 if (EQ (def
, Qundefined
))
8032 /* If a map has an explicit `undefined' as definition,
8033 discard any previously made item. */
8034 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8036 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8038 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8040 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8041 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8042 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8044 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8049 else if (parse_tool_bar_item (key
, def
))
8050 /* Append a new tool bar item to tool_bar_items_vector. Accept
8051 more than one definition for the same key. */
8052 append_tool_bar_item ();
8057 /* Access slot with index IDX of vector tool_bar_item_properties. */
8058 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8060 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8062 ASET (tool_bar_item_properties
, idx
, val
);
8066 /* Parse a tool bar item specification ITEM for key KEY and return the
8067 result in tool_bar_item_properties. Value is false if ITEM is
8070 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8072 CAPTION is the caption of the item, If it's not a string, it is
8073 evaluated to get a string.
8075 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8076 as binding are currently ignored.
8078 The following properties are recognized:
8082 FORM is evaluated and specifies whether the tool bar item is
8083 enabled or disabled.
8087 FORM is evaluated and specifies whether the tool bar item is visible.
8089 - `:filter FUNCTION'
8091 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8092 result is stored as the new binding.
8094 - `:button (TYPE SELECTED)'
8096 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8097 and specifies whether the button is selected (pressed) or not.
8101 IMAGES is either a single image specification or a vector of four
8102 image specifications. See enum tool_bar_item_images.
8104 - `:help HELP-STRING'.
8106 Gives a help string to display for the tool bar item.
8108 - `:label LABEL-STRING'.
8110 A text label to show with the tool bar button if labels are enabled. */
8113 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8115 Lisp_Object filter
= Qnil
;
8116 Lisp_Object caption
;
8118 bool have_label
= 0;
8120 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8121 Rule out items that aren't lists, don't start with
8122 `menu-item' or whose rest following `tool-bar-item' is not a
8127 /* As an exception, allow old-style menu separators. */
8128 if (STRINGP (XCAR (item
)))
8129 item
= list1 (XCAR (item
));
8130 else if (!EQ (XCAR (item
), Qmenu_item
)
8131 || (item
= XCDR (item
), !CONSP (item
)))
8134 /* Create tool_bar_item_properties vector if necessary. Reset it to
8136 if (VECTORP (tool_bar_item_properties
))
8138 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8142 tool_bar_item_properties
8143 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8146 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8147 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8149 /* Get the caption of the item. If the caption is not a string,
8150 evaluate it to get a string. If we don't get a string, skip this
8152 caption
= XCAR (item
);
8153 if (!STRINGP (caption
))
8155 caption
= menu_item_eval_property (caption
);
8156 if (!STRINGP (caption
))
8159 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8161 /* If the rest following the caption is not a list, the menu item is
8162 either a separator, or invalid. */
8166 if (menu_separator_name_p (SSDATA (caption
)))
8168 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8169 #if !defined (USE_GTK) && !defined (HAVE_NS)
8170 /* If we use build_desired_tool_bar_string to render the
8171 tool bar, the separator is rendered as an image. */
8172 set_prop (TOOL_BAR_ITEM_IMAGES
,
8173 (menu_item_eval_property
8174 (Vtool_bar_separator_image_expression
)));
8175 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8176 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8177 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8184 /* Store the binding. */
8185 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8188 /* Ignore cached key binding, if any. */
8189 if (CONSP (item
) && CONSP (XCAR (item
)))
8192 /* Process the rest of the properties. */
8193 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8195 Lisp_Object ikey
, value
;
8198 value
= XCAR (XCDR (item
));
8200 if (EQ (ikey
, QCenable
))
8202 /* `:enable FORM'. */
8203 if (!NILP (Venable_disabled_menus_and_buttons
))
8204 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8206 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8208 else if (EQ (ikey
, QCvisible
))
8210 /* `:visible FORM'. If got a visible property and that
8211 evaluates to nil then ignore this item. */
8212 if (NILP (menu_item_eval_property (value
)))
8215 else if (EQ (ikey
, QChelp
))
8216 /* `:help HELP-STRING'. */
8217 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8218 else if (EQ (ikey
, QCvert_only
))
8219 /* `:vert-only t/nil'. */
8220 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8221 else if (EQ (ikey
, QClabel
))
8223 const char *bad_label
= "!!?GARBLED ITEM?!!";
8224 /* `:label LABEL-STRING'. */
8225 set_prop (TOOL_BAR_ITEM_LABEL
,
8226 STRINGP (value
) ? value
: build_string (bad_label
));
8229 else if (EQ (ikey
, QCfilter
))
8230 /* ':filter FORM'. */
8232 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8234 /* `:button (TYPE . SELECTED)'. */
8235 Lisp_Object type
, selected
;
8237 type
= XCAR (value
);
8238 selected
= XCDR (value
);
8239 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8241 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8242 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8245 else if (EQ (ikey
, QCimage
)
8247 || (VECTORP (value
) && ASIZE (value
) == 4)))
8248 /* Value is either a single image specification or a vector
8249 of 4 such specifications for the different button states. */
8250 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8251 else if (EQ (ikey
, QCrtl
))
8253 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8259 /* Try to make one from caption and key. */
8260 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8261 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8262 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8263 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8265 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8266 char *buf
= xmalloc (max_lbl
+ 1);
8267 Lisp_Object new_lbl
;
8268 ptrdiff_t caption_len
= strlen (capt
);
8270 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8273 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8275 buf
[caption_len
] = '\0';
8279 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8283 strcpy (buf
, label
);
8285 for (j
= 0; buf
[j
] != '\0'; ++j
)
8293 new_lbl
= Fupcase_initials (build_string (label
));
8294 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8295 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8297 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8301 /* If got a filter apply it on binding. */
8303 set_prop (TOOL_BAR_ITEM_BINDING
,
8304 (menu_item_eval_property
8307 PROP (TOOL_BAR_ITEM_BINDING
))))));
8309 /* See if the binding is a keymap. Give up if it is. */
8310 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8313 /* Enable or disable selection of item. */
8314 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8315 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8316 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8318 /* Handle radio buttons or toggle boxes. */
8319 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8320 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8321 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8329 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8330 that can be reused. */
8333 init_tool_bar_items (Lisp_Object reuse
)
8335 if (VECTORP (reuse
))
8336 tool_bar_items_vector
= reuse
;
8338 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8339 ntool_bar_items
= 0;
8343 /* Append parsed tool bar item properties from
8344 tool_bar_item_properties */
8347 append_tool_bar_item (void)
8351 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8353 /* Enlarge tool_bar_items_vector if necessary. */
8355 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8357 /* Append entries from tool_bar_item_properties to the end of
8358 tool_bar_items_vector. */
8359 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8360 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8361 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8368 /* Read a character using menus based on the keymap MAP.
8369 Return nil if there are no menus in the maps.
8370 Return t if we displayed a menu but the user rejected it.
8372 PREV_EVENT is the previous input event, or nil if we are reading
8373 the first event of a key sequence.
8375 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8376 if we used a mouse menu to read the input, or false otherwise. If
8377 USED_MOUSE_MENU is null, don't dereference it.
8379 The prompting is done based on the prompt-string of the map
8380 and the strings associated with various map elements.
8382 This can be done with X menus or with menus put in the minibuf.
8383 These are done in different ways, depending on how the input will be read.
8384 Menus using X are done after auto-saving in read-char, getting the input
8385 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8386 and do auto-saving in the inner call of read_char. */
8389 read_char_x_menu_prompt (Lisp_Object map
,
8390 Lisp_Object prev_event
, bool *used_mouse_menu
)
8392 if (used_mouse_menu
)
8393 *used_mouse_menu
= 0;
8395 /* Use local over global Menu maps. */
8397 if (! menu_prompting
)
8400 /* If we got to this point via a mouse click,
8401 use a real menu for mouse selection. */
8402 if (EVENT_HAS_PARAMETERS (prev_event
)
8403 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8404 && !EQ (XCAR (prev_event
), Qtool_bar
))
8406 /* Display the menu and get the selection. */
8409 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8414 record_menu_key (XCAR (value
));
8416 /* If we got multiple events, unread all but
8418 There is no way to prevent those unread events
8419 from showing up later in last_nonmenu_event.
8420 So turn symbol and integer events into lists,
8421 to indicate that they came from a mouse menu,
8422 so that when present in last_nonmenu_event
8423 they won't confuse things. */
8424 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8426 record_menu_key (XCAR (tem
));
8427 if (SYMBOLP (XCAR (tem
))
8428 || INTEGERP (XCAR (tem
)))
8429 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8432 /* If we got more than one event, put all but the first
8433 onto this list to be read later.
8434 Return just the first event now. */
8435 Vunread_command_events
8436 = nconc2 (XCDR (value
), Vunread_command_events
);
8437 value
= XCAR (value
);
8439 else if (NILP (value
))
8441 if (used_mouse_menu
)
8442 *used_mouse_menu
= 1;
8449 read_char_minibuf_menu_prompt (int commandflag
,
8452 register Lisp_Object name
;
8454 /* FIXME: Use the minibuffer's frame width. */
8455 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8457 bool nobindings
= 1;
8458 Lisp_Object rest
, vector
;
8459 Lisp_Object prompt_strings
= Qnil
;
8463 if (! menu_prompting
)
8466 map
= get_keymap (map
, 0, 1);
8467 name
= Fkeymap_prompt (map
);
8469 /* If we don't have any menus, just read a character normally. */
8470 if (!STRINGP (name
))
8473 #define PUSH_C_STR(str, listvar) \
8474 listvar = Fcons (build_unibyte_string (str), listvar)
8476 /* Prompt string always starts with map's prompt, and a space. */
8477 prompt_strings
= Fcons (name
, prompt_strings
);
8478 PUSH_C_STR (": ", prompt_strings
);
8479 nlength
= SCHARS (name
) + 2;
8483 /* Present the documented bindings, a line at a time. */
8487 Lisp_Object menu_strings
= prompt_strings
;
8488 ptrdiff_t i
= nlength
;
8490 Lisp_Object orig_defn_macro
;
8492 /* Loop over elements of map. */
8497 /* FIXME: Use map_keymap to handle new keymap formats. */
8499 /* At end of map, wrap around if just starting,
8500 or end this line if already have something on it. */
8503 if (notfirst
|| nobindings
)
8509 /* Look at the next element of the map. */
8511 elt
= AREF (vector
, idx
);
8513 elt
= Fcar_safe (rest
);
8515 if (idx
< 0 && VECTORP (elt
))
8517 /* If we found a dense table in the keymap,
8518 advanced past it, but start scanning its contents. */
8519 rest
= Fcdr_safe (rest
);
8525 /* An ordinary element. */
8526 Lisp_Object event
, tem
;
8530 event
= Fcar_safe (elt
); /* alist */
8531 elt
= Fcdr_safe (elt
);
8535 XSETINT (event
, idx
); /* vector */
8538 /* Ignore the element if it has no prompt string. */
8539 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8541 /* True if the char to type matches the string. */
8543 Lisp_Object upcased_event
, downcased_event
;
8544 Lisp_Object desc
= Qnil
;
8546 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8548 upcased_event
= Fupcase (event
);
8549 downcased_event
= Fdowncase (event
);
8550 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8551 || XINT (downcased_event
) == SREF (s
, 0));
8553 desc
= Fsingle_key_description (event
, Qnil
);
8555 #if 0 /* It is redundant to list the equivalent key bindings because
8556 the prefix is what the user has already typed. */
8558 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8560 /* Insert equivalent keybinding. */
8561 s
= concat2 (s
, tem
);
8564 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8565 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8567 /* Insert button prefix. */
8568 Lisp_Object selected
8569 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8570 if (EQ (tem
, QCradio
))
8571 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8573 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8574 s
= concat2 (tem
, s
);
8578 /* If we have room for the prompt string, add it to this line.
8579 If this is the first on the line, always add it. */
8580 if ((SCHARS (s
) + i
+ 2
8581 + (char_matches
? 0 : SCHARS (desc
) + 3))
8585 ptrdiff_t thiswidth
;
8587 /* Punctuate between strings. */
8590 PUSH_C_STR (", ", menu_strings
);
8596 /* If the char to type doesn't match the string's
8597 first char, explicitly show what char to type. */
8600 /* Add as much of string as fits. */
8601 thiswidth
= min (SCHARS (desc
), width
- i
);
8603 = Fcons (Fsubstring (desc
, make_number (0),
8604 make_number (thiswidth
)),
8607 PUSH_C_STR (" = ", menu_strings
);
8611 /* Add as much of string as fits. */
8612 thiswidth
= min (SCHARS (s
), width
- i
);
8614 = Fcons (Fsubstring (s
, make_number (0),
8615 make_number (thiswidth
)),
8621 /* If this element does not fit, end the line now,
8622 and save the element for the next line. */
8623 PUSH_C_STR ("...", menu_strings
);
8628 /* Move past this element. */
8629 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8630 /* Handle reaching end of dense table. */
8635 rest
= Fcdr_safe (rest
);
8639 /* Prompt with that and read response. */
8640 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8642 /* Make believe it's not a keyboard macro in case the help char
8643 is pressed. Help characters are not recorded because menu prompting
8644 is not used on replay. */
8645 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8646 kset_defining_kbd_macro (current_kboard
, Qnil
);
8648 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8649 while (BUFFERP (obj
));
8650 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8652 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8655 if (! EQ (obj
, menu_prompt_more_char
)
8656 && (!INTEGERP (menu_prompt_more_char
)
8657 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8659 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8660 store_kbd_macro_char (obj
);
8663 /* Help char - go round again. */
8667 /* Reading key sequences. */
8670 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8672 return access_keymap (get_keymap (keymap
, 0, 1),
8677 active_maps (Lisp_Object first_event
)
8679 Lisp_Object position
8680 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8681 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8684 /* Structure used to keep track of partial application of key remapping
8685 such as Vfunction_key_map and Vkey_translation_map. */
8686 typedef struct keyremap
8688 /* This is the map originally specified for this use. */
8690 /* This is a submap reached by looking up, in PARENT,
8691 the events from START to END. */
8693 /* Positions [START, END) in the key sequence buffer
8694 are the key that we have scanned so far.
8695 Those events are the ones that we will replace
8696 if PARENT maps them into a key sequence. */
8700 /* Lookup KEY in MAP.
8701 MAP is a keymap mapping keys to key vectors or functions.
8702 If the mapping is a function and DO_FUNCALL is true,
8703 the function is called with PROMPT as parameter and its return
8704 value is used as the return value of this function (after checking
8705 that it is indeed a vector). */
8708 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8713 next
= access_keymap (map
, key
, 1, 0, 1);
8715 /* Handle a symbol whose function definition is a keymap
8717 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8718 && (ARRAYP (XSYMBOL (next
)->function
)
8719 || KEYMAPP (XSYMBOL (next
)->function
)))
8720 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8722 /* If the keymap gives a function, not an
8723 array, then call the function with one arg and use
8724 its value instead. */
8725 if (do_funcall
&& FUNCTIONP (next
))
8730 next
= call1 (next
, prompt
);
8731 /* If the function returned something invalid,
8732 barf--don't ignore it.
8733 (To ignore it safely, we would need to gcpro a bunch of
8734 other variables.) */
8735 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8736 error ("Function %s returns invalid key sequence",
8737 SSDATA (SYMBOL_NAME (tem
)));
8742 /* Do one step of the key remapping used for function-key-map and
8743 key-translation-map:
8744 KEYBUF is the buffer holding the input events.
8745 BUFSIZE is its maximum size.
8746 FKEY is a pointer to the keyremap structure to use.
8747 INPUT is the index of the last element in KEYBUF.
8748 DOIT if true says that the remapping can actually take place.
8749 DIFF is used to return the number of keys added/removed by the remapping.
8750 PARENT is the root of the keymap.
8751 PROMPT is the prompt to use if the remapping happens through a function.
8752 Return true if the remapping actually took place. */
8755 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8756 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8758 Lisp_Object next
, key
;
8760 key
= keybuf
[fkey
->end
++];
8762 if (KEYMAPP (fkey
->parent
))
8763 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8767 /* If keybuf[fkey->start..fkey->end] is bound in the
8768 map and we're in a position to do the key remapping, replace it with
8769 the binding and restart with fkey->start at the end. */
8770 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8772 int len
= XFASTINT (Flength (next
));
8775 *diff
= len
- (fkey
->end
- fkey
->start
);
8777 if (bufsize
- input
<= *diff
)
8778 error ("Key sequence too long");
8780 /* Shift the keys that follow fkey->end. */
8782 for (i
= fkey
->end
; i
< input
; i
++)
8783 keybuf
[i
+ *diff
] = keybuf
[i
];
8785 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8786 keybuf
[i
+ *diff
] = keybuf
[i
];
8787 /* Overwrite the old keys with the new ones. */
8788 for (i
= 0; i
< len
; i
++)
8789 keybuf
[fkey
->start
+ i
]
8790 = Faref (next
, make_number (i
));
8792 fkey
->start
= fkey
->end
+= *diff
;
8793 fkey
->map
= fkey
->parent
;
8798 fkey
->map
= get_keymap (next
, 0, 1);
8800 /* If we no longer have a bound suffix, try a new position for
8802 if (!CONSP (fkey
->map
))
8804 fkey
->end
= ++fkey
->start
;
8805 fkey
->map
= fkey
->parent
;
8811 test_undefined (Lisp_Object binding
)
8813 return (NILP (binding
)
8814 || EQ (binding
, Qundefined
)
8815 || (SYMBOLP (binding
)
8816 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8819 /* Read a sequence of keys that ends with a non prefix character,
8820 storing it in KEYBUF, a buffer of size BUFSIZE.
8822 Return the length of the key sequence stored.
8823 Return -1 if the user rejected a command menu.
8825 Echo starting immediately unless `prompt' is 0.
8827 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8828 read_char with a suitable COMMANDFLAG argument.
8830 Where a key sequence ends depends on the currently active keymaps.
8831 These include any minor mode keymaps active in the current buffer,
8832 the current buffer's local map, and the global map.
8834 If a key sequence has no other bindings, we check Vfunction_key_map
8835 to see if some trailing subsequence might be the beginning of a
8836 function key's sequence. If so, we try to read the whole function
8837 key, and substitute its symbolic name into the key sequence.
8839 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8840 `double-' events into similar click events, if that would make them
8841 bound. We try to turn `triple-' events first into `double-' events,
8844 If we get a mouse click in a mode line, vertical divider, or other
8845 non-text area, we treat the click as if it were prefixed by the
8846 symbol denoting that area - `mode-line', `vertical-line', or
8849 If the sequence starts with a mouse click, we read the key sequence
8850 with respect to the buffer clicked on, not the current buffer.
8852 If the user switches frames in the midst of a key sequence, we put
8853 off the switch-frame event until later; the next call to
8854 read_char will return it.
8856 If FIX_CURRENT_BUFFER, we restore current_buffer
8857 from the selected window's buffer. */
8860 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8861 bool dont_downcase_last
, bool can_return_switch_frame
,
8862 bool fix_current_buffer
, bool prevent_redisplay
)
8864 ptrdiff_t count
= SPECPDL_INDEX ();
8866 /* How many keys there are in the current key sequence. */
8869 /* The length of the echo buffer when we started reading, and
8870 the length of this_command_keys when we started reading. */
8871 ptrdiff_t echo_start
IF_LINT (= 0);
8872 ptrdiff_t keys_start
;
8874 Lisp_Object current_binding
= Qnil
;
8875 Lisp_Object first_event
= Qnil
;
8877 /* Index of the first key that has no binding.
8878 It is useless to try fkey.start larger than that. */
8881 /* If t < mock_input, then KEYBUF[t] should be read as the next
8884 We use this to recover after recognizing a function key. Once we
8885 realize that a suffix of the current key sequence is actually a
8886 function key's escape sequence, we replace the suffix with the
8887 function key's binding from Vfunction_key_map. Now keybuf
8888 contains a new and different key sequence, so the echo area,
8889 this_command_keys, and the submaps and defs arrays are wrong. In
8890 this situation, we set mock_input to t, set t to 0, and jump to
8891 restart_sequence; the loop will read keys from keybuf up until
8892 mock_input, thus rebuilding the state; and then it will resume
8893 reading characters from the keyboard. */
8896 /* If the sequence is unbound in submaps[], then
8897 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8898 and fkey.map is its binding.
8900 These might be > t, indicating that all function key scanning
8901 should hold off until t reaches them. We do this when we've just
8902 recognized a function key, to avoid searching for the function
8903 key's again in Vfunction_key_map. */
8906 /* Likewise, for key_translation_map and input-decode-map. */
8907 keyremap keytran
, indec
;
8909 /* True if we are trying to map a key by changing an upper-case
8910 letter to lower case, or a shifted function key to an unshifted
8912 bool shift_translated
= 0;
8914 /* If we receive a `switch-frame' or `select-window' event in the middle of
8915 a key sequence, we put it off for later.
8916 While we're reading, we keep the event here. */
8917 Lisp_Object delayed_switch_frame
;
8919 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8920 int original_uppercase_position
= -1;
8922 /* Gets around Microsoft compiler limitations. */
8925 struct buffer
*starting_buffer
;
8927 /* List of events for which a fake prefix key has been generated. */
8928 Lisp_Object fake_prefixed_keys
= Qnil
;
8930 struct gcpro gcpro1
;
8932 GCPRO1 (fake_prefixed_keys
);
8933 raw_keybuf_count
= 0;
8935 last_nonmenu_event
= Qnil
;
8937 delayed_switch_frame
= Qnil
;
8943 /* Install the string PROMPT as the beginning of the string
8944 of echoing, so that it serves as a prompt for the next
8946 kset_echo_string (current_kboard
, prompt
);
8947 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8950 else if (cursor_in_echo_area
8951 && echo_keystrokes_p ())
8952 /* This doesn't put in a dash if the echo buffer is empty, so
8953 you don't always see a dash hanging out in the minibuffer. */
8957 /* Record the initial state of the echo area and this_command_keys;
8958 we will need to restore them if we replay a key sequence. */
8960 echo_start
= echo_length ();
8961 keys_start
= this_command_key_count
;
8962 this_single_command_key_start
= keys_start
;
8964 /* We jump here when we need to reinitialize fkey and keytran; this
8965 happens if we switch keyboards between rescans. */
8966 replay_entire_sequence
:
8968 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8969 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8970 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8971 indec
.start
= indec
.end
= 0;
8972 fkey
.start
= fkey
.end
= 0;
8973 keytran
.start
= keytran
.end
= 0;
8975 /* We jump here when the key sequence has been thoroughly changed, and
8976 we need to rescan it starting from the beginning. When we jump here,
8977 keybuf[0..mock_input] holds the sequence we should reread. */
8980 starting_buffer
= current_buffer
;
8981 first_unbound
= bufsize
+ 1;
8983 /* Build our list of keymaps.
8984 If we recognize a function key and replace its escape sequence in
8985 keybuf with its symbol, or if the sequence starts with a mouse
8986 click and we need to switch buffers, we jump back here to rebuild
8987 the initial keymaps from the current buffer. */
8988 current_binding
= active_maps (first_event
);
8990 /* Start from the beginning in keybuf. */
8993 /* These are no-ops the first time through, but if we restart, they
8994 revert the echo area and this_command_keys to their original state. */
8995 this_command_key_count
= keys_start
;
8996 if (INTERACTIVE
&& t
< mock_input
)
8997 echo_truncate (echo_start
);
8999 /* If the best binding for the current key sequence is a keymap, or
9000 we may be looking at a function key's escape sequence, keep on
9002 while (!NILP (current_binding
)
9003 /* Keep reading as long as there's a prefix binding. */
9004 ? KEYMAPP (current_binding
)
9005 /* Don't return in the middle of a possible function key sequence,
9006 if the only bindings we found were via case conversion.
9007 Thus, if ESC O a has a function-key-map translation
9008 and ESC o has a binding, don't return after ESC O,
9009 so that we can translate ESC O plus the next character. */
9010 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9013 bool used_mouse_menu
= 0;
9015 /* Where the last real key started. If we need to throw away a
9016 key that has expanded into more than one element of keybuf
9017 (say, a mouse click on the mode line which is being treated
9018 as [mode-line (mouse-...)], then we backtrack to this point
9020 int last_real_key_start
;
9022 /* These variables are analogous to echo_start and keys_start;
9023 while those allow us to restart the entire key sequence,
9024 echo_local_start and keys_local_start allow us to throw away
9026 ptrdiff_t echo_local_start
IF_LINT (= 0);
9027 int keys_local_start
;
9028 Lisp_Object new_binding
;
9030 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9031 eassert (indec
.start
<= indec
.end
);
9032 eassert (fkey
.start
<= fkey
.end
);
9033 eassert (keytran
.start
<= keytran
.end
);
9034 /* key-translation-map is applied *after* function-key-map
9035 which is itself applied *after* input-decode-map. */
9036 eassert (fkey
.end
<= indec
.start
);
9037 eassert (keytran
.end
<= fkey
.start
);
9039 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9040 first_unbound
< keytran
.start
)
9041 { /* The prefix upto first_unbound has no binding and has
9042 no translation left to do either, so we know it's unbound.
9043 If we don't stop now, we risk staying here indefinitely
9044 (if the user keeps entering fkey or keytran prefixes
9045 like C-c ESC ESC ESC ESC ...) */
9047 for (i
= first_unbound
+ 1; i
< t
; i
++)
9048 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9049 mock_input
= t
- first_unbound
- 1;
9050 indec
.end
= indec
.start
-= first_unbound
+ 1;
9051 indec
.map
= indec
.parent
;
9052 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9053 fkey
.map
= fkey
.parent
;
9054 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9055 keytran
.map
= keytran
.parent
;
9056 goto replay_sequence
;
9060 error ("Key sequence too long");
9063 echo_local_start
= echo_length ();
9064 keys_local_start
= this_command_key_count
;
9067 /* These are no-ops, unless we throw away a keystroke below and
9068 jumped back up to replay_key; in that case, these restore the
9069 variables to their original state, allowing us to replay the
9071 if (INTERACTIVE
&& t
< mock_input
)
9072 echo_truncate (echo_local_start
);
9073 this_command_key_count
= keys_local_start
;
9075 /* By default, assume each event is "real". */
9076 last_real_key_start
= t
;
9078 /* Does mock_input indicate that we are re-reading a key sequence? */
9082 add_command_key (key
);
9083 if (echo_keystrokes_p ()
9084 && current_kboard
->immediate_echo
)
9091 /* If not, we should actually read a character. */
9095 KBOARD
*interrupted_kboard
= current_kboard
;
9096 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9097 /* Calling read_char with COMMANDFLAG = -2 avoids
9098 redisplay in read_char and its subroutines. */
9099 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9100 current_binding
, last_nonmenu_event
,
9101 &used_mouse_menu
, NULL
);
9102 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9103 /* When switching to a new tty (with a new keyboard),
9104 read_char returns the new buffer, rather than -2
9105 (Bug#5095). This is because `terminal-init-xterm'
9106 calls read-char, which eats the wrong_kboard_jmpbuf
9107 return. Any better way to fix this? -- cyd */
9108 || (interrupted_kboard
!= current_kboard
))
9113 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9114 if (k
== interrupted_kboard
)
9119 /* Don't touch interrupted_kboard when it's been
9121 delayed_switch_frame
= Qnil
;
9122 goto replay_entire_sequence
;
9125 if (!NILP (delayed_switch_frame
))
9128 (interrupted_kboard
,
9129 Fcons (delayed_switch_frame
,
9130 KVAR (interrupted_kboard
, kbd_queue
)));
9131 delayed_switch_frame
= Qnil
;
9136 (interrupted_kboard
,
9137 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9139 /* If the side queue is non-empty, ensure it begins with a
9140 switch-frame, so we'll replay it in the right context. */
9141 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9142 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9143 !(EVENT_HAS_PARAMETERS (key
)
9144 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9148 XSETFRAME (frame
, interrupted_frame
);
9150 (interrupted_kboard
,
9151 Fcons (make_lispy_switch_frame (frame
),
9152 KVAR (interrupted_kboard
, kbd_queue
)));
9155 goto replay_entire_sequence
;
9159 /* read_char returns t when it shows a menu and the user rejects it.
9163 unbind_to (count
, Qnil
);
9168 /* read_char returns -1 at the end of a macro.
9169 Emacs 18 handles this by returning immediately with a
9170 zero, so that's what we'll do. */
9171 if (INTEGERP (key
) && XINT (key
) == -1)
9174 /* The Microsoft C compiler can't handle the goto that
9180 /* If the current buffer has been changed from under us, the
9181 keymap may have changed, so replay the sequence. */
9184 timer_resume_idle ();
9187 /* Reset the current buffer from the selected window
9188 in case something changed the former and not the latter.
9189 This is to be more consistent with the behavior
9190 of the command_loop_1. */
9191 if (fix_current_buffer
)
9193 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9195 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9197 Fset_buffer (XWINDOW (selected_window
)->contents
);
9200 goto replay_sequence
;
9203 /* If we have a quit that was typed in another frame, and
9204 quit_throw_to_read_char switched buffers,
9205 replay to get the right keymap. */
9207 && XINT (key
) == quit_char
9208 && current_buffer
!= starting_buffer
)
9211 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9216 goto replay_sequence
;
9221 if (EVENT_HAS_PARAMETERS (key
)
9222 /* Either a `switch-frame' or a `select-window' event. */
9223 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9225 /* If we're at the beginning of a key sequence, and the caller
9226 says it's okay, go ahead and return this event. If we're
9227 in the midst of a key sequence, delay it until the end. */
9228 if (t
> 0 || !can_return_switch_frame
)
9230 delayed_switch_frame
= key
;
9235 if (NILP (first_event
))
9238 /* Even if first_event does not specify a particular
9239 window/position, it's important to recompute the maps here
9240 since a long time might have passed since we entered
9241 read_key_sequence, and a timer (or process-filter or
9242 special-event-map, ...) might have switched the current buffer
9243 or the selected window from under us in the mean time. */
9244 if (fix_current_buffer
9245 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9247 Fset_buffer (XWINDOW (selected_window
)->contents
);
9248 current_binding
= active_maps (first_event
);
9252 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9256 /* Clicks in non-text areas get prefixed by the symbol
9257 in their CHAR-ADDRESS field. For example, a click on
9258 the mode line is prefixed by the symbol `mode-line'.
9260 Furthermore, key sequences beginning with mouse clicks
9261 are read using the keymaps of the buffer clicked on, not
9262 the current buffer. So we may have to switch the buffer
9265 When we turn one event into two events, we must make sure
9266 that neither of the two looks like the original--so that,
9267 if we replay the events, they won't be expanded again.
9268 If not for this, such reexpansion could happen either here
9269 or when user programs play with this-command-keys. */
9270 if (EVENT_HAS_PARAMETERS (key
))
9272 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9273 if (EQ (kind
, Qmouse_click
))
9275 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9276 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9279 || (!NILP (fake_prefixed_keys
)
9280 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9282 /* We're looking a second time at an event for which
9283 we generated a fake prefix key. Set
9284 last_real_key_start appropriately. */
9286 last_real_key_start
= t
- 1;
9289 if (last_real_key_start
== 0)
9291 /* Key sequences beginning with mouse clicks are
9292 read using the keymaps in the buffer clicked on,
9293 not the current buffer. If we're at the
9294 beginning of a key sequence, switch buffers. */
9295 if (WINDOWP (window
)
9296 && BUFFERP (XWINDOW (window
)->contents
)
9297 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9299 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9304 /* Arrange to go back to the original buffer once we're
9305 done reading the key sequence. Note that we can't
9306 use save_excursion_{save,restore} here, because they
9307 save point as well as the current buffer; we don't
9308 want to save point, because redisplay may change it,
9309 to accommodate a Fset_window_start or something. We
9310 don't want to do this at the top of the function,
9311 because we may get input from a subprocess which
9312 wants to change the selected window and stuff (say,
9314 record_unwind_current_buffer ();
9316 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9318 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9319 goto replay_sequence
;
9323 /* Expand mode-line and scroll-bar events into two events:
9324 use posn as a fake prefix key. */
9326 && (NILP (fake_prefixed_keys
)
9327 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9329 if (bufsize
- t
<= 1)
9330 error ("Key sequence too long");
9333 keybuf
[t
+ 1] = key
;
9336 /* Record that a fake prefix key has been generated
9337 for KEY. Don't modify the event; this would
9338 prevent proper action when the event is pushed
9339 back into unread-command-events. */
9340 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9344 else if (CONSP (XCDR (key
))
9345 && CONSP (EVENT_START (key
))
9346 && CONSP (XCDR (EVENT_START (key
))))
9350 posn
= POSN_POSN (EVENT_START (key
));
9351 /* Handle menu-bar events:
9352 insert the dummy prefix event `menu-bar'. */
9353 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9355 if (bufsize
- t
<= 1)
9356 error ("Key sequence too long");
9358 keybuf
[t
+ 1] = key
;
9360 /* Zap the position in key, so we know that we've
9361 expanded it, and don't try to do so again. */
9362 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9365 goto replay_sequence
;
9367 else if (CONSP (posn
))
9369 /* We're looking at the second event of a
9370 sequence which we expanded before. Set
9371 last_real_key_start appropriately. */
9372 if (last_real_key_start
== t
&& t
> 0)
9373 last_real_key_start
= t
- 1;
9378 /* We have finally decided that KEY is something we might want
9380 new_binding
= follow_key (current_binding
, key
);
9382 /* If KEY wasn't bound, we'll try some fallbacks. */
9383 if (!NILP (new_binding
))
9384 /* This is needed for the following scenario:
9385 event 0: a down-event that gets dropped by calling replay_key.
9386 event 1: some normal prefix like C-h.
9387 After event 0, first_unbound is 0, after event 1 indec.start,
9388 fkey.start, and keytran.start are all 1, so when we see that
9389 C-h is bound, we need to update first_unbound. */
9390 first_unbound
= max (t
+ 1, first_unbound
);
9395 /* Remember the position to put an upper bound on indec.start. */
9396 first_unbound
= min (t
, first_unbound
);
9398 head
= EVENT_HEAD (key
);
9399 if (help_char_p (head
) && t
> 0)
9401 read_key_sequence_cmd
= Vprefix_help_command
;
9403 last_nonmenu_event
= key
;
9404 /* The Microsoft C compiler can't handle the goto that
9412 Lisp_Object breakdown
;
9415 breakdown
= parse_modifiers (head
);
9416 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9417 /* Attempt to reduce an unbound mouse event to a simpler
9418 event that is bound:
9419 Drags reduce to clicks.
9420 Double-clicks reduce to clicks.
9421 Triple-clicks reduce to double-clicks, then to clicks.
9422 Down-clicks are eliminated.
9423 Double-downs reduce to downs, then are eliminated.
9424 Triple-downs reduce to double-downs, then to downs,
9425 then are eliminated. */
9426 if (modifiers
& (down_modifier
| drag_modifier
9427 | double_modifier
| triple_modifier
))
9429 while (modifiers
& (down_modifier
| drag_modifier
9430 | double_modifier
| triple_modifier
))
9432 Lisp_Object new_head
, new_click
;
9433 if (modifiers
& triple_modifier
)
9434 modifiers
^= (double_modifier
| triple_modifier
);
9435 else if (modifiers
& double_modifier
)
9436 modifiers
&= ~double_modifier
;
9437 else if (modifiers
& drag_modifier
)
9438 modifiers
&= ~drag_modifier
;
9441 /* Dispose of this `down' event by simply jumping
9442 back to replay_key, to get another event.
9444 Note that if this event came from mock input,
9445 then just jumping back to replay_key will just
9446 hand it to us again. So we have to wipe out any
9449 We could delete keybuf[t] and shift everything
9450 after that to the left by one spot, but we'd also
9451 have to fix up any variable that points into
9452 keybuf, and shifting isn't really necessary
9455 Adding prefixes for non-textual mouse clicks
9456 creates two characters of mock input, and both
9457 must be thrown away. If we're only looking at
9458 the prefix now, we can just jump back to
9459 replay_key. On the other hand, if we've already
9460 processed the prefix, and now the actual click
9461 itself is giving us trouble, then we've lost the
9462 state of the keymaps we want to backtrack to, and
9463 we need to replay the whole sequence to rebuild
9466 Beyond that, only function key expansion could
9467 create more than two keys, but that should never
9468 generate mouse events, so it's okay to zero
9469 mock_input in that case too.
9471 FIXME: The above paragraph seems just plain
9472 wrong, if you consider things like
9473 xterm-mouse-mode. -stef
9475 Isn't this just the most wonderful code ever? */
9477 /* If mock_input > t + 1, the above simplification
9478 will actually end up dropping keys on the floor.
9479 This is probably OK for now, but even
9480 if mock_input <= t + 1, we need to adjust indec,
9482 Typical case [header-line down-mouse-N]:
9483 mock_input = 2, t = 1, fkey.end = 1,
9484 last_real_key_start = 0. */
9485 if (indec
.end
> last_real_key_start
)
9487 indec
.end
= indec
.start
9488 = min (last_real_key_start
, indec
.start
);
9489 indec
.map
= indec
.parent
;
9490 if (fkey
.end
> last_real_key_start
)
9492 fkey
.end
= fkey
.start
9493 = min (last_real_key_start
, fkey
.start
);
9494 fkey
.map
= fkey
.parent
;
9495 if (keytran
.end
> last_real_key_start
)
9497 keytran
.end
= keytran
.start
9498 = min (last_real_key_start
, keytran
.start
);
9499 keytran
.map
= keytran
.parent
;
9503 if (t
== last_real_key_start
)
9510 mock_input
= last_real_key_start
;
9511 goto replay_sequence
;
9516 = apply_modifiers (modifiers
, XCAR (breakdown
));
9517 new_click
= list2 (new_head
, EVENT_START (key
));
9519 /* Look for a binding for this new key. */
9520 new_binding
= follow_key (current_binding
, new_click
);
9522 /* If that click is bound, go for it. */
9523 if (!NILP (new_binding
))
9525 current_binding
= new_binding
;
9529 /* Otherwise, we'll leave key set to the drag event. */
9534 current_binding
= new_binding
;
9537 /* Normally, last_nonmenu_event gets the previous key we read.
9538 But when a mouse popup menu is being used,
9539 we don't update last_nonmenu_event; it continues to hold the mouse
9540 event that preceded the first level of menu. */
9541 if (!used_mouse_menu
)
9542 last_nonmenu_event
= key
;
9544 /* Record what part of this_command_keys is the current key sequence. */
9545 this_single_command_key_start
= this_command_key_count
- t
;
9547 /* Look for this sequence in input-decode-map.
9548 Scan from indec.end until we find a bound suffix. */
9549 while (indec
.end
< t
)
9551 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9555 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9556 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9561 mock_input
= diff
+ max (t
, mock_input
);
9562 goto replay_sequence
;
9566 if (!KEYMAPP (current_binding
)
9567 && !test_undefined (current_binding
)
9568 && indec
.start
>= t
)
9569 /* There is a binding and it's not a prefix.
9570 (and it doesn't have any input-decode-map translation pending).
9571 There is thus no function-key in this sequence.
9572 Moving fkey.start is important in this case to allow keytran.start
9573 to go over the sequence before we return (since we keep the
9574 invariant that keytran.end <= fkey.start). */
9577 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9580 /* If the sequence is unbound, see if we can hang a function key
9581 off the end of it. */
9582 /* Continue scan from fkey.end until we find a bound suffix. */
9583 while (fkey
.end
< indec
.start
)
9585 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9589 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9590 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9591 max (t
, mock_input
),
9592 /* If there's a binding (i.e.
9593 first_binding >= nmaps) we don't want
9594 to apply this function-key-mapping. */
9596 && (test_undefined (current_binding
)),
9601 mock_input
= diff
+ max (t
, mock_input
);
9602 /* Adjust the input-decode-map counters. */
9604 indec
.start
+= diff
;
9606 goto replay_sequence
;
9610 /* Look for this sequence in key-translation-map.
9611 Scan from keytran.end until we find a bound suffix. */
9612 while (keytran
.end
< fkey
.start
)
9614 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9618 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9619 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9624 mock_input
= diff
+ max (t
, mock_input
);
9625 /* Adjust the function-key-map and input-decode-map counters. */
9627 indec
.start
+= diff
;
9631 goto replay_sequence
;
9635 /* If KEY is not defined in any of the keymaps,
9636 and cannot be part of a function key or translation,
9637 and is an upper case letter
9638 use the corresponding lower-case letter instead. */
9639 if (NILP (current_binding
)
9640 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9642 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9643 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9644 || (XINT (key
) & shift_modifier
)))
9646 Lisp_Object new_key
;
9648 original_uppercase
= key
;
9649 original_uppercase_position
= t
- 1;
9651 if (XINT (key
) & shift_modifier
)
9652 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9654 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9655 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9657 /* We have to do this unconditionally, regardless of whether
9658 the lower-case char is defined in the keymaps, because they
9659 might get translated through function-key-map. */
9660 keybuf
[t
- 1] = new_key
;
9661 mock_input
= max (t
, mock_input
);
9662 shift_translated
= 1;
9664 goto replay_sequence
;
9666 /* If KEY is not defined in any of the keymaps,
9667 and cannot be part of a function key or translation,
9668 and is a shifted function key,
9669 use the corresponding unshifted function key instead. */
9670 if (NILP (current_binding
)
9671 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9673 Lisp_Object breakdown
= parse_modifiers (key
);
9675 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9677 if (modifiers
& shift_modifier
9678 /* Treat uppercase keys as shifted. */
9680 && (KEY_TO_CHAR (key
)
9681 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9682 && uppercasep (KEY_TO_CHAR (key
))))
9685 = (modifiers
& shift_modifier
9686 ? apply_modifiers (modifiers
& ~shift_modifier
,
9688 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9690 original_uppercase
= key
;
9691 original_uppercase_position
= t
- 1;
9693 /* We have to do this unconditionally, regardless of whether
9694 the lower-case char is defined in the keymaps, because they
9695 might get translated through function-key-map. */
9696 keybuf
[t
- 1] = new_key
;
9697 mock_input
= max (t
, mock_input
);
9698 /* Reset fkey (and consequently keytran) to apply
9699 function-key-map on the result, so that S-backspace is
9700 correctly mapped to DEL (via backspace). OTOH,
9701 input-decode-map doesn't need to go through it again. */
9702 fkey
.start
= fkey
.end
= 0;
9703 keytran
.start
= keytran
.end
= 0;
9704 shift_translated
= 1;
9706 goto replay_sequence
;
9711 read_key_sequence_cmd
= current_binding
;
9712 read_key_sequence_remapped
9713 /* Remap command through active keymaps.
9714 Do the remapping here, before the unbind_to so it uses the keymaps
9715 of the appropriate buffer. */
9716 = SYMBOLP (read_key_sequence_cmd
)
9717 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9720 unread_switch_frame
= delayed_switch_frame
;
9721 unbind_to (count
, Qnil
);
9723 /* Don't downcase the last character if the caller says don't.
9724 Don't downcase it if the result is undefined, either. */
9725 if ((dont_downcase_last
|| NILP (current_binding
))
9727 && t
- 1 == original_uppercase_position
)
9729 keybuf
[t
- 1] = original_uppercase
;
9730 shift_translated
= 0;
9733 if (shift_translated
)
9734 Vthis_command_keys_shift_translated
= Qt
;
9736 /* Occasionally we fabricate events, perhaps by expanding something
9737 according to function-key-map, or by adding a prefix symbol to a
9738 mouse click in the scroll bar or modeline. In this cases, return
9739 the entire generated key sequence, even if we hit an unbound
9740 prefix or a definition before the end. This means that you will
9741 be able to push back the event properly, and also means that
9742 read-key-sequence will always return a logical unit.
9745 for (; t
< mock_input
; t
++)
9747 if (echo_keystrokes_p ())
9748 echo_char (keybuf
[t
]);
9749 add_command_key (keybuf
[t
]);
9757 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9758 Lisp_Object dont_downcase_last
,
9759 Lisp_Object can_return_switch_frame
,
9760 Lisp_Object cmd_loop
, bool allow_string
)
9762 Lisp_Object keybuf
[30];
9764 struct gcpro gcpro1
;
9765 ptrdiff_t count
= SPECPDL_INDEX ();
9768 CHECK_STRING (prompt
);
9771 specbind (Qinput_method_exit_on_first_char
,
9772 (NILP (cmd_loop
) ? Qt
: Qnil
));
9773 specbind (Qinput_method_use_echo_area
,
9774 (NILP (cmd_loop
) ? Qt
: Qnil
));
9776 memset (keybuf
, 0, sizeof keybuf
);
9778 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9780 if (NILP (continue_echo
))
9782 this_command_key_count
= 0;
9783 this_command_key_count_reset
= 0;
9784 this_single_command_key_start
= 0;
9787 #ifdef HAVE_WINDOW_SYSTEM
9788 if (display_hourglass_p
)
9789 cancel_hourglass ();
9792 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9793 prompt
, ! NILP (dont_downcase_last
),
9794 ! NILP (can_return_switch_frame
), 0, 0);
9796 #if 0 /* The following is fine for code reading a key sequence and
9797 then proceeding with a lengthy computation, but it's not good
9798 for code reading keys in a loop, like an input method. */
9799 #ifdef HAVE_WINDOW_SYSTEM
9800 if (display_hourglass_p
)
9811 return unbind_to (count
,
9812 ((allow_string
? make_event_array
: Fvector
)
9816 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9817 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9818 The sequence is sufficient to specify a non-prefix command in the
9819 current local and global maps.
9821 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9822 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9823 as a continuation of the previous key.
9825 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9826 convert the last event to lower case. (Normally any upper case event
9827 is converted to lower case if the original event is undefined and the lower
9828 case equivalent is defined.) A non-nil value is appropriate for reading
9829 a key sequence to be defined.
9831 A C-g typed while in this function is treated like any other character,
9832 and `quit-flag' is not set.
9834 If the key sequence starts with a mouse click, then the sequence is read
9835 using the keymaps of the buffer of the window clicked in, not the buffer
9836 of the selected window as normal.
9838 `read-key-sequence' drops unbound button-down events, since you normally
9839 only care about the click or drag events which follow them. If a drag
9840 or multi-click event is unbound, but the corresponding click event would
9841 be bound, `read-key-sequence' turns the event into a click event at the
9842 drag's starting position. This means that you don't have to distinguish
9843 between click and drag, double, or triple events unless you want to.
9845 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9846 lines separating windows, and scroll bars with imaginary keys
9847 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9849 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9850 function will process a switch-frame event if the user switches frames
9851 before typing anything. If the user switches frames in the middle of a
9852 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9853 is nil, then the event will be put off until after the current key sequence.
9855 `read-key-sequence' checks `function-key-map' for function key
9856 sequences, where they wouldn't conflict with ordinary bindings. See
9857 `function-key-map' for more details.
9859 The optional fifth argument CMD-LOOP, if non-nil, means
9860 that this key sequence is being read by something that will
9861 read commands one after another. It should be nil if the caller
9862 will read just one key sequence. */)
9863 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9865 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9866 can_return_switch_frame
, cmd_loop
, true);
9869 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9870 Sread_key_sequence_vector
, 1, 5, 0,
9871 doc
: /* Like `read-key-sequence' but always return a vector. */)
9872 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9874 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9875 can_return_switch_frame
, cmd_loop
, false);
9878 /* Return true if input events are pending. */
9881 detect_input_pending (void)
9883 return input_pending
|| get_input_pending (0);
9886 /* Return true if input events other than mouse movements are
9890 detect_input_pending_ignore_squeezables (void)
9892 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9895 /* Return true if input events are pending, and run any pending timers. */
9898 detect_input_pending_run_timers (bool do_display
)
9900 unsigned old_timers_run
= timers_run
;
9903 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9905 if (old_timers_run
!= timers_run
&& do_display
)
9906 redisplay_preserve_echo_area (8);
9908 return input_pending
;
9911 /* This is called in some cases before a possible quit.
9912 It cases the next call to detect_input_pending to recompute input_pending.
9913 So calling this function unnecessarily can't do any harm. */
9916 clear_input_pending (void)
9921 /* Return true if there are pending requeued events.
9922 This isn't used yet. The hope is to make wait_reading_process_output
9923 call it, and return if it runs Lisp code that unreads something.
9924 The problem is, kbd_buffer_get_event needs to be fixed to know what
9925 to do in that case. It isn't trivial. */
9928 requeued_events_pending_p (void)
9930 return (!NILP (Vunread_command_events
));
9933 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9934 doc
: /* Return t if command input is currently available with no wait.
9935 Actually, the value is nil only if we can be sure that no input is available;
9936 if there is a doubt, the value is t.
9938 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9939 (Lisp_Object check_timers
)
9941 if (!NILP (Vunread_command_events
)
9942 || !NILP (Vunread_post_input_method_events
)
9943 || !NILP (Vunread_input_method_events
))
9946 /* Process non-user-visible events (Bug#10195). */
9947 process_special_events ();
9949 return (get_input_pending ((NILP (check_timers
)
9950 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9951 | READABLE_EVENTS_FILTER_EVENTS
)
9955 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9956 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9959 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9962 if (total_keys
< NUM_RECENT_KEYS
)
9963 return Fvector (total_keys
, keys
);
9966 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9967 vcopy (val
, 0, keys
+ recent_keys_index
,
9968 NUM_RECENT_KEYS
- recent_keys_index
);
9969 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9970 keys
, recent_keys_index
);
9975 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9976 doc
: /* Return the key sequence that invoked this command.
9977 However, if the command has called `read-key-sequence', it returns
9978 the last key sequence that has been read.
9979 The value is a string or a vector.
9981 See also `this-command-keys-vector'. */)
9984 return make_event_array (this_command_key_count
,
9985 XVECTOR (this_command_keys
)->contents
);
9988 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9989 doc
: /* Return the key sequence that invoked this command, as a vector.
9990 However, if the command has called `read-key-sequence', it returns
9991 the last key sequence that has been read.
9993 See also `this-command-keys'. */)
9996 return Fvector (this_command_key_count
,
9997 XVECTOR (this_command_keys
)->contents
);
10000 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10001 Sthis_single_command_keys
, 0, 0, 0,
10002 doc
: /* Return the key sequence that invoked this command.
10003 More generally, it returns the last key sequence read, either by
10004 the command loop or by `read-key-sequence'.
10005 Unlike `this-command-keys', this function's value
10006 does not include prefix arguments.
10007 The value is always a vector. */)
10010 return Fvector (this_command_key_count
10011 - this_single_command_key_start
,
10012 (XVECTOR (this_command_keys
)->contents
10013 + this_single_command_key_start
));
10016 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10017 Sthis_single_command_raw_keys
, 0, 0, 0,
10018 doc
: /* Return the raw events that were read for this command.
10019 More generally, it returns the last key sequence read, either by
10020 the command loop or by `read-key-sequence'.
10021 Unlike `this-single-command-keys', this function's value
10022 shows the events before all translations (except for input methods).
10023 The value is always a vector. */)
10026 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10029 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10030 Sreset_this_command_lengths
, 0, 0, 0,
10031 doc
: /* Make the unread events replace the last command and echo.
10032 Used in `universal-argument-other-key'.
10034 `universal-argument-other-key' rereads the event just typed.
10035 It then gets translated through `function-key-map'.
10036 The translated event has to replace the real events,
10037 both in the value of (this-command-keys) and in echoing.
10038 To achieve this, `universal-argument-other-key' calls
10039 `reset-this-command-lengths', which discards the record of reading
10040 these events the first time. */)
10043 this_command_key_count
= before_command_key_count
;
10044 if (this_command_key_count
< this_single_command_key_start
)
10045 this_single_command_key_start
= this_command_key_count
;
10047 echo_truncate (before_command_echo_length
);
10049 /* Cause whatever we put into unread-command-events
10050 to echo as if it were being freshly read from the keyboard. */
10051 this_command_key_count_reset
= 1;
10056 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10057 Sclear_this_command_keys
, 0, 1, 0,
10058 doc
: /* Clear out the vector that `this-command-keys' returns.
10059 Also clear the record of the last 100 events, unless optional arg
10060 KEEP-RECORD is non-nil. */)
10061 (Lisp_Object keep_record
)
10065 this_command_key_count
= 0;
10066 this_command_key_count_reset
= 0;
10068 if (NILP (keep_record
))
10070 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10071 ASET (recent_keys
, i
, Qnil
);
10073 recent_keys_index
= 0;
10078 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10079 doc
: /* Return the current depth in recursive edits. */)
10083 /* Wrap around reliably on integer overflow. */
10084 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10085 XSETINT (temp
, sum
);
10089 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10090 "FOpen dribble file: ",
10091 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10092 If FILE is nil, close any open dribble file.
10093 The file will be closed when Emacs exits.
10095 Be aware that this records ALL characters you type!
10096 This may include sensitive information such as passwords. */)
10109 Lisp_Object encfile
;
10111 file
= Fexpand_file_name (file
, Qnil
);
10112 encfile
= ENCODE_FILE (file
);
10113 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10114 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10115 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10116 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10118 report_file_error ("Opening dribble", file
);
10123 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10124 doc
: /* Discard the contents of the terminal input buffer.
10125 Also end any kbd macro being defined. */)
10128 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10130 /* Discard the last command from the macro. */
10131 Fcancel_kbd_macro_events ();
10135 Vunread_command_events
= Qnil
;
10137 discard_tty_input ();
10139 kbd_fetch_ptr
= kbd_store_ptr
;
10145 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10146 doc
: /* Stop Emacs and return to superior process. You can resume later.
10147 If `cannot-suspend' is non-nil, or if the system doesn't support job
10148 control, run a subshell instead.
10150 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10151 to be read as terminal input by Emacs's parent, after suspension.
10153 Before suspending, run the normal hook `suspend-hook'.
10154 After resumption run the normal hook `suspend-resume-hook'.
10156 Some operating systems cannot stop the Emacs process and resume it later.
10157 On such systems, Emacs starts a subshell instead of suspending. */)
10158 (Lisp_Object stuffstring
)
10160 ptrdiff_t count
= SPECPDL_INDEX ();
10161 int old_height
, old_width
;
10163 struct gcpro gcpro1
;
10166 if (tty_list
&& tty_list
->next
)
10167 error ("There are other tty frames open; close them before suspending Emacs");
10169 if (!NILP (stuffstring
))
10170 CHECK_STRING (stuffstring
);
10172 /* Run the functions in suspend-hook. */
10173 hook
= intern ("suspend-hook");
10174 Frun_hooks (1, &hook
);
10176 GCPRO1 (stuffstring
);
10177 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10178 reset_all_sys_modes ();
10179 /* sys_suspend can get an error if it tries to fork a subshell
10180 and the system resources aren't available for that. */
10181 record_unwind_protect_void (init_all_sys_modes
);
10182 stuff_buffered_input (stuffstring
);
10183 if (cannot_suspend
)
10187 unbind_to (count
, Qnil
);
10189 /* Check if terminal/window size has changed.
10190 Note that this is not useful when we are running directly
10191 with a window system; but suspend should be disabled in that case. */
10192 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10193 if (width
!= old_width
|| height
!= old_height
)
10194 change_frame_size (SELECTED_FRAME (), width
, height
, 0, 0, 0, 0);
10196 /* Run suspend-resume-hook. */
10197 hook
= intern ("suspend-resume-hook");
10198 Frun_hooks (1, &hook
);
10204 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10205 Then in any case stuff anything Emacs has read ahead and not used. */
10208 stuff_buffered_input (Lisp_Object stuffstring
)
10210 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10211 register unsigned char *p
;
10213 if (STRINGP (stuffstring
))
10215 register ptrdiff_t count
;
10217 p
= SDATA (stuffstring
);
10218 count
= SBYTES (stuffstring
);
10219 while (count
-- > 0)
10224 /* Anything we have read ahead, put back for the shell to read. */
10225 /* ?? What should this do when we have multiple keyboards??
10226 Should we ignore anything that was typed in at the "wrong" kboard?
10228 rms: we should stuff everything back into the kboard
10230 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10233 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10234 kbd_fetch_ptr
= kbd_buffer
;
10235 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10236 stuff_char (kbd_fetch_ptr
->code
);
10238 clear_event (kbd_fetch_ptr
);
10242 #endif /* SIGTSTP */
10246 set_waiting_for_input (struct timespec
*time_to_clear
)
10248 input_available_clear_time
= time_to_clear
;
10250 /* Tell handle_interrupt to throw back to read_char, */
10251 waiting_for_input
= 1;
10253 /* If handle_interrupt was called before and buffered a C-g,
10254 make it run again now, to avoid timing error. */
10255 if (!NILP (Vquit_flag
))
10256 quit_throw_to_read_char (0);
10260 clear_waiting_for_input (void)
10262 /* Tell handle_interrupt not to throw back to read_char, */
10263 waiting_for_input
= 0;
10264 input_available_clear_time
= 0;
10267 /* The SIGINT handler.
10269 If we have a frame on the controlling tty, we assume that the
10270 SIGINT was generated by C-g, so we call handle_interrupt.
10271 Otherwise, tell QUIT to kill Emacs. */
10274 handle_interrupt_signal (int sig
)
10276 /* See if we have an active terminal on our controlling tty. */
10277 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10280 /* If there are no frames there, let's pretend that we are a
10281 well-behaving UN*X program and quit. We must not call Lisp
10282 in a signal handler, so tell QUIT to exit when it is
10284 Vquit_flag
= Qkill_emacs
;
10288 /* Otherwise, the SIGINT was probably generated by C-g. */
10290 /* Set internal_last_event_frame to the top frame of the
10291 controlling tty, if we have a frame there. We disable the
10292 interrupt key on secondary ttys, so the SIGINT must have come
10293 from the controlling tty. */
10294 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10296 handle_interrupt (1);
10301 deliver_interrupt_signal (int sig
)
10303 deliver_process_signal (sig
, handle_interrupt_signal
);
10307 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10308 of the number of times C-g has been requested. If C-g is pressed
10309 enough times, then quit anyway. See bug#6585. */
10310 static int volatile force_quit_count
;
10312 /* This routine is called at interrupt level in response to C-g.
10314 It is called from the SIGINT handler or kbd_buffer_store_event.
10316 If `waiting_for_input' is non zero, then unless `echoing' is
10317 nonzero, immediately throw back to read_char.
10319 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10320 eval to throw, when it gets a chance. If quit-flag is already
10321 non-nil, it stops the job right away. */
10324 handle_interrupt (bool in_signal_handler
)
10330 /* XXX This code needs to be revised for multi-tty support. */
10331 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10333 if (! in_signal_handler
)
10335 /* If SIGINT isn't blocked, don't let us be interrupted by
10336 a SIGINT. It might be harmful due to non-reentrancy
10337 in I/O functions. */
10339 sigemptyset (&blocked
);
10340 sigaddset (&blocked
, SIGINT
);
10341 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10345 reset_all_sys_modes ();
10349 * On systems which can suspend the current process and return to the original
10350 * shell, this command causes the user to end up back at the shell.
10351 * The "Auto-save" and "Abort" questions are not asked until
10352 * the user elects to return to emacs, at which point he can save the current
10353 * job and either dump core or continue.
10357 /* Perhaps should really fork an inferior shell?
10358 But that would not provide any way to get back
10359 to the original shell, ever. */
10360 printf ("No support for stopping a process on this operating system;\n");
10361 printf ("you can continue or abort.\n");
10362 #endif /* not SIGTSTP */
10364 /* We must remain inside the screen area when the internal terminal
10365 is used. Note that [Enter] is not echoed by dos. */
10366 cursor_to (SELECTED_FRAME (), 0, 0);
10368 /* It doesn't work to autosave while GC is in progress;
10369 the code used for auto-saving doesn't cope with the mark bit. */
10370 if (!gc_in_progress
)
10372 printf ("Auto-save? (y or n) ");
10374 if (((c
= getchar ()) & ~040) == 'Y')
10376 Fdo_auto_save (Qt
, Qnil
);
10378 printf ("\r\nAuto-save done");
10379 #else /* not MSDOS */
10380 printf ("Auto-save done\n");
10381 #endif /* not MSDOS */
10383 while (c
!= '\n') c
= getchar ();
10387 /* During GC, it must be safe to reenable quitting again. */
10388 Vinhibit_quit
= Qnil
;
10391 #endif /* not MSDOS */
10392 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10393 printf ("but will instead do a real quit after garbage collection ends\r\n");
10398 printf ("\r\nAbort? (y or n) ");
10399 #else /* not MSDOS */
10400 printf ("Abort (and dump core)? (y or n) ");
10401 #endif /* not MSDOS */
10403 if (((c
= getchar ()) & ~040) == 'Y')
10405 while (c
!= '\n') c
= getchar ();
10407 printf ("\r\nContinuing...\r\n");
10408 #else /* not MSDOS */
10409 printf ("Continuing...\n");
10410 #endif /* not MSDOS */
10412 init_all_sys_modes ();
10416 /* If executing a function that wants to be interrupted out of
10417 and the user has not deferred quitting by binding `inhibit-quit'
10418 then quit right away. */
10419 if (immediate_quit
&& NILP (Vinhibit_quit
))
10421 struct gl_state_s saved
;
10422 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10424 immediate_quit
= 0;
10425 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10427 GCPRO4 (saved
.object
, saved
.global_code
,
10428 saved
.current_syntax_table
, saved
.old_prop
);
10429 Fsignal (Qquit
, Qnil
);
10434 { /* Else request quit when it's safe. */
10435 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10436 force_quit_count
= count
;
10439 immediate_quit
= 1;
10440 Vinhibit_quit
= Qnil
;
10446 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10448 /* TODO: The longjmp in this call throws the NS event loop integration off,
10449 and it seems to do fine without this. Probably some attention
10450 needs to be paid to the setting of waiting_for_input in
10451 wait_reading_process_output() under HAVE_NS because of the call
10452 to ns_select there (needed because otherwise events aren't picked up
10453 outside of polling since we don't get SIGIO like X and we don't have a
10454 separate event loop thread like W32. */
10456 if (waiting_for_input
&& !echoing
)
10457 quit_throw_to_read_char (in_signal_handler
);
10461 /* Handle a C-g by making read_char return C-g. */
10464 quit_throw_to_read_char (bool from_signal
)
10466 /* When not called from a signal handler it is safe to call
10468 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10469 Fkill_emacs (Qnil
);
10471 /* Prevent another signal from doing this before we finish. */
10472 clear_waiting_for_input ();
10475 Vunread_command_events
= Qnil
;
10477 if (FRAMEP (internal_last_event_frame
)
10478 && !EQ (internal_last_event_frame
, selected_frame
))
10479 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10482 sys_longjmp (getcjmp
, 1);
10485 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10486 Sset_input_interrupt_mode
, 1, 1, 0,
10487 doc
: /* Set interrupt mode of reading keyboard input.
10488 If INTERRUPT is non-nil, Emacs will use input interrupts;
10489 otherwise Emacs uses CBREAK mode.
10491 See also `current-input-mode'. */)
10492 (Lisp_Object interrupt
)
10494 bool new_interrupt_input
;
10495 #ifdef USABLE_SIGIO
10496 #ifdef HAVE_X_WINDOWS
10497 if (x_display_list
!= NULL
)
10499 /* When using X, don't give the user a real choice,
10500 because we haven't implemented the mechanisms to support it. */
10501 new_interrupt_input
= 1;
10504 #endif /* HAVE_X_WINDOWS */
10505 new_interrupt_input
= !NILP (interrupt
);
10506 #else /* not USABLE_SIGIO */
10507 new_interrupt_input
= 0;
10508 #endif /* not USABLE_SIGIO */
10510 if (new_interrupt_input
!= interrupt_input
)
10512 #ifdef POLL_FOR_INPUT
10516 /* this causes startup screen to be restored and messes with the mouse */
10517 reset_all_sys_modes ();
10518 interrupt_input
= new_interrupt_input
;
10519 init_all_sys_modes ();
10521 interrupt_input
= new_interrupt_input
;
10524 #ifdef POLL_FOR_INPUT
10525 poll_suppress_count
= 1;
10532 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10533 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10534 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10535 C-q in key sequences.
10537 This setting only has an effect on tty terminals and only when
10538 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10540 See also `current-input-mode'. */)
10541 (Lisp_Object flow
, Lisp_Object terminal
)
10543 struct terminal
*t
= get_terminal (terminal
, 1);
10544 struct tty_display_info
*tty
;
10545 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10547 tty
= t
->display_info
.tty
;
10549 if (tty
->flow_control
!= !NILP (flow
))
10552 /* This causes startup screen to be restored and messes with the mouse. */
10553 reset_sys_modes (tty
);
10556 tty
->flow_control
= !NILP (flow
);
10559 init_sys_modes (tty
);
10565 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10566 doc
: /* Enable or disable 8-bit input on TERMINAL.
10567 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10568 bit as the Meta modifier.
10570 If META is nil, Emacs will ignore the top bit, on the assumption it is
10573 Otherwise, Emacs will accept and pass through 8-bit input without
10574 specially interpreting the top bit.
10576 This setting only has an effect on tty terminal devices.
10578 Optional parameter TERMINAL specifies the tty terminal device to use.
10579 It may be a terminal object, a frame, or nil for the terminal used by
10580 the currently selected frame.
10582 See also `current-input-mode'. */)
10583 (Lisp_Object meta
, Lisp_Object terminal
)
10585 struct terminal
*t
= get_terminal (terminal
, 1);
10586 struct tty_display_info
*tty
;
10589 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10591 tty
= t
->display_info
.tty
;
10595 else if (EQ (meta
, Qt
))
10600 if (tty
->meta_key
!= new_meta
)
10603 /* this causes startup screen to be restored and messes with the mouse */
10604 reset_sys_modes (tty
);
10607 tty
->meta_key
= new_meta
;
10610 init_sys_modes (tty
);
10616 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10617 doc
: /* Specify character used for quitting.
10618 QUIT must be an ASCII character.
10620 This function only has an effect on the controlling tty of the Emacs
10623 See also `current-input-mode'. */)
10626 struct terminal
*t
= get_named_tty ("/dev/tty");
10627 struct tty_display_info
*tty
;
10628 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10630 tty
= t
->display_info
.tty
;
10632 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10633 error ("QUIT must be an ASCII character");
10636 /* this causes startup screen to be restored and messes with the mouse */
10637 reset_sys_modes (tty
);
10640 /* Don't let this value be out of range. */
10641 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10644 init_sys_modes (tty
);
10650 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10651 doc
: /* Set mode of reading keyboard input.
10652 First arg INTERRUPT non-nil means use input interrupts;
10653 nil means use CBREAK mode.
10654 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10655 (no effect except in CBREAK mode).
10656 Third arg META t means accept 8-bit input (for a Meta key).
10657 META nil means ignore the top bit, on the assumption it is parity.
10658 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10659 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10660 See also `current-input-mode'. */)
10661 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10663 Fset_input_interrupt_mode (interrupt
);
10664 Fset_output_flow_control (flow
, Qnil
);
10665 Fset_input_meta_mode (meta
, Qnil
);
10667 Fset_quit_char (quit
);
10671 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10672 doc
: /* Return information about the way Emacs currently reads keyboard input.
10673 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10674 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10675 nil, Emacs is using CBREAK mode.
10676 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10677 terminal; this does not apply if Emacs uses interrupt-driven input.
10678 META is t if accepting 8-bit input with 8th bit as Meta flag.
10679 META nil means ignoring the top bit, on the assumption it is parity.
10680 META is neither t nor nil if accepting 8-bit input and using
10681 all 8 bits as the character code.
10682 QUIT is the character Emacs currently uses to quit.
10683 The elements of this list correspond to the arguments of
10684 `set-input-mode'. */)
10687 Lisp_Object val
[4];
10688 struct frame
*sf
= XFRAME (selected_frame
);
10690 val
[0] = interrupt_input
? Qt
: Qnil
;
10691 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10693 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10694 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10696 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10703 XSETFASTINT (val
[3], quit_char
);
10705 return Flist (ARRAYELTS (val
), val
);
10708 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10709 doc
: /* Return position information for pixel coordinates X and Y.
10710 By default, X and Y are relative to text area of the selected window.
10711 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10712 If optional fourth arg WHOLE is non-nil, X is relative to the left
10713 edge of the window.
10715 The return value is similar to a mouse click position:
10716 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10717 IMAGE (DX . DY) (WIDTH . HEIGHT))
10718 The `posn-' functions access elements of such lists. */)
10719 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10724 if (NILP (frame_or_window
))
10725 frame_or_window
= selected_window
;
10727 if (WINDOWP (frame_or_window
))
10729 struct window
*w
= decode_live_window (frame_or_window
);
10731 XSETINT (x
, (XINT (x
)
10732 + WINDOW_LEFT_EDGE_X (w
)
10734 ? window_box_left_offset (w
, TEXT_AREA
)
10736 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10737 frame_or_window
= w
->frame
;
10740 CHECK_LIVE_FRAME (frame_or_window
);
10742 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10745 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10746 doc
: /* Return position information for buffer POS in WINDOW.
10747 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10749 Return nil if position is not visible in window. Otherwise,
10750 the return value is similar to that returned by `event-start' for
10751 a mouse click at the upper left corner of the glyph corresponding
10752 to the given buffer position:
10753 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10754 IMAGE (DX . DY) (WIDTH . HEIGHT))
10755 The `posn-' functions access elements of such lists. */)
10756 (Lisp_Object pos
, Lisp_Object window
)
10761 window
= selected_window
;
10763 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10766 Lisp_Object x
= XCAR (tem
);
10767 Lisp_Object y
= XCAR (XCDR (tem
));
10769 /* Point invisible due to hscrolling? */
10772 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10778 /* Set up a new kboard object with reasonable initial values.
10779 TYPE is a window system for which this keyboard is used. */
10782 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10784 kset_overriding_terminal_local_map (kb
, Qnil
);
10785 kset_last_command (kb
, Qnil
);
10786 kset_real_last_command (kb
, Qnil
);
10787 kset_keyboard_translate_table (kb
, Qnil
);
10788 kset_last_repeatable_command (kb
, Qnil
);
10789 kset_prefix_arg (kb
, Qnil
);
10790 kset_last_prefix_arg (kb
, Qnil
);
10791 kset_kbd_queue (kb
, Qnil
);
10792 kb
->kbd_queue_has_data
= 0;
10793 kb
->immediate_echo
= 0;
10794 kset_echo_string (kb
, Qnil
);
10795 kb
->echo_after_prompt
= -1;
10796 kb
->kbd_macro_buffer
= 0;
10797 kb
->kbd_macro_bufsize
= 0;
10798 kset_defining_kbd_macro (kb
, Qnil
);
10799 kset_last_kbd_macro (kb
, Qnil
);
10800 kb
->reference_count
= 0;
10801 kset_system_key_alist (kb
, Qnil
);
10802 kset_system_key_syms (kb
, Qnil
);
10803 kset_window_system (kb
, type
);
10804 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10805 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10806 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10807 kset_default_minibuffer_frame (kb
, Qnil
);
10810 /* Allocate and basically initialize keyboard
10811 object to use with window system TYPE. */
10814 allocate_kboard (Lisp_Object type
)
10816 KBOARD
*kb
= xmalloc (sizeof *kb
);
10818 init_kboard (kb
, type
);
10819 kb
->next_kboard
= all_kboards
;
10825 * Destroy the contents of a kboard object, but not the object itself.
10826 * We use this just before deleting it, or if we're going to initialize
10827 * it a second time.
10830 wipe_kboard (KBOARD
*kb
)
10832 xfree (kb
->kbd_macro_buffer
);
10835 /* Free KB and memory referenced from it. */
10838 delete_kboard (KBOARD
*kb
)
10842 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10845 *kbp
= kb
->next_kboard
;
10847 /* Prevent a dangling reference to KB. */
10848 if (kb
== current_kboard
10849 && FRAMEP (selected_frame
)
10850 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10852 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10854 if (current_kboard
== kb
)
10863 init_keyboard (void)
10865 /* This is correct before outermost invocation of the editor loop. */
10866 command_loop_level
= -1;
10867 immediate_quit
= 0;
10868 quit_char
= Ctl ('g');
10869 Vunread_command_events
= Qnil
;
10870 timer_idleness_start_time
= invalid_timespec ();
10872 recent_keys_index
= 0;
10873 kbd_fetch_ptr
= kbd_buffer
;
10874 kbd_store_ptr
= kbd_buffer
;
10875 do_mouse_tracking
= Qnil
;
10877 interrupt_input_blocked
= 0;
10878 pending_signals
= 0;
10880 /* This means that command_loop_1 won't try to select anything the first
10882 internal_last_event_frame
= Qnil
;
10883 Vlast_event_frame
= internal_last_event_frame
;
10885 current_kboard
= initial_kboard
;
10886 /* Re-initialize the keyboard again. */
10887 wipe_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 init_kboard (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 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10953 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10954 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10955 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10956 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10957 /* `select-window' should be handled just like `switch-frame'
10958 in read_key_sequence. */
10959 {&Qselect_window
, "select-window", &Qswitch_frame
}
10963 syms_of_keyboard (void)
10965 pending_funcalls
= Qnil
;
10966 staticpro (&pending_funcalls
);
10968 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10969 staticpro (&Vlispy_mouse_stem
);
10972 DEFSYM (QCimage
, ":image");
10973 DEFSYM (Qhelp_echo
, "help-echo");
10974 DEFSYM (QCrtl
, ":rtl");
10976 staticpro (&item_properties
);
10977 item_properties
= Qnil
;
10979 staticpro (&tool_bar_item_properties
);
10980 tool_bar_item_properties
= Qnil
;
10981 staticpro (&tool_bar_items_vector
);
10982 tool_bar_items_vector
= Qnil
;
10984 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10985 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10986 DEFSYM (Qself_insert_command
, "self-insert-command");
10987 DEFSYM (Qforward_char
, "forward-char");
10988 DEFSYM (Qbackward_char
, "backward-char");
10989 DEFSYM (Qdisabled
, "disabled");
10990 DEFSYM (Qundefined
, "undefined");
10991 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10992 DEFSYM (Qpost_command_hook
, "post-command-hook");
10993 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10994 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10995 DEFSYM (Qfunction_key
, "function-key");
10996 DEFSYM (Qmouse_click
, "mouse-click");
10997 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10998 DEFSYM (Qsave_session
, "save-session");
10999 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11000 DEFSYM (Qmenu_enable
, "menu-enable");
11003 DEFSYM (Qlanguage_change
, "language-change");
11007 DEFSYM (Qdbus_event
, "dbus-event");
11010 #ifdef USE_FILE_NOTIFY
11011 DEFSYM (Qfile_notify
, "file-notify");
11012 #endif /* USE_FILE_NOTIFY */
11014 DEFSYM (QCenable
, ":enable");
11015 DEFSYM (QCvisible
, ":visible");
11016 DEFSYM (QChelp
, ":help");
11017 DEFSYM (QCfilter
, ":filter");
11018 DEFSYM (QCbutton
, ":button");
11019 DEFSYM (QCkeys
, ":keys");
11020 DEFSYM (QCkey_sequence
, ":key-sequence");
11021 DEFSYM (QCtoggle
, ":toggle");
11022 DEFSYM (QCradio
, ":radio");
11023 DEFSYM (QClabel
, ":label");
11024 DEFSYM (QCvert_only
, ":vert-only");
11026 DEFSYM (Qmode_line
, "mode-line");
11027 DEFSYM (Qvertical_line
, "vertical-line");
11028 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11029 DEFSYM (Qmenu_bar
, "menu-bar");
11030 DEFSYM (Qright_divider
, "right-divider");
11031 DEFSYM (Qbottom_divider
, "bottom-divider");
11033 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11035 DEFSYM (Qabove_handle
, "above-handle");
11036 DEFSYM (Qhandle
, "handle");
11037 DEFSYM (Qbelow_handle
, "below-handle");
11038 DEFSYM (Qup
, "up");
11039 DEFSYM (Qdown
, "down");
11040 DEFSYM (Qtop
, "top");
11041 DEFSYM (Qbottom
, "bottom");
11042 DEFSYM (Qend_scroll
, "end-scroll");
11043 DEFSYM (Qratio
, "ratio");
11045 DEFSYM (Qevent_kind
, "event-kind");
11046 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11047 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11048 DEFSYM (Qmodifier_cache
, "modifier-cache");
11050 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11051 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11053 DEFSYM (Qpolling_period
, "polling-period");
11055 DEFSYM (Qx_set_selection
, "x-set-selection");
11056 DEFSYM (QPRIMARY
, "PRIMARY");
11057 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11058 DEFSYM (Qhandle_select_window
, "handle-select-window");
11060 DEFSYM (Qinput_method_function
, "input-method-function");
11061 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11062 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11064 DEFSYM (Qhelp_form_show
, "help-form-show");
11066 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11068 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11069 Fset (Qinput_method_use_echo_area
, Qnil
);
11073 int len
= ARRAYELTS (head_table
);
11075 for (i
= 0; i
< len
; i
++)
11077 const struct event_head
*p
= &head_table
[i
];
11078 *p
->var
= intern_c_string (p
->name
);
11079 staticpro (p
->var
);
11080 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11081 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11085 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11086 staticpro (&button_down_location
);
11087 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11088 staticpro (&mouse_syms
);
11089 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11091 staticpro (&wheel_syms
);
11095 int len
= ARRAYELTS (modifier_names
);
11097 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11098 for (i
= 0; i
< len
; i
++)
11099 if (modifier_names
[i
])
11100 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11101 staticpro (&modifier_symbols
);
11104 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11105 staticpro (&recent_keys
);
11107 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11108 staticpro (&this_command_keys
);
11110 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11111 staticpro (&raw_keybuf
);
11113 DEFSYM (Qcommand_execute
, "command-execute");
11115 accent_key_syms
= Qnil
;
11116 staticpro (&accent_key_syms
);
11118 func_key_syms
= Qnil
;
11119 staticpro (&func_key_syms
);
11121 drag_n_drop_syms
= Qnil
;
11122 staticpro (&drag_n_drop_syms
);
11124 unread_switch_frame
= Qnil
;
11125 staticpro (&unread_switch_frame
);
11127 internal_last_event_frame
= Qnil
;
11128 staticpro (&internal_last_event_frame
);
11130 read_key_sequence_cmd
= Qnil
;
11131 staticpro (&read_key_sequence_cmd
);
11132 read_key_sequence_remapped
= Qnil
;
11133 staticpro (&read_key_sequence_remapped
);
11135 menu_bar_one_keymap_changed_items
= Qnil
;
11136 staticpro (&menu_bar_one_keymap_changed_items
);
11138 menu_bar_items_vector
= Qnil
;
11139 staticpro (&menu_bar_items_vector
);
11141 help_form_saved_window_configs
= Qnil
;
11142 staticpro (&help_form_saved_window_configs
);
11144 defsubr (&Scurrent_idle_time
);
11145 defsubr (&Sevent_symbol_parse_modifiers
);
11146 defsubr (&Sevent_convert_list
);
11147 defsubr (&Sread_key_sequence
);
11148 defsubr (&Sread_key_sequence_vector
);
11149 defsubr (&Srecursive_edit
);
11150 defsubr (&Strack_mouse
);
11151 defsubr (&Sinput_pending_p
);
11152 defsubr (&Srecent_keys
);
11153 defsubr (&Sthis_command_keys
);
11154 defsubr (&Sthis_command_keys_vector
);
11155 defsubr (&Sthis_single_command_keys
);
11156 defsubr (&Sthis_single_command_raw_keys
);
11157 defsubr (&Sreset_this_command_lengths
);
11158 defsubr (&Sclear_this_command_keys
);
11159 defsubr (&Ssuspend_emacs
);
11160 defsubr (&Sabort_recursive_edit
);
11161 defsubr (&Sexit_recursive_edit
);
11162 defsubr (&Srecursion_depth
);
11163 defsubr (&Scommand_error_default_function
);
11164 defsubr (&Stop_level
);
11165 defsubr (&Sdiscard_input
);
11166 defsubr (&Sopen_dribble_file
);
11167 defsubr (&Sset_input_interrupt_mode
);
11168 defsubr (&Sset_output_flow_control
);
11169 defsubr (&Sset_input_meta_mode
);
11170 defsubr (&Sset_quit_char
);
11171 defsubr (&Sset_input_mode
);
11172 defsubr (&Scurrent_input_mode
);
11173 defsubr (&Sposn_at_point
);
11174 defsubr (&Sposn_at_x_y
);
11176 DEFVAR_LISP ("last-command-event", last_command_event
,
11177 doc
: /* Last input event that was part of a command. */);
11179 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11180 doc
: /* Last input event in a command, except for mouse menu events.
11181 Mouse menus give back keys that don't look like mouse events;
11182 this variable holds the actual mouse event that led to the menu,
11183 so that you can determine whether the command was run by mouse or not. */);
11185 DEFVAR_LISP ("last-input-event", last_input_event
,
11186 doc
: /* Last input event. */);
11188 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11189 doc
: /* List of events to be read as the command input.
11190 These events are processed first, before actual keyboard input.
11191 Events read from this list are not normally added to `this-command-keys',
11192 as they will already have been added once as they were read for the first time.
11193 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11194 Vunread_command_events
= Qnil
;
11196 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11197 doc
: /* List of events to be processed as input by input methods.
11198 These events are processed before `unread-command-events'
11199 and actual keyboard input, but are not given to `input-method-function'. */);
11200 Vunread_post_input_method_events
= Qnil
;
11202 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11203 doc
: /* List of events to be processed as input by input methods.
11204 These events are processed after `unread-command-events', but
11205 before actual keyboard input.
11206 If there's an active input method, the events are given to
11207 `input-method-function'. */);
11208 Vunread_input_method_events
= Qnil
;
11210 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11211 doc
: /* Meta-prefix character code.
11212 Meta-foo as command input turns into this character followed by foo. */);
11213 XSETINT (meta_prefix_char
, 033);
11215 DEFVAR_KBOARD ("last-command", Vlast_command
,
11216 doc
: /* The last command executed.
11217 Normally a symbol with a function definition, but can be whatever was found
11218 in the keymap, or whatever the variable `this-command' was set to by that
11221 The value `mode-exit' is special; it means that the previous command
11222 read an event that told it to exit, and it did so and unread that event.
11223 In other words, the present command is the event that made the previous
11226 The value `kill-region' is special; it means that the previous command
11227 was a kill command.
11229 `last-command' has a separate binding for each terminal device.
11230 See Info node `(elisp)Multiple Terminals'. */);
11232 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11233 doc
: /* Same as `last-command', but never altered by Lisp code.
11234 Taken from the previous value of `real-this-command'. */);
11236 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11237 doc
: /* Last command that may be repeated.
11238 The last command executed that was not bound to an input event.
11239 This is the command `repeat' will try to repeat.
11240 Taken from a previous value of `real-this-command'. */);
11242 DEFVAR_LISP ("this-command", Vthis_command
,
11243 doc
: /* The command now being executed.
11244 The command can set this variable; whatever is put here
11245 will be in `last-command' during the following command. */);
11246 Vthis_command
= Qnil
;
11248 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11249 doc
: /* This is like `this-command', except that commands should never modify it. */);
11250 Vreal_this_command
= Qnil
;
11252 DEFVAR_LISP ("this-command-keys-shift-translated",
11253 Vthis_command_keys_shift_translated
,
11254 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11255 Shift-translation occurs when there is no binding for the key sequence
11256 as entered, but a binding was found by changing an upper-case letter
11257 to lower-case, or a shifted function key to an unshifted one. */);
11258 Vthis_command_keys_shift_translated
= Qnil
;
11260 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11261 doc
: /* The command bound to the current key sequence before remapping.
11262 It equals `this-command' if the original command was not remapped through
11263 any of the active keymaps. Otherwise, the value of `this-command' is the
11264 result of looking up the original command in the active keymaps. */);
11265 Vthis_original_command
= Qnil
;
11267 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11268 doc
: /* Number of input events between auto-saves.
11269 Zero means disable autosaving due to number of characters typed. */);
11270 auto_save_interval
= 300;
11272 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11273 doc
: /* Number of seconds idle time before auto-save.
11274 Zero or nil means disable auto-saving due to idleness.
11275 After auto-saving due to this many seconds of idle time,
11276 Emacs also does a garbage collection if that seems to be warranted. */);
11277 XSETFASTINT (Vauto_save_timeout
, 30);
11279 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11280 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11281 The value may be integer or floating point.
11282 If the value is zero, don't echo at all. */);
11283 Vecho_keystrokes
= make_number (1);
11285 DEFVAR_INT ("polling-period", polling_period
,
11286 doc
: /* Interval between polling for input during Lisp execution.
11287 The reason for polling is to make C-g work to stop a running program.
11288 Polling is needed only when using X windows and SIGIO does not work.
11289 Polling is automatically disabled in all other cases. */);
11290 polling_period
= 2;
11292 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11293 doc
: /* Maximum time between mouse clicks to make a double-click.
11294 Measured in milliseconds. The value nil means disable double-click
11295 recognition; t means double-clicks have no time limit and are detected
11296 by position only. */);
11297 Vdouble_click_time
= make_number (500);
11299 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11300 doc
: /* Maximum mouse movement between clicks to make a double-click.
11301 On window-system frames, value is the number of pixels the mouse may have
11302 moved horizontally or vertically between two clicks to make a double-click.
11303 On non window-system frames, value is interpreted in units of 1/8 characters
11306 This variable is also the threshold for motion of the mouse
11307 to count as a drag. */);
11308 double_click_fuzz
= 3;
11310 DEFVAR_INT ("num-input-keys", num_input_keys
,
11311 doc
: /* Number of complete key sequences read as input so far.
11312 This includes key sequences read from keyboard macros.
11313 The number is effectively the number of interactive command invocations. */);
11314 num_input_keys
= 0;
11316 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11317 doc
: /* Number of input events read from the keyboard so far.
11318 This does not include events generated by keyboard macros. */);
11319 num_nonmacro_input_events
= 0;
11321 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11322 doc
: /* The frame in which the most recently read event occurred.
11323 If the last event came from a keyboard macro, this is set to `macro'. */);
11324 Vlast_event_frame
= Qnil
;
11326 /* This variable is set up in sysdep.c. */
11327 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11328 doc
: /* The ERASE character as set by the user with stty. */);
11330 DEFVAR_LISP ("help-char", Vhelp_char
,
11331 doc
: /* Character to recognize as meaning Help.
11332 When it is read, do `(eval help-form)', and display result if it's a string.
11333 If the value of `help-form' is nil, this char can be read normally. */);
11334 XSETINT (Vhelp_char
, Ctl ('H'));
11336 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11337 doc
: /* List of input events to recognize as meaning Help.
11338 These work just like the value of `help-char' (see that). */);
11339 Vhelp_event_list
= Qnil
;
11341 DEFVAR_LISP ("help-form", Vhelp_form
,
11342 doc
: /* Form to execute when character `help-char' is read.
11343 If the form returns a string, that string is displayed.
11344 If `help-form' is nil, the help char is not recognized. */);
11347 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11348 doc
: /* Command to run when `help-char' character follows a prefix key.
11349 This command is used only when there is no actual binding
11350 for that character after that prefix key. */);
11351 Vprefix_help_command
= Qnil
;
11353 DEFVAR_LISP ("top-level", Vtop_level
,
11354 doc
: /* Form to evaluate when Emacs starts up.
11355 Useful to set before you dump a modified Emacs. */);
11358 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11359 doc
: /* Translate table for local keyboard input, or nil.
11360 If non-nil, the value should be a char-table. Each character read
11361 from the keyboard is looked up in this char-table. If the value found
11362 there is non-nil, then it is used instead of the actual input character.
11364 The value can also be a string or vector, but this is considered obsolete.
11365 If it is a string or vector of length N, character codes N and up are left
11366 untranslated. In a vector, an element which is nil means "no translation".
11368 This is applied to the characters supplied to input methods, not their
11369 output. See also `translation-table-for-input'.
11371 This variable has a separate binding for each terminal.
11372 See Info node `(elisp)Multiple Terminals'. */);
11374 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11375 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11376 \(Even if the operating system has support for stopping a process.\) */);
11377 cannot_suspend
= 0;
11379 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11380 doc
: /* Non-nil means prompt with menus when appropriate.
11381 This is done when reading from a keymap that has a prompt string,
11382 for elements that have prompt strings.
11383 The menu is displayed on the screen
11384 if X menus were enabled at configuration
11385 time and the previous event was a mouse click prefix key.
11386 Otherwise, menu prompting uses the echo area. */);
11387 menu_prompting
= 1;
11389 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11390 doc
: /* Character to see next line of menu prompt.
11391 Type this character while in a menu prompt to rotate around the lines of it. */);
11392 XSETINT (menu_prompt_more_char
, ' ');
11394 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11395 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11396 Emacs applies the modifiers of the character stored here to each keyboard
11397 character it reads. For example, after evaluating the expression
11398 (setq extra-keyboard-modifiers ?\\C-x)
11399 all input characters will have the control modifier applied to them.
11401 Note that the character ?\\C-@, equivalent to the integer zero, does
11402 not count as a control character; rather, it counts as a character
11403 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11404 cancels any modification. */);
11405 extra_keyboard_modifiers
= 0;
11407 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11408 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11409 The command loop sets this to nil before each command,
11410 and tests the value when the command returns.
11411 Buffer modification stores t in this variable. */);
11412 Vdeactivate_mark
= Qnil
;
11413 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11414 Fmake_variable_buffer_local (Qdeactivate_mark
);
11416 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11417 doc
: /* Normal hook run before each command is executed.
11418 If an unhandled error happens in running this hook,
11419 the function in which the error occurred is unconditionally removed, since
11420 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11421 Vpre_command_hook
= Qnil
;
11423 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11424 doc
: /* Normal hook run after each command is executed.
11425 If an unhandled error happens in running this hook,
11426 the function in which the error occurred is unconditionally removed, since
11427 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11428 Vpost_command_hook
= Qnil
;
11431 DEFVAR_LISP ("echo-area-clear-hook", ...,
11432 doc
: /* Normal hook run when clearing the echo area. */);
11434 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11435 Fset (Qecho_area_clear_hook
, Qnil
);
11437 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11438 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11439 Vlucid_menu_bar_dirty_flag
= Qnil
;
11441 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11442 doc
: /* List of menu bar items to move to the end of the menu bar.
11443 The elements of the list are event types that may have menu bar bindings. */);
11444 Vmenu_bar_final_items
= Qnil
;
11446 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11447 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11448 This is used internally by graphical displays that do not render
11449 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11450 Vtool_bar_separator_image_expression
= Qnil
;
11452 DEFVAR_KBOARD ("overriding-terminal-local-map",
11453 Voverriding_terminal_local_map
,
11454 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11455 This variable is intended to let commands such as `universal-argument'
11456 set up a different keymap for reading the next command.
11458 `overriding-terminal-local-map' has a separate binding for each
11459 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11461 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11462 doc
: /* Keymap that replaces (overrides) local keymaps.
11463 If this variable is non-nil, Emacs looks up key bindings in this
11464 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11465 buffer's local map. Hence, the only active keymaps would be
11466 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11467 order of precedence. */);
11468 Voverriding_local_map
= Qnil
;
11470 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11471 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11472 Otherwise, the menu bar continues to reflect the buffer's local map
11473 and the minor mode maps regardless of `overriding-local-map'. */);
11474 Voverriding_local_map_menu_flag
= Qnil
;
11476 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11477 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11478 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11480 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11481 doc
: /* Non-nil means generate motion events for mouse motion. */);
11483 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11484 doc
: /* Alist of system-specific X windows key symbols.
11485 Each element should have the form (N . SYMBOL) where N is the
11486 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11487 and SYMBOL is its name.
11489 `system-key-alist' has a separate binding for each terminal device.
11490 See Info node `(elisp)Multiple Terminals'. */);
11492 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11493 doc
: /* Keymap that translates key sequences to key sequences during input.
11494 This is used mainly for mapping key sequences into some preferred
11495 key events (symbols).
11497 The `read-key-sequence' function replaces any subsequence bound by
11498 `local-function-key-map' with its binding. More precisely, when the
11499 active keymaps have no binding for the current key sequence but
11500 `local-function-key-map' binds a suffix of the sequence to a vector or
11501 string, `read-key-sequence' replaces the matching suffix with its
11502 binding, and continues with the new sequence.
11504 If the binding is a function, it is called with one argument (the prompt)
11505 and its return value (a key sequence) is used.
11507 The events that come from bindings in `local-function-key-map' are not
11508 themselves looked up in `local-function-key-map'.
11510 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11511 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11512 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11513 typing `ESC O P x' would return [f1 x].
11515 `local-function-key-map' has a separate binding for each terminal
11516 device. See Info node `(elisp)Multiple Terminals'. If you need to
11517 define a binding on all terminals, change `function-key-map'
11518 instead. Initially, `local-function-key-map' is an empty keymap that
11519 has `function-key-map' as its parent on all terminal devices. */);
11521 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11522 doc
: /* Keymap that decodes input escape sequences.
11523 This is used mainly for mapping ASCII function key sequences into
11524 real Emacs function key events (symbols).
11526 The `read-key-sequence' function replaces any subsequence bound by
11527 `input-decode-map' with its binding. Contrary to `function-key-map',
11528 this map applies its rebinding regardless of the presence of an ordinary
11529 binding. So it is more like `key-translation-map' except that it applies
11530 before `function-key-map' rather than after.
11532 If the binding is a function, it is called with one argument (the prompt)
11533 and its return value (a key sequence) is used.
11535 The events that come from bindings in `input-decode-map' are not
11536 themselves looked up in `input-decode-map'. */);
11538 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11539 doc
: /* The parent keymap of all `local-function-key-map' instances.
11540 Function key definitions that apply to all terminal devices should go
11541 here. If a mapping is defined in both the current
11542 `local-function-key-map' binding and this variable, then the local
11543 definition will take precedence. */);
11544 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11546 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11547 doc
: /* Keymap of key translations that can override keymaps.
11548 This keymap works like `input-decode-map', but comes after `function-key-map'.
11549 Another difference is that it is global rather than terminal-local. */);
11550 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11552 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11553 doc
: /* List of deferred actions to be performed at a later time.
11554 The precise format isn't relevant here; we just check whether it is nil. */);
11555 Vdeferred_action_list
= Qnil
;
11557 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11558 doc
: /* Function to call to handle deferred actions, after each command.
11559 This function is called with no arguments after each command
11560 whenever `deferred-action-list' is non-nil. */);
11561 Vdeferred_action_function
= Qnil
;
11563 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11564 doc
: /* List of warnings to be displayed after this command.
11565 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11566 as per the args of `display-warning' (which see).
11567 If this variable is non-nil, `delayed-warnings-hook' will be run
11568 immediately after running `post-command-hook'. */);
11569 Vdelayed_warnings_list
= Qnil
;
11571 DEFVAR_LISP ("timer-list", Vtimer_list
,
11572 doc
: /* List of active absolute time timers in order of increasing time. */);
11573 Vtimer_list
= Qnil
;
11575 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11576 doc
: /* List of active idle-time timers in order of increasing time. */);
11577 Vtimer_idle_list
= Qnil
;
11579 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11580 doc
: /* If non-nil, the function that implements the current input method.
11581 It's called with one argument, a printing character that was just read.
11582 \(That means a character with code 040...0176.)
11583 Typically this function uses `read-event' to read additional events.
11584 When it does so, it should first bind `input-method-function' to nil
11585 so it will not be called recursively.
11587 The function should return a list of zero or more events
11588 to be used as input. If it wants to put back some events
11589 to be reconsidered, separately, by the input method,
11590 it can add them to the beginning of `unread-command-events'.
11592 The input method function can find in `input-method-previous-message'
11593 the previous echo area message.
11595 The input method function should refer to the variables
11596 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11597 for guidance on what to do. */);
11598 Vinput_method_function
= Qnil
;
11600 DEFVAR_LISP ("input-method-previous-message",
11601 Vinput_method_previous_message
,
11602 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11603 This variable exists because `read-event' clears the echo area
11604 before running the input method. It is nil if there was no message. */);
11605 Vinput_method_previous_message
= Qnil
;
11607 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11608 doc
: /* If non-nil, the function that implements the display of help.
11609 It's called with one argument, the help string to display. */);
11610 Vshow_help_function
= Qnil
;
11612 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11613 doc
: /* If non-nil, suppress point adjustment after executing a command.
11615 After a command is executed, if point is moved into a region that has
11616 special properties (e.g. composition, display), we adjust point to
11617 the boundary of the region. But, when a command sets this variable to
11618 non-nil, we suppress the point adjustment.
11620 This variable is set to nil before reading a command, and is checked
11621 just after executing the command. */);
11622 Vdisable_point_adjustment
= Qnil
;
11624 DEFVAR_LISP ("global-disable-point-adjustment",
11625 Vglobal_disable_point_adjustment
,
11626 doc
: /* If non-nil, always suppress point adjustment.
11628 The default value is nil, in which case, point adjustment are
11629 suppressed only after special commands that set
11630 `disable-point-adjustment' (which see) to non-nil. */);
11631 Vglobal_disable_point_adjustment
= Qnil
;
11633 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11634 doc
: /* How long to display an echo-area message when the minibuffer is active.
11635 If the value is not a number, such messages don't time out. */);
11636 Vminibuffer_message_timeout
= make_number (2);
11638 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11639 doc
: /* If non-nil, any keyboard input throws to this symbol.
11640 The value of that variable is passed to `quit-flag' and later causes a
11641 peculiar kind of quitting. */);
11642 Vthrow_on_input
= Qnil
;
11644 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11645 doc
: /* Function to output error messages.
11646 Called with three arguments:
11647 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11648 such as what `condition-case' would bind its variable to,
11649 - the context (a string which normally goes at the start of the message),
11650 - the Lisp function within which the error was signaled. */);
11651 Vcommand_error_function
= intern ("command-error-default-function");
11653 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11654 Venable_disabled_menus_and_buttons
,
11655 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11657 Help functions bind this to allow help on disabled menu items
11658 and tool-bar buttons. */);
11659 Venable_disabled_menus_and_buttons
= Qnil
;
11661 DEFVAR_LISP ("select-active-regions",
11662 Vselect_active_regions
,
11663 doc
: /* If non-nil, an active region automatically sets the primary selection.
11664 If the value is `only', only temporarily active regions (usually made
11665 by mouse-dragging or shift-selection) set the window selection.
11667 This takes effect only when Transient Mark mode is enabled. */);
11668 Vselect_active_regions
= Qt
;
11670 DEFVAR_LISP ("saved-region-selection",
11671 Vsaved_region_selection
,
11672 doc
: /* Contents of active region prior to buffer modification.
11673 If `select-active-regions' is non-nil, Emacs sets this to the
11674 text in the region before modifying the buffer. The next call to
11675 the function `deactivate-mark' uses this to set the window selection. */);
11676 Vsaved_region_selection
= Qnil
;
11678 DEFVAR_LISP ("selection-inhibit-update-commands",
11679 Vselection_inhibit_update_commands
,
11680 doc
: /* List of commands which should not update the selection.
11681 Normally, if `select-active-regions' is non-nil and the mark remains
11682 active after a command (i.e. the mark was not deactivated), the Emacs
11683 command loop sets the selection to the text in the region. However,
11684 if the command is in this list, the selection is not updated. */);
11685 Vselection_inhibit_update_commands
11686 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11688 DEFVAR_LISP ("debug-on-event",
11690 doc
: /* Enter debugger on this event. When Emacs
11691 receives the special event specified by this variable, it will try to
11692 break into the debugger as soon as possible instead of processing the
11693 event normally through `special-event-map'.
11695 Currently, the only supported values for this
11696 variable are `sigusr1' and `sigusr2'. */);
11697 Vdebug_on_event
= intern_c_string ("sigusr2");
11699 /* Create the initial keyboard. Qt means 'unset'. */
11700 initial_kboard
= allocate_kboard (Qt
);
11704 keys_of_keyboard (void)
11706 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11707 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11708 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11709 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11710 initial_define_key (meta_map
, 'x', "execute-extended-command");
11712 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11713 "handle-delete-frame");
11714 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11715 "ns-put-working-text");
11716 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11717 "ns-unput-working-text");
11718 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11719 current-prefix-arg, as is done in `handle-switch-frame'.
11720 But `handle-switch-frame is not run from the special-map.
11721 Commands from that map are run in a special way that automatically
11722 preserves the prefix-arg. Restoring the prefix arg here is not just
11723 redundant but harmful:
11725 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11726 - after the first prompt, the exit-minibuffer-hook is run which may
11727 iconify a frame and thus push a `iconify-frame' event.
11728 - after running exit-minibuffer-hook, current-prefix-arg is
11729 restored to the non-nil value it had before the prompt.
11730 - we enter the second prompt.
11731 current-prefix-arg is non-nil, prefix-arg is nil.
11732 - before running the first real event, we run the special iconify-frame
11733 event, but we pass the `special' arg to execute-command so
11734 current-prefix-arg and prefix-arg are left untouched.
11735 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11736 - the next key event will have a spuriously non-nil current-prefix-arg. */
11737 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11739 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11741 /* Handling it at such a low-level causes read_key_sequence to get
11742 * confused because it doesn't realize that the current_buffer was
11743 * changed by read_char.
11745 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11746 * "handle-select-window"); */
11747 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11748 "handle-save-session");
11751 /* Define a special event which is raised for dbus callback
11753 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11754 "dbus-handle-event");
11757 #ifdef USE_FILE_NOTIFY
11758 /* Define a special event which is raised for notification callback
11760 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11761 "file-notify-handle-event");
11762 #endif /* USE_FILE_NOTIFY */
11764 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11766 #if defined (WINDOWSNT)
11767 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11770 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11771 "handle-focus-in");
11772 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11773 "handle-focus-out");
11776 /* Mark the pointers in the kboard objects.
11777 Called by Fgarbage_collect. */
11779 mark_kboards (void)
11783 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11785 if (kb
->kbd_macro_buffer
)
11786 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11788 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11789 mark_object (KVAR (kb
, Vlast_command
));
11790 mark_object (KVAR (kb
, Vreal_last_command
));
11791 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11792 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11793 mark_object (KVAR (kb
, Vprefix_arg
));
11794 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11795 mark_object (KVAR (kb
, kbd_queue
));
11796 mark_object (KVAR (kb
, defining_kbd_macro
));
11797 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11798 mark_object (KVAR (kb
, Vsystem_key_alist
));
11799 mark_object (KVAR (kb
, system_key_syms
));
11800 mark_object (KVAR (kb
, Vwindow_system
));
11801 mark_object (KVAR (kb
, Vinput_decode_map
));
11802 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11803 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11804 mark_object (KVAR (kb
, echo_string
));
11807 struct input_event
*event
;
11808 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11810 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11811 event
= kbd_buffer
;
11812 /* These two special event types has no Lisp_Objects to mark. */
11813 if (event
->kind
!= SELECTION_REQUEST_EVENT
11814 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11816 mark_object (event
->x
);
11817 mark_object (event
->y
);
11818 mark_object (event
->frame_or_window
);
11819 mark_object (event
->arg
);