1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2014 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
28 #include "termhooks.h"
33 #include "character.h"
36 #include "dispextern.h"
38 #include "intervals.h"
40 #include "blockinput.h"
54 #include <sys/ioctl.h>
55 #endif /* not MSDOS */
57 #if defined USABLE_FIONREAD && defined USG5_4
58 # include <sys/filio.h>
61 #include "syssignal.h"
63 #include <sys/types.h>
67 #ifdef HAVE_WINDOW_SYSTEM
69 #endif /* HAVE_WINDOW_SYSTEM */
71 /* Variables for blockinput.h: */
73 /* Positive if interrupt input is blocked right now. */
74 volatile int interrupt_input_blocked
;
76 /* True means an input interrupt or alarm signal has arrived.
77 The QUIT macro checks this. */
78 volatile bool pending_signals
;
80 #define KBD_BUFFER_SIZE 4096
82 KBOARD
*initial_kboard
;
83 KBOARD
*current_kboard
;
84 static KBOARD
*all_kboards
;
86 /* True in the single-kboard state, false in the any-kboard state. */
87 static bool single_kboard
;
89 /* Non-nil disable property on a command means
90 do not execute it; call disabled-command-function's value instead. */
91 Lisp_Object Qdisabled
;
92 static Lisp_Object Qdisabled_command_function
;
94 #define NUM_RECENT_KEYS (300)
96 /* Index for storing next element into recent_keys. */
97 static int recent_keys_index
;
99 /* Total number of elements stored into recent_keys. */
100 static int total_keys
;
102 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
103 static Lisp_Object recent_keys
;
105 /* Vector holding the key sequence that invoked the current command.
106 It is reused for each command, and it may be longer than the current
107 sequence; this_command_key_count indicates how many elements
108 actually mean something.
109 It's easier to staticpro a single Lisp_Object than an array. */
110 Lisp_Object this_command_keys
;
111 ptrdiff_t this_command_key_count
;
113 /* True after calling Freset_this_command_lengths.
114 Usually it is false. */
115 static bool this_command_key_count_reset
;
117 /* This vector is used as a buffer to record the events that were actually read
118 by read_key_sequence. */
119 static Lisp_Object raw_keybuf
;
120 static int raw_keybuf_count
;
122 #define GROW_RAW_KEYBUF \
123 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
124 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
126 /* Number of elements of this_command_keys
127 that precede this key sequence. */
128 static ptrdiff_t this_single_command_key_start
;
130 /* Record values of this_command_key_count and echo_length ()
131 before this command was read. */
132 static ptrdiff_t before_command_key_count
;
133 static ptrdiff_t before_command_echo_length
;
135 /* For longjmp to where kbd input is being done. */
137 static sys_jmp_buf getcjmp
;
139 /* True while doing kbd input. */
140 bool waiting_for_input
;
142 /* True while displaying for echoing. Delays C-g throwing. */
146 /* Non-null means we can start echoing at the next input pause even
147 though there is something in the echo area. */
149 static struct kboard
*ok_to_echo_at_next_pause
;
151 /* The kboard last echoing, or null for none. Reset to 0 in
152 cancel_echoing. If non-null, and a current echo area message
153 exists, and echo_message_buffer is eq to the current message
154 buffer, we know that the message comes from echo_kboard. */
156 struct kboard
*echo_kboard
;
158 /* The buffer used for echoing. Set in echo_now, reset in
161 Lisp_Object echo_message_buffer
;
163 /* True means C-g should cause immediate error-signal. */
166 /* Character that causes a quit. Normally C-g.
168 If we are running on an ordinary terminal, this must be an ordinary
169 ASCII char, since we want to make it our interrupt character.
171 If we are not running on an ordinary terminal, it still needs to be
172 an ordinary ASCII char. This character needs to be recognized in
173 the input interrupt handler. At this point, the keystroke is
174 represented as a struct input_event, while the desired quit
175 character is specified as a lispy event. The mapping from struct
176 input_events to lispy events cannot run in an interrupt handler,
177 and the reverse mapping is difficult for anything but ASCII
180 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
184 /* Current depth in recursive edits. */
185 EMACS_INT command_loop_level
;
187 /* If not Qnil, this is a switch-frame event which we decided to put
188 off until the end of a key sequence. This should be read as the
189 next command input, after any unread_command_events.
191 read_key_sequence uses this to delay switch-frame events until the
192 end of the key sequence; Fread_char uses it to put off switch-frame
193 events until a non-ASCII event is acceptable as input. */
194 Lisp_Object unread_switch_frame
;
196 /* Last size recorded for a current buffer which is not a minibuffer. */
197 static ptrdiff_t last_non_minibuf_size
;
199 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
200 uintmax_t num_input_events
;
202 /* Value of num_nonmacro_input_events as of last auto save. */
204 static EMACS_INT last_auto_save
;
206 /* The value of point when the last command was started. */
207 static ptrdiff_t last_point_position
;
209 /* The frame in which the last input event occurred, or Qmacro if the
210 last event came from a macro. We use this to determine when to
211 generate switch-frame events. This may be cleared by functions
212 like Fselect_frame, to make sure that a switch-frame event is
213 generated by the next character.
215 FIXME: This is modified by a signal handler so it should be volatile.
216 It's exported to Lisp, though, so it can't simply be marked
218 Lisp_Object internal_last_event_frame
;
220 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
221 static Lisp_Object Qhandle_select_window
;
222 Lisp_Object QPRIMARY
;
224 static Lisp_Object Qself_insert_command
;
225 static Lisp_Object Qforward_char
;
226 static Lisp_Object Qbackward_char
;
227 Lisp_Object Qundefined
;
228 static Lisp_Object Qtimer_event_handler
;
230 /* read_key_sequence stores here the command definition of the
231 key sequence that it reads. */
232 static Lisp_Object read_key_sequence_cmd
;
233 static Lisp_Object read_key_sequence_remapped
;
235 static Lisp_Object Qinput_method_function
;
237 static Lisp_Object Qdeactivate_mark
;
239 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
241 static Lisp_Object Qecho_area_clear_hook
;
243 /* Hooks to run before and after each command. */
244 static Lisp_Object Qpre_command_hook
;
245 static Lisp_Object Qpost_command_hook
;
247 static Lisp_Object Qdeferred_action_function
;
249 static Lisp_Object Qdelayed_warnings_hook
;
251 static Lisp_Object Qinput_method_exit_on_first_char
;
252 static Lisp_Object Qinput_method_use_echo_area
;
254 static Lisp_Object Qhelp_form_show
;
256 /* File in which we write all commands we read. */
257 static FILE *dribble
;
259 /* Nonzero if input is available. */
262 /* Circular buffer for pre-read keyboard input. */
264 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
266 /* Pointer to next available character in kbd_buffer.
267 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
268 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
269 next available char is in kbd_buffer[0]. */
270 static struct input_event
*kbd_fetch_ptr
;
272 /* Pointer to next place to store character in kbd_buffer. This
273 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
274 character should go in kbd_buffer[0]. */
275 static struct input_event
* volatile kbd_store_ptr
;
277 /* The above pair of variables forms a "queue empty" flag. When we
278 enqueue a non-hook event, we increment kbd_store_ptr. When we
279 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
280 there is input available if the two pointers are not equal.
282 Why not just have a flag set and cleared by the enqueuing and
283 dequeuing functions? Such a flag could be screwed up by interrupts
284 at inopportune times. */
286 /* Symbols to head events. */
287 static Lisp_Object Qmouse_movement
;
288 static Lisp_Object Qscroll_bar_movement
;
289 Lisp_Object Qswitch_frame
;
290 static Lisp_Object Qfocus_in
, Qfocus_out
;
291 static Lisp_Object Qdelete_frame
;
292 static Lisp_Object Qiconify_frame
;
293 static Lisp_Object Qmake_frame_visible
;
294 static Lisp_Object Qselect_window
;
295 Lisp_Object Qhelp_echo
;
297 static Lisp_Object Qmouse_fixup_help_message
;
299 /* Symbols to denote kinds of events. */
300 static Lisp_Object Qfunction_key
;
301 Lisp_Object Qmouse_click
;
303 Lisp_Object Qlanguage_change
;
305 static Lisp_Object Qdrag_n_drop
;
306 static Lisp_Object Qsave_session
;
308 static Lisp_Object Qdbus_event
;
310 #ifdef USE_FILE_NOTIFY
311 static Lisp_Object Qfile_notify
;
312 #endif /* USE_FILE_NOTIFY */
313 static Lisp_Object Qconfig_changed_event
;
315 /* Lisp_Object Qmouse_movement; - also an event header */
317 /* Properties of event headers. */
318 Lisp_Object Qevent_kind
;
319 static Lisp_Object Qevent_symbol_elements
;
321 /* Menu and tool bar item parts. */
322 static Lisp_Object Qmenu_enable
;
323 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
324 Lisp_Object QCfilter
;
326 /* Non-nil disable property on a command means
327 do not execute it; call disabled-command-function's value instead. */
328 Lisp_Object QCtoggle
, QCradio
;
329 static Lisp_Object QCbutton
, QClabel
;
331 static Lisp_Object QCvert_only
;
333 /* An event header symbol HEAD may have a property named
334 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
335 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
336 mask of modifiers applied to it. If present, this is used to help
337 speed up parse_modifiers. */
338 Lisp_Object Qevent_symbol_element_mask
;
340 /* An unmodified event header BASE may have a property named
341 Qmodifier_cache, which is an alist mapping modifier masks onto
342 modified versions of BASE. If present, this helps speed up
344 static Lisp_Object Qmodifier_cache
;
346 /* Symbols to use for parts of windows. */
347 Lisp_Object Qmode_line
;
348 Lisp_Object Qvertical_line
;
349 Lisp_Object Qright_divider
, Qbottom_divider
;
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 throw to `exit' -- for
810 instance `(throw 'exit nil)'.
811 If you throw a value other than t, `recursive-edit' returns normally
812 to the function that called it. Throwing a t value causes
813 `recursive-edit' to quit, so that control returns to the command loop
816 This function is called by the editor initialization to begin editing. */)
819 ptrdiff_t count
= SPECPDL_INDEX ();
822 /* If we enter while input is blocked, don't lock up here.
823 This may happen through the debugger during redisplay. */
824 if (input_blocked_p ())
827 command_loop_level
++;
828 update_mode_lines
= 17;
830 if (command_loop_level
831 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
832 buffer
= Fcurrent_buffer ();
836 /* If we leave recursive_edit_1 below with a `throw' for instance,
837 like it is done in the splash screen display, we have to
838 make sure that we restore single_kboard as command_loop_1
839 would have done if it were left normally. */
840 if (command_loop_level
> 0)
841 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
842 record_unwind_protect (recursive_edit_unwind
, buffer
);
845 return unbind_to (count
, Qnil
);
849 recursive_edit_unwind (Lisp_Object buffer
)
851 if (BUFFERP (buffer
))
852 Fset_buffer (buffer
);
854 command_loop_level
--;
855 update_mode_lines
= 18;
859 #if 0 /* These two functions are now replaced with
860 temporarily_switch_to_single_kboard. */
864 #if 0 /* Theory: if there's anything in Vunread_command_events,
865 it will right away be read by read_key_sequence,
866 and then if we do switch KBOARDS, it will go into the side
867 queue then. So we don't need to do anything special here -- rms. */
868 if (CONSP (Vunread_command_events
))
870 current_kboard
->kbd_queue
871 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
872 current_kboard
->kbd_queue_has_data
= 1;
874 Vunread_command_events
= Qnil
;
879 /* Switch to the single-kboard state, making current_kboard
880 the only KBOARD from which further input is accepted. */
883 single_kboard_state ()
889 /* If we're in single_kboard state for kboard KBOARD,
893 not_single_kboard_state (KBOARD
*kboard
)
895 if (kboard
== current_kboard
)
899 /* Maintain a stack of kboards, so other parts of Emacs
900 can switch temporarily to the kboard of a given frame
901 and then revert to the previous status. */
906 struct kboard_stack
*next
;
909 static struct kboard_stack
*kboard_stack
;
912 push_kboard (struct kboard
*k
)
914 struct kboard_stack
*p
= xmalloc (sizeof *p
);
916 p
->next
= kboard_stack
;
917 p
->kboard
= current_kboard
;
927 struct kboard_stack
*p
= kboard_stack
;
929 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
931 if (t
->kboard
== p
->kboard
)
933 current_kboard
= p
->kboard
;
940 /* The terminal we remembered has been deleted. */
941 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
944 kboard_stack
= p
->next
;
948 /* Switch to single_kboard mode, making current_kboard the only KBOARD
949 from which further input is accepted. If F is non-nil, set its
950 KBOARD as the current keyboard.
952 This function uses record_unwind_protect_int to return to the previous
955 If Emacs is already in single_kboard mode, and F's keyboard is
956 locked, then this function will throw an error. */
959 temporarily_switch_to_single_kboard (struct frame
*f
)
961 bool was_locked
= single_kboard
;
964 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
965 /* We can not switch keyboards while in single_kboard mode.
966 In rare cases, Lisp code may call `recursive-edit' (or
967 `read-minibuffer' or `y-or-n-p') after it switched to a
968 locked frame. For example, this is likely to happen
969 when server.el connects to a new terminal while Emacs is in
970 single_kboard mode. It is best to throw an error instead
971 of presenting the user with a frozen screen. */
972 error ("Terminal %d is locked, cannot read from it",
973 FRAME_TERMINAL (f
)->id
);
975 /* This call is unnecessary, but helps
976 `restore_kboard_configuration' discover if somebody changed
977 `current_kboard' behind our back. */
978 push_kboard (current_kboard
);
981 current_kboard
= FRAME_KBOARD (f
);
983 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
986 #if 0 /* This function is not needed anymore. */
988 record_single_kboard_state ()
991 push_kboard (current_kboard
);
992 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
997 restore_kboard_configuration (int was_locked
)
999 single_kboard
= was_locked
;
1002 struct kboard
*prev
= current_kboard
;
1004 /* The pop should not change the kboard. */
1005 if (single_kboard
&& current_kboard
!= prev
)
1011 /* Handle errors that are not handled at inner levels
1012 by printing an error message and returning to the editor command loop. */
1015 cmd_error (Lisp_Object data
)
1017 Lisp_Object old_level
, old_length
;
1018 char macroerror
[sizeof "After..kbd macro iterations: "
1019 + INT_STRLEN_BOUND (EMACS_INT
)];
1021 #ifdef HAVE_WINDOW_SYSTEM
1022 if (display_hourglass_p
)
1023 cancel_hourglass ();
1026 if (!NILP (executing_kbd_macro
))
1028 if (executing_kbd_macro_iterations
== 1)
1029 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1031 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1032 executing_kbd_macro_iterations
);
1037 Vstandard_output
= Qt
;
1038 Vstandard_input
= Qt
;
1039 Vexecuting_kbd_macro
= Qnil
;
1040 executing_kbd_macro
= Qnil
;
1041 kset_prefix_arg (current_kboard
, Qnil
);
1042 kset_last_prefix_arg (current_kboard
, Qnil
);
1045 /* Avoid unquittable loop if data contains a circular list. */
1046 old_level
= Vprint_level
;
1047 old_length
= Vprint_length
;
1048 XSETFASTINT (Vprint_level
, 10);
1049 XSETFASTINT (Vprint_length
, 10);
1050 cmd_error_internal (data
, macroerror
);
1051 Vprint_level
= old_level
;
1052 Vprint_length
= old_length
;
1055 Vinhibit_quit
= Qnil
;
1057 return make_number (0);
1060 /* Take actions on handling an error. DATA is the data that describes
1063 CONTEXT is a C-string containing ASCII characters only which
1064 describes the context in which the error happened. If we need to
1065 generalize CONTEXT to allow multibyte characters, make it a Lisp
1069 cmd_error_internal (Lisp_Object data
, const char *context
)
1071 /* The immediate context is not interesting for Quits,
1072 since they are asynchronous. */
1073 if (EQ (XCAR (data
), Qquit
))
1074 Vsignaling_function
= Qnil
;
1079 /* Use user's specified output function if any. */
1080 if (!NILP (Vcommand_error_function
))
1081 call3 (Vcommand_error_function
, data
,
1082 context
? build_string (context
) : empty_unibyte_string
,
1083 Vsignaling_function
);
1085 Vsignaling_function
= Qnil
;
1088 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1089 Scommand_error_default_function
, 3, 3, 0,
1090 doc
: /* Produce default output for unhandled error message.
1091 Default value of `command-error-function'. */)
1092 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1094 struct frame
*sf
= SELECTED_FRAME ();
1096 CHECK_STRING (context
);
1098 /* If the window system or terminal frame hasn't been initialized
1099 yet, or we're not interactive, write the message to stderr and exit. */
1100 if (!sf
->glyphs_initialized_p
1101 /* The initial frame is a special non-displaying frame. It
1102 will be current in daemon mode when there are no frames
1103 to display, and in non-daemon mode before the real frame
1104 has finished initializing. If an error is thrown in the
1105 latter case while creating the frame, then the frame
1106 will never be displayed, so the safest thing to do is
1107 write to stderr and quit. In daemon mode, there are
1108 many other potential errors that do not prevent frames
1109 from being created, so continuing as normal is better in
1111 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1114 print_error_message (data
, Qexternal_debugging_output
,
1115 SSDATA (context
), signal
);
1116 Fterpri (Qexternal_debugging_output
);
1117 Fkill_emacs (make_number (-1));
1121 clear_message (1, 0);
1123 message_log_maybe_newline ();
1126 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1131 static Lisp_Object
command_loop_2 (Lisp_Object
);
1132 static Lisp_Object
top_level_1 (Lisp_Object
);
1134 /* Entry to editor-command-loop.
1135 This level has the catches for exiting/returning to editor command loop.
1136 It returns nil to exit recursive edit, t to abort it. */
1141 if (command_loop_level
> 0 || minibuf_level
> 0)
1144 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1145 executing_kbd_macro
= Qnil
;
1151 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1152 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1153 executing_kbd_macro
= Qnil
;
1155 /* End of file in -batch run causes exit here. */
1161 /* Here we catch errors in execution of commands within the
1162 editing loop, and reenter the editing loop.
1163 When there is an error, cmd_error runs and returns a non-nil
1164 value to us. A value of nil means that command_loop_1 itself
1165 returned due to end of file (or end of kbd macro). */
1168 command_loop_2 (Lisp_Object ignore
)
1170 register Lisp_Object val
;
1173 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1174 while (!NILP (val
));
1182 return Feval (Vtop_level
, Qnil
);
1186 top_level_1 (Lisp_Object ignore
)
1188 /* On entry to the outer level, run the startup file. */
1189 if (!NILP (Vtop_level
))
1190 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1191 else if (!NILP (Vpurify_flag
))
1192 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1194 message1 ("Bare Emacs (standard Lisp code not loaded)");
1198 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1199 doc
: /* Exit all recursive editing levels.
1200 This also exits all active minibuffers. */)
1203 #ifdef HAVE_WINDOW_SYSTEM
1204 if (display_hourglass_p
)
1205 cancel_hourglass ();
1208 /* Unblock input if we enter with input blocked. This may happen if
1209 redisplay traps e.g. during tool-bar update with input blocked. */
1210 totally_unblock_input ();
1212 Fthrow (Qtop_level
, Qnil
);
1215 static _Noreturn
void
1216 user_error (const char *msg
)
1218 xsignal1 (Quser_error
, build_string (msg
));
1222 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1223 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1226 if (command_loop_level
> 0 || minibuf_level
> 0)
1227 Fthrow (Qexit
, Qnil
);
1229 user_error ("No recursive edit is in progress");
1233 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1234 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1237 if (command_loop_level
> 0 || minibuf_level
> 0)
1240 user_error ("No recursive edit is in progress");
1243 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1244 of this function. */
1247 tracking_off (Lisp_Object old_value
)
1249 do_mouse_tracking
= old_value
;
1250 if (NILP (old_value
))
1252 /* Redisplay may have been preempted because there was input
1253 available, and it assumes it will be called again after the
1254 input has been processed. If the only input available was
1255 the sort that we have just disabled, then we need to call
1257 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1259 redisplay_preserve_echo_area (6);
1260 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1265 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1266 doc
: /* Evaluate BODY with mouse movement events enabled.
1267 Within a `track-mouse' form, mouse motion generates input events that
1268 you can read with `read-event'.
1269 Normally, mouse motion is ignored.
1270 usage: (track-mouse BODY...) */)
1273 ptrdiff_t count
= SPECPDL_INDEX ();
1276 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1278 do_mouse_tracking
= Qt
;
1280 val
= Fprogn (args
);
1281 return unbind_to (count
, val
);
1284 /* If mouse has moved on some frame, return one of those frames.
1288 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1289 after resizing the tool-bar window. */
1291 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1294 bool ignore_mouse_drag_p
;
1296 static struct frame
*
1297 some_mouse_moved (void)
1299 Lisp_Object tail
, frame
;
1301 if (ignore_mouse_drag_p
)
1303 /* ignore_mouse_drag_p = 0; */
1307 FOR_EACH_FRAME (tail
, frame
)
1309 if (XFRAME (frame
)->mouse_moved
)
1310 return XFRAME (frame
);
1317 /* This is the actual command reading loop,
1318 sans error-handling encapsulation. */
1320 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1321 bool, bool, bool, bool);
1322 void safe_run_hooks (Lisp_Object
);
1323 static void adjust_point_for_property (ptrdiff_t, bool);
1325 /* The last boundary auto-added to buffer-undo-list. */
1326 Lisp_Object last_undo_boundary
;
1328 extern Lisp_Object Qregion_extract_function
;
1330 /* FIXME: This is wrong rather than test window-system, we should call
1331 a new set-selection, which will then dispatch to x-set-selection, or
1332 tty-set-selection, or w32-set-selection, ... */
1335 command_loop_1 (void)
1338 Lisp_Object keybuf
[30];
1340 EMACS_INT prev_modiff
= 0;
1341 struct buffer
*prev_buffer
= NULL
;
1342 bool already_adjusted
= 0;
1344 kset_prefix_arg (current_kboard
, Qnil
);
1345 kset_last_prefix_arg (current_kboard
, Qnil
);
1346 Vdeactivate_mark
= Qnil
;
1347 waiting_for_input
= 0;
1350 this_command_key_count
= 0;
1351 this_command_key_count_reset
= 0;
1352 this_single_command_key_start
= 0;
1354 if (NILP (Vmemory_full
))
1356 /* Make sure this hook runs after commands that get errors and
1357 throw to top level. */
1358 /* Note that the value cell will never directly contain nil
1359 if the symbol is a local variable. */
1360 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1361 safe_run_hooks (Qpost_command_hook
);
1363 /* If displaying a message, resize the echo area window to fit
1364 that message's size exactly. */
1365 if (!NILP (echo_area_buffer
[0]))
1366 resize_echo_area_exactly ();
1368 /* If there are warnings waiting, process them. */
1369 if (!NILP (Vdelayed_warnings_list
))
1370 safe_run_hooks (Qdelayed_warnings_hook
);
1372 if (!NILP (Vdeferred_action_list
))
1373 safe_run_hooks (Qdeferred_action_function
);
1376 /* Do this after running Vpost_command_hook, for consistency. */
1377 kset_last_command (current_kboard
, Vthis_command
);
1378 kset_real_last_command (current_kboard
, Vreal_this_command
);
1379 if (!CONSP (last_command_event
))
1380 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1384 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1387 /* Make sure the current window's buffer is selected. */
1388 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1390 /* Display any malloc warning that just came out. Use while because
1391 displaying one warning can cause another. */
1393 while (pending_malloc_warning
)
1394 display_malloc_warning ();
1396 Vdeactivate_mark
= Qnil
;
1398 /* Don't ignore mouse movements for more than a single command
1399 loop. (This flag is set in xdisp.c whenever the tool bar is
1400 resized, because the resize moves text up or down, and would
1401 generate false mouse drag events if we don't ignore them.) */
1402 ignore_mouse_drag_p
= 0;
1404 /* If minibuffer on and echo area in use,
1405 wait a short time and redraw minibuffer. */
1408 && !NILP (echo_area_buffer
[0])
1409 && EQ (minibuf_window
, echo_area_window
)
1410 && NUMBERP (Vminibuffer_message_timeout
))
1412 /* Bind inhibit-quit to t so that C-g gets read in
1413 rather than quitting back to the minibuffer. */
1414 ptrdiff_t count
= SPECPDL_INDEX ();
1415 specbind (Qinhibit_quit
, Qt
);
1417 sit_for (Vminibuffer_message_timeout
, 0, 2);
1419 /* Clear the echo area. */
1421 safe_run_hooks (Qecho_area_clear_hook
);
1423 unbind_to (count
, Qnil
);
1425 /* If a C-g came in before, treat it as input now. */
1426 if (!NILP (Vquit_flag
))
1429 Vunread_command_events
= list1 (make_number (quit_char
));
1433 /* If it has changed current-menubar from previous value,
1434 really recompute the menubar from the value. */
1435 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1436 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1437 call0 (Qrecompute_lucid_menubar
);
1439 before_command_key_count
= this_command_key_count
;
1440 before_command_echo_length
= echo_length ();
1442 Vthis_command
= Qnil
;
1443 Vreal_this_command
= Qnil
;
1444 Vthis_original_command
= Qnil
;
1445 Vthis_command_keys_shift_translated
= Qnil
;
1447 /* Read next key sequence; i gets its length. */
1448 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1451 /* A filter may have run while we were reading the input. */
1452 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1454 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1458 /* Now we have read a key sequence of length I,
1459 or else I is 0 and we found end of file. */
1461 if (i
== 0) /* End of file -- happens only in */
1462 return Qnil
; /* a kbd macro, at the end. */
1463 /* -1 means read_key_sequence got a menu that was rejected.
1464 Just loop around and read another command. */
1468 this_command_key_count
= 0;
1469 this_command_key_count_reset
= 0;
1470 this_single_command_key_start
= 0;
1474 last_command_event
= keybuf
[i
- 1];
1476 /* If the previous command tried to force a specific window-start,
1477 forget about that, in case this command moves point far away
1478 from that position. But also throw away beg_unchanged and
1479 end_unchanged information in that case, so that redisplay will
1480 update the whole window properly. */
1481 if (XWINDOW (selected_window
)->force_start
)
1484 XWINDOW (selected_window
)->force_start
= 0;
1485 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1486 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1489 cmd
= read_key_sequence_cmd
;
1490 if (!NILP (Vexecuting_kbd_macro
))
1492 if (!NILP (Vquit_flag
))
1494 Vexecuting_kbd_macro
= Qt
;
1495 QUIT
; /* Make some noise. */
1496 /* Will return since macro now empty. */
1500 /* Do redisplay processing after this command except in special
1501 cases identified below. */
1502 prev_buffer
= current_buffer
;
1503 prev_modiff
= MODIFF
;
1504 last_point_position
= PT
;
1506 /* By default, we adjust point to a boundary of a region that
1507 has such a property that should be treated intangible
1508 (e.g. composition, display). But, some commands will set
1509 this variable differently. */
1510 Vdisable_point_adjustment
= Qnil
;
1512 /* Process filters and timers may have messed with deactivate-mark.
1513 reset it before we execute the command. */
1514 Vdeactivate_mark
= Qnil
;
1516 /* Remap command through active keymaps. */
1517 Vthis_original_command
= cmd
;
1518 if (!NILP (read_key_sequence_remapped
))
1519 cmd
= read_key_sequence_remapped
;
1521 /* Execute the command. */
1523 Vthis_command
= cmd
;
1524 Vreal_this_command
= cmd
;
1525 safe_run_hooks (Qpre_command_hook
);
1527 already_adjusted
= 0;
1529 if (NILP (Vthis_command
))
1530 /* nil means key is undefined. */
1534 /* Here for a command that isn't executed directly. */
1536 #ifdef HAVE_WINDOW_SYSTEM
1537 ptrdiff_t scount
= SPECPDL_INDEX ();
1539 if (display_hourglass_p
1540 && NILP (Vexecuting_kbd_macro
))
1542 record_unwind_protect_void (cancel_hourglass
);
1547 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1549 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1552 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1553 ? Qnil
: BVAR (current_buffer
, undo_list
));
1555 call1 (Qcommand_execute
, Vthis_command
);
1557 #ifdef HAVE_WINDOW_SYSTEM
1558 /* Do not check display_hourglass_p here, because
1559 `command-execute' could change it, but we should cancel
1560 hourglass cursor anyway.
1561 But don't cancel the hourglass within a macro
1562 just because a command in the macro finishes. */
1563 if (NILP (Vexecuting_kbd_macro
))
1564 unbind_to (scount
, Qnil
);
1567 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1569 safe_run_hooks (Qpost_command_hook
);
1571 /* If displaying a message, resize the echo area window to fit
1572 that message's size exactly. */
1573 if (!NILP (echo_area_buffer
[0]))
1574 resize_echo_area_exactly ();
1576 /* If there are warnings waiting, process them. */
1577 if (!NILP (Vdelayed_warnings_list
))
1578 safe_run_hooks (Qdelayed_warnings_hook
);
1580 safe_run_hooks (Qdeferred_action_function
);
1582 /* If there is a prefix argument,
1583 1) We don't want Vlast_command to be ``universal-argument''
1584 (that would be dumb), so don't set Vlast_command,
1585 2) we want to leave echoing on so that the prefix will be
1586 echoed as part of this key sequence, so don't call
1588 3) we want to leave this_command_key_count non-zero, so that
1589 read_char will realize that it is re-reading a character, and
1590 not echo it a second time.
1592 If the command didn't actually create a prefix arg,
1593 but is merely a frame event that is transparent to prefix args,
1594 then the above doesn't apply. */
1595 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1596 || CONSP (last_command_event
))
1598 kset_last_command (current_kboard
, Vthis_command
);
1599 kset_real_last_command (current_kboard
, Vreal_this_command
);
1600 if (!CONSP (last_command_event
))
1601 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1603 this_command_key_count
= 0;
1604 this_command_key_count_reset
= 0;
1605 this_single_command_key_start
= 0;
1608 if (!NILP (BVAR (current_buffer
, mark_active
))
1609 && !NILP (Vrun_hooks
))
1611 /* In Emacs 22, setting transient-mark-mode to `only' was a
1612 way of turning it on for just one command. This usage is
1613 obsolete, but support it anyway. */
1614 if (EQ (Vtransient_mark_mode
, Qidentity
))
1615 Vtransient_mark_mode
= Qnil
;
1616 else if (EQ (Vtransient_mark_mode
, Qonly
))
1617 Vtransient_mark_mode
= Qidentity
;
1619 if (!NILP (Vdeactivate_mark
))
1620 /* If `select-active-regions' is non-nil, this call to
1621 `deactivate-mark' also sets the PRIMARY selection. */
1622 call0 (Qdeactivate_mark
);
1625 /* Even if not deactivating the mark, set PRIMARY if
1626 `select-active-regions' is non-nil. */
1627 if (!NILP (Fwindow_system (Qnil
))
1628 /* Even if mark_active is non-nil, the actual buffer
1629 marker may not have been set yet (Bug#7044). */
1630 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1631 && (EQ (Vselect_active_regions
, Qonly
)
1632 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1633 : (!NILP (Vselect_active_regions
)
1634 && !NILP (Vtransient_mark_mode
)))
1635 && NILP (Fmemq (Vthis_command
,
1636 Vselection_inhibit_update_commands
)))
1639 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1640 if (XINT (Flength (txt
)) > 0)
1641 /* Don't set empty selections. */
1642 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1645 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1647 Lisp_Object hook
= intern ("activate-mark-hook");
1648 Frun_hooks (1, &hook
);
1652 Vsaved_region_selection
= Qnil
;
1657 if (current_buffer
== prev_buffer
1658 && last_point_position
!= PT
1659 && NILP (Vdisable_point_adjustment
)
1660 && NILP (Vglobal_disable_point_adjustment
))
1662 if (last_point_position
> BEGV
1663 && last_point_position
< ZV
1664 && (composition_adjust_point (last_point_position
,
1665 last_point_position
)
1666 != last_point_position
))
1667 /* The last point was temporarily set within a grapheme
1668 cluster to prevent automatic composition. To recover
1669 the automatic composition, we must update the
1671 windows_or_buffers_changed
= 21;
1672 if (!already_adjusted
)
1673 adjust_point_for_property (last_point_position
,
1674 MODIFF
!= prev_modiff
);
1677 /* Install chars successfully executed in kbd macro. */
1679 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1680 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1681 finalize_kbd_macro_chars ();
1686 read_menu_command (void)
1688 Lisp_Object keybuf
[30];
1689 ptrdiff_t count
= SPECPDL_INDEX ();
1692 /* We don't want to echo the keystrokes while navigating the
1694 specbind (Qecho_keystrokes
, make_number (0));
1696 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1699 unbind_to (count
, Qnil
);
1701 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1703 if (i
== 0 || i
== -1)
1706 return read_key_sequence_cmd
;
1709 /* Adjust point to a boundary of a region that has such a property
1710 that should be treated intangible. For the moment, we check
1711 `composition', `display' and `invisible' properties.
1712 LAST_PT is the last position of point. */
1715 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1718 Lisp_Object val
, overlay
, tmp
;
1719 /* When called after buffer modification, we should temporarily
1720 suppress the point adjustment for automatic composition so that a
1721 user can keep inserting another character at point or keep
1722 deleting characters around point. */
1723 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1724 ptrdiff_t orig_pt
= PT
;
1726 /* FIXME: cycling is probably not necessary because these properties
1727 can't be usefully combined anyway. */
1728 while (check_composition
|| check_display
|| check_invisible
)
1730 /* FIXME: check `intangible'. */
1731 if (check_composition
1732 && PT
> BEGV
&& PT
< ZV
1733 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1736 check_display
= check_invisible
= 1;
1738 check_composition
= 0;
1740 && PT
> BEGV
&& PT
< ZV
1741 && !NILP (val
= get_char_property_and_overlay
1742 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1743 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1744 && (!OVERLAYP (overlay
)
1745 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1746 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1747 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1748 && (beg
< PT
/* && end > PT <- It's always the case. */
1749 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1752 SET_PT (PT
< last_pt
1753 ? (STRINGP (val
) && SCHARS (val
) == 0
1754 ? max (beg
- 1, BEGV
)
1757 check_composition
= check_invisible
= 1;
1760 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1766 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1769 /* FIXME: We should stop if we find a spot between
1770 two runs of `invisible' where inserted text would
1771 be visible. This is important when we have two
1772 invisible boundaries that enclose an area: if the
1773 area is empty, we need this test in order to make
1774 it possible to place point in the middle rather
1775 than skip both boundaries. However, this code
1776 also stops anywhere in a non-sticky text-property,
1777 which breaks (e.g.) Org mode. */
1778 && (val
= Fget_pos_property (make_number (end
),
1780 TEXT_PROP_MEANS_INVISIBLE (val
))
1782 && !NILP (val
= get_char_property_and_overlay
1783 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1784 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1786 ellipsis
= ellipsis
|| inv
> 1
1787 || (OVERLAYP (overlay
)
1788 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1789 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1790 tmp
= Fnext_single_char_property_change
1791 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1792 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1796 && (val
= Fget_pos_property (make_number (beg
),
1798 TEXT_PROP_MEANS_INVISIBLE (val
))
1800 && !NILP (val
= get_char_property_and_overlay
1801 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1802 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1804 ellipsis
= ellipsis
|| inv
> 1
1805 || (OVERLAYP (overlay
)
1806 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1807 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1808 tmp
= Fprevious_single_char_property_change
1809 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1810 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1813 /* Move away from the inside area. */
1814 if (beg
< PT
&& end
> PT
)
1816 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1817 /* We haven't moved yet (so we don't need to fear
1818 infinite-looping) and we were outside the range
1819 before (so either end of the range still corresponds
1820 to a move in the right direction): pretend we moved
1821 less than we actually did, so that we still have
1822 more freedom below in choosing which end of the range
1824 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1825 /* We either have moved already or the last point
1826 was already in the range: we don't get to choose
1827 which end of the range we have to go to. */
1828 : (PT
< last_pt
? beg
: end
));
1829 check_composition
= check_display
= 1;
1831 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1832 the point to something other than its argument, due to
1833 point-motion hooks, intangibility, etc. */
1834 eassert (PT
== beg
|| PT
== end
);
1837 /* Pretend the area doesn't exist if the buffer is not
1839 if (!modified
&& !ellipsis
&& beg
< end
)
1841 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1842 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1843 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1844 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1845 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1846 /* We've already moved as far as we can. Trying to go
1847 to the other end would mean moving backwards and thus
1848 could lead to an infinite loop. */
1850 else if (val
= Fget_pos_property (make_number (PT
),
1852 TEXT_PROP_MEANS_INVISIBLE (val
)
1853 && (val
= (Fget_pos_property
1854 (make_number (PT
== beg
? end
: beg
),
1856 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1857 (check_composition
= check_display
= 1,
1858 SET_PT (PT
== beg
? end
: beg
));
1861 check_invisible
= 0;
1865 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1868 safe_run_hooks_1 (void)
1870 eassert (CONSP (Vinhibit_quit
));
1871 return call0 (XCDR (Vinhibit_quit
));
1874 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1878 safe_run_hooks_error (Lisp_Object error_data
)
1881 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1882 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1883 Lisp_Object args
[4];
1884 args
[0] = build_string ("Error in %s (%S): %S");
1887 args
[3] = error_data
;
1893 Lisp_Object newval
= Qnil
;
1894 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1895 if (EQ (fun
, XCAR (val
)))
1898 newval
= Fcons (XCAR (val
), newval
);
1900 return Fset (hook
, Fnreverse (newval
));
1901 /* Not found in the local part of the hook. Let's look at the global
1904 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1905 : Fdefault_value (hook
));
1906 CONSP (val
); val
= XCDR (val
))
1907 if (EQ (fun
, XCAR (val
)))
1910 newval
= Fcons (XCAR (val
), newval
);
1912 return Fset_default (hook
, Fnreverse (newval
));
1918 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1920 eassert (nargs
== 1);
1921 if (CONSP (Vinhibit_quit
))
1922 XSETCDR (Vinhibit_quit
, args
[0]);
1924 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1926 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1930 /* If we get an error while running the hook, cause the hook variable
1931 to be nil. Also inhibit quits, so that C-g won't cause the hook
1932 to mysteriously evaporate. */
1935 safe_run_hooks (Lisp_Object hook
)
1937 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1938 to its body or to its handlers other than via globals such as
1939 dynamically-bound variables ;-) */
1940 ptrdiff_t count
= SPECPDL_INDEX ();
1941 specbind (Qinhibit_quit
, hook
);
1943 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1945 unbind_to (count
, Qnil
);
1949 /* Nonzero means polling for input is temporarily suppressed. */
1951 int poll_suppress_count
;
1954 #ifdef POLL_FOR_INPUT
1956 /* Asynchronous timer for polling. */
1958 static struct atimer
*poll_timer
;
1960 /* Poll for input, so that we catch a C-g if it comes in. */
1962 poll_for_input_1 (void)
1964 if (! input_blocked_p ()
1965 && !waiting_for_input
)
1969 /* Timer callback function for poll_timer. TIMER is equal to
1973 poll_for_input (struct atimer
*timer
)
1975 if (poll_suppress_count
== 0)
1976 pending_signals
= 1;
1979 #endif /* POLL_FOR_INPUT */
1981 /* Begin signals to poll for input, if they are appropriate.
1982 This function is called unconditionally from various places. */
1985 start_polling (void)
1987 #ifdef POLL_FOR_INPUT
1988 /* XXX This condition was (read_socket_hook && !interrupt_input),
1989 but read_socket_hook is not global anymore. Let's pretend that
1991 if (!interrupt_input
)
1993 /* Turn alarm handling on unconditionally. It might have
1994 been turned off in process.c. */
1995 turn_on_atimers (1);
1997 /* If poll timer doesn't exist, or we need one with
1998 a different interval, start a new one. */
1999 if (poll_timer
== NULL
2000 || poll_timer
->interval
.tv_sec
!= polling_period
)
2002 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2003 struct timespec interval
= make_timespec (period
, 0);
2006 cancel_atimer (poll_timer
);
2008 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2009 poll_for_input
, NULL
);
2012 /* Let the timer's callback function poll for input
2013 if this becomes zero. */
2014 --poll_suppress_count
;
2019 /* True if we are using polling to handle input asynchronously. */
2022 input_polling_used (void)
2024 #ifdef POLL_FOR_INPUT
2025 /* XXX This condition was (read_socket_hook && !interrupt_input),
2026 but read_socket_hook is not global anymore. Let's pretend that
2028 return !interrupt_input
;
2034 /* Turn off polling. */
2039 #ifdef POLL_FOR_INPUT
2040 /* XXX This condition was (read_socket_hook && !interrupt_input),
2041 but read_socket_hook is not global anymore. Let's pretend that
2043 if (!interrupt_input
)
2044 ++poll_suppress_count
;
2048 /* Set the value of poll_suppress_count to COUNT
2049 and start or stop polling accordingly. */
2052 set_poll_suppress_count (int count
)
2054 #ifdef POLL_FOR_INPUT
2055 if (count
== 0 && poll_suppress_count
!= 0)
2057 poll_suppress_count
= 1;
2060 else if (count
!= 0 && poll_suppress_count
== 0)
2064 poll_suppress_count
= count
;
2068 /* Bind polling_period to a value at least N.
2069 But don't decrease it. */
2072 bind_polling_period (int n
)
2074 #ifdef POLL_FOR_INPUT
2075 EMACS_INT
new = polling_period
;
2080 stop_other_atimers (poll_timer
);
2082 specbind (Qpolling_period
, make_number (new));
2083 /* Start a new alarm with the new period. */
2088 /* Apply the control modifier to CHARACTER. */
2094 make_ctrl_char (int c
)
2096 /* Save the upper bits here. */
2097 int upper
= c
& ~0177;
2099 if (! ASCII_BYTE_P (c
))
2100 return c
|= ctrl_modifier
;
2104 /* Everything in the columns containing the upper-case letters
2105 denotes a control character. */
2106 if (c
>= 0100 && c
< 0140)
2110 /* Set the shift modifier for a control char
2111 made from a shifted letter. But only for letters! */
2112 if (oc
>= 'A' && oc
<= 'Z')
2113 c
|= shift_modifier
;
2116 /* The lower-case letters denote control characters too. */
2117 else if (c
>= 'a' && c
<= 'z')
2120 /* Include the bits for control and shift
2121 only if the basic ASCII code can't indicate them. */
2125 /* Replace the high bits. */
2126 c
|= (upper
& ~ctrl_modifier
);
2131 /* Display the help-echo property of the character after the mouse pointer.
2132 Either show it in the echo area, or call show-help-function to display
2133 it by other means (maybe in a tooltip).
2135 If HELP is nil, that means clear the previous help echo.
2137 If HELP is a string, display that string. If HELP is a function,
2138 call it with OBJECT and POS as arguments; the function should
2139 return a help string or nil for none. For all other types of HELP,
2140 evaluate it to obtain a string.
2142 WINDOW is the window in which the help was generated, if any.
2143 It is nil if not in a window.
2145 If OBJECT is a buffer, POS is the position in the buffer where the
2146 `help-echo' text property was found.
2148 If OBJECT is an overlay, that overlay has a `help-echo' property,
2149 and POS is the position in the overlay's buffer under the mouse.
2151 If OBJECT is a string (an overlay string or a string displayed with
2152 the `display' property). POS is the position in that string under
2155 Note: this function may only be called with HELP nil or a string
2156 from X code running asynchronously. */
2159 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2162 if (!NILP (help
) && !STRINGP (help
))
2164 if (FUNCTIONP (help
))
2165 help
= safe_call (4, help
, window
, object
, pos
);
2167 help
= safe_eval (help
);
2169 if (!STRINGP (help
))
2173 if (!noninteractive
&& STRINGP (help
))
2175 /* The mouse-fixup-help-message Lisp function can call
2176 mouse_position_hook, which resets the mouse_moved flags.
2177 This causes trouble if we are trying to read a mouse motion
2178 event (i.e., if we are inside a `track-mouse' form), so we
2179 restore the mouse_moved flag. */
2180 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2181 help
= call1 (Qmouse_fixup_help_message
, help
);
2186 if (STRINGP (help
) || NILP (help
))
2188 if (!NILP (Vshow_help_function
))
2189 call1 (Vshow_help_function
, help
);
2190 help_echo_showing_p
= STRINGP (help
);
2196 /* Input of single characters from keyboard */
2198 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2199 struct timespec
*end_time
);
2200 static void record_char (Lisp_Object c
);
2202 static Lisp_Object help_form_saved_window_configs
;
2204 read_char_help_form_unwind (void)
2206 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2207 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2208 if (!NILP (window_config
))
2209 Fset_window_configuration (window_config
);
2212 #define STOP_POLLING \
2213 do { if (! polling_stopped_here) stop_polling (); \
2214 polling_stopped_here = 1; } while (0)
2216 #define RESUME_POLLING \
2217 do { if (polling_stopped_here) start_polling (); \
2218 polling_stopped_here = 0; } while (0)
2221 read_event_from_main_queue (struct timespec
*end_time
,
2222 sys_jmp_buf local_getcjmp
,
2223 bool *used_mouse_menu
)
2225 Lisp_Object c
= Qnil
;
2226 sys_jmp_buf save_jump
;
2227 KBOARD
*kb
IF_LINT (= NULL
);
2231 /* Read from the main queue, and if that gives us something we can't use yet,
2232 we put it on the appropriate side queue and try again. */
2234 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2237 /* Actually read a character, waiting if necessary. */
2238 save_getcjmp (save_jump
);
2239 restore_getcjmp (local_getcjmp
);
2241 timer_start_idle ();
2242 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2243 restore_getcjmp (save_jump
);
2245 if (! NILP (c
) && (kb
!= current_kboard
))
2247 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2250 while (CONSP (XCDR (last
)))
2252 if (!NILP (XCDR (last
)))
2256 kset_kbd_queue (kb
, list1 (c
));
2258 XSETCDR (last
, list1 (c
));
2259 kb
->kbd_queue_has_data
= 1;
2263 current_kboard
= kb
;
2264 /* This is going to exit from read_char
2265 so we had better get rid of this frame's stuff. */
2266 return make_number (-2);
2269 /* Terminate Emacs in batch mode if at eof. */
2270 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2271 Fkill_emacs (make_number (1));
2275 /* Add in any extra modifiers, where appropriate. */
2276 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2277 || ((extra_keyboard_modifiers
& 0177) < ' '
2278 && (extra_keyboard_modifiers
& 0177) != 0))
2279 XSETINT (c
, make_ctrl_char (XINT (c
)));
2281 /* Transfer any other modifier bits directly from
2282 extra_keyboard_modifiers to c. Ignore the actual character code
2283 in the low 16 bits of extra_keyboard_modifiers. */
2284 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2292 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2295 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2296 sys_jmp_buf local_getcjmp
,
2297 Lisp_Object prev_event
,
2298 bool *used_mouse_menu
)
2300 #define MAX_ENCODED_BYTES 16
2301 Lisp_Object events
[MAX_ENCODED_BYTES
];
2306 = read_event_from_main_queue (end_time
, local_getcjmp
,
2309 /* w32_console already returns decoded events. It either reads
2310 Unicode characters from the Windows keyboard input, or
2311 converts characters encoded in the current codepage into
2312 Unicode. See w32inevt.c:key_event, near its end. */
2315 struct frame
*frame
= XFRAME (selected_frame
);
2316 struct terminal
*terminal
= frame
->terminal
;
2317 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2318 /* Don't apply decoding if we're just reading a raw event
2319 (e.g. reading bytes sent by the xterm to specify the position
2320 of a mouse click). */
2321 && (!EQ (prev_event
, Qt
))
2322 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2323 & CODING_REQUIRE_DECODING_MASK
)))
2324 return nextevt
; /* No decoding needed. */
2327 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2328 eassert (n
< MAX_ENCODED_BYTES
);
2329 events
[n
++] = nextevt
;
2330 if (NATNUMP (nextevt
)
2331 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2332 { /* An encoded byte sequence, let's try to decode it. */
2333 struct coding_system
*coding
2334 = TERMINAL_KEYBOARD_CODING (terminal
);
2335 unsigned char *src
= alloca (n
);
2337 for (i
= 0; i
< n
; i
++)
2338 src
[i
] = XINT (events
[i
]);
2340 for (i
= 0; i
< n
; i
++)
2342 coding
->destination
= alloca (n
* 4);
2343 coding
->dst_bytes
= n
* 4;
2344 decode_coding_c_string (coding
, src
, n
, Qnil
);
2345 eassert (coding
->produced_char
<= n
);
2346 if (coding
->produced_char
== 0)
2347 { /* The encoded sequence is incomplete. */
2348 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2349 continue; /* Read on! */
2353 const unsigned char *p
= coding
->destination
;
2354 eassert (coding
->carryover_bytes
== 0);
2356 while (n
< coding
->produced_char
)
2357 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2360 /* Now `events' should hold decoded events.
2361 Normally, n should be equal to 1, but better not rely on it.
2362 We can only return one event here, so return the first we
2363 had and keep the others (if any) for later. */
2365 Vunread_command_events
2366 = Fcons (events
[--n
], Vunread_command_events
);
2373 /* Read a character from the keyboard; call the redisplay if needed. */
2374 /* commandflag 0 means do not autosave, but do redisplay.
2375 -1 means do not redisplay, but do autosave.
2376 -2 means do neither.
2379 /* The argument MAP is a keymap for menu prompting.
2381 PREV_EVENT is the previous input event, or nil if we are reading
2382 the first event of a key sequence (or not reading a key sequence).
2383 If PREV_EVENT is t, that is a "magic" value that says
2384 not to run input methods, but in other respects to act as if
2385 not reading a key sequence.
2387 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2388 if we used a mouse menu to read the input, or false otherwise. If
2389 USED_MOUSE_MENU is null, don't dereference it.
2391 Value is -2 when we find input on another keyboard. A second call
2392 to read_char will read it.
2394 If END_TIME is non-null, it is a pointer to a struct timespec
2395 specifying the maximum time to wait until. If no input arrives by
2396 that time, stop waiting and return nil.
2398 Value is t if we showed a menu and the user rejected it. */
2401 read_char (int commandflag
, Lisp_Object map
,
2402 Lisp_Object prev_event
,
2403 bool *used_mouse_menu
, struct timespec
*end_time
)
2407 sys_jmp_buf local_getcjmp
;
2408 sys_jmp_buf save_jump
;
2409 Lisp_Object tem
, save
;
2410 volatile Lisp_Object previous_echo_area_message
;
2411 volatile Lisp_Object also_record
;
2412 volatile bool reread
;
2413 struct gcpro gcpro1
, gcpro2
;
2414 bool volatile polling_stopped_here
= 0;
2415 struct kboard
*orig_kboard
= current_kboard
;
2419 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2420 before_command_key_count
= this_command_key_count
;
2421 before_command_echo_length
= echo_length ();
2424 previous_echo_area_message
= Qnil
;
2426 GCPRO2 (c
, previous_echo_area_message
);
2431 if (CONSP (Vunread_post_input_method_events
))
2433 c
= XCAR (Vunread_post_input_method_events
);
2434 Vunread_post_input_method_events
2435 = XCDR (Vunread_post_input_method_events
);
2437 /* Undo what read_char_x_menu_prompt did when it unread
2438 additional keys returned by Fx_popup_menu. */
2440 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2448 if (CONSP (Vunread_command_events
))
2450 bool was_disabled
= 0;
2452 c
= XCAR (Vunread_command_events
);
2453 Vunread_command_events
= XCDR (Vunread_command_events
);
2457 /* Undo what sit-for did when it unread additional keys
2458 inside universal-argument. */
2461 && EQ (XCAR (c
), Qt
))
2467 /* Undo what read_char_x_menu_prompt did when it unread
2468 additional keys returned by Fx_popup_menu. */
2470 && EQ (XCDR (c
), Qdisabled
)
2471 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2477 /* If the queued event is something that used the mouse,
2478 set used_mouse_menu accordingly. */
2480 /* Also check was_disabled so last-nonmenu-event won't return
2481 a bad value when submenus are involved. (Bug#447) */
2482 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2483 *used_mouse_menu
= 1;
2485 goto reread_for_input_method
;
2488 if (CONSP (Vunread_input_method_events
))
2490 c
= XCAR (Vunread_input_method_events
);
2491 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2493 /* Undo what read_char_x_menu_prompt did when it unread
2494 additional keys returned by Fx_popup_menu. */
2496 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2500 goto reread_for_input_method
;
2503 this_command_key_count_reset
= 0;
2505 if (!NILP (Vexecuting_kbd_macro
))
2507 /* We set this to Qmacro; since that's not a frame, nobody will
2508 try to switch frames on us, and the selected window will
2511 Since this event came from a macro, it would be misleading to
2512 leave internal_last_event_frame set to wherever the last
2513 real event came from. Normally, a switch-frame event selects
2514 internal_last_event_frame after each command is read, but
2515 events read from a macro should never cause a new frame to be
2517 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2519 /* Exit the macro if we are at the end.
2520 Also, some things replace the macro with t
2521 to force an early exit. */
2522 if (EQ (Vexecuting_kbd_macro
, Qt
)
2523 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2529 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2530 if (STRINGP (Vexecuting_kbd_macro
)
2531 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2532 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2534 executing_kbd_macro_index
++;
2539 if (!NILP (unread_switch_frame
))
2541 c
= unread_switch_frame
;
2542 unread_switch_frame
= Qnil
;
2544 /* This event should make it into this_command_keys, and get echoed
2545 again, so we do not set `reread'. */
2549 /* If redisplay was requested. */
2550 if (commandflag
>= 0)
2552 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2554 /* If there is pending input, process any events which are not
2555 user-visible, such as X selection_request events. */
2557 || detect_input_pending_run_timers (0))
2558 swallow_events (0); /* May clear input_pending. */
2560 /* Redisplay if no pending input. */
2561 while (!input_pending
)
2563 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2564 redisplay_preserve_echo_area (5);
2569 /* Normal case: no input arrived during redisplay. */
2572 /* Input arrived and pre-empted redisplay.
2573 Process any events which are not user-visible. */
2575 /* If that cleared input_pending, try again to redisplay. */
2578 /* Prevent the redisplay we just did
2579 from messing up echoing of the input after the prompt. */
2580 if (commandflag
== 0 && echo_current
)
2581 echo_message_buffer
= echo_area_buffer
[0];
2585 /* Message turns off echoing unless more keystrokes turn it on again.
2587 The code in 20.x for the condition was
2589 1. echo_area_glyphs && *echo_area_glyphs
2590 2. && echo_area_glyphs != current_kboard->echobuf
2591 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2593 (1) means there's a current message displayed
2595 (2) means it's not the message from echoing from the current
2598 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2599 is set to a non-null value. This is done in read_char and it is
2600 set to echo_area_glyphs after a call to echo_char. That means
2601 ok_to_echo_at_next_pause is either null or
2602 current_kboard->echobuf with the appropriate current_kboard at
2605 So, condition (3) means in clear text ok_to_echo_at_next_pause
2606 must be either null, or the current message isn't from echoing at
2607 all, or it's from echoing from a different kboard than the
2610 if (/* There currently is something in the echo area. */
2611 !NILP (echo_area_buffer
[0])
2612 && (/* It's an echo from a different kboard. */
2613 echo_kboard
!= current_kboard
2614 /* Or we explicitly allow overwriting whatever there is. */
2615 || ok_to_echo_at_next_pause
== NULL
))
2620 /* Try reading a character via menu prompting in the minibuf.
2621 Try this before the sit-for, because the sit-for
2622 would do the wrong thing if we are supposed to do
2623 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2624 after a mouse event so don't try a minibuf menu. */
2626 if (KEYMAPP (map
) && INTERACTIVE
2627 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2628 /* Don't bring up a menu if we already have another event. */
2629 && NILP (Vunread_command_events
)
2630 && !detect_input_pending_run_timers (0))
2632 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2634 if (INTEGERP (c
) && XINT (c
) == -2)
2635 return c
; /* wrong_kboard_jmpbuf */
2641 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2642 We will do that below, temporarily for short sections of code,
2643 when appropriate. local_getcjmp must be in effect
2644 around any call to sit_for or kbd_buffer_get_event;
2645 it *must not* be in effect when we call redisplay. */
2647 jmpcount
= SPECPDL_INDEX ();
2648 if (sys_setjmp (local_getcjmp
))
2650 /* Handle quits while reading the keyboard. */
2651 /* We must have saved the outer value of getcjmp here,
2652 so restore it now. */
2653 restore_getcjmp (save_jump
);
2654 unbind_to (jmpcount
, Qnil
);
2655 XSETINT (c
, quit_char
);
2656 internal_last_event_frame
= selected_frame
;
2657 Vlast_event_frame
= internal_last_event_frame
;
2658 /* If we report the quit char as an event,
2659 don't do so more than once. */
2660 if (!NILP (Vinhibit_quit
))
2664 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2665 if (kb
!= current_kboard
)
2667 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2668 /* We shouldn't get here if we were in single-kboard mode! */
2673 while (CONSP (XCDR (last
)))
2675 if (!NILP (XCDR (last
)))
2679 kset_kbd_queue (kb
, list1 (c
));
2681 XSETCDR (last
, list1 (c
));
2682 kb
->kbd_queue_has_data
= 1;
2683 current_kboard
= kb
;
2684 /* This is going to exit from read_char
2685 so we had better get rid of this frame's stuff. */
2687 return make_number (-2); /* wrong_kboard_jmpbuf */
2693 /* Start idle timers if no time limit is supplied. We don't do it
2694 if a time limit is supplied to avoid an infinite recursion in the
2695 situation where an idle timer calls `sit-for'. */
2698 timer_start_idle ();
2700 /* If in middle of key sequence and minibuffer not active,
2701 start echoing if enough time elapses. */
2703 if (minibuf_level
== 0
2705 && !current_kboard
->immediate_echo
2706 && this_command_key_count
> 0
2708 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2709 && NILP (Fzerop (Vecho_keystrokes
))
2710 && (/* No message. */
2711 NILP (echo_area_buffer
[0])
2712 /* Or empty message. */
2713 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2714 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2715 /* Or already echoing from same kboard. */
2716 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2717 /* Or not echoing before and echoing allowed. */
2718 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2720 /* After a mouse event, start echoing right away.
2721 This is because we are probably about to display a menu,
2722 and we don't want to delay before doing so. */
2723 if (EVENT_HAS_PARAMETERS (prev_event
))
2729 save_getcjmp (save_jump
);
2730 restore_getcjmp (local_getcjmp
);
2731 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2732 restore_getcjmp (save_jump
);
2734 && ! CONSP (Vunread_command_events
))
2739 /* Maybe auto save due to number of keystrokes. */
2741 if (commandflag
!= 0 && commandflag
!= -2
2742 && auto_save_interval
> 0
2743 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2744 && !detect_input_pending_run_timers (0))
2746 Fdo_auto_save (Qnil
, Qnil
);
2747 /* Hooks can actually change some buffers in auto save. */
2751 /* Try reading using an X menu.
2752 This is never confused with reading using the minibuf
2753 because the recursive call of read_char in read_char_minibuf_menu_prompt
2754 does not pass on any keymaps. */
2756 if (KEYMAPP (map
) && INTERACTIVE
2757 && !NILP (prev_event
)
2758 && EVENT_HAS_PARAMETERS (prev_event
)
2759 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2760 && !EQ (XCAR (prev_event
), Qtool_bar
)
2761 /* Don't bring up a menu if we already have another event. */
2762 && NILP (Vunread_command_events
))
2764 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2766 /* Now that we have read an event, Emacs is not idle. */
2773 /* Maybe autosave and/or garbage collect due to idleness. */
2775 if (INTERACTIVE
&& NILP (c
))
2778 ptrdiff_t buffer_size
;
2780 /* Slow down auto saves logarithmically in size of current buffer,
2781 and garbage collect while we're at it. */
2782 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2783 last_non_minibuf_size
= Z
- BEG
;
2784 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2786 while (buffer_size
> 64)
2787 delay_level
++, buffer_size
-= buffer_size
>> 2;
2788 if (delay_level
< 4) delay_level
= 4;
2789 /* delay_level is 4 for files under around 50k, 7 at 100k,
2790 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2792 /* Auto save if enough time goes by without input. */
2793 if (commandflag
!= 0 && commandflag
!= -2
2794 && num_nonmacro_input_events
> last_auto_save
2795 && INTEGERP (Vauto_save_timeout
)
2796 && XINT (Vauto_save_timeout
) > 0)
2799 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2801 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2802 timeout
= delay_level
* timeout
/ 4;
2803 save_getcjmp (save_jump
);
2804 restore_getcjmp (local_getcjmp
);
2805 tem0
= sit_for (make_number (timeout
), 1, 1);
2806 restore_getcjmp (save_jump
);
2809 && ! CONSP (Vunread_command_events
))
2811 Fdo_auto_save (Qnil
, Qnil
);
2816 /* If there is still no input available, ask for GC. */
2817 if (!detect_input_pending_run_timers (0))
2821 /* Notify the caller if an autosave hook, or a timer, sentinel or
2822 filter in the sit_for calls above have changed the current
2823 kboard. This could happen if they use the minibuffer or start a
2824 recursive edit, like the fancy splash screen in server.el's
2825 filter. If this longjmp wasn't here, read_key_sequence would
2826 interpret the next key sequence using the wrong translation
2827 tables and function keymaps. */
2828 if (NILP (c
) && current_kboard
!= orig_kboard
)
2831 return make_number (-2); /* wrong_kboard_jmpbuf */
2834 /* If this has become non-nil here, it has been set by a timer
2835 or sentinel or filter. */
2836 if (CONSP (Vunread_command_events
))
2838 c
= XCAR (Vunread_command_events
);
2839 Vunread_command_events
= XCDR (Vunread_command_events
);
2842 /* Read something from current KBOARD's side queue, if possible. */
2846 if (current_kboard
->kbd_queue_has_data
)
2848 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2850 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2851 kset_kbd_queue (current_kboard
,
2852 XCDR (KVAR (current_kboard
, kbd_queue
)));
2853 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2854 current_kboard
->kbd_queue_has_data
= 0;
2855 input_pending
= readable_events (0);
2856 if (EVENT_HAS_PARAMETERS (c
)
2857 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2858 internal_last_event_frame
= XCAR (XCDR (c
));
2859 Vlast_event_frame
= internal_last_event_frame
;
2863 /* If current_kboard's side queue is empty check the other kboards.
2864 If one of them has data that we have not yet seen here,
2865 switch to it and process the data waiting for it.
2867 Note: if the events queued up for another kboard
2868 have already been seen here, and therefore are not a complete command,
2869 the kbd_queue_has_data field is 0, so we skip that kboard here.
2870 That's to avoid an infinite loop switching between kboards here. */
2871 if (NILP (c
) && !single_kboard
)
2874 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2875 if (kb
->kbd_queue_has_data
)
2877 current_kboard
= kb
;
2878 /* This is going to exit from read_char
2879 so we had better get rid of this frame's stuff. */
2881 return make_number (-2); /* wrong_kboard_jmpbuf */
2891 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2892 prev_event
, used_mouse_menu
);
2893 if (NILP(c
) && end_time
&&
2894 timespec_cmp (*end_time
, current_timespec ()) <= 0)
2899 if (EQ (c
, make_number (-2)))
2901 /* This is going to exit from read_char
2902 so we had better get rid of this frame's stuff. */
2916 if (commandflag
>= 0
2917 && !input_pending
&& !detect_input_pending_run_timers (0))
2923 /* Buffer switch events are only for internal wakeups
2924 so don't show them to the user.
2925 Also, don't record a key if we already did. */
2929 /* Process special events within read_char
2930 and loop around to read another event. */
2933 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2938 struct buffer
*prev_buffer
= current_buffer
;
2939 last_input_event
= c
;
2940 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2942 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2943 /* We stopped being idle for this event; undo that. This
2944 prevents automatic window selection (under
2945 mouse_autoselect_window from acting as a real input event, for
2946 example banishing the mouse under mouse-avoidance-mode. */
2947 timer_resume_idle ();
2949 if (current_buffer
!= prev_buffer
)
2951 /* The command may have changed the keymaps. Pretend there
2952 is input in another keyboard and return. This will
2953 recalculate keymaps. */
2954 c
= make_number (-2);
2961 /* Handle things that only apply to characters. */
2964 /* If kbd_buffer_get_event gave us an EOF, return that. */
2968 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2969 && UNSIGNED_CMP (XFASTINT (c
), <,
2970 SCHARS (KVAR (current_kboard
,
2971 Vkeyboard_translate_table
))))
2972 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2973 && UNSIGNED_CMP (XFASTINT (c
), <,
2974 ASIZE (KVAR (current_kboard
,
2975 Vkeyboard_translate_table
))))
2976 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2980 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2981 /* nil in keyboard-translate-table means no translation. */
2987 /* If this event is a mouse click in the menu bar,
2988 return just menu-bar for now. Modify the mouse click event
2989 so we won't do this twice, then queue it up. */
2990 if (EVENT_HAS_PARAMETERS (c
)
2992 && CONSP (EVENT_START (c
))
2993 && CONSP (XCDR (EVENT_START (c
))))
2997 posn
= POSN_POSN (EVENT_START (c
));
2998 /* Handle menu-bar events:
2999 insert the dummy prefix event `menu-bar'. */
3000 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3002 /* Change menu-bar to (menu-bar) as the event "position". */
3003 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3006 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3011 /* Store these characters into recent_keys, the dribble file if any,
3012 and the keyboard macro being defined, if any. */
3014 if (! NILP (also_record
))
3015 record_char (also_record
);
3017 /* Wipe the echo area.
3018 But first, if we are about to use an input method,
3019 save the echo area contents for it to refer to. */
3021 && ! NILP (Vinput_method_function
)
3022 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3024 previous_echo_area_message
= Fcurrent_message ();
3025 Vinput_method_previous_message
= previous_echo_area_message
;
3028 /* Now wipe the echo area, except for help events which do their
3029 own stuff with the echo area. */
3031 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3032 && !(EQ (Qswitch_frame
, XCAR (c
)))
3033 /* Don't wipe echo area for select window events: These might
3034 get delayed via `mouse-autoselect-window' (Bug#11304). */
3035 && !(EQ (Qselect_window
, XCAR (c
)))))
3037 if (!NILP (echo_area_buffer
[0]))
3039 safe_run_hooks (Qecho_area_clear_hook
);
3040 clear_message (1, 0);
3044 reread_for_input_method
:
3046 /* Pass this to the input method, if appropriate. */
3048 && ! NILP (Vinput_method_function
)
3049 /* Don't run the input method within a key sequence,
3050 after the first event of the key sequence. */
3051 && NILP (prev_event
)
3052 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3055 ptrdiff_t key_count
;
3056 bool key_count_reset
;
3057 struct gcpro gcpro1
;
3058 ptrdiff_t count
= SPECPDL_INDEX ();
3060 /* Save the echo status. */
3061 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3062 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3063 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3064 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3067 if (before_command_restore_flag
)
3069 this_command_key_count
= before_command_key_count_1
;
3070 if (this_command_key_count
< this_single_command_key_start
)
3071 this_single_command_key_start
= this_command_key_count
;
3072 echo_truncate (before_command_echo_length_1
);
3073 before_command_restore_flag
= 0;
3077 /* Save the this_command_keys status. */
3078 key_count
= this_command_key_count
;
3079 key_count_reset
= this_command_key_count_reset
;
3082 keys
= Fcopy_sequence (this_command_keys
);
3087 /* Clear out this_command_keys. */
3088 this_command_key_count
= 0;
3089 this_command_key_count_reset
= 0;
3091 /* Now wipe the echo area. */
3092 if (!NILP (echo_area_buffer
[0]))
3093 safe_run_hooks (Qecho_area_clear_hook
);
3094 clear_message (1, 0);
3097 /* If we are not reading a key sequence,
3098 never use the echo area. */
3101 specbind (Qinput_method_use_echo_area
, Qt
);
3104 /* Call the input method. */
3105 tem
= call1 (Vinput_method_function
, c
);
3107 tem
= unbind_to (count
, tem
);
3109 /* Restore the saved echoing state
3110 and this_command_keys state. */
3111 this_command_key_count
= key_count
;
3112 this_command_key_count_reset
= key_count_reset
;
3114 this_command_keys
= keys
;
3117 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3118 kset_echo_string (current_kboard
, saved_echo_string
);
3119 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3120 if (saved_immediate_echo
)
3125 /* The input method can return no events. */
3128 /* Bring back the previous message, if any. */
3129 if (! NILP (previous_echo_area_message
))
3130 message_with_string ("%s", previous_echo_area_message
, 0);
3133 /* It returned one event or more. */
3135 Vunread_post_input_method_events
3136 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3141 /* Display help if not echoing. */
3142 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3144 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3145 Lisp_Object help
, object
, position
, window
, htem
;
3147 htem
= Fcdr (XCDR (c
));
3150 window
= Fcar (htem
);
3152 object
= Fcar (htem
);
3154 position
= Fcar (htem
);
3156 show_help_echo (help
, window
, object
, position
);
3158 /* We stopped being idle for this event; undo that. */
3160 timer_resume_idle ();
3164 if ((! reread
|| this_command_key_count
== 0
3165 || this_command_key_count_reset
)
3169 /* Don't echo mouse motion events. */
3170 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3171 && NILP (Fzerop (Vecho_keystrokes
))
3172 && ! (EVENT_HAS_PARAMETERS (c
)
3173 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3176 if (! NILP (also_record
))
3177 echo_char (also_record
);
3178 /* Once we reread a character, echoing can happen
3179 the next time we pause to read a new one. */
3180 ok_to_echo_at_next_pause
= current_kboard
;
3183 /* Record this character as part of the current key. */
3184 add_command_key (c
);
3185 if (! NILP (also_record
))
3186 add_command_key (also_record
);
3189 last_input_event
= c
;
3192 /* Process the help character specially if enabled. */
3193 if (!NILP (Vhelp_form
) && help_char_p (c
))
3195 ptrdiff_t count
= SPECPDL_INDEX ();
3197 help_form_saved_window_configs
3198 = Fcons (Fcurrent_window_configuration (Qnil
),
3199 help_form_saved_window_configs
);
3200 record_unwind_protect_void (read_char_help_form_unwind
);
3201 call0 (Qhelp_form_show
);
3206 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3207 if (EVENT_HAS_PARAMETERS (c
)
3208 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3209 XSETCAR (help_form_saved_window_configs
, Qnil
);
3211 while (BUFFERP (c
));
3212 /* Remove the help from the frame. */
3213 unbind_to (count
, Qnil
);
3216 if (EQ (c
, make_number (040)))
3220 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3221 while (BUFFERP (c
));
3230 /* Record a key that came from a mouse menu.
3231 Record it for echoing, for this-command-keys, and so on. */
3234 record_menu_key (Lisp_Object c
)
3236 /* Wipe the echo area. */
3237 clear_message (1, 0);
3242 before_command_key_count
= this_command_key_count
;
3243 before_command_echo_length
= echo_length ();
3246 /* Don't echo mouse motion events. */
3247 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3248 && NILP (Fzerop (Vecho_keystrokes
)))
3252 /* Once we reread a character, echoing can happen
3253 the next time we pause to read a new one. */
3254 ok_to_echo_at_next_pause
= 0;
3257 /* Record this character as part of the current key. */
3258 add_command_key (c
);
3260 /* Re-reading in the middle of a command. */
3261 last_input_event
= c
;
3265 /* Return true if should recognize C as "the help character". */
3268 help_char_p (Lisp_Object c
)
3272 if (EQ (c
, Vhelp_char
))
3274 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3275 if (EQ (c
, XCAR (tail
)))
3280 /* Record the input event C in various ways. */
3283 record_char (Lisp_Object c
)
3287 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3289 /* To avoid filling recent_keys with help-echo and mouse-movement
3290 events, we filter out repeated help-echo events, only store the
3291 first and last in a series of mouse-movement events, and don't
3292 store repeated help-echo events which are only separated by
3293 mouse-movement events. */
3295 Lisp_Object ev1
, ev2
, ev3
;
3298 if ((ix1
= recent_keys_index
- 1) < 0)
3299 ix1
= NUM_RECENT_KEYS
- 1;
3300 ev1
= AREF (recent_keys
, ix1
);
3302 if ((ix2
= ix1
- 1) < 0)
3303 ix2
= NUM_RECENT_KEYS
- 1;
3304 ev2
= AREF (recent_keys
, ix2
);
3306 if ((ix3
= ix2
- 1) < 0)
3307 ix3
= NUM_RECENT_KEYS
- 1;
3308 ev3
= AREF (recent_keys
, ix3
);
3310 if (EQ (XCAR (c
), Qhelp_echo
))
3312 /* Don't record `help-echo' in recent_keys unless it shows some help
3313 message, and a different help than the previously recorded
3315 Lisp_Object help
, last_help
;
3317 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3318 if (!STRINGP (help
))
3320 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3321 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3323 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3324 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3325 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3327 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3328 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3329 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3330 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3333 else if (EQ (XCAR (c
), Qmouse_movement
))
3335 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3336 So additional mouse movement events replace the last element. */
3337 Lisp_Object last_window
, window
;
3339 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3340 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3341 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3342 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3343 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3345 ASET (recent_keys
, ix1
, c
);
3351 store_kbd_macro_char (c
);
3355 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3356 ASET (recent_keys
, recent_keys_index
, c
);
3357 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3358 recent_keys_index
= 0;
3360 else if (recorded
< 0)
3362 /* We need to remove one or two events from recent_keys.
3363 To do this, we simply put nil at those events and move the
3364 recent_keys_index backwards over those events. Usually,
3365 users will never see those nil events, as they will be
3366 overwritten by the command keys entered to see recent_keys
3369 while (recorded
++ < 0 && total_keys
> 0)
3371 if (total_keys
< NUM_RECENT_KEYS
)
3373 if (--recent_keys_index
< 0)
3374 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3375 ASET (recent_keys
, recent_keys_index
, Qnil
);
3379 num_nonmacro_input_events
++;
3381 /* Write c to the dribble file. If c is a lispy event, write
3382 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3383 If you, dear reader, have a better idea, you've got the source. :-) */
3389 if (XUINT (c
) < 0x100)
3390 putc (XUINT (c
), dribble
);
3392 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3396 Lisp_Object dribblee
;
3398 /* If it's a structured event, take the event header. */
3399 dribblee
= EVENT_HEAD (c
);
3401 if (SYMBOLP (dribblee
))
3403 putc ('<', dribble
);
3404 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3405 SBYTES (SYMBOL_NAME (dribblee
)),
3407 putc ('>', dribble
);
3416 /* Copy out or in the info on where C-g should throw to.
3417 This is used when running Lisp code from within get_char,
3418 in case get_char is called recursively.
3419 See read_process_output. */
3422 save_getcjmp (sys_jmp_buf temp
)
3424 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3428 restore_getcjmp (sys_jmp_buf temp
)
3430 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3433 /* Low level keyboard/mouse input.
3434 kbd_buffer_store_event places events in kbd_buffer, and
3435 kbd_buffer_get_event retrieves them. */
3437 /* Return true if there are any events in the queue that read-char
3438 would return. If this returns false, a read-char would block. */
3440 readable_events (int flags
)
3442 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3445 /* If the buffer contains only FOCUS_IN_EVENT events, and
3446 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3447 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3449 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3450 #ifdef USE_TOOLKIT_SCROLL_BARS
3451 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3455 struct input_event
*event
;
3457 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3464 #ifdef USE_TOOLKIT_SCROLL_BARS
3465 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3467 event
->kind
== FOCUS_IN_EVENT
)
3468 #ifdef USE_TOOLKIT_SCROLL_BARS
3469 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3470 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3471 && event
->part
== scroll_bar_handle
3472 && event
->modifiers
== 0)
3477 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3480 while (event
!= kbd_store_ptr
);
3486 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3487 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3491 if (current_kboard
->kbd_queue_has_data
)
3497 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3498 if (kb
->kbd_queue_has_data
)
3504 /* Set this for debugging, to have a way to get out */
3505 int stop_character EXTERNALLY_VISIBLE
;
3508 event_to_kboard (struct input_event
*event
)
3510 /* Not applicable for these special events. */
3511 if (event
->kind
== SELECTION_REQUEST_EVENT
3512 || event
->kind
== SELECTION_CLEAR_EVENT
)
3516 Lisp_Object obj
= event
->frame_or_window
;
3517 /* There are some events that set this field to nil or string. */
3519 obj
= WINDOW_FRAME (XWINDOW (obj
));
3520 /* Also ignore dead frames here. */
3521 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3522 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3527 /* Return the number of slots occupied in kbd_buffer. */
3530 kbd_buffer_nr_stored (void)
3532 return kbd_fetch_ptr
== kbd_store_ptr
3534 : (kbd_fetch_ptr
< kbd_store_ptr
3535 ? kbd_store_ptr
- kbd_fetch_ptr
3536 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3537 + (kbd_store_ptr
- kbd_buffer
)));
3539 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3542 kbd_buffer_store_event (register struct input_event
*event
)
3544 kbd_buffer_store_event_hold (event
, 0);
3547 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3549 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3550 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3551 Else, if EVENT is a quit event, store the quit event
3552 in HOLD_QUIT, and return (thus ignoring further events).
3554 This is used to postpone the processing of the quit event until all
3555 subsequent input events have been parsed (and discarded). */
3558 kbd_buffer_store_event_hold (register struct input_event
*event
,
3559 struct input_event
*hold_quit
)
3561 if (event
->kind
== NO_EVENT
)
3564 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3567 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3569 register int c
= event
->code
& 0377;
3571 if (event
->modifiers
& ctrl_modifier
)
3572 c
= make_ctrl_char (c
);
3574 c
|= (event
->modifiers
3575 & (meta_modifier
| alt_modifier
3576 | hyper_modifier
| super_modifier
));
3580 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3581 struct input_event
*sp
;
3583 if (single_kboard
&& kb
!= current_kboard
)
3586 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3588 kb
->kbd_queue_has_data
= 1;
3589 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3591 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3594 if (event_to_kboard (sp
) == kb
)
3596 sp
->kind
= NO_EVENT
;
3597 sp
->frame_or_window
= Qnil
;
3606 *hold_quit
= *event
;
3610 /* If this results in a quit_char being returned to Emacs as
3611 input, set Vlast_event_frame properly. If this doesn't
3612 get returned to Emacs as an event, the next event read
3613 will set Vlast_event_frame again, so this is safe to do. */
3617 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3619 focus
= event
->frame_or_window
;
3620 internal_last_event_frame
= focus
;
3621 Vlast_event_frame
= focus
;
3624 handle_interrupt (0);
3628 if (c
&& c
== stop_character
)
3634 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3635 Just ignore the second one. */
3636 else if (event
->kind
== BUFFER_SWITCH_EVENT
3637 && kbd_fetch_ptr
!= kbd_store_ptr
3638 && ((kbd_store_ptr
== kbd_buffer
3639 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3640 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3643 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3644 kbd_store_ptr
= kbd_buffer
;
3646 /* Don't let the very last slot in the buffer become full,
3647 since that would make the two pointers equal,
3648 and that is indistinguishable from an empty buffer.
3649 Discard the event if it would fill the last slot. */
3650 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3652 *kbd_store_ptr
= *event
;
3655 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3657 /* Don't read keyboard input until we have processed kbd_buffer.
3658 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3659 hold_keyboard_input ();
3660 if (!noninteractive
)
3664 #endif /* subprocesses */
3667 /* If we're inside while-no-input, and this event qualifies
3668 as input, set quit-flag to cause an interrupt. */
3669 if (!NILP (Vthrow_on_input
)
3670 && event
->kind
!= FOCUS_IN_EVENT
3671 && event
->kind
!= HELP_EVENT
3672 && event
->kind
!= DEICONIFY_EVENT
)
3674 Vquit_flag
= Vthrow_on_input
;
3675 /* If we're inside a function that wants immediate quits,
3677 if (immediate_quit
&& NILP (Vinhibit_quit
))
3686 /* Put an input event back in the head of the event queue. */
3689 kbd_buffer_unget_event (register struct input_event
*event
)
3691 if (kbd_fetch_ptr
== kbd_buffer
)
3692 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3694 /* Don't let the very last slot in the buffer become full, */
3695 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3698 *kbd_fetch_ptr
= *event
;
3703 /* Generate a HELP_EVENT input_event and store it in the keyboard
3706 HELP is the help form.
3708 FRAME and WINDOW are the frame and window where the help is
3709 generated. OBJECT is the Lisp object where the help was found (a
3710 buffer, a string, an overlay, or nil if neither from a string nor
3711 from a buffer). POS is the position within OBJECT where the help
3715 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3716 Lisp_Object object
, ptrdiff_t pos
)
3718 struct input_event event
;
3722 event
.kind
= HELP_EVENT
;
3723 event
.frame_or_window
= frame
;
3725 event
.x
= WINDOWP (window
) ? window
: frame
;
3728 kbd_buffer_store_event (&event
);
3732 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3735 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3737 struct input_event event
;
3739 event
.kind
= HELP_EVENT
;
3740 event
.frame_or_window
= frame
;
3745 kbd_buffer_store_event (&event
);
3749 /* Discard any mouse events in the event buffer by setting them to
3752 discard_mouse_events (void)
3754 struct input_event
*sp
;
3755 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3757 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3760 if (sp
->kind
== MOUSE_CLICK_EVENT
3761 || sp
->kind
== WHEEL_EVENT
3762 || sp
->kind
== HORIZ_WHEEL_EVENT
3764 || sp
->kind
== GPM_CLICK_EVENT
3766 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3768 sp
->kind
= NO_EVENT
;
3774 /* Return true if there are any real events waiting in the event
3775 buffer, not counting `NO_EVENT's.
3777 Discard NO_EVENT events at the front of the input queue, possibly
3778 leaving the input queue empty if there are no real input events. */
3781 kbd_buffer_events_waiting (void)
3783 struct input_event
*sp
;
3785 for (sp
= kbd_fetch_ptr
;
3786 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3789 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3794 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3798 /* Clear input event EVENT. */
3801 clear_event (struct input_event
*event
)
3803 event
->kind
= NO_EVENT
;
3807 /* Read one event from the event buffer, waiting if necessary.
3808 The value is a Lisp object representing the event.
3809 The value is nil for an event that should be ignored,
3810 or that was handled here.
3811 We always read and discard one event. */
3814 kbd_buffer_get_event (KBOARD
**kbp
,
3815 bool *used_mouse_menu
,
3816 struct timespec
*end_time
)
3821 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3823 /* Start reading input again because we have processed enough to
3824 be able to accept new events again. */
3825 unhold_keyboard_input ();
3828 #endif /* subprocesses */
3830 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3832 /* In case we are running as a daemon, only do this before
3833 detaching from the terminal. */
3834 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3838 *kbp
= current_kboard
;
3841 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3843 /* Wait until there is input available. */
3846 /* Break loop if there's an unread command event. Needed in
3847 moused window autoselection which uses a timer to insert such
3849 if (CONSP (Vunread_command_events
))
3852 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3854 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3857 /* If the quit flag is set, then read_char will return
3858 quit_char, so that counts as "available input." */
3859 if (!NILP (Vquit_flag
))
3860 quit_throw_to_read_char (0);
3862 /* One way or another, wait until input is available; then, if
3863 interrupt handlers have not read it, read it now. */
3868 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3870 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3874 struct timespec now
= current_timespec ();
3875 if (timespec_cmp (*end_time
, now
) <= 0)
3876 return Qnil
; /* Finished waiting. */
3879 struct timespec duration
= timespec_sub (*end_time
, now
);
3880 wait_reading_process_output (min (duration
.tv_sec
,
3883 -1, 1, Qnil
, NULL
, 0);
3888 bool do_display
= true;
3890 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3892 struct tty_display_info
*tty
= CURTTY ();
3894 /* When this TTY is displaying a menu, we must prevent
3895 any redisplay, because we modify the frame's glyph
3896 matrix behind the back of the display engine. */
3897 if (tty
->showing_menu
)
3901 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3904 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3908 if (CONSP (Vunread_command_events
))
3911 first
= XCAR (Vunread_command_events
);
3912 Vunread_command_events
= XCDR (Vunread_command_events
);
3913 *kbp
= current_kboard
;
3917 /* At this point, we know that there is a readable event available
3918 somewhere. If the event queue is empty, then there must be a
3919 mouse movement enabled and available. */
3920 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3922 struct input_event
*event
;
3924 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3928 *kbp
= event_to_kboard (event
);
3930 *kbp
= current_kboard
; /* Better than returning null ptr? */
3934 /* These two kinds of events get special handling
3935 and don't actually appear to the command loop.
3936 We return nil for them. */
3937 if (event
->kind
== SELECTION_REQUEST_EVENT
3938 || event
->kind
== SELECTION_CLEAR_EVENT
)
3941 struct input_event copy
;
3943 /* Remove it from the buffer before processing it,
3944 since otherwise swallow_events will see it
3945 and process it again. */
3947 kbd_fetch_ptr
= event
+ 1;
3948 input_pending
= readable_events (0);
3949 x_handle_selection_event (©
);
3951 /* We're getting selection request events, but we don't have
3957 #if defined (HAVE_NS)
3958 else if (event
->kind
== NS_TEXT_EVENT
)
3960 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3961 obj
= list1 (intern ("ns-put-working-text"));
3963 obj
= list1 (intern ("ns-unput-working-text"));
3964 kbd_fetch_ptr
= event
+ 1;
3965 if (used_mouse_menu
)
3966 *used_mouse_menu
= 1;
3970 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3971 || defined (HAVE_NS)
3972 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3974 /* Make an event (delete-frame (FRAME)). */
3975 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3976 kbd_fetch_ptr
= event
+ 1;
3979 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3980 || defined (HAVE_NS)
3981 else if (event
->kind
== ICONIFY_EVENT
)
3983 /* Make an event (iconify-frame (FRAME)). */
3984 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3985 kbd_fetch_ptr
= event
+ 1;
3987 else if (event
->kind
== DEICONIFY_EVENT
)
3989 /* Make an event (make-frame-visible (FRAME)). */
3990 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3991 kbd_fetch_ptr
= event
+ 1;
3994 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3996 /* The value doesn't matter here; only the type is tested. */
3997 XSETBUFFER (obj
, current_buffer
);
3998 kbd_fetch_ptr
= event
+ 1;
4000 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4001 || defined (HAVE_NS) || defined (USE_GTK)
4002 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4004 kbd_fetch_ptr
= event
+ 1;
4005 input_pending
= readable_events (0);
4006 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4007 x_activate_menubar (XFRAME (event
->frame_or_window
));
4011 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4013 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4014 obj
= list4 (Qlanguage_change
,
4015 event
->frame_or_window
,
4016 make_number (event
->code
),
4017 make_number (event
->modifiers
));
4018 kbd_fetch_ptr
= event
+ 1;
4021 #ifdef USE_FILE_NOTIFY
4022 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4024 #ifdef HAVE_W32NOTIFY
4025 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4026 obj
= list3 (Qfile_notify
,
4027 list3 (make_number (event
->code
),
4030 event
->frame_or_window
);
4032 obj
= make_lispy_event (event
);
4034 kbd_fetch_ptr
= event
+ 1;
4036 #endif /* USE_FILE_NOTIFY */
4037 else if (event
->kind
== SAVE_SESSION_EVENT
)
4039 obj
= list2 (Qsave_session
, event
->arg
);
4040 kbd_fetch_ptr
= event
+ 1;
4042 /* Just discard these, by returning nil.
4043 With MULTI_KBOARD, these events are used as placeholders
4044 when we need to randomly delete events from the queue.
4045 (They shouldn't otherwise be found in the buffer,
4046 but on some machines it appears they do show up
4047 even without MULTI_KBOARD.) */
4048 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4049 mouse events during a popup-menu call. */
4050 else if (event
->kind
== NO_EVENT
)
4051 kbd_fetch_ptr
= event
+ 1;
4052 else if (event
->kind
== HELP_EVENT
)
4054 Lisp_Object object
, position
, help
, frame
, window
;
4056 frame
= event
->frame_or_window
;
4057 object
= event
->arg
;
4058 position
= make_number (event
->code
);
4061 clear_event (event
);
4063 kbd_fetch_ptr
= event
+ 1;
4064 if (!WINDOWP (window
))
4066 obj
= Fcons (Qhelp_echo
,
4067 list5 (frame
, help
, window
, object
, position
));
4069 else if (event
->kind
== FOCUS_IN_EVENT
)
4071 /* Notification of a FocusIn event. The frame receiving the
4072 focus is in event->frame_or_window. Generate a
4073 switch-frame event if necessary. */
4074 Lisp_Object frame
, focus
;
4076 frame
= event
->frame_or_window
;
4077 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4086 !EQ (frame
, internal_last_event_frame
)
4087 && !EQ (frame
, selected_frame
))
4088 obj
= make_lispy_switch_frame (frame
);
4090 obj
= make_lispy_focus_in (frame
);
4092 internal_last_event_frame
= frame
;
4093 kbd_fetch_ptr
= event
+ 1;
4095 else if (event
->kind
== FOCUS_OUT_EVENT
)
4097 #ifdef HAVE_WINDOW_SYSTEM
4100 Lisp_Object frame
= event
->frame_or_window
;
4101 bool focused
= false;
4103 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4104 focused
= di
->x_highlight_frame
!= 0;
4107 obj
= make_lispy_focus_out (frame
);
4109 #endif /* HAVE_WINDOW_SYSTEM */
4111 kbd_fetch_ptr
= event
+ 1;
4114 else if (event
->kind
== DBUS_EVENT
)
4116 obj
= make_lispy_event (event
);
4117 kbd_fetch_ptr
= event
+ 1;
4120 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4122 obj
= make_lispy_event (event
);
4123 kbd_fetch_ptr
= event
+ 1;
4127 /* If this event is on a different frame, return a switch-frame this
4128 time, and leave the event in the queue for next time. */
4132 frame
= event
->frame_or_window
;
4134 frame
= XCAR (frame
);
4135 else if (WINDOWP (frame
))
4136 frame
= WINDOW_FRAME (XWINDOW (frame
));
4138 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4142 if (! EQ (frame
, internal_last_event_frame
)
4143 && !EQ (frame
, selected_frame
))
4144 obj
= make_lispy_switch_frame (frame
);
4145 internal_last_event_frame
= frame
;
4147 /* If we didn't decide to make a switch-frame event, go ahead
4148 and build a real event from the queue entry. */
4152 obj
= make_lispy_event (event
);
4154 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4155 || defined (HAVE_NS) || defined (USE_GTK)
4156 /* If this was a menu selection, then set the flag to inhibit
4157 writing to last_nonmenu_event. Don't do this if the event
4158 we're returning is (menu-bar), though; that indicates the
4159 beginning of the menu sequence, and we might as well leave
4160 that as the `event with parameters' for this selection. */
4162 && !EQ (event
->frame_or_window
, event
->arg
)
4163 && (event
->kind
== MENU_BAR_EVENT
4164 || event
->kind
== TOOL_BAR_EVENT
))
4165 *used_mouse_menu
= 1;
4168 /* Certain system events are non-key events. */
4170 && event
->kind
== NS_NONKEY_EVENT
)
4171 *used_mouse_menu
= 1;
4174 /* Wipe out this event, to catch bugs. */
4175 clear_event (event
);
4176 kbd_fetch_ptr
= event
+ 1;
4180 /* Try generating a mouse motion event. */
4181 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4183 struct frame
*f
= some_mouse_moved ();
4184 Lisp_Object bar_window
;
4185 enum scroll_bar_part part
;
4189 *kbp
= current_kboard
;
4190 /* Note that this uses F to determine which terminal to look at.
4191 If there is no valid info, it does not store anything
4192 so x remains nil. */
4195 /* XXX Can f or mouse_position_hook be NULL here? */
4196 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4197 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4202 /* Decide if we should generate a switch-frame event. Don't
4203 generate switch-frame events for motion outside of all Emacs
4209 frame
= FRAME_FOCUS_FRAME (f
);
4211 XSETFRAME (frame
, f
);
4213 if (! EQ (frame
, internal_last_event_frame
)
4214 && !EQ (frame
, selected_frame
))
4215 obj
= make_lispy_switch_frame (frame
);
4216 internal_last_event_frame
= frame
;
4219 /* If we didn't decide to make a switch-frame event, go ahead and
4220 return a mouse-motion event. */
4221 if (!NILP (x
) && NILP (obj
))
4222 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4225 /* We were promised by the above while loop that there was
4226 something for us to read! */
4229 input_pending
= readable_events (0);
4231 Vlast_event_frame
= internal_last_event_frame
;
4236 /* Process any non-user-visible events (currently X selection events),
4237 without reading any user-visible events. */
4240 process_special_events (void)
4242 struct input_event
*event
;
4244 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4246 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4249 if (event
== kbd_store_ptr
)
4253 /* If we find a stored X selection request, handle it now. */
4254 if (event
->kind
== SELECTION_REQUEST_EVENT
4255 || event
->kind
== SELECTION_CLEAR_EVENT
)
4259 /* Remove the event from the fifo buffer before processing;
4260 otherwise swallow_events called recursively could see it
4261 and process it again. To do this, we move the events
4262 between kbd_fetch_ptr and EVENT one slot to the right,
4265 struct input_event copy
= *event
;
4266 struct input_event
*beg
4267 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4268 ? kbd_buffer
: kbd_fetch_ptr
;
4271 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4272 else if (event
< beg
)
4274 if (event
> kbd_buffer
)
4275 memmove (kbd_buffer
+ 1, kbd_buffer
,
4276 (event
- kbd_buffer
) * sizeof (struct input_event
));
4277 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4278 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4279 memmove (beg
+ 1, beg
,
4280 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4281 * sizeof (struct input_event
));
4284 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4285 kbd_fetch_ptr
= kbd_buffer
+ 1;
4289 input_pending
= readable_events (0);
4290 x_handle_selection_event (©
);
4292 /* We're getting selection request events, but we don't have
4300 /* Process any events that are not user-visible, run timer events that
4301 are ripe, and return, without reading any user-visible events. */
4304 swallow_events (bool do_display
)
4306 unsigned old_timers_run
;
4308 process_special_events ();
4310 old_timers_run
= timers_run
;
4311 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4313 if (timers_run
!= old_timers_run
&& do_display
)
4314 redisplay_preserve_echo_area (7);
4317 /* Record the start of when Emacs is idle,
4318 for the sake of running idle-time timers. */
4321 timer_start_idle (void)
4323 /* If we are already in the idle state, do nothing. */
4324 if (timespec_valid_p (timer_idleness_start_time
))
4327 timer_idleness_start_time
= current_timespec ();
4328 timer_last_idleness_start_time
= timer_idleness_start_time
;
4330 /* Mark all idle-time timers as once again candidates for running. */
4331 call0 (intern ("internal-timer-start-idle"));
4334 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4337 timer_stop_idle (void)
4339 timer_idleness_start_time
= invalid_timespec ();
4342 /* Resume idle timer from last idle start time. */
4345 timer_resume_idle (void)
4347 if (timespec_valid_p (timer_idleness_start_time
))
4350 timer_idleness_start_time
= timer_last_idleness_start_time
;
4353 /* This is only for debugging. */
4354 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4356 /* List of elisp functions to call, delayed because they were generated in
4357 a context where Elisp could not be safely run (e.g. redisplay, signal,
4358 ...). Each element has the form (FUN . ARGS). */
4359 Lisp_Object pending_funcalls
;
4361 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4363 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4365 Lisp_Object
*vector
;
4367 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4369 vector
= XVECTOR (timer
)->contents
;
4370 if (! NILP (vector
[0]))
4373 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4378 /* Check whether a timer has fired. To prevent larger problems we simply
4379 disregard elements that are not proper timers. Do not make a circular
4380 timer list for the time being.
4382 Returns the time to wait until the next timer fires. If a
4383 timer is triggering now, return zero.
4384 If no timer is active, return -1.
4386 If a timer is ripe, we run it, with quitting turned off.
4387 In that case we return 0 to indicate that a new timer_check_2 call
4390 static struct timespec
4391 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4393 struct timespec nexttime
;
4394 struct timespec now
;
4395 struct timespec idleness_now
;
4396 Lisp_Object chosen_timer
;
4397 struct gcpro gcpro1
;
4399 nexttime
= invalid_timespec ();
4401 chosen_timer
= Qnil
;
4402 GCPRO1 (chosen_timer
);
4404 /* First run the code that was delayed. */
4405 while (CONSP (pending_funcalls
))
4407 Lisp_Object funcall
= XCAR (pending_funcalls
);
4408 pending_funcalls
= XCDR (pending_funcalls
);
4409 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4412 if (CONSP (timers
) || CONSP (idle_timers
))
4414 now
= current_timespec ();
4415 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4416 ? timespec_sub (now
, timer_idleness_start_time
)
4417 : make_timespec (0, 0));
4420 while (CONSP (timers
) || CONSP (idle_timers
))
4422 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4423 struct timespec timer_time
, idle_timer_time
;
4424 struct timespec difference
;
4425 struct timespec timer_difference
= invalid_timespec ();
4426 struct timespec idle_timer_difference
= invalid_timespec ();
4427 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4429 /* Set TIMER and TIMER_DIFFERENCE
4430 based on the next ordinary timer.
4431 TIMER_DIFFERENCE is the distance in time from NOW to when
4432 this timer becomes ripe (negative if it's already ripe).
4433 Skip past invalid timers and timers already handled. */
4436 timer
= XCAR (timers
);
4437 if (! decode_timer (timer
, &timer_time
))
4439 timers
= XCDR (timers
);
4443 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4444 timer_difference
= (timer_ripe
4445 ? timespec_sub (now
, timer_time
)
4446 : timespec_sub (timer_time
, now
));
4449 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4450 based on the next idle timer. */
4451 if (CONSP (idle_timers
))
4453 idle_timer
= XCAR (idle_timers
);
4454 if (! decode_timer (idle_timer
, &idle_timer_time
))
4456 idle_timers
= XCDR (idle_timers
);
4460 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4461 idle_timer_difference
4463 ? timespec_sub (idleness_now
, idle_timer_time
)
4464 : timespec_sub (idle_timer_time
, idleness_now
));
4467 /* Decide which timer is the next timer,
4468 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4469 Also step down the list where we found that timer. */
4471 if (timespec_valid_p (timer_difference
)
4472 && (! timespec_valid_p (idle_timer_difference
)
4473 || idle_timer_ripe
< timer_ripe
4474 || (idle_timer_ripe
== timer_ripe
4476 ? timespec_cmp (idle_timer_difference
,
4478 : timespec_cmp (timer_difference
,
4479 idle_timer_difference
))
4482 chosen_timer
= timer
;
4483 timers
= XCDR (timers
);
4484 difference
= timer_difference
;
4489 chosen_timer
= idle_timer
;
4490 idle_timers
= XCDR (idle_timers
);
4491 difference
= idle_timer_difference
;
4492 ripe
= idle_timer_ripe
;
4495 /* If timer is ripe, run it if it hasn't been run. */
4498 if (NILP (AREF (chosen_timer
, 0)))
4500 ptrdiff_t count
= SPECPDL_INDEX ();
4501 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4503 /* Mark the timer as triggered to prevent problems if the lisp
4504 code fails to reschedule it right. */
4505 ASET (chosen_timer
, 0, Qt
);
4507 specbind (Qinhibit_quit
, Qt
);
4509 call1 (Qtimer_event_handler
, chosen_timer
);
4510 Vdeactivate_mark
= old_deactivate_mark
;
4512 unbind_to (count
, Qnil
);
4514 /* Since we have handled the event,
4515 we don't need to tell the caller to wake up and do it. */
4516 /* But the caller must still wait for the next timer, so
4517 return 0 to indicate that. */
4520 nexttime
= make_timespec (0, 0);
4524 /* When we encounter a timer that is still waiting,
4525 return the amount of time to wait before it is ripe. */
4532 /* No timers are pending in the future. */
4533 /* Return 0 if we generated an event, and -1 if not. */
4539 /* Check whether a timer has fired. To prevent larger problems we simply
4540 disregard elements that are not proper timers. Do not make a circular
4541 timer list for the time being.
4543 Returns the time to wait until the next timer fires.
4544 If no timer is active, return an invalid value.
4546 As long as any timer is ripe, we run it. */
4551 struct timespec nexttime
;
4552 Lisp_Object timers
, idle_timers
;
4553 struct gcpro gcpro1
, gcpro2
;
4555 Lisp_Object tem
= Vinhibit_quit
;
4558 /* We use copies of the timers' lists to allow a timer to add itself
4559 again, without locking up Emacs if the newly added timer is
4560 already ripe when added. */
4562 /* Always consider the ordinary timers. */
4563 timers
= Fcopy_sequence (Vtimer_list
);
4564 /* Consider the idle timers only if Emacs is idle. */
4565 if (timespec_valid_p (timer_idleness_start_time
))
4566 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4570 Vinhibit_quit
= tem
;
4572 GCPRO2 (timers
, idle_timers
);
4576 nexttime
= timer_check_2 (timers
, idle_timers
);
4578 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4584 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4585 doc
: /* Return the current length of Emacs idleness, or nil.
4586 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4587 in the same style as (current-time).
4589 The value when Emacs is not idle is nil.
4591 PSEC is a multiple of the system clock resolution. */)
4594 if (timespec_valid_p (timer_idleness_start_time
))
4595 return make_lisp_time (timespec_sub (current_timespec (),
4596 timer_idleness_start_time
));
4601 /* Caches for modify_event_symbol. */
4602 static Lisp_Object accent_key_syms
;
4603 static Lisp_Object func_key_syms
;
4604 static Lisp_Object mouse_syms
;
4605 static Lisp_Object wheel_syms
;
4606 static Lisp_Object drag_n_drop_syms
;
4608 /* This is a list of keysym codes for special "accent" characters.
4609 It parallels lispy_accent_keys. */
4611 static const int lispy_accent_codes
[] =
4613 #ifdef XK_dead_circumflex
4618 #ifdef XK_dead_grave
4623 #ifdef XK_dead_tilde
4628 #ifdef XK_dead_diaeresis
4633 #ifdef XK_dead_macron
4638 #ifdef XK_dead_degree
4643 #ifdef XK_dead_acute
4648 #ifdef XK_dead_cedilla
4653 #ifdef XK_dead_breve
4658 #ifdef XK_dead_ogonek
4663 #ifdef XK_dead_caron
4668 #ifdef XK_dead_doubleacute
4669 XK_dead_doubleacute
,
4673 #ifdef XK_dead_abovedot
4678 #ifdef XK_dead_abovering
4688 #ifdef XK_dead_belowdot
4693 #ifdef XK_dead_voiced_sound
4694 XK_dead_voiced_sound
,
4698 #ifdef XK_dead_semivoiced_sound
4699 XK_dead_semivoiced_sound
,
4715 /* This is a list of Lisp names for special "accent" characters.
4716 It parallels lispy_accent_codes. */
4718 static const char *const lispy_accent_keys
[] =
4736 "dead-voiced-sound",
4737 "dead-semivoiced-sound",
4743 #define FUNCTION_KEY_OFFSET 0x0
4745 const char *const lispy_function_keys
[] =
4749 0, /* VK_LBUTTON 0x01 */
4750 0, /* VK_RBUTTON 0x02 */
4751 "cancel", /* VK_CANCEL 0x03 */
4752 0, /* VK_MBUTTON 0x04 */
4754 0, 0, 0, /* 0x05 .. 0x07 */
4756 "backspace", /* VK_BACK 0x08 */
4757 "tab", /* VK_TAB 0x09 */
4759 0, 0, /* 0x0A .. 0x0B */
4761 "clear", /* VK_CLEAR 0x0C */
4762 "return", /* VK_RETURN 0x0D */
4764 0, 0, /* 0x0E .. 0x0F */
4766 0, /* VK_SHIFT 0x10 */
4767 0, /* VK_CONTROL 0x11 */
4768 0, /* VK_MENU 0x12 */
4769 "pause", /* VK_PAUSE 0x13 */
4770 "capslock", /* VK_CAPITAL 0x14 */
4771 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4773 "junja", /* VK_JUNJA 0x17 */
4774 "final", /* VK_FINAL 0x18 */
4775 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4777 "escape", /* VK_ESCAPE 0x1B */
4778 "convert", /* VK_CONVERT 0x1C */
4779 "non-convert", /* VK_NONCONVERT 0x1D */
4780 "accept", /* VK_ACCEPT 0x1E */
4781 "mode-change", /* VK_MODECHANGE 0x1F */
4782 0, /* VK_SPACE 0x20 */
4783 "prior", /* VK_PRIOR 0x21 */
4784 "next", /* VK_NEXT 0x22 */
4785 "end", /* VK_END 0x23 */
4786 "home", /* VK_HOME 0x24 */
4787 "left", /* VK_LEFT 0x25 */
4788 "up", /* VK_UP 0x26 */
4789 "right", /* VK_RIGHT 0x27 */
4790 "down", /* VK_DOWN 0x28 */
4791 "select", /* VK_SELECT 0x29 */
4792 "print", /* VK_PRINT 0x2A */
4793 "execute", /* VK_EXECUTE 0x2B */
4794 "snapshot", /* VK_SNAPSHOT 0x2C */
4795 "insert", /* VK_INSERT 0x2D */
4796 "delete", /* VK_DELETE 0x2E */
4797 "help", /* VK_HELP 0x2F */
4799 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4801 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4803 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4805 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4807 0, 0, 0, 0, 0, 0, 0, 0, 0,
4808 0, 0, 0, 0, 0, 0, 0, 0, 0,
4809 0, 0, 0, 0, 0, 0, 0, 0,
4811 "lwindow", /* VK_LWIN 0x5B */
4812 "rwindow", /* VK_RWIN 0x5C */
4813 "apps", /* VK_APPS 0x5D */
4816 "kp-0", /* VK_NUMPAD0 0x60 */
4817 "kp-1", /* VK_NUMPAD1 0x61 */
4818 "kp-2", /* VK_NUMPAD2 0x62 */
4819 "kp-3", /* VK_NUMPAD3 0x63 */
4820 "kp-4", /* VK_NUMPAD4 0x64 */
4821 "kp-5", /* VK_NUMPAD5 0x65 */
4822 "kp-6", /* VK_NUMPAD6 0x66 */
4823 "kp-7", /* VK_NUMPAD7 0x67 */
4824 "kp-8", /* VK_NUMPAD8 0x68 */
4825 "kp-9", /* VK_NUMPAD9 0x69 */
4826 "kp-multiply", /* VK_MULTIPLY 0x6A */
4827 "kp-add", /* VK_ADD 0x6B */
4828 "kp-separator", /* VK_SEPARATOR 0x6C */
4829 "kp-subtract", /* VK_SUBTRACT 0x6D */
4830 "kp-decimal", /* VK_DECIMAL 0x6E */
4831 "kp-divide", /* VK_DIVIDE 0x6F */
4832 "f1", /* VK_F1 0x70 */
4833 "f2", /* VK_F2 0x71 */
4834 "f3", /* VK_F3 0x72 */
4835 "f4", /* VK_F4 0x73 */
4836 "f5", /* VK_F5 0x74 */
4837 "f6", /* VK_F6 0x75 */
4838 "f7", /* VK_F7 0x76 */
4839 "f8", /* VK_F8 0x77 */
4840 "f9", /* VK_F9 0x78 */
4841 "f10", /* VK_F10 0x79 */
4842 "f11", /* VK_F11 0x7A */
4843 "f12", /* VK_F12 0x7B */
4844 "f13", /* VK_F13 0x7C */
4845 "f14", /* VK_F14 0x7D */
4846 "f15", /* VK_F15 0x7E */
4847 "f16", /* VK_F16 0x7F */
4848 "f17", /* VK_F17 0x80 */
4849 "f18", /* VK_F18 0x81 */
4850 "f19", /* VK_F19 0x82 */
4851 "f20", /* VK_F20 0x83 */
4852 "f21", /* VK_F21 0x84 */
4853 "f22", /* VK_F22 0x85 */
4854 "f23", /* VK_F23 0x86 */
4855 "f24", /* VK_F24 0x87 */
4857 0, 0, 0, 0, /* 0x88 .. 0x8B */
4858 0, 0, 0, 0, /* 0x8C .. 0x8F */
4860 "kp-numlock", /* VK_NUMLOCK 0x90 */
4861 "scroll", /* VK_SCROLL 0x91 */
4862 /* Not sure where the following block comes from.
4863 Windows headers have NEC and Fujitsu specific keys in
4864 this block, but nothing generic. */
4865 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4866 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4867 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4868 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4869 "kp-end", /* VK_NUMPAD_END 0x96 */
4870 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4871 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4872 "kp-up", /* VK_NUMPAD_UP 0x99 */
4873 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4874 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4875 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4876 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4878 0, 0, /* 0x9E .. 0x9F */
4881 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4882 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4883 * No other API or message will distinguish left and right keys this way.
4888 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4889 to enable them selectively, and gives access to a few more functions.
4890 See lispy_multimedia_keys below. */
4891 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4892 0, 0, 0, /* 0xAD .. 0xAF Volume */
4893 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4894 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4896 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4897 0, 0, 0, 0, 0, 0, 0, 0, 0,
4899 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4900 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4901 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4904 "ax", /* VK_OEM_AX 0xE1 */
4905 0, /* VK_OEM_102 0xE2 */
4906 "ico-help", /* VK_ICO_HELP 0xE3 */
4907 "ico-00", /* VK_ICO_00 0xE4 */
4908 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4909 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4910 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4912 "reset", /* VK_OEM_RESET 0xE9 */
4913 "jump", /* VK_OEM_JUMP 0xEA */
4914 "oem-pa1", /* VK_OEM_PA1 0xEB */
4915 "oem-pa2", /* VK_OEM_PA2 0xEC */
4916 "oem-pa3", /* VK_OEM_PA3 0xED */
4917 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4918 "cusel", /* VK_OEM_CUSEL 0xEF */
4919 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4920 "finish", /* VK_OEM_FINISH 0xF1 */
4921 "copy", /* VK_OEM_COPY 0xF2 */
4922 "auto", /* VK_OEM_AUTO 0xF3 */
4923 "enlw", /* VK_OEM_ENLW 0xF4 */
4924 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4925 "attn", /* VK_ATTN 0xF6 */
4926 "crsel", /* VK_CRSEL 0xF7 */
4927 "exsel", /* VK_EXSEL 0xF8 */
4928 "ereof", /* VK_EREOF 0xF9 */
4929 "play", /* VK_PLAY 0xFA */
4930 "zoom", /* VK_ZOOM 0xFB */
4931 "noname", /* VK_NONAME 0xFC */
4932 "pa1", /* VK_PA1 0xFD */
4933 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4937 /* Some of these duplicate the "Media keys" on newer keyboards,
4938 but they are delivered to the application in a different way. */
4939 static const char *const lispy_multimedia_keys
[] =
4947 "browser-favorites",
4984 "toggle-dictate-command",
4990 "media-fast-forward",
4993 "media-channel-down"
4996 #else /* not HAVE_NTGUI */
4998 /* This should be dealt with in XTread_socket now, and that doesn't
4999 depend on the client system having the Kana syms defined. See also
5000 the XK_kana_A case below. */
5003 static const char *const lispy_kana_keys
[] =
5005 /* X Keysym value */
5006 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5007 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5008 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5009 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5010 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5011 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5012 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5013 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5014 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5015 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5016 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5017 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5018 "kana-i", "kana-u", "kana-e", "kana-o",
5019 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5020 "prolongedsound", "kana-A", "kana-I", "kana-U",
5021 "kana-E", "kana-O", "kana-KA", "kana-KI",
5022 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5023 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5024 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5025 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5026 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5027 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5028 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5029 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5030 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5031 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5032 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5033 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5035 #endif /* XK_kana_A */
5038 #define FUNCTION_KEY_OFFSET 0xff00
5040 /* You'll notice that this table is arranged to be conveniently
5041 indexed by X Windows keysym values. */
5042 static const char *const lispy_function_keys
[] =
5044 /* X Keysym value */
5046 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5047 "backspace", "tab", "linefeed", "clear",
5049 0, 0, 0, "pause", /* 0xff10...1f */
5050 0, 0, 0, 0, 0, 0, 0, "escape",
5052 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5053 "romaji", "hiragana", "katakana", "hiragana-katakana",
5054 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5055 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5056 "eisu-toggle", /* 0xff30...3f */
5057 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5058 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5060 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5061 "down", "prior", "next", "end",
5062 "begin", 0, 0, 0, 0, 0, 0, 0,
5063 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5074 "break", /* 0xff6b */
5077 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5078 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5079 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5080 0, 0, 0, 0, 0, 0, 0, 0,
5081 "kp-tab", /* 0xff89 */
5083 "kp-enter", /* 0xff8d */
5085 "kp-f1", /* 0xff91 */
5089 "kp-home", /* 0xff95 */
5094 "kp-prior", /* kp-page-up */
5095 "kp-next", /* kp-page-down */
5101 0, 0, 0, 0, 0, 0, 0, 0, 0,
5102 "kp-multiply", /* 0xffaa */
5107 "kp-divide", /* 0xffaf */
5108 "kp-0", /* 0xffb0 */
5109 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5112 "kp-equal", /* 0xffbd */
5113 "f1", /* 0xffbe */ /* IsFunctionKey */
5115 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5116 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5117 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5118 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5119 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5120 0, 0, 0, 0, 0, 0, 0, 0,
5121 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5122 0, 0, 0, 0, 0, 0, 0, "delete"
5125 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5126 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5128 static const char *const iso_lispy_function_keys
[] =
5130 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5131 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5132 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5133 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5134 "iso-lefttab", /* 0xfe20 */
5135 "iso-move-line-up", "iso-move-line-down",
5136 "iso-partial-line-up", "iso-partial-line-down",
5137 "iso-partial-space-left", "iso-partial-space-right",
5138 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5139 "iso-release-margin-left", "iso-release-margin-right",
5140 "iso-release-both-margins",
5141 "iso-fast-cursor-left", "iso-fast-cursor-right",
5142 "iso-fast-cursor-up", "iso-fast-cursor-down",
5143 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5144 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5147 #endif /* not HAVE_NTGUI */
5149 static Lisp_Object Vlispy_mouse_stem
;
5151 static const char *const lispy_wheel_names
[] =
5153 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5156 /* drag-n-drop events are generated when a set of selected files are
5157 dragged from another application and dropped onto an Emacs window. */
5158 static const char *const lispy_drag_n_drop_names
[] =
5163 /* Scroll bar parts. */
5164 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5165 Lisp_Object Qup
, Qdown
, Qbottom
;
5166 static Lisp_Object Qend_scroll
;
5168 static Lisp_Object Qratio
;
5170 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5171 static Lisp_Object
*const scroll_bar_parts
[] = {
5172 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5173 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5176 /* A vector, indexed by button number, giving the down-going location
5177 of currently depressed buttons, both scroll bar and non-scroll bar.
5179 The elements have the form
5180 (BUTTON-NUMBER MODIFIER-MASK . REST)
5181 where REST is the cdr of a position as it would be reported in the event.
5183 The make_lispy_event function stores positions here to tell the
5184 difference between click and drag events, and to store the starting
5185 location to be included in drag events. */
5187 static Lisp_Object button_down_location
;
5189 /* Information about the most recent up-going button event: Which
5190 button, what location, and what time. */
5192 static int last_mouse_button
;
5193 static int last_mouse_x
;
5194 static int last_mouse_y
;
5195 static Time button_down_time
;
5197 /* The number of clicks in this multiple-click. */
5199 static int double_click_count
;
5201 /* X and Y are frame-relative coordinates for a click or wheel event.
5202 Return a Lisp-style event list. */
5205 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5208 enum window_part part
;
5209 Lisp_Object posn
= Qnil
;
5210 Lisp_Object extra_info
= Qnil
;
5211 /* Coordinate pixel positions to return. */
5212 int xret
= 0, yret
= 0;
5213 /* The window under frame pixel coordinates (x,y) */
5214 Lisp_Object window
= f
5215 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5218 if (WINDOWP (window
))
5220 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5221 struct window
*w
= XWINDOW (window
);
5222 Lisp_Object string_info
= Qnil
;
5223 ptrdiff_t textpos
= -1;
5224 int col
= -1, row
= -1;
5225 int dx
= -1, dy
= -1;
5226 int width
= -1, height
= -1;
5227 Lisp_Object object
= Qnil
;
5229 /* Pixel coordinates relative to the window corner. */
5230 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5231 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5233 /* For text area clicks, return X, Y relative to the corner of
5234 this text area. Note that dX, dY etc are set below, by
5235 buffer_posn_from_coords. */
5236 if (part
== ON_TEXT
)
5238 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5239 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5241 /* For mode line and header line clicks, return X, Y relative to
5242 the left window edge. Use mode_line_string to look for a
5243 string on the click position. */
5244 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5249 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5250 /* Note that mode_line_string takes COL, ROW as pixels and
5251 converts them to characters. */
5254 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5255 &object
, &dx
, &dy
, &width
, &height
);
5256 if (STRINGP (string
))
5257 string_info
= Fcons (string
, make_number (charpos
));
5258 textpos
= (w
== XWINDOW (selected_window
)
5259 && current_buffer
== XBUFFER (w
->contents
))
5260 ? PT
: marker_position (w
->pointm
);
5265 /* For fringes and margins, Y is relative to the area's (and the
5266 window's) top edge, while X is meaningless. */
5267 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5272 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5275 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5276 &object
, &dx
, &dy
, &width
, &height
);
5277 if (STRINGP (string
))
5278 string_info
= Fcons (string
, make_number (charpos
));
5279 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5281 else if (part
== ON_LEFT_FRINGE
)
5283 posn
= Qleft_fringe
;
5286 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5287 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5288 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5290 else if (part
== ON_RIGHT_FRINGE
)
5292 posn
= Qright_fringe
;
5295 - window_box_width (w
, LEFT_MARGIN_AREA
)
5296 - window_box_width (w
, TEXT_AREA
)
5297 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5298 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5300 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5302 else if (part
== ON_VERTICAL_BORDER
)
5304 posn
= Qvertical_line
;
5309 /* Nothing special for part == ON_SCROLL_BAR. */
5310 else if (part
== ON_RIGHT_DIVIDER
)
5312 posn
= Qright_divider
;
5313 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5317 else if (part
== ON_BOTTOM_DIVIDER
)
5319 posn
= Qbottom_divider
;
5320 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5325 /* For clicks in the text area, fringes, or margins, call
5326 buffer_posn_from_coords to extract TEXTPOS, the buffer
5327 position nearest to the click. */
5330 Lisp_Object string2
, object2
= Qnil
;
5331 struct display_pos p
;
5333 int width2
, height2
;
5334 /* The pixel X coordinate passed to buffer_posn_from_coords
5335 is the X coordinate relative to the text area for
5336 text-area and right-margin clicks, zero otherwise. */
5338 = (part
== ON_TEXT
) ? xret
5339 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5340 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5344 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5345 &object2
, &dx2
, &dy2
,
5347 textpos
= CHARPOS (p
.pos
);
5348 if (col
< 0) col
= x2
;
5349 if (row
< 0) row
= y2
;
5350 if (dx
< 0) dx
= dx2
;
5351 if (dy
< 0) dy
= dy2
;
5352 if (width
< 0) width
= width2
;
5353 if (height
< 0) height
= height2
;
5357 posn
= make_number (textpos
);
5358 if (STRINGP (string2
))
5359 string_info
= Fcons (string2
,
5360 make_number (CHARPOS (p
.string_pos
)));
5366 #ifdef HAVE_WINDOW_SYSTEM
5367 if (IMAGEP (object
))
5369 Lisp_Object image_map
, hotspot
;
5370 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5372 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5374 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5375 posn
= XCAR (hotspot
);
5382 Fcons (make_number (dx
), make_number (dy
)),
5383 Fcons (make_number (width
), make_number (height
)));
5386 extra_info
= Fcons (string_info
,
5387 Fcons (make_number (textpos
),
5388 Fcons (Fcons (make_number (col
),
5393 XSETFRAME (window
, f
);
5397 return Fcons (window
,
5399 Fcons (Fcons (make_number (xret
),
5400 make_number (yret
)),
5401 Fcons (make_number (t
),
5405 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5406 menu bar. This really means that Emacs draws and manages the menu
5407 bar as part of its normal display, and therefore can compute its
5410 toolkit_menubar_in_use (struct frame
*f
)
5412 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5413 return !(!FRAME_WINDOW_P (f
));
5419 /* Given a struct input_event, build the lisp event which represents
5420 it. If EVENT is 0, build a mouse movement event from the mouse
5421 movement buffer, which should have a movement event in it.
5423 Note that events must be passed to this function in the order they
5424 are received; this function stores the location of button presses
5425 in order to build drag events when the button is released. */
5428 make_lispy_event (struct input_event
*event
)
5432 switch (event
->kind
)
5434 /* A simple keystroke. */
5435 case ASCII_KEYSTROKE_EVENT
:
5436 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5438 Lisp_Object lispy_c
;
5439 EMACS_INT c
= event
->code
;
5440 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5443 eassert (c
== event
->code
);
5444 /* Turn ASCII characters into control characters
5446 if (event
->modifiers
& ctrl_modifier
)
5448 c
= make_ctrl_char (c
);
5449 event
->modifiers
&= ~ctrl_modifier
;
5453 /* Add in the other modifier bits. The shift key was taken care
5454 of by the X code. */
5455 c
|= (event
->modifiers
5456 & (meta_modifier
| alt_modifier
5457 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5458 /* Distinguish Shift-SPC from SPC. */
5459 if ((event
->code
) == 040
5460 && event
->modifiers
& shift_modifier
)
5461 c
|= shift_modifier
;
5462 button_down_time
= 0;
5463 XSETFASTINT (lispy_c
, c
);
5468 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5469 except that they are non-key events (last-nonmenu-event is nil). */
5470 case NS_NONKEY_EVENT
:
5473 /* A function key. The symbol may need to have modifier prefixes
5475 case NON_ASCII_KEYSTROKE_EVENT
:
5476 button_down_time
= 0;
5478 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5479 if (event
->code
== lispy_accent_codes
[i
])
5480 return modify_event_symbol (i
,
5482 Qfunction_key
, Qnil
,
5483 lispy_accent_keys
, &accent_key_syms
,
5484 (sizeof (lispy_accent_keys
)
5485 / sizeof (lispy_accent_keys
[0])));
5489 if (event
->code
>= 0x400 && event
->code
< 0x500)
5490 return modify_event_symbol (event
->code
- 0x400,
5491 event
->modifiers
& ~shift_modifier
,
5492 Qfunction_key
, Qnil
,
5493 lispy_kana_keys
, &func_key_syms
,
5494 (sizeof (lispy_kana_keys
)
5495 / sizeof (lispy_kana_keys
[0])));
5496 #endif /* XK_kana_A */
5499 #ifdef ISO_FUNCTION_KEY_OFFSET
5500 if (event
->code
< FUNCTION_KEY_OFFSET
5501 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5502 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5504 Qfunction_key
, Qnil
,
5505 iso_lispy_function_keys
, &func_key_syms
,
5506 (sizeof (iso_lispy_function_keys
)
5507 / sizeof (iso_lispy_function_keys
[0])));
5510 /* Handle system-specific or unknown keysyms. */
5511 if (event
->code
& (1 << 28)
5512 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5513 || (event
->code
- FUNCTION_KEY_OFFSET
5514 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5515 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5517 /* We need to use an alist rather than a vector as the cache
5518 since we can't make a vector long enough. */
5519 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5520 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5521 return modify_event_symbol (event
->code
,
5524 KVAR (current_kboard
, Vsystem_key_alist
),
5525 0, &KVAR (current_kboard
, system_key_syms
),
5529 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5531 Qfunction_key
, Qnil
,
5532 lispy_function_keys
, &func_key_syms
,
5533 (sizeof (lispy_function_keys
)
5534 / sizeof (lispy_function_keys
[0])));
5537 case MULTIMEDIA_KEY_EVENT
:
5538 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5539 / sizeof (lispy_multimedia_keys
[0]))
5540 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5542 return modify_event_symbol (event
->code
, event
->modifiers
,
5543 Qfunction_key
, Qnil
,
5544 lispy_multimedia_keys
, &func_key_syms
,
5545 (sizeof (lispy_multimedia_keys
)
5546 / sizeof (lispy_multimedia_keys
[0])));
5551 /* A mouse click. Figure out where it is, decide whether it's
5552 a press, click or drag, and build the appropriate structure. */
5553 case MOUSE_CLICK_EVENT
:
5555 case GPM_CLICK_EVENT
:
5557 #ifndef USE_TOOLKIT_SCROLL_BARS
5558 case SCROLL_BAR_CLICK_EVENT
:
5561 int button
= event
->code
;
5563 Lisp_Object position
;
5564 Lisp_Object
*start_pos_ptr
;
5565 Lisp_Object start_pos
;
5569 /* Build the position as appropriate for this mouse click. */
5570 if (event
->kind
== MOUSE_CLICK_EVENT
5572 || event
->kind
== GPM_CLICK_EVENT
5576 struct frame
*f
= XFRAME (event
->frame_or_window
);
5579 /* Ignore mouse events that were made on frame that
5580 have been deleted. */
5581 if (! FRAME_LIVE_P (f
))
5584 /* EVENT->x and EVENT->y are frame-relative pixel
5585 coordinates at this place. Under old redisplay, COLUMN
5586 and ROW are set to frame relative glyph coordinates
5587 which are then used to determine whether this click is
5588 in a menu (non-toolkit version). */
5589 if (!toolkit_menubar_in_use (f
))
5591 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5592 &column
, &row
, NULL
, 1);
5594 /* In the non-toolkit version, clicks on the menu bar
5595 are ordinary button events in the event buffer.
5596 Distinguish them, and invoke the menu.
5598 (In the toolkit version, the toolkit handles the
5599 menu bar and Emacs doesn't know about it until
5600 after the user makes a selection.) */
5601 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5602 && (event
->modifiers
& down_modifier
))
5604 Lisp_Object items
, item
;
5606 /* Find the menu bar item under `column'. */
5608 items
= FRAME_MENU_BAR_ITEMS (f
);
5609 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5611 Lisp_Object pos
, string
;
5612 string
= AREF (items
, i
+ 1);
5613 pos
= AREF (items
, i
+ 3);
5616 if (column
>= XINT (pos
)
5617 && column
< XINT (pos
) + SCHARS (string
))
5619 item
= AREF (items
, i
);
5624 /* ELisp manual 2.4b says (x y) are window
5625 relative but code says they are
5627 position
= list4 (event
->frame_or_window
,
5629 Fcons (event
->x
, event
->y
),
5630 make_number (event
->timestamp
));
5632 return list2 (item
, position
);
5636 position
= make_lispy_position (f
, event
->x
, event
->y
,
5639 #ifndef USE_TOOLKIT_SCROLL_BARS
5642 /* It's a scrollbar click. */
5644 Lisp_Object portion_whole
;
5647 window
= event
->frame_or_window
;
5648 portion_whole
= Fcons (event
->x
, event
->y
);
5649 part
= *scroll_bar_parts
[(int) event
->part
];
5651 position
= list5 (window
, Qvertical_scroll_bar
,
5652 portion_whole
, make_number (event
->timestamp
),
5655 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5657 if (button
>= ASIZE (button_down_location
))
5659 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5660 button_down_location
= larger_vector (button_down_location
,
5662 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5665 start_pos_ptr
= aref_addr (button_down_location
, button
);
5666 start_pos
= *start_pos_ptr
;
5667 *start_pos_ptr
= Qnil
;
5670 /* On window-system frames, use the value of
5671 double-click-fuzz as is. On other frames, interpret it
5672 as a multiple of 1/8 characters. */
5676 if (WINDOWP (event
->frame_or_window
))
5677 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5678 else if (FRAMEP (event
->frame_or_window
))
5679 f
= XFRAME (event
->frame_or_window
);
5683 if (FRAME_WINDOW_P (f
))
5684 fuzz
= double_click_fuzz
;
5686 fuzz
= double_click_fuzz
/ 8;
5688 is_double
= (button
== last_mouse_button
5689 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5690 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5691 && button_down_time
!= 0
5692 && (EQ (Vdouble_click_time
, Qt
)
5693 || (NATNUMP (Vdouble_click_time
)
5694 && (event
->timestamp
- button_down_time
5695 < XFASTINT (Vdouble_click_time
)))));
5698 last_mouse_button
= button
;
5699 last_mouse_x
= XINT (event
->x
);
5700 last_mouse_y
= XINT (event
->y
);
5702 /* If this is a button press, squirrel away the location, so
5703 we can decide later whether it was a click or a drag. */
5704 if (event
->modifiers
& down_modifier
)
5708 double_click_count
++;
5709 event
->modifiers
|= ((double_click_count
> 2)
5714 double_click_count
= 1;
5715 button_down_time
= event
->timestamp
;
5716 *start_pos_ptr
= Fcopy_alist (position
);
5717 ignore_mouse_drag_p
= 0;
5720 /* Now we're releasing a button - check the co-ordinates to
5721 see if this was a click or a drag. */
5722 else if (event
->modifiers
& up_modifier
)
5724 /* If we did not see a down before this up, ignore the up.
5725 Probably this happened because the down event chose a
5726 menu item. It would be an annoyance to treat the
5727 release of the button that chose the menu item as a
5730 if (!CONSP (start_pos
))
5733 event
->modifiers
&= ~up_modifier
;
5736 Lisp_Object new_down
, down
;
5737 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5739 /* The third element of every position
5740 should be the (x,y) pair. */
5741 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5742 new_down
= Fcar (Fcdr (Fcdr (position
)));
5745 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5747 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5748 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5751 if (ignore_mouse_drag_p
)
5753 event
->modifiers
|= click_modifier
;
5754 ignore_mouse_drag_p
= 0;
5756 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5757 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5758 /* Maybe the mouse has moved a lot, caused scrolling, and
5759 eventually ended up at the same screen position (but
5760 not buffer position) in which case it is a drag, not
5762 /* FIXME: OTOH if the buffer position has changed
5763 because of a timer or process filter rather than
5764 because of mouse movement, it should be considered as
5765 a click. But mouse-drag-region completely ignores
5766 this case and it hasn't caused any real problem, so
5767 it's probably OK to ignore it as well. */
5768 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5769 /* Mouse hasn't moved (much). */
5770 event
->modifiers
|= click_modifier
;
5773 button_down_time
= 0;
5774 event
->modifiers
|= drag_modifier
;
5777 /* Don't check is_double; treat this as multiple
5778 if the down-event was multiple. */
5779 if (double_click_count
> 1)
5780 event
->modifiers
|= ((double_click_count
> 2)
5786 /* Every mouse event should either have the down_modifier or
5787 the up_modifier set. */
5791 /* Get the symbol we should use for the mouse click. */
5794 head
= modify_event_symbol (button
,
5796 Qmouse_click
, Vlispy_mouse_stem
,
5799 ASIZE (mouse_syms
));
5800 if (event
->modifiers
& drag_modifier
)
5801 return list3 (head
, start_pos
, position
);
5802 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5803 return list3 (head
, position
, make_number (double_click_count
));
5805 return list2 (head
, position
);
5810 case HORIZ_WHEEL_EVENT
:
5812 Lisp_Object position
;
5815 /* Build the position as appropriate for this mouse click. */
5816 struct frame
*f
= XFRAME (event
->frame_or_window
);
5818 /* Ignore wheel events that were made on frame that have been
5820 if (! FRAME_LIVE_P (f
))
5823 position
= make_lispy_position (f
, event
->x
, event
->y
,
5826 /* Set double or triple modifiers to indicate the wheel speed. */
5828 /* On window-system frames, use the value of
5829 double-click-fuzz as is. On other frames, interpret it
5830 as a multiple of 1/8 characters. */
5836 if (WINDOWP (event
->frame_or_window
))
5837 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5838 else if (FRAMEP (event
->frame_or_window
))
5839 fr
= XFRAME (event
->frame_or_window
);
5843 fuzz
= FRAME_WINDOW_P (fr
)
5844 ? double_click_fuzz
: double_click_fuzz
/ 8;
5846 if (event
->modifiers
& up_modifier
)
5848 /* Emit a wheel-up event. */
5849 event
->modifiers
&= ~up_modifier
;
5852 else if (event
->modifiers
& down_modifier
)
5854 /* Emit a wheel-down event. */
5855 event
->modifiers
&= ~down_modifier
;
5859 /* Every wheel event should either have the down_modifier or
5860 the up_modifier set. */
5863 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5866 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5867 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5868 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5869 && button_down_time
!= 0
5870 && (EQ (Vdouble_click_time
, Qt
)
5871 || (NATNUMP (Vdouble_click_time
)
5872 && (event
->timestamp
- button_down_time
5873 < XFASTINT (Vdouble_click_time
)))));
5876 double_click_count
++;
5877 event
->modifiers
|= ((double_click_count
> 2)
5883 double_click_count
= 1;
5884 event
->modifiers
|= click_modifier
;
5887 button_down_time
= event
->timestamp
;
5888 /* Use a negative value to distinguish wheel from mouse button. */
5889 last_mouse_button
= - (1 + symbol_num
);
5890 last_mouse_x
= XINT (event
->x
);
5891 last_mouse_y
= XINT (event
->y
);
5893 /* Get the symbol we should use for the wheel event. */
5894 head
= modify_event_symbol (symbol_num
,
5900 ASIZE (wheel_syms
));
5903 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5904 return list3 (head
, position
, make_number (double_click_count
));
5906 return list2 (head
, position
);
5910 #ifdef USE_TOOLKIT_SCROLL_BARS
5912 /* We don't have down and up events if using toolkit scroll bars,
5913 so make this always a click event. Store in the `part' of
5914 the Lisp event a symbol which maps to the following actions:
5916 `above_handle' page up
5917 `below_handle' page down
5921 `bottom' bottom of buffer
5922 `handle' thumb has been dragged.
5923 `end-scroll' end of interaction with scroll bar
5925 The incoming input_event contains in its `part' member an
5926 index of type `enum scroll_bar_part' which we can use as an
5927 index in scroll_bar_parts to get the appropriate symbol. */
5929 case SCROLL_BAR_CLICK_EVENT
:
5931 Lisp_Object position
, head
, window
, portion_whole
, part
;
5933 window
= event
->frame_or_window
;
5934 portion_whole
= Fcons (event
->x
, event
->y
);
5935 part
= *scroll_bar_parts
[(int) event
->part
];
5937 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5938 make_number (event
->timestamp
), part
);
5940 /* Always treat scroll bar events as clicks. */
5941 event
->modifiers
|= click_modifier
;
5942 event
->modifiers
&= ~up_modifier
;
5944 if (event
->code
>= ASIZE (mouse_syms
))
5945 mouse_syms
= larger_vector (mouse_syms
,
5946 event
->code
- ASIZE (mouse_syms
) + 1,
5949 /* Get the symbol we should use for the mouse click. */
5950 head
= modify_event_symbol (event
->code
,
5955 ASIZE (mouse_syms
));
5956 return list2 (head
, position
);
5959 #endif /* USE_TOOLKIT_SCROLL_BARS */
5961 case DRAG_N_DROP_EVENT
:
5964 Lisp_Object head
, position
;
5967 f
= XFRAME (event
->frame_or_window
);
5970 /* Ignore mouse events that were made on frames that
5971 have been deleted. */
5972 if (! FRAME_LIVE_P (f
))
5975 position
= make_lispy_position (f
, event
->x
, event
->y
,
5978 head
= modify_event_symbol (0, event
->modifiers
,
5980 lispy_drag_n_drop_names
,
5981 &drag_n_drop_syms
, 1);
5982 return list3 (head
, position
, files
);
5985 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5986 || defined (HAVE_NS) || defined (USE_GTK)
5987 case MENU_BAR_EVENT
:
5988 if (EQ (event
->arg
, event
->frame_or_window
))
5989 /* This is the prefix key. We translate this to
5990 `(menu_bar)' because the code in keyboard.c for menu
5991 events, which we use, relies on this. */
5992 return list1 (Qmenu_bar
);
5996 case SELECT_WINDOW_EVENT
:
5997 /* Make an event (select-window (WINDOW)). */
5998 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6000 case TOOL_BAR_EVENT
:
6001 if (EQ (event
->arg
, event
->frame_or_window
))
6002 /* This is the prefix key. We translate this to
6003 `(tool_bar)' because the code in keyboard.c for tool bar
6004 events, which we use, relies on this. */
6005 return list1 (Qtool_bar
);
6006 else if (SYMBOLP (event
->arg
))
6007 return apply_modifiers (event
->modifiers
, event
->arg
);
6010 case USER_SIGNAL_EVENT
:
6011 /* A user signal. */
6013 char *name
= find_user_signal_name (event
->code
);
6016 return intern (name
);
6019 case SAVE_SESSION_EVENT
:
6020 return Qsave_session
;
6025 return Fcons (Qdbus_event
, event
->arg
);
6027 #endif /* HAVE_DBUS */
6029 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6030 case FILE_NOTIFY_EVENT
:
6032 return Fcons (Qfile_notify
, event
->arg
);
6034 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6036 case CONFIG_CHANGED_EVENT
:
6037 return list3 (Qconfig_changed_event
,
6038 event
->arg
, event
->frame_or_window
);
6040 /* The 'kind' field of the event is something we don't recognize. */
6047 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6048 Lisp_Object x
, Lisp_Object y
, Time t
)
6050 /* Is it a scroll bar movement? */
6051 if (frame
&& ! NILP (bar_window
))
6053 Lisp_Object part_sym
;
6055 part_sym
= *scroll_bar_parts
[(int) part
];
6056 return list2 (Qscroll_bar_movement
,
6058 Qvertical_scroll_bar
,
6063 /* Or is it an ordinary mouse movement? */
6066 Lisp_Object position
;
6067 position
= make_lispy_position (frame
, x
, y
, t
);
6068 return list2 (Qmouse_movement
, position
);
6072 /* Construct a switch frame event. */
6074 make_lispy_switch_frame (Lisp_Object frame
)
6076 return list2 (Qswitch_frame
, frame
);
6080 make_lispy_focus_in (Lisp_Object frame
)
6082 return list2 (Qfocus_in
, frame
);
6085 #ifdef HAVE_WINDOW_SYSTEM
6088 make_lispy_focus_out (Lisp_Object frame
)
6090 return list2 (Qfocus_out
, frame
);
6093 #endif /* HAVE_WINDOW_SYSTEM */
6095 /* Manipulating modifiers. */
6097 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6099 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6100 SYMBOL's name of the end of the modifiers; the string from this
6101 position is the unmodified symbol name.
6103 This doesn't use any caches. */
6106 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6112 CHECK_SYMBOL (symbol
);
6115 name
= SYMBOL_NAME (symbol
);
6117 for (i
= 0; i
< SBYTES (name
) - 1; )
6119 ptrdiff_t this_mod_end
= 0;
6122 /* See if the name continues with a modifier word.
6123 Check that the word appears, but don't check what follows it.
6124 Set this_mod and this_mod_end to record what we find. */
6126 switch (SREF (name
, i
))
6128 #define SINGLE_LETTER_MOD(BIT) \
6129 (this_mod_end = i + 1, this_mod = BIT)
6132 SINGLE_LETTER_MOD (alt_modifier
);
6136 SINGLE_LETTER_MOD (ctrl_modifier
);
6140 SINGLE_LETTER_MOD (hyper_modifier
);
6144 SINGLE_LETTER_MOD (meta_modifier
);
6148 SINGLE_LETTER_MOD (shift_modifier
);
6152 SINGLE_LETTER_MOD (super_modifier
);
6155 #undef SINGLE_LETTER_MOD
6157 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6158 if (i + LEN + 1 <= SBYTES (name) \
6159 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6161 this_mod_end = i + LEN; \
6166 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6167 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6168 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6172 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6174 #undef MULTI_LETTER_MOD
6178 /* If we found no modifier, stop looking for them. */
6179 if (this_mod_end
== 0)
6182 /* Check there is a dash after the modifier, so that it
6183 really is a modifier. */
6184 if (this_mod_end
>= SBYTES (name
)
6185 || SREF (name
, this_mod_end
) != '-')
6188 /* This modifier is real; look for another. */
6189 modifiers
|= this_mod
;
6190 i
= this_mod_end
+ 1;
6193 /* Should we include the `click' modifier? */
6194 if (! (modifiers
& (down_modifier
| drag_modifier
6195 | double_modifier
| triple_modifier
))
6196 && i
+ 7 == SBYTES (name
)
6197 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6198 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6199 modifiers
|= click_modifier
;
6201 if (! (modifiers
& (double_modifier
| triple_modifier
))
6202 && i
+ 6 < SBYTES (name
)
6203 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6204 modifiers
|= click_modifier
;
6212 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6213 prepended to the string BASE[0..BASE_LEN-1].
6214 This doesn't use any caches. */
6216 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6218 /* Since BASE could contain nulls, we can't use intern here; we have
6219 to use Fintern, which expects a genuine Lisp_String, and keeps a
6221 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6227 /* Only the event queue may use the `up' modifier; it should always
6228 be turned into a click or drag event before presented to lisp code. */
6229 if (modifiers
& up_modifier
)
6232 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6233 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6234 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6235 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6236 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6237 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6238 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6239 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6240 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6241 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6242 /* The click modifier is denoted by the absence of other modifiers. */
6246 mod_len
= p
- new_mods
;
6250 Lisp_Object new_name
;
6252 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6253 mod_len
+ base_len_byte
);
6254 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6255 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6257 return Fintern (new_name
, Qnil
);
6262 static const char *const modifier_names
[] =
6264 "up", "down", "drag", "click", "double", "triple", 0, 0,
6265 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6266 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6268 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6270 static Lisp_Object modifier_symbols
;
6272 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6274 lispy_modifier_list (int modifiers
)
6276 Lisp_Object modifier_list
;
6279 modifier_list
= Qnil
;
6280 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6281 if (modifiers
& (1<<i
))
6282 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6285 return modifier_list
;
6289 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6290 where UNMODIFIED is the unmodified form of SYMBOL,
6291 MASK is the set of modifiers present in SYMBOL's name.
6292 This is similar to parse_modifiers_uncached, but uses the cache in
6293 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6294 Qevent_symbol_elements property. */
6296 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6299 parse_modifiers (Lisp_Object symbol
)
6301 Lisp_Object elements
;
6303 if (INTEGERP (symbol
))
6304 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6305 else if (!SYMBOLP (symbol
))
6308 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6309 if (CONSP (elements
))
6314 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6315 Lisp_Object unmodified
;
6318 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6319 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6322 if (modifiers
& ~INTMASK
)
6324 XSETFASTINT (mask
, modifiers
);
6325 elements
= list2 (unmodified
, mask
);
6327 /* Cache the parsing results on SYMBOL. */
6328 Fput (symbol
, Qevent_symbol_element_mask
,
6330 Fput (symbol
, Qevent_symbol_elements
,
6331 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6333 /* Since we know that SYMBOL is modifiers applied to unmodified,
6334 it would be nice to put that in unmodified's cache.
6335 But we can't, since we're not sure that parse_modifiers is
6342 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6343 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6344 doc
: /* Parse the event symbol. For internal use. */)
6345 (Lisp_Object symbol
)
6347 /* Fill the cache if needed. */
6348 parse_modifiers (symbol
);
6349 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6350 and use the Lispier representation stored on Qevent_symbol_elements
6352 return Fget (symbol
, Qevent_symbol_elements
);
6355 /* Apply the modifiers MODIFIERS to the symbol BASE.
6356 BASE must be unmodified.
6358 This is like apply_modifiers_uncached, but uses BASE's
6359 Qmodifier_cache property, if present. It also builds
6360 Qevent_symbol_elements properties, since it has that info anyway.
6362 apply_modifiers copies the value of BASE's Qevent_kind property to
6363 the modified symbol. */
6365 apply_modifiers (int modifiers
, Lisp_Object base
)
6367 Lisp_Object cache
, idx
, entry
, new_symbol
;
6369 /* Mask out upper bits. We don't know where this value's been. */
6370 modifiers
&= INTMASK
;
6372 if (INTEGERP (base
))
6373 return make_number (XINT (base
) | modifiers
);
6375 /* The click modifier never figures into cache indices. */
6376 cache
= Fget (base
, Qmodifier_cache
);
6377 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6378 entry
= assq_no_quit (idx
, cache
);
6381 new_symbol
= XCDR (entry
);
6384 /* We have to create the symbol ourselves. */
6385 new_symbol
= apply_modifiers_uncached (modifiers
,
6386 SSDATA (SYMBOL_NAME (base
)),
6387 SCHARS (SYMBOL_NAME (base
)),
6388 SBYTES (SYMBOL_NAME (base
)));
6390 /* Add the new symbol to the base's cache. */
6391 entry
= Fcons (idx
, new_symbol
);
6392 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6394 /* We have the parsing info now for free, so we could add it to
6396 XSETFASTINT (idx, modifiers);
6397 Fput (new_symbol, Qevent_symbol_element_mask,
6399 Fput (new_symbol, Qevent_symbol_elements,
6400 Fcons (base, lispy_modifier_list (modifiers)));
6401 Sadly, this is only correct if `base' is indeed a base event,
6402 which is not necessarily the case. -stef */
6405 /* Make sure this symbol is of the same kind as BASE.
6407 You'd think we could just set this once and for all when we
6408 intern the symbol above, but reorder_modifiers may call us when
6409 BASE's property isn't set right; we can't assume that just
6410 because it has a Qmodifier_cache property it must have its
6411 Qevent_kind set right as well. */
6412 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6416 kind
= Fget (base
, Qevent_kind
);
6418 Fput (new_symbol
, Qevent_kind
, kind
);
6425 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6426 return a symbol with the modifiers placed in the canonical order.
6427 Canonical order is alphabetical, except for down and drag, which
6428 always come last. The 'click' modifier is never written out.
6430 Fdefine_key calls this to make sure that (for example) C-M-foo
6431 and M-C-foo end up being equivalent in the keymap. */
6434 reorder_modifiers (Lisp_Object symbol
)
6436 /* It's hopefully okay to write the code this way, since everything
6437 will soon be in caches, and no consing will be done at all. */
6440 parsed
= parse_modifiers (symbol
);
6441 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6446 /* For handling events, we often want to produce a symbol whose name
6447 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6448 to some base, like the name of a function key or mouse button.
6449 modify_event_symbol produces symbols of this sort.
6451 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6452 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6455 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6456 into symbol names, or a string specifying a name stem used to
6457 construct a symbol name or the form `STEM-N', where N is the decimal
6458 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6459 non-nil; otherwise NAME_TABLE is used.
6461 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6462 persist between calls to modify_event_symbol that it can use to
6463 store a cache of the symbols it's generated for this NAME_TABLE
6464 before. The object stored there may be a vector or an alist.
6466 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6468 MODIFIERS is a set of modifier bits (as given in struct input_events)
6469 whose prefixes should be applied to the symbol name.
6471 SYMBOL_KIND is the value to be placed in the event_kind property of
6472 the returned symbol.
6474 The symbols we create are supposed to have an
6475 `event-symbol-elements' property, which lists the modifiers present
6476 in the symbol's name. */
6479 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6480 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6481 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6484 Lisp_Object symbol_int
;
6486 /* Get rid of the "vendor-specific" bit here. */
6487 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6489 /* Is this a request for a valid symbol? */
6490 if (symbol_num
< 0 || symbol_num
>= table_size
)
6493 if (CONSP (*symbol_table
))
6494 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6496 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6497 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6498 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6499 we've never used that symbol before. */
6502 if (! VECTORP (*symbol_table
)
6503 || ASIZE (*symbol_table
) != table_size
)
6507 XSETFASTINT (size
, table_size
);
6508 *symbol_table
= Fmake_vector (size
, Qnil
);
6511 value
= AREF (*symbol_table
, symbol_num
);
6514 /* Have we already used this symbol before? */
6517 /* No; let's create it. */
6518 if (CONSP (name_alist_or_stem
))
6519 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6520 else if (STRINGP (name_alist_or_stem
))
6523 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6524 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6526 buf
= SAFE_ALLOCA (len
);
6527 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6528 XINT (symbol_int
) + 1);
6529 value
= intern (buf
);
6532 else if (name_table
!= 0 && name_table
[symbol_num
])
6533 value
= intern (name_table
[symbol_num
]);
6535 #ifdef HAVE_WINDOW_SYSTEM
6538 char *name
= x_get_keysym_name (symbol_num
);
6540 value
= intern (name
);
6546 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6547 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6548 value
= intern (buf
);
6551 if (CONSP (*symbol_table
))
6552 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6554 ASET (*symbol_table
, symbol_num
, value
);
6556 /* Fill in the cache entries for this symbol; this also
6557 builds the Qevent_symbol_elements property, which the user
6559 apply_modifiers (modifiers
& click_modifier
, value
);
6560 Fput (value
, Qevent_kind
, symbol_kind
);
6563 /* Apply modifiers to that symbol. */
6564 return apply_modifiers (modifiers
, value
);
6567 /* Convert a list that represents an event type,
6568 such as (ctrl meta backspace), into the usual representation of that
6569 event type as a number or a symbol. */
6571 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6572 doc
: /* Convert the event description list EVENT-DESC to an event type.
6573 EVENT-DESC should contain one base event type (a character or symbol)
6574 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6575 drag, down, double or triple). The base must be last.
6576 The return value is an event type (a character or symbol) which
6577 has the same base event type and all the specified modifiers. */)
6578 (Lisp_Object event_desc
)
6586 while (CONSP (rest
))
6594 /* Given a symbol, see if it is a modifier name. */
6595 if (SYMBOLP (elt
) && CONSP (rest
))
6596 this = parse_solitary_modifier (elt
);
6600 else if (!NILP (base
))
6601 error ("Two bases given in one event");
6607 /* Let the symbol A refer to the character A. */
6608 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6609 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6611 if (INTEGERP (base
))
6613 /* Turn (shift a) into A. */
6614 if ((modifiers
& shift_modifier
) != 0
6615 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6617 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6618 modifiers
&= ~shift_modifier
;
6621 /* Turn (control a) into C-a. */
6622 if (modifiers
& ctrl_modifier
)
6623 return make_number ((modifiers
& ~ctrl_modifier
)
6624 | make_ctrl_char (XINT (base
)));
6626 return make_number (modifiers
| XINT (base
));
6628 else if (SYMBOLP (base
))
6629 return apply_modifiers (modifiers
, base
);
6631 error ("Invalid base event");
6634 /* Try to recognize SYMBOL as a modifier name.
6635 Return the modifier flag bit, or 0 if not recognized. */
6638 parse_solitary_modifier (Lisp_Object symbol
)
6640 Lisp_Object name
= SYMBOL_NAME (symbol
);
6642 switch (SREF (name
, 0))
6644 #define SINGLE_LETTER_MOD(BIT) \
6645 if (SBYTES (name) == 1) \
6648 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6649 if (LEN == SBYTES (name) \
6650 && ! memcmp (SDATA (name), NAME, LEN)) \
6654 SINGLE_LETTER_MOD (alt_modifier
);
6658 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6662 SINGLE_LETTER_MOD (ctrl_modifier
);
6666 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6667 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6671 SINGLE_LETTER_MOD (hyper_modifier
);
6675 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6679 SINGLE_LETTER_MOD (meta_modifier
);
6683 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6687 SINGLE_LETTER_MOD (shift_modifier
);
6691 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6692 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6693 SINGLE_LETTER_MOD (super_modifier
);
6697 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6698 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6699 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6703 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6706 #undef SINGLE_LETTER_MOD
6707 #undef MULTI_LETTER_MOD
6713 /* Return true if EVENT is a list whose elements are all integers or symbols.
6714 Such a list is not valid as an event,
6715 but it can be a Lucid-style event type list. */
6718 lucid_event_type_list_p (Lisp_Object object
)
6722 if (! CONSP (object
))
6725 if (EQ (XCAR (object
), Qhelp_echo
)
6726 || EQ (XCAR (object
), Qvertical_line
)
6727 || EQ (XCAR (object
), Qmode_line
)
6728 || EQ (XCAR (object
), Qheader_line
))
6731 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6735 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6742 /* Return true if terminal input chars are available.
6743 Also, store the return value into INPUT_PENDING.
6745 Serves the purpose of ioctl (0, FIONREAD, ...)
6746 but works even if FIONREAD does not exist.
6747 (In fact, this may actually read some input.)
6749 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6750 timer events that are ripe.
6751 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6752 events (FOCUS_IN_EVENT).
6753 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6754 movements and toolkit scroll bar thumb drags. */
6757 get_input_pending (int flags
)
6759 /* First of all, have we already counted some input? */
6760 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6762 /* If input is being read as it arrives, and we have none, there is none. */
6763 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6765 /* Try to read some input and see how much we get. */
6767 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6770 return input_pending
;
6773 /* Put a BUFFER_SWITCH_EVENT in the buffer
6774 so that read_key_sequence will notice the new current buffer. */
6777 record_asynch_buffer_change (void)
6779 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6780 The purpose of the event is to make read_key_sequence look up the
6781 keymaps again. If we aren't in read_key_sequence, we don't need one,
6782 and the event could cause trouble by messing up (input-pending-p).
6783 Note: Fwaiting_for_user_input_p always returns nil when async
6784 subprocesses aren't supported. */
6785 if (!NILP (Fwaiting_for_user_input_p ()))
6787 struct input_event event
;
6790 event
.kind
= BUFFER_SWITCH_EVENT
;
6791 event
.frame_or_window
= Qnil
;
6794 /* Make sure no interrupt happens while storing the event. */
6796 if (interrupt_input
)
6797 kbd_buffer_store_event (&event
);
6802 kbd_buffer_store_event (&event
);
6808 /* Read any terminal input already buffered up by the system
6809 into the kbd_buffer, but do not wait.
6811 Return the number of keyboard chars read, or -1 meaning
6812 this is a bad time to try to read input. */
6821 /* Store pending user signal events, if any. */
6822 store_user_signal_events ();
6824 /* Loop through the available terminals, and call their input hooks. */
6828 struct terminal
*next
= t
->next_terminal
;
6830 if (t
->read_socket_hook
)
6833 struct input_event hold_quit
;
6835 if (input_blocked_p ())
6837 pending_signals
= 1;
6841 EVENT_INIT (hold_quit
);
6842 hold_quit
.kind
= NO_EVENT
;
6844 /* No need for FIONREAD or fcntl; just say don't wait. */
6845 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6848 if (nr
== -1) /* Not OK to read input now. */
6852 else if (nr
== -2) /* Non-transient error. */
6854 /* The terminal device terminated; it should be closed. */
6856 /* Kill Emacs if this was our last terminal. */
6857 if (!terminal_list
->next_terminal
)
6858 /* Formerly simply reported no input, but that
6859 sometimes led to a failure of Emacs to terminate.
6860 SIGHUP seems appropriate if we can't reach the
6862 /* ??? Is it really right to send the signal just to
6863 this process rather than to the whole process
6864 group? Perhaps on systems with FIONREAD Emacs is
6865 alone in its group. */
6866 terminate_due_to_signal (SIGHUP
, 10);
6868 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6871 XSETTERMINAL (tmp
, t
);
6872 Fdelete_terminal (tmp
, Qnoelisp
);
6876 if (hold_quit
.kind
!= NO_EVENT
)
6877 kbd_buffer_store_event (&hold_quit
);
6886 frame_make_pointer_visible ();
6891 /* This is the tty way of reading available input.
6893 Note that each terminal device has its own `struct terminal' object,
6894 and so this function is called once for each individual termcap
6895 terminal. The first parameter indicates which terminal to read from. */
6898 tty_read_avail_input (struct terminal
*terminal
,
6899 struct input_event
*hold_quit
)
6901 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6902 the kbd_buffer can really hold. That may prevent loss
6903 of characters on some systems when input is stuffed at us. */
6904 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6906 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6909 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6911 if (kbd_on_hold_p () || buffer_free
<= 0)
6913 #endif /* subprocesses */
6915 if (!terminal
->name
) /* Don't read from a dead terminal. */
6918 if (terminal
->type
!= output_termcap
6919 && terminal
->type
!= output_msdos_raw
)
6922 /* XXX I think the following code should be moved to separate hook
6923 functions in system-dependent files. */
6925 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6926 code sets read_socket_hook to w32_console_read_socket instead! */
6928 #else /* not WINDOWSNT */
6929 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6933 return 0; /* The terminal is suspended. */
6936 n_to_read
= dos_keysns ();
6940 cbuf
[0] = dos_keyread ();
6943 #else /* not MSDOS */
6948 struct input_event gpm_hold_quit
;
6949 int gpm
, fd
= gpm_fd
;
6951 EVENT_INIT (gpm_hold_quit
);
6952 gpm_hold_quit
.kind
= NO_EVENT
;
6954 /* gpm==1 if event received.
6955 gpm==0 if the GPM daemon has closed the connection, in which case
6956 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6957 we save it in `fd' so close_gpm can remove it from the
6959 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6960 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6961 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6964 /* Presumably the GPM daemon has closed the connection. */
6966 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6967 kbd_buffer_store_event (&gpm_hold_quit
);
6971 #endif /* HAVE_GPM */
6973 /* Determine how many characters we should *try* to read. */
6974 #ifdef USABLE_FIONREAD
6975 /* Find out how much input is available. */
6976 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6978 if (! noninteractive
)
6979 return -2; /* Close this terminal. */
6985 if (n_to_read
> sizeof cbuf
)
6986 n_to_read
= sizeof cbuf
;
6987 #elif defined USG || defined CYGWIN
6988 /* Read some input if available, but don't wait. */
6989 n_to_read
= sizeof cbuf
;
6990 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6992 # error "Cannot read without possibly delaying"
6996 /* Don't read more than we can store. */
6997 if (n_to_read
> buffer_free
)
6998 n_to_read
= buffer_free
;
6999 #endif /* subprocesses */
7001 /* Now read; for one reason or another, this will not block.
7002 NREAD is set to the number of chars read. */
7005 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7006 /* POSIX infers that processes which are not in the session leader's
7007 process group won't get SIGHUPs at logout time. BSDI adheres to
7008 this part standard and returns -1 from read (0) with errno==EIO
7009 when the control tty is taken away.
7010 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7011 if (nread
== -1 && errno
== EIO
)
7012 return -2; /* Close this terminal. */
7013 #if defined (AIX) && defined (_BSD)
7014 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7015 This looks incorrect, but it isn't, because _BSD causes
7016 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7017 and that causes a value other than 0 when there is no input. */
7019 return -2; /* Close this terminal. */
7023 /* We used to retry the read if it was interrupted.
7024 But this does the wrong thing when O_NONBLOCK causes
7025 an EAGAIN error. Does anybody know of a situation
7026 where a retry is actually needed? */
7028 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7038 #ifndef USABLE_FIONREAD
7039 #if defined (USG) || defined (CYGWIN)
7040 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7041 #endif /* USG or CYGWIN */
7042 #endif /* no FIONREAD */
7047 #endif /* not MSDOS */
7048 #endif /* not WINDOWSNT */
7050 for (i
= 0; i
< nread
; i
++)
7052 struct input_event buf
;
7054 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7056 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7057 buf
.modifiers
= meta_modifier
;
7058 if (tty
->meta_key
!= 2)
7062 /* Set the frame corresponding to the active tty. Note that the
7063 value of selected_frame is not reliable here, redisplay tends
7064 to temporarily change it. */
7065 buf
.frame_or_window
= tty
->top_frame
;
7068 kbd_buffer_store_event (&buf
);
7069 /* Don't look at input that follows a C-g too closely.
7070 This reduces lossage due to autorepeat on C-g. */
7071 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7072 && buf
.code
== quit_char
)
7080 handle_async_input (void)
7085 int nread
= gobble_input ();
7086 /* -1 means it's not ok to read the input now.
7087 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7088 0 means there was no keyboard input available. */
7096 process_pending_signals (void)
7098 pending_signals
= 0;
7099 handle_async_input ();
7100 do_pending_atimers ();
7103 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7104 and reinvoke any pending signal if the level is now 0 and
7105 a fatal error is not already in progress. */
7108 unblock_input_to (int level
)
7110 interrupt_input_blocked
= level
;
7113 if (pending_signals
&& !fatal_error_in_progress
)
7114 process_pending_signals ();
7120 /* End critical section.
7122 If doing signal-driven input, and a signal came in when input was
7123 blocked, reinvoke the signal handler now to deal with it. */
7126 unblock_input (void)
7128 unblock_input_to (interrupt_input_blocked
- 1);
7131 /* Undo any number of BLOCK_INPUT calls,
7132 and also reinvoke any pending signal. */
7135 totally_unblock_input (void)
7137 unblock_input_to (0);
7143 handle_input_available_signal (int sig
)
7145 pending_signals
= 1;
7147 if (input_available_clear_time
)
7148 *input_available_clear_time
= make_timespec (0, 0);
7152 deliver_input_available_signal (int sig
)
7154 deliver_process_signal (sig
, handle_input_available_signal
);
7156 #endif /* USABLE_SIGIO */
7159 /* User signal events. */
7161 struct user_signal_info
7163 /* Signal number. */
7166 /* Name of the signal. */
7169 /* Number of pending signals. */
7172 struct user_signal_info
*next
;
7175 /* List of user signals. */
7176 static struct user_signal_info
*user_signals
= NULL
;
7179 add_user_signal (int sig
, const char *name
)
7181 struct sigaction action
;
7182 struct user_signal_info
*p
;
7184 for (p
= user_signals
; p
; p
= p
->next
)
7186 /* Already added. */
7189 p
= xmalloc (sizeof *p
);
7191 p
->name
= xstrdup (name
);
7193 p
->next
= user_signals
;
7196 emacs_sigaction_init (&action
, deliver_user_signal
);
7197 sigaction (sig
, &action
, 0);
7201 handle_user_signal (int sig
)
7203 struct user_signal_info
*p
;
7204 const char *special_event_name
= NULL
;
7206 if (SYMBOLP (Vdebug_on_event
))
7207 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7209 for (p
= user_signals
; p
; p
= p
->next
)
7212 if (special_event_name
7213 && strcmp (special_event_name
, p
->name
) == 0)
7215 /* Enter the debugger in many ways. */
7216 debug_on_next_call
= 1;
7219 Vinhibit_quit
= Qnil
;
7221 /* Eat the event. */
7227 if (interrupt_input
)
7228 handle_input_available_signal (sig
);
7232 /* Tell wait_reading_process_output that it needs to wake
7233 up and look around. */
7234 if (input_available_clear_time
)
7235 *input_available_clear_time
= make_timespec (0, 0);
7242 deliver_user_signal (int sig
)
7244 deliver_process_signal (sig
, handle_user_signal
);
7248 find_user_signal_name (int sig
)
7250 struct user_signal_info
*p
;
7252 for (p
= user_signals
; p
; p
= p
->next
)
7260 store_user_signal_events (void)
7262 struct user_signal_info
*p
;
7263 struct input_event buf
;
7264 bool buf_initialized
= 0;
7266 for (p
= user_signals
; p
; p
= p
->next
)
7267 if (p
->npending
> 0)
7269 if (! buf_initialized
)
7271 memset (&buf
, 0, sizeof buf
);
7272 buf
.kind
= USER_SIGNAL_EVENT
;
7273 buf
.frame_or_window
= selected_frame
;
7274 buf_initialized
= 1;
7280 kbd_buffer_store_event (&buf
);
7283 while (p
->npending
> 0);
7288 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7289 static Lisp_Object menu_bar_one_keymap_changed_items
;
7291 /* These variables hold the vector under construction within
7292 menu_bar_items and its subroutines, and the current index
7293 for storing into that vector. */
7294 static Lisp_Object menu_bar_items_vector
;
7295 static int menu_bar_items_index
;
7298 static const char* separator_names
[] = {
7303 "single-dashed-line",
7304 "double-dashed-line",
7306 "shadow-etched-out",
7307 "shadow-etched-in-dash",
7308 "shadow-etched-out-dash",
7309 "shadow-double-etched-in",
7310 "shadow-double-etched-out",
7311 "shadow-double-etched-in-dash",
7312 "shadow-double-etched-out-dash",
7316 /* Return true if LABEL specifies a separator. */
7319 menu_separator_name_p (const char *label
)
7323 else if (strlen (label
) > 3
7324 && memcmp (label
, "--", 2) == 0
7329 for (i
= 0; separator_names
[i
]; ++i
)
7330 if (strcmp (label
, separator_names
[i
]) == 0)
7335 /* It's a separator if it contains only dashes. */
7336 while (*label
== '-')
7338 return (*label
== 0);
7345 /* Return a vector of menu items for a menu bar, appropriate
7346 to the current buffer. Each item has three elements in the vector:
7349 OLD is an old vector we can optionally reuse, or nil. */
7352 menu_bar_items (Lisp_Object old
)
7354 /* The number of keymaps we're scanning right now, and the number of
7355 keymaps we have allocated space for. */
7358 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7359 in the current keymaps, or nil where it is not a prefix. */
7362 Lisp_Object def
, tail
;
7367 /* In order to build the menus, we need to call the keymap
7368 accessors. They all call QUIT. But this function is called
7369 during redisplay, during which a quit is fatal. So inhibit
7370 quitting while building the menus.
7371 We do this instead of specbind because (1) errors will clear it anyway
7372 and (2) this avoids risk of specpdl overflow. */
7373 oquit
= Vinhibit_quit
;
7377 menu_bar_items_vector
= old
;
7379 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7380 menu_bar_items_index
= 0;
7382 /* Build our list of keymaps.
7383 If we recognize a function key and replace its escape sequence in
7384 keybuf with its symbol, or if the sequence starts with a mouse
7385 click and we need to switch buffers, we jump back here to rebuild
7386 the initial keymaps from the current buffer. */
7390 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7391 if (!NILP (Voverriding_local_map_menu_flag
)
7392 && !NILP (Voverriding_local_map
))
7394 /* Yes, use them (if non-nil) as well as the global map. */
7395 maps
= alloca (3 * sizeof (maps
[0]));
7397 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7398 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7399 if (!NILP (Voverriding_local_map
))
7400 maps
[nmaps
++] = Voverriding_local_map
;
7404 /* No, so use major and minor mode keymaps and keymap property.
7405 Note that menu-bar bindings in the local-map and keymap
7406 properties may not work reliable, as they are only
7407 recognized when the menu-bar (or mode-line) is updated,
7408 which does not normally happen after every command. */
7411 nminor
= current_minor_maps (NULL
, &tmaps
);
7412 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7414 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7415 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7416 maps
[nmaps
++] = tem
;
7417 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7418 maps
[nmaps
++] = tem
;
7419 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7421 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7423 maps
[nmaps
++] = current_global_map
;
7426 /* Look up in each map the dummy prefix key `menu-bar'. */
7428 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7429 if (!NILP (maps
[mapno
]))
7431 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7435 menu_bar_one_keymap_changed_items
= Qnil
;
7436 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7440 /* Move to the end those items that should be at the end. */
7442 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7445 int end
= menu_bar_items_index
;
7447 for (i
= 0; i
< end
; i
+= 4)
7448 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7450 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7451 /* Move the item at index I to the end,
7452 shifting all the others forward. */
7453 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7454 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7455 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7456 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7458 memmove (aref_addr (menu_bar_items_vector
, i
),
7459 aref_addr (menu_bar_items_vector
, i
+ 4),
7460 (end
- i
- 4) * word_size
);
7461 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7462 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7463 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7464 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7469 /* Add nil, nil, nil, nil at the end. */
7471 int i
= menu_bar_items_index
;
7472 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7473 menu_bar_items_vector
=
7474 larger_vector (menu_bar_items_vector
, 4, -1);
7475 /* Add this item. */
7476 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7477 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7478 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7479 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7480 menu_bar_items_index
= i
;
7483 Vinhibit_quit
= oquit
;
7484 return menu_bar_items_vector
;
7487 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7488 If there's already an item for KEY, add this DEF to it. */
7490 Lisp_Object item_properties
;
7493 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7495 struct gcpro gcpro1
;
7500 if (EQ (item
, Qundefined
))
7502 /* If a map has an explicit `undefined' as definition,
7503 discard any previously made menu bar item. */
7505 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7506 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7508 if (menu_bar_items_index
> i
+ 4)
7509 memmove (aref_addr (menu_bar_items_vector
, i
),
7510 aref_addr (menu_bar_items_vector
, i
+ 4),
7511 (menu_bar_items_index
- i
- 4) * word_size
);
7512 menu_bar_items_index
-= 4;
7516 /* If this keymap has already contributed to this KEY,
7517 don't contribute to it a second time. */
7518 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7519 if (!NILP (tem
) || NILP (item
))
7522 menu_bar_one_keymap_changed_items
7523 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7525 /* We add to menu_bar_one_keymap_changed_items before doing the
7526 parse_menu_item, so that if it turns out it wasn't a menu item,
7527 it still correctly hides any further menu item. */
7529 parsed
= parse_menu_item (item
, 1);
7534 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7536 /* Find any existing item for this KEY. */
7537 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7538 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7541 /* If we did not find this KEY, add it at the end. */
7542 if (i
== menu_bar_items_index
)
7544 /* If vector is too small, get a bigger one. */
7545 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7546 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7547 /* Add this item. */
7548 ASET (menu_bar_items_vector
, i
, key
); i
++;
7549 ASET (menu_bar_items_vector
, i
,
7550 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7551 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7552 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7553 menu_bar_items_index
= i
;
7555 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7559 old
= AREF (menu_bar_items_vector
, i
+ 2);
7560 /* If the new and the old items are not both keymaps,
7561 the lookup will only find `item'. */
7562 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7563 ASET (menu_bar_items_vector
, i
+ 2, item
);
7567 /* This is used as the handler when calling menu_item_eval_property. */
7569 menu_item_eval_property_1 (Lisp_Object arg
)
7571 /* If we got a quit from within the menu computation,
7572 quit all the way out of it. This takes care of C-] in the debugger. */
7573 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7574 Fsignal (Qquit
, Qnil
);
7580 eval_dyn (Lisp_Object form
)
7582 return Feval (form
, Qnil
);
7585 /* Evaluate an expression and return the result (or nil if something
7586 went wrong). Used to evaluate dynamic parts of menu items. */
7588 menu_item_eval_property (Lisp_Object sexpr
)
7590 ptrdiff_t count
= SPECPDL_INDEX ();
7592 specbind (Qinhibit_redisplay
, Qt
);
7593 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7594 menu_item_eval_property_1
);
7595 return unbind_to (count
, val
);
7598 /* This function parses a menu item and leaves the result in the
7599 vector item_properties.
7600 ITEM is a key binding, a possible menu item.
7601 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7603 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7604 parse_menu_item returns true if the item is a menu item and false
7608 parse_menu_item (Lisp_Object item
, int inmenubar
)
7610 Lisp_Object def
, tem
, item_string
, start
;
7612 Lisp_Object keyhint
;
7621 /* Create item_properties vector if necessary. */
7622 if (NILP (item_properties
))
7624 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7626 /* Initialize optional entries. */
7627 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7628 ASET (item_properties
, i
, Qnil
);
7629 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7631 /* Save the item here to protect it from GC. */
7632 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7634 item_string
= XCAR (item
);
7638 if (STRINGP (item_string
))
7640 /* Old format menu item. */
7641 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7643 /* Maybe help string. */
7644 if (CONSP (item
) && STRINGP (XCAR (item
)))
7646 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7651 /* Maybe an obsolete key binding cache. */
7652 if (CONSP (item
) && CONSP (XCAR (item
))
7653 && (NILP (XCAR (XCAR (item
)))
7654 || VECTORP (XCAR (XCAR (item
)))))
7657 /* This is the real definition--the function to run. */
7658 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7660 /* Get enable property, if any. */
7663 tem
= Fget (item
, Qmenu_enable
);
7664 if (!NILP (Venable_disabled_menus_and_buttons
))
7665 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7666 else if (!NILP (tem
))
7667 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7670 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7672 /* New format menu item. */
7673 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7674 start
= XCDR (item
);
7677 /* We have a real binding. */
7678 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7680 item
= XCDR (start
);
7681 /* Is there an obsolete cache list with key equivalences. */
7682 if (CONSP (item
) && CONSP (XCAR (item
)))
7685 /* Parse properties. */
7686 while (CONSP (item
) && CONSP (XCDR (item
)))
7691 if (EQ (tem
, QCenable
))
7693 if (!NILP (Venable_disabled_menus_and_buttons
))
7694 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7696 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7698 else if (EQ (tem
, QCvisible
))
7700 /* If got a visible property and that evaluates to nil
7701 then ignore this item. */
7702 tem
= menu_item_eval_property (XCAR (item
));
7706 else if (EQ (tem
, QChelp
))
7707 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7708 else if (EQ (tem
, QCfilter
))
7710 else if (EQ (tem
, QCkey_sequence
))
7713 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7714 /* Be GC protected. Set keyhint to item instead of tem. */
7717 else if (EQ (tem
, QCkeys
))
7720 if (CONSP (tem
) || STRINGP (tem
))
7721 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7723 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7728 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7730 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7732 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7738 else if (inmenubar
|| !NILP (start
))
7742 return 0; /* not a menu item */
7744 /* If item string is not a string, evaluate it to get string.
7745 If we don't get a string, skip this item. */
7746 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7747 if (!(STRINGP (item_string
)))
7749 item_string
= menu_item_eval_property (item_string
);
7750 if (!STRINGP (item_string
))
7752 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7755 /* If got a filter apply it on definition. */
7756 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7759 def
= menu_item_eval_property (list2 (XCAR (filter
),
7760 list2 (Qquote
, def
)));
7762 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7765 /* Enable or disable selection of item. */
7766 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7769 tem
= menu_item_eval_property (tem
);
7770 if (inmenubar
&& NILP (tem
))
7771 return 0; /* Ignore disabled items in menu bar. */
7772 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7775 /* If we got no definition, this item is just unselectable text which
7776 is OK in a submenu but not in the menubar. */
7778 return (!inmenubar
);
7780 /* See if this is a separate pane or a submenu. */
7781 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7782 tem
= get_keymap (def
, 0, 1);
7783 /* For a subkeymap, just record its details and exit. */
7786 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7787 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7791 /* At the top level in the menu bar, do likewise for commands also.
7792 The menu bar does not display equivalent key bindings anyway.
7793 ITEM_PROPERTY_DEF is already set up properly. */
7797 { /* This is a command. See if there is an equivalent key binding. */
7798 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7800 /* The previous code preferred :key-sequence to :keys, so we
7801 preserve this behavior. */
7802 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7803 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7806 Lisp_Object prefix
= keyeq
;
7807 Lisp_Object keys
= Qnil
;
7811 def
= XCAR (prefix
);
7812 prefix
= XCDR (prefix
);
7815 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7817 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7819 keys
= XCAR (keyhint
);
7820 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7822 /* We have a suggested key. Is it bound to the command? */
7825 /* If the command is an alias for another
7826 (such as lmenu.el set it up), check if the
7827 original command matches the cached command. */
7829 && EQ (tem
, XSYMBOL (def
)->function
))))
7834 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7838 tem
= Fkey_description (keys
, Qnil
);
7841 if (STRINGP (XCAR (prefix
)))
7842 tem
= concat2 (XCAR (prefix
), tem
);
7843 if (STRINGP (XCDR (prefix
)))
7844 tem
= concat2 (tem
, XCDR (prefix
));
7846 keyeq
= concat2 (build_string (" "), tem
);
7847 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7853 /* If we have an equivalent key binding, use that. */
7854 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7857 /* Include this when menu help is implemented.
7858 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7859 if (!(NILP (tem) || STRINGP (tem)))
7861 tem = menu_item_eval_property (tem);
7864 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7868 /* Handle radio buttons or toggle boxes. */
7869 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7871 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7872 menu_item_eval_property (tem
));
7879 /***********************************************************************
7881 ***********************************************************************/
7883 /* A vector holding tool bar items while they are parsed in function
7884 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7887 static Lisp_Object tool_bar_items_vector
;
7889 /* A vector holding the result of parse_tool_bar_item. Layout is like
7890 the one for a single item in tool_bar_items_vector. */
7892 static Lisp_Object tool_bar_item_properties
;
7894 /* Next free index in tool_bar_items_vector. */
7896 static int ntool_bar_items
;
7898 /* The symbols `:image' and `:rtl'. */
7900 static Lisp_Object QCimage
;
7901 static Lisp_Object QCrtl
;
7903 /* Function prototypes. */
7905 static void init_tool_bar_items (Lisp_Object
);
7906 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7907 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7908 static void append_tool_bar_item (void);
7911 /* Return a vector of tool bar items for keymaps currently in effect.
7912 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7913 tool bar items found. */
7916 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7925 /* In order to build the menus, we need to call the keymap
7926 accessors. They all call QUIT. But this function is called
7927 during redisplay, during which a quit is fatal. So inhibit
7928 quitting while building the menus. We do this instead of
7929 specbind because (1) errors will clear it anyway and (2) this
7930 avoids risk of specpdl overflow. */
7931 oquit
= Vinhibit_quit
;
7934 /* Initialize tool_bar_items_vector and protect it from GC. */
7935 init_tool_bar_items (reuse
);
7937 /* Build list of keymaps in maps. Set nmaps to the number of maps
7940 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7941 if (!NILP (Voverriding_local_map_menu_flag
)
7942 && !NILP (Voverriding_local_map
))
7944 /* Yes, use them (if non-nil) as well as the global map. */
7945 maps
= alloca (3 * sizeof *maps
);
7947 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7948 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7949 if (!NILP (Voverriding_local_map
))
7950 maps
[nmaps
++] = Voverriding_local_map
;
7954 /* No, so use major and minor mode keymaps and keymap property.
7955 Note that tool-bar bindings in the local-map and keymap
7956 properties may not work reliable, as they are only
7957 recognized when the tool-bar (or mode-line) is updated,
7958 which does not normally happen after every command. */
7961 nminor
= current_minor_maps (NULL
, &tmaps
);
7962 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7964 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7965 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7966 maps
[nmaps
++] = tem
;
7967 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7968 maps
[nmaps
++] = tem
;
7969 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7971 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7974 /* Add global keymap at the end. */
7975 maps
[nmaps
++] = current_global_map
;
7977 /* Process maps in reverse order and look up in each map the prefix
7979 for (i
= nmaps
- 1; i
>= 0; --i
)
7980 if (!NILP (maps
[i
]))
7984 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7986 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7989 Vinhibit_quit
= oquit
;
7990 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7991 return tool_bar_items_vector
;
7995 /* Process the definition of KEY which is DEF. */
7998 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8001 struct gcpro gcpro1
, gcpro2
;
8003 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8007 if (EQ (def
, Qundefined
))
8009 /* If a map has an explicit `undefined' as definition,
8010 discard any previously made item. */
8011 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8013 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8015 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8017 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8018 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8019 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8021 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8026 else if (parse_tool_bar_item (key
, def
))
8027 /* Append a new tool bar item to tool_bar_items_vector. Accept
8028 more than one definition for the same key. */
8029 append_tool_bar_item ();
8034 /* Access slot with index IDX of vector tool_bar_item_properties. */
8035 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8037 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8039 ASET (tool_bar_item_properties
, idx
, val
);
8043 /* Parse a tool bar item specification ITEM for key KEY and return the
8044 result in tool_bar_item_properties. Value is false if ITEM is
8047 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8049 CAPTION is the caption of the item, If it's not a string, it is
8050 evaluated to get a string.
8052 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8053 as binding are currently ignored.
8055 The following properties are recognized:
8059 FORM is evaluated and specifies whether the tool bar item is
8060 enabled or disabled.
8064 FORM is evaluated and specifies whether the tool bar item is visible.
8066 - `:filter FUNCTION'
8068 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8069 result is stored as the new binding.
8071 - `:button (TYPE SELECTED)'
8073 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8074 and specifies whether the button is selected (pressed) or not.
8078 IMAGES is either a single image specification or a vector of four
8079 image specifications. See enum tool_bar_item_images.
8081 - `:help HELP-STRING'.
8083 Gives a help string to display for the tool bar item.
8085 - `:label LABEL-STRING'.
8087 A text label to show with the tool bar button if labels are enabled. */
8090 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8092 Lisp_Object filter
= Qnil
;
8093 Lisp_Object caption
;
8095 bool have_label
= 0;
8097 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8098 Rule out items that aren't lists, don't start with
8099 `menu-item' or whose rest following `tool-bar-item' is not a
8104 /* As an exception, allow old-style menu separators. */
8105 if (STRINGP (XCAR (item
)))
8106 item
= list1 (XCAR (item
));
8107 else if (!EQ (XCAR (item
), Qmenu_item
)
8108 || (item
= XCDR (item
), !CONSP (item
)))
8111 /* Create tool_bar_item_properties vector if necessary. Reset it to
8113 if (VECTORP (tool_bar_item_properties
))
8115 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8119 tool_bar_item_properties
8120 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8123 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8124 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8126 /* Get the caption of the item. If the caption is not a string,
8127 evaluate it to get a string. If we don't get a string, skip this
8129 caption
= XCAR (item
);
8130 if (!STRINGP (caption
))
8132 caption
= menu_item_eval_property (caption
);
8133 if (!STRINGP (caption
))
8136 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8138 /* If the rest following the caption is not a list, the menu item is
8139 either a separator, or invalid. */
8143 if (menu_separator_name_p (SSDATA (caption
)))
8145 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8146 #if !defined (USE_GTK) && !defined (HAVE_NS)
8147 /* If we use build_desired_tool_bar_string to render the
8148 tool bar, the separator is rendered as an image. */
8149 set_prop (TOOL_BAR_ITEM_IMAGES
,
8150 (menu_item_eval_property
8151 (Vtool_bar_separator_image_expression
)));
8152 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8153 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8154 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8161 /* Store the binding. */
8162 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8165 /* Ignore cached key binding, if any. */
8166 if (CONSP (item
) && CONSP (XCAR (item
)))
8169 /* Process the rest of the properties. */
8170 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8172 Lisp_Object ikey
, value
;
8175 value
= XCAR (XCDR (item
));
8177 if (EQ (ikey
, QCenable
))
8179 /* `:enable FORM'. */
8180 if (!NILP (Venable_disabled_menus_and_buttons
))
8181 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8183 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8185 else if (EQ (ikey
, QCvisible
))
8187 /* `:visible FORM'. If got a visible property and that
8188 evaluates to nil then ignore this item. */
8189 if (NILP (menu_item_eval_property (value
)))
8192 else if (EQ (ikey
, QChelp
))
8193 /* `:help HELP-STRING'. */
8194 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8195 else if (EQ (ikey
, QCvert_only
))
8196 /* `:vert-only t/nil'. */
8197 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8198 else if (EQ (ikey
, QClabel
))
8200 const char *bad_label
= "!!?GARBLED ITEM?!!";
8201 /* `:label LABEL-STRING'. */
8202 set_prop (TOOL_BAR_ITEM_LABEL
,
8203 STRINGP (value
) ? value
: build_string (bad_label
));
8206 else if (EQ (ikey
, QCfilter
))
8207 /* ':filter FORM'. */
8209 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8211 /* `:button (TYPE . SELECTED)'. */
8212 Lisp_Object type
, selected
;
8214 type
= XCAR (value
);
8215 selected
= XCDR (value
);
8216 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8218 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8219 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8222 else if (EQ (ikey
, QCimage
)
8224 || (VECTORP (value
) && ASIZE (value
) == 4)))
8225 /* Value is either a single image specification or a vector
8226 of 4 such specifications for the different button states. */
8227 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8228 else if (EQ (ikey
, QCrtl
))
8230 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8236 /* Try to make one from caption and key. */
8237 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8238 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8239 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8240 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8242 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8243 char *buf
= xmalloc (max_lbl
+ 1);
8244 Lisp_Object new_lbl
;
8245 ptrdiff_t caption_len
= strlen (capt
);
8247 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8250 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8252 buf
[caption_len
] = '\0';
8256 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8260 strcpy (buf
, label
);
8262 for (j
= 0; buf
[j
] != '\0'; ++j
)
8270 new_lbl
= Fupcase_initials (build_string (label
));
8271 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8272 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8274 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8278 /* If got a filter apply it on binding. */
8280 set_prop (TOOL_BAR_ITEM_BINDING
,
8281 (menu_item_eval_property
8284 PROP (TOOL_BAR_ITEM_BINDING
))))));
8286 /* See if the binding is a keymap. Give up if it is. */
8287 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8290 /* Enable or disable selection of item. */
8291 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8292 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8293 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8295 /* Handle radio buttons or toggle boxes. */
8296 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8297 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8298 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8306 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8307 that can be reused. */
8310 init_tool_bar_items (Lisp_Object reuse
)
8312 if (VECTORP (reuse
))
8313 tool_bar_items_vector
= reuse
;
8315 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8316 ntool_bar_items
= 0;
8320 /* Append parsed tool bar item properties from
8321 tool_bar_item_properties */
8324 append_tool_bar_item (void)
8328 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8330 /* Enlarge tool_bar_items_vector if necessary. */
8332 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8334 /* Append entries from tool_bar_item_properties to the end of
8335 tool_bar_items_vector. */
8336 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8337 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8338 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8345 /* Read a character using menus based on the keymap MAP.
8346 Return nil if there are no menus in the maps.
8347 Return t if we displayed a menu but the user rejected it.
8349 PREV_EVENT is the previous input event, or nil if we are reading
8350 the first event of a key sequence.
8352 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8353 if we used a mouse menu to read the input, or false otherwise. If
8354 USED_MOUSE_MENU is null, don't dereference it.
8356 The prompting is done based on the prompt-string of the map
8357 and the strings associated with various map elements.
8359 This can be done with X menus or with menus put in the minibuf.
8360 These are done in different ways, depending on how the input will be read.
8361 Menus using X are done after auto-saving in read-char, getting the input
8362 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8363 and do auto-saving in the inner call of read_char. */
8366 read_char_x_menu_prompt (Lisp_Object map
,
8367 Lisp_Object prev_event
, bool *used_mouse_menu
)
8369 if (used_mouse_menu
)
8370 *used_mouse_menu
= 0;
8372 /* Use local over global Menu maps. */
8374 if (! menu_prompting
)
8377 /* If we got to this point via a mouse click,
8378 use a real menu for mouse selection. */
8379 if (EVENT_HAS_PARAMETERS (prev_event
)
8380 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8381 && !EQ (XCAR (prev_event
), Qtool_bar
))
8383 /* Display the menu and get the selection. */
8386 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8391 record_menu_key (XCAR (value
));
8393 /* If we got multiple events, unread all but
8395 There is no way to prevent those unread events
8396 from showing up later in last_nonmenu_event.
8397 So turn symbol and integer events into lists,
8398 to indicate that they came from a mouse menu,
8399 so that when present in last_nonmenu_event
8400 they won't confuse things. */
8401 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8403 record_menu_key (XCAR (tem
));
8404 if (SYMBOLP (XCAR (tem
))
8405 || INTEGERP (XCAR (tem
)))
8406 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8409 /* If we got more than one event, put all but the first
8410 onto this list to be read later.
8411 Return just the first event now. */
8412 Vunread_command_events
8413 = nconc2 (XCDR (value
), Vunread_command_events
);
8414 value
= XCAR (value
);
8416 else if (NILP (value
))
8418 if (used_mouse_menu
)
8419 *used_mouse_menu
= 1;
8426 read_char_minibuf_menu_prompt (int commandflag
,
8429 register Lisp_Object name
;
8431 /* FIXME: Use the minibuffer's frame width. */
8432 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8434 bool nobindings
= 1;
8435 Lisp_Object rest
, vector
;
8436 Lisp_Object prompt_strings
= Qnil
;
8440 if (! menu_prompting
)
8443 map
= get_keymap (map
, 0, 1);
8444 name
= Fkeymap_prompt (map
);
8446 /* If we don't have any menus, just read a character normally. */
8447 if (!STRINGP (name
))
8450 #define PUSH_C_STR(str, listvar) \
8451 listvar = Fcons (build_unibyte_string (str), listvar)
8453 /* Prompt string always starts with map's prompt, and a space. */
8454 prompt_strings
= Fcons (name
, prompt_strings
);
8455 PUSH_C_STR (": ", prompt_strings
);
8456 nlength
= SCHARS (name
) + 2;
8460 /* Present the documented bindings, a line at a time. */
8464 Lisp_Object menu_strings
= prompt_strings
;
8465 ptrdiff_t i
= nlength
;
8467 Lisp_Object orig_defn_macro
;
8469 /* Loop over elements of map. */
8474 /* FIXME: Use map_keymap to handle new keymap formats. */
8476 /* At end of map, wrap around if just starting,
8477 or end this line if already have something on it. */
8480 if (notfirst
|| nobindings
)
8486 /* Look at the next element of the map. */
8488 elt
= AREF (vector
, idx
);
8490 elt
= Fcar_safe (rest
);
8492 if (idx
< 0 && VECTORP (elt
))
8494 /* If we found a dense table in the keymap,
8495 advanced past it, but start scanning its contents. */
8496 rest
= Fcdr_safe (rest
);
8502 /* An ordinary element. */
8503 Lisp_Object event
, tem
;
8507 event
= Fcar_safe (elt
); /* alist */
8508 elt
= Fcdr_safe (elt
);
8512 XSETINT (event
, idx
); /* vector */
8515 /* Ignore the element if it has no prompt string. */
8516 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8518 /* True if the char to type matches the string. */
8520 Lisp_Object upcased_event
, downcased_event
;
8521 Lisp_Object desc
= Qnil
;
8523 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8525 upcased_event
= Fupcase (event
);
8526 downcased_event
= Fdowncase (event
);
8527 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8528 || XINT (downcased_event
) == SREF (s
, 0));
8530 desc
= Fsingle_key_description (event
, Qnil
);
8532 #if 0 /* It is redundant to list the equivalent key bindings because
8533 the prefix is what the user has already typed. */
8535 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8537 /* Insert equivalent keybinding. */
8538 s
= concat2 (s
, tem
);
8541 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8542 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8544 /* Insert button prefix. */
8545 Lisp_Object selected
8546 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8547 if (EQ (tem
, QCradio
))
8548 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8550 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8551 s
= concat2 (tem
, s
);
8555 /* If we have room for the prompt string, add it to this line.
8556 If this is the first on the line, always add it. */
8557 if ((SCHARS (s
) + i
+ 2
8558 + (char_matches
? 0 : SCHARS (desc
) + 3))
8562 ptrdiff_t thiswidth
;
8564 /* Punctuate between strings. */
8567 PUSH_C_STR (", ", menu_strings
);
8573 /* If the char to type doesn't match the string's
8574 first char, explicitly show what char to type. */
8577 /* Add as much of string as fits. */
8578 thiswidth
= min (SCHARS (desc
), width
- i
);
8580 = Fcons (Fsubstring (desc
, make_number (0),
8581 make_number (thiswidth
)),
8584 PUSH_C_STR (" = ", menu_strings
);
8588 /* Add as much of string as fits. */
8589 thiswidth
= min (SCHARS (s
), width
- i
);
8591 = Fcons (Fsubstring (s
, make_number (0),
8592 make_number (thiswidth
)),
8598 /* If this element does not fit, end the line now,
8599 and save the element for the next line. */
8600 PUSH_C_STR ("...", menu_strings
);
8605 /* Move past this element. */
8606 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8607 /* Handle reaching end of dense table. */
8612 rest
= Fcdr_safe (rest
);
8616 /* Prompt with that and read response. */
8617 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8619 /* Make believe it's not a keyboard macro in case the help char
8620 is pressed. Help characters are not recorded because menu prompting
8621 is not used on replay. */
8622 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8623 kset_defining_kbd_macro (current_kboard
, Qnil
);
8625 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8626 while (BUFFERP (obj
));
8627 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8629 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8632 if (! EQ (obj
, menu_prompt_more_char
)
8633 && (!INTEGERP (menu_prompt_more_char
)
8634 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8636 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8637 store_kbd_macro_char (obj
);
8640 /* Help char - go round again. */
8644 /* Reading key sequences. */
8647 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8649 return access_keymap (get_keymap (keymap
, 0, 1),
8654 active_maps (Lisp_Object first_event
)
8656 Lisp_Object position
8657 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8658 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8661 /* Structure used to keep track of partial application of key remapping
8662 such as Vfunction_key_map and Vkey_translation_map. */
8663 typedef struct keyremap
8665 /* This is the map originally specified for this use. */
8667 /* This is a submap reached by looking up, in PARENT,
8668 the events from START to END. */
8670 /* Positions [START, END) in the key sequence buffer
8671 are the key that we have scanned so far.
8672 Those events are the ones that we will replace
8673 if PARENT maps them into a key sequence. */
8677 /* Lookup KEY in MAP.
8678 MAP is a keymap mapping keys to key vectors or functions.
8679 If the mapping is a function and DO_FUNCALL is true,
8680 the function is called with PROMPT as parameter and its return
8681 value is used as the return value of this function (after checking
8682 that it is indeed a vector). */
8685 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8690 next
= access_keymap (map
, key
, 1, 0, 1);
8692 /* Handle a symbol whose function definition is a keymap
8694 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8695 && (ARRAYP (XSYMBOL (next
)->function
)
8696 || KEYMAPP (XSYMBOL (next
)->function
)))
8697 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8699 /* If the keymap gives a function, not an
8700 array, then call the function with one arg and use
8701 its value instead. */
8702 if (do_funcall
&& FUNCTIONP (next
))
8707 next
= call1 (next
, prompt
);
8708 /* If the function returned something invalid,
8709 barf--don't ignore it.
8710 (To ignore it safely, we would need to gcpro a bunch of
8711 other variables.) */
8712 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8713 error ("Function %s returns invalid key sequence",
8714 SSDATA (SYMBOL_NAME (tem
)));
8719 /* Do one step of the key remapping used for function-key-map and
8720 key-translation-map:
8721 KEYBUF is the buffer holding the input events.
8722 BUFSIZE is its maximum size.
8723 FKEY is a pointer to the keyremap structure to use.
8724 INPUT is the index of the last element in KEYBUF.
8725 DOIT if true says that the remapping can actually take place.
8726 DIFF is used to return the number of keys added/removed by the remapping.
8727 PARENT is the root of the keymap.
8728 PROMPT is the prompt to use if the remapping happens through a function.
8729 Return true if the remapping actually took place. */
8732 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8733 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8735 Lisp_Object next
, key
;
8737 key
= keybuf
[fkey
->end
++];
8739 if (KEYMAPP (fkey
->parent
))
8740 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8744 /* If keybuf[fkey->start..fkey->end] is bound in the
8745 map and we're in a position to do the key remapping, replace it with
8746 the binding and restart with fkey->start at the end. */
8747 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8749 int len
= XFASTINT (Flength (next
));
8752 *diff
= len
- (fkey
->end
- fkey
->start
);
8754 if (bufsize
- input
<= *diff
)
8755 error ("Key sequence too long");
8757 /* Shift the keys that follow fkey->end. */
8759 for (i
= fkey
->end
; i
< input
; i
++)
8760 keybuf
[i
+ *diff
] = keybuf
[i
];
8762 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8763 keybuf
[i
+ *diff
] = keybuf
[i
];
8764 /* Overwrite the old keys with the new ones. */
8765 for (i
= 0; i
< len
; i
++)
8766 keybuf
[fkey
->start
+ i
]
8767 = Faref (next
, make_number (i
));
8769 fkey
->start
= fkey
->end
+= *diff
;
8770 fkey
->map
= fkey
->parent
;
8775 fkey
->map
= get_keymap (next
, 0, 1);
8777 /* If we no longer have a bound suffix, try a new position for
8779 if (!CONSP (fkey
->map
))
8781 fkey
->end
= ++fkey
->start
;
8782 fkey
->map
= fkey
->parent
;
8788 test_undefined (Lisp_Object binding
)
8790 return (NILP (binding
)
8791 || EQ (binding
, Qundefined
)
8792 || (SYMBOLP (binding
)
8793 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8796 /* Read a sequence of keys that ends with a non prefix character,
8797 storing it in KEYBUF, a buffer of size BUFSIZE.
8799 Return the length of the key sequence stored.
8800 Return -1 if the user rejected a command menu.
8802 Echo starting immediately unless `prompt' is 0.
8804 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8805 read_char with a suitable COMMANDFLAG argument.
8807 Where a key sequence ends depends on the currently active keymaps.
8808 These include any minor mode keymaps active in the current buffer,
8809 the current buffer's local map, and the global map.
8811 If a key sequence has no other bindings, we check Vfunction_key_map
8812 to see if some trailing subsequence might be the beginning of a
8813 function key's sequence. If so, we try to read the whole function
8814 key, and substitute its symbolic name into the key sequence.
8816 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8817 `double-' events into similar click events, if that would make them
8818 bound. We try to turn `triple-' events first into `double-' events,
8821 If we get a mouse click in a mode line, vertical divider, or other
8822 non-text area, we treat the click as if it were prefixed by the
8823 symbol denoting that area - `mode-line', `vertical-line', or
8826 If the sequence starts with a mouse click, we read the key sequence
8827 with respect to the buffer clicked on, not the current buffer.
8829 If the user switches frames in the midst of a key sequence, we put
8830 off the switch-frame event until later; the next call to
8831 read_char will return it.
8833 If FIX_CURRENT_BUFFER, we restore current_buffer
8834 from the selected window's buffer. */
8837 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8838 bool dont_downcase_last
, bool can_return_switch_frame
,
8839 bool fix_current_buffer
, bool prevent_redisplay
)
8841 ptrdiff_t count
= SPECPDL_INDEX ();
8843 /* How many keys there are in the current key sequence. */
8846 /* The length of the echo buffer when we started reading, and
8847 the length of this_command_keys when we started reading. */
8848 ptrdiff_t echo_start
IF_LINT (= 0);
8849 ptrdiff_t keys_start
;
8851 Lisp_Object current_binding
= Qnil
;
8852 Lisp_Object first_event
= Qnil
;
8854 /* Index of the first key that has no binding.
8855 It is useless to try fkey.start larger than that. */
8858 /* If t < mock_input, then KEYBUF[t] should be read as the next
8861 We use this to recover after recognizing a function key. Once we
8862 realize that a suffix of the current key sequence is actually a
8863 function key's escape sequence, we replace the suffix with the
8864 function key's binding from Vfunction_key_map. Now keybuf
8865 contains a new and different key sequence, so the echo area,
8866 this_command_keys, and the submaps and defs arrays are wrong. In
8867 this situation, we set mock_input to t, set t to 0, and jump to
8868 restart_sequence; the loop will read keys from keybuf up until
8869 mock_input, thus rebuilding the state; and then it will resume
8870 reading characters from the keyboard. */
8873 /* If the sequence is unbound in submaps[], then
8874 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8875 and fkey.map is its binding.
8877 These might be > t, indicating that all function key scanning
8878 should hold off until t reaches them. We do this when we've just
8879 recognized a function key, to avoid searching for the function
8880 key's again in Vfunction_key_map. */
8883 /* Likewise, for key_translation_map and input-decode-map. */
8884 keyremap keytran
, indec
;
8886 /* True if we are trying to map a key by changing an upper-case
8887 letter to lower case, or a shifted function key to an unshifted
8889 bool shift_translated
= 0;
8891 /* If we receive a `switch-frame' or `select-window' event in the middle of
8892 a key sequence, we put it off for later.
8893 While we're reading, we keep the event here. */
8894 Lisp_Object delayed_switch_frame
;
8896 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8897 int original_uppercase_position
= -1;
8899 /* Gets around Microsoft compiler limitations. */
8902 struct buffer
*starting_buffer
;
8904 /* List of events for which a fake prefix key has been generated. */
8905 Lisp_Object fake_prefixed_keys
= Qnil
;
8907 struct gcpro gcpro1
;
8909 GCPRO1 (fake_prefixed_keys
);
8910 raw_keybuf_count
= 0;
8912 last_nonmenu_event
= Qnil
;
8914 delayed_switch_frame
= Qnil
;
8920 /* Install the string PROMPT as the beginning of the string
8921 of echoing, so that it serves as a prompt for the next
8923 kset_echo_string (current_kboard
, prompt
);
8924 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8927 else if (cursor_in_echo_area
8928 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8929 && NILP (Fzerop (Vecho_keystrokes
)))
8930 /* This doesn't put in a dash if the echo buffer is empty, so
8931 you don't always see a dash hanging out in the minibuffer. */
8935 /* Record the initial state of the echo area and this_command_keys;
8936 we will need to restore them if we replay a key sequence. */
8938 echo_start
= echo_length ();
8939 keys_start
= this_command_key_count
;
8940 this_single_command_key_start
= keys_start
;
8942 /* We jump here when we need to reinitialize fkey and keytran; this
8943 happens if we switch keyboards between rescans. */
8944 replay_entire_sequence
:
8946 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8947 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8948 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8949 indec
.start
= indec
.end
= 0;
8950 fkey
.start
= fkey
.end
= 0;
8951 keytran
.start
= keytran
.end
= 0;
8953 /* We jump here when the key sequence has been thoroughly changed, and
8954 we need to rescan it starting from the beginning. When we jump here,
8955 keybuf[0..mock_input] holds the sequence we should reread. */
8958 starting_buffer
= current_buffer
;
8959 first_unbound
= bufsize
+ 1;
8961 /* Build our list of keymaps.
8962 If we recognize a function key and replace its escape sequence in
8963 keybuf with its symbol, or if the sequence starts with a mouse
8964 click and we need to switch buffers, we jump back here to rebuild
8965 the initial keymaps from the current buffer. */
8966 current_binding
= active_maps (first_event
);
8968 /* Start from the beginning in keybuf. */
8971 /* These are no-ops the first time through, but if we restart, they
8972 revert the echo area and this_command_keys to their original state. */
8973 this_command_key_count
= keys_start
;
8974 if (INTERACTIVE
&& t
< mock_input
)
8975 echo_truncate (echo_start
);
8977 /* If the best binding for the current key sequence is a keymap, or
8978 we may be looking at a function key's escape sequence, keep on
8980 while (!NILP (current_binding
)
8981 /* Keep reading as long as there's a prefix binding. */
8982 ? KEYMAPP (current_binding
)
8983 /* Don't return in the middle of a possible function key sequence,
8984 if the only bindings we found were via case conversion.
8985 Thus, if ESC O a has a function-key-map translation
8986 and ESC o has a binding, don't return after ESC O,
8987 so that we can translate ESC O plus the next character. */
8988 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8991 bool used_mouse_menu
= 0;
8993 /* Where the last real key started. If we need to throw away a
8994 key that has expanded into more than one element of keybuf
8995 (say, a mouse click on the mode line which is being treated
8996 as [mode-line (mouse-...)], then we backtrack to this point
8998 int last_real_key_start
;
9000 /* These variables are analogous to echo_start and keys_start;
9001 while those allow us to restart the entire key sequence,
9002 echo_local_start and keys_local_start allow us to throw away
9004 ptrdiff_t echo_local_start
IF_LINT (= 0);
9005 int keys_local_start
;
9006 Lisp_Object new_binding
;
9008 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9009 eassert (indec
.start
<= indec
.end
);
9010 eassert (fkey
.start
<= fkey
.end
);
9011 eassert (keytran
.start
<= keytran
.end
);
9012 /* key-translation-map is applied *after* function-key-map
9013 which is itself applied *after* input-decode-map. */
9014 eassert (fkey
.end
<= indec
.start
);
9015 eassert (keytran
.end
<= fkey
.start
);
9017 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9018 first_unbound
< keytran
.start
)
9019 { /* The prefix upto first_unbound has no binding and has
9020 no translation left to do either, so we know it's unbound.
9021 If we don't stop now, we risk staying here indefinitely
9022 (if the user keeps entering fkey or keytran prefixes
9023 like C-c ESC ESC ESC ESC ...) */
9025 for (i
= first_unbound
+ 1; i
< t
; i
++)
9026 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9027 mock_input
= t
- first_unbound
- 1;
9028 indec
.end
= indec
.start
-= first_unbound
+ 1;
9029 indec
.map
= indec
.parent
;
9030 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9031 fkey
.map
= fkey
.parent
;
9032 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9033 keytran
.map
= keytran
.parent
;
9034 goto replay_sequence
;
9038 error ("Key sequence too long");
9041 echo_local_start
= echo_length ();
9042 keys_local_start
= this_command_key_count
;
9045 /* These are no-ops, unless we throw away a keystroke below and
9046 jumped back up to replay_key; in that case, these restore the
9047 variables to their original state, allowing us to replay the
9049 if (INTERACTIVE
&& t
< mock_input
)
9050 echo_truncate (echo_local_start
);
9051 this_command_key_count
= keys_local_start
;
9053 /* By default, assume each event is "real". */
9054 last_real_key_start
= t
;
9056 /* Does mock_input indicate that we are re-reading a key sequence? */
9060 add_command_key (key
);
9061 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9062 && NILP (Fzerop (Vecho_keystrokes
))
9063 && current_kboard
->immediate_echo
)
9070 /* If not, we should actually read a character. */
9074 KBOARD
*interrupted_kboard
= current_kboard
;
9075 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9076 /* Calling read_char with COMMANDFLAG = -2 avoids
9077 redisplay in read_char and its subroutines. */
9078 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9079 current_binding
, last_nonmenu_event
,
9080 &used_mouse_menu
, NULL
);
9081 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9082 /* When switching to a new tty (with a new keyboard),
9083 read_char returns the new buffer, rather than -2
9084 (Bug#5095). This is because `terminal-init-xterm'
9085 calls read-char, which eats the wrong_kboard_jmpbuf
9086 return. Any better way to fix this? -- cyd */
9087 || (interrupted_kboard
!= current_kboard
))
9092 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9093 if (k
== interrupted_kboard
)
9098 /* Don't touch interrupted_kboard when it's been
9100 delayed_switch_frame
= Qnil
;
9101 goto replay_entire_sequence
;
9104 if (!NILP (delayed_switch_frame
))
9107 (interrupted_kboard
,
9108 Fcons (delayed_switch_frame
,
9109 KVAR (interrupted_kboard
, kbd_queue
)));
9110 delayed_switch_frame
= Qnil
;
9115 (interrupted_kboard
,
9116 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9118 /* If the side queue is non-empty, ensure it begins with a
9119 switch-frame, so we'll replay it in the right context. */
9120 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9121 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9122 !(EVENT_HAS_PARAMETERS (key
)
9123 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9127 XSETFRAME (frame
, interrupted_frame
);
9129 (interrupted_kboard
,
9130 Fcons (make_lispy_switch_frame (frame
),
9131 KVAR (interrupted_kboard
, kbd_queue
)));
9134 goto replay_entire_sequence
;
9138 /* read_char returns t when it shows a menu and the user rejects it.
9142 unbind_to (count
, Qnil
);
9147 /* read_char returns -1 at the end of a macro.
9148 Emacs 18 handles this by returning immediately with a
9149 zero, so that's what we'll do. */
9150 if (INTEGERP (key
) && XINT (key
) == -1)
9153 /* The Microsoft C compiler can't handle the goto that
9159 /* If the current buffer has been changed from under us, the
9160 keymap may have changed, so replay the sequence. */
9163 timer_resume_idle ();
9166 /* Reset the current buffer from the selected window
9167 in case something changed the former and not the latter.
9168 This is to be more consistent with the behavior
9169 of the command_loop_1. */
9170 if (fix_current_buffer
)
9172 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9174 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9176 Fset_buffer (XWINDOW (selected_window
)->contents
);
9179 goto replay_sequence
;
9182 /* If we have a quit that was typed in another frame, and
9183 quit_throw_to_read_char switched buffers,
9184 replay to get the right keymap. */
9186 && XINT (key
) == quit_char
9187 && current_buffer
!= starting_buffer
)
9190 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9195 goto replay_sequence
;
9200 if (EVENT_HAS_PARAMETERS (key
)
9201 /* Either a `switch-frame' or a `select-window' event. */
9202 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9204 /* If we're at the beginning of a key sequence, and the caller
9205 says it's okay, go ahead and return this event. If we're
9206 in the midst of a key sequence, delay it until the end. */
9207 if (t
> 0 || !can_return_switch_frame
)
9209 delayed_switch_frame
= key
;
9214 if (NILP (first_event
))
9217 /* Even if first_event does not specify a particular
9218 window/position, it's important to recompute the maps here
9219 since a long time might have passed since we entered
9220 read_key_sequence, and a timer (or process-filter or
9221 special-event-map, ...) might have switched the current buffer
9222 or the selected window from under us in the mean time. */
9223 if (fix_current_buffer
9224 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9226 Fset_buffer (XWINDOW (selected_window
)->contents
);
9227 current_binding
= active_maps (first_event
);
9231 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9235 /* Clicks in non-text areas get prefixed by the symbol
9236 in their CHAR-ADDRESS field. For example, a click on
9237 the mode line is prefixed by the symbol `mode-line'.
9239 Furthermore, key sequences beginning with mouse clicks
9240 are read using the keymaps of the buffer clicked on, not
9241 the current buffer. So we may have to switch the buffer
9244 When we turn one event into two events, we must make sure
9245 that neither of the two looks like the original--so that,
9246 if we replay the events, they won't be expanded again.
9247 If not for this, such reexpansion could happen either here
9248 or when user programs play with this-command-keys. */
9249 if (EVENT_HAS_PARAMETERS (key
))
9251 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9252 if (EQ (kind
, Qmouse_click
))
9254 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9255 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9258 || (!NILP (fake_prefixed_keys
)
9259 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9261 /* We're looking a second time at an event for which
9262 we generated a fake prefix key. Set
9263 last_real_key_start appropriately. */
9265 last_real_key_start
= t
- 1;
9268 if (last_real_key_start
== 0)
9270 /* Key sequences beginning with mouse clicks are
9271 read using the keymaps in the buffer clicked on,
9272 not the current buffer. If we're at the
9273 beginning of a key sequence, switch buffers. */
9274 if (WINDOWP (window
)
9275 && BUFFERP (XWINDOW (window
)->contents
)
9276 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9278 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9283 /* Arrange to go back to the original buffer once we're
9284 done reading the key sequence. Note that we can't
9285 use save_excursion_{save,restore} here, because they
9286 save point as well as the current buffer; we don't
9287 want to save point, because redisplay may change it,
9288 to accommodate a Fset_window_start or something. We
9289 don't want to do this at the top of the function,
9290 because we may get input from a subprocess which
9291 wants to change the selected window and stuff (say,
9293 record_unwind_current_buffer ();
9295 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9297 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9298 goto replay_sequence
;
9302 /* Expand mode-line and scroll-bar events into two events:
9303 use posn as a fake prefix key. */
9305 && (NILP (fake_prefixed_keys
)
9306 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9308 if (bufsize
- t
<= 1)
9309 error ("Key sequence too long");
9312 keybuf
[t
+ 1] = key
;
9315 /* Record that a fake prefix key has been generated
9316 for KEY. Don't modify the event; this would
9317 prevent proper action when the event is pushed
9318 back into unread-command-events. */
9319 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9323 else if (CONSP (XCDR (key
))
9324 && CONSP (EVENT_START (key
))
9325 && CONSP (XCDR (EVENT_START (key
))))
9329 posn
= POSN_POSN (EVENT_START (key
));
9330 /* Handle menu-bar events:
9331 insert the dummy prefix event `menu-bar'. */
9332 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9334 if (bufsize
- t
<= 1)
9335 error ("Key sequence too long");
9337 keybuf
[t
+ 1] = key
;
9339 /* Zap the position in key, so we know that we've
9340 expanded it, and don't try to do so again. */
9341 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9344 goto replay_sequence
;
9346 else if (CONSP (posn
))
9348 /* We're looking at the second event of a
9349 sequence which we expanded before. Set
9350 last_real_key_start appropriately. */
9351 if (last_real_key_start
== t
&& t
> 0)
9352 last_real_key_start
= t
- 1;
9357 /* We have finally decided that KEY is something we might want
9359 new_binding
= follow_key (current_binding
, key
);
9361 /* If KEY wasn't bound, we'll try some fallbacks. */
9362 if (!NILP (new_binding
))
9363 /* This is needed for the following scenario:
9364 event 0: a down-event that gets dropped by calling replay_key.
9365 event 1: some normal prefix like C-h.
9366 After event 0, first_unbound is 0, after event 1 indec.start,
9367 fkey.start, and keytran.start are all 1, so when we see that
9368 C-h is bound, we need to update first_unbound. */
9369 first_unbound
= max (t
+ 1, first_unbound
);
9374 /* Remember the position to put an upper bound on indec.start. */
9375 first_unbound
= min (t
, first_unbound
);
9377 head
= EVENT_HEAD (key
);
9378 if (help_char_p (head
) && t
> 0)
9380 read_key_sequence_cmd
= Vprefix_help_command
;
9382 last_nonmenu_event
= key
;
9383 /* The Microsoft C compiler can't handle the goto that
9391 Lisp_Object breakdown
;
9394 breakdown
= parse_modifiers (head
);
9395 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9396 /* Attempt to reduce an unbound mouse event to a simpler
9397 event that is bound:
9398 Drags reduce to clicks.
9399 Double-clicks reduce to clicks.
9400 Triple-clicks reduce to double-clicks, then to clicks.
9401 Down-clicks are eliminated.
9402 Double-downs reduce to downs, then are eliminated.
9403 Triple-downs reduce to double-downs, then to downs,
9404 then are eliminated. */
9405 if (modifiers
& (down_modifier
| drag_modifier
9406 | double_modifier
| triple_modifier
))
9408 while (modifiers
& (down_modifier
| drag_modifier
9409 | double_modifier
| triple_modifier
))
9411 Lisp_Object new_head
, new_click
;
9412 if (modifiers
& triple_modifier
)
9413 modifiers
^= (double_modifier
| triple_modifier
);
9414 else if (modifiers
& double_modifier
)
9415 modifiers
&= ~double_modifier
;
9416 else if (modifiers
& drag_modifier
)
9417 modifiers
&= ~drag_modifier
;
9420 /* Dispose of this `down' event by simply jumping
9421 back to replay_key, to get another event.
9423 Note that if this event came from mock input,
9424 then just jumping back to replay_key will just
9425 hand it to us again. So we have to wipe out any
9428 We could delete keybuf[t] and shift everything
9429 after that to the left by one spot, but we'd also
9430 have to fix up any variable that points into
9431 keybuf, and shifting isn't really necessary
9434 Adding prefixes for non-textual mouse clicks
9435 creates two characters of mock input, and both
9436 must be thrown away. If we're only looking at
9437 the prefix now, we can just jump back to
9438 replay_key. On the other hand, if we've already
9439 processed the prefix, and now the actual click
9440 itself is giving us trouble, then we've lost the
9441 state of the keymaps we want to backtrack to, and
9442 we need to replay the whole sequence to rebuild
9445 Beyond that, only function key expansion could
9446 create more than two keys, but that should never
9447 generate mouse events, so it's okay to zero
9448 mock_input in that case too.
9450 FIXME: The above paragraph seems just plain
9451 wrong, if you consider things like
9452 xterm-mouse-mode. -stef
9454 Isn't this just the most wonderful code ever? */
9456 /* If mock_input > t + 1, the above simplification
9457 will actually end up dropping keys on the floor.
9458 This is probably OK for now, but even
9459 if mock_input <= t + 1, we need to adjust indec,
9461 Typical case [header-line down-mouse-N]:
9462 mock_input = 2, t = 1, fkey.end = 1,
9463 last_real_key_start = 0. */
9464 if (indec
.end
> last_real_key_start
)
9466 indec
.end
= indec
.start
9467 = min (last_real_key_start
, indec
.start
);
9468 indec
.map
= indec
.parent
;
9469 if (fkey
.end
> last_real_key_start
)
9471 fkey
.end
= fkey
.start
9472 = min (last_real_key_start
, fkey
.start
);
9473 fkey
.map
= fkey
.parent
;
9474 if (keytran
.end
> last_real_key_start
)
9476 keytran
.end
= keytran
.start
9477 = min (last_real_key_start
, keytran
.start
);
9478 keytran
.map
= keytran
.parent
;
9482 if (t
== last_real_key_start
)
9489 mock_input
= last_real_key_start
;
9490 goto replay_sequence
;
9495 = apply_modifiers (modifiers
, XCAR (breakdown
));
9496 new_click
= list2 (new_head
, EVENT_START (key
));
9498 /* Look for a binding for this new key. */
9499 new_binding
= follow_key (current_binding
, new_click
);
9501 /* If that click is bound, go for it. */
9502 if (!NILP (new_binding
))
9504 current_binding
= new_binding
;
9508 /* Otherwise, we'll leave key set to the drag event. */
9513 current_binding
= new_binding
;
9516 /* Normally, last_nonmenu_event gets the previous key we read.
9517 But when a mouse popup menu is being used,
9518 we don't update last_nonmenu_event; it continues to hold the mouse
9519 event that preceded the first level of menu. */
9520 if (!used_mouse_menu
)
9521 last_nonmenu_event
= key
;
9523 /* Record what part of this_command_keys is the current key sequence. */
9524 this_single_command_key_start
= this_command_key_count
- t
;
9526 /* Look for this sequence in input-decode-map.
9527 Scan from indec.end until we find a bound suffix. */
9528 while (indec
.end
< t
)
9530 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9534 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9535 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9540 mock_input
= diff
+ max (t
, mock_input
);
9541 goto replay_sequence
;
9545 if (!KEYMAPP (current_binding
)
9546 && !test_undefined (current_binding
)
9547 && indec
.start
>= t
)
9548 /* There is a binding and it's not a prefix.
9549 (and it doesn't have any input-decode-map translation pending).
9550 There is thus no function-key in this sequence.
9551 Moving fkey.start is important in this case to allow keytran.start
9552 to go over the sequence before we return (since we keep the
9553 invariant that keytran.end <= fkey.start). */
9556 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9559 /* If the sequence is unbound, see if we can hang a function key
9560 off the end of it. */
9561 /* Continue scan from fkey.end until we find a bound suffix. */
9562 while (fkey
.end
< indec
.start
)
9564 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9568 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9569 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9570 max (t
, mock_input
),
9571 /* If there's a binding (i.e.
9572 first_binding >= nmaps) we don't want
9573 to apply this function-key-mapping. */
9575 && (test_undefined (current_binding
)),
9580 mock_input
= diff
+ max (t
, mock_input
);
9581 /* Adjust the input-decode-map counters. */
9583 indec
.start
+= diff
;
9585 goto replay_sequence
;
9589 /* Look for this sequence in key-translation-map.
9590 Scan from keytran.end until we find a bound suffix. */
9591 while (keytran
.end
< fkey
.start
)
9593 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9597 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9598 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9603 mock_input
= diff
+ max (t
, mock_input
);
9604 /* Adjust the function-key-map and input-decode-map counters. */
9606 indec
.start
+= diff
;
9610 goto replay_sequence
;
9614 /* If KEY is not defined in any of the keymaps,
9615 and cannot be part of a function key or translation,
9616 and is an upper case letter
9617 use the corresponding lower-case letter instead. */
9618 if (NILP (current_binding
)
9619 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9621 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9622 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9623 || (XINT (key
) & shift_modifier
)))
9625 Lisp_Object new_key
;
9627 original_uppercase
= key
;
9628 original_uppercase_position
= t
- 1;
9630 if (XINT (key
) & shift_modifier
)
9631 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9633 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9634 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9636 /* We have to do this unconditionally, regardless of whether
9637 the lower-case char is defined in the keymaps, because they
9638 might get translated through function-key-map. */
9639 keybuf
[t
- 1] = new_key
;
9640 mock_input
= max (t
, mock_input
);
9641 shift_translated
= 1;
9643 goto replay_sequence
;
9645 /* If KEY is not defined in any of the keymaps,
9646 and cannot be part of a function key or translation,
9647 and is a shifted function key,
9648 use the corresponding unshifted function key instead. */
9649 if (NILP (current_binding
)
9650 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9652 Lisp_Object breakdown
= parse_modifiers (key
);
9654 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9656 if (modifiers
& shift_modifier
9657 /* Treat uppercase keys as shifted. */
9659 && (KEY_TO_CHAR (key
)
9660 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9661 && uppercasep (KEY_TO_CHAR (key
))))
9664 = (modifiers
& shift_modifier
9665 ? apply_modifiers (modifiers
& ~shift_modifier
,
9667 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9669 original_uppercase
= key
;
9670 original_uppercase_position
= t
- 1;
9672 /* We have to do this unconditionally, regardless of whether
9673 the lower-case char is defined in the keymaps, because they
9674 might get translated through function-key-map. */
9675 keybuf
[t
- 1] = new_key
;
9676 mock_input
= max (t
, mock_input
);
9677 /* Reset fkey (and consequently keytran) to apply
9678 function-key-map on the result, so that S-backspace is
9679 correctly mapped to DEL (via backspace). OTOH,
9680 input-decode-map doesn't need to go through it again. */
9681 fkey
.start
= fkey
.end
= 0;
9682 keytran
.start
= keytran
.end
= 0;
9683 shift_translated
= 1;
9685 goto replay_sequence
;
9690 read_key_sequence_cmd
= current_binding
;
9691 read_key_sequence_remapped
9692 /* Remap command through active keymaps.
9693 Do the remapping here, before the unbind_to so it uses the keymaps
9694 of the appropriate buffer. */
9695 = SYMBOLP (read_key_sequence_cmd
)
9696 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9699 unread_switch_frame
= delayed_switch_frame
;
9700 unbind_to (count
, Qnil
);
9702 /* Don't downcase the last character if the caller says don't.
9703 Don't downcase it if the result is undefined, either. */
9704 if ((dont_downcase_last
|| NILP (current_binding
))
9706 && t
- 1 == original_uppercase_position
)
9708 keybuf
[t
- 1] = original_uppercase
;
9709 shift_translated
= 0;
9712 if (shift_translated
)
9713 Vthis_command_keys_shift_translated
= Qt
;
9715 /* Occasionally we fabricate events, perhaps by expanding something
9716 according to function-key-map, or by adding a prefix symbol to a
9717 mouse click in the scroll bar or modeline. In this cases, return
9718 the entire generated key sequence, even if we hit an unbound
9719 prefix or a definition before the end. This means that you will
9720 be able to push back the event properly, and also means that
9721 read-key-sequence will always return a logical unit.
9724 for (; t
< mock_input
; t
++)
9726 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9727 && NILP (Fzerop (Vecho_keystrokes
)))
9728 echo_char (keybuf
[t
]);
9729 add_command_key (keybuf
[t
]);
9737 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9738 Lisp_Object dont_downcase_last
,
9739 Lisp_Object can_return_switch_frame
,
9740 Lisp_Object cmd_loop
, bool allow_string
)
9742 Lisp_Object keybuf
[30];
9744 struct gcpro gcpro1
;
9745 ptrdiff_t count
= SPECPDL_INDEX ();
9748 CHECK_STRING (prompt
);
9751 specbind (Qinput_method_exit_on_first_char
,
9752 (NILP (cmd_loop
) ? Qt
: Qnil
));
9753 specbind (Qinput_method_use_echo_area
,
9754 (NILP (cmd_loop
) ? Qt
: Qnil
));
9756 memset (keybuf
, 0, sizeof keybuf
);
9758 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9760 if (NILP (continue_echo
))
9762 this_command_key_count
= 0;
9763 this_command_key_count_reset
= 0;
9764 this_single_command_key_start
= 0;
9767 #ifdef HAVE_WINDOW_SYSTEM
9768 if (display_hourglass_p
)
9769 cancel_hourglass ();
9772 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9773 prompt
, ! NILP (dont_downcase_last
),
9774 ! NILP (can_return_switch_frame
), 0, 0);
9776 #if 0 /* The following is fine for code reading a key sequence and
9777 then proceeding with a lengthy computation, but it's not good
9778 for code reading keys in a loop, like an input method. */
9779 #ifdef HAVE_WINDOW_SYSTEM
9780 if (display_hourglass_p
)
9791 return unbind_to (count
,
9792 ((allow_string
? make_event_array
: Fvector
)
9796 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9797 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9798 The sequence is sufficient to specify a non-prefix command in the
9799 current local and global maps.
9801 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9802 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9803 as a continuation of the previous key.
9805 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9806 convert the last event to lower case. (Normally any upper case event
9807 is converted to lower case if the original event is undefined and the lower
9808 case equivalent is defined.) A non-nil value is appropriate for reading
9809 a key sequence to be defined.
9811 A C-g typed while in this function is treated like any other character,
9812 and `quit-flag' is not set.
9814 If the key sequence starts with a mouse click, then the sequence is read
9815 using the keymaps of the buffer of the window clicked in, not the buffer
9816 of the selected window as normal.
9818 `read-key-sequence' drops unbound button-down events, since you normally
9819 only care about the click or drag events which follow them. If a drag
9820 or multi-click event is unbound, but the corresponding click event would
9821 be bound, `read-key-sequence' turns the event into a click event at the
9822 drag's starting position. This means that you don't have to distinguish
9823 between click and drag, double, or triple events unless you want to.
9825 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9826 lines separating windows, and scroll bars with imaginary keys
9827 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9829 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9830 function will process a switch-frame event if the user switches frames
9831 before typing anything. If the user switches frames in the middle of a
9832 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9833 is nil, then the event will be put off until after the current key sequence.
9835 `read-key-sequence' checks `function-key-map' for function key
9836 sequences, where they wouldn't conflict with ordinary bindings. See
9837 `function-key-map' for more details.
9839 The optional fifth argument CMD-LOOP, if non-nil, means
9840 that this key sequence is being read by something that will
9841 read commands one after another. It should be nil if the caller
9842 will read just one key sequence. */)
9843 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9845 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9846 can_return_switch_frame
, cmd_loop
, true);
9849 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9850 Sread_key_sequence_vector
, 1, 5, 0,
9851 doc
: /* Like `read-key-sequence' but always return a vector. */)
9852 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9854 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9855 can_return_switch_frame
, cmd_loop
, false);
9858 /* Return true if input events are pending. */
9861 detect_input_pending (void)
9863 return input_pending
|| get_input_pending (0);
9866 /* Return true if input events other than mouse movements are
9870 detect_input_pending_ignore_squeezables (void)
9872 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9875 /* Return true if input events are pending, and run any pending timers. */
9878 detect_input_pending_run_timers (bool do_display
)
9880 unsigned old_timers_run
= timers_run
;
9883 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9885 if (old_timers_run
!= timers_run
&& do_display
)
9886 redisplay_preserve_echo_area (8);
9888 return input_pending
;
9891 /* This is called in some cases before a possible quit.
9892 It cases the next call to detect_input_pending to recompute input_pending.
9893 So calling this function unnecessarily can't do any harm. */
9896 clear_input_pending (void)
9901 /* Return true if there are pending requeued events.
9902 This isn't used yet. The hope is to make wait_reading_process_output
9903 call it, and return if it runs Lisp code that unreads something.
9904 The problem is, kbd_buffer_get_event needs to be fixed to know what
9905 to do in that case. It isn't trivial. */
9908 requeued_events_pending_p (void)
9910 return (!NILP (Vunread_command_events
));
9913 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9914 doc
: /* Return t if command input is currently available with no wait.
9915 Actually, the value is nil only if we can be sure that no input is available;
9916 if there is a doubt, the value is t.
9918 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9919 (Lisp_Object check_timers
)
9921 if (!NILP (Vunread_command_events
)
9922 || !NILP (Vunread_post_input_method_events
)
9923 || !NILP (Vunread_input_method_events
))
9926 /* Process non-user-visible events (Bug#10195). */
9927 process_special_events ();
9929 return (get_input_pending ((NILP (check_timers
)
9930 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9931 | READABLE_EVENTS_FILTER_EVENTS
)
9935 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9936 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9939 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9942 if (total_keys
< NUM_RECENT_KEYS
)
9943 return Fvector (total_keys
, keys
);
9946 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9947 vcopy (val
, 0, keys
+ recent_keys_index
,
9948 NUM_RECENT_KEYS
- recent_keys_index
);
9949 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9950 keys
, recent_keys_index
);
9955 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9956 doc
: /* Return the key sequence that invoked this command.
9957 However, if the command has called `read-key-sequence', it returns
9958 the last key sequence that has been read.
9959 The value is a string or a vector.
9961 See also `this-command-keys-vector'. */)
9964 return make_event_array (this_command_key_count
,
9965 XVECTOR (this_command_keys
)->contents
);
9968 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9969 doc
: /* Return the key sequence that invoked this command, as a vector.
9970 However, if the command has called `read-key-sequence', it returns
9971 the last key sequence that has been read.
9973 See also `this-command-keys'. */)
9976 return Fvector (this_command_key_count
,
9977 XVECTOR (this_command_keys
)->contents
);
9980 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9981 Sthis_single_command_keys
, 0, 0, 0,
9982 doc
: /* Return the key sequence that invoked this command.
9983 More generally, it returns the last key sequence read, either by
9984 the command loop or by `read-key-sequence'.
9985 Unlike `this-command-keys', this function's value
9986 does not include prefix arguments.
9987 The value is always a vector. */)
9990 return Fvector (this_command_key_count
9991 - this_single_command_key_start
,
9992 (XVECTOR (this_command_keys
)->contents
9993 + this_single_command_key_start
));
9996 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
9997 Sthis_single_command_raw_keys
, 0, 0, 0,
9998 doc
: /* Return the raw events that were read for this command.
9999 More generally, it returns the last key sequence read, either by
10000 the command loop or by `read-key-sequence'.
10001 Unlike `this-single-command-keys', this function's value
10002 shows the events before all translations (except for input methods).
10003 The value is always a vector. */)
10006 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10009 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10010 Sreset_this_command_lengths
, 0, 0, 0,
10011 doc
: /* Make the unread events replace the last command and echo.
10012 Used in `universal-argument-other-key'.
10014 `universal-argument-other-key' rereads the event just typed.
10015 It then gets translated through `function-key-map'.
10016 The translated event has to replace the real events,
10017 both in the value of (this-command-keys) and in echoing.
10018 To achieve this, `universal-argument-other-key' calls
10019 `reset-this-command-lengths', which discards the record of reading
10020 these events the first time. */)
10023 this_command_key_count
= before_command_key_count
;
10024 if (this_command_key_count
< this_single_command_key_start
)
10025 this_single_command_key_start
= this_command_key_count
;
10027 echo_truncate (before_command_echo_length
);
10029 /* Cause whatever we put into unread-command-events
10030 to echo as if it were being freshly read from the keyboard. */
10031 this_command_key_count_reset
= 1;
10036 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10037 Sclear_this_command_keys
, 0, 1, 0,
10038 doc
: /* Clear out the vector that `this-command-keys' returns.
10039 Also clear the record of the last 100 events, unless optional arg
10040 KEEP-RECORD is non-nil. */)
10041 (Lisp_Object keep_record
)
10045 this_command_key_count
= 0;
10046 this_command_key_count_reset
= 0;
10048 if (NILP (keep_record
))
10050 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10051 ASET (recent_keys
, i
, Qnil
);
10053 recent_keys_index
= 0;
10058 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10059 doc
: /* Return the current depth in recursive edits. */)
10063 /* Wrap around reliably on integer overflow. */
10064 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10065 XSETINT (temp
, sum
);
10069 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10070 "FOpen dribble file: ",
10071 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10072 If FILE is nil, close any open dribble file.
10073 The file will be closed when Emacs exits.
10075 Be aware that this records ALL characters you type!
10076 This may include sensitive information such as passwords. */)
10088 file
= Fexpand_file_name (file
, Qnil
);
10089 dribble
= emacs_fopen (SSDATA (file
), "w");
10091 report_file_error ("Opening dribble", file
);
10096 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10097 doc
: /* Discard the contents of the terminal input buffer.
10098 Also end any kbd macro being defined. */)
10101 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10103 /* Discard the last command from the macro. */
10104 Fcancel_kbd_macro_events ();
10108 Vunread_command_events
= Qnil
;
10110 discard_tty_input ();
10112 kbd_fetch_ptr
= kbd_store_ptr
;
10118 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10119 doc
: /* Stop Emacs and return to superior process. You can resume later.
10120 If `cannot-suspend' is non-nil, or if the system doesn't support job
10121 control, run a subshell instead.
10123 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10124 to be read as terminal input by Emacs's parent, after suspension.
10126 Before suspending, run the normal hook `suspend-hook'.
10127 After resumption run the normal hook `suspend-resume-hook'.
10129 Some operating systems cannot stop the Emacs process and resume it later.
10130 On such systems, Emacs starts a subshell instead of suspending. */)
10131 (Lisp_Object stuffstring
)
10133 ptrdiff_t count
= SPECPDL_INDEX ();
10134 int old_height
, old_width
;
10136 struct gcpro gcpro1
;
10139 if (tty_list
&& tty_list
->next
)
10140 error ("There are other tty frames open; close them before suspending Emacs");
10142 if (!NILP (stuffstring
))
10143 CHECK_STRING (stuffstring
);
10145 /* Run the functions in suspend-hook. */
10146 hook
= intern ("suspend-hook");
10147 Frun_hooks (1, &hook
);
10149 GCPRO1 (stuffstring
);
10150 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10151 reset_all_sys_modes ();
10152 /* sys_suspend can get an error if it tries to fork a subshell
10153 and the system resources aren't available for that. */
10154 record_unwind_protect_void (init_all_sys_modes
);
10155 stuff_buffered_input (stuffstring
);
10156 if (cannot_suspend
)
10160 unbind_to (count
, Qnil
);
10162 /* Check if terminal/window size has changed.
10163 Note that this is not useful when we are running directly
10164 with a window system; but suspend should be disabled in that case. */
10165 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10166 if (width
!= old_width
|| height
!= old_height
)
10167 change_frame_size (SELECTED_FRAME (), width
, height
, 0, 0, 0, 0);
10169 /* Run suspend-resume-hook. */
10170 hook
= intern ("suspend-resume-hook");
10171 Frun_hooks (1, &hook
);
10177 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10178 Then in any case stuff anything Emacs has read ahead and not used. */
10181 stuff_buffered_input (Lisp_Object stuffstring
)
10183 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10184 register unsigned char *p
;
10186 if (STRINGP (stuffstring
))
10188 register ptrdiff_t count
;
10190 p
= SDATA (stuffstring
);
10191 count
= SBYTES (stuffstring
);
10192 while (count
-- > 0)
10197 /* Anything we have read ahead, put back for the shell to read. */
10198 /* ?? What should this do when we have multiple keyboards??
10199 Should we ignore anything that was typed in at the "wrong" kboard?
10201 rms: we should stuff everything back into the kboard
10203 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10206 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10207 kbd_fetch_ptr
= kbd_buffer
;
10208 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10209 stuff_char (kbd_fetch_ptr
->code
);
10211 clear_event (kbd_fetch_ptr
);
10215 #endif /* SIGTSTP */
10219 set_waiting_for_input (struct timespec
*time_to_clear
)
10221 input_available_clear_time
= time_to_clear
;
10223 /* Tell handle_interrupt to throw back to read_char, */
10224 waiting_for_input
= 1;
10226 /* If handle_interrupt was called before and buffered a C-g,
10227 make it run again now, to avoid timing error. */
10228 if (!NILP (Vquit_flag
))
10229 quit_throw_to_read_char (0);
10233 clear_waiting_for_input (void)
10235 /* Tell handle_interrupt not to throw back to read_char, */
10236 waiting_for_input
= 0;
10237 input_available_clear_time
= 0;
10240 /* The SIGINT handler.
10242 If we have a frame on the controlling tty, we assume that the
10243 SIGINT was generated by C-g, so we call handle_interrupt.
10244 Otherwise, tell QUIT to kill Emacs. */
10247 handle_interrupt_signal (int sig
)
10249 /* See if we have an active terminal on our controlling tty. */
10250 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10253 /* If there are no frames there, let's pretend that we are a
10254 well-behaving UN*X program and quit. We must not call Lisp
10255 in a signal handler, so tell QUIT to exit when it is
10257 Vquit_flag
= Qkill_emacs
;
10261 /* Otherwise, the SIGINT was probably generated by C-g. */
10263 /* Set internal_last_event_frame to the top frame of the
10264 controlling tty, if we have a frame there. We disable the
10265 interrupt key on secondary ttys, so the SIGINT must have come
10266 from the controlling tty. */
10267 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10269 handle_interrupt (1);
10274 deliver_interrupt_signal (int sig
)
10276 deliver_process_signal (sig
, handle_interrupt_signal
);
10280 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10281 of the number of times C-g has been requested. If C-g is pressed
10282 enough times, then quit anyway. See bug#6585. */
10283 static int volatile force_quit_count
;
10285 /* This routine is called at interrupt level in response to C-g.
10287 It is called from the SIGINT handler or kbd_buffer_store_event.
10289 If `waiting_for_input' is non zero, then unless `echoing' is
10290 nonzero, immediately throw back to read_char.
10292 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10293 eval to throw, when it gets a chance. If quit-flag is already
10294 non-nil, it stops the job right away. */
10297 handle_interrupt (bool in_signal_handler
)
10303 /* XXX This code needs to be revised for multi-tty support. */
10304 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10306 if (! in_signal_handler
)
10308 /* If SIGINT isn't blocked, don't let us be interrupted by
10309 a SIGINT. It might be harmful due to non-reentrancy
10310 in I/O functions. */
10312 sigemptyset (&blocked
);
10313 sigaddset (&blocked
, SIGINT
);
10314 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10318 reset_all_sys_modes ();
10322 * On systems which can suspend the current process and return to the original
10323 * shell, this command causes the user to end up back at the shell.
10324 * The "Auto-save" and "Abort" questions are not asked until
10325 * the user elects to return to emacs, at which point he can save the current
10326 * job and either dump core or continue.
10330 /* Perhaps should really fork an inferior shell?
10331 But that would not provide any way to get back
10332 to the original shell, ever. */
10333 printf ("No support for stopping a process on this operating system;\n");
10334 printf ("you can continue or abort.\n");
10335 #endif /* not SIGTSTP */
10337 /* We must remain inside the screen area when the internal terminal
10338 is used. Note that [Enter] is not echoed by dos. */
10339 cursor_to (SELECTED_FRAME (), 0, 0);
10341 /* It doesn't work to autosave while GC is in progress;
10342 the code used for auto-saving doesn't cope with the mark bit. */
10343 if (!gc_in_progress
)
10345 printf ("Auto-save? (y or n) ");
10347 if (((c
= getchar ()) & ~040) == 'Y')
10349 Fdo_auto_save (Qt
, Qnil
);
10351 printf ("\r\nAuto-save done");
10352 #else /* not MSDOS */
10353 printf ("Auto-save done\n");
10354 #endif /* not MSDOS */
10356 while (c
!= '\n') c
= getchar ();
10360 /* During GC, it must be safe to reenable quitting again. */
10361 Vinhibit_quit
= Qnil
;
10364 #endif /* not MSDOS */
10365 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10366 printf ("but will instead do a real quit after garbage collection ends\r\n");
10371 printf ("\r\nAbort? (y or n) ");
10372 #else /* not MSDOS */
10373 printf ("Abort (and dump core)? (y or n) ");
10374 #endif /* not MSDOS */
10376 if (((c
= getchar ()) & ~040) == 'Y')
10378 while (c
!= '\n') c
= getchar ();
10380 printf ("\r\nContinuing...\r\n");
10381 #else /* not MSDOS */
10382 printf ("Continuing...\n");
10383 #endif /* not MSDOS */
10385 init_all_sys_modes ();
10389 /* If executing a function that wants to be interrupted out of
10390 and the user has not deferred quitting by binding `inhibit-quit'
10391 then quit right away. */
10392 if (immediate_quit
&& NILP (Vinhibit_quit
))
10394 struct gl_state_s saved
;
10395 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10397 immediate_quit
= 0;
10398 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10400 GCPRO4 (saved
.object
, saved
.global_code
,
10401 saved
.current_syntax_table
, saved
.old_prop
);
10402 Fsignal (Qquit
, Qnil
);
10407 { /* Else request quit when it's safe. */
10408 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10409 force_quit_count
= count
;
10412 immediate_quit
= 1;
10413 Vinhibit_quit
= Qnil
;
10419 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10421 /* TODO: The longjmp in this call throws the NS event loop integration off,
10422 and it seems to do fine without this. Probably some attention
10423 needs to be paid to the setting of waiting_for_input in
10424 wait_reading_process_output() under HAVE_NS because of the call
10425 to ns_select there (needed because otherwise events aren't picked up
10426 outside of polling since we don't get SIGIO like X and we don't have a
10427 separate event loop thread like W32. */
10429 if (waiting_for_input
&& !echoing
)
10430 quit_throw_to_read_char (in_signal_handler
);
10434 /* Handle a C-g by making read_char return C-g. */
10437 quit_throw_to_read_char (bool from_signal
)
10439 /* When not called from a signal handler it is safe to call
10441 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10442 Fkill_emacs (Qnil
);
10444 /* Prevent another signal from doing this before we finish. */
10445 clear_waiting_for_input ();
10448 Vunread_command_events
= Qnil
;
10450 if (FRAMEP (internal_last_event_frame
)
10451 && !EQ (internal_last_event_frame
, selected_frame
))
10452 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10455 sys_longjmp (getcjmp
, 1);
10458 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10459 Sset_input_interrupt_mode
, 1, 1, 0,
10460 doc
: /* Set interrupt mode of reading keyboard input.
10461 If INTERRUPT is non-nil, Emacs will use input interrupts;
10462 otherwise Emacs uses CBREAK mode.
10464 See also `current-input-mode'. */)
10465 (Lisp_Object interrupt
)
10467 bool new_interrupt_input
;
10468 #ifdef USABLE_SIGIO
10469 #ifdef HAVE_X_WINDOWS
10470 if (x_display_list
!= NULL
)
10472 /* When using X, don't give the user a real choice,
10473 because we haven't implemented the mechanisms to support it. */
10474 new_interrupt_input
= 1;
10477 #endif /* HAVE_X_WINDOWS */
10478 new_interrupt_input
= !NILP (interrupt
);
10479 #else /* not USABLE_SIGIO */
10480 new_interrupt_input
= 0;
10481 #endif /* not USABLE_SIGIO */
10483 if (new_interrupt_input
!= interrupt_input
)
10485 #ifdef POLL_FOR_INPUT
10489 /* this causes startup screen to be restored and messes with the mouse */
10490 reset_all_sys_modes ();
10491 interrupt_input
= new_interrupt_input
;
10492 init_all_sys_modes ();
10494 interrupt_input
= new_interrupt_input
;
10497 #ifdef POLL_FOR_INPUT
10498 poll_suppress_count
= 1;
10505 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10506 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10507 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10508 C-q in key sequences.
10510 This setting only has an effect on tty terminals and only when
10511 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10513 See also `current-input-mode'. */)
10514 (Lisp_Object flow
, Lisp_Object terminal
)
10516 struct terminal
*t
= get_terminal (terminal
, 1);
10517 struct tty_display_info
*tty
;
10518 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10520 tty
= t
->display_info
.tty
;
10522 if (tty
->flow_control
!= !NILP (flow
))
10525 /* This causes startup screen to be restored and messes with the mouse. */
10526 reset_sys_modes (tty
);
10529 tty
->flow_control
= !NILP (flow
);
10532 init_sys_modes (tty
);
10538 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10539 doc
: /* Enable or disable 8-bit input on TERMINAL.
10540 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10541 bit as the Meta modifier.
10543 If META is nil, Emacs will ignore the top bit, on the assumption it is
10546 Otherwise, Emacs will accept and pass through 8-bit input without
10547 specially interpreting the top bit.
10549 This setting only has an effect on tty terminal devices.
10551 Optional parameter TERMINAL specifies the tty terminal device to use.
10552 It may be a terminal object, a frame, or nil for the terminal used by
10553 the currently selected frame.
10555 See also `current-input-mode'. */)
10556 (Lisp_Object meta
, Lisp_Object terminal
)
10558 struct terminal
*t
= get_terminal (terminal
, 1);
10559 struct tty_display_info
*tty
;
10562 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10564 tty
= t
->display_info
.tty
;
10568 else if (EQ (meta
, Qt
))
10573 if (tty
->meta_key
!= new_meta
)
10576 /* this causes startup screen to be restored and messes with the mouse */
10577 reset_sys_modes (tty
);
10580 tty
->meta_key
= new_meta
;
10583 init_sys_modes (tty
);
10589 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10590 doc
: /* Specify character used for quitting.
10591 QUIT must be an ASCII character.
10593 This function only has an effect on the controlling tty of the Emacs
10596 See also `current-input-mode'. */)
10599 struct terminal
*t
= get_named_tty ("/dev/tty");
10600 struct tty_display_info
*tty
;
10601 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10603 tty
= t
->display_info
.tty
;
10605 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10606 error ("QUIT must be an ASCII character");
10609 /* this causes startup screen to be restored and messes with the mouse */
10610 reset_sys_modes (tty
);
10613 /* Don't let this value be out of range. */
10614 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10617 init_sys_modes (tty
);
10623 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10624 doc
: /* Set mode of reading keyboard input.
10625 First arg INTERRUPT non-nil means use input interrupts;
10626 nil means use CBREAK mode.
10627 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10628 (no effect except in CBREAK mode).
10629 Third arg META t means accept 8-bit input (for a Meta key).
10630 META nil means ignore the top bit, on the assumption it is parity.
10631 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10632 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10633 See also `current-input-mode'. */)
10634 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10636 Fset_input_interrupt_mode (interrupt
);
10637 Fset_output_flow_control (flow
, Qnil
);
10638 Fset_input_meta_mode (meta
, Qnil
);
10640 Fset_quit_char (quit
);
10644 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10645 doc
: /* Return information about the way Emacs currently reads keyboard input.
10646 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10647 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10648 nil, Emacs is using CBREAK mode.
10649 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10650 terminal; this does not apply if Emacs uses interrupt-driven input.
10651 META is t if accepting 8-bit input with 8th bit as Meta flag.
10652 META nil means ignoring the top bit, on the assumption it is parity.
10653 META is neither t nor nil if accepting 8-bit input and using
10654 all 8 bits as the character code.
10655 QUIT is the character Emacs currently uses to quit.
10656 The elements of this list correspond to the arguments of
10657 `set-input-mode'. */)
10660 Lisp_Object val
[4];
10661 struct frame
*sf
= XFRAME (selected_frame
);
10663 val
[0] = interrupt_input
? Qt
: Qnil
;
10664 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10666 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10667 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10669 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10676 XSETFASTINT (val
[3], quit_char
);
10678 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10681 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10682 doc
: /* Return position information for pixel coordinates X and Y.
10683 By default, X and Y are relative to text area of the selected window.
10684 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10685 If optional fourth arg WHOLE is non-nil, X is relative to the left
10686 edge of the window.
10688 The return value is similar to a mouse click position:
10689 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10690 IMAGE (DX . DY) (WIDTH . HEIGHT))
10691 The `posn-' functions access elements of such lists. */)
10692 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10697 if (NILP (frame_or_window
))
10698 frame_or_window
= selected_window
;
10700 if (WINDOWP (frame_or_window
))
10702 struct window
*w
= decode_live_window (frame_or_window
);
10704 XSETINT (x
, (XINT (x
)
10705 + WINDOW_LEFT_EDGE_X (w
)
10707 ? window_box_left_offset (w
, TEXT_AREA
)
10709 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10710 frame_or_window
= w
->frame
;
10713 CHECK_LIVE_FRAME (frame_or_window
);
10715 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10718 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10719 doc
: /* Return position information for buffer POS in WINDOW.
10720 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10722 Return nil if position is not visible in window. Otherwise,
10723 the return value is similar to that returned by `event-start' for
10724 a mouse click at the upper left corner of the glyph corresponding
10725 to the given buffer position:
10726 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10727 IMAGE (DX . DY) (WIDTH . HEIGHT))
10728 The `posn-' functions access elements of such lists. */)
10729 (Lisp_Object pos
, Lisp_Object window
)
10734 window
= selected_window
;
10736 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10739 Lisp_Object x
= XCAR (tem
);
10740 Lisp_Object y
= XCAR (XCDR (tem
));
10742 /* Point invisible due to hscrolling? */
10745 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10751 /* Set up a new kboard object with reasonable initial values.
10752 TYPE is a window system for which this keyboard is used. */
10755 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10757 kset_overriding_terminal_local_map (kb
, Qnil
);
10758 kset_last_command (kb
, Qnil
);
10759 kset_real_last_command (kb
, Qnil
);
10760 kset_keyboard_translate_table (kb
, Qnil
);
10761 kset_last_repeatable_command (kb
, Qnil
);
10762 kset_prefix_arg (kb
, Qnil
);
10763 kset_last_prefix_arg (kb
, Qnil
);
10764 kset_kbd_queue (kb
, Qnil
);
10765 kb
->kbd_queue_has_data
= 0;
10766 kb
->immediate_echo
= 0;
10767 kset_echo_string (kb
, Qnil
);
10768 kb
->echo_after_prompt
= -1;
10769 kb
->kbd_macro_buffer
= 0;
10770 kb
->kbd_macro_bufsize
= 0;
10771 kset_defining_kbd_macro (kb
, Qnil
);
10772 kset_last_kbd_macro (kb
, Qnil
);
10773 kb
->reference_count
= 0;
10774 kset_system_key_alist (kb
, Qnil
);
10775 kset_system_key_syms (kb
, Qnil
);
10776 kset_window_system (kb
, type
);
10777 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10778 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10779 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10780 kset_default_minibuffer_frame (kb
, Qnil
);
10783 /* Allocate and basically initialize keyboard
10784 object to use with window system TYPE. */
10787 allocate_kboard (Lisp_Object type
)
10789 KBOARD
*kb
= xmalloc (sizeof *kb
);
10791 init_kboard (kb
, type
);
10792 kb
->next_kboard
= all_kboards
;
10798 * Destroy the contents of a kboard object, but not the object itself.
10799 * We use this just before deleting it, or if we're going to initialize
10800 * it a second time.
10803 wipe_kboard (KBOARD
*kb
)
10805 xfree (kb
->kbd_macro_buffer
);
10808 /* Free KB and memory referenced from it. */
10811 delete_kboard (KBOARD
*kb
)
10815 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10818 *kbp
= kb
->next_kboard
;
10820 /* Prevent a dangling reference to KB. */
10821 if (kb
== current_kboard
10822 && FRAMEP (selected_frame
)
10823 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10825 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10827 if (current_kboard
== kb
)
10836 init_keyboard (void)
10838 /* This is correct before outermost invocation of the editor loop. */
10839 command_loop_level
= -1;
10840 immediate_quit
= 0;
10841 quit_char
= Ctl ('g');
10842 Vunread_command_events
= Qnil
;
10843 timer_idleness_start_time
= invalid_timespec ();
10845 recent_keys_index
= 0;
10846 kbd_fetch_ptr
= kbd_buffer
;
10847 kbd_store_ptr
= kbd_buffer
;
10848 do_mouse_tracking
= Qnil
;
10850 interrupt_input_blocked
= 0;
10851 pending_signals
= 0;
10853 /* This means that command_loop_1 won't try to select anything the first
10855 internal_last_event_frame
= Qnil
;
10856 Vlast_event_frame
= internal_last_event_frame
;
10858 current_kboard
= initial_kboard
;
10859 /* Re-initialize the keyboard again. */
10860 wipe_kboard (current_kboard
);
10861 /* A value of nil for Vwindow_system normally means a tty, but we also use
10862 it for the initial terminal since there is no window system there. */
10863 init_kboard (current_kboard
, Qnil
);
10865 if (!noninteractive
)
10867 /* Before multi-tty support, these handlers used to be installed
10868 only if the current session was a tty session. Now an Emacs
10869 session may have multiple display types, so we always handle
10870 SIGINT. There is special code in handle_interrupt_signal to exit
10871 Emacs on SIGINT when there are no termcap frames on the
10872 controlling terminal. */
10873 struct sigaction action
;
10874 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10875 sigaction (SIGINT
, &action
, 0);
10877 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10878 SIGQUIT and we can't tell which one it will give us. */
10879 sigaction (SIGQUIT
, &action
, 0);
10880 #endif /* not DOS_NT */
10882 #ifdef USABLE_SIGIO
10883 if (!noninteractive
)
10885 struct sigaction action
;
10886 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10887 sigaction (SIGIO
, &action
, 0);
10891 /* Use interrupt input by default, if it works and noninterrupt input
10892 has deficiencies. */
10894 #ifdef INTERRUPT_INPUT
10895 interrupt_input
= 1;
10897 interrupt_input
= 0;
10900 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10903 if (keyboard_init_hook
)
10904 (*keyboard_init_hook
) ();
10906 #ifdef POLL_FOR_INPUT
10908 poll_suppress_count
= 1;
10913 /* This type's only use is in syms_of_keyboard, to initialize the
10914 event header symbols and put properties on them. */
10915 struct event_head
{
10921 static const struct event_head head_table
[] = {
10922 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10923 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10924 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10925 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10926 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10927 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10928 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10929 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10930 /* `select-window' should be handled just like `switch-frame'
10931 in read_key_sequence. */
10932 {&Qselect_window
, "select-window", &Qswitch_frame
}
10936 syms_of_keyboard (void)
10938 pending_funcalls
= Qnil
;
10939 staticpro (&pending_funcalls
);
10941 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10942 staticpro (&Vlispy_mouse_stem
);
10945 DEFSYM (QCimage
, ":image");
10946 DEFSYM (Qhelp_echo
, "help-echo");
10947 DEFSYM (QCrtl
, ":rtl");
10949 staticpro (&item_properties
);
10950 item_properties
= Qnil
;
10952 staticpro (&tool_bar_item_properties
);
10953 tool_bar_item_properties
= Qnil
;
10954 staticpro (&tool_bar_items_vector
);
10955 tool_bar_items_vector
= Qnil
;
10957 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10958 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10959 DEFSYM (Qself_insert_command
, "self-insert-command");
10960 DEFSYM (Qforward_char
, "forward-char");
10961 DEFSYM (Qbackward_char
, "backward-char");
10962 DEFSYM (Qdisabled
, "disabled");
10963 DEFSYM (Qundefined
, "undefined");
10964 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10965 DEFSYM (Qpost_command_hook
, "post-command-hook");
10966 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10967 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10968 DEFSYM (Qfunction_key
, "function-key");
10969 DEFSYM (Qmouse_click
, "mouse-click");
10970 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10971 DEFSYM (Qsave_session
, "save-session");
10972 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10973 DEFSYM (Qmenu_enable
, "menu-enable");
10976 DEFSYM (Qlanguage_change
, "language-change");
10980 DEFSYM (Qdbus_event
, "dbus-event");
10983 #ifdef USE_FILE_NOTIFY
10984 DEFSYM (Qfile_notify
, "file-notify");
10985 #endif /* USE_FILE_NOTIFY */
10987 DEFSYM (QCenable
, ":enable");
10988 DEFSYM (QCvisible
, ":visible");
10989 DEFSYM (QChelp
, ":help");
10990 DEFSYM (QCfilter
, ":filter");
10991 DEFSYM (QCbutton
, ":button");
10992 DEFSYM (QCkeys
, ":keys");
10993 DEFSYM (QCkey_sequence
, ":key-sequence");
10994 DEFSYM (QCtoggle
, ":toggle");
10995 DEFSYM (QCradio
, ":radio");
10996 DEFSYM (QClabel
, ":label");
10997 DEFSYM (QCvert_only
, ":vert-only");
10999 DEFSYM (Qmode_line
, "mode-line");
11000 DEFSYM (Qvertical_line
, "vertical-line");
11001 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11002 DEFSYM (Qmenu_bar
, "menu-bar");
11003 DEFSYM (Qright_divider
, "right-divider");
11004 DEFSYM (Qbottom_divider
, "bottom-divider");
11006 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11008 DEFSYM (Qabove_handle
, "above-handle");
11009 DEFSYM (Qhandle
, "handle");
11010 DEFSYM (Qbelow_handle
, "below-handle");
11011 DEFSYM (Qup
, "up");
11012 DEFSYM (Qdown
, "down");
11013 DEFSYM (Qtop
, "top");
11014 DEFSYM (Qbottom
, "bottom");
11015 DEFSYM (Qend_scroll
, "end-scroll");
11016 DEFSYM (Qratio
, "ratio");
11018 DEFSYM (Qevent_kind
, "event-kind");
11019 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11020 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11021 DEFSYM (Qmodifier_cache
, "modifier-cache");
11023 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11024 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11026 DEFSYM (Qpolling_period
, "polling-period");
11028 DEFSYM (Qx_set_selection
, "x-set-selection");
11029 DEFSYM (QPRIMARY
, "PRIMARY");
11030 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11031 DEFSYM (Qhandle_select_window
, "handle-select-window");
11033 DEFSYM (Qinput_method_function
, "input-method-function");
11034 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11035 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11037 DEFSYM (Qhelp_form_show
, "help-form-show");
11039 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11041 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11042 Fset (Qinput_method_use_echo_area
, Qnil
);
11046 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11048 for (i
= 0; i
< len
; i
++)
11050 const struct event_head
*p
= &head_table
[i
];
11051 *p
->var
= intern_c_string (p
->name
);
11052 staticpro (p
->var
);
11053 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11054 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11058 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11059 staticpro (&button_down_location
);
11060 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11061 staticpro (&mouse_syms
);
11062 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11063 / sizeof (lispy_wheel_names
[0])),
11065 staticpro (&wheel_syms
);
11069 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11071 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11072 for (i
= 0; i
< len
; i
++)
11073 if (modifier_names
[i
])
11074 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11075 staticpro (&modifier_symbols
);
11078 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11079 staticpro (&recent_keys
);
11081 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11082 staticpro (&this_command_keys
);
11084 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11085 staticpro (&raw_keybuf
);
11087 DEFSYM (Qcommand_execute
, "command-execute");
11089 accent_key_syms
= Qnil
;
11090 staticpro (&accent_key_syms
);
11092 func_key_syms
= Qnil
;
11093 staticpro (&func_key_syms
);
11095 drag_n_drop_syms
= Qnil
;
11096 staticpro (&drag_n_drop_syms
);
11098 unread_switch_frame
= Qnil
;
11099 staticpro (&unread_switch_frame
);
11101 internal_last_event_frame
= Qnil
;
11102 staticpro (&internal_last_event_frame
);
11104 read_key_sequence_cmd
= Qnil
;
11105 staticpro (&read_key_sequence_cmd
);
11106 read_key_sequence_remapped
= Qnil
;
11107 staticpro (&read_key_sequence_remapped
);
11109 menu_bar_one_keymap_changed_items
= Qnil
;
11110 staticpro (&menu_bar_one_keymap_changed_items
);
11112 menu_bar_items_vector
= Qnil
;
11113 staticpro (&menu_bar_items_vector
);
11115 help_form_saved_window_configs
= Qnil
;
11116 staticpro (&help_form_saved_window_configs
);
11118 defsubr (&Scurrent_idle_time
);
11119 defsubr (&Sevent_symbol_parse_modifiers
);
11120 defsubr (&Sevent_convert_list
);
11121 defsubr (&Sread_key_sequence
);
11122 defsubr (&Sread_key_sequence_vector
);
11123 defsubr (&Srecursive_edit
);
11124 defsubr (&Strack_mouse
);
11125 defsubr (&Sinput_pending_p
);
11126 defsubr (&Srecent_keys
);
11127 defsubr (&Sthis_command_keys
);
11128 defsubr (&Sthis_command_keys_vector
);
11129 defsubr (&Sthis_single_command_keys
);
11130 defsubr (&Sthis_single_command_raw_keys
);
11131 defsubr (&Sreset_this_command_lengths
);
11132 defsubr (&Sclear_this_command_keys
);
11133 defsubr (&Ssuspend_emacs
);
11134 defsubr (&Sabort_recursive_edit
);
11135 defsubr (&Sexit_recursive_edit
);
11136 defsubr (&Srecursion_depth
);
11137 defsubr (&Scommand_error_default_function
);
11138 defsubr (&Stop_level
);
11139 defsubr (&Sdiscard_input
);
11140 defsubr (&Sopen_dribble_file
);
11141 defsubr (&Sset_input_interrupt_mode
);
11142 defsubr (&Sset_output_flow_control
);
11143 defsubr (&Sset_input_meta_mode
);
11144 defsubr (&Sset_quit_char
);
11145 defsubr (&Sset_input_mode
);
11146 defsubr (&Scurrent_input_mode
);
11147 defsubr (&Sposn_at_point
);
11148 defsubr (&Sposn_at_x_y
);
11150 DEFVAR_LISP ("last-command-event", last_command_event
,
11151 doc
: /* Last input event that was part of a command. */);
11153 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11154 doc
: /* Last input event in a command, except for mouse menu events.
11155 Mouse menus give back keys that don't look like mouse events;
11156 this variable holds the actual mouse event that led to the menu,
11157 so that you can determine whether the command was run by mouse or not. */);
11159 DEFVAR_LISP ("last-input-event", last_input_event
,
11160 doc
: /* Last input event. */);
11162 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11163 doc
: /* List of events to be read as the command input.
11164 These events are processed first, before actual keyboard input.
11165 Events read from this list are not normally added to `this-command-keys',
11166 as they will already have been added once as they were read for the first time.
11167 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11168 Vunread_command_events
= Qnil
;
11170 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11171 doc
: /* List of events to be processed as input by input methods.
11172 These events are processed before `unread-command-events'
11173 and actual keyboard input, but are not given to `input-method-function'. */);
11174 Vunread_post_input_method_events
= Qnil
;
11176 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11177 doc
: /* List of events to be processed as input by input methods.
11178 These events are processed after `unread-command-events', but
11179 before actual keyboard input.
11180 If there's an active input method, the events are given to
11181 `input-method-function'. */);
11182 Vunread_input_method_events
= Qnil
;
11184 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11185 doc
: /* Meta-prefix character code.
11186 Meta-foo as command input turns into this character followed by foo. */);
11187 XSETINT (meta_prefix_char
, 033);
11189 DEFVAR_KBOARD ("last-command", Vlast_command
,
11190 doc
: /* The last command executed.
11191 Normally a symbol with a function definition, but can be whatever was found
11192 in the keymap, or whatever the variable `this-command' was set to by that
11195 The value `mode-exit' is special; it means that the previous command
11196 read an event that told it to exit, and it did so and unread that event.
11197 In other words, the present command is the event that made the previous
11200 The value `kill-region' is special; it means that the previous command
11201 was a kill command.
11203 `last-command' has a separate binding for each terminal device.
11204 See Info node `(elisp)Multiple Terminals'. */);
11206 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11207 doc
: /* Same as `last-command', but never altered by Lisp code.
11208 Taken from the previous value of `real-this-command'. */);
11210 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11211 doc
: /* Last command that may be repeated.
11212 The last command executed that was not bound to an input event.
11213 This is the command `repeat' will try to repeat.
11214 Taken from a previous value of `real-this-command'. */);
11216 DEFVAR_LISP ("this-command", Vthis_command
,
11217 doc
: /* The command now being executed.
11218 The command can set this variable; whatever is put here
11219 will be in `last-command' during the following command. */);
11220 Vthis_command
= Qnil
;
11222 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11223 doc
: /* This is like `this-command', except that commands should never modify it. */);
11224 Vreal_this_command
= Qnil
;
11226 DEFVAR_LISP ("this-command-keys-shift-translated",
11227 Vthis_command_keys_shift_translated
,
11228 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11229 Shift-translation occurs when there is no binding for the key sequence
11230 as entered, but a binding was found by changing an upper-case letter
11231 to lower-case, or a shifted function key to an unshifted one. */);
11232 Vthis_command_keys_shift_translated
= Qnil
;
11234 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11235 doc
: /* The command bound to the current key sequence before remapping.
11236 It equals `this-command' if the original command was not remapped through
11237 any of the active keymaps. Otherwise, the value of `this-command' is the
11238 result of looking up the original command in the active keymaps. */);
11239 Vthis_original_command
= Qnil
;
11241 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11242 doc
: /* Number of input events between auto-saves.
11243 Zero means disable autosaving due to number of characters typed. */);
11244 auto_save_interval
= 300;
11246 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11247 doc
: /* Number of seconds idle time before auto-save.
11248 Zero or nil means disable auto-saving due to idleness.
11249 After auto-saving due to this many seconds of idle time,
11250 Emacs also does a garbage collection if that seems to be warranted. */);
11251 XSETFASTINT (Vauto_save_timeout
, 30);
11253 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11254 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11255 The value may be integer or floating point.
11256 If the value is zero, don't echo at all. */);
11257 Vecho_keystrokes
= make_number (1);
11259 DEFVAR_INT ("polling-period", polling_period
,
11260 doc
: /* Interval between polling for input during Lisp execution.
11261 The reason for polling is to make C-g work to stop a running program.
11262 Polling is needed only when using X windows and SIGIO does not work.
11263 Polling is automatically disabled in all other cases. */);
11264 polling_period
= 2;
11266 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11267 doc
: /* Maximum time between mouse clicks to make a double-click.
11268 Measured in milliseconds. The value nil means disable double-click
11269 recognition; t means double-clicks have no time limit and are detected
11270 by position only. */);
11271 Vdouble_click_time
= make_number (500);
11273 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11274 doc
: /* Maximum mouse movement between clicks to make a double-click.
11275 On window-system frames, value is the number of pixels the mouse may have
11276 moved horizontally or vertically between two clicks to make a double-click.
11277 On non window-system frames, value is interpreted in units of 1/8 characters
11280 This variable is also the threshold for motion of the mouse
11281 to count as a drag. */);
11282 double_click_fuzz
= 3;
11284 DEFVAR_INT ("num-input-keys", num_input_keys
,
11285 doc
: /* Number of complete key sequences read as input so far.
11286 This includes key sequences read from keyboard macros.
11287 The number is effectively the number of interactive command invocations. */);
11288 num_input_keys
= 0;
11290 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11291 doc
: /* Number of input events read from the keyboard so far.
11292 This does not include events generated by keyboard macros. */);
11293 num_nonmacro_input_events
= 0;
11295 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11296 doc
: /* The frame in which the most recently read event occurred.
11297 If the last event came from a keyboard macro, this is set to `macro'. */);
11298 Vlast_event_frame
= Qnil
;
11300 /* This variable is set up in sysdep.c. */
11301 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11302 doc
: /* The ERASE character as set by the user with stty. */);
11304 DEFVAR_LISP ("help-char", Vhelp_char
,
11305 doc
: /* Character to recognize as meaning Help.
11306 When it is read, do `(eval help-form)', and display result if it's a string.
11307 If the value of `help-form' is nil, this char can be read normally. */);
11308 XSETINT (Vhelp_char
, Ctl ('H'));
11310 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11311 doc
: /* List of input events to recognize as meaning Help.
11312 These work just like the value of `help-char' (see that). */);
11313 Vhelp_event_list
= Qnil
;
11315 DEFVAR_LISP ("help-form", Vhelp_form
,
11316 doc
: /* Form to execute when character `help-char' is read.
11317 If the form returns a string, that string is displayed.
11318 If `help-form' is nil, the help char is not recognized. */);
11321 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11322 doc
: /* Command to run when `help-char' character follows a prefix key.
11323 This command is used only when there is no actual binding
11324 for that character after that prefix key. */);
11325 Vprefix_help_command
= Qnil
;
11327 DEFVAR_LISP ("top-level", Vtop_level
,
11328 doc
: /* Form to evaluate when Emacs starts up.
11329 Useful to set before you dump a modified Emacs. */);
11332 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11333 doc
: /* Translate table for local keyboard input, or nil.
11334 If non-nil, the value should be a char-table. Each character read
11335 from the keyboard is looked up in this char-table. If the value found
11336 there is non-nil, then it is used instead of the actual input character.
11338 The value can also be a string or vector, but this is considered obsolete.
11339 If it is a string or vector of length N, character codes N and up are left
11340 untranslated. In a vector, an element which is nil means "no translation".
11342 This is applied to the characters supplied to input methods, not their
11343 output. See also `translation-table-for-input'.
11345 This variable has a separate binding for each terminal.
11346 See Info node `(elisp)Multiple Terminals'. */);
11348 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11349 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11350 \(Even if the operating system has support for stopping a process.\) */);
11351 cannot_suspend
= 0;
11353 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11354 doc
: /* Non-nil means prompt with menus when appropriate.
11355 This is done when reading from a keymap that has a prompt string,
11356 for elements that have prompt strings.
11357 The menu is displayed on the screen
11358 if X menus were enabled at configuration
11359 time and the previous event was a mouse click prefix key.
11360 Otherwise, menu prompting uses the echo area. */);
11361 menu_prompting
= 1;
11363 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11364 doc
: /* Character to see next line of menu prompt.
11365 Type this character while in a menu prompt to rotate around the lines of it. */);
11366 XSETINT (menu_prompt_more_char
, ' ');
11368 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11369 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11370 Emacs applies the modifiers of the character stored here to each keyboard
11371 character it reads. For example, after evaluating the expression
11372 (setq extra-keyboard-modifiers ?\\C-x)
11373 all input characters will have the control modifier applied to them.
11375 Note that the character ?\\C-@, equivalent to the integer zero, does
11376 not count as a control character; rather, it counts as a character
11377 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11378 cancels any modification. */);
11379 extra_keyboard_modifiers
= 0;
11381 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11382 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11383 The command loop sets this to nil before each command,
11384 and tests the value when the command returns.
11385 Buffer modification stores t in this variable. */);
11386 Vdeactivate_mark
= Qnil
;
11387 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11389 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11390 doc
: /* Normal hook run before each command is executed.
11391 If an unhandled error happens in running this hook,
11392 the function in which the error occurred is unconditionally removed, since
11393 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11394 Vpre_command_hook
= Qnil
;
11396 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11397 doc
: /* Normal hook run after each command is executed.
11398 If an unhandled error happens in running this hook,
11399 the function in which the error occurred is unconditionally removed, since
11400 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11401 Vpost_command_hook
= Qnil
;
11404 DEFVAR_LISP ("echo-area-clear-hook", ...,
11405 doc
: /* Normal hook run when clearing the echo area. */);
11407 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11408 Fset (Qecho_area_clear_hook
, Qnil
);
11410 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11411 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11412 Vlucid_menu_bar_dirty_flag
= Qnil
;
11414 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11415 doc
: /* List of menu bar items to move to the end of the menu bar.
11416 The elements of the list are event types that may have menu bar bindings. */);
11417 Vmenu_bar_final_items
= Qnil
;
11419 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11420 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11421 This is used internally by graphical displays that do not render
11422 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11423 Vtool_bar_separator_image_expression
= Qnil
;
11425 DEFVAR_KBOARD ("overriding-terminal-local-map",
11426 Voverriding_terminal_local_map
,
11427 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11428 This variable is intended to let commands such as `universal-argument'
11429 set up a different keymap for reading the next command.
11431 `overriding-terminal-local-map' has a separate binding for each
11432 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11434 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11435 doc
: /* Keymap that replaces (overrides) local keymaps.
11436 If this variable is non-nil, Emacs looks up key bindings in this
11437 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11438 buffer's local map. Hence, the only active keymaps would be
11439 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11440 order of precedence. */);
11441 Voverriding_local_map
= Qnil
;
11443 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11444 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11445 Otherwise, the menu bar continues to reflect the buffer's local map
11446 and the minor mode maps regardless of `overriding-local-map'. */);
11447 Voverriding_local_map_menu_flag
= Qnil
;
11449 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11450 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11451 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11453 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11454 doc
: /* Non-nil means generate motion events for mouse motion. */);
11456 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11457 doc
: /* Alist of system-specific X windows key symbols.
11458 Each element should have the form (N . SYMBOL) where N is the
11459 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11460 and SYMBOL is its name.
11462 `system-key-alist' has a separate binding for each terminal device.
11463 See Info node `(elisp)Multiple Terminals'. */);
11465 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11466 doc
: /* Keymap that translates key sequences to key sequences during input.
11467 This is used mainly for mapping key sequences into some preferred
11468 key events (symbols).
11470 The `read-key-sequence' function replaces any subsequence bound by
11471 `local-function-key-map' with its binding. More precisely, when the
11472 active keymaps have no binding for the current key sequence but
11473 `local-function-key-map' binds a suffix of the sequence to a vector or
11474 string, `read-key-sequence' replaces the matching suffix with its
11475 binding, and continues with the new sequence.
11477 If the binding is a function, it is called with one argument (the prompt)
11478 and its return value (a key sequence) is used.
11480 The events that come from bindings in `local-function-key-map' are not
11481 themselves looked up in `local-function-key-map'.
11483 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11484 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11485 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11486 typing `ESC O P x' would return [f1 x].
11488 `local-function-key-map' has a separate binding for each terminal
11489 device. See Info node `(elisp)Multiple Terminals'. If you need to
11490 define a binding on all terminals, change `function-key-map'
11491 instead. Initially, `local-function-key-map' is an empty keymap that
11492 has `function-key-map' as its parent on all terminal devices. */);
11494 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11495 doc
: /* Keymap that decodes input escape sequences.
11496 This is used mainly for mapping ASCII function key sequences into
11497 real Emacs function key events (symbols).
11499 The `read-key-sequence' function replaces any subsequence bound by
11500 `input-decode-map' with its binding. Contrary to `function-key-map',
11501 this map applies its rebinding regardless of the presence of an ordinary
11502 binding. So it is more like `key-translation-map' except that it applies
11503 before `function-key-map' rather than after.
11505 If the binding is a function, it is called with one argument (the prompt)
11506 and its return value (a key sequence) is used.
11508 The events that come from bindings in `input-decode-map' are not
11509 themselves looked up in `input-decode-map'. */);
11511 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11512 doc
: /* The parent keymap of all `local-function-key-map' instances.
11513 Function key definitions that apply to all terminal devices should go
11514 here. If a mapping is defined in both the current
11515 `local-function-key-map' binding and this variable, then the local
11516 definition will take precedence. */);
11517 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11519 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11520 doc
: /* Keymap of key translations that can override keymaps.
11521 This keymap works like `input-decode-map', but comes after `function-key-map'.
11522 Another difference is that it is global rather than terminal-local. */);
11523 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11525 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11526 doc
: /* List of deferred actions to be performed at a later time.
11527 The precise format isn't relevant here; we just check whether it is nil. */);
11528 Vdeferred_action_list
= Qnil
;
11530 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11531 doc
: /* Function to call to handle deferred actions, after each command.
11532 This function is called with no arguments after each command
11533 whenever `deferred-action-list' is non-nil. */);
11534 Vdeferred_action_function
= Qnil
;
11536 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11537 doc
: /* List of warnings to be displayed after this command.
11538 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11539 as per the args of `display-warning' (which see).
11540 If this variable is non-nil, `delayed-warnings-hook' will be run
11541 immediately after running `post-command-hook'. */);
11542 Vdelayed_warnings_list
= Qnil
;
11544 DEFVAR_LISP ("timer-list", Vtimer_list
,
11545 doc
: /* List of active absolute time timers in order of increasing time. */);
11546 Vtimer_list
= Qnil
;
11548 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11549 doc
: /* List of active idle-time timers in order of increasing time. */);
11550 Vtimer_idle_list
= Qnil
;
11552 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11553 doc
: /* If non-nil, the function that implements the current input method.
11554 It's called with one argument, a printing character that was just read.
11555 \(That means a character with code 040...0176.)
11556 Typically this function uses `read-event' to read additional events.
11557 When it does so, it should first bind `input-method-function' to nil
11558 so it will not be called recursively.
11560 The function should return a list of zero or more events
11561 to be used as input. If it wants to put back some events
11562 to be reconsidered, separately, by the input method,
11563 it can add them to the beginning of `unread-command-events'.
11565 The input method function can find in `input-method-previous-message'
11566 the previous echo area message.
11568 The input method function should refer to the variables
11569 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11570 for guidance on what to do. */);
11571 Vinput_method_function
= Qnil
;
11573 DEFVAR_LISP ("input-method-previous-message",
11574 Vinput_method_previous_message
,
11575 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11576 This variable exists because `read-event' clears the echo area
11577 before running the input method. It is nil if there was no message. */);
11578 Vinput_method_previous_message
= Qnil
;
11580 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11581 doc
: /* If non-nil, the function that implements the display of help.
11582 It's called with one argument, the help string to display. */);
11583 Vshow_help_function
= Qnil
;
11585 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11586 doc
: /* If non-nil, suppress point adjustment after executing a command.
11588 After a command is executed, if point is moved into a region that has
11589 special properties (e.g. composition, display), we adjust point to
11590 the boundary of the region. But, when a command sets this variable to
11591 non-nil, we suppress the point adjustment.
11593 This variable is set to nil before reading a command, and is checked
11594 just after executing the command. */);
11595 Vdisable_point_adjustment
= Qnil
;
11597 DEFVAR_LISP ("global-disable-point-adjustment",
11598 Vglobal_disable_point_adjustment
,
11599 doc
: /* If non-nil, always suppress point adjustment.
11601 The default value is nil, in which case, point adjustment are
11602 suppressed only after special commands that set
11603 `disable-point-adjustment' (which see) to non-nil. */);
11604 Vglobal_disable_point_adjustment
= Qnil
;
11606 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11607 doc
: /* How long to display an echo-area message when the minibuffer is active.
11608 If the value is not a number, such messages don't time out. */);
11609 Vminibuffer_message_timeout
= make_number (2);
11611 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11612 doc
: /* If non-nil, any keyboard input throws to this symbol.
11613 The value of that variable is passed to `quit-flag' and later causes a
11614 peculiar kind of quitting. */);
11615 Vthrow_on_input
= Qnil
;
11617 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11618 doc
: /* Function to output error messages.
11619 Called with three arguments:
11620 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11621 such as what `condition-case' would bind its variable to,
11622 - the context (a string which normally goes at the start of the message),
11623 - the Lisp function within which the error was signaled. */);
11624 Vcommand_error_function
= intern ("command-error-default-function");
11626 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11627 Venable_disabled_menus_and_buttons
,
11628 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11630 Help functions bind this to allow help on disabled menu items
11631 and tool-bar buttons. */);
11632 Venable_disabled_menus_and_buttons
= Qnil
;
11634 DEFVAR_LISP ("select-active-regions",
11635 Vselect_active_regions
,
11636 doc
: /* If non-nil, an active region automatically sets the primary selection.
11637 If the value is `only', only temporarily active regions (usually made
11638 by mouse-dragging or shift-selection) set the window selection.
11640 This takes effect only when Transient Mark mode is enabled. */);
11641 Vselect_active_regions
= Qt
;
11643 DEFVAR_LISP ("saved-region-selection",
11644 Vsaved_region_selection
,
11645 doc
: /* Contents of active region prior to buffer modification.
11646 If `select-active-regions' is non-nil, Emacs sets this to the
11647 text in the region before modifying the buffer. The next call to
11648 the function `deactivate-mark' uses this to set the window selection. */);
11649 Vsaved_region_selection
= Qnil
;
11651 DEFVAR_LISP ("selection-inhibit-update-commands",
11652 Vselection_inhibit_update_commands
,
11653 doc
: /* List of commands which should not update the selection.
11654 Normally, if `select-active-regions' is non-nil and the mark remains
11655 active after a command (i.e. the mark was not deactivated), the Emacs
11656 command loop sets the selection to the text in the region. However,
11657 if the command is in this list, the selection is not updated. */);
11658 Vselection_inhibit_update_commands
11659 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11661 DEFVAR_LISP ("debug-on-event",
11663 doc
: /* Enter debugger on this event. When Emacs
11664 receives the special event specified by this variable, it will try to
11665 break into the debugger as soon as possible instead of processing the
11666 event normally through `special-event-map'.
11668 Currently, the only supported values for this
11669 variable are `sigusr1' and `sigusr2'. */);
11670 Vdebug_on_event
= intern_c_string ("sigusr2");
11672 /* Create the initial keyboard. Qt means 'unset'. */
11673 initial_kboard
= allocate_kboard (Qt
);
11677 keys_of_keyboard (void)
11679 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11680 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11681 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11682 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11683 initial_define_key (meta_map
, 'x', "execute-extended-command");
11685 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11686 "handle-delete-frame");
11687 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11688 "ns-put-working-text");
11689 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11690 "ns-unput-working-text");
11691 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11692 current-prefix-arg, as is done in `handle-switch-frame'.
11693 But `handle-switch-frame is not run from the special-map.
11694 Commands from that map are run in a special way that automatically
11695 preserves the prefix-arg. Restoring the prefix arg here is not just
11696 redundant but harmful:
11698 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11699 - after the first prompt, the exit-minibuffer-hook is run which may
11700 iconify a frame and thus push a `iconify-frame' event.
11701 - after running exit-minibuffer-hook, current-prefix-arg is
11702 restored to the non-nil value it had before the prompt.
11703 - we enter the second prompt.
11704 current-prefix-arg is non-nil, prefix-arg is nil.
11705 - before running the first real event, we run the special iconify-frame
11706 event, but we pass the `special' arg to execute-command so
11707 current-prefix-arg and prefix-arg are left untouched.
11708 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11709 - the next key event will have a spuriously non-nil current-prefix-arg. */
11710 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11712 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11714 /* Handling it at such a low-level causes read_key_sequence to get
11715 * confused because it doesn't realize that the current_buffer was
11716 * changed by read_char.
11718 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11719 * "handle-select-window"); */
11720 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11721 "handle-save-session");
11724 /* Define a special event which is raised for dbus callback
11726 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11727 "dbus-handle-event");
11730 #ifdef USE_FILE_NOTIFY
11731 /* Define a special event which is raised for notification callback
11733 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11734 "file-notify-handle-event");
11735 #endif /* USE_FILE_NOTIFY */
11737 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11739 #if defined (WINDOWSNT)
11740 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11743 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11744 "handle-focus-in");
11745 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11746 "handle-focus-out");
11749 /* Mark the pointers in the kboard objects.
11750 Called by Fgarbage_collect. */
11752 mark_kboards (void)
11756 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11758 if (kb
->kbd_macro_buffer
)
11759 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11761 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11762 mark_object (KVAR (kb
, Vlast_command
));
11763 mark_object (KVAR (kb
, Vreal_last_command
));
11764 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11765 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11766 mark_object (KVAR (kb
, Vprefix_arg
));
11767 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11768 mark_object (KVAR (kb
, kbd_queue
));
11769 mark_object (KVAR (kb
, defining_kbd_macro
));
11770 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11771 mark_object (KVAR (kb
, Vsystem_key_alist
));
11772 mark_object (KVAR (kb
, system_key_syms
));
11773 mark_object (KVAR (kb
, Vwindow_system
));
11774 mark_object (KVAR (kb
, Vinput_decode_map
));
11775 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11776 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11777 mark_object (KVAR (kb
, echo_string
));
11780 struct input_event
*event
;
11781 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11783 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11784 event
= kbd_buffer
;
11785 /* These two special event types has no Lisp_Objects to mark. */
11786 if (event
->kind
!= SELECTION_REQUEST_EVENT
11787 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11789 mark_object (event
->x
);
11790 mark_object (event
->y
);
11791 mark_object (event
->frame_or_window
);
11792 mark_object (event
->arg
);