1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2014 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include "termhooks.h"
34 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #if defined USABLE_FIONREAD && defined USG5_4
59 # include <sys/filio.h>
62 #include "syssignal.h"
64 #include <sys/types.h>
68 #ifdef HAVE_WINDOW_SYSTEM
70 #endif /* HAVE_WINDOW_SYSTEM */
72 /* Variables for blockinput.h: */
74 /* Positive if interrupt input is blocked right now. */
75 volatile int interrupt_input_blocked
;
77 /* True means an input interrupt or alarm signal has arrived.
78 The QUIT macro checks this. */
79 volatile bool pending_signals
;
81 #define KBD_BUFFER_SIZE 4096
83 KBOARD
*initial_kboard
;
84 KBOARD
*current_kboard
;
85 static KBOARD
*all_kboards
;
87 /* True in the single-kboard state, false in the any-kboard state. */
88 static bool single_kboard
;
90 /* Non-nil disable property on a command means
91 do not execute it; call disabled-command-function's value instead. */
92 Lisp_Object Qdisabled
;
93 static Lisp_Object Qdisabled_command_function
;
95 #define NUM_RECENT_KEYS (300)
97 /* Index for storing next element into recent_keys. */
98 static int recent_keys_index
;
100 /* Total number of elements stored into recent_keys. */
101 static int total_keys
;
103 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
104 static Lisp_Object recent_keys
;
106 /* Vector holding the key sequence that invoked the current command.
107 It is reused for each command, and it may be longer than the current
108 sequence; this_command_key_count indicates how many elements
109 actually mean something.
110 It's easier to staticpro a single Lisp_Object than an array. */
111 Lisp_Object this_command_keys
;
112 ptrdiff_t this_command_key_count
;
114 /* True after calling Freset_this_command_lengths.
115 Usually it is false. */
116 static bool this_command_key_count_reset
;
118 /* This vector is used as a buffer to record the events that were actually read
119 by read_key_sequence. */
120 static Lisp_Object raw_keybuf
;
121 static int raw_keybuf_count
;
123 #define GROW_RAW_KEYBUF \
124 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
125 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
127 /* Number of elements of this_command_keys
128 that precede this key sequence. */
129 static ptrdiff_t this_single_command_key_start
;
131 /* Record values of this_command_key_count and echo_length ()
132 before this command was read. */
133 static ptrdiff_t before_command_key_count
;
134 static ptrdiff_t before_command_echo_length
;
136 #ifdef HAVE_STACK_OVERFLOW_HANDLING
138 /* For longjmp to recover from C stack overflow. */
139 sigjmp_buf return_to_command_loop
;
141 /* Message displayed by Vtop_level when recovering from C stack overflow. */
142 static Lisp_Object recover_top_level_message
;
144 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
146 /* Message normally displayed by Vtop_level. */
147 static Lisp_Object regular_top_level_message
;
149 /* For longjmp to where kbd input is being done. */
151 static sys_jmp_buf getcjmp
;
153 /* True while doing kbd input. */
154 bool waiting_for_input
;
156 /* True while displaying for echoing. Delays C-g throwing. */
160 /* Non-null means we can start echoing at the next input pause even
161 though there is something in the echo area. */
163 static struct kboard
*ok_to_echo_at_next_pause
;
165 /* The kboard last echoing, or null for none. Reset to 0 in
166 cancel_echoing. If non-null, and a current echo area message
167 exists, and echo_message_buffer is eq to the current message
168 buffer, we know that the message comes from echo_kboard. */
170 struct kboard
*echo_kboard
;
172 /* The buffer used for echoing. Set in echo_now, reset in
175 Lisp_Object echo_message_buffer
;
177 /* True means C-g should cause immediate error-signal. */
180 /* Character that causes a quit. Normally C-g.
182 If we are running on an ordinary terminal, this must be an ordinary
183 ASCII char, since we want to make it our interrupt character.
185 If we are not running on an ordinary terminal, it still needs to be
186 an ordinary ASCII char. This character needs to be recognized in
187 the input interrupt handler. At this point, the keystroke is
188 represented as a struct input_event, while the desired quit
189 character is specified as a lispy event. The mapping from struct
190 input_events to lispy events cannot run in an interrupt handler,
191 and the reverse mapping is difficult for anything but ASCII
194 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
198 /* Current depth in recursive edits. */
199 EMACS_INT command_loop_level
;
201 /* If not Qnil, this is a switch-frame event which we decided to put
202 off until the end of a key sequence. This should be read as the
203 next command input, after any unread_command_events.
205 read_key_sequence uses this to delay switch-frame events until the
206 end of the key sequence; Fread_char uses it to put off switch-frame
207 events until a non-ASCII event is acceptable as input. */
208 Lisp_Object unread_switch_frame
;
210 /* Last size recorded for a current buffer which is not a minibuffer. */
211 static ptrdiff_t last_non_minibuf_size
;
213 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
214 uintmax_t num_input_events
;
216 /* Value of num_nonmacro_input_events as of last auto save. */
218 static EMACS_INT last_auto_save
;
220 /* The value of point when the last command was started. */
221 static ptrdiff_t last_point_position
;
223 /* The frame in which the last input event occurred, or Qmacro if the
224 last event came from a macro. We use this to determine when to
225 generate switch-frame events. This may be cleared by functions
226 like Fselect_frame, to make sure that a switch-frame event is
227 generated by the next character.
229 FIXME: This is modified by a signal handler so it should be volatile.
230 It's exported to Lisp, though, so it can't simply be marked
232 Lisp_Object internal_last_event_frame
;
234 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
235 static Lisp_Object Qhandle_select_window
;
236 Lisp_Object QPRIMARY
;
238 static Lisp_Object Qself_insert_command
;
239 static Lisp_Object Qforward_char
;
240 static Lisp_Object Qbackward_char
;
241 Lisp_Object Qundefined
;
242 static Lisp_Object Qtimer_event_handler
;
244 /* `read_key_sequence' stores here the command definition of the
245 key sequence that it reads. */
246 static Lisp_Object read_key_sequence_cmd
;
247 static Lisp_Object read_key_sequence_remapped
;
249 static Lisp_Object Qinput_method_function
;
251 static Lisp_Object Qdeactivate_mark
;
253 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
255 static Lisp_Object Qecho_area_clear_hook
;
257 /* Hooks to run before and after each command. */
258 static Lisp_Object Qpre_command_hook
;
259 static Lisp_Object Qpost_command_hook
;
261 static Lisp_Object Qdeferred_action_function
;
263 static Lisp_Object Qdelayed_warnings_hook
;
265 static Lisp_Object Qinput_method_exit_on_first_char
;
266 static Lisp_Object Qinput_method_use_echo_area
;
268 static Lisp_Object Qhelp_form_show
;
270 /* File in which we write all commands we read. */
271 static FILE *dribble
;
273 /* Nonzero if input is available. */
276 /* Circular buffer for pre-read keyboard input. */
278 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
280 /* Pointer to next available character in kbd_buffer.
281 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
282 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
283 next available char is in kbd_buffer[0]. */
284 static struct input_event
*kbd_fetch_ptr
;
286 /* Pointer to next place to store character in kbd_buffer. This
287 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
288 character should go in kbd_buffer[0]. */
289 static struct input_event
* volatile kbd_store_ptr
;
291 /* The above pair of variables forms a "queue empty" flag. When we
292 enqueue a non-hook event, we increment kbd_store_ptr. When we
293 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
294 there is input available if the two pointers are not equal.
296 Why not just have a flag set and cleared by the enqueuing and
297 dequeuing functions? Such a flag could be screwed up by interrupts
298 at inopportune times. */
300 /* Symbols to head events. */
301 static Lisp_Object Qmouse_movement
;
302 static Lisp_Object Qscroll_bar_movement
;
303 Lisp_Object Qswitch_frame
;
304 static Lisp_Object Qfocus_in
, Qfocus_out
;
305 static Lisp_Object Qdelete_frame
;
306 static Lisp_Object Qiconify_frame
;
307 static Lisp_Object Qmake_frame_visible
;
308 static Lisp_Object Qselect_window
;
309 Lisp_Object Qhelp_echo
;
311 static Lisp_Object Qmouse_fixup_help_message
;
313 /* Symbols to denote kinds of events. */
314 static Lisp_Object Qfunction_key
;
315 Lisp_Object Qmouse_click
;
317 Lisp_Object Qlanguage_change
;
319 static Lisp_Object Qdrag_n_drop
;
320 static Lisp_Object Qsave_session
;
322 static Lisp_Object Qdbus_event
;
324 #ifdef USE_FILE_NOTIFY
325 static Lisp_Object Qfile_notify
;
326 #endif /* USE_FILE_NOTIFY */
327 static Lisp_Object Qconfig_changed_event
;
329 /* Lisp_Object Qmouse_movement; - also an event header */
331 /* Properties of event headers. */
332 Lisp_Object Qevent_kind
;
333 static Lisp_Object Qevent_symbol_elements
;
335 /* Menu and tool bar item parts. */
336 static Lisp_Object Qmenu_enable
;
337 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
338 Lisp_Object QCfilter
;
340 /* Non-nil disable property on a command means
341 do not execute it; call disabled-command-function's value instead. */
342 Lisp_Object QCtoggle
, QCradio
;
343 static Lisp_Object QCbutton
, QClabel
;
345 static Lisp_Object QCvert_only
;
347 /* An event header symbol HEAD may have a property named
348 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
349 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
350 mask of modifiers applied to it. If present, this is used to help
351 speed up parse_modifiers. */
352 Lisp_Object Qevent_symbol_element_mask
;
354 /* An unmodified event header BASE may have a property named
355 Qmodifier_cache, which is an alist mapping modifier masks onto
356 modified versions of BASE. If present, this helps speed up
358 static Lisp_Object Qmodifier_cache
;
360 /* Symbols to use for parts of windows. */
361 Lisp_Object Qmode_line
;
362 Lisp_Object Qvertical_line
;
363 Lisp_Object Qright_divider
, Qbottom_divider
;
364 Lisp_Object Qmenu_bar
;
366 static Lisp_Object Qecho_keystrokes
;
368 static void recursive_edit_unwind (Lisp_Object buffer
);
369 static Lisp_Object
command_loop (void);
370 static Lisp_Object Qcommand_execute
;
372 static void echo_now (void);
373 static ptrdiff_t echo_length (void);
375 static Lisp_Object Qpolling_period
;
377 /* Incremented whenever a timer is run. */
380 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
382 struct timespec
*input_available_clear_time
;
384 /* True means use SIGIO interrupts; false means use CBREAK mode.
385 Default is true if INTERRUPT_INPUT is defined. */
386 bool interrupt_input
;
388 /* Nonzero while interrupts are temporarily deferred during redisplay. */
389 bool interrupts_deferred
;
391 /* The time when Emacs started being idle. */
393 static struct timespec timer_idleness_start_time
;
395 /* After Emacs stops being idle, this saves the last value
396 of timer_idleness_start_time from when it was idle. */
398 static struct timespec timer_last_idleness_start_time
;
401 /* Global variable declarations. */
403 /* Flags for readable_events. */
404 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
405 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
406 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
408 /* Function for init_keyboard to call with no args (if nonzero). */
409 static void (*keyboard_init_hook
) (void);
411 static bool get_input_pending (int);
412 static bool readable_events (int);
413 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
414 Lisp_Object
, bool *);
415 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
416 static Lisp_Object
make_lispy_event (struct input_event
*);
417 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
418 enum scroll_bar_part
,
419 Lisp_Object
, Lisp_Object
,
421 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
422 Lisp_Object
, const char *const *,
423 Lisp_Object
*, ptrdiff_t);
424 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
425 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
426 #ifdef HAVE_WINDOW_SYSTEM
427 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
428 #endif /* HAVE_WINDOW_SYSTEM */
429 static bool help_char_p (Lisp_Object
);
430 static void save_getcjmp (sys_jmp_buf
);
431 static void restore_getcjmp (sys_jmp_buf
);
432 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
433 static void clear_event (struct input_event
*);
434 static void restore_kboard_configuration (int);
436 static void deliver_input_available_signal (int signo
);
438 static void handle_interrupt (bool);
439 static _Noreturn
void quit_throw_to_read_char (bool);
440 static void process_special_events (void);
441 static void timer_start_idle (void);
442 static void timer_stop_idle (void);
443 static void timer_resume_idle (void);
444 static void deliver_user_signal (int);
445 static char *find_user_signal_name (int);
446 static void store_user_signal_events (void);
448 /* These setters are used only in this file, so they can be private. */
450 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
452 kb
->INTERNAL_FIELD (echo_string
) = val
;
455 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
457 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
460 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
462 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
465 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
467 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
470 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
472 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
475 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
477 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
480 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
482 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
485 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
487 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
490 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
492 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
496 /* Add C to the echo string, without echoing it immediately. C can be
497 a character, which is pretty-printed, or a symbol, whose name is
501 echo_add_key (Lisp_Object c
)
503 char initbuf
[KEY_DESCRIPTION_SIZE
+ 100];
504 ptrdiff_t size
= sizeof initbuf
;
505 char *buffer
= initbuf
;
507 Lisp_Object echo_string
;
510 echo_string
= KVAR (current_kboard
, echo_string
);
512 /* If someone has passed us a composite event, use its head symbol. */
516 ptr
= push_key_description (XINT (c
), ptr
);
517 else if (SYMBOLP (c
))
519 Lisp_Object name
= SYMBOL_NAME (c
);
520 ptrdiff_t nbytes
= SBYTES (name
);
522 if (size
- (ptr
- buffer
) < nbytes
)
524 ptrdiff_t offset
= ptr
- buffer
;
525 size
= max (2 * size
, size
+ nbytes
);
526 buffer
= SAFE_ALLOCA (size
);
527 ptr
= buffer
+ offset
;
530 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
531 STRING_MULTIBYTE (name
), 1);
534 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
537 static const char text
[] = " (Type ? for further options)";
538 int len
= sizeof text
- 1;
540 if (size
- (ptr
- buffer
) < len
)
542 ptrdiff_t offset
= ptr
- buffer
;
544 buffer
= SAFE_ALLOCA (size
);
545 ptr
= buffer
+ offset
;
548 memcpy (ptr
, text
, len
);
552 /* Replace a dash from echo_dash with a space, otherwise add a space
553 at the end as a separator between keys. */
554 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
556 Lisp_Object last_char
, prev_char
, idx
;
558 idx
= make_number (SCHARS (echo_string
) - 2);
559 prev_char
= Faref (echo_string
, idx
);
561 idx
= make_number (SCHARS (echo_string
) - 1);
562 last_char
= Faref (echo_string
, idx
);
564 /* We test PREV_CHAR to make sure this isn't the echoing of a
566 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
567 Faset (echo_string
, idx
, make_number (' '));
569 echo_string
= concat2 (echo_string
, build_string (" "));
571 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
572 echo_string
= concat2 (echo_string
, build_string (" "));
576 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
580 /* Add C to the echo string, if echoing is going on. C can be a
581 character or a symbol. */
584 echo_char (Lisp_Object c
)
586 if (current_kboard
->immediate_echo
)
593 /* Temporarily add a dash to the end of the echo string if it's not
594 empty, so that it serves as a mini-prompt for the very next
600 /* Do nothing if not echoing at all. */
601 if (NILP (KVAR (current_kboard
, echo_string
)))
604 if (this_command_key_count
== 0)
607 if (!current_kboard
->immediate_echo
608 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
611 /* Do nothing if we just printed a prompt. */
612 if (current_kboard
->echo_after_prompt
613 == SCHARS (KVAR (current_kboard
, echo_string
)))
616 /* Do nothing if we have already put a dash at the end. */
617 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
619 Lisp_Object last_char
, prev_char
, idx
;
621 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
622 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
624 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
625 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
627 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
631 /* Put a dash at the end of the buffer temporarily,
632 but make it go away when the next character is added. */
635 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
639 /* Display the current echo string, and begin echoing if not already
645 if (!current_kboard
->immediate_echo
)
648 current_kboard
->immediate_echo
= 1;
650 for (i
= 0; i
< this_command_key_count
; i
++)
654 /* Set before_command_echo_length to the value that would
655 have been saved before the start of this subcommand in
656 command_loop_1, if we had already been echoing then. */
657 if (i
== this_single_command_key_start
)
658 before_command_echo_length
= echo_length ();
660 c
= AREF (this_command_keys
, i
);
661 if (! (EVENT_HAS_PARAMETERS (c
)
662 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
666 /* Set before_command_echo_length to the value that would
667 have been saved before the start of this subcommand in
668 command_loop_1, if we had already been echoing then. */
669 if (this_command_key_count
== this_single_command_key_start
)
670 before_command_echo_length
= echo_length ();
672 /* Put a dash at the end to invite the user to type more. */
677 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
678 message3_nolog (KVAR (current_kboard
, echo_string
));
681 /* Record in what buffer we echoed, and from which kboard. */
682 echo_message_buffer
= echo_area_buffer
[0];
683 echo_kboard
= current_kboard
;
685 if (waiting_for_input
&& !NILP (Vquit_flag
))
686 quit_throw_to_read_char (0);
689 /* Turn off echoing, for the start of a new command. */
692 cancel_echoing (void)
694 current_kboard
->immediate_echo
= 0;
695 current_kboard
->echo_after_prompt
= -1;
696 kset_echo_string (current_kboard
, Qnil
);
697 ok_to_echo_at_next_pause
= NULL
;
699 echo_message_buffer
= Qnil
;
702 /* Return the length of the current echo string. */
707 return (STRINGP (KVAR (current_kboard
, echo_string
))
708 ? SCHARS (KVAR (current_kboard
, echo_string
))
712 /* Truncate the current echo message to its first LEN chars.
713 This and echo_char get used by read_key_sequence when the user
714 switches frames while entering a key sequence. */
717 echo_truncate (ptrdiff_t nchars
)
719 if (STRINGP (KVAR (current_kboard
, echo_string
)))
720 kset_echo_string (current_kboard
,
721 Fsubstring (KVAR (current_kboard
, echo_string
),
722 make_number (0), make_number (nchars
)));
723 truncate_echo_area (nchars
);
727 /* Functions for manipulating this_command_keys. */
729 add_command_key (Lisp_Object key
)
731 #if 0 /* Not needed after we made Freset_this_command_lengths
732 do the job immediately. */
733 /* If reset-this-command-length was called recently, obey it now.
734 See the doc string of that function for an explanation of why. */
735 if (before_command_restore_flag
)
737 this_command_key_count
= before_command_key_count_1
;
738 if (this_command_key_count
< this_single_command_key_start
)
739 this_single_command_key_start
= this_command_key_count
;
740 echo_truncate (before_command_echo_length_1
);
741 before_command_restore_flag
= 0;
745 if (this_command_key_count
>= ASIZE (this_command_keys
))
746 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
748 ASET (this_command_keys
, this_command_key_count
, key
);
749 ++this_command_key_count
;
754 recursive_edit_1 (void)
756 ptrdiff_t count
= SPECPDL_INDEX ();
759 if (command_loop_level
> 0)
761 specbind (Qstandard_output
, Qt
);
762 specbind (Qstandard_input
, Qt
);
765 #ifdef HAVE_WINDOW_SYSTEM
766 /* The command loop has started an hourglass timer, so we have to
767 cancel it here, otherwise it will fire because the recursive edit
768 can take some time. Do not check for display_hourglass_p here,
769 because it could already be nil. */
773 /* This function may have been called from a debugger called from
774 within redisplay, for instance by Edebugging a function called
775 from fontification-functions. We want to allow redisplay in
776 the debugging session.
778 The recursive edit is left with a `(throw exit ...)'. The `exit'
779 tag is not caught anywhere in redisplay, i.e. when we leave the
780 recursive edit, the original redisplay leading to the recursive
781 edit will be unwound. The outcome should therefore be safe. */
782 specbind (Qinhibit_redisplay
, Qnil
);
785 val
= command_loop ();
787 Fsignal (Qquit
, Qnil
);
788 /* Handle throw from read_minibuf when using minibuffer
789 while it's active but we're in another window. */
791 xsignal1 (Qerror
, val
);
793 return unbind_to (count
, Qnil
);
796 /* When an auto-save happens, record the "time", and don't do again soon. */
799 record_auto_save (void)
801 last_auto_save
= num_nonmacro_input_events
;
804 /* Make an auto save happen as soon as possible at command level. */
808 force_auto_save_soon (void)
810 last_auto_save
= - auto_save_interval
- 1;
812 record_asynch_buffer_change ();
816 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
817 doc
: /* Invoke the editor command loop recursively.
818 To get out of the recursive edit, a command can throw to `exit' -- for
819 instance `(throw 'exit nil)'.
820 If you throw a value other than t, `recursive-edit' returns normally
821 to the function that called it. Throwing a t value causes
822 `recursive-edit' to quit, so that control returns to the command loop
825 This function is called by the editor initialization to begin editing. */)
828 ptrdiff_t count
= SPECPDL_INDEX ();
831 /* If we enter while input is blocked, don't lock up here.
832 This may happen through the debugger during redisplay. */
833 if (input_blocked_p ())
836 if (command_loop_level
>= 0
837 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
838 buffer
= Fcurrent_buffer ();
842 /* Don't do anything interesting between the increment and the
843 record_unwind_protect! Otherwise, we could get distracted and
844 never decrement the counter again. */
845 command_loop_level
++;
846 update_mode_lines
= 17;
847 record_unwind_protect (recursive_edit_unwind
, buffer
);
849 /* If we leave recursive_edit_1 below with a `throw' for instance,
850 like it is done in the splash screen display, we have to
851 make sure that we restore single_kboard as command_loop_1
852 would have done if it were left normally. */
853 if (command_loop_level
> 0)
854 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
857 return unbind_to (count
, Qnil
);
861 recursive_edit_unwind (Lisp_Object buffer
)
863 if (BUFFERP (buffer
))
864 Fset_buffer (buffer
);
866 command_loop_level
--;
867 update_mode_lines
= 18;
871 #if 0 /* These two functions are now replaced with
872 temporarily_switch_to_single_kboard. */
876 #if 0 /* Theory: if there's anything in Vunread_command_events,
877 it will right away be read by read_key_sequence,
878 and then if we do switch KBOARDS, it will go into the side
879 queue then. So we don't need to do anything special here -- rms. */
880 if (CONSP (Vunread_command_events
))
882 current_kboard
->kbd_queue
883 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
884 current_kboard
->kbd_queue_has_data
= 1;
886 Vunread_command_events
= Qnil
;
891 /* Switch to the single-kboard state, making current_kboard
892 the only KBOARD from which further input is accepted. */
895 single_kboard_state ()
901 /* If we're in single_kboard state for kboard KBOARD,
905 not_single_kboard_state (KBOARD
*kboard
)
907 if (kboard
== current_kboard
)
911 /* Maintain a stack of kboards, so other parts of Emacs
912 can switch temporarily to the kboard of a given frame
913 and then revert to the previous status. */
918 struct kboard_stack
*next
;
921 static struct kboard_stack
*kboard_stack
;
924 push_kboard (struct kboard
*k
)
926 struct kboard_stack
*p
= xmalloc (sizeof *p
);
928 p
->next
= kboard_stack
;
929 p
->kboard
= current_kboard
;
939 struct kboard_stack
*p
= kboard_stack
;
941 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
943 if (t
->kboard
== p
->kboard
)
945 current_kboard
= p
->kboard
;
952 /* The terminal we remembered has been deleted. */
953 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
956 kboard_stack
= p
->next
;
960 /* Switch to single_kboard mode, making current_kboard the only KBOARD
961 from which further input is accepted. If F is non-nil, set its
962 KBOARD as the current keyboard.
964 This function uses record_unwind_protect_int to return to the previous
967 If Emacs is already in single_kboard mode, and F's keyboard is
968 locked, then this function will throw an error. */
971 temporarily_switch_to_single_kboard (struct frame
*f
)
973 bool was_locked
= single_kboard
;
976 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
977 /* We can not switch keyboards while in single_kboard mode.
978 In rare cases, Lisp code may call `recursive-edit' (or
979 `read-minibuffer' or `y-or-n-p') after it switched to a
980 locked frame. For example, this is likely to happen
981 when server.el connects to a new terminal while Emacs is in
982 single_kboard mode. It is best to throw an error instead
983 of presenting the user with a frozen screen. */
984 error ("Terminal %d is locked, cannot read from it",
985 FRAME_TERMINAL (f
)->id
);
987 /* This call is unnecessary, but helps
988 `restore_kboard_configuration' discover if somebody changed
989 `current_kboard' behind our back. */
990 push_kboard (current_kboard
);
993 current_kboard
= FRAME_KBOARD (f
);
995 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
998 #if 0 /* This function is not needed anymore. */
1000 record_single_kboard_state ()
1003 push_kboard (current_kboard
);
1004 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
1009 restore_kboard_configuration (int was_locked
)
1011 single_kboard
= was_locked
;
1014 struct kboard
*prev
= current_kboard
;
1016 /* The pop should not change the kboard. */
1017 if (single_kboard
&& current_kboard
!= prev
)
1023 /* Handle errors that are not handled at inner levels
1024 by printing an error message and returning to the editor command loop. */
1027 cmd_error (Lisp_Object data
)
1029 Lisp_Object old_level
, old_length
;
1030 char macroerror
[sizeof "After..kbd macro iterations: "
1031 + INT_STRLEN_BOUND (EMACS_INT
)];
1033 #ifdef HAVE_WINDOW_SYSTEM
1034 if (display_hourglass_p
)
1035 cancel_hourglass ();
1038 if (!NILP (executing_kbd_macro
))
1040 if (executing_kbd_macro_iterations
== 1)
1041 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1043 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1044 executing_kbd_macro_iterations
);
1049 Vstandard_output
= Qt
;
1050 Vstandard_input
= Qt
;
1051 Vexecuting_kbd_macro
= Qnil
;
1052 executing_kbd_macro
= Qnil
;
1053 kset_prefix_arg (current_kboard
, Qnil
);
1054 kset_last_prefix_arg (current_kboard
, Qnil
);
1057 /* Avoid unquittable loop if data contains a circular list. */
1058 old_level
= Vprint_level
;
1059 old_length
= Vprint_length
;
1060 XSETFASTINT (Vprint_level
, 10);
1061 XSETFASTINT (Vprint_length
, 10);
1062 cmd_error_internal (data
, macroerror
);
1063 Vprint_level
= old_level
;
1064 Vprint_length
= old_length
;
1067 Vinhibit_quit
= Qnil
;
1069 return make_number (0);
1072 /* Take actions on handling an error. DATA is the data that describes
1075 CONTEXT is a C-string containing ASCII characters only which
1076 describes the context in which the error happened. If we need to
1077 generalize CONTEXT to allow multibyte characters, make it a Lisp
1081 cmd_error_internal (Lisp_Object data
, const char *context
)
1083 /* The immediate context is not interesting for Quits,
1084 since they are asynchronous. */
1085 if (EQ (XCAR (data
), Qquit
))
1086 Vsignaling_function
= Qnil
;
1091 /* Use user's specified output function if any. */
1092 if (!NILP (Vcommand_error_function
))
1093 call3 (Vcommand_error_function
, data
,
1094 context
? build_string (context
) : empty_unibyte_string
,
1095 Vsignaling_function
);
1097 Vsignaling_function
= Qnil
;
1100 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1101 Scommand_error_default_function
, 3, 3, 0,
1102 doc
: /* Produce default output for unhandled error message.
1103 Default value of `command-error-function'. */)
1104 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1106 struct frame
*sf
= SELECTED_FRAME ();
1108 CHECK_STRING (context
);
1110 /* If the window system or terminal frame hasn't been initialized
1111 yet, or we're not interactive, write the message to stderr and exit. */
1112 if (!sf
->glyphs_initialized_p
1113 /* The initial frame is a special non-displaying frame. It
1114 will be current in daemon mode when there are no frames
1115 to display, and in non-daemon mode before the real frame
1116 has finished initializing. If an error is thrown in the
1117 latter case while creating the frame, then the frame
1118 will never be displayed, so the safest thing to do is
1119 write to stderr and quit. In daemon mode, there are
1120 many other potential errors that do not prevent frames
1121 from being created, so continuing as normal is better in
1123 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1126 print_error_message (data
, Qexternal_debugging_output
,
1127 SSDATA (context
), signal
);
1128 Fterpri (Qexternal_debugging_output
);
1129 Fkill_emacs (make_number (-1));
1133 clear_message (1, 0);
1135 message_log_maybe_newline ();
1138 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1143 static Lisp_Object
command_loop_2 (Lisp_Object
);
1144 static Lisp_Object
top_level_1 (Lisp_Object
);
1146 /* Entry to editor-command-loop.
1147 This level has the catches for exiting/returning to editor command loop.
1148 It returns nil to exit recursive edit, t to abort it. */
1153 #ifdef HAVE_STACK_OVERFLOW_HANDLING
1154 /* At least on GNU/Linux, saving signal mask is important here. */
1155 if (sigsetjmp (return_to_command_loop
, 1) != 0)
1157 /* Comes here from handle_sigsegv, see sysdep.c. */
1159 Vinternal__top_level_message
= recover_top_level_message
;
1162 Vinternal__top_level_message
= regular_top_level_message
;
1163 #endif /* HAVE_STACK_OVERFLOW_HANDLING */
1164 if (command_loop_level
> 0 || minibuf_level
> 0)
1167 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1168 executing_kbd_macro
= Qnil
;
1174 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1175 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1176 executing_kbd_macro
= Qnil
;
1178 /* End of file in -batch run causes exit here. */
1184 /* Here we catch errors in execution of commands within the
1185 editing loop, and reenter the editing loop.
1186 When there is an error, cmd_error runs and returns a non-nil
1187 value to us. A value of nil means that command_loop_1 itself
1188 returned due to end of file (or end of kbd macro). */
1191 command_loop_2 (Lisp_Object ignore
)
1193 register Lisp_Object val
;
1196 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1197 while (!NILP (val
));
1205 return Feval (Vtop_level
, Qnil
);
1209 top_level_1 (Lisp_Object ignore
)
1211 /* On entry to the outer level, run the startup file. */
1212 if (!NILP (Vtop_level
))
1213 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1214 else if (!NILP (Vpurify_flag
))
1215 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1217 message1 ("Bare Emacs (standard Lisp code not loaded)");
1221 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1222 doc
: /* Exit all recursive editing levels.
1223 This also exits all active minibuffers. */)
1226 #ifdef HAVE_WINDOW_SYSTEM
1227 if (display_hourglass_p
)
1228 cancel_hourglass ();
1231 /* Unblock input if we enter with input blocked. This may happen if
1232 redisplay traps e.g. during tool-bar update with input blocked. */
1233 totally_unblock_input ();
1235 Fthrow (Qtop_level
, Qnil
);
1238 static _Noreturn
void
1239 user_error (const char *msg
)
1241 xsignal1 (Quser_error
, build_string (msg
));
1244 /* _Noreturn will be added to prototype by make-docfile. */
1245 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1246 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1249 if (command_loop_level
> 0 || minibuf_level
> 0)
1250 Fthrow (Qexit
, Qnil
);
1252 user_error ("No recursive edit is in progress");
1255 /* _Noreturn will be added to prototype by make-docfile. */
1256 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1257 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1260 if (command_loop_level
> 0 || minibuf_level
> 0)
1263 user_error ("No recursive edit is in progress");
1266 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1267 of this function. */
1270 tracking_off (Lisp_Object old_value
)
1272 do_mouse_tracking
= old_value
;
1273 if (NILP (old_value
))
1275 /* Redisplay may have been preempted because there was input
1276 available, and it assumes it will be called again after the
1277 input has been processed. If the only input available was
1278 the sort that we have just disabled, then we need to call
1280 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1282 redisplay_preserve_echo_area (6);
1283 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1288 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1289 doc
: /* Evaluate BODY with mouse movement events enabled.
1290 Within a `track-mouse' form, mouse motion generates input events that
1291 you can read with `read-event'.
1292 Normally, mouse motion is ignored.
1293 usage: (track-mouse BODY...) */)
1296 ptrdiff_t count
= SPECPDL_INDEX ();
1299 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1301 do_mouse_tracking
= Qt
;
1303 val
= Fprogn (args
);
1304 return unbind_to (count
, val
);
1307 /* If mouse has moved on some frame, return one of those frames.
1311 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1312 after resizing the tool-bar window. */
1314 bool ignore_mouse_drag_p
;
1316 static struct frame
*
1317 some_mouse_moved (void)
1319 Lisp_Object tail
, frame
;
1321 if (ignore_mouse_drag_p
)
1323 /* ignore_mouse_drag_p = 0; */
1327 FOR_EACH_FRAME (tail
, frame
)
1329 if (XFRAME (frame
)->mouse_moved
)
1330 return XFRAME (frame
);
1337 /* This is the actual command reading loop,
1338 sans error-handling encapsulation. */
1340 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1341 bool, bool, bool, bool);
1342 static void adjust_point_for_property (ptrdiff_t, bool);
1344 /* The last boundary auto-added to buffer-undo-list. */
1345 Lisp_Object last_undo_boundary
;
1347 /* FIXME: This is wrong rather than test window-system, we should call
1348 a new set-selection, which will then dispatch to x-set-selection, or
1349 tty-set-selection, or w32-set-selection, ... */
1352 command_loop_1 (void)
1355 Lisp_Object keybuf
[30];
1357 EMACS_INT prev_modiff
= 0;
1358 struct buffer
*prev_buffer
= NULL
;
1359 bool already_adjusted
= 0;
1361 kset_prefix_arg (current_kboard
, Qnil
);
1362 kset_last_prefix_arg (current_kboard
, Qnil
);
1363 Vdeactivate_mark
= Qnil
;
1364 waiting_for_input
= 0;
1367 this_command_key_count
= 0;
1368 this_command_key_count_reset
= 0;
1369 this_single_command_key_start
= 0;
1371 if (NILP (Vmemory_full
))
1373 /* Make sure this hook runs after commands that get errors and
1374 throw to top level. */
1375 /* Note that the value cell will never directly contain nil
1376 if the symbol is a local variable. */
1377 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1378 safe_run_hooks (Qpost_command_hook
);
1380 /* If displaying a message, resize the echo area window to fit
1381 that message's size exactly. */
1382 if (!NILP (echo_area_buffer
[0]))
1383 resize_echo_area_exactly ();
1385 /* If there are warnings waiting, process them. */
1386 if (!NILP (Vdelayed_warnings_list
))
1387 safe_run_hooks (Qdelayed_warnings_hook
);
1389 if (!NILP (Vdeferred_action_list
))
1390 safe_run_hooks (Qdeferred_action_function
);
1393 /* Do this after running Vpost_command_hook, for consistency. */
1394 kset_last_command (current_kboard
, Vthis_command
);
1395 kset_real_last_command (current_kboard
, Vreal_this_command
);
1396 if (!CONSP (last_command_event
))
1397 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1401 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1404 /* Make sure the current window's buffer is selected. */
1405 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1407 /* Display any malloc warning that just came out. Use while because
1408 displaying one warning can cause another. */
1410 while (pending_malloc_warning
)
1411 display_malloc_warning ();
1413 Vdeactivate_mark
= Qnil
;
1415 /* Don't ignore mouse movements for more than a single command
1416 loop. (This flag is set in xdisp.c whenever the tool bar is
1417 resized, because the resize moves text up or down, and would
1418 generate false mouse drag events if we don't ignore them.) */
1419 ignore_mouse_drag_p
= 0;
1421 /* If minibuffer on and echo area in use,
1422 wait a short time and redraw minibuffer. */
1425 && !NILP (echo_area_buffer
[0])
1426 && EQ (minibuf_window
, echo_area_window
)
1427 && NUMBERP (Vminibuffer_message_timeout
))
1429 /* Bind inhibit-quit to t so that C-g gets read in
1430 rather than quitting back to the minibuffer. */
1431 ptrdiff_t count
= SPECPDL_INDEX ();
1432 specbind (Qinhibit_quit
, Qt
);
1434 sit_for (Vminibuffer_message_timeout
, 0, 2);
1436 /* Clear the echo area. */
1438 safe_run_hooks (Qecho_area_clear_hook
);
1440 unbind_to (count
, Qnil
);
1442 /* If a C-g came in before, treat it as input now. */
1443 if (!NILP (Vquit_flag
))
1446 Vunread_command_events
= list1 (make_number (quit_char
));
1450 /* If it has changed current-menubar from previous value,
1451 really recompute the menubar from the value. */
1452 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1453 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1454 call0 (Qrecompute_lucid_menubar
);
1456 before_command_key_count
= this_command_key_count
;
1457 before_command_echo_length
= echo_length ();
1459 Vthis_command
= Qnil
;
1460 Vreal_this_command
= Qnil
;
1461 Vthis_original_command
= Qnil
;
1462 Vthis_command_keys_shift_translated
= Qnil
;
1464 /* Read next key sequence; i gets its length. */
1465 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1468 /* A filter may have run while we were reading the input. */
1469 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1471 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1475 /* Now we have read a key sequence of length I,
1476 or else I is 0 and we found end of file. */
1478 if (i
== 0) /* End of file -- happens only in */
1479 return Qnil
; /* a kbd macro, at the end. */
1480 /* -1 means read_key_sequence got a menu that was rejected.
1481 Just loop around and read another command. */
1485 this_command_key_count
= 0;
1486 this_command_key_count_reset
= 0;
1487 this_single_command_key_start
= 0;
1491 last_command_event
= keybuf
[i
- 1];
1493 /* If the previous command tried to force a specific window-start,
1494 forget about that, in case this command moves point far away
1495 from that position. But also throw away beg_unchanged and
1496 end_unchanged information in that case, so that redisplay will
1497 update the whole window properly. */
1498 if (XWINDOW (selected_window
)->force_start
)
1501 XWINDOW (selected_window
)->force_start
= 0;
1502 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1503 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1506 cmd
= read_key_sequence_cmd
;
1507 if (!NILP (Vexecuting_kbd_macro
))
1509 if (!NILP (Vquit_flag
))
1511 Vexecuting_kbd_macro
= Qt
;
1512 QUIT
; /* Make some noise. */
1513 /* Will return since macro now empty. */
1517 /* Do redisplay processing after this command except in special
1518 cases identified below. */
1519 prev_buffer
= current_buffer
;
1520 prev_modiff
= MODIFF
;
1521 last_point_position
= PT
;
1523 /* By default, we adjust point to a boundary of a region that
1524 has such a property that should be treated intangible
1525 (e.g. composition, display). But, some commands will set
1526 this variable differently. */
1527 Vdisable_point_adjustment
= Qnil
;
1529 /* Process filters and timers may have messed with deactivate-mark.
1530 reset it before we execute the command. */
1531 Vdeactivate_mark
= Qnil
;
1533 /* Remap command through active keymaps. */
1534 Vthis_original_command
= cmd
;
1535 if (!NILP (read_key_sequence_remapped
))
1536 cmd
= read_key_sequence_remapped
;
1538 /* Execute the command. */
1540 Vthis_command
= cmd
;
1541 Vreal_this_command
= cmd
;
1542 safe_run_hooks (Qpre_command_hook
);
1544 already_adjusted
= 0;
1546 if (NILP (Vthis_command
))
1547 /* nil means key is undefined. */
1551 /* Here for a command that isn't executed directly. */
1553 #ifdef HAVE_WINDOW_SYSTEM
1554 ptrdiff_t scount
= SPECPDL_INDEX ();
1556 if (display_hourglass_p
1557 && NILP (Vexecuting_kbd_macro
))
1559 record_unwind_protect_void (cancel_hourglass
);
1564 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1566 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1569 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1570 ? Qnil
: BVAR (current_buffer
, undo_list
));
1572 call1 (Qcommand_execute
, Vthis_command
);
1574 #ifdef HAVE_WINDOW_SYSTEM
1575 /* Do not check display_hourglass_p here, because
1576 `command-execute' could change it, but we should cancel
1577 hourglass cursor anyway.
1578 But don't cancel the hourglass within a macro
1579 just because a command in the macro finishes. */
1580 if (NILP (Vexecuting_kbd_macro
))
1581 unbind_to (scount
, Qnil
);
1584 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1586 safe_run_hooks (Qpost_command_hook
);
1588 /* If displaying a message, resize the echo area window to fit
1589 that message's size exactly. */
1590 if (!NILP (echo_area_buffer
[0]))
1591 resize_echo_area_exactly ();
1593 /* If there are warnings waiting, process them. */
1594 if (!NILP (Vdelayed_warnings_list
))
1595 safe_run_hooks (Qdelayed_warnings_hook
);
1597 safe_run_hooks (Qdeferred_action_function
);
1599 /* If there is a prefix argument,
1600 1) We don't want Vlast_command to be ``universal-argument''
1601 (that would be dumb), so don't set Vlast_command,
1602 2) we want to leave echoing on so that the prefix will be
1603 echoed as part of this key sequence, so don't call
1605 3) we want to leave this_command_key_count non-zero, so that
1606 read_char will realize that it is re-reading a character, and
1607 not echo it a second time.
1609 If the command didn't actually create a prefix arg,
1610 but is merely a frame event that is transparent to prefix args,
1611 then the above doesn't apply. */
1612 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1613 || CONSP (last_command_event
))
1615 kset_last_command (current_kboard
, Vthis_command
);
1616 kset_real_last_command (current_kboard
, Vreal_this_command
);
1617 if (!CONSP (last_command_event
))
1618 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1620 this_command_key_count
= 0;
1621 this_command_key_count_reset
= 0;
1622 this_single_command_key_start
= 0;
1625 if (!NILP (BVAR (current_buffer
, mark_active
))
1626 && !NILP (Vrun_hooks
))
1628 /* In Emacs 22, setting transient-mark-mode to `only' was a
1629 way of turning it on for just one command. This usage is
1630 obsolete, but support it anyway. */
1631 if (EQ (Vtransient_mark_mode
, Qidentity
))
1632 Vtransient_mark_mode
= Qnil
;
1633 else if (EQ (Vtransient_mark_mode
, Qonly
))
1634 Vtransient_mark_mode
= Qidentity
;
1636 if (!NILP (Vdeactivate_mark
))
1637 /* If `select-active-regions' is non-nil, this call to
1638 `deactivate-mark' also sets the PRIMARY selection. */
1639 call0 (Qdeactivate_mark
);
1642 /* Even if not deactivating the mark, set PRIMARY if
1643 `select-active-regions' is non-nil. */
1644 if (!NILP (Fwindow_system (Qnil
))
1645 /* Even if mark_active is non-nil, the actual buffer
1646 marker may not have been set yet (Bug#7044). */
1647 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1648 && (EQ (Vselect_active_regions
, Qonly
)
1649 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1650 : (!NILP (Vselect_active_regions
)
1651 && !NILP (Vtransient_mark_mode
)))
1652 && NILP (Fmemq (Vthis_command
,
1653 Vselection_inhibit_update_commands
)))
1656 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1657 if (XINT (Flength (txt
)) > 0)
1658 /* Don't set empty selections. */
1659 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1662 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1664 Lisp_Object hook
= intern ("activate-mark-hook");
1665 Frun_hooks (1, &hook
);
1669 Vsaved_region_selection
= Qnil
;
1674 if (current_buffer
== prev_buffer
1675 && last_point_position
!= PT
1676 && NILP (Vdisable_point_adjustment
)
1677 && NILP (Vglobal_disable_point_adjustment
))
1679 if (last_point_position
> BEGV
1680 && last_point_position
< ZV
1681 && (composition_adjust_point (last_point_position
,
1682 last_point_position
)
1683 != last_point_position
))
1684 /* The last point was temporarily set within a grapheme
1685 cluster to prevent automatic composition. To recover
1686 the automatic composition, we must update the
1688 windows_or_buffers_changed
= 21;
1689 if (!already_adjusted
)
1690 adjust_point_for_property (last_point_position
,
1691 MODIFF
!= prev_modiff
);
1694 /* Install chars successfully executed in kbd macro. */
1696 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1697 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1698 finalize_kbd_macro_chars ();
1703 read_menu_command (void)
1705 Lisp_Object keybuf
[30];
1706 ptrdiff_t count
= SPECPDL_INDEX ();
1709 /* We don't want to echo the keystrokes while navigating the
1711 specbind (Qecho_keystrokes
, make_number (0));
1713 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1716 unbind_to (count
, Qnil
);
1718 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1720 if (i
== 0 || i
== -1)
1723 return read_key_sequence_cmd
;
1726 /* Adjust point to a boundary of a region that has such a property
1727 that should be treated intangible. For the moment, we check
1728 `composition', `display' and `invisible' properties.
1729 LAST_PT is the last position of point. */
1732 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1735 Lisp_Object val
, overlay
, tmp
;
1736 /* When called after buffer modification, we should temporarily
1737 suppress the point adjustment for automatic composition so that a
1738 user can keep inserting another character at point or keep
1739 deleting characters around point. */
1740 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1741 ptrdiff_t orig_pt
= PT
;
1743 /* FIXME: cycling is probably not necessary because these properties
1744 can't be usefully combined anyway. */
1745 while (check_composition
|| check_display
|| check_invisible
)
1747 /* FIXME: check `intangible'. */
1748 if (check_composition
1749 && PT
> BEGV
&& PT
< ZV
1750 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1753 check_display
= check_invisible
= 1;
1755 check_composition
= 0;
1757 && PT
> BEGV
&& PT
< ZV
1758 && !NILP (val
= get_char_property_and_overlay
1759 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1760 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1761 && (!OVERLAYP (overlay
)
1762 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1763 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1764 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1765 && (beg
< PT
/* && end > PT <- It's always the case. */
1766 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1769 SET_PT (PT
< last_pt
1770 ? (STRINGP (val
) && SCHARS (val
) == 0
1771 ? max (beg
- 1, BEGV
)
1774 check_composition
= check_invisible
= 1;
1777 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1783 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1786 /* FIXME: We should stop if we find a spot between
1787 two runs of `invisible' where inserted text would
1788 be visible. This is important when we have two
1789 invisible boundaries that enclose an area: if the
1790 area is empty, we need this test in order to make
1791 it possible to place point in the middle rather
1792 than skip both boundaries. However, this code
1793 also stops anywhere in a non-sticky text-property,
1794 which breaks (e.g.) Org mode. */
1795 && (val
= Fget_pos_property (make_number (end
),
1797 TEXT_PROP_MEANS_INVISIBLE (val
))
1799 && !NILP (val
= get_char_property_and_overlay
1800 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1801 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1803 ellipsis
= ellipsis
|| inv
> 1
1804 || (OVERLAYP (overlay
)
1805 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1806 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1807 tmp
= Fnext_single_char_property_change
1808 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1809 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1813 && (val
= Fget_pos_property (make_number (beg
),
1815 TEXT_PROP_MEANS_INVISIBLE (val
))
1817 && !NILP (val
= get_char_property_and_overlay
1818 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1819 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1821 ellipsis
= ellipsis
|| inv
> 1
1822 || (OVERLAYP (overlay
)
1823 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1824 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1825 tmp
= Fprevious_single_char_property_change
1826 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1827 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1830 /* Move away from the inside area. */
1831 if (beg
< PT
&& end
> PT
)
1833 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1834 /* We haven't moved yet (so we don't need to fear
1835 infinite-looping) and we were outside the range
1836 before (so either end of the range still corresponds
1837 to a move in the right direction): pretend we moved
1838 less than we actually did, so that we still have
1839 more freedom below in choosing which end of the range
1841 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1842 /* We either have moved already or the last point
1843 was already in the range: we don't get to choose
1844 which end of the range we have to go to. */
1845 : (PT
< last_pt
? beg
: end
));
1846 check_composition
= check_display
= 1;
1848 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1849 the point to something other than its argument, due to
1850 point-motion hooks, intangibility, etc. */
1851 eassert (PT
== beg
|| PT
== end
);
1854 /* Pretend the area doesn't exist if the buffer is not
1856 if (!modified
&& !ellipsis
&& beg
< end
)
1858 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1859 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1860 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1861 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1862 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1863 /* We've already moved as far as we can. Trying to go
1864 to the other end would mean moving backwards and thus
1865 could lead to an infinite loop. */
1867 else if (val
= Fget_pos_property (make_number (PT
),
1869 TEXT_PROP_MEANS_INVISIBLE (val
)
1870 && (val
= (Fget_pos_property
1871 (make_number (PT
== beg
? end
: beg
),
1873 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1874 (check_composition
= check_display
= 1,
1875 SET_PT (PT
== beg
? end
: beg
));
1878 check_invisible
= 0;
1882 /* Subroutine for safe_run_hooks: run the hook, which is ARGS[1]. */
1885 safe_run_hooks_1 (ptrdiff_t nargs
, Lisp_Object
*args
)
1887 eassert (nargs
== 2);
1888 return call0 (args
[1]);
1891 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1895 safe_run_hooks_error (Lisp_Object error
, ptrdiff_t nargs
, Lisp_Object
*args
)
1897 Lisp_Object hook
, fun
, msgargs
[4];
1899 eassert (nargs
== 2);
1902 msgargs
[0] = build_string ("Error in %s (%S): %S");
1906 Fmessage (4, msgargs
);
1912 Lisp_Object newval
= Qnil
;
1913 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1914 if (EQ (fun
, XCAR (val
)))
1917 newval
= Fcons (XCAR (val
), newval
);
1919 return Fset (hook
, Fnreverse (newval
));
1920 /* Not found in the local part of the hook. Let's look at the global
1923 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1924 : Fdefault_value (hook
));
1925 CONSP (val
); val
= XCDR (val
))
1926 if (EQ (fun
, XCAR (val
)))
1929 newval
= Fcons (XCAR (val
), newval
);
1931 return Fset_default (hook
, Fnreverse (newval
));
1937 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1939 Lisp_Object iargs
[2];
1941 eassert (nargs
== 2);
1942 /* Yes, run_hook_with_args works this way. */
1945 internal_condition_case_n (safe_run_hooks_1
, 2, iargs
,
1946 Qt
, safe_run_hooks_error
);
1950 /* If we get an error while running the hook, cause the hook variable
1951 to be nil. Also inhibit quits, so that C-g won't cause the hook
1952 to mysteriously evaporate. */
1955 safe_run_hooks (Lisp_Object hook
)
1957 Lisp_Object args
[2];
1958 struct gcpro gcpro1
;
1959 ptrdiff_t count
= SPECPDL_INDEX ();
1965 specbind (Qinhibit_quit
, Qt
);
1966 run_hook_with_args (2, args
, safe_run_hook_funcall
);
1967 unbind_to (count
, Qnil
);
1972 /* Nonzero means polling for input is temporarily suppressed. */
1974 int poll_suppress_count
;
1977 #ifdef POLL_FOR_INPUT
1979 /* Asynchronous timer for polling. */
1981 static struct atimer
*poll_timer
;
1983 /* Poll for input, so that we catch a C-g if it comes in. */
1985 poll_for_input_1 (void)
1987 if (! input_blocked_p ()
1988 && !waiting_for_input
)
1992 /* Timer callback function for poll_timer. TIMER is equal to
1996 poll_for_input (struct atimer
*timer
)
1998 if (poll_suppress_count
== 0)
1999 pending_signals
= 1;
2002 #endif /* POLL_FOR_INPUT */
2004 /* Begin signals to poll for input, if they are appropriate.
2005 This function is called unconditionally from various places. */
2008 start_polling (void)
2010 #ifdef POLL_FOR_INPUT
2011 /* XXX This condition was (read_socket_hook && !interrupt_input),
2012 but read_socket_hook is not global anymore. Let's pretend that
2014 if (!interrupt_input
)
2016 /* Turn alarm handling on unconditionally. It might have
2017 been turned off in process.c. */
2018 turn_on_atimers (1);
2020 /* If poll timer doesn't exist, or we need one with
2021 a different interval, start a new one. */
2022 if (poll_timer
== NULL
2023 || poll_timer
->interval
.tv_sec
!= polling_period
)
2025 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2026 struct timespec interval
= make_timespec (period
, 0);
2029 cancel_atimer (poll_timer
);
2031 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2032 poll_for_input
, NULL
);
2035 /* Let the timer's callback function poll for input
2036 if this becomes zero. */
2037 --poll_suppress_count
;
2042 /* True if we are using polling to handle input asynchronously. */
2045 input_polling_used (void)
2047 #ifdef POLL_FOR_INPUT
2048 /* XXX This condition was (read_socket_hook && !interrupt_input),
2049 but read_socket_hook is not global anymore. Let's pretend that
2051 return !interrupt_input
;
2057 /* Turn off polling. */
2062 #ifdef POLL_FOR_INPUT
2063 /* XXX This condition was (read_socket_hook && !interrupt_input),
2064 but read_socket_hook is not global anymore. Let's pretend that
2066 if (!interrupt_input
)
2067 ++poll_suppress_count
;
2071 /* Set the value of poll_suppress_count to COUNT
2072 and start or stop polling accordingly. */
2075 set_poll_suppress_count (int count
)
2077 #ifdef POLL_FOR_INPUT
2078 if (count
== 0 && poll_suppress_count
!= 0)
2080 poll_suppress_count
= 1;
2083 else if (count
!= 0 && poll_suppress_count
== 0)
2087 poll_suppress_count
= count
;
2091 /* Bind polling_period to a value at least N.
2092 But don't decrease it. */
2095 bind_polling_period (int n
)
2097 #ifdef POLL_FOR_INPUT
2098 EMACS_INT
new = polling_period
;
2103 stop_other_atimers (poll_timer
);
2105 specbind (Qpolling_period
, make_number (new));
2106 /* Start a new alarm with the new period. */
2111 /* Apply the control modifier to CHARACTER. */
2114 make_ctrl_char (int c
)
2116 /* Save the upper bits here. */
2117 int upper
= c
& ~0177;
2119 if (! ASCII_CHAR_P (c
))
2120 return c
|= ctrl_modifier
;
2124 /* Everything in the columns containing the upper-case letters
2125 denotes a control character. */
2126 if (c
>= 0100 && c
< 0140)
2130 /* Set the shift modifier for a control char
2131 made from a shifted letter. But only for letters! */
2132 if (oc
>= 'A' && oc
<= 'Z')
2133 c
|= shift_modifier
;
2136 /* The lower-case letters denote control characters too. */
2137 else if (c
>= 'a' && c
<= 'z')
2140 /* Include the bits for control and shift
2141 only if the basic ASCII code can't indicate them. */
2145 /* Replace the high bits. */
2146 c
|= (upper
& ~ctrl_modifier
);
2151 /* Display the help-echo property of the character after the mouse pointer.
2152 Either show it in the echo area, or call show-help-function to display
2153 it by other means (maybe in a tooltip).
2155 If HELP is nil, that means clear the previous help echo.
2157 If HELP is a string, display that string. If HELP is a function,
2158 call it with OBJECT and POS as arguments; the function should
2159 return a help string or nil for none. For all other types of HELP,
2160 evaluate it to obtain a string.
2162 WINDOW is the window in which the help was generated, if any.
2163 It is nil if not in a window.
2165 If OBJECT is a buffer, POS is the position in the buffer where the
2166 `help-echo' text property was found.
2168 If OBJECT is an overlay, that overlay has a `help-echo' property,
2169 and POS is the position in the overlay's buffer under the mouse.
2171 If OBJECT is a string (an overlay string or a string displayed with
2172 the `display' property). POS is the position in that string under
2175 Note: this function may only be called with HELP nil or a string
2176 from X code running asynchronously. */
2179 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2182 if (!NILP (help
) && !STRINGP (help
))
2184 if (FUNCTIONP (help
))
2185 help
= safe_call (4, help
, window
, object
, pos
);
2187 help
= safe_eval (help
);
2189 if (!STRINGP (help
))
2193 if (!noninteractive
&& STRINGP (help
))
2195 /* The mouse-fixup-help-message Lisp function can call
2196 mouse_position_hook, which resets the mouse_moved flags.
2197 This causes trouble if we are trying to read a mouse motion
2198 event (i.e., if we are inside a `track-mouse' form), so we
2199 restore the mouse_moved flag. */
2200 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2201 help
= call1 (Qmouse_fixup_help_message
, help
);
2206 if (STRINGP (help
) || NILP (help
))
2208 if (!NILP (Vshow_help_function
))
2209 call1 (Vshow_help_function
, help
);
2210 help_echo_showing_p
= STRINGP (help
);
2216 /* Input of single characters from keyboard. */
2218 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2219 struct timespec
*end_time
);
2220 static void record_char (Lisp_Object c
);
2222 static Lisp_Object help_form_saved_window_configs
;
2224 read_char_help_form_unwind (void)
2226 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2227 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2228 if (!NILP (window_config
))
2229 Fset_window_configuration (window_config
);
2232 #define STOP_POLLING \
2233 do { if (! polling_stopped_here) stop_polling (); \
2234 polling_stopped_here = 1; } while (0)
2236 #define RESUME_POLLING \
2237 do { if (polling_stopped_here) start_polling (); \
2238 polling_stopped_here = 0; } while (0)
2241 read_event_from_main_queue (struct timespec
*end_time
,
2242 sys_jmp_buf local_getcjmp
,
2243 bool *used_mouse_menu
)
2245 Lisp_Object c
= Qnil
;
2246 sys_jmp_buf save_jump
;
2247 KBOARD
*kb
IF_LINT (= NULL
);
2251 /* Read from the main queue, and if that gives us something we can't use yet,
2252 we put it on the appropriate side queue and try again. */
2254 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2257 /* Actually read a character, waiting if necessary. */
2258 save_getcjmp (save_jump
);
2259 restore_getcjmp (local_getcjmp
);
2261 timer_start_idle ();
2262 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2263 restore_getcjmp (save_jump
);
2265 if (! NILP (c
) && (kb
!= current_kboard
))
2267 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2270 while (CONSP (XCDR (last
)))
2272 if (!NILP (XCDR (last
)))
2276 kset_kbd_queue (kb
, list1 (c
));
2278 XSETCDR (last
, list1 (c
));
2279 kb
->kbd_queue_has_data
= 1;
2283 current_kboard
= kb
;
2284 /* This is going to exit from read_char
2285 so we had better get rid of this frame's stuff. */
2286 return make_number (-2);
2289 /* Terminate Emacs in batch mode if at eof. */
2290 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2291 Fkill_emacs (make_number (1));
2295 /* Add in any extra modifiers, where appropriate. */
2296 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2297 || ((extra_keyboard_modifiers
& 0177) < ' '
2298 && (extra_keyboard_modifiers
& 0177) != 0))
2299 XSETINT (c
, make_ctrl_char (XINT (c
)));
2301 /* Transfer any other modifier bits directly from
2302 extra_keyboard_modifiers to c. Ignore the actual character code
2303 in the low 16 bits of extra_keyboard_modifiers. */
2304 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2312 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2315 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2316 sys_jmp_buf local_getcjmp
,
2317 Lisp_Object prev_event
,
2318 bool *used_mouse_menu
)
2320 #define MAX_ENCODED_BYTES 16
2322 Lisp_Object events
[MAX_ENCODED_BYTES
];
2328 = read_event_from_main_queue (end_time
, local_getcjmp
,
2331 /* w32_console already returns decoded events. It either reads
2332 Unicode characters from the Windows keyboard input, or
2333 converts characters encoded in the current codepage into
2334 Unicode. See w32inevt.c:key_event, near its end. */
2337 struct frame
*frame
= XFRAME (selected_frame
);
2338 struct terminal
*terminal
= frame
->terminal
;
2339 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2340 /* Don't apply decoding if we're just reading a raw event
2341 (e.g. reading bytes sent by the xterm to specify the position
2342 of a mouse click). */
2343 && (!EQ (prev_event
, Qt
))
2344 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2345 & CODING_REQUIRE_DECODING_MASK
)))
2346 return nextevt
; /* No decoding needed. */
2349 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2350 eassert (n
< MAX_ENCODED_BYTES
);
2351 events
[n
++] = nextevt
;
2352 if (NATNUMP (nextevt
)
2353 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2354 { /* An encoded byte sequence, let's try to decode it. */
2355 struct coding_system
*coding
2356 = TERMINAL_KEYBOARD_CODING (terminal
);
2357 unsigned char src
[MAX_ENCODED_BYTES
];
2358 unsigned char dest
[4 * sizeof src
];
2360 for (i
= 0; i
< n
; i
++)
2361 src
[i
] = XINT (events
[i
]);
2363 for (i
= 0; i
< n
; i
++)
2365 coding
->destination
= dest
;
2366 coding
->dst_bytes
= n
* 4;
2367 decode_coding_c_string (coding
, src
, n
, Qnil
);
2368 eassert (coding
->produced_char
<= n
);
2369 if (coding
->produced_char
== 0)
2370 { /* The encoded sequence is incomplete. */
2371 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2372 continue; /* Read on! */
2376 const unsigned char *p
= coding
->destination
;
2377 eassert (coding
->carryover_bytes
== 0);
2379 while (n
< coding
->produced_char
)
2380 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2383 /* Now `events' should hold decoded events.
2384 Normally, n should be equal to 1, but better not rely on it.
2385 We can only return one event here, so return the first we
2386 had and keep the others (if any) for later. */
2388 Vunread_command_events
2389 = Fcons (events
[--n
], Vunread_command_events
);
2397 echo_keystrokes_p (void)
2399 return (FLOATP (Vecho_keystrokes
) ? XFLOAT_DATA (Vecho_keystrokes
) > 0.0
2400 : INTEGERP (Vecho_keystrokes
) ? XINT (Vecho_keystrokes
) > 0 : false);
2403 /* Read a character from the keyboard; call the redisplay if needed. */
2404 /* commandflag 0 means do not autosave, but do redisplay.
2405 -1 means do not redisplay, but do autosave.
2406 -2 means do neither.
2409 /* The argument MAP is a keymap for menu prompting.
2411 PREV_EVENT is the previous input event, or nil if we are reading
2412 the first event of a key sequence (or not reading a key sequence).
2413 If PREV_EVENT is t, that is a "magic" value that says
2414 not to run input methods, but in other respects to act as if
2415 not reading a key sequence.
2417 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2418 if we used a mouse menu to read the input, or false otherwise. If
2419 USED_MOUSE_MENU is null, don't dereference it.
2421 Value is -2 when we find input on another keyboard. A second call
2422 to read_char will read it.
2424 If END_TIME is non-null, it is a pointer to a struct timespec
2425 specifying the maximum time to wait until. If no input arrives by
2426 that time, stop waiting and return nil.
2428 Value is t if we showed a menu and the user rejected it. */
2431 read_char (int commandflag
, Lisp_Object map
,
2432 Lisp_Object prev_event
,
2433 bool *used_mouse_menu
, struct timespec
*end_time
)
2437 sys_jmp_buf local_getcjmp
;
2438 sys_jmp_buf save_jump
;
2439 Lisp_Object tem
, save
;
2440 volatile Lisp_Object previous_echo_area_message
;
2441 volatile Lisp_Object also_record
;
2442 volatile bool reread
;
2443 struct gcpro gcpro1
, gcpro2
;
2444 bool volatile polling_stopped_here
= 0;
2445 struct kboard
*orig_kboard
= current_kboard
;
2449 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2450 before_command_key_count
= this_command_key_count
;
2451 before_command_echo_length
= echo_length ();
2454 previous_echo_area_message
= Qnil
;
2456 GCPRO2 (c
, previous_echo_area_message
);
2460 if (CONSP (Vunread_post_input_method_events
))
2462 c
= XCAR (Vunread_post_input_method_events
);
2463 Vunread_post_input_method_events
2464 = XCDR (Vunread_post_input_method_events
);
2466 /* Undo what read_char_x_menu_prompt did when it unread
2467 additional keys returned by Fx_popup_menu. */
2469 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2480 if (CONSP (Vunread_command_events
))
2482 bool was_disabled
= 0;
2484 c
= XCAR (Vunread_command_events
);
2485 Vunread_command_events
= XCDR (Vunread_command_events
);
2487 /* Undo what sit-for did when it unread additional keys
2488 inside universal-argument. */
2490 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2495 /* Undo what read_char_x_menu_prompt did when it unread
2496 additional keys returned by Fx_popup_menu. */
2498 && EQ (XCDR (c
), Qdisabled
)
2499 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2505 /* If the queued event is something that used the mouse,
2506 set used_mouse_menu accordingly. */
2508 /* Also check was_disabled so last-nonmenu-event won't return
2509 a bad value when submenus are involved. (Bug#447) */
2510 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2511 *used_mouse_menu
= 1;
2513 goto reread_for_input_method
;
2516 if (CONSP (Vunread_input_method_events
))
2518 c
= XCAR (Vunread_input_method_events
);
2519 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2521 /* Undo what read_char_x_menu_prompt did when it unread
2522 additional keys returned by Fx_popup_menu. */
2524 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2528 goto reread_for_input_method
;
2531 this_command_key_count_reset
= 0;
2533 if (!NILP (Vexecuting_kbd_macro
))
2535 /* We set this to Qmacro; since that's not a frame, nobody will
2536 try to switch frames on us, and the selected window will
2539 Since this event came from a macro, it would be misleading to
2540 leave internal_last_event_frame set to wherever the last
2541 real event came from. Normally, a switch-frame event selects
2542 internal_last_event_frame after each command is read, but
2543 events read from a macro should never cause a new frame to be
2545 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2547 /* Exit the macro if we are at the end.
2548 Also, some things replace the macro with t
2549 to force an early exit. */
2550 if (EQ (Vexecuting_kbd_macro
, Qt
)
2551 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2557 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2558 if (STRINGP (Vexecuting_kbd_macro
)
2559 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2560 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2562 executing_kbd_macro_index
++;
2567 if (!NILP (unread_switch_frame
))
2569 c
= unread_switch_frame
;
2570 unread_switch_frame
= Qnil
;
2572 /* This event should make it into this_command_keys, and get echoed
2573 again, so we do not set `reread'. */
2577 /* If redisplay was requested. */
2578 if (commandflag
>= 0)
2580 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2582 /* If there is pending input, process any events which are not
2583 user-visible, such as X selection_request events. */
2585 || detect_input_pending_run_timers (0))
2586 swallow_events (0); /* May clear input_pending. */
2588 /* Redisplay if no pending input. */
2589 while (!input_pending
)
2591 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2592 redisplay_preserve_echo_area (5);
2597 /* Normal case: no input arrived during redisplay. */
2600 /* Input arrived and pre-empted redisplay.
2601 Process any events which are not user-visible. */
2603 /* If that cleared input_pending, try again to redisplay. */
2606 /* Prevent the redisplay we just did
2607 from messing up echoing of the input after the prompt. */
2608 if (commandflag
== 0 && echo_current
)
2609 echo_message_buffer
= echo_area_buffer
[0];
2613 /* Message turns off echoing unless more keystrokes turn it on again.
2615 The code in 20.x for the condition was
2617 1. echo_area_glyphs && *echo_area_glyphs
2618 2. && echo_area_glyphs != current_kboard->echobuf
2619 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2621 (1) means there's a current message displayed
2623 (2) means it's not the message from echoing from the current
2626 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2627 is set to a non-null value. This is done in read_char and it is
2628 set to echo_area_glyphs after a call to echo_char. That means
2629 ok_to_echo_at_next_pause is either null or
2630 current_kboard->echobuf with the appropriate current_kboard at
2633 So, condition (3) means in clear text ok_to_echo_at_next_pause
2634 must be either null, or the current message isn't from echoing at
2635 all, or it's from echoing from a different kboard than the
2638 if (/* There currently is something in the echo area. */
2639 !NILP (echo_area_buffer
[0])
2640 && (/* It's an echo from a different kboard. */
2641 echo_kboard
!= current_kboard
2642 /* Or we explicitly allow overwriting whatever there is. */
2643 || ok_to_echo_at_next_pause
== NULL
))
2648 /* Try reading a character via menu prompting in the minibuf.
2649 Try this before the sit-for, because the sit-for
2650 would do the wrong thing if we are supposed to do
2651 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2652 after a mouse event so don't try a minibuf menu. */
2654 if (KEYMAPP (map
) && INTERACTIVE
2655 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2656 /* Don't bring up a menu if we already have another event. */
2657 && NILP (Vunread_command_events
)
2658 && !detect_input_pending_run_timers (0))
2660 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2662 if (INTEGERP (c
) && XINT (c
) == -2)
2663 return c
; /* wrong_kboard_jmpbuf */
2669 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2670 We will do that below, temporarily for short sections of code,
2671 when appropriate. local_getcjmp must be in effect
2672 around any call to sit_for or kbd_buffer_get_event;
2673 it *must not* be in effect when we call redisplay. */
2675 jmpcount
= SPECPDL_INDEX ();
2676 if (sys_setjmp (local_getcjmp
))
2678 /* Handle quits while reading the keyboard. */
2679 /* We must have saved the outer value of getcjmp here,
2680 so restore it now. */
2681 restore_getcjmp (save_jump
);
2682 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
2683 unbind_to (jmpcount
, Qnil
);
2684 XSETINT (c
, quit_char
);
2685 internal_last_event_frame
= selected_frame
;
2686 Vlast_event_frame
= internal_last_event_frame
;
2687 /* If we report the quit char as an event,
2688 don't do so more than once. */
2689 if (!NILP (Vinhibit_quit
))
2693 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2694 if (kb
!= current_kboard
)
2696 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2697 /* We shouldn't get here if we were in single-kboard mode! */
2702 while (CONSP (XCDR (last
)))
2704 if (!NILP (XCDR (last
)))
2708 kset_kbd_queue (kb
, list1 (c
));
2710 XSETCDR (last
, list1 (c
));
2711 kb
->kbd_queue_has_data
= 1;
2712 current_kboard
= kb
;
2713 /* This is going to exit from read_char
2714 so we had better get rid of this frame's stuff. */
2716 return make_number (-2); /* wrong_kboard_jmpbuf */
2722 /* Start idle timers if no time limit is supplied. We don't do it
2723 if a time limit is supplied to avoid an infinite recursion in the
2724 situation where an idle timer calls `sit-for'. */
2727 timer_start_idle ();
2729 /* If in middle of key sequence and minibuffer not active,
2730 start echoing if enough time elapses. */
2732 if (minibuf_level
== 0
2734 && !current_kboard
->immediate_echo
2735 && this_command_key_count
> 0
2737 && echo_keystrokes_p ()
2738 && (/* No message. */
2739 NILP (echo_area_buffer
[0])
2740 /* Or empty message. */
2741 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2742 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2743 /* Or already echoing from same kboard. */
2744 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2745 /* Or not echoing before and echoing allowed. */
2746 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2748 /* After a mouse event, start echoing right away.
2749 This is because we are probably about to display a menu,
2750 and we don't want to delay before doing so. */
2751 if (EVENT_HAS_PARAMETERS (prev_event
))
2757 save_getcjmp (save_jump
);
2758 restore_getcjmp (local_getcjmp
);
2759 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2760 restore_getcjmp (save_jump
);
2762 && ! CONSP (Vunread_command_events
))
2767 /* Maybe auto save due to number of keystrokes. */
2769 if (commandflag
!= 0 && commandflag
!= -2
2770 && auto_save_interval
> 0
2771 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2772 && !detect_input_pending_run_timers (0))
2774 Fdo_auto_save (Qnil
, Qnil
);
2775 /* Hooks can actually change some buffers in auto save. */
2779 /* Try reading using an X menu.
2780 This is never confused with reading using the minibuf
2781 because the recursive call of read_char in read_char_minibuf_menu_prompt
2782 does not pass on any keymaps. */
2784 if (KEYMAPP (map
) && INTERACTIVE
2785 && !NILP (prev_event
)
2786 && EVENT_HAS_PARAMETERS (prev_event
)
2787 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2788 && !EQ (XCAR (prev_event
), Qtool_bar
)
2789 /* Don't bring up a menu if we already have another event. */
2790 && NILP (Vunread_command_events
))
2792 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2794 /* Now that we have read an event, Emacs is not idle. */
2801 /* Maybe autosave and/or garbage collect due to idleness. */
2803 if (INTERACTIVE
&& NILP (c
))
2806 ptrdiff_t buffer_size
;
2808 /* Slow down auto saves logarithmically in size of current buffer,
2809 and garbage collect while we're at it. */
2810 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2811 last_non_minibuf_size
= Z
- BEG
;
2812 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2814 while (buffer_size
> 64)
2815 delay_level
++, buffer_size
-= buffer_size
>> 2;
2816 if (delay_level
< 4) delay_level
= 4;
2817 /* delay_level is 4 for files under around 50k, 7 at 100k,
2818 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2820 /* Auto save if enough time goes by without input. */
2821 if (commandflag
!= 0 && commandflag
!= -2
2822 && num_nonmacro_input_events
> last_auto_save
2823 && INTEGERP (Vauto_save_timeout
)
2824 && XINT (Vauto_save_timeout
) > 0)
2827 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2829 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2830 timeout
= delay_level
* timeout
/ 4;
2831 save_getcjmp (save_jump
);
2832 restore_getcjmp (local_getcjmp
);
2833 tem0
= sit_for (make_number (timeout
), 1, 1);
2834 restore_getcjmp (save_jump
);
2837 && ! CONSP (Vunread_command_events
))
2839 Fdo_auto_save (Qnil
, Qnil
);
2844 /* If there is still no input available, ask for GC. */
2845 if (!detect_input_pending_run_timers (0))
2849 /* Notify the caller if an autosave hook, or a timer, sentinel or
2850 filter in the sit_for calls above have changed the current
2851 kboard. This could happen if they use the minibuffer or start a
2852 recursive edit, like the fancy splash screen in server.el's
2853 filter. If this longjmp wasn't here, read_key_sequence would
2854 interpret the next key sequence using the wrong translation
2855 tables and function keymaps. */
2856 if (NILP (c
) && current_kboard
!= orig_kboard
)
2859 return make_number (-2); /* wrong_kboard_jmpbuf */
2862 /* If this has become non-nil here, it has been set by a timer
2863 or sentinel or filter. */
2864 if (CONSP (Vunread_command_events
))
2866 c
= XCAR (Vunread_command_events
);
2867 Vunread_command_events
= XCDR (Vunread_command_events
);
2869 if (CONSP (c
) && EQ (XCAR (c
), Qt
))
2875 /* Read something from current KBOARD's side queue, if possible. */
2879 if (current_kboard
->kbd_queue_has_data
)
2881 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2883 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2884 kset_kbd_queue (current_kboard
,
2885 XCDR (KVAR (current_kboard
, kbd_queue
)));
2886 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2887 current_kboard
->kbd_queue_has_data
= 0;
2888 input_pending
= readable_events (0);
2889 if (EVENT_HAS_PARAMETERS (c
)
2890 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2891 internal_last_event_frame
= XCAR (XCDR (c
));
2892 Vlast_event_frame
= internal_last_event_frame
;
2896 /* If current_kboard's side queue is empty check the other kboards.
2897 If one of them has data that we have not yet seen here,
2898 switch to it and process the data waiting for it.
2900 Note: if the events queued up for another kboard
2901 have already been seen here, and therefore are not a complete command,
2902 the kbd_queue_has_data field is 0, so we skip that kboard here.
2903 That's to avoid an infinite loop switching between kboards here. */
2904 if (NILP (c
) && !single_kboard
)
2907 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2908 if (kb
->kbd_queue_has_data
)
2910 current_kboard
= kb
;
2911 /* This is going to exit from read_char
2912 so we had better get rid of this frame's stuff. */
2914 return make_number (-2); /* wrong_kboard_jmpbuf */
2924 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2925 prev_event
, used_mouse_menu
);
2926 if (NILP (c
) && end_time
2927 && timespec_cmp (*end_time
, current_timespec ()) <= 0)
2932 if (EQ (c
, make_number (-2)))
2934 /* This is going to exit from read_char
2935 so we had better get rid of this frame's stuff. */
2949 if (commandflag
>= 0
2950 && !input_pending
&& !detect_input_pending_run_timers (0))
2956 /* Buffer switch events are only for internal wakeups
2957 so don't show them to the user.
2958 Also, don't record a key if we already did. */
2962 /* Process special events within read_char
2963 and loop around to read another event. */
2966 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2971 struct buffer
*prev_buffer
= current_buffer
;
2972 last_input_event
= c
;
2973 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2975 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2976 /* We stopped being idle for this event; undo that. This
2977 prevents automatic window selection (under
2978 mouse_autoselect_window from acting as a real input event, for
2979 example banishing the mouse under mouse-avoidance-mode. */
2980 timer_resume_idle ();
2982 if (current_buffer
!= prev_buffer
)
2984 /* The command may have changed the keymaps. Pretend there
2985 is input in another keyboard and return. This will
2986 recalculate keymaps. */
2987 c
= make_number (-2);
2994 /* Handle things that only apply to characters. */
2997 /* If kbd_buffer_get_event gave us an EOF, return that. */
3001 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
3002 && UNSIGNED_CMP (XFASTINT (c
), <,
3003 SCHARS (KVAR (current_kboard
,
3004 Vkeyboard_translate_table
))))
3005 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
3006 && UNSIGNED_CMP (XFASTINT (c
), <,
3007 ASIZE (KVAR (current_kboard
,
3008 Vkeyboard_translate_table
))))
3009 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
3013 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
3014 /* nil in keyboard-translate-table means no translation. */
3020 /* If this event is a mouse click in the menu bar,
3021 return just menu-bar for now. Modify the mouse click event
3022 so we won't do this twice, then queue it up. */
3023 if (EVENT_HAS_PARAMETERS (c
)
3025 && CONSP (EVENT_START (c
))
3026 && CONSP (XCDR (EVENT_START (c
))))
3030 posn
= POSN_POSN (EVENT_START (c
));
3031 /* Handle menu-bar events:
3032 insert the dummy prefix event `menu-bar'. */
3033 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3035 /* Change menu-bar to (menu-bar) as the event "position". */
3036 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3039 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3044 /* Store these characters into recent_keys, the dribble file if any,
3045 and the keyboard macro being defined, if any. */
3047 if (! NILP (also_record
))
3048 record_char (also_record
);
3050 /* Wipe the echo area.
3051 But first, if we are about to use an input method,
3052 save the echo area contents for it to refer to. */
3054 && ! NILP (Vinput_method_function
)
3055 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3057 previous_echo_area_message
= Fcurrent_message ();
3058 Vinput_method_previous_message
= previous_echo_area_message
;
3061 /* Now wipe the echo area, except for help events which do their
3062 own stuff with the echo area. */
3064 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3065 && !(EQ (Qswitch_frame
, XCAR (c
)))
3066 /* Don't wipe echo area for select window events: These might
3067 get delayed via `mouse-autoselect-window' (Bug#11304). */
3068 && !(EQ (Qselect_window
, XCAR (c
)))))
3070 if (!NILP (echo_area_buffer
[0]))
3072 safe_run_hooks (Qecho_area_clear_hook
);
3073 clear_message (1, 0);
3077 reread_for_input_method
:
3079 /* Pass this to the input method, if appropriate. */
3081 && ! NILP (Vinput_method_function
)
3082 /* Don't run the input method within a key sequence,
3083 after the first event of the key sequence. */
3084 && NILP (prev_event
)
3085 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3088 ptrdiff_t key_count
;
3089 bool key_count_reset
;
3090 struct gcpro gcpro1
;
3091 ptrdiff_t count
= SPECPDL_INDEX ();
3093 /* Save the echo status. */
3094 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3095 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3096 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3097 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3100 if (before_command_restore_flag
)
3102 this_command_key_count
= before_command_key_count_1
;
3103 if (this_command_key_count
< this_single_command_key_start
)
3104 this_single_command_key_start
= this_command_key_count
;
3105 echo_truncate (before_command_echo_length_1
);
3106 before_command_restore_flag
= 0;
3110 /* Save the this_command_keys status. */
3111 key_count
= this_command_key_count
;
3112 key_count_reset
= this_command_key_count_reset
;
3115 keys
= Fcopy_sequence (this_command_keys
);
3120 /* Clear out this_command_keys. */
3121 this_command_key_count
= 0;
3122 this_command_key_count_reset
= 0;
3124 /* Now wipe the echo area. */
3125 if (!NILP (echo_area_buffer
[0]))
3126 safe_run_hooks (Qecho_area_clear_hook
);
3127 clear_message (1, 0);
3130 /* If we are not reading a key sequence,
3131 never use the echo area. */
3134 specbind (Qinput_method_use_echo_area
, Qt
);
3137 /* Call the input method. */
3138 tem
= call1 (Vinput_method_function
, c
);
3140 tem
= unbind_to (count
, tem
);
3142 /* Restore the saved echoing state
3143 and this_command_keys state. */
3144 this_command_key_count
= key_count
;
3145 this_command_key_count_reset
= key_count_reset
;
3147 this_command_keys
= keys
;
3150 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3151 kset_echo_string (current_kboard
, saved_echo_string
);
3152 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3153 if (saved_immediate_echo
)
3158 /* The input method can return no events. */
3161 /* Bring back the previous message, if any. */
3162 if (! NILP (previous_echo_area_message
))
3163 message_with_string ("%s", previous_echo_area_message
, 0);
3166 /* It returned one event or more. */
3168 Vunread_post_input_method_events
3169 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3174 /* Display help if not echoing. */
3175 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3177 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3178 Lisp_Object help
, object
, position
, window
, htem
;
3180 htem
= Fcdr (XCDR (c
));
3183 window
= Fcar (htem
);
3185 object
= Fcar (htem
);
3187 position
= Fcar (htem
);
3189 show_help_echo (help
, window
, object
, position
);
3191 /* We stopped being idle for this event; undo that. */
3193 timer_resume_idle ();
3197 if ((! reread
|| this_command_key_count
== 0
3198 || this_command_key_count_reset
)
3202 /* Don't echo mouse motion events. */
3203 if (echo_keystrokes_p ()
3204 && ! (EVENT_HAS_PARAMETERS (c
)
3205 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3208 if (! NILP (also_record
))
3209 echo_char (also_record
);
3210 /* Once we reread a character, echoing can happen
3211 the next time we pause to read a new one. */
3212 ok_to_echo_at_next_pause
= current_kboard
;
3215 /* Record this character as part of the current key. */
3216 add_command_key (c
);
3217 if (! NILP (also_record
))
3218 add_command_key (also_record
);
3221 last_input_event
= c
;
3224 /* Process the help character specially if enabled. */
3225 if (!NILP (Vhelp_form
) && help_char_p (c
))
3227 ptrdiff_t count
= SPECPDL_INDEX ();
3229 help_form_saved_window_configs
3230 = Fcons (Fcurrent_window_configuration (Qnil
),
3231 help_form_saved_window_configs
);
3232 record_unwind_protect_void (read_char_help_form_unwind
);
3233 call0 (Qhelp_form_show
);
3238 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3239 if (EVENT_HAS_PARAMETERS (c
)
3240 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3241 XSETCAR (help_form_saved_window_configs
, Qnil
);
3243 while (BUFFERP (c
));
3244 /* Remove the help from the frame. */
3245 unbind_to (count
, Qnil
);
3248 if (EQ (c
, make_number (040)))
3252 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3253 while (BUFFERP (c
));
3262 /* Record a key that came from a mouse menu.
3263 Record it for echoing, for this-command-keys, and so on. */
3266 record_menu_key (Lisp_Object c
)
3268 /* Wipe the echo area. */
3269 clear_message (1, 0);
3274 before_command_key_count
= this_command_key_count
;
3275 before_command_echo_length
= echo_length ();
3278 /* Don't echo mouse motion events. */
3279 if (echo_keystrokes_p ())
3283 /* Once we reread a character, echoing can happen
3284 the next time we pause to read a new one. */
3285 ok_to_echo_at_next_pause
= 0;
3288 /* Record this character as part of the current key. */
3289 add_command_key (c
);
3291 /* Re-reading in the middle of a command. */
3292 last_input_event
= c
;
3296 /* Return true if should recognize C as "the help character". */
3299 help_char_p (Lisp_Object c
)
3303 if (EQ (c
, Vhelp_char
))
3305 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3306 if (EQ (c
, XCAR (tail
)))
3311 /* Record the input event C in various ways. */
3314 record_char (Lisp_Object c
)
3318 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3320 /* To avoid filling recent_keys with help-echo and mouse-movement
3321 events, we filter out repeated help-echo events, only store the
3322 first and last in a series of mouse-movement events, and don't
3323 store repeated help-echo events which are only separated by
3324 mouse-movement events. */
3326 Lisp_Object ev1
, ev2
, ev3
;
3329 if ((ix1
= recent_keys_index
- 1) < 0)
3330 ix1
= NUM_RECENT_KEYS
- 1;
3331 ev1
= AREF (recent_keys
, ix1
);
3333 if ((ix2
= ix1
- 1) < 0)
3334 ix2
= NUM_RECENT_KEYS
- 1;
3335 ev2
= AREF (recent_keys
, ix2
);
3337 if ((ix3
= ix2
- 1) < 0)
3338 ix3
= NUM_RECENT_KEYS
- 1;
3339 ev3
= AREF (recent_keys
, ix3
);
3341 if (EQ (XCAR (c
), Qhelp_echo
))
3343 /* Don't record `help-echo' in recent_keys unless it shows some help
3344 message, and a different help than the previously recorded
3346 Lisp_Object help
, last_help
;
3348 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3349 if (!STRINGP (help
))
3351 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3352 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3354 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3355 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3356 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3358 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3359 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3360 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3361 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3364 else if (EQ (XCAR (c
), Qmouse_movement
))
3366 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3367 So additional mouse movement events replace the last element. */
3368 Lisp_Object last_window
, window
;
3370 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3371 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3372 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3373 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3374 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3376 ASET (recent_keys
, ix1
, c
);
3382 store_kbd_macro_char (c
);
3386 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3387 ASET (recent_keys
, recent_keys_index
, c
);
3388 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3389 recent_keys_index
= 0;
3391 else if (recorded
< 0)
3393 /* We need to remove one or two events from recent_keys.
3394 To do this, we simply put nil at those events and move the
3395 recent_keys_index backwards over those events. Usually,
3396 users will never see those nil events, as they will be
3397 overwritten by the command keys entered to see recent_keys
3400 while (recorded
++ < 0 && total_keys
> 0)
3402 if (total_keys
< NUM_RECENT_KEYS
)
3404 if (--recent_keys_index
< 0)
3405 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3406 ASET (recent_keys
, recent_keys_index
, Qnil
);
3410 num_nonmacro_input_events
++;
3412 /* Write c to the dribble file. If c is a lispy event, write
3413 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3414 If you, dear reader, have a better idea, you've got the source. :-) */
3420 if (XUINT (c
) < 0x100)
3421 putc (XUINT (c
), dribble
);
3423 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3427 Lisp_Object dribblee
;
3429 /* If it's a structured event, take the event header. */
3430 dribblee
= EVENT_HEAD (c
);
3432 if (SYMBOLP (dribblee
))
3434 putc ('<', dribble
);
3435 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3436 SBYTES (SYMBOL_NAME (dribblee
)),
3438 putc ('>', dribble
);
3447 /* Copy out or in the info on where C-g should throw to.
3448 This is used when running Lisp code from within get_char,
3449 in case get_char is called recursively.
3450 See read_process_output. */
3453 save_getcjmp (sys_jmp_buf temp
)
3455 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3459 restore_getcjmp (sys_jmp_buf temp
)
3461 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3464 /* Low level keyboard/mouse input.
3465 kbd_buffer_store_event places events in kbd_buffer, and
3466 kbd_buffer_get_event retrieves them. */
3468 /* Return true if there are any events in the queue that read-char
3469 would return. If this returns false, a read-char would block. */
3471 readable_events (int flags
)
3473 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3476 /* If the buffer contains only FOCUS_IN_EVENT events, and
3477 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3478 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3480 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3481 #ifdef USE_TOOLKIT_SCROLL_BARS
3482 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3486 struct input_event
*event
;
3488 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3495 #ifdef USE_TOOLKIT_SCROLL_BARS
3496 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3498 event
->kind
== FOCUS_IN_EVENT
)
3499 #ifdef USE_TOOLKIT_SCROLL_BARS
3500 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3501 && (event
->kind
== SCROLL_BAR_CLICK_EVENT
3502 || event
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3503 && event
->part
== scroll_bar_handle
3504 && event
->modifiers
== 0)
3509 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3512 while (event
!= kbd_store_ptr
);
3518 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3519 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3523 if (current_kboard
->kbd_queue_has_data
)
3529 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3530 if (kb
->kbd_queue_has_data
)
3536 /* Set this for debugging, to have a way to get out */
3537 int stop_character EXTERNALLY_VISIBLE
;
3540 event_to_kboard (struct input_event
*event
)
3542 /* Not applicable for these special events. */
3543 if (event
->kind
== SELECTION_REQUEST_EVENT
3544 || event
->kind
== SELECTION_CLEAR_EVENT
)
3548 Lisp_Object obj
= event
->frame_or_window
;
3549 /* There are some events that set this field to nil or string. */
3551 obj
= WINDOW_FRAME (XWINDOW (obj
));
3552 /* Also ignore dead frames here. */
3553 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3554 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3559 /* Return the number of slots occupied in kbd_buffer. */
3562 kbd_buffer_nr_stored (void)
3564 return kbd_fetch_ptr
== kbd_store_ptr
3566 : (kbd_fetch_ptr
< kbd_store_ptr
3567 ? kbd_store_ptr
- kbd_fetch_ptr
3568 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3569 + (kbd_store_ptr
- kbd_buffer
)));
3571 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3574 kbd_buffer_store_event (register struct input_event
*event
)
3576 kbd_buffer_store_event_hold (event
, 0);
3579 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3581 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3582 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3583 Else, if EVENT is a quit event, store the quit event
3584 in HOLD_QUIT, and return (thus ignoring further events).
3586 This is used to postpone the processing of the quit event until all
3587 subsequent input events have been parsed (and discarded). */
3590 kbd_buffer_store_event_hold (register struct input_event
*event
,
3591 struct input_event
*hold_quit
)
3593 if (event
->kind
== NO_EVENT
)
3596 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3599 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3601 register int c
= event
->code
& 0377;
3603 if (event
->modifiers
& ctrl_modifier
)
3604 c
= make_ctrl_char (c
);
3606 c
|= (event
->modifiers
3607 & (meta_modifier
| alt_modifier
3608 | hyper_modifier
| super_modifier
));
3612 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3613 struct input_event
*sp
;
3615 if (single_kboard
&& kb
!= current_kboard
)
3618 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3620 kb
->kbd_queue_has_data
= 1;
3621 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3623 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3626 if (event_to_kboard (sp
) == kb
)
3628 sp
->kind
= NO_EVENT
;
3629 sp
->frame_or_window
= Qnil
;
3638 *hold_quit
= *event
;
3642 /* If this results in a quit_char being returned to Emacs as
3643 input, set Vlast_event_frame properly. If this doesn't
3644 get returned to Emacs as an event, the next event read
3645 will set Vlast_event_frame again, so this is safe to do. */
3649 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3651 focus
= event
->frame_or_window
;
3652 internal_last_event_frame
= focus
;
3653 Vlast_event_frame
= focus
;
3656 handle_interrupt (0);
3660 if (c
&& c
== stop_character
)
3666 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3667 Just ignore the second one. */
3668 else if (event
->kind
== BUFFER_SWITCH_EVENT
3669 && kbd_fetch_ptr
!= kbd_store_ptr
3670 && ((kbd_store_ptr
== kbd_buffer
3671 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3672 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3675 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3676 kbd_store_ptr
= kbd_buffer
;
3678 /* Don't let the very last slot in the buffer become full,
3679 since that would make the two pointers equal,
3680 and that is indistinguishable from an empty buffer.
3681 Discard the event if it would fill the last slot. */
3682 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3684 *kbd_store_ptr
= *event
;
3687 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/ 2
3688 && ! kbd_on_hold_p ())
3690 /* Don't read keyboard input until we have processed kbd_buffer.
3691 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3692 hold_keyboard_input ();
3693 if (!noninteractive
)
3697 #endif /* subprocesses */
3700 /* If we're inside while-no-input, and this event qualifies
3701 as input, set quit-flag to cause an interrupt. */
3702 if (!NILP (Vthrow_on_input
)
3703 && event
->kind
!= FOCUS_IN_EVENT
3704 && event
->kind
!= HELP_EVENT
3705 && event
->kind
!= DEICONIFY_EVENT
)
3707 Vquit_flag
= Vthrow_on_input
;
3708 /* If we're inside a function that wants immediate quits,
3710 if (immediate_quit
&& NILP (Vinhibit_quit
))
3719 /* Put an input event back in the head of the event queue. */
3722 kbd_buffer_unget_event (register struct input_event
*event
)
3724 if (kbd_fetch_ptr
== kbd_buffer
)
3725 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3727 /* Don't let the very last slot in the buffer become full, */
3728 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3731 *kbd_fetch_ptr
= *event
;
3736 /* Generate a HELP_EVENT input_event and store it in the keyboard
3739 HELP is the help form.
3741 FRAME and WINDOW are the frame and window where the help is
3742 generated. OBJECT is the Lisp object where the help was found (a
3743 buffer, a string, an overlay, or nil if neither from a string nor
3744 from a buffer). POS is the position within OBJECT where the help
3748 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3749 Lisp_Object object
, ptrdiff_t pos
)
3751 struct input_event event
;
3755 event
.kind
= HELP_EVENT
;
3756 event
.frame_or_window
= frame
;
3758 event
.x
= WINDOWP (window
) ? window
: frame
;
3761 kbd_buffer_store_event (&event
);
3765 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3768 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3770 struct input_event event
;
3772 event
.kind
= HELP_EVENT
;
3773 event
.frame_or_window
= frame
;
3778 kbd_buffer_store_event (&event
);
3782 /* Discard any mouse events in the event buffer by setting them to
3785 discard_mouse_events (void)
3787 struct input_event
*sp
;
3788 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3790 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3793 if (sp
->kind
== MOUSE_CLICK_EVENT
3794 || sp
->kind
== WHEEL_EVENT
3795 || sp
->kind
== HORIZ_WHEEL_EVENT
3797 || sp
->kind
== GPM_CLICK_EVENT
3799 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
3800 || sp
->kind
== HORIZONTAL_SCROLL_BAR_CLICK_EVENT
)
3802 sp
->kind
= NO_EVENT
;
3808 /* Return true if there are any real events waiting in the event
3809 buffer, not counting `NO_EVENT's.
3811 Discard NO_EVENT events at the front of the input queue, possibly
3812 leaving the input queue empty if there are no real input events. */
3815 kbd_buffer_events_waiting (void)
3817 struct input_event
*sp
;
3819 for (sp
= kbd_fetch_ptr
;
3820 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3823 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3828 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3832 /* Clear input event EVENT. */
3835 clear_event (struct input_event
*event
)
3837 event
->kind
= NO_EVENT
;
3841 /* Read one event from the event buffer, waiting if necessary.
3842 The value is a Lisp object representing the event.
3843 The value is nil for an event that should be ignored,
3844 or that was handled here.
3845 We always read and discard one event. */
3848 kbd_buffer_get_event (KBOARD
**kbp
,
3849 bool *used_mouse_menu
,
3850 struct timespec
*end_time
)
3855 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3857 /* Start reading input again because we have processed enough to
3858 be able to accept new events again. */
3859 unhold_keyboard_input ();
3862 #endif /* subprocesses */
3864 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3866 /* In case we are running as a daemon, only do this before
3867 detaching from the terminal. */
3868 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3872 *kbp
= current_kboard
;
3875 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3877 /* Wait until there is input available. */
3880 /* Break loop if there's an unread command event. Needed in
3881 moused window autoselection which uses a timer to insert such
3883 if (CONSP (Vunread_command_events
))
3886 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3888 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3891 /* If the quit flag is set, then read_char will return
3892 quit_char, so that counts as "available input." */
3893 if (!NILP (Vquit_flag
))
3894 quit_throw_to_read_char (0);
3896 /* One way or another, wait until input is available; then, if
3897 interrupt handlers have not read it, read it now. */
3902 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3904 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3908 struct timespec now
= current_timespec ();
3909 if (timespec_cmp (*end_time
, now
) <= 0)
3910 return Qnil
; /* Finished waiting. */
3913 struct timespec duration
= timespec_sub (*end_time
, now
);
3914 wait_reading_process_output (min (duration
.tv_sec
,
3917 -1, 1, Qnil
, NULL
, 0);
3922 bool do_display
= true;
3924 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3926 struct tty_display_info
*tty
= CURTTY ();
3928 /* When this TTY is displaying a menu, we must prevent
3929 any redisplay, because we modify the frame's glyph
3930 matrix behind the back of the display engine. */
3931 if (tty
->showing_menu
)
3935 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3938 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3942 if (CONSP (Vunread_command_events
))
3945 first
= XCAR (Vunread_command_events
);
3946 Vunread_command_events
= XCDR (Vunread_command_events
);
3947 *kbp
= current_kboard
;
3951 /* At this point, we know that there is a readable event available
3952 somewhere. If the event queue is empty, then there must be a
3953 mouse movement enabled and available. */
3954 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3956 struct input_event
*event
;
3958 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3962 *kbp
= event_to_kboard (event
);
3964 *kbp
= current_kboard
; /* Better than returning null ptr? */
3968 /* These two kinds of events get special handling
3969 and don't actually appear to the command loop.
3970 We return nil for them. */
3971 if (event
->kind
== SELECTION_REQUEST_EVENT
3972 || event
->kind
== SELECTION_CLEAR_EVENT
)
3975 struct input_event copy
;
3977 /* Remove it from the buffer before processing it,
3978 since otherwise swallow_events will see it
3979 and process it again. */
3981 kbd_fetch_ptr
= event
+ 1;
3982 input_pending
= readable_events (0);
3983 x_handle_selection_event (©
);
3985 /* We're getting selection request events, but we don't have
3991 #if defined (HAVE_NS)
3992 else if (event
->kind
== NS_TEXT_EVENT
)
3994 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3995 obj
= list1 (intern ("ns-put-working-text"));
3997 obj
= list1 (intern ("ns-unput-working-text"));
3998 kbd_fetch_ptr
= event
+ 1;
3999 if (used_mouse_menu
)
4000 *used_mouse_menu
= 1;
4004 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4005 || defined (HAVE_NS)
4006 else if (event
->kind
== DELETE_WINDOW_EVENT
)
4008 /* Make an event (delete-frame (FRAME)). */
4009 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
4010 kbd_fetch_ptr
= event
+ 1;
4013 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
4014 || defined (HAVE_NS)
4015 else if (event
->kind
== ICONIFY_EVENT
)
4017 /* Make an event (iconify-frame (FRAME)). */
4018 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
4019 kbd_fetch_ptr
= event
+ 1;
4021 else if (event
->kind
== DEICONIFY_EVENT
)
4023 /* Make an event (make-frame-visible (FRAME)). */
4024 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
4025 kbd_fetch_ptr
= event
+ 1;
4028 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4030 /* The value doesn't matter here; only the type is tested. */
4031 XSETBUFFER (obj
, current_buffer
);
4032 kbd_fetch_ptr
= event
+ 1;
4034 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4035 || defined (HAVE_NS) || defined (USE_GTK)
4036 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4038 kbd_fetch_ptr
= event
+ 1;
4039 input_pending
= readable_events (0);
4040 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4041 x_activate_menubar (XFRAME (event
->frame_or_window
));
4045 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4047 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4048 obj
= list4 (Qlanguage_change
,
4049 event
->frame_or_window
,
4050 make_number (event
->code
),
4051 make_number (event
->modifiers
));
4052 kbd_fetch_ptr
= event
+ 1;
4055 #ifdef USE_FILE_NOTIFY
4056 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4058 #ifdef HAVE_W32NOTIFY
4059 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4060 obj
= list3 (Qfile_notify
,
4061 list3 (make_number (event
->code
),
4064 event
->frame_or_window
);
4066 obj
= make_lispy_event (event
);
4068 kbd_fetch_ptr
= event
+ 1;
4070 #endif /* USE_FILE_NOTIFY */
4071 else if (event
->kind
== SAVE_SESSION_EVENT
)
4073 obj
= list2 (Qsave_session
, event
->arg
);
4074 kbd_fetch_ptr
= event
+ 1;
4076 /* Just discard these, by returning nil.
4077 With MULTI_KBOARD, these events are used as placeholders
4078 when we need to randomly delete events from the queue.
4079 (They shouldn't otherwise be found in the buffer,
4080 but on some machines it appears they do show up
4081 even without MULTI_KBOARD.) */
4082 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4083 mouse events during a popup-menu call. */
4084 else if (event
->kind
== NO_EVENT
)
4085 kbd_fetch_ptr
= event
+ 1;
4086 else if (event
->kind
== HELP_EVENT
)
4088 Lisp_Object object
, position
, help
, frame
, window
;
4090 frame
= event
->frame_or_window
;
4091 object
= event
->arg
;
4092 position
= make_number (event
->code
);
4095 clear_event (event
);
4097 kbd_fetch_ptr
= event
+ 1;
4098 if (!WINDOWP (window
))
4100 obj
= Fcons (Qhelp_echo
,
4101 list5 (frame
, help
, window
, object
, position
));
4103 else if (event
->kind
== FOCUS_IN_EVENT
)
4105 /* Notification of a FocusIn event. The frame receiving the
4106 focus is in event->frame_or_window. Generate a
4107 switch-frame event if necessary. */
4108 Lisp_Object frame
, focus
;
4110 frame
= event
->frame_or_window
;
4111 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4120 !EQ (frame
, internal_last_event_frame
)
4121 && !EQ (frame
, selected_frame
))
4122 obj
= make_lispy_switch_frame (frame
);
4124 obj
= make_lispy_focus_in (frame
);
4126 internal_last_event_frame
= frame
;
4127 kbd_fetch_ptr
= event
+ 1;
4129 else if (event
->kind
== FOCUS_OUT_EVENT
)
4131 #ifdef HAVE_WINDOW_SYSTEM
4134 Lisp_Object frame
= event
->frame_or_window
;
4135 bool focused
= false;
4137 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4138 focused
= di
->x_highlight_frame
!= 0;
4141 obj
= make_lispy_focus_out (frame
);
4143 #endif /* HAVE_WINDOW_SYSTEM */
4145 kbd_fetch_ptr
= event
+ 1;
4148 else if (event
->kind
== DBUS_EVENT
)
4150 obj
= make_lispy_event (event
);
4151 kbd_fetch_ptr
= event
+ 1;
4154 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4156 obj
= make_lispy_event (event
);
4157 kbd_fetch_ptr
= event
+ 1;
4161 /* If this event is on a different frame, return a switch-frame this
4162 time, and leave the event in the queue for next time. */
4166 frame
= event
->frame_or_window
;
4168 frame
= XCAR (frame
);
4169 else if (WINDOWP (frame
))
4170 frame
= WINDOW_FRAME (XWINDOW (frame
));
4172 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4176 if (! EQ (frame
, internal_last_event_frame
)
4177 && !EQ (frame
, selected_frame
))
4178 obj
= make_lispy_switch_frame (frame
);
4179 internal_last_event_frame
= frame
;
4181 /* If we didn't decide to make a switch-frame event, go ahead
4182 and build a real event from the queue entry. */
4186 obj
= make_lispy_event (event
);
4188 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4189 || defined (HAVE_NS) || defined (USE_GTK)
4190 /* If this was a menu selection, then set the flag to inhibit
4191 writing to last_nonmenu_event. Don't do this if the event
4192 we're returning is (menu-bar), though; that indicates the
4193 beginning of the menu sequence, and we might as well leave
4194 that as the `event with parameters' for this selection. */
4196 && !EQ (event
->frame_or_window
, event
->arg
)
4197 && (event
->kind
== MENU_BAR_EVENT
4198 || event
->kind
== TOOL_BAR_EVENT
))
4199 *used_mouse_menu
= 1;
4202 /* Certain system events are non-key events. */
4204 && event
->kind
== NS_NONKEY_EVENT
)
4205 *used_mouse_menu
= 1;
4208 /* Wipe out this event, to catch bugs. */
4209 clear_event (event
);
4210 kbd_fetch_ptr
= event
+ 1;
4214 /* Try generating a mouse motion event. */
4215 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4217 struct frame
*f
= some_mouse_moved ();
4218 Lisp_Object bar_window
;
4219 enum scroll_bar_part part
;
4223 *kbp
= current_kboard
;
4224 /* Note that this uses F to determine which terminal to look at.
4225 If there is no valid info, it does not store anything
4226 so x remains nil. */
4229 /* XXX Can f or mouse_position_hook be NULL here? */
4230 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4231 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4236 /* Decide if we should generate a switch-frame event. Don't
4237 generate switch-frame events for motion outside of all Emacs
4243 frame
= FRAME_FOCUS_FRAME (f
);
4245 XSETFRAME (frame
, f
);
4247 if (! EQ (frame
, internal_last_event_frame
)
4248 && !EQ (frame
, selected_frame
))
4249 obj
= make_lispy_switch_frame (frame
);
4250 internal_last_event_frame
= frame
;
4253 /* If we didn't decide to make a switch-frame event, go ahead and
4254 return a mouse-motion event. */
4255 if (!NILP (x
) && NILP (obj
))
4256 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4259 /* We were promised by the above while loop that there was
4260 something for us to read! */
4263 input_pending
= readable_events (0);
4265 Vlast_event_frame
= internal_last_event_frame
;
4270 /* Process any non-user-visible events (currently X selection events),
4271 without reading any user-visible events. */
4274 process_special_events (void)
4276 struct input_event
*event
;
4278 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4280 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4283 if (event
== kbd_store_ptr
)
4287 /* If we find a stored X selection request, handle it now. */
4288 if (event
->kind
== SELECTION_REQUEST_EVENT
4289 || event
->kind
== SELECTION_CLEAR_EVENT
)
4293 /* Remove the event from the fifo buffer before processing;
4294 otherwise swallow_events called recursively could see it
4295 and process it again. To do this, we move the events
4296 between kbd_fetch_ptr and EVENT one slot to the right,
4299 struct input_event copy
= *event
;
4300 struct input_event
*beg
4301 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4302 ? kbd_buffer
: kbd_fetch_ptr
;
4305 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4306 else if (event
< beg
)
4308 if (event
> kbd_buffer
)
4309 memmove (kbd_buffer
+ 1, kbd_buffer
,
4310 (event
- kbd_buffer
) * sizeof (struct input_event
));
4311 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4312 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4313 memmove (beg
+ 1, beg
,
4314 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4315 * sizeof (struct input_event
));
4318 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4319 kbd_fetch_ptr
= kbd_buffer
+ 1;
4323 input_pending
= readable_events (0);
4324 x_handle_selection_event (©
);
4326 /* We're getting selection request events, but we don't have
4334 /* Process any events that are not user-visible, run timer events that
4335 are ripe, and return, without reading any user-visible events. */
4338 swallow_events (bool do_display
)
4340 unsigned old_timers_run
;
4342 process_special_events ();
4344 old_timers_run
= timers_run
;
4345 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4347 if (timers_run
!= old_timers_run
&& do_display
)
4348 redisplay_preserve_echo_area (7);
4351 /* Record the start of when Emacs is idle,
4352 for the sake of running idle-time timers. */
4355 timer_start_idle (void)
4357 /* If we are already in the idle state, do nothing. */
4358 if (timespec_valid_p (timer_idleness_start_time
))
4361 timer_idleness_start_time
= current_timespec ();
4362 timer_last_idleness_start_time
= timer_idleness_start_time
;
4364 /* Mark all idle-time timers as once again candidates for running. */
4365 call0 (intern ("internal-timer-start-idle"));
4368 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4371 timer_stop_idle (void)
4373 timer_idleness_start_time
= invalid_timespec ();
4376 /* Resume idle timer from last idle start time. */
4379 timer_resume_idle (void)
4381 if (timespec_valid_p (timer_idleness_start_time
))
4384 timer_idleness_start_time
= timer_last_idleness_start_time
;
4387 /* This is only for debugging. */
4388 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4390 /* List of elisp functions to call, delayed because they were generated in
4391 a context where Elisp could not be safely run (e.g. redisplay, signal,
4392 ...). Each element has the form (FUN . ARGS). */
4393 Lisp_Object pending_funcalls
;
4395 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4397 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4399 Lisp_Object
*vector
;
4401 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4403 vector
= XVECTOR (timer
)->contents
;
4404 if (! NILP (vector
[0]))
4407 return (decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4409 && timespec_valid_p (*result
));
4413 /* Check whether a timer has fired. To prevent larger problems we simply
4414 disregard elements that are not proper timers. Do not make a circular
4415 timer list for the time being.
4417 Returns the time to wait until the next timer fires. If a
4418 timer is triggering now, return zero.
4419 If no timer is active, return -1.
4421 If a timer is ripe, we run it, with quitting turned off.
4422 In that case we return 0 to indicate that a new timer_check_2 call
4425 static struct timespec
4426 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4428 struct timespec nexttime
;
4429 struct timespec now
;
4430 struct timespec idleness_now
;
4431 Lisp_Object chosen_timer
;
4432 struct gcpro gcpro1
;
4434 nexttime
= invalid_timespec ();
4436 chosen_timer
= Qnil
;
4437 GCPRO1 (chosen_timer
);
4439 /* First run the code that was delayed. */
4440 while (CONSP (pending_funcalls
))
4442 Lisp_Object funcall
= XCAR (pending_funcalls
);
4443 pending_funcalls
= XCDR (pending_funcalls
);
4444 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4447 if (CONSP (timers
) || CONSP (idle_timers
))
4449 now
= current_timespec ();
4450 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4451 ? timespec_sub (now
, timer_idleness_start_time
)
4452 : make_timespec (0, 0));
4455 while (CONSP (timers
) || CONSP (idle_timers
))
4457 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4458 struct timespec timer_time
, idle_timer_time
;
4459 struct timespec difference
;
4460 struct timespec timer_difference
= invalid_timespec ();
4461 struct timespec idle_timer_difference
= invalid_timespec ();
4462 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4464 /* Set TIMER and TIMER_DIFFERENCE
4465 based on the next ordinary timer.
4466 TIMER_DIFFERENCE is the distance in time from NOW to when
4467 this timer becomes ripe (negative if it's already ripe).
4468 Skip past invalid timers and timers already handled. */
4471 timer
= XCAR (timers
);
4472 if (! decode_timer (timer
, &timer_time
))
4474 timers
= XCDR (timers
);
4478 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4479 timer_difference
= (timer_ripe
4480 ? timespec_sub (now
, timer_time
)
4481 : timespec_sub (timer_time
, now
));
4484 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4485 based on the next idle timer. */
4486 if (CONSP (idle_timers
))
4488 idle_timer
= XCAR (idle_timers
);
4489 if (! decode_timer (idle_timer
, &idle_timer_time
))
4491 idle_timers
= XCDR (idle_timers
);
4495 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4496 idle_timer_difference
4498 ? timespec_sub (idleness_now
, idle_timer_time
)
4499 : timespec_sub (idle_timer_time
, idleness_now
));
4502 /* Decide which timer is the next timer,
4503 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4504 Also step down the list where we found that timer. */
4506 if (timespec_valid_p (timer_difference
)
4507 && (! timespec_valid_p (idle_timer_difference
)
4508 || idle_timer_ripe
< timer_ripe
4509 || (idle_timer_ripe
== timer_ripe
4511 ? timespec_cmp (idle_timer_difference
,
4513 : timespec_cmp (timer_difference
,
4514 idle_timer_difference
))
4517 chosen_timer
= timer
;
4518 timers
= XCDR (timers
);
4519 difference
= timer_difference
;
4524 chosen_timer
= idle_timer
;
4525 idle_timers
= XCDR (idle_timers
);
4526 difference
= idle_timer_difference
;
4527 ripe
= idle_timer_ripe
;
4530 /* If timer is ripe, run it if it hasn't been run. */
4533 if (NILP (AREF (chosen_timer
, 0)))
4535 ptrdiff_t count
= SPECPDL_INDEX ();
4536 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4538 /* Mark the timer as triggered to prevent problems if the lisp
4539 code fails to reschedule it right. */
4540 ASET (chosen_timer
, 0, Qt
);
4542 specbind (Qinhibit_quit
, Qt
);
4544 call1 (Qtimer_event_handler
, chosen_timer
);
4545 Vdeactivate_mark
= old_deactivate_mark
;
4547 unbind_to (count
, Qnil
);
4549 /* Since we have handled the event,
4550 we don't need to tell the caller to wake up and do it. */
4551 /* But the caller must still wait for the next timer, so
4552 return 0 to indicate that. */
4555 nexttime
= make_timespec (0, 0);
4559 /* When we encounter a timer that is still waiting,
4560 return the amount of time to wait before it is ripe. */
4567 /* No timers are pending in the future. */
4568 /* Return 0 if we generated an event, and -1 if not. */
4574 /* Check whether a timer has fired. To prevent larger problems we simply
4575 disregard elements that are not proper timers. Do not make a circular
4576 timer list for the time being.
4578 Returns the time to wait until the next timer fires.
4579 If no timer is active, return an invalid value.
4581 As long as any timer is ripe, we run it. */
4586 struct timespec nexttime
;
4587 Lisp_Object timers
, idle_timers
;
4588 struct gcpro gcpro1
, gcpro2
;
4590 Lisp_Object tem
= Vinhibit_quit
;
4593 /* We use copies of the timers' lists to allow a timer to add itself
4594 again, without locking up Emacs if the newly added timer is
4595 already ripe when added. */
4597 /* Always consider the ordinary timers. */
4598 timers
= Fcopy_sequence (Vtimer_list
);
4599 /* Consider the idle timers only if Emacs is idle. */
4600 if (timespec_valid_p (timer_idleness_start_time
))
4601 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4605 Vinhibit_quit
= tem
;
4607 GCPRO2 (timers
, idle_timers
);
4611 nexttime
= timer_check_2 (timers
, idle_timers
);
4613 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4619 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4620 doc
: /* Return the current length of Emacs idleness, or nil.
4621 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4622 in the same style as (current-time).
4624 The value when Emacs is not idle is nil.
4626 PSEC is a multiple of the system clock resolution. */)
4629 if (timespec_valid_p (timer_idleness_start_time
))
4630 return make_lisp_time (timespec_sub (current_timespec (),
4631 timer_idleness_start_time
));
4636 /* Caches for modify_event_symbol. */
4637 static Lisp_Object accent_key_syms
;
4638 static Lisp_Object func_key_syms
;
4639 static Lisp_Object mouse_syms
;
4640 static Lisp_Object wheel_syms
;
4641 static Lisp_Object drag_n_drop_syms
;
4643 /* This is a list of keysym codes for special "accent" characters.
4644 It parallels lispy_accent_keys. */
4646 static const int lispy_accent_codes
[] =
4648 #ifdef XK_dead_circumflex
4653 #ifdef XK_dead_grave
4658 #ifdef XK_dead_tilde
4663 #ifdef XK_dead_diaeresis
4668 #ifdef XK_dead_macron
4673 #ifdef XK_dead_degree
4678 #ifdef XK_dead_acute
4683 #ifdef XK_dead_cedilla
4688 #ifdef XK_dead_breve
4693 #ifdef XK_dead_ogonek
4698 #ifdef XK_dead_caron
4703 #ifdef XK_dead_doubleacute
4704 XK_dead_doubleacute
,
4708 #ifdef XK_dead_abovedot
4713 #ifdef XK_dead_abovering
4723 #ifdef XK_dead_belowdot
4728 #ifdef XK_dead_voiced_sound
4729 XK_dead_voiced_sound
,
4733 #ifdef XK_dead_semivoiced_sound
4734 XK_dead_semivoiced_sound
,
4750 /* This is a list of Lisp names for special "accent" characters.
4751 It parallels lispy_accent_codes. */
4753 static const char *const lispy_accent_keys
[] =
4771 "dead-voiced-sound",
4772 "dead-semivoiced-sound",
4778 #define FUNCTION_KEY_OFFSET 0x0
4780 const char *const lispy_function_keys
[] =
4784 0, /* VK_LBUTTON 0x01 */
4785 0, /* VK_RBUTTON 0x02 */
4786 "cancel", /* VK_CANCEL 0x03 */
4787 0, /* VK_MBUTTON 0x04 */
4789 0, 0, 0, /* 0x05 .. 0x07 */
4791 "backspace", /* VK_BACK 0x08 */
4792 "tab", /* VK_TAB 0x09 */
4794 0, 0, /* 0x0A .. 0x0B */
4796 "clear", /* VK_CLEAR 0x0C */
4797 "return", /* VK_RETURN 0x0D */
4799 0, 0, /* 0x0E .. 0x0F */
4801 0, /* VK_SHIFT 0x10 */
4802 0, /* VK_CONTROL 0x11 */
4803 0, /* VK_MENU 0x12 */
4804 "pause", /* VK_PAUSE 0x13 */
4805 "capslock", /* VK_CAPITAL 0x14 */
4806 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4808 "junja", /* VK_JUNJA 0x17 */
4809 "final", /* VK_FINAL 0x18 */
4810 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4812 "escape", /* VK_ESCAPE 0x1B */
4813 "convert", /* VK_CONVERT 0x1C */
4814 "non-convert", /* VK_NONCONVERT 0x1D */
4815 "accept", /* VK_ACCEPT 0x1E */
4816 "mode-change", /* VK_MODECHANGE 0x1F */
4817 0, /* VK_SPACE 0x20 */
4818 "prior", /* VK_PRIOR 0x21 */
4819 "next", /* VK_NEXT 0x22 */
4820 "end", /* VK_END 0x23 */
4821 "home", /* VK_HOME 0x24 */
4822 "left", /* VK_LEFT 0x25 */
4823 "up", /* VK_UP 0x26 */
4824 "right", /* VK_RIGHT 0x27 */
4825 "down", /* VK_DOWN 0x28 */
4826 "select", /* VK_SELECT 0x29 */
4827 "print", /* VK_PRINT 0x2A */
4828 "execute", /* VK_EXECUTE 0x2B */
4829 "snapshot", /* VK_SNAPSHOT 0x2C */
4830 "insert", /* VK_INSERT 0x2D */
4831 "delete", /* VK_DELETE 0x2E */
4832 "help", /* VK_HELP 0x2F */
4834 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4836 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4838 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4840 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4842 0, 0, 0, 0, 0, 0, 0, 0, 0,
4843 0, 0, 0, 0, 0, 0, 0, 0, 0,
4844 0, 0, 0, 0, 0, 0, 0, 0,
4846 "lwindow", /* VK_LWIN 0x5B */
4847 "rwindow", /* VK_RWIN 0x5C */
4848 "apps", /* VK_APPS 0x5D */
4851 "kp-0", /* VK_NUMPAD0 0x60 */
4852 "kp-1", /* VK_NUMPAD1 0x61 */
4853 "kp-2", /* VK_NUMPAD2 0x62 */
4854 "kp-3", /* VK_NUMPAD3 0x63 */
4855 "kp-4", /* VK_NUMPAD4 0x64 */
4856 "kp-5", /* VK_NUMPAD5 0x65 */
4857 "kp-6", /* VK_NUMPAD6 0x66 */
4858 "kp-7", /* VK_NUMPAD7 0x67 */
4859 "kp-8", /* VK_NUMPAD8 0x68 */
4860 "kp-9", /* VK_NUMPAD9 0x69 */
4861 "kp-multiply", /* VK_MULTIPLY 0x6A */
4862 "kp-add", /* VK_ADD 0x6B */
4863 "kp-separator", /* VK_SEPARATOR 0x6C */
4864 "kp-subtract", /* VK_SUBTRACT 0x6D */
4865 "kp-decimal", /* VK_DECIMAL 0x6E */
4866 "kp-divide", /* VK_DIVIDE 0x6F */
4867 "f1", /* VK_F1 0x70 */
4868 "f2", /* VK_F2 0x71 */
4869 "f3", /* VK_F3 0x72 */
4870 "f4", /* VK_F4 0x73 */
4871 "f5", /* VK_F5 0x74 */
4872 "f6", /* VK_F6 0x75 */
4873 "f7", /* VK_F7 0x76 */
4874 "f8", /* VK_F8 0x77 */
4875 "f9", /* VK_F9 0x78 */
4876 "f10", /* VK_F10 0x79 */
4877 "f11", /* VK_F11 0x7A */
4878 "f12", /* VK_F12 0x7B */
4879 "f13", /* VK_F13 0x7C */
4880 "f14", /* VK_F14 0x7D */
4881 "f15", /* VK_F15 0x7E */
4882 "f16", /* VK_F16 0x7F */
4883 "f17", /* VK_F17 0x80 */
4884 "f18", /* VK_F18 0x81 */
4885 "f19", /* VK_F19 0x82 */
4886 "f20", /* VK_F20 0x83 */
4887 "f21", /* VK_F21 0x84 */
4888 "f22", /* VK_F22 0x85 */
4889 "f23", /* VK_F23 0x86 */
4890 "f24", /* VK_F24 0x87 */
4892 0, 0, 0, 0, /* 0x88 .. 0x8B */
4893 0, 0, 0, 0, /* 0x8C .. 0x8F */
4895 "kp-numlock", /* VK_NUMLOCK 0x90 */
4896 "scroll", /* VK_SCROLL 0x91 */
4897 /* Not sure where the following block comes from.
4898 Windows headers have NEC and Fujitsu specific keys in
4899 this block, but nothing generic. */
4900 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4901 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4902 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4903 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4904 "kp-end", /* VK_NUMPAD_END 0x96 */
4905 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4906 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4907 "kp-up", /* VK_NUMPAD_UP 0x99 */
4908 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4909 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4910 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4911 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4913 0, 0, /* 0x9E .. 0x9F */
4916 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4917 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4918 * No other API or message will distinguish left and right keys this way.
4923 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4924 to enable them selectively, and gives access to a few more functions.
4925 See lispy_multimedia_keys below. */
4926 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4927 0, 0, 0, /* 0xAD .. 0xAF Volume */
4928 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4929 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4931 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4932 0, 0, 0, 0, 0, 0, 0, 0, 0,
4934 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4935 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4936 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4939 "ax", /* VK_OEM_AX 0xE1 */
4940 0, /* VK_OEM_102 0xE2 */
4941 "ico-help", /* VK_ICO_HELP 0xE3 */
4942 "ico-00", /* VK_ICO_00 0xE4 */
4943 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4944 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4945 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4947 "reset", /* VK_OEM_RESET 0xE9 */
4948 "jump", /* VK_OEM_JUMP 0xEA */
4949 "oem-pa1", /* VK_OEM_PA1 0xEB */
4950 "oem-pa2", /* VK_OEM_PA2 0xEC */
4951 "oem-pa3", /* VK_OEM_PA3 0xED */
4952 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4953 "cusel", /* VK_OEM_CUSEL 0xEF */
4954 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4955 "finish", /* VK_OEM_FINISH 0xF1 */
4956 "copy", /* VK_OEM_COPY 0xF2 */
4957 "auto", /* VK_OEM_AUTO 0xF3 */
4958 "enlw", /* VK_OEM_ENLW 0xF4 */
4959 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4960 "attn", /* VK_ATTN 0xF6 */
4961 "crsel", /* VK_CRSEL 0xF7 */
4962 "exsel", /* VK_EXSEL 0xF8 */
4963 "ereof", /* VK_EREOF 0xF9 */
4964 "play", /* VK_PLAY 0xFA */
4965 "zoom", /* VK_ZOOM 0xFB */
4966 "noname", /* VK_NONAME 0xFC */
4967 "pa1", /* VK_PA1 0xFD */
4968 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4972 /* Some of these duplicate the "Media keys" on newer keyboards,
4973 but they are delivered to the application in a different way. */
4974 static const char *const lispy_multimedia_keys
[] =
4982 "browser-favorites",
5019 "toggle-dictate-command",
5025 "media-fast-forward",
5028 "media-channel-down"
5031 #else /* not HAVE_NTGUI */
5033 /* This should be dealt with in XTread_socket now, and that doesn't
5034 depend on the client system having the Kana syms defined. See also
5035 the XK_kana_A case below. */
5038 static const char *const lispy_kana_keys
[] =
5040 /* X Keysym value */
5041 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5042 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5043 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5044 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5045 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5046 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5047 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5048 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5049 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5050 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5051 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5052 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5053 "kana-i", "kana-u", "kana-e", "kana-o",
5054 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5055 "prolongedsound", "kana-A", "kana-I", "kana-U",
5056 "kana-E", "kana-O", "kana-KA", "kana-KI",
5057 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5058 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5059 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5060 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5061 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5062 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5063 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5064 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5065 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5066 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5067 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5068 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5070 #endif /* XK_kana_A */
5073 #define FUNCTION_KEY_OFFSET 0xff00
5075 /* You'll notice that this table is arranged to be conveniently
5076 indexed by X Windows keysym values. */
5077 static const char *const lispy_function_keys
[] =
5079 /* X Keysym value */
5081 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5082 "backspace", "tab", "linefeed", "clear",
5084 0, 0, 0, "pause", /* 0xff10...1f */
5085 0, 0, 0, 0, 0, 0, 0, "escape",
5087 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5088 "romaji", "hiragana", "katakana", "hiragana-katakana",
5089 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5090 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5091 "eisu-toggle", /* 0xff30...3f */
5092 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5093 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5095 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5096 "down", "prior", "next", "end",
5097 "begin", 0, 0, 0, 0, 0, 0, 0,
5098 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5109 "break", /* 0xff6b */
5112 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5113 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5114 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5115 0, 0, 0, 0, 0, 0, 0, 0,
5116 "kp-tab", /* 0xff89 */
5118 "kp-enter", /* 0xff8d */
5120 "kp-f1", /* 0xff91 */
5124 "kp-home", /* 0xff95 */
5129 "kp-prior", /* kp-page-up */
5130 "kp-next", /* kp-page-down */
5136 0, 0, 0, 0, 0, 0, 0, 0, 0,
5137 "kp-multiply", /* 0xffaa */
5142 "kp-divide", /* 0xffaf */
5143 "kp-0", /* 0xffb0 */
5144 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5147 "kp-equal", /* 0xffbd */
5148 "f1", /* 0xffbe */ /* IsFunctionKey */
5150 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5151 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5152 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5153 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5154 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5155 0, 0, 0, 0, 0, 0, 0, 0,
5156 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5157 0, 0, 0, 0, 0, 0, 0, "delete"
5160 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5161 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5163 static const char *const iso_lispy_function_keys
[] =
5165 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5166 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5167 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5168 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5169 "iso-lefttab", /* 0xfe20 */
5170 "iso-move-line-up", "iso-move-line-down",
5171 "iso-partial-line-up", "iso-partial-line-down",
5172 "iso-partial-space-left", "iso-partial-space-right",
5173 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5174 "iso-release-margin-left", "iso-release-margin-right",
5175 "iso-release-both-margins",
5176 "iso-fast-cursor-left", "iso-fast-cursor-right",
5177 "iso-fast-cursor-up", "iso-fast-cursor-down",
5178 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5179 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5182 #endif /* not HAVE_NTGUI */
5184 static Lisp_Object Vlispy_mouse_stem
;
5186 static const char *const lispy_wheel_names
[] =
5188 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5191 /* drag-n-drop events are generated when a set of selected files are
5192 dragged from another application and dropped onto an Emacs window. */
5193 static const char *const lispy_drag_n_drop_names
[] =
5198 /* Scroll bar parts. */
5199 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5200 static Lisp_Object Qbefore_handle
, Qhorizontal_handle
, Qafter_handle
;
5201 Lisp_Object Qup
, Qdown
, Qtop
, Qbottom
;
5202 Lisp_Object Qleft
, Qright
;
5203 static Lisp_Object Qleftmost
, Qrightmost
;
5204 static Lisp_Object Qend_scroll
;
5205 static Lisp_Object Qratio
;
5207 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5208 static Lisp_Object
*const scroll_bar_parts
[] = {
5209 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5210 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
,
5211 &Qbefore_handle
, &Qhorizontal_handle
, &Qafter_handle
,
5212 &Qleft
, &Qright
, &Qleftmost
, &Qrightmost
, &Qend_scroll
, &Qratio
5215 /* A vector, indexed by button number, giving the down-going location
5216 of currently depressed buttons, both scroll bar and non-scroll bar.
5218 The elements have the form
5219 (BUTTON-NUMBER MODIFIER-MASK . REST)
5220 where REST is the cdr of a position as it would be reported in the event.
5222 The make_lispy_event function stores positions here to tell the
5223 difference between click and drag events, and to store the starting
5224 location to be included in drag events. */
5226 static Lisp_Object button_down_location
;
5228 /* Information about the most recent up-going button event: Which
5229 button, what location, and what time. */
5231 static int last_mouse_button
;
5232 static int last_mouse_x
;
5233 static int last_mouse_y
;
5234 static Time button_down_time
;
5236 /* The number of clicks in this multiple-click. */
5238 static int double_click_count
;
5240 /* X and Y are frame-relative coordinates for a click or wheel event.
5241 Return a Lisp-style event list. */
5244 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5247 enum window_part part
;
5248 Lisp_Object posn
= Qnil
;
5249 Lisp_Object extra_info
= Qnil
;
5250 /* Coordinate pixel positions to return. */
5251 int xret
= 0, yret
= 0;
5252 /* The window under frame pixel coordinates (x,y) */
5253 Lisp_Object window
= f
5254 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5257 if (WINDOWP (window
))
5259 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5260 struct window
*w
= XWINDOW (window
);
5261 Lisp_Object string_info
= Qnil
;
5262 ptrdiff_t textpos
= 0;
5263 int col
= -1, row
= -1;
5264 int dx
= -1, dy
= -1;
5265 int width
= -1, height
= -1;
5266 Lisp_Object object
= Qnil
;
5268 /* Pixel coordinates relative to the window corner. */
5269 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5270 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5272 /* For text area clicks, return X, Y relative to the corner of
5273 this text area. Note that dX, dY etc are set below, by
5274 buffer_posn_from_coords. */
5275 if (part
== ON_TEXT
)
5277 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5278 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5280 /* For mode line and header line clicks, return X, Y relative to
5281 the left window edge. Use mode_line_string to look for a
5282 string on the click position. */
5283 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5288 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5289 /* Note that mode_line_string takes COL, ROW as pixels and
5290 converts them to characters. */
5293 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5294 &object
, &dx
, &dy
, &width
, &height
);
5295 if (STRINGP (string
))
5296 string_info
= Fcons (string
, make_number (charpos
));
5302 /* For fringes and margins, Y is relative to the area's (and the
5303 window's) top edge, while X is meaningless. */
5304 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5309 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5312 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5313 &object
, &dx
, &dy
, &width
, &height
);
5314 if (STRINGP (string
))
5315 string_info
= Fcons (string
, make_number (charpos
));
5316 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5318 else if (part
== ON_LEFT_FRINGE
)
5320 posn
= Qleft_fringe
;
5323 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5324 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5325 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5327 else if (part
== ON_RIGHT_FRINGE
)
5329 posn
= Qright_fringe
;
5332 - window_box_width (w
, LEFT_MARGIN_AREA
)
5333 - window_box_width (w
, TEXT_AREA
)
5334 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5335 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5337 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5339 else if (part
== ON_VERTICAL_BORDER
)
5341 posn
= Qvertical_line
;
5346 /* Nothing special for part == ON_SCROLL_BAR. */
5347 else if (part
== ON_RIGHT_DIVIDER
)
5349 posn
= Qright_divider
;
5350 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5354 else if (part
== ON_BOTTOM_DIVIDER
)
5356 posn
= Qbottom_divider
;
5357 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5362 /* For clicks in the text area, fringes, or margins, call
5363 buffer_posn_from_coords to extract TEXTPOS, the buffer
5364 position nearest to the click. */
5367 Lisp_Object string2
, object2
= Qnil
;
5368 struct display_pos p
;
5370 int width2
, height2
;
5371 /* The pixel X coordinate passed to buffer_posn_from_coords
5372 is the X coordinate relative to the text area for
5373 text-area and right-margin clicks, zero otherwise. */
5375 = (part
== ON_TEXT
) ? xret
5376 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5377 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5381 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5382 &object2
, &dx2
, &dy2
,
5384 textpos
= CHARPOS (p
.pos
);
5385 if (col
< 0) col
= x2
;
5386 if (row
< 0) row
= y2
;
5387 if (dx
< 0) dx
= dx2
;
5388 if (dy
< 0) dy
= dy2
;
5389 if (width
< 0) width
= width2
;
5390 if (height
< 0) height
= height2
;
5394 posn
= make_number (textpos
);
5395 if (STRINGP (string2
))
5396 string_info
= Fcons (string2
,
5397 make_number (CHARPOS (p
.string_pos
)));
5403 #ifdef HAVE_WINDOW_SYSTEM
5404 if (IMAGEP (object
))
5406 Lisp_Object image_map
, hotspot
;
5407 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5409 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5411 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5412 posn
= XCAR (hotspot
);
5419 Fcons (make_number (dx
), make_number (dy
)),
5420 Fcons (make_number (width
), make_number (height
)));
5423 extra_info
= Fcons (string_info
,
5424 Fcons (textpos
< 0 ? Qnil
: make_number (textpos
),
5425 Fcons (Fcons (make_number (col
),
5430 XSETFRAME (window
, f
);
5434 return Fcons (window
,
5436 Fcons (Fcons (make_number (xret
),
5437 make_number (yret
)),
5438 Fcons (make_number (t
),
5442 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5443 menu bar. This really means that Emacs draws and manages the menu
5444 bar as part of its normal display, and therefore can compute its
5447 toolkit_menubar_in_use (struct frame
*f
)
5449 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5450 return !(!FRAME_WINDOW_P (f
));
5456 /* Given a struct input_event, build the lisp event which represents
5457 it. If EVENT is 0, build a mouse movement event from the mouse
5458 movement buffer, which should have a movement event in it.
5460 Note that events must be passed to this function in the order they
5461 are received; this function stores the location of button presses
5462 in order to build drag events when the button is released. */
5465 make_lispy_event (struct input_event
*event
)
5469 switch (event
->kind
)
5471 /* A simple keystroke. */
5472 case ASCII_KEYSTROKE_EVENT
:
5473 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5475 Lisp_Object lispy_c
;
5476 EMACS_INT c
= event
->code
;
5477 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5480 eassert (c
== event
->code
);
5481 /* Turn ASCII characters into control characters
5483 if (event
->modifiers
& ctrl_modifier
)
5485 c
= make_ctrl_char (c
);
5486 event
->modifiers
&= ~ctrl_modifier
;
5490 /* Add in the other modifier bits. The shift key was taken care
5491 of by the X code. */
5492 c
|= (event
->modifiers
5493 & (meta_modifier
| alt_modifier
5494 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5495 /* Distinguish Shift-SPC from SPC. */
5496 if ((event
->code
) == 040
5497 && event
->modifiers
& shift_modifier
)
5498 c
|= shift_modifier
;
5499 button_down_time
= 0;
5500 XSETFASTINT (lispy_c
, c
);
5505 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5506 except that they are non-key events (last-nonmenu-event is nil). */
5507 case NS_NONKEY_EVENT
:
5510 /* A function key. The symbol may need to have modifier prefixes
5512 case NON_ASCII_KEYSTROKE_EVENT
:
5513 button_down_time
= 0;
5515 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5516 if (event
->code
== lispy_accent_codes
[i
])
5517 return modify_event_symbol (i
,
5519 Qfunction_key
, Qnil
,
5520 lispy_accent_keys
, &accent_key_syms
,
5521 ARRAYELTS (lispy_accent_keys
));
5525 if (event
->code
>= 0x400 && event
->code
< 0x500)
5526 return modify_event_symbol (event
->code
- 0x400,
5527 event
->modifiers
& ~shift_modifier
,
5528 Qfunction_key
, Qnil
,
5529 lispy_kana_keys
, &func_key_syms
,
5530 ARRAYELTS (lispy_kana_keys
));
5531 #endif /* XK_kana_A */
5534 #ifdef ISO_FUNCTION_KEY_OFFSET
5535 if (event
->code
< FUNCTION_KEY_OFFSET
5536 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5537 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5539 Qfunction_key
, Qnil
,
5540 iso_lispy_function_keys
, &func_key_syms
,
5541 ARRAYELTS (iso_lispy_function_keys
));
5544 /* Handle system-specific or unknown keysyms. */
5545 if (event
->code
& (1 << 28)
5546 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5547 || (event
->code
- FUNCTION_KEY_OFFSET
5548 >= ARRAYELTS (lispy_function_keys
))
5549 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5551 /* We need to use an alist rather than a vector as the cache
5552 since we can't make a vector long enough. */
5553 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5554 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5555 return modify_event_symbol (event
->code
,
5558 KVAR (current_kboard
, Vsystem_key_alist
),
5559 0, &KVAR (current_kboard
, system_key_syms
),
5563 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5565 Qfunction_key
, Qnil
,
5566 lispy_function_keys
, &func_key_syms
,
5567 ARRAYELTS (lispy_function_keys
));
5570 case MULTIMEDIA_KEY_EVENT
:
5571 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5572 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5574 return modify_event_symbol (event
->code
, event
->modifiers
,
5575 Qfunction_key
, Qnil
,
5576 lispy_multimedia_keys
, &func_key_syms
,
5577 ARRAYELTS (lispy_multimedia_keys
));
5582 /* A mouse click. Figure out where it is, decide whether it's
5583 a press, click or drag, and build the appropriate structure. */
5584 case MOUSE_CLICK_EVENT
:
5586 case GPM_CLICK_EVENT
:
5588 #ifndef USE_TOOLKIT_SCROLL_BARS
5589 case SCROLL_BAR_CLICK_EVENT
:
5590 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5593 int button
= event
->code
;
5595 Lisp_Object position
;
5596 Lisp_Object
*start_pos_ptr
;
5597 Lisp_Object start_pos
;
5601 /* Build the position as appropriate for this mouse click. */
5602 if (event
->kind
== MOUSE_CLICK_EVENT
5604 || event
->kind
== GPM_CLICK_EVENT
5608 struct frame
*f
= XFRAME (event
->frame_or_window
);
5611 /* Ignore mouse events that were made on frame that
5612 have been deleted. */
5613 if (! FRAME_LIVE_P (f
))
5616 /* EVENT->x and EVENT->y are frame-relative pixel
5617 coordinates at this place. Under old redisplay, COLUMN
5618 and ROW are set to frame relative glyph coordinates
5619 which are then used to determine whether this click is
5620 in a menu (non-toolkit version). */
5621 if (!toolkit_menubar_in_use (f
))
5623 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5624 &column
, &row
, NULL
, 1);
5626 /* In the non-toolkit version, clicks on the menu bar
5627 are ordinary button events in the event buffer.
5628 Distinguish them, and invoke the menu.
5630 (In the toolkit version, the toolkit handles the
5631 menu bar and Emacs doesn't know about it until
5632 after the user makes a selection.) */
5633 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5634 && (event
->modifiers
& down_modifier
))
5636 Lisp_Object items
, item
;
5638 /* Find the menu bar item under `column'. */
5640 items
= FRAME_MENU_BAR_ITEMS (f
);
5641 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5643 Lisp_Object pos
, string
;
5644 string
= AREF (items
, i
+ 1);
5645 pos
= AREF (items
, i
+ 3);
5648 if (column
>= XINT (pos
)
5649 && column
< XINT (pos
) + SCHARS (string
))
5651 item
= AREF (items
, i
);
5656 /* ELisp manual 2.4b says (x y) are window
5657 relative but code says they are
5659 position
= list4 (event
->frame_or_window
,
5661 Fcons (event
->x
, event
->y
),
5662 make_number (event
->timestamp
));
5664 return list2 (item
, position
);
5668 position
= make_lispy_position (f
, event
->x
, event
->y
,
5671 #ifndef USE_TOOLKIT_SCROLL_BARS
5674 /* It's a scrollbar click. */
5676 Lisp_Object portion_whole
;
5679 window
= event
->frame_or_window
;
5680 portion_whole
= Fcons (event
->x
, event
->y
);
5681 part
= *scroll_bar_parts
[(int) event
->part
];
5683 position
= list5 (window
, Qvertical_scroll_bar
,
5684 portion_whole
, make_number (event
->timestamp
),
5687 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5689 if (button
>= ASIZE (button_down_location
))
5691 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5692 button_down_location
= larger_vector (button_down_location
,
5694 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5697 start_pos_ptr
= aref_addr (button_down_location
, button
);
5698 start_pos
= *start_pos_ptr
;
5699 *start_pos_ptr
= Qnil
;
5702 /* On window-system frames, use the value of
5703 double-click-fuzz as is. On other frames, interpret it
5704 as a multiple of 1/8 characters. */
5708 if (WINDOWP (event
->frame_or_window
))
5709 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5710 else if (FRAMEP (event
->frame_or_window
))
5711 f
= XFRAME (event
->frame_or_window
);
5715 if (FRAME_WINDOW_P (f
))
5716 fuzz
= double_click_fuzz
;
5718 fuzz
= double_click_fuzz
/ 8;
5720 is_double
= (button
== last_mouse_button
5721 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5722 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5723 && button_down_time
!= 0
5724 && (EQ (Vdouble_click_time
, Qt
)
5725 || (NATNUMP (Vdouble_click_time
)
5726 && (event
->timestamp
- button_down_time
5727 < XFASTINT (Vdouble_click_time
)))));
5730 last_mouse_button
= button
;
5731 last_mouse_x
= XINT (event
->x
);
5732 last_mouse_y
= XINT (event
->y
);
5734 /* If this is a button press, squirrel away the location, so
5735 we can decide later whether it was a click or a drag. */
5736 if (event
->modifiers
& down_modifier
)
5740 double_click_count
++;
5741 event
->modifiers
|= ((double_click_count
> 2)
5746 double_click_count
= 1;
5747 button_down_time
= event
->timestamp
;
5748 *start_pos_ptr
= Fcopy_alist (position
);
5749 ignore_mouse_drag_p
= 0;
5752 /* Now we're releasing a button - check the co-ordinates to
5753 see if this was a click or a drag. */
5754 else if (event
->modifiers
& up_modifier
)
5756 /* If we did not see a down before this up, ignore the up.
5757 Probably this happened because the down event chose a
5758 menu item. It would be an annoyance to treat the
5759 release of the button that chose the menu item as a
5762 if (!CONSP (start_pos
))
5765 event
->modifiers
&= ~up_modifier
;
5768 Lisp_Object new_down
, down
;
5769 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5771 /* The third element of every position
5772 should be the (x,y) pair. */
5773 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5774 new_down
= Fcar (Fcdr (Fcdr (position
)));
5777 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5779 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5780 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5783 if (ignore_mouse_drag_p
)
5785 event
->modifiers
|= click_modifier
;
5786 ignore_mouse_drag_p
= 0;
5788 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5789 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5790 /* Maybe the mouse has moved a lot, caused scrolling, and
5791 eventually ended up at the same screen position (but
5792 not buffer position) in which case it is a drag, not
5794 /* FIXME: OTOH if the buffer position has changed
5795 because of a timer or process filter rather than
5796 because of mouse movement, it should be considered as
5797 a click. But mouse-drag-region completely ignores
5798 this case and it hasn't caused any real problem, so
5799 it's probably OK to ignore it as well. */
5800 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5801 /* Mouse hasn't moved (much). */
5802 event
->modifiers
|= click_modifier
;
5805 button_down_time
= 0;
5806 event
->modifiers
|= drag_modifier
;
5809 /* Don't check is_double; treat this as multiple
5810 if the down-event was multiple. */
5811 if (double_click_count
> 1)
5812 event
->modifiers
|= ((double_click_count
> 2)
5818 /* Every mouse event should either have the down_modifier or
5819 the up_modifier set. */
5823 /* Get the symbol we should use for the mouse click. */
5826 head
= modify_event_symbol (button
,
5828 Qmouse_click
, Vlispy_mouse_stem
,
5831 ASIZE (mouse_syms
));
5832 if (event
->modifiers
& drag_modifier
)
5833 return list3 (head
, start_pos
, position
);
5834 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5835 return list3 (head
, position
, make_number (double_click_count
));
5837 return list2 (head
, position
);
5842 case HORIZ_WHEEL_EVENT
:
5844 Lisp_Object position
;
5847 /* Build the position as appropriate for this mouse click. */
5848 struct frame
*f
= XFRAME (event
->frame_or_window
);
5850 /* Ignore wheel events that were made on frame that have been
5852 if (! FRAME_LIVE_P (f
))
5855 position
= make_lispy_position (f
, event
->x
, event
->y
,
5858 /* Set double or triple modifiers to indicate the wheel speed. */
5860 /* On window-system frames, use the value of
5861 double-click-fuzz as is. On other frames, interpret it
5862 as a multiple of 1/8 characters. */
5868 if (WINDOWP (event
->frame_or_window
))
5869 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5870 else if (FRAMEP (event
->frame_or_window
))
5871 fr
= XFRAME (event
->frame_or_window
);
5875 fuzz
= FRAME_WINDOW_P (fr
)
5876 ? double_click_fuzz
: double_click_fuzz
/ 8;
5878 if (event
->modifiers
& up_modifier
)
5880 /* Emit a wheel-up event. */
5881 event
->modifiers
&= ~up_modifier
;
5884 else if (event
->modifiers
& down_modifier
)
5886 /* Emit a wheel-down event. */
5887 event
->modifiers
&= ~down_modifier
;
5891 /* Every wheel event should either have the down_modifier or
5892 the up_modifier set. */
5895 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5898 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5899 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5900 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5901 && button_down_time
!= 0
5902 && (EQ (Vdouble_click_time
, Qt
)
5903 || (NATNUMP (Vdouble_click_time
)
5904 && (event
->timestamp
- button_down_time
5905 < XFASTINT (Vdouble_click_time
)))));
5908 double_click_count
++;
5909 event
->modifiers
|= ((double_click_count
> 2)
5915 double_click_count
= 1;
5916 event
->modifiers
|= click_modifier
;
5919 button_down_time
= event
->timestamp
;
5920 /* Use a negative value to distinguish wheel from mouse button. */
5921 last_mouse_button
= - (1 + symbol_num
);
5922 last_mouse_x
= XINT (event
->x
);
5923 last_mouse_y
= XINT (event
->y
);
5925 /* Get the symbol we should use for the wheel event. */
5926 head
= modify_event_symbol (symbol_num
,
5932 ASIZE (wheel_syms
));
5935 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5936 return list3 (head
, position
, make_number (double_click_count
));
5938 return list2 (head
, position
);
5942 #ifdef USE_TOOLKIT_SCROLL_BARS
5944 /* We don't have down and up events if using toolkit scroll bars,
5945 so make this always a click event. Store in the `part' of
5946 the Lisp event a symbol which maps to the following actions:
5948 `above_handle' page up
5949 `below_handle' page down
5953 `bottom' bottom of buffer
5954 `handle' thumb has been dragged.
5955 `end-scroll' end of interaction with scroll bar
5957 The incoming input_event contains in its `part' member an
5958 index of type `enum scroll_bar_part' which we can use as an
5959 index in scroll_bar_parts to get the appropriate symbol. */
5961 case SCROLL_BAR_CLICK_EVENT
:
5963 Lisp_Object position
, head
, window
, portion_whole
, part
;
5965 window
= event
->frame_or_window
;
5966 portion_whole
= Fcons (event
->x
, event
->y
);
5967 part
= *scroll_bar_parts
[(int) event
->part
];
5969 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5970 make_number (event
->timestamp
), part
);
5972 /* Always treat scroll bar events as clicks. */
5973 event
->modifiers
|= click_modifier
;
5974 event
->modifiers
&= ~up_modifier
;
5976 if (event
->code
>= ASIZE (mouse_syms
))
5977 mouse_syms
= larger_vector (mouse_syms
,
5978 event
->code
- ASIZE (mouse_syms
) + 1,
5981 /* Get the symbol we should use for the mouse click. */
5982 head
= modify_event_symbol (event
->code
,
5987 ASIZE (mouse_syms
));
5988 return list2 (head
, position
);
5991 case HORIZONTAL_SCROLL_BAR_CLICK_EVENT
:
5993 Lisp_Object position
, head
, window
, portion_whole
, part
;
5995 window
= event
->frame_or_window
;
5996 portion_whole
= Fcons (event
->x
, event
->y
);
5997 part
= *scroll_bar_parts
[(int) event
->part
];
5999 position
= list5 (window
, Qhorizontal_scroll_bar
, portion_whole
,
6000 make_number (event
->timestamp
), part
);
6002 /* Always treat scroll bar events as clicks. */
6003 event
->modifiers
|= click_modifier
;
6004 event
->modifiers
&= ~up_modifier
;
6006 if (event
->code
>= ASIZE (mouse_syms
))
6007 mouse_syms
= larger_vector (mouse_syms
,
6008 event
->code
- ASIZE (mouse_syms
) + 1,
6011 /* Get the symbol we should use for the mouse click. */
6012 head
= modify_event_symbol (event
->code
,
6017 ASIZE (mouse_syms
));
6018 return list2 (head
, position
);
6021 #endif /* USE_TOOLKIT_SCROLL_BARS */
6023 case DRAG_N_DROP_EVENT
:
6026 Lisp_Object head
, position
;
6029 f
= XFRAME (event
->frame_or_window
);
6032 /* Ignore mouse events that were made on frames that
6033 have been deleted. */
6034 if (! FRAME_LIVE_P (f
))
6037 position
= make_lispy_position (f
, event
->x
, event
->y
,
6040 head
= modify_event_symbol (0, event
->modifiers
,
6042 lispy_drag_n_drop_names
,
6043 &drag_n_drop_syms
, 1);
6044 return list3 (head
, position
, files
);
6047 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
6048 || defined (HAVE_NS) || defined (USE_GTK)
6049 case MENU_BAR_EVENT
:
6050 if (EQ (event
->arg
, event
->frame_or_window
))
6051 /* This is the prefix key. We translate this to
6052 `(menu_bar)' because the code in keyboard.c for menu
6053 events, which we use, relies on this. */
6054 return list1 (Qmenu_bar
);
6058 case SELECT_WINDOW_EVENT
:
6059 /* Make an event (select-window (WINDOW)). */
6060 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6062 case TOOL_BAR_EVENT
:
6063 if (EQ (event
->arg
, event
->frame_or_window
))
6064 /* This is the prefix key. We translate this to
6065 `(tool_bar)' because the code in keyboard.c for tool bar
6066 events, which we use, relies on this. */
6067 return list1 (Qtool_bar
);
6068 else if (SYMBOLP (event
->arg
))
6069 return apply_modifiers (event
->modifiers
, event
->arg
);
6072 case USER_SIGNAL_EVENT
:
6073 /* A user signal. */
6075 char *name
= find_user_signal_name (event
->code
);
6078 return intern (name
);
6081 case SAVE_SESSION_EVENT
:
6082 return Qsave_session
;
6087 return Fcons (Qdbus_event
, event
->arg
);
6089 #endif /* HAVE_DBUS */
6091 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6092 case FILE_NOTIFY_EVENT
:
6094 return Fcons (Qfile_notify
, event
->arg
);
6096 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6098 case CONFIG_CHANGED_EVENT
:
6099 return list3 (Qconfig_changed_event
,
6100 event
->arg
, event
->frame_or_window
);
6102 /* The 'kind' field of the event is something we don't recognize. */
6109 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6110 Lisp_Object x
, Lisp_Object y
, Time t
)
6112 /* Is it a scroll bar movement? */
6113 if (frame
&& ! NILP (bar_window
))
6115 Lisp_Object part_sym
;
6117 part_sym
= *scroll_bar_parts
[(int) part
];
6118 return list2 (Qscroll_bar_movement
,
6120 Qvertical_scroll_bar
,
6125 /* Or is it an ordinary mouse movement? */
6128 Lisp_Object position
;
6129 position
= make_lispy_position (frame
, x
, y
, t
);
6130 return list2 (Qmouse_movement
, position
);
6134 /* Construct a switch frame event. */
6136 make_lispy_switch_frame (Lisp_Object frame
)
6138 return list2 (Qswitch_frame
, frame
);
6142 make_lispy_focus_in (Lisp_Object frame
)
6144 return list2 (Qfocus_in
, frame
);
6147 #ifdef HAVE_WINDOW_SYSTEM
6150 make_lispy_focus_out (Lisp_Object frame
)
6152 return list2 (Qfocus_out
, frame
);
6155 #endif /* HAVE_WINDOW_SYSTEM */
6157 /* Manipulating modifiers. */
6159 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6161 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6162 SYMBOL's name of the end of the modifiers; the string from this
6163 position is the unmodified symbol name.
6165 This doesn't use any caches. */
6168 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6174 CHECK_SYMBOL (symbol
);
6177 name
= SYMBOL_NAME (symbol
);
6179 for (i
= 0; i
< SBYTES (name
) - 1; )
6181 ptrdiff_t this_mod_end
= 0;
6184 /* See if the name continues with a modifier word.
6185 Check that the word appears, but don't check what follows it.
6186 Set this_mod and this_mod_end to record what we find. */
6188 switch (SREF (name
, i
))
6190 #define SINGLE_LETTER_MOD(BIT) \
6191 (this_mod_end = i + 1, this_mod = BIT)
6194 SINGLE_LETTER_MOD (alt_modifier
);
6198 SINGLE_LETTER_MOD (ctrl_modifier
);
6202 SINGLE_LETTER_MOD (hyper_modifier
);
6206 SINGLE_LETTER_MOD (meta_modifier
);
6210 SINGLE_LETTER_MOD (shift_modifier
);
6214 SINGLE_LETTER_MOD (super_modifier
);
6217 #undef SINGLE_LETTER_MOD
6219 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6220 if (i + LEN + 1 <= SBYTES (name) \
6221 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6223 this_mod_end = i + LEN; \
6228 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6229 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6230 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6234 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6236 #undef MULTI_LETTER_MOD
6240 /* If we found no modifier, stop looking for them. */
6241 if (this_mod_end
== 0)
6244 /* Check there is a dash after the modifier, so that it
6245 really is a modifier. */
6246 if (this_mod_end
>= SBYTES (name
)
6247 || SREF (name
, this_mod_end
) != '-')
6250 /* This modifier is real; look for another. */
6251 modifiers
|= this_mod
;
6252 i
= this_mod_end
+ 1;
6255 /* Should we include the `click' modifier? */
6256 if (! (modifiers
& (down_modifier
| drag_modifier
6257 | double_modifier
| triple_modifier
))
6258 && i
+ 7 == SBYTES (name
)
6259 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6260 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6261 modifiers
|= click_modifier
;
6263 if (! (modifiers
& (double_modifier
| triple_modifier
))
6264 && i
+ 6 < SBYTES (name
)
6265 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6266 modifiers
|= click_modifier
;
6274 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6275 prepended to the string BASE[0..BASE_LEN-1].
6276 This doesn't use any caches. */
6278 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6280 /* Since BASE could contain nulls, we can't use intern here; we have
6281 to use Fintern, which expects a genuine Lisp_String, and keeps a
6283 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6289 /* Only the event queue may use the `up' modifier; it should always
6290 be turned into a click or drag event before presented to lisp code. */
6291 if (modifiers
& up_modifier
)
6294 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6295 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6296 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6297 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6298 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6299 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6300 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6301 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6302 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6303 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6304 /* The click modifier is denoted by the absence of other modifiers. */
6308 mod_len
= p
- new_mods
;
6312 Lisp_Object new_name
;
6314 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6315 mod_len
+ base_len_byte
);
6316 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6317 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6319 return Fintern (new_name
, Qnil
);
6324 static const char *const modifier_names
[] =
6326 "up", "down", "drag", "click", "double", "triple", 0, 0,
6327 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6328 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6330 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6332 static Lisp_Object modifier_symbols
;
6334 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6336 lispy_modifier_list (int modifiers
)
6338 Lisp_Object modifier_list
;
6341 modifier_list
= Qnil
;
6342 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6343 if (modifiers
& (1<<i
))
6344 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6347 return modifier_list
;
6351 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6352 where UNMODIFIED is the unmodified form of SYMBOL,
6353 MASK is the set of modifiers present in SYMBOL's name.
6354 This is similar to parse_modifiers_uncached, but uses the cache in
6355 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6356 Qevent_symbol_elements property. */
6358 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6361 parse_modifiers (Lisp_Object symbol
)
6363 Lisp_Object elements
;
6365 if (INTEGERP (symbol
))
6366 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6367 else if (!SYMBOLP (symbol
))
6370 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6371 if (CONSP (elements
))
6376 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6377 Lisp_Object unmodified
;
6380 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6381 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6384 if (modifiers
& ~INTMASK
)
6386 XSETFASTINT (mask
, modifiers
);
6387 elements
= list2 (unmodified
, mask
);
6389 /* Cache the parsing results on SYMBOL. */
6390 Fput (symbol
, Qevent_symbol_element_mask
,
6392 Fput (symbol
, Qevent_symbol_elements
,
6393 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6395 /* Since we know that SYMBOL is modifiers applied to unmodified,
6396 it would be nice to put that in unmodified's cache.
6397 But we can't, since we're not sure that parse_modifiers is
6404 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6405 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6406 doc
: /* Parse the event symbol. For internal use. */)
6407 (Lisp_Object symbol
)
6409 /* Fill the cache if needed. */
6410 parse_modifiers (symbol
);
6411 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6412 and use the Lispier representation stored on Qevent_symbol_elements
6414 return Fget (symbol
, Qevent_symbol_elements
);
6417 /* Apply the modifiers MODIFIERS to the symbol BASE.
6418 BASE must be unmodified.
6420 This is like apply_modifiers_uncached, but uses BASE's
6421 Qmodifier_cache property, if present. It also builds
6422 Qevent_symbol_elements properties, since it has that info anyway.
6424 apply_modifiers copies the value of BASE's Qevent_kind property to
6425 the modified symbol. */
6427 apply_modifiers (int modifiers
, Lisp_Object base
)
6429 Lisp_Object cache
, idx
, entry
, new_symbol
;
6431 /* Mask out upper bits. We don't know where this value's been. */
6432 modifiers
&= INTMASK
;
6434 if (INTEGERP (base
))
6435 return make_number (XINT (base
) | modifiers
);
6437 /* The click modifier never figures into cache indices. */
6438 cache
= Fget (base
, Qmodifier_cache
);
6439 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6440 entry
= assq_no_quit (idx
, cache
);
6443 new_symbol
= XCDR (entry
);
6446 /* We have to create the symbol ourselves. */
6447 new_symbol
= apply_modifiers_uncached (modifiers
,
6448 SSDATA (SYMBOL_NAME (base
)),
6449 SCHARS (SYMBOL_NAME (base
)),
6450 SBYTES (SYMBOL_NAME (base
)));
6452 /* Add the new symbol to the base's cache. */
6453 entry
= Fcons (idx
, new_symbol
);
6454 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6456 /* We have the parsing info now for free, so we could add it to
6458 XSETFASTINT (idx, modifiers);
6459 Fput (new_symbol, Qevent_symbol_element_mask,
6461 Fput (new_symbol, Qevent_symbol_elements,
6462 Fcons (base, lispy_modifier_list (modifiers)));
6463 Sadly, this is only correct if `base' is indeed a base event,
6464 which is not necessarily the case. -stef */
6467 /* Make sure this symbol is of the same kind as BASE.
6469 You'd think we could just set this once and for all when we
6470 intern the symbol above, but reorder_modifiers may call us when
6471 BASE's property isn't set right; we can't assume that just
6472 because it has a Qmodifier_cache property it must have its
6473 Qevent_kind set right as well. */
6474 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6478 kind
= Fget (base
, Qevent_kind
);
6480 Fput (new_symbol
, Qevent_kind
, kind
);
6487 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6488 return a symbol with the modifiers placed in the canonical order.
6489 Canonical order is alphabetical, except for down and drag, which
6490 always come last. The 'click' modifier is never written out.
6492 Fdefine_key calls this to make sure that (for example) C-M-foo
6493 and M-C-foo end up being equivalent in the keymap. */
6496 reorder_modifiers (Lisp_Object symbol
)
6498 /* It's hopefully okay to write the code this way, since everything
6499 will soon be in caches, and no consing will be done at all. */
6502 parsed
= parse_modifiers (symbol
);
6503 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6508 /* For handling events, we often want to produce a symbol whose name
6509 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6510 to some base, like the name of a function key or mouse button.
6511 modify_event_symbol produces symbols of this sort.
6513 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6514 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6517 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6518 into symbol names, or a string specifying a name stem used to
6519 construct a symbol name or the form `STEM-N', where N is the decimal
6520 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6521 non-nil; otherwise NAME_TABLE is used.
6523 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6524 persist between calls to modify_event_symbol that it can use to
6525 store a cache of the symbols it's generated for this NAME_TABLE
6526 before. The object stored there may be a vector or an alist.
6528 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6530 MODIFIERS is a set of modifier bits (as given in struct input_events)
6531 whose prefixes should be applied to the symbol name.
6533 SYMBOL_KIND is the value to be placed in the event_kind property of
6534 the returned symbol.
6536 The symbols we create are supposed to have an
6537 `event-symbol-elements' property, which lists the modifiers present
6538 in the symbol's name. */
6541 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6542 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6543 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6546 Lisp_Object symbol_int
;
6548 /* Get rid of the "vendor-specific" bit here. */
6549 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6551 /* Is this a request for a valid symbol? */
6552 if (symbol_num
< 0 || symbol_num
>= table_size
)
6555 if (CONSP (*symbol_table
))
6556 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6558 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6559 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6560 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6561 we've never used that symbol before. */
6564 if (! VECTORP (*symbol_table
)
6565 || ASIZE (*symbol_table
) != table_size
)
6569 XSETFASTINT (size
, table_size
);
6570 *symbol_table
= Fmake_vector (size
, Qnil
);
6573 value
= AREF (*symbol_table
, symbol_num
);
6576 /* Have we already used this symbol before? */
6579 /* No; let's create it. */
6580 if (CONSP (name_alist_or_stem
))
6581 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6582 else if (STRINGP (name_alist_or_stem
))
6585 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6586 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6588 buf
= SAFE_ALLOCA (len
);
6589 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6590 XINT (symbol_int
) + 1);
6591 value
= intern (buf
);
6594 else if (name_table
!= 0 && name_table
[symbol_num
])
6595 value
= intern (name_table
[symbol_num
]);
6597 #ifdef HAVE_WINDOW_SYSTEM
6600 char *name
= x_get_keysym_name (symbol_num
);
6602 value
= intern (name
);
6608 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6609 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6610 value
= intern (buf
);
6613 if (CONSP (*symbol_table
))
6614 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6616 ASET (*symbol_table
, symbol_num
, value
);
6618 /* Fill in the cache entries for this symbol; this also
6619 builds the Qevent_symbol_elements property, which the user
6621 apply_modifiers (modifiers
& click_modifier
, value
);
6622 Fput (value
, Qevent_kind
, symbol_kind
);
6625 /* Apply modifiers to that symbol. */
6626 return apply_modifiers (modifiers
, value
);
6629 /* Convert a list that represents an event type,
6630 such as (ctrl meta backspace), into the usual representation of that
6631 event type as a number or a symbol. */
6633 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6634 doc
: /* Convert the event description list EVENT-DESC to an event type.
6635 EVENT-DESC should contain one base event type (a character or symbol)
6636 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6637 drag, down, double or triple). The base must be last.
6638 The return value is an event type (a character or symbol) which
6639 has the same base event type and all the specified modifiers. */)
6640 (Lisp_Object event_desc
)
6648 while (CONSP (rest
))
6656 /* Given a symbol, see if it is a modifier name. */
6657 if (SYMBOLP (elt
) && CONSP (rest
))
6658 this = parse_solitary_modifier (elt
);
6662 else if (!NILP (base
))
6663 error ("Two bases given in one event");
6669 /* Let the symbol A refer to the character A. */
6670 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6671 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6673 if (INTEGERP (base
))
6675 /* Turn (shift a) into A. */
6676 if ((modifiers
& shift_modifier
) != 0
6677 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6679 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6680 modifiers
&= ~shift_modifier
;
6683 /* Turn (control a) into C-a. */
6684 if (modifiers
& ctrl_modifier
)
6685 return make_number ((modifiers
& ~ctrl_modifier
)
6686 | make_ctrl_char (XINT (base
)));
6688 return make_number (modifiers
| XINT (base
));
6690 else if (SYMBOLP (base
))
6691 return apply_modifiers (modifiers
, base
);
6693 error ("Invalid base event");
6696 /* Try to recognize SYMBOL as a modifier name.
6697 Return the modifier flag bit, or 0 if not recognized. */
6700 parse_solitary_modifier (Lisp_Object symbol
)
6702 Lisp_Object name
= SYMBOL_NAME (symbol
);
6704 switch (SREF (name
, 0))
6706 #define SINGLE_LETTER_MOD(BIT) \
6707 if (SBYTES (name) == 1) \
6710 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6711 if (LEN == SBYTES (name) \
6712 && ! memcmp (SDATA (name), NAME, LEN)) \
6716 SINGLE_LETTER_MOD (alt_modifier
);
6720 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6724 SINGLE_LETTER_MOD (ctrl_modifier
);
6728 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6729 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6733 SINGLE_LETTER_MOD (hyper_modifier
);
6737 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6741 SINGLE_LETTER_MOD (meta_modifier
);
6745 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6749 SINGLE_LETTER_MOD (shift_modifier
);
6753 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6754 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6755 SINGLE_LETTER_MOD (super_modifier
);
6759 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6760 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6761 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6765 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6768 #undef SINGLE_LETTER_MOD
6769 #undef MULTI_LETTER_MOD
6775 /* Return true if EVENT is a list whose elements are all integers or symbols.
6776 Such a list is not valid as an event,
6777 but it can be a Lucid-style event type list. */
6780 lucid_event_type_list_p (Lisp_Object object
)
6784 if (! CONSP (object
))
6787 if (EQ (XCAR (object
), Qhelp_echo
)
6788 || EQ (XCAR (object
), Qvertical_line
)
6789 || EQ (XCAR (object
), Qmode_line
)
6790 || EQ (XCAR (object
), Qheader_line
))
6793 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6797 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6804 /* Return true if terminal input chars are available.
6805 Also, store the return value into INPUT_PENDING.
6807 Serves the purpose of ioctl (0, FIONREAD, ...)
6808 but works even if FIONREAD does not exist.
6809 (In fact, this may actually read some input.)
6811 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6812 timer events that are ripe.
6813 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6814 events (FOCUS_IN_EVENT).
6815 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6816 movements and toolkit scroll bar thumb drags. */
6819 get_input_pending (int flags
)
6821 /* First of all, have we already counted some input? */
6822 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6824 /* If input is being read as it arrives, and we have none, there is none. */
6825 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6827 /* Try to read some input and see how much we get. */
6829 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6832 return input_pending
;
6835 /* Put a BUFFER_SWITCH_EVENT in the buffer
6836 so that read_key_sequence will notice the new current buffer. */
6839 record_asynch_buffer_change (void)
6841 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6842 The purpose of the event is to make read_key_sequence look up the
6843 keymaps again. If we aren't in read_key_sequence, we don't need one,
6844 and the event could cause trouble by messing up (input-pending-p).
6845 Note: Fwaiting_for_user_input_p always returns nil when async
6846 subprocesses aren't supported. */
6847 if (!NILP (Fwaiting_for_user_input_p ()))
6849 struct input_event event
;
6852 event
.kind
= BUFFER_SWITCH_EVENT
;
6853 event
.frame_or_window
= Qnil
;
6856 /* Make sure no interrupt happens while storing the event. */
6858 if (interrupt_input
)
6859 kbd_buffer_store_event (&event
);
6864 kbd_buffer_store_event (&event
);
6870 /* Read any terminal input already buffered up by the system
6871 into the kbd_buffer, but do not wait.
6873 Return the number of keyboard chars read, or -1 meaning
6874 this is a bad time to try to read input. */
6883 /* Store pending user signal events, if any. */
6884 store_user_signal_events ();
6886 /* Loop through the available terminals, and call their input hooks. */
6890 struct terminal
*next
= t
->next_terminal
;
6892 if (t
->read_socket_hook
)
6895 struct input_event hold_quit
;
6897 if (input_blocked_p ())
6899 pending_signals
= 1;
6903 EVENT_INIT (hold_quit
);
6904 hold_quit
.kind
= NO_EVENT
;
6906 /* No need for FIONREAD or fcntl; just say don't wait. */
6907 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6910 if (nr
== -1) /* Not OK to read input now. */
6914 else if (nr
== -2) /* Non-transient error. */
6916 /* The terminal device terminated; it should be closed. */
6918 /* Kill Emacs if this was our last terminal. */
6919 if (!terminal_list
->next_terminal
)
6920 /* Formerly simply reported no input, but that
6921 sometimes led to a failure of Emacs to terminate.
6922 SIGHUP seems appropriate if we can't reach the
6924 /* ??? Is it really right to send the signal just to
6925 this process rather than to the whole process
6926 group? Perhaps on systems with FIONREAD Emacs is
6927 alone in its group. */
6928 terminate_due_to_signal (SIGHUP
, 10);
6930 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6933 XSETTERMINAL (tmp
, t
);
6934 Fdelete_terminal (tmp
, Qnoelisp
);
6938 /* If there was no error, make sure the pointer
6939 is visible for all frames on this terminal. */
6942 Lisp_Object tail
, frame
;
6944 FOR_EACH_FRAME (tail
, frame
)
6946 struct frame
*f
= XFRAME (frame
);
6947 if (FRAME_TERMINAL (f
) == t
)
6948 frame_make_pointer_visible (f
);
6952 if (hold_quit
.kind
!= NO_EVENT
)
6953 kbd_buffer_store_event (&hold_quit
);
6965 /* This is the tty way of reading available input.
6967 Note that each terminal device has its own `struct terminal' object,
6968 and so this function is called once for each individual termcap
6969 terminal. The first parameter indicates which terminal to read from. */
6972 tty_read_avail_input (struct terminal
*terminal
,
6973 struct input_event
*hold_quit
)
6975 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6976 the kbd_buffer can really hold. That may prevent loss
6977 of characters on some systems when input is stuffed at us. */
6978 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6980 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6983 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6985 if (kbd_on_hold_p () || buffer_free
<= 0)
6987 #endif /* subprocesses */
6989 if (!terminal
->name
) /* Don't read from a dead terminal. */
6992 if (terminal
->type
!= output_termcap
6993 && terminal
->type
!= output_msdos_raw
)
6996 /* XXX I think the following code should be moved to separate hook
6997 functions in system-dependent files. */
6999 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
7000 code sets read_socket_hook to w32_console_read_socket instead! */
7002 #else /* not WINDOWSNT */
7003 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
7007 return 0; /* The terminal is suspended. */
7010 n_to_read
= dos_keysns ();
7014 cbuf
[0] = dos_keyread ();
7017 #else /* not MSDOS */
7022 struct input_event gpm_hold_quit
;
7023 int gpm
, fd
= gpm_fd
;
7025 EVENT_INIT (gpm_hold_quit
);
7026 gpm_hold_quit
.kind
= NO_EVENT
;
7028 /* gpm==1 if event received.
7029 gpm==0 if the GPM daemon has closed the connection, in which case
7030 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
7031 we save it in `fd' so close_gpm can remove it from the
7033 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
7034 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
7035 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
7038 /* Presumably the GPM daemon has closed the connection. */
7040 if (gpm_hold_quit
.kind
!= NO_EVENT
)
7041 kbd_buffer_store_event (&gpm_hold_quit
);
7045 #endif /* HAVE_GPM */
7047 /* Determine how many characters we should *try* to read. */
7048 #ifdef USABLE_FIONREAD
7049 /* Find out how much input is available. */
7050 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
7052 if (! noninteractive
)
7053 return -2; /* Close this terminal. */
7059 if (n_to_read
> sizeof cbuf
)
7060 n_to_read
= sizeof cbuf
;
7061 #elif defined USG || defined CYGWIN
7062 /* Read some input if available, but don't wait. */
7063 n_to_read
= sizeof cbuf
;
7064 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7066 # error "Cannot read without possibly delaying"
7070 /* Don't read more than we can store. */
7071 if (n_to_read
> buffer_free
)
7072 n_to_read
= buffer_free
;
7073 #endif /* subprocesses */
7075 /* Now read; for one reason or another, this will not block.
7076 NREAD is set to the number of chars read. */
7079 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7080 /* POSIX infers that processes which are not in the session leader's
7081 process group won't get SIGHUPs at logout time. BSDI adheres to
7082 this part standard and returns -1 from read (0) with errno==EIO
7083 when the control tty is taken away.
7084 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7085 if (nread
== -1 && errno
== EIO
)
7086 return -2; /* Close this terminal. */
7087 #if defined (AIX) && defined (_BSD)
7088 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7089 This looks incorrect, but it isn't, because _BSD causes
7090 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7091 and that causes a value other than 0 when there is no input. */
7093 return -2; /* Close this terminal. */
7097 /* We used to retry the read if it was interrupted.
7098 But this does the wrong thing when O_NONBLOCK causes
7099 an EAGAIN error. Does anybody know of a situation
7100 where a retry is actually needed? */
7102 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7112 #ifndef USABLE_FIONREAD
7113 #if defined (USG) || defined (CYGWIN)
7114 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7115 #endif /* USG or CYGWIN */
7116 #endif /* no FIONREAD */
7121 #endif /* not MSDOS */
7122 #endif /* not WINDOWSNT */
7124 for (i
= 0; i
< nread
; i
++)
7126 struct input_event buf
;
7128 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7130 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7131 buf
.modifiers
= meta_modifier
;
7132 if (tty
->meta_key
!= 2)
7136 /* Set the frame corresponding to the active tty. Note that the
7137 value of selected_frame is not reliable here, redisplay tends
7138 to temporarily change it. */
7139 buf
.frame_or_window
= tty
->top_frame
;
7142 kbd_buffer_store_event (&buf
);
7143 /* Don't look at input that follows a C-g too closely.
7144 This reduces lossage due to autorepeat on C-g. */
7145 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7146 && buf
.code
== quit_char
)
7154 handle_async_input (void)
7159 int nread
= gobble_input ();
7160 /* -1 means it's not ok to read the input now.
7161 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7162 0 means there was no keyboard input available. */
7170 process_pending_signals (void)
7172 pending_signals
= 0;
7173 handle_async_input ();
7174 do_pending_atimers ();
7177 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7178 and reinvoke any pending signal if the level is now 0 and
7179 a fatal error is not already in progress. */
7182 unblock_input_to (int level
)
7184 interrupt_input_blocked
= level
;
7187 if (pending_signals
&& !fatal_error_in_progress
)
7188 process_pending_signals ();
7194 /* End critical section.
7196 If doing signal-driven input, and a signal came in when input was
7197 blocked, reinvoke the signal handler now to deal with it.
7199 It will also process queued input, if it was not read before.
7200 When a longer code sequence does not use block/unblock input
7201 at all, the whole input gathered up to the next call to
7202 unblock_input will be processed inside that call. */
7205 unblock_input (void)
7207 unblock_input_to (interrupt_input_blocked
- 1);
7210 /* Undo any number of BLOCK_INPUT calls,
7211 and also reinvoke any pending signal. */
7214 totally_unblock_input (void)
7216 unblock_input_to (0);
7222 handle_input_available_signal (int sig
)
7224 pending_signals
= 1;
7226 if (input_available_clear_time
)
7227 *input_available_clear_time
= make_timespec (0, 0);
7231 deliver_input_available_signal (int sig
)
7233 deliver_process_signal (sig
, handle_input_available_signal
);
7235 #endif /* USABLE_SIGIO */
7238 /* User signal events. */
7240 struct user_signal_info
7242 /* Signal number. */
7245 /* Name of the signal. */
7248 /* Number of pending signals. */
7251 struct user_signal_info
*next
;
7254 /* List of user signals. */
7255 static struct user_signal_info
*user_signals
= NULL
;
7258 add_user_signal (int sig
, const char *name
)
7260 struct sigaction action
;
7261 struct user_signal_info
*p
;
7263 for (p
= user_signals
; p
; p
= p
->next
)
7265 /* Already added. */
7268 p
= xmalloc (sizeof *p
);
7270 p
->name
= xstrdup (name
);
7272 p
->next
= user_signals
;
7275 emacs_sigaction_init (&action
, deliver_user_signal
);
7276 sigaction (sig
, &action
, 0);
7280 handle_user_signal (int sig
)
7282 struct user_signal_info
*p
;
7283 const char *special_event_name
= NULL
;
7285 if (SYMBOLP (Vdebug_on_event
))
7286 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7288 for (p
= user_signals
; p
; p
= p
->next
)
7291 if (special_event_name
7292 && strcmp (special_event_name
, p
->name
) == 0)
7294 /* Enter the debugger in many ways. */
7295 debug_on_next_call
= 1;
7298 Vinhibit_quit
= Qnil
;
7300 /* Eat the event. */
7306 if (interrupt_input
)
7307 handle_input_available_signal (sig
);
7311 /* Tell wait_reading_process_output that it needs to wake
7312 up and look around. */
7313 if (input_available_clear_time
)
7314 *input_available_clear_time
= make_timespec (0, 0);
7321 deliver_user_signal (int sig
)
7323 deliver_process_signal (sig
, handle_user_signal
);
7327 find_user_signal_name (int sig
)
7329 struct user_signal_info
*p
;
7331 for (p
= user_signals
; p
; p
= p
->next
)
7339 store_user_signal_events (void)
7341 struct user_signal_info
*p
;
7342 struct input_event buf
;
7343 bool buf_initialized
= 0;
7345 for (p
= user_signals
; p
; p
= p
->next
)
7346 if (p
->npending
> 0)
7348 if (! buf_initialized
)
7350 memset (&buf
, 0, sizeof buf
);
7351 buf
.kind
= USER_SIGNAL_EVENT
;
7352 buf
.frame_or_window
= selected_frame
;
7353 buf_initialized
= 1;
7359 kbd_buffer_store_event (&buf
);
7362 while (p
->npending
> 0);
7367 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7368 static Lisp_Object menu_bar_one_keymap_changed_items
;
7370 /* These variables hold the vector under construction within
7371 menu_bar_items and its subroutines, and the current index
7372 for storing into that vector. */
7373 static Lisp_Object menu_bar_items_vector
;
7374 static int menu_bar_items_index
;
7377 static const char *separator_names
[] = {
7382 "single-dashed-line",
7383 "double-dashed-line",
7385 "shadow-etched-out",
7386 "shadow-etched-in-dash",
7387 "shadow-etched-out-dash",
7388 "shadow-double-etched-in",
7389 "shadow-double-etched-out",
7390 "shadow-double-etched-in-dash",
7391 "shadow-double-etched-out-dash",
7395 /* Return true if LABEL specifies a separator. */
7398 menu_separator_name_p (const char *label
)
7402 else if (strlen (label
) > 3
7403 && memcmp (label
, "--", 2) == 0
7408 for (i
= 0; separator_names
[i
]; ++i
)
7409 if (strcmp (label
, separator_names
[i
]) == 0)
7414 /* It's a separator if it contains only dashes. */
7415 while (*label
== '-')
7417 return (*label
== 0);
7424 /* Return a vector of menu items for a menu bar, appropriate
7425 to the current buffer. Each item has three elements in the vector:
7428 OLD is an old vector we can optionally reuse, or nil. */
7431 menu_bar_items (Lisp_Object old
)
7433 /* The number of keymaps we're scanning right now, and the number of
7434 keymaps we have allocated space for. */
7437 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7438 in the current keymaps, or nil where it is not a prefix. */
7441 Lisp_Object mapsbuf
[3];
7442 Lisp_Object def
, tail
;
7449 /* In order to build the menus, we need to call the keymap
7450 accessors. They all call QUIT. But this function is called
7451 during redisplay, during which a quit is fatal. So inhibit
7452 quitting while building the menus.
7453 We do this instead of specbind because (1) errors will clear it anyway
7454 and (2) this avoids risk of specpdl overflow. */
7455 oquit
= Vinhibit_quit
;
7459 menu_bar_items_vector
= old
;
7461 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7462 menu_bar_items_index
= 0;
7464 /* Build our list of keymaps.
7465 If we recognize a function key and replace its escape sequence in
7466 keybuf with its symbol, or if the sequence starts with a mouse
7467 click and we need to switch buffers, we jump back here to rebuild
7468 the initial keymaps from the current buffer. */
7472 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7473 if (!NILP (Voverriding_local_map_menu_flag
)
7474 && !NILP (Voverriding_local_map
))
7476 /* Yes, use them (if non-nil) as well as the global map. */
7479 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7480 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7481 if (!NILP (Voverriding_local_map
))
7482 maps
[nmaps
++] = Voverriding_local_map
;
7486 /* No, so use major and minor mode keymaps and keymap property.
7487 Note that menu-bar bindings in the local-map and keymap
7488 properties may not work reliable, as they are only
7489 recognized when the menu-bar (or mode-line) is updated,
7490 which does not normally happen after every command. */
7493 nminor
= current_minor_maps (NULL
, &tmaps
);
7494 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
7496 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7497 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7498 maps
[nmaps
++] = tem
;
7499 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7500 maps
[nmaps
++] = tem
;
7501 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7503 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7505 maps
[nmaps
++] = current_global_map
;
7508 /* Look up in each map the dummy prefix key `menu-bar'. */
7510 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7511 if (!NILP (maps
[mapno
]))
7513 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7517 menu_bar_one_keymap_changed_items
= Qnil
;
7518 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7522 /* Move to the end those items that should be at the end. */
7524 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7527 int end
= menu_bar_items_index
;
7529 for (i
= 0; i
< end
; i
+= 4)
7530 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7532 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7533 /* Move the item at index I to the end,
7534 shifting all the others forward. */
7535 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7536 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7537 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7538 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7540 memmove (aref_addr (menu_bar_items_vector
, i
),
7541 aref_addr (menu_bar_items_vector
, i
+ 4),
7542 (end
- i
- 4) * word_size
);
7543 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7544 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7545 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7546 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7551 /* Add nil, nil, nil, nil at the end. */
7553 int i
= menu_bar_items_index
;
7554 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7555 menu_bar_items_vector
7556 = larger_vector (menu_bar_items_vector
, 4, -1);
7557 /* Add this item. */
7558 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7559 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7560 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7561 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7562 menu_bar_items_index
= i
;
7565 Vinhibit_quit
= oquit
;
7567 return menu_bar_items_vector
;
7570 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7571 If there's already an item for KEY, add this DEF to it. */
7573 Lisp_Object item_properties
;
7576 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7578 struct gcpro gcpro1
;
7583 if (EQ (item
, Qundefined
))
7585 /* If a map has an explicit `undefined' as definition,
7586 discard any previously made menu bar item. */
7588 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7589 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7591 if (menu_bar_items_index
> i
+ 4)
7592 memmove (aref_addr (menu_bar_items_vector
, i
),
7593 aref_addr (menu_bar_items_vector
, i
+ 4),
7594 (menu_bar_items_index
- i
- 4) * word_size
);
7595 menu_bar_items_index
-= 4;
7599 /* If this keymap has already contributed to this KEY,
7600 don't contribute to it a second time. */
7601 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7602 if (!NILP (tem
) || NILP (item
))
7605 menu_bar_one_keymap_changed_items
7606 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7608 /* We add to menu_bar_one_keymap_changed_items before doing the
7609 parse_menu_item, so that if it turns out it wasn't a menu item,
7610 it still correctly hides any further menu item. */
7612 parsed
= parse_menu_item (item
, 1);
7617 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7619 /* Find any existing item for this KEY. */
7620 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7621 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7624 /* If we did not find this KEY, add it at the end. */
7625 if (i
== menu_bar_items_index
)
7627 /* If vector is too small, get a bigger one. */
7628 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7629 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7630 /* Add this item. */
7631 ASET (menu_bar_items_vector
, i
, key
); i
++;
7632 ASET (menu_bar_items_vector
, i
,
7633 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7634 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7635 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7636 menu_bar_items_index
= i
;
7638 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7642 old
= AREF (menu_bar_items_vector
, i
+ 2);
7643 /* If the new and the old items are not both keymaps,
7644 the lookup will only find `item'. */
7645 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7646 ASET (menu_bar_items_vector
, i
+ 2, item
);
7650 /* This is used as the handler when calling menu_item_eval_property. */
7652 menu_item_eval_property_1 (Lisp_Object arg
)
7654 /* If we got a quit from within the menu computation,
7655 quit all the way out of it. This takes care of C-] in the debugger. */
7656 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7657 Fsignal (Qquit
, Qnil
);
7663 eval_dyn (Lisp_Object form
)
7665 return Feval (form
, Qnil
);
7668 /* Evaluate an expression and return the result (or nil if something
7669 went wrong). Used to evaluate dynamic parts of menu items. */
7671 menu_item_eval_property (Lisp_Object sexpr
)
7673 ptrdiff_t count
= SPECPDL_INDEX ();
7675 specbind (Qinhibit_redisplay
, Qt
);
7676 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7677 menu_item_eval_property_1
);
7678 return unbind_to (count
, val
);
7681 /* This function parses a menu item and leaves the result in the
7682 vector item_properties.
7683 ITEM is a key binding, a possible menu item.
7684 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7686 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7687 parse_menu_item returns true if the item is a menu item and false
7691 parse_menu_item (Lisp_Object item
, int inmenubar
)
7693 Lisp_Object def
, tem
, item_string
, start
;
7695 Lisp_Object keyhint
;
7704 /* Create item_properties vector if necessary. */
7705 if (NILP (item_properties
))
7707 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7709 /* Initialize optional entries. */
7710 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7711 ASET (item_properties
, i
, Qnil
);
7712 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7714 /* Save the item here to protect it from GC. */
7715 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7717 item_string
= XCAR (item
);
7721 if (STRINGP (item_string
))
7723 /* Old format menu item. */
7724 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7726 /* Maybe help string. */
7727 if (CONSP (item
) && STRINGP (XCAR (item
)))
7729 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7734 /* Maybe an obsolete key binding cache. */
7735 if (CONSP (item
) && CONSP (XCAR (item
))
7736 && (NILP (XCAR (XCAR (item
)))
7737 || VECTORP (XCAR (XCAR (item
)))))
7740 /* This is the real definition--the function to run. */
7741 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7743 /* Get enable property, if any. */
7746 tem
= Fget (item
, Qmenu_enable
);
7747 if (!NILP (Venable_disabled_menus_and_buttons
))
7748 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7749 else if (!NILP (tem
))
7750 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7753 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7755 /* New format menu item. */
7756 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7757 start
= XCDR (item
);
7760 /* We have a real binding. */
7761 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7763 item
= XCDR (start
);
7764 /* Is there an obsolete cache list with key equivalences. */
7765 if (CONSP (item
) && CONSP (XCAR (item
)))
7768 /* Parse properties. */
7769 while (CONSP (item
) && CONSP (XCDR (item
)))
7774 if (EQ (tem
, QCenable
))
7776 if (!NILP (Venable_disabled_menus_and_buttons
))
7777 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7779 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7781 else if (EQ (tem
, QCvisible
))
7783 /* If got a visible property and that evaluates to nil
7784 then ignore this item. */
7785 tem
= menu_item_eval_property (XCAR (item
));
7789 else if (EQ (tem
, QChelp
))
7790 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7791 else if (EQ (tem
, QCfilter
))
7793 else if (EQ (tem
, QCkey_sequence
))
7796 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7797 /* Be GC protected. Set keyhint to item instead of tem. */
7800 else if (EQ (tem
, QCkeys
))
7803 if (CONSP (tem
) || STRINGP (tem
))
7804 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7806 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7811 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7813 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7815 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7821 else if (inmenubar
|| !NILP (start
))
7825 return 0; /* not a menu item */
7827 /* If item string is not a string, evaluate it to get string.
7828 If we don't get a string, skip this item. */
7829 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7830 if (!(STRINGP (item_string
)))
7832 item_string
= menu_item_eval_property (item_string
);
7833 if (!STRINGP (item_string
))
7835 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7838 /* If got a filter apply it on definition. */
7839 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7842 def
= menu_item_eval_property (list2 (XCAR (filter
),
7843 list2 (Qquote
, def
)));
7845 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7848 /* Enable or disable selection of item. */
7849 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7852 tem
= menu_item_eval_property (tem
);
7853 if (inmenubar
&& NILP (tem
))
7854 return 0; /* Ignore disabled items in menu bar. */
7855 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7858 /* If we got no definition, this item is just unselectable text which
7859 is OK in a submenu but not in the menubar. */
7861 return (!inmenubar
);
7863 /* See if this is a separate pane or a submenu. */
7864 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7865 tem
= get_keymap (def
, 0, 1);
7866 /* For a subkeymap, just record its details and exit. */
7869 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7870 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7874 /* At the top level in the menu bar, do likewise for commands also.
7875 The menu bar does not display equivalent key bindings anyway.
7876 ITEM_PROPERTY_DEF is already set up properly. */
7880 { /* This is a command. See if there is an equivalent key binding. */
7881 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7883 /* The previous code preferred :key-sequence to :keys, so we
7884 preserve this behavior. */
7885 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7886 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7889 Lisp_Object prefix
= keyeq
;
7890 Lisp_Object keys
= Qnil
;
7894 def
= XCAR (prefix
);
7895 prefix
= XCDR (prefix
);
7898 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7900 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7902 keys
= XCAR (keyhint
);
7903 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7905 /* We have a suggested key. Is it bound to the command? */
7908 /* If the command is an alias for another
7909 (such as lmenu.el set it up), check if the
7910 original command matches the cached command. */
7912 && EQ (tem
, XSYMBOL (def
)->function
))))
7917 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7921 tem
= Fkey_description (keys
, Qnil
);
7924 if (STRINGP (XCAR (prefix
)))
7925 tem
= concat2 (XCAR (prefix
), tem
);
7926 if (STRINGP (XCDR (prefix
)))
7927 tem
= concat2 (tem
, XCDR (prefix
));
7929 keyeq
= concat2 (build_string (" "), tem
);
7930 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7936 /* If we have an equivalent key binding, use that. */
7937 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7940 /* Include this when menu help is implemented.
7941 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7942 if (!(NILP (tem) || STRINGP (tem)))
7944 tem = menu_item_eval_property (tem);
7947 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7951 /* Handle radio buttons or toggle boxes. */
7952 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7954 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7955 menu_item_eval_property (tem
));
7962 /***********************************************************************
7964 ***********************************************************************/
7966 /* A vector holding tool bar items while they are parsed in function
7967 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7970 static Lisp_Object tool_bar_items_vector
;
7972 /* A vector holding the result of parse_tool_bar_item. Layout is like
7973 the one for a single item in tool_bar_items_vector. */
7975 static Lisp_Object tool_bar_item_properties
;
7977 /* Next free index in tool_bar_items_vector. */
7979 static int ntool_bar_items
;
7981 /* The symbols `:image' and `:rtl'. */
7983 static Lisp_Object QCimage
;
7984 static Lisp_Object QCrtl
;
7986 /* Function prototypes. */
7988 static void init_tool_bar_items (Lisp_Object
);
7989 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7991 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7992 static void append_tool_bar_item (void);
7995 /* Return a vector of tool bar items for keymaps currently in effect.
7996 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7997 tool bar items found. */
8000 tool_bar_items (Lisp_Object reuse
, int *nitems
)
8003 Lisp_Object mapsbuf
[3];
8011 /* In order to build the menus, we need to call the keymap
8012 accessors. They all call QUIT. But this function is called
8013 during redisplay, during which a quit is fatal. So inhibit
8014 quitting while building the menus. We do this instead of
8015 specbind because (1) errors will clear it anyway and (2) this
8016 avoids risk of specpdl overflow. */
8017 oquit
= Vinhibit_quit
;
8020 /* Initialize tool_bar_items_vector and protect it from GC. */
8021 init_tool_bar_items (reuse
);
8023 /* Build list of keymaps in maps. Set nmaps to the number of maps
8026 /* Should overriding-terminal-local-map and overriding-local-map apply? */
8027 if (!NILP (Voverriding_local_map_menu_flag
)
8028 && !NILP (Voverriding_local_map
))
8030 /* Yes, use them (if non-nil) as well as the global map. */
8033 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
8034 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
8035 if (!NILP (Voverriding_local_map
))
8036 maps
[nmaps
++] = Voverriding_local_map
;
8040 /* No, so use major and minor mode keymaps and keymap property.
8041 Note that tool-bar bindings in the local-map and keymap
8042 properties may not work reliable, as they are only
8043 recognized when the tool-bar (or mode-line) is updated,
8044 which does not normally happen after every command. */
8047 nminor
= current_minor_maps (NULL
, &tmaps
);
8048 SAFE_NALLOCA (maps
, 1, nminor
+ 4);
8050 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
8051 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
8052 maps
[nmaps
++] = tem
;
8053 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
8054 maps
[nmaps
++] = tem
;
8055 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
8057 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
8060 /* Add global keymap at the end. */
8061 maps
[nmaps
++] = current_global_map
;
8063 /* Process maps in reverse order and look up in each map the prefix
8065 for (i
= nmaps
- 1; i
>= 0; --i
)
8066 if (!NILP (maps
[i
]))
8070 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
8072 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
8075 Vinhibit_quit
= oquit
;
8076 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8078 return tool_bar_items_vector
;
8082 /* Process the definition of KEY which is DEF. */
8085 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8088 struct gcpro gcpro1
, gcpro2
;
8090 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8094 if (EQ (def
, Qundefined
))
8096 /* If a map has an explicit `undefined' as definition,
8097 discard any previously made item. */
8098 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8100 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8102 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8104 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8105 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8106 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8108 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8113 else if (parse_tool_bar_item (key
, def
))
8114 /* Append a new tool bar item to tool_bar_items_vector. Accept
8115 more than one definition for the same key. */
8116 append_tool_bar_item ();
8121 /* Access slot with index IDX of vector tool_bar_item_properties. */
8122 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8124 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8126 ASET (tool_bar_item_properties
, idx
, val
);
8130 /* Parse a tool bar item specification ITEM for key KEY and return the
8131 result in tool_bar_item_properties. Value is false if ITEM is
8134 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8136 CAPTION is the caption of the item, If it's not a string, it is
8137 evaluated to get a string.
8139 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8140 as binding are currently ignored.
8142 The following properties are recognized:
8146 FORM is evaluated and specifies whether the tool bar item is
8147 enabled or disabled.
8151 FORM is evaluated and specifies whether the tool bar item is visible.
8153 - `:filter FUNCTION'
8155 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8156 result is stored as the new binding.
8158 - `:button (TYPE SELECTED)'
8160 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8161 and specifies whether the button is selected (pressed) or not.
8165 IMAGES is either a single image specification or a vector of four
8166 image specifications. See enum tool_bar_item_images.
8168 - `:help HELP-STRING'.
8170 Gives a help string to display for the tool bar item.
8172 - `:label LABEL-STRING'.
8174 A text label to show with the tool bar button if labels are enabled. */
8177 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8179 Lisp_Object filter
= Qnil
;
8180 Lisp_Object caption
;
8182 bool have_label
= 0;
8184 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8185 Rule out items that aren't lists, don't start with
8186 `menu-item' or whose rest following `tool-bar-item' is not a
8191 /* As an exception, allow old-style menu separators. */
8192 if (STRINGP (XCAR (item
)))
8193 item
= list1 (XCAR (item
));
8194 else if (!EQ (XCAR (item
), Qmenu_item
)
8195 || (item
= XCDR (item
), !CONSP (item
)))
8198 /* Create tool_bar_item_properties vector if necessary. Reset it to
8200 if (VECTORP (tool_bar_item_properties
))
8202 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8206 tool_bar_item_properties
8207 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8210 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8211 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8213 /* Get the caption of the item. If the caption is not a string,
8214 evaluate it to get a string. If we don't get a string, skip this
8216 caption
= XCAR (item
);
8217 if (!STRINGP (caption
))
8219 caption
= menu_item_eval_property (caption
);
8220 if (!STRINGP (caption
))
8223 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8225 /* If the rest following the caption is not a list, the menu item is
8226 either a separator, or invalid. */
8230 if (menu_separator_name_p (SSDATA (caption
)))
8232 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8233 #if !defined (USE_GTK) && !defined (HAVE_NS)
8234 /* If we use build_desired_tool_bar_string to render the
8235 tool bar, the separator is rendered as an image. */
8236 set_prop (TOOL_BAR_ITEM_IMAGES
,
8237 (menu_item_eval_property
8238 (Vtool_bar_separator_image_expression
)));
8239 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8240 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8241 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8248 /* Store the binding. */
8249 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8252 /* Ignore cached key binding, if any. */
8253 if (CONSP (item
) && CONSP (XCAR (item
)))
8256 /* Process the rest of the properties. */
8257 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8259 Lisp_Object ikey
, value
;
8262 value
= XCAR (XCDR (item
));
8264 if (EQ (ikey
, QCenable
))
8266 /* `:enable FORM'. */
8267 if (!NILP (Venable_disabled_menus_and_buttons
))
8268 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8270 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8272 else if (EQ (ikey
, QCvisible
))
8274 /* `:visible FORM'. If got a visible property and that
8275 evaluates to nil then ignore this item. */
8276 if (NILP (menu_item_eval_property (value
)))
8279 else if (EQ (ikey
, QChelp
))
8280 /* `:help HELP-STRING'. */
8281 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8282 else if (EQ (ikey
, QCvert_only
))
8283 /* `:vert-only t/nil'. */
8284 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8285 else if (EQ (ikey
, QClabel
))
8287 const char *bad_label
= "!!?GARBLED ITEM?!!";
8288 /* `:label LABEL-STRING'. */
8289 set_prop (TOOL_BAR_ITEM_LABEL
,
8290 STRINGP (value
) ? value
: build_string (bad_label
));
8293 else if (EQ (ikey
, QCfilter
))
8294 /* ':filter FORM'. */
8296 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8298 /* `:button (TYPE . SELECTED)'. */
8299 Lisp_Object type
, selected
;
8301 type
= XCAR (value
);
8302 selected
= XCDR (value
);
8303 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8305 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8306 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8309 else if (EQ (ikey
, QCimage
)
8311 || (VECTORP (value
) && ASIZE (value
) == 4)))
8312 /* Value is either a single image specification or a vector
8313 of 4 such specifications for the different button states. */
8314 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8315 else if (EQ (ikey
, QCrtl
))
8317 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8323 /* Try to make one from caption and key. */
8324 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8325 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8326 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8327 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8329 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8330 char *buf
= xmalloc (max_lbl
+ 1);
8331 Lisp_Object new_lbl
;
8332 ptrdiff_t caption_len
= strlen (capt
);
8334 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8337 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8339 buf
[caption_len
] = '\0';
8343 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8347 strcpy (buf
, label
);
8349 for (j
= 0; buf
[j
] != '\0'; ++j
)
8357 new_lbl
= Fupcase_initials (build_string (label
));
8358 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8359 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8361 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8365 /* If got a filter apply it on binding. */
8367 set_prop (TOOL_BAR_ITEM_BINDING
,
8368 (menu_item_eval_property
8371 PROP (TOOL_BAR_ITEM_BINDING
))))));
8373 /* See if the binding is a keymap. Give up if it is. */
8374 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8377 /* Enable or disable selection of item. */
8378 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8379 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8380 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8382 /* Handle radio buttons or toggle boxes. */
8383 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8384 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8385 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8393 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8394 that can be reused. */
8397 init_tool_bar_items (Lisp_Object reuse
)
8399 if (VECTORP (reuse
))
8400 tool_bar_items_vector
= reuse
;
8402 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8403 ntool_bar_items
= 0;
8407 /* Append parsed tool bar item properties from
8408 tool_bar_item_properties */
8411 append_tool_bar_item (void)
8415 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8417 /* Enlarge tool_bar_items_vector if necessary. */
8419 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8421 /* Append entries from tool_bar_item_properties to the end of
8422 tool_bar_items_vector. */
8423 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8424 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8425 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8432 /* Read a character using menus based on the keymap MAP.
8433 Return nil if there are no menus in the maps.
8434 Return t if we displayed a menu but the user rejected it.
8436 PREV_EVENT is the previous input event, or nil if we are reading
8437 the first event of a key sequence.
8439 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8440 if we used a mouse menu to read the input, or false otherwise. If
8441 USED_MOUSE_MENU is null, don't dereference it.
8443 The prompting is done based on the prompt-string of the map
8444 and the strings associated with various map elements.
8446 This can be done with X menus or with menus put in the minibuf.
8447 These are done in different ways, depending on how the input will be read.
8448 Menus using X are done after auto-saving in read-char, getting the input
8449 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8450 and do auto-saving in the inner call of read_char. */
8453 read_char_x_menu_prompt (Lisp_Object map
,
8454 Lisp_Object prev_event
, bool *used_mouse_menu
)
8456 if (used_mouse_menu
)
8457 *used_mouse_menu
= 0;
8459 /* Use local over global Menu maps. */
8461 if (! menu_prompting
)
8464 /* If we got to this point via a mouse click,
8465 use a real menu for mouse selection. */
8466 if (EVENT_HAS_PARAMETERS (prev_event
)
8467 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8468 && !EQ (XCAR (prev_event
), Qtool_bar
))
8470 /* Display the menu and get the selection. */
8473 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8478 record_menu_key (XCAR (value
));
8480 /* If we got multiple events, unread all but
8482 There is no way to prevent those unread events
8483 from showing up later in last_nonmenu_event.
8484 So turn symbol and integer events into lists,
8485 to indicate that they came from a mouse menu,
8486 so that when present in last_nonmenu_event
8487 they won't confuse things. */
8488 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8490 record_menu_key (XCAR (tem
));
8491 if (SYMBOLP (XCAR (tem
))
8492 || INTEGERP (XCAR (tem
)))
8493 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8496 /* If we got more than one event, put all but the first
8497 onto this list to be read later.
8498 Return just the first event now. */
8499 Vunread_command_events
8500 = nconc2 (XCDR (value
), Vunread_command_events
);
8501 value
= XCAR (value
);
8503 else if (NILP (value
))
8505 if (used_mouse_menu
)
8506 *used_mouse_menu
= 1;
8513 read_char_minibuf_menu_prompt (int commandflag
,
8516 register Lisp_Object name
;
8518 /* FIXME: Use the minibuffer's frame width. */
8519 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8521 bool nobindings
= 1;
8522 Lisp_Object rest
, vector
;
8523 Lisp_Object prompt_strings
= Qnil
;
8527 if (! menu_prompting
)
8530 map
= get_keymap (map
, 0, 1);
8531 name
= Fkeymap_prompt (map
);
8533 /* If we don't have any menus, just read a character normally. */
8534 if (!STRINGP (name
))
8537 #define PUSH_C_STR(str, listvar) \
8538 listvar = Fcons (build_unibyte_string (str), listvar)
8540 /* Prompt string always starts with map's prompt, and a space. */
8541 prompt_strings
= Fcons (name
, prompt_strings
);
8542 PUSH_C_STR (": ", prompt_strings
);
8543 nlength
= SCHARS (name
) + 2;
8547 /* Present the documented bindings, a line at a time. */
8551 Lisp_Object menu_strings
= prompt_strings
;
8552 ptrdiff_t i
= nlength
;
8554 Lisp_Object orig_defn_macro
;
8556 /* Loop over elements of map. */
8561 /* FIXME: Use map_keymap to handle new keymap formats. */
8563 /* At end of map, wrap around if just starting,
8564 or end this line if already have something on it. */
8567 if (notfirst
|| nobindings
)
8573 /* Look at the next element of the map. */
8575 elt
= AREF (vector
, idx
);
8577 elt
= Fcar_safe (rest
);
8579 if (idx
< 0 && VECTORP (elt
))
8581 /* If we found a dense table in the keymap,
8582 advanced past it, but start scanning its contents. */
8583 rest
= Fcdr_safe (rest
);
8589 /* An ordinary element. */
8590 Lisp_Object event
, tem
;
8594 event
= Fcar_safe (elt
); /* alist */
8595 elt
= Fcdr_safe (elt
);
8599 XSETINT (event
, idx
); /* vector */
8602 /* Ignore the element if it has no prompt string. */
8603 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8605 /* True if the char to type matches the string. */
8607 Lisp_Object upcased_event
, downcased_event
;
8608 Lisp_Object desc
= Qnil
;
8610 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8612 upcased_event
= Fupcase (event
);
8613 downcased_event
= Fdowncase (event
);
8614 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8615 || XINT (downcased_event
) == SREF (s
, 0));
8617 desc
= Fsingle_key_description (event
, Qnil
);
8619 #if 0 /* It is redundant to list the equivalent key bindings because
8620 the prefix is what the user has already typed. */
8622 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8624 /* Insert equivalent keybinding. */
8625 s
= concat2 (s
, tem
);
8628 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8629 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8631 /* Insert button prefix. */
8632 Lisp_Object selected
8633 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8634 if (EQ (tem
, QCradio
))
8635 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8637 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8638 s
= concat2 (tem
, s
);
8642 /* If we have room for the prompt string, add it to this line.
8643 If this is the first on the line, always add it. */
8644 if ((SCHARS (s
) + i
+ 2
8645 + (char_matches
? 0 : SCHARS (desc
) + 3))
8649 ptrdiff_t thiswidth
;
8651 /* Punctuate between strings. */
8654 PUSH_C_STR (", ", menu_strings
);
8660 /* If the char to type doesn't match the string's
8661 first char, explicitly show what char to type. */
8664 /* Add as much of string as fits. */
8665 thiswidth
= min (SCHARS (desc
), width
- i
);
8667 = Fcons (Fsubstring (desc
, make_number (0),
8668 make_number (thiswidth
)),
8671 PUSH_C_STR (" = ", menu_strings
);
8675 /* Add as much of string as fits. */
8676 thiswidth
= min (SCHARS (s
), width
- i
);
8678 = Fcons (Fsubstring (s
, make_number (0),
8679 make_number (thiswidth
)),
8685 /* If this element does not fit, end the line now,
8686 and save the element for the next line. */
8687 PUSH_C_STR ("...", menu_strings
);
8692 /* Move past this element. */
8693 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8694 /* Handle reaching end of dense table. */
8699 rest
= Fcdr_safe (rest
);
8703 /* Prompt with that and read response. */
8704 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8706 /* Make believe it's not a keyboard macro in case the help char
8707 is pressed. Help characters are not recorded because menu prompting
8708 is not used on replay. */
8709 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8710 kset_defining_kbd_macro (current_kboard
, Qnil
);
8712 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8713 while (BUFFERP (obj
));
8714 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8716 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8719 if (! EQ (obj
, menu_prompt_more_char
)
8720 && (!INTEGERP (menu_prompt_more_char
)
8721 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8723 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8724 store_kbd_macro_char (obj
);
8727 /* Help char - go round again. */
8731 /* Reading key sequences. */
8734 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8736 return access_keymap (get_keymap (keymap
, 0, 1),
8741 active_maps (Lisp_Object first_event
)
8743 Lisp_Object position
8744 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8745 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8748 /* Structure used to keep track of partial application of key remapping
8749 such as Vfunction_key_map and Vkey_translation_map. */
8750 typedef struct keyremap
8752 /* This is the map originally specified for this use. */
8754 /* This is a submap reached by looking up, in PARENT,
8755 the events from START to END. */
8757 /* Positions [START, END) in the key sequence buffer
8758 are the key that we have scanned so far.
8759 Those events are the ones that we will replace
8760 if PARENT maps them into a key sequence. */
8764 /* Lookup KEY in MAP.
8765 MAP is a keymap mapping keys to key vectors or functions.
8766 If the mapping is a function and DO_FUNCALL is true,
8767 the function is called with PROMPT as parameter and its return
8768 value is used as the return value of this function (after checking
8769 that it is indeed a vector). */
8772 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8777 next
= access_keymap (map
, key
, 1, 0, 1);
8779 /* Handle a symbol whose function definition is a keymap
8781 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8782 && (ARRAYP (XSYMBOL (next
)->function
)
8783 || KEYMAPP (XSYMBOL (next
)->function
)))
8784 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8786 /* If the keymap gives a function, not an
8787 array, then call the function with one arg and use
8788 its value instead. */
8789 if (do_funcall
&& FUNCTIONP (next
))
8794 next
= call1 (next
, prompt
);
8795 /* If the function returned something invalid,
8796 barf--don't ignore it.
8797 (To ignore it safely, we would need to gcpro a bunch of
8798 other variables.) */
8799 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8800 error ("Function %s returns invalid key sequence",
8801 SSDATA (SYMBOL_NAME (tem
)));
8806 /* Do one step of the key remapping used for function-key-map and
8807 key-translation-map:
8808 KEYBUF is the buffer holding the input events.
8809 BUFSIZE is its maximum size.
8810 FKEY is a pointer to the keyremap structure to use.
8811 INPUT is the index of the last element in KEYBUF.
8812 DOIT if true says that the remapping can actually take place.
8813 DIFF is used to return the number of keys added/removed by the remapping.
8814 PARENT is the root of the keymap.
8815 PROMPT is the prompt to use if the remapping happens through a function.
8816 Return true if the remapping actually took place. */
8819 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8820 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8822 Lisp_Object next
, key
;
8824 key
= keybuf
[fkey
->end
++];
8826 if (KEYMAPP (fkey
->parent
))
8827 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8831 /* If keybuf[fkey->start..fkey->end] is bound in the
8832 map and we're in a position to do the key remapping, replace it with
8833 the binding and restart with fkey->start at the end. */
8834 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8836 int len
= XFASTINT (Flength (next
));
8839 *diff
= len
- (fkey
->end
- fkey
->start
);
8841 if (bufsize
- input
<= *diff
)
8842 error ("Key sequence too long");
8844 /* Shift the keys that follow fkey->end. */
8846 for (i
= fkey
->end
; i
< input
; i
++)
8847 keybuf
[i
+ *diff
] = keybuf
[i
];
8849 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8850 keybuf
[i
+ *diff
] = keybuf
[i
];
8851 /* Overwrite the old keys with the new ones. */
8852 for (i
= 0; i
< len
; i
++)
8853 keybuf
[fkey
->start
+ i
]
8854 = Faref (next
, make_number (i
));
8856 fkey
->start
= fkey
->end
+= *diff
;
8857 fkey
->map
= fkey
->parent
;
8862 fkey
->map
= get_keymap (next
, 0, 1);
8864 /* If we no longer have a bound suffix, try a new position for
8866 if (!CONSP (fkey
->map
))
8868 fkey
->end
= ++fkey
->start
;
8869 fkey
->map
= fkey
->parent
;
8875 test_undefined (Lisp_Object binding
)
8877 return (NILP (binding
)
8878 || EQ (binding
, Qundefined
)
8879 || (SYMBOLP (binding
)
8880 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8883 /* Read a sequence of keys that ends with a non prefix character,
8884 storing it in KEYBUF, a buffer of size BUFSIZE.
8886 Return the length of the key sequence stored.
8887 Return -1 if the user rejected a command menu.
8889 Echo starting immediately unless `prompt' is 0.
8891 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8892 read_char with a suitable COMMANDFLAG argument.
8894 Where a key sequence ends depends on the currently active keymaps.
8895 These include any minor mode keymaps active in the current buffer,
8896 the current buffer's local map, and the global map.
8898 If a key sequence has no other bindings, we check Vfunction_key_map
8899 to see if some trailing subsequence might be the beginning of a
8900 function key's sequence. If so, we try to read the whole function
8901 key, and substitute its symbolic name into the key sequence.
8903 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8904 `double-' events into similar click events, if that would make them
8905 bound. We try to turn `triple-' events first into `double-' events,
8908 If we get a mouse click in a mode line, vertical divider, or other
8909 non-text area, we treat the click as if it were prefixed by the
8910 symbol denoting that area - `mode-line', `vertical-line', or
8913 If the sequence starts with a mouse click, we read the key sequence
8914 with respect to the buffer clicked on, not the current buffer.
8916 If the user switches frames in the midst of a key sequence, we put
8917 off the switch-frame event until later; the next call to
8918 read_char will return it.
8920 If FIX_CURRENT_BUFFER, we restore current_buffer
8921 from the selected window's buffer. */
8924 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8925 bool dont_downcase_last
, bool can_return_switch_frame
,
8926 bool fix_current_buffer
, bool prevent_redisplay
)
8928 ptrdiff_t count
= SPECPDL_INDEX ();
8930 /* How many keys there are in the current key sequence. */
8933 /* The length of the echo buffer when we started reading, and
8934 the length of this_command_keys when we started reading. */
8935 ptrdiff_t echo_start
IF_LINT (= 0);
8936 ptrdiff_t keys_start
;
8938 Lisp_Object current_binding
= Qnil
;
8939 Lisp_Object first_event
= Qnil
;
8941 /* Index of the first key that has no binding.
8942 It is useless to try fkey.start larger than that. */
8945 /* If t < mock_input, then KEYBUF[t] should be read as the next
8948 We use this to recover after recognizing a function key. Once we
8949 realize that a suffix of the current key sequence is actually a
8950 function key's escape sequence, we replace the suffix with the
8951 function key's binding from Vfunction_key_map. Now keybuf
8952 contains a new and different key sequence, so the echo area,
8953 this_command_keys, and the submaps and defs arrays are wrong. In
8954 this situation, we set mock_input to t, set t to 0, and jump to
8955 restart_sequence; the loop will read keys from keybuf up until
8956 mock_input, thus rebuilding the state; and then it will resume
8957 reading characters from the keyboard. */
8960 /* If the sequence is unbound in submaps[], then
8961 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8962 and fkey.map is its binding.
8964 These might be > t, indicating that all function key scanning
8965 should hold off until t reaches them. We do this when we've just
8966 recognized a function key, to avoid searching for the function
8967 key's again in Vfunction_key_map. */
8970 /* Likewise, for key_translation_map and input-decode-map. */
8971 keyremap keytran
, indec
;
8973 /* True if we are trying to map a key by changing an upper-case
8974 letter to lower case, or a shifted function key to an unshifted
8976 bool shift_translated
= 0;
8978 /* If we receive a `switch-frame' or `select-window' event in the middle of
8979 a key sequence, we put it off for later.
8980 While we're reading, we keep the event here. */
8981 Lisp_Object delayed_switch_frame
;
8983 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8984 int original_uppercase_position
= -1;
8986 /* Gets around Microsoft compiler limitations. */
8989 struct buffer
*starting_buffer
;
8991 /* List of events for which a fake prefix key has been generated. */
8992 Lisp_Object fake_prefixed_keys
= Qnil
;
8994 struct gcpro gcpro1
;
8996 GCPRO1 (fake_prefixed_keys
);
8997 raw_keybuf_count
= 0;
8999 last_nonmenu_event
= Qnil
;
9001 delayed_switch_frame
= Qnil
;
9007 /* Install the string PROMPT as the beginning of the string
9008 of echoing, so that it serves as a prompt for the next
9010 kset_echo_string (current_kboard
, prompt
);
9011 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
9014 else if (cursor_in_echo_area
9015 && echo_keystrokes_p ())
9016 /* This doesn't put in a dash if the echo buffer is empty, so
9017 you don't always see a dash hanging out in the minibuffer. */
9021 /* Record the initial state of the echo area and this_command_keys;
9022 we will need to restore them if we replay a key sequence. */
9024 echo_start
= echo_length ();
9025 keys_start
= this_command_key_count
;
9026 this_single_command_key_start
= keys_start
;
9028 /* We jump here when we need to reinitialize fkey and keytran; this
9029 happens if we switch keyboards between rescans. */
9030 replay_entire_sequence
:
9032 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
9033 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
9034 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
9035 indec
.start
= indec
.end
= 0;
9036 fkey
.start
= fkey
.end
= 0;
9037 keytran
.start
= keytran
.end
= 0;
9039 /* We jump here when the key sequence has been thoroughly changed, and
9040 we need to rescan it starting from the beginning. When we jump here,
9041 keybuf[0..mock_input] holds the sequence we should reread. */
9044 starting_buffer
= current_buffer
;
9045 first_unbound
= bufsize
+ 1;
9047 /* Build our list of keymaps.
9048 If we recognize a function key and replace its escape sequence in
9049 keybuf with its symbol, or if the sequence starts with a mouse
9050 click and we need to switch buffers, we jump back here to rebuild
9051 the initial keymaps from the current buffer. */
9052 current_binding
= active_maps (first_event
);
9054 /* Start from the beginning in keybuf. */
9057 /* These are no-ops the first time through, but if we restart, they
9058 revert the echo area and this_command_keys to their original state. */
9059 this_command_key_count
= keys_start
;
9060 if (INTERACTIVE
&& t
< mock_input
)
9061 echo_truncate (echo_start
);
9063 /* If the best binding for the current key sequence is a keymap, or
9064 we may be looking at a function key's escape sequence, keep on
9066 while (!NILP (current_binding
)
9067 /* Keep reading as long as there's a prefix binding. */
9068 ? KEYMAPP (current_binding
)
9069 /* Don't return in the middle of a possible function key sequence,
9070 if the only bindings we found were via case conversion.
9071 Thus, if ESC O a has a function-key-map translation
9072 and ESC o has a binding, don't return after ESC O,
9073 so that we can translate ESC O plus the next character. */
9074 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9077 bool used_mouse_menu
= 0;
9079 /* Where the last real key started. If we need to throw away a
9080 key that has expanded into more than one element of keybuf
9081 (say, a mouse click on the mode line which is being treated
9082 as [mode-line (mouse-...)], then we backtrack to this point
9084 int last_real_key_start
;
9086 /* These variables are analogous to echo_start and keys_start;
9087 while those allow us to restart the entire key sequence,
9088 echo_local_start and keys_local_start allow us to throw away
9090 ptrdiff_t echo_local_start
IF_LINT (= 0);
9091 int keys_local_start
;
9092 Lisp_Object new_binding
;
9094 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9095 eassert (indec
.start
<= indec
.end
);
9096 eassert (fkey
.start
<= fkey
.end
);
9097 eassert (keytran
.start
<= keytran
.end
);
9098 /* key-translation-map is applied *after* function-key-map
9099 which is itself applied *after* input-decode-map. */
9100 eassert (fkey
.end
<= indec
.start
);
9101 eassert (keytran
.end
<= fkey
.start
);
9103 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9104 first_unbound
< keytran
.start
)
9105 { /* The prefix upto first_unbound has no binding and has
9106 no translation left to do either, so we know it's unbound.
9107 If we don't stop now, we risk staying here indefinitely
9108 (if the user keeps entering fkey or keytran prefixes
9109 like C-c ESC ESC ESC ESC ...) */
9111 for (i
= first_unbound
+ 1; i
< t
; i
++)
9112 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9113 mock_input
= t
- first_unbound
- 1;
9114 indec
.end
= indec
.start
-= first_unbound
+ 1;
9115 indec
.map
= indec
.parent
;
9116 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9117 fkey
.map
= fkey
.parent
;
9118 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9119 keytran
.map
= keytran
.parent
;
9120 goto replay_sequence
;
9124 error ("Key sequence too long");
9127 echo_local_start
= echo_length ();
9128 keys_local_start
= this_command_key_count
;
9131 /* These are no-ops, unless we throw away a keystroke below and
9132 jumped back up to replay_key; in that case, these restore the
9133 variables to their original state, allowing us to replay the
9135 if (INTERACTIVE
&& t
< mock_input
)
9136 echo_truncate (echo_local_start
);
9137 this_command_key_count
= keys_local_start
;
9139 /* By default, assume each event is "real". */
9140 last_real_key_start
= t
;
9142 /* Does mock_input indicate that we are re-reading a key sequence? */
9146 add_command_key (key
);
9147 if (echo_keystrokes_p ()
9148 && current_kboard
->immediate_echo
)
9155 /* If not, we should actually read a character. */
9159 KBOARD
*interrupted_kboard
= current_kboard
;
9160 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9161 /* Calling read_char with COMMANDFLAG = -2 avoids
9162 redisplay in read_char and its subroutines. */
9163 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9164 current_binding
, last_nonmenu_event
,
9165 &used_mouse_menu
, NULL
);
9166 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9167 /* When switching to a new tty (with a new keyboard),
9168 read_char returns the new buffer, rather than -2
9169 (Bug#5095). This is because `terminal-init-xterm'
9170 calls read-char, which eats the wrong_kboard_jmpbuf
9171 return. Any better way to fix this? -- cyd */
9172 || (interrupted_kboard
!= current_kboard
))
9177 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9178 if (k
== interrupted_kboard
)
9183 /* Don't touch interrupted_kboard when it's been
9185 delayed_switch_frame
= Qnil
;
9186 goto replay_entire_sequence
;
9189 if (!NILP (delayed_switch_frame
))
9192 (interrupted_kboard
,
9193 Fcons (delayed_switch_frame
,
9194 KVAR (interrupted_kboard
, kbd_queue
)));
9195 delayed_switch_frame
= Qnil
;
9200 (interrupted_kboard
,
9201 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9203 /* If the side queue is non-empty, ensure it begins with a
9204 switch-frame, so we'll replay it in the right context. */
9205 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9206 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9207 !(EVENT_HAS_PARAMETERS (key
)
9208 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9212 XSETFRAME (frame
, interrupted_frame
);
9214 (interrupted_kboard
,
9215 Fcons (make_lispy_switch_frame (frame
),
9216 KVAR (interrupted_kboard
, kbd_queue
)));
9219 goto replay_entire_sequence
;
9223 /* read_char returns t when it shows a menu and the user rejects it.
9227 unbind_to (count
, Qnil
);
9232 /* read_char returns -1 at the end of a macro.
9233 Emacs 18 handles this by returning immediately with a
9234 zero, so that's what we'll do. */
9235 if (INTEGERP (key
) && XINT (key
) == -1)
9238 /* The Microsoft C compiler can't handle the goto that
9244 /* If the current buffer has been changed from under us, the
9245 keymap may have changed, so replay the sequence. */
9248 timer_resume_idle ();
9251 /* Reset the current buffer from the selected window
9252 in case something changed the former and not the latter.
9253 This is to be more consistent with the behavior
9254 of the command_loop_1. */
9255 if (fix_current_buffer
)
9257 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9259 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9261 Fset_buffer (XWINDOW (selected_window
)->contents
);
9264 goto replay_sequence
;
9267 /* If we have a quit that was typed in another frame, and
9268 quit_throw_to_read_char switched buffers,
9269 replay to get the right keymap. */
9271 && XINT (key
) == quit_char
9272 && current_buffer
!= starting_buffer
)
9275 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9280 goto replay_sequence
;
9285 if (EVENT_HAS_PARAMETERS (key
)
9286 /* Either a `switch-frame' or a `select-window' event. */
9287 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9289 /* If we're at the beginning of a key sequence, and the caller
9290 says it's okay, go ahead and return this event. If we're
9291 in the midst of a key sequence, delay it until the end. */
9292 if (t
> 0 || !can_return_switch_frame
)
9294 delayed_switch_frame
= key
;
9299 if (NILP (first_event
))
9302 /* Even if first_event does not specify a particular
9303 window/position, it's important to recompute the maps here
9304 since a long time might have passed since we entered
9305 read_key_sequence, and a timer (or process-filter or
9306 special-event-map, ...) might have switched the current buffer
9307 or the selected window from under us in the mean time. */
9308 if (fix_current_buffer
9309 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9311 Fset_buffer (XWINDOW (selected_window
)->contents
);
9312 current_binding
= active_maps (first_event
);
9316 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9320 /* Clicks in non-text areas get prefixed by the symbol
9321 in their CHAR-ADDRESS field. For example, a click on
9322 the mode line is prefixed by the symbol `mode-line'.
9324 Furthermore, key sequences beginning with mouse clicks
9325 are read using the keymaps of the buffer clicked on, not
9326 the current buffer. So we may have to switch the buffer
9329 When we turn one event into two events, we must make sure
9330 that neither of the two looks like the original--so that,
9331 if we replay the events, they won't be expanded again.
9332 If not for this, such reexpansion could happen either here
9333 or when user programs play with this-command-keys. */
9334 if (EVENT_HAS_PARAMETERS (key
))
9336 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9337 if (EQ (kind
, Qmouse_click
))
9339 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9340 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9343 || (!NILP (fake_prefixed_keys
)
9344 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9346 /* We're looking a second time at an event for which
9347 we generated a fake prefix key. Set
9348 last_real_key_start appropriately. */
9350 last_real_key_start
= t
- 1;
9353 if (last_real_key_start
== 0)
9355 /* Key sequences beginning with mouse clicks are
9356 read using the keymaps in the buffer clicked on,
9357 not the current buffer. If we're at the
9358 beginning of a key sequence, switch buffers. */
9359 if (WINDOWP (window
)
9360 && BUFFERP (XWINDOW (window
)->contents
)
9361 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9363 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9368 /* Arrange to go back to the original buffer once we're
9369 done reading the key sequence. Note that we can't
9370 use save_excursion_{save,restore} here, because they
9371 save point as well as the current buffer; we don't
9372 want to save point, because redisplay may change it,
9373 to accommodate a Fset_window_start or something. We
9374 don't want to do this at the top of the function,
9375 because we may get input from a subprocess which
9376 wants to change the selected window and stuff (say,
9378 record_unwind_current_buffer ();
9380 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9382 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9383 goto replay_sequence
;
9387 /* Expand mode-line and scroll-bar events into two events:
9388 use posn as a fake prefix key. */
9390 && (NILP (fake_prefixed_keys
)
9391 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9393 if (bufsize
- t
<= 1)
9394 error ("Key sequence too long");
9397 keybuf
[t
+ 1] = key
;
9400 /* Record that a fake prefix key has been generated
9401 for KEY. Don't modify the event; this would
9402 prevent proper action when the event is pushed
9403 back into unread-command-events. */
9404 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9408 else if (CONSP (XCDR (key
))
9409 && CONSP (EVENT_START (key
))
9410 && CONSP (XCDR (EVENT_START (key
))))
9414 posn
= POSN_POSN (EVENT_START (key
));
9415 /* Handle menu-bar events:
9416 insert the dummy prefix event `menu-bar'. */
9417 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9419 if (bufsize
- t
<= 1)
9420 error ("Key sequence too long");
9422 keybuf
[t
+ 1] = key
;
9424 /* Zap the position in key, so we know that we've
9425 expanded it, and don't try to do so again. */
9426 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9429 goto replay_sequence
;
9431 else if (CONSP (posn
))
9433 /* We're looking at the second event of a
9434 sequence which we expanded before. Set
9435 last_real_key_start appropriately. */
9436 if (last_real_key_start
== t
&& t
> 0)
9437 last_real_key_start
= t
- 1;
9442 /* We have finally decided that KEY is something we might want
9444 new_binding
= follow_key (current_binding
, key
);
9446 /* If KEY wasn't bound, we'll try some fallbacks. */
9447 if (!NILP (new_binding
))
9448 /* This is needed for the following scenario:
9449 event 0: a down-event that gets dropped by calling replay_key.
9450 event 1: some normal prefix like C-h.
9451 After event 0, first_unbound is 0, after event 1 indec.start,
9452 fkey.start, and keytran.start are all 1, so when we see that
9453 C-h is bound, we need to update first_unbound. */
9454 first_unbound
= max (t
+ 1, first_unbound
);
9459 /* Remember the position to put an upper bound on indec.start. */
9460 first_unbound
= min (t
, first_unbound
);
9462 head
= EVENT_HEAD (key
);
9466 Lisp_Object breakdown
;
9469 breakdown
= parse_modifiers (head
);
9470 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9471 /* Attempt to reduce an unbound mouse event to a simpler
9472 event that is bound:
9473 Drags reduce to clicks.
9474 Double-clicks reduce to clicks.
9475 Triple-clicks reduce to double-clicks, then to clicks.
9476 Down-clicks are eliminated.
9477 Double-downs reduce to downs, then are eliminated.
9478 Triple-downs reduce to double-downs, then to downs,
9479 then are eliminated. */
9480 if (modifiers
& (down_modifier
| drag_modifier
9481 | double_modifier
| triple_modifier
))
9483 while (modifiers
& (down_modifier
| drag_modifier
9484 | double_modifier
| triple_modifier
))
9486 Lisp_Object new_head
, new_click
;
9487 if (modifiers
& triple_modifier
)
9488 modifiers
^= (double_modifier
| triple_modifier
);
9489 else if (modifiers
& double_modifier
)
9490 modifiers
&= ~double_modifier
;
9491 else if (modifiers
& drag_modifier
)
9492 modifiers
&= ~drag_modifier
;
9495 /* Dispose of this `down' event by simply jumping
9496 back to replay_key, to get another event.
9498 Note that if this event came from mock input,
9499 then just jumping back to replay_key will just
9500 hand it to us again. So we have to wipe out any
9503 We could delete keybuf[t] and shift everything
9504 after that to the left by one spot, but we'd also
9505 have to fix up any variable that points into
9506 keybuf, and shifting isn't really necessary
9509 Adding prefixes for non-textual mouse clicks
9510 creates two characters of mock input, and both
9511 must be thrown away. If we're only looking at
9512 the prefix now, we can just jump back to
9513 replay_key. On the other hand, if we've already
9514 processed the prefix, and now the actual click
9515 itself is giving us trouble, then we've lost the
9516 state of the keymaps we want to backtrack to, and
9517 we need to replay the whole sequence to rebuild
9520 Beyond that, only function key expansion could
9521 create more than two keys, but that should never
9522 generate mouse events, so it's okay to zero
9523 mock_input in that case too.
9525 FIXME: The above paragraph seems just plain
9526 wrong, if you consider things like
9527 xterm-mouse-mode. -stef
9529 Isn't this just the most wonderful code ever? */
9531 /* If mock_input > t + 1, the above simplification
9532 will actually end up dropping keys on the floor.
9533 This is probably OK for now, but even
9534 if mock_input <= t + 1, we need to adjust indec,
9536 Typical case [header-line down-mouse-N]:
9537 mock_input = 2, t = 1, fkey.end = 1,
9538 last_real_key_start = 0. */
9539 if (indec
.end
> last_real_key_start
)
9541 indec
.end
= indec
.start
9542 = min (last_real_key_start
, indec
.start
);
9543 indec
.map
= indec
.parent
;
9544 if (fkey
.end
> last_real_key_start
)
9546 fkey
.end
= fkey
.start
9547 = min (last_real_key_start
, fkey
.start
);
9548 fkey
.map
= fkey
.parent
;
9549 if (keytran
.end
> last_real_key_start
)
9551 keytran
.end
= keytran
.start
9552 = min (last_real_key_start
, keytran
.start
);
9553 keytran
.map
= keytran
.parent
;
9557 if (t
== last_real_key_start
)
9564 mock_input
= last_real_key_start
;
9565 goto replay_sequence
;
9570 = apply_modifiers (modifiers
, XCAR (breakdown
));
9571 new_click
= list2 (new_head
, EVENT_START (key
));
9573 /* Look for a binding for this new key. */
9574 new_binding
= follow_key (current_binding
, new_click
);
9576 /* If that click is bound, go for it. */
9577 if (!NILP (new_binding
))
9579 current_binding
= new_binding
;
9583 /* Otherwise, we'll leave key set to the drag event. */
9588 current_binding
= new_binding
;
9591 /* Normally, last_nonmenu_event gets the previous key we read.
9592 But when a mouse popup menu is being used,
9593 we don't update last_nonmenu_event; it continues to hold the mouse
9594 event that preceded the first level of menu. */
9595 if (!used_mouse_menu
)
9596 last_nonmenu_event
= key
;
9598 /* Record what part of this_command_keys is the current key sequence. */
9599 this_single_command_key_start
= this_command_key_count
- t
;
9601 /* Look for this sequence in input-decode-map.
9602 Scan from indec.end until we find a bound suffix. */
9603 while (indec
.end
< t
)
9605 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9609 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9610 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9615 mock_input
= diff
+ max (t
, mock_input
);
9616 goto replay_sequence
;
9620 if (!KEYMAPP (current_binding
)
9621 && !test_undefined (current_binding
)
9622 && indec
.start
>= t
)
9623 /* There is a binding and it's not a prefix.
9624 (and it doesn't have any input-decode-map translation pending).
9625 There is thus no function-key in this sequence.
9626 Moving fkey.start is important in this case to allow keytran.start
9627 to go over the sequence before we return (since we keep the
9628 invariant that keytran.end <= fkey.start). */
9631 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9634 /* If the sequence is unbound, see if we can hang a function key
9635 off the end of it. */
9636 /* Continue scan from fkey.end until we find a bound suffix. */
9637 while (fkey
.end
< indec
.start
)
9639 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9643 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9644 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9645 max (t
, mock_input
),
9646 /* If there's a binding (i.e.
9647 first_binding >= nmaps) we don't want
9648 to apply this function-key-mapping. */
9650 && (test_undefined (current_binding
)),
9655 mock_input
= diff
+ max (t
, mock_input
);
9656 /* Adjust the input-decode-map counters. */
9658 indec
.start
+= diff
;
9660 goto replay_sequence
;
9664 /* Look for this sequence in key-translation-map.
9665 Scan from keytran.end until we find a bound suffix. */
9666 while (keytran
.end
< fkey
.start
)
9668 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9672 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9673 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9678 mock_input
= diff
+ max (t
, mock_input
);
9679 /* Adjust the function-key-map and input-decode-map counters. */
9681 indec
.start
+= diff
;
9685 goto replay_sequence
;
9689 /* If KEY is not defined in any of the keymaps,
9690 and cannot be part of a function key or translation,
9691 and is an upper case letter
9692 use the corresponding lower-case letter instead. */
9693 if (NILP (current_binding
)
9694 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9696 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9697 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9698 || (XINT (key
) & shift_modifier
)))
9700 Lisp_Object new_key
;
9702 original_uppercase
= key
;
9703 original_uppercase_position
= t
- 1;
9705 if (XINT (key
) & shift_modifier
)
9706 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9708 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9709 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9711 /* We have to do this unconditionally, regardless of whether
9712 the lower-case char is defined in the keymaps, because they
9713 might get translated through function-key-map. */
9714 keybuf
[t
- 1] = new_key
;
9715 mock_input
= max (t
, mock_input
);
9716 shift_translated
= 1;
9718 goto replay_sequence
;
9721 if (NILP (current_binding
)
9722 && help_char_p (EVENT_HEAD (key
)) && t
> 1)
9724 read_key_sequence_cmd
= Vprefix_help_command
;
9725 /* The Microsoft C compiler can't handle the goto that
9731 /* If KEY is not defined in any of the keymaps,
9732 and cannot be part of a function key or translation,
9733 and is a shifted function key,
9734 use the corresponding unshifted function key instead. */
9735 if (NILP (current_binding
)
9736 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9738 Lisp_Object breakdown
= parse_modifiers (key
);
9740 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9742 if (modifiers
& shift_modifier
9743 /* Treat uppercase keys as shifted. */
9745 && (KEY_TO_CHAR (key
)
9746 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9747 && uppercasep (KEY_TO_CHAR (key
))))
9750 = (modifiers
& shift_modifier
9751 ? apply_modifiers (modifiers
& ~shift_modifier
,
9753 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9755 original_uppercase
= key
;
9756 original_uppercase_position
= t
- 1;
9758 /* We have to do this unconditionally, regardless of whether
9759 the lower-case char is defined in the keymaps, because they
9760 might get translated through function-key-map. */
9761 keybuf
[t
- 1] = new_key
;
9762 mock_input
= max (t
, mock_input
);
9763 /* Reset fkey (and consequently keytran) to apply
9764 function-key-map on the result, so that S-backspace is
9765 correctly mapped to DEL (via backspace). OTOH,
9766 input-decode-map doesn't need to go through it again. */
9767 fkey
.start
= fkey
.end
= 0;
9768 keytran
.start
= keytran
.end
= 0;
9769 shift_translated
= 1;
9771 goto replay_sequence
;
9776 read_key_sequence_cmd
= current_binding
;
9777 read_key_sequence_remapped
9778 /* Remap command through active keymaps.
9779 Do the remapping here, before the unbind_to so it uses the keymaps
9780 of the appropriate buffer. */
9781 = SYMBOLP (read_key_sequence_cmd
)
9782 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9785 unread_switch_frame
= delayed_switch_frame
;
9786 unbind_to (count
, Qnil
);
9788 /* Don't downcase the last character if the caller says don't.
9789 Don't downcase it if the result is undefined, either. */
9790 if ((dont_downcase_last
|| NILP (current_binding
))
9792 && t
- 1 == original_uppercase_position
)
9794 keybuf
[t
- 1] = original_uppercase
;
9795 shift_translated
= 0;
9798 if (shift_translated
)
9799 Vthis_command_keys_shift_translated
= Qt
;
9801 /* Occasionally we fabricate events, perhaps by expanding something
9802 according to function-key-map, or by adding a prefix symbol to a
9803 mouse click in the scroll bar or modeline. In this cases, return
9804 the entire generated key sequence, even if we hit an unbound
9805 prefix or a definition before the end. This means that you will
9806 be able to push back the event properly, and also means that
9807 read-key-sequence will always return a logical unit.
9810 for (; t
< mock_input
; t
++)
9812 if (echo_keystrokes_p ())
9813 echo_char (keybuf
[t
]);
9814 add_command_key (keybuf
[t
]);
9822 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9823 Lisp_Object dont_downcase_last
,
9824 Lisp_Object can_return_switch_frame
,
9825 Lisp_Object cmd_loop
, bool allow_string
)
9827 Lisp_Object keybuf
[30];
9829 struct gcpro gcpro1
;
9830 ptrdiff_t count
= SPECPDL_INDEX ();
9833 CHECK_STRING (prompt
);
9836 specbind (Qinput_method_exit_on_first_char
,
9837 (NILP (cmd_loop
) ? Qt
: Qnil
));
9838 specbind (Qinput_method_use_echo_area
,
9839 (NILP (cmd_loop
) ? Qt
: Qnil
));
9841 memset (keybuf
, 0, sizeof keybuf
);
9843 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9845 if (NILP (continue_echo
))
9847 this_command_key_count
= 0;
9848 this_command_key_count_reset
= 0;
9849 this_single_command_key_start
= 0;
9852 #ifdef HAVE_WINDOW_SYSTEM
9853 if (display_hourglass_p
)
9854 cancel_hourglass ();
9857 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9858 prompt
, ! NILP (dont_downcase_last
),
9859 ! NILP (can_return_switch_frame
), 0, 0);
9861 #if 0 /* The following is fine for code reading a key sequence and
9862 then proceeding with a lengthy computation, but it's not good
9863 for code reading keys in a loop, like an input method. */
9864 #ifdef HAVE_WINDOW_SYSTEM
9865 if (display_hourglass_p
)
9876 return unbind_to (count
,
9877 ((allow_string
? make_event_array
: Fvector
)
9881 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9882 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9883 The sequence is sufficient to specify a non-prefix command in the
9884 current local and global maps.
9886 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9887 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9888 as a continuation of the previous key.
9890 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9891 convert the last event to lower case. (Normally any upper case event
9892 is converted to lower case if the original event is undefined and the lower
9893 case equivalent is defined.) A non-nil value is appropriate for reading
9894 a key sequence to be defined.
9896 A C-g typed while in this function is treated like any other character,
9897 and `quit-flag' is not set.
9899 If the key sequence starts with a mouse click, then the sequence is read
9900 using the keymaps of the buffer of the window clicked in, not the buffer
9901 of the selected window as normal.
9903 `read-key-sequence' drops unbound button-down events, since you normally
9904 only care about the click or drag events which follow them. If a drag
9905 or multi-click event is unbound, but the corresponding click event would
9906 be bound, `read-key-sequence' turns the event into a click event at the
9907 drag's starting position. This means that you don't have to distinguish
9908 between click and drag, double, or triple events unless you want to.
9910 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9911 lines separating windows, and scroll bars with imaginary keys
9912 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9914 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9915 function will process a switch-frame event if the user switches frames
9916 before typing anything. If the user switches frames in the middle of a
9917 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9918 is nil, then the event will be put off until after the current key sequence.
9920 `read-key-sequence' checks `function-key-map' for function key
9921 sequences, where they wouldn't conflict with ordinary bindings. See
9922 `function-key-map' for more details.
9924 The optional fifth argument CMD-LOOP, if non-nil, means
9925 that this key sequence is being read by something that will
9926 read commands one after another. It should be nil if the caller
9927 will read just one key sequence. */)
9928 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9930 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9931 can_return_switch_frame
, cmd_loop
, true);
9934 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9935 Sread_key_sequence_vector
, 1, 5, 0,
9936 doc
: /* Like `read-key-sequence' but always return a vector. */)
9937 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9939 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9940 can_return_switch_frame
, cmd_loop
, false);
9943 /* Return true if input events are pending. */
9946 detect_input_pending (void)
9948 return input_pending
|| get_input_pending (0);
9951 /* Return true if input events other than mouse movements are
9955 detect_input_pending_ignore_squeezables (void)
9957 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9960 /* Return true if input events are pending, and run any pending timers. */
9963 detect_input_pending_run_timers (bool do_display
)
9965 unsigned old_timers_run
= timers_run
;
9968 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9970 if (old_timers_run
!= timers_run
&& do_display
)
9971 redisplay_preserve_echo_area (8);
9973 return input_pending
;
9976 /* This is called in some cases before a possible quit.
9977 It cases the next call to detect_input_pending to recompute input_pending.
9978 So calling this function unnecessarily can't do any harm. */
9981 clear_input_pending (void)
9986 /* Return true if there are pending requeued events.
9987 This isn't used yet. The hope is to make wait_reading_process_output
9988 call it, and return if it runs Lisp code that unreads something.
9989 The problem is, kbd_buffer_get_event needs to be fixed to know what
9990 to do in that case. It isn't trivial. */
9993 requeued_events_pending_p (void)
9995 return (!NILP (Vunread_command_events
));
9998 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9999 doc
: /* Return t if command input is currently available with no wait.
10000 Actually, the value is nil only if we can be sure that no input is available;
10001 if there is a doubt, the value is t.
10003 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
10004 (Lisp_Object check_timers
)
10006 if (!NILP (Vunread_command_events
)
10007 || !NILP (Vunread_post_input_method_events
)
10008 || !NILP (Vunread_input_method_events
))
10011 /* Process non-user-visible events (Bug#10195). */
10012 process_special_events ();
10014 return (get_input_pending ((NILP (check_timers
)
10015 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
10016 | READABLE_EVENTS_FILTER_EVENTS
)
10020 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10021 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10024 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10027 if (total_keys
< NUM_RECENT_KEYS
)
10028 return Fvector (total_keys
, keys
);
10031 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10032 vcopy (val
, 0, keys
+ recent_keys_index
,
10033 NUM_RECENT_KEYS
- recent_keys_index
);
10034 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10035 keys
, recent_keys_index
);
10040 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10041 doc
: /* Return the key sequence that invoked this command.
10042 However, if the command has called `read-key-sequence', it returns
10043 the last key sequence that has been read.
10044 The value is a string or a vector.
10046 See also `this-command-keys-vector'. */)
10049 return make_event_array (this_command_key_count
,
10050 XVECTOR (this_command_keys
)->contents
);
10053 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10054 doc
: /* Return the key sequence that invoked this command, as a vector.
10055 However, if the command has called `read-key-sequence', it returns
10056 the last key sequence that has been read.
10058 See also `this-command-keys'. */)
10061 return Fvector (this_command_key_count
,
10062 XVECTOR (this_command_keys
)->contents
);
10065 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10066 Sthis_single_command_keys
, 0, 0, 0,
10067 doc
: /* Return the key sequence that invoked this command.
10068 More generally, it returns the last key sequence read, either by
10069 the command loop or by `read-key-sequence'.
10070 Unlike `this-command-keys', this function's value
10071 does not include prefix arguments.
10072 The value is always a vector. */)
10075 return Fvector (this_command_key_count
10076 - this_single_command_key_start
,
10077 (XVECTOR (this_command_keys
)->contents
10078 + this_single_command_key_start
));
10081 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10082 Sthis_single_command_raw_keys
, 0, 0, 0,
10083 doc
: /* Return the raw events that were read for this command.
10084 More generally, it returns the last key sequence read, either by
10085 the command loop or by `read-key-sequence'.
10086 Unlike `this-single-command-keys', this function's value
10087 shows the events before all translations (except for input methods).
10088 The value is always a vector. */)
10091 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10094 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10095 Sreset_this_command_lengths
, 0, 0, 0,
10096 doc
: /* Make the unread events replace the last command and echo.
10097 Used in `universal-argument-other-key'.
10099 `universal-argument-other-key' rereads the event just typed.
10100 It then gets translated through `function-key-map'.
10101 The translated event has to replace the real events,
10102 both in the value of (this-command-keys) and in echoing.
10103 To achieve this, `universal-argument-other-key' calls
10104 `reset-this-command-lengths', which discards the record of reading
10105 these events the first time. */)
10108 this_command_key_count
= before_command_key_count
;
10109 if (this_command_key_count
< this_single_command_key_start
)
10110 this_single_command_key_start
= this_command_key_count
;
10112 echo_truncate (before_command_echo_length
);
10114 /* Cause whatever we put into unread-command-events
10115 to echo as if it were being freshly read from the keyboard. */
10116 this_command_key_count_reset
= 1;
10121 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10122 Sclear_this_command_keys
, 0, 1, 0,
10123 doc
: /* Clear out the vector that `this-command-keys' returns.
10124 Also clear the record of the last 100 events, unless optional arg
10125 KEEP-RECORD is non-nil. */)
10126 (Lisp_Object keep_record
)
10130 this_command_key_count
= 0;
10131 this_command_key_count_reset
= 0;
10133 if (NILP (keep_record
))
10135 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10136 ASET (recent_keys
, i
, Qnil
);
10138 recent_keys_index
= 0;
10143 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10144 doc
: /* Return the current depth in recursive edits. */)
10148 /* Wrap around reliably on integer overflow. */
10149 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10150 XSETINT (temp
, sum
);
10154 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10155 "FOpen dribble file: ",
10156 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10157 If FILE is nil, close any open dribble file.
10158 The file will be closed when Emacs exits.
10160 Be aware that this records ALL characters you type!
10161 This may include sensitive information such as passwords. */)
10174 Lisp_Object encfile
;
10176 file
= Fexpand_file_name (file
, Qnil
);
10177 encfile
= ENCODE_FILE (file
);
10178 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10179 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10180 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10181 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10183 report_file_error ("Opening dribble", file
);
10188 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10189 doc
: /* Discard the contents of the terminal input buffer.
10190 Also end any kbd macro being defined. */)
10193 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10195 /* Discard the last command from the macro. */
10196 Fcancel_kbd_macro_events ();
10200 Vunread_command_events
= Qnil
;
10202 discard_tty_input ();
10204 kbd_fetch_ptr
= kbd_store_ptr
;
10210 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10211 doc
: /* Stop Emacs and return to superior process. You can resume later.
10212 If `cannot-suspend' is non-nil, or if the system doesn't support job
10213 control, run a subshell instead.
10215 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10216 to be read as terminal input by Emacs's parent, after suspension.
10218 Before suspending, run the normal hook `suspend-hook'.
10219 After resumption run the normal hook `suspend-resume-hook'.
10221 Some operating systems cannot stop the Emacs process and resume it later.
10222 On such systems, Emacs starts a subshell instead of suspending. */)
10223 (Lisp_Object stuffstring
)
10225 ptrdiff_t count
= SPECPDL_INDEX ();
10226 int old_height
, old_width
;
10228 struct gcpro gcpro1
;
10231 if (tty_list
&& tty_list
->next
)
10232 error ("There are other tty frames open; close them before suspending Emacs");
10234 if (!NILP (stuffstring
))
10235 CHECK_STRING (stuffstring
);
10237 /* Run the functions in suspend-hook. */
10238 hook
= intern ("suspend-hook");
10239 Frun_hooks (1, &hook
);
10241 GCPRO1 (stuffstring
);
10242 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10243 reset_all_sys_modes ();
10244 /* sys_suspend can get an error if it tries to fork a subshell
10245 and the system resources aren't available for that. */
10246 record_unwind_protect_void (init_all_sys_modes
);
10247 stuff_buffered_input (stuffstring
);
10248 if (cannot_suspend
)
10252 unbind_to (count
, Qnil
);
10254 /* Check if terminal/window size has changed.
10255 Note that this is not useful when we are running directly
10256 with a window system; but suspend should be disabled in that case. */
10257 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10258 if (width
!= old_width
|| height
!= old_height
)
10259 change_frame_size (SELECTED_FRAME (), width
,
10260 height
- FRAME_MENU_BAR_LINES (SELECTED_FRAME ()),
10263 /* Run suspend-resume-hook. */
10264 hook
= intern ("suspend-resume-hook");
10265 Frun_hooks (1, &hook
);
10271 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10272 Then in any case stuff anything Emacs has read ahead and not used. */
10275 stuff_buffered_input (Lisp_Object stuffstring
)
10277 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10278 register unsigned char *p
;
10280 if (STRINGP (stuffstring
))
10282 register ptrdiff_t count
;
10284 p
= SDATA (stuffstring
);
10285 count
= SBYTES (stuffstring
);
10286 while (count
-- > 0)
10291 /* Anything we have read ahead, put back for the shell to read. */
10292 /* ?? What should this do when we have multiple keyboards??
10293 Should we ignore anything that was typed in at the "wrong" kboard?
10295 rms: we should stuff everything back into the kboard
10297 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10300 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10301 kbd_fetch_ptr
= kbd_buffer
;
10302 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10303 stuff_char (kbd_fetch_ptr
->code
);
10305 clear_event (kbd_fetch_ptr
);
10309 #endif /* SIGTSTP */
10313 set_waiting_for_input (struct timespec
*time_to_clear
)
10315 input_available_clear_time
= time_to_clear
;
10317 /* Tell handle_interrupt to throw back to read_char, */
10318 waiting_for_input
= 1;
10320 /* If handle_interrupt was called before and buffered a C-g,
10321 make it run again now, to avoid timing error. */
10322 if (!NILP (Vquit_flag
))
10323 quit_throw_to_read_char (0);
10327 clear_waiting_for_input (void)
10329 /* Tell handle_interrupt not to throw back to read_char, */
10330 waiting_for_input
= 0;
10331 input_available_clear_time
= 0;
10334 /* The SIGINT handler.
10336 If we have a frame on the controlling tty, we assume that the
10337 SIGINT was generated by C-g, so we call handle_interrupt.
10338 Otherwise, tell QUIT to kill Emacs. */
10341 handle_interrupt_signal (int sig
)
10343 /* See if we have an active terminal on our controlling tty. */
10344 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10347 /* If there are no frames there, let's pretend that we are a
10348 well-behaving UN*X program and quit. We must not call Lisp
10349 in a signal handler, so tell QUIT to exit when it is
10351 Vquit_flag
= Qkill_emacs
;
10355 /* Otherwise, the SIGINT was probably generated by C-g. */
10357 /* Set internal_last_event_frame to the top frame of the
10358 controlling tty, if we have a frame there. We disable the
10359 interrupt key on secondary ttys, so the SIGINT must have come
10360 from the controlling tty. */
10361 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10363 handle_interrupt (1);
10368 deliver_interrupt_signal (int sig
)
10370 deliver_process_signal (sig
, handle_interrupt_signal
);
10374 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10375 of the number of times C-g has been requested. If C-g is pressed
10376 enough times, then quit anyway. See bug#6585. */
10377 static int volatile force_quit_count
;
10379 /* This routine is called at interrupt level in response to C-g.
10381 It is called from the SIGINT handler or kbd_buffer_store_event.
10383 If `waiting_for_input' is non zero, then unless `echoing' is
10384 nonzero, immediately throw back to read_char.
10386 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10387 eval to throw, when it gets a chance. If quit-flag is already
10388 non-nil, it stops the job right away. */
10391 handle_interrupt (bool in_signal_handler
)
10397 /* XXX This code needs to be revised for multi-tty support. */
10398 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10400 if (! in_signal_handler
)
10402 /* If SIGINT isn't blocked, don't let us be interrupted by
10403 a SIGINT. It might be harmful due to non-reentrancy
10404 in I/O functions. */
10406 sigemptyset (&blocked
);
10407 sigaddset (&blocked
, SIGINT
);
10408 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10412 reset_all_sys_modes ();
10416 * On systems which can suspend the current process and return to the original
10417 * shell, this command causes the user to end up back at the shell.
10418 * The "Auto-save" and "Abort" questions are not asked until
10419 * the user elects to return to emacs, at which point he can save the current
10420 * job and either dump core or continue.
10424 /* Perhaps should really fork an inferior shell?
10425 But that would not provide any way to get back
10426 to the original shell, ever. */
10427 printf ("No support for stopping a process on this operating system;\n");
10428 printf ("you can continue or abort.\n");
10429 #endif /* not SIGTSTP */
10431 /* We must remain inside the screen area when the internal terminal
10432 is used. Note that [Enter] is not echoed by dos. */
10433 cursor_to (SELECTED_FRAME (), 0, 0);
10435 /* It doesn't work to autosave while GC is in progress;
10436 the code used for auto-saving doesn't cope with the mark bit. */
10437 if (!gc_in_progress
)
10439 printf ("Auto-save? (y or n) ");
10441 if (((c
= getchar ()) & ~040) == 'Y')
10443 Fdo_auto_save (Qt
, Qnil
);
10445 printf ("\r\nAuto-save done");
10446 #else /* not MSDOS */
10447 printf ("Auto-save done\n");
10448 #endif /* not MSDOS */
10450 while (c
!= '\n') c
= getchar ();
10454 /* During GC, it must be safe to reenable quitting again. */
10455 Vinhibit_quit
= Qnil
;
10458 #endif /* not MSDOS */
10459 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10460 printf ("but will instead do a real quit after garbage collection ends\r\n");
10465 printf ("\r\nAbort? (y or n) ");
10466 #else /* not MSDOS */
10467 printf ("Abort (and dump core)? (y or n) ");
10468 #endif /* not MSDOS */
10470 if (((c
= getchar ()) & ~040) == 'Y')
10472 while (c
!= '\n') c
= getchar ();
10474 printf ("\r\nContinuing...\r\n");
10475 #else /* not MSDOS */
10476 printf ("Continuing...\n");
10477 #endif /* not MSDOS */
10479 init_all_sys_modes ();
10483 /* If executing a function that wants to be interrupted out of
10484 and the user has not deferred quitting by binding `inhibit-quit'
10485 then quit right away. */
10486 if (immediate_quit
&& NILP (Vinhibit_quit
))
10488 struct gl_state_s saved
;
10489 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10491 immediate_quit
= 0;
10492 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10494 GCPRO4 (saved
.object
, saved
.global_code
,
10495 saved
.current_syntax_table
, saved
.old_prop
);
10496 Fsignal (Qquit
, Qnil
);
10501 { /* Else request quit when it's safe. */
10502 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10503 force_quit_count
= count
;
10506 immediate_quit
= 1;
10507 Vinhibit_quit
= Qnil
;
10513 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10515 /* TODO: The longjmp in this call throws the NS event loop integration off,
10516 and it seems to do fine without this. Probably some attention
10517 needs to be paid to the setting of waiting_for_input in
10518 wait_reading_process_output() under HAVE_NS because of the call
10519 to ns_select there (needed because otherwise events aren't picked up
10520 outside of polling since we don't get SIGIO like X and we don't have a
10521 separate event loop thread like W32. */
10523 if (waiting_for_input
&& !echoing
)
10524 quit_throw_to_read_char (in_signal_handler
);
10528 /* Handle a C-g by making read_char return C-g. */
10531 quit_throw_to_read_char (bool from_signal
)
10533 /* When not called from a signal handler it is safe to call
10535 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10536 Fkill_emacs (Qnil
);
10538 /* Prevent another signal from doing this before we finish. */
10539 clear_waiting_for_input ();
10542 Vunread_command_events
= Qnil
;
10544 if (FRAMEP (internal_last_event_frame
)
10545 && !EQ (internal_last_event_frame
, selected_frame
))
10546 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10549 sys_longjmp (getcjmp
, 1);
10552 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10553 Sset_input_interrupt_mode
, 1, 1, 0,
10554 doc
: /* Set interrupt mode of reading keyboard input.
10555 If INTERRUPT is non-nil, Emacs will use input interrupts;
10556 otherwise Emacs uses CBREAK mode.
10558 See also `current-input-mode'. */)
10559 (Lisp_Object interrupt
)
10561 bool new_interrupt_input
;
10562 #ifdef USABLE_SIGIO
10563 #ifdef HAVE_X_WINDOWS
10564 if (x_display_list
!= NULL
)
10566 /* When using X, don't give the user a real choice,
10567 because we haven't implemented the mechanisms to support it. */
10568 new_interrupt_input
= 1;
10571 #endif /* HAVE_X_WINDOWS */
10572 new_interrupt_input
= !NILP (interrupt
);
10573 #else /* not USABLE_SIGIO */
10574 new_interrupt_input
= 0;
10575 #endif /* not USABLE_SIGIO */
10577 if (new_interrupt_input
!= interrupt_input
)
10579 #ifdef POLL_FOR_INPUT
10583 /* this causes startup screen to be restored and messes with the mouse */
10584 reset_all_sys_modes ();
10585 interrupt_input
= new_interrupt_input
;
10586 init_all_sys_modes ();
10588 interrupt_input
= new_interrupt_input
;
10591 #ifdef POLL_FOR_INPUT
10592 poll_suppress_count
= 1;
10599 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10600 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10601 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10602 C-q in key sequences.
10604 This setting only has an effect on tty terminals and only when
10605 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10607 See also `current-input-mode'. */)
10608 (Lisp_Object flow
, Lisp_Object terminal
)
10610 struct terminal
*t
= get_terminal (terminal
, 1);
10611 struct tty_display_info
*tty
;
10612 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10614 tty
= t
->display_info
.tty
;
10616 if (tty
->flow_control
!= !NILP (flow
))
10619 /* This causes startup screen to be restored and messes with the mouse. */
10620 reset_sys_modes (tty
);
10623 tty
->flow_control
= !NILP (flow
);
10626 init_sys_modes (tty
);
10632 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10633 doc
: /* Enable or disable 8-bit input on TERMINAL.
10634 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10635 bit as the Meta modifier.
10637 If META is nil, Emacs will ignore the top bit, on the assumption it is
10640 Otherwise, Emacs will accept and pass through 8-bit input without
10641 specially interpreting the top bit.
10643 This setting only has an effect on tty terminal devices.
10645 Optional parameter TERMINAL specifies the tty terminal device to use.
10646 It may be a terminal object, a frame, or nil for the terminal used by
10647 the currently selected frame.
10649 See also `current-input-mode'. */)
10650 (Lisp_Object meta
, Lisp_Object terminal
)
10652 struct terminal
*t
= get_terminal (terminal
, 1);
10653 struct tty_display_info
*tty
;
10656 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10658 tty
= t
->display_info
.tty
;
10662 else if (EQ (meta
, Qt
))
10667 if (tty
->meta_key
!= new_meta
)
10670 /* this causes startup screen to be restored and messes with the mouse */
10671 reset_sys_modes (tty
);
10674 tty
->meta_key
= new_meta
;
10677 init_sys_modes (tty
);
10683 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10684 doc
: /* Specify character used for quitting.
10685 QUIT must be an ASCII character.
10687 This function only has an effect on the controlling tty of the Emacs
10690 See also `current-input-mode'. */)
10693 struct terminal
*t
= get_named_tty ("/dev/tty");
10694 struct tty_display_info
*tty
;
10695 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10697 tty
= t
->display_info
.tty
;
10699 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10700 error ("QUIT must be an ASCII character");
10703 /* this causes startup screen to be restored and messes with the mouse */
10704 reset_sys_modes (tty
);
10707 /* Don't let this value be out of range. */
10708 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10711 init_sys_modes (tty
);
10717 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10718 doc
: /* Set mode of reading keyboard input.
10719 First arg INTERRUPT non-nil means use input interrupts;
10720 nil means use CBREAK mode.
10721 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10722 (no effect except in CBREAK mode).
10723 Third arg META t means accept 8-bit input (for a Meta key).
10724 META nil means ignore the top bit, on the assumption it is parity.
10725 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10726 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10727 See also `current-input-mode'. */)
10728 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10730 Fset_input_interrupt_mode (interrupt
);
10731 Fset_output_flow_control (flow
, Qnil
);
10732 Fset_input_meta_mode (meta
, Qnil
);
10734 Fset_quit_char (quit
);
10738 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10739 doc
: /* Return information about the way Emacs currently reads keyboard input.
10740 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10741 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10742 nil, Emacs is using CBREAK mode.
10743 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10744 terminal; this does not apply if Emacs uses interrupt-driven input.
10745 META is t if accepting 8-bit input with 8th bit as Meta flag.
10746 META nil means ignoring the top bit, on the assumption it is parity.
10747 META is neither t nor nil if accepting 8-bit input and using
10748 all 8 bits as the character code.
10749 QUIT is the character Emacs currently uses to quit.
10750 The elements of this list correspond to the arguments of
10751 `set-input-mode'. */)
10754 Lisp_Object val
[4];
10755 struct frame
*sf
= XFRAME (selected_frame
);
10757 val
[0] = interrupt_input
? Qt
: Qnil
;
10758 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10760 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10761 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10763 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10770 XSETFASTINT (val
[3], quit_char
);
10772 return Flist (ARRAYELTS (val
), val
);
10775 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10776 doc
: /* Return position information for pixel coordinates X and Y.
10777 By default, X and Y are relative to text area of the selected window.
10778 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10779 If optional fourth arg WHOLE is non-nil, X is relative to the left
10780 edge of the window.
10782 The return value is similar to a mouse click position:
10783 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10784 IMAGE (DX . DY) (WIDTH . HEIGHT))
10785 The `posn-' functions access elements of such lists. */)
10786 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10791 if (NILP (frame_or_window
))
10792 frame_or_window
= selected_window
;
10794 if (WINDOWP (frame_or_window
))
10796 struct window
*w
= decode_live_window (frame_or_window
);
10798 XSETINT (x
, (XINT (x
)
10799 + WINDOW_LEFT_EDGE_X (w
)
10801 ? window_box_left_offset (w
, TEXT_AREA
)
10803 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10804 frame_or_window
= w
->frame
;
10807 CHECK_LIVE_FRAME (frame_or_window
);
10809 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10812 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10813 doc
: /* Return position information for buffer POS in WINDOW.
10814 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10816 Return nil if position is not visible in window. Otherwise,
10817 the return value is similar to that returned by `event-start' for
10818 a mouse click at the upper left corner of the glyph corresponding
10819 to the given buffer position:
10820 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10821 IMAGE (DX . DY) (WIDTH . HEIGHT))
10822 The `posn-' functions access elements of such lists. */)
10823 (Lisp_Object pos
, Lisp_Object window
)
10828 window
= selected_window
;
10830 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10833 Lisp_Object x
= XCAR (tem
);
10834 Lisp_Object y
= XCAR (XCDR (tem
));
10836 /* Point invisible due to hscrolling? */
10839 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10845 /* Set up a new kboard object with reasonable initial values.
10846 TYPE is a window system for which this keyboard is used. */
10849 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10851 kset_overriding_terminal_local_map (kb
, Qnil
);
10852 kset_last_command (kb
, Qnil
);
10853 kset_real_last_command (kb
, Qnil
);
10854 kset_keyboard_translate_table (kb
, Qnil
);
10855 kset_last_repeatable_command (kb
, Qnil
);
10856 kset_prefix_arg (kb
, Qnil
);
10857 kset_last_prefix_arg (kb
, Qnil
);
10858 kset_kbd_queue (kb
, Qnil
);
10859 kb
->kbd_queue_has_data
= 0;
10860 kb
->immediate_echo
= 0;
10861 kset_echo_string (kb
, Qnil
);
10862 kb
->echo_after_prompt
= -1;
10863 kb
->kbd_macro_buffer
= 0;
10864 kb
->kbd_macro_bufsize
= 0;
10865 kset_defining_kbd_macro (kb
, Qnil
);
10866 kset_last_kbd_macro (kb
, Qnil
);
10867 kb
->reference_count
= 0;
10868 kset_system_key_alist (kb
, Qnil
);
10869 kset_system_key_syms (kb
, Qnil
);
10870 kset_window_system (kb
, type
);
10871 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10872 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10873 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10874 kset_default_minibuffer_frame (kb
, Qnil
);
10877 /* Allocate and basically initialize keyboard
10878 object to use with window system TYPE. */
10881 allocate_kboard (Lisp_Object type
)
10883 KBOARD
*kb
= xmalloc (sizeof *kb
);
10885 init_kboard (kb
, type
);
10886 kb
->next_kboard
= all_kboards
;
10892 * Destroy the contents of a kboard object, but not the object itself.
10893 * We use this just before deleting it, or if we're going to initialize
10894 * it a second time.
10897 wipe_kboard (KBOARD
*kb
)
10899 xfree (kb
->kbd_macro_buffer
);
10902 /* Free KB and memory referenced from it. */
10905 delete_kboard (KBOARD
*kb
)
10909 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10912 *kbp
= kb
->next_kboard
;
10914 /* Prevent a dangling reference to KB. */
10915 if (kb
== current_kboard
10916 && FRAMEP (selected_frame
)
10917 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10919 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10921 if (current_kboard
== kb
)
10930 init_keyboard (void)
10932 /* This is correct before outermost invocation of the editor loop. */
10933 command_loop_level
= -1;
10934 immediate_quit
= 0;
10935 quit_char
= Ctl ('g');
10936 Vunread_command_events
= Qnil
;
10937 timer_idleness_start_time
= invalid_timespec ();
10939 recent_keys_index
= 0;
10940 kbd_fetch_ptr
= kbd_buffer
;
10941 kbd_store_ptr
= kbd_buffer
;
10942 do_mouse_tracking
= Qnil
;
10944 interrupt_input_blocked
= 0;
10945 pending_signals
= 0;
10947 /* This means that command_loop_1 won't try to select anything the first
10949 internal_last_event_frame
= Qnil
;
10950 Vlast_event_frame
= internal_last_event_frame
;
10952 current_kboard
= initial_kboard
;
10953 /* Re-initialize the keyboard again. */
10954 wipe_kboard (current_kboard
);
10955 /* A value of nil for Vwindow_system normally means a tty, but we also use
10956 it for the initial terminal since there is no window system there. */
10957 init_kboard (current_kboard
, Qnil
);
10959 if (!noninteractive
)
10961 /* Before multi-tty support, these handlers used to be installed
10962 only if the current session was a tty session. Now an Emacs
10963 session may have multiple display types, so we always handle
10964 SIGINT. There is special code in handle_interrupt_signal to exit
10965 Emacs on SIGINT when there are no termcap frames on the
10966 controlling terminal. */
10967 struct sigaction action
;
10968 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10969 sigaction (SIGINT
, &action
, 0);
10971 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10972 SIGQUIT and we can't tell which one it will give us. */
10973 sigaction (SIGQUIT
, &action
, 0);
10974 #endif /* not DOS_NT */
10976 #ifdef USABLE_SIGIO
10977 if (!noninteractive
)
10979 struct sigaction action
;
10980 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10981 sigaction (SIGIO
, &action
, 0);
10985 /* Use interrupt input by default, if it works and noninterrupt input
10986 has deficiencies. */
10988 #ifdef INTERRUPT_INPUT
10989 interrupt_input
= 1;
10991 interrupt_input
= 0;
10994 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10997 if (keyboard_init_hook
)
10998 (*keyboard_init_hook
) ();
11000 #ifdef POLL_FOR_INPUT
11002 poll_suppress_count
= 1;
11007 /* This type's only use is in syms_of_keyboard, to initialize the
11008 event header symbols and put properties on them. */
11009 struct event_head
{
11015 static const struct event_head head_table
[] = {
11016 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11017 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11018 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11019 {&Qfocus_in
, "focus-in", &Qfocus_in
},
11020 {&Qfocus_out
, "focus-out", &Qfocus_out
},
11021 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11022 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11023 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11024 /* `select-window' should be handled just like `switch-frame'
11025 in read_key_sequence. */
11026 {&Qselect_window
, "select-window", &Qswitch_frame
}
11030 syms_of_keyboard (void)
11032 pending_funcalls
= Qnil
;
11033 staticpro (&pending_funcalls
);
11035 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11036 staticpro (&Vlispy_mouse_stem
);
11038 regular_top_level_message
= build_pure_c_string ("Back to top level");
11039 #ifdef HAVE_STACK_OVERFLOW_HANDLING
11040 recover_top_level_message
11041 = build_pure_c_string ("Re-entering top level after C stack overflow");
11043 DEFVAR_LISP ("internal--top-level-message", Vinternal__top_level_message
,
11044 doc
: /* Message displayed by `normal-top-level'. */);
11045 Vinternal__top_level_message
= regular_top_level_message
;
11048 DEFSYM (QCimage
, ":image");
11049 DEFSYM (Qhelp_echo
, "help-echo");
11050 DEFSYM (QCrtl
, ":rtl");
11052 staticpro (&item_properties
);
11053 item_properties
= Qnil
;
11055 staticpro (&tool_bar_item_properties
);
11056 tool_bar_item_properties
= Qnil
;
11057 staticpro (&tool_bar_items_vector
);
11058 tool_bar_items_vector
= Qnil
;
11060 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11061 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11062 DEFSYM (Qself_insert_command
, "self-insert-command");
11063 DEFSYM (Qforward_char
, "forward-char");
11064 DEFSYM (Qbackward_char
, "backward-char");
11065 DEFSYM (Qdisabled
, "disabled");
11066 DEFSYM (Qundefined
, "undefined");
11067 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11068 DEFSYM (Qpost_command_hook
, "post-command-hook");
11069 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11070 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11071 DEFSYM (Qfunction_key
, "function-key");
11072 DEFSYM (Qmouse_click
, "mouse-click");
11073 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11074 DEFSYM (Qsave_session
, "save-session");
11075 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11076 DEFSYM (Qmenu_enable
, "menu-enable");
11079 DEFSYM (Qlanguage_change
, "language-change");
11083 DEFSYM (Qdbus_event
, "dbus-event");
11086 #ifdef USE_FILE_NOTIFY
11087 DEFSYM (Qfile_notify
, "file-notify");
11088 #endif /* USE_FILE_NOTIFY */
11090 DEFSYM (QCenable
, ":enable");
11091 DEFSYM (QCvisible
, ":visible");
11092 DEFSYM (QChelp
, ":help");
11093 DEFSYM (QCfilter
, ":filter");
11094 DEFSYM (QCbutton
, ":button");
11095 DEFSYM (QCkeys
, ":keys");
11096 DEFSYM (QCkey_sequence
, ":key-sequence");
11097 DEFSYM (QCtoggle
, ":toggle");
11098 DEFSYM (QCradio
, ":radio");
11099 DEFSYM (QClabel
, ":label");
11100 DEFSYM (QCvert_only
, ":vert-only");
11102 DEFSYM (Qmode_line
, "mode-line");
11103 DEFSYM (Qvertical_line
, "vertical-line");
11104 DEFSYM (Qmenu_bar
, "menu-bar");
11105 DEFSYM (Qright_divider
, "right-divider");
11106 DEFSYM (Qbottom_divider
, "bottom-divider");
11108 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11110 DEFSYM (Qabove_handle
, "above-handle");
11111 DEFSYM (Qhandle
, "handle");
11112 DEFSYM (Qbelow_handle
, "below-handle");
11113 DEFSYM (Qup
, "up");
11114 DEFSYM (Qdown
, "down");
11115 DEFSYM (Qtop
, "top");
11116 DEFSYM (Qbottom
, "bottom");
11117 DEFSYM (Qend_scroll
, "end-scroll");
11118 DEFSYM (Qratio
, "ratio");
11119 DEFSYM (Qbefore_handle
, "before-handle");
11120 DEFSYM (Qhorizontal_handle
, "horizontal-handle");
11121 DEFSYM (Qafter_handle
, "after-handle");
11122 DEFSYM (Qleft
, "left");
11123 DEFSYM (Qright
, "right");
11124 DEFSYM (Qleftmost
, "leftmost");
11125 DEFSYM (Qrightmost
, "rightmost");
11127 DEFSYM (Qevent_kind
, "event-kind");
11128 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11129 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11130 DEFSYM (Qmodifier_cache
, "modifier-cache");
11132 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11133 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11135 DEFSYM (Qpolling_period
, "polling-period");
11137 DEFSYM (Qx_set_selection
, "x-set-selection");
11138 DEFSYM (QPRIMARY
, "PRIMARY");
11139 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11140 DEFSYM (Qhandle_select_window
, "handle-select-window");
11142 DEFSYM (Qinput_method_function
, "input-method-function");
11143 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11144 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11146 DEFSYM (Qhelp_form_show
, "help-form-show");
11148 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11150 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11151 Fset (Qinput_method_use_echo_area
, Qnil
);
11155 int len
= ARRAYELTS (head_table
);
11157 for (i
= 0; i
< len
; i
++)
11159 const struct event_head
*p
= &head_table
[i
];
11160 *p
->var
= intern_c_string (p
->name
);
11161 staticpro (p
->var
);
11162 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11163 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11167 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11168 staticpro (&button_down_location
);
11169 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11170 staticpro (&mouse_syms
);
11171 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11173 staticpro (&wheel_syms
);
11177 int len
= ARRAYELTS (modifier_names
);
11179 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11180 for (i
= 0; i
< len
; i
++)
11181 if (modifier_names
[i
])
11182 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11183 staticpro (&modifier_symbols
);
11186 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11187 staticpro (&recent_keys
);
11189 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11190 staticpro (&this_command_keys
);
11192 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11193 staticpro (&raw_keybuf
);
11195 DEFSYM (Qcommand_execute
, "command-execute");
11197 accent_key_syms
= Qnil
;
11198 staticpro (&accent_key_syms
);
11200 func_key_syms
= Qnil
;
11201 staticpro (&func_key_syms
);
11203 drag_n_drop_syms
= Qnil
;
11204 staticpro (&drag_n_drop_syms
);
11206 unread_switch_frame
= Qnil
;
11207 staticpro (&unread_switch_frame
);
11209 internal_last_event_frame
= Qnil
;
11210 staticpro (&internal_last_event_frame
);
11212 read_key_sequence_cmd
= Qnil
;
11213 staticpro (&read_key_sequence_cmd
);
11214 read_key_sequence_remapped
= Qnil
;
11215 staticpro (&read_key_sequence_remapped
);
11217 menu_bar_one_keymap_changed_items
= Qnil
;
11218 staticpro (&menu_bar_one_keymap_changed_items
);
11220 menu_bar_items_vector
= Qnil
;
11221 staticpro (&menu_bar_items_vector
);
11223 help_form_saved_window_configs
= Qnil
;
11224 staticpro (&help_form_saved_window_configs
);
11226 defsubr (&Scurrent_idle_time
);
11227 defsubr (&Sevent_symbol_parse_modifiers
);
11228 defsubr (&Sevent_convert_list
);
11229 defsubr (&Sread_key_sequence
);
11230 defsubr (&Sread_key_sequence_vector
);
11231 defsubr (&Srecursive_edit
);
11232 defsubr (&Strack_mouse
);
11233 defsubr (&Sinput_pending_p
);
11234 defsubr (&Srecent_keys
);
11235 defsubr (&Sthis_command_keys
);
11236 defsubr (&Sthis_command_keys_vector
);
11237 defsubr (&Sthis_single_command_keys
);
11238 defsubr (&Sthis_single_command_raw_keys
);
11239 defsubr (&Sreset_this_command_lengths
);
11240 defsubr (&Sclear_this_command_keys
);
11241 defsubr (&Ssuspend_emacs
);
11242 defsubr (&Sabort_recursive_edit
);
11243 defsubr (&Sexit_recursive_edit
);
11244 defsubr (&Srecursion_depth
);
11245 defsubr (&Scommand_error_default_function
);
11246 defsubr (&Stop_level
);
11247 defsubr (&Sdiscard_input
);
11248 defsubr (&Sopen_dribble_file
);
11249 defsubr (&Sset_input_interrupt_mode
);
11250 defsubr (&Sset_output_flow_control
);
11251 defsubr (&Sset_input_meta_mode
);
11252 defsubr (&Sset_quit_char
);
11253 defsubr (&Sset_input_mode
);
11254 defsubr (&Scurrent_input_mode
);
11255 defsubr (&Sposn_at_point
);
11256 defsubr (&Sposn_at_x_y
);
11258 DEFVAR_LISP ("last-command-event", last_command_event
,
11259 doc
: /* Last input event that was part of a command. */);
11261 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11262 doc
: /* Last input event in a command, except for mouse menu events.
11263 Mouse menus give back keys that don't look like mouse events;
11264 this variable holds the actual mouse event that led to the menu,
11265 so that you can determine whether the command was run by mouse or not. */);
11267 DEFVAR_LISP ("last-input-event", last_input_event
,
11268 doc
: /* Last input event. */);
11270 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11271 doc
: /* List of events to be read as the command input.
11272 These events are processed first, before actual keyboard input.
11273 Events read from this list are not normally added to `this-command-keys',
11274 as they will already have been added once as they were read for the first time.
11275 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11276 Vunread_command_events
= Qnil
;
11278 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11279 doc
: /* List of events to be processed as input by input methods.
11280 These events are processed before `unread-command-events'
11281 and actual keyboard input, but are not given to `input-method-function'. */);
11282 Vunread_post_input_method_events
= Qnil
;
11284 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11285 doc
: /* List of events to be processed as input by input methods.
11286 These events are processed after `unread-command-events', but
11287 before actual keyboard input.
11288 If there's an active input method, the events are given to
11289 `input-method-function'. */);
11290 Vunread_input_method_events
= Qnil
;
11292 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11293 doc
: /* Meta-prefix character code.
11294 Meta-foo as command input turns into this character followed by foo. */);
11295 XSETINT (meta_prefix_char
, 033);
11297 DEFVAR_KBOARD ("last-command", Vlast_command
,
11298 doc
: /* The last command executed.
11299 Normally a symbol with a function definition, but can be whatever was found
11300 in the keymap, or whatever the variable `this-command' was set to by that
11303 The value `mode-exit' is special; it means that the previous command
11304 read an event that told it to exit, and it did so and unread that event.
11305 In other words, the present command is the event that made the previous
11308 The value `kill-region' is special; it means that the previous command
11309 was a kill command.
11311 `last-command' has a separate binding for each terminal device.
11312 See Info node `(elisp)Multiple Terminals'. */);
11314 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11315 doc
: /* Same as `last-command', but never altered by Lisp code.
11316 Taken from the previous value of `real-this-command'. */);
11318 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11319 doc
: /* Last command that may be repeated.
11320 The last command executed that was not bound to an input event.
11321 This is the command `repeat' will try to repeat.
11322 Taken from a previous value of `real-this-command'. */);
11324 DEFVAR_LISP ("this-command", Vthis_command
,
11325 doc
: /* The command now being executed.
11326 The command can set this variable; whatever is put here
11327 will be in `last-command' during the following command. */);
11328 Vthis_command
= Qnil
;
11330 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11331 doc
: /* This is like `this-command', except that commands should never modify it. */);
11332 Vreal_this_command
= Qnil
;
11334 DEFVAR_LISP ("this-command-keys-shift-translated",
11335 Vthis_command_keys_shift_translated
,
11336 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11337 Shift-translation occurs when there is no binding for the key sequence
11338 as entered, but a binding was found by changing an upper-case letter
11339 to lower-case, or a shifted function key to an unshifted one. */);
11340 Vthis_command_keys_shift_translated
= Qnil
;
11342 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11343 doc
: /* The command bound to the current key sequence before remapping.
11344 It equals `this-command' if the original command was not remapped through
11345 any of the active keymaps. Otherwise, the value of `this-command' is the
11346 result of looking up the original command in the active keymaps. */);
11347 Vthis_original_command
= Qnil
;
11349 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11350 doc
: /* Number of input events between auto-saves.
11351 Zero means disable autosaving due to number of characters typed. */);
11352 auto_save_interval
= 300;
11354 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11355 doc
: /* Number of seconds idle time before auto-save.
11356 Zero or nil means disable auto-saving due to idleness.
11357 After auto-saving due to this many seconds of idle time,
11358 Emacs also does a garbage collection if that seems to be warranted. */);
11359 XSETFASTINT (Vauto_save_timeout
, 30);
11361 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11362 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11363 The value may be integer or floating point.
11364 If the value is zero, don't echo at all. */);
11365 Vecho_keystrokes
= make_number (1);
11367 DEFVAR_INT ("polling-period", polling_period
,
11368 doc
: /* Interval between polling for input during Lisp execution.
11369 The reason for polling is to make C-g work to stop a running program.
11370 Polling is needed only when using X windows and SIGIO does not work.
11371 Polling is automatically disabled in all other cases. */);
11372 polling_period
= 2;
11374 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11375 doc
: /* Maximum time between mouse clicks to make a double-click.
11376 Measured in milliseconds. The value nil means disable double-click
11377 recognition; t means double-clicks have no time limit and are detected
11378 by position only. */);
11379 Vdouble_click_time
= make_number (500);
11381 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11382 doc
: /* Maximum mouse movement between clicks to make a double-click.
11383 On window-system frames, value is the number of pixels the mouse may have
11384 moved horizontally or vertically between two clicks to make a double-click.
11385 On non window-system frames, value is interpreted in units of 1/8 characters
11388 This variable is also the threshold for motion of the mouse
11389 to count as a drag. */);
11390 double_click_fuzz
= 3;
11392 DEFVAR_INT ("num-input-keys", num_input_keys
,
11393 doc
: /* Number of complete key sequences read as input so far.
11394 This includes key sequences read from keyboard macros.
11395 The number is effectively the number of interactive command invocations. */);
11396 num_input_keys
= 0;
11398 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11399 doc
: /* Number of input events read from the keyboard so far.
11400 This does not include events generated by keyboard macros. */);
11401 num_nonmacro_input_events
= 0;
11403 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11404 doc
: /* The frame in which the most recently read event occurred.
11405 If the last event came from a keyboard macro, this is set to `macro'. */);
11406 Vlast_event_frame
= Qnil
;
11408 /* This variable is set up in sysdep.c. */
11409 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11410 doc
: /* The ERASE character as set by the user with stty. */);
11412 DEFVAR_LISP ("help-char", Vhelp_char
,
11413 doc
: /* Character to recognize as meaning Help.
11414 When it is read, do `(eval help-form)', and display result if it's a string.
11415 If the value of `help-form' is nil, this char can be read normally. */);
11416 XSETINT (Vhelp_char
, Ctl ('H'));
11418 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11419 doc
: /* List of input events to recognize as meaning Help.
11420 These work just like the value of `help-char' (see that). */);
11421 Vhelp_event_list
= Qnil
;
11423 DEFVAR_LISP ("help-form", Vhelp_form
,
11424 doc
: /* Form to execute when character `help-char' is read.
11425 If the form returns a string, that string is displayed.
11426 If `help-form' is nil, the help char is not recognized. */);
11429 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11430 doc
: /* Command to run when `help-char' character follows a prefix key.
11431 This command is used only when there is no actual binding
11432 for that character after that prefix key. */);
11433 Vprefix_help_command
= Qnil
;
11435 DEFVAR_LISP ("top-level", Vtop_level
,
11436 doc
: /* Form to evaluate when Emacs starts up.
11437 Useful to set before you dump a modified Emacs. */);
11440 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11441 doc
: /* Translate table for local keyboard input, or nil.
11442 If non-nil, the value should be a char-table. Each character read
11443 from the keyboard is looked up in this char-table. If the value found
11444 there is non-nil, then it is used instead of the actual input character.
11446 The value can also be a string or vector, but this is considered obsolete.
11447 If it is a string or vector of length N, character codes N and up are left
11448 untranslated. In a vector, an element which is nil means "no translation".
11450 This is applied to the characters supplied to input methods, not their
11451 output. See also `translation-table-for-input'.
11453 This variable has a separate binding for each terminal.
11454 See Info node `(elisp)Multiple Terminals'. */);
11456 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11457 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11458 \(Even if the operating system has support for stopping a process.\) */);
11459 cannot_suspend
= 0;
11461 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11462 doc
: /* Non-nil means prompt with menus when appropriate.
11463 This is done when reading from a keymap that has a prompt string,
11464 for elements that have prompt strings.
11465 The menu is displayed on the screen
11466 if X menus were enabled at configuration
11467 time and the previous event was a mouse click prefix key.
11468 Otherwise, menu prompting uses the echo area. */);
11469 menu_prompting
= 1;
11471 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11472 doc
: /* Character to see next line of menu prompt.
11473 Type this character while in a menu prompt to rotate around the lines of it. */);
11474 XSETINT (menu_prompt_more_char
, ' ');
11476 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11477 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11478 Emacs applies the modifiers of the character stored here to each keyboard
11479 character it reads. For example, after evaluating the expression
11480 (setq extra-keyboard-modifiers ?\\C-x)
11481 all input characters will have the control modifier applied to them.
11483 Note that the character ?\\C-@, equivalent to the integer zero, does
11484 not count as a control character; rather, it counts as a character
11485 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11486 cancels any modification. */);
11487 extra_keyboard_modifiers
= 0;
11489 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11490 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11491 The command loop sets this to nil before each command,
11492 and tests the value when the command returns.
11493 Buffer modification stores t in this variable. */);
11494 Vdeactivate_mark
= Qnil
;
11495 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11496 Fmake_variable_buffer_local (Qdeactivate_mark
);
11498 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11499 doc
: /* Normal hook run before each command is executed.
11500 If an unhandled error happens in running this hook,
11501 the function in which the error occurred is unconditionally removed, since
11502 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11503 Vpre_command_hook
= Qnil
;
11505 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11506 doc
: /* Normal hook run after each command is executed.
11507 If an unhandled error happens in running this hook,
11508 the function in which the error occurred is unconditionally removed, since
11509 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11510 Vpost_command_hook
= Qnil
;
11513 DEFVAR_LISP ("echo-area-clear-hook", ...,
11514 doc
: /* Normal hook run when clearing the echo area. */);
11516 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11517 Fset (Qecho_area_clear_hook
, Qnil
);
11519 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11520 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11521 Vlucid_menu_bar_dirty_flag
= Qnil
;
11523 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11524 doc
: /* List of menu bar items to move to the end of the menu bar.
11525 The elements of the list are event types that may have menu bar bindings. */);
11526 Vmenu_bar_final_items
= Qnil
;
11528 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11529 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11530 This is used internally by graphical displays that do not render
11531 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11532 Vtool_bar_separator_image_expression
= Qnil
;
11534 DEFVAR_KBOARD ("overriding-terminal-local-map",
11535 Voverriding_terminal_local_map
,
11536 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11537 This variable is intended to let commands such as `universal-argument'
11538 set up a different keymap for reading the next command.
11540 `overriding-terminal-local-map' has a separate binding for each
11541 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11543 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11544 doc
: /* Keymap that replaces (overrides) local keymaps.
11545 If this variable is non-nil, Emacs looks up key bindings in this
11546 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11547 buffer's local map. Hence, the only active keymaps would be
11548 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11549 order of precedence. */);
11550 Voverriding_local_map
= Qnil
;
11552 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11553 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11554 Otherwise, the menu bar continues to reflect the buffer's local map
11555 and the minor mode maps regardless of `overriding-local-map'. */);
11556 Voverriding_local_map_menu_flag
= Qnil
;
11558 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11559 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11560 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11562 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11563 doc
: /* Non-nil means generate motion events for mouse motion. */);
11565 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11566 doc
: /* Alist of system-specific X windows key symbols.
11567 Each element should have the form (N . SYMBOL) where N is the
11568 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11569 and SYMBOL is its name.
11571 `system-key-alist' has a separate binding for each terminal device.
11572 See Info node `(elisp)Multiple Terminals'. */);
11574 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11575 doc
: /* Keymap that translates key sequences to key sequences during input.
11576 This is used mainly for mapping key sequences into some preferred
11577 key events (symbols).
11579 The `read-key-sequence' function replaces any subsequence bound by
11580 `local-function-key-map' with its binding. More precisely, when the
11581 active keymaps have no binding for the current key sequence but
11582 `local-function-key-map' binds a suffix of the sequence to a vector or
11583 string, `read-key-sequence' replaces the matching suffix with its
11584 binding, and continues with the new sequence.
11586 If the binding is a function, it is called with one argument (the prompt)
11587 and its return value (a key sequence) is used.
11589 The events that come from bindings in `local-function-key-map' are not
11590 themselves looked up in `local-function-key-map'.
11592 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11593 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11594 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11595 typing `ESC O P x' would return [f1 x].
11597 `local-function-key-map' has a separate binding for each terminal
11598 device. See Info node `(elisp)Multiple Terminals'. If you need to
11599 define a binding on all terminals, change `function-key-map'
11600 instead. Initially, `local-function-key-map' is an empty keymap that
11601 has `function-key-map' as its parent on all terminal devices. */);
11603 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11604 doc
: /* Keymap that decodes input escape sequences.
11605 This is used mainly for mapping ASCII function key sequences into
11606 real Emacs function key events (symbols).
11608 The `read-key-sequence' function replaces any subsequence bound by
11609 `input-decode-map' with its binding. Contrary to `function-key-map',
11610 this map applies its rebinding regardless of the presence of an ordinary
11611 binding. So it is more like `key-translation-map' except that it applies
11612 before `function-key-map' rather than after.
11614 If the binding is a function, it is called with one argument (the prompt)
11615 and its return value (a key sequence) is used.
11617 The events that come from bindings in `input-decode-map' are not
11618 themselves looked up in `input-decode-map'. */);
11620 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11621 doc
: /* The parent keymap of all `local-function-key-map' instances.
11622 Function key definitions that apply to all terminal devices should go
11623 here. If a mapping is defined in both the current
11624 `local-function-key-map' binding and this variable, then the local
11625 definition will take precedence. */);
11626 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11628 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11629 doc
: /* Keymap of key translations that can override keymaps.
11630 This keymap works like `input-decode-map', but comes after `function-key-map'.
11631 Another difference is that it is global rather than terminal-local. */);
11632 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11634 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11635 doc
: /* List of deferred actions to be performed at a later time.
11636 The precise format isn't relevant here; we just check whether it is nil. */);
11637 Vdeferred_action_list
= Qnil
;
11639 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11640 doc
: /* Function to call to handle deferred actions, after each command.
11641 This function is called with no arguments after each command
11642 whenever `deferred-action-list' is non-nil. */);
11643 Vdeferred_action_function
= Qnil
;
11645 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11646 doc
: /* List of warnings to be displayed after this command.
11647 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11648 as per the args of `display-warning' (which see).
11649 If this variable is non-nil, `delayed-warnings-hook' will be run
11650 immediately after running `post-command-hook'. */);
11651 Vdelayed_warnings_list
= Qnil
;
11653 DEFVAR_LISP ("timer-list", Vtimer_list
,
11654 doc
: /* List of active absolute time timers in order of increasing time. */);
11655 Vtimer_list
= Qnil
;
11657 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11658 doc
: /* List of active idle-time timers in order of increasing time. */);
11659 Vtimer_idle_list
= Qnil
;
11661 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11662 doc
: /* If non-nil, the function that implements the current input method.
11663 It's called with one argument, a printing character that was just read.
11664 \(That means a character with code 040...0176.)
11665 Typically this function uses `read-event' to read additional events.
11666 When it does so, it should first bind `input-method-function' to nil
11667 so it will not be called recursively.
11669 The function should return a list of zero or more events
11670 to be used as input. If it wants to put back some events
11671 to be reconsidered, separately, by the input method,
11672 it can add them to the beginning of `unread-command-events'.
11674 The input method function can find in `input-method-previous-message'
11675 the previous echo area message.
11677 The input method function should refer to the variables
11678 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11679 for guidance on what to do. */);
11680 Vinput_method_function
= Qnil
;
11682 DEFVAR_LISP ("input-method-previous-message",
11683 Vinput_method_previous_message
,
11684 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11685 This variable exists because `read-event' clears the echo area
11686 before running the input method. It is nil if there was no message. */);
11687 Vinput_method_previous_message
= Qnil
;
11689 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11690 doc
: /* If non-nil, the function that implements the display of help.
11691 It's called with one argument, the help string to display. */);
11692 Vshow_help_function
= Qnil
;
11694 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11695 doc
: /* If non-nil, suppress point adjustment after executing a command.
11697 After a command is executed, if point is moved into a region that has
11698 special properties (e.g. composition, display), we adjust point to
11699 the boundary of the region. But, when a command sets this variable to
11700 non-nil, we suppress the point adjustment.
11702 This variable is set to nil before reading a command, and is checked
11703 just after executing the command. */);
11704 Vdisable_point_adjustment
= Qnil
;
11706 DEFVAR_LISP ("global-disable-point-adjustment",
11707 Vglobal_disable_point_adjustment
,
11708 doc
: /* If non-nil, always suppress point adjustment.
11710 The default value is nil, in which case, point adjustment are
11711 suppressed only after special commands that set
11712 `disable-point-adjustment' (which see) to non-nil. */);
11713 Vglobal_disable_point_adjustment
= Qnil
;
11715 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11716 doc
: /* How long to display an echo-area message when the minibuffer is active.
11717 If the value is not a number, such messages don't time out. */);
11718 Vminibuffer_message_timeout
= make_number (2);
11720 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11721 doc
: /* If non-nil, any keyboard input throws to this symbol.
11722 The value of that variable is passed to `quit-flag' and later causes a
11723 peculiar kind of quitting. */);
11724 Vthrow_on_input
= Qnil
;
11726 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11727 doc
: /* Function to output error messages.
11728 Called with three arguments:
11729 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11730 such as what `condition-case' would bind its variable to,
11731 - the context (a string which normally goes at the start of the message),
11732 - the Lisp function within which the error was signaled. */);
11733 Vcommand_error_function
= intern ("command-error-default-function");
11735 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11736 Venable_disabled_menus_and_buttons
,
11737 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11739 Help functions bind this to allow help on disabled menu items
11740 and tool-bar buttons. */);
11741 Venable_disabled_menus_and_buttons
= Qnil
;
11743 DEFVAR_LISP ("select-active-regions",
11744 Vselect_active_regions
,
11745 doc
: /* If non-nil, an active region automatically sets the primary selection.
11746 If the value is `only', only temporarily active regions (usually made
11747 by mouse-dragging or shift-selection) set the window selection.
11749 This takes effect only when Transient Mark mode is enabled. */);
11750 Vselect_active_regions
= Qt
;
11752 DEFVAR_LISP ("saved-region-selection",
11753 Vsaved_region_selection
,
11754 doc
: /* Contents of active region prior to buffer modification.
11755 If `select-active-regions' is non-nil, Emacs sets this to the
11756 text in the region before modifying the buffer. The next call to
11757 the function `deactivate-mark' uses this to set the window selection. */);
11758 Vsaved_region_selection
= Qnil
;
11760 DEFVAR_LISP ("selection-inhibit-update-commands",
11761 Vselection_inhibit_update_commands
,
11762 doc
: /* List of commands which should not update the selection.
11763 Normally, if `select-active-regions' is non-nil and the mark remains
11764 active after a command (i.e. the mark was not deactivated), the Emacs
11765 command loop sets the selection to the text in the region. However,
11766 if the command is in this list, the selection is not updated. */);
11767 Vselection_inhibit_update_commands
11768 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11770 DEFVAR_LISP ("debug-on-event",
11772 doc
: /* Enter debugger on this event. When Emacs
11773 receives the special event specified by this variable, it will try to
11774 break into the debugger as soon as possible instead of processing the
11775 event normally through `special-event-map'.
11777 Currently, the only supported values for this
11778 variable are `sigusr1' and `sigusr2'. */);
11779 Vdebug_on_event
= intern_c_string ("sigusr2");
11781 /* Create the initial keyboard. Qt means 'unset'. */
11782 initial_kboard
= allocate_kboard (Qt
);
11786 keys_of_keyboard (void)
11788 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11789 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11790 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11791 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11792 initial_define_key (meta_map
, 'x', "execute-extended-command");
11794 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11795 "handle-delete-frame");
11796 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11797 "ns-put-working-text");
11798 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11799 "ns-unput-working-text");
11800 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11801 current-prefix-arg, as is done in `handle-switch-frame'.
11802 But `handle-switch-frame is not run from the special-map.
11803 Commands from that map are run in a special way that automatically
11804 preserves the prefix-arg. Restoring the prefix arg here is not just
11805 redundant but harmful:
11807 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11808 - after the first prompt, the exit-minibuffer-hook is run which may
11809 iconify a frame and thus push a `iconify-frame' event.
11810 - after running exit-minibuffer-hook, current-prefix-arg is
11811 restored to the non-nil value it had before the prompt.
11812 - we enter the second prompt.
11813 current-prefix-arg is non-nil, prefix-arg is nil.
11814 - before running the first real event, we run the special iconify-frame
11815 event, but we pass the `special' arg to execute-command so
11816 current-prefix-arg and prefix-arg are left untouched.
11817 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11818 - the next key event will have a spuriously non-nil current-prefix-arg. */
11819 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11821 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11823 /* Handling it at such a low-level causes read_key_sequence to get
11824 * confused because it doesn't realize that the current_buffer was
11825 * changed by read_char.
11827 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11828 * "handle-select-window"); */
11829 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11830 "handle-save-session");
11833 /* Define a special event which is raised for dbus callback
11835 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11836 "dbus-handle-event");
11839 #ifdef USE_FILE_NOTIFY
11840 /* Define a special event which is raised for notification callback
11842 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11843 "file-notify-handle-event");
11844 #endif /* USE_FILE_NOTIFY */
11846 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11848 #if defined (WINDOWSNT)
11849 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11852 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11853 "handle-focus-in");
11854 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11855 "handle-focus-out");
11858 /* Mark the pointers in the kboard objects.
11859 Called by Fgarbage_collect. */
11861 mark_kboards (void)
11865 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11867 if (kb
->kbd_macro_buffer
)
11868 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11870 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11871 mark_object (KVAR (kb
, Vlast_command
));
11872 mark_object (KVAR (kb
, Vreal_last_command
));
11873 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11874 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11875 mark_object (KVAR (kb
, Vprefix_arg
));
11876 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11877 mark_object (KVAR (kb
, kbd_queue
));
11878 mark_object (KVAR (kb
, defining_kbd_macro
));
11879 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11880 mark_object (KVAR (kb
, Vsystem_key_alist
));
11881 mark_object (KVAR (kb
, system_key_syms
));
11882 mark_object (KVAR (kb
, Vwindow_system
));
11883 mark_object (KVAR (kb
, Vinput_decode_map
));
11884 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11885 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11886 mark_object (KVAR (kb
, echo_string
));
11889 struct input_event
*event
;
11890 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11892 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11893 event
= kbd_buffer
;
11894 /* These two special event types has no Lisp_Objects to mark. */
11895 if (event
->kind
!= SELECTION_REQUEST_EVENT
11896 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11898 mark_object (event
->x
);
11899 mark_object (event
->y
);
11900 mark_object (event
->frame_or_window
);
11901 mark_object (event
->arg
);