1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2013 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
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 static Lisp_Object Qvertical_scroll_bar
;
351 Lisp_Object Qmenu_bar
;
353 static Lisp_Object Qecho_keystrokes
;
355 static void recursive_edit_unwind (Lisp_Object buffer
);
356 static Lisp_Object
command_loop (void);
357 static Lisp_Object Qcommand_execute
;
358 struct timespec
timer_check (void);
360 static void echo_now (void);
361 static ptrdiff_t echo_length (void);
363 static Lisp_Object Qpolling_period
;
365 /* Incremented whenever a timer is run. */
368 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
370 struct timespec
*input_available_clear_time
;
372 /* True means use SIGIO interrupts; false means use CBREAK mode.
373 Default is true if INTERRUPT_INPUT is defined. */
374 bool interrupt_input
;
376 /* Nonzero while interrupts are temporarily deferred during redisplay. */
377 bool interrupts_deferred
;
379 /* If we support a window system, turn on the code to poll periodically
380 to detect C-g. It isn't actually used when doing interrupt input. */
381 #ifdef HAVE_WINDOW_SYSTEM
382 #define POLL_FOR_INPUT
385 /* The time when Emacs started being idle. */
387 static struct timespec timer_idleness_start_time
;
389 /* After Emacs stops being idle, this saves the last value
390 of timer_idleness_start_time from when it was idle. */
392 static struct timespec timer_last_idleness_start_time
;
395 /* Global variable declarations. */
397 /* Flags for readable_events. */
398 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
399 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
400 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
402 /* Function for init_keyboard to call with no args (if nonzero). */
403 static void (*keyboard_init_hook
) (void);
405 static bool get_input_pending (int);
406 static bool readable_events (int);
407 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
408 Lisp_Object
, bool *);
409 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
410 static Lisp_Object
make_lispy_event (struct input_event
*);
411 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
412 enum scroll_bar_part
,
413 Lisp_Object
, Lisp_Object
,
415 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
416 Lisp_Object
, const char *const *,
417 Lisp_Object
*, ptrdiff_t);
418 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
419 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
420 #ifdef HAVE_WINDOW_SYSTEM
421 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
422 #endif /* HAVE_WINDOW_SYSTEM */
423 static bool help_char_p (Lisp_Object
);
424 static void save_getcjmp (sys_jmp_buf
);
425 static void restore_getcjmp (sys_jmp_buf
);
426 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
427 static void clear_event (struct input_event
*);
428 static void restore_kboard_configuration (int);
430 static void deliver_input_available_signal (int signo
);
432 static void handle_interrupt (bool);
433 static _Noreturn
void quit_throw_to_read_char (bool);
434 static void process_special_events (void);
435 static void timer_start_idle (void);
436 static void timer_stop_idle (void);
437 static void timer_resume_idle (void);
438 static void deliver_user_signal (int);
439 static char *find_user_signal_name (int);
440 static void store_user_signal_events (void);
442 /* These setters are used only in this file, so they can be private. */
444 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
446 kb
->INTERNAL_FIELD (echo_string
) = val
;
449 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
451 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
454 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
456 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
459 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
461 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
464 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
466 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
469 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
471 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
474 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
476 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
479 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
481 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
484 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
486 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
490 /* Add C to the echo string, without echoing it immediately. C can be
491 a character, which is pretty-printed, or a symbol, whose name is
495 echo_add_key (Lisp_Object c
)
497 int size
= KEY_DESCRIPTION_SIZE
+ 100;
498 char *buffer
= alloca (size
);
500 Lisp_Object echo_string
;
502 echo_string
= KVAR (current_kboard
, echo_string
);
504 /* If someone has passed us a composite event, use its head symbol. */
508 ptr
= push_key_description (XINT (c
), ptr
);
509 else if (SYMBOLP (c
))
511 Lisp_Object name
= SYMBOL_NAME (c
);
512 int nbytes
= SBYTES (name
);
514 if (size
- (ptr
- buffer
) < nbytes
)
516 int offset
= ptr
- buffer
;
517 size
= max (2 * size
, size
+ nbytes
);
518 buffer
= alloca (size
);
519 ptr
= buffer
+ offset
;
522 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
523 STRING_MULTIBYTE (name
), 1);
526 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
529 const char *text
= " (Type ? for further options)";
530 int len
= strlen (text
);
532 if (size
- (ptr
- buffer
) < len
)
534 int offset
= ptr
- buffer
;
536 buffer
= alloca (size
);
537 ptr
= buffer
+ offset
;
540 memcpy (ptr
, text
, len
);
544 /* Replace a dash from echo_dash with a space, otherwise add a space
545 at the end as a separator between keys. */
546 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
548 Lisp_Object last_char
, prev_char
, idx
;
550 idx
= make_number (SCHARS (echo_string
) - 2);
551 prev_char
= Faref (echo_string
, idx
);
553 idx
= make_number (SCHARS (echo_string
) - 1);
554 last_char
= Faref (echo_string
, idx
);
556 /* We test PREV_CHAR to make sure this isn't the echoing of a
558 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
559 Faset (echo_string
, idx
, make_number (' '));
561 echo_string
= concat2 (echo_string
, build_string (" "));
563 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
564 echo_string
= concat2 (echo_string
, build_string (" "));
568 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
571 /* Add C to the echo string, if echoing is going on. C can be a
572 character or a symbol. */
575 echo_char (Lisp_Object c
)
577 if (current_kboard
->immediate_echo
)
584 /* Temporarily add a dash to the end of the echo string if it's not
585 empty, so that it serves as a mini-prompt for the very next
591 /* Do nothing if not echoing at all. */
592 if (NILP (KVAR (current_kboard
, echo_string
)))
595 if (this_command_key_count
== 0)
598 if (!current_kboard
->immediate_echo
599 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
602 /* Do nothing if we just printed a prompt. */
603 if (current_kboard
->echo_after_prompt
604 == SCHARS (KVAR (current_kboard
, echo_string
)))
607 /* Do nothing if we have already put a dash at the end. */
608 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
610 Lisp_Object last_char
, prev_char
, idx
;
612 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
613 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
615 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
616 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
618 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
622 /* Put a dash at the end of the buffer temporarily,
623 but make it go away when the next character is added. */
626 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
630 /* Display the current echo string, and begin echoing if not already
636 if (!current_kboard
->immediate_echo
)
639 current_kboard
->immediate_echo
= 1;
641 for (i
= 0; i
< this_command_key_count
; i
++)
645 /* Set before_command_echo_length to the value that would
646 have been saved before the start of this subcommand in
647 command_loop_1, if we had already been echoing then. */
648 if (i
== this_single_command_key_start
)
649 before_command_echo_length
= echo_length ();
651 c
= AREF (this_command_keys
, i
);
652 if (! (EVENT_HAS_PARAMETERS (c
)
653 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
657 /* Set before_command_echo_length to the value that would
658 have been saved before the start of this subcommand in
659 command_loop_1, if we had already been echoing then. */
660 if (this_command_key_count
== this_single_command_key_start
)
661 before_command_echo_length
= echo_length ();
663 /* Put a dash at the end to invite the user to type more. */
668 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
669 message3_nolog (KVAR (current_kboard
, echo_string
));
672 /* Record in what buffer we echoed, and from which kboard. */
673 echo_message_buffer
= echo_area_buffer
[0];
674 echo_kboard
= current_kboard
;
676 if (waiting_for_input
&& !NILP (Vquit_flag
))
677 quit_throw_to_read_char (0);
680 /* Turn off echoing, for the start of a new command. */
683 cancel_echoing (void)
685 current_kboard
->immediate_echo
= 0;
686 current_kboard
->echo_after_prompt
= -1;
687 kset_echo_string (current_kboard
, Qnil
);
688 ok_to_echo_at_next_pause
= NULL
;
690 echo_message_buffer
= Qnil
;
693 /* Return the length of the current echo string. */
698 return (STRINGP (KVAR (current_kboard
, echo_string
))
699 ? SCHARS (KVAR (current_kboard
, echo_string
))
703 /* Truncate the current echo message to its first LEN chars.
704 This and echo_char get used by read_key_sequence when the user
705 switches frames while entering a key sequence. */
708 echo_truncate (ptrdiff_t nchars
)
710 if (STRINGP (KVAR (current_kboard
, echo_string
)))
711 kset_echo_string (current_kboard
,
712 Fsubstring (KVAR (current_kboard
, echo_string
),
713 make_number (0), make_number (nchars
)));
714 truncate_echo_area (nchars
);
718 /* Functions for manipulating this_command_keys. */
720 add_command_key (Lisp_Object key
)
722 #if 0 /* Not needed after we made Freset_this_command_lengths
723 do the job immediately. */
724 /* If reset-this-command-length was called recently, obey it now.
725 See the doc string of that function for an explanation of why. */
726 if (before_command_restore_flag
)
728 this_command_key_count
= before_command_key_count_1
;
729 if (this_command_key_count
< this_single_command_key_start
)
730 this_single_command_key_start
= this_command_key_count
;
731 echo_truncate (before_command_echo_length_1
);
732 before_command_restore_flag
= 0;
736 if (this_command_key_count
>= ASIZE (this_command_keys
))
737 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
739 ASET (this_command_keys
, this_command_key_count
, key
);
740 ++this_command_key_count
;
745 recursive_edit_1 (void)
747 ptrdiff_t count
= SPECPDL_INDEX ();
750 if (command_loop_level
> 0)
752 specbind (Qstandard_output
, Qt
);
753 specbind (Qstandard_input
, Qt
);
756 #ifdef HAVE_WINDOW_SYSTEM
757 /* The command loop has started an hourglass timer, so we have to
758 cancel it here, otherwise it will fire because the recursive edit
759 can take some time. Do not check for display_hourglass_p here,
760 because it could already be nil. */
764 /* This function may have been called from a debugger called from
765 within redisplay, for instance by Edebugging a function called
766 from fontification-functions. We want to allow redisplay in
767 the debugging session.
769 The recursive edit is left with a `(throw exit ...)'. The `exit'
770 tag is not caught anywhere in redisplay, i.e. when we leave the
771 recursive edit, the original redisplay leading to the recursive
772 edit will be unwound. The outcome should therefore be safe. */
773 specbind (Qinhibit_redisplay
, Qnil
);
776 val
= command_loop ();
778 Fsignal (Qquit
, Qnil
);
779 /* Handle throw from read_minibuf when using minibuffer
780 while it's active but we're in another window. */
782 xsignal1 (Qerror
, val
);
784 return unbind_to (count
, Qnil
);
787 /* When an auto-save happens, record the "time", and don't do again soon. */
790 record_auto_save (void)
792 last_auto_save
= num_nonmacro_input_events
;
795 /* Make an auto save happen as soon as possible at command level. */
799 force_auto_save_soon (void)
801 last_auto_save
= - auto_save_interval
- 1;
803 record_asynch_buffer_change ();
807 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
808 doc
: /* Invoke the editor command loop recursively.
809 To get out of the recursive edit, a command can do `(throw 'exit nil)';
810 that tells this function to return.
811 Alternatively, `(throw 'exit t)' makes this function signal an error.
812 This function is called by the editor initialization to begin editing. */)
815 ptrdiff_t count
= SPECPDL_INDEX ();
818 /* If we enter while input is blocked, don't lock up here.
819 This may happen through the debugger during redisplay. */
820 if (input_blocked_p ())
823 command_loop_level
++;
824 update_mode_lines
= 17;
826 if (command_loop_level
827 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
828 buffer
= Fcurrent_buffer ();
832 /* If we leave recursive_edit_1 below with a `throw' for instance,
833 like it is done in the splash screen display, we have to
834 make sure that we restore single_kboard as command_loop_1
835 would have done if it were left normally. */
836 if (command_loop_level
> 0)
837 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
838 record_unwind_protect (recursive_edit_unwind
, buffer
);
841 return unbind_to (count
, Qnil
);
845 recursive_edit_unwind (Lisp_Object buffer
)
847 if (BUFFERP (buffer
))
848 Fset_buffer (buffer
);
850 command_loop_level
--;
851 update_mode_lines
= 18;
855 #if 0 /* These two functions are now replaced with
856 temporarily_switch_to_single_kboard. */
860 #if 0 /* Theory: if there's anything in Vunread_command_events,
861 it will right away be read by read_key_sequence,
862 and then if we do switch KBOARDS, it will go into the side
863 queue then. So we don't need to do anything special here -- rms. */
864 if (CONSP (Vunread_command_events
))
866 current_kboard
->kbd_queue
867 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
868 current_kboard
->kbd_queue_has_data
= 1;
870 Vunread_command_events
= Qnil
;
875 /* Switch to the single-kboard state, making current_kboard
876 the only KBOARD from which further input is accepted. */
879 single_kboard_state ()
885 /* If we're in single_kboard state for kboard KBOARD,
889 not_single_kboard_state (KBOARD
*kboard
)
891 if (kboard
== current_kboard
)
895 /* Maintain a stack of kboards, so other parts of Emacs
896 can switch temporarily to the kboard of a given frame
897 and then revert to the previous status. */
902 struct kboard_stack
*next
;
905 static struct kboard_stack
*kboard_stack
;
908 push_kboard (struct kboard
*k
)
910 struct kboard_stack
*p
= xmalloc (sizeof *p
);
912 p
->next
= kboard_stack
;
913 p
->kboard
= current_kboard
;
923 struct kboard_stack
*p
= kboard_stack
;
925 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
927 if (t
->kboard
== p
->kboard
)
929 current_kboard
= p
->kboard
;
936 /* The terminal we remembered has been deleted. */
937 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
940 kboard_stack
= p
->next
;
944 /* Switch to single_kboard mode, making current_kboard the only KBOARD
945 from which further input is accepted. If F is non-nil, set its
946 KBOARD as the current keyboard.
948 This function uses record_unwind_protect_int to return to the previous
951 If Emacs is already in single_kboard mode, and F's keyboard is
952 locked, then this function will throw an error. */
955 temporarily_switch_to_single_kboard (struct frame
*f
)
957 bool was_locked
= single_kboard
;
960 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
961 /* We can not switch keyboards while in single_kboard mode.
962 In rare cases, Lisp code may call `recursive-edit' (or
963 `read-minibuffer' or `y-or-n-p') after it switched to a
964 locked frame. For example, this is likely to happen
965 when server.el connects to a new terminal while Emacs is in
966 single_kboard mode. It is best to throw an error instead
967 of presenting the user with a frozen screen. */
968 error ("Terminal %d is locked, cannot read from it",
969 FRAME_TERMINAL (f
)->id
);
971 /* This call is unnecessary, but helps
972 `restore_kboard_configuration' discover if somebody changed
973 `current_kboard' behind our back. */
974 push_kboard (current_kboard
);
977 current_kboard
= FRAME_KBOARD (f
);
979 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
982 #if 0 /* This function is not needed anymore. */
984 record_single_kboard_state ()
987 push_kboard (current_kboard
);
988 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
993 restore_kboard_configuration (int was_locked
)
995 single_kboard
= was_locked
;
998 struct kboard
*prev
= current_kboard
;
1000 /* The pop should not change the kboard. */
1001 if (single_kboard
&& current_kboard
!= prev
)
1007 /* Handle errors that are not handled at inner levels
1008 by printing an error message and returning to the editor command loop. */
1011 cmd_error (Lisp_Object data
)
1013 Lisp_Object old_level
, old_length
;
1014 char macroerror
[sizeof "After..kbd macro iterations: "
1015 + INT_STRLEN_BOUND (EMACS_INT
)];
1017 #ifdef HAVE_WINDOW_SYSTEM
1018 if (display_hourglass_p
)
1019 cancel_hourglass ();
1022 if (!NILP (executing_kbd_macro
))
1024 if (executing_kbd_macro_iterations
== 1)
1025 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1027 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1028 executing_kbd_macro_iterations
);
1033 Vstandard_output
= Qt
;
1034 Vstandard_input
= Qt
;
1035 Vexecuting_kbd_macro
= Qnil
;
1036 executing_kbd_macro
= Qnil
;
1037 kset_prefix_arg (current_kboard
, Qnil
);
1038 kset_last_prefix_arg (current_kboard
, Qnil
);
1041 /* Avoid unquittable loop if data contains a circular list. */
1042 old_level
= Vprint_level
;
1043 old_length
= Vprint_length
;
1044 XSETFASTINT (Vprint_level
, 10);
1045 XSETFASTINT (Vprint_length
, 10);
1046 cmd_error_internal (data
, macroerror
);
1047 Vprint_level
= old_level
;
1048 Vprint_length
= old_length
;
1051 Vinhibit_quit
= Qnil
;
1053 return make_number (0);
1056 /* Take actions on handling an error. DATA is the data that describes
1059 CONTEXT is a C-string containing ASCII characters only which
1060 describes the context in which the error happened. If we need to
1061 generalize CONTEXT to allow multibyte characters, make it a Lisp
1065 cmd_error_internal (Lisp_Object data
, const char *context
)
1067 /* The immediate context is not interesting for Quits,
1068 since they are asynchronous. */
1069 if (EQ (XCAR (data
), Qquit
))
1070 Vsignaling_function
= Qnil
;
1075 /* Use user's specified output function if any. */
1076 if (!NILP (Vcommand_error_function
))
1077 call3 (Vcommand_error_function
, data
,
1078 context
? build_string (context
) : empty_unibyte_string
,
1079 Vsignaling_function
);
1081 Vsignaling_function
= Qnil
;
1084 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1085 Scommand_error_default_function
, 3, 3, 0,
1086 doc
: /* Produce default output for unhandled error message.
1087 Default value of `command-error-function'. */)
1088 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1090 struct frame
*sf
= SELECTED_FRAME ();
1092 CHECK_STRING (context
);
1094 /* If the window system or terminal frame hasn't been initialized
1095 yet, or we're not interactive, write the message to stderr and exit. */
1096 if (!sf
->glyphs_initialized_p
1097 /* The initial frame is a special non-displaying frame. It
1098 will be current in daemon mode when there are no frames
1099 to display, and in non-daemon mode before the real frame
1100 has finished initializing. If an error is thrown in the
1101 latter case while creating the frame, then the frame
1102 will never be displayed, so the safest thing to do is
1103 write to stderr and quit. In daemon mode, there are
1104 many other potential errors that do not prevent frames
1105 from being created, so continuing as normal is better in
1107 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1110 print_error_message (data
, Qexternal_debugging_output
,
1111 SSDATA (context
), signal
);
1112 Fterpri (Qexternal_debugging_output
);
1113 Fkill_emacs (make_number (-1));
1117 clear_message (1, 0);
1119 message_log_maybe_newline ();
1122 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1127 static Lisp_Object
command_loop_2 (Lisp_Object
);
1128 static Lisp_Object
top_level_1 (Lisp_Object
);
1130 /* Entry to editor-command-loop.
1131 This level has the catches for exiting/returning to editor command loop.
1132 It returns nil to exit recursive edit, t to abort it. */
1137 if (command_loop_level
> 0 || minibuf_level
> 0)
1140 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1141 executing_kbd_macro
= Qnil
;
1147 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1148 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1149 executing_kbd_macro
= Qnil
;
1151 /* End of file in -batch run causes exit here. */
1157 /* Here we catch errors in execution of commands within the
1158 editing loop, and reenter the editing loop.
1159 When there is an error, cmd_error runs and returns a non-nil
1160 value to us. A value of nil means that command_loop_1 itself
1161 returned due to end of file (or end of kbd macro). */
1164 command_loop_2 (Lisp_Object ignore
)
1166 register Lisp_Object val
;
1169 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1170 while (!NILP (val
));
1178 return Feval (Vtop_level
, Qnil
);
1182 top_level_1 (Lisp_Object ignore
)
1184 /* On entry to the outer level, run the startup file. */
1185 if (!NILP (Vtop_level
))
1186 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1187 else if (!NILP (Vpurify_flag
))
1188 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1190 message1 ("Bare Emacs (standard Lisp code not loaded)");
1194 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1195 doc
: /* Exit all recursive editing levels.
1196 This also exits all active minibuffers. */)
1199 #ifdef HAVE_WINDOW_SYSTEM
1200 if (display_hourglass_p
)
1201 cancel_hourglass ();
1204 /* Unblock input if we enter with input blocked. This may happen if
1205 redisplay traps e.g. during tool-bar update with input blocked. */
1206 totally_unblock_input ();
1208 Fthrow (Qtop_level
, Qnil
);
1211 static _Noreturn
void
1212 user_error (const char *msg
)
1214 xsignal1 (Quser_error
, build_string (msg
));
1218 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1219 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1222 if (command_loop_level
> 0 || minibuf_level
> 0)
1223 Fthrow (Qexit
, Qnil
);
1225 user_error ("No recursive edit is in progress");
1229 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1230 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1233 if (command_loop_level
> 0 || minibuf_level
> 0)
1236 user_error ("No recursive edit is in progress");
1239 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1240 of this function. */
1243 tracking_off (Lisp_Object old_value
)
1245 do_mouse_tracking
= old_value
;
1246 if (NILP (old_value
))
1248 /* Redisplay may have been preempted because there was input
1249 available, and it assumes it will be called again after the
1250 input has been processed. If the only input available was
1251 the sort that we have just disabled, then we need to call
1253 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1255 redisplay_preserve_echo_area (6);
1256 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1261 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1262 doc
: /* Evaluate BODY with mouse movement events enabled.
1263 Within a `track-mouse' form, mouse motion generates input events that
1264 you can read with `read-event'.
1265 Normally, mouse motion is ignored.
1266 usage: (track-mouse BODY...) */)
1269 ptrdiff_t count
= SPECPDL_INDEX ();
1272 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1274 do_mouse_tracking
= Qt
;
1276 val
= Fprogn (args
);
1277 return unbind_to (count
, val
);
1280 /* If mouse has moved on some frame, return one of those frames.
1284 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1285 after resizing the tool-bar window. */
1287 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1290 bool ignore_mouse_drag_p
;
1292 static struct frame
*
1293 some_mouse_moved (void)
1295 Lisp_Object tail
, frame
;
1297 if (ignore_mouse_drag_p
)
1299 /* ignore_mouse_drag_p = 0; */
1303 FOR_EACH_FRAME (tail
, frame
)
1305 if (XFRAME (frame
)->mouse_moved
)
1306 return XFRAME (frame
);
1313 /* This is the actual command reading loop,
1314 sans error-handling encapsulation. */
1316 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1317 bool, bool, bool, bool);
1318 void safe_run_hooks (Lisp_Object
);
1319 static void adjust_point_for_property (ptrdiff_t, bool);
1321 /* The last boundary auto-added to buffer-undo-list. */
1322 Lisp_Object last_undo_boundary
;
1324 extern Lisp_Object Qregion_extract_function
;
1326 /* FIXME: This is wrong rather than test window-system, we should call
1327 a new set-selection, which will then dispatch to x-set-selection, or
1328 tty-set-selection, or w32-set-selection, ... */
1331 command_loop_1 (void)
1334 Lisp_Object keybuf
[30];
1336 EMACS_INT prev_modiff
= 0;
1337 struct buffer
*prev_buffer
= NULL
;
1338 bool already_adjusted
= 0;
1340 kset_prefix_arg (current_kboard
, Qnil
);
1341 kset_last_prefix_arg (current_kboard
, Qnil
);
1342 Vdeactivate_mark
= Qnil
;
1343 waiting_for_input
= 0;
1346 this_command_key_count
= 0;
1347 this_command_key_count_reset
= 0;
1348 this_single_command_key_start
= 0;
1350 if (NILP (Vmemory_full
))
1352 /* Make sure this hook runs after commands that get errors and
1353 throw to top level. */
1354 /* Note that the value cell will never directly contain nil
1355 if the symbol is a local variable. */
1356 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1357 safe_run_hooks (Qpost_command_hook
);
1359 /* If displaying a message, resize the echo area window to fit
1360 that message's size exactly. */
1361 if (!NILP (echo_area_buffer
[0]))
1362 resize_echo_area_exactly ();
1364 /* If there are warnings waiting, process them. */
1365 if (!NILP (Vdelayed_warnings_list
))
1366 safe_run_hooks (Qdelayed_warnings_hook
);
1368 if (!NILP (Vdeferred_action_list
))
1369 safe_run_hooks (Qdeferred_action_function
);
1372 /* Do this after running Vpost_command_hook, for consistency. */
1373 kset_last_command (current_kboard
, Vthis_command
);
1374 kset_real_last_command (current_kboard
, Vreal_this_command
);
1375 if (!CONSP (last_command_event
))
1376 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1380 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1383 /* Make sure the current window's buffer is selected. */
1384 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1386 /* Display any malloc warning that just came out. Use while because
1387 displaying one warning can cause another. */
1389 while (pending_malloc_warning
)
1390 display_malloc_warning ();
1392 Vdeactivate_mark
= Qnil
;
1394 /* Don't ignore mouse movements for more than a single command
1395 loop. (This flag is set in xdisp.c whenever the tool bar is
1396 resized, because the resize moves text up or down, and would
1397 generate false mouse drag events if we don't ignore them.) */
1398 ignore_mouse_drag_p
= 0;
1400 /* If minibuffer on and echo area in use,
1401 wait a short time and redraw minibuffer. */
1404 && !NILP (echo_area_buffer
[0])
1405 && EQ (minibuf_window
, echo_area_window
)
1406 && NUMBERP (Vminibuffer_message_timeout
))
1408 /* Bind inhibit-quit to t so that C-g gets read in
1409 rather than quitting back to the minibuffer. */
1410 ptrdiff_t count
= SPECPDL_INDEX ();
1411 specbind (Qinhibit_quit
, Qt
);
1413 sit_for (Vminibuffer_message_timeout
, 0, 2);
1415 /* Clear the echo area. */
1417 safe_run_hooks (Qecho_area_clear_hook
);
1419 unbind_to (count
, Qnil
);
1421 /* If a C-g came in before, treat it as input now. */
1422 if (!NILP (Vquit_flag
))
1425 Vunread_command_events
= list1 (make_number (quit_char
));
1429 /* If it has changed current-menubar from previous value,
1430 really recompute the menubar from the value. */
1431 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1432 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1433 call0 (Qrecompute_lucid_menubar
);
1435 before_command_key_count
= this_command_key_count
;
1436 before_command_echo_length
= echo_length ();
1438 Vthis_command
= Qnil
;
1439 Vreal_this_command
= Qnil
;
1440 Vthis_original_command
= Qnil
;
1441 Vthis_command_keys_shift_translated
= Qnil
;
1443 /* Read next key sequence; i gets its length. */
1444 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1447 /* A filter may have run while we were reading the input. */
1448 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1450 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1454 /* Now we have read a key sequence of length I,
1455 or else I is 0 and we found end of file. */
1457 if (i
== 0) /* End of file -- happens only in */
1458 return Qnil
; /* a kbd macro, at the end. */
1459 /* -1 means read_key_sequence got a menu that was rejected.
1460 Just loop around and read another command. */
1464 this_command_key_count
= 0;
1465 this_command_key_count_reset
= 0;
1466 this_single_command_key_start
= 0;
1470 last_command_event
= keybuf
[i
- 1];
1472 /* If the previous command tried to force a specific window-start,
1473 forget about that, in case this command moves point far away
1474 from that position. But also throw away beg_unchanged and
1475 end_unchanged information in that case, so that redisplay will
1476 update the whole window properly. */
1477 if (XWINDOW (selected_window
)->force_start
)
1480 XWINDOW (selected_window
)->force_start
= 0;
1481 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1482 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1485 cmd
= read_key_sequence_cmd
;
1486 if (!NILP (Vexecuting_kbd_macro
))
1488 if (!NILP (Vquit_flag
))
1490 Vexecuting_kbd_macro
= Qt
;
1491 QUIT
; /* Make some noise. */
1492 /* Will return since macro now empty. */
1496 /* Do redisplay processing after this command except in special
1497 cases identified below. */
1498 prev_buffer
= current_buffer
;
1499 prev_modiff
= MODIFF
;
1500 last_point_position
= PT
;
1502 /* By default, we adjust point to a boundary of a region that
1503 has such a property that should be treated intangible
1504 (e.g. composition, display). But, some commands will set
1505 this variable differently. */
1506 Vdisable_point_adjustment
= Qnil
;
1508 /* Process filters and timers may have messed with deactivate-mark.
1509 reset it before we execute the command. */
1510 Vdeactivate_mark
= Qnil
;
1512 /* Remap command through active keymaps. */
1513 Vthis_original_command
= cmd
;
1514 if (!NILP (read_key_sequence_remapped
))
1515 cmd
= read_key_sequence_remapped
;
1517 /* Execute the command. */
1519 Vthis_command
= cmd
;
1520 Vreal_this_command
= cmd
;
1521 safe_run_hooks (Qpre_command_hook
);
1523 already_adjusted
= 0;
1525 if (NILP (Vthis_command
))
1526 /* nil means key is undefined. */
1530 /* Here for a command that isn't executed directly. */
1532 #ifdef HAVE_WINDOW_SYSTEM
1533 ptrdiff_t scount
= SPECPDL_INDEX ();
1535 if (display_hourglass_p
1536 && NILP (Vexecuting_kbd_macro
))
1538 record_unwind_protect_void (cancel_hourglass
);
1543 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1545 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1548 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1549 ? Qnil
: BVAR (current_buffer
, undo_list
));
1551 call1 (Qcommand_execute
, Vthis_command
);
1553 #ifdef HAVE_WINDOW_SYSTEM
1554 /* Do not check display_hourglass_p here, because
1555 `command-execute' could change it, but we should cancel
1556 hourglass cursor anyway.
1557 But don't cancel the hourglass within a macro
1558 just because a command in the macro finishes. */
1559 if (NILP (Vexecuting_kbd_macro
))
1560 unbind_to (scount
, Qnil
);
1563 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1565 safe_run_hooks (Qpost_command_hook
);
1567 /* If displaying a message, resize the echo area window to fit
1568 that message's size exactly. */
1569 if (!NILP (echo_area_buffer
[0]))
1570 resize_echo_area_exactly ();
1572 /* If there are warnings waiting, process them. */
1573 if (!NILP (Vdelayed_warnings_list
))
1574 safe_run_hooks (Qdelayed_warnings_hook
);
1576 safe_run_hooks (Qdeferred_action_function
);
1578 /* If there is a prefix argument,
1579 1) We don't want Vlast_command to be ``universal-argument''
1580 (that would be dumb), so don't set Vlast_command,
1581 2) we want to leave echoing on so that the prefix will be
1582 echoed as part of this key sequence, so don't call
1584 3) we want to leave this_command_key_count non-zero, so that
1585 read_char will realize that it is re-reading a character, and
1586 not echo it a second time.
1588 If the command didn't actually create a prefix arg,
1589 but is merely a frame event that is transparent to prefix args,
1590 then the above doesn't apply. */
1591 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1592 || CONSP (last_command_event
))
1594 kset_last_command (current_kboard
, Vthis_command
);
1595 kset_real_last_command (current_kboard
, Vreal_this_command
);
1596 if (!CONSP (last_command_event
))
1597 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1599 this_command_key_count
= 0;
1600 this_command_key_count_reset
= 0;
1601 this_single_command_key_start
= 0;
1604 if (!NILP (BVAR (current_buffer
, mark_active
))
1605 && !NILP (Vrun_hooks
))
1607 /* In Emacs 22, setting transient-mark-mode to `only' was a
1608 way of turning it on for just one command. This usage is
1609 obsolete, but support it anyway. */
1610 if (EQ (Vtransient_mark_mode
, Qidentity
))
1611 Vtransient_mark_mode
= Qnil
;
1612 else if (EQ (Vtransient_mark_mode
, Qonly
))
1613 Vtransient_mark_mode
= Qidentity
;
1615 if (!NILP (Vdeactivate_mark
))
1616 /* If `select-active-regions' is non-nil, this call to
1617 `deactivate-mark' also sets the PRIMARY selection. */
1618 call0 (Qdeactivate_mark
);
1621 /* Even if not deactivating the mark, set PRIMARY if
1622 `select-active-regions' is non-nil. */
1623 if (!NILP (Fwindow_system (Qnil
))
1624 /* Even if mark_active is non-nil, the actual buffer
1625 marker may not have been set yet (Bug#7044). */
1626 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1627 && (EQ (Vselect_active_regions
, Qonly
)
1628 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1629 : (!NILP (Vselect_active_regions
)
1630 && !NILP (Vtransient_mark_mode
)))
1631 && NILP (Fmemq (Vthis_command
,
1632 Vselection_inhibit_update_commands
)))
1635 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1636 if (XINT (Flength (txt
)) > 0)
1637 /* Don't set empty selections. */
1638 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1641 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1643 Lisp_Object hook
= intern ("activate-mark-hook");
1644 Frun_hooks (1, &hook
);
1648 Vsaved_region_selection
= Qnil
;
1653 if (current_buffer
== prev_buffer
1654 && last_point_position
!= PT
1655 && NILP (Vdisable_point_adjustment
)
1656 && NILP (Vglobal_disable_point_adjustment
))
1658 if (last_point_position
> BEGV
1659 && last_point_position
< ZV
1660 && (composition_adjust_point (last_point_position
,
1661 last_point_position
)
1662 != last_point_position
))
1663 /* The last point was temporarily set within a grapheme
1664 cluster to prevent automatic composition. To recover
1665 the automatic composition, we must update the
1667 windows_or_buffers_changed
= 21;
1668 if (!already_adjusted
)
1669 adjust_point_for_property (last_point_position
,
1670 MODIFF
!= prev_modiff
);
1673 /* Install chars successfully executed in kbd macro. */
1675 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1676 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1677 finalize_kbd_macro_chars ();
1682 read_menu_command (void)
1684 Lisp_Object keybuf
[30];
1685 ptrdiff_t count
= SPECPDL_INDEX ();
1688 /* We don't want to echo the keystrokes while navigating the
1690 specbind (Qecho_keystrokes
, make_number (0));
1692 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1695 unbind_to (count
, Qnil
);
1697 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1699 if (i
== 0 || i
== -1)
1702 return read_key_sequence_cmd
;
1705 /* Adjust point to a boundary of a region that has such a property
1706 that should be treated intangible. For the moment, we check
1707 `composition', `display' and `invisible' properties.
1708 LAST_PT is the last position of point. */
1711 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1714 Lisp_Object val
, overlay
, tmp
;
1715 /* When called after buffer modification, we should temporarily
1716 suppress the point adjustment for automatic composition so that a
1717 user can keep inserting another character at point or keep
1718 deleting characters around point. */
1719 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1720 ptrdiff_t orig_pt
= PT
;
1722 /* FIXME: cycling is probably not necessary because these properties
1723 can't be usefully combined anyway. */
1724 while (check_composition
|| check_display
|| check_invisible
)
1726 /* FIXME: check `intangible'. */
1727 if (check_composition
1728 && PT
> BEGV
&& PT
< ZV
1729 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1732 check_display
= check_invisible
= 1;
1734 check_composition
= 0;
1736 && PT
> BEGV
&& PT
< ZV
1737 && !NILP (val
= get_char_property_and_overlay
1738 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1739 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1740 && (!OVERLAYP (overlay
)
1741 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1742 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1743 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1744 && (beg
< PT
/* && end > PT <- It's always the case. */
1745 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1748 SET_PT (PT
< last_pt
1749 ? (STRINGP (val
) && SCHARS (val
) == 0
1750 ? max (beg
- 1, BEGV
)
1753 check_composition
= check_invisible
= 1;
1756 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1762 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1765 /* FIXME: We should stop if we find a spot between
1766 two runs of `invisible' where inserted text would
1767 be visible. This is important when we have two
1768 invisible boundaries that enclose an area: if the
1769 area is empty, we need this test in order to make
1770 it possible to place point in the middle rather
1771 than skip both boundaries. However, this code
1772 also stops anywhere in a non-sticky text-property,
1773 which breaks (e.g.) Org mode. */
1774 && (val
= Fget_pos_property (make_number (end
),
1776 TEXT_PROP_MEANS_INVISIBLE (val
))
1778 && !NILP (val
= get_char_property_and_overlay
1779 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1780 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1782 ellipsis
= ellipsis
|| inv
> 1
1783 || (OVERLAYP (overlay
)
1784 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1785 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1786 tmp
= Fnext_single_char_property_change
1787 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1788 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1792 && (val
= Fget_pos_property (make_number (beg
),
1794 TEXT_PROP_MEANS_INVISIBLE (val
))
1796 && !NILP (val
= get_char_property_and_overlay
1797 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1798 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1800 ellipsis
= ellipsis
|| inv
> 1
1801 || (OVERLAYP (overlay
)
1802 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1803 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1804 tmp
= Fprevious_single_char_property_change
1805 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1806 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1809 /* Move away from the inside area. */
1810 if (beg
< PT
&& end
> PT
)
1812 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1813 /* We haven't moved yet (so we don't need to fear
1814 infinite-looping) and we were outside the range
1815 before (so either end of the range still corresponds
1816 to a move in the right direction): pretend we moved
1817 less than we actually did, so that we still have
1818 more freedom below in choosing which end of the range
1820 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1821 /* We either have moved already or the last point
1822 was already in the range: we don't get to choose
1823 which end of the range we have to go to. */
1824 : (PT
< last_pt
? beg
: end
));
1825 check_composition
= check_display
= 1;
1827 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1828 the point to something other than its argument, due to
1829 point-motion hooks, intangibility, etc. */
1830 eassert (PT
== beg
|| PT
== end
);
1833 /* Pretend the area doesn't exist if the buffer is not
1835 if (!modified
&& !ellipsis
&& beg
< end
)
1837 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1838 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1839 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1840 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1841 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1842 /* We've already moved as far as we can. Trying to go
1843 to the other end would mean moving backwards and thus
1844 could lead to an infinite loop. */
1846 else if (val
= Fget_pos_property (make_number (PT
),
1848 TEXT_PROP_MEANS_INVISIBLE (val
)
1849 && (val
= (Fget_pos_property
1850 (make_number (PT
== beg
? end
: beg
),
1852 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1853 (check_composition
= check_display
= 1,
1854 SET_PT (PT
== beg
? end
: beg
));
1857 check_invisible
= 0;
1861 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1864 safe_run_hooks_1 (void)
1866 eassert (CONSP (Vinhibit_quit
));
1867 return call0 (XCDR (Vinhibit_quit
));
1870 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1874 safe_run_hooks_error (Lisp_Object error_data
)
1877 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1878 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1879 Lisp_Object args
[4];
1880 args
[0] = build_string ("Error in %s (%S): %S");
1883 args
[3] = error_data
;
1889 Lisp_Object newval
= Qnil
;
1890 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1891 if (EQ (fun
, XCAR (val
)))
1894 newval
= Fcons (XCAR (val
), newval
);
1896 return Fset (hook
, Fnreverse (newval
));
1897 /* Not found in the local part of the hook. Let's look at the global
1900 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1901 : Fdefault_value (hook
));
1902 CONSP (val
); val
= XCDR (val
))
1903 if (EQ (fun
, XCAR (val
)))
1906 newval
= Fcons (XCAR (val
), newval
);
1908 return Fset_default (hook
, Fnreverse (newval
));
1914 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1916 eassert (nargs
== 1);
1917 if (CONSP (Vinhibit_quit
))
1918 XSETCDR (Vinhibit_quit
, args
[0]);
1920 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1922 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1926 /* If we get an error while running the hook, cause the hook variable
1927 to be nil. Also inhibit quits, so that C-g won't cause the hook
1928 to mysteriously evaporate. */
1931 safe_run_hooks (Lisp_Object hook
)
1933 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1934 to its body or to its handlers other than via globals such as
1935 dynamically-bound variables ;-) */
1936 ptrdiff_t count
= SPECPDL_INDEX ();
1937 specbind (Qinhibit_quit
, hook
);
1939 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1941 unbind_to (count
, Qnil
);
1945 /* Nonzero means polling for input is temporarily suppressed. */
1947 int poll_suppress_count
;
1950 #ifdef POLL_FOR_INPUT
1952 /* Asynchronous timer for polling. */
1954 static struct atimer
*poll_timer
;
1956 /* Poll for input, so that we catch a C-g if it comes in. This
1957 function is called from x_make_frame_visible, see comment
1961 poll_for_input_1 (void)
1963 if (! input_blocked_p ()
1964 && !waiting_for_input
)
1968 /* Timer callback function for poll_timer. TIMER is equal to
1972 poll_for_input (struct atimer
*timer
)
1974 if (poll_suppress_count
== 0)
1975 pending_signals
= 1;
1978 #endif /* POLL_FOR_INPUT */
1980 /* Begin signals to poll for input, if they are appropriate.
1981 This function is called unconditionally from various places. */
1984 start_polling (void)
1986 #ifdef POLL_FOR_INPUT
1987 /* XXX This condition was (read_socket_hook && !interrupt_input),
1988 but read_socket_hook is not global anymore. Let's pretend that
1990 if (!interrupt_input
)
1992 /* Turn alarm handling on unconditionally. It might have
1993 been turned off in process.c. */
1994 turn_on_atimers (1);
1996 /* If poll timer doesn't exist, are we need one with
1997 a different interval, start a new one. */
1998 if (poll_timer
== NULL
1999 || poll_timer
->interval
.tv_sec
!= polling_period
)
2001 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2002 struct timespec interval
= make_timespec (period
, 0);
2005 cancel_atimer (poll_timer
);
2007 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2008 poll_for_input
, NULL
);
2011 /* Let the timer's callback function poll for input
2012 if this becomes zero. */
2013 --poll_suppress_count
;
2018 /* True if we are using polling to handle input asynchronously. */
2021 input_polling_used (void)
2023 #ifdef POLL_FOR_INPUT
2024 /* XXX This condition was (read_socket_hook && !interrupt_input),
2025 but read_socket_hook is not global anymore. Let's pretend that
2027 return !interrupt_input
;
2033 /* Turn off polling. */
2038 #ifdef POLL_FOR_INPUT
2039 /* XXX This condition was (read_socket_hook && !interrupt_input),
2040 but read_socket_hook is not global anymore. Let's pretend that
2042 if (!interrupt_input
)
2043 ++poll_suppress_count
;
2047 /* Set the value of poll_suppress_count to COUNT
2048 and start or stop polling accordingly. */
2051 set_poll_suppress_count (int count
)
2053 #ifdef POLL_FOR_INPUT
2054 if (count
== 0 && poll_suppress_count
!= 0)
2056 poll_suppress_count
= 1;
2059 else if (count
!= 0 && poll_suppress_count
== 0)
2063 poll_suppress_count
= count
;
2067 /* Bind polling_period to a value at least N.
2068 But don't decrease it. */
2071 bind_polling_period (int n
)
2073 #ifdef POLL_FOR_INPUT
2074 EMACS_INT
new = polling_period
;
2079 stop_other_atimers (poll_timer
);
2081 specbind (Qpolling_period
, make_number (new));
2082 /* Start a new alarm with the new period. */
2087 /* Apply the control modifier to CHARACTER. */
2093 make_ctrl_char (int c
)
2095 /* Save the upper bits here. */
2096 int upper
= c
& ~0177;
2098 if (! ASCII_BYTE_P (c
))
2099 return c
|= ctrl_modifier
;
2103 /* Everything in the columns containing the upper-case letters
2104 denotes a control character. */
2105 if (c
>= 0100 && c
< 0140)
2109 /* Set the shift modifier for a control char
2110 made from a shifted letter. But only for letters! */
2111 if (oc
>= 'A' && oc
<= 'Z')
2112 c
|= shift_modifier
;
2115 /* The lower-case letters denote control characters too. */
2116 else if (c
>= 'a' && c
<= 'z')
2119 /* Include the bits for control and shift
2120 only if the basic ASCII code can't indicate them. */
2124 /* Replace the high bits. */
2125 c
|= (upper
& ~ctrl_modifier
);
2130 /* Display the help-echo property of the character after the mouse pointer.
2131 Either show it in the echo area, or call show-help-function to display
2132 it by other means (maybe in a tooltip).
2134 If HELP is nil, that means clear the previous help echo.
2136 If HELP is a string, display that string. If HELP is a function,
2137 call it with OBJECT and POS as arguments; the function should
2138 return a help string or nil for none. For all other types of HELP,
2139 evaluate it to obtain a string.
2141 WINDOW is the window in which the help was generated, if any.
2142 It is nil if not in a window.
2144 If OBJECT is a buffer, POS is the position in the buffer where the
2145 `help-echo' text property was found.
2147 If OBJECT is an overlay, that overlay has a `help-echo' property,
2148 and POS is the position in the overlay's buffer under the mouse.
2150 If OBJECT is a string (an overlay string or a string displayed with
2151 the `display' property). POS is the position in that string under
2154 Note: this function may only be called with HELP nil or a string
2155 from X code running asynchronously. */
2158 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2161 if (!NILP (help
) && !STRINGP (help
))
2163 if (FUNCTIONP (help
))
2164 help
= safe_call (4, help
, window
, object
, pos
);
2166 help
= safe_eval (help
);
2168 if (!STRINGP (help
))
2172 if (!noninteractive
&& STRINGP (help
))
2174 /* The mouse-fixup-help-message Lisp function can call
2175 mouse_position_hook, which resets the mouse_moved flags.
2176 This causes trouble if we are trying to read a mouse motion
2177 event (i.e., if we are inside a `track-mouse' form), so we
2178 restore the mouse_moved flag. */
2179 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2180 help
= call1 (Qmouse_fixup_help_message
, help
);
2185 if (STRINGP (help
) || NILP (help
))
2187 if (!NILP (Vshow_help_function
))
2188 call1 (Vshow_help_function
, help
);
2189 help_echo_showing_p
= STRINGP (help
);
2195 /* Input of single characters from keyboard */
2197 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2198 struct timespec
*end_time
);
2199 static void record_char (Lisp_Object c
);
2201 static Lisp_Object help_form_saved_window_configs
;
2203 read_char_help_form_unwind (void)
2205 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2206 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2207 if (!NILP (window_config
))
2208 Fset_window_configuration (window_config
);
2211 #define STOP_POLLING \
2212 do { if (! polling_stopped_here) stop_polling (); \
2213 polling_stopped_here = 1; } while (0)
2215 #define RESUME_POLLING \
2216 do { if (polling_stopped_here) start_polling (); \
2217 polling_stopped_here = 0; } while (0)
2220 read_event_from_main_queue (struct timespec
*end_time
,
2221 sys_jmp_buf local_getcjmp
,
2222 bool *used_mouse_menu
)
2224 Lisp_Object c
= Qnil
;
2225 sys_jmp_buf save_jump
;
2226 KBOARD
*kb
IF_LINT (= NULL
);
2230 /* Read from the main queue, and if that gives us something we can't use yet,
2231 we put it on the appropriate side queue and try again. */
2233 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2236 /* Actually read a character, waiting if necessary. */
2237 save_getcjmp (save_jump
);
2238 restore_getcjmp (local_getcjmp
);
2240 timer_start_idle ();
2241 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2242 restore_getcjmp (save_jump
);
2244 if (! NILP (c
) && (kb
!= current_kboard
))
2246 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2249 while (CONSP (XCDR (last
)))
2251 if (!NILP (XCDR (last
)))
2255 kset_kbd_queue (kb
, list1 (c
));
2257 XSETCDR (last
, list1 (c
));
2258 kb
->kbd_queue_has_data
= 1;
2262 current_kboard
= kb
;
2263 /* This is going to exit from read_char
2264 so we had better get rid of this frame's stuff. */
2265 return make_number (-2);
2268 /* Terminate Emacs in batch mode if at eof. */
2269 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2270 Fkill_emacs (make_number (1));
2274 /* Add in any extra modifiers, where appropriate. */
2275 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2276 || ((extra_keyboard_modifiers
& 0177) < ' '
2277 && (extra_keyboard_modifiers
& 0177) != 0))
2278 XSETINT (c
, make_ctrl_char (XINT (c
)));
2280 /* Transfer any other modifier bits directly from
2281 extra_keyboard_modifiers to c. Ignore the actual character code
2282 in the low 16 bits of extra_keyboard_modifiers. */
2283 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2291 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2294 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2295 sys_jmp_buf local_getcjmp
,
2296 Lisp_Object prev_event
,
2297 bool *used_mouse_menu
)
2299 #define MAX_ENCODED_BYTES 16
2300 Lisp_Object events
[MAX_ENCODED_BYTES
];
2305 = read_event_from_main_queue (end_time
, local_getcjmp
,
2308 /* w32_console already returns decoded events. It either reads
2309 Unicode characters from the Windows keyboard input, or
2310 converts characters encoded in the current codepage into
2311 Unicode. See w32inevt.c:key_event, near its end. */
2314 struct frame
*frame
= XFRAME (selected_frame
);
2315 struct terminal
*terminal
= frame
->terminal
;
2316 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2317 /* Don't apply decoding if we're just reading a raw event
2318 (e.g. reading bytes sent by the xterm to specify the position
2319 of a mouse click). */
2320 && (!EQ (prev_event
, Qt
))
2321 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2322 & CODING_REQUIRE_DECODING_MASK
)))
2323 return nextevt
; /* No decoding needed. */
2326 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2327 eassert (n
< MAX_ENCODED_BYTES
);
2328 events
[n
++] = nextevt
;
2329 if (NATNUMP (nextevt
)
2330 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2331 { /* An encoded byte sequence, let's try to decode it. */
2332 struct coding_system
*coding
2333 = TERMINAL_KEYBOARD_CODING (terminal
);
2334 unsigned char *src
= alloca (n
);
2336 for (i
= 0; i
< n
; i
++)
2337 src
[i
] = XINT (events
[i
]);
2339 for (i
= 0; i
< n
; i
++)
2341 coding
->destination
= alloca (n
* 4);
2342 coding
->dst_bytes
= n
* 4;
2343 decode_coding_c_string (coding
, src
, n
, Qnil
);
2344 eassert (coding
->produced_char
<= n
);
2345 if (coding
->produced_char
== 0)
2346 { /* The encoded sequence is incomplete. */
2347 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2348 continue; /* Read on! */
2352 const unsigned char *p
= coding
->destination
;
2353 eassert (coding
->carryover_bytes
== 0);
2355 while (n
< coding
->produced_char
)
2356 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2359 /* Now `events' should hold decoded events.
2360 Normally, n should be equal to 1, but better not rely on it.
2361 We can only return one event here, so return the first we
2362 had and keep the others (if any) for later. */
2364 Vunread_command_events
2365 = Fcons (events
[--n
], Vunread_command_events
);
2372 /* Read a character from the keyboard; call the redisplay if needed. */
2373 /* commandflag 0 means do not autosave, but do redisplay.
2374 -1 means do not redisplay, but do autosave.
2375 -2 means do neither.
2378 /* The arguments MAP is for menu prompting. MAP is a keymap.
2380 PREV_EVENT is the previous input event, or nil if we are reading
2381 the first event of a key sequence (or not reading a key sequence).
2382 If PREV_EVENT is t, that is a "magic" value that says
2383 not to run input methods, but in other respects to act as if
2384 not reading a key sequence.
2386 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2387 if we used a mouse menu to read the input, or false otherwise. If
2388 USED_MOUSE_MENU is null, don't dereference it.
2390 Value is -2 when we find input on another keyboard. A second call
2391 to read_char will read it.
2393 If END_TIME is non-null, it is a pointer to a struct timespec
2394 specifying the maximum time to wait until. If no input arrives by
2395 that time, stop waiting and return nil.
2397 Value is t if we showed a menu and the user rejected it. */
2400 read_char (int commandflag
, Lisp_Object map
,
2401 Lisp_Object prev_event
,
2402 bool *used_mouse_menu
, struct timespec
*end_time
)
2406 sys_jmp_buf local_getcjmp
;
2407 sys_jmp_buf save_jump
;
2408 Lisp_Object tem
, save
;
2409 volatile Lisp_Object previous_echo_area_message
;
2410 volatile Lisp_Object also_record
;
2411 volatile bool reread
;
2412 struct gcpro gcpro1
, gcpro2
;
2413 bool volatile polling_stopped_here
= 0;
2414 struct kboard
*orig_kboard
= current_kboard
;
2418 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2419 before_command_key_count
= this_command_key_count
;
2420 before_command_echo_length
= echo_length ();
2423 previous_echo_area_message
= Qnil
;
2425 GCPRO2 (c
, previous_echo_area_message
);
2430 if (CONSP (Vunread_post_input_method_events
))
2432 c
= XCAR (Vunread_post_input_method_events
);
2433 Vunread_post_input_method_events
2434 = XCDR (Vunread_post_input_method_events
);
2436 /* Undo what read_char_x_menu_prompt did when it unread
2437 additional keys returned by Fx_popup_menu. */
2439 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2447 if (CONSP (Vunread_command_events
))
2449 bool was_disabled
= 0;
2451 c
= XCAR (Vunread_command_events
);
2452 Vunread_command_events
= XCDR (Vunread_command_events
);
2456 /* Undo what sit-for did when it unread additional keys
2457 inside universal-argument. */
2460 && EQ (XCAR (c
), Qt
))
2466 /* Undo what read_char_x_menu_prompt did when it unread
2467 additional keys returned by Fx_popup_menu. */
2469 && EQ (XCDR (c
), Qdisabled
)
2470 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2476 /* If the queued event is something that used the mouse,
2477 set used_mouse_menu accordingly. */
2479 /* Also check was_disabled so last-nonmenu-event won't return
2480 a bad value when submenus are involved. (Bug#447) */
2481 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2482 *used_mouse_menu
= 1;
2484 goto reread_for_input_method
;
2487 if (CONSP (Vunread_input_method_events
))
2489 c
= XCAR (Vunread_input_method_events
);
2490 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2492 /* Undo what read_char_x_menu_prompt did when it unread
2493 additional keys returned by Fx_popup_menu. */
2495 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2499 goto reread_for_input_method
;
2502 this_command_key_count_reset
= 0;
2504 if (!NILP (Vexecuting_kbd_macro
))
2506 /* We set this to Qmacro; since that's not a frame, nobody will
2507 try to switch frames on us, and the selected window will
2510 Since this event came from a macro, it would be misleading to
2511 leave internal_last_event_frame set to wherever the last
2512 real event came from. Normally, a switch-frame event selects
2513 internal_last_event_frame after each command is read, but
2514 events read from a macro should never cause a new frame to be
2516 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2518 /* Exit the macro if we are at the end.
2519 Also, some things replace the macro with t
2520 to force an early exit. */
2521 if (EQ (Vexecuting_kbd_macro
, Qt
)
2522 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2528 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2529 if (STRINGP (Vexecuting_kbd_macro
)
2530 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2531 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2533 executing_kbd_macro_index
++;
2538 if (!NILP (unread_switch_frame
))
2540 c
= unread_switch_frame
;
2541 unread_switch_frame
= Qnil
;
2543 /* This event should make it into this_command_keys, and get echoed
2544 again, so we do not set `reread'. */
2548 /* If redisplay was requested. */
2549 if (commandflag
>= 0)
2551 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2553 /* If there is pending input, process any events which are not
2554 user-visible, such as X selection_request events. */
2556 || detect_input_pending_run_timers (0))
2557 swallow_events (0); /* May clear input_pending. */
2559 /* Redisplay if no pending input. */
2560 while (!input_pending
)
2562 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2563 redisplay_preserve_echo_area (5);
2568 /* Normal case: no input arrived during redisplay. */
2571 /* Input arrived and pre-empted redisplay.
2572 Process any events which are not user-visible. */
2574 /* If that cleared input_pending, try again to redisplay. */
2577 /* Prevent the redisplay we just did
2578 from messing up echoing of the input after the prompt. */
2579 if (commandflag
== 0 && echo_current
)
2580 echo_message_buffer
= echo_area_buffer
[0];
2584 /* Message turns off echoing unless more keystrokes turn it on again.
2586 The code in 20.x for the condition was
2588 1. echo_area_glyphs && *echo_area_glyphs
2589 2. && echo_area_glyphs != current_kboard->echobuf
2590 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2592 (1) means there's a current message displayed
2594 (2) means it's not the message from echoing from the current
2597 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2598 is set to a non-null value. This is done in read_char and it is
2599 set to echo_area_glyphs after a call to echo_char. That means
2600 ok_to_echo_at_next_pause is either null or
2601 current_kboard->echobuf with the appropriate current_kboard at
2604 So, condition (3) means in clear text ok_to_echo_at_next_pause
2605 must be either null, or the current message isn't from echoing at
2606 all, or it's from echoing from a different kboard than the
2609 if (/* There currently is something in the echo area. */
2610 !NILP (echo_area_buffer
[0])
2611 && (/* It's an echo from a different kboard. */
2612 echo_kboard
!= current_kboard
2613 /* Or we explicitly allow overwriting whatever there is. */
2614 || ok_to_echo_at_next_pause
== NULL
))
2619 /* Try reading a character via menu prompting in the minibuf.
2620 Try this before the sit-for, because the sit-for
2621 would do the wrong thing if we are supposed to do
2622 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2623 after a mouse event so don't try a minibuf menu. */
2625 if (KEYMAPP (map
) && INTERACTIVE
2626 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2627 /* Don't bring up a menu if we already have another event. */
2628 && NILP (Vunread_command_events
)
2629 && !detect_input_pending_run_timers (0))
2631 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2633 if (INTEGERP (c
) && XINT (c
) == -2)
2634 return c
; /* wrong_kboard_jmpbuf */
2640 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2641 We will do that below, temporarily for short sections of code,
2642 when appropriate. local_getcjmp must be in effect
2643 around any call to sit_for or kbd_buffer_get_event;
2644 it *must not* be in effect when we call redisplay. */
2646 jmpcount
= SPECPDL_INDEX ();
2647 if (sys_setjmp (local_getcjmp
))
2649 /* Handle quits while reading the keyboard. */
2650 /* We must have saved the outer value of getcjmp here,
2651 so restore it now. */
2652 restore_getcjmp (save_jump
);
2653 unbind_to (jmpcount
, Qnil
);
2654 XSETINT (c
, quit_char
);
2655 internal_last_event_frame
= selected_frame
;
2656 Vlast_event_frame
= internal_last_event_frame
;
2657 /* If we report the quit char as an event,
2658 don't do so more than once. */
2659 if (!NILP (Vinhibit_quit
))
2663 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2664 if (kb
!= current_kboard
)
2666 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2667 /* We shouldn't get here if we were in single-kboard mode! */
2672 while (CONSP (XCDR (last
)))
2674 if (!NILP (XCDR (last
)))
2678 kset_kbd_queue (kb
, list1 (c
));
2680 XSETCDR (last
, list1 (c
));
2681 kb
->kbd_queue_has_data
= 1;
2682 current_kboard
= kb
;
2683 /* This is going to exit from read_char
2684 so we had better get rid of this frame's stuff. */
2686 return make_number (-2); /* wrong_kboard_jmpbuf */
2692 /* Start idle timers if no time limit is supplied. We don't do it
2693 if a time limit is supplied to avoid an infinite recursion in the
2694 situation where an idle timer calls `sit-for'. */
2697 timer_start_idle ();
2699 /* If in middle of key sequence and minibuffer not active,
2700 start echoing if enough time elapses. */
2702 if (minibuf_level
== 0
2704 && !current_kboard
->immediate_echo
2705 && this_command_key_count
> 0
2707 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2708 && NILP (Fzerop (Vecho_keystrokes
))
2709 && (/* No message. */
2710 NILP (echo_area_buffer
[0])
2711 /* Or empty message. */
2712 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2713 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2714 /* Or already echoing from same kboard. */
2715 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2716 /* Or not echoing before and echoing allowed. */
2717 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2719 /* After a mouse event, start echoing right away.
2720 This is because we are probably about to display a menu,
2721 and we don't want to delay before doing so. */
2722 if (EVENT_HAS_PARAMETERS (prev_event
))
2728 save_getcjmp (save_jump
);
2729 restore_getcjmp (local_getcjmp
);
2730 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2731 restore_getcjmp (save_jump
);
2733 && ! CONSP (Vunread_command_events
))
2738 /* Maybe auto save due to number of keystrokes. */
2740 if (commandflag
!= 0 && commandflag
!= -2
2741 && auto_save_interval
> 0
2742 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2743 && !detect_input_pending_run_timers (0))
2745 Fdo_auto_save (Qnil
, Qnil
);
2746 /* Hooks can actually change some buffers in auto save. */
2750 /* Try reading using an X menu.
2751 This is never confused with reading using the minibuf
2752 because the recursive call of read_char in read_char_minibuf_menu_prompt
2753 does not pass on any keymaps. */
2755 if (KEYMAPP (map
) && INTERACTIVE
2756 && !NILP (prev_event
)
2757 && EVENT_HAS_PARAMETERS (prev_event
)
2758 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2759 && !EQ (XCAR (prev_event
), Qtool_bar
)
2760 /* Don't bring up a menu if we already have another event. */
2761 && NILP (Vunread_command_events
))
2763 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2765 /* Now that we have read an event, Emacs is not idle. */
2772 /* Maybe autosave and/or garbage collect due to idleness. */
2774 if (INTERACTIVE
&& NILP (c
))
2777 ptrdiff_t buffer_size
;
2779 /* Slow down auto saves logarithmically in size of current buffer,
2780 and garbage collect while we're at it. */
2781 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2782 last_non_minibuf_size
= Z
- BEG
;
2783 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2785 while (buffer_size
> 64)
2786 delay_level
++, buffer_size
-= buffer_size
>> 2;
2787 if (delay_level
< 4) delay_level
= 4;
2788 /* delay_level is 4 for files under around 50k, 7 at 100k,
2789 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2791 /* Auto save if enough time goes by without input. */
2792 if (commandflag
!= 0 && commandflag
!= -2
2793 && num_nonmacro_input_events
> last_auto_save
2794 && INTEGERP (Vauto_save_timeout
)
2795 && XINT (Vauto_save_timeout
) > 0)
2798 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2800 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2801 timeout
= delay_level
* timeout
/ 4;
2802 save_getcjmp (save_jump
);
2803 restore_getcjmp (local_getcjmp
);
2804 tem0
= sit_for (make_number (timeout
), 1, 1);
2805 restore_getcjmp (save_jump
);
2808 && ! CONSP (Vunread_command_events
))
2810 Fdo_auto_save (Qnil
, Qnil
);
2815 /* If there is still no input available, ask for GC. */
2816 if (!detect_input_pending_run_timers (0))
2820 /* Notify the caller if an autosave hook, or a timer, sentinel or
2821 filter in the sit_for calls above have changed the current
2822 kboard. This could happen if they use the minibuffer or start a
2823 recursive edit, like the fancy splash screen in server.el's
2824 filter. If this longjmp wasn't here, read_key_sequence would
2825 interpret the next key sequence using the wrong translation
2826 tables and function keymaps. */
2827 if (NILP (c
) && current_kboard
!= orig_kboard
)
2830 return make_number (-2); /* wrong_kboard_jmpbuf */
2833 /* If this has become non-nil here, it has been set by a timer
2834 or sentinel or filter. */
2835 if (CONSP (Vunread_command_events
))
2837 c
= XCAR (Vunread_command_events
);
2838 Vunread_command_events
= XCDR (Vunread_command_events
);
2841 /* Read something from current KBOARD's side queue, if possible. */
2845 if (current_kboard
->kbd_queue_has_data
)
2847 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2849 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2850 kset_kbd_queue (current_kboard
,
2851 XCDR (KVAR (current_kboard
, kbd_queue
)));
2852 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2853 current_kboard
->kbd_queue_has_data
= 0;
2854 input_pending
= readable_events (0);
2855 if (EVENT_HAS_PARAMETERS (c
)
2856 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2857 internal_last_event_frame
= XCAR (XCDR (c
));
2858 Vlast_event_frame
= internal_last_event_frame
;
2862 /* If current_kboard's side queue is empty check the other kboards.
2863 If one of them has data that we have not yet seen here,
2864 switch to it and process the data waiting for it.
2866 Note: if the events queued up for another kboard
2867 have already been seen here, and therefore are not a complete command,
2868 the kbd_queue_has_data field is 0, so we skip that kboard here.
2869 That's to avoid an infinite loop switching between kboards here. */
2870 if (NILP (c
) && !single_kboard
)
2873 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2874 if (kb
->kbd_queue_has_data
)
2876 current_kboard
= kb
;
2877 /* This is going to exit from read_char
2878 so we had better get rid of this frame's stuff. */
2880 return make_number (-2); /* wrong_kboard_jmpbuf */
2890 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2891 prev_event
, used_mouse_menu
);
2892 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2894 if (EQ (c
, make_number (-2)))
2896 /* This is going to exit from read_char
2897 so we had better get rid of this frame's stuff. */
2911 if (commandflag
>= 0
2912 && !input_pending
&& !detect_input_pending_run_timers (0))
2918 /* Buffer switch events are only for internal wakeups
2919 so don't show them to the user.
2920 Also, don't record a key if we already did. */
2924 /* Process special events within read_char
2925 and loop around to read another event. */
2928 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2933 struct buffer
*prev_buffer
= current_buffer
;
2934 last_input_event
= c
;
2935 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2937 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2938 /* We stopped being idle for this event; undo that. This
2939 prevents automatic window selection (under
2940 mouse_autoselect_window from acting as a real input event, for
2941 example banishing the mouse under mouse-avoidance-mode. */
2942 timer_resume_idle ();
2944 if (current_buffer
!= prev_buffer
)
2946 /* The command may have changed the keymaps. Pretend there
2947 is input in another keyboard and return. This will
2948 recalculate keymaps. */
2949 c
= make_number (-2);
2956 /* Handle things that only apply to characters. */
2959 /* If kbd_buffer_get_event gave us an EOF, return that. */
2963 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2964 && UNSIGNED_CMP (XFASTINT (c
), <,
2965 SCHARS (KVAR (current_kboard
,
2966 Vkeyboard_translate_table
))))
2967 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2968 && UNSIGNED_CMP (XFASTINT (c
), <,
2969 ASIZE (KVAR (current_kboard
,
2970 Vkeyboard_translate_table
))))
2971 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2975 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2976 /* nil in keyboard-translate-table means no translation. */
2982 /* If this event is a mouse click in the menu bar,
2983 return just menu-bar for now. Modify the mouse click event
2984 so we won't do this twice, then queue it up. */
2985 if (EVENT_HAS_PARAMETERS (c
)
2987 && CONSP (EVENT_START (c
))
2988 && CONSP (XCDR (EVENT_START (c
))))
2992 posn
= POSN_POSN (EVENT_START (c
));
2993 /* Handle menu-bar events:
2994 insert the dummy prefix event `menu-bar'. */
2995 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2997 /* Change menu-bar to (menu-bar) as the event "position". */
2998 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3001 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3006 /* Store these characters into recent_keys, the dribble file if any,
3007 and the keyboard macro being defined, if any. */
3009 if (! NILP (also_record
))
3010 record_char (also_record
);
3012 /* Wipe the echo area.
3013 But first, if we are about to use an input method,
3014 save the echo area contents for it to refer to. */
3016 && ! NILP (Vinput_method_function
)
3017 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3019 previous_echo_area_message
= Fcurrent_message ();
3020 Vinput_method_previous_message
= previous_echo_area_message
;
3023 /* Now wipe the echo area, except for help events which do their
3024 own stuff with the echo area. */
3026 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3027 && !(EQ (Qswitch_frame
, XCAR (c
)))
3028 /* Don't wipe echo area for select window events: These might
3029 get delayed via `mouse-autoselect-window' (Bug#11304). */
3030 && !(EQ (Qselect_window
, XCAR (c
)))))
3032 if (!NILP (echo_area_buffer
[0]))
3034 safe_run_hooks (Qecho_area_clear_hook
);
3035 clear_message (1, 0);
3039 reread_for_input_method
:
3041 /* Pass this to the input method, if appropriate. */
3043 && ! NILP (Vinput_method_function
)
3044 /* Don't run the input method within a key sequence,
3045 after the first event of the key sequence. */
3046 && NILP (prev_event
)
3047 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3050 ptrdiff_t key_count
;
3051 bool key_count_reset
;
3052 struct gcpro gcpro1
;
3053 ptrdiff_t count
= SPECPDL_INDEX ();
3055 /* Save the echo status. */
3056 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3057 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3058 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3059 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3062 if (before_command_restore_flag
)
3064 this_command_key_count
= before_command_key_count_1
;
3065 if (this_command_key_count
< this_single_command_key_start
)
3066 this_single_command_key_start
= this_command_key_count
;
3067 echo_truncate (before_command_echo_length_1
);
3068 before_command_restore_flag
= 0;
3072 /* Save the this_command_keys status. */
3073 key_count
= this_command_key_count
;
3074 key_count_reset
= this_command_key_count_reset
;
3077 keys
= Fcopy_sequence (this_command_keys
);
3082 /* Clear out this_command_keys. */
3083 this_command_key_count
= 0;
3084 this_command_key_count_reset
= 0;
3086 /* Now wipe the echo area. */
3087 if (!NILP (echo_area_buffer
[0]))
3088 safe_run_hooks (Qecho_area_clear_hook
);
3089 clear_message (1, 0);
3092 /* If we are not reading a key sequence,
3093 never use the echo area. */
3096 specbind (Qinput_method_use_echo_area
, Qt
);
3099 /* Call the input method. */
3100 tem
= call1 (Vinput_method_function
, c
);
3102 tem
= unbind_to (count
, tem
);
3104 /* Restore the saved echoing state
3105 and this_command_keys state. */
3106 this_command_key_count
= key_count
;
3107 this_command_key_count_reset
= key_count_reset
;
3109 this_command_keys
= keys
;
3112 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3113 kset_echo_string (current_kboard
, saved_echo_string
);
3114 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3115 if (saved_immediate_echo
)
3120 /* The input method can return no events. */
3123 /* Bring back the previous message, if any. */
3124 if (! NILP (previous_echo_area_message
))
3125 message_with_string ("%s", previous_echo_area_message
, 0);
3128 /* It returned one event or more. */
3130 Vunread_post_input_method_events
3131 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3136 /* Display help if not echoing. */
3137 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3139 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3140 Lisp_Object help
, object
, position
, window
, htem
;
3142 htem
= Fcdr (XCDR (c
));
3145 window
= Fcar (htem
);
3147 object
= Fcar (htem
);
3149 position
= Fcar (htem
);
3151 show_help_echo (help
, window
, object
, position
);
3153 /* We stopped being idle for this event; undo that. */
3155 timer_resume_idle ();
3159 if ((! reread
|| this_command_key_count
== 0
3160 || this_command_key_count_reset
)
3164 /* Don't echo mouse motion events. */
3165 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3166 && NILP (Fzerop (Vecho_keystrokes
))
3167 && ! (EVENT_HAS_PARAMETERS (c
)
3168 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3171 if (! NILP (also_record
))
3172 echo_char (also_record
);
3173 /* Once we reread a character, echoing can happen
3174 the next time we pause to read a new one. */
3175 ok_to_echo_at_next_pause
= current_kboard
;
3178 /* Record this character as part of the current key. */
3179 add_command_key (c
);
3180 if (! NILP (also_record
))
3181 add_command_key (also_record
);
3184 last_input_event
= c
;
3187 /* Process the help character specially if enabled. */
3188 if (!NILP (Vhelp_form
) && help_char_p (c
))
3190 ptrdiff_t count
= SPECPDL_INDEX ();
3192 help_form_saved_window_configs
3193 = Fcons (Fcurrent_window_configuration (Qnil
),
3194 help_form_saved_window_configs
);
3195 record_unwind_protect_void (read_char_help_form_unwind
);
3196 call0 (Qhelp_form_show
);
3201 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3202 if (EVENT_HAS_PARAMETERS (c
)
3203 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3204 XSETCAR (help_form_saved_window_configs
, Qnil
);
3206 while (BUFFERP (c
));
3207 /* Remove the help from the frame. */
3208 unbind_to (count
, Qnil
);
3211 if (EQ (c
, make_number (040)))
3215 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3216 while (BUFFERP (c
));
3227 /* Record a key that came from a mouse menu.
3228 Record it for echoing, for this-command-keys, and so on. */
3231 record_menu_key (Lisp_Object c
)
3233 /* Wipe the echo area. */
3234 clear_message (1, 0);
3239 before_command_key_count
= this_command_key_count
;
3240 before_command_echo_length
= echo_length ();
3243 /* Don't echo mouse motion events. */
3244 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3245 && NILP (Fzerop (Vecho_keystrokes
)))
3249 /* Once we reread a character, echoing can happen
3250 the next time we pause to read a new one. */
3251 ok_to_echo_at_next_pause
= 0;
3254 /* Record this character as part of the current key. */
3255 add_command_key (c
);
3257 /* Re-reading in the middle of a command */
3258 last_input_event
= c
;
3262 #endif /* HAVE_MENUS */
3264 /* Return true if should recognize C as "the help character". */
3267 help_char_p (Lisp_Object c
)
3271 if (EQ (c
, Vhelp_char
))
3273 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3274 if (EQ (c
, XCAR (tail
)))
3279 /* Record the input event C in various ways. */
3282 record_char (Lisp_Object c
)
3286 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3288 /* To avoid filling recent_keys with help-echo and mouse-movement
3289 events, we filter out repeated help-echo events, only store the
3290 first and last in a series of mouse-movement events, and don't
3291 store repeated help-echo events which are only separated by
3292 mouse-movement events. */
3294 Lisp_Object ev1
, ev2
, ev3
;
3297 if ((ix1
= recent_keys_index
- 1) < 0)
3298 ix1
= NUM_RECENT_KEYS
- 1;
3299 ev1
= AREF (recent_keys
, ix1
);
3301 if ((ix2
= ix1
- 1) < 0)
3302 ix2
= NUM_RECENT_KEYS
- 1;
3303 ev2
= AREF (recent_keys
, ix2
);
3305 if ((ix3
= ix2
- 1) < 0)
3306 ix3
= NUM_RECENT_KEYS
- 1;
3307 ev3
= AREF (recent_keys
, ix3
);
3309 if (EQ (XCAR (c
), Qhelp_echo
))
3311 /* Don't record `help-echo' in recent_keys unless it shows some help
3312 message, and a different help than the previously recorded
3314 Lisp_Object help
, last_help
;
3316 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3317 if (!STRINGP (help
))
3319 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3320 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3322 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3323 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3324 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3326 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3327 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3328 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3329 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3332 else if (EQ (XCAR (c
), Qmouse_movement
))
3334 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3335 So additional mouse movement events replace the last element. */
3336 Lisp_Object last_window
, window
;
3338 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3339 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3340 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3341 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3342 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3344 ASET (recent_keys
, ix1
, c
);
3350 store_kbd_macro_char (c
);
3354 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3355 ASET (recent_keys
, recent_keys_index
, c
);
3356 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3357 recent_keys_index
= 0;
3359 else if (recorded
< 0)
3361 /* We need to remove one or two events from recent_keys.
3362 To do this, we simply put nil at those events and move the
3363 recent_keys_index backwards over those events. Usually,
3364 users will never see those nil events, as they will be
3365 overwritten by the command keys entered to see recent_keys
3368 while (recorded
++ < 0 && total_keys
> 0)
3370 if (total_keys
< NUM_RECENT_KEYS
)
3372 if (--recent_keys_index
< 0)
3373 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3374 ASET (recent_keys
, recent_keys_index
, Qnil
);
3378 num_nonmacro_input_events
++;
3380 /* Write c to the dribble file. If c is a lispy event, write
3381 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3382 If you, dear reader, have a better idea, you've got the source. :-) */
3388 if (XUINT (c
) < 0x100)
3389 putc (XUINT (c
), dribble
);
3391 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3395 Lisp_Object dribblee
;
3397 /* If it's a structured event, take the event header. */
3398 dribblee
= EVENT_HEAD (c
);
3400 if (SYMBOLP (dribblee
))
3402 putc ('<', dribble
);
3403 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3404 SBYTES (SYMBOL_NAME (dribblee
)),
3406 putc ('>', dribble
);
3415 /* Copy out or in the info on where C-g should throw to.
3416 This is used when running Lisp code from within get_char,
3417 in case get_char is called recursively.
3418 See read_process_output. */
3421 save_getcjmp (sys_jmp_buf temp
)
3423 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3427 restore_getcjmp (sys_jmp_buf temp
)
3429 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3432 /* Low level keyboard/mouse input.
3433 kbd_buffer_store_event places events in kbd_buffer, and
3434 kbd_buffer_get_event retrieves them. */
3436 /* Return true if there are any events in the queue that read-char
3437 would return. If this returns false, a read-char would block. */
3439 readable_events (int flags
)
3441 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3444 /* If the buffer contains only FOCUS_IN_EVENT events, and
3445 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3446 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3448 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3449 #ifdef USE_TOOLKIT_SCROLL_BARS
3450 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3454 struct input_event
*event
;
3456 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3463 #ifdef USE_TOOLKIT_SCROLL_BARS
3464 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3466 event
->kind
== FOCUS_IN_EVENT
)
3467 #ifdef USE_TOOLKIT_SCROLL_BARS
3468 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3469 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3470 && event
->part
== scroll_bar_handle
3471 && event
->modifiers
== 0)
3476 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3479 while (event
!= kbd_store_ptr
);
3485 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3486 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3490 if (current_kboard
->kbd_queue_has_data
)
3496 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3497 if (kb
->kbd_queue_has_data
)
3503 /* Set this for debugging, to have a way to get out */
3504 int stop_character EXTERNALLY_VISIBLE
;
3507 event_to_kboard (struct input_event
*event
)
3509 /* Not applicable for these special events. */
3510 if (event
->kind
== SELECTION_REQUEST_EVENT
3511 || event
->kind
== SELECTION_CLEAR_EVENT
)
3515 Lisp_Object obj
= event
->frame_or_window
;
3516 /* There are some events that set this field to nil or string. */
3518 obj
= WINDOW_FRAME (XWINDOW (obj
));
3519 /* Also ignore dead frames here. */
3520 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3521 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3526 /* Return the number of slots occupied in kbd_buffer. */
3529 kbd_buffer_nr_stored (void)
3531 return kbd_fetch_ptr
== kbd_store_ptr
3533 : (kbd_fetch_ptr
< kbd_store_ptr
3534 ? kbd_store_ptr
- kbd_fetch_ptr
3535 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3536 + (kbd_store_ptr
- kbd_buffer
)));
3538 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3541 kbd_buffer_store_event (register struct input_event
*event
)
3543 kbd_buffer_store_event_hold (event
, 0);
3546 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3548 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3549 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3550 Else, if EVENT is a quit event, store the quit event
3551 in HOLD_QUIT, and return (thus ignoring further events).
3553 This is used to postpone the processing of the quit event until all
3554 subsequent input events have been parsed (and discarded). */
3557 kbd_buffer_store_event_hold (register struct input_event
*event
,
3558 struct input_event
*hold_quit
)
3560 if (event
->kind
== NO_EVENT
)
3563 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3566 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3568 register int c
= event
->code
& 0377;
3570 if (event
->modifiers
& ctrl_modifier
)
3571 c
= make_ctrl_char (c
);
3573 c
|= (event
->modifiers
3574 & (meta_modifier
| alt_modifier
3575 | hyper_modifier
| super_modifier
));
3579 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3580 struct input_event
*sp
;
3582 if (single_kboard
&& kb
!= current_kboard
)
3585 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3587 kb
->kbd_queue_has_data
= 1;
3588 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3590 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3593 if (event_to_kboard (sp
) == kb
)
3595 sp
->kind
= NO_EVENT
;
3596 sp
->frame_or_window
= Qnil
;
3605 *hold_quit
= *event
;
3609 /* If this results in a quit_char being returned to Emacs as
3610 input, set Vlast_event_frame properly. If this doesn't
3611 get returned to Emacs as an event, the next event read
3612 will set Vlast_event_frame again, so this is safe to do. */
3616 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3618 focus
= event
->frame_or_window
;
3619 internal_last_event_frame
= focus
;
3620 Vlast_event_frame
= focus
;
3623 handle_interrupt (0);
3627 if (c
&& c
== stop_character
)
3633 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3634 Just ignore the second one. */
3635 else if (event
->kind
== BUFFER_SWITCH_EVENT
3636 && kbd_fetch_ptr
!= kbd_store_ptr
3637 && ((kbd_store_ptr
== kbd_buffer
3638 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3639 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3642 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3643 kbd_store_ptr
= kbd_buffer
;
3645 /* Don't let the very last slot in the buffer become full,
3646 since that would make the two pointers equal,
3647 and that is indistinguishable from an empty buffer.
3648 Discard the event if it would fill the last slot. */
3649 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3651 *kbd_store_ptr
= *event
;
3654 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3656 /* Don't read keyboard input until we have processed kbd_buffer.
3657 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3658 hold_keyboard_input ();
3659 if (!noninteractive
)
3663 #endif /* subprocesses */
3666 /* If we're inside while-no-input, and this event qualifies
3667 as input, set quit-flag to cause an interrupt. */
3668 if (!NILP (Vthrow_on_input
)
3669 && event
->kind
!= FOCUS_IN_EVENT
3670 && event
->kind
!= HELP_EVENT
3671 && event
->kind
!= DEICONIFY_EVENT
)
3673 Vquit_flag
= Vthrow_on_input
;
3674 /* If we're inside a function that wants immediate quits,
3676 if (immediate_quit
&& NILP (Vinhibit_quit
))
3685 /* Put an input event back in the head of the event queue. */
3688 kbd_buffer_unget_event (register struct input_event
*event
)
3690 if (kbd_fetch_ptr
== kbd_buffer
)
3691 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3693 /* Don't let the very last slot in the buffer become full, */
3694 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3697 *kbd_fetch_ptr
= *event
;
3702 /* Generate a HELP_EVENT input_event and store it in the keyboard
3705 HELP is the help form.
3707 FRAME and WINDOW are the frame and window where the help is
3708 generated. OBJECT is the Lisp object where the help was found (a
3709 buffer, a string, an overlay, or nil if neither from a string nor
3710 from a buffer). POS is the position within OBJECT where the help
3714 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3715 Lisp_Object object
, ptrdiff_t pos
)
3717 struct input_event event
;
3721 event
.kind
= HELP_EVENT
;
3722 event
.frame_or_window
= frame
;
3724 event
.x
= WINDOWP (window
) ? window
: frame
;
3727 kbd_buffer_store_event (&event
);
3731 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3734 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3736 struct input_event event
;
3738 event
.kind
= HELP_EVENT
;
3739 event
.frame_or_window
= frame
;
3744 kbd_buffer_store_event (&event
);
3748 /* Discard any mouse events in the event buffer by setting them to
3751 discard_mouse_events (void)
3753 struct input_event
*sp
;
3754 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3756 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3759 if (sp
->kind
== MOUSE_CLICK_EVENT
3760 || sp
->kind
== WHEEL_EVENT
3761 || sp
->kind
== HORIZ_WHEEL_EVENT
3763 || sp
->kind
== GPM_CLICK_EVENT
3765 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3767 sp
->kind
= NO_EVENT
;
3773 /* Return true if there are any real events waiting in the event
3774 buffer, not counting `NO_EVENT's.
3776 Discard NO_EVENT events at the front of the input queue, possibly
3777 leaving the input queue empty if there are no real input events. */
3780 kbd_buffer_events_waiting (void)
3782 struct input_event
*sp
;
3784 for (sp
= kbd_fetch_ptr
;
3785 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3788 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3793 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3797 /* Clear input event EVENT. */
3800 clear_event (struct input_event
*event
)
3802 event
->kind
= NO_EVENT
;
3806 /* Read one event from the event buffer, waiting if necessary.
3807 The value is a Lisp object representing the event.
3808 The value is nil for an event that should be ignored,
3809 or that was handled here.
3810 We always read and discard one event. */
3813 kbd_buffer_get_event (KBOARD
**kbp
,
3814 bool *used_mouse_menu
,
3815 struct timespec
*end_time
)
3820 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3822 /* Start reading input again because we have processed enough to
3823 be able to accept new events again. */
3824 unhold_keyboard_input ();
3827 #endif /* subprocesses */
3829 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3831 /* In case we are running as a daemon, only do this before
3832 detaching from the terminal. */
3833 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3837 *kbp
= current_kboard
;
3840 #endif /* ! HAVE_DBUS */
3842 /* Wait until there is input available. */
3845 /* Break loop if there's an unread command event. Needed in
3846 moused window autoselection which uses a timer to insert such
3848 if (CONSP (Vunread_command_events
))
3851 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3853 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3856 /* If the quit flag is set, then read_char will return
3857 quit_char, so that counts as "available input." */
3858 if (!NILP (Vquit_flag
))
3859 quit_throw_to_read_char (0);
3861 /* One way or another, wait until input is available; then, if
3862 interrupt handlers have not read it, read it now. */
3867 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3869 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3873 struct timespec now
= current_timespec ();
3874 if (timespec_cmp (*end_time
, now
) <= 0)
3875 return Qnil
; /* Finished waiting. */
3878 struct timespec duration
= timespec_sub (*end_time
, now
);
3879 wait_reading_process_output (min (duration
.tv_sec
,
3882 -1, 1, Qnil
, NULL
, 0);
3887 bool do_display
= true;
3889 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3891 struct tty_display_info
*tty
= CURTTY ();
3893 /* When this TTY is displaying a menu, we must prevent
3894 any redisplay, because we modify the frame's glyph
3895 matrix behind the back of the display engine. */
3896 if (tty
->showing_menu
)
3900 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3903 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3907 if (CONSP (Vunread_command_events
))
3910 first
= XCAR (Vunread_command_events
);
3911 Vunread_command_events
= XCDR (Vunread_command_events
);
3912 *kbp
= current_kboard
;
3916 /* At this point, we know that there is a readable event available
3917 somewhere. If the event queue is empty, then there must be a
3918 mouse movement enabled and available. */
3919 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3921 struct input_event
*event
;
3923 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3927 *kbp
= event_to_kboard (event
);
3929 *kbp
= current_kboard
; /* Better than returning null ptr? */
3933 /* These two kinds of events get special handling
3934 and don't actually appear to the command loop.
3935 We return nil for them. */
3936 if (event
->kind
== SELECTION_REQUEST_EVENT
3937 || event
->kind
== SELECTION_CLEAR_EVENT
)
3940 struct input_event copy
;
3942 /* Remove it from the buffer before processing it,
3943 since otherwise swallow_events will see it
3944 and process it again. */
3946 kbd_fetch_ptr
= event
+ 1;
3947 input_pending
= readable_events (0);
3948 x_handle_selection_event (©
);
3950 /* We're getting selection request events, but we don't have
3956 #if defined (HAVE_NS)
3957 else if (event
->kind
== NS_TEXT_EVENT
)
3959 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3960 obj
= list1 (intern ("ns-put-working-text"));
3962 obj
= list1 (intern ("ns-unput-working-text"));
3963 kbd_fetch_ptr
= event
+ 1;
3964 if (used_mouse_menu
)
3965 *used_mouse_menu
= 1;
3969 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3970 || defined (HAVE_NS)
3971 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3973 /* Make an event (delete-frame (FRAME)). */
3974 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3975 kbd_fetch_ptr
= event
+ 1;
3978 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3979 || defined (HAVE_NS)
3980 else if (event
->kind
== ICONIFY_EVENT
)
3982 /* Make an event (iconify-frame (FRAME)). */
3983 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3984 kbd_fetch_ptr
= event
+ 1;
3986 else if (event
->kind
== DEICONIFY_EVENT
)
3988 /* Make an event (make-frame-visible (FRAME)). */
3989 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3990 kbd_fetch_ptr
= event
+ 1;
3993 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3995 /* The value doesn't matter here; only the type is tested. */
3996 XSETBUFFER (obj
, current_buffer
);
3997 kbd_fetch_ptr
= event
+ 1;
3999 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4000 || defined (HAVE_NS) || defined (USE_GTK)
4001 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4003 kbd_fetch_ptr
= event
+ 1;
4004 input_pending
= readable_events (0);
4005 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4006 x_activate_menubar (XFRAME (event
->frame_or_window
));
4010 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4012 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4013 obj
= list4 (Qlanguage_change
,
4014 event
->frame_or_window
,
4015 make_number (event
->code
),
4016 make_number (event
->modifiers
));
4017 kbd_fetch_ptr
= event
+ 1;
4020 #ifdef USE_FILE_NOTIFY
4021 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4023 #ifdef HAVE_W32NOTIFY
4024 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4025 obj
= list3 (Qfile_notify
,
4026 list3 (make_number (event
->code
),
4029 event
->frame_or_window
);
4031 obj
= make_lispy_event (event
);
4033 kbd_fetch_ptr
= event
+ 1;
4035 #endif /* USE_FILE_NOTIFY */
4036 else if (event
->kind
== SAVE_SESSION_EVENT
)
4038 obj
= list2 (Qsave_session
, event
->arg
);
4039 kbd_fetch_ptr
= event
+ 1;
4041 /* Just discard these, by returning nil.
4042 With MULTI_KBOARD, these events are used as placeholders
4043 when we need to randomly delete events from the queue.
4044 (They shouldn't otherwise be found in the buffer,
4045 but on some machines it appears they do show up
4046 even without MULTI_KBOARD.) */
4047 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4048 mouse events during a popup-menu call. */
4049 else if (event
->kind
== NO_EVENT
)
4050 kbd_fetch_ptr
= event
+ 1;
4051 else if (event
->kind
== HELP_EVENT
)
4053 Lisp_Object object
, position
, help
, frame
, window
;
4055 frame
= event
->frame_or_window
;
4056 object
= event
->arg
;
4057 position
= make_number (event
->code
);
4060 clear_event (event
);
4062 kbd_fetch_ptr
= event
+ 1;
4063 if (!WINDOWP (window
))
4065 obj
= Fcons (Qhelp_echo
,
4066 list5 (frame
, help
, window
, object
, position
));
4068 else if (event
->kind
== FOCUS_IN_EVENT
)
4070 /* Notification of a FocusIn event. The frame receiving the
4071 focus is in event->frame_or_window. Generate a
4072 switch-frame event if necessary. */
4073 Lisp_Object frame
, focus
;
4075 frame
= event
->frame_or_window
;
4076 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4085 !EQ (frame
, internal_last_event_frame
)
4086 && !EQ (frame
, selected_frame
))
4087 obj
= make_lispy_switch_frame (frame
);
4089 obj
= make_lispy_focus_in (frame
);
4091 internal_last_event_frame
= frame
;
4092 kbd_fetch_ptr
= event
+ 1;
4094 else if (event
->kind
== FOCUS_OUT_EVENT
)
4096 #ifdef HAVE_WINDOW_SYSTEM
4099 Lisp_Object frame
= event
->frame_or_window
;
4100 bool focused
= false;
4102 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4103 focused
= di
->x_highlight_frame
!= 0;
4106 obj
= make_lispy_focus_out (frame
);
4108 #endif /* HAVE_WINDOW_SYSTEM */
4110 kbd_fetch_ptr
= event
+ 1;
4113 else if (event
->kind
== DBUS_EVENT
)
4115 obj
= make_lispy_event (event
);
4116 kbd_fetch_ptr
= event
+ 1;
4119 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4121 obj
= make_lispy_event (event
);
4122 kbd_fetch_ptr
= event
+ 1;
4126 /* If this event is on a different frame, return a switch-frame this
4127 time, and leave the event in the queue for next time. */
4131 frame
= event
->frame_or_window
;
4133 frame
= XCAR (frame
);
4134 else if (WINDOWP (frame
))
4135 frame
= WINDOW_FRAME (XWINDOW (frame
));
4137 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4141 if (! EQ (frame
, internal_last_event_frame
)
4142 && !EQ (frame
, selected_frame
))
4143 obj
= make_lispy_switch_frame (frame
);
4144 internal_last_event_frame
= frame
;
4146 /* If we didn't decide to make a switch-frame event, go ahead
4147 and build a real event from the queue entry. */
4151 obj
= make_lispy_event (event
);
4153 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4154 || defined (HAVE_NS) || defined (USE_GTK)
4155 /* If this was a menu selection, then set the flag to inhibit
4156 writing to last_nonmenu_event. Don't do this if the event
4157 we're returning is (menu-bar), though; that indicates the
4158 beginning of the menu sequence, and we might as well leave
4159 that as the `event with parameters' for this selection. */
4161 && !EQ (event
->frame_or_window
, event
->arg
)
4162 && (event
->kind
== MENU_BAR_EVENT
4163 || event
->kind
== TOOL_BAR_EVENT
))
4164 *used_mouse_menu
= 1;
4167 /* Certain system events are non-key events. */
4169 && event
->kind
== NS_NONKEY_EVENT
)
4170 *used_mouse_menu
= 1;
4173 /* Wipe out this event, to catch bugs. */
4174 clear_event (event
);
4175 kbd_fetch_ptr
= event
+ 1;
4179 /* Try generating a mouse motion event. */
4180 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4182 struct frame
*f
= some_mouse_moved ();
4183 Lisp_Object bar_window
;
4184 enum scroll_bar_part part
;
4188 *kbp
= current_kboard
;
4189 /* Note that this uses F to determine which terminal to look at.
4190 If there is no valid info, it does not store anything
4191 so x remains nil. */
4194 /* XXX Can f or mouse_position_hook be NULL here? */
4195 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4196 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4201 /* Decide if we should generate a switch-frame event. Don't
4202 generate switch-frame events for motion outside of all Emacs
4208 frame
= FRAME_FOCUS_FRAME (f
);
4210 XSETFRAME (frame
, f
);
4212 if (! EQ (frame
, internal_last_event_frame
)
4213 && !EQ (frame
, selected_frame
))
4214 obj
= make_lispy_switch_frame (frame
);
4215 internal_last_event_frame
= frame
;
4218 /* If we didn't decide to make a switch-frame event, go ahead and
4219 return a mouse-motion event. */
4220 if (!NILP (x
) && NILP (obj
))
4221 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4224 /* We were promised by the above while loop that there was
4225 something for us to read! */
4228 input_pending
= readable_events (0);
4230 Vlast_event_frame
= internal_last_event_frame
;
4235 /* Process any non-user-visible events (currently X selection events),
4236 without reading any user-visible events. */
4239 process_special_events (void)
4241 struct input_event
*event
;
4243 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4245 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4248 if (event
== kbd_store_ptr
)
4252 /* If we find a stored X selection request, handle it now. */
4253 if (event
->kind
== SELECTION_REQUEST_EVENT
4254 || event
->kind
== SELECTION_CLEAR_EVENT
)
4258 /* Remove the event from the fifo buffer before processing;
4259 otherwise swallow_events called recursively could see it
4260 and process it again. To do this, we move the events
4261 between kbd_fetch_ptr and EVENT one slot to the right,
4264 struct input_event copy
= *event
;
4265 struct input_event
*beg
4266 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4267 ? kbd_buffer
: kbd_fetch_ptr
;
4270 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4271 else if (event
< beg
)
4273 if (event
> kbd_buffer
)
4274 memmove (kbd_buffer
+ 1, kbd_buffer
,
4275 (event
- kbd_buffer
) * sizeof (struct input_event
));
4276 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4277 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4278 memmove (beg
+ 1, beg
,
4279 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4280 * sizeof (struct input_event
));
4283 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4284 kbd_fetch_ptr
= kbd_buffer
+ 1;
4288 input_pending
= readable_events (0);
4289 x_handle_selection_event (©
);
4291 /* We're getting selection request events, but we don't have
4299 /* Process any events that are not user-visible, run timer events that
4300 are ripe, and return, without reading any user-visible events. */
4303 swallow_events (bool do_display
)
4305 unsigned old_timers_run
;
4307 process_special_events ();
4309 old_timers_run
= timers_run
;
4310 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4312 if (timers_run
!= old_timers_run
&& do_display
)
4313 redisplay_preserve_echo_area (7);
4316 /* Record the start of when Emacs is idle,
4317 for the sake of running idle-time timers. */
4320 timer_start_idle (void)
4322 /* If we are already in the idle state, do nothing. */
4323 if (timespec_valid_p (timer_idleness_start_time
))
4326 timer_idleness_start_time
= current_timespec ();
4327 timer_last_idleness_start_time
= timer_idleness_start_time
;
4329 /* Mark all idle-time timers as once again candidates for running. */
4330 call0 (intern ("internal-timer-start-idle"));
4333 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4336 timer_stop_idle (void)
4338 timer_idleness_start_time
= invalid_timespec ();
4341 /* Resume idle timer from last idle start time. */
4344 timer_resume_idle (void)
4346 if (timespec_valid_p (timer_idleness_start_time
))
4349 timer_idleness_start_time
= timer_last_idleness_start_time
;
4352 /* This is only for debugging. */
4353 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4355 /* List of elisp functions to call, delayed because they were generated in
4356 a context where Elisp could not be safely run (e.g. redisplay, signal,
4357 ...). Each element has the form (FUN . ARGS). */
4358 Lisp_Object pending_funcalls
;
4360 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4362 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4364 Lisp_Object
*vector
;
4366 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4368 vector
= XVECTOR (timer
)->contents
;
4369 if (! NILP (vector
[0]))
4372 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4377 /* Check whether a timer has fired. To prevent larger problems we simply
4378 disregard elements that are not proper timers. Do not make a circular
4379 timer list for the time being.
4381 Returns the time to wait until the next timer fires. If a
4382 timer is triggering now, return zero.
4383 If no timer is active, return -1.
4385 If a timer is ripe, we run it, with quitting turned off.
4386 In that case we return 0 to indicate that a new timer_check_2 call
4389 static struct timespec
4390 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4392 struct timespec nexttime
;
4393 struct timespec now
;
4394 struct timespec idleness_now
;
4395 Lisp_Object chosen_timer
;
4396 struct gcpro gcpro1
;
4398 nexttime
= invalid_timespec ();
4400 chosen_timer
= Qnil
;
4401 GCPRO1 (chosen_timer
);
4403 /* First run the code that was delayed. */
4404 while (CONSP (pending_funcalls
))
4406 Lisp_Object funcall
= XCAR (pending_funcalls
);
4407 pending_funcalls
= XCDR (pending_funcalls
);
4408 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4411 if (CONSP (timers
) || CONSP (idle_timers
))
4413 now
= current_timespec ();
4414 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4415 ? timespec_sub (now
, timer_idleness_start_time
)
4416 : make_timespec (0, 0));
4419 while (CONSP (timers
) || CONSP (idle_timers
))
4421 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4422 struct timespec timer_time
, idle_timer_time
;
4423 struct timespec difference
;
4424 struct timespec timer_difference
= invalid_timespec ();
4425 struct timespec idle_timer_difference
= invalid_timespec ();
4426 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4428 /* Set TIMER and TIMER_DIFFERENCE
4429 based on the next ordinary timer.
4430 TIMER_DIFFERENCE is the distance in time from NOW to when
4431 this timer becomes ripe (negative if it's already ripe).
4432 Skip past invalid timers and timers already handled. */
4435 timer
= XCAR (timers
);
4436 if (! decode_timer (timer
, &timer_time
))
4438 timers
= XCDR (timers
);
4442 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4443 timer_difference
= (timer_ripe
4444 ? timespec_sub (now
, timer_time
)
4445 : timespec_sub (timer_time
, now
));
4448 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4449 based on the next idle timer. */
4450 if (CONSP (idle_timers
))
4452 idle_timer
= XCAR (idle_timers
);
4453 if (! decode_timer (idle_timer
, &idle_timer_time
))
4455 idle_timers
= XCDR (idle_timers
);
4459 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4460 idle_timer_difference
4462 ? timespec_sub (idleness_now
, idle_timer_time
)
4463 : timespec_sub (idle_timer_time
, idleness_now
));
4466 /* Decide which timer is the next timer,
4467 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4468 Also step down the list where we found that timer. */
4470 if (timespec_valid_p (timer_difference
)
4471 && (! timespec_valid_p (idle_timer_difference
)
4472 || idle_timer_ripe
< timer_ripe
4473 || (idle_timer_ripe
== timer_ripe
4475 ? timespec_cmp (idle_timer_difference
,
4477 : timespec_cmp (timer_difference
,
4478 idle_timer_difference
))
4481 chosen_timer
= timer
;
4482 timers
= XCDR (timers
);
4483 difference
= timer_difference
;
4488 chosen_timer
= idle_timer
;
4489 idle_timers
= XCDR (idle_timers
);
4490 difference
= idle_timer_difference
;
4491 ripe
= idle_timer_ripe
;
4494 /* If timer is ripe, run it if it hasn't been run. */
4497 if (NILP (AREF (chosen_timer
, 0)))
4499 ptrdiff_t count
= SPECPDL_INDEX ();
4500 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4502 /* Mark the timer as triggered to prevent problems if the lisp
4503 code fails to reschedule it right. */
4504 ASET (chosen_timer
, 0, Qt
);
4506 specbind (Qinhibit_quit
, Qt
);
4508 call1 (Qtimer_event_handler
, chosen_timer
);
4509 Vdeactivate_mark
= old_deactivate_mark
;
4511 unbind_to (count
, Qnil
);
4513 /* Since we have handled the event,
4514 we don't need to tell the caller to wake up and do it. */
4515 /* But the caller must still wait for the next timer, so
4516 return 0 to indicate that. */
4519 nexttime
= make_timespec (0, 0);
4523 /* When we encounter a timer that is still waiting,
4524 return the amount of time to wait before it is ripe. */
4531 /* No timers are pending in the future. */
4532 /* Return 0 if we generated an event, and -1 if not. */
4538 /* Check whether a timer has fired. To prevent larger problems we simply
4539 disregard elements that are not proper timers. Do not make a circular
4540 timer list for the time being.
4542 Returns the time to wait until the next timer fires.
4543 If no timer is active, return an invalid value.
4545 As long as any timer is ripe, we run it. */
4550 struct timespec nexttime
;
4551 Lisp_Object timers
, idle_timers
;
4552 struct gcpro gcpro1
, gcpro2
;
4554 Lisp_Object tem
= Vinhibit_quit
;
4557 /* We use copies of the timers' lists to allow a timer to add itself
4558 again, without locking up Emacs if the newly added timer is
4559 already ripe when added. */
4561 /* Always consider the ordinary timers. */
4562 timers
= Fcopy_sequence (Vtimer_list
);
4563 /* Consider the idle timers only if Emacs is idle. */
4564 if (timespec_valid_p (timer_idleness_start_time
))
4565 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4569 Vinhibit_quit
= tem
;
4571 GCPRO2 (timers
, idle_timers
);
4575 nexttime
= timer_check_2 (timers
, idle_timers
);
4577 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4583 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4584 doc
: /* Return the current length of Emacs idleness, or nil.
4585 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4586 in the same style as (current-time).
4588 The value when Emacs is not idle is nil.
4590 PSEC is a multiple of the system clock resolution. */)
4593 if (timespec_valid_p (timer_idleness_start_time
))
4594 return make_lisp_time (timespec_sub (current_timespec (),
4595 timer_idleness_start_time
));
4600 /* Caches for modify_event_symbol. */
4601 static Lisp_Object accent_key_syms
;
4602 static Lisp_Object func_key_syms
;
4603 static Lisp_Object mouse_syms
;
4604 static Lisp_Object wheel_syms
;
4605 static Lisp_Object drag_n_drop_syms
;
4607 /* This is a list of keysym codes for special "accent" characters.
4608 It parallels lispy_accent_keys. */
4610 static const int lispy_accent_codes
[] =
4612 #ifdef XK_dead_circumflex
4617 #ifdef XK_dead_grave
4622 #ifdef XK_dead_tilde
4627 #ifdef XK_dead_diaeresis
4632 #ifdef XK_dead_macron
4637 #ifdef XK_dead_degree
4642 #ifdef XK_dead_acute
4647 #ifdef XK_dead_cedilla
4652 #ifdef XK_dead_breve
4657 #ifdef XK_dead_ogonek
4662 #ifdef XK_dead_caron
4667 #ifdef XK_dead_doubleacute
4668 XK_dead_doubleacute
,
4672 #ifdef XK_dead_abovedot
4677 #ifdef XK_dead_abovering
4687 #ifdef XK_dead_belowdot
4692 #ifdef XK_dead_voiced_sound
4693 XK_dead_voiced_sound
,
4697 #ifdef XK_dead_semivoiced_sound
4698 XK_dead_semivoiced_sound
,
4714 /* This is a list of Lisp names for special "accent" characters.
4715 It parallels lispy_accent_codes. */
4717 static const char *const lispy_accent_keys
[] =
4735 "dead-voiced-sound",
4736 "dead-semivoiced-sound",
4742 #define FUNCTION_KEY_OFFSET 0x0
4744 const char *const lispy_function_keys
[] =
4748 0, /* VK_LBUTTON 0x01 */
4749 0, /* VK_RBUTTON 0x02 */
4750 "cancel", /* VK_CANCEL 0x03 */
4751 0, /* VK_MBUTTON 0x04 */
4753 0, 0, 0, /* 0x05 .. 0x07 */
4755 "backspace", /* VK_BACK 0x08 */
4756 "tab", /* VK_TAB 0x09 */
4758 0, 0, /* 0x0A .. 0x0B */
4760 "clear", /* VK_CLEAR 0x0C */
4761 "return", /* VK_RETURN 0x0D */
4763 0, 0, /* 0x0E .. 0x0F */
4765 0, /* VK_SHIFT 0x10 */
4766 0, /* VK_CONTROL 0x11 */
4767 0, /* VK_MENU 0x12 */
4768 "pause", /* VK_PAUSE 0x13 */
4769 "capslock", /* VK_CAPITAL 0x14 */
4770 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4772 "junja", /* VK_JUNJA 0x17 */
4773 "final", /* VK_FINAL 0x18 */
4774 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4776 "escape", /* VK_ESCAPE 0x1B */
4777 "convert", /* VK_CONVERT 0x1C */
4778 "non-convert", /* VK_NONCONVERT 0x1D */
4779 "accept", /* VK_ACCEPT 0x1E */
4780 "mode-change", /* VK_MODECHANGE 0x1F */
4781 0, /* VK_SPACE 0x20 */
4782 "prior", /* VK_PRIOR 0x21 */
4783 "next", /* VK_NEXT 0x22 */
4784 "end", /* VK_END 0x23 */
4785 "home", /* VK_HOME 0x24 */
4786 "left", /* VK_LEFT 0x25 */
4787 "up", /* VK_UP 0x26 */
4788 "right", /* VK_RIGHT 0x27 */
4789 "down", /* VK_DOWN 0x28 */
4790 "select", /* VK_SELECT 0x29 */
4791 "print", /* VK_PRINT 0x2A */
4792 "execute", /* VK_EXECUTE 0x2B */
4793 "snapshot", /* VK_SNAPSHOT 0x2C */
4794 "insert", /* VK_INSERT 0x2D */
4795 "delete", /* VK_DELETE 0x2E */
4796 "help", /* VK_HELP 0x2F */
4798 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4800 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4802 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4804 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4806 0, 0, 0, 0, 0, 0, 0, 0, 0,
4807 0, 0, 0, 0, 0, 0, 0, 0, 0,
4808 0, 0, 0, 0, 0, 0, 0, 0,
4810 "lwindow", /* VK_LWIN 0x5B */
4811 "rwindow", /* VK_RWIN 0x5C */
4812 "apps", /* VK_APPS 0x5D */
4815 "kp-0", /* VK_NUMPAD0 0x60 */
4816 "kp-1", /* VK_NUMPAD1 0x61 */
4817 "kp-2", /* VK_NUMPAD2 0x62 */
4818 "kp-3", /* VK_NUMPAD3 0x63 */
4819 "kp-4", /* VK_NUMPAD4 0x64 */
4820 "kp-5", /* VK_NUMPAD5 0x65 */
4821 "kp-6", /* VK_NUMPAD6 0x66 */
4822 "kp-7", /* VK_NUMPAD7 0x67 */
4823 "kp-8", /* VK_NUMPAD8 0x68 */
4824 "kp-9", /* VK_NUMPAD9 0x69 */
4825 "kp-multiply", /* VK_MULTIPLY 0x6A */
4826 "kp-add", /* VK_ADD 0x6B */
4827 "kp-separator", /* VK_SEPARATOR 0x6C */
4828 "kp-subtract", /* VK_SUBTRACT 0x6D */
4829 "kp-decimal", /* VK_DECIMAL 0x6E */
4830 "kp-divide", /* VK_DIVIDE 0x6F */
4831 "f1", /* VK_F1 0x70 */
4832 "f2", /* VK_F2 0x71 */
4833 "f3", /* VK_F3 0x72 */
4834 "f4", /* VK_F4 0x73 */
4835 "f5", /* VK_F5 0x74 */
4836 "f6", /* VK_F6 0x75 */
4837 "f7", /* VK_F7 0x76 */
4838 "f8", /* VK_F8 0x77 */
4839 "f9", /* VK_F9 0x78 */
4840 "f10", /* VK_F10 0x79 */
4841 "f11", /* VK_F11 0x7A */
4842 "f12", /* VK_F12 0x7B */
4843 "f13", /* VK_F13 0x7C */
4844 "f14", /* VK_F14 0x7D */
4845 "f15", /* VK_F15 0x7E */
4846 "f16", /* VK_F16 0x7F */
4847 "f17", /* VK_F17 0x80 */
4848 "f18", /* VK_F18 0x81 */
4849 "f19", /* VK_F19 0x82 */
4850 "f20", /* VK_F20 0x83 */
4851 "f21", /* VK_F21 0x84 */
4852 "f22", /* VK_F22 0x85 */
4853 "f23", /* VK_F23 0x86 */
4854 "f24", /* VK_F24 0x87 */
4856 0, 0, 0, 0, /* 0x88 .. 0x8B */
4857 0, 0, 0, 0, /* 0x8C .. 0x8F */
4859 "kp-numlock", /* VK_NUMLOCK 0x90 */
4860 "scroll", /* VK_SCROLL 0x91 */
4861 /* Not sure where the following block comes from.
4862 Windows headers have NEC and Fujitsu specific keys in
4863 this block, but nothing generic. */
4864 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4865 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4866 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4867 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4868 "kp-end", /* VK_NUMPAD_END 0x96 */
4869 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4870 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4871 "kp-up", /* VK_NUMPAD_UP 0x99 */
4872 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4873 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4874 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4875 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4877 0, 0, /* 0x9E .. 0x9F */
4880 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4881 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4882 * No other API or message will distinguish left and right keys this way.
4887 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4888 to enable them selectively, and gives access to a few more functions.
4889 See lispy_multimedia_keys below. */
4890 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4891 0, 0, 0, /* 0xAD .. 0xAF Volume */
4892 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4893 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4895 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4896 0, 0, 0, 0, 0, 0, 0, 0, 0,
4898 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4899 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4900 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4903 "ax", /* VK_OEM_AX 0xE1 */
4904 0, /* VK_OEM_102 0xE2 */
4905 "ico-help", /* VK_ICO_HELP 0xE3 */
4906 "ico-00", /* VK_ICO_00 0xE4 */
4907 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4908 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4909 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4911 "reset", /* VK_OEM_RESET 0xE9 */
4912 "jump", /* VK_OEM_JUMP 0xEA */
4913 "oem-pa1", /* VK_OEM_PA1 0xEB */
4914 "oem-pa2", /* VK_OEM_PA2 0xEC */
4915 "oem-pa3", /* VK_OEM_PA3 0xED */
4916 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4917 "cusel", /* VK_OEM_CUSEL 0xEF */
4918 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4919 "finish", /* VK_OEM_FINISH 0xF1 */
4920 "copy", /* VK_OEM_COPY 0xF2 */
4921 "auto", /* VK_OEM_AUTO 0xF3 */
4922 "enlw", /* VK_OEM_ENLW 0xF4 */
4923 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4924 "attn", /* VK_ATTN 0xF6 */
4925 "crsel", /* VK_CRSEL 0xF7 */
4926 "exsel", /* VK_EXSEL 0xF8 */
4927 "ereof", /* VK_EREOF 0xF9 */
4928 "play", /* VK_PLAY 0xFA */
4929 "zoom", /* VK_ZOOM 0xFB */
4930 "noname", /* VK_NONAME 0xFC */
4931 "pa1", /* VK_PA1 0xFD */
4932 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4936 /* Some of these duplicate the "Media keys" on newer keyboards,
4937 but they are delivered to the application in a different way. */
4938 static const char *const lispy_multimedia_keys
[] =
4946 "browser-favorites",
4983 "toggle-dictate-command",
4989 "media-fast-forward",
4992 "media-channel-down"
4995 #else /* not HAVE_NTGUI */
4997 /* This should be dealt with in XTread_socket now, and that doesn't
4998 depend on the client system having the Kana syms defined. See also
4999 the XK_kana_A case below. */
5002 static const char *const lispy_kana_keys
[] =
5004 /* X Keysym value */
5005 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5006 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5007 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5008 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5009 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5010 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5011 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5012 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5013 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5014 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5015 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5016 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5017 "kana-i", "kana-u", "kana-e", "kana-o",
5018 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5019 "prolongedsound", "kana-A", "kana-I", "kana-U",
5020 "kana-E", "kana-O", "kana-KA", "kana-KI",
5021 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5022 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5023 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5024 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5025 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5026 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5027 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5028 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5029 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5030 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5031 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5032 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5034 #endif /* XK_kana_A */
5037 #define FUNCTION_KEY_OFFSET 0xff00
5039 /* You'll notice that this table is arranged to be conveniently
5040 indexed by X Windows keysym values. */
5041 static const char *const lispy_function_keys
[] =
5043 /* X Keysym value */
5045 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5046 "backspace", "tab", "linefeed", "clear",
5048 0, 0, 0, "pause", /* 0xff10...1f */
5049 0, 0, 0, 0, 0, 0, 0, "escape",
5051 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5052 "romaji", "hiragana", "katakana", "hiragana-katakana",
5053 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5054 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5055 "eisu-toggle", /* 0xff30...3f */
5056 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5057 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5059 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5060 "down", "prior", "next", "end",
5061 "begin", 0, 0, 0, 0, 0, 0, 0,
5062 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5073 "break", /* 0xff6b */
5076 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5077 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5078 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5079 0, 0, 0, 0, 0, 0, 0, 0,
5080 "kp-tab", /* 0xff89 */
5082 "kp-enter", /* 0xff8d */
5084 "kp-f1", /* 0xff91 */
5088 "kp-home", /* 0xff95 */
5093 "kp-prior", /* kp-page-up */
5094 "kp-next", /* kp-page-down */
5100 0, 0, 0, 0, 0, 0, 0, 0, 0,
5101 "kp-multiply", /* 0xffaa */
5106 "kp-divide", /* 0xffaf */
5107 "kp-0", /* 0xffb0 */
5108 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5111 "kp-equal", /* 0xffbd */
5112 "f1", /* 0xffbe */ /* IsFunctionKey */
5114 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5115 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5116 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5117 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5118 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5119 0, 0, 0, 0, 0, 0, 0, 0,
5120 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5121 0, 0, 0, 0, 0, 0, 0, "delete"
5124 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5125 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5127 static const char *const iso_lispy_function_keys
[] =
5129 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5130 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5131 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5132 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5133 "iso-lefttab", /* 0xfe20 */
5134 "iso-move-line-up", "iso-move-line-down",
5135 "iso-partial-line-up", "iso-partial-line-down",
5136 "iso-partial-space-left", "iso-partial-space-right",
5137 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5138 "iso-release-margin-left", "iso-release-margin-right",
5139 "iso-release-both-margins",
5140 "iso-fast-cursor-left", "iso-fast-cursor-right",
5141 "iso-fast-cursor-up", "iso-fast-cursor-down",
5142 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5143 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5146 #endif /* not HAVE_NTGUI */
5148 static Lisp_Object Vlispy_mouse_stem
;
5150 static const char *const lispy_wheel_names
[] =
5152 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5155 /* drag-n-drop events are generated when a set of selected files are
5156 dragged from another application and dropped onto an Emacs window. */
5157 static const char *const lispy_drag_n_drop_names
[] =
5162 /* Scroll bar parts. */
5163 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5164 Lisp_Object Qup
, Qdown
, Qbottom
;
5165 static Lisp_Object Qend_scroll
;
5167 static Lisp_Object Qratio
;
5169 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5170 static Lisp_Object
*const scroll_bar_parts
[] = {
5171 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5172 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5175 /* A vector, indexed by button number, giving the down-going location
5176 of currently depressed buttons, both scroll bar and non-scroll bar.
5178 The elements have the form
5179 (BUTTON-NUMBER MODIFIER-MASK . REST)
5180 where REST is the cdr of a position as it would be reported in the event.
5182 The make_lispy_event function stores positions here to tell the
5183 difference between click and drag events, and to store the starting
5184 location to be included in drag events. */
5186 static Lisp_Object button_down_location
;
5188 /* Information about the most recent up-going button event: Which
5189 button, what location, and what time. */
5191 static int last_mouse_button
;
5192 static int last_mouse_x
;
5193 static int last_mouse_y
;
5194 static Time button_down_time
;
5196 /* The number of clicks in this multiple-click. */
5198 static int double_click_count
;
5200 /* X and Y are frame-relative coordinates for a click or wheel event.
5201 Return a Lisp-style event list. */
5204 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5207 enum window_part part
;
5208 Lisp_Object posn
= Qnil
;
5209 Lisp_Object extra_info
= Qnil
;
5210 /* Coordinate pixel positions to return. */
5211 int xret
= 0, yret
= 0;
5212 /* The window under frame pixel coordinates (x,y) */
5213 Lisp_Object window
= f
5214 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5217 if (WINDOWP (window
))
5219 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5220 struct window
*w
= XWINDOW (window
);
5221 Lisp_Object string_info
= Qnil
;
5222 ptrdiff_t textpos
= -1;
5223 int col
= -1, row
= -1;
5224 int dx
= -1, dy
= -1;
5225 int width
= -1, height
= -1;
5226 Lisp_Object object
= Qnil
;
5228 /* Pixel coordinates relative to the window corner. */
5229 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5230 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5232 /* For text area clicks, return X, Y relative to the corner of
5233 this text area. Note that dX, dY etc are set below, by
5234 buffer_posn_from_coords. */
5235 if (part
== ON_TEXT
)
5237 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5238 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5240 /* For mode line and header line clicks, return X, Y relative to
5241 the left window edge. Use mode_line_string to look for a
5242 string on the click position. */
5243 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5248 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5249 /* Note that mode_line_string takes COL, ROW as pixels and
5250 converts them to characters. */
5253 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5254 &object
, &dx
, &dy
, &width
, &height
);
5255 if (STRINGP (string
))
5256 string_info
= Fcons (string
, make_number (charpos
));
5257 textpos
= (w
== XWINDOW (selected_window
)
5258 && current_buffer
== XBUFFER (w
->contents
))
5259 ? PT
: marker_position (w
->pointm
);
5264 /* For fringes and margins, Y is relative to the area's (and the
5265 window's) top edge, while X is meaningless. */
5266 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5271 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5274 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5275 &object
, &dx
, &dy
, &width
, &height
);
5276 if (STRINGP (string
))
5277 string_info
= Fcons (string
, make_number (charpos
));
5278 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5280 else if (part
== ON_LEFT_FRINGE
)
5282 posn
= Qleft_fringe
;
5285 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5286 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5287 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5289 else if (part
== ON_RIGHT_FRINGE
)
5291 posn
= Qright_fringe
;
5294 - window_box_width (w
, LEFT_MARGIN_AREA
)
5295 - window_box_width (w
, TEXT_AREA
)
5296 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5297 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5299 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5301 else if (part
== ON_VERTICAL_BORDER
)
5303 posn
= Qvertical_line
;
5308 /* Nothing special for part == ON_SCROLL_BAR. */
5310 /* For clicks in the text area, fringes, or margins, call
5311 buffer_posn_from_coords to extract TEXTPOS, the buffer
5312 position nearest to the click. */
5315 Lisp_Object string2
, object2
= Qnil
;
5316 struct display_pos p
;
5318 int width2
, height2
;
5319 /* The pixel X coordinate passed to buffer_posn_from_coords
5320 is the X coordinate relative to the text area for
5321 text-area and right-margin clicks, zero otherwise. */
5323 = (part
== ON_TEXT
) ? xret
5324 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5325 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5329 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5330 &object2
, &dx2
, &dy2
,
5332 textpos
= CHARPOS (p
.pos
);
5333 if (col
< 0) col
= x2
;
5334 if (row
< 0) row
= y2
;
5335 if (dx
< 0) dx
= dx2
;
5336 if (dy
< 0) dy
= dy2
;
5337 if (width
< 0) width
= width2
;
5338 if (height
< 0) height
= height2
;
5342 posn
= make_number (textpos
);
5343 if (STRINGP (string2
))
5344 string_info
= Fcons (string2
,
5345 make_number (CHARPOS (p
.string_pos
)));
5351 #ifdef HAVE_WINDOW_SYSTEM
5352 if (IMAGEP (object
))
5354 Lisp_Object image_map
, hotspot
;
5355 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5357 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5359 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5360 posn
= XCAR (hotspot
);
5367 Fcons (make_number (dx
), make_number (dy
)),
5368 Fcons (make_number (width
), make_number (height
)));
5371 extra_info
= Fcons (string_info
,
5372 Fcons (make_number (textpos
),
5373 Fcons (Fcons (make_number (col
),
5378 XSETFRAME (window
, f
);
5382 return Fcons (window
,
5384 Fcons (Fcons (make_number (xret
),
5385 make_number (yret
)),
5386 Fcons (make_number (t
),
5390 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5391 menu bar. This really means that Emacs draws and manages the menu
5392 bar as part of its normal display, and therefore can compute its
5395 toolkit_menubar_in_use (struct frame
*f
)
5397 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5398 return !(!FRAME_WINDOW_P (f
));
5404 /* Given a struct input_event, build the lisp event which represents
5405 it. If EVENT is 0, build a mouse movement event from the mouse
5406 movement buffer, which should have a movement event in it.
5408 Note that events must be passed to this function in the order they
5409 are received; this function stores the location of button presses
5410 in order to build drag events when the button is released. */
5413 make_lispy_event (struct input_event
*event
)
5417 switch (event
->kind
)
5419 /* A simple keystroke. */
5420 case ASCII_KEYSTROKE_EVENT
:
5421 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5423 Lisp_Object lispy_c
;
5424 EMACS_INT c
= event
->code
;
5425 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5428 eassert (c
== event
->code
);
5429 /* Turn ASCII characters into control characters
5431 if (event
->modifiers
& ctrl_modifier
)
5433 c
= make_ctrl_char (c
);
5434 event
->modifiers
&= ~ctrl_modifier
;
5438 /* Add in the other modifier bits. The shift key was taken care
5439 of by the X code. */
5440 c
|= (event
->modifiers
5441 & (meta_modifier
| alt_modifier
5442 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5443 /* Distinguish Shift-SPC from SPC. */
5444 if ((event
->code
) == 040
5445 && event
->modifiers
& shift_modifier
)
5446 c
|= shift_modifier
;
5447 button_down_time
= 0;
5448 XSETFASTINT (lispy_c
, c
);
5453 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5454 except that they are non-key events (last-nonmenu-event is nil). */
5455 case NS_NONKEY_EVENT
:
5458 /* A function key. The symbol may need to have modifier prefixes
5460 case NON_ASCII_KEYSTROKE_EVENT
:
5461 button_down_time
= 0;
5463 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5464 if (event
->code
== lispy_accent_codes
[i
])
5465 return modify_event_symbol (i
,
5467 Qfunction_key
, Qnil
,
5468 lispy_accent_keys
, &accent_key_syms
,
5469 (sizeof (lispy_accent_keys
)
5470 / sizeof (lispy_accent_keys
[0])));
5474 if (event
->code
>= 0x400 && event
->code
< 0x500)
5475 return modify_event_symbol (event
->code
- 0x400,
5476 event
->modifiers
& ~shift_modifier
,
5477 Qfunction_key
, Qnil
,
5478 lispy_kana_keys
, &func_key_syms
,
5479 (sizeof (lispy_kana_keys
)
5480 / sizeof (lispy_kana_keys
[0])));
5481 #endif /* XK_kana_A */
5484 #ifdef ISO_FUNCTION_KEY_OFFSET
5485 if (event
->code
< FUNCTION_KEY_OFFSET
5486 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5487 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5489 Qfunction_key
, Qnil
,
5490 iso_lispy_function_keys
, &func_key_syms
,
5491 (sizeof (iso_lispy_function_keys
)
5492 / sizeof (iso_lispy_function_keys
[0])));
5495 /* Handle system-specific or unknown keysyms. */
5496 if (event
->code
& (1 << 28)
5497 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5498 || (event
->code
- FUNCTION_KEY_OFFSET
5499 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5500 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5502 /* We need to use an alist rather than a vector as the cache
5503 since we can't make a vector long enough. */
5504 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5505 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5506 return modify_event_symbol (event
->code
,
5509 KVAR (current_kboard
, Vsystem_key_alist
),
5510 0, &KVAR (current_kboard
, system_key_syms
),
5514 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5516 Qfunction_key
, Qnil
,
5517 lispy_function_keys
, &func_key_syms
,
5518 (sizeof (lispy_function_keys
)
5519 / sizeof (lispy_function_keys
[0])));
5522 case MULTIMEDIA_KEY_EVENT
:
5523 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5524 / sizeof (lispy_multimedia_keys
[0]))
5525 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5527 return modify_event_symbol (event
->code
, event
->modifiers
,
5528 Qfunction_key
, Qnil
,
5529 lispy_multimedia_keys
, &func_key_syms
,
5530 (sizeof (lispy_multimedia_keys
)
5531 / sizeof (lispy_multimedia_keys
[0])));
5536 /* A mouse click. Figure out where it is, decide whether it's
5537 a press, click or drag, and build the appropriate structure. */
5538 case MOUSE_CLICK_EVENT
:
5540 case GPM_CLICK_EVENT
:
5542 #ifndef USE_TOOLKIT_SCROLL_BARS
5543 case SCROLL_BAR_CLICK_EVENT
:
5546 int button
= event
->code
;
5548 Lisp_Object position
;
5549 Lisp_Object
*start_pos_ptr
;
5550 Lisp_Object start_pos
;
5554 /* Build the position as appropriate for this mouse click. */
5555 if (event
->kind
== MOUSE_CLICK_EVENT
5557 || event
->kind
== GPM_CLICK_EVENT
5561 struct frame
*f
= XFRAME (event
->frame_or_window
);
5564 /* Ignore mouse events that were made on frame that
5565 have been deleted. */
5566 if (! FRAME_LIVE_P (f
))
5569 /* EVENT->x and EVENT->y are frame-relative pixel
5570 coordinates at this place. Under old redisplay, COLUMN
5571 and ROW are set to frame relative glyph coordinates
5572 which are then used to determine whether this click is
5573 in a menu (non-toolkit version). */
5574 if (!toolkit_menubar_in_use (f
))
5576 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5577 &column
, &row
, NULL
, 1);
5579 /* In the non-toolkit version, clicks on the menu bar
5580 are ordinary button events in the event buffer.
5581 Distinguish them, and invoke the menu.
5583 (In the toolkit version, the toolkit handles the
5584 menu bar and Emacs doesn't know about it until
5585 after the user makes a selection.) */
5586 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5587 && (event
->modifiers
& down_modifier
))
5589 Lisp_Object items
, item
;
5591 /* Find the menu bar item under `column'. */
5593 items
= FRAME_MENU_BAR_ITEMS (f
);
5594 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5596 Lisp_Object pos
, string
;
5597 string
= AREF (items
, i
+ 1);
5598 pos
= AREF (items
, i
+ 3);
5601 if (column
>= XINT (pos
)
5602 && column
< XINT (pos
) + SCHARS (string
))
5604 item
= AREF (items
, i
);
5609 /* ELisp manual 2.4b says (x y) are window
5610 relative but code says they are
5612 position
= list4 (event
->frame_or_window
,
5614 Fcons (event
->x
, event
->y
),
5615 make_number (event
->timestamp
));
5617 return list2 (item
, position
);
5621 position
= make_lispy_position (f
, event
->x
, event
->y
,
5624 #ifndef USE_TOOLKIT_SCROLL_BARS
5627 /* It's a scrollbar click. */
5629 Lisp_Object portion_whole
;
5632 window
= event
->frame_or_window
;
5633 portion_whole
= Fcons (event
->x
, event
->y
);
5634 part
= *scroll_bar_parts
[(int) event
->part
];
5636 position
= list5 (window
, Qvertical_scroll_bar
,
5637 portion_whole
, make_number (event
->timestamp
),
5640 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5642 if (button
>= ASIZE (button_down_location
))
5644 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5645 button_down_location
= larger_vector (button_down_location
,
5647 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5650 start_pos_ptr
= aref_addr (button_down_location
, button
);
5651 start_pos
= *start_pos_ptr
;
5652 *start_pos_ptr
= Qnil
;
5655 /* On window-system frames, use the value of
5656 double-click-fuzz as is. On other frames, interpret it
5657 as a multiple of 1/8 characters. */
5661 if (WINDOWP (event
->frame_or_window
))
5662 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5663 else if (FRAMEP (event
->frame_or_window
))
5664 f
= XFRAME (event
->frame_or_window
);
5668 if (FRAME_WINDOW_P (f
))
5669 fuzz
= double_click_fuzz
;
5671 fuzz
= double_click_fuzz
/ 8;
5673 is_double
= (button
== last_mouse_button
5674 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5675 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5676 && button_down_time
!= 0
5677 && (EQ (Vdouble_click_time
, Qt
)
5678 || (NATNUMP (Vdouble_click_time
)
5679 && (event
->timestamp
- button_down_time
5680 < XFASTINT (Vdouble_click_time
)))));
5683 last_mouse_button
= button
;
5684 last_mouse_x
= XINT (event
->x
);
5685 last_mouse_y
= XINT (event
->y
);
5687 /* If this is a button press, squirrel away the location, so
5688 we can decide later whether it was a click or a drag. */
5689 if (event
->modifiers
& down_modifier
)
5693 double_click_count
++;
5694 event
->modifiers
|= ((double_click_count
> 2)
5699 double_click_count
= 1;
5700 button_down_time
= event
->timestamp
;
5701 *start_pos_ptr
= Fcopy_alist (position
);
5702 ignore_mouse_drag_p
= 0;
5705 /* Now we're releasing a button - check the co-ordinates to
5706 see if this was a click or a drag. */
5707 else if (event
->modifiers
& up_modifier
)
5709 /* If we did not see a down before this up, ignore the up.
5710 Probably this happened because the down event chose a
5711 menu item. It would be an annoyance to treat the
5712 release of the button that chose the menu item as a
5715 if (!CONSP (start_pos
))
5718 event
->modifiers
&= ~up_modifier
;
5721 Lisp_Object new_down
, down
;
5722 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5724 /* The third element of every position
5725 should be the (x,y) pair. */
5726 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5727 new_down
= Fcar (Fcdr (Fcdr (position
)));
5730 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5732 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5733 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5736 if (ignore_mouse_drag_p
)
5738 event
->modifiers
|= click_modifier
;
5739 ignore_mouse_drag_p
= 0;
5741 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5742 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5743 /* Maybe the mouse has moved a lot, caused scrolling, and
5744 eventually ended up at the same screen position (but
5745 not buffer position) in which case it is a drag, not
5747 /* FIXME: OTOH if the buffer position has changed
5748 because of a timer or process filter rather than
5749 because of mouse movement, it should be considered as
5750 a click. But mouse-drag-region completely ignores
5751 this case and it hasn't caused any real problem, so
5752 it's probably OK to ignore it as well. */
5753 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5754 /* Mouse hasn't moved (much). */
5755 event
->modifiers
|= click_modifier
;
5758 button_down_time
= 0;
5759 event
->modifiers
|= drag_modifier
;
5762 /* Don't check is_double; treat this as multiple
5763 if the down-event was multiple. */
5764 if (double_click_count
> 1)
5765 event
->modifiers
|= ((double_click_count
> 2)
5771 /* Every mouse event should either have the down_modifier or
5772 the up_modifier set. */
5776 /* Get the symbol we should use for the mouse click. */
5779 head
= modify_event_symbol (button
,
5781 Qmouse_click
, Vlispy_mouse_stem
,
5784 ASIZE (mouse_syms
));
5785 if (event
->modifiers
& drag_modifier
)
5786 return list3 (head
, start_pos
, position
);
5787 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5788 return list3 (head
, position
, make_number (double_click_count
));
5790 return list2 (head
, position
);
5795 case HORIZ_WHEEL_EVENT
:
5797 Lisp_Object position
;
5800 /* Build the position as appropriate for this mouse click. */
5801 struct frame
*f
= XFRAME (event
->frame_or_window
);
5803 /* Ignore wheel events that were made on frame that have been
5805 if (! FRAME_LIVE_P (f
))
5808 position
= make_lispy_position (f
, event
->x
, event
->y
,
5811 /* Set double or triple modifiers to indicate the wheel speed. */
5813 /* On window-system frames, use the value of
5814 double-click-fuzz as is. On other frames, interpret it
5815 as a multiple of 1/8 characters. */
5821 if (WINDOWP (event
->frame_or_window
))
5822 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5823 else if (FRAMEP (event
->frame_or_window
))
5824 fr
= XFRAME (event
->frame_or_window
);
5828 fuzz
= FRAME_WINDOW_P (fr
)
5829 ? double_click_fuzz
: double_click_fuzz
/ 8;
5831 if (event
->modifiers
& up_modifier
)
5833 /* Emit a wheel-up event. */
5834 event
->modifiers
&= ~up_modifier
;
5837 else if (event
->modifiers
& down_modifier
)
5839 /* Emit a wheel-down event. */
5840 event
->modifiers
&= ~down_modifier
;
5844 /* Every wheel event should either have the down_modifier or
5845 the up_modifier set. */
5848 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5851 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5852 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5853 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5854 && button_down_time
!= 0
5855 && (EQ (Vdouble_click_time
, Qt
)
5856 || (NATNUMP (Vdouble_click_time
)
5857 && (event
->timestamp
- button_down_time
5858 < XFASTINT (Vdouble_click_time
)))));
5861 double_click_count
++;
5862 event
->modifiers
|= ((double_click_count
> 2)
5868 double_click_count
= 1;
5869 event
->modifiers
|= click_modifier
;
5872 button_down_time
= event
->timestamp
;
5873 /* Use a negative value to distinguish wheel from mouse button. */
5874 last_mouse_button
= - (1 + symbol_num
);
5875 last_mouse_x
= XINT (event
->x
);
5876 last_mouse_y
= XINT (event
->y
);
5878 /* Get the symbol we should use for the wheel event. */
5879 head
= modify_event_symbol (symbol_num
,
5885 ASIZE (wheel_syms
));
5888 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5889 return list3 (head
, position
, make_number (double_click_count
));
5891 return list2 (head
, position
);
5895 #ifdef USE_TOOLKIT_SCROLL_BARS
5897 /* We don't have down and up events if using toolkit scroll bars,
5898 so make this always a click event. Store in the `part' of
5899 the Lisp event a symbol which maps to the following actions:
5901 `above_handle' page up
5902 `below_handle' page down
5906 `bottom' bottom of buffer
5907 `handle' thumb has been dragged.
5908 `end-scroll' end of interaction with scroll bar
5910 The incoming input_event contains in its `part' member an
5911 index of type `enum scroll_bar_part' which we can use as an
5912 index in scroll_bar_parts to get the appropriate symbol. */
5914 case SCROLL_BAR_CLICK_EVENT
:
5916 Lisp_Object position
, head
, window
, portion_whole
, part
;
5918 window
= event
->frame_or_window
;
5919 portion_whole
= Fcons (event
->x
, event
->y
);
5920 part
= *scroll_bar_parts
[(int) event
->part
];
5922 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5923 make_number (event
->timestamp
), part
);
5925 /* Always treat scroll bar events as clicks. */
5926 event
->modifiers
|= click_modifier
;
5927 event
->modifiers
&= ~up_modifier
;
5929 if (event
->code
>= ASIZE (mouse_syms
))
5930 mouse_syms
= larger_vector (mouse_syms
,
5931 event
->code
- ASIZE (mouse_syms
) + 1,
5934 /* Get the symbol we should use for the mouse click. */
5935 head
= modify_event_symbol (event
->code
,
5940 ASIZE (mouse_syms
));
5941 return list2 (head
, position
);
5944 #endif /* USE_TOOLKIT_SCROLL_BARS */
5946 case DRAG_N_DROP_EVENT
:
5949 Lisp_Object head
, position
;
5952 f
= XFRAME (event
->frame_or_window
);
5955 /* Ignore mouse events that were made on frames that
5956 have been deleted. */
5957 if (! FRAME_LIVE_P (f
))
5960 position
= make_lispy_position (f
, event
->x
, event
->y
,
5963 head
= modify_event_symbol (0, event
->modifiers
,
5965 lispy_drag_n_drop_names
,
5966 &drag_n_drop_syms
, 1);
5967 return list3 (head
, position
, files
);
5970 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5971 || defined (HAVE_NS) || defined (USE_GTK)
5972 case MENU_BAR_EVENT
:
5973 if (EQ (event
->arg
, event
->frame_or_window
))
5974 /* This is the prefix key. We translate this to
5975 `(menu_bar)' because the code in keyboard.c for menu
5976 events, which we use, relies on this. */
5977 return list1 (Qmenu_bar
);
5981 case SELECT_WINDOW_EVENT
:
5982 /* Make an event (select-window (WINDOW)). */
5983 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5985 case TOOL_BAR_EVENT
:
5986 if (EQ (event
->arg
, event
->frame_or_window
))
5987 /* This is the prefix key. We translate this to
5988 `(tool_bar)' because the code in keyboard.c for tool bar
5989 events, which we use, relies on this. */
5990 return list1 (Qtool_bar
);
5991 else if (SYMBOLP (event
->arg
))
5992 return apply_modifiers (event
->modifiers
, event
->arg
);
5995 case USER_SIGNAL_EVENT
:
5996 /* A user signal. */
5998 char *name
= find_user_signal_name (event
->code
);
6001 return intern (name
);
6004 case SAVE_SESSION_EVENT
:
6005 return Qsave_session
;
6010 return Fcons (Qdbus_event
, event
->arg
);
6012 #endif /* HAVE_DBUS */
6014 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6015 case FILE_NOTIFY_EVENT
:
6017 return Fcons (Qfile_notify
, event
->arg
);
6019 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6021 case CONFIG_CHANGED_EVENT
:
6022 return list3 (Qconfig_changed_event
,
6023 event
->arg
, event
->frame_or_window
);
6025 /* The 'kind' field of the event is something we don't recognize. */
6032 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6033 Lisp_Object x
, Lisp_Object y
, Time t
)
6035 /* Is it a scroll bar movement? */
6036 if (frame
&& ! NILP (bar_window
))
6038 Lisp_Object part_sym
;
6040 part_sym
= *scroll_bar_parts
[(int) part
];
6041 return list2 (Qscroll_bar_movement
,
6043 Qvertical_scroll_bar
,
6048 /* Or is it an ordinary mouse movement? */
6051 Lisp_Object position
;
6052 position
= make_lispy_position (frame
, x
, y
, t
);
6053 return list2 (Qmouse_movement
, position
);
6057 /* Construct a switch frame event. */
6059 make_lispy_switch_frame (Lisp_Object frame
)
6061 return list2 (Qswitch_frame
, frame
);
6065 make_lispy_focus_in (Lisp_Object frame
)
6067 return list2 (Qfocus_in
, frame
);
6070 #ifdef HAVE_WINDOW_SYSTEM
6073 make_lispy_focus_out (Lisp_Object frame
)
6075 return list2 (Qfocus_out
, frame
);
6078 #endif /* HAVE_WINDOW_SYSTEM */
6080 /* Manipulating modifiers. */
6082 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6084 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6085 SYMBOL's name of the end of the modifiers; the string from this
6086 position is the unmodified symbol name.
6088 This doesn't use any caches. */
6091 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6097 CHECK_SYMBOL (symbol
);
6100 name
= SYMBOL_NAME (symbol
);
6102 for (i
= 0; i
< SBYTES (name
) - 1; )
6104 ptrdiff_t this_mod_end
= 0;
6107 /* See if the name continues with a modifier word.
6108 Check that the word appears, but don't check what follows it.
6109 Set this_mod and this_mod_end to record what we find. */
6111 switch (SREF (name
, i
))
6113 #define SINGLE_LETTER_MOD(BIT) \
6114 (this_mod_end = i + 1, this_mod = BIT)
6117 SINGLE_LETTER_MOD (alt_modifier
);
6121 SINGLE_LETTER_MOD (ctrl_modifier
);
6125 SINGLE_LETTER_MOD (hyper_modifier
);
6129 SINGLE_LETTER_MOD (meta_modifier
);
6133 SINGLE_LETTER_MOD (shift_modifier
);
6137 SINGLE_LETTER_MOD (super_modifier
);
6140 #undef SINGLE_LETTER_MOD
6142 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6143 if (i + LEN + 1 <= SBYTES (name) \
6144 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6146 this_mod_end = i + LEN; \
6151 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6152 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6153 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6157 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6159 #undef MULTI_LETTER_MOD
6163 /* If we found no modifier, stop looking for them. */
6164 if (this_mod_end
== 0)
6167 /* Check there is a dash after the modifier, so that it
6168 really is a modifier. */
6169 if (this_mod_end
>= SBYTES (name
)
6170 || SREF (name
, this_mod_end
) != '-')
6173 /* This modifier is real; look for another. */
6174 modifiers
|= this_mod
;
6175 i
= this_mod_end
+ 1;
6178 /* Should we include the `click' modifier? */
6179 if (! (modifiers
& (down_modifier
| drag_modifier
6180 | double_modifier
| triple_modifier
))
6181 && i
+ 7 == SBYTES (name
)
6182 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6183 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6184 modifiers
|= click_modifier
;
6186 if (! (modifiers
& (double_modifier
| triple_modifier
))
6187 && i
+ 6 < SBYTES (name
)
6188 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6189 modifiers
|= click_modifier
;
6197 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6198 prepended to the string BASE[0..BASE_LEN-1].
6199 This doesn't use any caches. */
6201 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6203 /* Since BASE could contain nulls, we can't use intern here; we have
6204 to use Fintern, which expects a genuine Lisp_String, and keeps a
6206 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6212 /* Only the event queue may use the `up' modifier; it should always
6213 be turned into a click or drag event before presented to lisp code. */
6214 if (modifiers
& up_modifier
)
6217 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6218 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6219 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6220 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6221 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6222 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6223 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6224 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6225 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6226 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6227 /* The click modifier is denoted by the absence of other modifiers. */
6231 mod_len
= p
- new_mods
;
6235 Lisp_Object new_name
;
6237 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6238 mod_len
+ base_len_byte
);
6239 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6240 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6242 return Fintern (new_name
, Qnil
);
6247 static const char *const modifier_names
[] =
6249 "up", "down", "drag", "click", "double", "triple", 0, 0,
6250 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6251 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6253 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6255 static Lisp_Object modifier_symbols
;
6257 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6259 lispy_modifier_list (int modifiers
)
6261 Lisp_Object modifier_list
;
6264 modifier_list
= Qnil
;
6265 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6266 if (modifiers
& (1<<i
))
6267 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6270 return modifier_list
;
6274 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6275 where UNMODIFIED is the unmodified form of SYMBOL,
6276 MASK is the set of modifiers present in SYMBOL's name.
6277 This is similar to parse_modifiers_uncached, but uses the cache in
6278 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6279 Qevent_symbol_elements property. */
6281 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6284 parse_modifiers (Lisp_Object symbol
)
6286 Lisp_Object elements
;
6288 if (INTEGERP (symbol
))
6289 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6290 else if (!SYMBOLP (symbol
))
6293 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6294 if (CONSP (elements
))
6299 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6300 Lisp_Object unmodified
;
6303 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6304 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6307 if (modifiers
& ~INTMASK
)
6309 XSETFASTINT (mask
, modifiers
);
6310 elements
= list2 (unmodified
, mask
);
6312 /* Cache the parsing results on SYMBOL. */
6313 Fput (symbol
, Qevent_symbol_element_mask
,
6315 Fput (symbol
, Qevent_symbol_elements
,
6316 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6318 /* Since we know that SYMBOL is modifiers applied to unmodified,
6319 it would be nice to put that in unmodified's cache.
6320 But we can't, since we're not sure that parse_modifiers is
6327 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6328 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6329 doc
: /* Parse the event symbol. For internal use. */)
6330 (Lisp_Object symbol
)
6332 /* Fill the cache if needed. */
6333 parse_modifiers (symbol
);
6334 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6335 and use the Lispier representation stored on Qevent_symbol_elements
6337 return Fget (symbol
, Qevent_symbol_elements
);
6340 /* Apply the modifiers MODIFIERS to the symbol BASE.
6341 BASE must be unmodified.
6343 This is like apply_modifiers_uncached, but uses BASE's
6344 Qmodifier_cache property, if present. It also builds
6345 Qevent_symbol_elements properties, since it has that info anyway.
6347 apply_modifiers copies the value of BASE's Qevent_kind property to
6348 the modified symbol. */
6350 apply_modifiers (int modifiers
, Lisp_Object base
)
6352 Lisp_Object cache
, idx
, entry
, new_symbol
;
6354 /* Mask out upper bits. We don't know where this value's been. */
6355 modifiers
&= INTMASK
;
6357 if (INTEGERP (base
))
6358 return make_number (XINT (base
) | modifiers
);
6360 /* The click modifier never figures into cache indices. */
6361 cache
= Fget (base
, Qmodifier_cache
);
6362 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6363 entry
= assq_no_quit (idx
, cache
);
6366 new_symbol
= XCDR (entry
);
6369 /* We have to create the symbol ourselves. */
6370 new_symbol
= apply_modifiers_uncached (modifiers
,
6371 SSDATA (SYMBOL_NAME (base
)),
6372 SCHARS (SYMBOL_NAME (base
)),
6373 SBYTES (SYMBOL_NAME (base
)));
6375 /* Add the new symbol to the base's cache. */
6376 entry
= Fcons (idx
, new_symbol
);
6377 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6379 /* We have the parsing info now for free, so we could add it to
6381 XSETFASTINT (idx, modifiers);
6382 Fput (new_symbol, Qevent_symbol_element_mask,
6384 Fput (new_symbol, Qevent_symbol_elements,
6385 Fcons (base, lispy_modifier_list (modifiers)));
6386 Sadly, this is only correct if `base' is indeed a base event,
6387 which is not necessarily the case. -stef */
6390 /* Make sure this symbol is of the same kind as BASE.
6392 You'd think we could just set this once and for all when we
6393 intern the symbol above, but reorder_modifiers may call us when
6394 BASE's property isn't set right; we can't assume that just
6395 because it has a Qmodifier_cache property it must have its
6396 Qevent_kind set right as well. */
6397 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6401 kind
= Fget (base
, Qevent_kind
);
6403 Fput (new_symbol
, Qevent_kind
, kind
);
6410 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6411 return a symbol with the modifiers placed in the canonical order.
6412 Canonical order is alphabetical, except for down and drag, which
6413 always come last. The 'click' modifier is never written out.
6415 Fdefine_key calls this to make sure that (for example) C-M-foo
6416 and M-C-foo end up being equivalent in the keymap. */
6419 reorder_modifiers (Lisp_Object symbol
)
6421 /* It's hopefully okay to write the code this way, since everything
6422 will soon be in caches, and no consing will be done at all. */
6425 parsed
= parse_modifiers (symbol
);
6426 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6431 /* For handling events, we often want to produce a symbol whose name
6432 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6433 to some base, like the name of a function key or mouse button.
6434 modify_event_symbol produces symbols of this sort.
6436 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6437 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6440 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6441 into symbol names, or a string specifying a name stem used to
6442 construct a symbol name or the form `STEM-N', where N is the decimal
6443 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6444 non-nil; otherwise NAME_TABLE is used.
6446 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6447 persist between calls to modify_event_symbol that it can use to
6448 store a cache of the symbols it's generated for this NAME_TABLE
6449 before. The object stored there may be a vector or an alist.
6451 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6453 MODIFIERS is a set of modifier bits (as given in struct input_events)
6454 whose prefixes should be applied to the symbol name.
6456 SYMBOL_KIND is the value to be placed in the event_kind property of
6457 the returned symbol.
6459 The symbols we create are supposed to have an
6460 `event-symbol-elements' property, which lists the modifiers present
6461 in the symbol's name. */
6464 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6465 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6466 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6469 Lisp_Object symbol_int
;
6471 /* Get rid of the "vendor-specific" bit here. */
6472 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6474 /* Is this a request for a valid symbol? */
6475 if (symbol_num
< 0 || symbol_num
>= table_size
)
6478 if (CONSP (*symbol_table
))
6479 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6481 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6482 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6483 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6484 we've never used that symbol before. */
6487 if (! VECTORP (*symbol_table
)
6488 || ASIZE (*symbol_table
) != table_size
)
6492 XSETFASTINT (size
, table_size
);
6493 *symbol_table
= Fmake_vector (size
, Qnil
);
6496 value
= AREF (*symbol_table
, symbol_num
);
6499 /* Have we already used this symbol before? */
6502 /* No; let's create it. */
6503 if (CONSP (name_alist_or_stem
))
6504 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6505 else if (STRINGP (name_alist_or_stem
))
6508 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6509 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6511 buf
= SAFE_ALLOCA (len
);
6512 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6513 XINT (symbol_int
) + 1);
6514 value
= intern (buf
);
6517 else if (name_table
!= 0 && name_table
[symbol_num
])
6518 value
= intern (name_table
[symbol_num
]);
6520 #ifdef HAVE_WINDOW_SYSTEM
6523 char *name
= x_get_keysym_name (symbol_num
);
6525 value
= intern (name
);
6531 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6532 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6533 value
= intern (buf
);
6536 if (CONSP (*symbol_table
))
6537 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6539 ASET (*symbol_table
, symbol_num
, value
);
6541 /* Fill in the cache entries for this symbol; this also
6542 builds the Qevent_symbol_elements property, which the user
6544 apply_modifiers (modifiers
& click_modifier
, value
);
6545 Fput (value
, Qevent_kind
, symbol_kind
);
6548 /* Apply modifiers to that symbol. */
6549 return apply_modifiers (modifiers
, value
);
6552 /* Convert a list that represents an event type,
6553 such as (ctrl meta backspace), into the usual representation of that
6554 event type as a number or a symbol. */
6556 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6557 doc
: /* Convert the event description list EVENT-DESC to an event type.
6558 EVENT-DESC should contain one base event type (a character or symbol)
6559 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6560 drag, down, double or triple). The base must be last.
6561 The return value is an event type (a character or symbol) which
6562 has the same base event type and all the specified modifiers. */)
6563 (Lisp_Object event_desc
)
6571 while (CONSP (rest
))
6579 /* Given a symbol, see if it is a modifier name. */
6580 if (SYMBOLP (elt
) && CONSP (rest
))
6581 this = parse_solitary_modifier (elt
);
6585 else if (!NILP (base
))
6586 error ("Two bases given in one event");
6592 /* Let the symbol A refer to the character A. */
6593 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6594 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6596 if (INTEGERP (base
))
6598 /* Turn (shift a) into A. */
6599 if ((modifiers
& shift_modifier
) != 0
6600 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6602 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6603 modifiers
&= ~shift_modifier
;
6606 /* Turn (control a) into C-a. */
6607 if (modifiers
& ctrl_modifier
)
6608 return make_number ((modifiers
& ~ctrl_modifier
)
6609 | make_ctrl_char (XINT (base
)));
6611 return make_number (modifiers
| XINT (base
));
6613 else if (SYMBOLP (base
))
6614 return apply_modifiers (modifiers
, base
);
6616 error ("Invalid base event");
6619 /* Try to recognize SYMBOL as a modifier name.
6620 Return the modifier flag bit, or 0 if not recognized. */
6623 parse_solitary_modifier (Lisp_Object symbol
)
6625 Lisp_Object name
= SYMBOL_NAME (symbol
);
6627 switch (SREF (name
, 0))
6629 #define SINGLE_LETTER_MOD(BIT) \
6630 if (SBYTES (name) == 1) \
6633 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6634 if (LEN == SBYTES (name) \
6635 && ! memcmp (SDATA (name), NAME, LEN)) \
6639 SINGLE_LETTER_MOD (alt_modifier
);
6643 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6647 SINGLE_LETTER_MOD (ctrl_modifier
);
6651 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6652 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6656 SINGLE_LETTER_MOD (hyper_modifier
);
6660 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6664 SINGLE_LETTER_MOD (meta_modifier
);
6668 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6672 SINGLE_LETTER_MOD (shift_modifier
);
6676 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6677 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6678 SINGLE_LETTER_MOD (super_modifier
);
6682 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6683 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6684 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6688 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6691 #undef SINGLE_LETTER_MOD
6692 #undef MULTI_LETTER_MOD
6698 /* Return true if EVENT is a list whose elements are all integers or symbols.
6699 Such a list is not valid as an event,
6700 but it can be a Lucid-style event type list. */
6703 lucid_event_type_list_p (Lisp_Object object
)
6707 if (! CONSP (object
))
6710 if (EQ (XCAR (object
), Qhelp_echo
)
6711 || EQ (XCAR (object
), Qvertical_line
)
6712 || EQ (XCAR (object
), Qmode_line
)
6713 || EQ (XCAR (object
), Qheader_line
))
6716 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6720 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6727 /* Return true if terminal input chars are available.
6728 Also, store the return value into INPUT_PENDING.
6730 Serves the purpose of ioctl (0, FIONREAD, ...)
6731 but works even if FIONREAD does not exist.
6732 (In fact, this may actually read some input.)
6734 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6735 timer events that are ripe.
6736 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6737 events (FOCUS_IN_EVENT).
6738 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6739 movements and toolkit scroll bar thumb drags. */
6742 get_input_pending (int flags
)
6744 /* First of all, have we already counted some input? */
6745 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6747 /* If input is being read as it arrives, and we have none, there is none. */
6748 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6750 /* Try to read some input and see how much we get. */
6752 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6755 return input_pending
;
6758 /* Put a BUFFER_SWITCH_EVENT in the buffer
6759 so that read_key_sequence will notice the new current buffer. */
6762 record_asynch_buffer_change (void)
6764 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6765 The purpose of the event is to make read_key_sequence look up the
6766 keymaps again. If we aren't in read_key_sequence, we don't need one,
6767 and the event could cause trouble by messing up (input-pending-p).
6768 Note: Fwaiting_for_user_input_p always returns nil when async
6769 subprocesses aren't supported. */
6770 if (!NILP (Fwaiting_for_user_input_p ()))
6772 struct input_event event
;
6775 event
.kind
= BUFFER_SWITCH_EVENT
;
6776 event
.frame_or_window
= Qnil
;
6779 /* Make sure no interrupt happens while storing the event. */
6781 if (interrupt_input
)
6782 kbd_buffer_store_event (&event
);
6787 kbd_buffer_store_event (&event
);
6793 /* Read any terminal input already buffered up by the system
6794 into the kbd_buffer, but do not wait.
6796 Return the number of keyboard chars read, or -1 meaning
6797 this is a bad time to try to read input. */
6806 /* Store pending user signal events, if any. */
6807 store_user_signal_events ();
6809 /* Loop through the available terminals, and call their input hooks. */
6813 struct terminal
*next
= t
->next_terminal
;
6815 if (t
->read_socket_hook
)
6818 struct input_event hold_quit
;
6820 if (input_blocked_p ())
6822 pending_signals
= 1;
6826 EVENT_INIT (hold_quit
);
6827 hold_quit
.kind
= NO_EVENT
;
6829 /* No need for FIONREAD or fcntl; just say don't wait. */
6830 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6833 if (nr
== -1) /* Not OK to read input now. */
6837 else if (nr
== -2) /* Non-transient error. */
6839 /* The terminal device terminated; it should be closed. */
6841 /* Kill Emacs if this was our last terminal. */
6842 if (!terminal_list
->next_terminal
)
6843 /* Formerly simply reported no input, but that
6844 sometimes led to a failure of Emacs to terminate.
6845 SIGHUP seems appropriate if we can't reach the
6847 /* ??? Is it really right to send the signal just to
6848 this process rather than to the whole process
6849 group? Perhaps on systems with FIONREAD Emacs is
6850 alone in its group. */
6851 terminate_due_to_signal (SIGHUP
, 10);
6853 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6856 XSETTERMINAL (tmp
, t
);
6857 Fdelete_terminal (tmp
, Qnoelisp
);
6861 if (hold_quit
.kind
!= NO_EVENT
)
6862 kbd_buffer_store_event (&hold_quit
);
6871 frame_make_pointer_visible ();
6876 /* This is the tty way of reading available input.
6878 Note that each terminal device has its own `struct terminal' object,
6879 and so this function is called once for each individual termcap
6880 terminal. The first parameter indicates which terminal to read from. */
6883 tty_read_avail_input (struct terminal
*terminal
,
6884 struct input_event
*hold_quit
)
6886 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6887 the kbd_buffer can really hold. That may prevent loss
6888 of characters on some systems when input is stuffed at us. */
6889 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6891 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6894 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6896 if (kbd_on_hold_p () || buffer_free
<= 0)
6898 #endif /* subprocesses */
6900 if (!terminal
->name
) /* Don't read from a dead terminal. */
6903 if (terminal
->type
!= output_termcap
6904 && terminal
->type
!= output_msdos_raw
)
6907 /* XXX I think the following code should be moved to separate hook
6908 functions in system-dependent files. */
6910 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6911 code sets read_socket_hook to w32_console_read_socket instead! */
6913 #else /* not WINDOWSNT */
6914 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6918 return 0; /* The terminal is suspended. */
6921 n_to_read
= dos_keysns ();
6925 cbuf
[0] = dos_keyread ();
6928 #else /* not MSDOS */
6933 struct input_event gpm_hold_quit
;
6934 int gpm
, fd
= gpm_fd
;
6936 EVENT_INIT (gpm_hold_quit
);
6937 gpm_hold_quit
.kind
= NO_EVENT
;
6939 /* gpm==1 if event received.
6940 gpm==0 if the GPM daemon has closed the connection, in which case
6941 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6942 we save it in `fd' so close_gpm can remove it from the
6944 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6945 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6946 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6949 /* Presumably the GPM daemon has closed the connection. */
6951 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6952 kbd_buffer_store_event (&gpm_hold_quit
);
6956 #endif /* HAVE_GPM */
6958 /* Determine how many characters we should *try* to read. */
6959 #ifdef USABLE_FIONREAD
6960 /* Find out how much input is available. */
6961 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6963 if (! noninteractive
)
6964 return -2; /* Close this terminal. */
6970 if (n_to_read
> sizeof cbuf
)
6971 n_to_read
= sizeof cbuf
;
6972 #elif defined USG || defined CYGWIN
6973 /* Read some input if available, but don't wait. */
6974 n_to_read
= sizeof cbuf
;
6975 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6977 # error "Cannot read without possibly delaying"
6981 /* Don't read more than we can store. */
6982 if (n_to_read
> buffer_free
)
6983 n_to_read
= buffer_free
;
6984 #endif /* subprocesses */
6986 /* Now read; for one reason or another, this will not block.
6987 NREAD is set to the number of chars read. */
6990 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6991 /* POSIX infers that processes which are not in the session leader's
6992 process group won't get SIGHUPs at logout time. BSDI adheres to
6993 this part standard and returns -1 from read (0) with errno==EIO
6994 when the control tty is taken away.
6995 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6996 if (nread
== -1 && errno
== EIO
)
6997 return -2; /* Close this terminal. */
6998 #if defined (AIX) && defined (_BSD)
6999 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7000 This looks incorrect, but it isn't, because _BSD causes
7001 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7002 and that causes a value other than 0 when there is no input. */
7004 return -2; /* Close this terminal. */
7008 /* We used to retry the read if it was interrupted.
7009 But this does the wrong thing when O_NONBLOCK causes
7010 an EAGAIN error. Does anybody know of a situation
7011 where a retry is actually needed? */
7013 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7023 #ifndef USABLE_FIONREAD
7024 #if defined (USG) || defined (CYGWIN)
7025 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7026 #endif /* USG or CYGWIN */
7027 #endif /* no FIONREAD */
7032 #endif /* not MSDOS */
7033 #endif /* not WINDOWSNT */
7035 for (i
= 0; i
< nread
; i
++)
7037 struct input_event buf
;
7039 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7041 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7042 buf
.modifiers
= meta_modifier
;
7043 if (tty
->meta_key
!= 2)
7047 /* Set the frame corresponding to the active tty. Note that the
7048 value of selected_frame is not reliable here, redisplay tends
7049 to temporarily change it. */
7050 buf
.frame_or_window
= tty
->top_frame
;
7053 kbd_buffer_store_event (&buf
);
7054 /* Don't look at input that follows a C-g too closely.
7055 This reduces lossage due to autorepeat on C-g. */
7056 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7057 && buf
.code
== quit_char
)
7065 handle_async_input (void)
7070 int nread
= gobble_input ();
7071 /* -1 means it's not ok to read the input now.
7072 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7073 0 means there was no keyboard input available. */
7081 process_pending_signals (void)
7083 pending_signals
= 0;
7084 handle_async_input ();
7085 do_pending_atimers ();
7088 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7089 and reinvoke any pending signal if the level is now 0 and
7090 a fatal error is not already in progress. */
7093 unblock_input_to (int level
)
7095 interrupt_input_blocked
= level
;
7098 if (pending_signals
&& !fatal_error_in_progress
)
7099 process_pending_signals ();
7105 /* End critical section.
7107 If doing signal-driven input, and a signal came in when input was
7108 blocked, reinvoke the signal handler now to deal with it. */
7111 unblock_input (void)
7113 unblock_input_to (interrupt_input_blocked
- 1);
7116 /* Undo any number of BLOCK_INPUT calls,
7117 and also reinvoke any pending signal. */
7120 totally_unblock_input (void)
7122 unblock_input_to (0);
7128 handle_input_available_signal (int sig
)
7130 pending_signals
= 1;
7132 if (input_available_clear_time
)
7133 *input_available_clear_time
= make_timespec (0, 0);
7137 deliver_input_available_signal (int sig
)
7139 deliver_process_signal (sig
, handle_input_available_signal
);
7141 #endif /* USABLE_SIGIO */
7144 /* User signal events. */
7146 struct user_signal_info
7148 /* Signal number. */
7151 /* Name of the signal. */
7154 /* Number of pending signals. */
7157 struct user_signal_info
*next
;
7160 /* List of user signals. */
7161 static struct user_signal_info
*user_signals
= NULL
;
7164 add_user_signal (int sig
, const char *name
)
7166 struct sigaction action
;
7167 struct user_signal_info
*p
;
7169 for (p
= user_signals
; p
; p
= p
->next
)
7171 /* Already added. */
7174 p
= xmalloc (sizeof *p
);
7176 p
->name
= xstrdup (name
);
7178 p
->next
= user_signals
;
7181 emacs_sigaction_init (&action
, deliver_user_signal
);
7182 sigaction (sig
, &action
, 0);
7186 handle_user_signal (int sig
)
7188 struct user_signal_info
*p
;
7189 const char *special_event_name
= NULL
;
7191 if (SYMBOLP (Vdebug_on_event
))
7192 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7194 for (p
= user_signals
; p
; p
= p
->next
)
7197 if (special_event_name
7198 && strcmp (special_event_name
, p
->name
) == 0)
7200 /* Enter the debugger in many ways. */
7201 debug_on_next_call
= 1;
7204 Vinhibit_quit
= Qnil
;
7206 /* Eat the event. */
7212 if (interrupt_input
)
7213 handle_input_available_signal (sig
);
7217 /* Tell wait_reading_process_output that it needs to wake
7218 up and look around. */
7219 if (input_available_clear_time
)
7220 *input_available_clear_time
= make_timespec (0, 0);
7227 deliver_user_signal (int sig
)
7229 deliver_process_signal (sig
, handle_user_signal
);
7233 find_user_signal_name (int sig
)
7235 struct user_signal_info
*p
;
7237 for (p
= user_signals
; p
; p
= p
->next
)
7245 store_user_signal_events (void)
7247 struct user_signal_info
*p
;
7248 struct input_event buf
;
7249 bool buf_initialized
= 0;
7251 for (p
= user_signals
; p
; p
= p
->next
)
7252 if (p
->npending
> 0)
7254 if (! buf_initialized
)
7256 memset (&buf
, 0, sizeof buf
);
7257 buf
.kind
= USER_SIGNAL_EVENT
;
7258 buf
.frame_or_window
= selected_frame
;
7259 buf_initialized
= 1;
7265 kbd_buffer_store_event (&buf
);
7268 while (p
->npending
> 0);
7273 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7274 static Lisp_Object menu_bar_one_keymap_changed_items
;
7276 /* These variables hold the vector under construction within
7277 menu_bar_items and its subroutines, and the current index
7278 for storing into that vector. */
7279 static Lisp_Object menu_bar_items_vector
;
7280 static int menu_bar_items_index
;
7283 static const char* separator_names
[] = {
7288 "single-dashed-line",
7289 "double-dashed-line",
7291 "shadow-etched-out",
7292 "shadow-etched-in-dash",
7293 "shadow-etched-out-dash",
7294 "shadow-double-etched-in",
7295 "shadow-double-etched-out",
7296 "shadow-double-etched-in-dash",
7297 "shadow-double-etched-out-dash",
7301 /* Return true if LABEL specifies a separator. */
7304 menu_separator_name_p (const char *label
)
7308 else if (strlen (label
) > 3
7309 && memcmp (label
, "--", 2) == 0
7314 for (i
= 0; separator_names
[i
]; ++i
)
7315 if (strcmp (label
, separator_names
[i
]) == 0)
7320 /* It's a separator if it contains only dashes. */
7321 while (*label
== '-')
7323 return (*label
== 0);
7330 /* Return a vector of menu items for a menu bar, appropriate
7331 to the current buffer. Each item has three elements in the vector:
7334 OLD is an old vector we can optionally reuse, or nil. */
7337 menu_bar_items (Lisp_Object old
)
7339 /* The number of keymaps we're scanning right now, and the number of
7340 keymaps we have allocated space for. */
7343 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7344 in the current keymaps, or nil where it is not a prefix. */
7347 Lisp_Object def
, tail
;
7352 /* In order to build the menus, we need to call the keymap
7353 accessors. They all call QUIT. But this function is called
7354 during redisplay, during which a quit is fatal. So inhibit
7355 quitting while building the menus.
7356 We do this instead of specbind because (1) errors will clear it anyway
7357 and (2) this avoids risk of specpdl overflow. */
7358 oquit
= Vinhibit_quit
;
7362 menu_bar_items_vector
= old
;
7364 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7365 menu_bar_items_index
= 0;
7367 /* Build our list of keymaps.
7368 If we recognize a function key and replace its escape sequence in
7369 keybuf with its symbol, or if the sequence starts with a mouse
7370 click and we need to switch buffers, we jump back here to rebuild
7371 the initial keymaps from the current buffer. */
7375 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7376 if (!NILP (Voverriding_local_map_menu_flag
)
7377 && !NILP (Voverriding_local_map
))
7379 /* Yes, use them (if non-nil) as well as the global map. */
7380 maps
= alloca (3 * sizeof (maps
[0]));
7382 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7383 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7384 if (!NILP (Voverriding_local_map
))
7385 maps
[nmaps
++] = Voverriding_local_map
;
7389 /* No, so use major and minor mode keymaps and keymap property.
7390 Note that menu-bar bindings in the local-map and keymap
7391 properties may not work reliable, as they are only
7392 recognized when the menu-bar (or mode-line) is updated,
7393 which does not normally happen after every command. */
7396 nminor
= current_minor_maps (NULL
, &tmaps
);
7397 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7399 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7400 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7401 maps
[nmaps
++] = tem
;
7402 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7403 maps
[nmaps
++] = tem
;
7404 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7406 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7408 maps
[nmaps
++] = current_global_map
;
7411 /* Look up in each map the dummy prefix key `menu-bar'. */
7413 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7414 if (!NILP (maps
[mapno
]))
7416 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7420 menu_bar_one_keymap_changed_items
= Qnil
;
7421 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7425 /* Move to the end those items that should be at the end. */
7427 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7430 int end
= menu_bar_items_index
;
7432 for (i
= 0; i
< end
; i
+= 4)
7433 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7435 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7436 /* Move the item at index I to the end,
7437 shifting all the others forward. */
7438 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7439 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7440 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7441 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7443 memmove (aref_addr (menu_bar_items_vector
, i
),
7444 aref_addr (menu_bar_items_vector
, i
+ 4),
7445 (end
- i
- 4) * word_size
);
7446 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7447 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7448 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7449 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7454 /* Add nil, nil, nil, nil at the end. */
7456 int i
= menu_bar_items_index
;
7457 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7458 menu_bar_items_vector
=
7459 larger_vector (menu_bar_items_vector
, 4, -1);
7460 /* Add this item. */
7461 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7462 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7463 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7464 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7465 menu_bar_items_index
= i
;
7468 Vinhibit_quit
= oquit
;
7469 return menu_bar_items_vector
;
7472 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7473 If there's already an item for KEY, add this DEF to it. */
7475 Lisp_Object item_properties
;
7478 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7480 struct gcpro gcpro1
;
7485 if (EQ (item
, Qundefined
))
7487 /* If a map has an explicit `undefined' as definition,
7488 discard any previously made menu bar item. */
7490 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7491 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7493 if (menu_bar_items_index
> i
+ 4)
7494 memmove (aref_addr (menu_bar_items_vector
, i
),
7495 aref_addr (menu_bar_items_vector
, i
+ 4),
7496 (menu_bar_items_index
- i
- 4) * word_size
);
7497 menu_bar_items_index
-= 4;
7501 /* If this keymap has already contributed to this KEY,
7502 don't contribute to it a second time. */
7503 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7504 if (!NILP (tem
) || NILP (item
))
7507 menu_bar_one_keymap_changed_items
7508 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7510 /* We add to menu_bar_one_keymap_changed_items before doing the
7511 parse_menu_item, so that if it turns out it wasn't a menu item,
7512 it still correctly hides any further menu item. */
7514 parsed
= parse_menu_item (item
, 1);
7519 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7521 /* Find any existing item for this KEY. */
7522 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7523 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7526 /* If we did not find this KEY, add it at the end. */
7527 if (i
== menu_bar_items_index
)
7529 /* If vector is too small, get a bigger one. */
7530 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7531 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7532 /* Add this item. */
7533 ASET (menu_bar_items_vector
, i
, key
); i
++;
7534 ASET (menu_bar_items_vector
, i
,
7535 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7536 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7537 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7538 menu_bar_items_index
= i
;
7540 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7544 old
= AREF (menu_bar_items_vector
, i
+ 2);
7545 /* If the new and the old items are not both keymaps,
7546 the lookup will only find `item'. */
7547 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7548 ASET (menu_bar_items_vector
, i
+ 2, item
);
7552 /* This is used as the handler when calling menu_item_eval_property. */
7554 menu_item_eval_property_1 (Lisp_Object arg
)
7556 /* If we got a quit from within the menu computation,
7557 quit all the way out of it. This takes care of C-] in the debugger. */
7558 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7559 Fsignal (Qquit
, Qnil
);
7565 eval_dyn (Lisp_Object form
)
7567 return Feval (form
, Qnil
);
7570 /* Evaluate an expression and return the result (or nil if something
7571 went wrong). Used to evaluate dynamic parts of menu items. */
7573 menu_item_eval_property (Lisp_Object sexpr
)
7575 ptrdiff_t count
= SPECPDL_INDEX ();
7577 specbind (Qinhibit_redisplay
, Qt
);
7578 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7579 menu_item_eval_property_1
);
7580 return unbind_to (count
, val
);
7583 /* This function parses a menu item and leaves the result in the
7584 vector item_properties.
7585 ITEM is a key binding, a possible menu item.
7586 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7588 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7589 parse_menu_item returns true if the item is a menu item and false
7593 parse_menu_item (Lisp_Object item
, int inmenubar
)
7595 Lisp_Object def
, tem
, item_string
, start
;
7597 Lisp_Object keyhint
;
7606 /* Create item_properties vector if necessary. */
7607 if (NILP (item_properties
))
7609 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7611 /* Initialize optional entries. */
7612 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7613 ASET (item_properties
, i
, Qnil
);
7614 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7616 /* Save the item here to protect it from GC. */
7617 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7619 item_string
= XCAR (item
);
7623 if (STRINGP (item_string
))
7625 /* Old format menu item. */
7626 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7628 /* Maybe help string. */
7629 if (CONSP (item
) && STRINGP (XCAR (item
)))
7631 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7636 /* Maybe an obsolete key binding cache. */
7637 if (CONSP (item
) && CONSP (XCAR (item
))
7638 && (NILP (XCAR (XCAR (item
)))
7639 || VECTORP (XCAR (XCAR (item
)))))
7642 /* This is the real definition--the function to run. */
7643 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7645 /* Get enable property, if any. */
7648 tem
= Fget (item
, Qmenu_enable
);
7649 if (!NILP (Venable_disabled_menus_and_buttons
))
7650 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7651 else if (!NILP (tem
))
7652 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7655 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7657 /* New format menu item. */
7658 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7659 start
= XCDR (item
);
7662 /* We have a real binding. */
7663 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7665 item
= XCDR (start
);
7666 /* Is there an obsolete cache list with key equivalences. */
7667 if (CONSP (item
) && CONSP (XCAR (item
)))
7670 /* Parse properties. */
7671 while (CONSP (item
) && CONSP (XCDR (item
)))
7676 if (EQ (tem
, QCenable
))
7678 if (!NILP (Venable_disabled_menus_and_buttons
))
7679 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7681 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7683 else if (EQ (tem
, QCvisible
))
7685 /* If got a visible property and that evaluates to nil
7686 then ignore this item. */
7687 tem
= menu_item_eval_property (XCAR (item
));
7691 else if (EQ (tem
, QChelp
))
7692 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7693 else if (EQ (tem
, QCfilter
))
7695 else if (EQ (tem
, QCkey_sequence
))
7698 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7699 /* Be GC protected. Set keyhint to item instead of tem. */
7702 else if (EQ (tem
, QCkeys
))
7705 if (CONSP (tem
) || STRINGP (tem
))
7706 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7708 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7713 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7715 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7717 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7723 else if (inmenubar
|| !NILP (start
))
7727 return 0; /* not a menu item */
7729 /* If item string is not a string, evaluate it to get string.
7730 If we don't get a string, skip this item. */
7731 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7732 if (!(STRINGP (item_string
)))
7734 item_string
= menu_item_eval_property (item_string
);
7735 if (!STRINGP (item_string
))
7737 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7740 /* If got a filter apply it on definition. */
7741 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7744 def
= menu_item_eval_property (list2 (XCAR (filter
),
7745 list2 (Qquote
, def
)));
7747 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7750 /* Enable or disable selection of item. */
7751 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7754 tem
= menu_item_eval_property (tem
);
7755 if (inmenubar
&& NILP (tem
))
7756 return 0; /* Ignore disabled items in menu bar. */
7757 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7760 /* If we got no definition, this item is just unselectable text which
7761 is OK in a submenu but not in the menubar. */
7763 return (!inmenubar
);
7765 /* See if this is a separate pane or a submenu. */
7766 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7767 tem
= get_keymap (def
, 0, 1);
7768 /* For a subkeymap, just record its details and exit. */
7771 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7772 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7776 /* At the top level in the menu bar, do likewise for commands also.
7777 The menu bar does not display equivalent key bindings anyway.
7778 ITEM_PROPERTY_DEF is already set up properly. */
7782 { /* This is a command. See if there is an equivalent key binding. */
7783 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7785 /* The previous code preferred :key-sequence to :keys, so we
7786 preserve this behavior. */
7787 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7788 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7791 Lisp_Object prefix
= keyeq
;
7792 Lisp_Object keys
= Qnil
;
7796 def
= XCAR (prefix
);
7797 prefix
= XCDR (prefix
);
7800 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7802 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7804 keys
= XCAR (keyhint
);
7805 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7807 /* We have a suggested key. Is it bound to the command? */
7810 /* If the command is an alias for another
7811 (such as lmenu.el set it up), check if the
7812 original command matches the cached command. */
7814 && EQ (tem
, XSYMBOL (def
)->function
))))
7819 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7823 tem
= Fkey_description (keys
, Qnil
);
7826 if (STRINGP (XCAR (prefix
)))
7827 tem
= concat2 (XCAR (prefix
), tem
);
7828 if (STRINGP (XCDR (prefix
)))
7829 tem
= concat2 (tem
, XCDR (prefix
));
7831 keyeq
= concat2 (build_string (" "), tem
);
7832 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7838 /* If we have an equivalent key binding, use that. */
7839 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7842 /* Include this when menu help is implemented.
7843 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7844 if (!(NILP (tem) || STRINGP (tem)))
7846 tem = menu_item_eval_property (tem);
7849 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7853 /* Handle radio buttons or toggle boxes. */
7854 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7856 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7857 menu_item_eval_property (tem
));
7864 /***********************************************************************
7866 ***********************************************************************/
7868 /* A vector holding tool bar items while they are parsed in function
7869 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7872 static Lisp_Object tool_bar_items_vector
;
7874 /* A vector holding the result of parse_tool_bar_item. Layout is like
7875 the one for a single item in tool_bar_items_vector. */
7877 static Lisp_Object tool_bar_item_properties
;
7879 /* Next free index in tool_bar_items_vector. */
7881 static int ntool_bar_items
;
7883 /* The symbols `:image' and `:rtl'. */
7885 static Lisp_Object QCimage
;
7886 static Lisp_Object QCrtl
;
7888 /* Function prototypes. */
7890 static void init_tool_bar_items (Lisp_Object
);
7891 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7892 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7893 static void append_tool_bar_item (void);
7896 /* Return a vector of tool bar items for keymaps currently in effect.
7897 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7898 tool bar items found. */
7901 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7910 /* In order to build the menus, we need to call the keymap
7911 accessors. They all call QUIT. But this function is called
7912 during redisplay, during which a quit is fatal. So inhibit
7913 quitting while building the menus. We do this instead of
7914 specbind because (1) errors will clear it anyway and (2) this
7915 avoids risk of specpdl overflow. */
7916 oquit
= Vinhibit_quit
;
7919 /* Initialize tool_bar_items_vector and protect it from GC. */
7920 init_tool_bar_items (reuse
);
7922 /* Build list of keymaps in maps. Set nmaps to the number of maps
7925 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7926 if (!NILP (Voverriding_local_map_menu_flag
)
7927 && !NILP (Voverriding_local_map
))
7929 /* Yes, use them (if non-nil) as well as the global map. */
7930 maps
= alloca (3 * sizeof *maps
);
7932 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7933 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7934 if (!NILP (Voverriding_local_map
))
7935 maps
[nmaps
++] = Voverriding_local_map
;
7939 /* No, so use major and minor mode keymaps and keymap property.
7940 Note that tool-bar bindings in the local-map and keymap
7941 properties may not work reliable, as they are only
7942 recognized when the tool-bar (or mode-line) is updated,
7943 which does not normally happen after every command. */
7946 nminor
= current_minor_maps (NULL
, &tmaps
);
7947 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7949 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7950 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7951 maps
[nmaps
++] = tem
;
7952 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7953 maps
[nmaps
++] = tem
;
7954 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7956 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7959 /* Add global keymap at the end. */
7960 maps
[nmaps
++] = current_global_map
;
7962 /* Process maps in reverse order and look up in each map the prefix
7964 for (i
= nmaps
- 1; i
>= 0; --i
)
7965 if (!NILP (maps
[i
]))
7969 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7971 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7974 Vinhibit_quit
= oquit
;
7975 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7976 return tool_bar_items_vector
;
7980 /* Process the definition of KEY which is DEF. */
7983 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7986 struct gcpro gcpro1
, gcpro2
;
7988 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7992 if (EQ (def
, Qundefined
))
7994 /* If a map has an explicit `undefined' as definition,
7995 discard any previously made item. */
7996 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
7998 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8000 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8002 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8003 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8004 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8006 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8011 else if (parse_tool_bar_item (key
, def
))
8012 /* Append a new tool bar item to tool_bar_items_vector. Accept
8013 more than one definition for the same key. */
8014 append_tool_bar_item ();
8019 /* Access slot with index IDX of vector tool_bar_item_properties. */
8020 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8022 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8024 ASET (tool_bar_item_properties
, idx
, val
);
8028 /* Parse a tool bar item specification ITEM for key KEY and return the
8029 result in tool_bar_item_properties. Value is false if ITEM is
8032 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8034 CAPTION is the caption of the item, If it's not a string, it is
8035 evaluated to get a string.
8037 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8038 as binding are currently ignored.
8040 The following properties are recognized:
8044 FORM is evaluated and specifies whether the tool bar item is
8045 enabled or disabled.
8049 FORM is evaluated and specifies whether the tool bar item is visible.
8051 - `:filter FUNCTION'
8053 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8054 result is stored as the new binding.
8056 - `:button (TYPE SELECTED)'
8058 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8059 and specifies whether the button is selected (pressed) or not.
8063 IMAGES is either a single image specification or a vector of four
8064 image specifications. See enum tool_bar_item_images.
8066 - `:help HELP-STRING'.
8068 Gives a help string to display for the tool bar item.
8070 - `:label LABEL-STRING'.
8072 A text label to show with the tool bar button if labels are enabled. */
8075 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8077 Lisp_Object filter
= Qnil
;
8078 Lisp_Object caption
;
8080 bool have_label
= 0;
8082 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8083 Rule out items that aren't lists, don't start with
8084 `menu-item' or whose rest following `tool-bar-item' is not a
8089 /* As an exception, allow old-style menu separators. */
8090 if (STRINGP (XCAR (item
)))
8091 item
= list1 (XCAR (item
));
8092 else if (!EQ (XCAR (item
), Qmenu_item
)
8093 || (item
= XCDR (item
), !CONSP (item
)))
8096 /* Create tool_bar_item_properties vector if necessary. Reset it to
8098 if (VECTORP (tool_bar_item_properties
))
8100 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8104 tool_bar_item_properties
8105 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8108 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8109 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8111 /* Get the caption of the item. If the caption is not a string,
8112 evaluate it to get a string. If we don't get a string, skip this
8114 caption
= XCAR (item
);
8115 if (!STRINGP (caption
))
8117 caption
= menu_item_eval_property (caption
);
8118 if (!STRINGP (caption
))
8121 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8123 /* If the rest following the caption is not a list, the menu item is
8124 either a separator, or invalid. */
8128 if (menu_separator_name_p (SSDATA (caption
)))
8130 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8131 #if !defined (USE_GTK) && !defined (HAVE_NS)
8132 /* If we use build_desired_tool_bar_string to render the
8133 tool bar, the separator is rendered as an image. */
8134 set_prop (TOOL_BAR_ITEM_IMAGES
,
8135 (menu_item_eval_property
8136 (Vtool_bar_separator_image_expression
)));
8137 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8138 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8139 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8146 /* Store the binding. */
8147 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8150 /* Ignore cached key binding, if any. */
8151 if (CONSP (item
) && CONSP (XCAR (item
)))
8154 /* Process the rest of the properties. */
8155 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8157 Lisp_Object ikey
, value
;
8160 value
= XCAR (XCDR (item
));
8162 if (EQ (ikey
, QCenable
))
8164 /* `:enable FORM'. */
8165 if (!NILP (Venable_disabled_menus_and_buttons
))
8166 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8168 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8170 else if (EQ (ikey
, QCvisible
))
8172 /* `:visible FORM'. If got a visible property and that
8173 evaluates to nil then ignore this item. */
8174 if (NILP (menu_item_eval_property (value
)))
8177 else if (EQ (ikey
, QChelp
))
8178 /* `:help HELP-STRING'. */
8179 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8180 else if (EQ (ikey
, QCvert_only
))
8181 /* `:vert-only t/nil'. */
8182 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8183 else if (EQ (ikey
, QClabel
))
8185 const char *bad_label
= "!!?GARBLED ITEM?!!";
8186 /* `:label LABEL-STRING'. */
8187 set_prop (TOOL_BAR_ITEM_LABEL
,
8188 STRINGP (value
) ? value
: build_string (bad_label
));
8191 else if (EQ (ikey
, QCfilter
))
8192 /* ':filter FORM'. */
8194 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8196 /* `:button (TYPE . SELECTED)'. */
8197 Lisp_Object type
, selected
;
8199 type
= XCAR (value
);
8200 selected
= XCDR (value
);
8201 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8203 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8204 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8207 else if (EQ (ikey
, QCimage
)
8209 || (VECTORP (value
) && ASIZE (value
) == 4)))
8210 /* Value is either a single image specification or a vector
8211 of 4 such specifications for the different button states. */
8212 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8213 else if (EQ (ikey
, QCrtl
))
8215 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8221 /* Try to make one from caption and key. */
8222 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8223 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8224 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8225 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8227 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8228 char *buf
= xmalloc (max_lbl
+ 1);
8229 Lisp_Object new_lbl
;
8230 ptrdiff_t caption_len
= strlen (capt
);
8232 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8235 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8237 buf
[caption_len
] = '\0';
8241 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8245 strcpy (buf
, label
);
8247 for (j
= 0; buf
[j
] != '\0'; ++j
)
8255 new_lbl
= Fupcase_initials (build_string (label
));
8256 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8257 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8259 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8263 /* If got a filter apply it on binding. */
8265 set_prop (TOOL_BAR_ITEM_BINDING
,
8266 (menu_item_eval_property
8269 PROP (TOOL_BAR_ITEM_BINDING
))))));
8271 /* See if the binding is a keymap. Give up if it is. */
8272 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8275 /* Enable or disable selection of item. */
8276 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8277 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8278 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8280 /* Handle radio buttons or toggle boxes. */
8281 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8282 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8283 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8291 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8292 that can be reused. */
8295 init_tool_bar_items (Lisp_Object reuse
)
8297 if (VECTORP (reuse
))
8298 tool_bar_items_vector
= reuse
;
8300 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8301 ntool_bar_items
= 0;
8305 /* Append parsed tool bar item properties from
8306 tool_bar_item_properties */
8309 append_tool_bar_item (void)
8313 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8315 /* Enlarge tool_bar_items_vector if necessary. */
8317 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8319 /* Append entries from tool_bar_item_properties to the end of
8320 tool_bar_items_vector. */
8321 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8322 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8323 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8330 /* Read a character using menus based on the keymap MAP.
8331 Return nil if there are no menus in the maps.
8332 Return t if we displayed a menu but the user rejected it.
8334 PREV_EVENT is the previous input event, or nil if we are reading
8335 the first event of a key sequence.
8337 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8338 if we used a mouse menu to read the input, or false otherwise. If
8339 USED_MOUSE_MENU is null, don't dereference it.
8341 The prompting is done based on the prompt-string of the map
8342 and the strings associated with various map elements.
8344 This can be done with X menus or with menus put in the minibuf.
8345 These are done in different ways, depending on how the input will be read.
8346 Menus using X are done after auto-saving in read-char, getting the input
8347 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8348 and do auto-saving in the inner call of read_char. */
8351 read_char_x_menu_prompt (Lisp_Object map
,
8352 Lisp_Object prev_event
, bool *used_mouse_menu
)
8354 if (used_mouse_menu
)
8355 *used_mouse_menu
= 0;
8357 /* Use local over global Menu maps. */
8359 if (! menu_prompting
)
8363 /* If we got to this point via a mouse click,
8364 use a real menu for mouse selection. */
8365 if (EVENT_HAS_PARAMETERS (prev_event
)
8366 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8367 && !EQ (XCAR (prev_event
), Qtool_bar
))
8369 /* Display the menu and get the selection. */
8372 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8377 record_menu_key (XCAR (value
));
8379 /* If we got multiple events, unread all but
8381 There is no way to prevent those unread events
8382 from showing up later in last_nonmenu_event.
8383 So turn symbol and integer events into lists,
8384 to indicate that they came from a mouse menu,
8385 so that when present in last_nonmenu_event
8386 they won't confuse things. */
8387 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8389 record_menu_key (XCAR (tem
));
8390 if (SYMBOLP (XCAR (tem
))
8391 || INTEGERP (XCAR (tem
)))
8392 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8395 /* If we got more than one event, put all but the first
8396 onto this list to be read later.
8397 Return just the first event now. */
8398 Vunread_command_events
8399 = nconc2 (XCDR (value
), Vunread_command_events
);
8400 value
= XCAR (value
);
8402 else if (NILP (value
))
8404 if (used_mouse_menu
)
8405 *used_mouse_menu
= 1;
8408 #endif /* HAVE_MENUS */
8413 read_char_minibuf_menu_prompt (int commandflag
,
8416 register Lisp_Object name
;
8418 /* FIXME: Use the minibuffer's frame width. */
8419 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8421 bool nobindings
= 1;
8422 Lisp_Object rest
, vector
;
8423 Lisp_Object prompt_strings
= Qnil
;
8427 if (! menu_prompting
)
8430 map
= get_keymap (map
, 0, 1);
8431 name
= Fkeymap_prompt (map
);
8433 /* If we don't have any menus, just read a character normally. */
8434 if (!STRINGP (name
))
8437 #define PUSH_C_STR(str, listvar) \
8438 listvar = Fcons (build_unibyte_string (str), listvar)
8440 /* Prompt string always starts with map's prompt, and a space. */
8441 prompt_strings
= Fcons (name
, prompt_strings
);
8442 PUSH_C_STR (": ", prompt_strings
);
8443 nlength
= SCHARS (name
) + 2;
8447 /* Present the documented bindings, a line at a time. */
8451 Lisp_Object menu_strings
= prompt_strings
;
8452 ptrdiff_t i
= nlength
;
8454 Lisp_Object orig_defn_macro
;
8456 /* Loop over elements of map. */
8461 /* FIXME: Use map_keymap to handle new keymap formats. */
8463 /* At end of map, wrap around if just starting,
8464 or end this line if already have something on it. */
8467 if (notfirst
|| nobindings
)
8473 /* Look at the next element of the map. */
8475 elt
= AREF (vector
, idx
);
8477 elt
= Fcar_safe (rest
);
8479 if (idx
< 0 && VECTORP (elt
))
8481 /* If we found a dense table in the keymap,
8482 advanced past it, but start scanning its contents. */
8483 rest
= Fcdr_safe (rest
);
8489 /* An ordinary element. */
8490 Lisp_Object event
, tem
;
8494 event
= Fcar_safe (elt
); /* alist */
8495 elt
= Fcdr_safe (elt
);
8499 XSETINT (event
, idx
); /* vector */
8502 /* Ignore the element if it has no prompt string. */
8503 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8505 /* True if the char to type matches the string. */
8507 Lisp_Object upcased_event
, downcased_event
;
8508 Lisp_Object desc
= Qnil
;
8510 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8512 upcased_event
= Fupcase (event
);
8513 downcased_event
= Fdowncase (event
);
8514 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8515 || XINT (downcased_event
) == SREF (s
, 0));
8517 desc
= Fsingle_key_description (event
, Qnil
);
8519 #if 0 /* It is redundant to list the equivalent key bindings because
8520 the prefix is what the user has already typed. */
8522 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8524 /* Insert equivalent keybinding. */
8525 s
= concat2 (s
, tem
);
8528 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8529 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8531 /* Insert button prefix. */
8532 Lisp_Object selected
8533 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8534 if (EQ (tem
, QCradio
))
8535 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8537 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8538 s
= concat2 (tem
, s
);
8542 /* If we have room for the prompt string, add it to this line.
8543 If this is the first on the line, always add it. */
8544 if ((SCHARS (s
) + i
+ 2
8545 + (char_matches
? 0 : SCHARS (desc
) + 3))
8549 ptrdiff_t thiswidth
;
8551 /* Punctuate between strings. */
8554 PUSH_C_STR (", ", menu_strings
);
8560 /* If the char to type doesn't match the string's
8561 first char, explicitly show what char to type. */
8564 /* Add as much of string as fits. */
8565 thiswidth
= min (SCHARS (desc
), width
- i
);
8567 = Fcons (Fsubstring (desc
, make_number (0),
8568 make_number (thiswidth
)),
8571 PUSH_C_STR (" = ", menu_strings
);
8575 /* Add as much of string as fits. */
8576 thiswidth
= min (SCHARS (s
), width
- i
);
8578 = Fcons (Fsubstring (s
, make_number (0),
8579 make_number (thiswidth
)),
8585 /* If this element does not fit, end the line now,
8586 and save the element for the next line. */
8587 PUSH_C_STR ("...", menu_strings
);
8592 /* Move past this element. */
8593 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8594 /* Handle reaching end of dense table. */
8599 rest
= Fcdr_safe (rest
);
8603 /* Prompt with that and read response. */
8604 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8606 /* Make believe it's not a keyboard macro in case the help char
8607 is pressed. Help characters are not recorded because menu prompting
8608 is not used on replay. */
8609 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8610 kset_defining_kbd_macro (current_kboard
, Qnil
);
8612 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8613 while (BUFFERP (obj
));
8614 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8616 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8619 if (! EQ (obj
, menu_prompt_more_char
)
8620 && (!INTEGERP (menu_prompt_more_char
)
8621 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8623 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8624 store_kbd_macro_char (obj
);
8627 /* Help char - go round again. */
8631 /* Reading key sequences. */
8634 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8636 return access_keymap (get_keymap (keymap
, 0, 1),
8641 active_maps (Lisp_Object first_event
)
8643 Lisp_Object position
8644 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8645 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8648 /* Structure used to keep track of partial application of key remapping
8649 such as Vfunction_key_map and Vkey_translation_map. */
8650 typedef struct keyremap
8652 /* This is the map originally specified for this use. */
8654 /* This is a submap reached by looking up, in PARENT,
8655 the events from START to END. */
8657 /* Positions [START, END) in the key sequence buffer
8658 are the key that we have scanned so far.
8659 Those events are the ones that we will replace
8660 if PARENT maps them into a key sequence. */
8664 /* Lookup KEY in MAP.
8665 MAP is a keymap mapping keys to key vectors or functions.
8666 If the mapping is a function and DO_FUNCALL is true,
8667 the function is called with PROMPT as parameter and its return
8668 value is used as the return value of this function (after checking
8669 that it is indeed a vector). */
8672 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8677 next
= access_keymap (map
, key
, 1, 0, 1);
8679 /* Handle a symbol whose function definition is a keymap
8681 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8682 && (ARRAYP (XSYMBOL (next
)->function
)
8683 || KEYMAPP (XSYMBOL (next
)->function
)))
8684 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8686 /* If the keymap gives a function, not an
8687 array, then call the function with one arg and use
8688 its value instead. */
8689 if (do_funcall
&& FUNCTIONP (next
))
8694 next
= call1 (next
, prompt
);
8695 /* If the function returned something invalid,
8696 barf--don't ignore it.
8697 (To ignore it safely, we would need to gcpro a bunch of
8698 other variables.) */
8699 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8700 error ("Function %s returns invalid key sequence",
8701 SSDATA (SYMBOL_NAME (tem
)));
8706 /* Do one step of the key remapping used for function-key-map and
8707 key-translation-map:
8708 KEYBUF is the buffer holding the input events.
8709 BUFSIZE is its maximum size.
8710 FKEY is a pointer to the keyremap structure to use.
8711 INPUT is the index of the last element in KEYBUF.
8712 DOIT if true says that the remapping can actually take place.
8713 DIFF is used to return the number of keys added/removed by the remapping.
8714 PARENT is the root of the keymap.
8715 PROMPT is the prompt to use if the remapping happens through a function.
8716 Return true if the remapping actually took place. */
8719 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8720 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8722 Lisp_Object next
, key
;
8724 key
= keybuf
[fkey
->end
++];
8726 if (KEYMAPP (fkey
->parent
))
8727 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8731 /* If keybuf[fkey->start..fkey->end] is bound in the
8732 map and we're in a position to do the key remapping, replace it with
8733 the binding and restart with fkey->start at the end. */
8734 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8736 int len
= XFASTINT (Flength (next
));
8739 *diff
= len
- (fkey
->end
- fkey
->start
);
8741 if (bufsize
- input
<= *diff
)
8742 error ("Key sequence too long");
8744 /* Shift the keys that follow fkey->end. */
8746 for (i
= fkey
->end
; i
< input
; i
++)
8747 keybuf
[i
+ *diff
] = keybuf
[i
];
8749 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8750 keybuf
[i
+ *diff
] = keybuf
[i
];
8751 /* Overwrite the old keys with the new ones. */
8752 for (i
= 0; i
< len
; i
++)
8753 keybuf
[fkey
->start
+ i
]
8754 = Faref (next
, make_number (i
));
8756 fkey
->start
= fkey
->end
+= *diff
;
8757 fkey
->map
= fkey
->parent
;
8762 fkey
->map
= get_keymap (next
, 0, 1);
8764 /* If we no longer have a bound suffix, try a new position for
8766 if (!CONSP (fkey
->map
))
8768 fkey
->end
= ++fkey
->start
;
8769 fkey
->map
= fkey
->parent
;
8775 test_undefined (Lisp_Object binding
)
8777 return (NILP (binding
)
8778 || EQ (binding
, Qundefined
)
8779 || (SYMBOLP (binding
)
8780 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8783 /* Read a sequence of keys that ends with a non prefix character,
8784 storing it in KEYBUF, a buffer of size BUFSIZE.
8786 Return the length of the key sequence stored.
8787 Return -1 if the user rejected a command menu.
8789 Echo starting immediately unless `prompt' is 0.
8791 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8792 read_char with a suitable COMMANDFLAG argument.
8794 Where a key sequence ends depends on the currently active keymaps.
8795 These include any minor mode keymaps active in the current buffer,
8796 the current buffer's local map, and the global map.
8798 If a key sequence has no other bindings, we check Vfunction_key_map
8799 to see if some trailing subsequence might be the beginning of a
8800 function key's sequence. If so, we try to read the whole function
8801 key, and substitute its symbolic name into the key sequence.
8803 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8804 `double-' events into similar click events, if that would make them
8805 bound. We try to turn `triple-' events first into `double-' events,
8808 If we get a mouse click in a mode line, vertical divider, or other
8809 non-text area, we treat the click as if it were prefixed by the
8810 symbol denoting that area - `mode-line', `vertical-line', or
8813 If the sequence starts with a mouse click, we read the key sequence
8814 with respect to the buffer clicked on, not the current buffer.
8816 If the user switches frames in the midst of a key sequence, we put
8817 off the switch-frame event until later; the next call to
8818 read_char will return it.
8820 If FIX_CURRENT_BUFFER, we restore current_buffer
8821 from the selected window's buffer. */
8824 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8825 bool dont_downcase_last
, bool can_return_switch_frame
,
8826 bool fix_current_buffer
, bool prevent_redisplay
)
8828 ptrdiff_t count
= SPECPDL_INDEX ();
8830 /* How many keys there are in the current key sequence. */
8833 /* The length of the echo buffer when we started reading, and
8834 the length of this_command_keys when we started reading. */
8835 ptrdiff_t echo_start
IF_LINT (= 0);
8836 ptrdiff_t keys_start
;
8838 Lisp_Object current_binding
= Qnil
;
8839 Lisp_Object first_event
= Qnil
;
8841 /* Index of the first key that has no binding.
8842 It is useless to try fkey.start larger than that. */
8845 /* If t < mock_input, then KEYBUF[t] should be read as the next
8848 We use this to recover after recognizing a function key. Once we
8849 realize that a suffix of the current key sequence is actually a
8850 function key's escape sequence, we replace the suffix with the
8851 function key's binding from Vfunction_key_map. Now keybuf
8852 contains a new and different key sequence, so the echo area,
8853 this_command_keys, and the submaps and defs arrays are wrong. In
8854 this situation, we set mock_input to t, set t to 0, and jump to
8855 restart_sequence; the loop will read keys from keybuf up until
8856 mock_input, thus rebuilding the state; and then it will resume
8857 reading characters from the keyboard. */
8860 /* If the sequence is unbound in submaps[], then
8861 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8862 and fkey.map is its binding.
8864 These might be > t, indicating that all function key scanning
8865 should hold off until t reaches them. We do this when we've just
8866 recognized a function key, to avoid searching for the function
8867 key's again in Vfunction_key_map. */
8870 /* Likewise, for key_translation_map and input-decode-map. */
8871 keyremap keytran
, indec
;
8873 /* True if we are trying to map a key by changing an upper-case
8874 letter to lower case, or a shifted function key to an unshifted
8876 bool shift_translated
= 0;
8878 /* If we receive a `switch-frame' or `select-window' event in the middle of
8879 a key sequence, we put it off for later.
8880 While we're reading, we keep the event here. */
8881 Lisp_Object delayed_switch_frame
;
8883 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8884 int original_uppercase_position
= -1;
8886 /* Gets around Microsoft compiler limitations. */
8889 struct buffer
*starting_buffer
;
8891 /* List of events for which a fake prefix key has been generated. */
8892 Lisp_Object fake_prefixed_keys
= Qnil
;
8894 struct gcpro gcpro1
;
8896 GCPRO1 (fake_prefixed_keys
);
8897 raw_keybuf_count
= 0;
8899 last_nonmenu_event
= Qnil
;
8901 delayed_switch_frame
= Qnil
;
8907 /* Install the string PROMPT as the beginning of the string
8908 of echoing, so that it serves as a prompt for the next
8910 kset_echo_string (current_kboard
, prompt
);
8911 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8914 else if (cursor_in_echo_area
8915 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8916 && NILP (Fzerop (Vecho_keystrokes
)))
8917 /* This doesn't put in a dash if the echo buffer is empty, so
8918 you don't always see a dash hanging out in the minibuffer. */
8922 /* Record the initial state of the echo area and this_command_keys;
8923 we will need to restore them if we replay a key sequence. */
8925 echo_start
= echo_length ();
8926 keys_start
= this_command_key_count
;
8927 this_single_command_key_start
= keys_start
;
8929 /* We jump here when we need to reinitialize fkey and keytran; this
8930 happens if we switch keyboards between rescans. */
8931 replay_entire_sequence
:
8933 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8934 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8935 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8936 indec
.start
= indec
.end
= 0;
8937 fkey
.start
= fkey
.end
= 0;
8938 keytran
.start
= keytran
.end
= 0;
8940 /* We jump here when the key sequence has been thoroughly changed, and
8941 we need to rescan it starting from the beginning. When we jump here,
8942 keybuf[0..mock_input] holds the sequence we should reread. */
8945 starting_buffer
= current_buffer
;
8946 first_unbound
= bufsize
+ 1;
8948 /* Build our list of keymaps.
8949 If we recognize a function key and replace its escape sequence in
8950 keybuf with its symbol, or if the sequence starts with a mouse
8951 click and we need to switch buffers, we jump back here to rebuild
8952 the initial keymaps from the current buffer. */
8953 current_binding
= active_maps (first_event
);
8955 /* Start from the beginning in keybuf. */
8958 /* These are no-ops the first time through, but if we restart, they
8959 revert the echo area and this_command_keys to their original state. */
8960 this_command_key_count
= keys_start
;
8961 if (INTERACTIVE
&& t
< mock_input
)
8962 echo_truncate (echo_start
);
8964 /* If the best binding for the current key sequence is a keymap, or
8965 we may be looking at a function key's escape sequence, keep on
8967 while (!NILP (current_binding
)
8968 /* Keep reading as long as there's a prefix binding. */
8969 ? KEYMAPP (current_binding
)
8970 /* Don't return in the middle of a possible function key sequence,
8971 if the only bindings we found were via case conversion.
8972 Thus, if ESC O a has a function-key-map translation
8973 and ESC o has a binding, don't return after ESC O,
8974 so that we can translate ESC O plus the next character. */
8975 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8978 bool used_mouse_menu
= 0;
8980 /* Where the last real key started. If we need to throw away a
8981 key that has expanded into more than one element of keybuf
8982 (say, a mouse click on the mode line which is being treated
8983 as [mode-line (mouse-...)], then we backtrack to this point
8985 int last_real_key_start
;
8987 /* These variables are analogous to echo_start and keys_start;
8988 while those allow us to restart the entire key sequence,
8989 echo_local_start and keys_local_start allow us to throw away
8991 ptrdiff_t echo_local_start
IF_LINT (= 0);
8992 int keys_local_start
;
8993 Lisp_Object new_binding
;
8995 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
8996 eassert (indec
.start
<= indec
.end
);
8997 eassert (fkey
.start
<= fkey
.end
);
8998 eassert (keytran
.start
<= keytran
.end
);
8999 /* key-translation-map is applied *after* function-key-map
9000 which is itself applied *after* input-decode-map. */
9001 eassert (fkey
.end
<= indec
.start
);
9002 eassert (keytran
.end
<= fkey
.start
);
9004 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9005 first_unbound
< keytran
.start
)
9006 { /* The prefix upto first_unbound has no binding and has
9007 no translation left to do either, so we know it's unbound.
9008 If we don't stop now, we risk staying here indefinitely
9009 (if the user keeps entering fkey or keytran prefixes
9010 like C-c ESC ESC ESC ESC ...) */
9012 for (i
= first_unbound
+ 1; i
< t
; i
++)
9013 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9014 mock_input
= t
- first_unbound
- 1;
9015 indec
.end
= indec
.start
-= first_unbound
+ 1;
9016 indec
.map
= indec
.parent
;
9017 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9018 fkey
.map
= fkey
.parent
;
9019 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9020 keytran
.map
= keytran
.parent
;
9021 goto replay_sequence
;
9025 error ("Key sequence too long");
9028 echo_local_start
= echo_length ();
9029 keys_local_start
= this_command_key_count
;
9032 /* These are no-ops, unless we throw away a keystroke below and
9033 jumped back up to replay_key; in that case, these restore the
9034 variables to their original state, allowing us to replay the
9036 if (INTERACTIVE
&& t
< mock_input
)
9037 echo_truncate (echo_local_start
);
9038 this_command_key_count
= keys_local_start
;
9040 /* By default, assume each event is "real". */
9041 last_real_key_start
= t
;
9043 /* Does mock_input indicate that we are re-reading a key sequence? */
9047 add_command_key (key
);
9048 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9049 && NILP (Fzerop (Vecho_keystrokes
))
9050 && current_kboard
->immediate_echo
)
9057 /* If not, we should actually read a character. */
9061 KBOARD
*interrupted_kboard
= current_kboard
;
9062 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9063 /* Calling read_char with COMMANDFLAG = -2 avoids
9064 redisplay in read_char and its subroutines. */
9065 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9066 current_binding
, last_nonmenu_event
,
9067 &used_mouse_menu
, NULL
);
9068 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9069 /* When switching to a new tty (with a new keyboard),
9070 read_char returns the new buffer, rather than -2
9071 (Bug#5095). This is because `terminal-init-xterm'
9072 calls read-char, which eats the wrong_kboard_jmpbuf
9073 return. Any better way to fix this? -- cyd */
9074 || (interrupted_kboard
!= current_kboard
))
9079 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9080 if (k
== interrupted_kboard
)
9085 /* Don't touch interrupted_kboard when it's been
9087 delayed_switch_frame
= Qnil
;
9088 goto replay_entire_sequence
;
9091 if (!NILP (delayed_switch_frame
))
9094 (interrupted_kboard
,
9095 Fcons (delayed_switch_frame
,
9096 KVAR (interrupted_kboard
, kbd_queue
)));
9097 delayed_switch_frame
= Qnil
;
9102 (interrupted_kboard
,
9103 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9105 /* If the side queue is non-empty, ensure it begins with a
9106 switch-frame, so we'll replay it in the right context. */
9107 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9108 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9109 !(EVENT_HAS_PARAMETERS (key
)
9110 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9114 XSETFRAME (frame
, interrupted_frame
);
9116 (interrupted_kboard
,
9117 Fcons (make_lispy_switch_frame (frame
),
9118 KVAR (interrupted_kboard
, kbd_queue
)));
9121 goto replay_entire_sequence
;
9125 /* read_char returns t when it shows a menu and the user rejects it.
9129 unbind_to (count
, Qnil
);
9134 /* read_char returns -1 at the end of a macro.
9135 Emacs 18 handles this by returning immediately with a
9136 zero, so that's what we'll do. */
9137 if (INTEGERP (key
) && XINT (key
) == -1)
9140 /* The Microsoft C compiler can't handle the goto that
9146 /* If the current buffer has been changed from under us, the
9147 keymap may have changed, so replay the sequence. */
9150 timer_resume_idle ();
9153 /* Reset the current buffer from the selected window
9154 in case something changed the former and not the latter.
9155 This is to be more consistent with the behavior
9156 of the command_loop_1. */
9157 if (fix_current_buffer
)
9159 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9161 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9163 Fset_buffer (XWINDOW (selected_window
)->contents
);
9166 goto replay_sequence
;
9169 /* If we have a quit that was typed in another frame, and
9170 quit_throw_to_read_char switched buffers,
9171 replay to get the right keymap. */
9173 && XINT (key
) == quit_char
9174 && current_buffer
!= starting_buffer
)
9177 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9182 goto replay_sequence
;
9187 if (EVENT_HAS_PARAMETERS (key
)
9188 /* Either a `switch-frame' or a `select-window' event. */
9189 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9191 /* If we're at the beginning of a key sequence, and the caller
9192 says it's okay, go ahead and return this event. If we're
9193 in the midst of a key sequence, delay it until the end. */
9194 if (t
> 0 || !can_return_switch_frame
)
9196 delayed_switch_frame
= key
;
9201 if (NILP (first_event
))
9204 /* Even if first_event does not specify a particular
9205 window/position, it's important to recompute the maps here
9206 since a long time might have passed since we entered
9207 read_key_sequence, and a timer (or process-filter or
9208 special-event-map, ...) might have switched the current buffer
9209 or the selected window from under us in the mean time. */
9210 if (fix_current_buffer
9211 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9213 Fset_buffer (XWINDOW (selected_window
)->contents
);
9214 current_binding
= active_maps (first_event
);
9218 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9222 /* Clicks in non-text areas get prefixed by the symbol
9223 in their CHAR-ADDRESS field. For example, a click on
9224 the mode line is prefixed by the symbol `mode-line'.
9226 Furthermore, key sequences beginning with mouse clicks
9227 are read using the keymaps of the buffer clicked on, not
9228 the current buffer. So we may have to switch the buffer
9231 When we turn one event into two events, we must make sure
9232 that neither of the two looks like the original--so that,
9233 if we replay the events, they won't be expanded again.
9234 If not for this, such reexpansion could happen either here
9235 or when user programs play with this-command-keys. */
9236 if (EVENT_HAS_PARAMETERS (key
))
9238 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9239 if (EQ (kind
, Qmouse_click
))
9241 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9242 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9245 || (!NILP (fake_prefixed_keys
)
9246 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9248 /* We're looking a second time at an event for which
9249 we generated a fake prefix key. Set
9250 last_real_key_start appropriately. */
9252 last_real_key_start
= t
- 1;
9255 if (last_real_key_start
== 0)
9257 /* Key sequences beginning with mouse clicks are
9258 read using the keymaps in the buffer clicked on,
9259 not the current buffer. If we're at the
9260 beginning of a key sequence, switch buffers. */
9261 if (WINDOWP (window
)
9262 && BUFFERP (XWINDOW (window
)->contents
)
9263 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9265 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9270 /* Arrange to go back to the original buffer once we're
9271 done reading the key sequence. Note that we can't
9272 use save_excursion_{save,restore} here, because they
9273 save point as well as the current buffer; we don't
9274 want to save point, because redisplay may change it,
9275 to accommodate a Fset_window_start or something. We
9276 don't want to do this at the top of the function,
9277 because we may get input from a subprocess which
9278 wants to change the selected window and stuff (say,
9280 record_unwind_current_buffer ();
9282 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9284 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9285 goto replay_sequence
;
9289 /* Expand mode-line and scroll-bar events into two events:
9290 use posn as a fake prefix key. */
9292 && (NILP (fake_prefixed_keys
)
9293 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9295 if (bufsize
- t
<= 1)
9296 error ("Key sequence too long");
9299 keybuf
[t
+ 1] = key
;
9302 /* Record that a fake prefix key has been generated
9303 for KEY. Don't modify the event; this would
9304 prevent proper action when the event is pushed
9305 back into unread-command-events. */
9306 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9310 else if (CONSP (XCDR (key
))
9311 && CONSP (EVENT_START (key
))
9312 && CONSP (XCDR (EVENT_START (key
))))
9316 posn
= POSN_POSN (EVENT_START (key
));
9317 /* Handle menu-bar events:
9318 insert the dummy prefix event `menu-bar'. */
9319 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9321 if (bufsize
- t
<= 1)
9322 error ("Key sequence too long");
9324 keybuf
[t
+ 1] = key
;
9326 /* Zap the position in key, so we know that we've
9327 expanded it, and don't try to do so again. */
9328 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9331 goto replay_sequence
;
9333 else if (CONSP (posn
))
9335 /* We're looking at the second event of a
9336 sequence which we expanded before. Set
9337 last_real_key_start appropriately. */
9338 if (last_real_key_start
== t
&& t
> 0)
9339 last_real_key_start
= t
- 1;
9344 /* We have finally decided that KEY is something we might want
9346 new_binding
= follow_key (current_binding
, key
);
9348 /* If KEY wasn't bound, we'll try some fallbacks. */
9349 if (!NILP (new_binding
))
9350 /* This is needed for the following scenario:
9351 event 0: a down-event that gets dropped by calling replay_key.
9352 event 1: some normal prefix like C-h.
9353 After event 0, first_unbound is 0, after event 1 indec.start,
9354 fkey.start, and keytran.start are all 1, so when we see that
9355 C-h is bound, we need to update first_unbound. */
9356 first_unbound
= max (t
+ 1, first_unbound
);
9361 /* Remember the position to put an upper bound on indec.start. */
9362 first_unbound
= min (t
, first_unbound
);
9364 head
= EVENT_HEAD (key
);
9365 if (help_char_p (head
) && t
> 0)
9367 read_key_sequence_cmd
= Vprefix_help_command
;
9369 last_nonmenu_event
= key
;
9370 /* The Microsoft C compiler can't handle the goto that
9378 Lisp_Object breakdown
;
9381 breakdown
= parse_modifiers (head
);
9382 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9383 /* Attempt to reduce an unbound mouse event to a simpler
9384 event that is bound:
9385 Drags reduce to clicks.
9386 Double-clicks reduce to clicks.
9387 Triple-clicks reduce to double-clicks, then to clicks.
9388 Down-clicks are eliminated.
9389 Double-downs reduce to downs, then are eliminated.
9390 Triple-downs reduce to double-downs, then to downs,
9391 then are eliminated. */
9392 if (modifiers
& (down_modifier
| drag_modifier
9393 | double_modifier
| triple_modifier
))
9395 while (modifiers
& (down_modifier
| drag_modifier
9396 | double_modifier
| triple_modifier
))
9398 Lisp_Object new_head
, new_click
;
9399 if (modifiers
& triple_modifier
)
9400 modifiers
^= (double_modifier
| triple_modifier
);
9401 else if (modifiers
& double_modifier
)
9402 modifiers
&= ~double_modifier
;
9403 else if (modifiers
& drag_modifier
)
9404 modifiers
&= ~drag_modifier
;
9407 /* Dispose of this `down' event by simply jumping
9408 back to replay_key, to get another event.
9410 Note that if this event came from mock input,
9411 then just jumping back to replay_key will just
9412 hand it to us again. So we have to wipe out any
9415 We could delete keybuf[t] and shift everything
9416 after that to the left by one spot, but we'd also
9417 have to fix up any variable that points into
9418 keybuf, and shifting isn't really necessary
9421 Adding prefixes for non-textual mouse clicks
9422 creates two characters of mock input, and both
9423 must be thrown away. If we're only looking at
9424 the prefix now, we can just jump back to
9425 replay_key. On the other hand, if we've already
9426 processed the prefix, and now the actual click
9427 itself is giving us trouble, then we've lost the
9428 state of the keymaps we want to backtrack to, and
9429 we need to replay the whole sequence to rebuild
9432 Beyond that, only function key expansion could
9433 create more than two keys, but that should never
9434 generate mouse events, so it's okay to zero
9435 mock_input in that case too.
9437 FIXME: The above paragraph seems just plain
9438 wrong, if you consider things like
9439 xterm-mouse-mode. -stef
9441 Isn't this just the most wonderful code ever? */
9443 /* If mock_input > t + 1, the above simplification
9444 will actually end up dropping keys on the floor.
9445 This is probably OK for now, but even
9446 if mock_input <= t + 1, we need to adjust indec,
9448 Typical case [header-line down-mouse-N]:
9449 mock_input = 2, t = 1, fkey.end = 1,
9450 last_real_key_start = 0. */
9451 if (indec
.end
> last_real_key_start
)
9453 indec
.end
= indec
.start
9454 = min (last_real_key_start
, indec
.start
);
9455 indec
.map
= indec
.parent
;
9456 if (fkey
.end
> last_real_key_start
)
9458 fkey
.end
= fkey
.start
9459 = min (last_real_key_start
, fkey
.start
);
9460 fkey
.map
= fkey
.parent
;
9461 if (keytran
.end
> last_real_key_start
)
9463 keytran
.end
= keytran
.start
9464 = min (last_real_key_start
, keytran
.start
);
9465 keytran
.map
= keytran
.parent
;
9469 if (t
== last_real_key_start
)
9476 mock_input
= last_real_key_start
;
9477 goto replay_sequence
;
9482 = apply_modifiers (modifiers
, XCAR (breakdown
));
9483 new_click
= list2 (new_head
, EVENT_START (key
));
9485 /* Look for a binding for this new key. */
9486 new_binding
= follow_key (current_binding
, new_click
);
9488 /* If that click is bound, go for it. */
9489 if (!NILP (new_binding
))
9491 current_binding
= new_binding
;
9495 /* Otherwise, we'll leave key set to the drag event. */
9500 current_binding
= new_binding
;
9503 /* Normally, last_nonmenu_event gets the previous key we read.
9504 But when a mouse popup menu is being used,
9505 we don't update last_nonmenu_event; it continues to hold the mouse
9506 event that preceded the first level of menu. */
9507 if (!used_mouse_menu
)
9508 last_nonmenu_event
= key
;
9510 /* Record what part of this_command_keys is the current key sequence. */
9511 this_single_command_key_start
= this_command_key_count
- t
;
9513 /* Look for this sequence in input-decode-map.
9514 Scan from indec.end until we find a bound suffix. */
9515 while (indec
.end
< t
)
9517 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9521 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9522 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9527 mock_input
= diff
+ max (t
, mock_input
);
9528 goto replay_sequence
;
9532 if (!KEYMAPP (current_binding
)
9533 && !test_undefined (current_binding
)
9534 && indec
.start
>= t
)
9535 /* There is a binding and it's not a prefix.
9536 (and it doesn't have any input-decode-map translation pending).
9537 There is thus no function-key in this sequence.
9538 Moving fkey.start is important in this case to allow keytran.start
9539 to go over the sequence before we return (since we keep the
9540 invariant that keytran.end <= fkey.start). */
9543 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9546 /* If the sequence is unbound, see if we can hang a function key
9547 off the end of it. */
9548 /* Continue scan from fkey.end until we find a bound suffix. */
9549 while (fkey
.end
< indec
.start
)
9551 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9555 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9556 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9557 max (t
, mock_input
),
9558 /* If there's a binding (i.e.
9559 first_binding >= nmaps) we don't want
9560 to apply this function-key-mapping. */
9562 && (test_undefined (current_binding
)),
9567 mock_input
= diff
+ max (t
, mock_input
);
9568 /* Adjust the input-decode-map counters. */
9570 indec
.start
+= diff
;
9572 goto replay_sequence
;
9576 /* Look for this sequence in key-translation-map.
9577 Scan from keytran.end until we find a bound suffix. */
9578 while (keytran
.end
< fkey
.start
)
9580 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9584 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9585 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9590 mock_input
= diff
+ max (t
, mock_input
);
9591 /* Adjust the function-key-map and input-decode-map counters. */
9593 indec
.start
+= diff
;
9597 goto replay_sequence
;
9601 /* If KEY is not defined in any of the keymaps,
9602 and cannot be part of a function key or translation,
9603 and is an upper case letter
9604 use the corresponding lower-case letter instead. */
9605 if (NILP (current_binding
)
9606 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9608 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9609 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9610 || (XINT (key
) & shift_modifier
)))
9612 Lisp_Object new_key
;
9614 original_uppercase
= key
;
9615 original_uppercase_position
= t
- 1;
9617 if (XINT (key
) & shift_modifier
)
9618 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9620 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9621 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9623 /* We have to do this unconditionally, regardless of whether
9624 the lower-case char is defined in the keymaps, because they
9625 might get translated through function-key-map. */
9626 keybuf
[t
- 1] = new_key
;
9627 mock_input
= max (t
, mock_input
);
9628 shift_translated
= 1;
9630 goto replay_sequence
;
9632 /* If KEY is not defined in any of the keymaps,
9633 and cannot be part of a function key or translation,
9634 and is a shifted function key,
9635 use the corresponding unshifted function key instead. */
9636 if (NILP (current_binding
)
9637 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9639 Lisp_Object breakdown
= parse_modifiers (key
);
9641 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9643 if (modifiers
& shift_modifier
9644 /* Treat uppercase keys as shifted. */
9646 && (KEY_TO_CHAR (key
)
9647 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9648 && uppercasep (KEY_TO_CHAR (key
))))
9651 = (modifiers
& shift_modifier
9652 ? apply_modifiers (modifiers
& ~shift_modifier
,
9654 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9656 original_uppercase
= key
;
9657 original_uppercase_position
= t
- 1;
9659 /* We have to do this unconditionally, regardless of whether
9660 the lower-case char is defined in the keymaps, because they
9661 might get translated through function-key-map. */
9662 keybuf
[t
- 1] = new_key
;
9663 mock_input
= max (t
, mock_input
);
9664 /* Reset fkey (and consequently keytran) to apply
9665 function-key-map on the result, so that S-backspace is
9666 correctly mapped to DEL (via backspace). OTOH,
9667 input-decode-map doesn't need to go through it again. */
9668 fkey
.start
= fkey
.end
= 0;
9669 keytran
.start
= keytran
.end
= 0;
9670 shift_translated
= 1;
9672 goto replay_sequence
;
9677 read_key_sequence_cmd
= current_binding
;
9678 read_key_sequence_remapped
9679 /* Remap command through active keymaps.
9680 Do the remapping here, before the unbind_to so it uses the keymaps
9681 of the appropriate buffer. */
9682 = SYMBOLP (read_key_sequence_cmd
)
9683 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9686 unread_switch_frame
= delayed_switch_frame
;
9687 unbind_to (count
, Qnil
);
9689 /* Don't downcase the last character if the caller says don't.
9690 Don't downcase it if the result is undefined, either. */
9691 if ((dont_downcase_last
|| NILP (current_binding
))
9693 && t
- 1 == original_uppercase_position
)
9695 keybuf
[t
- 1] = original_uppercase
;
9696 shift_translated
= 0;
9699 if (shift_translated
)
9700 Vthis_command_keys_shift_translated
= Qt
;
9702 /* Occasionally we fabricate events, perhaps by expanding something
9703 according to function-key-map, or by adding a prefix symbol to a
9704 mouse click in the scroll bar or modeline. In this cases, return
9705 the entire generated key sequence, even if we hit an unbound
9706 prefix or a definition before the end. This means that you will
9707 be able to push back the event properly, and also means that
9708 read-key-sequence will always return a logical unit.
9711 for (; t
< mock_input
; t
++)
9713 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9714 && NILP (Fzerop (Vecho_keystrokes
)))
9715 echo_char (keybuf
[t
]);
9716 add_command_key (keybuf
[t
]);
9724 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9725 Lisp_Object dont_downcase_last
,
9726 Lisp_Object can_return_switch_frame
,
9727 Lisp_Object cmd_loop
, bool allow_string
)
9729 Lisp_Object keybuf
[30];
9731 struct gcpro gcpro1
;
9732 ptrdiff_t count
= SPECPDL_INDEX ();
9735 CHECK_STRING (prompt
);
9738 specbind (Qinput_method_exit_on_first_char
,
9739 (NILP (cmd_loop
) ? Qt
: Qnil
));
9740 specbind (Qinput_method_use_echo_area
,
9741 (NILP (cmd_loop
) ? Qt
: Qnil
));
9743 memset (keybuf
, 0, sizeof keybuf
);
9745 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9747 if (NILP (continue_echo
))
9749 this_command_key_count
= 0;
9750 this_command_key_count_reset
= 0;
9751 this_single_command_key_start
= 0;
9754 #ifdef HAVE_WINDOW_SYSTEM
9755 if (display_hourglass_p
)
9756 cancel_hourglass ();
9759 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9760 prompt
, ! NILP (dont_downcase_last
),
9761 ! NILP (can_return_switch_frame
), 0, 0);
9763 #if 0 /* The following is fine for code reading a key sequence and
9764 then proceeding with a lengthy computation, but it's not good
9765 for code reading keys in a loop, like an input method. */
9766 #ifdef HAVE_WINDOW_SYSTEM
9767 if (display_hourglass_p
)
9778 return unbind_to (count
,
9779 ((allow_string
? make_event_array
: Fvector
)
9783 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9784 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9785 The sequence is sufficient to specify a non-prefix command in the
9786 current local and global maps.
9788 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9789 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9790 as a continuation of the previous key.
9792 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9793 convert the last event to lower case. (Normally any upper case event
9794 is converted to lower case if the original event is undefined and the lower
9795 case equivalent is defined.) A non-nil value is appropriate for reading
9796 a key sequence to be defined.
9798 A C-g typed while in this function is treated like any other character,
9799 and `quit-flag' is not set.
9801 If the key sequence starts with a mouse click, then the sequence is read
9802 using the keymaps of the buffer of the window clicked in, not the buffer
9803 of the selected window as normal.
9805 `read-key-sequence' drops unbound button-down events, since you normally
9806 only care about the click or drag events which follow them. If a drag
9807 or multi-click event is unbound, but the corresponding click event would
9808 be bound, `read-key-sequence' turns the event into a click event at the
9809 drag's starting position. This means that you don't have to distinguish
9810 between click and drag, double, or triple events unless you want to.
9812 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9813 lines separating windows, and scroll bars with imaginary keys
9814 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9816 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9817 function will process a switch-frame event if the user switches frames
9818 before typing anything. If the user switches frames in the middle of a
9819 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9820 is nil, then the event will be put off until after the current key sequence.
9822 `read-key-sequence' checks `function-key-map' for function key
9823 sequences, where they wouldn't conflict with ordinary bindings. See
9824 `function-key-map' for more details.
9826 The optional fifth argument CMD-LOOP, if non-nil, means
9827 that this key sequence is being read by something that will
9828 read commands one after another. It should be nil if the caller
9829 will read just one key sequence. */)
9830 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9832 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9833 can_return_switch_frame
, cmd_loop
, true);
9836 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9837 Sread_key_sequence_vector
, 1, 5, 0,
9838 doc
: /* Like `read-key-sequence' but always return a vector. */)
9839 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9841 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9842 can_return_switch_frame
, cmd_loop
, false);
9845 /* Return true if input events are pending. */
9848 detect_input_pending (void)
9850 return input_pending
|| get_input_pending (0);
9853 /* Return true if input events other than mouse movements are
9857 detect_input_pending_ignore_squeezables (void)
9859 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9862 /* Return true if input events are pending, and run any pending timers. */
9865 detect_input_pending_run_timers (bool do_display
)
9867 unsigned old_timers_run
= timers_run
;
9870 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9872 if (old_timers_run
!= timers_run
&& do_display
)
9873 redisplay_preserve_echo_area (8);
9875 return input_pending
;
9878 /* This is called in some cases before a possible quit.
9879 It cases the next call to detect_input_pending to recompute input_pending.
9880 So calling this function unnecessarily can't do any harm. */
9883 clear_input_pending (void)
9888 /* Return true if there are pending requeued events.
9889 This isn't used yet. The hope is to make wait_reading_process_output
9890 call it, and return if it runs Lisp code that unreads something.
9891 The problem is, kbd_buffer_get_event needs to be fixed to know what
9892 to do in that case. It isn't trivial. */
9895 requeued_events_pending_p (void)
9897 return (!NILP (Vunread_command_events
));
9900 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9901 doc
: /* Return t if command input is currently available with no wait.
9902 Actually, the value is nil only if we can be sure that no input is available;
9903 if there is a doubt, the value is t.
9905 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9906 (Lisp_Object check_timers
)
9908 if (!NILP (Vunread_command_events
)
9909 || !NILP (Vunread_post_input_method_events
)
9910 || !NILP (Vunread_input_method_events
))
9913 /* Process non-user-visible events (Bug#10195). */
9914 process_special_events ();
9916 return (get_input_pending ((NILP (check_timers
)
9917 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9918 | READABLE_EVENTS_FILTER_EVENTS
)
9922 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9923 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9926 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9929 if (total_keys
< NUM_RECENT_KEYS
)
9930 return Fvector (total_keys
, keys
);
9933 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9934 vcopy (val
, 0, keys
+ recent_keys_index
,
9935 NUM_RECENT_KEYS
- recent_keys_index
);
9936 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9937 keys
, recent_keys_index
);
9942 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9943 doc
: /* Return the key sequence that invoked this command.
9944 However, if the command has called `read-key-sequence', it returns
9945 the last key sequence that has been read.
9946 The value is a string or a vector.
9948 See also `this-command-keys-vector'. */)
9951 return make_event_array (this_command_key_count
,
9952 XVECTOR (this_command_keys
)->contents
);
9955 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9956 doc
: /* Return the key sequence that invoked this command, as a vector.
9957 However, if the command has called `read-key-sequence', it returns
9958 the last key sequence that has been read.
9960 See also `this-command-keys'. */)
9963 return Fvector (this_command_key_count
,
9964 XVECTOR (this_command_keys
)->contents
);
9967 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9968 Sthis_single_command_keys
, 0, 0, 0,
9969 doc
: /* Return the key sequence that invoked this command.
9970 More generally, it returns the last key sequence read, either by
9971 the command loop or by `read-key-sequence'.
9972 Unlike `this-command-keys', this function's value
9973 does not include prefix arguments.
9974 The value is always a vector. */)
9977 return Fvector (this_command_key_count
9978 - this_single_command_key_start
,
9979 (XVECTOR (this_command_keys
)->contents
9980 + this_single_command_key_start
));
9983 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9984 Sthis_single_command_raw_keys
, 0, 0, 0,
9985 doc
: /* Return the raw events that were read for this command.
9986 More generally, it returns the last key sequence read, either by
9987 the command loop or by `read-key-sequence'.
9988 Unlike `this-single-command-keys', this function's value
9989 shows the events before all translations (except for input methods).
9990 The value is always a vector. */)
9993 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
9996 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
9997 Sreset_this_command_lengths
, 0, 0, 0,
9998 doc
: /* Make the unread events replace the last command and echo.
9999 Used in `universal-argument-other-key'.
10001 `universal-argument-other-key' rereads the event just typed.
10002 It then gets translated through `function-key-map'.
10003 The translated event has to replace the real events,
10004 both in the value of (this-command-keys) and in echoing.
10005 To achieve this, `universal-argument-other-key' calls
10006 `reset-this-command-lengths', which discards the record of reading
10007 these events the first time. */)
10010 this_command_key_count
= before_command_key_count
;
10011 if (this_command_key_count
< this_single_command_key_start
)
10012 this_single_command_key_start
= this_command_key_count
;
10014 echo_truncate (before_command_echo_length
);
10016 /* Cause whatever we put into unread-command-events
10017 to echo as if it were being freshly read from the keyboard. */
10018 this_command_key_count_reset
= 1;
10023 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10024 Sclear_this_command_keys
, 0, 1, 0,
10025 doc
: /* Clear out the vector that `this-command-keys' returns.
10026 Also clear the record of the last 100 events, unless optional arg
10027 KEEP-RECORD is non-nil. */)
10028 (Lisp_Object keep_record
)
10032 this_command_key_count
= 0;
10033 this_command_key_count_reset
= 0;
10035 if (NILP (keep_record
))
10037 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10038 ASET (recent_keys
, i
, Qnil
);
10040 recent_keys_index
= 0;
10045 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10046 doc
: /* Return the current depth in recursive edits. */)
10050 /* Wrap around reliably on integer overflow. */
10051 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10052 XSETINT (temp
, sum
);
10056 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10057 "FOpen dribble file: ",
10058 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10059 If FILE is nil, close any open dribble file.
10060 The file will be closed when Emacs exits. */)
10072 file
= Fexpand_file_name (file
, Qnil
);
10073 dribble
= emacs_fopen (SSDATA (file
), "w");
10075 report_file_error ("Opening dribble", file
);
10080 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10081 doc
: /* Discard the contents of the terminal input buffer.
10082 Also end any kbd macro being defined. */)
10085 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10087 /* Discard the last command from the macro. */
10088 Fcancel_kbd_macro_events ();
10092 Vunread_command_events
= Qnil
;
10094 discard_tty_input ();
10096 kbd_fetch_ptr
= kbd_store_ptr
;
10102 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10103 doc
: /* Stop Emacs and return to superior process. You can resume later.
10104 If `cannot-suspend' is non-nil, or if the system doesn't support job
10105 control, run a subshell instead.
10107 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10108 to be read as terminal input by Emacs's parent, after suspension.
10110 Before suspending, run the normal hook `suspend-hook'.
10111 After resumption run the normal hook `suspend-resume-hook'.
10113 Some operating systems cannot stop the Emacs process and resume it later.
10114 On such systems, Emacs starts a subshell instead of suspending. */)
10115 (Lisp_Object stuffstring
)
10117 ptrdiff_t count
= SPECPDL_INDEX ();
10118 int old_height
, old_width
;
10120 struct gcpro gcpro1
;
10123 if (tty_list
&& tty_list
->next
)
10124 error ("There are other tty frames open; close them before suspending Emacs");
10126 if (!NILP (stuffstring
))
10127 CHECK_STRING (stuffstring
);
10129 /* Run the functions in suspend-hook. */
10130 hook
= intern ("suspend-hook");
10131 Frun_hooks (1, &hook
);
10133 GCPRO1 (stuffstring
);
10134 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10135 reset_all_sys_modes ();
10136 /* sys_suspend can get an error if it tries to fork a subshell
10137 and the system resources aren't available for that. */
10138 record_unwind_protect_void (init_all_sys_modes
);
10139 stuff_buffered_input (stuffstring
);
10140 if (cannot_suspend
)
10144 unbind_to (count
, Qnil
);
10146 /* Check if terminal/window size has changed.
10147 Note that this is not useful when we are running directly
10148 with a window system; but suspend should be disabled in that case. */
10149 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10150 if (width
!= old_width
|| height
!= old_height
)
10151 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10153 /* Run suspend-resume-hook. */
10154 hook
= intern ("suspend-resume-hook");
10155 Frun_hooks (1, &hook
);
10161 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10162 Then in any case stuff anything Emacs has read ahead and not used. */
10165 stuff_buffered_input (Lisp_Object stuffstring
)
10167 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10168 register unsigned char *p
;
10170 if (STRINGP (stuffstring
))
10172 register ptrdiff_t count
;
10174 p
= SDATA (stuffstring
);
10175 count
= SBYTES (stuffstring
);
10176 while (count
-- > 0)
10181 /* Anything we have read ahead, put back for the shell to read. */
10182 /* ?? What should this do when we have multiple keyboards??
10183 Should we ignore anything that was typed in at the "wrong" kboard?
10185 rms: we should stuff everything back into the kboard
10187 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10190 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10191 kbd_fetch_ptr
= kbd_buffer
;
10192 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10193 stuff_char (kbd_fetch_ptr
->code
);
10195 clear_event (kbd_fetch_ptr
);
10199 #endif /* SIGTSTP */
10203 set_waiting_for_input (struct timespec
*time_to_clear
)
10205 input_available_clear_time
= time_to_clear
;
10207 /* Tell handle_interrupt to throw back to read_char, */
10208 waiting_for_input
= 1;
10210 /* If handle_interrupt was called before and buffered a C-g,
10211 make it run again now, to avoid timing error. */
10212 if (!NILP (Vquit_flag
))
10213 quit_throw_to_read_char (0);
10217 clear_waiting_for_input (void)
10219 /* Tell handle_interrupt not to throw back to read_char, */
10220 waiting_for_input
= 0;
10221 input_available_clear_time
= 0;
10224 /* The SIGINT handler.
10226 If we have a frame on the controlling tty, we assume that the
10227 SIGINT was generated by C-g, so we call handle_interrupt.
10228 Otherwise, tell QUIT to kill Emacs. */
10231 handle_interrupt_signal (int sig
)
10233 /* See if we have an active terminal on our controlling tty. */
10234 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10237 /* If there are no frames there, let's pretend that we are a
10238 well-behaving UN*X program and quit. We must not call Lisp
10239 in a signal handler, so tell QUIT to exit when it is
10241 Vquit_flag
= Qkill_emacs
;
10245 /* Otherwise, the SIGINT was probably generated by C-g. */
10247 /* Set internal_last_event_frame to the top frame of the
10248 controlling tty, if we have a frame there. We disable the
10249 interrupt key on secondary ttys, so the SIGINT must have come
10250 from the controlling tty. */
10251 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10253 handle_interrupt (1);
10258 deliver_interrupt_signal (int sig
)
10260 deliver_process_signal (sig
, handle_interrupt_signal
);
10264 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10265 of the number of times C-g has been requested. If C-g is pressed
10266 enough times, then quit anyway. See bug#6585. */
10267 static int volatile force_quit_count
;
10269 /* This routine is called at interrupt level in response to C-g.
10271 It is called from the SIGINT handler or kbd_buffer_store_event.
10273 If `waiting_for_input' is non zero, then unless `echoing' is
10274 nonzero, immediately throw back to read_char.
10276 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10277 eval to throw, when it gets a chance. If quit-flag is already
10278 non-nil, it stops the job right away. */
10281 handle_interrupt (bool in_signal_handler
)
10287 /* XXX This code needs to be revised for multi-tty support. */
10288 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10290 if (! in_signal_handler
)
10292 /* If SIGINT isn't blocked, don't let us be interrupted by
10293 a SIGINT. It might be harmful due to non-reentrancy
10294 in I/O functions. */
10296 sigemptyset (&blocked
);
10297 sigaddset (&blocked
, SIGINT
);
10298 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10302 reset_all_sys_modes ();
10306 * On systems which can suspend the current process and return to the original
10307 * shell, this command causes the user to end up back at the shell.
10308 * The "Auto-save" and "Abort" questions are not asked until
10309 * the user elects to return to emacs, at which point he can save the current
10310 * job and either dump core or continue.
10314 /* Perhaps should really fork an inferior shell?
10315 But that would not provide any way to get back
10316 to the original shell, ever. */
10317 printf ("No support for stopping a process on this operating system;\n");
10318 printf ("you can continue or abort.\n");
10319 #endif /* not SIGTSTP */
10321 /* We must remain inside the screen area when the internal terminal
10322 is used. Note that [Enter] is not echoed by dos. */
10323 cursor_to (SELECTED_FRAME (), 0, 0);
10325 /* It doesn't work to autosave while GC is in progress;
10326 the code used for auto-saving doesn't cope with the mark bit. */
10327 if (!gc_in_progress
)
10329 printf ("Auto-save? (y or n) ");
10331 if (((c
= getchar ()) & ~040) == 'Y')
10333 Fdo_auto_save (Qt
, Qnil
);
10335 printf ("\r\nAuto-save done");
10336 #else /* not MSDOS */
10337 printf ("Auto-save done\n");
10338 #endif /* not MSDOS */
10340 while (c
!= '\n') c
= getchar ();
10344 /* During GC, it must be safe to reenable quitting again. */
10345 Vinhibit_quit
= Qnil
;
10348 #endif /* not MSDOS */
10349 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10350 printf ("but will instead do a real quit after garbage collection ends\r\n");
10355 printf ("\r\nAbort? (y or n) ");
10356 #else /* not MSDOS */
10357 printf ("Abort (and dump core)? (y or n) ");
10358 #endif /* not MSDOS */
10360 if (((c
= getchar ()) & ~040) == 'Y')
10362 while (c
!= '\n') c
= getchar ();
10364 printf ("\r\nContinuing...\r\n");
10365 #else /* not MSDOS */
10366 printf ("Continuing...\n");
10367 #endif /* not MSDOS */
10369 init_all_sys_modes ();
10373 /* If executing a function that wants to be interrupted out of
10374 and the user has not deferred quitting by binding `inhibit-quit'
10375 then quit right away. */
10376 if (immediate_quit
&& NILP (Vinhibit_quit
))
10378 struct gl_state_s saved
;
10379 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10381 immediate_quit
= 0;
10382 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10384 GCPRO4 (saved
.object
, saved
.global_code
,
10385 saved
.current_syntax_table
, saved
.old_prop
);
10386 Fsignal (Qquit
, Qnil
);
10391 { /* Else request quit when it's safe. */
10392 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10393 force_quit_count
= count
;
10396 immediate_quit
= 1;
10397 Vinhibit_quit
= Qnil
;
10403 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10405 /* TODO: The longjmp in this call throws the NS event loop integration off,
10406 and it seems to do fine without this. Probably some attention
10407 needs to be paid to the setting of waiting_for_input in
10408 wait_reading_process_output() under HAVE_NS because of the call
10409 to ns_select there (needed because otherwise events aren't picked up
10410 outside of polling since we don't get SIGIO like X and we don't have a
10411 separate event loop thread like W32. */
10413 if (waiting_for_input
&& !echoing
)
10414 quit_throw_to_read_char (in_signal_handler
);
10418 /* Handle a C-g by making read_char return C-g. */
10421 quit_throw_to_read_char (bool from_signal
)
10423 /* When not called from a signal handler it is safe to call
10425 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10426 Fkill_emacs (Qnil
);
10428 /* Prevent another signal from doing this before we finish. */
10429 clear_waiting_for_input ();
10432 Vunread_command_events
= Qnil
;
10434 if (FRAMEP (internal_last_event_frame
)
10435 && !EQ (internal_last_event_frame
, selected_frame
))
10436 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10439 sys_longjmp (getcjmp
, 1);
10442 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10443 Sset_input_interrupt_mode
, 1, 1, 0,
10444 doc
: /* Set interrupt mode of reading keyboard input.
10445 If INTERRUPT is non-nil, Emacs will use input interrupts;
10446 otherwise Emacs uses CBREAK mode.
10448 See also `current-input-mode'. */)
10449 (Lisp_Object interrupt
)
10451 bool new_interrupt_input
;
10452 #ifdef USABLE_SIGIO
10453 #ifdef HAVE_X_WINDOWS
10454 if (x_display_list
!= NULL
)
10456 /* When using X, don't give the user a real choice,
10457 because we haven't implemented the mechanisms to support it. */
10458 new_interrupt_input
= 1;
10461 #endif /* HAVE_X_WINDOWS */
10462 new_interrupt_input
= !NILP (interrupt
);
10463 #else /* not USABLE_SIGIO */
10464 new_interrupt_input
= 0;
10465 #endif /* not USABLE_SIGIO */
10467 if (new_interrupt_input
!= interrupt_input
)
10469 #ifdef POLL_FOR_INPUT
10473 /* this causes startup screen to be restored and messes with the mouse */
10474 reset_all_sys_modes ();
10475 interrupt_input
= new_interrupt_input
;
10476 init_all_sys_modes ();
10478 interrupt_input
= new_interrupt_input
;
10481 #ifdef POLL_FOR_INPUT
10482 poll_suppress_count
= 1;
10489 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10490 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10491 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10492 C-q in key sequences.
10494 This setting only has an effect on tty terminals and only when
10495 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10497 See also `current-input-mode'. */)
10498 (Lisp_Object flow
, Lisp_Object terminal
)
10500 struct terminal
*t
= get_terminal (terminal
, 1);
10501 struct tty_display_info
*tty
;
10502 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10504 tty
= t
->display_info
.tty
;
10506 if (tty
->flow_control
!= !NILP (flow
))
10509 /* This causes startup screen to be restored and messes with the mouse. */
10510 reset_sys_modes (tty
);
10513 tty
->flow_control
= !NILP (flow
);
10516 init_sys_modes (tty
);
10522 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10523 doc
: /* Enable or disable 8-bit input on TERMINAL.
10524 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10525 bit as the Meta modifier.
10527 If META is nil, Emacs will ignore the top bit, on the assumption it is
10530 Otherwise, Emacs will accept and pass through 8-bit input without
10531 specially interpreting the top bit.
10533 This setting only has an effect on tty terminal devices.
10535 Optional parameter TERMINAL specifies the tty terminal device to use.
10536 It may be a terminal object, a frame, or nil for the terminal used by
10537 the currently selected frame.
10539 See also `current-input-mode'. */)
10540 (Lisp_Object meta
, Lisp_Object terminal
)
10542 struct terminal
*t
= get_terminal (terminal
, 1);
10543 struct tty_display_info
*tty
;
10546 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10548 tty
= t
->display_info
.tty
;
10552 else if (EQ (meta
, Qt
))
10557 if (tty
->meta_key
!= new_meta
)
10560 /* this causes startup screen to be restored and messes with the mouse */
10561 reset_sys_modes (tty
);
10564 tty
->meta_key
= new_meta
;
10567 init_sys_modes (tty
);
10573 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10574 doc
: /* Specify character used for quitting.
10575 QUIT must be an ASCII character.
10577 This function only has an effect on the controlling tty of the Emacs
10580 See also `current-input-mode'. */)
10583 struct terminal
*t
= get_named_tty ("/dev/tty");
10584 struct tty_display_info
*tty
;
10585 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10587 tty
= t
->display_info
.tty
;
10589 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10590 error ("QUIT must be an ASCII character");
10593 /* this causes startup screen to be restored and messes with the mouse */
10594 reset_sys_modes (tty
);
10597 /* Don't let this value be out of range. */
10598 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10601 init_sys_modes (tty
);
10607 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10608 doc
: /* Set mode of reading keyboard input.
10609 First arg INTERRUPT non-nil means use input interrupts;
10610 nil means use CBREAK mode.
10611 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10612 (no effect except in CBREAK mode).
10613 Third arg META t means accept 8-bit input (for a Meta key).
10614 META nil means ignore the top bit, on the assumption it is parity.
10615 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10616 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10617 See also `current-input-mode'. */)
10618 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10620 Fset_input_interrupt_mode (interrupt
);
10621 Fset_output_flow_control (flow
, Qnil
);
10622 Fset_input_meta_mode (meta
, Qnil
);
10624 Fset_quit_char (quit
);
10628 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10629 doc
: /* Return information about the way Emacs currently reads keyboard input.
10630 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10631 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10632 nil, Emacs is using CBREAK mode.
10633 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10634 terminal; this does not apply if Emacs uses interrupt-driven input.
10635 META is t if accepting 8-bit input with 8th bit as Meta flag.
10636 META nil means ignoring the top bit, on the assumption it is parity.
10637 META is neither t nor nil if accepting 8-bit input and using
10638 all 8 bits as the character code.
10639 QUIT is the character Emacs currently uses to quit.
10640 The elements of this list correspond to the arguments of
10641 `set-input-mode'. */)
10644 Lisp_Object val
[4];
10645 struct frame
*sf
= XFRAME (selected_frame
);
10647 val
[0] = interrupt_input
? Qt
: Qnil
;
10648 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10650 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10651 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10653 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10660 XSETFASTINT (val
[3], quit_char
);
10662 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10665 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10666 doc
: /* Return position information for pixel coordinates X and Y.
10667 By default, X and Y are relative to text area of the selected window.
10668 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10669 If optional fourth arg WHOLE is non-nil, X is relative to the left
10670 edge of the window.
10672 The return value is similar to a mouse click position:
10673 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10674 IMAGE (DX . DY) (WIDTH . HEIGHT))
10675 The `posn-' functions access elements of such lists. */)
10676 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10681 if (NILP (frame_or_window
))
10682 frame_or_window
= selected_window
;
10684 if (WINDOWP (frame_or_window
))
10686 struct window
*w
= decode_live_window (frame_or_window
);
10688 XSETINT (x
, (XINT (x
)
10689 + WINDOW_LEFT_EDGE_X (w
)
10691 ? window_box_left_offset (w
, TEXT_AREA
)
10693 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10694 frame_or_window
= w
->frame
;
10697 CHECK_LIVE_FRAME (frame_or_window
);
10699 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10702 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10703 doc
: /* Return position information for buffer POS in WINDOW.
10704 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10706 Return nil if position is not visible in window. Otherwise,
10707 the return value is similar to that returned by `event-start' for
10708 a mouse click at the upper left corner of the glyph corresponding
10709 to the given buffer position:
10710 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10711 IMAGE (DX . DY) (WIDTH . HEIGHT))
10712 The `posn-' functions access elements of such lists. */)
10713 (Lisp_Object pos
, Lisp_Object window
)
10718 window
= selected_window
;
10720 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10723 Lisp_Object x
= XCAR (tem
);
10724 Lisp_Object y
= XCAR (XCDR (tem
));
10726 /* Point invisible due to hscrolling? */
10729 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10735 /* Set up a new kboard object with reasonable initial values.
10736 TYPE is a window system for which this keyboard is used. */
10739 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10741 kset_overriding_terminal_local_map (kb
, Qnil
);
10742 kset_last_command (kb
, Qnil
);
10743 kset_real_last_command (kb
, Qnil
);
10744 kset_keyboard_translate_table (kb
, Qnil
);
10745 kset_last_repeatable_command (kb
, Qnil
);
10746 kset_prefix_arg (kb
, Qnil
);
10747 kset_last_prefix_arg (kb
, Qnil
);
10748 kset_kbd_queue (kb
, Qnil
);
10749 kb
->kbd_queue_has_data
= 0;
10750 kb
->immediate_echo
= 0;
10751 kset_echo_string (kb
, Qnil
);
10752 kb
->echo_after_prompt
= -1;
10753 kb
->kbd_macro_buffer
= 0;
10754 kb
->kbd_macro_bufsize
= 0;
10755 kset_defining_kbd_macro (kb
, Qnil
);
10756 kset_last_kbd_macro (kb
, Qnil
);
10757 kb
->reference_count
= 0;
10758 kset_system_key_alist (kb
, Qnil
);
10759 kset_system_key_syms (kb
, Qnil
);
10760 kset_window_system (kb
, type
);
10761 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10762 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10763 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10764 kset_default_minibuffer_frame (kb
, Qnil
);
10767 /* Allocate and basically initialize keyboard
10768 object to use with window system TYPE. */
10771 allocate_kboard (Lisp_Object type
)
10773 KBOARD
*kb
= xmalloc (sizeof *kb
);
10775 init_kboard (kb
, type
);
10776 kb
->next_kboard
= all_kboards
;
10782 * Destroy the contents of a kboard object, but not the object itself.
10783 * We use this just before deleting it, or if we're going to initialize
10784 * it a second time.
10787 wipe_kboard (KBOARD
*kb
)
10789 xfree (kb
->kbd_macro_buffer
);
10792 /* Free KB and memory referenced from it. */
10795 delete_kboard (KBOARD
*kb
)
10799 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10802 *kbp
= kb
->next_kboard
;
10804 /* Prevent a dangling reference to KB. */
10805 if (kb
== current_kboard
10806 && FRAMEP (selected_frame
)
10807 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10809 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10811 if (current_kboard
== kb
)
10820 init_keyboard (void)
10822 /* This is correct before outermost invocation of the editor loop. */
10823 command_loop_level
= -1;
10824 immediate_quit
= 0;
10825 quit_char
= Ctl ('g');
10826 Vunread_command_events
= Qnil
;
10827 timer_idleness_start_time
= invalid_timespec ();
10829 recent_keys_index
= 0;
10830 kbd_fetch_ptr
= kbd_buffer
;
10831 kbd_store_ptr
= kbd_buffer
;
10832 do_mouse_tracking
= Qnil
;
10834 interrupt_input_blocked
= 0;
10835 pending_signals
= 0;
10837 /* This means that command_loop_1 won't try to select anything the first
10839 internal_last_event_frame
= Qnil
;
10840 Vlast_event_frame
= internal_last_event_frame
;
10842 current_kboard
= initial_kboard
;
10843 /* Re-initialize the keyboard again. */
10844 wipe_kboard (current_kboard
);
10845 /* A value of nil for Vwindow_system normally means a tty, but we also use
10846 it for the initial terminal since there is no window system there. */
10847 init_kboard (current_kboard
, Qnil
);
10849 if (!noninteractive
)
10851 /* Before multi-tty support, these handlers used to be installed
10852 only if the current session was a tty session. Now an Emacs
10853 session may have multiple display types, so we always handle
10854 SIGINT. There is special code in handle_interrupt_signal to exit
10855 Emacs on SIGINT when there are no termcap frames on the
10856 controlling terminal. */
10857 struct sigaction action
;
10858 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10859 sigaction (SIGINT
, &action
, 0);
10861 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10862 SIGQUIT and we can't tell which one it will give us. */
10863 sigaction (SIGQUIT
, &action
, 0);
10864 #endif /* not DOS_NT */
10866 #ifdef USABLE_SIGIO
10867 if (!noninteractive
)
10869 struct sigaction action
;
10870 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10871 sigaction (SIGIO
, &action
, 0);
10875 /* Use interrupt input by default, if it works and noninterrupt input
10876 has deficiencies. */
10878 #ifdef INTERRUPT_INPUT
10879 interrupt_input
= 1;
10881 interrupt_input
= 0;
10884 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10887 if (keyboard_init_hook
)
10888 (*keyboard_init_hook
) ();
10890 #ifdef POLL_FOR_INPUT
10892 poll_suppress_count
= 1;
10897 /* This type's only use is in syms_of_keyboard, to initialize the
10898 event header symbols and put properties on them. */
10899 struct event_head
{
10905 static const struct event_head head_table
[] = {
10906 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10907 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10908 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10909 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10910 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10911 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10912 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10913 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10914 /* `select-window' should be handled just like `switch-frame'
10915 in read_key_sequence. */
10916 {&Qselect_window
, "select-window", &Qswitch_frame
}
10920 syms_of_keyboard (void)
10922 pending_funcalls
= Qnil
;
10923 staticpro (&pending_funcalls
);
10925 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10926 staticpro (&Vlispy_mouse_stem
);
10929 DEFSYM (QCimage
, ":image");
10930 DEFSYM (Qhelp_echo
, "help-echo");
10931 DEFSYM (QCrtl
, ":rtl");
10933 staticpro (&item_properties
);
10934 item_properties
= Qnil
;
10936 staticpro (&tool_bar_item_properties
);
10937 tool_bar_item_properties
= Qnil
;
10938 staticpro (&tool_bar_items_vector
);
10939 tool_bar_items_vector
= Qnil
;
10941 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10942 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10943 DEFSYM (Qself_insert_command
, "self-insert-command");
10944 DEFSYM (Qforward_char
, "forward-char");
10945 DEFSYM (Qbackward_char
, "backward-char");
10946 DEFSYM (Qdisabled
, "disabled");
10947 DEFSYM (Qundefined
, "undefined");
10948 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10949 DEFSYM (Qpost_command_hook
, "post-command-hook");
10950 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10951 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10952 DEFSYM (Qfunction_key
, "function-key");
10953 DEFSYM (Qmouse_click
, "mouse-click");
10954 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10955 DEFSYM (Qsave_session
, "save-session");
10956 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10957 DEFSYM (Qmenu_enable
, "menu-enable");
10960 DEFSYM (Qlanguage_change
, "language-change");
10964 DEFSYM (Qdbus_event
, "dbus-event");
10967 #ifdef USE_FILE_NOTIFY
10968 DEFSYM (Qfile_notify
, "file-notify");
10969 #endif /* USE_FILE_NOTIFY */
10971 DEFSYM (QCenable
, ":enable");
10972 DEFSYM (QCvisible
, ":visible");
10973 DEFSYM (QChelp
, ":help");
10974 DEFSYM (QCfilter
, ":filter");
10975 DEFSYM (QCbutton
, ":button");
10976 DEFSYM (QCkeys
, ":keys");
10977 DEFSYM (QCkey_sequence
, ":key-sequence");
10978 DEFSYM (QCtoggle
, ":toggle");
10979 DEFSYM (QCradio
, ":radio");
10980 DEFSYM (QClabel
, ":label");
10981 DEFSYM (QCvert_only
, ":vert-only");
10983 DEFSYM (Qmode_line
, "mode-line");
10984 DEFSYM (Qvertical_line
, "vertical-line");
10985 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
10986 DEFSYM (Qmenu_bar
, "menu-bar");
10988 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
10990 DEFSYM (Qabove_handle
, "above-handle");
10991 DEFSYM (Qhandle
, "handle");
10992 DEFSYM (Qbelow_handle
, "below-handle");
10993 DEFSYM (Qup
, "up");
10994 DEFSYM (Qdown
, "down");
10995 DEFSYM (Qtop
, "top");
10996 DEFSYM (Qbottom
, "bottom");
10997 DEFSYM (Qend_scroll
, "end-scroll");
10998 DEFSYM (Qratio
, "ratio");
11000 DEFSYM (Qevent_kind
, "event-kind");
11001 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11002 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11003 DEFSYM (Qmodifier_cache
, "modifier-cache");
11005 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11006 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11008 DEFSYM (Qpolling_period
, "polling-period");
11010 DEFSYM (Qx_set_selection
, "x-set-selection");
11011 DEFSYM (QPRIMARY
, "PRIMARY");
11012 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11013 DEFSYM (Qhandle_select_window
, "handle-select-window");
11015 DEFSYM (Qinput_method_function
, "input-method-function");
11016 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11017 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11019 DEFSYM (Qhelp_form_show
, "help-form-show");
11021 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11023 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11024 Fset (Qinput_method_use_echo_area
, Qnil
);
11028 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11030 for (i
= 0; i
< len
; i
++)
11032 const struct event_head
*p
= &head_table
[i
];
11033 *p
->var
= intern_c_string (p
->name
);
11034 staticpro (p
->var
);
11035 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11036 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11040 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11041 staticpro (&button_down_location
);
11042 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11043 staticpro (&mouse_syms
);
11044 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11045 / sizeof (lispy_wheel_names
[0])),
11047 staticpro (&wheel_syms
);
11051 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11053 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11054 for (i
= 0; i
< len
; i
++)
11055 if (modifier_names
[i
])
11056 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11057 staticpro (&modifier_symbols
);
11060 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11061 staticpro (&recent_keys
);
11063 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11064 staticpro (&this_command_keys
);
11066 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11067 staticpro (&raw_keybuf
);
11069 DEFSYM (Qcommand_execute
, "command-execute");
11071 accent_key_syms
= Qnil
;
11072 staticpro (&accent_key_syms
);
11074 func_key_syms
= Qnil
;
11075 staticpro (&func_key_syms
);
11077 drag_n_drop_syms
= Qnil
;
11078 staticpro (&drag_n_drop_syms
);
11080 unread_switch_frame
= Qnil
;
11081 staticpro (&unread_switch_frame
);
11083 internal_last_event_frame
= Qnil
;
11084 staticpro (&internal_last_event_frame
);
11086 read_key_sequence_cmd
= Qnil
;
11087 staticpro (&read_key_sequence_cmd
);
11088 read_key_sequence_remapped
= Qnil
;
11089 staticpro (&read_key_sequence_remapped
);
11091 menu_bar_one_keymap_changed_items
= Qnil
;
11092 staticpro (&menu_bar_one_keymap_changed_items
);
11094 menu_bar_items_vector
= Qnil
;
11095 staticpro (&menu_bar_items_vector
);
11097 help_form_saved_window_configs
= Qnil
;
11098 staticpro (&help_form_saved_window_configs
);
11100 defsubr (&Scurrent_idle_time
);
11101 defsubr (&Sevent_symbol_parse_modifiers
);
11102 defsubr (&Sevent_convert_list
);
11103 defsubr (&Sread_key_sequence
);
11104 defsubr (&Sread_key_sequence_vector
);
11105 defsubr (&Srecursive_edit
);
11106 defsubr (&Strack_mouse
);
11107 defsubr (&Sinput_pending_p
);
11108 defsubr (&Srecent_keys
);
11109 defsubr (&Sthis_command_keys
);
11110 defsubr (&Sthis_command_keys_vector
);
11111 defsubr (&Sthis_single_command_keys
);
11112 defsubr (&Sthis_single_command_raw_keys
);
11113 defsubr (&Sreset_this_command_lengths
);
11114 defsubr (&Sclear_this_command_keys
);
11115 defsubr (&Ssuspend_emacs
);
11116 defsubr (&Sabort_recursive_edit
);
11117 defsubr (&Sexit_recursive_edit
);
11118 defsubr (&Srecursion_depth
);
11119 defsubr (&Scommand_error_default_function
);
11120 defsubr (&Stop_level
);
11121 defsubr (&Sdiscard_input
);
11122 defsubr (&Sopen_dribble_file
);
11123 defsubr (&Sset_input_interrupt_mode
);
11124 defsubr (&Sset_output_flow_control
);
11125 defsubr (&Sset_input_meta_mode
);
11126 defsubr (&Sset_quit_char
);
11127 defsubr (&Sset_input_mode
);
11128 defsubr (&Scurrent_input_mode
);
11129 defsubr (&Sposn_at_point
);
11130 defsubr (&Sposn_at_x_y
);
11132 DEFVAR_LISP ("last-command-event", last_command_event
,
11133 doc
: /* Last input event that was part of a command. */);
11135 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11136 doc
: /* Last input event in a command, except for mouse menu events.
11137 Mouse menus give back keys that don't look like mouse events;
11138 this variable holds the actual mouse event that led to the menu,
11139 so that you can determine whether the command was run by mouse or not. */);
11141 DEFVAR_LISP ("last-input-event", last_input_event
,
11142 doc
: /* Last input event. */);
11144 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11145 doc
: /* List of events to be read as the command input.
11146 These events are processed first, before actual keyboard input.
11147 Events read from this list are not normally added to `this-command-keys',
11148 as they will already have been added once as they were read for the first time.
11149 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11150 Vunread_command_events
= Qnil
;
11152 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11153 doc
: /* List of events to be processed as input by input methods.
11154 These events are processed before `unread-command-events'
11155 and actual keyboard input, but are not given to `input-method-function'. */);
11156 Vunread_post_input_method_events
= Qnil
;
11158 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11159 doc
: /* List of events to be processed as input by input methods.
11160 These events are processed after `unread-command-events', but
11161 before actual keyboard input.
11162 If there's an active input method, the events are given to
11163 `input-method-function'. */);
11164 Vunread_input_method_events
= Qnil
;
11166 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11167 doc
: /* Meta-prefix character code.
11168 Meta-foo as command input turns into this character followed by foo. */);
11169 XSETINT (meta_prefix_char
, 033);
11171 DEFVAR_KBOARD ("last-command", Vlast_command
,
11172 doc
: /* The last command executed.
11173 Normally a symbol with a function definition, but can be whatever was found
11174 in the keymap, or whatever the variable `this-command' was set to by that
11177 The value `mode-exit' is special; it means that the previous command
11178 read an event that told it to exit, and it did so and unread that event.
11179 In other words, the present command is the event that made the previous
11182 The value `kill-region' is special; it means that the previous command
11183 was a kill command.
11185 `last-command' has a separate binding for each terminal device.
11186 See Info node `(elisp)Multiple Terminals'. */);
11188 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11189 doc
: /* Same as `last-command', but never altered by Lisp code.
11190 Taken from the previous value of `real-this-command'. */);
11192 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11193 doc
: /* Last command that may be repeated.
11194 The last command executed that was not bound to an input event.
11195 This is the command `repeat' will try to repeat.
11196 Taken from a previous value of `real-this-command'. */);
11198 DEFVAR_LISP ("this-command", Vthis_command
,
11199 doc
: /* The command now being executed.
11200 The command can set this variable; whatever is put here
11201 will be in `last-command' during the following command. */);
11202 Vthis_command
= Qnil
;
11204 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11205 doc
: /* This is like `this-command', except that commands should never modify it. */);
11206 Vreal_this_command
= Qnil
;
11208 DEFVAR_LISP ("this-command-keys-shift-translated",
11209 Vthis_command_keys_shift_translated
,
11210 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11211 Shift-translation occurs when there is no binding for the key sequence
11212 as entered, but a binding was found by changing an upper-case letter
11213 to lower-case, or a shifted function key to an unshifted one. */);
11214 Vthis_command_keys_shift_translated
= Qnil
;
11216 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11217 doc
: /* The command bound to the current key sequence before remapping.
11218 It equals `this-command' if the original command was not remapped through
11219 any of the active keymaps. Otherwise, the value of `this-command' is the
11220 result of looking up the original command in the active keymaps. */);
11221 Vthis_original_command
= Qnil
;
11223 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11224 doc
: /* Number of input events between auto-saves.
11225 Zero means disable autosaving due to number of characters typed. */);
11226 auto_save_interval
= 300;
11228 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11229 doc
: /* Number of seconds idle time before auto-save.
11230 Zero or nil means disable auto-saving due to idleness.
11231 After auto-saving due to this many seconds of idle time,
11232 Emacs also does a garbage collection if that seems to be warranted. */);
11233 XSETFASTINT (Vauto_save_timeout
, 30);
11235 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11236 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11237 The value may be integer or floating point.
11238 If the value is zero, don't echo at all. */);
11239 Vecho_keystrokes
= make_number (1);
11241 DEFVAR_INT ("polling-period", polling_period
,
11242 doc
: /* Interval between polling for input during Lisp execution.
11243 The reason for polling is to make C-g work to stop a running program.
11244 Polling is needed only when using X windows and SIGIO does not work.
11245 Polling is automatically disabled in all other cases. */);
11246 polling_period
= 2;
11248 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11249 doc
: /* Maximum time between mouse clicks to make a double-click.
11250 Measured in milliseconds. The value nil means disable double-click
11251 recognition; t means double-clicks have no time limit and are detected
11252 by position only. */);
11253 Vdouble_click_time
= make_number (500);
11255 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11256 doc
: /* Maximum mouse movement between clicks to make a double-click.
11257 On window-system frames, value is the number of pixels the mouse may have
11258 moved horizontally or vertically between two clicks to make a double-click.
11259 On non window-system frames, value is interpreted in units of 1/8 characters
11262 This variable is also the threshold for motion of the mouse
11263 to count as a drag. */);
11264 double_click_fuzz
= 3;
11266 DEFVAR_INT ("num-input-keys", num_input_keys
,
11267 doc
: /* Number of complete key sequences read as input so far.
11268 This includes key sequences read from keyboard macros.
11269 The number is effectively the number of interactive command invocations. */);
11270 num_input_keys
= 0;
11272 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11273 doc
: /* Number of input events read from the keyboard so far.
11274 This does not include events generated by keyboard macros. */);
11275 num_nonmacro_input_events
= 0;
11277 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11278 doc
: /* The frame in which the most recently read event occurred.
11279 If the last event came from a keyboard macro, this is set to `macro'. */);
11280 Vlast_event_frame
= Qnil
;
11282 /* This variable is set up in sysdep.c. */
11283 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11284 doc
: /* The ERASE character as set by the user with stty. */);
11286 DEFVAR_LISP ("help-char", Vhelp_char
,
11287 doc
: /* Character to recognize as meaning Help.
11288 When it is read, do `(eval help-form)', and display result if it's a string.
11289 If the value of `help-form' is nil, this char can be read normally. */);
11290 XSETINT (Vhelp_char
, Ctl ('H'));
11292 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11293 doc
: /* List of input events to recognize as meaning Help.
11294 These work just like the value of `help-char' (see that). */);
11295 Vhelp_event_list
= Qnil
;
11297 DEFVAR_LISP ("help-form", Vhelp_form
,
11298 doc
: /* Form to execute when character `help-char' is read.
11299 If the form returns a string, that string is displayed.
11300 If `help-form' is nil, the help char is not recognized. */);
11303 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11304 doc
: /* Command to run when `help-char' character follows a prefix key.
11305 This command is used only when there is no actual binding
11306 for that character after that prefix key. */);
11307 Vprefix_help_command
= Qnil
;
11309 DEFVAR_LISP ("top-level", Vtop_level
,
11310 doc
: /* Form to evaluate when Emacs starts up.
11311 Useful to set before you dump a modified Emacs. */);
11314 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11315 doc
: /* Translate table for local keyboard input, or nil.
11316 If non-nil, the value should be a char-table. Each character read
11317 from the keyboard is looked up in this char-table. If the value found
11318 there is non-nil, then it is used instead of the actual input character.
11320 The value can also be a string or vector, but this is considered obsolete.
11321 If it is a string or vector of length N, character codes N and up are left
11322 untranslated. In a vector, an element which is nil means "no translation".
11324 This is applied to the characters supplied to input methods, not their
11325 output. See also `translation-table-for-input'.
11327 This variable has a separate binding for each terminal.
11328 See Info node `(elisp)Multiple Terminals'. */);
11330 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11331 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11332 \(Even if the operating system has support for stopping a process.\) */);
11333 cannot_suspend
= 0;
11335 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11336 doc
: /* Non-nil means prompt with menus when appropriate.
11337 This is done when reading from a keymap that has a prompt string,
11338 for elements that have prompt strings.
11339 The menu is displayed on the screen
11340 if X menus were enabled at configuration
11341 time and the previous event was a mouse click prefix key.
11342 Otherwise, menu prompting uses the echo area. */);
11343 menu_prompting
= 1;
11345 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11346 doc
: /* Character to see next line of menu prompt.
11347 Type this character while in a menu prompt to rotate around the lines of it. */);
11348 XSETINT (menu_prompt_more_char
, ' ');
11350 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11351 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11352 Emacs applies the modifiers of the character stored here to each keyboard
11353 character it reads. For example, after evaluating the expression
11354 (setq extra-keyboard-modifiers ?\\C-x)
11355 all input characters will have the control modifier applied to them.
11357 Note that the character ?\\C-@, equivalent to the integer zero, does
11358 not count as a control character; rather, it counts as a character
11359 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11360 cancels any modification. */);
11361 extra_keyboard_modifiers
= 0;
11363 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11364 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11365 The command loop sets this to nil before each command,
11366 and tests the value when the command returns.
11367 Buffer modification stores t in this variable. */);
11368 Vdeactivate_mark
= Qnil
;
11369 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11371 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11372 doc
: /* Normal hook run before each command is executed.
11373 If an unhandled error happens in running this hook,
11374 the function in which the error occurred is unconditionally removed, since
11375 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11376 Vpre_command_hook
= Qnil
;
11378 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11379 doc
: /* Normal hook run after each command is executed.
11380 If an unhandled error happens in running this hook,
11381 the function in which the error occurred is unconditionally removed, since
11382 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11383 Vpost_command_hook
= Qnil
;
11386 DEFVAR_LISP ("echo-area-clear-hook", ...,
11387 doc
: /* Normal hook run when clearing the echo area. */);
11389 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11390 Fset (Qecho_area_clear_hook
, Qnil
);
11392 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11393 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11394 Vlucid_menu_bar_dirty_flag
= Qnil
;
11396 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11397 doc
: /* List of menu bar items to move to the end of the menu bar.
11398 The elements of the list are event types that may have menu bar bindings. */);
11399 Vmenu_bar_final_items
= Qnil
;
11401 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11402 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11403 This is used internally by graphical displays that do not render
11404 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11405 Vtool_bar_separator_image_expression
= Qnil
;
11407 DEFVAR_KBOARD ("overriding-terminal-local-map",
11408 Voverriding_terminal_local_map
,
11409 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11411 This variable is intended to let commands such as `universal-argument'
11412 set up a different keymap for reading the next command.
11414 `overriding-terminal-local-map' has a separate binding for each
11416 See Info node `(elisp)Multiple Terminals'. */);
11418 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11419 doc
: /* Keymap that overrides almost all other local keymaps.
11420 If this variable is non-nil, it is used as a keymap--replacing the
11421 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11422 Voverriding_local_map
= Qnil
;
11424 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11425 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11426 Otherwise, the menu bar continues to reflect the buffer's local map
11427 and the minor mode maps regardless of `overriding-local-map'. */);
11428 Voverriding_local_map_menu_flag
= Qnil
;
11430 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11431 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11432 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11434 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11435 doc
: /* Non-nil means generate motion events for mouse motion. */);
11437 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11438 doc
: /* Alist of system-specific X windows key symbols.
11439 Each element should have the form (N . SYMBOL) where N is the
11440 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11441 and SYMBOL is its name.
11443 `system-key-alist' has a separate binding for each terminal device.
11444 See Info node `(elisp)Multiple Terminals'. */);
11446 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11447 doc
: /* Keymap that translates key sequences to key sequences during input.
11448 This is used mainly for mapping key sequences into some preferred
11449 key events (symbols).
11451 The `read-key-sequence' function replaces any subsequence bound by
11452 `local-function-key-map' with its binding. More precisely, when the
11453 active keymaps have no binding for the current key sequence but
11454 `local-function-key-map' binds a suffix of the sequence to a vector or
11455 string, `read-key-sequence' replaces the matching suffix with its
11456 binding, and continues with the new sequence.
11458 If the binding is a function, it is called with one argument (the prompt)
11459 and its return value (a key sequence) is used.
11461 The events that come from bindings in `local-function-key-map' are not
11462 themselves looked up in `local-function-key-map'.
11464 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11465 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11466 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11467 typing `ESC O P x' would return [f1 x].
11469 `local-function-key-map' has a separate binding for each terminal
11470 device. See Info node `(elisp)Multiple Terminals'. If you need to
11471 define a binding on all terminals, change `function-key-map'
11472 instead. Initially, `local-function-key-map' is an empty keymap that
11473 has `function-key-map' as its parent on all terminal devices. */);
11475 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11476 doc
: /* Keymap that decodes input escape sequences.
11477 This is used mainly for mapping ASCII function key sequences into
11478 real Emacs function key events (symbols).
11480 The `read-key-sequence' function replaces any subsequence bound by
11481 `input-decode-map' with its binding. Contrary to `function-key-map',
11482 this map applies its rebinding regardless of the presence of an ordinary
11483 binding. So it is more like `key-translation-map' except that it applies
11484 before `function-key-map' rather than after.
11486 If the binding is a function, it is called with one argument (the prompt)
11487 and its return value (a key sequence) is used.
11489 The events that come from bindings in `input-decode-map' are not
11490 themselves looked up in `input-decode-map'. */);
11492 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11493 doc
: /* The parent keymap of all `local-function-key-map' instances.
11494 Function key definitions that apply to all terminal devices should go
11495 here. If a mapping is defined in both the current
11496 `local-function-key-map' binding and this variable, then the local
11497 definition will take precedence. */);
11498 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11500 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11501 doc
: /* Keymap of key translations that can override keymaps.
11502 This keymap works like `input-decode-map', but comes after `function-key-map'.
11503 Another difference is that it is global rather than terminal-local. */);
11504 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11506 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11507 doc
: /* List of deferred actions to be performed at a later time.
11508 The precise format isn't relevant here; we just check whether it is nil. */);
11509 Vdeferred_action_list
= Qnil
;
11511 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11512 doc
: /* Function to call to handle deferred actions, after each command.
11513 This function is called with no arguments after each command
11514 whenever `deferred-action-list' is non-nil. */);
11515 Vdeferred_action_function
= Qnil
;
11517 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11518 doc
: /* List of warnings to be displayed after this command.
11519 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11520 as per the args of `display-warning' (which see).
11521 If this variable is non-nil, `delayed-warnings-hook' will be run
11522 immediately after running `post-command-hook'. */);
11523 Vdelayed_warnings_list
= Qnil
;
11525 DEFVAR_LISP ("timer-list", Vtimer_list
,
11526 doc
: /* List of active absolute time timers in order of increasing time. */);
11527 Vtimer_list
= Qnil
;
11529 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11530 doc
: /* List of active idle-time timers in order of increasing time. */);
11531 Vtimer_idle_list
= Qnil
;
11533 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11534 doc
: /* If non-nil, the function that implements the current input method.
11535 It's called with one argument, a printing character that was just read.
11536 \(That means a character with code 040...0176.)
11537 Typically this function uses `read-event' to read additional events.
11538 When it does so, it should first bind `input-method-function' to nil
11539 so it will not be called recursively.
11541 The function should return a list of zero or more events
11542 to be used as input. If it wants to put back some events
11543 to be reconsidered, separately, by the input method,
11544 it can add them to the beginning of `unread-command-events'.
11546 The input method function can find in `input-method-previous-message'
11547 the previous echo area message.
11549 The input method function should refer to the variables
11550 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11551 for guidance on what to do. */);
11552 Vinput_method_function
= Qnil
;
11554 DEFVAR_LISP ("input-method-previous-message",
11555 Vinput_method_previous_message
,
11556 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11557 This variable exists because `read-event' clears the echo area
11558 before running the input method. It is nil if there was no message. */);
11559 Vinput_method_previous_message
= Qnil
;
11561 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11562 doc
: /* If non-nil, the function that implements the display of help.
11563 It's called with one argument, the help string to display. */);
11564 Vshow_help_function
= Qnil
;
11566 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11567 doc
: /* If non-nil, suppress point adjustment after executing a command.
11569 After a command is executed, if point is moved into a region that has
11570 special properties (e.g. composition, display), we adjust point to
11571 the boundary of the region. But, when a command sets this variable to
11572 non-nil, we suppress the point adjustment.
11574 This variable is set to nil before reading a command, and is checked
11575 just after executing the command. */);
11576 Vdisable_point_adjustment
= Qnil
;
11578 DEFVAR_LISP ("global-disable-point-adjustment",
11579 Vglobal_disable_point_adjustment
,
11580 doc
: /* If non-nil, always suppress point adjustment.
11582 The default value is nil, in which case, point adjustment are
11583 suppressed only after special commands that set
11584 `disable-point-adjustment' (which see) to non-nil. */);
11585 Vglobal_disable_point_adjustment
= Qnil
;
11587 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11588 doc
: /* How long to display an echo-area message when the minibuffer is active.
11589 If the value is not a number, such messages don't time out. */);
11590 Vminibuffer_message_timeout
= make_number (2);
11592 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11593 doc
: /* If non-nil, any keyboard input throws to this symbol.
11594 The value of that variable is passed to `quit-flag' and later causes a
11595 peculiar kind of quitting. */);
11596 Vthrow_on_input
= Qnil
;
11598 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11599 doc
: /* Function to output error messages.
11600 Called with three arguments:
11601 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11602 such as what `condition-case' would bind its variable to,
11603 - the context (a string which normally goes at the start of the message),
11604 - the Lisp function within which the error was signaled. */);
11605 Vcommand_error_function
= intern ("command-error-default-function");
11607 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11608 Venable_disabled_menus_and_buttons
,
11609 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11611 Help functions bind this to allow help on disabled menu items
11612 and tool-bar buttons. */);
11613 Venable_disabled_menus_and_buttons
= Qnil
;
11615 DEFVAR_LISP ("select-active-regions",
11616 Vselect_active_regions
,
11617 doc
: /* If non-nil, an active region automatically sets the primary selection.
11618 If the value is `only', only temporarily active regions (usually made
11619 by mouse-dragging or shift-selection) set the window selection.
11621 This takes effect only when Transient Mark mode is enabled. */);
11622 Vselect_active_regions
= Qt
;
11624 DEFVAR_LISP ("saved-region-selection",
11625 Vsaved_region_selection
,
11626 doc
: /* Contents of active region prior to buffer modification.
11627 If `select-active-regions' is non-nil, Emacs sets this to the
11628 text in the region before modifying the buffer. The next call to
11629 the function `deactivate-mark' uses this to set the window selection. */);
11630 Vsaved_region_selection
= Qnil
;
11632 DEFVAR_LISP ("selection-inhibit-update-commands",
11633 Vselection_inhibit_update_commands
,
11634 doc
: /* List of commands which should not update the selection.
11635 Normally, if `select-active-regions' is non-nil and the mark remains
11636 active after a command (i.e. the mark was not deactivated), the Emacs
11637 command loop sets the selection to the text in the region. However,
11638 if the command is in this list, the selection is not updated. */);
11639 Vselection_inhibit_update_commands
11640 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11642 DEFVAR_LISP ("debug-on-event",
11644 doc
: /* Enter debugger on this event. When Emacs
11645 receives the special event specified by this variable, it will try to
11646 break into the debugger as soon as possible instead of processing the
11647 event normally through `special-event-map'.
11649 Currently, the only supported values for this
11650 variable are `sigusr1' and `sigusr2'. */);
11651 Vdebug_on_event
= intern_c_string ("sigusr2");
11653 /* Create the initial keyboard. Qt means 'unset'. */
11654 initial_kboard
= allocate_kboard (Qt
);
11658 keys_of_keyboard (void)
11660 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11661 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11662 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11663 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11664 initial_define_key (meta_map
, 'x', "execute-extended-command");
11666 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11667 "handle-delete-frame");
11668 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11669 "ns-put-working-text");
11670 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11671 "ns-unput-working-text");
11672 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11673 current-prefix-arg, as is done in `handle-switch-frame'.
11674 But `handle-switch-frame is not run from the special-map.
11675 Commands from that map are run in a special way that automatically
11676 preserves the prefix-arg. Restoring the prefix arg here is not just
11677 redundant but harmful:
11679 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11680 - after the first prompt, the exit-minibuffer-hook is run which may
11681 iconify a frame and thus push a `iconify-frame' event.
11682 - after running exit-minibuffer-hook, current-prefix-arg is
11683 restored to the non-nil value it had before the prompt.
11684 - we enter the second prompt.
11685 current-prefix-arg is non-nil, prefix-arg is nil.
11686 - before running the first real event, we run the special iconify-frame
11687 event, but we pass the `special' arg to execute-command so
11688 current-prefix-arg and prefix-arg are left untouched.
11689 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11690 - the next key event will have a spuriously non-nil current-prefix-arg. */
11691 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11693 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11695 /* Handling it at such a low-level causes read_key_sequence to get
11696 * confused because it doesn't realize that the current_buffer was
11697 * changed by read_char.
11699 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11700 * "handle-select-window"); */
11701 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11702 "handle-save-session");
11705 /* Define a special event which is raised for dbus callback
11707 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11708 "dbus-handle-event");
11711 #ifdef USE_FILE_NOTIFY
11712 /* Define a special event which is raised for notification callback
11714 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11715 "file-notify-handle-event");
11716 #endif /* USE_FILE_NOTIFY */
11718 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11720 #if defined (WINDOWSNT)
11721 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11724 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11725 "handle-focus-in");
11726 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11727 "handle-focus-out");
11730 /* Mark the pointers in the kboard objects.
11731 Called by Fgarbage_collect. */
11733 mark_kboards (void)
11737 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11739 if (kb
->kbd_macro_buffer
)
11740 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11742 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11743 mark_object (KVAR (kb
, Vlast_command
));
11744 mark_object (KVAR (kb
, Vreal_last_command
));
11745 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11746 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11747 mark_object (KVAR (kb
, Vprefix_arg
));
11748 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11749 mark_object (KVAR (kb
, kbd_queue
));
11750 mark_object (KVAR (kb
, defining_kbd_macro
));
11751 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11752 mark_object (KVAR (kb
, Vsystem_key_alist
));
11753 mark_object (KVAR (kb
, system_key_syms
));
11754 mark_object (KVAR (kb
, Vwindow_system
));
11755 mark_object (KVAR (kb
, Vinput_decode_map
));
11756 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11757 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11758 mark_object (KVAR (kb
, echo_string
));
11761 struct input_event
*event
;
11762 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11764 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11765 event
= kbd_buffer
;
11766 /* These two special event types has no Lisp_Objects to mark. */
11767 if (event
->kind
!= SELECTION_REQUEST_EVENT
11768 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11770 mark_object (event
->x
);
11771 mark_object (event
->y
);
11772 mark_object (event
->frame_or_window
);
11773 mark_object (event
->arg
);