1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2013 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include "termhooks.h"
34 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #if defined USABLE_FIONREAD && defined USG5_4
59 # include <sys/filio.h>
62 #include "syssignal.h"
64 #include <sys/types.h>
68 #ifdef HAVE_WINDOW_SYSTEM
70 #endif /* HAVE_WINDOW_SYSTEM */
72 /* Variables for blockinput.h: */
74 /* Positive if interrupt input is blocked right now. */
75 volatile int interrupt_input_blocked
;
77 /* True means an input interrupt or alarm signal has arrived.
78 The QUIT macro checks this. */
79 volatile bool pending_signals
;
81 #define KBD_BUFFER_SIZE 4096
83 KBOARD
*initial_kboard
;
84 KBOARD
*current_kboard
;
85 static KBOARD
*all_kboards
;
87 /* True in the single-kboard state, false in the any-kboard state. */
88 static bool single_kboard
;
90 /* Non-nil disable property on a command means
91 do not execute it; call disabled-command-function's value instead. */
92 Lisp_Object Qdisabled
;
93 static Lisp_Object Qdisabled_command_function
;
95 #define NUM_RECENT_KEYS (300)
97 /* Index for storing next element into recent_keys. */
98 static int recent_keys_index
;
100 /* Total number of elements stored into recent_keys. */
101 static int total_keys
;
103 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
104 static Lisp_Object recent_keys
;
106 /* Vector holding the key sequence that invoked the current command.
107 It is reused for each command, and it may be longer than the current
108 sequence; this_command_key_count indicates how many elements
109 actually mean something.
110 It's easier to staticpro a single Lisp_Object than an array. */
111 Lisp_Object this_command_keys
;
112 ptrdiff_t this_command_key_count
;
114 /* True after calling Freset_this_command_lengths.
115 Usually it is false. */
116 static bool this_command_key_count_reset
;
118 /* This vector is used as a buffer to record the events that were actually read
119 by read_key_sequence. */
120 static Lisp_Object raw_keybuf
;
121 static int raw_keybuf_count
;
123 #define GROW_RAW_KEYBUF \
124 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
125 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
127 /* Number of elements of this_command_keys
128 that precede this key sequence. */
129 static ptrdiff_t this_single_command_key_start
;
131 /* Record values of this_command_key_count and echo_length ()
132 before this command was read. */
133 static ptrdiff_t before_command_key_count
;
134 static ptrdiff_t before_command_echo_length
;
136 /* For longjmp to where kbd input is being done. */
138 static sys_jmp_buf getcjmp
;
140 /* True while doing kbd input. */
141 bool waiting_for_input
;
143 /* True while displaying for echoing. Delays C-g throwing. */
147 /* Non-null means we can start echoing at the next input pause even
148 though there is something in the echo area. */
150 static struct kboard
*ok_to_echo_at_next_pause
;
152 /* The kboard last echoing, or null for none. Reset to 0 in
153 cancel_echoing. If non-null, and a current echo area message
154 exists, and echo_message_buffer is eq to the current message
155 buffer, we know that the message comes from echo_kboard. */
157 struct kboard
*echo_kboard
;
159 /* The buffer used for echoing. Set in echo_now, reset in
162 Lisp_Object echo_message_buffer
;
164 /* True means C-g should cause immediate error-signal. */
167 /* Character that causes a quit. Normally C-g.
169 If we are running on an ordinary terminal, this must be an ordinary
170 ASCII char, since we want to make it our interrupt character.
172 If we are not running on an ordinary terminal, it still needs to be
173 an ordinary ASCII char. This character needs to be recognized in
174 the input interrupt handler. At this point, the keystroke is
175 represented as a struct input_event, while the desired quit
176 character is specified as a lispy event. The mapping from struct
177 input_events to lispy events cannot run in an interrupt handler,
178 and the reverse mapping is difficult for anything but ASCII
181 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
185 /* Current depth in recursive edits. */
186 EMACS_INT command_loop_level
;
188 /* If not Qnil, this is a switch-frame event which we decided to put
189 off until the end of a key sequence. This should be read as the
190 next command input, after any unread_command_events.
192 read_key_sequence uses this to delay switch-frame events until the
193 end of the key sequence; Fread_char uses it to put off switch-frame
194 events until a non-ASCII event is acceptable as input. */
195 Lisp_Object unread_switch_frame
;
197 /* Last size recorded for a current buffer which is not a minibuffer. */
198 static ptrdiff_t last_non_minibuf_size
;
200 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
201 uintmax_t num_input_events
;
203 /* Value of num_nonmacro_input_events as of last auto save. */
205 static EMACS_INT last_auto_save
;
207 /* The value of point when the last command was started. */
208 static ptrdiff_t last_point_position
;
210 /* The frame in which the last input event occurred, or Qmacro if the
211 last event came from a macro. We use this to determine when to
212 generate switch-frame events. This may be cleared by functions
213 like Fselect_frame, to make sure that a switch-frame event is
214 generated by the next character.
216 FIXME: This is modified by a signal handler so it should be volatile.
217 It's exported to Lisp, though, so it can't simply be marked
219 Lisp_Object internal_last_event_frame
;
221 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
222 static Lisp_Object Qhandle_select_window
;
223 Lisp_Object QPRIMARY
;
225 static Lisp_Object Qself_insert_command
;
226 static Lisp_Object Qforward_char
;
227 static Lisp_Object Qbackward_char
;
228 Lisp_Object Qundefined
;
229 static Lisp_Object Qtimer_event_handler
;
231 /* read_key_sequence stores here the command definition of the
232 key sequence that it reads. */
233 static Lisp_Object read_key_sequence_cmd
;
234 static Lisp_Object read_key_sequence_remapped
;
236 static Lisp_Object Qinput_method_function
;
238 static Lisp_Object Qdeactivate_mark
;
240 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
242 static Lisp_Object Qecho_area_clear_hook
;
244 /* Hooks to run before and after each command. */
245 static Lisp_Object Qpre_command_hook
;
246 static Lisp_Object Qpost_command_hook
;
248 static Lisp_Object Qdeferred_action_function
;
250 static Lisp_Object Qdelayed_warnings_hook
;
252 static Lisp_Object Qinput_method_exit_on_first_char
;
253 static Lisp_Object Qinput_method_use_echo_area
;
255 static Lisp_Object Qhelp_form_show
;
257 /* File in which we write all commands we read. */
258 static FILE *dribble
;
260 /* Nonzero if input is available. */
263 /* Circular buffer for pre-read keyboard input. */
265 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
267 /* Pointer to next available character in kbd_buffer.
268 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
269 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
270 next available char is in kbd_buffer[0]. */
271 static struct input_event
*kbd_fetch_ptr
;
273 /* Pointer to next place to store character in kbd_buffer. This
274 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
275 character should go in kbd_buffer[0]. */
276 static struct input_event
* volatile kbd_store_ptr
;
278 /* The above pair of variables forms a "queue empty" flag. When we
279 enqueue a non-hook event, we increment kbd_store_ptr. When we
280 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
281 there is input available if the two pointers are not equal.
283 Why not just have a flag set and cleared by the enqueuing and
284 dequeuing functions? Such a flag could be screwed up by interrupts
285 at inopportune times. */
287 /* Symbols to head events. */
288 static Lisp_Object Qmouse_movement
;
289 static Lisp_Object Qscroll_bar_movement
;
290 Lisp_Object Qswitch_frame
;
291 static Lisp_Object Qfocus_in
, Qfocus_out
;
292 static Lisp_Object Qdelete_frame
;
293 static Lisp_Object Qiconify_frame
;
294 static Lisp_Object Qmake_frame_visible
;
295 static Lisp_Object Qselect_window
;
296 Lisp_Object Qhelp_echo
;
298 static Lisp_Object Qmouse_fixup_help_message
;
300 /* Symbols to denote kinds of events. */
301 static Lisp_Object Qfunction_key
;
302 Lisp_Object Qmouse_click
;
304 Lisp_Object Qlanguage_change
;
306 static Lisp_Object Qdrag_n_drop
;
307 static Lisp_Object Qsave_session
;
309 static Lisp_Object Qdbus_event
;
311 #ifdef USE_FILE_NOTIFY
312 static Lisp_Object Qfile_notify
;
313 #endif /* USE_FILE_NOTIFY */
314 static Lisp_Object Qconfig_changed_event
;
316 /* Lisp_Object Qmouse_movement; - also an event header */
318 /* Properties of event headers. */
319 Lisp_Object Qevent_kind
;
320 static Lisp_Object Qevent_symbol_elements
;
322 /* Menu and tool bar item parts. */
323 static Lisp_Object Qmenu_enable
;
324 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
325 Lisp_Object QCfilter
;
327 /* Non-nil disable property on a command means
328 do not execute it; call disabled-command-function's value instead. */
329 Lisp_Object QCtoggle
, QCradio
;
330 static Lisp_Object QCbutton
, QClabel
;
332 static Lisp_Object QCvert_only
;
334 /* An event header symbol HEAD may have a property named
335 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
336 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
337 mask of modifiers applied to it. If present, this is used to help
338 speed up parse_modifiers. */
339 Lisp_Object Qevent_symbol_element_mask
;
341 /* An unmodified event header BASE may have a property named
342 Qmodifier_cache, which is an alist mapping modifier masks onto
343 modified versions of BASE. If present, this helps speed up
345 static Lisp_Object Qmodifier_cache
;
347 /* Symbols to use for parts of windows. */
348 Lisp_Object Qmode_line
;
349 Lisp_Object Qvertical_line
;
350 static Lisp_Object Qvertical_scroll_bar
;
351 Lisp_Object Qmenu_bar
;
353 static Lisp_Object Qecho_keystrokes
;
355 static void recursive_edit_unwind (Lisp_Object buffer
);
356 static Lisp_Object
command_loop (void);
357 static Lisp_Object Qcommand_execute
;
358 struct timespec
timer_check (void);
360 static void echo_now (void);
361 static ptrdiff_t echo_length (void);
363 static Lisp_Object Qpolling_period
;
365 /* Incremented whenever a timer is run. */
368 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
370 struct timespec
*input_available_clear_time
;
372 /* True means use SIGIO interrupts; false means use CBREAK mode.
373 Default is true if INTERRUPT_INPUT is defined. */
374 bool interrupt_input
;
376 /* Nonzero while interrupts are temporarily deferred during redisplay. */
377 bool interrupts_deferred
;
379 /* If we support a window system, turn on the code to poll periodically
380 to detect C-g. It isn't actually used when doing interrupt input. */
381 #ifdef HAVE_WINDOW_SYSTEM
382 #define POLL_FOR_INPUT
385 /* The time when Emacs started being idle. */
387 static struct timespec timer_idleness_start_time
;
389 /* After Emacs stops being idle, this saves the last value
390 of timer_idleness_start_time from when it was idle. */
392 static struct timespec timer_last_idleness_start_time
;
395 /* Global variable declarations. */
397 /* Flags for readable_events. */
398 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
399 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
400 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
402 /* Function for init_keyboard to call with no args (if nonzero). */
403 static void (*keyboard_init_hook
) (void);
405 static bool get_input_pending (int);
406 static bool readable_events (int);
407 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
408 Lisp_Object
, bool *);
409 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
410 static Lisp_Object
make_lispy_event (struct input_event
*);
411 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
412 enum scroll_bar_part
,
413 Lisp_Object
, Lisp_Object
,
415 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
416 Lisp_Object
, const char *const *,
417 Lisp_Object
*, ptrdiff_t);
418 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
419 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
420 #ifdef HAVE_WINDOW_SYSTEM
421 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
422 #endif /* HAVE_WINDOW_SYSTEM */
423 static bool help_char_p (Lisp_Object
);
424 static void save_getcjmp (sys_jmp_buf
);
425 static void restore_getcjmp (sys_jmp_buf
);
426 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
427 static void clear_event (struct input_event
*);
428 static void restore_kboard_configuration (int);
430 static void deliver_input_available_signal (int signo
);
432 static void handle_interrupt (bool);
433 static _Noreturn
void quit_throw_to_read_char (bool);
434 static void process_special_events (void);
435 static void timer_start_idle (void);
436 static void timer_stop_idle (void);
437 static void timer_resume_idle (void);
438 static void deliver_user_signal (int);
439 static char *find_user_signal_name (int);
440 static void store_user_signal_events (void);
442 /* These setters are used only in this file, so they can be private. */
444 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
446 kb
->INTERNAL_FIELD (echo_string
) = val
;
449 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
451 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
454 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
456 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
459 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
461 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
464 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
466 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
469 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
471 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
474 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
476 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
479 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
481 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
484 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
486 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
490 /* Add C to the echo string, without echoing it immediately. C can be
491 a character, which is pretty-printed, or a symbol, whose name is
495 echo_add_key (Lisp_Object c
)
497 int size
= KEY_DESCRIPTION_SIZE
+ 100;
498 char *buffer
= alloca (size
);
500 Lisp_Object echo_string
;
502 echo_string
= KVAR (current_kboard
, echo_string
);
504 /* If someone has passed us a composite event, use its head symbol. */
508 ptr
= push_key_description (XINT (c
), ptr
);
509 else if (SYMBOLP (c
))
511 Lisp_Object name
= SYMBOL_NAME (c
);
512 int nbytes
= SBYTES (name
);
514 if (size
- (ptr
- buffer
) < nbytes
)
516 int offset
= ptr
- buffer
;
517 size
= max (2 * size
, size
+ nbytes
);
518 buffer
= alloca (size
);
519 ptr
= buffer
+ offset
;
522 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
523 STRING_MULTIBYTE (name
), 1);
526 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
529 const char *text
= " (Type ? for further options)";
530 int len
= strlen (text
);
532 if (size
- (ptr
- buffer
) < len
)
534 int offset
= ptr
- buffer
;
536 buffer
= alloca (size
);
537 ptr
= buffer
+ offset
;
540 memcpy (ptr
, text
, len
);
544 /* Replace a dash from echo_dash with a space, otherwise add a space
545 at the end as a separator between keys. */
546 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
548 Lisp_Object last_char
, prev_char
, idx
;
550 idx
= make_number (SCHARS (echo_string
) - 2);
551 prev_char
= Faref (echo_string
, idx
);
553 idx
= make_number (SCHARS (echo_string
) - 1);
554 last_char
= Faref (echo_string
, idx
);
556 /* We test PREV_CHAR to make sure this isn't the echoing of a
558 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
559 Faset (echo_string
, idx
, make_number (' '));
561 echo_string
= concat2 (echo_string
, build_string (" "));
563 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
564 echo_string
= concat2 (echo_string
, build_string (" "));
568 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
571 /* Add C to the echo string, if echoing is going on. C can be a
572 character or a symbol. */
575 echo_char (Lisp_Object c
)
577 if (current_kboard
->immediate_echo
)
584 /* Temporarily add a dash to the end of the echo string if it's not
585 empty, so that it serves as a mini-prompt for the very next
591 /* Do nothing if not echoing at all. */
592 if (NILP (KVAR (current_kboard
, echo_string
)))
595 if (this_command_key_count
== 0)
598 if (!current_kboard
->immediate_echo
599 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
602 /* Do nothing if we just printed a prompt. */
603 if (current_kboard
->echo_after_prompt
604 == SCHARS (KVAR (current_kboard
, echo_string
)))
607 /* Do nothing if we have already put a dash at the end. */
608 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
610 Lisp_Object last_char
, prev_char
, idx
;
612 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
613 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
615 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
616 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
618 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
622 /* Put a dash at the end of the buffer temporarily,
623 but make it go away when the next character is added. */
626 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
630 /* Display the current echo string, and begin echoing if not already
636 if (!current_kboard
->immediate_echo
)
639 current_kboard
->immediate_echo
= 1;
641 for (i
= 0; i
< this_command_key_count
; i
++)
645 /* Set before_command_echo_length to the value that would
646 have been saved before the start of this subcommand in
647 command_loop_1, if we had already been echoing then. */
648 if (i
== this_single_command_key_start
)
649 before_command_echo_length
= echo_length ();
651 c
= AREF (this_command_keys
, i
);
652 if (! (EVENT_HAS_PARAMETERS (c
)
653 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
657 /* Set before_command_echo_length to the value that would
658 have been saved before the start of this subcommand in
659 command_loop_1, if we had already been echoing then. */
660 if (this_command_key_count
== this_single_command_key_start
)
661 before_command_echo_length
= echo_length ();
663 /* Put a dash at the end to invite the user to type more. */
668 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
669 message3_nolog (KVAR (current_kboard
, echo_string
));
672 /* Record in what buffer we echoed, and from which kboard. */
673 echo_message_buffer
= echo_area_buffer
[0];
674 echo_kboard
= current_kboard
;
676 if (waiting_for_input
&& !NILP (Vquit_flag
))
677 quit_throw_to_read_char (0);
680 /* Turn off echoing, for the start of a new command. */
683 cancel_echoing (void)
685 current_kboard
->immediate_echo
= 0;
686 current_kboard
->echo_after_prompt
= -1;
687 kset_echo_string (current_kboard
, Qnil
);
688 ok_to_echo_at_next_pause
= NULL
;
690 echo_message_buffer
= Qnil
;
693 /* Return the length of the current echo string. */
698 return (STRINGP (KVAR (current_kboard
, echo_string
))
699 ? SCHARS (KVAR (current_kboard
, echo_string
))
703 /* Truncate the current echo message to its first LEN chars.
704 This and echo_char get used by read_key_sequence when the user
705 switches frames while entering a key sequence. */
708 echo_truncate (ptrdiff_t nchars
)
710 if (STRINGP (KVAR (current_kboard
, echo_string
)))
711 kset_echo_string (current_kboard
,
712 Fsubstring (KVAR (current_kboard
, echo_string
),
713 make_number (0), make_number (nchars
)));
714 truncate_echo_area (nchars
);
718 /* Functions for manipulating this_command_keys. */
720 add_command_key (Lisp_Object key
)
722 #if 0 /* Not needed after we made Freset_this_command_lengths
723 do the job immediately. */
724 /* If reset-this-command-length was called recently, obey it now.
725 See the doc string of that function for an explanation of why. */
726 if (before_command_restore_flag
)
728 this_command_key_count
= before_command_key_count_1
;
729 if (this_command_key_count
< this_single_command_key_start
)
730 this_single_command_key_start
= this_command_key_count
;
731 echo_truncate (before_command_echo_length_1
);
732 before_command_restore_flag
= 0;
736 if (this_command_key_count
>= ASIZE (this_command_keys
))
737 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
739 ASET (this_command_keys
, this_command_key_count
, key
);
740 ++this_command_key_count
;
745 recursive_edit_1 (void)
747 ptrdiff_t count
= SPECPDL_INDEX ();
750 if (command_loop_level
> 0)
752 specbind (Qstandard_output
, Qt
);
753 specbind (Qstandard_input
, Qt
);
756 #ifdef HAVE_WINDOW_SYSTEM
757 /* The command loop has started an hourglass timer, so we have to
758 cancel it here, otherwise it will fire because the recursive edit
759 can take some time. Do not check for display_hourglass_p here,
760 because it could already be nil. */
764 /* This function may have been called from a debugger called from
765 within redisplay, for instance by Edebugging a function called
766 from fontification-functions. We want to allow redisplay in
767 the debugging session.
769 The recursive edit is left with a `(throw exit ...)'. The `exit'
770 tag is not caught anywhere in redisplay, i.e. when we leave the
771 recursive edit, the original redisplay leading to the recursive
772 edit will be unwound. The outcome should therefore be safe. */
773 specbind (Qinhibit_redisplay
, Qnil
);
776 val
= command_loop ();
778 Fsignal (Qquit
, Qnil
);
779 /* Handle throw from read_minibuf when using minibuffer
780 while it's active but we're in another window. */
782 xsignal1 (Qerror
, val
);
784 return unbind_to (count
, Qnil
);
787 /* When an auto-save happens, record the "time", and don't do again soon. */
790 record_auto_save (void)
792 last_auto_save
= num_nonmacro_input_events
;
795 /* Make an auto save happen as soon as possible at command level. */
799 force_auto_save_soon (void)
801 last_auto_save
= - auto_save_interval
- 1;
803 record_asynch_buffer_change ();
807 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
808 doc
: /* Invoke the editor command loop recursively.
809 To get out of the recursive edit, a command can do `(throw 'exit nil)';
810 that tells this function to return.
811 Alternatively, `(throw 'exit t)' makes this function signal an error.
812 This function is called by the editor initialization to begin editing. */)
815 ptrdiff_t count
= SPECPDL_INDEX ();
818 /* If we enter while input is blocked, don't lock up here.
819 This may happen through the debugger during redisplay. */
820 if (input_blocked_p ())
823 command_loop_level
++;
824 update_mode_lines
= 1;
826 if (command_loop_level
827 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
828 buffer
= Fcurrent_buffer ();
832 /* If we leave recursive_edit_1 below with a `throw' for instance,
833 like it is done in the splash screen display, we have to
834 make sure that we restore single_kboard as command_loop_1
835 would have done if it were left normally. */
836 if (command_loop_level
> 0)
837 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
838 record_unwind_protect (recursive_edit_unwind
, buffer
);
841 return unbind_to (count
, Qnil
);
845 recursive_edit_unwind (Lisp_Object buffer
)
847 if (BUFFERP (buffer
))
848 Fset_buffer (buffer
);
850 command_loop_level
--;
851 update_mode_lines
= 1;
855 #if 0 /* These two functions are now replaced with
856 temporarily_switch_to_single_kboard. */
860 #if 0 /* Theory: if there's anything in Vunread_command_events,
861 it will right away be read by read_key_sequence,
862 and then if we do switch KBOARDS, it will go into the side
863 queue then. So we don't need to do anything special here -- rms. */
864 if (CONSP (Vunread_command_events
))
866 current_kboard
->kbd_queue
867 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
868 current_kboard
->kbd_queue_has_data
= 1;
870 Vunread_command_events
= Qnil
;
875 /* Switch to the single-kboard state, making current_kboard
876 the only KBOARD from which further input is accepted. */
879 single_kboard_state ()
885 /* If we're in single_kboard state for kboard KBOARD,
889 not_single_kboard_state (KBOARD
*kboard
)
891 if (kboard
== current_kboard
)
895 /* Maintain a stack of kboards, so other parts of Emacs
896 can switch temporarily to the kboard of a given frame
897 and then revert to the previous status. */
902 struct kboard_stack
*next
;
905 static struct kboard_stack
*kboard_stack
;
908 push_kboard (struct kboard
*k
)
910 struct kboard_stack
*p
= xmalloc (sizeof *p
);
912 p
->next
= kboard_stack
;
913 p
->kboard
= current_kboard
;
923 struct kboard_stack
*p
= kboard_stack
;
925 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
927 if (t
->kboard
== p
->kboard
)
929 current_kboard
= p
->kboard
;
936 /* The terminal we remembered has been deleted. */
937 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
940 kboard_stack
= p
->next
;
944 /* Switch to single_kboard mode, making current_kboard the only KBOARD
945 from which further input is accepted. If F is non-nil, set its
946 KBOARD as the current keyboard.
948 This function uses record_unwind_protect_int to return to the previous
951 If Emacs is already in single_kboard mode, and F's keyboard is
952 locked, then this function will throw an error. */
955 temporarily_switch_to_single_kboard (struct frame
*f
)
957 bool was_locked
= single_kboard
;
960 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
961 /* We can not switch keyboards while in single_kboard mode.
962 In rare cases, Lisp code may call `recursive-edit' (or
963 `read-minibuffer' or `y-or-n-p') after it switched to a
964 locked frame. For example, this is likely to happen
965 when server.el connects to a new terminal while Emacs is in
966 single_kboard mode. It is best to throw an error instead
967 of presenting the user with a frozen screen. */
968 error ("Terminal %d is locked, cannot read from it",
969 FRAME_TERMINAL (f
)->id
);
971 /* This call is unnecessary, but helps
972 `restore_kboard_configuration' discover if somebody changed
973 `current_kboard' behind our back. */
974 push_kboard (current_kboard
);
977 current_kboard
= FRAME_KBOARD (f
);
979 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
982 #if 0 /* This function is not needed anymore. */
984 record_single_kboard_state ()
987 push_kboard (current_kboard
);
988 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
993 restore_kboard_configuration (int was_locked
)
995 single_kboard
= was_locked
;
998 struct kboard
*prev
= current_kboard
;
1000 /* The pop should not change the kboard. */
1001 if (single_kboard
&& current_kboard
!= prev
)
1007 /* Handle errors that are not handled at inner levels
1008 by printing an error message and returning to the editor command loop. */
1011 cmd_error (Lisp_Object data
)
1013 Lisp_Object old_level
, old_length
;
1014 char macroerror
[sizeof "After..kbd macro iterations: "
1015 + INT_STRLEN_BOUND (EMACS_INT
)];
1017 #ifdef HAVE_WINDOW_SYSTEM
1018 if (display_hourglass_p
)
1019 cancel_hourglass ();
1022 if (!NILP (executing_kbd_macro
))
1024 if (executing_kbd_macro_iterations
== 1)
1025 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1027 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1028 executing_kbd_macro_iterations
);
1033 Vstandard_output
= Qt
;
1034 Vstandard_input
= Qt
;
1035 Vexecuting_kbd_macro
= Qnil
;
1036 executing_kbd_macro
= Qnil
;
1037 kset_prefix_arg (current_kboard
, Qnil
);
1038 kset_last_prefix_arg (current_kboard
, Qnil
);
1041 /* Avoid unquittable loop if data contains a circular list. */
1042 old_level
= Vprint_level
;
1043 old_length
= Vprint_length
;
1044 XSETFASTINT (Vprint_level
, 10);
1045 XSETFASTINT (Vprint_length
, 10);
1046 cmd_error_internal (data
, macroerror
);
1047 Vprint_level
= old_level
;
1048 Vprint_length
= old_length
;
1051 Vinhibit_quit
= Qnil
;
1053 return make_number (0);
1056 /* Take actions on handling an error. DATA is the data that describes
1059 CONTEXT is a C-string containing ASCII characters only which
1060 describes the context in which the error happened. If we need to
1061 generalize CONTEXT to allow multibyte characters, make it a Lisp
1065 cmd_error_internal (Lisp_Object data
, const char *context
)
1067 struct frame
*sf
= SELECTED_FRAME ();
1069 /* The immediate context is not interesting for Quits,
1070 since they are asynchronous. */
1071 if (EQ (XCAR (data
), Qquit
))
1072 Vsignaling_function
= Qnil
;
1077 /* Use user's specified output function if any. */
1078 if (!NILP (Vcommand_error_function
))
1079 call3 (Vcommand_error_function
, data
,
1080 context
? build_string (context
) : empty_unibyte_string
,
1081 Vsignaling_function
);
1082 /* If the window system or terminal frame hasn't been initialized
1083 yet, or we're not interactive, write the message to stderr and exit. */
1084 else if (!sf
->glyphs_initialized_p
1085 /* The initial frame is a special non-displaying frame. It
1086 will be current in daemon mode when there are no frames
1087 to display, and in non-daemon mode before the real frame
1088 has finished initializing. If an error is thrown in the
1089 latter case while creating the frame, then the frame
1090 will never be displayed, so the safest thing to do is
1091 write to stderr and quit. In daemon mode, there are
1092 many other potential errors that do not prevent frames
1093 from being created, so continuing as normal is better in
1095 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1098 print_error_message (data
, Qexternal_debugging_output
,
1099 context
, Vsignaling_function
);
1100 Fterpri (Qexternal_debugging_output
);
1101 Fkill_emacs (make_number (-1));
1105 clear_message (1, 0);
1107 message_log_maybe_newline ();
1110 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1113 Vsignaling_function
= Qnil
;
1116 static Lisp_Object
command_loop_2 (Lisp_Object
);
1117 static Lisp_Object
top_level_1 (Lisp_Object
);
1119 /* Entry to editor-command-loop.
1120 This level has the catches for exiting/returning to editor command loop.
1121 It returns nil to exit recursive edit, t to abort it. */
1126 if (command_loop_level
> 0 || minibuf_level
> 0)
1129 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1130 executing_kbd_macro
= Qnil
;
1136 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1137 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1138 executing_kbd_macro
= Qnil
;
1140 /* End of file in -batch run causes exit here. */
1146 /* Here we catch errors in execution of commands within the
1147 editing loop, and reenter the editing loop.
1148 When there is an error, cmd_error runs and returns a non-nil
1149 value to us. A value of nil means that command_loop_1 itself
1150 returned due to end of file (or end of kbd macro). */
1153 command_loop_2 (Lisp_Object ignore
)
1155 register Lisp_Object val
;
1158 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1159 while (!NILP (val
));
1167 return Feval (Vtop_level
, Qnil
);
1171 top_level_1 (Lisp_Object ignore
)
1173 /* On entry to the outer level, run the startup file. */
1174 if (!NILP (Vtop_level
))
1175 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1176 else if (!NILP (Vpurify_flag
))
1177 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1179 message1 ("Bare Emacs (standard Lisp code not loaded)");
1183 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1184 doc
: /* Exit all recursive editing levels.
1185 This also exits all active minibuffers. */)
1188 #ifdef HAVE_WINDOW_SYSTEM
1189 if (display_hourglass_p
)
1190 cancel_hourglass ();
1193 /* Unblock input if we enter with input blocked. This may happen if
1194 redisplay traps e.g. during tool-bar update with input blocked. */
1195 totally_unblock_input ();
1197 Fthrow (Qtop_level
, Qnil
);
1200 static _Noreturn
void
1201 user_error (const char *msg
)
1203 xsignal1 (Quser_error
, build_string (msg
));
1207 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1208 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1211 if (command_loop_level
> 0 || minibuf_level
> 0)
1212 Fthrow (Qexit
, Qnil
);
1214 user_error ("No recursive edit is in progress");
1218 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1219 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1222 if (command_loop_level
> 0 || minibuf_level
> 0)
1225 user_error ("No recursive edit is in progress");
1228 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1229 of this function. */
1232 tracking_off (Lisp_Object old_value
)
1234 do_mouse_tracking
= old_value
;
1235 if (NILP (old_value
))
1237 /* Redisplay may have been preempted because there was input
1238 available, and it assumes it will be called again after the
1239 input has been processed. If the only input available was
1240 the sort that we have just disabled, then we need to call
1242 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1244 redisplay_preserve_echo_area (6);
1245 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1250 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1251 doc
: /* Evaluate BODY with mouse movement events enabled.
1252 Within a `track-mouse' form, mouse motion generates input events that
1253 you can read with `read-event'.
1254 Normally, mouse motion is ignored.
1255 usage: (track-mouse BODY...) */)
1258 ptrdiff_t count
= SPECPDL_INDEX ();
1261 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1263 do_mouse_tracking
= Qt
;
1265 val
= Fprogn (args
);
1266 return unbind_to (count
, val
);
1269 /* If mouse has moved on some frame, return one of those frames.
1273 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1274 after resizing the tool-bar window. */
1276 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1279 bool ignore_mouse_drag_p
;
1281 static struct frame
*
1282 some_mouse_moved (void)
1284 Lisp_Object tail
, frame
;
1286 if (ignore_mouse_drag_p
)
1288 /* ignore_mouse_drag_p = 0; */
1292 FOR_EACH_FRAME (tail
, frame
)
1294 if (XFRAME (frame
)->mouse_moved
)
1295 return XFRAME (frame
);
1302 /* This is the actual command reading loop,
1303 sans error-handling encapsulation. */
1305 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1306 bool, bool, bool, bool);
1307 void safe_run_hooks (Lisp_Object
);
1308 static void adjust_point_for_property (ptrdiff_t, bool);
1310 /* The last boundary auto-added to buffer-undo-list. */
1311 Lisp_Object last_undo_boundary
;
1313 /* FIXME: This is wrong rather than test window-system, we should call
1314 a new set-selection, which will then dispatch to x-set-selection, or
1315 tty-set-selection, or w32-set-selection, ... */
1318 command_loop_1 (void)
1321 Lisp_Object keybuf
[30];
1323 EMACS_INT prev_modiff
= 0;
1324 struct buffer
*prev_buffer
= NULL
;
1325 bool already_adjusted
= 0;
1327 kset_prefix_arg (current_kboard
, Qnil
);
1328 kset_last_prefix_arg (current_kboard
, Qnil
);
1329 Vdeactivate_mark
= Qnil
;
1330 waiting_for_input
= 0;
1333 this_command_key_count
= 0;
1334 this_command_key_count_reset
= 0;
1335 this_single_command_key_start
= 0;
1337 if (NILP (Vmemory_full
))
1339 /* Make sure this hook runs after commands that get errors and
1340 throw to top level. */
1341 /* Note that the value cell will never directly contain nil
1342 if the symbol is a local variable. */
1343 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1344 safe_run_hooks (Qpost_command_hook
);
1346 /* If displaying a message, resize the echo area window to fit
1347 that message's size exactly. */
1348 if (!NILP (echo_area_buffer
[0]))
1349 resize_echo_area_exactly ();
1351 /* If there are warnings waiting, process them. */
1352 if (!NILP (Vdelayed_warnings_list
))
1353 safe_run_hooks (Qdelayed_warnings_hook
);
1355 if (!NILP (Vdeferred_action_list
))
1356 safe_run_hooks (Qdeferred_action_function
);
1359 /* Do this after running Vpost_command_hook, for consistency. */
1360 kset_last_command (current_kboard
, Vthis_command
);
1361 kset_real_last_command (current_kboard
, Vreal_this_command
);
1362 if (!CONSP (last_command_event
))
1363 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1367 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1370 /* Make sure the current window's buffer is selected. */
1371 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1373 /* Display any malloc warning that just came out. Use while because
1374 displaying one warning can cause another. */
1376 while (pending_malloc_warning
)
1377 display_malloc_warning ();
1379 Vdeactivate_mark
= Qnil
;
1381 /* Don't ignore mouse movements for more than a single command
1382 loop. (This flag is set in xdisp.c whenever the tool bar is
1383 resized, because the resize moves text up or down, and would
1384 generate false mouse drag events if we don't ignore them.) */
1385 ignore_mouse_drag_p
= 0;
1387 /* If minibuffer on and echo area in use,
1388 wait a short time and redraw minibuffer. */
1391 && !NILP (echo_area_buffer
[0])
1392 && EQ (minibuf_window
, echo_area_window
)
1393 && NUMBERP (Vminibuffer_message_timeout
))
1395 /* Bind inhibit-quit to t so that C-g gets read in
1396 rather than quitting back to the minibuffer. */
1397 ptrdiff_t count
= SPECPDL_INDEX ();
1398 specbind (Qinhibit_quit
, Qt
);
1400 sit_for (Vminibuffer_message_timeout
, 0, 2);
1402 /* Clear the echo area. */
1404 safe_run_hooks (Qecho_area_clear_hook
);
1406 unbind_to (count
, Qnil
);
1408 /* If a C-g came in before, treat it as input now. */
1409 if (!NILP (Vquit_flag
))
1412 Vunread_command_events
= list1 (make_number (quit_char
));
1416 /* If it has changed current-menubar from previous value,
1417 really recompute the menubar from the value. */
1418 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1419 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1420 call0 (Qrecompute_lucid_menubar
);
1422 before_command_key_count
= this_command_key_count
;
1423 before_command_echo_length
= echo_length ();
1425 Vthis_command
= Qnil
;
1426 Vreal_this_command
= Qnil
;
1427 Vthis_original_command
= Qnil
;
1428 Vthis_command_keys_shift_translated
= Qnil
;
1430 /* Read next key sequence; i gets its length. */
1431 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1434 /* A filter may have run while we were reading the input. */
1435 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1437 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1441 /* Now we have read a key sequence of length I,
1442 or else I is 0 and we found end of file. */
1444 if (i
== 0) /* End of file -- happens only in */
1445 return Qnil
; /* a kbd macro, at the end. */
1446 /* -1 means read_key_sequence got a menu that was rejected.
1447 Just loop around and read another command. */
1451 this_command_key_count
= 0;
1452 this_command_key_count_reset
= 0;
1453 this_single_command_key_start
= 0;
1457 last_command_event
= keybuf
[i
- 1];
1459 /* If the previous command tried to force a specific window-start,
1460 forget about that, in case this command moves point far away
1461 from that position. But also throw away beg_unchanged and
1462 end_unchanged information in that case, so that redisplay will
1463 update the whole window properly. */
1464 if (XWINDOW (selected_window
)->force_start
)
1467 XWINDOW (selected_window
)->force_start
= 0;
1468 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1469 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1472 cmd
= read_key_sequence_cmd
;
1473 if (!NILP (Vexecuting_kbd_macro
))
1475 if (!NILP (Vquit_flag
))
1477 Vexecuting_kbd_macro
= Qt
;
1478 QUIT
; /* Make some noise. */
1479 /* Will return since macro now empty. */
1483 /* Do redisplay processing after this command except in special
1484 cases identified below. */
1485 prev_buffer
= current_buffer
;
1486 prev_modiff
= MODIFF
;
1487 last_point_position
= PT
;
1489 /* By default, we adjust point to a boundary of a region that
1490 has such a property that should be treated intangible
1491 (e.g. composition, display). But, some commands will set
1492 this variable differently. */
1493 Vdisable_point_adjustment
= Qnil
;
1495 /* Process filters and timers may have messed with deactivate-mark.
1496 reset it before we execute the command. */
1497 Vdeactivate_mark
= Qnil
;
1499 /* Remap command through active keymaps. */
1500 Vthis_original_command
= cmd
;
1501 if (!NILP (read_key_sequence_remapped
))
1502 cmd
= read_key_sequence_remapped
;
1504 /* Execute the command. */
1506 Vthis_command
= cmd
;
1507 Vreal_this_command
= cmd
;
1508 safe_run_hooks (Qpre_command_hook
);
1510 already_adjusted
= 0;
1512 if (NILP (Vthis_command
))
1514 /* nil means key is undefined. */
1515 Lisp_Object keys
= Fvector (i
, keybuf
);
1516 keys
= Fkey_description (keys
, Qnil
);
1518 message_with_string ("%s is undefined", keys
, 0);
1519 kset_defining_kbd_macro (current_kboard
, Qnil
);
1520 update_mode_lines
= 1;
1521 /* If this is a down-mouse event, don't reset prefix-arg;
1522 pass it to the command run by the up event. */
1523 if (EVENT_HAS_PARAMETERS (last_command_event
))
1525 Lisp_Object breakdown
1526 = parse_modifiers (EVENT_HEAD (last_command_event
));
1527 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1528 if (!(modifiers
& down_modifier
))
1529 kset_prefix_arg (current_kboard
, Qnil
);
1532 kset_prefix_arg (current_kboard
, Qnil
);
1536 /* Here for a command that isn't executed directly. */
1538 #ifdef HAVE_WINDOW_SYSTEM
1539 ptrdiff_t scount
= SPECPDL_INDEX ();
1541 if (display_hourglass_p
1542 && NILP (Vexecuting_kbd_macro
))
1544 record_unwind_protect_void (cancel_hourglass
);
1549 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1551 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1554 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1555 ? Qnil
: BVAR (current_buffer
, undo_list
));
1557 call1 (Qcommand_execute
, Vthis_command
);
1559 #ifdef HAVE_WINDOW_SYSTEM
1560 /* Do not check display_hourglass_p here, because
1561 `command-execute' could change it, but we should cancel
1562 hourglass cursor anyway.
1563 But don't cancel the hourglass within a macro
1564 just because a command in the macro finishes. */
1565 if (NILP (Vexecuting_kbd_macro
))
1566 unbind_to (scount
, Qnil
);
1569 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1571 safe_run_hooks (Qpost_command_hook
);
1573 /* If displaying a message, resize the echo area window to fit
1574 that message's size exactly. */
1575 if (!NILP (echo_area_buffer
[0]))
1576 resize_echo_area_exactly ();
1578 /* If there are warnings waiting, process them. */
1579 if (!NILP (Vdelayed_warnings_list
))
1580 safe_run_hooks (Qdelayed_warnings_hook
);
1582 safe_run_hooks (Qdeferred_action_function
);
1584 /* If there is a prefix argument,
1585 1) We don't want Vlast_command to be ``universal-argument''
1586 (that would be dumb), so don't set Vlast_command,
1587 2) we want to leave echoing on so that the prefix will be
1588 echoed as part of this key sequence, so don't call
1590 3) we want to leave this_command_key_count non-zero, so that
1591 read_char will realize that it is re-reading a character, and
1592 not echo it a second time.
1594 If the command didn't actually create a prefix arg,
1595 but is merely a frame event that is transparent to prefix args,
1596 then the above doesn't apply. */
1597 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1598 || CONSP (last_command_event
))
1600 kset_last_command (current_kboard
, Vthis_command
);
1601 kset_real_last_command (current_kboard
, Vreal_this_command
);
1602 if (!CONSP (last_command_event
))
1603 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1605 this_command_key_count
= 0;
1606 this_command_key_count_reset
= 0;
1607 this_single_command_key_start
= 0;
1610 if (!NILP (BVAR (current_buffer
, mark_active
))
1611 && !NILP (Vrun_hooks
))
1613 /* In Emacs 22, setting transient-mark-mode to `only' was a
1614 way of turning it on for just one command. This usage is
1615 obsolete, but support it anyway. */
1616 if (EQ (Vtransient_mark_mode
, Qidentity
))
1617 Vtransient_mark_mode
= Qnil
;
1618 else if (EQ (Vtransient_mark_mode
, Qonly
))
1619 Vtransient_mark_mode
= Qidentity
;
1621 if (!NILP (Vdeactivate_mark
))
1622 /* If `select-active-regions' is non-nil, this call to
1623 `deactivate-mark' also sets the PRIMARY selection. */
1624 call0 (Qdeactivate_mark
);
1627 /* Even if not deactivating the mark, set PRIMARY if
1628 `select-active-regions' is non-nil. */
1629 if (!NILP (Fwindow_system (Qnil
))
1630 /* Even if mark_active is non-nil, the actual buffer
1631 marker may not have been set yet (Bug#7044). */
1632 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1633 && (EQ (Vselect_active_regions
, Qonly
)
1634 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1635 : (!NILP (Vselect_active_regions
)
1636 && !NILP (Vtransient_mark_mode
)))
1637 && NILP (Fmemq (Vthis_command
,
1638 Vselection_inhibit_update_commands
)))
1641 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1644 call2 (Qx_set_selection
, QPRIMARY
,
1645 make_buffer_string (beg
, end
, 0));
1647 call2 (Qx_set_selection
, QPRIMARY
,
1648 make_buffer_string (end
, beg
, 0));
1649 /* Don't set empty selections. */
1652 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1654 Lisp_Object hook
= intern ("activate-mark-hook");
1655 Frun_hooks (1, &hook
);
1659 Vsaved_region_selection
= Qnil
;
1664 if (current_buffer
== prev_buffer
1665 && last_point_position
!= PT
1666 && NILP (Vdisable_point_adjustment
)
1667 && NILP (Vglobal_disable_point_adjustment
))
1669 if (last_point_position
> BEGV
1670 && last_point_position
< ZV
1671 && (composition_adjust_point (last_point_position
,
1672 last_point_position
)
1673 != last_point_position
))
1674 /* The last point was temporarily set within a grapheme
1675 cluster to prevent automatic composition. To recover
1676 the automatic composition, we must update the
1678 windows_or_buffers_changed
++;
1679 if (!already_adjusted
)
1680 adjust_point_for_property (last_point_position
,
1681 MODIFF
!= prev_modiff
);
1684 /* Install chars successfully executed in kbd macro. */
1686 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1687 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1688 finalize_kbd_macro_chars ();
1693 read_menu_command (void)
1695 Lisp_Object keybuf
[30];
1696 ptrdiff_t count
= SPECPDL_INDEX ();
1699 /* We don't want to echo the keystrokes while navigating the
1701 specbind (Qecho_keystrokes
, make_number (0));
1703 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1706 unbind_to (count
, Qnil
);
1708 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1710 if (i
== 0 || i
== -1)
1713 return read_key_sequence_cmd
;
1716 /* Adjust point to a boundary of a region that has such a property
1717 that should be treated intangible. For the moment, we check
1718 `composition', `display' and `invisible' properties.
1719 LAST_PT is the last position of point. */
1722 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1725 Lisp_Object val
, overlay
, tmp
;
1726 /* When called after buffer modification, we should temporarily
1727 suppress the point adjustment for automatic composition so that a
1728 user can keep inserting another character at point or keep
1729 deleting characters around point. */
1730 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1731 ptrdiff_t orig_pt
= PT
;
1733 /* FIXME: cycling is probably not necessary because these properties
1734 can't be usefully combined anyway. */
1735 while (check_composition
|| check_display
|| check_invisible
)
1737 /* FIXME: check `intangible'. */
1738 if (check_composition
1739 && PT
> BEGV
&& PT
< ZV
1740 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1743 check_display
= check_invisible
= 1;
1745 check_composition
= 0;
1747 && PT
> BEGV
&& PT
< ZV
1748 && !NILP (val
= get_char_property_and_overlay
1749 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1750 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1751 && (!OVERLAYP (overlay
)
1752 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1753 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1754 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1755 && (beg
< PT
/* && end > PT <- It's always the case. */
1756 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1759 SET_PT (PT
< last_pt
1760 ? (STRINGP (val
) && SCHARS (val
) == 0
1761 ? max (beg
- 1, BEGV
)
1764 check_composition
= check_invisible
= 1;
1767 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1773 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1776 /* FIXME: We should stop if we find a spot between
1777 two runs of `invisible' where inserted text would
1778 be visible. This is important when we have two
1779 invisible boundaries that enclose an area: if the
1780 area is empty, we need this test in order to make
1781 it possible to place point in the middle rather
1782 than skip both boundaries. However, this code
1783 also stops anywhere in a non-sticky text-property,
1784 which breaks (e.g.) Org mode. */
1785 && (val
= get_pos_property (make_number (end
),
1787 TEXT_PROP_MEANS_INVISIBLE (val
))
1789 && !NILP (val
= get_char_property_and_overlay
1790 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1791 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1793 ellipsis
= ellipsis
|| inv
> 1
1794 || (OVERLAYP (overlay
)
1795 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1796 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1797 tmp
= Fnext_single_char_property_change
1798 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1799 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1803 && (val
= get_pos_property (make_number (beg
),
1805 TEXT_PROP_MEANS_INVISIBLE (val
))
1807 && !NILP (val
= get_char_property_and_overlay
1808 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1809 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1811 ellipsis
= ellipsis
|| inv
> 1
1812 || (OVERLAYP (overlay
)
1813 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1814 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1815 tmp
= Fprevious_single_char_property_change
1816 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1817 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1820 /* Move away from the inside area. */
1821 if (beg
< PT
&& end
> PT
)
1823 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1824 /* We haven't moved yet (so we don't need to fear
1825 infinite-looping) and we were outside the range
1826 before (so either end of the range still corresponds
1827 to a move in the right direction): pretend we moved
1828 less than we actually did, so that we still have
1829 more freedom below in choosing which end of the range
1831 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1832 /* We either have moved already or the last point
1833 was already in the range: we don't get to choose
1834 which end of the range we have to go to. */
1835 : (PT
< last_pt
? beg
: end
));
1836 check_composition
= check_display
= 1;
1838 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1839 the point to something other than its argument, due to
1840 point-motion hooks, intangibility, etc. */
1841 eassert (PT
== beg
|| PT
== end
);
1844 /* Pretend the area doesn't exist if the buffer is not
1846 if (!modified
&& !ellipsis
&& beg
< end
)
1848 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1849 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1850 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1851 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1852 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1853 /* We've already moved as far as we can. Trying to go
1854 to the other end would mean moving backwards and thus
1855 could lead to an infinite loop. */
1857 else if (val
= get_pos_property (make_number (PT
),
1859 TEXT_PROP_MEANS_INVISIBLE (val
)
1860 && (val
= get_pos_property
1861 (make_number (PT
== beg
? end
: beg
),
1863 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1864 (check_composition
= check_display
= 1,
1865 SET_PT (PT
== beg
? end
: beg
));
1868 check_invisible
= 0;
1872 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1875 safe_run_hooks_1 (void)
1877 eassert (CONSP (Vinhibit_quit
));
1878 return call0 (XCDR (Vinhibit_quit
));
1881 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1885 safe_run_hooks_error (Lisp_Object error_data
)
1888 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1889 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1890 Lisp_Object args
[4];
1891 args
[0] = build_string ("Error in %s (%S): %S");
1894 args
[3] = error_data
;
1900 Lisp_Object newval
= Qnil
;
1901 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1902 if (EQ (fun
, XCAR (val
)))
1905 newval
= Fcons (XCAR (val
), newval
);
1907 return Fset (hook
, Fnreverse (newval
));
1908 /* Not found in the local part of the hook. Let's look at the global
1911 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1912 : Fdefault_value (hook
));
1913 CONSP (val
); val
= XCDR (val
))
1914 if (EQ (fun
, XCAR (val
)))
1917 newval
= Fcons (XCAR (val
), newval
);
1919 return Fset_default (hook
, Fnreverse (newval
));
1925 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1927 eassert (nargs
== 1);
1928 if (CONSP (Vinhibit_quit
))
1929 XSETCDR (Vinhibit_quit
, args
[0]);
1931 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1933 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1937 /* If we get an error while running the hook, cause the hook variable
1938 to be nil. Also inhibit quits, so that C-g won't cause the hook
1939 to mysteriously evaporate. */
1942 safe_run_hooks (Lisp_Object hook
)
1944 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1945 to its body or to its handlers other than via globals such as
1946 dynamically-bound variables ;-) */
1947 ptrdiff_t count
= SPECPDL_INDEX ();
1948 specbind (Qinhibit_quit
, hook
);
1950 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1952 unbind_to (count
, Qnil
);
1956 /* Nonzero means polling for input is temporarily suppressed. */
1958 int poll_suppress_count
;
1961 #ifdef POLL_FOR_INPUT
1963 /* Asynchronous timer for polling. */
1965 static struct atimer
*poll_timer
;
1967 /* Poll for input, so that we catch a C-g if it comes in. This
1968 function is called from x_make_frame_visible, see comment
1972 poll_for_input_1 (void)
1974 if (! input_blocked_p ()
1975 && !waiting_for_input
)
1979 /* Timer callback function for poll_timer. TIMER is equal to
1983 poll_for_input (struct atimer
*timer
)
1985 if (poll_suppress_count
== 0)
1986 pending_signals
= 1;
1989 #endif /* POLL_FOR_INPUT */
1991 /* Begin signals to poll for input, if they are appropriate.
1992 This function is called unconditionally from various places. */
1995 start_polling (void)
1997 #ifdef POLL_FOR_INPUT
1998 /* XXX This condition was (read_socket_hook && !interrupt_input),
1999 but read_socket_hook is not global anymore. Let's pretend that
2001 if (!interrupt_input
)
2003 /* Turn alarm handling on unconditionally. It might have
2004 been turned off in process.c. */
2005 turn_on_atimers (1);
2007 /* If poll timer doesn't exist, are we need one with
2008 a different interval, start a new one. */
2009 if (poll_timer
== NULL
2010 || poll_timer
->interval
.tv_sec
!= polling_period
)
2012 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2013 struct timespec interval
= make_timespec (period
, 0);
2016 cancel_atimer (poll_timer
);
2018 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2019 poll_for_input
, NULL
);
2022 /* Let the timer's callback function poll for input
2023 if this becomes zero. */
2024 --poll_suppress_count
;
2029 /* True if we are using polling to handle input asynchronously. */
2032 input_polling_used (void)
2034 #ifdef POLL_FOR_INPUT
2035 /* XXX This condition was (read_socket_hook && !interrupt_input),
2036 but read_socket_hook is not global anymore. Let's pretend that
2038 return !interrupt_input
;
2044 /* Turn off polling. */
2049 #ifdef POLL_FOR_INPUT
2050 /* XXX This condition was (read_socket_hook && !interrupt_input),
2051 but read_socket_hook is not global anymore. Let's pretend that
2053 if (!interrupt_input
)
2054 ++poll_suppress_count
;
2058 /* Set the value of poll_suppress_count to COUNT
2059 and start or stop polling accordingly. */
2062 set_poll_suppress_count (int count
)
2064 #ifdef POLL_FOR_INPUT
2065 if (count
== 0 && poll_suppress_count
!= 0)
2067 poll_suppress_count
= 1;
2070 else if (count
!= 0 && poll_suppress_count
== 0)
2074 poll_suppress_count
= count
;
2078 /* Bind polling_period to a value at least N.
2079 But don't decrease it. */
2082 bind_polling_period (int n
)
2084 #ifdef POLL_FOR_INPUT
2085 EMACS_INT
new = polling_period
;
2090 stop_other_atimers (poll_timer
);
2092 specbind (Qpolling_period
, make_number (new));
2093 /* Start a new alarm with the new period. */
2098 /* Apply the control modifier to CHARACTER. */
2104 make_ctrl_char (int c
)
2106 /* Save the upper bits here. */
2107 int upper
= c
& ~0177;
2109 if (! ASCII_BYTE_P (c
))
2110 return c
|= ctrl_modifier
;
2114 /* Everything in the columns containing the upper-case letters
2115 denotes a control character. */
2116 if (c
>= 0100 && c
< 0140)
2120 /* Set the shift modifier for a control char
2121 made from a shifted letter. But only for letters! */
2122 if (oc
>= 'A' && oc
<= 'Z')
2123 c
|= shift_modifier
;
2126 /* The lower-case letters denote control characters too. */
2127 else if (c
>= 'a' && c
<= 'z')
2130 /* Include the bits for control and shift
2131 only if the basic ASCII code can't indicate them. */
2135 /* Replace the high bits. */
2136 c
|= (upper
& ~ctrl_modifier
);
2141 /* Display the help-echo property of the character after the mouse pointer.
2142 Either show it in the echo area, or call show-help-function to display
2143 it by other means (maybe in a tooltip).
2145 If HELP is nil, that means clear the previous help echo.
2147 If HELP is a string, display that string. If HELP is a function,
2148 call it with OBJECT and POS as arguments; the function should
2149 return a help string or nil for none. For all other types of HELP,
2150 evaluate it to obtain a string.
2152 WINDOW is the window in which the help was generated, if any.
2153 It is nil if not in a window.
2155 If OBJECT is a buffer, POS is the position in the buffer where the
2156 `help-echo' text property was found.
2158 If OBJECT is an overlay, that overlay has a `help-echo' property,
2159 and POS is the position in the overlay's buffer under the mouse.
2161 If OBJECT is a string (an overlay string or a string displayed with
2162 the `display' property). POS is the position in that string under
2165 Note: this function may only be called with HELP nil or a string
2166 from X code running asynchronously. */
2169 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2172 if (!NILP (help
) && !STRINGP (help
))
2174 if (FUNCTIONP (help
))
2175 help
= safe_call (4, help
, window
, object
, pos
);
2177 help
= safe_eval (help
);
2179 if (!STRINGP (help
))
2183 if (!noninteractive
&& STRINGP (help
))
2185 /* The mouse-fixup-help-message Lisp function can call
2186 mouse_position_hook, which resets the mouse_moved flags.
2187 This causes trouble if we are trying to read a mouse motion
2188 event (i.e., if we are inside a `track-mouse' form), so we
2189 restore the mouse_moved flag. */
2190 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2191 help
= call1 (Qmouse_fixup_help_message
, help
);
2196 if (STRINGP (help
) || NILP (help
))
2198 if (!NILP (Vshow_help_function
))
2199 call1 (Vshow_help_function
, help
);
2200 help_echo_showing_p
= STRINGP (help
);
2206 /* Input of single characters from keyboard */
2208 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2209 struct timespec
*end_time
);
2210 static void record_char (Lisp_Object c
);
2212 static Lisp_Object help_form_saved_window_configs
;
2214 read_char_help_form_unwind (void)
2216 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2217 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2218 if (!NILP (window_config
))
2219 Fset_window_configuration (window_config
);
2222 #define STOP_POLLING \
2223 do { if (! polling_stopped_here) stop_polling (); \
2224 polling_stopped_here = 1; } while (0)
2226 #define RESUME_POLLING \
2227 do { if (polling_stopped_here) start_polling (); \
2228 polling_stopped_here = 0; } while (0)
2231 read_event_from_main_queue (struct timespec
*end_time
,
2232 sys_jmp_buf local_getcjmp
,
2233 bool *used_mouse_menu
)
2235 Lisp_Object c
= Qnil
;
2236 sys_jmp_buf save_jump
;
2237 KBOARD
*kb
IF_LINT (= NULL
);
2241 /* Read from the main queue, and if that gives us something we can't use yet,
2242 we put it on the appropriate side queue and try again. */
2244 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2247 /* Actually read a character, waiting if necessary. */
2248 save_getcjmp (save_jump
);
2249 restore_getcjmp (local_getcjmp
);
2251 timer_start_idle ();
2252 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2253 restore_getcjmp (save_jump
);
2255 if (! NILP (c
) && (kb
!= current_kboard
))
2257 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2260 while (CONSP (XCDR (last
)))
2262 if (!NILP (XCDR (last
)))
2266 kset_kbd_queue (kb
, list1 (c
));
2268 XSETCDR (last
, list1 (c
));
2269 kb
->kbd_queue_has_data
= 1;
2273 current_kboard
= kb
;
2274 /* This is going to exit from read_char
2275 so we had better get rid of this frame's stuff. */
2276 return make_number (-2);
2279 /* Terminate Emacs in batch mode if at eof. */
2280 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2281 Fkill_emacs (make_number (1));
2285 /* Add in any extra modifiers, where appropriate. */
2286 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2287 || ((extra_keyboard_modifiers
& 0177) < ' '
2288 && (extra_keyboard_modifiers
& 0177) != 0))
2289 XSETINT (c
, make_ctrl_char (XINT (c
)));
2291 /* Transfer any other modifier bits directly from
2292 extra_keyboard_modifiers to c. Ignore the actual character code
2293 in the low 16 bits of extra_keyboard_modifiers. */
2294 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2302 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2305 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2306 sys_jmp_buf local_getcjmp
,
2307 Lisp_Object prev_event
,
2308 bool *used_mouse_menu
)
2310 #define MAX_ENCODED_BYTES 16
2311 Lisp_Object events
[MAX_ENCODED_BYTES
];
2316 = read_event_from_main_queue (end_time
, local_getcjmp
,
2319 /* w32_console already returns decoded events. It either reads
2320 Unicode characters from the Windows keyboard input, or
2321 converts characters encoded in the current codepage into
2322 Unicode. See w32inevt.c:key_event, near its end. */
2325 struct frame
*frame
= XFRAME (selected_frame
);
2326 struct terminal
*terminal
= frame
->terminal
;
2327 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2328 /* Don't apply decoding if we're just reading a raw event
2329 (e.g. reading bytes sent by the xterm to specify the position
2330 of a mouse click). */
2331 && (!EQ (prev_event
, Qt
))
2332 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2333 & CODING_REQUIRE_DECODING_MASK
)))
2334 return nextevt
; /* No decoding needed. */
2337 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2338 eassert (n
< MAX_ENCODED_BYTES
);
2339 events
[n
++] = nextevt
;
2340 if (NATNUMP (nextevt
)
2341 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2342 { /* An encoded byte sequence, let's try to decode it. */
2343 struct coding_system
*coding
2344 = TERMINAL_KEYBOARD_CODING (terminal
);
2345 unsigned char *src
= alloca (n
);
2347 for (i
= 0; i
< n
; i
++)
2348 src
[i
] = XINT (events
[i
]);
2350 for (i
= 0; i
< n
; i
++)
2352 coding
->destination
= alloca (n
* 4);
2353 coding
->dst_bytes
= n
* 4;
2354 decode_coding_c_string (coding
, src
, n
, Qnil
);
2355 eassert (coding
->produced_char
<= n
);
2356 if (coding
->produced_char
== 0)
2357 { /* The encoded sequence is incomplete. */
2358 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2359 continue; /* Read on! */
2363 const unsigned char *p
= coding
->destination
;
2364 eassert (coding
->carryover_bytes
== 0);
2366 while (n
< coding
->produced_char
)
2367 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2370 /* Now `events' should hold decoded events.
2371 Normally, n should be equal to 1, but better not rely on it.
2372 We can only return one event here, so return the first we
2373 had and keep the others (if any) for later. */
2375 Vunread_command_events
2376 = Fcons (events
[--n
], Vunread_command_events
);
2383 /* Read a character from the keyboard; call the redisplay if needed. */
2384 /* commandflag 0 means do not autosave, but do redisplay.
2385 -1 means do not redisplay, but do autosave.
2386 -2 means do neither.
2389 /* The arguments MAP is for menu prompting. MAP is a keymap.
2391 PREV_EVENT is the previous input event, or nil if we are reading
2392 the first event of a key sequence (or not reading a key sequence).
2393 If PREV_EVENT is t, that is a "magic" value that says
2394 not to run input methods, but in other respects to act as if
2395 not reading a key sequence.
2397 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2398 if we used a mouse menu to read the input, or false otherwise. If
2399 USED_MOUSE_MENU is null, don't dereference it.
2401 Value is -2 when we find input on another keyboard. A second call
2402 to read_char will read it.
2404 If END_TIME is non-null, it is a pointer to a struct timespec
2405 specifying the maximum time to wait until. If no input arrives by
2406 that time, stop waiting and return nil.
2408 Value is t if we showed a menu and the user rejected it. */
2411 read_char (int commandflag
, Lisp_Object map
,
2412 Lisp_Object prev_event
,
2413 bool *used_mouse_menu
, struct timespec
*end_time
)
2417 sys_jmp_buf local_getcjmp
;
2418 sys_jmp_buf save_jump
;
2419 Lisp_Object tem
, save
;
2420 volatile Lisp_Object previous_echo_area_message
;
2421 volatile Lisp_Object also_record
;
2422 volatile bool reread
;
2423 struct gcpro gcpro1
, gcpro2
;
2424 bool volatile polling_stopped_here
= 0;
2425 struct kboard
*orig_kboard
= current_kboard
;
2429 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2430 before_command_key_count
= this_command_key_count
;
2431 before_command_echo_length
= echo_length ();
2434 previous_echo_area_message
= Qnil
;
2436 GCPRO2 (c
, previous_echo_area_message
);
2441 if (CONSP (Vunread_post_input_method_events
))
2443 c
= XCAR (Vunread_post_input_method_events
);
2444 Vunread_post_input_method_events
2445 = XCDR (Vunread_post_input_method_events
);
2447 /* Undo what read_char_x_menu_prompt did when it unread
2448 additional keys returned by Fx_popup_menu. */
2450 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2458 if (CONSP (Vunread_command_events
))
2460 bool was_disabled
= 0;
2462 c
= XCAR (Vunread_command_events
);
2463 Vunread_command_events
= XCDR (Vunread_command_events
);
2467 /* Undo what sit-for did when it unread additional keys
2468 inside universal-argument. */
2471 && EQ (XCAR (c
), Qt
))
2477 /* Undo what read_char_x_menu_prompt did when it unread
2478 additional keys returned by Fx_popup_menu. */
2480 && EQ (XCDR (c
), Qdisabled
)
2481 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2487 /* If the queued event is something that used the mouse,
2488 set used_mouse_menu accordingly. */
2490 /* Also check was_disabled so last-nonmenu-event won't return
2491 a bad value when submenus are involved. (Bug#447) */
2492 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2493 *used_mouse_menu
= 1;
2495 goto reread_for_input_method
;
2498 if (CONSP (Vunread_input_method_events
))
2500 c
= XCAR (Vunread_input_method_events
);
2501 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2503 /* Undo what read_char_x_menu_prompt did when it unread
2504 additional keys returned by Fx_popup_menu. */
2506 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2510 goto reread_for_input_method
;
2513 this_command_key_count_reset
= 0;
2515 if (!NILP (Vexecuting_kbd_macro
))
2517 /* We set this to Qmacro; since that's not a frame, nobody will
2518 try to switch frames on us, and the selected window will
2521 Since this event came from a macro, it would be misleading to
2522 leave internal_last_event_frame set to wherever the last
2523 real event came from. Normally, a switch-frame event selects
2524 internal_last_event_frame after each command is read, but
2525 events read from a macro should never cause a new frame to be
2527 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2529 /* Exit the macro if we are at the end.
2530 Also, some things replace the macro with t
2531 to force an early exit. */
2532 if (EQ (Vexecuting_kbd_macro
, Qt
)
2533 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2539 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2540 if (STRINGP (Vexecuting_kbd_macro
)
2541 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2542 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2544 executing_kbd_macro_index
++;
2549 if (!NILP (unread_switch_frame
))
2551 c
= unread_switch_frame
;
2552 unread_switch_frame
= Qnil
;
2554 /* This event should make it into this_command_keys, and get echoed
2555 again, so we do not set `reread'. */
2559 /* If redisplay was requested. */
2560 if (commandflag
>= 0)
2562 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2564 /* If there is pending input, process any events which are not
2565 user-visible, such as X selection_request events. */
2567 || detect_input_pending_run_timers (0))
2568 swallow_events (0); /* May clear input_pending. */
2570 /* Redisplay if no pending input. */
2571 while (!input_pending
)
2573 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2574 redisplay_preserve_echo_area (5);
2579 /* Normal case: no input arrived during redisplay. */
2582 /* Input arrived and pre-empted redisplay.
2583 Process any events which are not user-visible. */
2585 /* If that cleared input_pending, try again to redisplay. */
2588 /* Prevent the redisplay we just did
2589 from messing up echoing of the input after the prompt. */
2590 if (commandflag
== 0 && echo_current
)
2591 echo_message_buffer
= echo_area_buffer
[0];
2595 /* Message turns off echoing unless more keystrokes turn it on again.
2597 The code in 20.x for the condition was
2599 1. echo_area_glyphs && *echo_area_glyphs
2600 2. && echo_area_glyphs != current_kboard->echobuf
2601 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2603 (1) means there's a current message displayed
2605 (2) means it's not the message from echoing from the current
2608 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2609 is set to a non-null value. This is done in read_char and it is
2610 set to echo_area_glyphs after a call to echo_char. That means
2611 ok_to_echo_at_next_pause is either null or
2612 current_kboard->echobuf with the appropriate current_kboard at
2615 So, condition (3) means in clear text ok_to_echo_at_next_pause
2616 must be either null, or the current message isn't from echoing at
2617 all, or it's from echoing from a different kboard than the
2620 if (/* There currently is something in the echo area. */
2621 !NILP (echo_area_buffer
[0])
2622 && (/* It's an echo from a different kboard. */
2623 echo_kboard
!= current_kboard
2624 /* Or we explicitly allow overwriting whatever there is. */
2625 || ok_to_echo_at_next_pause
== NULL
))
2630 /* Try reading a character via menu prompting in the minibuf.
2631 Try this before the sit-for, because the sit-for
2632 would do the wrong thing if we are supposed to do
2633 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2634 after a mouse event so don't try a minibuf menu. */
2636 if (KEYMAPP (map
) && INTERACTIVE
2637 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2638 /* Don't bring up a menu if we already have another event. */
2639 && NILP (Vunread_command_events
)
2640 && !detect_input_pending_run_timers (0))
2642 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2644 if (INTEGERP (c
) && XINT (c
) == -2)
2645 return c
; /* wrong_kboard_jmpbuf */
2651 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2652 We will do that below, temporarily for short sections of code,
2653 when appropriate. local_getcjmp must be in effect
2654 around any call to sit_for or kbd_buffer_get_event;
2655 it *must not* be in effect when we call redisplay. */
2657 jmpcount
= SPECPDL_INDEX ();
2658 if (sys_setjmp (local_getcjmp
))
2660 /* Handle quits while reading the keyboard. */
2661 /* We must have saved the outer value of getcjmp here,
2662 so restore it now. */
2663 restore_getcjmp (save_jump
);
2664 unbind_to (jmpcount
, Qnil
);
2665 XSETINT (c
, quit_char
);
2666 internal_last_event_frame
= selected_frame
;
2667 Vlast_event_frame
= internal_last_event_frame
;
2668 /* If we report the quit char as an event,
2669 don't do so more than once. */
2670 if (!NILP (Vinhibit_quit
))
2674 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2675 if (kb
!= current_kboard
)
2677 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2678 /* We shouldn't get here if we were in single-kboard mode! */
2683 while (CONSP (XCDR (last
)))
2685 if (!NILP (XCDR (last
)))
2689 kset_kbd_queue (kb
, list1 (c
));
2691 XSETCDR (last
, list1 (c
));
2692 kb
->kbd_queue_has_data
= 1;
2693 current_kboard
= kb
;
2694 /* This is going to exit from read_char
2695 so we had better get rid of this frame's stuff. */
2697 return make_number (-2); /* wrong_kboard_jmpbuf */
2703 /* Start idle timers if no time limit is supplied. We don't do it
2704 if a time limit is supplied to avoid an infinite recursion in the
2705 situation where an idle timer calls `sit-for'. */
2708 timer_start_idle ();
2710 /* If in middle of key sequence and minibuffer not active,
2711 start echoing if enough time elapses. */
2713 if (minibuf_level
== 0
2715 && !current_kboard
->immediate_echo
2716 && this_command_key_count
> 0
2718 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2719 && NILP (Fzerop (Vecho_keystrokes
))
2720 && (/* No message. */
2721 NILP (echo_area_buffer
[0])
2722 /* Or empty message. */
2723 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2724 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2725 /* Or already echoing from same kboard. */
2726 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2727 /* Or not echoing before and echoing allowed. */
2728 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2730 /* After a mouse event, start echoing right away.
2731 This is because we are probably about to display a menu,
2732 and we don't want to delay before doing so. */
2733 if (EVENT_HAS_PARAMETERS (prev_event
))
2739 save_getcjmp (save_jump
);
2740 restore_getcjmp (local_getcjmp
);
2741 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2742 restore_getcjmp (save_jump
);
2744 && ! CONSP (Vunread_command_events
))
2749 /* Maybe auto save due to number of keystrokes. */
2751 if (commandflag
!= 0 && commandflag
!= -2
2752 && auto_save_interval
> 0
2753 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2754 && !detect_input_pending_run_timers (0))
2756 Fdo_auto_save (Qnil
, Qnil
);
2757 /* Hooks can actually change some buffers in auto save. */
2761 /* Try reading using an X menu.
2762 This is never confused with reading using the minibuf
2763 because the recursive call of read_char in read_char_minibuf_menu_prompt
2764 does not pass on any keymaps. */
2766 if (KEYMAPP (map
) && INTERACTIVE
2767 && !NILP (prev_event
)
2768 && EVENT_HAS_PARAMETERS (prev_event
)
2769 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2770 && !EQ (XCAR (prev_event
), Qtool_bar
)
2771 /* Don't bring up a menu if we already have another event. */
2772 && NILP (Vunread_command_events
))
2774 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2776 /* Now that we have read an event, Emacs is not idle. */
2783 /* Maybe autosave and/or garbage collect due to idleness. */
2785 if (INTERACTIVE
&& NILP (c
))
2788 ptrdiff_t buffer_size
;
2790 /* Slow down auto saves logarithmically in size of current buffer,
2791 and garbage collect while we're at it. */
2792 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2793 last_non_minibuf_size
= Z
- BEG
;
2794 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2796 while (buffer_size
> 64)
2797 delay_level
++, buffer_size
-= buffer_size
>> 2;
2798 if (delay_level
< 4) delay_level
= 4;
2799 /* delay_level is 4 for files under around 50k, 7 at 100k,
2800 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2802 /* Auto save if enough time goes by without input. */
2803 if (commandflag
!= 0 && commandflag
!= -2
2804 && num_nonmacro_input_events
> last_auto_save
2805 && INTEGERP (Vauto_save_timeout
)
2806 && XINT (Vauto_save_timeout
) > 0)
2809 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2811 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2812 timeout
= delay_level
* timeout
/ 4;
2813 save_getcjmp (save_jump
);
2814 restore_getcjmp (local_getcjmp
);
2815 tem0
= sit_for (make_number (timeout
), 1, 1);
2816 restore_getcjmp (save_jump
);
2819 && ! CONSP (Vunread_command_events
))
2821 Fdo_auto_save (Qnil
, Qnil
);
2826 /* If there is still no input available, ask for GC. */
2827 if (!detect_input_pending_run_timers (0))
2831 /* Notify the caller if an autosave hook, or a timer, sentinel or
2832 filter in the sit_for calls above have changed the current
2833 kboard. This could happen if they use the minibuffer or start a
2834 recursive edit, like the fancy splash screen in server.el's
2835 filter. If this longjmp wasn't here, read_key_sequence would
2836 interpret the next key sequence using the wrong translation
2837 tables and function keymaps. */
2838 if (NILP (c
) && current_kboard
!= orig_kboard
)
2841 return make_number (-2); /* wrong_kboard_jmpbuf */
2844 /* If this has become non-nil here, it has been set by a timer
2845 or sentinel or filter. */
2846 if (CONSP (Vunread_command_events
))
2848 c
= XCAR (Vunread_command_events
);
2849 Vunread_command_events
= XCDR (Vunread_command_events
);
2852 /* Read something from current KBOARD's side queue, if possible. */
2856 if (current_kboard
->kbd_queue_has_data
)
2858 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2860 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2861 kset_kbd_queue (current_kboard
,
2862 XCDR (KVAR (current_kboard
, kbd_queue
)));
2863 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2864 current_kboard
->kbd_queue_has_data
= 0;
2865 input_pending
= readable_events (0);
2866 if (EVENT_HAS_PARAMETERS (c
)
2867 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2868 internal_last_event_frame
= XCAR (XCDR (c
));
2869 Vlast_event_frame
= internal_last_event_frame
;
2873 /* If current_kboard's side queue is empty check the other kboards.
2874 If one of them has data that we have not yet seen here,
2875 switch to it and process the data waiting for it.
2877 Note: if the events queued up for another kboard
2878 have already been seen here, and therefore are not a complete command,
2879 the kbd_queue_has_data field is 0, so we skip that kboard here.
2880 That's to avoid an infinite loop switching between kboards here. */
2881 if (NILP (c
) && !single_kboard
)
2884 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2885 if (kb
->kbd_queue_has_data
)
2887 current_kboard
= kb
;
2888 /* This is going to exit from read_char
2889 so we had better get rid of this frame's stuff. */
2891 return make_number (-2); /* wrong_kboard_jmpbuf */
2901 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2902 prev_event
, used_mouse_menu
);
2903 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2905 if (EQ (c
, make_number (-2)))
2907 /* This is going to exit from read_char
2908 so we had better get rid of this frame's stuff. */
2922 if (commandflag
>= 0
2923 && !input_pending
&& !detect_input_pending_run_timers (0))
2929 /* Buffer switch events are only for internal wakeups
2930 so don't show them to the user.
2931 Also, don't record a key if we already did. */
2935 /* Process special events within read_char
2936 and loop around to read another event. */
2939 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2944 struct buffer
*prev_buffer
= current_buffer
;
2945 last_input_event
= c
;
2946 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2948 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2949 /* We stopped being idle for this event; undo that. This
2950 prevents automatic window selection (under
2951 mouse_autoselect_window from acting as a real input event, for
2952 example banishing the mouse under mouse-avoidance-mode. */
2953 timer_resume_idle ();
2955 if (current_buffer
!= prev_buffer
)
2957 /* The command may have changed the keymaps. Pretend there
2958 is input in another keyboard and return. This will
2959 recalculate keymaps. */
2960 c
= make_number (-2);
2967 /* Handle things that only apply to characters. */
2970 /* If kbd_buffer_get_event gave us an EOF, return that. */
2974 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2975 && UNSIGNED_CMP (XFASTINT (c
), <,
2976 SCHARS (KVAR (current_kboard
,
2977 Vkeyboard_translate_table
))))
2978 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2979 && UNSIGNED_CMP (XFASTINT (c
), <,
2980 ASIZE (KVAR (current_kboard
,
2981 Vkeyboard_translate_table
))))
2982 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2986 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2987 /* nil in keyboard-translate-table means no translation. */
2993 /* If this event is a mouse click in the menu bar,
2994 return just menu-bar for now. Modify the mouse click event
2995 so we won't do this twice, then queue it up. */
2996 if (EVENT_HAS_PARAMETERS (c
)
2998 && CONSP (EVENT_START (c
))
2999 && CONSP (XCDR (EVENT_START (c
))))
3003 posn
= POSN_POSN (EVENT_START (c
));
3004 /* Handle menu-bar events:
3005 insert the dummy prefix event `menu-bar'. */
3006 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3008 /* Change menu-bar to (menu-bar) as the event "position". */
3009 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3012 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3017 /* Store these characters into recent_keys, the dribble file if any,
3018 and the keyboard macro being defined, if any. */
3020 if (! NILP (also_record
))
3021 record_char (also_record
);
3023 /* Wipe the echo area.
3024 But first, if we are about to use an input method,
3025 save the echo area contents for it to refer to. */
3027 && ! NILP (Vinput_method_function
)
3028 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3030 previous_echo_area_message
= Fcurrent_message ();
3031 Vinput_method_previous_message
= previous_echo_area_message
;
3034 /* Now wipe the echo area, except for help events which do their
3035 own stuff with the echo area. */
3037 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3038 && !(EQ (Qswitch_frame
, XCAR (c
)))
3039 /* Don't wipe echo area for select window events: These might
3040 get delayed via `mouse-autoselect-window' (Bug#11304). */
3041 && !(EQ (Qselect_window
, XCAR (c
)))))
3043 if (!NILP (echo_area_buffer
[0]))
3045 safe_run_hooks (Qecho_area_clear_hook
);
3046 clear_message (1, 0);
3050 reread_for_input_method
:
3052 /* Pass this to the input method, if appropriate. */
3054 && ! NILP (Vinput_method_function
)
3055 /* Don't run the input method within a key sequence,
3056 after the first event of the key sequence. */
3057 && NILP (prev_event
)
3058 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3061 ptrdiff_t key_count
;
3062 bool key_count_reset
;
3063 struct gcpro gcpro1
;
3064 ptrdiff_t count
= SPECPDL_INDEX ();
3066 /* Save the echo status. */
3067 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3068 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3069 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3070 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3073 if (before_command_restore_flag
)
3075 this_command_key_count
= before_command_key_count_1
;
3076 if (this_command_key_count
< this_single_command_key_start
)
3077 this_single_command_key_start
= this_command_key_count
;
3078 echo_truncate (before_command_echo_length_1
);
3079 before_command_restore_flag
= 0;
3083 /* Save the this_command_keys status. */
3084 key_count
= this_command_key_count
;
3085 key_count_reset
= this_command_key_count_reset
;
3088 keys
= Fcopy_sequence (this_command_keys
);
3093 /* Clear out this_command_keys. */
3094 this_command_key_count
= 0;
3095 this_command_key_count_reset
= 0;
3097 /* Now wipe the echo area. */
3098 if (!NILP (echo_area_buffer
[0]))
3099 safe_run_hooks (Qecho_area_clear_hook
);
3100 clear_message (1, 0);
3103 /* If we are not reading a key sequence,
3104 never use the echo area. */
3107 specbind (Qinput_method_use_echo_area
, Qt
);
3110 /* Call the input method. */
3111 tem
= call1 (Vinput_method_function
, c
);
3113 tem
= unbind_to (count
, tem
);
3115 /* Restore the saved echoing state
3116 and this_command_keys state. */
3117 this_command_key_count
= key_count
;
3118 this_command_key_count_reset
= key_count_reset
;
3120 this_command_keys
= keys
;
3123 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3124 kset_echo_string (current_kboard
, saved_echo_string
);
3125 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3126 if (saved_immediate_echo
)
3131 /* The input method can return no events. */
3134 /* Bring back the previous message, if any. */
3135 if (! NILP (previous_echo_area_message
))
3136 message_with_string ("%s", previous_echo_area_message
, 0);
3139 /* It returned one event or more. */
3141 Vunread_post_input_method_events
3142 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3147 /* Display help if not echoing. */
3148 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3150 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3151 Lisp_Object help
, object
, position
, window
, htem
;
3153 htem
= Fcdr (XCDR (c
));
3156 window
= Fcar (htem
);
3158 object
= Fcar (htem
);
3160 position
= Fcar (htem
);
3162 show_help_echo (help
, window
, object
, position
);
3164 /* We stopped being idle for this event; undo that. */
3166 timer_resume_idle ();
3170 if ((! reread
|| this_command_key_count
== 0
3171 || this_command_key_count_reset
)
3175 /* Don't echo mouse motion events. */
3176 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3177 && NILP (Fzerop (Vecho_keystrokes
))
3178 && ! (EVENT_HAS_PARAMETERS (c
)
3179 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3182 if (! NILP (also_record
))
3183 echo_char (also_record
);
3184 /* Once we reread a character, echoing can happen
3185 the next time we pause to read a new one. */
3186 ok_to_echo_at_next_pause
= current_kboard
;
3189 /* Record this character as part of the current key. */
3190 add_command_key (c
);
3191 if (! NILP (also_record
))
3192 add_command_key (also_record
);
3195 last_input_event
= c
;
3198 /* Process the help character specially if enabled. */
3199 if (!NILP (Vhelp_form
) && help_char_p (c
))
3201 ptrdiff_t count
= SPECPDL_INDEX ();
3203 help_form_saved_window_configs
3204 = Fcons (Fcurrent_window_configuration (Qnil
),
3205 help_form_saved_window_configs
);
3206 record_unwind_protect_void (read_char_help_form_unwind
);
3207 call0 (Qhelp_form_show
);
3212 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3213 if (EVENT_HAS_PARAMETERS (c
)
3214 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3215 XSETCAR (help_form_saved_window_configs
, Qnil
);
3217 while (BUFFERP (c
));
3218 /* Remove the help from the frame. */
3219 unbind_to (count
, Qnil
);
3222 if (EQ (c
, make_number (040)))
3226 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3227 while (BUFFERP (c
));
3238 /* Record a key that came from a mouse menu.
3239 Record it for echoing, for this-command-keys, and so on. */
3242 record_menu_key (Lisp_Object c
)
3244 /* Wipe the echo area. */
3245 clear_message (1, 0);
3250 before_command_key_count
= this_command_key_count
;
3251 before_command_echo_length
= echo_length ();
3254 /* Don't echo mouse motion events. */
3255 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3256 && NILP (Fzerop (Vecho_keystrokes
)))
3260 /* Once we reread a character, echoing can happen
3261 the next time we pause to read a new one. */
3262 ok_to_echo_at_next_pause
= 0;
3265 /* Record this character as part of the current key. */
3266 add_command_key (c
);
3268 /* Re-reading in the middle of a command */
3269 last_input_event
= c
;
3273 #endif /* HAVE_MENUS */
3275 /* Return true if should recognize C as "the help character". */
3278 help_char_p (Lisp_Object c
)
3282 if (EQ (c
, Vhelp_char
))
3284 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3285 if (EQ (c
, XCAR (tail
)))
3290 /* Record the input event C in various ways. */
3293 record_char (Lisp_Object c
)
3297 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3299 /* To avoid filling recent_keys with help-echo and mouse-movement
3300 events, we filter out repeated help-echo events, only store the
3301 first and last in a series of mouse-movement events, and don't
3302 store repeated help-echo events which are only separated by
3303 mouse-movement events. */
3305 Lisp_Object ev1
, ev2
, ev3
;
3308 if ((ix1
= recent_keys_index
- 1) < 0)
3309 ix1
= NUM_RECENT_KEYS
- 1;
3310 ev1
= AREF (recent_keys
, ix1
);
3312 if ((ix2
= ix1
- 1) < 0)
3313 ix2
= NUM_RECENT_KEYS
- 1;
3314 ev2
= AREF (recent_keys
, ix2
);
3316 if ((ix3
= ix2
- 1) < 0)
3317 ix3
= NUM_RECENT_KEYS
- 1;
3318 ev3
= AREF (recent_keys
, ix3
);
3320 if (EQ (XCAR (c
), Qhelp_echo
))
3322 /* Don't record `help-echo' in recent_keys unless it shows some help
3323 message, and a different help than the previously recorded
3325 Lisp_Object help
, last_help
;
3327 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3328 if (!STRINGP (help
))
3330 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3331 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3333 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3334 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3335 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3337 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3338 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3339 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3340 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3343 else if (EQ (XCAR (c
), Qmouse_movement
))
3345 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3346 So additional mouse movement events replace the last element. */
3347 Lisp_Object last_window
, window
;
3349 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3350 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3351 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3352 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3353 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3355 ASET (recent_keys
, ix1
, c
);
3361 store_kbd_macro_char (c
);
3365 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3366 ASET (recent_keys
, recent_keys_index
, c
);
3367 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3368 recent_keys_index
= 0;
3370 else if (recorded
< 0)
3372 /* We need to remove one or two events from recent_keys.
3373 To do this, we simply put nil at those events and move the
3374 recent_keys_index backwards over those events. Usually,
3375 users will never see those nil events, as they will be
3376 overwritten by the command keys entered to see recent_keys
3379 while (recorded
++ < 0 && total_keys
> 0)
3381 if (total_keys
< NUM_RECENT_KEYS
)
3383 if (--recent_keys_index
< 0)
3384 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3385 ASET (recent_keys
, recent_keys_index
, Qnil
);
3389 num_nonmacro_input_events
++;
3391 /* Write c to the dribble file. If c is a lispy event, write
3392 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3393 If you, dear reader, have a better idea, you've got the source. :-) */
3399 if (XUINT (c
) < 0x100)
3400 putc (XUINT (c
), dribble
);
3402 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3406 Lisp_Object dribblee
;
3408 /* If it's a structured event, take the event header. */
3409 dribblee
= EVENT_HEAD (c
);
3411 if (SYMBOLP (dribblee
))
3413 putc ('<', dribble
);
3414 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3415 SBYTES (SYMBOL_NAME (dribblee
)),
3417 putc ('>', dribble
);
3426 /* Copy out or in the info on where C-g should throw to.
3427 This is used when running Lisp code from within get_char,
3428 in case get_char is called recursively.
3429 See read_process_output. */
3432 save_getcjmp (sys_jmp_buf temp
)
3434 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3438 restore_getcjmp (sys_jmp_buf temp
)
3440 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3443 /* Low level keyboard/mouse input.
3444 kbd_buffer_store_event places events in kbd_buffer, and
3445 kbd_buffer_get_event retrieves them. */
3447 /* Return true if there are any events in the queue that read-char
3448 would return. If this returns false, a read-char would block. */
3450 readable_events (int flags
)
3452 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3455 /* If the buffer contains only FOCUS_IN_EVENT events, and
3456 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3457 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3459 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3460 #ifdef USE_TOOLKIT_SCROLL_BARS
3461 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3465 struct input_event
*event
;
3467 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3474 #ifdef USE_TOOLKIT_SCROLL_BARS
3475 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3477 event
->kind
== FOCUS_IN_EVENT
)
3478 #ifdef USE_TOOLKIT_SCROLL_BARS
3479 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3480 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3481 && event
->part
== scroll_bar_handle
3482 && event
->modifiers
== 0)
3487 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3490 while (event
!= kbd_store_ptr
);
3496 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3497 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3501 if (current_kboard
->kbd_queue_has_data
)
3507 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3508 if (kb
->kbd_queue_has_data
)
3514 /* Set this for debugging, to have a way to get out */
3515 int stop_character EXTERNALLY_VISIBLE
;
3518 event_to_kboard (struct input_event
*event
)
3520 /* Not applicable for these special events. */
3521 if (event
->kind
== SELECTION_REQUEST_EVENT
3522 || event
->kind
== SELECTION_CLEAR_EVENT
)
3526 Lisp_Object obj
= event
->frame_or_window
;
3527 /* There are some events that set this field to nil or string. */
3529 obj
= WINDOW_FRAME (XWINDOW (obj
));
3530 /* Also ignore dead frames here. */
3531 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3532 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3537 /* Return the number of slots occupied in kbd_buffer. */
3540 kbd_buffer_nr_stored (void)
3542 return kbd_fetch_ptr
== kbd_store_ptr
3544 : (kbd_fetch_ptr
< kbd_store_ptr
3545 ? kbd_store_ptr
- kbd_fetch_ptr
3546 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3547 + (kbd_store_ptr
- kbd_buffer
)));
3549 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3552 kbd_buffer_store_event (register struct input_event
*event
)
3554 kbd_buffer_store_event_hold (event
, 0);
3557 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3559 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3560 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3561 Else, if EVENT is a quit event, store the quit event
3562 in HOLD_QUIT, and return (thus ignoring further events).
3564 This is used to postpone the processing of the quit event until all
3565 subsequent input events have been parsed (and discarded). */
3568 kbd_buffer_store_event_hold (register struct input_event
*event
,
3569 struct input_event
*hold_quit
)
3571 if (event
->kind
== NO_EVENT
)
3574 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3577 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3579 register int c
= event
->code
& 0377;
3581 if (event
->modifiers
& ctrl_modifier
)
3582 c
= make_ctrl_char (c
);
3584 c
|= (event
->modifiers
3585 & (meta_modifier
| alt_modifier
3586 | hyper_modifier
| super_modifier
));
3590 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3591 struct input_event
*sp
;
3593 if (single_kboard
&& kb
!= current_kboard
)
3596 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3598 kb
->kbd_queue_has_data
= 1;
3599 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3601 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3604 if (event_to_kboard (sp
) == kb
)
3606 sp
->kind
= NO_EVENT
;
3607 sp
->frame_or_window
= Qnil
;
3616 *hold_quit
= *event
;
3620 /* If this results in a quit_char being returned to Emacs as
3621 input, set Vlast_event_frame properly. If this doesn't
3622 get returned to Emacs as an event, the next event read
3623 will set Vlast_event_frame again, so this is safe to do. */
3627 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3629 focus
= event
->frame_or_window
;
3630 internal_last_event_frame
= focus
;
3631 Vlast_event_frame
= focus
;
3634 handle_interrupt (0);
3638 if (c
&& c
== stop_character
)
3644 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3645 Just ignore the second one. */
3646 else if (event
->kind
== BUFFER_SWITCH_EVENT
3647 && kbd_fetch_ptr
!= kbd_store_ptr
3648 && ((kbd_store_ptr
== kbd_buffer
3649 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3650 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3653 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3654 kbd_store_ptr
= kbd_buffer
;
3656 /* Don't let the very last slot in the buffer become full,
3657 since that would make the two pointers equal,
3658 and that is indistinguishable from an empty buffer.
3659 Discard the event if it would fill the last slot. */
3660 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3662 *kbd_store_ptr
= *event
;
3665 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3667 /* Don't read keyboard input until we have processed kbd_buffer.
3668 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3669 hold_keyboard_input ();
3670 if (!noninteractive
)
3674 #endif /* subprocesses */
3677 /* If we're inside while-no-input, and this event qualifies
3678 as input, set quit-flag to cause an interrupt. */
3679 if (!NILP (Vthrow_on_input
)
3680 && event
->kind
!= FOCUS_IN_EVENT
3681 && event
->kind
!= HELP_EVENT
3682 && event
->kind
!= DEICONIFY_EVENT
)
3684 Vquit_flag
= Vthrow_on_input
;
3685 /* If we're inside a function that wants immediate quits,
3687 if (immediate_quit
&& NILP (Vinhibit_quit
))
3696 /* Put an input event back in the head of the event queue. */
3699 kbd_buffer_unget_event (register struct input_event
*event
)
3701 if (kbd_fetch_ptr
== kbd_buffer
)
3702 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3704 /* Don't let the very last slot in the buffer become full, */
3705 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3708 *kbd_fetch_ptr
= *event
;
3713 /* Generate a HELP_EVENT input_event and store it in the keyboard
3716 HELP is the help form.
3718 FRAME and WINDOW are the frame and window where the help is
3719 generated. OBJECT is the Lisp object where the help was found (a
3720 buffer, a string, an overlay, or nil if neither from a string nor
3721 from a buffer). POS is the position within OBJECT where the help
3725 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3726 Lisp_Object object
, ptrdiff_t pos
)
3728 struct input_event event
;
3732 event
.kind
= HELP_EVENT
;
3733 event
.frame_or_window
= frame
;
3735 event
.x
= WINDOWP (window
) ? window
: frame
;
3738 kbd_buffer_store_event (&event
);
3742 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3745 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3747 struct input_event event
;
3749 event
.kind
= HELP_EVENT
;
3750 event
.frame_or_window
= frame
;
3755 kbd_buffer_store_event (&event
);
3759 /* Discard any mouse events in the event buffer by setting them to
3762 discard_mouse_events (void)
3764 struct input_event
*sp
;
3765 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3767 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3770 if (sp
->kind
== MOUSE_CLICK_EVENT
3771 || sp
->kind
== WHEEL_EVENT
3772 || sp
->kind
== HORIZ_WHEEL_EVENT
3774 || sp
->kind
== GPM_CLICK_EVENT
3776 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3778 sp
->kind
= NO_EVENT
;
3784 /* Return true if there are any real events waiting in the event
3785 buffer, not counting `NO_EVENT's.
3787 Discard NO_EVENT events at the front of the input queue, possibly
3788 leaving the input queue empty if there are no real input events. */
3791 kbd_buffer_events_waiting (void)
3793 struct input_event
*sp
;
3795 for (sp
= kbd_fetch_ptr
;
3796 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3799 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3804 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3808 /* Clear input event EVENT. */
3811 clear_event (struct input_event
*event
)
3813 event
->kind
= NO_EVENT
;
3817 /* Read one event from the event buffer, waiting if necessary.
3818 The value is a Lisp object representing the event.
3819 The value is nil for an event that should be ignored,
3820 or that was handled here.
3821 We always read and discard one event. */
3824 kbd_buffer_get_event (KBOARD
**kbp
,
3825 bool *used_mouse_menu
,
3826 struct timespec
*end_time
)
3831 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3833 /* Start reading input again because we have processed enough to
3834 be able to accept new events again. */
3835 unhold_keyboard_input ();
3838 #endif /* subprocesses */
3840 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3842 /* In case we are running as a daemon, only do this before
3843 detaching from the terminal. */
3844 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3848 *kbp
= current_kboard
;
3851 #endif /* ! HAVE_DBUS */
3853 /* Wait until there is input available. */
3856 /* Break loop if there's an unread command event. Needed in
3857 moused window autoselection which uses a timer to insert such
3859 if (CONSP (Vunread_command_events
))
3862 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3864 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3867 /* If the quit flag is set, then read_char will return
3868 quit_char, so that counts as "available input." */
3869 if (!NILP (Vquit_flag
))
3870 quit_throw_to_read_char (0);
3872 /* One way or another, wait until input is available; then, if
3873 interrupt handlers have not read it, read it now. */
3878 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3880 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3884 struct timespec now
= current_timespec ();
3885 if (timespec_cmp (*end_time
, now
) <= 0)
3886 return Qnil
; /* Finished waiting. */
3889 struct timespec duration
= timespec_sub (*end_time
, now
);
3890 wait_reading_process_output (min (duration
.tv_sec
,
3893 -1, 1, Qnil
, NULL
, 0);
3898 bool do_display
= true;
3900 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3902 struct tty_display_info
*tty
= CURTTY ();
3904 /* When this TTY is displaying a menu, we must prevent
3905 any redisplay, because we modify the frame's glyph
3906 matrix behind the back of the display engine. */
3907 if (tty
->showing_menu
)
3911 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3914 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3918 if (CONSP (Vunread_command_events
))
3921 first
= XCAR (Vunread_command_events
);
3922 Vunread_command_events
= XCDR (Vunread_command_events
);
3923 *kbp
= current_kboard
;
3927 /* At this point, we know that there is a readable event available
3928 somewhere. If the event queue is empty, then there must be a
3929 mouse movement enabled and available. */
3930 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3932 struct input_event
*event
;
3934 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3938 *kbp
= event_to_kboard (event
);
3940 *kbp
= current_kboard
; /* Better than returning null ptr? */
3944 /* These two kinds of events get special handling
3945 and don't actually appear to the command loop.
3946 We return nil for them. */
3947 if (event
->kind
== SELECTION_REQUEST_EVENT
3948 || event
->kind
== SELECTION_CLEAR_EVENT
)
3951 struct input_event copy
;
3953 /* Remove it from the buffer before processing it,
3954 since otherwise swallow_events will see it
3955 and process it again. */
3957 kbd_fetch_ptr
= event
+ 1;
3958 input_pending
= readable_events (0);
3959 x_handle_selection_event (©
);
3961 /* We're getting selection request events, but we don't have
3967 #if defined (HAVE_NS)
3968 else if (event
->kind
== NS_TEXT_EVENT
)
3970 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3971 obj
= list1 (intern ("ns-put-working-text"));
3973 obj
= list1 (intern ("ns-unput-working-text"));
3974 kbd_fetch_ptr
= event
+ 1;
3975 if (used_mouse_menu
)
3976 *used_mouse_menu
= 1;
3980 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3981 || defined (HAVE_NS)
3982 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3984 /* Make an event (delete-frame (FRAME)). */
3985 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3986 kbd_fetch_ptr
= event
+ 1;
3989 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3990 || defined (HAVE_NS)
3991 else if (event
->kind
== ICONIFY_EVENT
)
3993 /* Make an event (iconify-frame (FRAME)). */
3994 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3995 kbd_fetch_ptr
= event
+ 1;
3997 else if (event
->kind
== DEICONIFY_EVENT
)
3999 /* Make an event (make-frame-visible (FRAME)). */
4000 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
4001 kbd_fetch_ptr
= event
+ 1;
4004 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4006 /* The value doesn't matter here; only the type is tested. */
4007 XSETBUFFER (obj
, current_buffer
);
4008 kbd_fetch_ptr
= event
+ 1;
4010 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4011 || defined (HAVE_NS) || defined (USE_GTK)
4012 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4014 kbd_fetch_ptr
= event
+ 1;
4015 input_pending
= readable_events (0);
4016 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4017 x_activate_menubar (XFRAME (event
->frame_or_window
));
4021 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4023 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4024 obj
= list4 (Qlanguage_change
,
4025 event
->frame_or_window
,
4026 make_number (event
->code
),
4027 make_number (event
->modifiers
));
4028 kbd_fetch_ptr
= event
+ 1;
4031 #ifdef USE_FILE_NOTIFY
4032 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4034 #ifdef HAVE_W32NOTIFY
4035 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4036 obj
= list3 (Qfile_notify
,
4037 list3 (make_number (event
->code
),
4040 event
->frame_or_window
);
4042 obj
= make_lispy_event (event
);
4044 kbd_fetch_ptr
= event
+ 1;
4046 #endif /* USE_FILE_NOTIFY */
4047 else if (event
->kind
== SAVE_SESSION_EVENT
)
4049 obj
= list2 (Qsave_session
, event
->arg
);
4050 kbd_fetch_ptr
= event
+ 1;
4052 /* Just discard these, by returning nil.
4053 With MULTI_KBOARD, these events are used as placeholders
4054 when we need to randomly delete events from the queue.
4055 (They shouldn't otherwise be found in the buffer,
4056 but on some machines it appears they do show up
4057 even without MULTI_KBOARD.) */
4058 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4059 mouse events during a popup-menu call. */
4060 else if (event
->kind
== NO_EVENT
)
4061 kbd_fetch_ptr
= event
+ 1;
4062 else if (event
->kind
== HELP_EVENT
)
4064 Lisp_Object object
, position
, help
, frame
, window
;
4066 frame
= event
->frame_or_window
;
4067 object
= event
->arg
;
4068 position
= make_number (event
->code
);
4071 clear_event (event
);
4073 kbd_fetch_ptr
= event
+ 1;
4074 if (!WINDOWP (window
))
4076 obj
= Fcons (Qhelp_echo
,
4077 list5 (frame
, help
, window
, object
, position
));
4079 else if (event
->kind
== FOCUS_IN_EVENT
)
4081 /* Notification of a FocusIn event. The frame receiving the
4082 focus is in event->frame_or_window. Generate a
4083 switch-frame event if necessary. */
4084 Lisp_Object frame
, focus
;
4086 frame
= event
->frame_or_window
;
4087 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4096 !EQ (frame
, internal_last_event_frame
)
4097 && !EQ (frame
, selected_frame
))
4098 obj
= make_lispy_switch_frame (frame
);
4100 obj
= make_lispy_focus_in (frame
);
4102 internal_last_event_frame
= frame
;
4103 kbd_fetch_ptr
= event
+ 1;
4105 else if (event
->kind
== FOCUS_OUT_EVENT
)
4107 #ifdef HAVE_WINDOW_SYSTEM
4110 Lisp_Object frame
= event
->frame_or_window
;
4111 bool focused
= false;
4113 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4114 focused
= di
->x_highlight_frame
!= 0;
4117 obj
= make_lispy_focus_out (frame
);
4119 #endif /* HAVE_WINDOW_SYSTEM */
4121 kbd_fetch_ptr
= event
+ 1;
4124 else if (event
->kind
== DBUS_EVENT
)
4126 obj
= make_lispy_event (event
);
4127 kbd_fetch_ptr
= event
+ 1;
4130 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4132 obj
= make_lispy_event (event
);
4133 kbd_fetch_ptr
= event
+ 1;
4137 /* If this event is on a different frame, return a switch-frame this
4138 time, and leave the event in the queue for next time. */
4142 frame
= event
->frame_or_window
;
4144 frame
= XCAR (frame
);
4145 else if (WINDOWP (frame
))
4146 frame
= WINDOW_FRAME (XWINDOW (frame
));
4148 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4152 if (! EQ (frame
, internal_last_event_frame
)
4153 && !EQ (frame
, selected_frame
))
4154 obj
= make_lispy_switch_frame (frame
);
4155 internal_last_event_frame
= frame
;
4157 /* If we didn't decide to make a switch-frame event, go ahead
4158 and build a real event from the queue entry. */
4162 obj
= make_lispy_event (event
);
4164 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4165 || defined (HAVE_NS) || defined (USE_GTK)
4166 /* If this was a menu selection, then set the flag to inhibit
4167 writing to last_nonmenu_event. Don't do this if the event
4168 we're returning is (menu-bar), though; that indicates the
4169 beginning of the menu sequence, and we might as well leave
4170 that as the `event with parameters' for this selection. */
4172 && !EQ (event
->frame_or_window
, event
->arg
)
4173 && (event
->kind
== MENU_BAR_EVENT
4174 || event
->kind
== TOOL_BAR_EVENT
))
4175 *used_mouse_menu
= 1;
4178 /* Certain system events are non-key events. */
4180 && event
->kind
== NS_NONKEY_EVENT
)
4181 *used_mouse_menu
= 1;
4184 /* Wipe out this event, to catch bugs. */
4185 clear_event (event
);
4186 kbd_fetch_ptr
= event
+ 1;
4190 /* Try generating a mouse motion event. */
4191 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4193 struct frame
*f
= some_mouse_moved ();
4194 Lisp_Object bar_window
;
4195 enum scroll_bar_part part
;
4199 *kbp
= current_kboard
;
4200 /* Note that this uses F to determine which terminal to look at.
4201 If there is no valid info, it does not store anything
4202 so x remains nil. */
4205 /* XXX Can f or mouse_position_hook be NULL here? */
4206 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4207 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4212 /* Decide if we should generate a switch-frame event. Don't
4213 generate switch-frame events for motion outside of all Emacs
4219 frame
= FRAME_FOCUS_FRAME (f
);
4221 XSETFRAME (frame
, f
);
4223 if (! EQ (frame
, internal_last_event_frame
)
4224 && !EQ (frame
, selected_frame
))
4225 obj
= make_lispy_switch_frame (frame
);
4226 internal_last_event_frame
= frame
;
4229 /* If we didn't decide to make a switch-frame event, go ahead and
4230 return a mouse-motion event. */
4231 if (!NILP (x
) && NILP (obj
))
4232 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4235 /* We were promised by the above while loop that there was
4236 something for us to read! */
4239 input_pending
= readable_events (0);
4241 Vlast_event_frame
= internal_last_event_frame
;
4246 /* Process any non-user-visible events (currently X selection events),
4247 without reading any user-visible events. */
4250 process_special_events (void)
4252 struct input_event
*event
;
4254 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4256 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4259 if (event
== kbd_store_ptr
)
4263 /* If we find a stored X selection request, handle it now. */
4264 if (event
->kind
== SELECTION_REQUEST_EVENT
4265 || event
->kind
== SELECTION_CLEAR_EVENT
)
4269 /* Remove the event from the fifo buffer before processing;
4270 otherwise swallow_events called recursively could see it
4271 and process it again. To do this, we move the events
4272 between kbd_fetch_ptr and EVENT one slot to the right,
4275 struct input_event copy
= *event
;
4276 struct input_event
*beg
4277 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4278 ? kbd_buffer
: kbd_fetch_ptr
;
4281 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4282 else if (event
< beg
)
4284 if (event
> kbd_buffer
)
4285 memmove (kbd_buffer
+ 1, kbd_buffer
,
4286 (event
- kbd_buffer
) * sizeof (struct input_event
));
4287 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4288 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4289 memmove (beg
+ 1, beg
,
4290 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4291 * sizeof (struct input_event
));
4294 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4295 kbd_fetch_ptr
= kbd_buffer
+ 1;
4299 input_pending
= readable_events (0);
4300 x_handle_selection_event (©
);
4302 /* We're getting selection request events, but we don't have
4310 /* Process any events that are not user-visible, run timer events that
4311 are ripe, and return, without reading any user-visible events. */
4314 swallow_events (bool do_display
)
4316 unsigned old_timers_run
;
4318 process_special_events ();
4320 old_timers_run
= timers_run
;
4321 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4323 if (timers_run
!= old_timers_run
&& do_display
)
4324 redisplay_preserve_echo_area (7);
4327 /* Record the start of when Emacs is idle,
4328 for the sake of running idle-time timers. */
4331 timer_start_idle (void)
4333 /* If we are already in the idle state, do nothing. */
4334 if (timespec_valid_p (timer_idleness_start_time
))
4337 timer_idleness_start_time
= current_timespec ();
4338 timer_last_idleness_start_time
= timer_idleness_start_time
;
4340 /* Mark all idle-time timers as once again candidates for running. */
4341 call0 (intern ("internal-timer-start-idle"));
4344 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4347 timer_stop_idle (void)
4349 timer_idleness_start_time
= invalid_timespec ();
4352 /* Resume idle timer from last idle start time. */
4355 timer_resume_idle (void)
4357 if (timespec_valid_p (timer_idleness_start_time
))
4360 timer_idleness_start_time
= timer_last_idleness_start_time
;
4363 /* This is only for debugging. */
4364 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4366 /* List of elisp functions to call, delayed because they were generated in
4367 a context where Elisp could not be safely run (e.g. redisplay, signal,
4368 ...). Each element has the form (FUN . ARGS). */
4369 Lisp_Object pending_funcalls
;
4371 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4373 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4375 Lisp_Object
*vector
;
4377 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4379 vector
= XVECTOR (timer
)->u
.contents
;
4380 if (! NILP (vector
[0]))
4383 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4388 /* Check whether a timer has fired. To prevent larger problems we simply
4389 disregard elements that are not proper timers. Do not make a circular
4390 timer list for the time being.
4392 Returns the time to wait until the next timer fires. If a
4393 timer is triggering now, return zero.
4394 If no timer is active, return -1.
4396 If a timer is ripe, we run it, with quitting turned off.
4397 In that case we return 0 to indicate that a new timer_check_2 call
4400 static struct timespec
4401 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4403 struct timespec nexttime
;
4404 struct timespec now
;
4405 struct timespec idleness_now
;
4406 Lisp_Object chosen_timer
;
4407 struct gcpro gcpro1
;
4409 nexttime
= invalid_timespec ();
4411 chosen_timer
= Qnil
;
4412 GCPRO1 (chosen_timer
);
4414 /* First run the code that was delayed. */
4415 while (CONSP (pending_funcalls
))
4417 Lisp_Object funcall
= XCAR (pending_funcalls
);
4418 pending_funcalls
= XCDR (pending_funcalls
);
4419 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4422 if (CONSP (timers
) || CONSP (idle_timers
))
4424 now
= current_timespec ();
4425 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4426 ? timespec_sub (now
, timer_idleness_start_time
)
4427 : make_timespec (0, 0));
4430 while (CONSP (timers
) || CONSP (idle_timers
))
4432 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4433 struct timespec timer_time
, idle_timer_time
;
4434 struct timespec difference
;
4435 struct timespec timer_difference
= invalid_timespec ();
4436 struct timespec idle_timer_difference
= invalid_timespec ();
4437 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4439 /* Set TIMER and TIMER_DIFFERENCE
4440 based on the next ordinary timer.
4441 TIMER_DIFFERENCE is the distance in time from NOW to when
4442 this timer becomes ripe (negative if it's already ripe).
4443 Skip past invalid timers and timers already handled. */
4446 timer
= XCAR (timers
);
4447 if (! decode_timer (timer
, &timer_time
))
4449 timers
= XCDR (timers
);
4453 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4454 timer_difference
= (timer_ripe
4455 ? timespec_sub (now
, timer_time
)
4456 : timespec_sub (timer_time
, now
));
4459 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4460 based on the next idle timer. */
4461 if (CONSP (idle_timers
))
4463 idle_timer
= XCAR (idle_timers
);
4464 if (! decode_timer (idle_timer
, &idle_timer_time
))
4466 idle_timers
= XCDR (idle_timers
);
4470 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4471 idle_timer_difference
4473 ? timespec_sub (idleness_now
, idle_timer_time
)
4474 : timespec_sub (idle_timer_time
, idleness_now
));
4477 /* Decide which timer is the next timer,
4478 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4479 Also step down the list where we found that timer. */
4481 if (timespec_valid_p (timer_difference
)
4482 && (! timespec_valid_p (idle_timer_difference
)
4483 || idle_timer_ripe
< timer_ripe
4484 || (idle_timer_ripe
== timer_ripe
4486 ? timespec_cmp (idle_timer_difference
,
4488 : timespec_cmp (timer_difference
,
4489 idle_timer_difference
))
4492 chosen_timer
= timer
;
4493 timers
= XCDR (timers
);
4494 difference
= timer_difference
;
4499 chosen_timer
= idle_timer
;
4500 idle_timers
= XCDR (idle_timers
);
4501 difference
= idle_timer_difference
;
4502 ripe
= idle_timer_ripe
;
4505 /* If timer is ripe, run it if it hasn't been run. */
4508 if (NILP (AREF (chosen_timer
, 0)))
4510 ptrdiff_t count
= SPECPDL_INDEX ();
4511 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4513 /* Mark the timer as triggered to prevent problems if the lisp
4514 code fails to reschedule it right. */
4515 ASET (chosen_timer
, 0, Qt
);
4517 specbind (Qinhibit_quit
, Qt
);
4519 call1 (Qtimer_event_handler
, chosen_timer
);
4520 Vdeactivate_mark
= old_deactivate_mark
;
4522 unbind_to (count
, Qnil
);
4524 /* Since we have handled the event,
4525 we don't need to tell the caller to wake up and do it. */
4526 /* But the caller must still wait for the next timer, so
4527 return 0 to indicate that. */
4530 nexttime
= make_timespec (0, 0);
4534 /* When we encounter a timer that is still waiting,
4535 return the amount of time to wait before it is ripe. */
4542 /* No timers are pending in the future. */
4543 /* Return 0 if we generated an event, and -1 if not. */
4549 /* Check whether a timer has fired. To prevent larger problems we simply
4550 disregard elements that are not proper timers. Do not make a circular
4551 timer list for the time being.
4553 Returns the time to wait until the next timer fires.
4554 If no timer is active, return an invalid value.
4556 As long as any timer is ripe, we run it. */
4561 struct timespec nexttime
;
4562 Lisp_Object timers
, idle_timers
;
4563 struct gcpro gcpro1
, gcpro2
;
4565 Lisp_Object tem
= Vinhibit_quit
;
4568 /* We use copies of the timers' lists to allow a timer to add itself
4569 again, without locking up Emacs if the newly added timer is
4570 already ripe when added. */
4572 /* Always consider the ordinary timers. */
4573 timers
= Fcopy_sequence (Vtimer_list
);
4574 /* Consider the idle timers only if Emacs is idle. */
4575 if (timespec_valid_p (timer_idleness_start_time
))
4576 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4580 Vinhibit_quit
= tem
;
4582 GCPRO2 (timers
, idle_timers
);
4586 nexttime
= timer_check_2 (timers
, idle_timers
);
4588 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4594 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4595 doc
: /* Return the current length of Emacs idleness, or nil.
4596 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4597 in the same style as (current-time).
4599 The value when Emacs is not idle is nil.
4601 PSEC is a multiple of the system clock resolution. */)
4604 if (timespec_valid_p (timer_idleness_start_time
))
4605 return make_lisp_time (timespec_sub (current_timespec (),
4606 timer_idleness_start_time
));
4611 /* Caches for modify_event_symbol. */
4612 static Lisp_Object accent_key_syms
;
4613 static Lisp_Object func_key_syms
;
4614 static Lisp_Object mouse_syms
;
4615 static Lisp_Object wheel_syms
;
4616 static Lisp_Object drag_n_drop_syms
;
4618 /* This is a list of keysym codes for special "accent" characters.
4619 It parallels lispy_accent_keys. */
4621 static const int lispy_accent_codes
[] =
4623 #ifdef XK_dead_circumflex
4628 #ifdef XK_dead_grave
4633 #ifdef XK_dead_tilde
4638 #ifdef XK_dead_diaeresis
4643 #ifdef XK_dead_macron
4648 #ifdef XK_dead_degree
4653 #ifdef XK_dead_acute
4658 #ifdef XK_dead_cedilla
4663 #ifdef XK_dead_breve
4668 #ifdef XK_dead_ogonek
4673 #ifdef XK_dead_caron
4678 #ifdef XK_dead_doubleacute
4679 XK_dead_doubleacute
,
4683 #ifdef XK_dead_abovedot
4688 #ifdef XK_dead_abovering
4698 #ifdef XK_dead_belowdot
4703 #ifdef XK_dead_voiced_sound
4704 XK_dead_voiced_sound
,
4708 #ifdef XK_dead_semivoiced_sound
4709 XK_dead_semivoiced_sound
,
4725 /* This is a list of Lisp names for special "accent" characters.
4726 It parallels lispy_accent_codes. */
4728 static const char *const lispy_accent_keys
[] =
4746 "dead-voiced-sound",
4747 "dead-semivoiced-sound",
4753 #define FUNCTION_KEY_OFFSET 0x0
4755 const char *const lispy_function_keys
[] =
4759 0, /* VK_LBUTTON 0x01 */
4760 0, /* VK_RBUTTON 0x02 */
4761 "cancel", /* VK_CANCEL 0x03 */
4762 0, /* VK_MBUTTON 0x04 */
4764 0, 0, 0, /* 0x05 .. 0x07 */
4766 "backspace", /* VK_BACK 0x08 */
4767 "tab", /* VK_TAB 0x09 */
4769 0, 0, /* 0x0A .. 0x0B */
4771 "clear", /* VK_CLEAR 0x0C */
4772 "return", /* VK_RETURN 0x0D */
4774 0, 0, /* 0x0E .. 0x0F */
4776 0, /* VK_SHIFT 0x10 */
4777 0, /* VK_CONTROL 0x11 */
4778 0, /* VK_MENU 0x12 */
4779 "pause", /* VK_PAUSE 0x13 */
4780 "capslock", /* VK_CAPITAL 0x14 */
4781 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4783 "junja", /* VK_JUNJA 0x17 */
4784 "final", /* VK_FINAL 0x18 */
4785 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4787 "escape", /* VK_ESCAPE 0x1B */
4788 "convert", /* VK_CONVERT 0x1C */
4789 "non-convert", /* VK_NONCONVERT 0x1D */
4790 "accept", /* VK_ACCEPT 0x1E */
4791 "mode-change", /* VK_MODECHANGE 0x1F */
4792 0, /* VK_SPACE 0x20 */
4793 "prior", /* VK_PRIOR 0x21 */
4794 "next", /* VK_NEXT 0x22 */
4795 "end", /* VK_END 0x23 */
4796 "home", /* VK_HOME 0x24 */
4797 "left", /* VK_LEFT 0x25 */
4798 "up", /* VK_UP 0x26 */
4799 "right", /* VK_RIGHT 0x27 */
4800 "down", /* VK_DOWN 0x28 */
4801 "select", /* VK_SELECT 0x29 */
4802 "print", /* VK_PRINT 0x2A */
4803 "execute", /* VK_EXECUTE 0x2B */
4804 "snapshot", /* VK_SNAPSHOT 0x2C */
4805 "insert", /* VK_INSERT 0x2D */
4806 "delete", /* VK_DELETE 0x2E */
4807 "help", /* VK_HELP 0x2F */
4809 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4811 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4813 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4815 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4817 0, 0, 0, 0, 0, 0, 0, 0, 0,
4818 0, 0, 0, 0, 0, 0, 0, 0, 0,
4819 0, 0, 0, 0, 0, 0, 0, 0,
4821 "lwindow", /* VK_LWIN 0x5B */
4822 "rwindow", /* VK_RWIN 0x5C */
4823 "apps", /* VK_APPS 0x5D */
4826 "kp-0", /* VK_NUMPAD0 0x60 */
4827 "kp-1", /* VK_NUMPAD1 0x61 */
4828 "kp-2", /* VK_NUMPAD2 0x62 */
4829 "kp-3", /* VK_NUMPAD3 0x63 */
4830 "kp-4", /* VK_NUMPAD4 0x64 */
4831 "kp-5", /* VK_NUMPAD5 0x65 */
4832 "kp-6", /* VK_NUMPAD6 0x66 */
4833 "kp-7", /* VK_NUMPAD7 0x67 */
4834 "kp-8", /* VK_NUMPAD8 0x68 */
4835 "kp-9", /* VK_NUMPAD9 0x69 */
4836 "kp-multiply", /* VK_MULTIPLY 0x6A */
4837 "kp-add", /* VK_ADD 0x6B */
4838 "kp-separator", /* VK_SEPARATOR 0x6C */
4839 "kp-subtract", /* VK_SUBTRACT 0x6D */
4840 "kp-decimal", /* VK_DECIMAL 0x6E */
4841 "kp-divide", /* VK_DIVIDE 0x6F */
4842 "f1", /* VK_F1 0x70 */
4843 "f2", /* VK_F2 0x71 */
4844 "f3", /* VK_F3 0x72 */
4845 "f4", /* VK_F4 0x73 */
4846 "f5", /* VK_F5 0x74 */
4847 "f6", /* VK_F6 0x75 */
4848 "f7", /* VK_F7 0x76 */
4849 "f8", /* VK_F8 0x77 */
4850 "f9", /* VK_F9 0x78 */
4851 "f10", /* VK_F10 0x79 */
4852 "f11", /* VK_F11 0x7A */
4853 "f12", /* VK_F12 0x7B */
4854 "f13", /* VK_F13 0x7C */
4855 "f14", /* VK_F14 0x7D */
4856 "f15", /* VK_F15 0x7E */
4857 "f16", /* VK_F16 0x7F */
4858 "f17", /* VK_F17 0x80 */
4859 "f18", /* VK_F18 0x81 */
4860 "f19", /* VK_F19 0x82 */
4861 "f20", /* VK_F20 0x83 */
4862 "f21", /* VK_F21 0x84 */
4863 "f22", /* VK_F22 0x85 */
4864 "f23", /* VK_F23 0x86 */
4865 "f24", /* VK_F24 0x87 */
4867 0, 0, 0, 0, /* 0x88 .. 0x8B */
4868 0, 0, 0, 0, /* 0x8C .. 0x8F */
4870 "kp-numlock", /* VK_NUMLOCK 0x90 */
4871 "scroll", /* VK_SCROLL 0x91 */
4872 /* Not sure where the following block comes from.
4873 Windows headers have NEC and Fujitsu specific keys in
4874 this block, but nothing generic. */
4875 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4876 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4877 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4878 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4879 "kp-end", /* VK_NUMPAD_END 0x96 */
4880 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4881 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4882 "kp-up", /* VK_NUMPAD_UP 0x99 */
4883 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4884 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4885 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4886 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4888 0, 0, /* 0x9E .. 0x9F */
4891 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4892 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4893 * No other API or message will distinguish left and right keys this way.
4898 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4899 to enable them selectively, and gives access to a few more functions.
4900 See lispy_multimedia_keys below. */
4901 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4902 0, 0, 0, /* 0xAD .. 0xAF Volume */
4903 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4904 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4906 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4907 0, 0, 0, 0, 0, 0, 0, 0, 0,
4909 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4910 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4911 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4914 "ax", /* VK_OEM_AX 0xE1 */
4915 0, /* VK_OEM_102 0xE2 */
4916 "ico-help", /* VK_ICO_HELP 0xE3 */
4917 "ico-00", /* VK_ICO_00 0xE4 */
4918 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4919 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4920 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4922 "reset", /* VK_OEM_RESET 0xE9 */
4923 "jump", /* VK_OEM_JUMP 0xEA */
4924 "oem-pa1", /* VK_OEM_PA1 0xEB */
4925 "oem-pa2", /* VK_OEM_PA2 0xEC */
4926 "oem-pa3", /* VK_OEM_PA3 0xED */
4927 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4928 "cusel", /* VK_OEM_CUSEL 0xEF */
4929 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4930 "finish", /* VK_OEM_FINISH 0xF1 */
4931 "copy", /* VK_OEM_COPY 0xF2 */
4932 "auto", /* VK_OEM_AUTO 0xF3 */
4933 "enlw", /* VK_OEM_ENLW 0xF4 */
4934 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4935 "attn", /* VK_ATTN 0xF6 */
4936 "crsel", /* VK_CRSEL 0xF7 */
4937 "exsel", /* VK_EXSEL 0xF8 */
4938 "ereof", /* VK_EREOF 0xF9 */
4939 "play", /* VK_PLAY 0xFA */
4940 "zoom", /* VK_ZOOM 0xFB */
4941 "noname", /* VK_NONAME 0xFC */
4942 "pa1", /* VK_PA1 0xFD */
4943 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4947 /* Some of these duplicate the "Media keys" on newer keyboards,
4948 but they are delivered to the application in a different way. */
4949 static const char *const lispy_multimedia_keys
[] =
4957 "browser-favorites",
4994 "toggle-dictate-command",
5000 "media-fast-forward",
5003 "media-channel-down"
5006 #else /* not HAVE_NTGUI */
5008 /* This should be dealt with in XTread_socket now, and that doesn't
5009 depend on the client system having the Kana syms defined. See also
5010 the XK_kana_A case below. */
5013 static const char *const lispy_kana_keys
[] =
5015 /* X Keysym value */
5016 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5017 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5018 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5019 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5020 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5021 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5022 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5023 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5024 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5025 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5026 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5027 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5028 "kana-i", "kana-u", "kana-e", "kana-o",
5029 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5030 "prolongedsound", "kana-A", "kana-I", "kana-U",
5031 "kana-E", "kana-O", "kana-KA", "kana-KI",
5032 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5033 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5034 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5035 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5036 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5037 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5038 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5039 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5040 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5041 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5042 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5043 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5045 #endif /* XK_kana_A */
5048 #define FUNCTION_KEY_OFFSET 0xff00
5050 /* You'll notice that this table is arranged to be conveniently
5051 indexed by X Windows keysym values. */
5052 static const char *const lispy_function_keys
[] =
5054 /* X Keysym value */
5056 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5057 "backspace", "tab", "linefeed", "clear",
5059 0, 0, 0, "pause", /* 0xff10...1f */
5060 0, 0, 0, 0, 0, 0, 0, "escape",
5062 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5063 "romaji", "hiragana", "katakana", "hiragana-katakana",
5064 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5065 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5066 "eisu-toggle", /* 0xff30...3f */
5067 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5068 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5070 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5071 "down", "prior", "next", "end",
5072 "begin", 0, 0, 0, 0, 0, 0, 0,
5073 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5084 "break", /* 0xff6b */
5087 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5088 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5089 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5090 0, 0, 0, 0, 0, 0, 0, 0,
5091 "kp-tab", /* 0xff89 */
5093 "kp-enter", /* 0xff8d */
5095 "kp-f1", /* 0xff91 */
5099 "kp-home", /* 0xff95 */
5104 "kp-prior", /* kp-page-up */
5105 "kp-next", /* kp-page-down */
5111 0, 0, 0, 0, 0, 0, 0, 0, 0,
5112 "kp-multiply", /* 0xffaa */
5117 "kp-divide", /* 0xffaf */
5118 "kp-0", /* 0xffb0 */
5119 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5122 "kp-equal", /* 0xffbd */
5123 "f1", /* 0xffbe */ /* IsFunctionKey */
5125 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5126 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5127 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5128 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5129 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5130 0, 0, 0, 0, 0, 0, 0, 0,
5131 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5132 0, 0, 0, 0, 0, 0, 0, "delete"
5135 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5136 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5138 static const char *const iso_lispy_function_keys
[] =
5140 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5141 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5142 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5143 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5144 "iso-lefttab", /* 0xfe20 */
5145 "iso-move-line-up", "iso-move-line-down",
5146 "iso-partial-line-up", "iso-partial-line-down",
5147 "iso-partial-space-left", "iso-partial-space-right",
5148 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5149 "iso-release-margin-left", "iso-release-margin-right",
5150 "iso-release-both-margins",
5151 "iso-fast-cursor-left", "iso-fast-cursor-right",
5152 "iso-fast-cursor-up", "iso-fast-cursor-down",
5153 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5154 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5157 #endif /* not HAVE_NTGUI */
5159 static Lisp_Object Vlispy_mouse_stem
;
5161 static const char *const lispy_wheel_names
[] =
5163 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5166 /* drag-n-drop events are generated when a set of selected files are
5167 dragged from another application and dropped onto an Emacs window. */
5168 static const char *const lispy_drag_n_drop_names
[] =
5173 /* Scroll bar parts. */
5174 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5175 Lisp_Object Qup
, Qdown
, Qbottom
;
5176 static Lisp_Object Qend_scroll
;
5178 static Lisp_Object Qratio
;
5180 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5181 static Lisp_Object
*const scroll_bar_parts
[] = {
5182 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5183 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5186 /* A vector, indexed by button number, giving the down-going location
5187 of currently depressed buttons, both scroll bar and non-scroll bar.
5189 The elements have the form
5190 (BUTTON-NUMBER MODIFIER-MASK . REST)
5191 where REST is the cdr of a position as it would be reported in the event.
5193 The make_lispy_event function stores positions here to tell the
5194 difference between click and drag events, and to store the starting
5195 location to be included in drag events. */
5197 static Lisp_Object button_down_location
;
5199 /* Information about the most recent up-going button event: Which
5200 button, what location, and what time. */
5202 static int last_mouse_button
;
5203 static int last_mouse_x
;
5204 static int last_mouse_y
;
5205 static Time button_down_time
;
5207 /* The number of clicks in this multiple-click. */
5209 static int double_click_count
;
5211 /* X and Y are frame-relative coordinates for a click or wheel event.
5212 Return a Lisp-style event list. */
5215 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5218 enum window_part part
;
5219 Lisp_Object posn
= Qnil
;
5220 Lisp_Object extra_info
= Qnil
;
5221 /* Coordinate pixel positions to return. */
5222 int xret
= 0, yret
= 0;
5223 /* The window under frame pixel coordinates (x,y) */
5224 Lisp_Object window
= f
5225 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5228 if (WINDOWP (window
))
5230 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5231 struct window
*w
= XWINDOW (window
);
5232 Lisp_Object string_info
= Qnil
;
5233 ptrdiff_t textpos
= -1;
5234 int col
= -1, row
= -1;
5235 int dx
= -1, dy
= -1;
5236 int width
= -1, height
= -1;
5237 Lisp_Object object
= Qnil
;
5239 /* Pixel coordinates relative to the window corner. */
5240 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5241 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5243 /* For text area clicks, return X, Y relative to the corner of
5244 this text area. Note that dX, dY etc are set below, by
5245 buffer_posn_from_coords. */
5246 if (part
== ON_TEXT
)
5248 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5249 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5251 /* For mode line and header line clicks, return X, Y relative to
5252 the left window edge. Use mode_line_string to look for a
5253 string on the click position. */
5254 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5259 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5260 /* Note that mode_line_string takes COL, ROW as pixels and
5261 converts them to characters. */
5264 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5265 &object
, &dx
, &dy
, &width
, &height
);
5266 if (STRINGP (string
))
5267 string_info
= Fcons (string
, make_number (charpos
));
5268 textpos
= (w
== XWINDOW (selected_window
)
5269 && current_buffer
== XBUFFER (w
->contents
))
5270 ? PT
: marker_position (w
->pointm
);
5275 /* For fringes and margins, Y is relative to the area's (and the
5276 window's) top edge, while X is meaningless. */
5277 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5282 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5285 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5286 &object
, &dx
, &dy
, &width
, &height
);
5287 if (STRINGP (string
))
5288 string_info
= Fcons (string
, make_number (charpos
));
5289 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5291 else if (part
== ON_LEFT_FRINGE
)
5293 posn
= Qleft_fringe
;
5296 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5297 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5298 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5300 else if (part
== ON_RIGHT_FRINGE
)
5302 posn
= Qright_fringe
;
5305 - window_box_width (w
, LEFT_MARGIN_AREA
)
5306 - window_box_width (w
, TEXT_AREA
)
5307 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5308 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5310 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5312 else if (part
== ON_VERTICAL_BORDER
)
5314 posn
= Qvertical_line
;
5319 /* Nothing special for part == ON_SCROLL_BAR. */
5321 /* For clicks in the text area, fringes, or margins, call
5322 buffer_posn_from_coords to extract TEXTPOS, the buffer
5323 position nearest to the click. */
5326 Lisp_Object string2
, object2
= Qnil
;
5327 struct display_pos p
;
5329 int width2
, height2
;
5330 /* The pixel X coordinate passed to buffer_posn_from_coords
5331 is the X coordinate relative to the text area for
5332 text-area and right-margin clicks, zero otherwise. */
5334 = (part
== ON_TEXT
) ? xret
5335 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5336 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5340 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5341 &object2
, &dx2
, &dy2
,
5343 textpos
= CHARPOS (p
.pos
);
5344 if (col
< 0) col
= x2
;
5345 if (row
< 0) row
= y2
;
5346 if (dx
< 0) dx
= dx2
;
5347 if (dy
< 0) dy
= dy2
;
5348 if (width
< 0) width
= width2
;
5349 if (height
< 0) height
= height2
;
5353 posn
= make_number (textpos
);
5354 if (STRINGP (string2
))
5355 string_info
= Fcons (string2
,
5356 make_number (CHARPOS (p
.string_pos
)));
5362 #ifdef HAVE_WINDOW_SYSTEM
5363 if (IMAGEP (object
))
5365 Lisp_Object image_map
, hotspot
;
5366 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5368 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5370 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5371 posn
= XCAR (hotspot
);
5378 Fcons (make_number (dx
), make_number (dy
)),
5379 Fcons (make_number (width
), make_number (height
)));
5382 extra_info
= Fcons (string_info
,
5383 Fcons (make_number (textpos
),
5384 Fcons (Fcons (make_number (col
),
5389 XSETFRAME (window
, f
);
5393 return Fcons (window
,
5395 Fcons (Fcons (make_number (xret
),
5396 make_number (yret
)),
5397 Fcons (make_number (t
),
5401 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5402 menu bar. This really means that Emacs draws and manages the menu
5403 bar as part of its normal display, and therefore can compute its
5406 toolkit_menubar_in_use (struct frame
*f
)
5408 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5409 return !(!FRAME_WINDOW_P (f
));
5415 /* Given a struct input_event, build the lisp event which represents
5416 it. If EVENT is 0, build a mouse movement event from the mouse
5417 movement buffer, which should have a movement event in it.
5419 Note that events must be passed to this function in the order they
5420 are received; this function stores the location of button presses
5421 in order to build drag events when the button is released. */
5424 make_lispy_event (struct input_event
*event
)
5428 switch (event
->kind
)
5430 /* A simple keystroke. */
5431 case ASCII_KEYSTROKE_EVENT
:
5432 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5434 Lisp_Object lispy_c
;
5435 EMACS_INT c
= event
->code
;
5436 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5439 eassert (c
== event
->code
);
5440 /* Turn ASCII characters into control characters
5442 if (event
->modifiers
& ctrl_modifier
)
5444 c
= make_ctrl_char (c
);
5445 event
->modifiers
&= ~ctrl_modifier
;
5449 /* Add in the other modifier bits. The shift key was taken care
5450 of by the X code. */
5451 c
|= (event
->modifiers
5452 & (meta_modifier
| alt_modifier
5453 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5454 /* Distinguish Shift-SPC from SPC. */
5455 if ((event
->code
) == 040
5456 && event
->modifiers
& shift_modifier
)
5457 c
|= shift_modifier
;
5458 button_down_time
= 0;
5459 XSETFASTINT (lispy_c
, c
);
5464 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5465 except that they are non-key events (last-nonmenu-event is nil). */
5466 case NS_NONKEY_EVENT
:
5469 /* A function key. The symbol may need to have modifier prefixes
5471 case NON_ASCII_KEYSTROKE_EVENT
:
5472 button_down_time
= 0;
5474 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5475 if (event
->code
== lispy_accent_codes
[i
])
5476 return modify_event_symbol (i
,
5478 Qfunction_key
, Qnil
,
5479 lispy_accent_keys
, &accent_key_syms
,
5480 (sizeof (lispy_accent_keys
)
5481 / sizeof (lispy_accent_keys
[0])));
5485 if (event
->code
>= 0x400 && event
->code
< 0x500)
5486 return modify_event_symbol (event
->code
- 0x400,
5487 event
->modifiers
& ~shift_modifier
,
5488 Qfunction_key
, Qnil
,
5489 lispy_kana_keys
, &func_key_syms
,
5490 (sizeof (lispy_kana_keys
)
5491 / sizeof (lispy_kana_keys
[0])));
5492 #endif /* XK_kana_A */
5495 #ifdef ISO_FUNCTION_KEY_OFFSET
5496 if (event
->code
< FUNCTION_KEY_OFFSET
5497 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5498 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5500 Qfunction_key
, Qnil
,
5501 iso_lispy_function_keys
, &func_key_syms
,
5502 (sizeof (iso_lispy_function_keys
)
5503 / sizeof (iso_lispy_function_keys
[0])));
5506 /* Handle system-specific or unknown keysyms. */
5507 if (event
->code
& (1 << 28)
5508 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5509 || (event
->code
- FUNCTION_KEY_OFFSET
5510 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5511 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5513 /* We need to use an alist rather than a vector as the cache
5514 since we can't make a vector long enough. */
5515 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5516 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5517 return modify_event_symbol (event
->code
,
5520 KVAR (current_kboard
, Vsystem_key_alist
),
5521 0, &KVAR (current_kboard
, system_key_syms
),
5525 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5527 Qfunction_key
, Qnil
,
5528 lispy_function_keys
, &func_key_syms
,
5529 (sizeof (lispy_function_keys
)
5530 / sizeof (lispy_function_keys
[0])));
5533 case MULTIMEDIA_KEY_EVENT
:
5534 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5535 / sizeof (lispy_multimedia_keys
[0]))
5536 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5538 return modify_event_symbol (event
->code
, event
->modifiers
,
5539 Qfunction_key
, Qnil
,
5540 lispy_multimedia_keys
, &func_key_syms
,
5541 (sizeof (lispy_multimedia_keys
)
5542 / sizeof (lispy_multimedia_keys
[0])));
5547 /* A mouse click. Figure out where it is, decide whether it's
5548 a press, click or drag, and build the appropriate structure. */
5549 case MOUSE_CLICK_EVENT
:
5550 #ifndef USE_TOOLKIT_SCROLL_BARS
5551 case SCROLL_BAR_CLICK_EVENT
:
5554 int button
= event
->code
;
5556 Lisp_Object position
;
5557 Lisp_Object
*start_pos_ptr
;
5558 Lisp_Object start_pos
;
5562 /* Build the position as appropriate for this mouse click. */
5563 if (event
->kind
== MOUSE_CLICK_EVENT
)
5565 struct frame
*f
= XFRAME (event
->frame_or_window
);
5568 /* Ignore mouse events that were made on frame that
5569 have been deleted. */
5570 if (! FRAME_LIVE_P (f
))
5573 /* EVENT->x and EVENT->y are frame-relative pixel
5574 coordinates at this place. Under old redisplay, COLUMN
5575 and ROW are set to frame relative glyph coordinates
5576 which are then used to determine whether this click is
5577 in a menu (non-toolkit version). */
5578 if (!toolkit_menubar_in_use (f
))
5580 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5581 &column
, &row
, NULL
, 1);
5583 /* In the non-toolkit version, clicks on the menu bar
5584 are ordinary button events in the event buffer.
5585 Distinguish them, and invoke the menu.
5587 (In the toolkit version, the toolkit handles the
5588 menu bar and Emacs doesn't know about it until
5589 after the user makes a selection.) */
5590 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5591 && (event
->modifiers
& down_modifier
))
5593 Lisp_Object items
, item
;
5595 /* Find the menu bar item under `column'. */
5597 items
= FRAME_MENU_BAR_ITEMS (f
);
5598 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5600 Lisp_Object pos
, string
;
5601 string
= AREF (items
, i
+ 1);
5602 pos
= AREF (items
, i
+ 3);
5605 if (column
>= XINT (pos
)
5606 && column
< XINT (pos
) + SCHARS (string
))
5608 item
= AREF (items
, i
);
5613 /* ELisp manual 2.4b says (x y) are window
5614 relative but code says they are
5616 position
= list4 (event
->frame_or_window
,
5618 Fcons (event
->x
, event
->y
),
5619 make_number (event
->timestamp
));
5621 return list2 (item
, position
);
5625 position
= make_lispy_position (f
, event
->x
, event
->y
,
5628 #ifndef USE_TOOLKIT_SCROLL_BARS
5631 /* It's a scrollbar click. */
5633 Lisp_Object portion_whole
;
5636 window
= event
->frame_or_window
;
5637 portion_whole
= Fcons (event
->x
, event
->y
);
5638 part
= *scroll_bar_parts
[(int) event
->part
];
5640 position
= list5 (window
, Qvertical_scroll_bar
,
5641 portion_whole
, make_number (event
->timestamp
),
5644 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5646 if (button
>= ASIZE (button_down_location
))
5648 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5649 button_down_location
= larger_vector (button_down_location
,
5651 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5654 start_pos_ptr
= aref_addr (button_down_location
, button
);
5655 start_pos
= *start_pos_ptr
;
5656 *start_pos_ptr
= Qnil
;
5659 /* On window-system frames, use the value of
5660 double-click-fuzz as is. On other frames, interpret it
5661 as a multiple of 1/8 characters. */
5665 if (WINDOWP (event
->frame_or_window
))
5666 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5667 else if (FRAMEP (event
->frame_or_window
))
5668 f
= XFRAME (event
->frame_or_window
);
5672 if (FRAME_WINDOW_P (f
))
5673 fuzz
= double_click_fuzz
;
5675 fuzz
= double_click_fuzz
/ 8;
5677 is_double
= (button
== last_mouse_button
5678 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5679 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5680 && button_down_time
!= 0
5681 && (EQ (Vdouble_click_time
, Qt
)
5682 || (NATNUMP (Vdouble_click_time
)
5683 && (event
->timestamp
- button_down_time
5684 < XFASTINT (Vdouble_click_time
)))));
5687 last_mouse_button
= button
;
5688 last_mouse_x
= XINT (event
->x
);
5689 last_mouse_y
= XINT (event
->y
);
5691 /* If this is a button press, squirrel away the location, so
5692 we can decide later whether it was a click or a drag. */
5693 if (event
->modifiers
& down_modifier
)
5697 double_click_count
++;
5698 event
->modifiers
|= ((double_click_count
> 2)
5703 double_click_count
= 1;
5704 button_down_time
= event
->timestamp
;
5705 *start_pos_ptr
= Fcopy_alist (position
);
5706 ignore_mouse_drag_p
= 0;
5709 /* Now we're releasing a button - check the co-ordinates to
5710 see if this was a click or a drag. */
5711 else if (event
->modifiers
& up_modifier
)
5713 /* If we did not see a down before this up, ignore the up.
5714 Probably this happened because the down event chose a
5715 menu item. It would be an annoyance to treat the
5716 release of the button that chose the menu item as a
5719 if (!CONSP (start_pos
))
5722 event
->modifiers
&= ~up_modifier
;
5725 Lisp_Object new_down
, down
;
5726 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5728 /* The third element of every position
5729 should be the (x,y) pair. */
5730 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5731 new_down
= Fcar (Fcdr (Fcdr (position
)));
5734 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5736 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5737 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5740 if (ignore_mouse_drag_p
)
5742 event
->modifiers
|= click_modifier
;
5743 ignore_mouse_drag_p
= 0;
5745 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5746 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5747 /* Maybe the mouse has moved a lot, caused scrolling, and
5748 eventually ended up at the same screen position (but
5749 not buffer position) in which case it is a drag, not
5751 /* FIXME: OTOH if the buffer position has changed
5752 because of a timer or process filter rather than
5753 because of mouse movement, it should be considered as
5754 a click. But mouse-drag-region completely ignores
5755 this case and it hasn't caused any real problem, so
5756 it's probably OK to ignore it as well. */
5757 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5758 /* Mouse hasn't moved (much). */
5759 event
->modifiers
|= click_modifier
;
5762 button_down_time
= 0;
5763 event
->modifiers
|= drag_modifier
;
5766 /* Don't check is_double; treat this as multiple
5767 if the down-event was multiple. */
5768 if (double_click_count
> 1)
5769 event
->modifiers
|= ((double_click_count
> 2)
5775 /* Every mouse event should either have the down_modifier or
5776 the up_modifier set. */
5780 /* Get the symbol we should use for the mouse click. */
5783 head
= modify_event_symbol (button
,
5785 Qmouse_click
, Vlispy_mouse_stem
,
5788 ASIZE (mouse_syms
));
5789 if (event
->modifiers
& drag_modifier
)
5790 return list3 (head
, start_pos
, position
);
5791 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5792 return list3 (head
, position
, make_number (double_click_count
));
5794 return list2 (head
, position
);
5799 case HORIZ_WHEEL_EVENT
:
5801 Lisp_Object position
;
5804 /* Build the position as appropriate for this mouse click. */
5805 struct frame
*f
= XFRAME (event
->frame_or_window
);
5807 /* Ignore wheel events that were made on frame that have been
5809 if (! FRAME_LIVE_P (f
))
5812 position
= make_lispy_position (f
, event
->x
, event
->y
,
5815 /* Set double or triple modifiers to indicate the wheel speed. */
5817 /* On window-system frames, use the value of
5818 double-click-fuzz as is. On other frames, interpret it
5819 as a multiple of 1/8 characters. */
5825 if (WINDOWP (event
->frame_or_window
))
5826 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5827 else if (FRAMEP (event
->frame_or_window
))
5828 fr
= XFRAME (event
->frame_or_window
);
5832 fuzz
= FRAME_WINDOW_P (fr
)
5833 ? double_click_fuzz
: double_click_fuzz
/ 8;
5835 if (event
->modifiers
& up_modifier
)
5837 /* Emit a wheel-up event. */
5838 event
->modifiers
&= ~up_modifier
;
5841 else if (event
->modifiers
& down_modifier
)
5843 /* Emit a wheel-down event. */
5844 event
->modifiers
&= ~down_modifier
;
5848 /* Every wheel event should either have the down_modifier or
5849 the up_modifier set. */
5852 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5855 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5856 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5857 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5858 && button_down_time
!= 0
5859 && (EQ (Vdouble_click_time
, Qt
)
5860 || (NATNUMP (Vdouble_click_time
)
5861 && (event
->timestamp
- button_down_time
5862 < XFASTINT (Vdouble_click_time
)))));
5865 double_click_count
++;
5866 event
->modifiers
|= ((double_click_count
> 2)
5872 double_click_count
= 1;
5873 event
->modifiers
|= click_modifier
;
5876 button_down_time
= event
->timestamp
;
5877 /* Use a negative value to distinguish wheel from mouse button. */
5878 last_mouse_button
= - (1 + symbol_num
);
5879 last_mouse_x
= XINT (event
->x
);
5880 last_mouse_y
= XINT (event
->y
);
5882 /* Get the symbol we should use for the wheel event. */
5883 head
= modify_event_symbol (symbol_num
,
5889 ASIZE (wheel_syms
));
5892 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5893 return list3 (head
, position
, make_number (double_click_count
));
5895 return list2 (head
, position
);
5899 #ifdef USE_TOOLKIT_SCROLL_BARS
5901 /* We don't have down and up events if using toolkit scroll bars,
5902 so make this always a click event. Store in the `part' of
5903 the Lisp event a symbol which maps to the following actions:
5905 `above_handle' page up
5906 `below_handle' page down
5910 `bottom' bottom of buffer
5911 `handle' thumb has been dragged.
5912 `end-scroll' end of interaction with scroll bar
5914 The incoming input_event contains in its `part' member an
5915 index of type `enum scroll_bar_part' which we can use as an
5916 index in scroll_bar_parts to get the appropriate symbol. */
5918 case SCROLL_BAR_CLICK_EVENT
:
5920 Lisp_Object position
, head
, window
, portion_whole
, part
;
5922 window
= event
->frame_or_window
;
5923 portion_whole
= Fcons (event
->x
, event
->y
);
5924 part
= *scroll_bar_parts
[(int) event
->part
];
5926 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5927 make_number (event
->timestamp
), part
);
5929 /* Always treat scroll bar events as clicks. */
5930 event
->modifiers
|= click_modifier
;
5931 event
->modifiers
&= ~up_modifier
;
5933 if (event
->code
>= ASIZE (mouse_syms
))
5934 mouse_syms
= larger_vector (mouse_syms
,
5935 event
->code
- ASIZE (mouse_syms
) + 1,
5938 /* Get the symbol we should use for the mouse click. */
5939 head
= modify_event_symbol (event
->code
,
5944 ASIZE (mouse_syms
));
5945 return list2 (head
, position
);
5948 #endif /* USE_TOOLKIT_SCROLL_BARS */
5950 case DRAG_N_DROP_EVENT
:
5953 Lisp_Object head
, position
;
5956 f
= XFRAME (event
->frame_or_window
);
5959 /* Ignore mouse events that were made on frames that
5960 have been deleted. */
5961 if (! FRAME_LIVE_P (f
))
5964 position
= make_lispy_position (f
, event
->x
, event
->y
,
5967 head
= modify_event_symbol (0, event
->modifiers
,
5969 lispy_drag_n_drop_names
,
5970 &drag_n_drop_syms
, 1);
5971 return list3 (head
, position
, files
);
5974 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5975 || defined (HAVE_NS) || defined (USE_GTK)
5976 case MENU_BAR_EVENT
:
5977 if (EQ (event
->arg
, event
->frame_or_window
))
5978 /* This is the prefix key. We translate this to
5979 `(menu_bar)' because the code in keyboard.c for menu
5980 events, which we use, relies on this. */
5981 return list1 (Qmenu_bar
);
5985 case SELECT_WINDOW_EVENT
:
5986 /* Make an event (select-window (WINDOW)). */
5987 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5989 case TOOL_BAR_EVENT
:
5990 if (EQ (event
->arg
, event
->frame_or_window
))
5991 /* This is the prefix key. We translate this to
5992 `(tool_bar)' because the code in keyboard.c for tool bar
5993 events, which we use, relies on this. */
5994 return list1 (Qtool_bar
);
5995 else if (SYMBOLP (event
->arg
))
5996 return apply_modifiers (event
->modifiers
, event
->arg
);
5999 case USER_SIGNAL_EVENT
:
6000 /* A user signal. */
6002 char *name
= find_user_signal_name (event
->code
);
6005 return intern (name
);
6008 case SAVE_SESSION_EVENT
:
6009 return Qsave_session
;
6014 return Fcons (Qdbus_event
, event
->arg
);
6016 #endif /* HAVE_DBUS */
6018 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6019 case FILE_NOTIFY_EVENT
:
6021 return Fcons (Qfile_notify
, event
->arg
);
6023 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6025 case CONFIG_CHANGED_EVENT
:
6026 return list3 (Qconfig_changed_event
,
6027 event
->arg
, event
->frame_or_window
);
6029 case GPM_CLICK_EVENT
:
6031 struct frame
*f
= XFRAME (event
->frame_or_window
);
6032 Lisp_Object head
, position
;
6033 Lisp_Object
*start_pos_ptr
;
6034 Lisp_Object start_pos
;
6035 int button
= event
->code
;
6037 if (button
>= ASIZE (button_down_location
))
6039 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
6040 button_down_location
= larger_vector (button_down_location
,
6042 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
6045 start_pos_ptr
= aref_addr (button_down_location
, button
);
6046 start_pos
= *start_pos_ptr
;
6048 position
= make_lispy_position (f
, event
->x
, event
->y
,
6051 if (event
->modifiers
& down_modifier
)
6052 *start_pos_ptr
= Fcopy_alist (position
);
6053 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6055 if (!CONSP (start_pos
))
6057 event
->modifiers
&= ~up_modifier
;
6060 head
= modify_event_symbol (button
,
6062 Qmouse_click
, Vlispy_mouse_stem
,
6065 ASIZE (mouse_syms
));
6067 if (event
->modifiers
& drag_modifier
)
6068 return list3 (head
, start_pos
, position
);
6069 else if (event
->modifiers
& double_modifier
)
6070 return list3 (head
, position
, make_number (2));
6071 else if (event
->modifiers
& triple_modifier
)
6072 return list3 (head
, position
, make_number (3));
6074 return list2 (head
, position
);
6076 #endif /* HAVE_GPM */
6078 /* The 'kind' field of the event is something we don't recognize. */
6085 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6086 Lisp_Object x
, Lisp_Object y
, Time t
)
6088 /* Is it a scroll bar movement? */
6089 if (frame
&& ! NILP (bar_window
))
6091 Lisp_Object part_sym
;
6093 part_sym
= *scroll_bar_parts
[(int) part
];
6094 return list2 (Qscroll_bar_movement
,
6096 Qvertical_scroll_bar
,
6101 /* Or is it an ordinary mouse movement? */
6104 Lisp_Object position
;
6105 position
= make_lispy_position (frame
, x
, y
, t
);
6106 return list2 (Qmouse_movement
, position
);
6110 /* Construct a switch frame event. */
6112 make_lispy_switch_frame (Lisp_Object frame
)
6114 return list2 (Qswitch_frame
, frame
);
6118 make_lispy_focus_in (Lisp_Object frame
)
6120 return list2 (Qfocus_in
, frame
);
6123 #ifdef HAVE_WINDOW_SYSTEM
6126 make_lispy_focus_out (Lisp_Object frame
)
6128 return list2 (Qfocus_out
, frame
);
6131 #endif /* HAVE_WINDOW_SYSTEM */
6133 /* Manipulating modifiers. */
6135 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6137 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6138 SYMBOL's name of the end of the modifiers; the string from this
6139 position is the unmodified symbol name.
6141 This doesn't use any caches. */
6144 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6150 CHECK_SYMBOL (symbol
);
6153 name
= SYMBOL_NAME (symbol
);
6155 for (i
= 0; i
< SBYTES (name
) - 1; )
6157 ptrdiff_t this_mod_end
= 0;
6160 /* See if the name continues with a modifier word.
6161 Check that the word appears, but don't check what follows it.
6162 Set this_mod and this_mod_end to record what we find. */
6164 switch (SREF (name
, i
))
6166 #define SINGLE_LETTER_MOD(BIT) \
6167 (this_mod_end = i + 1, this_mod = BIT)
6170 SINGLE_LETTER_MOD (alt_modifier
);
6174 SINGLE_LETTER_MOD (ctrl_modifier
);
6178 SINGLE_LETTER_MOD (hyper_modifier
);
6182 SINGLE_LETTER_MOD (meta_modifier
);
6186 SINGLE_LETTER_MOD (shift_modifier
);
6190 SINGLE_LETTER_MOD (super_modifier
);
6193 #undef SINGLE_LETTER_MOD
6195 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6196 if (i + LEN + 1 <= SBYTES (name) \
6197 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6199 this_mod_end = i + LEN; \
6204 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6205 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6206 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6210 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6212 #undef MULTI_LETTER_MOD
6216 /* If we found no modifier, stop looking for them. */
6217 if (this_mod_end
== 0)
6220 /* Check there is a dash after the modifier, so that it
6221 really is a modifier. */
6222 if (this_mod_end
>= SBYTES (name
)
6223 || SREF (name
, this_mod_end
) != '-')
6226 /* This modifier is real; look for another. */
6227 modifiers
|= this_mod
;
6228 i
= this_mod_end
+ 1;
6231 /* Should we include the `click' modifier? */
6232 if (! (modifiers
& (down_modifier
| drag_modifier
6233 | double_modifier
| triple_modifier
))
6234 && i
+ 7 == SBYTES (name
)
6235 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6236 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6237 modifiers
|= click_modifier
;
6239 if (! (modifiers
& (double_modifier
| triple_modifier
))
6240 && i
+ 6 < SBYTES (name
)
6241 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6242 modifiers
|= click_modifier
;
6250 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6251 prepended to the string BASE[0..BASE_LEN-1].
6252 This doesn't use any caches. */
6254 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6256 /* Since BASE could contain nulls, we can't use intern here; we have
6257 to use Fintern, which expects a genuine Lisp_String, and keeps a
6259 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6265 /* Only the event queue may use the `up' modifier; it should always
6266 be turned into a click or drag event before presented to lisp code. */
6267 if (modifiers
& up_modifier
)
6270 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6271 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6272 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6273 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6274 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6275 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6276 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6277 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6278 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6279 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6280 /* The click modifier is denoted by the absence of other modifiers. */
6284 mod_len
= p
- new_mods
;
6288 Lisp_Object new_name
;
6290 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6291 mod_len
+ base_len_byte
);
6292 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6293 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6295 return Fintern (new_name
, Qnil
);
6300 static const char *const modifier_names
[] =
6302 "up", "down", "drag", "click", "double", "triple", 0, 0,
6303 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6304 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6306 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6308 static Lisp_Object modifier_symbols
;
6310 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6312 lispy_modifier_list (int modifiers
)
6314 Lisp_Object modifier_list
;
6317 modifier_list
= Qnil
;
6318 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6319 if (modifiers
& (1<<i
))
6320 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6323 return modifier_list
;
6327 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6328 where UNMODIFIED is the unmodified form of SYMBOL,
6329 MASK is the set of modifiers present in SYMBOL's name.
6330 This is similar to parse_modifiers_uncached, but uses the cache in
6331 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6332 Qevent_symbol_elements property. */
6334 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6337 parse_modifiers (Lisp_Object symbol
)
6339 Lisp_Object elements
;
6341 if (INTEGERP (symbol
))
6342 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6343 else if (!SYMBOLP (symbol
))
6346 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6347 if (CONSP (elements
))
6352 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6353 Lisp_Object unmodified
;
6356 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6357 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6360 if (modifiers
& ~INTMASK
)
6362 XSETFASTINT (mask
, modifiers
);
6363 elements
= list2 (unmodified
, mask
);
6365 /* Cache the parsing results on SYMBOL. */
6366 Fput (symbol
, Qevent_symbol_element_mask
,
6368 Fput (symbol
, Qevent_symbol_elements
,
6369 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6371 /* Since we know that SYMBOL is modifiers applied to unmodified,
6372 it would be nice to put that in unmodified's cache.
6373 But we can't, since we're not sure that parse_modifiers is
6380 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6381 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6382 doc
: /* Parse the event symbol. For internal use. */)
6383 (Lisp_Object symbol
)
6385 /* Fill the cache if needed. */
6386 parse_modifiers (symbol
);
6387 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6388 and use the Lispier representation stored on Qevent_symbol_elements
6390 return Fget (symbol
, Qevent_symbol_elements
);
6393 /* Apply the modifiers MODIFIERS to the symbol BASE.
6394 BASE must be unmodified.
6396 This is like apply_modifiers_uncached, but uses BASE's
6397 Qmodifier_cache property, if present. It also builds
6398 Qevent_symbol_elements properties, since it has that info anyway.
6400 apply_modifiers copies the value of BASE's Qevent_kind property to
6401 the modified symbol. */
6403 apply_modifiers (int modifiers
, Lisp_Object base
)
6405 Lisp_Object cache
, idx
, entry
, new_symbol
;
6407 /* Mask out upper bits. We don't know where this value's been. */
6408 modifiers
&= INTMASK
;
6410 if (INTEGERP (base
))
6411 return make_number (XINT (base
) | modifiers
);
6413 /* The click modifier never figures into cache indices. */
6414 cache
= Fget (base
, Qmodifier_cache
);
6415 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6416 entry
= assq_no_quit (idx
, cache
);
6419 new_symbol
= XCDR (entry
);
6422 /* We have to create the symbol ourselves. */
6423 new_symbol
= apply_modifiers_uncached (modifiers
,
6424 SSDATA (SYMBOL_NAME (base
)),
6425 SCHARS (SYMBOL_NAME (base
)),
6426 SBYTES (SYMBOL_NAME (base
)));
6428 /* Add the new symbol to the base's cache. */
6429 entry
= Fcons (idx
, new_symbol
);
6430 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6432 /* We have the parsing info now for free, so we could add it to
6434 XSETFASTINT (idx, modifiers);
6435 Fput (new_symbol, Qevent_symbol_element_mask,
6437 Fput (new_symbol, Qevent_symbol_elements,
6438 Fcons (base, lispy_modifier_list (modifiers)));
6439 Sadly, this is only correct if `base' is indeed a base event,
6440 which is not necessarily the case. -stef */
6443 /* Make sure this symbol is of the same kind as BASE.
6445 You'd think we could just set this once and for all when we
6446 intern the symbol above, but reorder_modifiers may call us when
6447 BASE's property isn't set right; we can't assume that just
6448 because it has a Qmodifier_cache property it must have its
6449 Qevent_kind set right as well. */
6450 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6454 kind
= Fget (base
, Qevent_kind
);
6456 Fput (new_symbol
, Qevent_kind
, kind
);
6463 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6464 return a symbol with the modifiers placed in the canonical order.
6465 Canonical order is alphabetical, except for down and drag, which
6466 always come last. The 'click' modifier is never written out.
6468 Fdefine_key calls this to make sure that (for example) C-M-foo
6469 and M-C-foo end up being equivalent in the keymap. */
6472 reorder_modifiers (Lisp_Object symbol
)
6474 /* It's hopefully okay to write the code this way, since everything
6475 will soon be in caches, and no consing will be done at all. */
6478 parsed
= parse_modifiers (symbol
);
6479 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6484 /* For handling events, we often want to produce a symbol whose name
6485 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6486 to some base, like the name of a function key or mouse button.
6487 modify_event_symbol produces symbols of this sort.
6489 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6490 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6493 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6494 into symbol names, or a string specifying a name stem used to
6495 construct a symbol name or the form `STEM-N', where N is the decimal
6496 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6497 non-nil; otherwise NAME_TABLE is used.
6499 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6500 persist between calls to modify_event_symbol that it can use to
6501 store a cache of the symbols it's generated for this NAME_TABLE
6502 before. The object stored there may be a vector or an alist.
6504 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6506 MODIFIERS is a set of modifier bits (as given in struct input_events)
6507 whose prefixes should be applied to the symbol name.
6509 SYMBOL_KIND is the value to be placed in the event_kind property of
6510 the returned symbol.
6512 The symbols we create are supposed to have an
6513 `event-symbol-elements' property, which lists the modifiers present
6514 in the symbol's name. */
6517 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6518 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6519 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6522 Lisp_Object symbol_int
;
6524 /* Get rid of the "vendor-specific" bit here. */
6525 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6527 /* Is this a request for a valid symbol? */
6528 if (symbol_num
< 0 || symbol_num
>= table_size
)
6531 if (CONSP (*symbol_table
))
6532 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6534 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6535 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6536 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6537 we've never used that symbol before. */
6540 if (! VECTORP (*symbol_table
)
6541 || ASIZE (*symbol_table
) != table_size
)
6545 XSETFASTINT (size
, table_size
);
6546 *symbol_table
= Fmake_vector (size
, Qnil
);
6549 value
= AREF (*symbol_table
, symbol_num
);
6552 /* Have we already used this symbol before? */
6555 /* No; let's create it. */
6556 if (CONSP (name_alist_or_stem
))
6557 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6558 else if (STRINGP (name_alist_or_stem
))
6561 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6562 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6564 buf
= SAFE_ALLOCA (len
);
6565 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6566 XINT (symbol_int
) + 1);
6567 value
= intern (buf
);
6570 else if (name_table
!= 0 && name_table
[symbol_num
])
6571 value
= intern (name_table
[symbol_num
]);
6573 #ifdef HAVE_WINDOW_SYSTEM
6576 char *name
= x_get_keysym_name (symbol_num
);
6578 value
= intern (name
);
6584 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6585 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6586 value
= intern (buf
);
6589 if (CONSP (*symbol_table
))
6590 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6592 ASET (*symbol_table
, symbol_num
, value
);
6594 /* Fill in the cache entries for this symbol; this also
6595 builds the Qevent_symbol_elements property, which the user
6597 apply_modifiers (modifiers
& click_modifier
, value
);
6598 Fput (value
, Qevent_kind
, symbol_kind
);
6601 /* Apply modifiers to that symbol. */
6602 return apply_modifiers (modifiers
, value
);
6605 /* Convert a list that represents an event type,
6606 such as (ctrl meta backspace), into the usual representation of that
6607 event type as a number or a symbol. */
6609 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6610 doc
: /* Convert the event description list EVENT-DESC to an event type.
6611 EVENT-DESC should contain one base event type (a character or symbol)
6612 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6613 drag, down, double or triple). The base must be last.
6614 The return value is an event type (a character or symbol) which
6615 has the same base event type and all the specified modifiers. */)
6616 (Lisp_Object event_desc
)
6624 while (CONSP (rest
))
6632 /* Given a symbol, see if it is a modifier name. */
6633 if (SYMBOLP (elt
) && CONSP (rest
))
6634 this = parse_solitary_modifier (elt
);
6638 else if (!NILP (base
))
6639 error ("Two bases given in one event");
6645 /* Let the symbol A refer to the character A. */
6646 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6647 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6649 if (INTEGERP (base
))
6651 /* Turn (shift a) into A. */
6652 if ((modifiers
& shift_modifier
) != 0
6653 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6655 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6656 modifiers
&= ~shift_modifier
;
6659 /* Turn (control a) into C-a. */
6660 if (modifiers
& ctrl_modifier
)
6661 return make_number ((modifiers
& ~ctrl_modifier
)
6662 | make_ctrl_char (XINT (base
)));
6664 return make_number (modifiers
| XINT (base
));
6666 else if (SYMBOLP (base
))
6667 return apply_modifiers (modifiers
, base
);
6669 error ("Invalid base event");
6672 /* Try to recognize SYMBOL as a modifier name.
6673 Return the modifier flag bit, or 0 if not recognized. */
6676 parse_solitary_modifier (Lisp_Object symbol
)
6678 Lisp_Object name
= SYMBOL_NAME (symbol
);
6680 switch (SREF (name
, 0))
6682 #define SINGLE_LETTER_MOD(BIT) \
6683 if (SBYTES (name) == 1) \
6686 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6687 if (LEN == SBYTES (name) \
6688 && ! memcmp (SDATA (name), NAME, LEN)) \
6692 SINGLE_LETTER_MOD (alt_modifier
);
6696 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6700 SINGLE_LETTER_MOD (ctrl_modifier
);
6704 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6705 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6709 SINGLE_LETTER_MOD (hyper_modifier
);
6713 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6717 SINGLE_LETTER_MOD (meta_modifier
);
6721 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6725 SINGLE_LETTER_MOD (shift_modifier
);
6729 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6730 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6731 SINGLE_LETTER_MOD (super_modifier
);
6735 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6736 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6737 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6741 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6744 #undef SINGLE_LETTER_MOD
6745 #undef MULTI_LETTER_MOD
6751 /* Return true if EVENT is a list whose elements are all integers or symbols.
6752 Such a list is not valid as an event,
6753 but it can be a Lucid-style event type list. */
6756 lucid_event_type_list_p (Lisp_Object object
)
6760 if (! CONSP (object
))
6763 if (EQ (XCAR (object
), Qhelp_echo
)
6764 || EQ (XCAR (object
), Qvertical_line
)
6765 || EQ (XCAR (object
), Qmode_line
)
6766 || EQ (XCAR (object
), Qheader_line
))
6769 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6773 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6780 /* Return true if terminal input chars are available.
6781 Also, store the return value into INPUT_PENDING.
6783 Serves the purpose of ioctl (0, FIONREAD, ...)
6784 but works even if FIONREAD does not exist.
6785 (In fact, this may actually read some input.)
6787 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6788 timer events that are ripe.
6789 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6790 events (FOCUS_IN_EVENT).
6791 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6792 movements and toolkit scroll bar thumb drags. */
6795 get_input_pending (int flags
)
6797 /* First of all, have we already counted some input? */
6798 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6800 /* If input is being read as it arrives, and we have none, there is none. */
6801 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6803 /* Try to read some input and see how much we get. */
6805 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6808 return input_pending
;
6811 /* Put a BUFFER_SWITCH_EVENT in the buffer
6812 so that read_key_sequence will notice the new current buffer. */
6815 record_asynch_buffer_change (void)
6817 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6818 The purpose of the event is to make read_key_sequence look up the
6819 keymaps again. If we aren't in read_key_sequence, we don't need one,
6820 and the event could cause trouble by messing up (input-pending-p).
6821 Note: Fwaiting_for_user_input_p always returns nil when async
6822 subprocesses aren't supported. */
6823 if (!NILP (Fwaiting_for_user_input_p ()))
6825 struct input_event event
;
6828 event
.kind
= BUFFER_SWITCH_EVENT
;
6829 event
.frame_or_window
= Qnil
;
6832 /* Make sure no interrupt happens while storing the event. */
6834 if (interrupt_input
)
6835 kbd_buffer_store_event (&event
);
6840 kbd_buffer_store_event (&event
);
6846 /* Read any terminal input already buffered up by the system
6847 into the kbd_buffer, but do not wait.
6849 Return the number of keyboard chars read, or -1 meaning
6850 this is a bad time to try to read input. */
6859 /* Store pending user signal events, if any. */
6860 store_user_signal_events ();
6862 /* Loop through the available terminals, and call their input hooks. */
6866 struct terminal
*next
= t
->next_terminal
;
6868 if (t
->read_socket_hook
)
6871 struct input_event hold_quit
;
6873 if (input_blocked_p ())
6875 pending_signals
= 1;
6879 EVENT_INIT (hold_quit
);
6880 hold_quit
.kind
= NO_EVENT
;
6882 /* No need for FIONREAD or fcntl; just say don't wait. */
6883 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6886 if (nr
== -1) /* Not OK to read input now. */
6890 else if (nr
== -2) /* Non-transient error. */
6892 /* The terminal device terminated; it should be closed. */
6894 /* Kill Emacs if this was our last terminal. */
6895 if (!terminal_list
->next_terminal
)
6896 /* Formerly simply reported no input, but that
6897 sometimes led to a failure of Emacs to terminate.
6898 SIGHUP seems appropriate if we can't reach the
6900 /* ??? Is it really right to send the signal just to
6901 this process rather than to the whole process
6902 group? Perhaps on systems with FIONREAD Emacs is
6903 alone in its group. */
6904 terminate_due_to_signal (SIGHUP
, 10);
6906 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6909 XSETTERMINAL (tmp
, t
);
6910 Fdelete_terminal (tmp
, Qnoelisp
);
6914 if (hold_quit
.kind
!= NO_EVENT
)
6915 kbd_buffer_store_event (&hold_quit
);
6924 frame_make_pointer_visible ();
6929 /* This is the tty way of reading available input.
6931 Note that each terminal device has its own `struct terminal' object,
6932 and so this function is called once for each individual termcap
6933 terminal. The first parameter indicates which terminal to read from. */
6936 tty_read_avail_input (struct terminal
*terminal
,
6937 struct input_event
*hold_quit
)
6939 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6940 the kbd_buffer can really hold. That may prevent loss
6941 of characters on some systems when input is stuffed at us. */
6942 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6944 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6947 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6949 if (kbd_on_hold_p () || buffer_free
<= 0)
6951 #endif /* subprocesses */
6953 if (!terminal
->name
) /* Don't read from a dead terminal. */
6956 if (terminal
->type
!= output_termcap
6957 && terminal
->type
!= output_msdos_raw
)
6960 /* XXX I think the following code should be moved to separate hook
6961 functions in system-dependent files. */
6963 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6964 code sets read_socket_hook to w32_console_read_socket instead! */
6966 #else /* not WINDOWSNT */
6967 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6971 return 0; /* The terminal is suspended. */
6974 n_to_read
= dos_keysns ();
6978 cbuf
[0] = dos_keyread ();
6981 #else /* not MSDOS */
6986 struct input_event gpm_hold_quit
;
6987 int gpm
, fd
= gpm_fd
;
6989 EVENT_INIT (gpm_hold_quit
);
6990 gpm_hold_quit
.kind
= NO_EVENT
;
6992 /* gpm==1 if event received.
6993 gpm==0 if the GPM daemon has closed the connection, in which case
6994 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6995 we save it in `fd' so close_gpm can remove it from the
6997 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6998 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6999 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7002 /* Presumably the GPM daemon has closed the connection. */
7004 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7005 kbd_buffer_store_event (&gpm_hold_quit
);
7009 #endif /* HAVE_GPM */
7011 /* Determine how many characters we should *try* to read. */
7012 #ifdef USABLE_FIONREAD
7013 /* Find out how much input is available. */
7014 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7016 if (! noninteractive
)
7017 return -2; /* Close this terminal. */
7023 if (n_to_read
> sizeof cbuf
)
7024 n_to_read
= sizeof cbuf
;
7025 #elif defined USG || defined CYGWIN
7026 /* Read some input if available, but don't wait. */
7027 n_to_read
= sizeof cbuf
;
7028 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7030 # error "Cannot read without possibly delaying"
7034 /* Don't read more than we can store. */
7035 if (n_to_read
> buffer_free
)
7036 n_to_read
= buffer_free
;
7037 #endif /* subprocesses */
7039 /* Now read; for one reason or another, this will not block.
7040 NREAD is set to the number of chars read. */
7043 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7044 /* POSIX infers that processes which are not in the session leader's
7045 process group won't get SIGHUPs at logout time. BSDI adheres to
7046 this part standard and returns -1 from read (0) with errno==EIO
7047 when the control tty is taken away.
7048 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7049 if (nread
== -1 && errno
== EIO
)
7050 return -2; /* Close this terminal. */
7051 #if defined (AIX) && defined (_BSD)
7052 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7053 This looks incorrect, but it isn't, because _BSD causes
7054 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7055 and that causes a value other than 0 when there is no input. */
7057 return -2; /* Close this terminal. */
7061 /* We used to retry the read if it was interrupted.
7062 But this does the wrong thing when O_NONBLOCK causes
7063 an EAGAIN error. Does anybody know of a situation
7064 where a retry is actually needed? */
7066 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7076 #ifndef USABLE_FIONREAD
7077 #if defined (USG) || defined (CYGWIN)
7078 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7079 #endif /* USG or CYGWIN */
7080 #endif /* no FIONREAD */
7085 #endif /* not MSDOS */
7086 #endif /* not WINDOWSNT */
7088 for (i
= 0; i
< nread
; i
++)
7090 struct input_event buf
;
7092 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7094 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7095 buf
.modifiers
= meta_modifier
;
7096 if (tty
->meta_key
!= 2)
7100 /* Set the frame corresponding to the active tty. Note that the
7101 value of selected_frame is not reliable here, redisplay tends
7102 to temporarily change it. */
7103 buf
.frame_or_window
= tty
->top_frame
;
7106 kbd_buffer_store_event (&buf
);
7107 /* Don't look at input that follows a C-g too closely.
7108 This reduces lossage due to autorepeat on C-g. */
7109 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7110 && buf
.code
== quit_char
)
7118 handle_async_input (void)
7123 int nread
= gobble_input ();
7124 /* -1 means it's not ok to read the input now.
7125 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7126 0 means there was no keyboard input available. */
7134 process_pending_signals (void)
7136 pending_signals
= 0;
7137 handle_async_input ();
7138 do_pending_atimers ();
7141 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7142 and reinvoke any pending signal if the level is now 0 and
7143 a fatal error is not already in progress. */
7146 unblock_input_to (int level
)
7148 interrupt_input_blocked
= level
;
7151 if (pending_signals
&& !fatal_error_in_progress
)
7152 process_pending_signals ();
7158 /* End critical section.
7160 If doing signal-driven input, and a signal came in when input was
7161 blocked, reinvoke the signal handler now to deal with it. */
7164 unblock_input (void)
7166 unblock_input_to (interrupt_input_blocked
- 1);
7169 /* Undo any number of BLOCK_INPUT calls,
7170 and also reinvoke any pending signal. */
7173 totally_unblock_input (void)
7175 unblock_input_to (0);
7181 handle_input_available_signal (int sig
)
7183 pending_signals
= 1;
7185 if (input_available_clear_time
)
7186 *input_available_clear_time
= make_timespec (0, 0);
7190 deliver_input_available_signal (int sig
)
7192 deliver_process_signal (sig
, handle_input_available_signal
);
7194 #endif /* USABLE_SIGIO */
7197 /* User signal events. */
7199 struct user_signal_info
7201 /* Signal number. */
7204 /* Name of the signal. */
7207 /* Number of pending signals. */
7210 struct user_signal_info
*next
;
7213 /* List of user signals. */
7214 static struct user_signal_info
*user_signals
= NULL
;
7217 add_user_signal (int sig
, const char *name
)
7219 struct sigaction action
;
7220 struct user_signal_info
*p
;
7222 for (p
= user_signals
; p
; p
= p
->next
)
7224 /* Already added. */
7227 p
= xmalloc (sizeof *p
);
7229 p
->name
= xstrdup (name
);
7231 p
->next
= user_signals
;
7234 emacs_sigaction_init (&action
, deliver_user_signal
);
7235 sigaction (sig
, &action
, 0);
7239 handle_user_signal (int sig
)
7241 struct user_signal_info
*p
;
7242 const char *special_event_name
= NULL
;
7244 if (SYMBOLP (Vdebug_on_event
))
7245 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7247 for (p
= user_signals
; p
; p
= p
->next
)
7250 if (special_event_name
7251 && strcmp (special_event_name
, p
->name
) == 0)
7253 /* Enter the debugger in many ways. */
7254 debug_on_next_call
= 1;
7257 Vinhibit_quit
= Qnil
;
7259 /* Eat the event. */
7265 if (interrupt_input
)
7266 handle_input_available_signal (sig
);
7270 /* Tell wait_reading_process_output that it needs to wake
7271 up and look around. */
7272 if (input_available_clear_time
)
7273 *input_available_clear_time
= make_timespec (0, 0);
7280 deliver_user_signal (int sig
)
7282 deliver_process_signal (sig
, handle_user_signal
);
7286 find_user_signal_name (int sig
)
7288 struct user_signal_info
*p
;
7290 for (p
= user_signals
; p
; p
= p
->next
)
7298 store_user_signal_events (void)
7300 struct user_signal_info
*p
;
7301 struct input_event buf
;
7302 bool buf_initialized
= 0;
7304 for (p
= user_signals
; p
; p
= p
->next
)
7305 if (p
->npending
> 0)
7307 if (! buf_initialized
)
7309 memset (&buf
, 0, sizeof buf
);
7310 buf
.kind
= USER_SIGNAL_EVENT
;
7311 buf
.frame_or_window
= selected_frame
;
7312 buf_initialized
= 1;
7318 kbd_buffer_store_event (&buf
);
7321 while (p
->npending
> 0);
7326 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7327 static Lisp_Object menu_bar_one_keymap_changed_items
;
7329 /* These variables hold the vector under construction within
7330 menu_bar_items and its subroutines, and the current index
7331 for storing into that vector. */
7332 static Lisp_Object menu_bar_items_vector
;
7333 static int menu_bar_items_index
;
7336 static const char* separator_names
[] = {
7341 "single-dashed-line",
7342 "double-dashed-line",
7344 "shadow-etched-out",
7345 "shadow-etched-in-dash",
7346 "shadow-etched-out-dash",
7347 "shadow-double-etched-in",
7348 "shadow-double-etched-out",
7349 "shadow-double-etched-in-dash",
7350 "shadow-double-etched-out-dash",
7354 /* Return true if LABEL specifies a separator. */
7357 menu_separator_name_p (const char *label
)
7361 else if (strlen (label
) > 3
7362 && memcmp (label
, "--", 2) == 0
7367 for (i
= 0; separator_names
[i
]; ++i
)
7368 if (strcmp (label
, separator_names
[i
]) == 0)
7373 /* It's a separator if it contains only dashes. */
7374 while (*label
== '-')
7376 return (*label
== 0);
7383 /* Return a vector of menu items for a menu bar, appropriate
7384 to the current buffer. Each item has three elements in the vector:
7387 OLD is an old vector we can optionally reuse, or nil. */
7390 menu_bar_items (Lisp_Object old
)
7392 /* The number of keymaps we're scanning right now, and the number of
7393 keymaps we have allocated space for. */
7396 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7397 in the current keymaps, or nil where it is not a prefix. */
7400 Lisp_Object def
, tail
;
7405 /* In order to build the menus, we need to call the keymap
7406 accessors. They all call QUIT. But this function is called
7407 during redisplay, during which a quit is fatal. So inhibit
7408 quitting while building the menus.
7409 We do this instead of specbind because (1) errors will clear it anyway
7410 and (2) this avoids risk of specpdl overflow. */
7411 oquit
= Vinhibit_quit
;
7415 menu_bar_items_vector
= old
;
7417 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7418 menu_bar_items_index
= 0;
7420 /* Build our list of keymaps.
7421 If we recognize a function key and replace its escape sequence in
7422 keybuf with its symbol, or if the sequence starts with a mouse
7423 click and we need to switch buffers, we jump back here to rebuild
7424 the initial keymaps from the current buffer. */
7428 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7429 if (!NILP (Voverriding_local_map_menu_flag
)
7430 && !NILP (Voverriding_local_map
))
7432 /* Yes, use them (if non-nil) as well as the global map. */
7433 maps
= alloca (3 * sizeof (maps
[0]));
7435 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7436 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7437 if (!NILP (Voverriding_local_map
))
7438 maps
[nmaps
++] = Voverriding_local_map
;
7442 /* No, so use major and minor mode keymaps and keymap property.
7443 Note that menu-bar bindings in the local-map and keymap
7444 properties may not work reliable, as they are only
7445 recognized when the menu-bar (or mode-line) is updated,
7446 which does not normally happen after every command. */
7449 nminor
= current_minor_maps (NULL
, &tmaps
);
7450 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7452 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7453 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7454 maps
[nmaps
++] = tem
;
7455 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7456 maps
[nmaps
++] = tem
;
7457 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7459 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7461 maps
[nmaps
++] = current_global_map
;
7464 /* Look up in each map the dummy prefix key `menu-bar'. */
7466 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7467 if (!NILP (maps
[mapno
]))
7469 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7473 menu_bar_one_keymap_changed_items
= Qnil
;
7474 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7478 /* Move to the end those items that should be at the end. */
7480 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7483 int end
= menu_bar_items_index
;
7485 for (i
= 0; i
< end
; i
+= 4)
7486 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7488 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7489 /* Move the item at index I to the end,
7490 shifting all the others forward. */
7491 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7492 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7493 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7494 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7496 memmove (aref_addr (menu_bar_items_vector
, i
),
7497 aref_addr (menu_bar_items_vector
, i
+ 4),
7498 (end
- i
- 4) * word_size
);
7499 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7500 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7501 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7502 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7507 /* Add nil, nil, nil, nil at the end. */
7509 int i
= menu_bar_items_index
;
7510 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7511 menu_bar_items_vector
=
7512 larger_vector (menu_bar_items_vector
, 4, -1);
7513 /* Add this item. */
7514 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7515 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7516 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7517 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7518 menu_bar_items_index
= i
;
7521 Vinhibit_quit
= oquit
;
7522 return menu_bar_items_vector
;
7525 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7526 If there's already an item for KEY, add this DEF to it. */
7528 Lisp_Object item_properties
;
7531 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7533 struct gcpro gcpro1
;
7538 if (EQ (item
, Qundefined
))
7540 /* If a map has an explicit `undefined' as definition,
7541 discard any previously made menu bar item. */
7543 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7544 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7546 if (menu_bar_items_index
> i
+ 4)
7547 memmove (aref_addr (menu_bar_items_vector
, i
),
7548 aref_addr (menu_bar_items_vector
, i
+ 4),
7549 (menu_bar_items_index
- i
- 4) * word_size
);
7550 menu_bar_items_index
-= 4;
7554 /* If this keymap has already contributed to this KEY,
7555 don't contribute to it a second time. */
7556 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7557 if (!NILP (tem
) || NILP (item
))
7560 menu_bar_one_keymap_changed_items
7561 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7563 /* We add to menu_bar_one_keymap_changed_items before doing the
7564 parse_menu_item, so that if it turns out it wasn't a menu item,
7565 it still correctly hides any further menu item. */
7567 parsed
= parse_menu_item (item
, 1);
7572 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7574 /* Find any existing item for this KEY. */
7575 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7576 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7579 /* If we did not find this KEY, add it at the end. */
7580 if (i
== menu_bar_items_index
)
7582 /* If vector is too small, get a bigger one. */
7583 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7584 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7585 /* Add this item. */
7586 ASET (menu_bar_items_vector
, i
, key
); i
++;
7587 ASET (menu_bar_items_vector
, i
,
7588 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7589 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7590 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7591 menu_bar_items_index
= i
;
7593 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7597 old
= AREF (menu_bar_items_vector
, i
+ 2);
7598 /* If the new and the old items are not both keymaps,
7599 the lookup will only find `item'. */
7600 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7601 ASET (menu_bar_items_vector
, i
+ 2, item
);
7605 /* This is used as the handler when calling menu_item_eval_property. */
7607 menu_item_eval_property_1 (Lisp_Object arg
)
7609 /* If we got a quit from within the menu computation,
7610 quit all the way out of it. This takes care of C-] in the debugger. */
7611 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7612 Fsignal (Qquit
, Qnil
);
7618 eval_dyn (Lisp_Object form
)
7620 return Feval (form
, Qnil
);
7623 /* Evaluate an expression and return the result (or nil if something
7624 went wrong). Used to evaluate dynamic parts of menu items. */
7626 menu_item_eval_property (Lisp_Object sexpr
)
7628 ptrdiff_t count
= SPECPDL_INDEX ();
7630 specbind (Qinhibit_redisplay
, Qt
);
7631 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7632 menu_item_eval_property_1
);
7633 return unbind_to (count
, val
);
7636 /* This function parses a menu item and leaves the result in the
7637 vector item_properties.
7638 ITEM is a key binding, a possible menu item.
7639 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7641 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7642 parse_menu_item returns true if the item is a menu item and false
7646 parse_menu_item (Lisp_Object item
, int inmenubar
)
7648 Lisp_Object def
, tem
, item_string
, start
;
7650 Lisp_Object keyhint
;
7659 /* Create item_properties vector if necessary. */
7660 if (NILP (item_properties
))
7662 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7664 /* Initialize optional entries. */
7665 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7666 ASET (item_properties
, i
, Qnil
);
7667 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7669 /* Save the item here to protect it from GC. */
7670 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7672 item_string
= XCAR (item
);
7676 if (STRINGP (item_string
))
7678 /* Old format menu item. */
7679 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7681 /* Maybe help string. */
7682 if (CONSP (item
) && STRINGP (XCAR (item
)))
7684 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7689 /* Maybe an obsolete key binding cache. */
7690 if (CONSP (item
) && CONSP (XCAR (item
))
7691 && (NILP (XCAR (XCAR (item
)))
7692 || VECTORP (XCAR (XCAR (item
)))))
7695 /* This is the real definition--the function to run. */
7696 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7698 /* Get enable property, if any. */
7701 tem
= Fget (item
, Qmenu_enable
);
7702 if (!NILP (Venable_disabled_menus_and_buttons
))
7703 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7704 else if (!NILP (tem
))
7705 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7708 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7710 /* New format menu item. */
7711 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7712 start
= XCDR (item
);
7715 /* We have a real binding. */
7716 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7718 item
= XCDR (start
);
7719 /* Is there an obsolete cache list with key equivalences. */
7720 if (CONSP (item
) && CONSP (XCAR (item
)))
7723 /* Parse properties. */
7724 while (CONSP (item
) && CONSP (XCDR (item
)))
7729 if (EQ (tem
, QCenable
))
7731 if (!NILP (Venable_disabled_menus_and_buttons
))
7732 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7734 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7736 else if (EQ (tem
, QCvisible
))
7738 /* If got a visible property and that evaluates to nil
7739 then ignore this item. */
7740 tem
= menu_item_eval_property (XCAR (item
));
7744 else if (EQ (tem
, QChelp
))
7745 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7746 else if (EQ (tem
, QCfilter
))
7748 else if (EQ (tem
, QCkey_sequence
))
7751 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7752 /* Be GC protected. Set keyhint to item instead of tem. */
7755 else if (EQ (tem
, QCkeys
))
7758 if (CONSP (tem
) || STRINGP (tem
))
7759 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7761 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7766 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7768 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7770 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7776 else if (inmenubar
|| !NILP (start
))
7780 return 0; /* not a menu item */
7782 /* If item string is not a string, evaluate it to get string.
7783 If we don't get a string, skip this item. */
7784 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7785 if (!(STRINGP (item_string
)))
7787 item_string
= menu_item_eval_property (item_string
);
7788 if (!STRINGP (item_string
))
7790 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7793 /* If got a filter apply it on definition. */
7794 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7797 def
= menu_item_eval_property (list2 (XCAR (filter
),
7798 list2 (Qquote
, def
)));
7800 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7803 /* Enable or disable selection of item. */
7804 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7807 tem
= menu_item_eval_property (tem
);
7808 if (inmenubar
&& NILP (tem
))
7809 return 0; /* Ignore disabled items in menu bar. */
7810 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7813 /* If we got no definition, this item is just unselectable text which
7814 is OK in a submenu but not in the menubar. */
7816 return (!inmenubar
);
7818 /* See if this is a separate pane or a submenu. */
7819 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7820 tem
= get_keymap (def
, 0, 1);
7821 /* For a subkeymap, just record its details and exit. */
7824 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7825 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7829 /* At the top level in the menu bar, do likewise for commands also.
7830 The menu bar does not display equivalent key bindings anyway.
7831 ITEM_PROPERTY_DEF is already set up properly. */
7835 { /* This is a command. See if there is an equivalent key binding. */
7836 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7838 /* The previous code preferred :key-sequence to :keys, so we
7839 preserve this behavior. */
7840 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7841 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7844 Lisp_Object prefix
= keyeq
;
7845 Lisp_Object keys
= Qnil
;
7849 def
= XCAR (prefix
);
7850 prefix
= XCDR (prefix
);
7853 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7855 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7857 keys
= XCAR (keyhint
);
7858 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7860 /* We have a suggested key. Is it bound to the command? */
7863 /* If the command is an alias for another
7864 (such as lmenu.el set it up), check if the
7865 original command matches the cached command. */
7867 && EQ (tem
, XSYMBOL (def
)->function
))))
7872 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7876 tem
= Fkey_description (keys
, Qnil
);
7879 if (STRINGP (XCAR (prefix
)))
7880 tem
= concat2 (XCAR (prefix
), tem
);
7881 if (STRINGP (XCDR (prefix
)))
7882 tem
= concat2 (tem
, XCDR (prefix
));
7884 keyeq
= concat2 (build_string (" "), tem
);
7885 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7891 /* If we have an equivalent key binding, use that. */
7892 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7895 /* Include this when menu help is implemented.
7896 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7897 if (!(NILP (tem) || STRINGP (tem)))
7899 tem = menu_item_eval_property (tem);
7902 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7906 /* Handle radio buttons or toggle boxes. */
7907 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7909 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7910 menu_item_eval_property (tem
));
7917 /***********************************************************************
7919 ***********************************************************************/
7921 /* A vector holding tool bar items while they are parsed in function
7922 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7925 static Lisp_Object tool_bar_items_vector
;
7927 /* A vector holding the result of parse_tool_bar_item. Layout is like
7928 the one for a single item in tool_bar_items_vector. */
7930 static Lisp_Object tool_bar_item_properties
;
7932 /* Next free index in tool_bar_items_vector. */
7934 static int ntool_bar_items
;
7936 /* The symbols `:image' and `:rtl'. */
7938 static Lisp_Object QCimage
;
7939 static Lisp_Object QCrtl
;
7941 /* Function prototypes. */
7943 static void init_tool_bar_items (Lisp_Object
);
7944 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7945 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7946 static void append_tool_bar_item (void);
7949 /* Return a vector of tool bar items for keymaps currently in effect.
7950 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7951 tool bar items found. */
7954 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7963 /* In order to build the menus, we need to call the keymap
7964 accessors. They all call QUIT. But this function is called
7965 during redisplay, during which a quit is fatal. So inhibit
7966 quitting while building the menus. We do this instead of
7967 specbind because (1) errors will clear it anyway and (2) this
7968 avoids risk of specpdl overflow. */
7969 oquit
= Vinhibit_quit
;
7972 /* Initialize tool_bar_items_vector and protect it from GC. */
7973 init_tool_bar_items (reuse
);
7975 /* Build list of keymaps in maps. Set nmaps to the number of maps
7978 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7979 if (!NILP (Voverriding_local_map_menu_flag
)
7980 && !NILP (Voverriding_local_map
))
7982 /* Yes, use them (if non-nil) as well as the global map. */
7983 maps
= alloca (3 * sizeof *maps
);
7985 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7986 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7987 if (!NILP (Voverriding_local_map
))
7988 maps
[nmaps
++] = Voverriding_local_map
;
7992 /* No, so use major and minor mode keymaps and keymap property.
7993 Note that tool-bar bindings in the local-map and keymap
7994 properties may not work reliable, as they are only
7995 recognized when the tool-bar (or mode-line) is updated,
7996 which does not normally happen after every command. */
7999 nminor
= current_minor_maps (NULL
, &tmaps
);
8000 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
8002 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8003 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8004 maps
[nmaps
++] = tem
;
8005 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8006 maps
[nmaps
++] = tem
;
8007 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8009 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8012 /* Add global keymap at the end. */
8013 maps
[nmaps
++] = current_global_map
;
8015 /* Process maps in reverse order and look up in each map the prefix
8017 for (i
= nmaps
- 1; i
>= 0; --i
)
8018 if (!NILP (maps
[i
]))
8022 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8024 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8027 Vinhibit_quit
= oquit
;
8028 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8029 return tool_bar_items_vector
;
8033 /* Process the definition of KEY which is DEF. */
8036 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8039 struct gcpro gcpro1
, gcpro2
;
8041 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8045 if (EQ (def
, Qundefined
))
8047 /* If a map has an explicit `undefined' as definition,
8048 discard any previously made item. */
8049 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8051 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->u
.contents
+ i
;
8053 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8055 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8056 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8057 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8059 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8064 else if (parse_tool_bar_item (key
, def
))
8065 /* Append a new tool bar item to tool_bar_items_vector. Accept
8066 more than one definition for the same key. */
8067 append_tool_bar_item ();
8072 /* Access slot with index IDX of vector tool_bar_item_properties. */
8073 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8075 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8077 ASET (tool_bar_item_properties
, idx
, val
);
8081 /* Parse a tool bar item specification ITEM for key KEY and return the
8082 result in tool_bar_item_properties. Value is false if ITEM is
8085 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8087 CAPTION is the caption of the item, If it's not a string, it is
8088 evaluated to get a string.
8090 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8091 as binding are currently ignored.
8093 The following properties are recognized:
8097 FORM is evaluated and specifies whether the tool bar item is
8098 enabled or disabled.
8102 FORM is evaluated and specifies whether the tool bar item is visible.
8104 - `:filter FUNCTION'
8106 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8107 result is stored as the new binding.
8109 - `:button (TYPE SELECTED)'
8111 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8112 and specifies whether the button is selected (pressed) or not.
8116 IMAGES is either a single image specification or a vector of four
8117 image specifications. See enum tool_bar_item_images.
8119 - `:help HELP-STRING'.
8121 Gives a help string to display for the tool bar item.
8123 - `:label LABEL-STRING'.
8125 A text label to show with the tool bar button if labels are enabled. */
8128 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8130 Lisp_Object filter
= Qnil
;
8131 Lisp_Object caption
;
8133 bool have_label
= 0;
8135 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8136 Rule out items that aren't lists, don't start with
8137 `menu-item' or whose rest following `tool-bar-item' is not a
8142 /* As an exception, allow old-style menu separators. */
8143 if (STRINGP (XCAR (item
)))
8144 item
= list1 (XCAR (item
));
8145 else if (!EQ (XCAR (item
), Qmenu_item
)
8146 || (item
= XCDR (item
), !CONSP (item
)))
8149 /* Create tool_bar_item_properties vector if necessary. Reset it to
8151 if (VECTORP (tool_bar_item_properties
))
8153 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8157 tool_bar_item_properties
8158 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8161 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8162 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8164 /* Get the caption of the item. If the caption is not a string,
8165 evaluate it to get a string. If we don't get a string, skip this
8167 caption
= XCAR (item
);
8168 if (!STRINGP (caption
))
8170 caption
= menu_item_eval_property (caption
);
8171 if (!STRINGP (caption
))
8174 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8176 /* If the rest following the caption is not a list, the menu item is
8177 either a separator, or invalid. */
8181 if (menu_separator_name_p (SSDATA (caption
)))
8183 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8184 #if !defined (USE_GTK) && !defined (HAVE_NS)
8185 /* If we use build_desired_tool_bar_string to render the
8186 tool bar, the separator is rendered as an image. */
8187 set_prop (TOOL_BAR_ITEM_IMAGES
,
8188 (menu_item_eval_property
8189 (Vtool_bar_separator_image_expression
)));
8190 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8191 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8192 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8199 /* Store the binding. */
8200 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8203 /* Ignore cached key binding, if any. */
8204 if (CONSP (item
) && CONSP (XCAR (item
)))
8207 /* Process the rest of the properties. */
8208 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8210 Lisp_Object ikey
, value
;
8213 value
= XCAR (XCDR (item
));
8215 if (EQ (ikey
, QCenable
))
8217 /* `:enable FORM'. */
8218 if (!NILP (Venable_disabled_menus_and_buttons
))
8219 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8221 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8223 else if (EQ (ikey
, QCvisible
))
8225 /* `:visible FORM'. If got a visible property and that
8226 evaluates to nil then ignore this item. */
8227 if (NILP (menu_item_eval_property (value
)))
8230 else if (EQ (ikey
, QChelp
))
8231 /* `:help HELP-STRING'. */
8232 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8233 else if (EQ (ikey
, QCvert_only
))
8234 /* `:vert-only t/nil'. */
8235 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8236 else if (EQ (ikey
, QClabel
))
8238 const char *bad_label
= "!!?GARBLED ITEM?!!";
8239 /* `:label LABEL-STRING'. */
8240 set_prop (TOOL_BAR_ITEM_LABEL
,
8241 STRINGP (value
) ? value
: build_string (bad_label
));
8244 else if (EQ (ikey
, QCfilter
))
8245 /* ':filter FORM'. */
8247 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8249 /* `:button (TYPE . SELECTED)'. */
8250 Lisp_Object type
, selected
;
8252 type
= XCAR (value
);
8253 selected
= XCDR (value
);
8254 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8256 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8257 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8260 else if (EQ (ikey
, QCimage
)
8262 || (VECTORP (value
) && ASIZE (value
) == 4)))
8263 /* Value is either a single image specification or a vector
8264 of 4 such specifications for the different button states. */
8265 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8266 else if (EQ (ikey
, QCrtl
))
8268 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8274 /* Try to make one from caption and key. */
8275 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8276 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8277 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8278 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8280 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8281 char *buf
= xmalloc (max_lbl
+ 1);
8282 Lisp_Object new_lbl
;
8283 ptrdiff_t caption_len
= strlen (capt
);
8285 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8288 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8290 buf
[caption_len
] = '\0';
8294 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8298 strcpy (buf
, label
);
8300 for (j
= 0; buf
[j
] != '\0'; ++j
)
8308 new_lbl
= Fupcase_initials (build_string (label
));
8309 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8310 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8312 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8316 /* If got a filter apply it on binding. */
8318 set_prop (TOOL_BAR_ITEM_BINDING
,
8319 (menu_item_eval_property
8322 PROP (TOOL_BAR_ITEM_BINDING
))))));
8324 /* See if the binding is a keymap. Give up if it is. */
8325 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8328 /* Enable or disable selection of item. */
8329 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8330 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8331 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8333 /* Handle radio buttons or toggle boxes. */
8334 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8335 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8336 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8344 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8345 that can be reused. */
8348 init_tool_bar_items (Lisp_Object reuse
)
8350 if (VECTORP (reuse
))
8351 tool_bar_items_vector
= reuse
;
8353 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8354 ntool_bar_items
= 0;
8358 /* Append parsed tool bar item properties from
8359 tool_bar_item_properties */
8362 append_tool_bar_item (void)
8366 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8368 /* Enlarge tool_bar_items_vector if necessary. */
8370 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8372 /* Append entries from tool_bar_item_properties to the end of
8373 tool_bar_items_vector. */
8374 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8375 XVECTOR (tool_bar_item_properties
)->u
.contents
, TOOL_BAR_ITEM_NSLOTS
);
8376 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8383 /* Read a character using menus based on the keymap MAP.
8384 Return nil if there are no menus in the maps.
8385 Return t if we displayed a menu but the user rejected it.
8387 PREV_EVENT is the previous input event, or nil if we are reading
8388 the first event of a key sequence.
8390 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8391 if we used a mouse menu to read the input, or false otherwise. If
8392 USED_MOUSE_MENU is null, don't dereference it.
8394 The prompting is done based on the prompt-string of the map
8395 and the strings associated with various map elements.
8397 This can be done with X menus or with menus put in the minibuf.
8398 These are done in different ways, depending on how the input will be read.
8399 Menus using X are done after auto-saving in read-char, getting the input
8400 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8401 and do auto-saving in the inner call of read_char. */
8404 read_char_x_menu_prompt (Lisp_Object map
,
8405 Lisp_Object prev_event
, bool *used_mouse_menu
)
8407 if (used_mouse_menu
)
8408 *used_mouse_menu
= 0;
8410 /* Use local over global Menu maps. */
8412 if (! menu_prompting
)
8416 /* If we got to this point via a mouse click,
8417 use a real menu for mouse selection. */
8418 if (EVENT_HAS_PARAMETERS (prev_event
)
8419 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8420 && !EQ (XCAR (prev_event
), Qtool_bar
))
8422 /* Display the menu and get the selection. */
8425 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8430 record_menu_key (XCAR (value
));
8432 /* If we got multiple events, unread all but
8434 There is no way to prevent those unread events
8435 from showing up later in last_nonmenu_event.
8436 So turn symbol and integer events into lists,
8437 to indicate that they came from a mouse menu,
8438 so that when present in last_nonmenu_event
8439 they won't confuse things. */
8440 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8442 record_menu_key (XCAR (tem
));
8443 if (SYMBOLP (XCAR (tem
))
8444 || INTEGERP (XCAR (tem
)))
8445 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8448 /* If we got more than one event, put all but the first
8449 onto this list to be read later.
8450 Return just the first event now. */
8451 Vunread_command_events
8452 = nconc2 (XCDR (value
), Vunread_command_events
);
8453 value
= XCAR (value
);
8455 else if (NILP (value
))
8457 if (used_mouse_menu
)
8458 *used_mouse_menu
= 1;
8461 #endif /* HAVE_MENUS */
8466 read_char_minibuf_menu_prompt (int commandflag
,
8469 register Lisp_Object name
;
8471 /* FIXME: Use the minibuffer's frame width. */
8472 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8474 bool nobindings
= 1;
8475 Lisp_Object rest
, vector
;
8476 Lisp_Object prompt_strings
= Qnil
;
8480 if (! menu_prompting
)
8483 map
= get_keymap (map
, 0, 1);
8484 name
= Fkeymap_prompt (map
);
8486 /* If we don't have any menus, just read a character normally. */
8487 if (!STRINGP (name
))
8490 #define PUSH_C_STR(str, listvar) \
8491 listvar = Fcons (build_unibyte_string (str), listvar)
8493 /* Prompt string always starts with map's prompt, and a space. */
8494 prompt_strings
= Fcons (name
, prompt_strings
);
8495 PUSH_C_STR (": ", prompt_strings
);
8496 nlength
= SCHARS (name
) + 2;
8500 /* Present the documented bindings, a line at a time. */
8504 Lisp_Object menu_strings
= prompt_strings
;
8505 ptrdiff_t i
= nlength
;
8507 Lisp_Object orig_defn_macro
;
8509 /* Loop over elements of map. */
8514 /* FIXME: Use map_keymap to handle new keymap formats. */
8516 /* At end of map, wrap around if just starting,
8517 or end this line if already have something on it. */
8520 if (notfirst
|| nobindings
)
8526 /* Look at the next element of the map. */
8528 elt
= AREF (vector
, idx
);
8530 elt
= Fcar_safe (rest
);
8532 if (idx
< 0 && VECTORP (elt
))
8534 /* If we found a dense table in the keymap,
8535 advanced past it, but start scanning its contents. */
8536 rest
= Fcdr_safe (rest
);
8542 /* An ordinary element. */
8543 Lisp_Object event
, tem
;
8547 event
= Fcar_safe (elt
); /* alist */
8548 elt
= Fcdr_safe (elt
);
8552 XSETINT (event
, idx
); /* vector */
8555 /* Ignore the element if it has no prompt string. */
8556 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8558 /* True if the char to type matches the string. */
8560 Lisp_Object upcased_event
, downcased_event
;
8561 Lisp_Object desc
= Qnil
;
8563 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8565 upcased_event
= Fupcase (event
);
8566 downcased_event
= Fdowncase (event
);
8567 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8568 || XINT (downcased_event
) == SREF (s
, 0));
8570 desc
= Fsingle_key_description (event
, Qnil
);
8572 #if 0 /* It is redundant to list the equivalent key bindings because
8573 the prefix is what the user has already typed. */
8575 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8577 /* Insert equivalent keybinding. */
8578 s
= concat2 (s
, tem
);
8581 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8582 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8584 /* Insert button prefix. */
8585 Lisp_Object selected
8586 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8587 if (EQ (tem
, QCradio
))
8588 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8590 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8591 s
= concat2 (tem
, s
);
8595 /* If we have room for the prompt string, add it to this line.
8596 If this is the first on the line, always add it. */
8597 if ((SCHARS (s
) + i
+ 2
8598 + (char_matches
? 0 : SCHARS (desc
) + 3))
8602 ptrdiff_t thiswidth
;
8604 /* Punctuate between strings. */
8607 PUSH_C_STR (", ", menu_strings
);
8613 /* If the char to type doesn't match the string's
8614 first char, explicitly show what char to type. */
8617 /* Add as much of string as fits. */
8618 thiswidth
= min (SCHARS (desc
), width
- i
);
8620 = Fcons (Fsubstring (desc
, make_number (0),
8621 make_number (thiswidth
)),
8624 PUSH_C_STR (" = ", menu_strings
);
8628 /* Add as much of string as fits. */
8629 thiswidth
= min (SCHARS (s
), width
- i
);
8631 = Fcons (Fsubstring (s
, make_number (0),
8632 make_number (thiswidth
)),
8638 /* If this element does not fit, end the line now,
8639 and save the element for the next line. */
8640 PUSH_C_STR ("...", menu_strings
);
8645 /* Move past this element. */
8646 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8647 /* Handle reaching end of dense table. */
8652 rest
= Fcdr_safe (rest
);
8656 /* Prompt with that and read response. */
8657 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8659 /* Make believe it's not a keyboard macro in case the help char
8660 is pressed. Help characters are not recorded because menu prompting
8661 is not used on replay. */
8662 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8663 kset_defining_kbd_macro (current_kboard
, Qnil
);
8665 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8666 while (BUFFERP (obj
));
8667 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8669 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8672 if (! EQ (obj
, menu_prompt_more_char
)
8673 && (!INTEGERP (menu_prompt_more_char
)
8674 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8676 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8677 store_kbd_macro_char (obj
);
8680 /* Help char - go round again. */
8684 /* Reading key sequences. */
8687 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8689 return access_keymap (get_keymap (keymap
, 0, 1),
8694 active_maps (Lisp_Object first_event
)
8696 Lisp_Object position
8697 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8698 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8701 /* Structure used to keep track of partial application of key remapping
8702 such as Vfunction_key_map and Vkey_translation_map. */
8703 typedef struct keyremap
8705 /* This is the map originally specified for this use. */
8707 /* This is a submap reached by looking up, in PARENT,
8708 the events from START to END. */
8710 /* Positions [START, END) in the key sequence buffer
8711 are the key that we have scanned so far.
8712 Those events are the ones that we will replace
8713 if PARENT maps them into a key sequence. */
8717 /* Lookup KEY in MAP.
8718 MAP is a keymap mapping keys to key vectors or functions.
8719 If the mapping is a function and DO_FUNCALL is true,
8720 the function is called with PROMPT as parameter and its return
8721 value is used as the return value of this function (after checking
8722 that it is indeed a vector). */
8725 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8730 next
= access_keymap (map
, key
, 1, 0, 1);
8732 /* Handle a symbol whose function definition is a keymap
8734 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8735 && (ARRAYP (XSYMBOL (next
)->function
)
8736 || KEYMAPP (XSYMBOL (next
)->function
)))
8737 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8739 /* If the keymap gives a function, not an
8740 array, then call the function with one arg and use
8741 its value instead. */
8742 if (do_funcall
&& FUNCTIONP (next
))
8747 next
= call1 (next
, prompt
);
8748 /* If the function returned something invalid,
8749 barf--don't ignore it.
8750 (To ignore it safely, we would need to gcpro a bunch of
8751 other variables.) */
8752 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8753 error ("Function %s returns invalid key sequence",
8754 SSDATA (SYMBOL_NAME (tem
)));
8759 /* Do one step of the key remapping used for function-key-map and
8760 key-translation-map:
8761 KEYBUF is the buffer holding the input events.
8762 BUFSIZE is its maximum size.
8763 FKEY is a pointer to the keyremap structure to use.
8764 INPUT is the index of the last element in KEYBUF.
8765 DOIT if true says that the remapping can actually take place.
8766 DIFF is used to return the number of keys added/removed by the remapping.
8767 PARENT is the root of the keymap.
8768 PROMPT is the prompt to use if the remapping happens through a function.
8769 Return true if the remapping actually took place. */
8772 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8773 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8775 Lisp_Object next
, key
;
8777 key
= keybuf
[fkey
->end
++];
8779 if (KEYMAPP (fkey
->parent
))
8780 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8784 /* If keybuf[fkey->start..fkey->end] is bound in the
8785 map and we're in a position to do the key remapping, replace it with
8786 the binding and restart with fkey->start at the end. */
8787 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8789 int len
= XFASTINT (Flength (next
));
8792 *diff
= len
- (fkey
->end
- fkey
->start
);
8794 if (bufsize
- input
<= *diff
)
8795 error ("Key sequence too long");
8797 /* Shift the keys that follow fkey->end. */
8799 for (i
= fkey
->end
; i
< input
; i
++)
8800 keybuf
[i
+ *diff
] = keybuf
[i
];
8802 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8803 keybuf
[i
+ *diff
] = keybuf
[i
];
8804 /* Overwrite the old keys with the new ones. */
8805 for (i
= 0; i
< len
; i
++)
8806 keybuf
[fkey
->start
+ i
]
8807 = Faref (next
, make_number (i
));
8809 fkey
->start
= fkey
->end
+= *diff
;
8810 fkey
->map
= fkey
->parent
;
8815 fkey
->map
= get_keymap (next
, 0, 1);
8817 /* If we no longer have a bound suffix, try a new position for
8819 if (!CONSP (fkey
->map
))
8821 fkey
->end
= ++fkey
->start
;
8822 fkey
->map
= fkey
->parent
;
8828 test_undefined (Lisp_Object binding
)
8830 return (NILP (binding
)
8831 || EQ (binding
, Qundefined
)
8832 || (SYMBOLP (binding
)
8833 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8836 /* Read a sequence of keys that ends with a non prefix character,
8837 storing it in KEYBUF, a buffer of size BUFSIZE.
8839 Return the length of the key sequence stored.
8840 Return -1 if the user rejected a command menu.
8842 Echo starting immediately unless `prompt' is 0.
8844 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8845 read_char with a suitable COMMANDFLAG argument.
8847 Where a key sequence ends depends on the currently active keymaps.
8848 These include any minor mode keymaps active in the current buffer,
8849 the current buffer's local map, and the global map.
8851 If a key sequence has no other bindings, we check Vfunction_key_map
8852 to see if some trailing subsequence might be the beginning of a
8853 function key's sequence. If so, we try to read the whole function
8854 key, and substitute its symbolic name into the key sequence.
8856 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8857 `double-' events into similar click events, if that would make them
8858 bound. We try to turn `triple-' events first into `double-' events,
8861 If we get a mouse click in a mode line, vertical divider, or other
8862 non-text area, we treat the click as if it were prefixed by the
8863 symbol denoting that area - `mode-line', `vertical-line', or
8866 If the sequence starts with a mouse click, we read the key sequence
8867 with respect to the buffer clicked on, not the current buffer.
8869 If the user switches frames in the midst of a key sequence, we put
8870 off the switch-frame event until later; the next call to
8871 read_char will return it.
8873 If FIX_CURRENT_BUFFER, we restore current_buffer
8874 from the selected window's buffer. */
8877 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8878 bool dont_downcase_last
, bool can_return_switch_frame
,
8879 bool fix_current_buffer
, bool prevent_redisplay
)
8881 ptrdiff_t count
= SPECPDL_INDEX ();
8883 /* How many keys there are in the current key sequence. */
8886 /* The length of the echo buffer when we started reading, and
8887 the length of this_command_keys when we started reading. */
8888 ptrdiff_t echo_start
IF_LINT (= 0);
8889 ptrdiff_t keys_start
;
8891 Lisp_Object current_binding
= Qnil
;
8892 Lisp_Object first_event
= Qnil
;
8894 /* Index of the first key that has no binding.
8895 It is useless to try fkey.start larger than that. */
8898 /* If t < mock_input, then KEYBUF[t] should be read as the next
8901 We use this to recover after recognizing a function key. Once we
8902 realize that a suffix of the current key sequence is actually a
8903 function key's escape sequence, we replace the suffix with the
8904 function key's binding from Vfunction_key_map. Now keybuf
8905 contains a new and different key sequence, so the echo area,
8906 this_command_keys, and the submaps and defs arrays are wrong. In
8907 this situation, we set mock_input to t, set t to 0, and jump to
8908 restart_sequence; the loop will read keys from keybuf up until
8909 mock_input, thus rebuilding the state; and then it will resume
8910 reading characters from the keyboard. */
8913 /* If the sequence is unbound in submaps[], then
8914 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8915 and fkey.map is its binding.
8917 These might be > t, indicating that all function key scanning
8918 should hold off until t reaches them. We do this when we've just
8919 recognized a function key, to avoid searching for the function
8920 key's again in Vfunction_key_map. */
8923 /* Likewise, for key_translation_map and input-decode-map. */
8924 keyremap keytran
, indec
;
8926 /* True if we are trying to map a key by changing an upper-case
8927 letter to lower case, or a shifted function key to an unshifted
8929 bool shift_translated
= 0;
8931 /* If we receive a `switch-frame' or `select-window' event in the middle of
8932 a key sequence, we put it off for later.
8933 While we're reading, we keep the event here. */
8934 Lisp_Object delayed_switch_frame
;
8936 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8937 int original_uppercase_position
= -1;
8939 /* Gets around Microsoft compiler limitations. */
8942 struct buffer
*starting_buffer
;
8944 /* List of events for which a fake prefix key has been generated. */
8945 Lisp_Object fake_prefixed_keys
= Qnil
;
8947 struct gcpro gcpro1
;
8949 GCPRO1 (fake_prefixed_keys
);
8950 raw_keybuf_count
= 0;
8952 last_nonmenu_event
= Qnil
;
8954 delayed_switch_frame
= Qnil
;
8960 /* Install the string PROMPT as the beginning of the string
8961 of echoing, so that it serves as a prompt for the next
8963 kset_echo_string (current_kboard
, prompt
);
8964 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8967 else if (cursor_in_echo_area
8968 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8969 && NILP (Fzerop (Vecho_keystrokes
)))
8970 /* This doesn't put in a dash if the echo buffer is empty, so
8971 you don't always see a dash hanging out in the minibuffer. */
8975 /* Record the initial state of the echo area and this_command_keys;
8976 we will need to restore them if we replay a key sequence. */
8978 echo_start
= echo_length ();
8979 keys_start
= this_command_key_count
;
8980 this_single_command_key_start
= keys_start
;
8982 /* We jump here when we need to reinitialize fkey and keytran; this
8983 happens if we switch keyboards between rescans. */
8984 replay_entire_sequence
:
8986 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8987 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8988 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8989 indec
.start
= indec
.end
= 0;
8990 fkey
.start
= fkey
.end
= 0;
8991 keytran
.start
= keytran
.end
= 0;
8993 /* We jump here when the key sequence has been thoroughly changed, and
8994 we need to rescan it starting from the beginning. When we jump here,
8995 keybuf[0..mock_input] holds the sequence we should reread. */
8998 starting_buffer
= current_buffer
;
8999 first_unbound
= bufsize
+ 1;
9001 /* Build our list of keymaps.
9002 If we recognize a function key and replace its escape sequence in
9003 keybuf with its symbol, or if the sequence starts with a mouse
9004 click and we need to switch buffers, we jump back here to rebuild
9005 the initial keymaps from the current buffer. */
9006 current_binding
= active_maps (first_event
);
9008 /* Start from the beginning in keybuf. */
9011 /* These are no-ops the first time through, but if we restart, they
9012 revert the echo area and this_command_keys to their original state. */
9013 this_command_key_count
= keys_start
;
9014 if (INTERACTIVE
&& t
< mock_input
)
9015 echo_truncate (echo_start
);
9017 /* If the best binding for the current key sequence is a keymap, or
9018 we may be looking at a function key's escape sequence, keep on
9020 while (!NILP (current_binding
)
9021 /* Keep reading as long as there's a prefix binding. */
9022 ? KEYMAPP (current_binding
)
9023 /* Don't return in the middle of a possible function key sequence,
9024 if the only bindings we found were via case conversion.
9025 Thus, if ESC O a has a function-key-map translation
9026 and ESC o has a binding, don't return after ESC O,
9027 so that we can translate ESC O plus the next character. */
9028 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9031 bool used_mouse_menu
= 0;
9033 /* Where the last real key started. If we need to throw away a
9034 key that has expanded into more than one element of keybuf
9035 (say, a mouse click on the mode line which is being treated
9036 as [mode-line (mouse-...)], then we backtrack to this point
9038 int last_real_key_start
;
9040 /* These variables are analogous to echo_start and keys_start;
9041 while those allow us to restart the entire key sequence,
9042 echo_local_start and keys_local_start allow us to throw away
9044 ptrdiff_t echo_local_start
IF_LINT (= 0);
9045 int keys_local_start
;
9046 Lisp_Object new_binding
;
9048 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9049 eassert (indec
.start
<= indec
.end
);
9050 eassert (fkey
.start
<= fkey
.end
);
9051 eassert (keytran
.start
<= keytran
.end
);
9052 /* key-translation-map is applied *after* function-key-map
9053 which is itself applied *after* input-decode-map. */
9054 eassert (fkey
.end
<= indec
.start
);
9055 eassert (keytran
.end
<= fkey
.start
);
9057 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9058 first_unbound
< keytran
.start
)
9059 { /* The prefix upto first_unbound has no binding and has
9060 no translation left to do either, so we know it's unbound.
9061 If we don't stop now, we risk staying here indefinitely
9062 (if the user keeps entering fkey or keytran prefixes
9063 like C-c ESC ESC ESC ESC ...) */
9065 for (i
= first_unbound
+ 1; i
< t
; i
++)
9066 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9067 mock_input
= t
- first_unbound
- 1;
9068 indec
.end
= indec
.start
-= first_unbound
+ 1;
9069 indec
.map
= indec
.parent
;
9070 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9071 fkey
.map
= fkey
.parent
;
9072 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9073 keytran
.map
= keytran
.parent
;
9074 goto replay_sequence
;
9078 error ("Key sequence too long");
9081 echo_local_start
= echo_length ();
9082 keys_local_start
= this_command_key_count
;
9085 /* These are no-ops, unless we throw away a keystroke below and
9086 jumped back up to replay_key; in that case, these restore the
9087 variables to their original state, allowing us to replay the
9089 if (INTERACTIVE
&& t
< mock_input
)
9090 echo_truncate (echo_local_start
);
9091 this_command_key_count
= keys_local_start
;
9093 /* By default, assume each event is "real". */
9094 last_real_key_start
= t
;
9096 /* Does mock_input indicate that we are re-reading a key sequence? */
9100 add_command_key (key
);
9101 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9102 && NILP (Fzerop (Vecho_keystrokes
))
9103 && current_kboard
->immediate_echo
)
9110 /* If not, we should actually read a character. */
9114 KBOARD
*interrupted_kboard
= current_kboard
;
9115 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9116 /* Calling read_char with COMMANDFLAG = -2 avoids
9117 redisplay in read_char and its subroutines. */
9118 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9119 current_binding
, last_nonmenu_event
,
9120 &used_mouse_menu
, NULL
);
9121 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9122 /* When switching to a new tty (with a new keyboard),
9123 read_char returns the new buffer, rather than -2
9124 (Bug#5095). This is because `terminal-init-xterm'
9125 calls read-char, which eats the wrong_kboard_jmpbuf
9126 return. Any better way to fix this? -- cyd */
9127 || (interrupted_kboard
!= current_kboard
))
9132 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9133 if (k
== interrupted_kboard
)
9138 /* Don't touch interrupted_kboard when it's been
9140 delayed_switch_frame
= Qnil
;
9141 goto replay_entire_sequence
;
9144 if (!NILP (delayed_switch_frame
))
9147 (interrupted_kboard
,
9148 Fcons (delayed_switch_frame
,
9149 KVAR (interrupted_kboard
, kbd_queue
)));
9150 delayed_switch_frame
= Qnil
;
9155 (interrupted_kboard
,
9156 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9158 /* If the side queue is non-empty, ensure it begins with a
9159 switch-frame, so we'll replay it in the right context. */
9160 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9161 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9162 !(EVENT_HAS_PARAMETERS (key
)
9163 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9167 XSETFRAME (frame
, interrupted_frame
);
9169 (interrupted_kboard
,
9170 Fcons (make_lispy_switch_frame (frame
),
9171 KVAR (interrupted_kboard
, kbd_queue
)));
9174 goto replay_entire_sequence
;
9178 /* read_char returns t when it shows a menu and the user rejects it.
9182 unbind_to (count
, Qnil
);
9187 /* read_char returns -1 at the end of a macro.
9188 Emacs 18 handles this by returning immediately with a
9189 zero, so that's what we'll do. */
9190 if (INTEGERP (key
) && XINT (key
) == -1)
9193 /* The Microsoft C compiler can't handle the goto that
9199 /* If the current buffer has been changed from under us, the
9200 keymap may have changed, so replay the sequence. */
9203 timer_resume_idle ();
9206 /* Reset the current buffer from the selected window
9207 in case something changed the former and not the latter.
9208 This is to be more consistent with the behavior
9209 of the command_loop_1. */
9210 if (fix_current_buffer
)
9212 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9214 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9216 Fset_buffer (XWINDOW (selected_window
)->contents
);
9219 goto replay_sequence
;
9222 /* If we have a quit that was typed in another frame, and
9223 quit_throw_to_read_char switched buffers,
9224 replay to get the right keymap. */
9226 && XINT (key
) == quit_char
9227 && current_buffer
!= starting_buffer
)
9230 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9235 goto replay_sequence
;
9240 if (EVENT_HAS_PARAMETERS (key
)
9241 /* Either a `switch-frame' or a `select-window' event. */
9242 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9244 /* If we're at the beginning of a key sequence, and the caller
9245 says it's okay, go ahead and return this event. If we're
9246 in the midst of a key sequence, delay it until the end. */
9247 if (t
> 0 || !can_return_switch_frame
)
9249 delayed_switch_frame
= key
;
9254 if (NILP (first_event
))
9257 /* Even if first_event does not specify a particular
9258 window/position, it's important to recompute the maps here
9259 since a long time might have passed since we entered
9260 read_key_sequence, and a timer (or process-filter or
9261 special-event-map, ...) might have switched the current buffer
9262 or the selected window from under us in the mean time. */
9263 if (fix_current_buffer
9264 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9266 Fset_buffer (XWINDOW (selected_window
)->contents
);
9267 current_binding
= active_maps (first_event
);
9271 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9275 /* Clicks in non-text areas get prefixed by the symbol
9276 in their CHAR-ADDRESS field. For example, a click on
9277 the mode line is prefixed by the symbol `mode-line'.
9279 Furthermore, key sequences beginning with mouse clicks
9280 are read using the keymaps of the buffer clicked on, not
9281 the current buffer. So we may have to switch the buffer
9284 When we turn one event into two events, we must make sure
9285 that neither of the two looks like the original--so that,
9286 if we replay the events, they won't be expanded again.
9287 If not for this, such reexpansion could happen either here
9288 or when user programs play with this-command-keys. */
9289 if (EVENT_HAS_PARAMETERS (key
))
9291 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9292 if (EQ (kind
, Qmouse_click
))
9294 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9295 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9298 || (!NILP (fake_prefixed_keys
)
9299 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9301 /* We're looking a second time at an event for which
9302 we generated a fake prefix key. Set
9303 last_real_key_start appropriately. */
9305 last_real_key_start
= t
- 1;
9308 if (last_real_key_start
== 0)
9310 /* Key sequences beginning with mouse clicks are
9311 read using the keymaps in the buffer clicked on,
9312 not the current buffer. If we're at the
9313 beginning of a key sequence, switch buffers. */
9314 if (WINDOWP (window
)
9315 && BUFFERP (XWINDOW (window
)->contents
)
9316 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9318 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9323 /* Arrange to go back to the original buffer once we're
9324 done reading the key sequence. Note that we can't
9325 use save_excursion_{save,restore} here, because they
9326 save point as well as the current buffer; we don't
9327 want to save point, because redisplay may change it,
9328 to accommodate a Fset_window_start or something. We
9329 don't want to do this at the top of the function,
9330 because we may get input from a subprocess which
9331 wants to change the selected window and stuff (say,
9333 record_unwind_current_buffer ();
9335 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9337 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9338 goto replay_sequence
;
9342 /* Expand mode-line and scroll-bar events into two events:
9343 use posn as a fake prefix key. */
9345 && (NILP (fake_prefixed_keys
)
9346 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9348 if (bufsize
- t
<= 1)
9349 error ("Key sequence too long");
9352 keybuf
[t
+ 1] = key
;
9355 /* Record that a fake prefix key has been generated
9356 for KEY. Don't modify the event; this would
9357 prevent proper action when the event is pushed
9358 back into unread-command-events. */
9359 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9363 else if (CONSP (XCDR (key
))
9364 && CONSP (EVENT_START (key
))
9365 && CONSP (XCDR (EVENT_START (key
))))
9369 posn
= POSN_POSN (EVENT_START (key
));
9370 /* Handle menu-bar events:
9371 insert the dummy prefix event `menu-bar'. */
9372 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9374 if (bufsize
- t
<= 1)
9375 error ("Key sequence too long");
9377 keybuf
[t
+ 1] = key
;
9379 /* Zap the position in key, so we know that we've
9380 expanded it, and don't try to do so again. */
9381 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9384 goto replay_sequence
;
9386 else if (CONSP (posn
))
9388 /* We're looking at the second event of a
9389 sequence which we expanded before. Set
9390 last_real_key_start appropriately. */
9391 if (last_real_key_start
== t
&& t
> 0)
9392 last_real_key_start
= t
- 1;
9397 /* We have finally decided that KEY is something we might want
9399 new_binding
= follow_key (current_binding
, key
);
9401 /* If KEY wasn't bound, we'll try some fallbacks. */
9402 if (!NILP (new_binding
))
9403 /* This is needed for the following scenario:
9404 event 0: a down-event that gets dropped by calling replay_key.
9405 event 1: some normal prefix like C-h.
9406 After event 0, first_unbound is 0, after event 1 indec.start,
9407 fkey.start, and keytran.start are all 1, so when we see that
9408 C-h is bound, we need to update first_unbound. */
9409 first_unbound
= max (t
+ 1, first_unbound
);
9414 /* Remember the position to put an upper bound on indec.start. */
9415 first_unbound
= min (t
, first_unbound
);
9417 head
= EVENT_HEAD (key
);
9418 if (help_char_p (head
) && t
> 0)
9420 read_key_sequence_cmd
= Vprefix_help_command
;
9422 last_nonmenu_event
= key
;
9423 /* The Microsoft C compiler can't handle the goto that
9431 Lisp_Object breakdown
;
9434 breakdown
= parse_modifiers (head
);
9435 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9436 /* Attempt to reduce an unbound mouse event to a simpler
9437 event that is bound:
9438 Drags reduce to clicks.
9439 Double-clicks reduce to clicks.
9440 Triple-clicks reduce to double-clicks, then to clicks.
9441 Down-clicks are eliminated.
9442 Double-downs reduce to downs, then are eliminated.
9443 Triple-downs reduce to double-downs, then to downs,
9444 then are eliminated. */
9445 if (modifiers
& (down_modifier
| drag_modifier
9446 | double_modifier
| triple_modifier
))
9448 while (modifiers
& (down_modifier
| drag_modifier
9449 | double_modifier
| triple_modifier
))
9451 Lisp_Object new_head
, new_click
;
9452 if (modifiers
& triple_modifier
)
9453 modifiers
^= (double_modifier
| triple_modifier
);
9454 else if (modifiers
& double_modifier
)
9455 modifiers
&= ~double_modifier
;
9456 else if (modifiers
& drag_modifier
)
9457 modifiers
&= ~drag_modifier
;
9460 /* Dispose of this `down' event by simply jumping
9461 back to replay_key, to get another event.
9463 Note that if this event came from mock input,
9464 then just jumping back to replay_key will just
9465 hand it to us again. So we have to wipe out any
9468 We could delete keybuf[t] and shift everything
9469 after that to the left by one spot, but we'd also
9470 have to fix up any variable that points into
9471 keybuf, and shifting isn't really necessary
9474 Adding prefixes for non-textual mouse clicks
9475 creates two characters of mock input, and both
9476 must be thrown away. If we're only looking at
9477 the prefix now, we can just jump back to
9478 replay_key. On the other hand, if we've already
9479 processed the prefix, and now the actual click
9480 itself is giving us trouble, then we've lost the
9481 state of the keymaps we want to backtrack to, and
9482 we need to replay the whole sequence to rebuild
9485 Beyond that, only function key expansion could
9486 create more than two keys, but that should never
9487 generate mouse events, so it's okay to zero
9488 mock_input in that case too.
9490 FIXME: The above paragraph seems just plain
9491 wrong, if you consider things like
9492 xterm-mouse-mode. -stef
9494 Isn't this just the most wonderful code ever? */
9496 /* If mock_input > t + 1, the above simplification
9497 will actually end up dropping keys on the floor.
9498 This is probably OK for now, but even
9499 if mock_input <= t + 1, we need to adjust indec,
9501 Typical case [header-line down-mouse-N]:
9502 mock_input = 2, t = 1, fkey.end = 1,
9503 last_real_key_start = 0. */
9504 if (indec
.end
> last_real_key_start
)
9506 indec
.end
= indec
.start
9507 = min (last_real_key_start
, indec
.start
);
9508 indec
.map
= indec
.parent
;
9509 if (fkey
.end
> last_real_key_start
)
9511 fkey
.end
= fkey
.start
9512 = min (last_real_key_start
, fkey
.start
);
9513 fkey
.map
= fkey
.parent
;
9514 if (keytran
.end
> last_real_key_start
)
9516 keytran
.end
= keytran
.start
9517 = min (last_real_key_start
, keytran
.start
);
9518 keytran
.map
= keytran
.parent
;
9522 if (t
== last_real_key_start
)
9529 mock_input
= last_real_key_start
;
9530 goto replay_sequence
;
9535 = apply_modifiers (modifiers
, XCAR (breakdown
));
9536 new_click
= list2 (new_head
, EVENT_START (key
));
9538 /* Look for a binding for this new key. */
9539 new_binding
= follow_key (current_binding
, new_click
);
9541 /* If that click is bound, go for it. */
9542 if (!NILP (new_binding
))
9544 current_binding
= new_binding
;
9548 /* Otherwise, we'll leave key set to the drag event. */
9553 current_binding
= new_binding
;
9556 /* Normally, last_nonmenu_event gets the previous key we read.
9557 But when a mouse popup menu is being used,
9558 we don't update last_nonmenu_event; it continues to hold the mouse
9559 event that preceded the first level of menu. */
9560 if (!used_mouse_menu
)
9561 last_nonmenu_event
= key
;
9563 /* Record what part of this_command_keys is the current key sequence. */
9564 this_single_command_key_start
= this_command_key_count
- t
;
9566 /* Look for this sequence in input-decode-map.
9567 Scan from indec.end until we find a bound suffix. */
9568 while (indec
.end
< t
)
9570 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9574 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9575 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9580 mock_input
= diff
+ max (t
, mock_input
);
9581 goto replay_sequence
;
9585 if (!KEYMAPP (current_binding
)
9586 && !test_undefined (current_binding
)
9587 && indec
.start
>= t
)
9588 /* There is a binding and it's not a prefix.
9589 (and it doesn't have any input-decode-map translation pending).
9590 There is thus no function-key in this sequence.
9591 Moving fkey.start is important in this case to allow keytran.start
9592 to go over the sequence before we return (since we keep the
9593 invariant that keytran.end <= fkey.start). */
9596 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9599 /* If the sequence is unbound, see if we can hang a function key
9600 off the end of it. */
9601 /* Continue scan from fkey.end until we find a bound suffix. */
9602 while (fkey
.end
< indec
.start
)
9604 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9608 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9609 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9610 max (t
, mock_input
),
9611 /* If there's a binding (i.e.
9612 first_binding >= nmaps) we don't want
9613 to apply this function-key-mapping. */
9615 && (test_undefined (current_binding
)),
9620 mock_input
= diff
+ max (t
, mock_input
);
9621 /* Adjust the input-decode-map counters. */
9623 indec
.start
+= diff
;
9625 goto replay_sequence
;
9629 /* Look for this sequence in key-translation-map.
9630 Scan from keytran.end until we find a bound suffix. */
9631 while (keytran
.end
< fkey
.start
)
9633 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9637 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9638 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9643 mock_input
= diff
+ max (t
, mock_input
);
9644 /* Adjust the function-key-map and input-decode-map counters. */
9646 indec
.start
+= diff
;
9650 goto replay_sequence
;
9654 /* If KEY is not defined in any of the keymaps,
9655 and cannot be part of a function key or translation,
9656 and is an upper case letter
9657 use the corresponding lower-case letter instead. */
9658 if (NILP (current_binding
)
9659 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9661 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9662 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9663 || (XINT (key
) & shift_modifier
)))
9665 Lisp_Object new_key
;
9667 original_uppercase
= key
;
9668 original_uppercase_position
= t
- 1;
9670 if (XINT (key
) & shift_modifier
)
9671 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9673 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9674 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9676 /* We have to do this unconditionally, regardless of whether
9677 the lower-case char is defined in the keymaps, because they
9678 might get translated through function-key-map. */
9679 keybuf
[t
- 1] = new_key
;
9680 mock_input
= max (t
, mock_input
);
9681 shift_translated
= 1;
9683 goto replay_sequence
;
9685 /* If KEY is not defined in any of the keymaps,
9686 and cannot be part of a function key or translation,
9687 and is a shifted function key,
9688 use the corresponding unshifted function key instead. */
9689 if (NILP (current_binding
)
9690 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9692 Lisp_Object breakdown
= parse_modifiers (key
);
9694 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9696 if (modifiers
& shift_modifier
9697 /* Treat uppercase keys as shifted. */
9699 && (KEY_TO_CHAR (key
)
9700 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9701 && uppercasep (KEY_TO_CHAR (key
))))
9704 = (modifiers
& shift_modifier
9705 ? apply_modifiers (modifiers
& ~shift_modifier
,
9707 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9709 original_uppercase
= key
;
9710 original_uppercase_position
= t
- 1;
9712 /* We have to do this unconditionally, regardless of whether
9713 the lower-case char is defined in the keymaps, because they
9714 might get translated through function-key-map. */
9715 keybuf
[t
- 1] = new_key
;
9716 mock_input
= max (t
, mock_input
);
9717 /* Reset fkey (and consequently keytran) to apply
9718 function-key-map on the result, so that S-backspace is
9719 correctly mapped to DEL (via backspace). OTOH,
9720 input-decode-map doesn't need to go through it again. */
9721 fkey
.start
= fkey
.end
= 0;
9722 keytran
.start
= keytran
.end
= 0;
9723 shift_translated
= 1;
9725 goto replay_sequence
;
9730 read_key_sequence_cmd
= current_binding
;
9731 read_key_sequence_remapped
9732 /* Remap command through active keymaps.
9733 Do the remapping here, before the unbind_to so it uses the keymaps
9734 of the appropriate buffer. */
9735 = SYMBOLP (read_key_sequence_cmd
)
9736 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9739 unread_switch_frame
= delayed_switch_frame
;
9740 unbind_to (count
, Qnil
);
9742 /* Don't downcase the last character if the caller says don't.
9743 Don't downcase it if the result is undefined, either. */
9744 if ((dont_downcase_last
|| NILP (current_binding
))
9746 && t
- 1 == original_uppercase_position
)
9748 keybuf
[t
- 1] = original_uppercase
;
9749 shift_translated
= 0;
9752 if (shift_translated
)
9753 Vthis_command_keys_shift_translated
= Qt
;
9755 /* Occasionally we fabricate events, perhaps by expanding something
9756 according to function-key-map, or by adding a prefix symbol to a
9757 mouse click in the scroll bar or modeline. In this cases, return
9758 the entire generated key sequence, even if we hit an unbound
9759 prefix or a definition before the end. This means that you will
9760 be able to push back the event properly, and also means that
9761 read-key-sequence will always return a logical unit.
9764 for (; t
< mock_input
; t
++)
9766 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9767 && NILP (Fzerop (Vecho_keystrokes
)))
9768 echo_char (keybuf
[t
]);
9769 add_command_key (keybuf
[t
]);
9777 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9778 Lisp_Object dont_downcase_last
,
9779 Lisp_Object can_return_switch_frame
,
9780 Lisp_Object cmd_loop
, bool allow_string
)
9782 Lisp_Object keybuf
[30];
9784 struct gcpro gcpro1
;
9785 ptrdiff_t count
= SPECPDL_INDEX ();
9788 CHECK_STRING (prompt
);
9791 specbind (Qinput_method_exit_on_first_char
,
9792 (NILP (cmd_loop
) ? Qt
: Qnil
));
9793 specbind (Qinput_method_use_echo_area
,
9794 (NILP (cmd_loop
) ? Qt
: Qnil
));
9796 memset (keybuf
, 0, sizeof keybuf
);
9798 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9800 if (NILP (continue_echo
))
9802 this_command_key_count
= 0;
9803 this_command_key_count_reset
= 0;
9804 this_single_command_key_start
= 0;
9807 #ifdef HAVE_WINDOW_SYSTEM
9808 if (display_hourglass_p
)
9809 cancel_hourglass ();
9812 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9813 prompt
, ! NILP (dont_downcase_last
),
9814 ! NILP (can_return_switch_frame
), 0, 0);
9816 #if 0 /* The following is fine for code reading a key sequence and
9817 then proceeding with a lengthy computation, but it's not good
9818 for code reading keys in a loop, like an input method. */
9819 #ifdef HAVE_WINDOW_SYSTEM
9820 if (display_hourglass_p
)
9831 return unbind_to (count
,
9832 ((allow_string
? make_event_array
: Fvector
)
9836 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9837 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9838 The sequence is sufficient to specify a non-prefix command in the
9839 current local and global maps.
9841 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9842 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9843 as a continuation of the previous key.
9845 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9846 convert the last event to lower case. (Normally any upper case event
9847 is converted to lower case if the original event is undefined and the lower
9848 case equivalent is defined.) A non-nil value is appropriate for reading
9849 a key sequence to be defined.
9851 A C-g typed while in this function is treated like any other character,
9852 and `quit-flag' is not set.
9854 If the key sequence starts with a mouse click, then the sequence is read
9855 using the keymaps of the buffer of the window clicked in, not the buffer
9856 of the selected window as normal.
9858 `read-key-sequence' drops unbound button-down events, since you normally
9859 only care about the click or drag events which follow them. If a drag
9860 or multi-click event is unbound, but the corresponding click event would
9861 be bound, `read-key-sequence' turns the event into a click event at the
9862 drag's starting position. This means that you don't have to distinguish
9863 between click and drag, double, or triple events unless you want to.
9865 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9866 lines separating windows, and scroll bars with imaginary keys
9867 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9869 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9870 function will process a switch-frame event if the user switches frames
9871 before typing anything. If the user switches frames in the middle of a
9872 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9873 is nil, then the event will be put off until after the current key sequence.
9875 `read-key-sequence' checks `function-key-map' for function key
9876 sequences, where they wouldn't conflict with ordinary bindings. See
9877 `function-key-map' for more details.
9879 The optional fifth argument CMD-LOOP, if non-nil, means
9880 that this key sequence is being read by something that will
9881 read commands one after another. It should be nil if the caller
9882 will read just one key sequence. */)
9883 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9885 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9886 can_return_switch_frame
, cmd_loop
, true);
9889 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9890 Sread_key_sequence_vector
, 1, 5, 0,
9891 doc
: /* Like `read-key-sequence' but always return a vector. */)
9892 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9894 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9895 can_return_switch_frame
, cmd_loop
, false);
9898 /* Return true if input events are pending. */
9901 detect_input_pending (void)
9903 return input_pending
|| get_input_pending (0);
9906 /* Return true if input events other than mouse movements are
9910 detect_input_pending_ignore_squeezables (void)
9912 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9915 /* Return true if input events are pending, and run any pending timers. */
9918 detect_input_pending_run_timers (bool do_display
)
9920 unsigned old_timers_run
= timers_run
;
9923 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9925 if (old_timers_run
!= timers_run
&& do_display
)
9926 redisplay_preserve_echo_area (8);
9928 return input_pending
;
9931 /* This is called in some cases before a possible quit.
9932 It cases the next call to detect_input_pending to recompute input_pending.
9933 So calling this function unnecessarily can't do any harm. */
9936 clear_input_pending (void)
9941 /* Return true if there are pending requeued events.
9942 This isn't used yet. The hope is to make wait_reading_process_output
9943 call it, and return if it runs Lisp code that unreads something.
9944 The problem is, kbd_buffer_get_event needs to be fixed to know what
9945 to do in that case. It isn't trivial. */
9948 requeued_events_pending_p (void)
9950 return (!NILP (Vunread_command_events
));
9953 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9954 doc
: /* Return t if command input is currently available with no wait.
9955 Actually, the value is nil only if we can be sure that no input is available;
9956 if there is a doubt, the value is t.
9958 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9959 (Lisp_Object check_timers
)
9961 if (!NILP (Vunread_command_events
)
9962 || !NILP (Vunread_post_input_method_events
)
9963 || !NILP (Vunread_input_method_events
))
9966 /* Process non-user-visible events (Bug#10195). */
9967 process_special_events ();
9969 return (get_input_pending ((NILP (check_timers
)
9970 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9971 | READABLE_EVENTS_FILTER_EVENTS
)
9975 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9976 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9979 Lisp_Object
*keys
= XVECTOR (recent_keys
)->u
.contents
;
9982 if (total_keys
< NUM_RECENT_KEYS
)
9983 return Fvector (total_keys
, keys
);
9986 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9987 vcopy (val
, 0, keys
+ recent_keys_index
,
9988 NUM_RECENT_KEYS
- recent_keys_index
);
9989 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9990 keys
, recent_keys_index
);
9995 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9996 doc
: /* Return the key sequence that invoked this command.
9997 However, if the command has called `read-key-sequence', it returns
9998 the last key sequence that has been read.
9999 The value is a string or a vector.
10001 See also `this-command-keys-vector'. */)
10004 return make_event_array (this_command_key_count
,
10005 XVECTOR (this_command_keys
)->u
.contents
);
10008 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10009 doc
: /* Return the key sequence that invoked this command, as a vector.
10010 However, if the command has called `read-key-sequence', it returns
10011 the last key sequence that has been read.
10013 See also `this-command-keys'. */)
10016 return Fvector (this_command_key_count
,
10017 XVECTOR (this_command_keys
)->u
.contents
);
10020 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10021 Sthis_single_command_keys
, 0, 0, 0,
10022 doc
: /* Return the key sequence that invoked this command.
10023 More generally, it returns the last key sequence read, either by
10024 the command loop or by `read-key-sequence'.
10025 Unlike `this-command-keys', this function's value
10026 does not include prefix arguments.
10027 The value is always a vector. */)
10030 return Fvector (this_command_key_count
10031 - this_single_command_key_start
,
10032 (XVECTOR (this_command_keys
)->u
.contents
10033 + this_single_command_key_start
));
10036 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10037 Sthis_single_command_raw_keys
, 0, 0, 0,
10038 doc
: /* Return the raw events that were read for this command.
10039 More generally, it returns the last key sequence read, either by
10040 the command loop or by `read-key-sequence'.
10041 Unlike `this-single-command-keys', this function's value
10042 shows the events before all translations (except for input methods).
10043 The value is always a vector. */)
10046 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->u
.contents
);
10049 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10050 Sreset_this_command_lengths
, 0, 0, 0,
10051 doc
: /* Make the unread events replace the last command and echo.
10052 Used in `universal-argument-other-key'.
10054 `universal-argument-other-key' rereads the event just typed.
10055 It then gets translated through `function-key-map'.
10056 The translated event has to replace the real events,
10057 both in the value of (this-command-keys) and in echoing.
10058 To achieve this, `universal-argument-other-key' calls
10059 `reset-this-command-lengths', which discards the record of reading
10060 these events the first time. */)
10063 this_command_key_count
= before_command_key_count
;
10064 if (this_command_key_count
< this_single_command_key_start
)
10065 this_single_command_key_start
= this_command_key_count
;
10067 echo_truncate (before_command_echo_length
);
10069 /* Cause whatever we put into unread-command-events
10070 to echo as if it were being freshly read from the keyboard. */
10071 this_command_key_count_reset
= 1;
10076 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10077 Sclear_this_command_keys
, 0, 1, 0,
10078 doc
: /* Clear out the vector that `this-command-keys' returns.
10079 Also clear the record of the last 100 events, unless optional arg
10080 KEEP-RECORD is non-nil. */)
10081 (Lisp_Object keep_record
)
10085 this_command_key_count
= 0;
10086 this_command_key_count_reset
= 0;
10088 if (NILP (keep_record
))
10090 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10091 ASET (recent_keys
, i
, Qnil
);
10093 recent_keys_index
= 0;
10098 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10099 doc
: /* Return the current depth in recursive edits. */)
10103 /* Wrap around reliably on integer overflow. */
10104 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10105 XSETINT (temp
, sum
);
10109 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10110 "FOpen dribble file: ",
10111 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10112 If FILE is nil, close any open dribble file.
10113 The file will be closed when Emacs exits. */)
10125 file
= Fexpand_file_name (file
, Qnil
);
10126 dribble
= emacs_fopen (SSDATA (file
), "w");
10128 report_file_error ("Opening dribble", file
);
10133 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10134 doc
: /* Discard the contents of the terminal input buffer.
10135 Also end any kbd macro being defined. */)
10138 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10140 /* Discard the last command from the macro. */
10141 Fcancel_kbd_macro_events ();
10145 Vunread_command_events
= Qnil
;
10147 discard_tty_input ();
10149 kbd_fetch_ptr
= kbd_store_ptr
;
10155 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10156 doc
: /* Stop Emacs and return to superior process. You can resume later.
10157 If `cannot-suspend' is non-nil, or if the system doesn't support job
10158 control, run a subshell instead.
10160 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10161 to be read as terminal input by Emacs's parent, after suspension.
10163 Before suspending, run the normal hook `suspend-hook'.
10164 After resumption run the normal hook `suspend-resume-hook'.
10166 Some operating systems cannot stop the Emacs process and resume it later.
10167 On such systems, Emacs starts a subshell instead of suspending. */)
10168 (Lisp_Object stuffstring
)
10170 ptrdiff_t count
= SPECPDL_INDEX ();
10171 int old_height
, old_width
;
10173 struct gcpro gcpro1
;
10176 if (tty_list
&& tty_list
->next
)
10177 error ("There are other tty frames open; close them before suspending Emacs");
10179 if (!NILP (stuffstring
))
10180 CHECK_STRING (stuffstring
);
10182 /* Run the functions in suspend-hook. */
10183 hook
= intern ("suspend-hook");
10184 Frun_hooks (1, &hook
);
10186 GCPRO1 (stuffstring
);
10187 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10188 reset_all_sys_modes ();
10189 /* sys_suspend can get an error if it tries to fork a subshell
10190 and the system resources aren't available for that. */
10191 record_unwind_protect_void (init_all_sys_modes
);
10192 stuff_buffered_input (stuffstring
);
10193 if (cannot_suspend
)
10197 unbind_to (count
, Qnil
);
10199 /* Check if terminal/window size has changed.
10200 Note that this is not useful when we are running directly
10201 with a window system; but suspend should be disabled in that case. */
10202 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10203 if (width
!= old_width
|| height
!= old_height
)
10204 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10206 /* Run suspend-resume-hook. */
10207 hook
= intern ("suspend-resume-hook");
10208 Frun_hooks (1, &hook
);
10214 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10215 Then in any case stuff anything Emacs has read ahead and not used. */
10218 stuff_buffered_input (Lisp_Object stuffstring
)
10220 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10221 register unsigned char *p
;
10223 if (STRINGP (stuffstring
))
10225 register ptrdiff_t count
;
10227 p
= SDATA (stuffstring
);
10228 count
= SBYTES (stuffstring
);
10229 while (count
-- > 0)
10234 /* Anything we have read ahead, put back for the shell to read. */
10235 /* ?? What should this do when we have multiple keyboards??
10236 Should we ignore anything that was typed in at the "wrong" kboard?
10238 rms: we should stuff everything back into the kboard
10240 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10243 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10244 kbd_fetch_ptr
= kbd_buffer
;
10245 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10246 stuff_char (kbd_fetch_ptr
->code
);
10248 clear_event (kbd_fetch_ptr
);
10252 #endif /* SIGTSTP */
10256 set_waiting_for_input (struct timespec
*time_to_clear
)
10258 input_available_clear_time
= time_to_clear
;
10260 /* Tell handle_interrupt to throw back to read_char, */
10261 waiting_for_input
= 1;
10263 /* If handle_interrupt was called before and buffered a C-g,
10264 make it run again now, to avoid timing error. */
10265 if (!NILP (Vquit_flag
))
10266 quit_throw_to_read_char (0);
10270 clear_waiting_for_input (void)
10272 /* Tell handle_interrupt not to throw back to read_char, */
10273 waiting_for_input
= 0;
10274 input_available_clear_time
= 0;
10277 /* The SIGINT handler.
10279 If we have a frame on the controlling tty, we assume that the
10280 SIGINT was generated by C-g, so we call handle_interrupt.
10281 Otherwise, tell QUIT to kill Emacs. */
10284 handle_interrupt_signal (int sig
)
10286 /* See if we have an active terminal on our controlling tty. */
10287 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10290 /* If there are no frames there, let's pretend that we are a
10291 well-behaving UN*X program and quit. We must not call Lisp
10292 in a signal handler, so tell QUIT to exit when it is
10294 Vquit_flag
= Qkill_emacs
;
10298 /* Otherwise, the SIGINT was probably generated by C-g. */
10300 /* Set internal_last_event_frame to the top frame of the
10301 controlling tty, if we have a frame there. We disable the
10302 interrupt key on secondary ttys, so the SIGINT must have come
10303 from the controlling tty. */
10304 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10306 handle_interrupt (1);
10311 deliver_interrupt_signal (int sig
)
10313 deliver_process_signal (sig
, handle_interrupt_signal
);
10317 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10318 of the number of times C-g has been requested. If C-g is pressed
10319 enough times, then quit anyway. See bug#6585. */
10320 static int volatile force_quit_count
;
10322 /* This routine is called at interrupt level in response to C-g.
10324 It is called from the SIGINT handler or kbd_buffer_store_event.
10326 If `waiting_for_input' is non zero, then unless `echoing' is
10327 nonzero, immediately throw back to read_char.
10329 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10330 eval to throw, when it gets a chance. If quit-flag is already
10331 non-nil, it stops the job right away. */
10334 handle_interrupt (bool in_signal_handler
)
10340 /* XXX This code needs to be revised for multi-tty support. */
10341 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10343 if (! in_signal_handler
)
10345 /* If SIGINT isn't blocked, don't let us be interrupted by
10346 a SIGINT. It might be harmful due to non-reentrancy
10347 in I/O functions. */
10349 sigemptyset (&blocked
);
10350 sigaddset (&blocked
, SIGINT
);
10351 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10355 reset_all_sys_modes ();
10359 * On systems which can suspend the current process and return to the original
10360 * shell, this command causes the user to end up back at the shell.
10361 * The "Auto-save" and "Abort" questions are not asked until
10362 * the user elects to return to emacs, at which point he can save the current
10363 * job and either dump core or continue.
10367 /* Perhaps should really fork an inferior shell?
10368 But that would not provide any way to get back
10369 to the original shell, ever. */
10370 printf ("No support for stopping a process on this operating system;\n");
10371 printf ("you can continue or abort.\n");
10372 #endif /* not SIGTSTP */
10374 /* We must remain inside the screen area when the internal terminal
10375 is used. Note that [Enter] is not echoed by dos. */
10376 cursor_to (SELECTED_FRAME (), 0, 0);
10378 /* It doesn't work to autosave while GC is in progress;
10379 the code used for auto-saving doesn't cope with the mark bit. */
10380 if (!gc_in_progress
)
10382 printf ("Auto-save? (y or n) ");
10384 if (((c
= getchar ()) & ~040) == 'Y')
10386 Fdo_auto_save (Qt
, Qnil
);
10388 printf ("\r\nAuto-save done");
10389 #else /* not MSDOS */
10390 printf ("Auto-save done\n");
10391 #endif /* not MSDOS */
10393 while (c
!= '\n') c
= getchar ();
10397 /* During GC, it must be safe to reenable quitting again. */
10398 Vinhibit_quit
= Qnil
;
10401 #endif /* not MSDOS */
10402 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10403 printf ("but will instead do a real quit after garbage collection ends\r\n");
10408 printf ("\r\nAbort? (y or n) ");
10409 #else /* not MSDOS */
10410 printf ("Abort (and dump core)? (y or n) ");
10411 #endif /* not MSDOS */
10413 if (((c
= getchar ()) & ~040) == 'Y')
10415 while (c
!= '\n') c
= getchar ();
10417 printf ("\r\nContinuing...\r\n");
10418 #else /* not MSDOS */
10419 printf ("Continuing...\n");
10420 #endif /* not MSDOS */
10422 init_all_sys_modes ();
10426 /* If executing a function that wants to be interrupted out of
10427 and the user has not deferred quitting by binding `inhibit-quit'
10428 then quit right away. */
10429 if (immediate_quit
&& NILP (Vinhibit_quit
))
10431 struct gl_state_s saved
;
10432 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10434 immediate_quit
= 0;
10435 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10437 GCPRO4 (saved
.object
, saved
.global_code
,
10438 saved
.current_syntax_table
, saved
.old_prop
);
10439 Fsignal (Qquit
, Qnil
);
10444 { /* Else request quit when it's safe. */
10445 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10446 force_quit_count
= count
;
10449 immediate_quit
= 1;
10450 Vinhibit_quit
= Qnil
;
10456 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10458 /* TODO: The longjmp in this call throws the NS event loop integration off,
10459 and it seems to do fine without this. Probably some attention
10460 needs to be paid to the setting of waiting_for_input in
10461 wait_reading_process_output() under HAVE_NS because of the call
10462 to ns_select there (needed because otherwise events aren't picked up
10463 outside of polling since we don't get SIGIO like X and we don't have a
10464 separate event loop thread like W32. */
10466 if (waiting_for_input
&& !echoing
)
10467 quit_throw_to_read_char (in_signal_handler
);
10471 /* Handle a C-g by making read_char return C-g. */
10474 quit_throw_to_read_char (bool from_signal
)
10476 /* When not called from a signal handler it is safe to call
10478 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10479 Fkill_emacs (Qnil
);
10481 /* Prevent another signal from doing this before we finish. */
10482 clear_waiting_for_input ();
10485 Vunread_command_events
= Qnil
;
10487 if (FRAMEP (internal_last_event_frame
)
10488 && !EQ (internal_last_event_frame
, selected_frame
))
10489 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10492 sys_longjmp (getcjmp
, 1);
10495 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10496 Sset_input_interrupt_mode
, 1, 1, 0,
10497 doc
: /* Set interrupt mode of reading keyboard input.
10498 If INTERRUPT is non-nil, Emacs will use input interrupts;
10499 otherwise Emacs uses CBREAK mode.
10501 See also `current-input-mode'. */)
10502 (Lisp_Object interrupt
)
10504 bool new_interrupt_input
;
10505 #ifdef USABLE_SIGIO
10506 #ifdef HAVE_X_WINDOWS
10507 if (x_display_list
!= NULL
)
10509 /* When using X, don't give the user a real choice,
10510 because we haven't implemented the mechanisms to support it. */
10511 new_interrupt_input
= 1;
10514 #endif /* HAVE_X_WINDOWS */
10515 new_interrupt_input
= !NILP (interrupt
);
10516 #else /* not USABLE_SIGIO */
10517 new_interrupt_input
= 0;
10518 #endif /* not USABLE_SIGIO */
10520 if (new_interrupt_input
!= interrupt_input
)
10522 #ifdef POLL_FOR_INPUT
10526 /* this causes startup screen to be restored and messes with the mouse */
10527 reset_all_sys_modes ();
10528 interrupt_input
= new_interrupt_input
;
10529 init_all_sys_modes ();
10531 interrupt_input
= new_interrupt_input
;
10534 #ifdef POLL_FOR_INPUT
10535 poll_suppress_count
= 1;
10542 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10543 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10544 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10545 C-q in key sequences.
10547 This setting only has an effect on tty terminals and only when
10548 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10550 See also `current-input-mode'. */)
10551 (Lisp_Object flow
, Lisp_Object terminal
)
10553 struct terminal
*t
= get_terminal (terminal
, 1);
10554 struct tty_display_info
*tty
;
10555 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10557 tty
= t
->display_info
.tty
;
10559 if (tty
->flow_control
!= !NILP (flow
))
10562 /* This causes startup screen to be restored and messes with the mouse. */
10563 reset_sys_modes (tty
);
10566 tty
->flow_control
= !NILP (flow
);
10569 init_sys_modes (tty
);
10575 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10576 doc
: /* Enable or disable 8-bit input on TERMINAL.
10577 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10578 bit as the Meta modifier.
10580 If META is nil, Emacs will ignore the top bit, on the assumption it is
10583 Otherwise, Emacs will accept and pass through 8-bit input without
10584 specially interpreting the top bit.
10586 This setting only has an effect on tty terminal devices.
10588 Optional parameter TERMINAL specifies the tty terminal device to use.
10589 It may be a terminal object, a frame, or nil for the terminal used by
10590 the currently selected frame.
10592 See also `current-input-mode'. */)
10593 (Lisp_Object meta
, Lisp_Object terminal
)
10595 struct terminal
*t
= get_terminal (terminal
, 1);
10596 struct tty_display_info
*tty
;
10599 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10601 tty
= t
->display_info
.tty
;
10605 else if (EQ (meta
, Qt
))
10610 if (tty
->meta_key
!= new_meta
)
10613 /* this causes startup screen to be restored and messes with the mouse */
10614 reset_sys_modes (tty
);
10617 tty
->meta_key
= new_meta
;
10620 init_sys_modes (tty
);
10626 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10627 doc
: /* Specify character used for quitting.
10628 QUIT must be an ASCII character.
10630 This function only has an effect on the controlling tty of the Emacs
10633 See also `current-input-mode'. */)
10636 struct terminal
*t
= get_named_tty ("/dev/tty");
10637 struct tty_display_info
*tty
;
10638 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10640 tty
= t
->display_info
.tty
;
10642 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10643 error ("QUIT must be an ASCII character");
10646 /* this causes startup screen to be restored and messes with the mouse */
10647 reset_sys_modes (tty
);
10650 /* Don't let this value be out of range. */
10651 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10654 init_sys_modes (tty
);
10660 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10661 doc
: /* Set mode of reading keyboard input.
10662 First arg INTERRUPT non-nil means use input interrupts;
10663 nil means use CBREAK mode.
10664 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10665 (no effect except in CBREAK mode).
10666 Third arg META t means accept 8-bit input (for a Meta key).
10667 META nil means ignore the top bit, on the assumption it is parity.
10668 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10669 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10670 See also `current-input-mode'. */)
10671 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10673 Fset_input_interrupt_mode (interrupt
);
10674 Fset_output_flow_control (flow
, Qnil
);
10675 Fset_input_meta_mode (meta
, Qnil
);
10677 Fset_quit_char (quit
);
10681 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10682 doc
: /* Return information about the way Emacs currently reads keyboard input.
10683 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10684 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10685 nil, Emacs is using CBREAK mode.
10686 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10687 terminal; this does not apply if Emacs uses interrupt-driven input.
10688 META is t if accepting 8-bit input with 8th bit as Meta flag.
10689 META nil means ignoring the top bit, on the assumption it is parity.
10690 META is neither t nor nil if accepting 8-bit input and using
10691 all 8 bits as the character code.
10692 QUIT is the character Emacs currently uses to quit.
10693 The elements of this list correspond to the arguments of
10694 `set-input-mode'. */)
10697 Lisp_Object val
[4];
10698 struct frame
*sf
= XFRAME (selected_frame
);
10700 val
[0] = interrupt_input
? Qt
: Qnil
;
10701 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10703 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10704 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10706 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10713 XSETFASTINT (val
[3], quit_char
);
10715 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10718 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10719 doc
: /* Return position information for pixel coordinates X and Y.
10720 By default, X and Y are relative to text area of the selected window.
10721 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10722 If optional fourth arg WHOLE is non-nil, X is relative to the left
10723 edge of the window.
10725 The return value is similar to a mouse click 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 x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10734 if (NILP (frame_or_window
))
10735 frame_or_window
= selected_window
;
10737 if (WINDOWP (frame_or_window
))
10739 struct window
*w
= decode_live_window (frame_or_window
);
10741 XSETINT (x
, (XINT (x
)
10742 + WINDOW_LEFT_EDGE_X (w
)
10744 ? window_box_left_offset (w
, TEXT_AREA
)
10746 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10747 frame_or_window
= w
->frame
;
10750 CHECK_LIVE_FRAME (frame_or_window
);
10752 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10755 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10756 doc
: /* Return position information for buffer POS in WINDOW.
10757 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10759 Return nil if position is not visible in window. Otherwise,
10760 the return value is similar to that returned by `event-start' for
10761 a mouse click at the upper left corner of the glyph corresponding
10762 to the given buffer position:
10763 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10764 IMAGE (DX . DY) (WIDTH . HEIGHT))
10765 The `posn-' functions access elements of such lists. */)
10766 (Lisp_Object pos
, Lisp_Object window
)
10771 window
= selected_window
;
10773 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10776 Lisp_Object x
= XCAR (tem
);
10777 Lisp_Object y
= XCAR (XCDR (tem
));
10779 /* Point invisible due to hscrolling? */
10782 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10788 /* Set up a new kboard object with reasonable initial values.
10789 TYPE is a window system for which this keyboard is used. */
10792 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10794 kset_overriding_terminal_local_map (kb
, Qnil
);
10795 kset_last_command (kb
, Qnil
);
10796 kset_real_last_command (kb
, Qnil
);
10797 kset_keyboard_translate_table (kb
, Qnil
);
10798 kset_last_repeatable_command (kb
, Qnil
);
10799 kset_prefix_arg (kb
, Qnil
);
10800 kset_last_prefix_arg (kb
, Qnil
);
10801 kset_kbd_queue (kb
, Qnil
);
10802 kb
->kbd_queue_has_data
= 0;
10803 kb
->immediate_echo
= 0;
10804 kset_echo_string (kb
, Qnil
);
10805 kb
->echo_after_prompt
= -1;
10806 kb
->kbd_macro_buffer
= 0;
10807 kb
->kbd_macro_bufsize
= 0;
10808 kset_defining_kbd_macro (kb
, Qnil
);
10809 kset_last_kbd_macro (kb
, Qnil
);
10810 kb
->reference_count
= 0;
10811 kset_system_key_alist (kb
, Qnil
);
10812 kset_system_key_syms (kb
, Qnil
);
10813 kset_window_system (kb
, type
);
10814 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10815 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10816 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10817 kset_default_minibuffer_frame (kb
, Qnil
);
10820 /* Allocate and basically initialize keyboard
10821 object to use with window system TYPE. */
10824 allocate_kboard (Lisp_Object type
)
10826 KBOARD
*kb
= xmalloc (sizeof *kb
);
10828 init_kboard (kb
, type
);
10829 kb
->next_kboard
= all_kboards
;
10835 * Destroy the contents of a kboard object, but not the object itself.
10836 * We use this just before deleting it, or if we're going to initialize
10837 * it a second time.
10840 wipe_kboard (KBOARD
*kb
)
10842 xfree (kb
->kbd_macro_buffer
);
10845 /* Free KB and memory referenced from it. */
10848 delete_kboard (KBOARD
*kb
)
10852 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10855 *kbp
= kb
->next_kboard
;
10857 /* Prevent a dangling reference to KB. */
10858 if (kb
== current_kboard
10859 && FRAMEP (selected_frame
)
10860 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10862 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10864 if (current_kboard
== kb
)
10873 init_keyboard (void)
10875 /* This is correct before outermost invocation of the editor loop. */
10876 command_loop_level
= -1;
10877 immediate_quit
= 0;
10878 quit_char
= Ctl ('g');
10879 Vunread_command_events
= Qnil
;
10880 timer_idleness_start_time
= invalid_timespec ();
10882 recent_keys_index
= 0;
10883 kbd_fetch_ptr
= kbd_buffer
;
10884 kbd_store_ptr
= kbd_buffer
;
10885 do_mouse_tracking
= Qnil
;
10887 interrupt_input_blocked
= 0;
10888 pending_signals
= 0;
10890 /* This means that command_loop_1 won't try to select anything the first
10892 internal_last_event_frame
= Qnil
;
10893 Vlast_event_frame
= internal_last_event_frame
;
10895 current_kboard
= initial_kboard
;
10896 /* Re-initialize the keyboard again. */
10897 wipe_kboard (current_kboard
);
10898 /* A value of nil for Vwindow_system normally means a tty, but we also use
10899 it for the initial terminal since there is no window system there. */
10900 init_kboard (current_kboard
, Qnil
);
10902 if (!noninteractive
)
10904 /* Before multi-tty support, these handlers used to be installed
10905 only if the current session was a tty session. Now an Emacs
10906 session may have multiple display types, so we always handle
10907 SIGINT. There is special code in handle_interrupt_signal to exit
10908 Emacs on SIGINT when there are no termcap frames on the
10909 controlling terminal. */
10910 struct sigaction action
;
10911 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10912 sigaction (SIGINT
, &action
, 0);
10914 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10915 SIGQUIT and we can't tell which one it will give us. */
10916 sigaction (SIGQUIT
, &action
, 0);
10917 #endif /* not DOS_NT */
10919 #ifdef USABLE_SIGIO
10920 if (!noninteractive
)
10922 struct sigaction action
;
10923 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10924 sigaction (SIGIO
, &action
, 0);
10928 /* Use interrupt input by default, if it works and noninterrupt input
10929 has deficiencies. */
10931 #ifdef INTERRUPT_INPUT
10932 interrupt_input
= 1;
10934 interrupt_input
= 0;
10937 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10940 if (keyboard_init_hook
)
10941 (*keyboard_init_hook
) ();
10943 #ifdef POLL_FOR_INPUT
10945 poll_suppress_count
= 1;
10950 /* This type's only use is in syms_of_keyboard, to initialize the
10951 event header symbols and put properties on them. */
10952 struct event_head
{
10958 static const struct event_head head_table
[] = {
10959 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10960 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10961 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10962 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10963 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10964 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10965 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10966 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10967 /* `select-window' should be handled just like `switch-frame'
10968 in read_key_sequence. */
10969 {&Qselect_window
, "select-window", &Qswitch_frame
}
10973 syms_of_keyboard (void)
10975 pending_funcalls
= Qnil
;
10976 staticpro (&pending_funcalls
);
10978 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10979 staticpro (&Vlispy_mouse_stem
);
10982 DEFSYM (QCimage
, ":image");
10983 DEFSYM (Qhelp_echo
, "help-echo");
10984 DEFSYM (QCrtl
, ":rtl");
10986 staticpro (&item_properties
);
10987 item_properties
= Qnil
;
10989 staticpro (&tool_bar_item_properties
);
10990 tool_bar_item_properties
= Qnil
;
10991 staticpro (&tool_bar_items_vector
);
10992 tool_bar_items_vector
= Qnil
;
10994 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10995 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10996 DEFSYM (Qself_insert_command
, "self-insert-command");
10997 DEFSYM (Qforward_char
, "forward-char");
10998 DEFSYM (Qbackward_char
, "backward-char");
10999 DEFSYM (Qdisabled
, "disabled");
11000 DEFSYM (Qundefined
, "undefined");
11001 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11002 DEFSYM (Qpost_command_hook
, "post-command-hook");
11003 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11004 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11005 DEFSYM (Qfunction_key
, "function-key");
11006 DEFSYM (Qmouse_click
, "mouse-click");
11007 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11008 DEFSYM (Qsave_session
, "save-session");
11009 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11010 DEFSYM (Qmenu_enable
, "menu-enable");
11013 DEFSYM (Qlanguage_change
, "language-change");
11017 DEFSYM (Qdbus_event
, "dbus-event");
11020 #ifdef USE_FILE_NOTIFY
11021 DEFSYM (Qfile_notify
, "file-notify");
11022 #endif /* USE_FILE_NOTIFY */
11024 DEFSYM (QCenable
, ":enable");
11025 DEFSYM (QCvisible
, ":visible");
11026 DEFSYM (QChelp
, ":help");
11027 DEFSYM (QCfilter
, ":filter");
11028 DEFSYM (QCbutton
, ":button");
11029 DEFSYM (QCkeys
, ":keys");
11030 DEFSYM (QCkey_sequence
, ":key-sequence");
11031 DEFSYM (QCtoggle
, ":toggle");
11032 DEFSYM (QCradio
, ":radio");
11033 DEFSYM (QClabel
, ":label");
11034 DEFSYM (QCvert_only
, ":vert-only");
11036 DEFSYM (Qmode_line
, "mode-line");
11037 DEFSYM (Qvertical_line
, "vertical-line");
11038 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11039 DEFSYM (Qmenu_bar
, "menu-bar");
11041 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11043 DEFSYM (Qabove_handle
, "above-handle");
11044 DEFSYM (Qhandle
, "handle");
11045 DEFSYM (Qbelow_handle
, "below-handle");
11046 DEFSYM (Qup
, "up");
11047 DEFSYM (Qdown
, "down");
11048 DEFSYM (Qtop
, "top");
11049 DEFSYM (Qbottom
, "bottom");
11050 DEFSYM (Qend_scroll
, "end-scroll");
11051 DEFSYM (Qratio
, "ratio");
11053 DEFSYM (Qevent_kind
, "event-kind");
11054 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11055 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11056 DEFSYM (Qmodifier_cache
, "modifier-cache");
11058 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11059 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11061 DEFSYM (Qpolling_period
, "polling-period");
11063 DEFSYM (Qx_set_selection
, "x-set-selection");
11064 DEFSYM (QPRIMARY
, "PRIMARY");
11065 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11066 DEFSYM (Qhandle_select_window
, "handle-select-window");
11068 DEFSYM (Qinput_method_function
, "input-method-function");
11069 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11070 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11072 DEFSYM (Qhelp_form_show
, "help-form-show");
11074 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11076 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11077 Fset (Qinput_method_use_echo_area
, Qnil
);
11081 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11083 for (i
= 0; i
< len
; i
++)
11085 const struct event_head
*p
= &head_table
[i
];
11086 *p
->var
= intern_c_string (p
->name
);
11087 staticpro (p
->var
);
11088 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11089 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11093 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11094 staticpro (&button_down_location
);
11095 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11096 staticpro (&mouse_syms
);
11097 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11098 / sizeof (lispy_wheel_names
[0])),
11100 staticpro (&wheel_syms
);
11104 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11106 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11107 for (i
= 0; i
< len
; i
++)
11108 if (modifier_names
[i
])
11109 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11110 staticpro (&modifier_symbols
);
11113 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11114 staticpro (&recent_keys
);
11116 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11117 staticpro (&this_command_keys
);
11119 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11120 staticpro (&raw_keybuf
);
11122 DEFSYM (Qcommand_execute
, "command-execute");
11124 accent_key_syms
= Qnil
;
11125 staticpro (&accent_key_syms
);
11127 func_key_syms
= Qnil
;
11128 staticpro (&func_key_syms
);
11130 drag_n_drop_syms
= Qnil
;
11131 staticpro (&drag_n_drop_syms
);
11133 unread_switch_frame
= Qnil
;
11134 staticpro (&unread_switch_frame
);
11136 internal_last_event_frame
= Qnil
;
11137 staticpro (&internal_last_event_frame
);
11139 read_key_sequence_cmd
= Qnil
;
11140 staticpro (&read_key_sequence_cmd
);
11141 read_key_sequence_remapped
= Qnil
;
11142 staticpro (&read_key_sequence_remapped
);
11144 menu_bar_one_keymap_changed_items
= Qnil
;
11145 staticpro (&menu_bar_one_keymap_changed_items
);
11147 menu_bar_items_vector
= Qnil
;
11148 staticpro (&menu_bar_items_vector
);
11150 help_form_saved_window_configs
= Qnil
;
11151 staticpro (&help_form_saved_window_configs
);
11153 defsubr (&Scurrent_idle_time
);
11154 defsubr (&Sevent_symbol_parse_modifiers
);
11155 defsubr (&Sevent_convert_list
);
11156 defsubr (&Sread_key_sequence
);
11157 defsubr (&Sread_key_sequence_vector
);
11158 defsubr (&Srecursive_edit
);
11159 defsubr (&Strack_mouse
);
11160 defsubr (&Sinput_pending_p
);
11161 defsubr (&Srecent_keys
);
11162 defsubr (&Sthis_command_keys
);
11163 defsubr (&Sthis_command_keys_vector
);
11164 defsubr (&Sthis_single_command_keys
);
11165 defsubr (&Sthis_single_command_raw_keys
);
11166 defsubr (&Sreset_this_command_lengths
);
11167 defsubr (&Sclear_this_command_keys
);
11168 defsubr (&Ssuspend_emacs
);
11169 defsubr (&Sabort_recursive_edit
);
11170 defsubr (&Sexit_recursive_edit
);
11171 defsubr (&Srecursion_depth
);
11172 defsubr (&Stop_level
);
11173 defsubr (&Sdiscard_input
);
11174 defsubr (&Sopen_dribble_file
);
11175 defsubr (&Sset_input_interrupt_mode
);
11176 defsubr (&Sset_output_flow_control
);
11177 defsubr (&Sset_input_meta_mode
);
11178 defsubr (&Sset_quit_char
);
11179 defsubr (&Sset_input_mode
);
11180 defsubr (&Scurrent_input_mode
);
11181 defsubr (&Sposn_at_point
);
11182 defsubr (&Sposn_at_x_y
);
11184 DEFVAR_LISP ("last-command-event", last_command_event
,
11185 doc
: /* Last input event that was part of a command. */);
11187 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11188 doc
: /* Last input event in a command, except for mouse menu events.
11189 Mouse menus give back keys that don't look like mouse events;
11190 this variable holds the actual mouse event that led to the menu,
11191 so that you can determine whether the command was run by mouse or not. */);
11193 DEFVAR_LISP ("last-input-event", last_input_event
,
11194 doc
: /* Last input event. */);
11196 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11197 doc
: /* List of events to be read as the command input.
11198 These events are processed first, before actual keyboard input.
11199 Events read from this list are not normally added to `this-command-keys',
11200 as they will already have been added once as they were read for the first time.
11201 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11202 Vunread_command_events
= Qnil
;
11204 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11205 doc
: /* List of events to be processed as input by input methods.
11206 These events are processed before `unread-command-events'
11207 and actual keyboard input, but are not given to `input-method-function'. */);
11208 Vunread_post_input_method_events
= Qnil
;
11210 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11211 doc
: /* List of events to be processed as input by input methods.
11212 These events are processed after `unread-command-events', but
11213 before actual keyboard input.
11214 If there's an active input method, the events are given to
11215 `input-method-function'. */);
11216 Vunread_input_method_events
= Qnil
;
11218 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11219 doc
: /* Meta-prefix character code.
11220 Meta-foo as command input turns into this character followed by foo. */);
11221 XSETINT (meta_prefix_char
, 033);
11223 DEFVAR_KBOARD ("last-command", Vlast_command
,
11224 doc
: /* The last command executed.
11225 Normally a symbol with a function definition, but can be whatever was found
11226 in the keymap, or whatever the variable `this-command' was set to by that
11229 The value `mode-exit' is special; it means that the previous command
11230 read an event that told it to exit, and it did so and unread that event.
11231 In other words, the present command is the event that made the previous
11234 The value `kill-region' is special; it means that the previous command
11235 was a kill command.
11237 `last-command' has a separate binding for each terminal device.
11238 See Info node `(elisp)Multiple Terminals'. */);
11240 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11241 doc
: /* Same as `last-command', but never altered by Lisp code.
11242 Taken from the previous value of `real-this-command'. */);
11244 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11245 doc
: /* Last command that may be repeated.
11246 The last command executed that was not bound to an input event.
11247 This is the command `repeat' will try to repeat.
11248 Taken from a previous value of `real-this-command'. */);
11250 DEFVAR_LISP ("this-command", Vthis_command
,
11251 doc
: /* The command now being executed.
11252 The command can set this variable; whatever is put here
11253 will be in `last-command' during the following command. */);
11254 Vthis_command
= Qnil
;
11256 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11257 doc
: /* This is like `this-command', except that commands should never modify it. */);
11258 Vreal_this_command
= Qnil
;
11260 DEFVAR_LISP ("this-command-keys-shift-translated",
11261 Vthis_command_keys_shift_translated
,
11262 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11263 Shift-translation occurs when there is no binding for the key sequence
11264 as entered, but a binding was found by changing an upper-case letter
11265 to lower-case, or a shifted function key to an unshifted one. */);
11266 Vthis_command_keys_shift_translated
= Qnil
;
11268 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11269 doc
: /* The command bound to the current key sequence before remapping.
11270 It equals `this-command' if the original command was not remapped through
11271 any of the active keymaps. Otherwise, the value of `this-command' is the
11272 result of looking up the original command in the active keymaps. */);
11273 Vthis_original_command
= Qnil
;
11275 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11276 doc
: /* Number of input events between auto-saves.
11277 Zero means disable autosaving due to number of characters typed. */);
11278 auto_save_interval
= 300;
11280 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11281 doc
: /* Number of seconds idle time before auto-save.
11282 Zero or nil means disable auto-saving due to idleness.
11283 After auto-saving due to this many seconds of idle time,
11284 Emacs also does a garbage collection if that seems to be warranted. */);
11285 XSETFASTINT (Vauto_save_timeout
, 30);
11287 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11288 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11289 The value may be integer or floating point.
11290 If the value is zero, don't echo at all. */);
11291 Vecho_keystrokes
= make_number (1);
11293 DEFVAR_INT ("polling-period", polling_period
,
11294 doc
: /* Interval between polling for input during Lisp execution.
11295 The reason for polling is to make C-g work to stop a running program.
11296 Polling is needed only when using X windows and SIGIO does not work.
11297 Polling is automatically disabled in all other cases. */);
11298 polling_period
= 2;
11300 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11301 doc
: /* Maximum time between mouse clicks to make a double-click.
11302 Measured in milliseconds. The value nil means disable double-click
11303 recognition; t means double-clicks have no time limit and are detected
11304 by position only. */);
11305 Vdouble_click_time
= make_number (500);
11307 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11308 doc
: /* Maximum mouse movement between clicks to make a double-click.
11309 On window-system frames, value is the number of pixels the mouse may have
11310 moved horizontally or vertically between two clicks to make a double-click.
11311 On non window-system frames, value is interpreted in units of 1/8 characters
11314 This variable is also the threshold for motion of the mouse
11315 to count as a drag. */);
11316 double_click_fuzz
= 3;
11318 DEFVAR_INT ("num-input-keys", num_input_keys
,
11319 doc
: /* Number of complete key sequences read as input so far.
11320 This includes key sequences read from keyboard macros.
11321 The number is effectively the number of interactive command invocations. */);
11322 num_input_keys
= 0;
11324 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11325 doc
: /* Number of input events read from the keyboard so far.
11326 This does not include events generated by keyboard macros. */);
11327 num_nonmacro_input_events
= 0;
11329 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11330 doc
: /* The frame in which the most recently read event occurred.
11331 If the last event came from a keyboard macro, this is set to `macro'. */);
11332 Vlast_event_frame
= Qnil
;
11334 /* This variable is set up in sysdep.c. */
11335 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11336 doc
: /* The ERASE character as set by the user with stty. */);
11338 DEFVAR_LISP ("help-char", Vhelp_char
,
11339 doc
: /* Character to recognize as meaning Help.
11340 When it is read, do `(eval help-form)', and display result if it's a string.
11341 If the value of `help-form' is nil, this char can be read normally. */);
11342 XSETINT (Vhelp_char
, Ctl ('H'));
11344 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11345 doc
: /* List of input events to recognize as meaning Help.
11346 These work just like the value of `help-char' (see that). */);
11347 Vhelp_event_list
= Qnil
;
11349 DEFVAR_LISP ("help-form", Vhelp_form
,
11350 doc
: /* Form to execute when character `help-char' is read.
11351 If the form returns a string, that string is displayed.
11352 If `help-form' is nil, the help char is not recognized. */);
11355 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11356 doc
: /* Command to run when `help-char' character follows a prefix key.
11357 This command is used only when there is no actual binding
11358 for that character after that prefix key. */);
11359 Vprefix_help_command
= Qnil
;
11361 DEFVAR_LISP ("top-level", Vtop_level
,
11362 doc
: /* Form to evaluate when Emacs starts up.
11363 Useful to set before you dump a modified Emacs. */);
11366 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11367 doc
: /* Translate table for local keyboard input, or nil.
11368 If non-nil, the value should be a char-table. Each character read
11369 from the keyboard is looked up in this char-table. If the value found
11370 there is non-nil, then it is used instead of the actual input character.
11372 The value can also be a string or vector, but this is considered obsolete.
11373 If it is a string or vector of length N, character codes N and up are left
11374 untranslated. In a vector, an element which is nil means "no translation".
11376 This is applied to the characters supplied to input methods, not their
11377 output. See also `translation-table-for-input'.
11379 This variable has a separate binding for each terminal.
11380 See Info node `(elisp)Multiple Terminals'. */);
11382 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11383 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11384 \(Even if the operating system has support for stopping a process.\) */);
11385 cannot_suspend
= 0;
11387 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11388 doc
: /* Non-nil means prompt with menus when appropriate.
11389 This is done when reading from a keymap that has a prompt string,
11390 for elements that have prompt strings.
11391 The menu is displayed on the screen
11392 if X menus were enabled at configuration
11393 time and the previous event was a mouse click prefix key.
11394 Otherwise, menu prompting uses the echo area. */);
11395 menu_prompting
= 1;
11397 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11398 doc
: /* Character to see next line of menu prompt.
11399 Type this character while in a menu prompt to rotate around the lines of it. */);
11400 XSETINT (menu_prompt_more_char
, ' ');
11402 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11403 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11404 Emacs applies the modifiers of the character stored here to each keyboard
11405 character it reads. For example, after evaluating the expression
11406 (setq extra-keyboard-modifiers ?\\C-x)
11407 all input characters will have the control modifier applied to them.
11409 Note that the character ?\\C-@, equivalent to the integer zero, does
11410 not count as a control character; rather, it counts as a character
11411 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11412 cancels any modification. */);
11413 extra_keyboard_modifiers
= 0;
11415 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11416 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11417 The command loop sets this to nil before each command,
11418 and tests the value when the command returns.
11419 Buffer modification stores t in this variable. */);
11420 Vdeactivate_mark
= Qnil
;
11421 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11423 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11424 doc
: /* Normal hook run before each command is executed.
11425 If an unhandled error happens in running this hook,
11426 the function in which the error occurred is unconditionally removed, since
11427 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11428 Vpre_command_hook
= Qnil
;
11430 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11431 doc
: /* Normal hook run after each command is executed.
11432 If an unhandled error happens in running this hook,
11433 the function in which the error occurred is unconditionally removed, since
11434 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11435 Vpost_command_hook
= Qnil
;
11438 DEFVAR_LISP ("echo-area-clear-hook", ...,
11439 doc
: /* Normal hook run when clearing the echo area. */);
11441 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11442 Fset (Qecho_area_clear_hook
, Qnil
);
11444 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11445 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11446 Vlucid_menu_bar_dirty_flag
= Qnil
;
11448 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11449 doc
: /* List of menu bar items to move to the end of the menu bar.
11450 The elements of the list are event types that may have menu bar bindings. */);
11451 Vmenu_bar_final_items
= Qnil
;
11453 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11454 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11455 This is used internally by graphical displays that do not render
11456 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11457 Vtool_bar_separator_image_expression
= Qnil
;
11459 DEFVAR_KBOARD ("overriding-terminal-local-map",
11460 Voverriding_terminal_local_map
,
11461 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11463 This variable is intended to let commands such as `universal-argument'
11464 set up a different keymap for reading the next command.
11466 `overriding-terminal-local-map' has a separate binding for each
11468 See Info node `(elisp)Multiple Terminals'. */);
11470 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11471 doc
: /* Keymap that overrides almost all other local keymaps.
11472 If this variable is non-nil, it is used as a keymap--replacing the
11473 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11474 Voverriding_local_map
= Qnil
;
11476 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11477 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11478 Otherwise, the menu bar continues to reflect the buffer's local map
11479 and the minor mode maps regardless of `overriding-local-map'. */);
11480 Voverriding_local_map_menu_flag
= Qnil
;
11482 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11483 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11484 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11486 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11487 doc
: /* Non-nil means generate motion events for mouse motion. */);
11489 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11490 doc
: /* Alist of system-specific X windows key symbols.
11491 Each element should have the form (N . SYMBOL) where N is the
11492 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11493 and SYMBOL is its name.
11495 `system-key-alist' has a separate binding for each terminal device.
11496 See Info node `(elisp)Multiple Terminals'. */);
11498 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11499 doc
: /* Keymap that translates key sequences to key sequences during input.
11500 This is used mainly for mapping key sequences into some preferred
11501 key events (symbols).
11503 The `read-key-sequence' function replaces any subsequence bound by
11504 `local-function-key-map' with its binding. More precisely, when the
11505 active keymaps have no binding for the current key sequence but
11506 `local-function-key-map' binds a suffix of the sequence to a vector or
11507 string, `read-key-sequence' replaces the matching suffix with its
11508 binding, and continues with the new sequence.
11510 If the binding is a function, it is called with one argument (the prompt)
11511 and its return value (a key sequence) is used.
11513 The events that come from bindings in `local-function-key-map' are not
11514 themselves looked up in `local-function-key-map'.
11516 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11517 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11518 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11519 typing `ESC O P x' would return [f1 x].
11521 `local-function-key-map' has a separate binding for each terminal
11522 device. See Info node `(elisp)Multiple Terminals'. If you need to
11523 define a binding on all terminals, change `function-key-map'
11524 instead. Initially, `local-function-key-map' is an empty keymap that
11525 has `function-key-map' as its parent on all terminal devices. */);
11527 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11528 doc
: /* Keymap that decodes input escape sequences.
11529 This is used mainly for mapping ASCII function key sequences into
11530 real Emacs function key events (symbols).
11532 The `read-key-sequence' function replaces any subsequence bound by
11533 `input-decode-map' with its binding. Contrary to `function-key-map',
11534 this map applies its rebinding regardless of the presence of an ordinary
11535 binding. So it is more like `key-translation-map' except that it applies
11536 before `function-key-map' rather than after.
11538 If the binding is a function, it is called with one argument (the prompt)
11539 and its return value (a key sequence) is used.
11541 The events that come from bindings in `input-decode-map' are not
11542 themselves looked up in `input-decode-map'. */);
11544 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11545 doc
: /* The parent keymap of all `local-function-key-map' instances.
11546 Function key definitions that apply to all terminal devices should go
11547 here. If a mapping is defined in both the current
11548 `local-function-key-map' binding and this variable, then the local
11549 definition will take precedence. */);
11550 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11552 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11553 doc
: /* Keymap of key translations that can override keymaps.
11554 This keymap works like `input-decode-map', but comes after `function-key-map'.
11555 Another difference is that it is global rather than terminal-local. */);
11556 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11558 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11559 doc
: /* List of deferred actions to be performed at a later time.
11560 The precise format isn't relevant here; we just check whether it is nil. */);
11561 Vdeferred_action_list
= Qnil
;
11563 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11564 doc
: /* Function to call to handle deferred actions, after each command.
11565 This function is called with no arguments after each command
11566 whenever `deferred-action-list' is non-nil. */);
11567 Vdeferred_action_function
= Qnil
;
11569 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11570 doc
: /* List of warnings to be displayed after this command.
11571 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11572 as per the args of `display-warning' (which see).
11573 If this variable is non-nil, `delayed-warnings-hook' will be run
11574 immediately after running `post-command-hook'. */);
11575 Vdelayed_warnings_list
= Qnil
;
11577 DEFVAR_LISP ("timer-list", Vtimer_list
,
11578 doc
: /* List of active absolute time timers in order of increasing time. */);
11579 Vtimer_list
= Qnil
;
11581 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11582 doc
: /* List of active idle-time timers in order of increasing time. */);
11583 Vtimer_idle_list
= Qnil
;
11585 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11586 doc
: /* If non-nil, the function that implements the current input method.
11587 It's called with one argument, a printing character that was just read.
11588 \(That means a character with code 040...0176.)
11589 Typically this function uses `read-event' to read additional events.
11590 When it does so, it should first bind `input-method-function' to nil
11591 so it will not be called recursively.
11593 The function should return a list of zero or more events
11594 to be used as input. If it wants to put back some events
11595 to be reconsidered, separately, by the input method,
11596 it can add them to the beginning of `unread-command-events'.
11598 The input method function can find in `input-method-previous-message'
11599 the previous echo area message.
11601 The input method function should refer to the variables
11602 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11603 for guidance on what to do. */);
11604 Vinput_method_function
= Qnil
;
11606 DEFVAR_LISP ("input-method-previous-message",
11607 Vinput_method_previous_message
,
11608 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11609 This variable exists because `read-event' clears the echo area
11610 before running the input method. It is nil if there was no message. */);
11611 Vinput_method_previous_message
= Qnil
;
11613 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11614 doc
: /* If non-nil, the function that implements the display of help.
11615 It's called with one argument, the help string to display. */);
11616 Vshow_help_function
= Qnil
;
11618 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11619 doc
: /* If non-nil, suppress point adjustment after executing a command.
11621 After a command is executed, if point is moved into a region that has
11622 special properties (e.g. composition, display), we adjust point to
11623 the boundary of the region. But, when a command sets this variable to
11624 non-nil, we suppress the point adjustment.
11626 This variable is set to nil before reading a command, and is checked
11627 just after executing the command. */);
11628 Vdisable_point_adjustment
= Qnil
;
11630 DEFVAR_LISP ("global-disable-point-adjustment",
11631 Vglobal_disable_point_adjustment
,
11632 doc
: /* If non-nil, always suppress point adjustment.
11634 The default value is nil, in which case, point adjustment are
11635 suppressed only after special commands that set
11636 `disable-point-adjustment' (which see) to non-nil. */);
11637 Vglobal_disable_point_adjustment
= Qnil
;
11639 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11640 doc
: /* How long to display an echo-area message when the minibuffer is active.
11641 If the value is not a number, such messages don't time out. */);
11642 Vminibuffer_message_timeout
= make_number (2);
11644 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11645 doc
: /* If non-nil, any keyboard input throws to this symbol.
11646 The value of that variable is passed to `quit-flag' and later causes a
11647 peculiar kind of quitting. */);
11648 Vthrow_on_input
= Qnil
;
11650 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11651 doc
: /* If non-nil, function to output error messages.
11652 The arguments are the error data, a list of the form
11653 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11654 such as just as `condition-case' would bind its variable to,
11655 the context (a string which normally goes at the start of the message),
11656 and the Lisp function within which the error was signaled. */);
11657 Vcommand_error_function
= Qnil
;
11659 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11660 Venable_disabled_menus_and_buttons
,
11661 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11663 Help functions bind this to allow help on disabled menu items
11664 and tool-bar buttons. */);
11665 Venable_disabled_menus_and_buttons
= Qnil
;
11667 DEFVAR_LISP ("select-active-regions",
11668 Vselect_active_regions
,
11669 doc
: /* If non-nil, an active region automatically sets the primary selection.
11670 If the value is `only', only temporarily active regions (usually made
11671 by mouse-dragging or shift-selection) set the window selection.
11673 This takes effect only when Transient Mark mode is enabled. */);
11674 Vselect_active_regions
= Qt
;
11676 DEFVAR_LISP ("saved-region-selection",
11677 Vsaved_region_selection
,
11678 doc
: /* Contents of active region prior to buffer modification.
11679 If `select-active-regions' is non-nil, Emacs sets this to the
11680 text in the region before modifying the buffer. The next call to
11681 the function `deactivate-mark' uses this to set the window selection. */);
11682 Vsaved_region_selection
= Qnil
;
11684 DEFVAR_LISP ("selection-inhibit-update-commands",
11685 Vselection_inhibit_update_commands
,
11686 doc
: /* List of commands which should not update the selection.
11687 Normally, if `select-active-regions' is non-nil and the mark remains
11688 active after a command (i.e. the mark was not deactivated), the Emacs
11689 command loop sets the selection to the text in the region. However,
11690 if the command is in this list, the selection is not updated. */);
11691 Vselection_inhibit_update_commands
11692 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11694 DEFVAR_LISP ("debug-on-event",
11696 doc
: /* Enter debugger on this event. When Emacs
11697 receives the special event specified by this variable, it will try to
11698 break into the debugger as soon as possible instead of processing the
11699 event normally through `special-event-map'.
11701 Currently, the only supported values for this
11702 variable are `sigusr1' and `sigusr2'. */);
11703 Vdebug_on_event
= intern_c_string ("sigusr2");
11705 /* Create the initial keyboard. Qt means 'unset'. */
11706 initial_kboard
= allocate_kboard (Qt
);
11710 keys_of_keyboard (void)
11712 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11713 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11714 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11715 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11716 initial_define_key (meta_map
, 'x', "execute-extended-command");
11718 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11719 "handle-delete-frame");
11720 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11721 "ns-put-working-text");
11722 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11723 "ns-unput-working-text");
11724 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11725 current-prefix-arg, as is done in `handle-switch-frame'.
11726 But `handle-switch-frame is not run from the special-map.
11727 Commands from that map are run in a special way that automatically
11728 preserves the prefix-arg. Restoring the prefix arg here is not just
11729 redundant but harmful:
11731 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11732 - after the first prompt, the exit-minibuffer-hook is run which may
11733 iconify a frame and thus push a `iconify-frame' event.
11734 - after running exit-minibuffer-hook, current-prefix-arg is
11735 restored to the non-nil value it had before the prompt.
11736 - we enter the second prompt.
11737 current-prefix-arg is non-nil, prefix-arg is nil.
11738 - before running the first real event, we run the special iconify-frame
11739 event, but we pass the `special' arg to execute-command so
11740 current-prefix-arg and prefix-arg are left untouched.
11741 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11742 - the next key event will have a spuriously non-nil current-prefix-arg. */
11743 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11745 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11747 /* Handling it at such a low-level causes read_key_sequence to get
11748 * confused because it doesn't realize that the current_buffer was
11749 * changed by read_char.
11751 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11752 * "handle-select-window"); */
11753 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11754 "handle-save-session");
11757 /* Define a special event which is raised for dbus callback
11759 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11760 "dbus-handle-event");
11763 #ifdef USE_FILE_NOTIFY
11764 /* Define a special event which is raised for notification callback
11766 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11767 "file-notify-handle-event");
11768 #endif /* USE_FILE_NOTIFY */
11770 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11772 #if defined (WINDOWSNT)
11773 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11776 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11777 "handle-focus-in");
11778 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11779 "handle-focus-out");
11782 /* Mark the pointers in the kboard objects.
11783 Called by Fgarbage_collect. */
11785 mark_kboards (void)
11789 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11791 if (kb
->kbd_macro_buffer
)
11792 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11794 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11795 mark_object (KVAR (kb
, Vlast_command
));
11796 mark_object (KVAR (kb
, Vreal_last_command
));
11797 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11798 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11799 mark_object (KVAR (kb
, Vprefix_arg
));
11800 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11801 mark_object (KVAR (kb
, kbd_queue
));
11802 mark_object (KVAR (kb
, defining_kbd_macro
));
11803 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11804 mark_object (KVAR (kb
, Vsystem_key_alist
));
11805 mark_object (KVAR (kb
, system_key_syms
));
11806 mark_object (KVAR (kb
, Vwindow_system
));
11807 mark_object (KVAR (kb
, Vinput_decode_map
));
11808 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11809 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11810 mark_object (KVAR (kb
, echo_string
));
11813 struct input_event
*event
;
11814 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11816 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11817 event
= kbd_buffer
;
11818 /* These two special event types has no Lisp_Objects to mark. */
11819 if (event
->kind
!= SELECTION_REQUEST_EVENT
11820 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11822 mark_object (event
->x
);
11823 mark_object (event
->y
);
11824 mark_object (event
->frame_or_window
);
11825 mark_object (event
->arg
);