1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2014 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
29 #include "termhooks.h"
34 #include "character.h"
37 #include "dispextern.h"
39 #include "intervals.h"
41 #include "blockinput.h"
55 #include <sys/ioctl.h>
56 #endif /* not MSDOS */
58 #if defined USABLE_FIONREAD && defined USG5_4
59 # include <sys/filio.h>
62 #include "syssignal.h"
64 #include <sys/types.h>
68 #ifdef HAVE_WINDOW_SYSTEM
70 #endif /* HAVE_WINDOW_SYSTEM */
72 /* Variables for blockinput.h: */
74 /* Positive if interrupt input is blocked right now. */
75 volatile int interrupt_input_blocked
;
77 /* True means an input interrupt or alarm signal has arrived.
78 The QUIT macro checks this. */
79 volatile bool pending_signals
;
81 #define KBD_BUFFER_SIZE 4096
83 KBOARD
*initial_kboard
;
84 KBOARD
*current_kboard
;
85 static KBOARD
*all_kboards
;
87 /* True in the single-kboard state, false in the any-kboard state. */
88 static bool single_kboard
;
90 /* Non-nil disable property on a command means
91 do not execute it; call disabled-command-function's value instead. */
92 Lisp_Object Qdisabled
;
93 static Lisp_Object Qdisabled_command_function
;
95 #define NUM_RECENT_KEYS (300)
97 /* Index for storing next element into recent_keys. */
98 static int recent_keys_index
;
100 /* Total number of elements stored into recent_keys. */
101 static int total_keys
;
103 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
104 static Lisp_Object recent_keys
;
106 /* Vector holding the key sequence that invoked the current command.
107 It is reused for each command, and it may be longer than the current
108 sequence; this_command_key_count indicates how many elements
109 actually mean something.
110 It's easier to staticpro a single Lisp_Object than an array. */
111 Lisp_Object this_command_keys
;
112 ptrdiff_t this_command_key_count
;
114 /* True after calling Freset_this_command_lengths.
115 Usually it is false. */
116 static bool this_command_key_count_reset
;
118 /* This vector is used as a buffer to record the events that were actually read
119 by read_key_sequence. */
120 static Lisp_Object raw_keybuf
;
121 static int raw_keybuf_count
;
123 #define GROW_RAW_KEYBUF \
124 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
125 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
127 /* Number of elements of this_command_keys
128 that precede this key sequence. */
129 static ptrdiff_t this_single_command_key_start
;
131 /* Record values of this_command_key_count and echo_length ()
132 before this command was read. */
133 static ptrdiff_t before_command_key_count
;
134 static ptrdiff_t before_command_echo_length
;
136 /* For longjmp to where kbd input is being done. */
138 static sys_jmp_buf getcjmp
;
140 /* True while doing kbd input. */
141 bool waiting_for_input
;
143 /* True while displaying for echoing. Delays C-g throwing. */
147 /* Non-null means we can start echoing at the next input pause even
148 though there is something in the echo area. */
150 static struct kboard
*ok_to_echo_at_next_pause
;
152 /* The kboard last echoing, or null for none. Reset to 0 in
153 cancel_echoing. If non-null, and a current echo area message
154 exists, and echo_message_buffer is eq to the current message
155 buffer, we know that the message comes from echo_kboard. */
157 struct kboard
*echo_kboard
;
159 /* The buffer used for echoing. Set in echo_now, reset in
162 Lisp_Object echo_message_buffer
;
164 /* True means C-g should cause immediate error-signal. */
167 /* Character that causes a quit. Normally C-g.
169 If we are running on an ordinary terminal, this must be an ordinary
170 ASCII char, since we want to make it our interrupt character.
172 If we are not running on an ordinary terminal, it still needs to be
173 an ordinary ASCII char. This character needs to be recognized in
174 the input interrupt handler. At this point, the keystroke is
175 represented as a struct input_event, while the desired quit
176 character is specified as a lispy event. The mapping from struct
177 input_events to lispy events cannot run in an interrupt handler,
178 and the reverse mapping is difficult for anything but ASCII
181 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
185 /* Current depth in recursive edits. */
186 EMACS_INT command_loop_level
;
188 /* If not Qnil, this is a switch-frame event which we decided to put
189 off until the end of a key sequence. This should be read as the
190 next command input, after any unread_command_events.
192 read_key_sequence uses this to delay switch-frame events until the
193 end of the key sequence; Fread_char uses it to put off switch-frame
194 events until a non-ASCII event is acceptable as input. */
195 Lisp_Object unread_switch_frame
;
197 /* Last size recorded for a current buffer which is not a minibuffer. */
198 static ptrdiff_t last_non_minibuf_size
;
200 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
201 uintmax_t num_input_events
;
203 /* Value of num_nonmacro_input_events as of last auto save. */
205 static EMACS_INT last_auto_save
;
207 /* The value of point when the last command was started. */
208 static ptrdiff_t last_point_position
;
210 /* The frame in which the last input event occurred, or Qmacro if the
211 last event came from a macro. We use this to determine when to
212 generate switch-frame events. This may be cleared by functions
213 like Fselect_frame, to make sure that a switch-frame event is
214 generated by the next character.
216 FIXME: This is modified by a signal handler so it should be volatile.
217 It's exported to Lisp, though, so it can't simply be marked
219 Lisp_Object internal_last_event_frame
;
221 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
222 static Lisp_Object Qhandle_select_window
;
223 Lisp_Object QPRIMARY
;
225 static Lisp_Object Qself_insert_command
;
226 static Lisp_Object Qforward_char
;
227 static Lisp_Object Qbackward_char
;
228 Lisp_Object Qundefined
;
229 static Lisp_Object Qtimer_event_handler
;
231 /* `read_key_sequence' stores here the command definition of the
232 key sequence that it reads. */
233 static Lisp_Object read_key_sequence_cmd
;
234 static Lisp_Object read_key_sequence_remapped
;
236 static Lisp_Object Qinput_method_function
;
238 static Lisp_Object Qdeactivate_mark
;
240 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
242 static Lisp_Object Qecho_area_clear_hook
;
244 /* Hooks to run before and after each command. */
245 static Lisp_Object Qpre_command_hook
;
246 static Lisp_Object Qpost_command_hook
;
248 static Lisp_Object Qdeferred_action_function
;
250 static Lisp_Object Qdelayed_warnings_hook
;
252 static Lisp_Object Qinput_method_exit_on_first_char
;
253 static Lisp_Object Qinput_method_use_echo_area
;
255 static Lisp_Object Qhelp_form_show
;
257 /* File in which we write all commands we read. */
258 static FILE *dribble
;
260 /* Nonzero if input is available. */
263 /* Circular buffer for pre-read keyboard input. */
265 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
267 /* Pointer to next available character in kbd_buffer.
268 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
269 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
270 next available char is in kbd_buffer[0]. */
271 static struct input_event
*kbd_fetch_ptr
;
273 /* Pointer to next place to store character in kbd_buffer. This
274 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
275 character should go in kbd_buffer[0]. */
276 static struct input_event
* volatile kbd_store_ptr
;
278 /* The above pair of variables forms a "queue empty" flag. When we
279 enqueue a non-hook event, we increment kbd_store_ptr. When we
280 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
281 there is input available if the two pointers are not equal.
283 Why not just have a flag set and cleared by the enqueuing and
284 dequeuing functions? Such a flag could be screwed up by interrupts
285 at inopportune times. */
287 /* Symbols to head events. */
288 static Lisp_Object Qmouse_movement
;
289 static Lisp_Object Qscroll_bar_movement
;
290 Lisp_Object Qswitch_frame
;
291 static Lisp_Object Qfocus_in
, Qfocus_out
;
292 static Lisp_Object Qdelete_frame
;
293 static Lisp_Object Qiconify_frame
;
294 static Lisp_Object Qmake_frame_visible
;
295 static Lisp_Object Qselect_window
;
296 Lisp_Object Qhelp_echo
;
298 static Lisp_Object Qmouse_fixup_help_message
;
300 /* Symbols to denote kinds of events. */
301 static Lisp_Object Qfunction_key
;
302 Lisp_Object Qmouse_click
;
304 Lisp_Object Qlanguage_change
;
306 static Lisp_Object Qdrag_n_drop
;
307 static Lisp_Object Qsave_session
;
309 static Lisp_Object Qdbus_event
;
311 #ifdef USE_FILE_NOTIFY
312 static Lisp_Object Qfile_notify
;
313 #endif /* USE_FILE_NOTIFY */
314 static Lisp_Object Qconfig_changed_event
;
316 /* Lisp_Object Qmouse_movement; - also an event header */
318 /* Properties of event headers. */
319 Lisp_Object Qevent_kind
;
320 static Lisp_Object Qevent_symbol_elements
;
322 /* Menu and tool bar item parts. */
323 static Lisp_Object Qmenu_enable
;
324 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
325 Lisp_Object QCfilter
;
327 /* Non-nil disable property on a command means
328 do not execute it; call disabled-command-function's value instead. */
329 Lisp_Object QCtoggle
, QCradio
;
330 static Lisp_Object QCbutton
, QClabel
;
332 static Lisp_Object QCvert_only
;
334 /* An event header symbol HEAD may have a property named
335 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
336 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
337 mask of modifiers applied to it. If present, this is used to help
338 speed up parse_modifiers. */
339 Lisp_Object Qevent_symbol_element_mask
;
341 /* An unmodified event header BASE may have a property named
342 Qmodifier_cache, which is an alist mapping modifier masks onto
343 modified versions of BASE. If present, this helps speed up
345 static Lisp_Object Qmodifier_cache
;
347 /* Symbols to use for parts of windows. */
348 Lisp_Object Qmode_line
;
349 Lisp_Object Qvertical_line
;
350 Lisp_Object Qright_divider
, Qbottom_divider
;
351 static Lisp_Object Qvertical_scroll_bar
;
352 Lisp_Object Qmenu_bar
;
354 static Lisp_Object Qecho_keystrokes
;
356 static void recursive_edit_unwind (Lisp_Object buffer
);
357 static Lisp_Object
command_loop (void);
358 static Lisp_Object Qcommand_execute
;
359 struct timespec
timer_check (void);
361 static void echo_now (void);
362 static ptrdiff_t echo_length (void);
364 static Lisp_Object Qpolling_period
;
366 /* Incremented whenever a timer is run. */
369 /* Address (if not 0) of struct timespec to zero out if a SIGIO interrupt
371 struct timespec
*input_available_clear_time
;
373 /* True means use SIGIO interrupts; false means use CBREAK mode.
374 Default is true if INTERRUPT_INPUT is defined. */
375 bool interrupt_input
;
377 /* Nonzero while interrupts are temporarily deferred during redisplay. */
378 bool interrupts_deferred
;
380 /* If we support a window system, turn on the code to poll periodically
381 to detect C-g. It isn't actually used when doing interrupt input. */
382 #ifdef HAVE_WINDOW_SYSTEM
383 #define POLL_FOR_INPUT
386 /* The time when Emacs started being idle. */
388 static struct timespec timer_idleness_start_time
;
390 /* After Emacs stops being idle, this saves the last value
391 of timer_idleness_start_time from when it was idle. */
393 static struct timespec timer_last_idleness_start_time
;
396 /* Global variable declarations. */
398 /* Flags for readable_events. */
399 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
400 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
401 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
403 /* Function for init_keyboard to call with no args (if nonzero). */
404 static void (*keyboard_init_hook
) (void);
406 static bool get_input_pending (int);
407 static bool readable_events (int);
408 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
409 Lisp_Object
, bool *);
410 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
411 static Lisp_Object
make_lispy_event (struct input_event
*);
412 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
413 enum scroll_bar_part
,
414 Lisp_Object
, Lisp_Object
,
416 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
417 Lisp_Object
, const char *const *,
418 Lisp_Object
*, ptrdiff_t);
419 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
420 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
421 #ifdef HAVE_WINDOW_SYSTEM
422 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
423 #endif /* HAVE_WINDOW_SYSTEM */
424 static bool help_char_p (Lisp_Object
);
425 static void save_getcjmp (sys_jmp_buf
);
426 static void restore_getcjmp (sys_jmp_buf
);
427 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
428 static void clear_event (struct input_event
*);
429 static void restore_kboard_configuration (int);
431 static void deliver_input_available_signal (int signo
);
433 static void handle_interrupt (bool);
434 static _Noreturn
void quit_throw_to_read_char (bool);
435 static void process_special_events (void);
436 static void timer_start_idle (void);
437 static void timer_stop_idle (void);
438 static void timer_resume_idle (void);
439 static void deliver_user_signal (int);
440 static char *find_user_signal_name (int);
441 static void store_user_signal_events (void);
443 /* These setters are used only in this file, so they can be private. */
445 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
447 kb
->INTERNAL_FIELD (echo_string
) = val
;
450 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
452 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
455 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
457 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
460 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
462 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
465 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
467 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
470 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
472 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
475 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
477 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
480 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
482 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
485 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
487 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
491 /* Add C to the echo string, without echoing it immediately. C can be
492 a character, which is pretty-printed, or a symbol, whose name is
496 echo_add_key (Lisp_Object c
)
498 int size
= KEY_DESCRIPTION_SIZE
+ 100;
499 char *buffer
= alloca (size
);
501 Lisp_Object echo_string
;
503 echo_string
= KVAR (current_kboard
, echo_string
);
505 /* If someone has passed us a composite event, use its head symbol. */
509 ptr
= push_key_description (XINT (c
), ptr
);
510 else if (SYMBOLP (c
))
512 Lisp_Object name
= SYMBOL_NAME (c
);
513 int nbytes
= SBYTES (name
);
515 if (size
- (ptr
- buffer
) < nbytes
)
517 int offset
= ptr
- buffer
;
518 size
= max (2 * size
, size
+ nbytes
);
519 buffer
= alloca (size
);
520 ptr
= buffer
+ offset
;
523 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
524 STRING_MULTIBYTE (name
), 1);
527 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
530 const char *text
= " (Type ? for further options)";
531 int len
= strlen (text
);
533 if (size
- (ptr
- buffer
) < len
)
535 int offset
= ptr
- buffer
;
537 buffer
= alloca (size
);
538 ptr
= buffer
+ offset
;
541 memcpy (ptr
, text
, len
);
545 /* Replace a dash from echo_dash with a space, otherwise add a space
546 at the end as a separator between keys. */
547 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
549 Lisp_Object last_char
, prev_char
, idx
;
551 idx
= make_number (SCHARS (echo_string
) - 2);
552 prev_char
= Faref (echo_string
, idx
);
554 idx
= make_number (SCHARS (echo_string
) - 1);
555 last_char
= Faref (echo_string
, idx
);
557 /* We test PREV_CHAR to make sure this isn't the echoing of a
559 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
560 Faset (echo_string
, idx
, make_number (' '));
562 echo_string
= concat2 (echo_string
, build_string (" "));
564 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
565 echo_string
= concat2 (echo_string
, build_string (" "));
569 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
572 /* Add C to the echo string, if echoing is going on. C can be a
573 character or a symbol. */
576 echo_char (Lisp_Object c
)
578 if (current_kboard
->immediate_echo
)
585 /* Temporarily add a dash to the end of the echo string if it's not
586 empty, so that it serves as a mini-prompt for the very next
592 /* Do nothing if not echoing at all. */
593 if (NILP (KVAR (current_kboard
, echo_string
)))
596 if (this_command_key_count
== 0)
599 if (!current_kboard
->immediate_echo
600 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
603 /* Do nothing if we just printed a prompt. */
604 if (current_kboard
->echo_after_prompt
605 == SCHARS (KVAR (current_kboard
, echo_string
)))
608 /* Do nothing if we have already put a dash at the end. */
609 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
611 Lisp_Object last_char
, prev_char
, idx
;
613 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
614 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
616 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
617 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
619 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
623 /* Put a dash at the end of the buffer temporarily,
624 but make it go away when the next character is added. */
627 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
631 /* Display the current echo string, and begin echoing if not already
637 if (!current_kboard
->immediate_echo
)
640 current_kboard
->immediate_echo
= 1;
642 for (i
= 0; i
< this_command_key_count
; i
++)
646 /* Set before_command_echo_length to the value that would
647 have been saved before the start of this subcommand in
648 command_loop_1, if we had already been echoing then. */
649 if (i
== this_single_command_key_start
)
650 before_command_echo_length
= echo_length ();
652 c
= AREF (this_command_keys
, i
);
653 if (! (EVENT_HAS_PARAMETERS (c
)
654 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
658 /* Set before_command_echo_length to the value that would
659 have been saved before the start of this subcommand in
660 command_loop_1, if we had already been echoing then. */
661 if (this_command_key_count
== this_single_command_key_start
)
662 before_command_echo_length
= echo_length ();
664 /* Put a dash at the end to invite the user to type more. */
669 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
670 message3_nolog (KVAR (current_kboard
, echo_string
));
673 /* Record in what buffer we echoed, and from which kboard. */
674 echo_message_buffer
= echo_area_buffer
[0];
675 echo_kboard
= current_kboard
;
677 if (waiting_for_input
&& !NILP (Vquit_flag
))
678 quit_throw_to_read_char (0);
681 /* Turn off echoing, for the start of a new command. */
684 cancel_echoing (void)
686 current_kboard
->immediate_echo
= 0;
687 current_kboard
->echo_after_prompt
= -1;
688 kset_echo_string (current_kboard
, Qnil
);
689 ok_to_echo_at_next_pause
= NULL
;
691 echo_message_buffer
= Qnil
;
694 /* Return the length of the current echo string. */
699 return (STRINGP (KVAR (current_kboard
, echo_string
))
700 ? SCHARS (KVAR (current_kboard
, echo_string
))
704 /* Truncate the current echo message to its first LEN chars.
705 This and echo_char get used by read_key_sequence when the user
706 switches frames while entering a key sequence. */
709 echo_truncate (ptrdiff_t nchars
)
711 if (STRINGP (KVAR (current_kboard
, echo_string
)))
712 kset_echo_string (current_kboard
,
713 Fsubstring (KVAR (current_kboard
, echo_string
),
714 make_number (0), make_number (nchars
)));
715 truncate_echo_area (nchars
);
719 /* Functions for manipulating this_command_keys. */
721 add_command_key (Lisp_Object key
)
723 #if 0 /* Not needed after we made Freset_this_command_lengths
724 do the job immediately. */
725 /* If reset-this-command-length was called recently, obey it now.
726 See the doc string of that function for an explanation of why. */
727 if (before_command_restore_flag
)
729 this_command_key_count
= before_command_key_count_1
;
730 if (this_command_key_count
< this_single_command_key_start
)
731 this_single_command_key_start
= this_command_key_count
;
732 echo_truncate (before_command_echo_length_1
);
733 before_command_restore_flag
= 0;
737 if (this_command_key_count
>= ASIZE (this_command_keys
))
738 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
740 ASET (this_command_keys
, this_command_key_count
, key
);
741 ++this_command_key_count
;
746 recursive_edit_1 (void)
748 ptrdiff_t count
= SPECPDL_INDEX ();
751 if (command_loop_level
> 0)
753 specbind (Qstandard_output
, Qt
);
754 specbind (Qstandard_input
, Qt
);
757 #ifdef HAVE_WINDOW_SYSTEM
758 /* The command loop has started an hourglass timer, so we have to
759 cancel it here, otherwise it will fire because the recursive edit
760 can take some time. Do not check for display_hourglass_p here,
761 because it could already be nil. */
765 /* This function may have been called from a debugger called from
766 within redisplay, for instance by Edebugging a function called
767 from fontification-functions. We want to allow redisplay in
768 the debugging session.
770 The recursive edit is left with a `(throw exit ...)'. The `exit'
771 tag is not caught anywhere in redisplay, i.e. when we leave the
772 recursive edit, the original redisplay leading to the recursive
773 edit will be unwound. The outcome should therefore be safe. */
774 specbind (Qinhibit_redisplay
, Qnil
);
777 val
= command_loop ();
779 Fsignal (Qquit
, Qnil
);
780 /* Handle throw from read_minibuf when using minibuffer
781 while it's active but we're in another window. */
783 xsignal1 (Qerror
, val
);
785 return unbind_to (count
, Qnil
);
788 /* When an auto-save happens, record the "time", and don't do again soon. */
791 record_auto_save (void)
793 last_auto_save
= num_nonmacro_input_events
;
796 /* Make an auto save happen as soon as possible at command level. */
800 force_auto_save_soon (void)
802 last_auto_save
= - auto_save_interval
- 1;
804 record_asynch_buffer_change ();
808 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
809 doc
: /* Invoke the editor command loop recursively.
810 To get out of the recursive edit, a command can throw to `exit' -- for
811 instance `(throw 'exit nil)'.
812 If you throw a value other than t, `recursive-edit' returns normally
813 to the function that called it. Throwing a t value causes
814 `recursive-edit' to quit, so that control returns to the command loop
817 This function is called by the editor initialization to begin editing. */)
820 ptrdiff_t count
= SPECPDL_INDEX ();
823 /* If we enter while input is blocked, don't lock up here.
824 This may happen through the debugger during redisplay. */
825 if (input_blocked_p ())
828 if (command_loop_level
>= 0
829 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
830 buffer
= Fcurrent_buffer ();
834 /* Don't do anything interesting between the increment and the
835 record_unwind_protect! Otherwise, we could get distracted and
836 never decrement the counter again. */
837 command_loop_level
++;
838 update_mode_lines
= 17;
839 record_unwind_protect (recursive_edit_unwind
, buffer
);
841 /* If we leave recursive_edit_1 below with a `throw' for instance,
842 like it is done in the splash screen display, we have to
843 make sure that we restore single_kboard as command_loop_1
844 would have done if it were left normally. */
845 if (command_loop_level
> 0)
846 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
849 return unbind_to (count
, Qnil
);
853 recursive_edit_unwind (Lisp_Object buffer
)
855 if (BUFFERP (buffer
))
856 Fset_buffer (buffer
);
858 command_loop_level
--;
859 update_mode_lines
= 18;
863 #if 0 /* These two functions are now replaced with
864 temporarily_switch_to_single_kboard. */
868 #if 0 /* Theory: if there's anything in Vunread_command_events,
869 it will right away be read by read_key_sequence,
870 and then if we do switch KBOARDS, it will go into the side
871 queue then. So we don't need to do anything special here -- rms. */
872 if (CONSP (Vunread_command_events
))
874 current_kboard
->kbd_queue
875 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
876 current_kboard
->kbd_queue_has_data
= 1;
878 Vunread_command_events
= Qnil
;
883 /* Switch to the single-kboard state, making current_kboard
884 the only KBOARD from which further input is accepted. */
887 single_kboard_state ()
893 /* If we're in single_kboard state for kboard KBOARD,
897 not_single_kboard_state (KBOARD
*kboard
)
899 if (kboard
== current_kboard
)
903 /* Maintain a stack of kboards, so other parts of Emacs
904 can switch temporarily to the kboard of a given frame
905 and then revert to the previous status. */
910 struct kboard_stack
*next
;
913 static struct kboard_stack
*kboard_stack
;
916 push_kboard (struct kboard
*k
)
918 struct kboard_stack
*p
= xmalloc (sizeof *p
);
920 p
->next
= kboard_stack
;
921 p
->kboard
= current_kboard
;
931 struct kboard_stack
*p
= kboard_stack
;
933 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
935 if (t
->kboard
== p
->kboard
)
937 current_kboard
= p
->kboard
;
944 /* The terminal we remembered has been deleted. */
945 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
948 kboard_stack
= p
->next
;
952 /* Switch to single_kboard mode, making current_kboard the only KBOARD
953 from which further input is accepted. If F is non-nil, set its
954 KBOARD as the current keyboard.
956 This function uses record_unwind_protect_int to return to the previous
959 If Emacs is already in single_kboard mode, and F's keyboard is
960 locked, then this function will throw an error. */
963 temporarily_switch_to_single_kboard (struct frame
*f
)
965 bool was_locked
= single_kboard
;
968 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
969 /* We can not switch keyboards while in single_kboard mode.
970 In rare cases, Lisp code may call `recursive-edit' (or
971 `read-minibuffer' or `y-or-n-p') after it switched to a
972 locked frame. For example, this is likely to happen
973 when server.el connects to a new terminal while Emacs is in
974 single_kboard mode. It is best to throw an error instead
975 of presenting the user with a frozen screen. */
976 error ("Terminal %d is locked, cannot read from it",
977 FRAME_TERMINAL (f
)->id
);
979 /* This call is unnecessary, but helps
980 `restore_kboard_configuration' discover if somebody changed
981 `current_kboard' behind our back. */
982 push_kboard (current_kboard
);
985 current_kboard
= FRAME_KBOARD (f
);
987 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
990 #if 0 /* This function is not needed anymore. */
992 record_single_kboard_state ()
995 push_kboard (current_kboard
);
996 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
1001 restore_kboard_configuration (int was_locked
)
1003 single_kboard
= was_locked
;
1006 struct kboard
*prev
= current_kboard
;
1008 /* The pop should not change the kboard. */
1009 if (single_kboard
&& current_kboard
!= prev
)
1015 /* Handle errors that are not handled at inner levels
1016 by printing an error message and returning to the editor command loop. */
1019 cmd_error (Lisp_Object data
)
1021 Lisp_Object old_level
, old_length
;
1022 char macroerror
[sizeof "After..kbd macro iterations: "
1023 + INT_STRLEN_BOUND (EMACS_INT
)];
1025 #ifdef HAVE_WINDOW_SYSTEM
1026 if (display_hourglass_p
)
1027 cancel_hourglass ();
1030 if (!NILP (executing_kbd_macro
))
1032 if (executing_kbd_macro_iterations
== 1)
1033 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1035 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1036 executing_kbd_macro_iterations
);
1041 Vstandard_output
= Qt
;
1042 Vstandard_input
= Qt
;
1043 Vexecuting_kbd_macro
= Qnil
;
1044 executing_kbd_macro
= Qnil
;
1045 kset_prefix_arg (current_kboard
, Qnil
);
1046 kset_last_prefix_arg (current_kboard
, Qnil
);
1049 /* Avoid unquittable loop if data contains a circular list. */
1050 old_level
= Vprint_level
;
1051 old_length
= Vprint_length
;
1052 XSETFASTINT (Vprint_level
, 10);
1053 XSETFASTINT (Vprint_length
, 10);
1054 cmd_error_internal (data
, macroerror
);
1055 Vprint_level
= old_level
;
1056 Vprint_length
= old_length
;
1059 Vinhibit_quit
= Qnil
;
1061 return make_number (0);
1064 /* Take actions on handling an error. DATA is the data that describes
1067 CONTEXT is a C-string containing ASCII characters only which
1068 describes the context in which the error happened. If we need to
1069 generalize CONTEXT to allow multibyte characters, make it a Lisp
1073 cmd_error_internal (Lisp_Object data
, const char *context
)
1075 /* The immediate context is not interesting for Quits,
1076 since they are asynchronous. */
1077 if (EQ (XCAR (data
), Qquit
))
1078 Vsignaling_function
= Qnil
;
1083 /* Use user's specified output function if any. */
1084 if (!NILP (Vcommand_error_function
))
1085 call3 (Vcommand_error_function
, data
,
1086 context
? build_string (context
) : empty_unibyte_string
,
1087 Vsignaling_function
);
1089 Vsignaling_function
= Qnil
;
1092 DEFUN ("command-error-default-function", Fcommand_error_default_function
,
1093 Scommand_error_default_function
, 3, 3, 0,
1094 doc
: /* Produce default output for unhandled error message.
1095 Default value of `command-error-function'. */)
1096 (Lisp_Object data
, Lisp_Object context
, Lisp_Object signal
)
1098 struct frame
*sf
= SELECTED_FRAME ();
1100 CHECK_STRING (context
);
1102 /* If the window system or terminal frame hasn't been initialized
1103 yet, or we're not interactive, write the message to stderr and exit. */
1104 if (!sf
->glyphs_initialized_p
1105 /* The initial frame is a special non-displaying frame. It
1106 will be current in daemon mode when there are no frames
1107 to display, and in non-daemon mode before the real frame
1108 has finished initializing. If an error is thrown in the
1109 latter case while creating the frame, then the frame
1110 will never be displayed, so the safest thing to do is
1111 write to stderr and quit. In daemon mode, there are
1112 many other potential errors that do not prevent frames
1113 from being created, so continuing as normal is better in
1115 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1118 print_error_message (data
, Qexternal_debugging_output
,
1119 SSDATA (context
), signal
);
1120 Fterpri (Qexternal_debugging_output
);
1121 Fkill_emacs (make_number (-1));
1125 clear_message (1, 0);
1127 message_log_maybe_newline ();
1130 print_error_message (data
, Qt
, SSDATA (context
), signal
);
1135 static Lisp_Object
command_loop_2 (Lisp_Object
);
1136 static Lisp_Object
top_level_1 (Lisp_Object
);
1138 /* Entry to editor-command-loop.
1139 This level has the catches for exiting/returning to editor command loop.
1140 It returns nil to exit recursive edit, t to abort it. */
1145 if (command_loop_level
> 0 || minibuf_level
> 0)
1148 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1149 executing_kbd_macro
= Qnil
;
1155 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1156 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1157 executing_kbd_macro
= Qnil
;
1159 /* End of file in -batch run causes exit here. */
1165 /* Here we catch errors in execution of commands within the
1166 editing loop, and reenter the editing loop.
1167 When there is an error, cmd_error runs and returns a non-nil
1168 value to us. A value of nil means that command_loop_1 itself
1169 returned due to end of file (or end of kbd macro). */
1172 command_loop_2 (Lisp_Object ignore
)
1174 register Lisp_Object val
;
1177 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1178 while (!NILP (val
));
1186 return Feval (Vtop_level
, Qnil
);
1190 top_level_1 (Lisp_Object ignore
)
1192 /* On entry to the outer level, run the startup file. */
1193 if (!NILP (Vtop_level
))
1194 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1195 else if (!NILP (Vpurify_flag
))
1196 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1198 message1 ("Bare Emacs (standard Lisp code not loaded)");
1202 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1203 doc
: /* Exit all recursive editing levels.
1204 This also exits all active minibuffers. */)
1207 #ifdef HAVE_WINDOW_SYSTEM
1208 if (display_hourglass_p
)
1209 cancel_hourglass ();
1212 /* Unblock input if we enter with input blocked. This may happen if
1213 redisplay traps e.g. during tool-bar update with input blocked. */
1214 totally_unblock_input ();
1216 Fthrow (Qtop_level
, Qnil
);
1219 static _Noreturn
void
1220 user_error (const char *msg
)
1222 xsignal1 (Quser_error
, build_string (msg
));
1226 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1227 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1230 if (command_loop_level
> 0 || minibuf_level
> 0)
1231 Fthrow (Qexit
, Qnil
);
1233 user_error ("No recursive edit is in progress");
1237 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1238 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1241 if (command_loop_level
> 0 || minibuf_level
> 0)
1244 user_error ("No recursive edit is in progress");
1247 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1248 of this function. */
1251 tracking_off (Lisp_Object old_value
)
1253 do_mouse_tracking
= old_value
;
1254 if (NILP (old_value
))
1256 /* Redisplay may have been preempted because there was input
1257 available, and it assumes it will be called again after the
1258 input has been processed. If the only input available was
1259 the sort that we have just disabled, then we need to call
1261 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1263 redisplay_preserve_echo_area (6);
1264 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1269 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1270 doc
: /* Evaluate BODY with mouse movement events enabled.
1271 Within a `track-mouse' form, mouse motion generates input events that
1272 you can read with `read-event'.
1273 Normally, mouse motion is ignored.
1274 usage: (track-mouse BODY...) */)
1277 ptrdiff_t count
= SPECPDL_INDEX ();
1280 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1282 do_mouse_tracking
= Qt
;
1284 val
= Fprogn (args
);
1285 return unbind_to (count
, val
);
1288 /* If mouse has moved on some frame, return one of those frames.
1292 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1293 after resizing the tool-bar window. */
1295 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1298 bool ignore_mouse_drag_p
;
1300 static struct frame
*
1301 some_mouse_moved (void)
1303 Lisp_Object tail
, frame
;
1305 if (ignore_mouse_drag_p
)
1307 /* ignore_mouse_drag_p = 0; */
1311 FOR_EACH_FRAME (tail
, frame
)
1313 if (XFRAME (frame
)->mouse_moved
)
1314 return XFRAME (frame
);
1321 /* This is the actual command reading loop,
1322 sans error-handling encapsulation. */
1324 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1325 bool, bool, bool, bool);
1326 void safe_run_hooks (Lisp_Object
);
1327 static void adjust_point_for_property (ptrdiff_t, bool);
1329 /* The last boundary auto-added to buffer-undo-list. */
1330 Lisp_Object last_undo_boundary
;
1332 extern Lisp_Object Qregion_extract_function
;
1334 /* FIXME: This is wrong rather than test window-system, we should call
1335 a new set-selection, which will then dispatch to x-set-selection, or
1336 tty-set-selection, or w32-set-selection, ... */
1339 command_loop_1 (void)
1342 Lisp_Object keybuf
[30];
1344 EMACS_INT prev_modiff
= 0;
1345 struct buffer
*prev_buffer
= NULL
;
1346 bool already_adjusted
= 0;
1348 kset_prefix_arg (current_kboard
, Qnil
);
1349 kset_last_prefix_arg (current_kboard
, Qnil
);
1350 Vdeactivate_mark
= Qnil
;
1351 waiting_for_input
= 0;
1354 this_command_key_count
= 0;
1355 this_command_key_count_reset
= 0;
1356 this_single_command_key_start
= 0;
1358 if (NILP (Vmemory_full
))
1360 /* Make sure this hook runs after commands that get errors and
1361 throw to top level. */
1362 /* Note that the value cell will never directly contain nil
1363 if the symbol is a local variable. */
1364 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1365 safe_run_hooks (Qpost_command_hook
);
1367 /* If displaying a message, resize the echo area window to fit
1368 that message's size exactly. */
1369 if (!NILP (echo_area_buffer
[0]))
1370 resize_echo_area_exactly ();
1372 /* If there are warnings waiting, process them. */
1373 if (!NILP (Vdelayed_warnings_list
))
1374 safe_run_hooks (Qdelayed_warnings_hook
);
1376 if (!NILP (Vdeferred_action_list
))
1377 safe_run_hooks (Qdeferred_action_function
);
1380 /* Do this after running Vpost_command_hook, for consistency. */
1381 kset_last_command (current_kboard
, Vthis_command
);
1382 kset_real_last_command (current_kboard
, Vreal_this_command
);
1383 if (!CONSP (last_command_event
))
1384 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1388 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1391 /* Make sure the current window's buffer is selected. */
1392 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1394 /* Display any malloc warning that just came out. Use while because
1395 displaying one warning can cause another. */
1397 while (pending_malloc_warning
)
1398 display_malloc_warning ();
1400 Vdeactivate_mark
= Qnil
;
1402 /* Don't ignore mouse movements for more than a single command
1403 loop. (This flag is set in xdisp.c whenever the tool bar is
1404 resized, because the resize moves text up or down, and would
1405 generate false mouse drag events if we don't ignore them.) */
1406 ignore_mouse_drag_p
= 0;
1408 /* If minibuffer on and echo area in use,
1409 wait a short time and redraw minibuffer. */
1412 && !NILP (echo_area_buffer
[0])
1413 && EQ (minibuf_window
, echo_area_window
)
1414 && NUMBERP (Vminibuffer_message_timeout
))
1416 /* Bind inhibit-quit to t so that C-g gets read in
1417 rather than quitting back to the minibuffer. */
1418 ptrdiff_t count
= SPECPDL_INDEX ();
1419 specbind (Qinhibit_quit
, Qt
);
1421 sit_for (Vminibuffer_message_timeout
, 0, 2);
1423 /* Clear the echo area. */
1425 safe_run_hooks (Qecho_area_clear_hook
);
1427 unbind_to (count
, Qnil
);
1429 /* If a C-g came in before, treat it as input now. */
1430 if (!NILP (Vquit_flag
))
1433 Vunread_command_events
= list1 (make_number (quit_char
));
1437 /* If it has changed current-menubar from previous value,
1438 really recompute the menubar from the value. */
1439 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1440 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1441 call0 (Qrecompute_lucid_menubar
);
1443 before_command_key_count
= this_command_key_count
;
1444 before_command_echo_length
= echo_length ();
1446 Vthis_command
= Qnil
;
1447 Vreal_this_command
= Qnil
;
1448 Vthis_original_command
= Qnil
;
1449 Vthis_command_keys_shift_translated
= Qnil
;
1451 /* Read next key sequence; i gets its length. */
1452 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1455 /* A filter may have run while we were reading the input. */
1456 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1458 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1462 /* Now we have read a key sequence of length I,
1463 or else I is 0 and we found end of file. */
1465 if (i
== 0) /* End of file -- happens only in */
1466 return Qnil
; /* a kbd macro, at the end. */
1467 /* -1 means read_key_sequence got a menu that was rejected.
1468 Just loop around and read another command. */
1472 this_command_key_count
= 0;
1473 this_command_key_count_reset
= 0;
1474 this_single_command_key_start
= 0;
1478 last_command_event
= keybuf
[i
- 1];
1480 /* If the previous command tried to force a specific window-start,
1481 forget about that, in case this command moves point far away
1482 from that position. But also throw away beg_unchanged and
1483 end_unchanged information in that case, so that redisplay will
1484 update the whole window properly. */
1485 if (XWINDOW (selected_window
)->force_start
)
1488 XWINDOW (selected_window
)->force_start
= 0;
1489 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1490 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1493 cmd
= read_key_sequence_cmd
;
1494 if (!NILP (Vexecuting_kbd_macro
))
1496 if (!NILP (Vquit_flag
))
1498 Vexecuting_kbd_macro
= Qt
;
1499 QUIT
; /* Make some noise. */
1500 /* Will return since macro now empty. */
1504 /* Do redisplay processing after this command except in special
1505 cases identified below. */
1506 prev_buffer
= current_buffer
;
1507 prev_modiff
= MODIFF
;
1508 last_point_position
= PT
;
1510 /* By default, we adjust point to a boundary of a region that
1511 has such a property that should be treated intangible
1512 (e.g. composition, display). But, some commands will set
1513 this variable differently. */
1514 Vdisable_point_adjustment
= Qnil
;
1516 /* Process filters and timers may have messed with deactivate-mark.
1517 reset it before we execute the command. */
1518 Vdeactivate_mark
= Qnil
;
1520 /* Remap command through active keymaps. */
1521 Vthis_original_command
= cmd
;
1522 if (!NILP (read_key_sequence_remapped
))
1523 cmd
= read_key_sequence_remapped
;
1525 /* Execute the command. */
1527 Vthis_command
= cmd
;
1528 Vreal_this_command
= cmd
;
1529 safe_run_hooks (Qpre_command_hook
);
1531 already_adjusted
= 0;
1533 if (NILP (Vthis_command
))
1534 /* nil means key is undefined. */
1538 /* Here for a command that isn't executed directly. */
1540 #ifdef HAVE_WINDOW_SYSTEM
1541 ptrdiff_t scount
= SPECPDL_INDEX ();
1543 if (display_hourglass_p
1544 && NILP (Vexecuting_kbd_macro
))
1546 record_unwind_protect_void (cancel_hourglass
);
1551 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1553 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1556 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1557 ? Qnil
: BVAR (current_buffer
, undo_list
));
1559 call1 (Qcommand_execute
, Vthis_command
);
1561 #ifdef HAVE_WINDOW_SYSTEM
1562 /* Do not check display_hourglass_p here, because
1563 `command-execute' could change it, but we should cancel
1564 hourglass cursor anyway.
1565 But don't cancel the hourglass within a macro
1566 just because a command in the macro finishes. */
1567 if (NILP (Vexecuting_kbd_macro
))
1568 unbind_to (scount
, Qnil
);
1571 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1573 safe_run_hooks (Qpost_command_hook
);
1575 /* If displaying a message, resize the echo area window to fit
1576 that message's size exactly. */
1577 if (!NILP (echo_area_buffer
[0]))
1578 resize_echo_area_exactly ();
1580 /* If there are warnings waiting, process them. */
1581 if (!NILP (Vdelayed_warnings_list
))
1582 safe_run_hooks (Qdelayed_warnings_hook
);
1584 safe_run_hooks (Qdeferred_action_function
);
1586 /* If there is a prefix argument,
1587 1) We don't want Vlast_command to be ``universal-argument''
1588 (that would be dumb), so don't set Vlast_command,
1589 2) we want to leave echoing on so that the prefix will be
1590 echoed as part of this key sequence, so don't call
1592 3) we want to leave this_command_key_count non-zero, so that
1593 read_char will realize that it is re-reading a character, and
1594 not echo it a second time.
1596 If the command didn't actually create a prefix arg,
1597 but is merely a frame event that is transparent to prefix args,
1598 then the above doesn't apply. */
1599 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1600 || CONSP (last_command_event
))
1602 kset_last_command (current_kboard
, Vthis_command
);
1603 kset_real_last_command (current_kboard
, Vreal_this_command
);
1604 if (!CONSP (last_command_event
))
1605 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1607 this_command_key_count
= 0;
1608 this_command_key_count_reset
= 0;
1609 this_single_command_key_start
= 0;
1612 if (!NILP (BVAR (current_buffer
, mark_active
))
1613 && !NILP (Vrun_hooks
))
1615 /* In Emacs 22, setting transient-mark-mode to `only' was a
1616 way of turning it on for just one command. This usage is
1617 obsolete, but support it anyway. */
1618 if (EQ (Vtransient_mark_mode
, Qidentity
))
1619 Vtransient_mark_mode
= Qnil
;
1620 else if (EQ (Vtransient_mark_mode
, Qonly
))
1621 Vtransient_mark_mode
= Qidentity
;
1623 if (!NILP (Vdeactivate_mark
))
1624 /* If `select-active-regions' is non-nil, this call to
1625 `deactivate-mark' also sets the PRIMARY selection. */
1626 call0 (Qdeactivate_mark
);
1629 /* Even if not deactivating the mark, set PRIMARY if
1630 `select-active-regions' is non-nil. */
1631 if (!NILP (Fwindow_system (Qnil
))
1632 /* Even if mark_active is non-nil, the actual buffer
1633 marker may not have been set yet (Bug#7044). */
1634 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1635 && (EQ (Vselect_active_regions
, Qonly
)
1636 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1637 : (!NILP (Vselect_active_regions
)
1638 && !NILP (Vtransient_mark_mode
)))
1639 && NILP (Fmemq (Vthis_command
,
1640 Vselection_inhibit_update_commands
)))
1643 = call1 (Fsymbol_value (Qregion_extract_function
), Qnil
);
1644 if (XINT (Flength (txt
)) > 0)
1645 /* Don't set empty selections. */
1646 call2 (Qx_set_selection
, QPRIMARY
, txt
);
1649 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1651 Lisp_Object hook
= intern ("activate-mark-hook");
1652 Frun_hooks (1, &hook
);
1656 Vsaved_region_selection
= Qnil
;
1661 if (current_buffer
== prev_buffer
1662 && last_point_position
!= PT
1663 && NILP (Vdisable_point_adjustment
)
1664 && NILP (Vglobal_disable_point_adjustment
))
1666 if (last_point_position
> BEGV
1667 && last_point_position
< ZV
1668 && (composition_adjust_point (last_point_position
,
1669 last_point_position
)
1670 != last_point_position
))
1671 /* The last point was temporarily set within a grapheme
1672 cluster to prevent automatic composition. To recover
1673 the automatic composition, we must update the
1675 windows_or_buffers_changed
= 21;
1676 if (!already_adjusted
)
1677 adjust_point_for_property (last_point_position
,
1678 MODIFF
!= prev_modiff
);
1681 /* Install chars successfully executed in kbd macro. */
1683 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1684 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1685 finalize_kbd_macro_chars ();
1690 read_menu_command (void)
1692 Lisp_Object keybuf
[30];
1693 ptrdiff_t count
= SPECPDL_INDEX ();
1696 /* We don't want to echo the keystrokes while navigating the
1698 specbind (Qecho_keystrokes
, make_number (0));
1700 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
1703 unbind_to (count
, Qnil
);
1705 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1707 if (i
== 0 || i
== -1)
1710 return read_key_sequence_cmd
;
1713 /* Adjust point to a boundary of a region that has such a property
1714 that should be treated intangible. For the moment, we check
1715 `composition', `display' and `invisible' properties.
1716 LAST_PT is the last position of point. */
1719 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1722 Lisp_Object val
, overlay
, tmp
;
1723 /* When called after buffer modification, we should temporarily
1724 suppress the point adjustment for automatic composition so that a
1725 user can keep inserting another character at point or keep
1726 deleting characters around point. */
1727 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1728 ptrdiff_t orig_pt
= PT
;
1730 /* FIXME: cycling is probably not necessary because these properties
1731 can't be usefully combined anyway. */
1732 while (check_composition
|| check_display
|| check_invisible
)
1734 /* FIXME: check `intangible'. */
1735 if (check_composition
1736 && PT
> BEGV
&& PT
< ZV
1737 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1740 check_display
= check_invisible
= 1;
1742 check_composition
= 0;
1744 && PT
> BEGV
&& PT
< ZV
1745 && !NILP (val
= get_char_property_and_overlay
1746 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1747 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1748 && (!OVERLAYP (overlay
)
1749 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1750 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1751 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1752 && (beg
< PT
/* && end > PT <- It's always the case. */
1753 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1756 SET_PT (PT
< last_pt
1757 ? (STRINGP (val
) && SCHARS (val
) == 0
1758 ? max (beg
- 1, BEGV
)
1761 check_composition
= check_invisible
= 1;
1764 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1770 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1773 /* FIXME: We should stop if we find a spot between
1774 two runs of `invisible' where inserted text would
1775 be visible. This is important when we have two
1776 invisible boundaries that enclose an area: if the
1777 area is empty, we need this test in order to make
1778 it possible to place point in the middle rather
1779 than skip both boundaries. However, this code
1780 also stops anywhere in a non-sticky text-property,
1781 which breaks (e.g.) Org mode. */
1782 && (val
= Fget_pos_property (make_number (end
),
1784 TEXT_PROP_MEANS_INVISIBLE (val
))
1786 && !NILP (val
= get_char_property_and_overlay
1787 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1788 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1790 ellipsis
= ellipsis
|| inv
> 1
1791 || (OVERLAYP (overlay
)
1792 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1793 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1794 tmp
= Fnext_single_char_property_change
1795 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1796 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1800 && (val
= Fget_pos_property (make_number (beg
),
1802 TEXT_PROP_MEANS_INVISIBLE (val
))
1804 && !NILP (val
= get_char_property_and_overlay
1805 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1806 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1808 ellipsis
= ellipsis
|| inv
> 1
1809 || (OVERLAYP (overlay
)
1810 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1811 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1812 tmp
= Fprevious_single_char_property_change
1813 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1814 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1817 /* Move away from the inside area. */
1818 if (beg
< PT
&& end
> PT
)
1820 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1821 /* We haven't moved yet (so we don't need to fear
1822 infinite-looping) and we were outside the range
1823 before (so either end of the range still corresponds
1824 to a move in the right direction): pretend we moved
1825 less than we actually did, so that we still have
1826 more freedom below in choosing which end of the range
1828 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1829 /* We either have moved already or the last point
1830 was already in the range: we don't get to choose
1831 which end of the range we have to go to. */
1832 : (PT
< last_pt
? beg
: end
));
1833 check_composition
= check_display
= 1;
1835 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1836 the point to something other than its argument, due to
1837 point-motion hooks, intangibility, etc. */
1838 eassert (PT
== beg
|| PT
== end
);
1841 /* Pretend the area doesn't exist if the buffer is not
1843 if (!modified
&& !ellipsis
&& beg
< end
)
1845 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1846 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1847 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1848 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1849 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1850 /* We've already moved as far as we can. Trying to go
1851 to the other end would mean moving backwards and thus
1852 could lead to an infinite loop. */
1854 else if (val
= Fget_pos_property (make_number (PT
),
1856 TEXT_PROP_MEANS_INVISIBLE (val
)
1857 && (val
= (Fget_pos_property
1858 (make_number (PT
== beg
? end
: beg
),
1860 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1861 (check_composition
= check_display
= 1,
1862 SET_PT (PT
== beg
? end
: beg
));
1865 check_invisible
= 0;
1869 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1872 safe_run_hooks_1 (void)
1874 eassert (CONSP (Vinhibit_quit
));
1875 return call0 (XCDR (Vinhibit_quit
));
1878 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1882 safe_run_hooks_error (Lisp_Object error_data
)
1885 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1886 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1887 Lisp_Object args
[4];
1888 args
[0] = build_string ("Error in %s (%S): %S");
1891 args
[3] = error_data
;
1897 Lisp_Object newval
= Qnil
;
1898 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1899 if (EQ (fun
, XCAR (val
)))
1902 newval
= Fcons (XCAR (val
), newval
);
1904 return Fset (hook
, Fnreverse (newval
));
1905 /* Not found in the local part of the hook. Let's look at the global
1908 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1909 : Fdefault_value (hook
));
1910 CONSP (val
); val
= XCDR (val
))
1911 if (EQ (fun
, XCAR (val
)))
1914 newval
= Fcons (XCAR (val
), newval
);
1916 return Fset_default (hook
, Fnreverse (newval
));
1922 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1924 eassert (nargs
== 1);
1925 if (CONSP (Vinhibit_quit
))
1926 XSETCDR (Vinhibit_quit
, args
[0]);
1928 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1930 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1934 /* If we get an error while running the hook, cause the hook variable
1935 to be nil. Also inhibit quits, so that C-g won't cause the hook
1936 to mysteriously evaporate. */
1939 safe_run_hooks (Lisp_Object hook
)
1941 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1942 to its body or to its handlers other than via globals such as
1943 dynamically-bound variables ;-) */
1944 ptrdiff_t count
= SPECPDL_INDEX ();
1945 specbind (Qinhibit_quit
, hook
);
1947 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1949 unbind_to (count
, Qnil
);
1953 /* Nonzero means polling for input is temporarily suppressed. */
1955 int poll_suppress_count
;
1958 #ifdef POLL_FOR_INPUT
1960 /* Asynchronous timer for polling. */
1962 static struct atimer
*poll_timer
;
1964 /* Poll for input, so that we catch a C-g if it comes in. */
1966 poll_for_input_1 (void)
1968 if (! input_blocked_p ()
1969 && !waiting_for_input
)
1973 /* Timer callback function for poll_timer. TIMER is equal to
1977 poll_for_input (struct atimer
*timer
)
1979 if (poll_suppress_count
== 0)
1980 pending_signals
= 1;
1983 #endif /* POLL_FOR_INPUT */
1985 /* Begin signals to poll for input, if they are appropriate.
1986 This function is called unconditionally from various places. */
1989 start_polling (void)
1991 #ifdef POLL_FOR_INPUT
1992 /* XXX This condition was (read_socket_hook && !interrupt_input),
1993 but read_socket_hook is not global anymore. Let's pretend that
1995 if (!interrupt_input
)
1997 /* Turn alarm handling on unconditionally. It might have
1998 been turned off in process.c. */
1999 turn_on_atimers (1);
2001 /* If poll timer doesn't exist, or we need one with
2002 a different interval, start a new one. */
2003 if (poll_timer
== NULL
2004 || poll_timer
->interval
.tv_sec
!= polling_period
)
2006 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2007 struct timespec interval
= make_timespec (period
, 0);
2010 cancel_atimer (poll_timer
);
2012 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2013 poll_for_input
, NULL
);
2016 /* Let the timer's callback function poll for input
2017 if this becomes zero. */
2018 --poll_suppress_count
;
2023 /* True if we are using polling to handle input asynchronously. */
2026 input_polling_used (void)
2028 #ifdef POLL_FOR_INPUT
2029 /* XXX This condition was (read_socket_hook && !interrupt_input),
2030 but read_socket_hook is not global anymore. Let's pretend that
2032 return !interrupt_input
;
2038 /* Turn off polling. */
2043 #ifdef POLL_FOR_INPUT
2044 /* XXX This condition was (read_socket_hook && !interrupt_input),
2045 but read_socket_hook is not global anymore. Let's pretend that
2047 if (!interrupt_input
)
2048 ++poll_suppress_count
;
2052 /* Set the value of poll_suppress_count to COUNT
2053 and start or stop polling accordingly. */
2056 set_poll_suppress_count (int count
)
2058 #ifdef POLL_FOR_INPUT
2059 if (count
== 0 && poll_suppress_count
!= 0)
2061 poll_suppress_count
= 1;
2064 else if (count
!= 0 && poll_suppress_count
== 0)
2068 poll_suppress_count
= count
;
2072 /* Bind polling_period to a value at least N.
2073 But don't decrease it. */
2076 bind_polling_period (int n
)
2078 #ifdef POLL_FOR_INPUT
2079 EMACS_INT
new = polling_period
;
2084 stop_other_atimers (poll_timer
);
2086 specbind (Qpolling_period
, make_number (new));
2087 /* Start a new alarm with the new period. */
2092 /* Apply the control modifier to CHARACTER. */
2098 make_ctrl_char (int c
)
2100 /* Save the upper bits here. */
2101 int upper
= c
& ~0177;
2103 if (! ASCII_BYTE_P (c
))
2104 return c
|= ctrl_modifier
;
2108 /* Everything in the columns containing the upper-case letters
2109 denotes a control character. */
2110 if (c
>= 0100 && c
< 0140)
2114 /* Set the shift modifier for a control char
2115 made from a shifted letter. But only for letters! */
2116 if (oc
>= 'A' && oc
<= 'Z')
2117 c
|= shift_modifier
;
2120 /* The lower-case letters denote control characters too. */
2121 else if (c
>= 'a' && c
<= 'z')
2124 /* Include the bits for control and shift
2125 only if the basic ASCII code can't indicate them. */
2129 /* Replace the high bits. */
2130 c
|= (upper
& ~ctrl_modifier
);
2135 /* Display the help-echo property of the character after the mouse pointer.
2136 Either show it in the echo area, or call show-help-function to display
2137 it by other means (maybe in a tooltip).
2139 If HELP is nil, that means clear the previous help echo.
2141 If HELP is a string, display that string. If HELP is a function,
2142 call it with OBJECT and POS as arguments; the function should
2143 return a help string or nil for none. For all other types of HELP,
2144 evaluate it to obtain a string.
2146 WINDOW is the window in which the help was generated, if any.
2147 It is nil if not in a window.
2149 If OBJECT is a buffer, POS is the position in the buffer where the
2150 `help-echo' text property was found.
2152 If OBJECT is an overlay, that overlay has a `help-echo' property,
2153 and POS is the position in the overlay's buffer under the mouse.
2155 If OBJECT is a string (an overlay string or a string displayed with
2156 the `display' property). POS is the position in that string under
2159 Note: this function may only be called with HELP nil or a string
2160 from X code running asynchronously. */
2163 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2166 if (!NILP (help
) && !STRINGP (help
))
2168 if (FUNCTIONP (help
))
2169 help
= safe_call (4, help
, window
, object
, pos
);
2171 help
= safe_eval (help
);
2173 if (!STRINGP (help
))
2177 if (!noninteractive
&& STRINGP (help
))
2179 /* The mouse-fixup-help-message Lisp function can call
2180 mouse_position_hook, which resets the mouse_moved flags.
2181 This causes trouble if we are trying to read a mouse motion
2182 event (i.e., if we are inside a `track-mouse' form), so we
2183 restore the mouse_moved flag. */
2184 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2185 help
= call1 (Qmouse_fixup_help_message
, help
);
2190 if (STRINGP (help
) || NILP (help
))
2192 if (!NILP (Vshow_help_function
))
2193 call1 (Vshow_help_function
, help
);
2194 help_echo_showing_p
= STRINGP (help
);
2200 /* Input of single characters from keyboard */
2202 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2203 struct timespec
*end_time
);
2204 static void record_char (Lisp_Object c
);
2206 static Lisp_Object help_form_saved_window_configs
;
2208 read_char_help_form_unwind (void)
2210 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2211 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2212 if (!NILP (window_config
))
2213 Fset_window_configuration (window_config
);
2216 #define STOP_POLLING \
2217 do { if (! polling_stopped_here) stop_polling (); \
2218 polling_stopped_here = 1; } while (0)
2220 #define RESUME_POLLING \
2221 do { if (polling_stopped_here) start_polling (); \
2222 polling_stopped_here = 0; } while (0)
2225 read_event_from_main_queue (struct timespec
*end_time
,
2226 sys_jmp_buf local_getcjmp
,
2227 bool *used_mouse_menu
)
2229 Lisp_Object c
= Qnil
;
2230 sys_jmp_buf save_jump
;
2231 KBOARD
*kb
IF_LINT (= NULL
);
2235 /* Read from the main queue, and if that gives us something we can't use yet,
2236 we put it on the appropriate side queue and try again. */
2238 if (end_time
&& timespec_cmp (*end_time
, current_timespec ()) <= 0)
2241 /* Actually read a character, waiting if necessary. */
2242 save_getcjmp (save_jump
);
2243 restore_getcjmp (local_getcjmp
);
2245 timer_start_idle ();
2246 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2247 restore_getcjmp (save_jump
);
2249 if (! NILP (c
) && (kb
!= current_kboard
))
2251 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2254 while (CONSP (XCDR (last
)))
2256 if (!NILP (XCDR (last
)))
2260 kset_kbd_queue (kb
, list1 (c
));
2262 XSETCDR (last
, list1 (c
));
2263 kb
->kbd_queue_has_data
= 1;
2267 current_kboard
= kb
;
2268 /* This is going to exit from read_char
2269 so we had better get rid of this frame's stuff. */
2270 return make_number (-2);
2273 /* Terminate Emacs in batch mode if at eof. */
2274 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2275 Fkill_emacs (make_number (1));
2279 /* Add in any extra modifiers, where appropriate. */
2280 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2281 || ((extra_keyboard_modifiers
& 0177) < ' '
2282 && (extra_keyboard_modifiers
& 0177) != 0))
2283 XSETINT (c
, make_ctrl_char (XINT (c
)));
2285 /* Transfer any other modifier bits directly from
2286 extra_keyboard_modifiers to c. Ignore the actual character code
2287 in the low 16 bits of extra_keyboard_modifiers. */
2288 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2296 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2299 read_decoded_event_from_main_queue (struct timespec
*end_time
,
2300 sys_jmp_buf local_getcjmp
,
2301 Lisp_Object prev_event
,
2302 bool *used_mouse_menu
)
2304 #define MAX_ENCODED_BYTES 16
2306 Lisp_Object events
[MAX_ENCODED_BYTES
];
2312 = read_event_from_main_queue (end_time
, local_getcjmp
,
2315 /* w32_console already returns decoded events. It either reads
2316 Unicode characters from the Windows keyboard input, or
2317 converts characters encoded in the current codepage into
2318 Unicode. See w32inevt.c:key_event, near its end. */
2321 struct frame
*frame
= XFRAME (selected_frame
);
2322 struct terminal
*terminal
= frame
->terminal
;
2323 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2324 /* Don't apply decoding if we're just reading a raw event
2325 (e.g. reading bytes sent by the xterm to specify the position
2326 of a mouse click). */
2327 && (!EQ (prev_event
, Qt
))
2328 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2329 & CODING_REQUIRE_DECODING_MASK
)))
2330 return nextevt
; /* No decoding needed. */
2333 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2334 eassert (n
< MAX_ENCODED_BYTES
);
2335 events
[n
++] = nextevt
;
2336 if (NATNUMP (nextevt
)
2337 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2338 { /* An encoded byte sequence, let's try to decode it. */
2339 struct coding_system
*coding
2340 = TERMINAL_KEYBOARD_CODING (terminal
);
2341 unsigned char *src
= alloca (n
);
2343 for (i
= 0; i
< n
; i
++)
2344 src
[i
] = XINT (events
[i
]);
2346 for (i
= 0; i
< n
; i
++)
2348 coding
->destination
= alloca (n
* 4);
2349 coding
->dst_bytes
= n
* 4;
2350 decode_coding_c_string (coding
, src
, n
, Qnil
);
2351 eassert (coding
->produced_char
<= n
);
2352 if (coding
->produced_char
== 0)
2353 { /* The encoded sequence is incomplete. */
2354 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2355 continue; /* Read on! */
2359 const unsigned char *p
= coding
->destination
;
2360 eassert (coding
->carryover_bytes
== 0);
2362 while (n
< coding
->produced_char
)
2363 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2366 /* Now `events' should hold decoded events.
2367 Normally, n should be equal to 1, but better not rely on it.
2368 We can only return one event here, so return the first we
2369 had and keep the others (if any) for later. */
2371 Vunread_command_events
2372 = Fcons (events
[--n
], Vunread_command_events
);
2379 /* Read a character from the keyboard; call the redisplay if needed. */
2380 /* commandflag 0 means do not autosave, but do redisplay.
2381 -1 means do not redisplay, but do autosave.
2382 -2 means do neither.
2385 /* The argument MAP is a keymap for menu prompting.
2387 PREV_EVENT is the previous input event, or nil if we are reading
2388 the first event of a key sequence (or not reading a key sequence).
2389 If PREV_EVENT is t, that is a "magic" value that says
2390 not to run input methods, but in other respects to act as if
2391 not reading a key sequence.
2393 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2394 if we used a mouse menu to read the input, or false otherwise. If
2395 USED_MOUSE_MENU is null, don't dereference it.
2397 Value is -2 when we find input on another keyboard. A second call
2398 to read_char will read it.
2400 If END_TIME is non-null, it is a pointer to a struct timespec
2401 specifying the maximum time to wait until. If no input arrives by
2402 that time, stop waiting and return nil.
2404 Value is t if we showed a menu and the user rejected it. */
2407 read_char (int commandflag
, Lisp_Object map
,
2408 Lisp_Object prev_event
,
2409 bool *used_mouse_menu
, struct timespec
*end_time
)
2413 sys_jmp_buf local_getcjmp
;
2414 sys_jmp_buf save_jump
;
2415 Lisp_Object tem
, save
;
2416 volatile Lisp_Object previous_echo_area_message
;
2417 volatile Lisp_Object also_record
;
2418 volatile bool reread
;
2419 struct gcpro gcpro1
, gcpro2
;
2420 bool volatile polling_stopped_here
= 0;
2421 struct kboard
*orig_kboard
= current_kboard
;
2425 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2426 before_command_key_count
= this_command_key_count
;
2427 before_command_echo_length
= echo_length ();
2430 previous_echo_area_message
= Qnil
;
2432 GCPRO2 (c
, previous_echo_area_message
);
2437 if (CONSP (Vunread_post_input_method_events
))
2439 c
= XCAR (Vunread_post_input_method_events
);
2440 Vunread_post_input_method_events
2441 = XCDR (Vunread_post_input_method_events
);
2443 /* Undo what read_char_x_menu_prompt did when it unread
2444 additional keys returned by Fx_popup_menu. */
2446 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2454 if (CONSP (Vunread_command_events
))
2456 bool was_disabled
= 0;
2458 c
= XCAR (Vunread_command_events
);
2459 Vunread_command_events
= XCDR (Vunread_command_events
);
2463 /* Undo what sit-for did when it unread additional keys
2464 inside universal-argument. */
2467 && EQ (XCAR (c
), Qt
))
2473 /* Undo what read_char_x_menu_prompt did when it unread
2474 additional keys returned by Fx_popup_menu. */
2476 && EQ (XCDR (c
), Qdisabled
)
2477 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2483 /* If the queued event is something that used the mouse,
2484 set used_mouse_menu accordingly. */
2486 /* Also check was_disabled so last-nonmenu-event won't return
2487 a bad value when submenus are involved. (Bug#447) */
2488 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2489 *used_mouse_menu
= 1;
2491 goto reread_for_input_method
;
2494 if (CONSP (Vunread_input_method_events
))
2496 c
= XCAR (Vunread_input_method_events
);
2497 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2499 /* Undo what read_char_x_menu_prompt did when it unread
2500 additional keys returned by Fx_popup_menu. */
2502 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2506 goto reread_for_input_method
;
2509 this_command_key_count_reset
= 0;
2511 if (!NILP (Vexecuting_kbd_macro
))
2513 /* We set this to Qmacro; since that's not a frame, nobody will
2514 try to switch frames on us, and the selected window will
2517 Since this event came from a macro, it would be misleading to
2518 leave internal_last_event_frame set to wherever the last
2519 real event came from. Normally, a switch-frame event selects
2520 internal_last_event_frame after each command is read, but
2521 events read from a macro should never cause a new frame to be
2523 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2525 /* Exit the macro if we are at the end.
2526 Also, some things replace the macro with t
2527 to force an early exit. */
2528 if (EQ (Vexecuting_kbd_macro
, Qt
)
2529 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2535 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2536 if (STRINGP (Vexecuting_kbd_macro
)
2537 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2538 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2540 executing_kbd_macro_index
++;
2545 if (!NILP (unread_switch_frame
))
2547 c
= unread_switch_frame
;
2548 unread_switch_frame
= Qnil
;
2550 /* This event should make it into this_command_keys, and get echoed
2551 again, so we do not set `reread'. */
2555 /* If redisplay was requested. */
2556 if (commandflag
>= 0)
2558 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2560 /* If there is pending input, process any events which are not
2561 user-visible, such as X selection_request events. */
2563 || detect_input_pending_run_timers (0))
2564 swallow_events (0); /* May clear input_pending. */
2566 /* Redisplay if no pending input. */
2567 while (!input_pending
)
2569 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2570 redisplay_preserve_echo_area (5);
2575 /* Normal case: no input arrived during redisplay. */
2578 /* Input arrived and pre-empted redisplay.
2579 Process any events which are not user-visible. */
2581 /* If that cleared input_pending, try again to redisplay. */
2584 /* Prevent the redisplay we just did
2585 from messing up echoing of the input after the prompt. */
2586 if (commandflag
== 0 && echo_current
)
2587 echo_message_buffer
= echo_area_buffer
[0];
2591 /* Message turns off echoing unless more keystrokes turn it on again.
2593 The code in 20.x for the condition was
2595 1. echo_area_glyphs && *echo_area_glyphs
2596 2. && echo_area_glyphs != current_kboard->echobuf
2597 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2599 (1) means there's a current message displayed
2601 (2) means it's not the message from echoing from the current
2604 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2605 is set to a non-null value. This is done in read_char and it is
2606 set to echo_area_glyphs after a call to echo_char. That means
2607 ok_to_echo_at_next_pause is either null or
2608 current_kboard->echobuf with the appropriate current_kboard at
2611 So, condition (3) means in clear text ok_to_echo_at_next_pause
2612 must be either null, or the current message isn't from echoing at
2613 all, or it's from echoing from a different kboard than the
2616 if (/* There currently is something in the echo area. */
2617 !NILP (echo_area_buffer
[0])
2618 && (/* It's an echo from a different kboard. */
2619 echo_kboard
!= current_kboard
2620 /* Or we explicitly allow overwriting whatever there is. */
2621 || ok_to_echo_at_next_pause
== NULL
))
2626 /* Try reading a character via menu prompting in the minibuf.
2627 Try this before the sit-for, because the sit-for
2628 would do the wrong thing if we are supposed to do
2629 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2630 after a mouse event so don't try a minibuf menu. */
2632 if (KEYMAPP (map
) && INTERACTIVE
2633 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2634 /* Don't bring up a menu if we already have another event. */
2635 && NILP (Vunread_command_events
)
2636 && !detect_input_pending_run_timers (0))
2638 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2640 if (INTEGERP (c
) && XINT (c
) == -2)
2641 return c
; /* wrong_kboard_jmpbuf */
2647 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2648 We will do that below, temporarily for short sections of code,
2649 when appropriate. local_getcjmp must be in effect
2650 around any call to sit_for or kbd_buffer_get_event;
2651 it *must not* be in effect when we call redisplay. */
2653 jmpcount
= SPECPDL_INDEX ();
2654 if (sys_setjmp (local_getcjmp
))
2656 /* Handle quits while reading the keyboard. */
2657 /* We must have saved the outer value of getcjmp here,
2658 so restore it now. */
2659 restore_getcjmp (save_jump
);
2660 unbind_to (jmpcount
, Qnil
);
2661 XSETINT (c
, quit_char
);
2662 internal_last_event_frame
= selected_frame
;
2663 Vlast_event_frame
= internal_last_event_frame
;
2664 /* If we report the quit char as an event,
2665 don't do so more than once. */
2666 if (!NILP (Vinhibit_quit
))
2670 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2671 if (kb
!= current_kboard
)
2673 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2674 /* We shouldn't get here if we were in single-kboard mode! */
2679 while (CONSP (XCDR (last
)))
2681 if (!NILP (XCDR (last
)))
2685 kset_kbd_queue (kb
, list1 (c
));
2687 XSETCDR (last
, list1 (c
));
2688 kb
->kbd_queue_has_data
= 1;
2689 current_kboard
= kb
;
2690 /* This is going to exit from read_char
2691 so we had better get rid of this frame's stuff. */
2693 return make_number (-2); /* wrong_kboard_jmpbuf */
2699 /* Start idle timers if no time limit is supplied. We don't do it
2700 if a time limit is supplied to avoid an infinite recursion in the
2701 situation where an idle timer calls `sit-for'. */
2704 timer_start_idle ();
2706 /* If in middle of key sequence and minibuffer not active,
2707 start echoing if enough time elapses. */
2709 if (minibuf_level
== 0
2711 && !current_kboard
->immediate_echo
2712 && this_command_key_count
> 0
2714 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2715 && NILP (Fzerop (Vecho_keystrokes
))
2716 && (/* No message. */
2717 NILP (echo_area_buffer
[0])
2718 /* Or empty message. */
2719 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2720 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2721 /* Or already echoing from same kboard. */
2722 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2723 /* Or not echoing before and echoing allowed. */
2724 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2726 /* After a mouse event, start echoing right away.
2727 This is because we are probably about to display a menu,
2728 and we don't want to delay before doing so. */
2729 if (EVENT_HAS_PARAMETERS (prev_event
))
2735 save_getcjmp (save_jump
);
2736 restore_getcjmp (local_getcjmp
);
2737 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2738 restore_getcjmp (save_jump
);
2740 && ! CONSP (Vunread_command_events
))
2745 /* Maybe auto save due to number of keystrokes. */
2747 if (commandflag
!= 0 && commandflag
!= -2
2748 && auto_save_interval
> 0
2749 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2750 && !detect_input_pending_run_timers (0))
2752 Fdo_auto_save (Qnil
, Qnil
);
2753 /* Hooks can actually change some buffers in auto save. */
2757 /* Try reading using an X menu.
2758 This is never confused with reading using the minibuf
2759 because the recursive call of read_char in read_char_minibuf_menu_prompt
2760 does not pass on any keymaps. */
2762 if (KEYMAPP (map
) && INTERACTIVE
2763 && !NILP (prev_event
)
2764 && EVENT_HAS_PARAMETERS (prev_event
)
2765 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2766 && !EQ (XCAR (prev_event
), Qtool_bar
)
2767 /* Don't bring up a menu if we already have another event. */
2768 && NILP (Vunread_command_events
))
2770 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2772 /* Now that we have read an event, Emacs is not idle. */
2779 /* Maybe autosave and/or garbage collect due to idleness. */
2781 if (INTERACTIVE
&& NILP (c
))
2784 ptrdiff_t buffer_size
;
2786 /* Slow down auto saves logarithmically in size of current buffer,
2787 and garbage collect while we're at it. */
2788 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2789 last_non_minibuf_size
= Z
- BEG
;
2790 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2792 while (buffer_size
> 64)
2793 delay_level
++, buffer_size
-= buffer_size
>> 2;
2794 if (delay_level
< 4) delay_level
= 4;
2795 /* delay_level is 4 for files under around 50k, 7 at 100k,
2796 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2798 /* Auto save if enough time goes by without input. */
2799 if (commandflag
!= 0 && commandflag
!= -2
2800 && num_nonmacro_input_events
> last_auto_save
2801 && INTEGERP (Vauto_save_timeout
)
2802 && XINT (Vauto_save_timeout
) > 0)
2805 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2807 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2808 timeout
= delay_level
* timeout
/ 4;
2809 save_getcjmp (save_jump
);
2810 restore_getcjmp (local_getcjmp
);
2811 tem0
= sit_for (make_number (timeout
), 1, 1);
2812 restore_getcjmp (save_jump
);
2815 && ! CONSP (Vunread_command_events
))
2817 Fdo_auto_save (Qnil
, Qnil
);
2822 /* If there is still no input available, ask for GC. */
2823 if (!detect_input_pending_run_timers (0))
2827 /* Notify the caller if an autosave hook, or a timer, sentinel or
2828 filter in the sit_for calls above have changed the current
2829 kboard. This could happen if they use the minibuffer or start a
2830 recursive edit, like the fancy splash screen in server.el's
2831 filter. If this longjmp wasn't here, read_key_sequence would
2832 interpret the next key sequence using the wrong translation
2833 tables and function keymaps. */
2834 if (NILP (c
) && current_kboard
!= orig_kboard
)
2837 return make_number (-2); /* wrong_kboard_jmpbuf */
2840 /* If this has become non-nil here, it has been set by a timer
2841 or sentinel or filter. */
2842 if (CONSP (Vunread_command_events
))
2844 c
= XCAR (Vunread_command_events
);
2845 Vunread_command_events
= XCDR (Vunread_command_events
);
2848 /* Read something from current KBOARD's side queue, if possible. */
2852 if (current_kboard
->kbd_queue_has_data
)
2854 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2856 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2857 kset_kbd_queue (current_kboard
,
2858 XCDR (KVAR (current_kboard
, kbd_queue
)));
2859 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2860 current_kboard
->kbd_queue_has_data
= 0;
2861 input_pending
= readable_events (0);
2862 if (EVENT_HAS_PARAMETERS (c
)
2863 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2864 internal_last_event_frame
= XCAR (XCDR (c
));
2865 Vlast_event_frame
= internal_last_event_frame
;
2869 /* If current_kboard's side queue is empty check the other kboards.
2870 If one of them has data that we have not yet seen here,
2871 switch to it and process the data waiting for it.
2873 Note: if the events queued up for another kboard
2874 have already been seen here, and therefore are not a complete command,
2875 the kbd_queue_has_data field is 0, so we skip that kboard here.
2876 That's to avoid an infinite loop switching between kboards here. */
2877 if (NILP (c
) && !single_kboard
)
2880 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2881 if (kb
->kbd_queue_has_data
)
2883 current_kboard
= kb
;
2884 /* This is going to exit from read_char
2885 so we had better get rid of this frame's stuff. */
2887 return make_number (-2); /* wrong_kboard_jmpbuf */
2897 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2898 prev_event
, used_mouse_menu
);
2899 if (NILP(c
) && end_time
&&
2900 timespec_cmp (*end_time
, current_timespec ()) <= 0)
2905 if (EQ (c
, make_number (-2)))
2907 /* This is going to exit from read_char
2908 so we had better get rid of this frame's stuff. */
2922 if (commandflag
>= 0
2923 && !input_pending
&& !detect_input_pending_run_timers (0))
2929 /* Buffer switch events are only for internal wakeups
2930 so don't show them to the user.
2931 Also, don't record a key if we already did. */
2935 /* Process special events within read_char
2936 and loop around to read another event. */
2939 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2944 struct buffer
*prev_buffer
= current_buffer
;
2945 last_input_event
= c
;
2946 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2948 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2949 /* We stopped being idle for this event; undo that. This
2950 prevents automatic window selection (under
2951 mouse_autoselect_window from acting as a real input event, for
2952 example banishing the mouse under mouse-avoidance-mode. */
2953 timer_resume_idle ();
2955 if (current_buffer
!= prev_buffer
)
2957 /* The command may have changed the keymaps. Pretend there
2958 is input in another keyboard and return. This will
2959 recalculate keymaps. */
2960 c
= make_number (-2);
2967 /* Handle things that only apply to characters. */
2970 /* If kbd_buffer_get_event gave us an EOF, return that. */
2974 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2975 && UNSIGNED_CMP (XFASTINT (c
), <,
2976 SCHARS (KVAR (current_kboard
,
2977 Vkeyboard_translate_table
))))
2978 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2979 && UNSIGNED_CMP (XFASTINT (c
), <,
2980 ASIZE (KVAR (current_kboard
,
2981 Vkeyboard_translate_table
))))
2982 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2986 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2987 /* nil in keyboard-translate-table means no translation. */
2993 /* If this event is a mouse click in the menu bar,
2994 return just menu-bar for now. Modify the mouse click event
2995 so we won't do this twice, then queue it up. */
2996 if (EVENT_HAS_PARAMETERS (c
)
2998 && CONSP (EVENT_START (c
))
2999 && CONSP (XCDR (EVENT_START (c
))))
3003 posn
= POSN_POSN (EVENT_START (c
));
3004 /* Handle menu-bar events:
3005 insert the dummy prefix event `menu-bar'. */
3006 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3008 /* Change menu-bar to (menu-bar) as the event "position". */
3009 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3012 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3017 /* Store these characters into recent_keys, the dribble file if any,
3018 and the keyboard macro being defined, if any. */
3020 if (! NILP (also_record
))
3021 record_char (also_record
);
3023 /* Wipe the echo area.
3024 But first, if we are about to use an input method,
3025 save the echo area contents for it to refer to. */
3027 && ! NILP (Vinput_method_function
)
3028 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3030 previous_echo_area_message
= Fcurrent_message ();
3031 Vinput_method_previous_message
= previous_echo_area_message
;
3034 /* Now wipe the echo area, except for help events which do their
3035 own stuff with the echo area. */
3037 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3038 && !(EQ (Qswitch_frame
, XCAR (c
)))
3039 /* Don't wipe echo area for select window events: These might
3040 get delayed via `mouse-autoselect-window' (Bug#11304). */
3041 && !(EQ (Qselect_window
, XCAR (c
)))))
3043 if (!NILP (echo_area_buffer
[0]))
3045 safe_run_hooks (Qecho_area_clear_hook
);
3046 clear_message (1, 0);
3050 reread_for_input_method
:
3052 /* Pass this to the input method, if appropriate. */
3054 && ! NILP (Vinput_method_function
)
3055 /* Don't run the input method within a key sequence,
3056 after the first event of the key sequence. */
3057 && NILP (prev_event
)
3058 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3061 ptrdiff_t key_count
;
3062 bool key_count_reset
;
3063 struct gcpro gcpro1
;
3064 ptrdiff_t count
= SPECPDL_INDEX ();
3066 /* Save the echo status. */
3067 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3068 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3069 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3070 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3073 if (before_command_restore_flag
)
3075 this_command_key_count
= before_command_key_count_1
;
3076 if (this_command_key_count
< this_single_command_key_start
)
3077 this_single_command_key_start
= this_command_key_count
;
3078 echo_truncate (before_command_echo_length_1
);
3079 before_command_restore_flag
= 0;
3083 /* Save the this_command_keys status. */
3084 key_count
= this_command_key_count
;
3085 key_count_reset
= this_command_key_count_reset
;
3088 keys
= Fcopy_sequence (this_command_keys
);
3093 /* Clear out this_command_keys. */
3094 this_command_key_count
= 0;
3095 this_command_key_count_reset
= 0;
3097 /* Now wipe the echo area. */
3098 if (!NILP (echo_area_buffer
[0]))
3099 safe_run_hooks (Qecho_area_clear_hook
);
3100 clear_message (1, 0);
3103 /* If we are not reading a key sequence,
3104 never use the echo area. */
3107 specbind (Qinput_method_use_echo_area
, Qt
);
3110 /* Call the input method. */
3111 tem
= call1 (Vinput_method_function
, c
);
3113 tem
= unbind_to (count
, tem
);
3115 /* Restore the saved echoing state
3116 and this_command_keys state. */
3117 this_command_key_count
= key_count
;
3118 this_command_key_count_reset
= key_count_reset
;
3120 this_command_keys
= keys
;
3123 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3124 kset_echo_string (current_kboard
, saved_echo_string
);
3125 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3126 if (saved_immediate_echo
)
3131 /* The input method can return no events. */
3134 /* Bring back the previous message, if any. */
3135 if (! NILP (previous_echo_area_message
))
3136 message_with_string ("%s", previous_echo_area_message
, 0);
3139 /* It returned one event or more. */
3141 Vunread_post_input_method_events
3142 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3147 /* Display help if not echoing. */
3148 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3150 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3151 Lisp_Object help
, object
, position
, window
, htem
;
3153 htem
= Fcdr (XCDR (c
));
3156 window
= Fcar (htem
);
3158 object
= Fcar (htem
);
3160 position
= Fcar (htem
);
3162 show_help_echo (help
, window
, object
, position
);
3164 /* We stopped being idle for this event; undo that. */
3166 timer_resume_idle ();
3170 if ((! reread
|| this_command_key_count
== 0
3171 || this_command_key_count_reset
)
3175 /* Don't echo mouse motion events. */
3176 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3177 && NILP (Fzerop (Vecho_keystrokes
))
3178 && ! (EVENT_HAS_PARAMETERS (c
)
3179 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3182 if (! NILP (also_record
))
3183 echo_char (also_record
);
3184 /* Once we reread a character, echoing can happen
3185 the next time we pause to read a new one. */
3186 ok_to_echo_at_next_pause
= current_kboard
;
3189 /* Record this character as part of the current key. */
3190 add_command_key (c
);
3191 if (! NILP (also_record
))
3192 add_command_key (also_record
);
3195 last_input_event
= c
;
3198 /* Process the help character specially if enabled. */
3199 if (!NILP (Vhelp_form
) && help_char_p (c
))
3201 ptrdiff_t count
= SPECPDL_INDEX ();
3203 help_form_saved_window_configs
3204 = Fcons (Fcurrent_window_configuration (Qnil
),
3205 help_form_saved_window_configs
);
3206 record_unwind_protect_void (read_char_help_form_unwind
);
3207 call0 (Qhelp_form_show
);
3212 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3213 if (EVENT_HAS_PARAMETERS (c
)
3214 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3215 XSETCAR (help_form_saved_window_configs
, Qnil
);
3217 while (BUFFERP (c
));
3218 /* Remove the help from the frame. */
3219 unbind_to (count
, Qnil
);
3222 if (EQ (c
, make_number (040)))
3226 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3227 while (BUFFERP (c
));
3236 /* Record a key that came from a mouse menu.
3237 Record it for echoing, for this-command-keys, and so on. */
3240 record_menu_key (Lisp_Object c
)
3242 /* Wipe the echo area. */
3243 clear_message (1, 0);
3248 before_command_key_count
= this_command_key_count
;
3249 before_command_echo_length
= echo_length ();
3252 /* Don't echo mouse motion events. */
3253 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3254 && NILP (Fzerop (Vecho_keystrokes
)))
3258 /* Once we reread a character, echoing can happen
3259 the next time we pause to read a new one. */
3260 ok_to_echo_at_next_pause
= 0;
3263 /* Record this character as part of the current key. */
3264 add_command_key (c
);
3266 /* Re-reading in the middle of a command. */
3267 last_input_event
= c
;
3271 /* Return true if should recognize C as "the help character". */
3274 help_char_p (Lisp_Object c
)
3278 if (EQ (c
, Vhelp_char
))
3280 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3281 if (EQ (c
, XCAR (tail
)))
3286 /* Record the input event C in various ways. */
3289 record_char (Lisp_Object c
)
3293 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3295 /* To avoid filling recent_keys with help-echo and mouse-movement
3296 events, we filter out repeated help-echo events, only store the
3297 first and last in a series of mouse-movement events, and don't
3298 store repeated help-echo events which are only separated by
3299 mouse-movement events. */
3301 Lisp_Object ev1
, ev2
, ev3
;
3304 if ((ix1
= recent_keys_index
- 1) < 0)
3305 ix1
= NUM_RECENT_KEYS
- 1;
3306 ev1
= AREF (recent_keys
, ix1
);
3308 if ((ix2
= ix1
- 1) < 0)
3309 ix2
= NUM_RECENT_KEYS
- 1;
3310 ev2
= AREF (recent_keys
, ix2
);
3312 if ((ix3
= ix2
- 1) < 0)
3313 ix3
= NUM_RECENT_KEYS
- 1;
3314 ev3
= AREF (recent_keys
, ix3
);
3316 if (EQ (XCAR (c
), Qhelp_echo
))
3318 /* Don't record `help-echo' in recent_keys unless it shows some help
3319 message, and a different help than the previously recorded
3321 Lisp_Object help
, last_help
;
3323 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3324 if (!STRINGP (help
))
3326 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3327 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3329 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3330 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3331 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3333 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3334 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3335 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3336 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3339 else if (EQ (XCAR (c
), Qmouse_movement
))
3341 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3342 So additional mouse movement events replace the last element. */
3343 Lisp_Object last_window
, window
;
3345 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3346 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3347 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3348 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3349 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3351 ASET (recent_keys
, ix1
, c
);
3357 store_kbd_macro_char (c
);
3361 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3362 ASET (recent_keys
, recent_keys_index
, c
);
3363 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3364 recent_keys_index
= 0;
3366 else if (recorded
< 0)
3368 /* We need to remove one or two events from recent_keys.
3369 To do this, we simply put nil at those events and move the
3370 recent_keys_index backwards over those events. Usually,
3371 users will never see those nil events, as they will be
3372 overwritten by the command keys entered to see recent_keys
3375 while (recorded
++ < 0 && total_keys
> 0)
3377 if (total_keys
< NUM_RECENT_KEYS
)
3379 if (--recent_keys_index
< 0)
3380 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3381 ASET (recent_keys
, recent_keys_index
, Qnil
);
3385 num_nonmacro_input_events
++;
3387 /* Write c to the dribble file. If c is a lispy event, write
3388 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3389 If you, dear reader, have a better idea, you've got the source. :-) */
3395 if (XUINT (c
) < 0x100)
3396 putc (XUINT (c
), dribble
);
3398 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3402 Lisp_Object dribblee
;
3404 /* If it's a structured event, take the event header. */
3405 dribblee
= EVENT_HEAD (c
);
3407 if (SYMBOLP (dribblee
))
3409 putc ('<', dribble
);
3410 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3411 SBYTES (SYMBOL_NAME (dribblee
)),
3413 putc ('>', dribble
);
3422 /* Copy out or in the info on where C-g should throw to.
3423 This is used when running Lisp code from within get_char,
3424 in case get_char is called recursively.
3425 See read_process_output. */
3428 save_getcjmp (sys_jmp_buf temp
)
3430 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3434 restore_getcjmp (sys_jmp_buf temp
)
3436 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3439 /* Low level keyboard/mouse input.
3440 kbd_buffer_store_event places events in kbd_buffer, and
3441 kbd_buffer_get_event retrieves them. */
3443 /* Return true if there are any events in the queue that read-char
3444 would return. If this returns false, a read-char would block. */
3446 readable_events (int flags
)
3448 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3451 /* If the buffer contains only FOCUS_IN_EVENT events, and
3452 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3453 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3455 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3456 #ifdef USE_TOOLKIT_SCROLL_BARS
3457 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3461 struct input_event
*event
;
3463 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3470 #ifdef USE_TOOLKIT_SCROLL_BARS
3471 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3473 event
->kind
== FOCUS_IN_EVENT
)
3474 #ifdef USE_TOOLKIT_SCROLL_BARS
3475 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3476 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3477 && event
->part
== scroll_bar_handle
3478 && event
->modifiers
== 0)
3483 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3486 while (event
!= kbd_store_ptr
);
3492 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3493 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3497 if (current_kboard
->kbd_queue_has_data
)
3503 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3504 if (kb
->kbd_queue_has_data
)
3510 /* Set this for debugging, to have a way to get out */
3511 int stop_character EXTERNALLY_VISIBLE
;
3514 event_to_kboard (struct input_event
*event
)
3516 /* Not applicable for these special events. */
3517 if (event
->kind
== SELECTION_REQUEST_EVENT
3518 || event
->kind
== SELECTION_CLEAR_EVENT
)
3522 Lisp_Object obj
= event
->frame_or_window
;
3523 /* There are some events that set this field to nil or string. */
3525 obj
= WINDOW_FRAME (XWINDOW (obj
));
3526 /* Also ignore dead frames here. */
3527 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3528 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3533 /* Return the number of slots occupied in kbd_buffer. */
3536 kbd_buffer_nr_stored (void)
3538 return kbd_fetch_ptr
== kbd_store_ptr
3540 : (kbd_fetch_ptr
< kbd_store_ptr
3541 ? kbd_store_ptr
- kbd_fetch_ptr
3542 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3543 + (kbd_store_ptr
- kbd_buffer
)));
3545 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3548 kbd_buffer_store_event (register struct input_event
*event
)
3550 kbd_buffer_store_event_hold (event
, 0);
3553 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3555 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3556 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3557 Else, if EVENT is a quit event, store the quit event
3558 in HOLD_QUIT, and return (thus ignoring further events).
3560 This is used to postpone the processing of the quit event until all
3561 subsequent input events have been parsed (and discarded). */
3564 kbd_buffer_store_event_hold (register struct input_event
*event
,
3565 struct input_event
*hold_quit
)
3567 if (event
->kind
== NO_EVENT
)
3570 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3573 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3575 register int c
= event
->code
& 0377;
3577 if (event
->modifiers
& ctrl_modifier
)
3578 c
= make_ctrl_char (c
);
3580 c
|= (event
->modifiers
3581 & (meta_modifier
| alt_modifier
3582 | hyper_modifier
| super_modifier
));
3586 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3587 struct input_event
*sp
;
3589 if (single_kboard
&& kb
!= current_kboard
)
3592 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3594 kb
->kbd_queue_has_data
= 1;
3595 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3597 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3600 if (event_to_kboard (sp
) == kb
)
3602 sp
->kind
= NO_EVENT
;
3603 sp
->frame_or_window
= Qnil
;
3612 *hold_quit
= *event
;
3616 /* If this results in a quit_char being returned to Emacs as
3617 input, set Vlast_event_frame properly. If this doesn't
3618 get returned to Emacs as an event, the next event read
3619 will set Vlast_event_frame again, so this is safe to do. */
3623 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3625 focus
= event
->frame_or_window
;
3626 internal_last_event_frame
= focus
;
3627 Vlast_event_frame
= focus
;
3630 handle_interrupt (0);
3634 if (c
&& c
== stop_character
)
3640 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3641 Just ignore the second one. */
3642 else if (event
->kind
== BUFFER_SWITCH_EVENT
3643 && kbd_fetch_ptr
!= kbd_store_ptr
3644 && ((kbd_store_ptr
== kbd_buffer
3645 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3646 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3649 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3650 kbd_store_ptr
= kbd_buffer
;
3652 /* Don't let the very last slot in the buffer become full,
3653 since that would make the two pointers equal,
3654 and that is indistinguishable from an empty buffer.
3655 Discard the event if it would fill the last slot. */
3656 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3658 *kbd_store_ptr
= *event
;
3661 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3663 /* Don't read keyboard input until we have processed kbd_buffer.
3664 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3665 hold_keyboard_input ();
3666 if (!noninteractive
)
3670 #endif /* subprocesses */
3673 /* If we're inside while-no-input, and this event qualifies
3674 as input, set quit-flag to cause an interrupt. */
3675 if (!NILP (Vthrow_on_input
)
3676 && event
->kind
!= FOCUS_IN_EVENT
3677 && event
->kind
!= HELP_EVENT
3678 && event
->kind
!= DEICONIFY_EVENT
)
3680 Vquit_flag
= Vthrow_on_input
;
3681 /* If we're inside a function that wants immediate quits,
3683 if (immediate_quit
&& NILP (Vinhibit_quit
))
3692 /* Put an input event back in the head of the event queue. */
3695 kbd_buffer_unget_event (register struct input_event
*event
)
3697 if (kbd_fetch_ptr
== kbd_buffer
)
3698 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3700 /* Don't let the very last slot in the buffer become full, */
3701 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3704 *kbd_fetch_ptr
= *event
;
3709 /* Generate a HELP_EVENT input_event and store it in the keyboard
3712 HELP is the help form.
3714 FRAME and WINDOW are the frame and window where the help is
3715 generated. OBJECT is the Lisp object where the help was found (a
3716 buffer, a string, an overlay, or nil if neither from a string nor
3717 from a buffer). POS is the position within OBJECT where the help
3721 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3722 Lisp_Object object
, ptrdiff_t pos
)
3724 struct input_event event
;
3728 event
.kind
= HELP_EVENT
;
3729 event
.frame_or_window
= frame
;
3731 event
.x
= WINDOWP (window
) ? window
: frame
;
3734 kbd_buffer_store_event (&event
);
3738 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3741 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3743 struct input_event event
;
3745 event
.kind
= HELP_EVENT
;
3746 event
.frame_or_window
= frame
;
3751 kbd_buffer_store_event (&event
);
3755 /* Discard any mouse events in the event buffer by setting them to
3758 discard_mouse_events (void)
3760 struct input_event
*sp
;
3761 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3763 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3766 if (sp
->kind
== MOUSE_CLICK_EVENT
3767 || sp
->kind
== WHEEL_EVENT
3768 || sp
->kind
== HORIZ_WHEEL_EVENT
3770 || sp
->kind
== GPM_CLICK_EVENT
3772 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3774 sp
->kind
= NO_EVENT
;
3780 /* Return true if there are any real events waiting in the event
3781 buffer, not counting `NO_EVENT's.
3783 Discard NO_EVENT events at the front of the input queue, possibly
3784 leaving the input queue empty if there are no real input events. */
3787 kbd_buffer_events_waiting (void)
3789 struct input_event
*sp
;
3791 for (sp
= kbd_fetch_ptr
;
3792 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3795 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3800 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3804 /* Clear input event EVENT. */
3807 clear_event (struct input_event
*event
)
3809 event
->kind
= NO_EVENT
;
3813 /* Read one event from the event buffer, waiting if necessary.
3814 The value is a Lisp object representing the event.
3815 The value is nil for an event that should be ignored,
3816 or that was handled here.
3817 We always read and discard one event. */
3820 kbd_buffer_get_event (KBOARD
**kbp
,
3821 bool *used_mouse_menu
,
3822 struct timespec
*end_time
)
3827 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3829 /* Start reading input again because we have processed enough to
3830 be able to accept new events again. */
3831 unhold_keyboard_input ();
3834 #endif /* subprocesses */
3836 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3838 /* In case we are running as a daemon, only do this before
3839 detaching from the terminal. */
3840 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3844 *kbp
= current_kboard
;
3847 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3849 /* Wait until there is input available. */
3852 /* Break loop if there's an unread command event. Needed in
3853 moused window autoselection which uses a timer to insert such
3855 if (CONSP (Vunread_command_events
))
3858 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3860 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3863 /* If the quit flag is set, then read_char will return
3864 quit_char, so that counts as "available input." */
3865 if (!NILP (Vquit_flag
))
3866 quit_throw_to_read_char (0);
3868 /* One way or another, wait until input is available; then, if
3869 interrupt handlers have not read it, read it now. */
3874 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3876 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3880 struct timespec now
= current_timespec ();
3881 if (timespec_cmp (*end_time
, now
) <= 0)
3882 return Qnil
; /* Finished waiting. */
3885 struct timespec duration
= timespec_sub (*end_time
, now
);
3886 wait_reading_process_output (min (duration
.tv_sec
,
3889 -1, 1, Qnil
, NULL
, 0);
3894 bool do_display
= true;
3896 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3898 struct tty_display_info
*tty
= CURTTY ();
3900 /* When this TTY is displaying a menu, we must prevent
3901 any redisplay, because we modify the frame's glyph
3902 matrix behind the back of the display engine. */
3903 if (tty
->showing_menu
)
3907 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3910 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3914 if (CONSP (Vunread_command_events
))
3917 first
= XCAR (Vunread_command_events
);
3918 Vunread_command_events
= XCDR (Vunread_command_events
);
3919 *kbp
= current_kboard
;
3923 /* At this point, we know that there is a readable event available
3924 somewhere. If the event queue is empty, then there must be a
3925 mouse movement enabled and available. */
3926 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3928 struct input_event
*event
;
3930 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3934 *kbp
= event_to_kboard (event
);
3936 *kbp
= current_kboard
; /* Better than returning null ptr? */
3940 /* These two kinds of events get special handling
3941 and don't actually appear to the command loop.
3942 We return nil for them. */
3943 if (event
->kind
== SELECTION_REQUEST_EVENT
3944 || event
->kind
== SELECTION_CLEAR_EVENT
)
3947 struct input_event copy
;
3949 /* Remove it from the buffer before processing it,
3950 since otherwise swallow_events will see it
3951 and process it again. */
3953 kbd_fetch_ptr
= event
+ 1;
3954 input_pending
= readable_events (0);
3955 x_handle_selection_event (©
);
3957 /* We're getting selection request events, but we don't have
3963 #if defined (HAVE_NS)
3964 else if (event
->kind
== NS_TEXT_EVENT
)
3966 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3967 obj
= list1 (intern ("ns-put-working-text"));
3969 obj
= list1 (intern ("ns-unput-working-text"));
3970 kbd_fetch_ptr
= event
+ 1;
3971 if (used_mouse_menu
)
3972 *used_mouse_menu
= 1;
3976 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3977 || defined (HAVE_NS)
3978 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3980 /* Make an event (delete-frame (FRAME)). */
3981 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3982 kbd_fetch_ptr
= event
+ 1;
3985 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3986 || defined (HAVE_NS)
3987 else if (event
->kind
== ICONIFY_EVENT
)
3989 /* Make an event (iconify-frame (FRAME)). */
3990 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3991 kbd_fetch_ptr
= event
+ 1;
3993 else if (event
->kind
== DEICONIFY_EVENT
)
3995 /* Make an event (make-frame-visible (FRAME)). */
3996 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3997 kbd_fetch_ptr
= event
+ 1;
4000 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4002 /* The value doesn't matter here; only the type is tested. */
4003 XSETBUFFER (obj
, current_buffer
);
4004 kbd_fetch_ptr
= event
+ 1;
4006 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4007 || defined (HAVE_NS) || defined (USE_GTK)
4008 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4010 kbd_fetch_ptr
= event
+ 1;
4011 input_pending
= readable_events (0);
4012 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4013 x_activate_menubar (XFRAME (event
->frame_or_window
));
4017 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4019 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4020 obj
= list4 (Qlanguage_change
,
4021 event
->frame_or_window
,
4022 make_number (event
->code
),
4023 make_number (event
->modifiers
));
4024 kbd_fetch_ptr
= event
+ 1;
4027 #ifdef USE_FILE_NOTIFY
4028 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4030 #ifdef HAVE_W32NOTIFY
4031 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4032 obj
= list3 (Qfile_notify
,
4033 list3 (make_number (event
->code
),
4036 event
->frame_or_window
);
4038 obj
= make_lispy_event (event
);
4040 kbd_fetch_ptr
= event
+ 1;
4042 #endif /* USE_FILE_NOTIFY */
4043 else if (event
->kind
== SAVE_SESSION_EVENT
)
4045 obj
= list2 (Qsave_session
, event
->arg
);
4046 kbd_fetch_ptr
= event
+ 1;
4048 /* Just discard these, by returning nil.
4049 With MULTI_KBOARD, these events are used as placeholders
4050 when we need to randomly delete events from the queue.
4051 (They shouldn't otherwise be found in the buffer,
4052 but on some machines it appears they do show up
4053 even without MULTI_KBOARD.) */
4054 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4055 mouse events during a popup-menu call. */
4056 else if (event
->kind
== NO_EVENT
)
4057 kbd_fetch_ptr
= event
+ 1;
4058 else if (event
->kind
== HELP_EVENT
)
4060 Lisp_Object object
, position
, help
, frame
, window
;
4062 frame
= event
->frame_or_window
;
4063 object
= event
->arg
;
4064 position
= make_number (event
->code
);
4067 clear_event (event
);
4069 kbd_fetch_ptr
= event
+ 1;
4070 if (!WINDOWP (window
))
4072 obj
= Fcons (Qhelp_echo
,
4073 list5 (frame
, help
, window
, object
, position
));
4075 else if (event
->kind
== FOCUS_IN_EVENT
)
4077 /* Notification of a FocusIn event. The frame receiving the
4078 focus is in event->frame_or_window. Generate a
4079 switch-frame event if necessary. */
4080 Lisp_Object frame
, focus
;
4082 frame
= event
->frame_or_window
;
4083 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4092 !EQ (frame
, internal_last_event_frame
)
4093 && !EQ (frame
, selected_frame
))
4094 obj
= make_lispy_switch_frame (frame
);
4096 obj
= make_lispy_focus_in (frame
);
4098 internal_last_event_frame
= frame
;
4099 kbd_fetch_ptr
= event
+ 1;
4101 else if (event
->kind
== FOCUS_OUT_EVENT
)
4103 #ifdef HAVE_WINDOW_SYSTEM
4106 Lisp_Object frame
= event
->frame_or_window
;
4107 bool focused
= false;
4109 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4110 focused
= di
->x_highlight_frame
!= 0;
4113 obj
= make_lispy_focus_out (frame
);
4115 #endif /* HAVE_WINDOW_SYSTEM */
4117 kbd_fetch_ptr
= event
+ 1;
4120 else if (event
->kind
== DBUS_EVENT
)
4122 obj
= make_lispy_event (event
);
4123 kbd_fetch_ptr
= event
+ 1;
4126 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4128 obj
= make_lispy_event (event
);
4129 kbd_fetch_ptr
= event
+ 1;
4133 /* If this event is on a different frame, return a switch-frame this
4134 time, and leave the event in the queue for next time. */
4138 frame
= event
->frame_or_window
;
4140 frame
= XCAR (frame
);
4141 else if (WINDOWP (frame
))
4142 frame
= WINDOW_FRAME (XWINDOW (frame
));
4144 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4148 if (! EQ (frame
, internal_last_event_frame
)
4149 && !EQ (frame
, selected_frame
))
4150 obj
= make_lispy_switch_frame (frame
);
4151 internal_last_event_frame
= frame
;
4153 /* If we didn't decide to make a switch-frame event, go ahead
4154 and build a real event from the queue entry. */
4158 obj
= make_lispy_event (event
);
4160 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4161 || defined (HAVE_NS) || defined (USE_GTK)
4162 /* If this was a menu selection, then set the flag to inhibit
4163 writing to last_nonmenu_event. Don't do this if the event
4164 we're returning is (menu-bar), though; that indicates the
4165 beginning of the menu sequence, and we might as well leave
4166 that as the `event with parameters' for this selection. */
4168 && !EQ (event
->frame_or_window
, event
->arg
)
4169 && (event
->kind
== MENU_BAR_EVENT
4170 || event
->kind
== TOOL_BAR_EVENT
))
4171 *used_mouse_menu
= 1;
4174 /* Certain system events are non-key events. */
4176 && event
->kind
== NS_NONKEY_EVENT
)
4177 *used_mouse_menu
= 1;
4180 /* Wipe out this event, to catch bugs. */
4181 clear_event (event
);
4182 kbd_fetch_ptr
= event
+ 1;
4186 /* Try generating a mouse motion event. */
4187 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4189 struct frame
*f
= some_mouse_moved ();
4190 Lisp_Object bar_window
;
4191 enum scroll_bar_part part
;
4195 *kbp
= current_kboard
;
4196 /* Note that this uses F to determine which terminal to look at.
4197 If there is no valid info, it does not store anything
4198 so x remains nil. */
4201 /* XXX Can f or mouse_position_hook be NULL here? */
4202 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4203 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4208 /* Decide if we should generate a switch-frame event. Don't
4209 generate switch-frame events for motion outside of all Emacs
4215 frame
= FRAME_FOCUS_FRAME (f
);
4217 XSETFRAME (frame
, f
);
4219 if (! EQ (frame
, internal_last_event_frame
)
4220 && !EQ (frame
, selected_frame
))
4221 obj
= make_lispy_switch_frame (frame
);
4222 internal_last_event_frame
= frame
;
4225 /* If we didn't decide to make a switch-frame event, go ahead and
4226 return a mouse-motion event. */
4227 if (!NILP (x
) && NILP (obj
))
4228 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4231 /* We were promised by the above while loop that there was
4232 something for us to read! */
4235 input_pending
= readable_events (0);
4237 Vlast_event_frame
= internal_last_event_frame
;
4242 /* Process any non-user-visible events (currently X selection events),
4243 without reading any user-visible events. */
4246 process_special_events (void)
4248 struct input_event
*event
;
4250 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4252 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4255 if (event
== kbd_store_ptr
)
4259 /* If we find a stored X selection request, handle it now. */
4260 if (event
->kind
== SELECTION_REQUEST_EVENT
4261 || event
->kind
== SELECTION_CLEAR_EVENT
)
4265 /* Remove the event from the fifo buffer before processing;
4266 otherwise swallow_events called recursively could see it
4267 and process it again. To do this, we move the events
4268 between kbd_fetch_ptr and EVENT one slot to the right,
4271 struct input_event copy
= *event
;
4272 struct input_event
*beg
4273 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4274 ? kbd_buffer
: kbd_fetch_ptr
;
4277 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4278 else if (event
< beg
)
4280 if (event
> kbd_buffer
)
4281 memmove (kbd_buffer
+ 1, kbd_buffer
,
4282 (event
- kbd_buffer
) * sizeof (struct input_event
));
4283 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4284 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4285 memmove (beg
+ 1, beg
,
4286 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4287 * sizeof (struct input_event
));
4290 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4291 kbd_fetch_ptr
= kbd_buffer
+ 1;
4295 input_pending
= readable_events (0);
4296 x_handle_selection_event (©
);
4298 /* We're getting selection request events, but we don't have
4306 /* Process any events that are not user-visible, run timer events that
4307 are ripe, and return, without reading any user-visible events. */
4310 swallow_events (bool do_display
)
4312 unsigned old_timers_run
;
4314 process_special_events ();
4316 old_timers_run
= timers_run
;
4317 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4319 if (timers_run
!= old_timers_run
&& do_display
)
4320 redisplay_preserve_echo_area (7);
4323 /* Record the start of when Emacs is idle,
4324 for the sake of running idle-time timers. */
4327 timer_start_idle (void)
4329 /* If we are already in the idle state, do nothing. */
4330 if (timespec_valid_p (timer_idleness_start_time
))
4333 timer_idleness_start_time
= current_timespec ();
4334 timer_last_idleness_start_time
= timer_idleness_start_time
;
4336 /* Mark all idle-time timers as once again candidates for running. */
4337 call0 (intern ("internal-timer-start-idle"));
4340 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4343 timer_stop_idle (void)
4345 timer_idleness_start_time
= invalid_timespec ();
4348 /* Resume idle timer from last idle start time. */
4351 timer_resume_idle (void)
4353 if (timespec_valid_p (timer_idleness_start_time
))
4356 timer_idleness_start_time
= timer_last_idleness_start_time
;
4359 /* This is only for debugging. */
4360 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4362 /* List of elisp functions to call, delayed because they were generated in
4363 a context where Elisp could not be safely run (e.g. redisplay, signal,
4364 ...). Each element has the form (FUN . ARGS). */
4365 Lisp_Object pending_funcalls
;
4367 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4369 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4371 Lisp_Object
*vector
;
4373 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4375 vector
= XVECTOR (timer
)->contents
;
4376 if (! NILP (vector
[0]))
4379 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4384 /* Check whether a timer has fired. To prevent larger problems we simply
4385 disregard elements that are not proper timers. Do not make a circular
4386 timer list for the time being.
4388 Returns the time to wait until the next timer fires. If a
4389 timer is triggering now, return zero.
4390 If no timer is active, return -1.
4392 If a timer is ripe, we run it, with quitting turned off.
4393 In that case we return 0 to indicate that a new timer_check_2 call
4396 static struct timespec
4397 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4399 struct timespec nexttime
;
4400 struct timespec now
;
4401 struct timespec idleness_now
;
4402 Lisp_Object chosen_timer
;
4403 struct gcpro gcpro1
;
4405 nexttime
= invalid_timespec ();
4407 chosen_timer
= Qnil
;
4408 GCPRO1 (chosen_timer
);
4410 /* First run the code that was delayed. */
4411 while (CONSP (pending_funcalls
))
4413 Lisp_Object funcall
= XCAR (pending_funcalls
);
4414 pending_funcalls
= XCDR (pending_funcalls
);
4415 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4418 if (CONSP (timers
) || CONSP (idle_timers
))
4420 now
= current_timespec ();
4421 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4422 ? timespec_sub (now
, timer_idleness_start_time
)
4423 : make_timespec (0, 0));
4426 while (CONSP (timers
) || CONSP (idle_timers
))
4428 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4429 struct timespec timer_time
, idle_timer_time
;
4430 struct timespec difference
;
4431 struct timespec timer_difference
= invalid_timespec ();
4432 struct timespec idle_timer_difference
= invalid_timespec ();
4433 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4435 /* Set TIMER and TIMER_DIFFERENCE
4436 based on the next ordinary timer.
4437 TIMER_DIFFERENCE is the distance in time from NOW to when
4438 this timer becomes ripe (negative if it's already ripe).
4439 Skip past invalid timers and timers already handled. */
4442 timer
= XCAR (timers
);
4443 if (! decode_timer (timer
, &timer_time
))
4445 timers
= XCDR (timers
);
4449 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4450 timer_difference
= (timer_ripe
4451 ? timespec_sub (now
, timer_time
)
4452 : timespec_sub (timer_time
, now
));
4455 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4456 based on the next idle timer. */
4457 if (CONSP (idle_timers
))
4459 idle_timer
= XCAR (idle_timers
);
4460 if (! decode_timer (idle_timer
, &idle_timer_time
))
4462 idle_timers
= XCDR (idle_timers
);
4466 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4467 idle_timer_difference
4469 ? timespec_sub (idleness_now
, idle_timer_time
)
4470 : timespec_sub (idle_timer_time
, idleness_now
));
4473 /* Decide which timer is the next timer,
4474 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4475 Also step down the list where we found that timer. */
4477 if (timespec_valid_p (timer_difference
)
4478 && (! timespec_valid_p (idle_timer_difference
)
4479 || idle_timer_ripe
< timer_ripe
4480 || (idle_timer_ripe
== timer_ripe
4482 ? timespec_cmp (idle_timer_difference
,
4484 : timespec_cmp (timer_difference
,
4485 idle_timer_difference
))
4488 chosen_timer
= timer
;
4489 timers
= XCDR (timers
);
4490 difference
= timer_difference
;
4495 chosen_timer
= idle_timer
;
4496 idle_timers
= XCDR (idle_timers
);
4497 difference
= idle_timer_difference
;
4498 ripe
= idle_timer_ripe
;
4501 /* If timer is ripe, run it if it hasn't been run. */
4504 if (NILP (AREF (chosen_timer
, 0)))
4506 ptrdiff_t count
= SPECPDL_INDEX ();
4507 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4509 /* Mark the timer as triggered to prevent problems if the lisp
4510 code fails to reschedule it right. */
4511 ASET (chosen_timer
, 0, Qt
);
4513 specbind (Qinhibit_quit
, Qt
);
4515 call1 (Qtimer_event_handler
, chosen_timer
);
4516 Vdeactivate_mark
= old_deactivate_mark
;
4518 unbind_to (count
, Qnil
);
4520 /* Since we have handled the event,
4521 we don't need to tell the caller to wake up and do it. */
4522 /* But the caller must still wait for the next timer, so
4523 return 0 to indicate that. */
4526 nexttime
= make_timespec (0, 0);
4530 /* When we encounter a timer that is still waiting,
4531 return the amount of time to wait before it is ripe. */
4538 /* No timers are pending in the future. */
4539 /* Return 0 if we generated an event, and -1 if not. */
4545 /* Check whether a timer has fired. To prevent larger problems we simply
4546 disregard elements that are not proper timers. Do not make a circular
4547 timer list for the time being.
4549 Returns the time to wait until the next timer fires.
4550 If no timer is active, return an invalid value.
4552 As long as any timer is ripe, we run it. */
4557 struct timespec nexttime
;
4558 Lisp_Object timers
, idle_timers
;
4559 struct gcpro gcpro1
, gcpro2
;
4561 Lisp_Object tem
= Vinhibit_quit
;
4564 /* We use copies of the timers' lists to allow a timer to add itself
4565 again, without locking up Emacs if the newly added timer is
4566 already ripe when added. */
4568 /* Always consider the ordinary timers. */
4569 timers
= Fcopy_sequence (Vtimer_list
);
4570 /* Consider the idle timers only if Emacs is idle. */
4571 if (timespec_valid_p (timer_idleness_start_time
))
4572 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4576 Vinhibit_quit
= tem
;
4578 GCPRO2 (timers
, idle_timers
);
4582 nexttime
= timer_check_2 (timers
, idle_timers
);
4584 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4590 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4591 doc
: /* Return the current length of Emacs idleness, or nil.
4592 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4593 in the same style as (current-time).
4595 The value when Emacs is not idle is nil.
4597 PSEC is a multiple of the system clock resolution. */)
4600 if (timespec_valid_p (timer_idleness_start_time
))
4601 return make_lisp_time (timespec_sub (current_timespec (),
4602 timer_idleness_start_time
));
4607 /* Caches for modify_event_symbol. */
4608 static Lisp_Object accent_key_syms
;
4609 static Lisp_Object func_key_syms
;
4610 static Lisp_Object mouse_syms
;
4611 static Lisp_Object wheel_syms
;
4612 static Lisp_Object drag_n_drop_syms
;
4614 /* This is a list of keysym codes for special "accent" characters.
4615 It parallels lispy_accent_keys. */
4617 static const int lispy_accent_codes
[] =
4619 #ifdef XK_dead_circumflex
4624 #ifdef XK_dead_grave
4629 #ifdef XK_dead_tilde
4634 #ifdef XK_dead_diaeresis
4639 #ifdef XK_dead_macron
4644 #ifdef XK_dead_degree
4649 #ifdef XK_dead_acute
4654 #ifdef XK_dead_cedilla
4659 #ifdef XK_dead_breve
4664 #ifdef XK_dead_ogonek
4669 #ifdef XK_dead_caron
4674 #ifdef XK_dead_doubleacute
4675 XK_dead_doubleacute
,
4679 #ifdef XK_dead_abovedot
4684 #ifdef XK_dead_abovering
4694 #ifdef XK_dead_belowdot
4699 #ifdef XK_dead_voiced_sound
4700 XK_dead_voiced_sound
,
4704 #ifdef XK_dead_semivoiced_sound
4705 XK_dead_semivoiced_sound
,
4721 /* This is a list of Lisp names for special "accent" characters.
4722 It parallels lispy_accent_codes. */
4724 static const char *const lispy_accent_keys
[] =
4742 "dead-voiced-sound",
4743 "dead-semivoiced-sound",
4749 #define FUNCTION_KEY_OFFSET 0x0
4751 const char *const lispy_function_keys
[] =
4755 0, /* VK_LBUTTON 0x01 */
4756 0, /* VK_RBUTTON 0x02 */
4757 "cancel", /* VK_CANCEL 0x03 */
4758 0, /* VK_MBUTTON 0x04 */
4760 0, 0, 0, /* 0x05 .. 0x07 */
4762 "backspace", /* VK_BACK 0x08 */
4763 "tab", /* VK_TAB 0x09 */
4765 0, 0, /* 0x0A .. 0x0B */
4767 "clear", /* VK_CLEAR 0x0C */
4768 "return", /* VK_RETURN 0x0D */
4770 0, 0, /* 0x0E .. 0x0F */
4772 0, /* VK_SHIFT 0x10 */
4773 0, /* VK_CONTROL 0x11 */
4774 0, /* VK_MENU 0x12 */
4775 "pause", /* VK_PAUSE 0x13 */
4776 "capslock", /* VK_CAPITAL 0x14 */
4777 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4779 "junja", /* VK_JUNJA 0x17 */
4780 "final", /* VK_FINAL 0x18 */
4781 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4783 "escape", /* VK_ESCAPE 0x1B */
4784 "convert", /* VK_CONVERT 0x1C */
4785 "non-convert", /* VK_NONCONVERT 0x1D */
4786 "accept", /* VK_ACCEPT 0x1E */
4787 "mode-change", /* VK_MODECHANGE 0x1F */
4788 0, /* VK_SPACE 0x20 */
4789 "prior", /* VK_PRIOR 0x21 */
4790 "next", /* VK_NEXT 0x22 */
4791 "end", /* VK_END 0x23 */
4792 "home", /* VK_HOME 0x24 */
4793 "left", /* VK_LEFT 0x25 */
4794 "up", /* VK_UP 0x26 */
4795 "right", /* VK_RIGHT 0x27 */
4796 "down", /* VK_DOWN 0x28 */
4797 "select", /* VK_SELECT 0x29 */
4798 "print", /* VK_PRINT 0x2A */
4799 "execute", /* VK_EXECUTE 0x2B */
4800 "snapshot", /* VK_SNAPSHOT 0x2C */
4801 "insert", /* VK_INSERT 0x2D */
4802 "delete", /* VK_DELETE 0x2E */
4803 "help", /* VK_HELP 0x2F */
4805 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4807 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4809 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4811 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4813 0, 0, 0, 0, 0, 0, 0, 0, 0,
4814 0, 0, 0, 0, 0, 0, 0, 0, 0,
4815 0, 0, 0, 0, 0, 0, 0, 0,
4817 "lwindow", /* VK_LWIN 0x5B */
4818 "rwindow", /* VK_RWIN 0x5C */
4819 "apps", /* VK_APPS 0x5D */
4822 "kp-0", /* VK_NUMPAD0 0x60 */
4823 "kp-1", /* VK_NUMPAD1 0x61 */
4824 "kp-2", /* VK_NUMPAD2 0x62 */
4825 "kp-3", /* VK_NUMPAD3 0x63 */
4826 "kp-4", /* VK_NUMPAD4 0x64 */
4827 "kp-5", /* VK_NUMPAD5 0x65 */
4828 "kp-6", /* VK_NUMPAD6 0x66 */
4829 "kp-7", /* VK_NUMPAD7 0x67 */
4830 "kp-8", /* VK_NUMPAD8 0x68 */
4831 "kp-9", /* VK_NUMPAD9 0x69 */
4832 "kp-multiply", /* VK_MULTIPLY 0x6A */
4833 "kp-add", /* VK_ADD 0x6B */
4834 "kp-separator", /* VK_SEPARATOR 0x6C */
4835 "kp-subtract", /* VK_SUBTRACT 0x6D */
4836 "kp-decimal", /* VK_DECIMAL 0x6E */
4837 "kp-divide", /* VK_DIVIDE 0x6F */
4838 "f1", /* VK_F1 0x70 */
4839 "f2", /* VK_F2 0x71 */
4840 "f3", /* VK_F3 0x72 */
4841 "f4", /* VK_F4 0x73 */
4842 "f5", /* VK_F5 0x74 */
4843 "f6", /* VK_F6 0x75 */
4844 "f7", /* VK_F7 0x76 */
4845 "f8", /* VK_F8 0x77 */
4846 "f9", /* VK_F9 0x78 */
4847 "f10", /* VK_F10 0x79 */
4848 "f11", /* VK_F11 0x7A */
4849 "f12", /* VK_F12 0x7B */
4850 "f13", /* VK_F13 0x7C */
4851 "f14", /* VK_F14 0x7D */
4852 "f15", /* VK_F15 0x7E */
4853 "f16", /* VK_F16 0x7F */
4854 "f17", /* VK_F17 0x80 */
4855 "f18", /* VK_F18 0x81 */
4856 "f19", /* VK_F19 0x82 */
4857 "f20", /* VK_F20 0x83 */
4858 "f21", /* VK_F21 0x84 */
4859 "f22", /* VK_F22 0x85 */
4860 "f23", /* VK_F23 0x86 */
4861 "f24", /* VK_F24 0x87 */
4863 0, 0, 0, 0, /* 0x88 .. 0x8B */
4864 0, 0, 0, 0, /* 0x8C .. 0x8F */
4866 "kp-numlock", /* VK_NUMLOCK 0x90 */
4867 "scroll", /* VK_SCROLL 0x91 */
4868 /* Not sure where the following block comes from.
4869 Windows headers have NEC and Fujitsu specific keys in
4870 this block, but nothing generic. */
4871 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4872 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4873 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4874 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4875 "kp-end", /* VK_NUMPAD_END 0x96 */
4876 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4877 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4878 "kp-up", /* VK_NUMPAD_UP 0x99 */
4879 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4880 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4881 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4882 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4884 0, 0, /* 0x9E .. 0x9F */
4887 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4888 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4889 * No other API or message will distinguish left and right keys this way.
4894 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4895 to enable them selectively, and gives access to a few more functions.
4896 See lispy_multimedia_keys below. */
4897 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4898 0, 0, 0, /* 0xAD .. 0xAF Volume */
4899 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4900 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4902 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4903 0, 0, 0, 0, 0, 0, 0, 0, 0,
4905 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4906 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4907 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4910 "ax", /* VK_OEM_AX 0xE1 */
4911 0, /* VK_OEM_102 0xE2 */
4912 "ico-help", /* VK_ICO_HELP 0xE3 */
4913 "ico-00", /* VK_ICO_00 0xE4 */
4914 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4915 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4916 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4918 "reset", /* VK_OEM_RESET 0xE9 */
4919 "jump", /* VK_OEM_JUMP 0xEA */
4920 "oem-pa1", /* VK_OEM_PA1 0xEB */
4921 "oem-pa2", /* VK_OEM_PA2 0xEC */
4922 "oem-pa3", /* VK_OEM_PA3 0xED */
4923 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4924 "cusel", /* VK_OEM_CUSEL 0xEF */
4925 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4926 "finish", /* VK_OEM_FINISH 0xF1 */
4927 "copy", /* VK_OEM_COPY 0xF2 */
4928 "auto", /* VK_OEM_AUTO 0xF3 */
4929 "enlw", /* VK_OEM_ENLW 0xF4 */
4930 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4931 "attn", /* VK_ATTN 0xF6 */
4932 "crsel", /* VK_CRSEL 0xF7 */
4933 "exsel", /* VK_EXSEL 0xF8 */
4934 "ereof", /* VK_EREOF 0xF9 */
4935 "play", /* VK_PLAY 0xFA */
4936 "zoom", /* VK_ZOOM 0xFB */
4937 "noname", /* VK_NONAME 0xFC */
4938 "pa1", /* VK_PA1 0xFD */
4939 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4943 /* Some of these duplicate the "Media keys" on newer keyboards,
4944 but they are delivered to the application in a different way. */
4945 static const char *const lispy_multimedia_keys
[] =
4953 "browser-favorites",
4990 "toggle-dictate-command",
4996 "media-fast-forward",
4999 "media-channel-down"
5002 #else /* not HAVE_NTGUI */
5004 /* This should be dealt with in XTread_socket now, and that doesn't
5005 depend on the client system having the Kana syms defined. See also
5006 the XK_kana_A case below. */
5009 static const char *const lispy_kana_keys
[] =
5011 /* X Keysym value */
5012 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5013 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5014 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5015 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5016 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5017 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5018 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5019 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5020 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5021 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5022 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5023 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5024 "kana-i", "kana-u", "kana-e", "kana-o",
5025 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5026 "prolongedsound", "kana-A", "kana-I", "kana-U",
5027 "kana-E", "kana-O", "kana-KA", "kana-KI",
5028 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5029 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5030 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5031 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5032 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5033 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5034 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5035 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5036 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5037 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5038 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5039 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5041 #endif /* XK_kana_A */
5044 #define FUNCTION_KEY_OFFSET 0xff00
5046 /* You'll notice that this table is arranged to be conveniently
5047 indexed by X Windows keysym values. */
5048 static const char *const lispy_function_keys
[] =
5050 /* X Keysym value */
5052 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5053 "backspace", "tab", "linefeed", "clear",
5055 0, 0, 0, "pause", /* 0xff10...1f */
5056 0, 0, 0, 0, 0, 0, 0, "escape",
5058 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5059 "romaji", "hiragana", "katakana", "hiragana-katakana",
5060 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5061 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5062 "eisu-toggle", /* 0xff30...3f */
5063 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5064 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5066 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5067 "down", "prior", "next", "end",
5068 "begin", 0, 0, 0, 0, 0, 0, 0,
5069 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5080 "break", /* 0xff6b */
5083 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5084 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5085 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5086 0, 0, 0, 0, 0, 0, 0, 0,
5087 "kp-tab", /* 0xff89 */
5089 "kp-enter", /* 0xff8d */
5091 "kp-f1", /* 0xff91 */
5095 "kp-home", /* 0xff95 */
5100 "kp-prior", /* kp-page-up */
5101 "kp-next", /* kp-page-down */
5107 0, 0, 0, 0, 0, 0, 0, 0, 0,
5108 "kp-multiply", /* 0xffaa */
5113 "kp-divide", /* 0xffaf */
5114 "kp-0", /* 0xffb0 */
5115 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5118 "kp-equal", /* 0xffbd */
5119 "f1", /* 0xffbe */ /* IsFunctionKey */
5121 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5122 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5123 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5124 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5125 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5126 0, 0, 0, 0, 0, 0, 0, 0,
5127 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5128 0, 0, 0, 0, 0, 0, 0, "delete"
5131 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5132 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5134 static const char *const iso_lispy_function_keys
[] =
5136 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5137 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5138 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5139 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5140 "iso-lefttab", /* 0xfe20 */
5141 "iso-move-line-up", "iso-move-line-down",
5142 "iso-partial-line-up", "iso-partial-line-down",
5143 "iso-partial-space-left", "iso-partial-space-right",
5144 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5145 "iso-release-margin-left", "iso-release-margin-right",
5146 "iso-release-both-margins",
5147 "iso-fast-cursor-left", "iso-fast-cursor-right",
5148 "iso-fast-cursor-up", "iso-fast-cursor-down",
5149 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5150 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5153 #endif /* not HAVE_NTGUI */
5155 static Lisp_Object Vlispy_mouse_stem
;
5157 static const char *const lispy_wheel_names
[] =
5159 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5162 /* drag-n-drop events are generated when a set of selected files are
5163 dragged from another application and dropped onto an Emacs window. */
5164 static const char *const lispy_drag_n_drop_names
[] =
5169 /* Scroll bar parts. */
5170 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5171 Lisp_Object Qup
, Qdown
, Qbottom
;
5172 static Lisp_Object Qend_scroll
;
5174 static Lisp_Object Qratio
;
5176 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5177 static Lisp_Object
*const scroll_bar_parts
[] = {
5178 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5179 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5182 /* A vector, indexed by button number, giving the down-going location
5183 of currently depressed buttons, both scroll bar and non-scroll bar.
5185 The elements have the form
5186 (BUTTON-NUMBER MODIFIER-MASK . REST)
5187 where REST is the cdr of a position as it would be reported in the event.
5189 The make_lispy_event function stores positions here to tell the
5190 difference between click and drag events, and to store the starting
5191 location to be included in drag events. */
5193 static Lisp_Object button_down_location
;
5195 /* Information about the most recent up-going button event: Which
5196 button, what location, and what time. */
5198 static int last_mouse_button
;
5199 static int last_mouse_x
;
5200 static int last_mouse_y
;
5201 static Time button_down_time
;
5203 /* The number of clicks in this multiple-click. */
5205 static int double_click_count
;
5207 /* X and Y are frame-relative coordinates for a click or wheel event.
5208 Return a Lisp-style event list. */
5211 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5214 enum window_part part
;
5215 Lisp_Object posn
= Qnil
;
5216 Lisp_Object extra_info
= Qnil
;
5217 /* Coordinate pixel positions to return. */
5218 int xret
= 0, yret
= 0;
5219 /* The window under frame pixel coordinates (x,y) */
5220 Lisp_Object window
= f
5221 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5224 if (WINDOWP (window
))
5226 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5227 struct window
*w
= XWINDOW (window
);
5228 Lisp_Object string_info
= Qnil
;
5229 ptrdiff_t textpos
= -1;
5230 int col
= -1, row
= -1;
5231 int dx
= -1, dy
= -1;
5232 int width
= -1, height
= -1;
5233 Lisp_Object object
= Qnil
;
5235 /* Pixel coordinates relative to the window corner. */
5236 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5237 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5239 /* For text area clicks, return X, Y relative to the corner of
5240 this text area. Note that dX, dY etc are set below, by
5241 buffer_posn_from_coords. */
5242 if (part
== ON_TEXT
)
5244 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5245 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5247 /* For mode line and header line clicks, return X, Y relative to
5248 the left window edge. Use mode_line_string to look for a
5249 string on the click position. */
5250 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5255 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5256 /* Note that mode_line_string takes COL, ROW as pixels and
5257 converts them to characters. */
5260 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5261 &object
, &dx
, &dy
, &width
, &height
);
5262 if (STRINGP (string
))
5263 string_info
= Fcons (string
, make_number (charpos
));
5264 textpos
= (w
== XWINDOW (selected_window
)
5265 && current_buffer
== XBUFFER (w
->contents
))
5266 ? PT
: marker_position (w
->pointm
);
5271 /* For fringes and margins, Y is relative to the area's (and the
5272 window's) top edge, while X is meaningless. */
5273 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5278 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5281 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5282 &object
, &dx
, &dy
, &width
, &height
);
5283 if (STRINGP (string
))
5284 string_info
= Fcons (string
, make_number (charpos
));
5285 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5287 else if (part
== ON_LEFT_FRINGE
)
5289 posn
= Qleft_fringe
;
5292 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5293 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5294 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5296 else if (part
== ON_RIGHT_FRINGE
)
5298 posn
= Qright_fringe
;
5301 - window_box_width (w
, LEFT_MARGIN_AREA
)
5302 - window_box_width (w
, TEXT_AREA
)
5303 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5304 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5306 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5308 else if (part
== ON_VERTICAL_BORDER
)
5310 posn
= Qvertical_line
;
5315 /* Nothing special for part == ON_SCROLL_BAR. */
5316 else if (part
== ON_RIGHT_DIVIDER
)
5318 posn
= Qright_divider
;
5319 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5323 else if (part
== ON_BOTTOM_DIVIDER
)
5325 posn
= Qbottom_divider
;
5326 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5331 /* For clicks in the text area, fringes, or margins, call
5332 buffer_posn_from_coords to extract TEXTPOS, the buffer
5333 position nearest to the click. */
5336 Lisp_Object string2
, object2
= Qnil
;
5337 struct display_pos p
;
5339 int width2
, height2
;
5340 /* The pixel X coordinate passed to buffer_posn_from_coords
5341 is the X coordinate relative to the text area for
5342 text-area and right-margin clicks, zero otherwise. */
5344 = (part
== ON_TEXT
) ? xret
5345 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5346 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5350 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5351 &object2
, &dx2
, &dy2
,
5353 textpos
= CHARPOS (p
.pos
);
5354 if (col
< 0) col
= x2
;
5355 if (row
< 0) row
= y2
;
5356 if (dx
< 0) dx
= dx2
;
5357 if (dy
< 0) dy
= dy2
;
5358 if (width
< 0) width
= width2
;
5359 if (height
< 0) height
= height2
;
5363 posn
= make_number (textpos
);
5364 if (STRINGP (string2
))
5365 string_info
= Fcons (string2
,
5366 make_number (CHARPOS (p
.string_pos
)));
5372 #ifdef HAVE_WINDOW_SYSTEM
5373 if (IMAGEP (object
))
5375 Lisp_Object image_map
, hotspot
;
5376 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5378 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5380 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5381 posn
= XCAR (hotspot
);
5388 Fcons (make_number (dx
), make_number (dy
)),
5389 Fcons (make_number (width
), make_number (height
)));
5392 extra_info
= Fcons (string_info
,
5393 Fcons (make_number (textpos
),
5394 Fcons (Fcons (make_number (col
),
5399 XSETFRAME (window
, f
);
5403 return Fcons (window
,
5405 Fcons (Fcons (make_number (xret
),
5406 make_number (yret
)),
5407 Fcons (make_number (t
),
5411 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5412 menu bar. This really means that Emacs draws and manages the menu
5413 bar as part of its normal display, and therefore can compute its
5416 toolkit_menubar_in_use (struct frame
*f
)
5418 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5419 return !(!FRAME_WINDOW_P (f
));
5425 /* Given a struct input_event, build the lisp event which represents
5426 it. If EVENT is 0, build a mouse movement event from the mouse
5427 movement buffer, which should have a movement event in it.
5429 Note that events must be passed to this function in the order they
5430 are received; this function stores the location of button presses
5431 in order to build drag events when the button is released. */
5434 make_lispy_event (struct input_event
*event
)
5438 switch (event
->kind
)
5440 /* A simple keystroke. */
5441 case ASCII_KEYSTROKE_EVENT
:
5442 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5444 Lisp_Object lispy_c
;
5445 EMACS_INT c
= event
->code
;
5446 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5449 eassert (c
== event
->code
);
5450 /* Turn ASCII characters into control characters
5452 if (event
->modifiers
& ctrl_modifier
)
5454 c
= make_ctrl_char (c
);
5455 event
->modifiers
&= ~ctrl_modifier
;
5459 /* Add in the other modifier bits. The shift key was taken care
5460 of by the X code. */
5461 c
|= (event
->modifiers
5462 & (meta_modifier
| alt_modifier
5463 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5464 /* Distinguish Shift-SPC from SPC. */
5465 if ((event
->code
) == 040
5466 && event
->modifiers
& shift_modifier
)
5467 c
|= shift_modifier
;
5468 button_down_time
= 0;
5469 XSETFASTINT (lispy_c
, c
);
5474 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5475 except that they are non-key events (last-nonmenu-event is nil). */
5476 case NS_NONKEY_EVENT
:
5479 /* A function key. The symbol may need to have modifier prefixes
5481 case NON_ASCII_KEYSTROKE_EVENT
:
5482 button_down_time
= 0;
5484 for (i
= 0; i
< ARRAYELTS (lispy_accent_codes
); i
++)
5485 if (event
->code
== lispy_accent_codes
[i
])
5486 return modify_event_symbol (i
,
5488 Qfunction_key
, Qnil
,
5489 lispy_accent_keys
, &accent_key_syms
,
5490 ARRAYELTS (lispy_accent_keys
));
5494 if (event
->code
>= 0x400 && event
->code
< 0x500)
5495 return modify_event_symbol (event
->code
- 0x400,
5496 event
->modifiers
& ~shift_modifier
,
5497 Qfunction_key
, Qnil
,
5498 lispy_kana_keys
, &func_key_syms
,
5499 ARRAYELTS (lispy_kana_keys
));
5500 #endif /* XK_kana_A */
5503 #ifdef ISO_FUNCTION_KEY_OFFSET
5504 if (event
->code
< FUNCTION_KEY_OFFSET
5505 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5506 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5508 Qfunction_key
, Qnil
,
5509 iso_lispy_function_keys
, &func_key_syms
,
5510 ARRAYELTS (iso_lispy_function_keys
));
5513 /* Handle system-specific or unknown keysyms. */
5514 if (event
->code
& (1 << 28)
5515 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5516 || (event
->code
- FUNCTION_KEY_OFFSET
5517 >= ARRAYELTS (lispy_function_keys
))
5518 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5520 /* We need to use an alist rather than a vector as the cache
5521 since we can't make a vector long enough. */
5522 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5523 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5524 return modify_event_symbol (event
->code
,
5527 KVAR (current_kboard
, Vsystem_key_alist
),
5528 0, &KVAR (current_kboard
, system_key_syms
),
5532 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5534 Qfunction_key
, Qnil
,
5535 lispy_function_keys
, &func_key_syms
,
5536 ARRAYELTS (lispy_function_keys
));
5539 case MULTIMEDIA_KEY_EVENT
:
5540 if (event
->code
< ARRAYELTS (lispy_multimedia_keys
)
5541 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5543 return modify_event_symbol (event
->code
, event
->modifiers
,
5544 Qfunction_key
, Qnil
,
5545 lispy_multimedia_keys
, &func_key_syms
,
5546 ARRAYELTS (lispy_multimedia_keys
));
5551 /* A mouse click. Figure out where it is, decide whether it's
5552 a press, click or drag, and build the appropriate structure. */
5553 case MOUSE_CLICK_EVENT
:
5555 case GPM_CLICK_EVENT
:
5557 #ifndef USE_TOOLKIT_SCROLL_BARS
5558 case SCROLL_BAR_CLICK_EVENT
:
5561 int button
= event
->code
;
5563 Lisp_Object position
;
5564 Lisp_Object
*start_pos_ptr
;
5565 Lisp_Object start_pos
;
5569 /* Build the position as appropriate for this mouse click. */
5570 if (event
->kind
== MOUSE_CLICK_EVENT
5572 || event
->kind
== GPM_CLICK_EVENT
5576 struct frame
*f
= XFRAME (event
->frame_or_window
);
5579 /* Ignore mouse events that were made on frame that
5580 have been deleted. */
5581 if (! FRAME_LIVE_P (f
))
5584 /* EVENT->x and EVENT->y are frame-relative pixel
5585 coordinates at this place. Under old redisplay, COLUMN
5586 and ROW are set to frame relative glyph coordinates
5587 which are then used to determine whether this click is
5588 in a menu (non-toolkit version). */
5589 if (!toolkit_menubar_in_use (f
))
5591 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5592 &column
, &row
, NULL
, 1);
5594 /* In the non-toolkit version, clicks on the menu bar
5595 are ordinary button events in the event buffer.
5596 Distinguish them, and invoke the menu.
5598 (In the toolkit version, the toolkit handles the
5599 menu bar and Emacs doesn't know about it until
5600 after the user makes a selection.) */
5601 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5602 && (event
->modifiers
& down_modifier
))
5604 Lisp_Object items
, item
;
5606 /* Find the menu bar item under `column'. */
5608 items
= FRAME_MENU_BAR_ITEMS (f
);
5609 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5611 Lisp_Object pos
, string
;
5612 string
= AREF (items
, i
+ 1);
5613 pos
= AREF (items
, i
+ 3);
5616 if (column
>= XINT (pos
)
5617 && column
< XINT (pos
) + SCHARS (string
))
5619 item
= AREF (items
, i
);
5624 /* ELisp manual 2.4b says (x y) are window
5625 relative but code says they are
5627 position
= list4 (event
->frame_or_window
,
5629 Fcons (event
->x
, event
->y
),
5630 make_number (event
->timestamp
));
5632 return list2 (item
, position
);
5636 position
= make_lispy_position (f
, event
->x
, event
->y
,
5639 #ifndef USE_TOOLKIT_SCROLL_BARS
5642 /* It's a scrollbar click. */
5644 Lisp_Object portion_whole
;
5647 window
= event
->frame_or_window
;
5648 portion_whole
= Fcons (event
->x
, event
->y
);
5649 part
= *scroll_bar_parts
[(int) event
->part
];
5651 position
= list5 (window
, Qvertical_scroll_bar
,
5652 portion_whole
, make_number (event
->timestamp
),
5655 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5657 if (button
>= ASIZE (button_down_location
))
5659 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5660 button_down_location
= larger_vector (button_down_location
,
5662 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5665 start_pos_ptr
= aref_addr (button_down_location
, button
);
5666 start_pos
= *start_pos_ptr
;
5667 *start_pos_ptr
= Qnil
;
5670 /* On window-system frames, use the value of
5671 double-click-fuzz as is. On other frames, interpret it
5672 as a multiple of 1/8 characters. */
5676 if (WINDOWP (event
->frame_or_window
))
5677 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5678 else if (FRAMEP (event
->frame_or_window
))
5679 f
= XFRAME (event
->frame_or_window
);
5683 if (FRAME_WINDOW_P (f
))
5684 fuzz
= double_click_fuzz
;
5686 fuzz
= double_click_fuzz
/ 8;
5688 is_double
= (button
== last_mouse_button
5689 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5690 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5691 && button_down_time
!= 0
5692 && (EQ (Vdouble_click_time
, Qt
)
5693 || (NATNUMP (Vdouble_click_time
)
5694 && (event
->timestamp
- button_down_time
5695 < XFASTINT (Vdouble_click_time
)))));
5698 last_mouse_button
= button
;
5699 last_mouse_x
= XINT (event
->x
);
5700 last_mouse_y
= XINT (event
->y
);
5702 /* If this is a button press, squirrel away the location, so
5703 we can decide later whether it was a click or a drag. */
5704 if (event
->modifiers
& down_modifier
)
5708 double_click_count
++;
5709 event
->modifiers
|= ((double_click_count
> 2)
5714 double_click_count
= 1;
5715 button_down_time
= event
->timestamp
;
5716 *start_pos_ptr
= Fcopy_alist (position
);
5717 ignore_mouse_drag_p
= 0;
5720 /* Now we're releasing a button - check the co-ordinates to
5721 see if this was a click or a drag. */
5722 else if (event
->modifiers
& up_modifier
)
5724 /* If we did not see a down before this up, ignore the up.
5725 Probably this happened because the down event chose a
5726 menu item. It would be an annoyance to treat the
5727 release of the button that chose the menu item as a
5730 if (!CONSP (start_pos
))
5733 event
->modifiers
&= ~up_modifier
;
5736 Lisp_Object new_down
, down
;
5737 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5739 /* The third element of every position
5740 should be the (x,y) pair. */
5741 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5742 new_down
= Fcar (Fcdr (Fcdr (position
)));
5745 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5747 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5748 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5751 if (ignore_mouse_drag_p
)
5753 event
->modifiers
|= click_modifier
;
5754 ignore_mouse_drag_p
= 0;
5756 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5757 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5758 /* Maybe the mouse has moved a lot, caused scrolling, and
5759 eventually ended up at the same screen position (but
5760 not buffer position) in which case it is a drag, not
5762 /* FIXME: OTOH if the buffer position has changed
5763 because of a timer or process filter rather than
5764 because of mouse movement, it should be considered as
5765 a click. But mouse-drag-region completely ignores
5766 this case and it hasn't caused any real problem, so
5767 it's probably OK to ignore it as well. */
5768 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5769 /* Mouse hasn't moved (much). */
5770 event
->modifiers
|= click_modifier
;
5773 button_down_time
= 0;
5774 event
->modifiers
|= drag_modifier
;
5777 /* Don't check is_double; treat this as multiple
5778 if the down-event was multiple. */
5779 if (double_click_count
> 1)
5780 event
->modifiers
|= ((double_click_count
> 2)
5786 /* Every mouse event should either have the down_modifier or
5787 the up_modifier set. */
5791 /* Get the symbol we should use for the mouse click. */
5794 head
= modify_event_symbol (button
,
5796 Qmouse_click
, Vlispy_mouse_stem
,
5799 ASIZE (mouse_syms
));
5800 if (event
->modifiers
& drag_modifier
)
5801 return list3 (head
, start_pos
, position
);
5802 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5803 return list3 (head
, position
, make_number (double_click_count
));
5805 return list2 (head
, position
);
5810 case HORIZ_WHEEL_EVENT
:
5812 Lisp_Object position
;
5815 /* Build the position as appropriate for this mouse click. */
5816 struct frame
*f
= XFRAME (event
->frame_or_window
);
5818 /* Ignore wheel events that were made on frame that have been
5820 if (! FRAME_LIVE_P (f
))
5823 position
= make_lispy_position (f
, event
->x
, event
->y
,
5826 /* Set double or triple modifiers to indicate the wheel speed. */
5828 /* On window-system frames, use the value of
5829 double-click-fuzz as is. On other frames, interpret it
5830 as a multiple of 1/8 characters. */
5836 if (WINDOWP (event
->frame_or_window
))
5837 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5838 else if (FRAMEP (event
->frame_or_window
))
5839 fr
= XFRAME (event
->frame_or_window
);
5843 fuzz
= FRAME_WINDOW_P (fr
)
5844 ? double_click_fuzz
: double_click_fuzz
/ 8;
5846 if (event
->modifiers
& up_modifier
)
5848 /* Emit a wheel-up event. */
5849 event
->modifiers
&= ~up_modifier
;
5852 else if (event
->modifiers
& down_modifier
)
5854 /* Emit a wheel-down event. */
5855 event
->modifiers
&= ~down_modifier
;
5859 /* Every wheel event should either have the down_modifier or
5860 the up_modifier set. */
5863 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5866 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5867 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5868 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5869 && button_down_time
!= 0
5870 && (EQ (Vdouble_click_time
, Qt
)
5871 || (NATNUMP (Vdouble_click_time
)
5872 && (event
->timestamp
- button_down_time
5873 < XFASTINT (Vdouble_click_time
)))));
5876 double_click_count
++;
5877 event
->modifiers
|= ((double_click_count
> 2)
5883 double_click_count
= 1;
5884 event
->modifiers
|= click_modifier
;
5887 button_down_time
= event
->timestamp
;
5888 /* Use a negative value to distinguish wheel from mouse button. */
5889 last_mouse_button
= - (1 + symbol_num
);
5890 last_mouse_x
= XINT (event
->x
);
5891 last_mouse_y
= XINT (event
->y
);
5893 /* Get the symbol we should use for the wheel event. */
5894 head
= modify_event_symbol (symbol_num
,
5900 ASIZE (wheel_syms
));
5903 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5904 return list3 (head
, position
, make_number (double_click_count
));
5906 return list2 (head
, position
);
5910 #ifdef USE_TOOLKIT_SCROLL_BARS
5912 /* We don't have down and up events if using toolkit scroll bars,
5913 so make this always a click event. Store in the `part' of
5914 the Lisp event a symbol which maps to the following actions:
5916 `above_handle' page up
5917 `below_handle' page down
5921 `bottom' bottom of buffer
5922 `handle' thumb has been dragged.
5923 `end-scroll' end of interaction with scroll bar
5925 The incoming input_event contains in its `part' member an
5926 index of type `enum scroll_bar_part' which we can use as an
5927 index in scroll_bar_parts to get the appropriate symbol. */
5929 case SCROLL_BAR_CLICK_EVENT
:
5931 Lisp_Object position
, head
, window
, portion_whole
, part
;
5933 window
= event
->frame_or_window
;
5934 portion_whole
= Fcons (event
->x
, event
->y
);
5935 part
= *scroll_bar_parts
[(int) event
->part
];
5937 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5938 make_number (event
->timestamp
), part
);
5940 /* Always treat scroll bar events as clicks. */
5941 event
->modifiers
|= click_modifier
;
5942 event
->modifiers
&= ~up_modifier
;
5944 if (event
->code
>= ASIZE (mouse_syms
))
5945 mouse_syms
= larger_vector (mouse_syms
,
5946 event
->code
- ASIZE (mouse_syms
) + 1,
5949 /* Get the symbol we should use for the mouse click. */
5950 head
= modify_event_symbol (event
->code
,
5955 ASIZE (mouse_syms
));
5956 return list2 (head
, position
);
5959 #endif /* USE_TOOLKIT_SCROLL_BARS */
5961 case DRAG_N_DROP_EVENT
:
5964 Lisp_Object head
, position
;
5967 f
= XFRAME (event
->frame_or_window
);
5970 /* Ignore mouse events that were made on frames that
5971 have been deleted. */
5972 if (! FRAME_LIVE_P (f
))
5975 position
= make_lispy_position (f
, event
->x
, event
->y
,
5978 head
= modify_event_symbol (0, event
->modifiers
,
5980 lispy_drag_n_drop_names
,
5981 &drag_n_drop_syms
, 1);
5982 return list3 (head
, position
, files
);
5985 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5986 || defined (HAVE_NS) || defined (USE_GTK)
5987 case MENU_BAR_EVENT
:
5988 if (EQ (event
->arg
, event
->frame_or_window
))
5989 /* This is the prefix key. We translate this to
5990 `(menu_bar)' because the code in keyboard.c for menu
5991 events, which we use, relies on this. */
5992 return list1 (Qmenu_bar
);
5996 case SELECT_WINDOW_EVENT
:
5997 /* Make an event (select-window (WINDOW)). */
5998 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6000 case TOOL_BAR_EVENT
:
6001 if (EQ (event
->arg
, event
->frame_or_window
))
6002 /* This is the prefix key. We translate this to
6003 `(tool_bar)' because the code in keyboard.c for tool bar
6004 events, which we use, relies on this. */
6005 return list1 (Qtool_bar
);
6006 else if (SYMBOLP (event
->arg
))
6007 return apply_modifiers (event
->modifiers
, event
->arg
);
6010 case USER_SIGNAL_EVENT
:
6011 /* A user signal. */
6013 char *name
= find_user_signal_name (event
->code
);
6016 return intern (name
);
6019 case SAVE_SESSION_EVENT
:
6020 return Qsave_session
;
6025 return Fcons (Qdbus_event
, event
->arg
);
6027 #endif /* HAVE_DBUS */
6029 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6030 case FILE_NOTIFY_EVENT
:
6032 return Fcons (Qfile_notify
, event
->arg
);
6034 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6036 case CONFIG_CHANGED_EVENT
:
6037 return list3 (Qconfig_changed_event
,
6038 event
->arg
, event
->frame_or_window
);
6040 /* The 'kind' field of the event is something we don't recognize. */
6047 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6048 Lisp_Object x
, Lisp_Object y
, Time t
)
6050 /* Is it a scroll bar movement? */
6051 if (frame
&& ! NILP (bar_window
))
6053 Lisp_Object part_sym
;
6055 part_sym
= *scroll_bar_parts
[(int) part
];
6056 return list2 (Qscroll_bar_movement
,
6058 Qvertical_scroll_bar
,
6063 /* Or is it an ordinary mouse movement? */
6066 Lisp_Object position
;
6067 position
= make_lispy_position (frame
, x
, y
, t
);
6068 return list2 (Qmouse_movement
, position
);
6072 /* Construct a switch frame event. */
6074 make_lispy_switch_frame (Lisp_Object frame
)
6076 return list2 (Qswitch_frame
, frame
);
6080 make_lispy_focus_in (Lisp_Object frame
)
6082 return list2 (Qfocus_in
, frame
);
6085 #ifdef HAVE_WINDOW_SYSTEM
6088 make_lispy_focus_out (Lisp_Object frame
)
6090 return list2 (Qfocus_out
, frame
);
6093 #endif /* HAVE_WINDOW_SYSTEM */
6095 /* Manipulating modifiers. */
6097 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6099 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6100 SYMBOL's name of the end of the modifiers; the string from this
6101 position is the unmodified symbol name.
6103 This doesn't use any caches. */
6106 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6112 CHECK_SYMBOL (symbol
);
6115 name
= SYMBOL_NAME (symbol
);
6117 for (i
= 0; i
< SBYTES (name
) - 1; )
6119 ptrdiff_t this_mod_end
= 0;
6122 /* See if the name continues with a modifier word.
6123 Check that the word appears, but don't check what follows it.
6124 Set this_mod and this_mod_end to record what we find. */
6126 switch (SREF (name
, i
))
6128 #define SINGLE_LETTER_MOD(BIT) \
6129 (this_mod_end = i + 1, this_mod = BIT)
6132 SINGLE_LETTER_MOD (alt_modifier
);
6136 SINGLE_LETTER_MOD (ctrl_modifier
);
6140 SINGLE_LETTER_MOD (hyper_modifier
);
6144 SINGLE_LETTER_MOD (meta_modifier
);
6148 SINGLE_LETTER_MOD (shift_modifier
);
6152 SINGLE_LETTER_MOD (super_modifier
);
6155 #undef SINGLE_LETTER_MOD
6157 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6158 if (i + LEN + 1 <= SBYTES (name) \
6159 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6161 this_mod_end = i + LEN; \
6166 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6167 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6168 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6172 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6174 #undef MULTI_LETTER_MOD
6178 /* If we found no modifier, stop looking for them. */
6179 if (this_mod_end
== 0)
6182 /* Check there is a dash after the modifier, so that it
6183 really is a modifier. */
6184 if (this_mod_end
>= SBYTES (name
)
6185 || SREF (name
, this_mod_end
) != '-')
6188 /* This modifier is real; look for another. */
6189 modifiers
|= this_mod
;
6190 i
= this_mod_end
+ 1;
6193 /* Should we include the `click' modifier? */
6194 if (! (modifiers
& (down_modifier
| drag_modifier
6195 | double_modifier
| triple_modifier
))
6196 && i
+ 7 == SBYTES (name
)
6197 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6198 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6199 modifiers
|= click_modifier
;
6201 if (! (modifiers
& (double_modifier
| triple_modifier
))
6202 && i
+ 6 < SBYTES (name
)
6203 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6204 modifiers
|= click_modifier
;
6212 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6213 prepended to the string BASE[0..BASE_LEN-1].
6214 This doesn't use any caches. */
6216 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6218 /* Since BASE could contain nulls, we can't use intern here; we have
6219 to use Fintern, which expects a genuine Lisp_String, and keeps a
6221 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6227 /* Only the event queue may use the `up' modifier; it should always
6228 be turned into a click or drag event before presented to lisp code. */
6229 if (modifiers
& up_modifier
)
6232 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6233 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6234 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6235 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6236 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6237 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6238 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6239 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6240 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6241 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6242 /* The click modifier is denoted by the absence of other modifiers. */
6246 mod_len
= p
- new_mods
;
6250 Lisp_Object new_name
;
6252 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6253 mod_len
+ base_len_byte
);
6254 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6255 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6257 return Fintern (new_name
, Qnil
);
6262 static const char *const modifier_names
[] =
6264 "up", "down", "drag", "click", "double", "triple", 0, 0,
6265 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6266 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6268 #define NUM_MOD_NAMES ARRAYELTS (modifier_names)
6270 static Lisp_Object modifier_symbols
;
6272 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6274 lispy_modifier_list (int modifiers
)
6276 Lisp_Object modifier_list
;
6279 modifier_list
= Qnil
;
6280 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6281 if (modifiers
& (1<<i
))
6282 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6285 return modifier_list
;
6289 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6290 where UNMODIFIED is the unmodified form of SYMBOL,
6291 MASK is the set of modifiers present in SYMBOL's name.
6292 This is similar to parse_modifiers_uncached, but uses the cache in
6293 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6294 Qevent_symbol_elements property. */
6296 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6299 parse_modifiers (Lisp_Object symbol
)
6301 Lisp_Object elements
;
6303 if (INTEGERP (symbol
))
6304 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6305 else if (!SYMBOLP (symbol
))
6308 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6309 if (CONSP (elements
))
6314 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6315 Lisp_Object unmodified
;
6318 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6319 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6322 if (modifiers
& ~INTMASK
)
6324 XSETFASTINT (mask
, modifiers
);
6325 elements
= list2 (unmodified
, mask
);
6327 /* Cache the parsing results on SYMBOL. */
6328 Fput (symbol
, Qevent_symbol_element_mask
,
6330 Fput (symbol
, Qevent_symbol_elements
,
6331 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6333 /* Since we know that SYMBOL is modifiers applied to unmodified,
6334 it would be nice to put that in unmodified's cache.
6335 But we can't, since we're not sure that parse_modifiers is
6342 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6343 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6344 doc
: /* Parse the event symbol. For internal use. */)
6345 (Lisp_Object symbol
)
6347 /* Fill the cache if needed. */
6348 parse_modifiers (symbol
);
6349 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6350 and use the Lispier representation stored on Qevent_symbol_elements
6352 return Fget (symbol
, Qevent_symbol_elements
);
6355 /* Apply the modifiers MODIFIERS to the symbol BASE.
6356 BASE must be unmodified.
6358 This is like apply_modifiers_uncached, but uses BASE's
6359 Qmodifier_cache property, if present. It also builds
6360 Qevent_symbol_elements properties, since it has that info anyway.
6362 apply_modifiers copies the value of BASE's Qevent_kind property to
6363 the modified symbol. */
6365 apply_modifiers (int modifiers
, Lisp_Object base
)
6367 Lisp_Object cache
, idx
, entry
, new_symbol
;
6369 /* Mask out upper bits. We don't know where this value's been. */
6370 modifiers
&= INTMASK
;
6372 if (INTEGERP (base
))
6373 return make_number (XINT (base
) | modifiers
);
6375 /* The click modifier never figures into cache indices. */
6376 cache
= Fget (base
, Qmodifier_cache
);
6377 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6378 entry
= assq_no_quit (idx
, cache
);
6381 new_symbol
= XCDR (entry
);
6384 /* We have to create the symbol ourselves. */
6385 new_symbol
= apply_modifiers_uncached (modifiers
,
6386 SSDATA (SYMBOL_NAME (base
)),
6387 SCHARS (SYMBOL_NAME (base
)),
6388 SBYTES (SYMBOL_NAME (base
)));
6390 /* Add the new symbol to the base's cache. */
6391 entry
= Fcons (idx
, new_symbol
);
6392 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6394 /* We have the parsing info now for free, so we could add it to
6396 XSETFASTINT (idx, modifiers);
6397 Fput (new_symbol, Qevent_symbol_element_mask,
6399 Fput (new_symbol, Qevent_symbol_elements,
6400 Fcons (base, lispy_modifier_list (modifiers)));
6401 Sadly, this is only correct if `base' is indeed a base event,
6402 which is not necessarily the case. -stef */
6405 /* Make sure this symbol is of the same kind as BASE.
6407 You'd think we could just set this once and for all when we
6408 intern the symbol above, but reorder_modifiers may call us when
6409 BASE's property isn't set right; we can't assume that just
6410 because it has a Qmodifier_cache property it must have its
6411 Qevent_kind set right as well. */
6412 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6416 kind
= Fget (base
, Qevent_kind
);
6418 Fput (new_symbol
, Qevent_kind
, kind
);
6425 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6426 return a symbol with the modifiers placed in the canonical order.
6427 Canonical order is alphabetical, except for down and drag, which
6428 always come last. The 'click' modifier is never written out.
6430 Fdefine_key calls this to make sure that (for example) C-M-foo
6431 and M-C-foo end up being equivalent in the keymap. */
6434 reorder_modifiers (Lisp_Object symbol
)
6436 /* It's hopefully okay to write the code this way, since everything
6437 will soon be in caches, and no consing will be done at all. */
6440 parsed
= parse_modifiers (symbol
);
6441 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6446 /* For handling events, we often want to produce a symbol whose name
6447 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6448 to some base, like the name of a function key or mouse button.
6449 modify_event_symbol produces symbols of this sort.
6451 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6452 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6455 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6456 into symbol names, or a string specifying a name stem used to
6457 construct a symbol name or the form `STEM-N', where N is the decimal
6458 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6459 non-nil; otherwise NAME_TABLE is used.
6461 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6462 persist between calls to modify_event_symbol that it can use to
6463 store a cache of the symbols it's generated for this NAME_TABLE
6464 before. The object stored there may be a vector or an alist.
6466 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6468 MODIFIERS is a set of modifier bits (as given in struct input_events)
6469 whose prefixes should be applied to the symbol name.
6471 SYMBOL_KIND is the value to be placed in the event_kind property of
6472 the returned symbol.
6474 The symbols we create are supposed to have an
6475 `event-symbol-elements' property, which lists the modifiers present
6476 in the symbol's name. */
6479 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6480 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6481 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6484 Lisp_Object symbol_int
;
6486 /* Get rid of the "vendor-specific" bit here. */
6487 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6489 /* Is this a request for a valid symbol? */
6490 if (symbol_num
< 0 || symbol_num
>= table_size
)
6493 if (CONSP (*symbol_table
))
6494 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6496 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6497 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6498 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6499 we've never used that symbol before. */
6502 if (! VECTORP (*symbol_table
)
6503 || ASIZE (*symbol_table
) != table_size
)
6507 XSETFASTINT (size
, table_size
);
6508 *symbol_table
= Fmake_vector (size
, Qnil
);
6511 value
= AREF (*symbol_table
, symbol_num
);
6514 /* Have we already used this symbol before? */
6517 /* No; let's create it. */
6518 if (CONSP (name_alist_or_stem
))
6519 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6520 else if (STRINGP (name_alist_or_stem
))
6523 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6524 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6526 buf
= SAFE_ALLOCA (len
);
6527 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6528 XINT (symbol_int
) + 1);
6529 value
= intern (buf
);
6532 else if (name_table
!= 0 && name_table
[symbol_num
])
6533 value
= intern (name_table
[symbol_num
]);
6535 #ifdef HAVE_WINDOW_SYSTEM
6538 char *name
= x_get_keysym_name (symbol_num
);
6540 value
= intern (name
);
6546 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6547 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6548 value
= intern (buf
);
6551 if (CONSP (*symbol_table
))
6552 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6554 ASET (*symbol_table
, symbol_num
, value
);
6556 /* Fill in the cache entries for this symbol; this also
6557 builds the Qevent_symbol_elements property, which the user
6559 apply_modifiers (modifiers
& click_modifier
, value
);
6560 Fput (value
, Qevent_kind
, symbol_kind
);
6563 /* Apply modifiers to that symbol. */
6564 return apply_modifiers (modifiers
, value
);
6567 /* Convert a list that represents an event type,
6568 such as (ctrl meta backspace), into the usual representation of that
6569 event type as a number or a symbol. */
6571 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6572 doc
: /* Convert the event description list EVENT-DESC to an event type.
6573 EVENT-DESC should contain one base event type (a character or symbol)
6574 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6575 drag, down, double or triple). The base must be last.
6576 The return value is an event type (a character or symbol) which
6577 has the same base event type and all the specified modifiers. */)
6578 (Lisp_Object event_desc
)
6586 while (CONSP (rest
))
6594 /* Given a symbol, see if it is a modifier name. */
6595 if (SYMBOLP (elt
) && CONSP (rest
))
6596 this = parse_solitary_modifier (elt
);
6600 else if (!NILP (base
))
6601 error ("Two bases given in one event");
6607 /* Let the symbol A refer to the character A. */
6608 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6609 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6611 if (INTEGERP (base
))
6613 /* Turn (shift a) into A. */
6614 if ((modifiers
& shift_modifier
) != 0
6615 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6617 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6618 modifiers
&= ~shift_modifier
;
6621 /* Turn (control a) into C-a. */
6622 if (modifiers
& ctrl_modifier
)
6623 return make_number ((modifiers
& ~ctrl_modifier
)
6624 | make_ctrl_char (XINT (base
)));
6626 return make_number (modifiers
| XINT (base
));
6628 else if (SYMBOLP (base
))
6629 return apply_modifiers (modifiers
, base
);
6631 error ("Invalid base event");
6634 /* Try to recognize SYMBOL as a modifier name.
6635 Return the modifier flag bit, or 0 if not recognized. */
6638 parse_solitary_modifier (Lisp_Object symbol
)
6640 Lisp_Object name
= SYMBOL_NAME (symbol
);
6642 switch (SREF (name
, 0))
6644 #define SINGLE_LETTER_MOD(BIT) \
6645 if (SBYTES (name) == 1) \
6648 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6649 if (LEN == SBYTES (name) \
6650 && ! memcmp (SDATA (name), NAME, LEN)) \
6654 SINGLE_LETTER_MOD (alt_modifier
);
6658 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6662 SINGLE_LETTER_MOD (ctrl_modifier
);
6666 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6667 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6671 SINGLE_LETTER_MOD (hyper_modifier
);
6675 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6679 SINGLE_LETTER_MOD (meta_modifier
);
6683 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6687 SINGLE_LETTER_MOD (shift_modifier
);
6691 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6692 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6693 SINGLE_LETTER_MOD (super_modifier
);
6697 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6698 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6699 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6703 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6706 #undef SINGLE_LETTER_MOD
6707 #undef MULTI_LETTER_MOD
6713 /* Return true if EVENT is a list whose elements are all integers or symbols.
6714 Such a list is not valid as an event,
6715 but it can be a Lucid-style event type list. */
6718 lucid_event_type_list_p (Lisp_Object object
)
6722 if (! CONSP (object
))
6725 if (EQ (XCAR (object
), Qhelp_echo
)
6726 || EQ (XCAR (object
), Qvertical_line
)
6727 || EQ (XCAR (object
), Qmode_line
)
6728 || EQ (XCAR (object
), Qheader_line
))
6731 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6735 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6742 /* Return true if terminal input chars are available.
6743 Also, store the return value into INPUT_PENDING.
6745 Serves the purpose of ioctl (0, FIONREAD, ...)
6746 but works even if FIONREAD does not exist.
6747 (In fact, this may actually read some input.)
6749 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6750 timer events that are ripe.
6751 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6752 events (FOCUS_IN_EVENT).
6753 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6754 movements and toolkit scroll bar thumb drags. */
6757 get_input_pending (int flags
)
6759 /* First of all, have we already counted some input? */
6760 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6762 /* If input is being read as it arrives, and we have none, there is none. */
6763 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6765 /* Try to read some input and see how much we get. */
6767 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6770 return input_pending
;
6773 /* Put a BUFFER_SWITCH_EVENT in the buffer
6774 so that read_key_sequence will notice the new current buffer. */
6777 record_asynch_buffer_change (void)
6779 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6780 The purpose of the event is to make read_key_sequence look up the
6781 keymaps again. If we aren't in read_key_sequence, we don't need one,
6782 and the event could cause trouble by messing up (input-pending-p).
6783 Note: Fwaiting_for_user_input_p always returns nil when async
6784 subprocesses aren't supported. */
6785 if (!NILP (Fwaiting_for_user_input_p ()))
6787 struct input_event event
;
6790 event
.kind
= BUFFER_SWITCH_EVENT
;
6791 event
.frame_or_window
= Qnil
;
6794 /* Make sure no interrupt happens while storing the event. */
6796 if (interrupt_input
)
6797 kbd_buffer_store_event (&event
);
6802 kbd_buffer_store_event (&event
);
6808 /* Read any terminal input already buffered up by the system
6809 into the kbd_buffer, but do not wait.
6811 Return the number of keyboard chars read, or -1 meaning
6812 this is a bad time to try to read input. */
6821 /* Store pending user signal events, if any. */
6822 store_user_signal_events ();
6824 /* Loop through the available terminals, and call their input hooks. */
6828 struct terminal
*next
= t
->next_terminal
;
6830 if (t
->read_socket_hook
)
6833 struct input_event hold_quit
;
6835 if (input_blocked_p ())
6837 pending_signals
= 1;
6841 EVENT_INIT (hold_quit
);
6842 hold_quit
.kind
= NO_EVENT
;
6844 /* No need for FIONREAD or fcntl; just say don't wait. */
6845 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6848 if (nr
== -1) /* Not OK to read input now. */
6852 else if (nr
== -2) /* Non-transient error. */
6854 /* The terminal device terminated; it should be closed. */
6856 /* Kill Emacs if this was our last terminal. */
6857 if (!terminal_list
->next_terminal
)
6858 /* Formerly simply reported no input, but that
6859 sometimes led to a failure of Emacs to terminate.
6860 SIGHUP seems appropriate if we can't reach the
6862 /* ??? Is it really right to send the signal just to
6863 this process rather than to the whole process
6864 group? Perhaps on systems with FIONREAD Emacs is
6865 alone in its group. */
6866 terminate_due_to_signal (SIGHUP
, 10);
6868 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6871 XSETTERMINAL (tmp
, t
);
6872 Fdelete_terminal (tmp
, Qnoelisp
);
6876 if (hold_quit
.kind
!= NO_EVENT
)
6877 kbd_buffer_store_event (&hold_quit
);
6886 frame_make_pointer_visible ();
6891 /* This is the tty way of reading available input.
6893 Note that each terminal device has its own `struct terminal' object,
6894 and so this function is called once for each individual termcap
6895 terminal. The first parameter indicates which terminal to read from. */
6898 tty_read_avail_input (struct terminal
*terminal
,
6899 struct input_event
*hold_quit
)
6901 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6902 the kbd_buffer can really hold. That may prevent loss
6903 of characters on some systems when input is stuffed at us. */
6904 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6906 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6909 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6911 if (kbd_on_hold_p () || buffer_free
<= 0)
6913 #endif /* subprocesses */
6915 if (!terminal
->name
) /* Don't read from a dead terminal. */
6918 if (terminal
->type
!= output_termcap
6919 && terminal
->type
!= output_msdos_raw
)
6922 /* XXX I think the following code should be moved to separate hook
6923 functions in system-dependent files. */
6925 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6926 code sets read_socket_hook to w32_console_read_socket instead! */
6928 #else /* not WINDOWSNT */
6929 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6933 return 0; /* The terminal is suspended. */
6936 n_to_read
= dos_keysns ();
6940 cbuf
[0] = dos_keyread ();
6943 #else /* not MSDOS */
6948 struct input_event gpm_hold_quit
;
6949 int gpm
, fd
= gpm_fd
;
6951 EVENT_INIT (gpm_hold_quit
);
6952 gpm_hold_quit
.kind
= NO_EVENT
;
6954 /* gpm==1 if event received.
6955 gpm==0 if the GPM daemon has closed the connection, in which case
6956 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6957 we save it in `fd' so close_gpm can remove it from the
6959 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6960 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6961 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6964 /* Presumably the GPM daemon has closed the connection. */
6966 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6967 kbd_buffer_store_event (&gpm_hold_quit
);
6971 #endif /* HAVE_GPM */
6973 /* Determine how many characters we should *try* to read. */
6974 #ifdef USABLE_FIONREAD
6975 /* Find out how much input is available. */
6976 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6978 if (! noninteractive
)
6979 return -2; /* Close this terminal. */
6985 if (n_to_read
> sizeof cbuf
)
6986 n_to_read
= sizeof cbuf
;
6987 #elif defined USG || defined CYGWIN
6988 /* Read some input if available, but don't wait. */
6989 n_to_read
= sizeof cbuf
;
6990 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6992 # error "Cannot read without possibly delaying"
6996 /* Don't read more than we can store. */
6997 if (n_to_read
> buffer_free
)
6998 n_to_read
= buffer_free
;
6999 #endif /* subprocesses */
7001 /* Now read; for one reason or another, this will not block.
7002 NREAD is set to the number of chars read. */
7005 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7006 /* POSIX infers that processes which are not in the session leader's
7007 process group won't get SIGHUPs at logout time. BSDI adheres to
7008 this part standard and returns -1 from read (0) with errno==EIO
7009 when the control tty is taken away.
7010 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7011 if (nread
== -1 && errno
== EIO
)
7012 return -2; /* Close this terminal. */
7013 #if defined (AIX) && defined (_BSD)
7014 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7015 This looks incorrect, but it isn't, because _BSD causes
7016 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7017 and that causes a value other than 0 when there is no input. */
7019 return -2; /* Close this terminal. */
7023 /* We used to retry the read if it was interrupted.
7024 But this does the wrong thing when O_NONBLOCK causes
7025 an EAGAIN error. Does anybody know of a situation
7026 where a retry is actually needed? */
7028 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7038 #ifndef USABLE_FIONREAD
7039 #if defined (USG) || defined (CYGWIN)
7040 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7041 #endif /* USG or CYGWIN */
7042 #endif /* no FIONREAD */
7047 #endif /* not MSDOS */
7048 #endif /* not WINDOWSNT */
7050 for (i
= 0; i
< nread
; i
++)
7052 struct input_event buf
;
7054 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7056 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7057 buf
.modifiers
= meta_modifier
;
7058 if (tty
->meta_key
!= 2)
7062 /* Set the frame corresponding to the active tty. Note that the
7063 value of selected_frame is not reliable here, redisplay tends
7064 to temporarily change it. */
7065 buf
.frame_or_window
= tty
->top_frame
;
7068 kbd_buffer_store_event (&buf
);
7069 /* Don't look at input that follows a C-g too closely.
7070 This reduces lossage due to autorepeat on C-g. */
7071 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7072 && buf
.code
== quit_char
)
7080 handle_async_input (void)
7085 int nread
= gobble_input ();
7086 /* -1 means it's not ok to read the input now.
7087 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7088 0 means there was no keyboard input available. */
7096 process_pending_signals (void)
7098 pending_signals
= 0;
7099 handle_async_input ();
7100 do_pending_atimers ();
7103 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7104 and reinvoke any pending signal if the level is now 0 and
7105 a fatal error is not already in progress. */
7108 unblock_input_to (int level
)
7110 interrupt_input_blocked
= level
;
7113 if (pending_signals
&& !fatal_error_in_progress
)
7114 process_pending_signals ();
7120 /* End critical section.
7122 If doing signal-driven input, and a signal came in when input was
7123 blocked, reinvoke the signal handler now to deal with it.
7125 It will also process queued input, if it was not read before.
7126 When a longer code sequence does not use block/unblock input
7127 at all, the whole input gathered up to the next call to
7128 unblock_input will be processed inside that call. */
7131 unblock_input (void)
7133 unblock_input_to (interrupt_input_blocked
- 1);
7136 /* Undo any number of BLOCK_INPUT calls,
7137 and also reinvoke any pending signal. */
7140 totally_unblock_input (void)
7142 unblock_input_to (0);
7148 handle_input_available_signal (int sig
)
7150 pending_signals
= 1;
7152 if (input_available_clear_time
)
7153 *input_available_clear_time
= make_timespec (0, 0);
7157 deliver_input_available_signal (int sig
)
7159 deliver_process_signal (sig
, handle_input_available_signal
);
7161 #endif /* USABLE_SIGIO */
7164 /* User signal events. */
7166 struct user_signal_info
7168 /* Signal number. */
7171 /* Name of the signal. */
7174 /* Number of pending signals. */
7177 struct user_signal_info
*next
;
7180 /* List of user signals. */
7181 static struct user_signal_info
*user_signals
= NULL
;
7184 add_user_signal (int sig
, const char *name
)
7186 struct sigaction action
;
7187 struct user_signal_info
*p
;
7189 for (p
= user_signals
; p
; p
= p
->next
)
7191 /* Already added. */
7194 p
= xmalloc (sizeof *p
);
7196 p
->name
= xstrdup (name
);
7198 p
->next
= user_signals
;
7201 emacs_sigaction_init (&action
, deliver_user_signal
);
7202 sigaction (sig
, &action
, 0);
7206 handle_user_signal (int sig
)
7208 struct user_signal_info
*p
;
7209 const char *special_event_name
= NULL
;
7211 if (SYMBOLP (Vdebug_on_event
))
7212 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7214 for (p
= user_signals
; p
; p
= p
->next
)
7217 if (special_event_name
7218 && strcmp (special_event_name
, p
->name
) == 0)
7220 /* Enter the debugger in many ways. */
7221 debug_on_next_call
= 1;
7224 Vinhibit_quit
= Qnil
;
7226 /* Eat the event. */
7232 if (interrupt_input
)
7233 handle_input_available_signal (sig
);
7237 /* Tell wait_reading_process_output that it needs to wake
7238 up and look around. */
7239 if (input_available_clear_time
)
7240 *input_available_clear_time
= make_timespec (0, 0);
7247 deliver_user_signal (int sig
)
7249 deliver_process_signal (sig
, handle_user_signal
);
7253 find_user_signal_name (int sig
)
7255 struct user_signal_info
*p
;
7257 for (p
= user_signals
; p
; p
= p
->next
)
7265 store_user_signal_events (void)
7267 struct user_signal_info
*p
;
7268 struct input_event buf
;
7269 bool buf_initialized
= 0;
7271 for (p
= user_signals
; p
; p
= p
->next
)
7272 if (p
->npending
> 0)
7274 if (! buf_initialized
)
7276 memset (&buf
, 0, sizeof buf
);
7277 buf
.kind
= USER_SIGNAL_EVENT
;
7278 buf
.frame_or_window
= selected_frame
;
7279 buf_initialized
= 1;
7285 kbd_buffer_store_event (&buf
);
7288 while (p
->npending
> 0);
7293 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void *);
7294 static Lisp_Object menu_bar_one_keymap_changed_items
;
7296 /* These variables hold the vector under construction within
7297 menu_bar_items and its subroutines, and the current index
7298 for storing into that vector. */
7299 static Lisp_Object menu_bar_items_vector
;
7300 static int menu_bar_items_index
;
7303 static const char *separator_names
[] = {
7308 "single-dashed-line",
7309 "double-dashed-line",
7311 "shadow-etched-out",
7312 "shadow-etched-in-dash",
7313 "shadow-etched-out-dash",
7314 "shadow-double-etched-in",
7315 "shadow-double-etched-out",
7316 "shadow-double-etched-in-dash",
7317 "shadow-double-etched-out-dash",
7321 /* Return true if LABEL specifies a separator. */
7324 menu_separator_name_p (const char *label
)
7328 else if (strlen (label
) > 3
7329 && memcmp (label
, "--", 2) == 0
7334 for (i
= 0; separator_names
[i
]; ++i
)
7335 if (strcmp (label
, separator_names
[i
]) == 0)
7340 /* It's a separator if it contains only dashes. */
7341 while (*label
== '-')
7343 return (*label
== 0);
7350 /* Return a vector of menu items for a menu bar, appropriate
7351 to the current buffer. Each item has three elements in the vector:
7354 OLD is an old vector we can optionally reuse, or nil. */
7357 menu_bar_items (Lisp_Object old
)
7359 /* The number of keymaps we're scanning right now, and the number of
7360 keymaps we have allocated space for. */
7363 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7364 in the current keymaps, or nil where it is not a prefix. */
7367 Lisp_Object def
, tail
;
7372 /* In order to build the menus, we need to call the keymap
7373 accessors. They all call QUIT. But this function is called
7374 during redisplay, during which a quit is fatal. So inhibit
7375 quitting while building the menus.
7376 We do this instead of specbind because (1) errors will clear it anyway
7377 and (2) this avoids risk of specpdl overflow. */
7378 oquit
= Vinhibit_quit
;
7382 menu_bar_items_vector
= old
;
7384 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7385 menu_bar_items_index
= 0;
7387 /* Build our list of keymaps.
7388 If we recognize a function key and replace its escape sequence in
7389 keybuf with its symbol, or if the sequence starts with a mouse
7390 click and we need to switch buffers, we jump back here to rebuild
7391 the initial keymaps from the current buffer. */
7395 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7396 if (!NILP (Voverriding_local_map_menu_flag
)
7397 && !NILP (Voverriding_local_map
))
7399 /* Yes, use them (if non-nil) as well as the global map. */
7400 maps
= alloca (3 * sizeof (maps
[0]));
7402 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7403 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7404 if (!NILP (Voverriding_local_map
))
7405 maps
[nmaps
++] = Voverriding_local_map
;
7409 /* No, so use major and minor mode keymaps and keymap property.
7410 Note that menu-bar bindings in the local-map and keymap
7411 properties may not work reliable, as they are only
7412 recognized when the menu-bar (or mode-line) is updated,
7413 which does not normally happen after every command. */
7416 nminor
= current_minor_maps (NULL
, &tmaps
);
7417 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7419 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7420 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7421 maps
[nmaps
++] = tem
;
7422 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7423 maps
[nmaps
++] = tem
;
7424 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7426 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7428 maps
[nmaps
++] = current_global_map
;
7431 /* Look up in each map the dummy prefix key `menu-bar'. */
7433 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7434 if (!NILP (maps
[mapno
]))
7436 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7440 menu_bar_one_keymap_changed_items
= Qnil
;
7441 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7445 /* Move to the end those items that should be at the end. */
7447 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7450 int end
= menu_bar_items_index
;
7452 for (i
= 0; i
< end
; i
+= 4)
7453 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7455 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7456 /* Move the item at index I to the end,
7457 shifting all the others forward. */
7458 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7459 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7460 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7461 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7463 memmove (aref_addr (menu_bar_items_vector
, i
),
7464 aref_addr (menu_bar_items_vector
, i
+ 4),
7465 (end
- i
- 4) * word_size
);
7466 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7467 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7468 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7469 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7474 /* Add nil, nil, nil, nil at the end. */
7476 int i
= menu_bar_items_index
;
7477 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7478 menu_bar_items_vector
=
7479 larger_vector (menu_bar_items_vector
, 4, -1);
7480 /* Add this item. */
7481 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7482 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7483 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7484 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7485 menu_bar_items_index
= i
;
7488 Vinhibit_quit
= oquit
;
7489 return menu_bar_items_vector
;
7492 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7493 If there's already an item for KEY, add this DEF to it. */
7495 Lisp_Object item_properties
;
7498 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7500 struct gcpro gcpro1
;
7505 if (EQ (item
, Qundefined
))
7507 /* If a map has an explicit `undefined' as definition,
7508 discard any previously made menu bar item. */
7510 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7511 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7513 if (menu_bar_items_index
> i
+ 4)
7514 memmove (aref_addr (menu_bar_items_vector
, i
),
7515 aref_addr (menu_bar_items_vector
, i
+ 4),
7516 (menu_bar_items_index
- i
- 4) * word_size
);
7517 menu_bar_items_index
-= 4;
7521 /* If this keymap has already contributed to this KEY,
7522 don't contribute to it a second time. */
7523 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7524 if (!NILP (tem
) || NILP (item
))
7527 menu_bar_one_keymap_changed_items
7528 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7530 /* We add to menu_bar_one_keymap_changed_items before doing the
7531 parse_menu_item, so that if it turns out it wasn't a menu item,
7532 it still correctly hides any further menu item. */
7534 parsed
= parse_menu_item (item
, 1);
7539 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7541 /* Find any existing item for this KEY. */
7542 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7543 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7546 /* If we did not find this KEY, add it at the end. */
7547 if (i
== menu_bar_items_index
)
7549 /* If vector is too small, get a bigger one. */
7550 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7551 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7552 /* Add this item. */
7553 ASET (menu_bar_items_vector
, i
, key
); i
++;
7554 ASET (menu_bar_items_vector
, i
,
7555 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7556 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7557 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7558 menu_bar_items_index
= i
;
7560 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7564 old
= AREF (menu_bar_items_vector
, i
+ 2);
7565 /* If the new and the old items are not both keymaps,
7566 the lookup will only find `item'. */
7567 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7568 ASET (menu_bar_items_vector
, i
+ 2, item
);
7572 /* This is used as the handler when calling menu_item_eval_property. */
7574 menu_item_eval_property_1 (Lisp_Object arg
)
7576 /* If we got a quit from within the menu computation,
7577 quit all the way out of it. This takes care of C-] in the debugger. */
7578 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7579 Fsignal (Qquit
, Qnil
);
7585 eval_dyn (Lisp_Object form
)
7587 return Feval (form
, Qnil
);
7590 /* Evaluate an expression and return the result (or nil if something
7591 went wrong). Used to evaluate dynamic parts of menu items. */
7593 menu_item_eval_property (Lisp_Object sexpr
)
7595 ptrdiff_t count
= SPECPDL_INDEX ();
7597 specbind (Qinhibit_redisplay
, Qt
);
7598 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7599 menu_item_eval_property_1
);
7600 return unbind_to (count
, val
);
7603 /* This function parses a menu item and leaves the result in the
7604 vector item_properties.
7605 ITEM is a key binding, a possible menu item.
7606 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7608 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7609 parse_menu_item returns true if the item is a menu item and false
7613 parse_menu_item (Lisp_Object item
, int inmenubar
)
7615 Lisp_Object def
, tem
, item_string
, start
;
7617 Lisp_Object keyhint
;
7626 /* Create item_properties vector if necessary. */
7627 if (NILP (item_properties
))
7629 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7631 /* Initialize optional entries. */
7632 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7633 ASET (item_properties
, i
, Qnil
);
7634 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7636 /* Save the item here to protect it from GC. */
7637 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7639 item_string
= XCAR (item
);
7643 if (STRINGP (item_string
))
7645 /* Old format menu item. */
7646 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7648 /* Maybe help string. */
7649 if (CONSP (item
) && STRINGP (XCAR (item
)))
7651 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7656 /* Maybe an obsolete key binding cache. */
7657 if (CONSP (item
) && CONSP (XCAR (item
))
7658 && (NILP (XCAR (XCAR (item
)))
7659 || VECTORP (XCAR (XCAR (item
)))))
7662 /* This is the real definition--the function to run. */
7663 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7665 /* Get enable property, if any. */
7668 tem
= Fget (item
, Qmenu_enable
);
7669 if (!NILP (Venable_disabled_menus_and_buttons
))
7670 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7671 else if (!NILP (tem
))
7672 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7675 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7677 /* New format menu item. */
7678 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7679 start
= XCDR (item
);
7682 /* We have a real binding. */
7683 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7685 item
= XCDR (start
);
7686 /* Is there an obsolete cache list with key equivalences. */
7687 if (CONSP (item
) && CONSP (XCAR (item
)))
7690 /* Parse properties. */
7691 while (CONSP (item
) && CONSP (XCDR (item
)))
7696 if (EQ (tem
, QCenable
))
7698 if (!NILP (Venable_disabled_menus_and_buttons
))
7699 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7701 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7703 else if (EQ (tem
, QCvisible
))
7705 /* If got a visible property and that evaluates to nil
7706 then ignore this item. */
7707 tem
= menu_item_eval_property (XCAR (item
));
7711 else if (EQ (tem
, QChelp
))
7712 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7713 else if (EQ (tem
, QCfilter
))
7715 else if (EQ (tem
, QCkey_sequence
))
7718 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7719 /* Be GC protected. Set keyhint to item instead of tem. */
7722 else if (EQ (tem
, QCkeys
))
7725 if (CONSP (tem
) || STRINGP (tem
))
7726 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7728 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7733 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7735 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7737 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7743 else if (inmenubar
|| !NILP (start
))
7747 return 0; /* not a menu item */
7749 /* If item string is not a string, evaluate it to get string.
7750 If we don't get a string, skip this item. */
7751 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7752 if (!(STRINGP (item_string
)))
7754 item_string
= menu_item_eval_property (item_string
);
7755 if (!STRINGP (item_string
))
7757 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7760 /* If got a filter apply it on definition. */
7761 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7764 def
= menu_item_eval_property (list2 (XCAR (filter
),
7765 list2 (Qquote
, def
)));
7767 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7770 /* Enable or disable selection of item. */
7771 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7774 tem
= menu_item_eval_property (tem
);
7775 if (inmenubar
&& NILP (tem
))
7776 return 0; /* Ignore disabled items in menu bar. */
7777 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7780 /* If we got no definition, this item is just unselectable text which
7781 is OK in a submenu but not in the menubar. */
7783 return (!inmenubar
);
7785 /* See if this is a separate pane or a submenu. */
7786 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7787 tem
= get_keymap (def
, 0, 1);
7788 /* For a subkeymap, just record its details and exit. */
7791 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7792 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7796 /* At the top level in the menu bar, do likewise for commands also.
7797 The menu bar does not display equivalent key bindings anyway.
7798 ITEM_PROPERTY_DEF is already set up properly. */
7802 { /* This is a command. See if there is an equivalent key binding. */
7803 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7805 /* The previous code preferred :key-sequence to :keys, so we
7806 preserve this behavior. */
7807 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7808 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7811 Lisp_Object prefix
= keyeq
;
7812 Lisp_Object keys
= Qnil
;
7816 def
= XCAR (prefix
);
7817 prefix
= XCDR (prefix
);
7820 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7822 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7824 keys
= XCAR (keyhint
);
7825 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7827 /* We have a suggested key. Is it bound to the command? */
7830 /* If the command is an alias for another
7831 (such as lmenu.el set it up), check if the
7832 original command matches the cached command. */
7834 && EQ (tem
, XSYMBOL (def
)->function
))))
7839 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7843 tem
= Fkey_description (keys
, Qnil
);
7846 if (STRINGP (XCAR (prefix
)))
7847 tem
= concat2 (XCAR (prefix
), tem
);
7848 if (STRINGP (XCDR (prefix
)))
7849 tem
= concat2 (tem
, XCDR (prefix
));
7851 keyeq
= concat2 (build_string (" "), tem
);
7852 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7858 /* If we have an equivalent key binding, use that. */
7859 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7862 /* Include this when menu help is implemented.
7863 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7864 if (!(NILP (tem) || STRINGP (tem)))
7866 tem = menu_item_eval_property (tem);
7869 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7873 /* Handle radio buttons or toggle boxes. */
7874 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7876 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7877 menu_item_eval_property (tem
));
7884 /***********************************************************************
7886 ***********************************************************************/
7888 /* A vector holding tool bar items while they are parsed in function
7889 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7892 static Lisp_Object tool_bar_items_vector
;
7894 /* A vector holding the result of parse_tool_bar_item. Layout is like
7895 the one for a single item in tool_bar_items_vector. */
7897 static Lisp_Object tool_bar_item_properties
;
7899 /* Next free index in tool_bar_items_vector. */
7901 static int ntool_bar_items
;
7903 /* The symbols `:image' and `:rtl'. */
7905 static Lisp_Object QCimage
;
7906 static Lisp_Object QCrtl
;
7908 /* Function prototypes. */
7910 static void init_tool_bar_items (Lisp_Object
);
7911 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
,
7913 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7914 static void append_tool_bar_item (void);
7917 /* Return a vector of tool bar items for keymaps currently in effect.
7918 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7919 tool bar items found. */
7922 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7931 /* In order to build the menus, we need to call the keymap
7932 accessors. They all call QUIT. But this function is called
7933 during redisplay, during which a quit is fatal. So inhibit
7934 quitting while building the menus. We do this instead of
7935 specbind because (1) errors will clear it anyway and (2) this
7936 avoids risk of specpdl overflow. */
7937 oquit
= Vinhibit_quit
;
7940 /* Initialize tool_bar_items_vector and protect it from GC. */
7941 init_tool_bar_items (reuse
);
7943 /* Build list of keymaps in maps. Set nmaps to the number of maps
7946 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7947 if (!NILP (Voverriding_local_map_menu_flag
)
7948 && !NILP (Voverriding_local_map
))
7950 /* Yes, use them (if non-nil) as well as the global map. */
7951 maps
= alloca (3 * sizeof *maps
);
7953 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7954 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7955 if (!NILP (Voverriding_local_map
))
7956 maps
[nmaps
++] = Voverriding_local_map
;
7960 /* No, so use major and minor mode keymaps and keymap property.
7961 Note that tool-bar bindings in the local-map and keymap
7962 properties may not work reliable, as they are only
7963 recognized when the tool-bar (or mode-line) is updated,
7964 which does not normally happen after every command. */
7967 nminor
= current_minor_maps (NULL
, &tmaps
);
7968 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7970 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7971 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7972 maps
[nmaps
++] = tem
;
7973 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7974 maps
[nmaps
++] = tem
;
7975 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7977 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7980 /* Add global keymap at the end. */
7981 maps
[nmaps
++] = current_global_map
;
7983 /* Process maps in reverse order and look up in each map the prefix
7985 for (i
= nmaps
- 1; i
>= 0; --i
)
7986 if (!NILP (maps
[i
]))
7990 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7992 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7995 Vinhibit_quit
= oquit
;
7996 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7997 return tool_bar_items_vector
;
8001 /* Process the definition of KEY which is DEF. */
8004 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8007 struct gcpro gcpro1
, gcpro2
;
8009 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8013 if (EQ (def
, Qundefined
))
8015 /* If a map has an explicit `undefined' as definition,
8016 discard any previously made item. */
8017 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8019 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8021 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8023 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8024 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8025 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8027 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8032 else if (parse_tool_bar_item (key
, def
))
8033 /* Append a new tool bar item to tool_bar_items_vector. Accept
8034 more than one definition for the same key. */
8035 append_tool_bar_item ();
8040 /* Access slot with index IDX of vector tool_bar_item_properties. */
8041 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8043 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8045 ASET (tool_bar_item_properties
, idx
, val
);
8049 /* Parse a tool bar item specification ITEM for key KEY and return the
8050 result in tool_bar_item_properties. Value is false if ITEM is
8053 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8055 CAPTION is the caption of the item, If it's not a string, it is
8056 evaluated to get a string.
8058 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8059 as binding are currently ignored.
8061 The following properties are recognized:
8065 FORM is evaluated and specifies whether the tool bar item is
8066 enabled or disabled.
8070 FORM is evaluated and specifies whether the tool bar item is visible.
8072 - `:filter FUNCTION'
8074 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8075 result is stored as the new binding.
8077 - `:button (TYPE SELECTED)'
8079 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8080 and specifies whether the button is selected (pressed) or not.
8084 IMAGES is either a single image specification or a vector of four
8085 image specifications. See enum tool_bar_item_images.
8087 - `:help HELP-STRING'.
8089 Gives a help string to display for the tool bar item.
8091 - `:label LABEL-STRING'.
8093 A text label to show with the tool bar button if labels are enabled. */
8096 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8098 Lisp_Object filter
= Qnil
;
8099 Lisp_Object caption
;
8101 bool have_label
= 0;
8103 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8104 Rule out items that aren't lists, don't start with
8105 `menu-item' or whose rest following `tool-bar-item' is not a
8110 /* As an exception, allow old-style menu separators. */
8111 if (STRINGP (XCAR (item
)))
8112 item
= list1 (XCAR (item
));
8113 else if (!EQ (XCAR (item
), Qmenu_item
)
8114 || (item
= XCDR (item
), !CONSP (item
)))
8117 /* Create tool_bar_item_properties vector if necessary. Reset it to
8119 if (VECTORP (tool_bar_item_properties
))
8121 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8125 tool_bar_item_properties
8126 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8129 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8130 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8132 /* Get the caption of the item. If the caption is not a string,
8133 evaluate it to get a string. If we don't get a string, skip this
8135 caption
= XCAR (item
);
8136 if (!STRINGP (caption
))
8138 caption
= menu_item_eval_property (caption
);
8139 if (!STRINGP (caption
))
8142 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8144 /* If the rest following the caption is not a list, the menu item is
8145 either a separator, or invalid. */
8149 if (menu_separator_name_p (SSDATA (caption
)))
8151 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8152 #if !defined (USE_GTK) && !defined (HAVE_NS)
8153 /* If we use build_desired_tool_bar_string to render the
8154 tool bar, the separator is rendered as an image. */
8155 set_prop (TOOL_BAR_ITEM_IMAGES
,
8156 (menu_item_eval_property
8157 (Vtool_bar_separator_image_expression
)));
8158 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8159 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8160 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8167 /* Store the binding. */
8168 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8171 /* Ignore cached key binding, if any. */
8172 if (CONSP (item
) && CONSP (XCAR (item
)))
8175 /* Process the rest of the properties. */
8176 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8178 Lisp_Object ikey
, value
;
8181 value
= XCAR (XCDR (item
));
8183 if (EQ (ikey
, QCenable
))
8185 /* `:enable FORM'. */
8186 if (!NILP (Venable_disabled_menus_and_buttons
))
8187 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8189 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8191 else if (EQ (ikey
, QCvisible
))
8193 /* `:visible FORM'. If got a visible property and that
8194 evaluates to nil then ignore this item. */
8195 if (NILP (menu_item_eval_property (value
)))
8198 else if (EQ (ikey
, QChelp
))
8199 /* `:help HELP-STRING'. */
8200 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8201 else if (EQ (ikey
, QCvert_only
))
8202 /* `:vert-only t/nil'. */
8203 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8204 else if (EQ (ikey
, QClabel
))
8206 const char *bad_label
= "!!?GARBLED ITEM?!!";
8207 /* `:label LABEL-STRING'. */
8208 set_prop (TOOL_BAR_ITEM_LABEL
,
8209 STRINGP (value
) ? value
: build_string (bad_label
));
8212 else if (EQ (ikey
, QCfilter
))
8213 /* ':filter FORM'. */
8215 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8217 /* `:button (TYPE . SELECTED)'. */
8218 Lisp_Object type
, selected
;
8220 type
= XCAR (value
);
8221 selected
= XCDR (value
);
8222 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8224 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8225 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8228 else if (EQ (ikey
, QCimage
)
8230 || (VECTORP (value
) && ASIZE (value
) == 4)))
8231 /* Value is either a single image specification or a vector
8232 of 4 such specifications for the different button states. */
8233 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8234 else if (EQ (ikey
, QCrtl
))
8236 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8242 /* Try to make one from caption and key. */
8243 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8244 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8245 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8246 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8248 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8249 char *buf
= xmalloc (max_lbl
+ 1);
8250 Lisp_Object new_lbl
;
8251 ptrdiff_t caption_len
= strlen (capt
);
8253 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8256 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8258 buf
[caption_len
] = '\0';
8262 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8266 strcpy (buf
, label
);
8268 for (j
= 0; buf
[j
] != '\0'; ++j
)
8276 new_lbl
= Fupcase_initials (build_string (label
));
8277 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8278 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8280 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8284 /* If got a filter apply it on binding. */
8286 set_prop (TOOL_BAR_ITEM_BINDING
,
8287 (menu_item_eval_property
8290 PROP (TOOL_BAR_ITEM_BINDING
))))));
8292 /* See if the binding is a keymap. Give up if it is. */
8293 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8296 /* Enable or disable selection of item. */
8297 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8298 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8299 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8301 /* Handle radio buttons or toggle boxes. */
8302 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8303 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8304 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8312 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8313 that can be reused. */
8316 init_tool_bar_items (Lisp_Object reuse
)
8318 if (VECTORP (reuse
))
8319 tool_bar_items_vector
= reuse
;
8321 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8322 ntool_bar_items
= 0;
8326 /* Append parsed tool bar item properties from
8327 tool_bar_item_properties */
8330 append_tool_bar_item (void)
8334 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8336 /* Enlarge tool_bar_items_vector if necessary. */
8338 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8340 /* Append entries from tool_bar_item_properties to the end of
8341 tool_bar_items_vector. */
8342 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8343 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8344 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8351 /* Read a character using menus based on the keymap MAP.
8352 Return nil if there are no menus in the maps.
8353 Return t if we displayed a menu but the user rejected it.
8355 PREV_EVENT is the previous input event, or nil if we are reading
8356 the first event of a key sequence.
8358 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8359 if we used a mouse menu to read the input, or false otherwise. If
8360 USED_MOUSE_MENU is null, don't dereference it.
8362 The prompting is done based on the prompt-string of the map
8363 and the strings associated with various map elements.
8365 This can be done with X menus or with menus put in the minibuf.
8366 These are done in different ways, depending on how the input will be read.
8367 Menus using X are done after auto-saving in read-char, getting the input
8368 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8369 and do auto-saving in the inner call of read_char. */
8372 read_char_x_menu_prompt (Lisp_Object map
,
8373 Lisp_Object prev_event
, bool *used_mouse_menu
)
8375 if (used_mouse_menu
)
8376 *used_mouse_menu
= 0;
8378 /* Use local over global Menu maps. */
8380 if (! menu_prompting
)
8383 /* If we got to this point via a mouse click,
8384 use a real menu for mouse selection. */
8385 if (EVENT_HAS_PARAMETERS (prev_event
)
8386 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8387 && !EQ (XCAR (prev_event
), Qtool_bar
))
8389 /* Display the menu and get the selection. */
8392 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8397 record_menu_key (XCAR (value
));
8399 /* If we got multiple events, unread all but
8401 There is no way to prevent those unread events
8402 from showing up later in last_nonmenu_event.
8403 So turn symbol and integer events into lists,
8404 to indicate that they came from a mouse menu,
8405 so that when present in last_nonmenu_event
8406 they won't confuse things. */
8407 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8409 record_menu_key (XCAR (tem
));
8410 if (SYMBOLP (XCAR (tem
))
8411 || INTEGERP (XCAR (tem
)))
8412 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8415 /* If we got more than one event, put all but the first
8416 onto this list to be read later.
8417 Return just the first event now. */
8418 Vunread_command_events
8419 = nconc2 (XCDR (value
), Vunread_command_events
);
8420 value
= XCAR (value
);
8422 else if (NILP (value
))
8424 if (used_mouse_menu
)
8425 *used_mouse_menu
= 1;
8432 read_char_minibuf_menu_prompt (int commandflag
,
8435 register Lisp_Object name
;
8437 /* FIXME: Use the minibuffer's frame width. */
8438 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8440 bool nobindings
= 1;
8441 Lisp_Object rest
, vector
;
8442 Lisp_Object prompt_strings
= Qnil
;
8446 if (! menu_prompting
)
8449 map
= get_keymap (map
, 0, 1);
8450 name
= Fkeymap_prompt (map
);
8452 /* If we don't have any menus, just read a character normally. */
8453 if (!STRINGP (name
))
8456 #define PUSH_C_STR(str, listvar) \
8457 listvar = Fcons (build_unibyte_string (str), listvar)
8459 /* Prompt string always starts with map's prompt, and a space. */
8460 prompt_strings
= Fcons (name
, prompt_strings
);
8461 PUSH_C_STR (": ", prompt_strings
);
8462 nlength
= SCHARS (name
) + 2;
8466 /* Present the documented bindings, a line at a time. */
8470 Lisp_Object menu_strings
= prompt_strings
;
8471 ptrdiff_t i
= nlength
;
8473 Lisp_Object orig_defn_macro
;
8475 /* Loop over elements of map. */
8480 /* FIXME: Use map_keymap to handle new keymap formats. */
8482 /* At end of map, wrap around if just starting,
8483 or end this line if already have something on it. */
8486 if (notfirst
|| nobindings
)
8492 /* Look at the next element of the map. */
8494 elt
= AREF (vector
, idx
);
8496 elt
= Fcar_safe (rest
);
8498 if (idx
< 0 && VECTORP (elt
))
8500 /* If we found a dense table in the keymap,
8501 advanced past it, but start scanning its contents. */
8502 rest
= Fcdr_safe (rest
);
8508 /* An ordinary element. */
8509 Lisp_Object event
, tem
;
8513 event
= Fcar_safe (elt
); /* alist */
8514 elt
= Fcdr_safe (elt
);
8518 XSETINT (event
, idx
); /* vector */
8521 /* Ignore the element if it has no prompt string. */
8522 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8524 /* True if the char to type matches the string. */
8526 Lisp_Object upcased_event
, downcased_event
;
8527 Lisp_Object desc
= Qnil
;
8529 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8531 upcased_event
= Fupcase (event
);
8532 downcased_event
= Fdowncase (event
);
8533 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8534 || XINT (downcased_event
) == SREF (s
, 0));
8536 desc
= Fsingle_key_description (event
, Qnil
);
8538 #if 0 /* It is redundant to list the equivalent key bindings because
8539 the prefix is what the user has already typed. */
8541 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8543 /* Insert equivalent keybinding. */
8544 s
= concat2 (s
, tem
);
8547 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8548 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8550 /* Insert button prefix. */
8551 Lisp_Object selected
8552 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8553 if (EQ (tem
, QCradio
))
8554 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8556 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8557 s
= concat2 (tem
, s
);
8561 /* If we have room for the prompt string, add it to this line.
8562 If this is the first on the line, always add it. */
8563 if ((SCHARS (s
) + i
+ 2
8564 + (char_matches
? 0 : SCHARS (desc
) + 3))
8568 ptrdiff_t thiswidth
;
8570 /* Punctuate between strings. */
8573 PUSH_C_STR (", ", menu_strings
);
8579 /* If the char to type doesn't match the string's
8580 first char, explicitly show what char to type. */
8583 /* Add as much of string as fits. */
8584 thiswidth
= min (SCHARS (desc
), width
- i
);
8586 = Fcons (Fsubstring (desc
, make_number (0),
8587 make_number (thiswidth
)),
8590 PUSH_C_STR (" = ", menu_strings
);
8594 /* Add as much of string as fits. */
8595 thiswidth
= min (SCHARS (s
), width
- i
);
8597 = Fcons (Fsubstring (s
, make_number (0),
8598 make_number (thiswidth
)),
8604 /* If this element does not fit, end the line now,
8605 and save the element for the next line. */
8606 PUSH_C_STR ("...", menu_strings
);
8611 /* Move past this element. */
8612 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8613 /* Handle reaching end of dense table. */
8618 rest
= Fcdr_safe (rest
);
8622 /* Prompt with that and read response. */
8623 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8625 /* Make believe it's not a keyboard macro in case the help char
8626 is pressed. Help characters are not recorded because menu prompting
8627 is not used on replay. */
8628 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8629 kset_defining_kbd_macro (current_kboard
, Qnil
);
8631 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8632 while (BUFFERP (obj
));
8633 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8635 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8638 if (! EQ (obj
, menu_prompt_more_char
)
8639 && (!INTEGERP (menu_prompt_more_char
)
8640 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8642 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8643 store_kbd_macro_char (obj
);
8646 /* Help char - go round again. */
8650 /* Reading key sequences. */
8653 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8655 return access_keymap (get_keymap (keymap
, 0, 1),
8660 active_maps (Lisp_Object first_event
)
8662 Lisp_Object position
8663 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8664 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8667 /* Structure used to keep track of partial application of key remapping
8668 such as Vfunction_key_map and Vkey_translation_map. */
8669 typedef struct keyremap
8671 /* This is the map originally specified for this use. */
8673 /* This is a submap reached by looking up, in PARENT,
8674 the events from START to END. */
8676 /* Positions [START, END) in the key sequence buffer
8677 are the key that we have scanned so far.
8678 Those events are the ones that we will replace
8679 if PARENT maps them into a key sequence. */
8683 /* Lookup KEY in MAP.
8684 MAP is a keymap mapping keys to key vectors or functions.
8685 If the mapping is a function and DO_FUNCALL is true,
8686 the function is called with PROMPT as parameter and its return
8687 value is used as the return value of this function (after checking
8688 that it is indeed a vector). */
8691 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8696 next
= access_keymap (map
, key
, 1, 0, 1);
8698 /* Handle a symbol whose function definition is a keymap
8700 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8701 && (ARRAYP (XSYMBOL (next
)->function
)
8702 || KEYMAPP (XSYMBOL (next
)->function
)))
8703 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8705 /* If the keymap gives a function, not an
8706 array, then call the function with one arg and use
8707 its value instead. */
8708 if (do_funcall
&& FUNCTIONP (next
))
8713 next
= call1 (next
, prompt
);
8714 /* If the function returned something invalid,
8715 barf--don't ignore it.
8716 (To ignore it safely, we would need to gcpro a bunch of
8717 other variables.) */
8718 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8719 error ("Function %s returns invalid key sequence",
8720 SSDATA (SYMBOL_NAME (tem
)));
8725 /* Do one step of the key remapping used for function-key-map and
8726 key-translation-map:
8727 KEYBUF is the buffer holding the input events.
8728 BUFSIZE is its maximum size.
8729 FKEY is a pointer to the keyremap structure to use.
8730 INPUT is the index of the last element in KEYBUF.
8731 DOIT if true says that the remapping can actually take place.
8732 DIFF is used to return the number of keys added/removed by the remapping.
8733 PARENT is the root of the keymap.
8734 PROMPT is the prompt to use if the remapping happens through a function.
8735 Return true if the remapping actually took place. */
8738 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8739 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8741 Lisp_Object next
, key
;
8743 key
= keybuf
[fkey
->end
++];
8745 if (KEYMAPP (fkey
->parent
))
8746 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8750 /* If keybuf[fkey->start..fkey->end] is bound in the
8751 map and we're in a position to do the key remapping, replace it with
8752 the binding and restart with fkey->start at the end. */
8753 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8755 int len
= XFASTINT (Flength (next
));
8758 *diff
= len
- (fkey
->end
- fkey
->start
);
8760 if (bufsize
- input
<= *diff
)
8761 error ("Key sequence too long");
8763 /* Shift the keys that follow fkey->end. */
8765 for (i
= fkey
->end
; i
< input
; i
++)
8766 keybuf
[i
+ *diff
] = keybuf
[i
];
8768 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8769 keybuf
[i
+ *diff
] = keybuf
[i
];
8770 /* Overwrite the old keys with the new ones. */
8771 for (i
= 0; i
< len
; i
++)
8772 keybuf
[fkey
->start
+ i
]
8773 = Faref (next
, make_number (i
));
8775 fkey
->start
= fkey
->end
+= *diff
;
8776 fkey
->map
= fkey
->parent
;
8781 fkey
->map
= get_keymap (next
, 0, 1);
8783 /* If we no longer have a bound suffix, try a new position for
8785 if (!CONSP (fkey
->map
))
8787 fkey
->end
= ++fkey
->start
;
8788 fkey
->map
= fkey
->parent
;
8794 test_undefined (Lisp_Object binding
)
8796 return (NILP (binding
)
8797 || EQ (binding
, Qundefined
)
8798 || (SYMBOLP (binding
)
8799 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8802 /* Read a sequence of keys that ends with a non prefix character,
8803 storing it in KEYBUF, a buffer of size BUFSIZE.
8805 Return the length of the key sequence stored.
8806 Return -1 if the user rejected a command menu.
8808 Echo starting immediately unless `prompt' is 0.
8810 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8811 read_char with a suitable COMMANDFLAG argument.
8813 Where a key sequence ends depends on the currently active keymaps.
8814 These include any minor mode keymaps active in the current buffer,
8815 the current buffer's local map, and the global map.
8817 If a key sequence has no other bindings, we check Vfunction_key_map
8818 to see if some trailing subsequence might be the beginning of a
8819 function key's sequence. If so, we try to read the whole function
8820 key, and substitute its symbolic name into the key sequence.
8822 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8823 `double-' events into similar click events, if that would make them
8824 bound. We try to turn `triple-' events first into `double-' events,
8827 If we get a mouse click in a mode line, vertical divider, or other
8828 non-text area, we treat the click as if it were prefixed by the
8829 symbol denoting that area - `mode-line', `vertical-line', or
8832 If the sequence starts with a mouse click, we read the key sequence
8833 with respect to the buffer clicked on, not the current buffer.
8835 If the user switches frames in the midst of a key sequence, we put
8836 off the switch-frame event until later; the next call to
8837 read_char will return it.
8839 If FIX_CURRENT_BUFFER, we restore current_buffer
8840 from the selected window's buffer. */
8843 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8844 bool dont_downcase_last
, bool can_return_switch_frame
,
8845 bool fix_current_buffer
, bool prevent_redisplay
)
8847 ptrdiff_t count
= SPECPDL_INDEX ();
8849 /* How many keys there are in the current key sequence. */
8852 /* The length of the echo buffer when we started reading, and
8853 the length of this_command_keys when we started reading. */
8854 ptrdiff_t echo_start
IF_LINT (= 0);
8855 ptrdiff_t keys_start
;
8857 Lisp_Object current_binding
= Qnil
;
8858 Lisp_Object first_event
= Qnil
;
8860 /* Index of the first key that has no binding.
8861 It is useless to try fkey.start larger than that. */
8864 /* If t < mock_input, then KEYBUF[t] should be read as the next
8867 We use this to recover after recognizing a function key. Once we
8868 realize that a suffix of the current key sequence is actually a
8869 function key's escape sequence, we replace the suffix with the
8870 function key's binding from Vfunction_key_map. Now keybuf
8871 contains a new and different key sequence, so the echo area,
8872 this_command_keys, and the submaps and defs arrays are wrong. In
8873 this situation, we set mock_input to t, set t to 0, and jump to
8874 restart_sequence; the loop will read keys from keybuf up until
8875 mock_input, thus rebuilding the state; and then it will resume
8876 reading characters from the keyboard. */
8879 /* If the sequence is unbound in submaps[], then
8880 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8881 and fkey.map is its binding.
8883 These might be > t, indicating that all function key scanning
8884 should hold off until t reaches them. We do this when we've just
8885 recognized a function key, to avoid searching for the function
8886 key's again in Vfunction_key_map. */
8889 /* Likewise, for key_translation_map and input-decode-map. */
8890 keyremap keytran
, indec
;
8892 /* True if we are trying to map a key by changing an upper-case
8893 letter to lower case, or a shifted function key to an unshifted
8895 bool shift_translated
= 0;
8897 /* If we receive a `switch-frame' or `select-window' event in the middle of
8898 a key sequence, we put it off for later.
8899 While we're reading, we keep the event here. */
8900 Lisp_Object delayed_switch_frame
;
8902 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8903 int original_uppercase_position
= -1;
8905 /* Gets around Microsoft compiler limitations. */
8908 struct buffer
*starting_buffer
;
8910 /* List of events for which a fake prefix key has been generated. */
8911 Lisp_Object fake_prefixed_keys
= Qnil
;
8913 struct gcpro gcpro1
;
8915 GCPRO1 (fake_prefixed_keys
);
8916 raw_keybuf_count
= 0;
8918 last_nonmenu_event
= Qnil
;
8920 delayed_switch_frame
= Qnil
;
8926 /* Install the string PROMPT as the beginning of the string
8927 of echoing, so that it serves as a prompt for the next
8929 kset_echo_string (current_kboard
, prompt
);
8930 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8933 else if (cursor_in_echo_area
8934 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8935 && NILP (Fzerop (Vecho_keystrokes
)))
8936 /* This doesn't put in a dash if the echo buffer is empty, so
8937 you don't always see a dash hanging out in the minibuffer. */
8941 /* Record the initial state of the echo area and this_command_keys;
8942 we will need to restore them if we replay a key sequence. */
8944 echo_start
= echo_length ();
8945 keys_start
= this_command_key_count
;
8946 this_single_command_key_start
= keys_start
;
8948 /* We jump here when we need to reinitialize fkey and keytran; this
8949 happens if we switch keyboards between rescans. */
8950 replay_entire_sequence
:
8952 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8953 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8954 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8955 indec
.start
= indec
.end
= 0;
8956 fkey
.start
= fkey
.end
= 0;
8957 keytran
.start
= keytran
.end
= 0;
8959 /* We jump here when the key sequence has been thoroughly changed, and
8960 we need to rescan it starting from the beginning. When we jump here,
8961 keybuf[0..mock_input] holds the sequence we should reread. */
8964 starting_buffer
= current_buffer
;
8965 first_unbound
= bufsize
+ 1;
8967 /* Build our list of keymaps.
8968 If we recognize a function key and replace its escape sequence in
8969 keybuf with its symbol, or if the sequence starts with a mouse
8970 click and we need to switch buffers, we jump back here to rebuild
8971 the initial keymaps from the current buffer. */
8972 current_binding
= active_maps (first_event
);
8974 /* Start from the beginning in keybuf. */
8977 /* These are no-ops the first time through, but if we restart, they
8978 revert the echo area and this_command_keys to their original state. */
8979 this_command_key_count
= keys_start
;
8980 if (INTERACTIVE
&& t
< mock_input
)
8981 echo_truncate (echo_start
);
8983 /* If the best binding for the current key sequence is a keymap, or
8984 we may be looking at a function key's escape sequence, keep on
8986 while (!NILP (current_binding
)
8987 /* Keep reading as long as there's a prefix binding. */
8988 ? KEYMAPP (current_binding
)
8989 /* Don't return in the middle of a possible function key sequence,
8990 if the only bindings we found were via case conversion.
8991 Thus, if ESC O a has a function-key-map translation
8992 and ESC o has a binding, don't return after ESC O,
8993 so that we can translate ESC O plus the next character. */
8994 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8997 bool used_mouse_menu
= 0;
8999 /* Where the last real key started. If we need to throw away a
9000 key that has expanded into more than one element of keybuf
9001 (say, a mouse click on the mode line which is being treated
9002 as [mode-line (mouse-...)], then we backtrack to this point
9004 int last_real_key_start
;
9006 /* These variables are analogous to echo_start and keys_start;
9007 while those allow us to restart the entire key sequence,
9008 echo_local_start and keys_local_start allow us to throw away
9010 ptrdiff_t echo_local_start
IF_LINT (= 0);
9011 int keys_local_start
;
9012 Lisp_Object new_binding
;
9014 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9015 eassert (indec
.start
<= indec
.end
);
9016 eassert (fkey
.start
<= fkey
.end
);
9017 eassert (keytran
.start
<= keytran
.end
);
9018 /* key-translation-map is applied *after* function-key-map
9019 which is itself applied *after* input-decode-map. */
9020 eassert (fkey
.end
<= indec
.start
);
9021 eassert (keytran
.end
<= fkey
.start
);
9023 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9024 first_unbound
< keytran
.start
)
9025 { /* The prefix upto first_unbound has no binding and has
9026 no translation left to do either, so we know it's unbound.
9027 If we don't stop now, we risk staying here indefinitely
9028 (if the user keeps entering fkey or keytran prefixes
9029 like C-c ESC ESC ESC ESC ...) */
9031 for (i
= first_unbound
+ 1; i
< t
; i
++)
9032 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9033 mock_input
= t
- first_unbound
- 1;
9034 indec
.end
= indec
.start
-= first_unbound
+ 1;
9035 indec
.map
= indec
.parent
;
9036 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9037 fkey
.map
= fkey
.parent
;
9038 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9039 keytran
.map
= keytran
.parent
;
9040 goto replay_sequence
;
9044 error ("Key sequence too long");
9047 echo_local_start
= echo_length ();
9048 keys_local_start
= this_command_key_count
;
9051 /* These are no-ops, unless we throw away a keystroke below and
9052 jumped back up to replay_key; in that case, these restore the
9053 variables to their original state, allowing us to replay the
9055 if (INTERACTIVE
&& t
< mock_input
)
9056 echo_truncate (echo_local_start
);
9057 this_command_key_count
= keys_local_start
;
9059 /* By default, assume each event is "real". */
9060 last_real_key_start
= t
;
9062 /* Does mock_input indicate that we are re-reading a key sequence? */
9066 add_command_key (key
);
9067 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9068 && NILP (Fzerop (Vecho_keystrokes
))
9069 && current_kboard
->immediate_echo
)
9076 /* If not, we should actually read a character. */
9080 KBOARD
*interrupted_kboard
= current_kboard
;
9081 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9082 /* Calling read_char with COMMANDFLAG = -2 avoids
9083 redisplay in read_char and its subroutines. */
9084 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9085 current_binding
, last_nonmenu_event
,
9086 &used_mouse_menu
, NULL
);
9087 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9088 /* When switching to a new tty (with a new keyboard),
9089 read_char returns the new buffer, rather than -2
9090 (Bug#5095). This is because `terminal-init-xterm'
9091 calls read-char, which eats the wrong_kboard_jmpbuf
9092 return. Any better way to fix this? -- cyd */
9093 || (interrupted_kboard
!= current_kboard
))
9098 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9099 if (k
== interrupted_kboard
)
9104 /* Don't touch interrupted_kboard when it's been
9106 delayed_switch_frame
= Qnil
;
9107 goto replay_entire_sequence
;
9110 if (!NILP (delayed_switch_frame
))
9113 (interrupted_kboard
,
9114 Fcons (delayed_switch_frame
,
9115 KVAR (interrupted_kboard
, kbd_queue
)));
9116 delayed_switch_frame
= Qnil
;
9121 (interrupted_kboard
,
9122 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9124 /* If the side queue is non-empty, ensure it begins with a
9125 switch-frame, so we'll replay it in the right context. */
9126 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9127 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9128 !(EVENT_HAS_PARAMETERS (key
)
9129 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9133 XSETFRAME (frame
, interrupted_frame
);
9135 (interrupted_kboard
,
9136 Fcons (make_lispy_switch_frame (frame
),
9137 KVAR (interrupted_kboard
, kbd_queue
)));
9140 goto replay_entire_sequence
;
9144 /* read_char returns t when it shows a menu and the user rejects it.
9148 unbind_to (count
, Qnil
);
9153 /* read_char returns -1 at the end of a macro.
9154 Emacs 18 handles this by returning immediately with a
9155 zero, so that's what we'll do. */
9156 if (INTEGERP (key
) && XINT (key
) == -1)
9159 /* The Microsoft C compiler can't handle the goto that
9165 /* If the current buffer has been changed from under us, the
9166 keymap may have changed, so replay the sequence. */
9169 timer_resume_idle ();
9172 /* Reset the current buffer from the selected window
9173 in case something changed the former and not the latter.
9174 This is to be more consistent with the behavior
9175 of the command_loop_1. */
9176 if (fix_current_buffer
)
9178 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9180 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9182 Fset_buffer (XWINDOW (selected_window
)->contents
);
9185 goto replay_sequence
;
9188 /* If we have a quit that was typed in another frame, and
9189 quit_throw_to_read_char switched buffers,
9190 replay to get the right keymap. */
9192 && XINT (key
) == quit_char
9193 && current_buffer
!= starting_buffer
)
9196 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9201 goto replay_sequence
;
9206 if (EVENT_HAS_PARAMETERS (key
)
9207 /* Either a `switch-frame' or a `select-window' event. */
9208 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9210 /* If we're at the beginning of a key sequence, and the caller
9211 says it's okay, go ahead and return this event. If we're
9212 in the midst of a key sequence, delay it until the end. */
9213 if (t
> 0 || !can_return_switch_frame
)
9215 delayed_switch_frame
= key
;
9220 if (NILP (first_event
))
9223 /* Even if first_event does not specify a particular
9224 window/position, it's important to recompute the maps here
9225 since a long time might have passed since we entered
9226 read_key_sequence, and a timer (or process-filter or
9227 special-event-map, ...) might have switched the current buffer
9228 or the selected window from under us in the mean time. */
9229 if (fix_current_buffer
9230 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9232 Fset_buffer (XWINDOW (selected_window
)->contents
);
9233 current_binding
= active_maps (first_event
);
9237 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9241 /* Clicks in non-text areas get prefixed by the symbol
9242 in their CHAR-ADDRESS field. For example, a click on
9243 the mode line is prefixed by the symbol `mode-line'.
9245 Furthermore, key sequences beginning with mouse clicks
9246 are read using the keymaps of the buffer clicked on, not
9247 the current buffer. So we may have to switch the buffer
9250 When we turn one event into two events, we must make sure
9251 that neither of the two looks like the original--so that,
9252 if we replay the events, they won't be expanded again.
9253 If not for this, such reexpansion could happen either here
9254 or when user programs play with this-command-keys. */
9255 if (EVENT_HAS_PARAMETERS (key
))
9257 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9258 if (EQ (kind
, Qmouse_click
))
9260 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9261 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9264 || (!NILP (fake_prefixed_keys
)
9265 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9267 /* We're looking a second time at an event for which
9268 we generated a fake prefix key. Set
9269 last_real_key_start appropriately. */
9271 last_real_key_start
= t
- 1;
9274 if (last_real_key_start
== 0)
9276 /* Key sequences beginning with mouse clicks are
9277 read using the keymaps in the buffer clicked on,
9278 not the current buffer. If we're at the
9279 beginning of a key sequence, switch buffers. */
9280 if (WINDOWP (window
)
9281 && BUFFERP (XWINDOW (window
)->contents
)
9282 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9284 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9289 /* Arrange to go back to the original buffer once we're
9290 done reading the key sequence. Note that we can't
9291 use save_excursion_{save,restore} here, because they
9292 save point as well as the current buffer; we don't
9293 want to save point, because redisplay may change it,
9294 to accommodate a Fset_window_start or something. We
9295 don't want to do this at the top of the function,
9296 because we may get input from a subprocess which
9297 wants to change the selected window and stuff (say,
9299 record_unwind_current_buffer ();
9301 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9303 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9304 goto replay_sequence
;
9308 /* Expand mode-line and scroll-bar events into two events:
9309 use posn as a fake prefix key. */
9311 && (NILP (fake_prefixed_keys
)
9312 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9314 if (bufsize
- t
<= 1)
9315 error ("Key sequence too long");
9318 keybuf
[t
+ 1] = key
;
9321 /* Record that a fake prefix key has been generated
9322 for KEY. Don't modify the event; this would
9323 prevent proper action when the event is pushed
9324 back into unread-command-events. */
9325 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9329 else if (CONSP (XCDR (key
))
9330 && CONSP (EVENT_START (key
))
9331 && CONSP (XCDR (EVENT_START (key
))))
9335 posn
= POSN_POSN (EVENT_START (key
));
9336 /* Handle menu-bar events:
9337 insert the dummy prefix event `menu-bar'. */
9338 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9340 if (bufsize
- t
<= 1)
9341 error ("Key sequence too long");
9343 keybuf
[t
+ 1] = key
;
9345 /* Zap the position in key, so we know that we've
9346 expanded it, and don't try to do so again. */
9347 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9350 goto replay_sequence
;
9352 else if (CONSP (posn
))
9354 /* We're looking at the second event of a
9355 sequence which we expanded before. Set
9356 last_real_key_start appropriately. */
9357 if (last_real_key_start
== t
&& t
> 0)
9358 last_real_key_start
= t
- 1;
9363 /* We have finally decided that KEY is something we might want
9365 new_binding
= follow_key (current_binding
, key
);
9367 /* If KEY wasn't bound, we'll try some fallbacks. */
9368 if (!NILP (new_binding
))
9369 /* This is needed for the following scenario:
9370 event 0: a down-event that gets dropped by calling replay_key.
9371 event 1: some normal prefix like C-h.
9372 After event 0, first_unbound is 0, after event 1 indec.start,
9373 fkey.start, and keytran.start are all 1, so when we see that
9374 C-h is bound, we need to update first_unbound. */
9375 first_unbound
= max (t
+ 1, first_unbound
);
9380 /* Remember the position to put an upper bound on indec.start. */
9381 first_unbound
= min (t
, first_unbound
);
9383 head
= EVENT_HEAD (key
);
9384 if (help_char_p (head
) && t
> 0)
9386 read_key_sequence_cmd
= Vprefix_help_command
;
9388 last_nonmenu_event
= key
;
9389 /* The Microsoft C compiler can't handle the goto that
9397 Lisp_Object breakdown
;
9400 breakdown
= parse_modifiers (head
);
9401 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9402 /* Attempt to reduce an unbound mouse event to a simpler
9403 event that is bound:
9404 Drags reduce to clicks.
9405 Double-clicks reduce to clicks.
9406 Triple-clicks reduce to double-clicks, then to clicks.
9407 Down-clicks are eliminated.
9408 Double-downs reduce to downs, then are eliminated.
9409 Triple-downs reduce to double-downs, then to downs,
9410 then are eliminated. */
9411 if (modifiers
& (down_modifier
| drag_modifier
9412 | double_modifier
| triple_modifier
))
9414 while (modifiers
& (down_modifier
| drag_modifier
9415 | double_modifier
| triple_modifier
))
9417 Lisp_Object new_head
, new_click
;
9418 if (modifiers
& triple_modifier
)
9419 modifiers
^= (double_modifier
| triple_modifier
);
9420 else if (modifiers
& double_modifier
)
9421 modifiers
&= ~double_modifier
;
9422 else if (modifiers
& drag_modifier
)
9423 modifiers
&= ~drag_modifier
;
9426 /* Dispose of this `down' event by simply jumping
9427 back to replay_key, to get another event.
9429 Note that if this event came from mock input,
9430 then just jumping back to replay_key will just
9431 hand it to us again. So we have to wipe out any
9434 We could delete keybuf[t] and shift everything
9435 after that to the left by one spot, but we'd also
9436 have to fix up any variable that points into
9437 keybuf, and shifting isn't really necessary
9440 Adding prefixes for non-textual mouse clicks
9441 creates two characters of mock input, and both
9442 must be thrown away. If we're only looking at
9443 the prefix now, we can just jump back to
9444 replay_key. On the other hand, if we've already
9445 processed the prefix, and now the actual click
9446 itself is giving us trouble, then we've lost the
9447 state of the keymaps we want to backtrack to, and
9448 we need to replay the whole sequence to rebuild
9451 Beyond that, only function key expansion could
9452 create more than two keys, but that should never
9453 generate mouse events, so it's okay to zero
9454 mock_input in that case too.
9456 FIXME: The above paragraph seems just plain
9457 wrong, if you consider things like
9458 xterm-mouse-mode. -stef
9460 Isn't this just the most wonderful code ever? */
9462 /* If mock_input > t + 1, the above simplification
9463 will actually end up dropping keys on the floor.
9464 This is probably OK for now, but even
9465 if mock_input <= t + 1, we need to adjust indec,
9467 Typical case [header-line down-mouse-N]:
9468 mock_input = 2, t = 1, fkey.end = 1,
9469 last_real_key_start = 0. */
9470 if (indec
.end
> last_real_key_start
)
9472 indec
.end
= indec
.start
9473 = min (last_real_key_start
, indec
.start
);
9474 indec
.map
= indec
.parent
;
9475 if (fkey
.end
> last_real_key_start
)
9477 fkey
.end
= fkey
.start
9478 = min (last_real_key_start
, fkey
.start
);
9479 fkey
.map
= fkey
.parent
;
9480 if (keytran
.end
> last_real_key_start
)
9482 keytran
.end
= keytran
.start
9483 = min (last_real_key_start
, keytran
.start
);
9484 keytran
.map
= keytran
.parent
;
9488 if (t
== last_real_key_start
)
9495 mock_input
= last_real_key_start
;
9496 goto replay_sequence
;
9501 = apply_modifiers (modifiers
, XCAR (breakdown
));
9502 new_click
= list2 (new_head
, EVENT_START (key
));
9504 /* Look for a binding for this new key. */
9505 new_binding
= follow_key (current_binding
, new_click
);
9507 /* If that click is bound, go for it. */
9508 if (!NILP (new_binding
))
9510 current_binding
= new_binding
;
9514 /* Otherwise, we'll leave key set to the drag event. */
9519 current_binding
= new_binding
;
9522 /* Normally, last_nonmenu_event gets the previous key we read.
9523 But when a mouse popup menu is being used,
9524 we don't update last_nonmenu_event; it continues to hold the mouse
9525 event that preceded the first level of menu. */
9526 if (!used_mouse_menu
)
9527 last_nonmenu_event
= key
;
9529 /* Record what part of this_command_keys is the current key sequence. */
9530 this_single_command_key_start
= this_command_key_count
- t
;
9532 /* Look for this sequence in input-decode-map.
9533 Scan from indec.end until we find a bound suffix. */
9534 while (indec
.end
< t
)
9536 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9540 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9541 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9546 mock_input
= diff
+ max (t
, mock_input
);
9547 goto replay_sequence
;
9551 if (!KEYMAPP (current_binding
)
9552 && !test_undefined (current_binding
)
9553 && indec
.start
>= t
)
9554 /* There is a binding and it's not a prefix.
9555 (and it doesn't have any input-decode-map translation pending).
9556 There is thus no function-key in this sequence.
9557 Moving fkey.start is important in this case to allow keytran.start
9558 to go over the sequence before we return (since we keep the
9559 invariant that keytran.end <= fkey.start). */
9562 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9565 /* If the sequence is unbound, see if we can hang a function key
9566 off the end of it. */
9567 /* Continue scan from fkey.end until we find a bound suffix. */
9568 while (fkey
.end
< indec
.start
)
9570 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9574 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9575 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9576 max (t
, mock_input
),
9577 /* If there's a binding (i.e.
9578 first_binding >= nmaps) we don't want
9579 to apply this function-key-mapping. */
9581 && (test_undefined (current_binding
)),
9586 mock_input
= diff
+ max (t
, mock_input
);
9587 /* Adjust the input-decode-map counters. */
9589 indec
.start
+= diff
;
9591 goto replay_sequence
;
9595 /* Look for this sequence in key-translation-map.
9596 Scan from keytran.end until we find a bound suffix. */
9597 while (keytran
.end
< fkey
.start
)
9599 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9603 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9604 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9609 mock_input
= diff
+ max (t
, mock_input
);
9610 /* Adjust the function-key-map and input-decode-map counters. */
9612 indec
.start
+= diff
;
9616 goto replay_sequence
;
9620 /* If KEY is not defined in any of the keymaps,
9621 and cannot be part of a function key or translation,
9622 and is an upper case letter
9623 use the corresponding lower-case letter instead. */
9624 if (NILP (current_binding
)
9625 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9627 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9628 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9629 || (XINT (key
) & shift_modifier
)))
9631 Lisp_Object new_key
;
9633 original_uppercase
= key
;
9634 original_uppercase_position
= t
- 1;
9636 if (XINT (key
) & shift_modifier
)
9637 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9639 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9640 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9642 /* We have to do this unconditionally, regardless of whether
9643 the lower-case char is defined in the keymaps, because they
9644 might get translated through function-key-map. */
9645 keybuf
[t
- 1] = new_key
;
9646 mock_input
= max (t
, mock_input
);
9647 shift_translated
= 1;
9649 goto replay_sequence
;
9651 /* If KEY is not defined in any of the keymaps,
9652 and cannot be part of a function key or translation,
9653 and is a shifted function key,
9654 use the corresponding unshifted function key instead. */
9655 if (NILP (current_binding
)
9656 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9658 Lisp_Object breakdown
= parse_modifiers (key
);
9660 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9662 if (modifiers
& shift_modifier
9663 /* Treat uppercase keys as shifted. */
9665 && (KEY_TO_CHAR (key
)
9666 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9667 && uppercasep (KEY_TO_CHAR (key
))))
9670 = (modifiers
& shift_modifier
9671 ? apply_modifiers (modifiers
& ~shift_modifier
,
9673 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9675 original_uppercase
= key
;
9676 original_uppercase_position
= t
- 1;
9678 /* We have to do this unconditionally, regardless of whether
9679 the lower-case char is defined in the keymaps, because they
9680 might get translated through function-key-map. */
9681 keybuf
[t
- 1] = new_key
;
9682 mock_input
= max (t
, mock_input
);
9683 /* Reset fkey (and consequently keytran) to apply
9684 function-key-map on the result, so that S-backspace is
9685 correctly mapped to DEL (via backspace). OTOH,
9686 input-decode-map doesn't need to go through it again. */
9687 fkey
.start
= fkey
.end
= 0;
9688 keytran
.start
= keytran
.end
= 0;
9689 shift_translated
= 1;
9691 goto replay_sequence
;
9696 read_key_sequence_cmd
= current_binding
;
9697 read_key_sequence_remapped
9698 /* Remap command through active keymaps.
9699 Do the remapping here, before the unbind_to so it uses the keymaps
9700 of the appropriate buffer. */
9701 = SYMBOLP (read_key_sequence_cmd
)
9702 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9705 unread_switch_frame
= delayed_switch_frame
;
9706 unbind_to (count
, Qnil
);
9708 /* Don't downcase the last character if the caller says don't.
9709 Don't downcase it if the result is undefined, either. */
9710 if ((dont_downcase_last
|| NILP (current_binding
))
9712 && t
- 1 == original_uppercase_position
)
9714 keybuf
[t
- 1] = original_uppercase
;
9715 shift_translated
= 0;
9718 if (shift_translated
)
9719 Vthis_command_keys_shift_translated
= Qt
;
9721 /* Occasionally we fabricate events, perhaps by expanding something
9722 according to function-key-map, or by adding a prefix symbol to a
9723 mouse click in the scroll bar or modeline. In this cases, return
9724 the entire generated key sequence, even if we hit an unbound
9725 prefix or a definition before the end. This means that you will
9726 be able to push back the event properly, and also means that
9727 read-key-sequence will always return a logical unit.
9730 for (; t
< mock_input
; t
++)
9732 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9733 && NILP (Fzerop (Vecho_keystrokes
)))
9734 echo_char (keybuf
[t
]);
9735 add_command_key (keybuf
[t
]);
9743 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9744 Lisp_Object dont_downcase_last
,
9745 Lisp_Object can_return_switch_frame
,
9746 Lisp_Object cmd_loop
, bool allow_string
)
9748 Lisp_Object keybuf
[30];
9750 struct gcpro gcpro1
;
9751 ptrdiff_t count
= SPECPDL_INDEX ();
9754 CHECK_STRING (prompt
);
9757 specbind (Qinput_method_exit_on_first_char
,
9758 (NILP (cmd_loop
) ? Qt
: Qnil
));
9759 specbind (Qinput_method_use_echo_area
,
9760 (NILP (cmd_loop
) ? Qt
: Qnil
));
9762 memset (keybuf
, 0, sizeof keybuf
);
9764 gcpro1
.nvars
= ARRAYELTS (keybuf
);
9766 if (NILP (continue_echo
))
9768 this_command_key_count
= 0;
9769 this_command_key_count_reset
= 0;
9770 this_single_command_key_start
= 0;
9773 #ifdef HAVE_WINDOW_SYSTEM
9774 if (display_hourglass_p
)
9775 cancel_hourglass ();
9778 i
= read_key_sequence (keybuf
, ARRAYELTS (keybuf
),
9779 prompt
, ! NILP (dont_downcase_last
),
9780 ! NILP (can_return_switch_frame
), 0, 0);
9782 #if 0 /* The following is fine for code reading a key sequence and
9783 then proceeding with a lengthy computation, but it's not good
9784 for code reading keys in a loop, like an input method. */
9785 #ifdef HAVE_WINDOW_SYSTEM
9786 if (display_hourglass_p
)
9797 return unbind_to (count
,
9798 ((allow_string
? make_event_array
: Fvector
)
9802 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9803 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9804 The sequence is sufficient to specify a non-prefix command in the
9805 current local and global maps.
9807 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9808 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9809 as a continuation of the previous key.
9811 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9812 convert the last event to lower case. (Normally any upper case event
9813 is converted to lower case if the original event is undefined and the lower
9814 case equivalent is defined.) A non-nil value is appropriate for reading
9815 a key sequence to be defined.
9817 A C-g typed while in this function is treated like any other character,
9818 and `quit-flag' is not set.
9820 If the key sequence starts with a mouse click, then the sequence is read
9821 using the keymaps of the buffer of the window clicked in, not the buffer
9822 of the selected window as normal.
9824 `read-key-sequence' drops unbound button-down events, since you normally
9825 only care about the click or drag events which follow them. If a drag
9826 or multi-click event is unbound, but the corresponding click event would
9827 be bound, `read-key-sequence' turns the event into a click event at the
9828 drag's starting position. This means that you don't have to distinguish
9829 between click and drag, double, or triple events unless you want to.
9831 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9832 lines separating windows, and scroll bars with imaginary keys
9833 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9835 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9836 function will process a switch-frame event if the user switches frames
9837 before typing anything. If the user switches frames in the middle of a
9838 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9839 is nil, then the event will be put off until after the current key sequence.
9841 `read-key-sequence' checks `function-key-map' for function key
9842 sequences, where they wouldn't conflict with ordinary bindings. See
9843 `function-key-map' for more details.
9845 The optional fifth argument CMD-LOOP, if non-nil, means
9846 that this key sequence is being read by something that will
9847 read commands one after another. It should be nil if the caller
9848 will read just one key sequence. */)
9849 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9851 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9852 can_return_switch_frame
, cmd_loop
, true);
9855 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9856 Sread_key_sequence_vector
, 1, 5, 0,
9857 doc
: /* Like `read-key-sequence' but always return a vector. */)
9858 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9860 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9861 can_return_switch_frame
, cmd_loop
, false);
9864 /* Return true if input events are pending. */
9867 detect_input_pending (void)
9869 return input_pending
|| get_input_pending (0);
9872 /* Return true if input events other than mouse movements are
9876 detect_input_pending_ignore_squeezables (void)
9878 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9881 /* Return true if input events are pending, and run any pending timers. */
9884 detect_input_pending_run_timers (bool do_display
)
9886 unsigned old_timers_run
= timers_run
;
9889 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9891 if (old_timers_run
!= timers_run
&& do_display
)
9892 redisplay_preserve_echo_area (8);
9894 return input_pending
;
9897 /* This is called in some cases before a possible quit.
9898 It cases the next call to detect_input_pending to recompute input_pending.
9899 So calling this function unnecessarily can't do any harm. */
9902 clear_input_pending (void)
9907 /* Return true if there are pending requeued events.
9908 This isn't used yet. The hope is to make wait_reading_process_output
9909 call it, and return if it runs Lisp code that unreads something.
9910 The problem is, kbd_buffer_get_event needs to be fixed to know what
9911 to do in that case. It isn't trivial. */
9914 requeued_events_pending_p (void)
9916 return (!NILP (Vunread_command_events
));
9919 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9920 doc
: /* Return t if command input is currently available with no wait.
9921 Actually, the value is nil only if we can be sure that no input is available;
9922 if there is a doubt, the value is t.
9924 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9925 (Lisp_Object check_timers
)
9927 if (!NILP (Vunread_command_events
)
9928 || !NILP (Vunread_post_input_method_events
)
9929 || !NILP (Vunread_input_method_events
))
9932 /* Process non-user-visible events (Bug#10195). */
9933 process_special_events ();
9935 return (get_input_pending ((NILP (check_timers
)
9936 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9937 | READABLE_EVENTS_FILTER_EVENTS
)
9941 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9942 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9945 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9948 if (total_keys
< NUM_RECENT_KEYS
)
9949 return Fvector (total_keys
, keys
);
9952 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9953 vcopy (val
, 0, keys
+ recent_keys_index
,
9954 NUM_RECENT_KEYS
- recent_keys_index
);
9955 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9956 keys
, recent_keys_index
);
9961 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9962 doc
: /* Return the key sequence that invoked this command.
9963 However, if the command has called `read-key-sequence', it returns
9964 the last key sequence that has been read.
9965 The value is a string or a vector.
9967 See also `this-command-keys-vector'. */)
9970 return make_event_array (this_command_key_count
,
9971 XVECTOR (this_command_keys
)->contents
);
9974 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9975 doc
: /* Return the key sequence that invoked this command, as a vector.
9976 However, if the command has called `read-key-sequence', it returns
9977 the last key sequence that has been read.
9979 See also `this-command-keys'. */)
9982 return Fvector (this_command_key_count
,
9983 XVECTOR (this_command_keys
)->contents
);
9986 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9987 Sthis_single_command_keys
, 0, 0, 0,
9988 doc
: /* Return the key sequence that invoked this command.
9989 More generally, it returns the last key sequence read, either by
9990 the command loop or by `read-key-sequence'.
9991 Unlike `this-command-keys', this function's value
9992 does not include prefix arguments.
9993 The value is always a vector. */)
9996 return Fvector (this_command_key_count
9997 - this_single_command_key_start
,
9998 (XVECTOR (this_command_keys
)->contents
9999 + this_single_command_key_start
));
10002 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10003 Sthis_single_command_raw_keys
, 0, 0, 0,
10004 doc
: /* Return the raw events that were read for this command.
10005 More generally, it returns the last key sequence read, either by
10006 the command loop or by `read-key-sequence'.
10007 Unlike `this-single-command-keys', this function's value
10008 shows the events before all translations (except for input methods).
10009 The value is always a vector. */)
10012 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10015 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10016 Sreset_this_command_lengths
, 0, 0, 0,
10017 doc
: /* Make the unread events replace the last command and echo.
10018 Used in `universal-argument-other-key'.
10020 `universal-argument-other-key' rereads the event just typed.
10021 It then gets translated through `function-key-map'.
10022 The translated event has to replace the real events,
10023 both in the value of (this-command-keys) and in echoing.
10024 To achieve this, `universal-argument-other-key' calls
10025 `reset-this-command-lengths', which discards the record of reading
10026 these events the first time. */)
10029 this_command_key_count
= before_command_key_count
;
10030 if (this_command_key_count
< this_single_command_key_start
)
10031 this_single_command_key_start
= this_command_key_count
;
10033 echo_truncate (before_command_echo_length
);
10035 /* Cause whatever we put into unread-command-events
10036 to echo as if it were being freshly read from the keyboard. */
10037 this_command_key_count_reset
= 1;
10042 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10043 Sclear_this_command_keys
, 0, 1, 0,
10044 doc
: /* Clear out the vector that `this-command-keys' returns.
10045 Also clear the record of the last 100 events, unless optional arg
10046 KEEP-RECORD is non-nil. */)
10047 (Lisp_Object keep_record
)
10051 this_command_key_count
= 0;
10052 this_command_key_count_reset
= 0;
10054 if (NILP (keep_record
))
10056 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10057 ASET (recent_keys
, i
, Qnil
);
10059 recent_keys_index
= 0;
10064 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10065 doc
: /* Return the current depth in recursive edits. */)
10069 /* Wrap around reliably on integer overflow. */
10070 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10071 XSETINT (temp
, sum
);
10075 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10076 "FOpen dribble file: ",
10077 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10078 If FILE is nil, close any open dribble file.
10079 The file will be closed when Emacs exits.
10081 Be aware that this records ALL characters you type!
10082 This may include sensitive information such as passwords. */)
10095 Lisp_Object encfile
;
10097 file
= Fexpand_file_name (file
, Qnil
);
10098 encfile
= ENCODE_FILE (file
);
10099 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10100 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10101 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10102 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10104 report_file_error ("Opening dribble", file
);
10109 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10110 doc
: /* Discard the contents of the terminal input buffer.
10111 Also end any kbd macro being defined. */)
10114 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10116 /* Discard the last command from the macro. */
10117 Fcancel_kbd_macro_events ();
10121 Vunread_command_events
= Qnil
;
10123 discard_tty_input ();
10125 kbd_fetch_ptr
= kbd_store_ptr
;
10131 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10132 doc
: /* Stop Emacs and return to superior process. You can resume later.
10133 If `cannot-suspend' is non-nil, or if the system doesn't support job
10134 control, run a subshell instead.
10136 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10137 to be read as terminal input by Emacs's parent, after suspension.
10139 Before suspending, run the normal hook `suspend-hook'.
10140 After resumption run the normal hook `suspend-resume-hook'.
10142 Some operating systems cannot stop the Emacs process and resume it later.
10143 On such systems, Emacs starts a subshell instead of suspending. */)
10144 (Lisp_Object stuffstring
)
10146 ptrdiff_t count
= SPECPDL_INDEX ();
10147 int old_height
, old_width
;
10149 struct gcpro gcpro1
;
10152 if (tty_list
&& tty_list
->next
)
10153 error ("There are other tty frames open; close them before suspending Emacs");
10155 if (!NILP (stuffstring
))
10156 CHECK_STRING (stuffstring
);
10158 /* Run the functions in suspend-hook. */
10159 hook
= intern ("suspend-hook");
10160 Frun_hooks (1, &hook
);
10162 GCPRO1 (stuffstring
);
10163 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10164 reset_all_sys_modes ();
10165 /* sys_suspend can get an error if it tries to fork a subshell
10166 and the system resources aren't available for that. */
10167 record_unwind_protect_void (init_all_sys_modes
);
10168 stuff_buffered_input (stuffstring
);
10169 if (cannot_suspend
)
10173 unbind_to (count
, Qnil
);
10175 /* Check if terminal/window size has changed.
10176 Note that this is not useful when we are running directly
10177 with a window system; but suspend should be disabled in that case. */
10178 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10179 if (width
!= old_width
|| height
!= old_height
)
10180 change_frame_size (SELECTED_FRAME (), width
, height
, 0, 0, 0, 0);
10182 /* Run suspend-resume-hook. */
10183 hook
= intern ("suspend-resume-hook");
10184 Frun_hooks (1, &hook
);
10190 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10191 Then in any case stuff anything Emacs has read ahead and not used. */
10194 stuff_buffered_input (Lisp_Object stuffstring
)
10196 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10197 register unsigned char *p
;
10199 if (STRINGP (stuffstring
))
10201 register ptrdiff_t count
;
10203 p
= SDATA (stuffstring
);
10204 count
= SBYTES (stuffstring
);
10205 while (count
-- > 0)
10210 /* Anything we have read ahead, put back for the shell to read. */
10211 /* ?? What should this do when we have multiple keyboards??
10212 Should we ignore anything that was typed in at the "wrong" kboard?
10214 rms: we should stuff everything back into the kboard
10216 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10219 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10220 kbd_fetch_ptr
= kbd_buffer
;
10221 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10222 stuff_char (kbd_fetch_ptr
->code
);
10224 clear_event (kbd_fetch_ptr
);
10228 #endif /* SIGTSTP */
10232 set_waiting_for_input (struct timespec
*time_to_clear
)
10234 input_available_clear_time
= time_to_clear
;
10236 /* Tell handle_interrupt to throw back to read_char, */
10237 waiting_for_input
= 1;
10239 /* If handle_interrupt was called before and buffered a C-g,
10240 make it run again now, to avoid timing error. */
10241 if (!NILP (Vquit_flag
))
10242 quit_throw_to_read_char (0);
10246 clear_waiting_for_input (void)
10248 /* Tell handle_interrupt not to throw back to read_char, */
10249 waiting_for_input
= 0;
10250 input_available_clear_time
= 0;
10253 /* The SIGINT handler.
10255 If we have a frame on the controlling tty, we assume that the
10256 SIGINT was generated by C-g, so we call handle_interrupt.
10257 Otherwise, tell QUIT to kill Emacs. */
10260 handle_interrupt_signal (int sig
)
10262 /* See if we have an active terminal on our controlling tty. */
10263 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10266 /* If there are no frames there, let's pretend that we are a
10267 well-behaving UN*X program and quit. We must not call Lisp
10268 in a signal handler, so tell QUIT to exit when it is
10270 Vquit_flag
= Qkill_emacs
;
10274 /* Otherwise, the SIGINT was probably generated by C-g. */
10276 /* Set internal_last_event_frame to the top frame of the
10277 controlling tty, if we have a frame there. We disable the
10278 interrupt key on secondary ttys, so the SIGINT must have come
10279 from the controlling tty. */
10280 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10282 handle_interrupt (1);
10287 deliver_interrupt_signal (int sig
)
10289 deliver_process_signal (sig
, handle_interrupt_signal
);
10293 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10294 of the number of times C-g has been requested. If C-g is pressed
10295 enough times, then quit anyway. See bug#6585. */
10296 static int volatile force_quit_count
;
10298 /* This routine is called at interrupt level in response to C-g.
10300 It is called from the SIGINT handler or kbd_buffer_store_event.
10302 If `waiting_for_input' is non zero, then unless `echoing' is
10303 nonzero, immediately throw back to read_char.
10305 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10306 eval to throw, when it gets a chance. If quit-flag is already
10307 non-nil, it stops the job right away. */
10310 handle_interrupt (bool in_signal_handler
)
10314 sigemptyset (&blocked
);
10315 sigaddset (&blocked
, SIGINT
);
10319 /* XXX This code needs to be revised for multi-tty support. */
10320 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10322 if (! in_signal_handler
)
10324 /* If SIGINT isn't blocked, don't let us be interrupted by
10325 a SIGINT. It might be harmful due to non-reentrancy
10326 in I/O functions. */
10327 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10331 reset_all_sys_modes ();
10335 * On systems which can suspend the current process and return to the original
10336 * shell, this command causes the user to end up back at the shell.
10337 * The "Auto-save" and "Abort" questions are not asked until
10338 * the user elects to return to emacs, at which point he can save the current
10339 * job and either dump core or continue.
10343 /* Perhaps should really fork an inferior shell?
10344 But that would not provide any way to get back
10345 to the original shell, ever. */
10346 printf ("No support for stopping a process on this operating system;\n");
10347 printf ("you can continue or abort.\n");
10348 #endif /* not SIGTSTP */
10350 /* We must remain inside the screen area when the internal terminal
10351 is used. Note that [Enter] is not echoed by dos. */
10352 cursor_to (SELECTED_FRAME (), 0, 0);
10354 /* It doesn't work to autosave while GC is in progress;
10355 the code used for auto-saving doesn't cope with the mark bit. */
10356 if (!gc_in_progress
)
10358 printf ("Auto-save? (y or n) ");
10360 if (((c
= getchar ()) & ~040) == 'Y')
10362 Fdo_auto_save (Qt
, Qnil
);
10364 printf ("\r\nAuto-save done");
10365 #else /* not MSDOS */
10366 printf ("Auto-save done\n");
10367 #endif /* not MSDOS */
10369 while (c
!= '\n') c
= getchar ();
10373 /* During GC, it must be safe to reenable quitting again. */
10374 Vinhibit_quit
= Qnil
;
10377 #endif /* not MSDOS */
10378 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10379 printf ("but will instead do a real quit after garbage collection ends\r\n");
10384 printf ("\r\nAbort? (y or n) ");
10385 #else /* not MSDOS */
10386 printf ("Abort (and dump core)? (y or n) ");
10387 #endif /* not MSDOS */
10389 if (((c
= getchar ()) & ~040) == 'Y')
10391 while (c
!= '\n') c
= getchar ();
10393 printf ("\r\nContinuing...\r\n");
10394 #else /* not MSDOS */
10395 printf ("Continuing...\n");
10396 #endif /* not MSDOS */
10398 init_all_sys_modes ();
10402 /* If executing a function that wants to be interrupted out of
10403 and the user has not deferred quitting by binding `inhibit-quit'
10404 then quit right away. */
10405 if (immediate_quit
&& NILP (Vinhibit_quit
))
10407 struct gl_state_s saved
;
10408 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10410 immediate_quit
= 0;
10411 pthread_sigmask (SIG_UNBLOCK
, &blocked
, 0);
10413 GCPRO4 (saved
.object
, saved
.global_code
,
10414 saved
.current_syntax_table
, saved
.old_prop
);
10415 Fsignal (Qquit
, Qnil
);
10420 { /* Else request quit when it's safe. */
10421 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10422 force_quit_count
= count
;
10425 immediate_quit
= 1;
10426 Vinhibit_quit
= Qnil
;
10432 pthread_sigmask (SIG_UNBLOCK
, &blocked
, 0);
10434 /* TODO: The longjmp in this call throws the NS event loop integration off,
10435 and it seems to do fine without this. Probably some attention
10436 needs to be paid to the setting of waiting_for_input in
10437 wait_reading_process_output() under HAVE_NS because of the call
10438 to ns_select there (needed because otherwise events aren't picked up
10439 outside of polling since we don't get SIGIO like X and we don't have a
10440 separate event loop thread like W32. */
10442 if (waiting_for_input
&& !echoing
)
10443 quit_throw_to_read_char (in_signal_handler
);
10447 /* Handle a C-g by making read_char return C-g. */
10450 quit_throw_to_read_char (bool from_signal
)
10452 /* When not called from a signal handler it is safe to call
10454 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10455 Fkill_emacs (Qnil
);
10457 /* Prevent another signal from doing this before we finish. */
10458 clear_waiting_for_input ();
10461 Vunread_command_events
= Qnil
;
10463 if (FRAMEP (internal_last_event_frame
)
10464 && !EQ (internal_last_event_frame
, selected_frame
))
10465 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10468 sys_longjmp (getcjmp
, 1);
10471 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10472 Sset_input_interrupt_mode
, 1, 1, 0,
10473 doc
: /* Set interrupt mode of reading keyboard input.
10474 If INTERRUPT is non-nil, Emacs will use input interrupts;
10475 otherwise Emacs uses CBREAK mode.
10477 See also `current-input-mode'. */)
10478 (Lisp_Object interrupt
)
10480 bool new_interrupt_input
;
10481 #ifdef USABLE_SIGIO
10482 #ifdef HAVE_X_WINDOWS
10483 if (x_display_list
!= NULL
)
10485 /* When using X, don't give the user a real choice,
10486 because we haven't implemented the mechanisms to support it. */
10487 new_interrupt_input
= 1;
10490 #endif /* HAVE_X_WINDOWS */
10491 new_interrupt_input
= !NILP (interrupt
);
10492 #else /* not USABLE_SIGIO */
10493 new_interrupt_input
= 0;
10494 #endif /* not USABLE_SIGIO */
10496 if (new_interrupt_input
!= interrupt_input
)
10498 #ifdef POLL_FOR_INPUT
10502 /* this causes startup screen to be restored and messes with the mouse */
10503 reset_all_sys_modes ();
10504 interrupt_input
= new_interrupt_input
;
10505 init_all_sys_modes ();
10507 interrupt_input
= new_interrupt_input
;
10510 #ifdef POLL_FOR_INPUT
10511 poll_suppress_count
= 1;
10518 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10519 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10520 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10521 C-q in key sequences.
10523 This setting only has an effect on tty terminals and only when
10524 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10526 See also `current-input-mode'. */)
10527 (Lisp_Object flow
, Lisp_Object terminal
)
10529 struct terminal
*t
= get_terminal (terminal
, 1);
10530 struct tty_display_info
*tty
;
10531 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10533 tty
= t
->display_info
.tty
;
10535 if (tty
->flow_control
!= !NILP (flow
))
10538 /* This causes startup screen to be restored and messes with the mouse. */
10539 reset_sys_modes (tty
);
10542 tty
->flow_control
= !NILP (flow
);
10545 init_sys_modes (tty
);
10551 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10552 doc
: /* Enable or disable 8-bit input on TERMINAL.
10553 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10554 bit as the Meta modifier.
10556 If META is nil, Emacs will ignore the top bit, on the assumption it is
10559 Otherwise, Emacs will accept and pass through 8-bit input without
10560 specially interpreting the top bit.
10562 This setting only has an effect on tty terminal devices.
10564 Optional parameter TERMINAL specifies the tty terminal device to use.
10565 It may be a terminal object, a frame, or nil for the terminal used by
10566 the currently selected frame.
10568 See also `current-input-mode'. */)
10569 (Lisp_Object meta
, Lisp_Object terminal
)
10571 struct terminal
*t
= get_terminal (terminal
, 1);
10572 struct tty_display_info
*tty
;
10575 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10577 tty
= t
->display_info
.tty
;
10581 else if (EQ (meta
, Qt
))
10586 if (tty
->meta_key
!= new_meta
)
10589 /* this causes startup screen to be restored and messes with the mouse */
10590 reset_sys_modes (tty
);
10593 tty
->meta_key
= new_meta
;
10596 init_sys_modes (tty
);
10602 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10603 doc
: /* Specify character used for quitting.
10604 QUIT must be an ASCII character.
10606 This function only has an effect on the controlling tty of the Emacs
10609 See also `current-input-mode'. */)
10612 struct terminal
*t
= get_named_tty ("/dev/tty");
10613 struct tty_display_info
*tty
;
10614 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10616 tty
= t
->display_info
.tty
;
10618 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10619 error ("QUIT must be an ASCII character");
10622 /* this causes startup screen to be restored and messes with the mouse */
10623 reset_sys_modes (tty
);
10626 /* Don't let this value be out of range. */
10627 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10630 init_sys_modes (tty
);
10636 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10637 doc
: /* Set mode of reading keyboard input.
10638 First arg INTERRUPT non-nil means use input interrupts;
10639 nil means use CBREAK mode.
10640 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10641 (no effect except in CBREAK mode).
10642 Third arg META t means accept 8-bit input (for a Meta key).
10643 META nil means ignore the top bit, on the assumption it is parity.
10644 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10645 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10646 See also `current-input-mode'. */)
10647 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10649 Fset_input_interrupt_mode (interrupt
);
10650 Fset_output_flow_control (flow
, Qnil
);
10651 Fset_input_meta_mode (meta
, Qnil
);
10653 Fset_quit_char (quit
);
10657 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10658 doc
: /* Return information about the way Emacs currently reads keyboard input.
10659 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10660 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10661 nil, Emacs is using CBREAK mode.
10662 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10663 terminal; this does not apply if Emacs uses interrupt-driven input.
10664 META is t if accepting 8-bit input with 8th bit as Meta flag.
10665 META nil means ignoring the top bit, on the assumption it is parity.
10666 META is neither t nor nil if accepting 8-bit input and using
10667 all 8 bits as the character code.
10668 QUIT is the character Emacs currently uses to quit.
10669 The elements of this list correspond to the arguments of
10670 `set-input-mode'. */)
10673 Lisp_Object val
[4];
10674 struct frame
*sf
= XFRAME (selected_frame
);
10676 val
[0] = interrupt_input
? Qt
: Qnil
;
10677 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10679 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10680 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10682 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10689 XSETFASTINT (val
[3], quit_char
);
10691 return Flist (ARRAYELTS (val
), val
);
10694 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10695 doc
: /* Return position information for pixel coordinates X and Y.
10696 By default, X and Y are relative to text area of the selected window.
10697 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10698 If optional fourth arg WHOLE is non-nil, X is relative to the left
10699 edge of the window.
10701 The return value is similar to a mouse click position:
10702 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10703 IMAGE (DX . DY) (WIDTH . HEIGHT))
10704 The `posn-' functions access elements of such lists. */)
10705 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10710 if (NILP (frame_or_window
))
10711 frame_or_window
= selected_window
;
10713 if (WINDOWP (frame_or_window
))
10715 struct window
*w
= decode_live_window (frame_or_window
);
10717 XSETINT (x
, (XINT (x
)
10718 + WINDOW_LEFT_EDGE_X (w
)
10720 ? window_box_left_offset (w
, TEXT_AREA
)
10722 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10723 frame_or_window
= w
->frame
;
10726 CHECK_LIVE_FRAME (frame_or_window
);
10728 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10731 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10732 doc
: /* Return position information for buffer POS in WINDOW.
10733 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10735 Return nil if position is not visible in window. Otherwise,
10736 the return value is similar to that returned by `event-start' for
10737 a mouse click at the upper left corner of the glyph corresponding
10738 to the given buffer position:
10739 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10740 IMAGE (DX . DY) (WIDTH . HEIGHT))
10741 The `posn-' functions access elements of such lists. */)
10742 (Lisp_Object pos
, Lisp_Object window
)
10747 window
= selected_window
;
10749 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10752 Lisp_Object x
= XCAR (tem
);
10753 Lisp_Object y
= XCAR (XCDR (tem
));
10755 /* Point invisible due to hscrolling? */
10758 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10764 /* Set up a new kboard object with reasonable initial values.
10765 TYPE is a window system for which this keyboard is used. */
10768 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10770 kset_overriding_terminal_local_map (kb
, Qnil
);
10771 kset_last_command (kb
, Qnil
);
10772 kset_real_last_command (kb
, Qnil
);
10773 kset_keyboard_translate_table (kb
, Qnil
);
10774 kset_last_repeatable_command (kb
, Qnil
);
10775 kset_prefix_arg (kb
, Qnil
);
10776 kset_last_prefix_arg (kb
, Qnil
);
10777 kset_kbd_queue (kb
, Qnil
);
10778 kb
->kbd_queue_has_data
= 0;
10779 kb
->immediate_echo
= 0;
10780 kset_echo_string (kb
, Qnil
);
10781 kb
->echo_after_prompt
= -1;
10782 kb
->kbd_macro_buffer
= 0;
10783 kb
->kbd_macro_bufsize
= 0;
10784 kset_defining_kbd_macro (kb
, Qnil
);
10785 kset_last_kbd_macro (kb
, Qnil
);
10786 kb
->reference_count
= 0;
10787 kset_system_key_alist (kb
, Qnil
);
10788 kset_system_key_syms (kb
, Qnil
);
10789 kset_window_system (kb
, type
);
10790 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10791 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10792 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10793 kset_default_minibuffer_frame (kb
, Qnil
);
10796 /* Allocate and basically initialize keyboard
10797 object to use with window system TYPE. */
10800 allocate_kboard (Lisp_Object type
)
10802 KBOARD
*kb
= xmalloc (sizeof *kb
);
10804 init_kboard (kb
, type
);
10805 kb
->next_kboard
= all_kboards
;
10811 * Destroy the contents of a kboard object, but not the object itself.
10812 * We use this just before deleting it, or if we're going to initialize
10813 * it a second time.
10816 wipe_kboard (KBOARD
*kb
)
10818 xfree (kb
->kbd_macro_buffer
);
10821 /* Free KB and memory referenced from it. */
10824 delete_kboard (KBOARD
*kb
)
10828 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10831 *kbp
= kb
->next_kboard
;
10833 /* Prevent a dangling reference to KB. */
10834 if (kb
== current_kboard
10835 && FRAMEP (selected_frame
)
10836 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10838 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10840 if (current_kboard
== kb
)
10849 init_keyboard (void)
10851 /* This is correct before outermost invocation of the editor loop. */
10852 command_loop_level
= -1;
10853 immediate_quit
= 0;
10854 quit_char
= Ctl ('g');
10855 Vunread_command_events
= Qnil
;
10856 timer_idleness_start_time
= invalid_timespec ();
10858 recent_keys_index
= 0;
10859 kbd_fetch_ptr
= kbd_buffer
;
10860 kbd_store_ptr
= kbd_buffer
;
10861 do_mouse_tracking
= Qnil
;
10863 interrupt_input_blocked
= 0;
10864 pending_signals
= 0;
10866 /* This means that command_loop_1 won't try to select anything the first
10868 internal_last_event_frame
= Qnil
;
10869 Vlast_event_frame
= internal_last_event_frame
;
10871 current_kboard
= initial_kboard
;
10872 /* Re-initialize the keyboard again. */
10873 wipe_kboard (current_kboard
);
10874 /* A value of nil for Vwindow_system normally means a tty, but we also use
10875 it for the initial terminal since there is no window system there. */
10876 init_kboard (current_kboard
, Qnil
);
10878 if (!noninteractive
)
10880 /* Before multi-tty support, these handlers used to be installed
10881 only if the current session was a tty session. Now an Emacs
10882 session may have multiple display types, so we always handle
10883 SIGINT. There is special code in handle_interrupt_signal to exit
10884 Emacs on SIGINT when there are no termcap frames on the
10885 controlling terminal. */
10886 struct sigaction action
;
10887 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10888 sigaction (SIGINT
, &action
, 0);
10890 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10891 SIGQUIT and we can't tell which one it will give us. */
10892 sigaction (SIGQUIT
, &action
, 0);
10893 #endif /* not DOS_NT */
10895 #ifdef USABLE_SIGIO
10896 if (!noninteractive
)
10898 struct sigaction action
;
10899 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10900 sigaction (SIGIO
, &action
, 0);
10904 /* Use interrupt input by default, if it works and noninterrupt input
10905 has deficiencies. */
10907 #ifdef INTERRUPT_INPUT
10908 interrupt_input
= 1;
10910 interrupt_input
= 0;
10913 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10916 if (keyboard_init_hook
)
10917 (*keyboard_init_hook
) ();
10919 #ifdef POLL_FOR_INPUT
10921 poll_suppress_count
= 1;
10926 /* This type's only use is in syms_of_keyboard, to initialize the
10927 event header symbols and put properties on them. */
10928 struct event_head
{
10934 static const struct event_head head_table
[] = {
10935 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10936 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10937 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10938 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10939 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10940 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10941 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10942 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10943 /* `select-window' should be handled just like `switch-frame'
10944 in read_key_sequence. */
10945 {&Qselect_window
, "select-window", &Qswitch_frame
}
10949 syms_of_keyboard (void)
10951 pending_funcalls
= Qnil
;
10952 staticpro (&pending_funcalls
);
10954 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10955 staticpro (&Vlispy_mouse_stem
);
10958 DEFSYM (QCimage
, ":image");
10959 DEFSYM (Qhelp_echo
, "help-echo");
10960 DEFSYM (QCrtl
, ":rtl");
10962 staticpro (&item_properties
);
10963 item_properties
= Qnil
;
10965 staticpro (&tool_bar_item_properties
);
10966 tool_bar_item_properties
= Qnil
;
10967 staticpro (&tool_bar_items_vector
);
10968 tool_bar_items_vector
= Qnil
;
10970 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10971 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10972 DEFSYM (Qself_insert_command
, "self-insert-command");
10973 DEFSYM (Qforward_char
, "forward-char");
10974 DEFSYM (Qbackward_char
, "backward-char");
10975 DEFSYM (Qdisabled
, "disabled");
10976 DEFSYM (Qundefined
, "undefined");
10977 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10978 DEFSYM (Qpost_command_hook
, "post-command-hook");
10979 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10980 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10981 DEFSYM (Qfunction_key
, "function-key");
10982 DEFSYM (Qmouse_click
, "mouse-click");
10983 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10984 DEFSYM (Qsave_session
, "save-session");
10985 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10986 DEFSYM (Qmenu_enable
, "menu-enable");
10989 DEFSYM (Qlanguage_change
, "language-change");
10993 DEFSYM (Qdbus_event
, "dbus-event");
10996 #ifdef USE_FILE_NOTIFY
10997 DEFSYM (Qfile_notify
, "file-notify");
10998 #endif /* USE_FILE_NOTIFY */
11000 DEFSYM (QCenable
, ":enable");
11001 DEFSYM (QCvisible
, ":visible");
11002 DEFSYM (QChelp
, ":help");
11003 DEFSYM (QCfilter
, ":filter");
11004 DEFSYM (QCbutton
, ":button");
11005 DEFSYM (QCkeys
, ":keys");
11006 DEFSYM (QCkey_sequence
, ":key-sequence");
11007 DEFSYM (QCtoggle
, ":toggle");
11008 DEFSYM (QCradio
, ":radio");
11009 DEFSYM (QClabel
, ":label");
11010 DEFSYM (QCvert_only
, ":vert-only");
11012 DEFSYM (Qmode_line
, "mode-line");
11013 DEFSYM (Qvertical_line
, "vertical-line");
11014 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11015 DEFSYM (Qmenu_bar
, "menu-bar");
11016 DEFSYM (Qright_divider
, "right-divider");
11017 DEFSYM (Qbottom_divider
, "bottom-divider");
11019 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11021 DEFSYM (Qabove_handle
, "above-handle");
11022 DEFSYM (Qhandle
, "handle");
11023 DEFSYM (Qbelow_handle
, "below-handle");
11024 DEFSYM (Qup
, "up");
11025 DEFSYM (Qdown
, "down");
11026 DEFSYM (Qtop
, "top");
11027 DEFSYM (Qbottom
, "bottom");
11028 DEFSYM (Qend_scroll
, "end-scroll");
11029 DEFSYM (Qratio
, "ratio");
11031 DEFSYM (Qevent_kind
, "event-kind");
11032 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11033 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11034 DEFSYM (Qmodifier_cache
, "modifier-cache");
11036 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11037 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11039 DEFSYM (Qpolling_period
, "polling-period");
11041 DEFSYM (Qx_set_selection
, "x-set-selection");
11042 DEFSYM (QPRIMARY
, "PRIMARY");
11043 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11044 DEFSYM (Qhandle_select_window
, "handle-select-window");
11046 DEFSYM (Qinput_method_function
, "input-method-function");
11047 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11048 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11050 DEFSYM (Qhelp_form_show
, "help-form-show");
11052 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11054 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11055 Fset (Qinput_method_use_echo_area
, Qnil
);
11059 int len
= ARRAYELTS (head_table
);
11061 for (i
= 0; i
< len
; i
++)
11063 const struct event_head
*p
= &head_table
[i
];
11064 *p
->var
= intern_c_string (p
->name
);
11065 staticpro (p
->var
);
11066 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11067 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11071 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11072 staticpro (&button_down_location
);
11073 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11074 staticpro (&mouse_syms
);
11075 wheel_syms
= Fmake_vector (make_number (ARRAYELTS (lispy_wheel_names
)),
11077 staticpro (&wheel_syms
);
11081 int len
= ARRAYELTS (modifier_names
);
11083 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11084 for (i
= 0; i
< len
; i
++)
11085 if (modifier_names
[i
])
11086 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11087 staticpro (&modifier_symbols
);
11090 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11091 staticpro (&recent_keys
);
11093 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11094 staticpro (&this_command_keys
);
11096 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11097 staticpro (&raw_keybuf
);
11099 DEFSYM (Qcommand_execute
, "command-execute");
11101 accent_key_syms
= Qnil
;
11102 staticpro (&accent_key_syms
);
11104 func_key_syms
= Qnil
;
11105 staticpro (&func_key_syms
);
11107 drag_n_drop_syms
= Qnil
;
11108 staticpro (&drag_n_drop_syms
);
11110 unread_switch_frame
= Qnil
;
11111 staticpro (&unread_switch_frame
);
11113 internal_last_event_frame
= Qnil
;
11114 staticpro (&internal_last_event_frame
);
11116 read_key_sequence_cmd
= Qnil
;
11117 staticpro (&read_key_sequence_cmd
);
11118 read_key_sequence_remapped
= Qnil
;
11119 staticpro (&read_key_sequence_remapped
);
11121 menu_bar_one_keymap_changed_items
= Qnil
;
11122 staticpro (&menu_bar_one_keymap_changed_items
);
11124 menu_bar_items_vector
= Qnil
;
11125 staticpro (&menu_bar_items_vector
);
11127 help_form_saved_window_configs
= Qnil
;
11128 staticpro (&help_form_saved_window_configs
);
11130 defsubr (&Scurrent_idle_time
);
11131 defsubr (&Sevent_symbol_parse_modifiers
);
11132 defsubr (&Sevent_convert_list
);
11133 defsubr (&Sread_key_sequence
);
11134 defsubr (&Sread_key_sequence_vector
);
11135 defsubr (&Srecursive_edit
);
11136 defsubr (&Strack_mouse
);
11137 defsubr (&Sinput_pending_p
);
11138 defsubr (&Srecent_keys
);
11139 defsubr (&Sthis_command_keys
);
11140 defsubr (&Sthis_command_keys_vector
);
11141 defsubr (&Sthis_single_command_keys
);
11142 defsubr (&Sthis_single_command_raw_keys
);
11143 defsubr (&Sreset_this_command_lengths
);
11144 defsubr (&Sclear_this_command_keys
);
11145 defsubr (&Ssuspend_emacs
);
11146 defsubr (&Sabort_recursive_edit
);
11147 defsubr (&Sexit_recursive_edit
);
11148 defsubr (&Srecursion_depth
);
11149 defsubr (&Scommand_error_default_function
);
11150 defsubr (&Stop_level
);
11151 defsubr (&Sdiscard_input
);
11152 defsubr (&Sopen_dribble_file
);
11153 defsubr (&Sset_input_interrupt_mode
);
11154 defsubr (&Sset_output_flow_control
);
11155 defsubr (&Sset_input_meta_mode
);
11156 defsubr (&Sset_quit_char
);
11157 defsubr (&Sset_input_mode
);
11158 defsubr (&Scurrent_input_mode
);
11159 defsubr (&Sposn_at_point
);
11160 defsubr (&Sposn_at_x_y
);
11162 DEFVAR_LISP ("last-command-event", last_command_event
,
11163 doc
: /* Last input event that was part of a command. */);
11165 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11166 doc
: /* Last input event in a command, except for mouse menu events.
11167 Mouse menus give back keys that don't look like mouse events;
11168 this variable holds the actual mouse event that led to the menu,
11169 so that you can determine whether the command was run by mouse or not. */);
11171 DEFVAR_LISP ("last-input-event", last_input_event
,
11172 doc
: /* Last input event. */);
11174 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11175 doc
: /* List of events to be read as the command input.
11176 These events are processed first, before actual keyboard input.
11177 Events read from this list are not normally added to `this-command-keys',
11178 as they will already have been added once as they were read for the first time.
11179 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11180 Vunread_command_events
= Qnil
;
11182 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11183 doc
: /* List of events to be processed as input by input methods.
11184 These events are processed before `unread-command-events'
11185 and actual keyboard input, but are not given to `input-method-function'. */);
11186 Vunread_post_input_method_events
= Qnil
;
11188 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11189 doc
: /* List of events to be processed as input by input methods.
11190 These events are processed after `unread-command-events', but
11191 before actual keyboard input.
11192 If there's an active input method, the events are given to
11193 `input-method-function'. */);
11194 Vunread_input_method_events
= Qnil
;
11196 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11197 doc
: /* Meta-prefix character code.
11198 Meta-foo as command input turns into this character followed by foo. */);
11199 XSETINT (meta_prefix_char
, 033);
11201 DEFVAR_KBOARD ("last-command", Vlast_command
,
11202 doc
: /* The last command executed.
11203 Normally a symbol with a function definition, but can be whatever was found
11204 in the keymap, or whatever the variable `this-command' was set to by that
11207 The value `mode-exit' is special; it means that the previous command
11208 read an event that told it to exit, and it did so and unread that event.
11209 In other words, the present command is the event that made the previous
11212 The value `kill-region' is special; it means that the previous command
11213 was a kill command.
11215 `last-command' has a separate binding for each terminal device.
11216 See Info node `(elisp)Multiple Terminals'. */);
11218 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11219 doc
: /* Same as `last-command', but never altered by Lisp code.
11220 Taken from the previous value of `real-this-command'. */);
11222 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11223 doc
: /* Last command that may be repeated.
11224 The last command executed that was not bound to an input event.
11225 This is the command `repeat' will try to repeat.
11226 Taken from a previous value of `real-this-command'. */);
11228 DEFVAR_LISP ("this-command", Vthis_command
,
11229 doc
: /* The command now being executed.
11230 The command can set this variable; whatever is put here
11231 will be in `last-command' during the following command. */);
11232 Vthis_command
= Qnil
;
11234 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11235 doc
: /* This is like `this-command', except that commands should never modify it. */);
11236 Vreal_this_command
= Qnil
;
11238 DEFVAR_LISP ("this-command-keys-shift-translated",
11239 Vthis_command_keys_shift_translated
,
11240 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11241 Shift-translation occurs when there is no binding for the key sequence
11242 as entered, but a binding was found by changing an upper-case letter
11243 to lower-case, or a shifted function key to an unshifted one. */);
11244 Vthis_command_keys_shift_translated
= Qnil
;
11246 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11247 doc
: /* The command bound to the current key sequence before remapping.
11248 It equals `this-command' if the original command was not remapped through
11249 any of the active keymaps. Otherwise, the value of `this-command' is the
11250 result of looking up the original command in the active keymaps. */);
11251 Vthis_original_command
= Qnil
;
11253 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11254 doc
: /* Number of input events between auto-saves.
11255 Zero means disable autosaving due to number of characters typed. */);
11256 auto_save_interval
= 300;
11258 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11259 doc
: /* Number of seconds idle time before auto-save.
11260 Zero or nil means disable auto-saving due to idleness.
11261 After auto-saving due to this many seconds of idle time,
11262 Emacs also does a garbage collection if that seems to be warranted. */);
11263 XSETFASTINT (Vauto_save_timeout
, 30);
11265 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11266 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11267 The value may be integer or floating point.
11268 If the value is zero, don't echo at all. */);
11269 Vecho_keystrokes
= make_number (1);
11271 DEFVAR_INT ("polling-period", polling_period
,
11272 doc
: /* Interval between polling for input during Lisp execution.
11273 The reason for polling is to make C-g work to stop a running program.
11274 Polling is needed only when using X windows and SIGIO does not work.
11275 Polling is automatically disabled in all other cases. */);
11276 polling_period
= 2;
11278 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11279 doc
: /* Maximum time between mouse clicks to make a double-click.
11280 Measured in milliseconds. The value nil means disable double-click
11281 recognition; t means double-clicks have no time limit and are detected
11282 by position only. */);
11283 Vdouble_click_time
= make_number (500);
11285 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11286 doc
: /* Maximum mouse movement between clicks to make a double-click.
11287 On window-system frames, value is the number of pixels the mouse may have
11288 moved horizontally or vertically between two clicks to make a double-click.
11289 On non window-system frames, value is interpreted in units of 1/8 characters
11292 This variable is also the threshold for motion of the mouse
11293 to count as a drag. */);
11294 double_click_fuzz
= 3;
11296 DEFVAR_INT ("num-input-keys", num_input_keys
,
11297 doc
: /* Number of complete key sequences read as input so far.
11298 This includes key sequences read from keyboard macros.
11299 The number is effectively the number of interactive command invocations. */);
11300 num_input_keys
= 0;
11302 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11303 doc
: /* Number of input events read from the keyboard so far.
11304 This does not include events generated by keyboard macros. */);
11305 num_nonmacro_input_events
= 0;
11307 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11308 doc
: /* The frame in which the most recently read event occurred.
11309 If the last event came from a keyboard macro, this is set to `macro'. */);
11310 Vlast_event_frame
= Qnil
;
11312 /* This variable is set up in sysdep.c. */
11313 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11314 doc
: /* The ERASE character as set by the user with stty. */);
11316 DEFVAR_LISP ("help-char", Vhelp_char
,
11317 doc
: /* Character to recognize as meaning Help.
11318 When it is read, do `(eval help-form)', and display result if it's a string.
11319 If the value of `help-form' is nil, this char can be read normally. */);
11320 XSETINT (Vhelp_char
, Ctl ('H'));
11322 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11323 doc
: /* List of input events to recognize as meaning Help.
11324 These work just like the value of `help-char' (see that). */);
11325 Vhelp_event_list
= Qnil
;
11327 DEFVAR_LISP ("help-form", Vhelp_form
,
11328 doc
: /* Form to execute when character `help-char' is read.
11329 If the form returns a string, that string is displayed.
11330 If `help-form' is nil, the help char is not recognized. */);
11333 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11334 doc
: /* Command to run when `help-char' character follows a prefix key.
11335 This command is used only when there is no actual binding
11336 for that character after that prefix key. */);
11337 Vprefix_help_command
= Qnil
;
11339 DEFVAR_LISP ("top-level", Vtop_level
,
11340 doc
: /* Form to evaluate when Emacs starts up.
11341 Useful to set before you dump a modified Emacs. */);
11344 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11345 doc
: /* Translate table for local keyboard input, or nil.
11346 If non-nil, the value should be a char-table. Each character read
11347 from the keyboard is looked up in this char-table. If the value found
11348 there is non-nil, then it is used instead of the actual input character.
11350 The value can also be a string or vector, but this is considered obsolete.
11351 If it is a string or vector of length N, character codes N and up are left
11352 untranslated. In a vector, an element which is nil means "no translation".
11354 This is applied to the characters supplied to input methods, not their
11355 output. See also `translation-table-for-input'.
11357 This variable has a separate binding for each terminal.
11358 See Info node `(elisp)Multiple Terminals'. */);
11360 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11361 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11362 \(Even if the operating system has support for stopping a process.\) */);
11363 cannot_suspend
= 0;
11365 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11366 doc
: /* Non-nil means prompt with menus when appropriate.
11367 This is done when reading from a keymap that has a prompt string,
11368 for elements that have prompt strings.
11369 The menu is displayed on the screen
11370 if X menus were enabled at configuration
11371 time and the previous event was a mouse click prefix key.
11372 Otherwise, menu prompting uses the echo area. */);
11373 menu_prompting
= 1;
11375 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11376 doc
: /* Character to see next line of menu prompt.
11377 Type this character while in a menu prompt to rotate around the lines of it. */);
11378 XSETINT (menu_prompt_more_char
, ' ');
11380 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11381 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11382 Emacs applies the modifiers of the character stored here to each keyboard
11383 character it reads. For example, after evaluating the expression
11384 (setq extra-keyboard-modifiers ?\\C-x)
11385 all input characters will have the control modifier applied to them.
11387 Note that the character ?\\C-@, equivalent to the integer zero, does
11388 not count as a control character; rather, it counts as a character
11389 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11390 cancels any modification. */);
11391 extra_keyboard_modifiers
= 0;
11393 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11394 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11395 The command loop sets this to nil before each command,
11396 and tests the value when the command returns.
11397 Buffer modification stores t in this variable. */);
11398 Vdeactivate_mark
= Qnil
;
11399 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11400 Fmake_variable_buffer_local (Qdeactivate_mark
);
11402 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11403 doc
: /* Normal hook run before each command is executed.
11404 If an unhandled error happens in running this hook,
11405 the function in which the error occurred is unconditionally removed, since
11406 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11407 Vpre_command_hook
= Qnil
;
11409 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11410 doc
: /* Normal hook run after each command is executed.
11411 If an unhandled error happens in running this hook,
11412 the function in which the error occurred is unconditionally removed, since
11413 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11414 Vpost_command_hook
= Qnil
;
11417 DEFVAR_LISP ("echo-area-clear-hook", ...,
11418 doc
: /* Normal hook run when clearing the echo area. */);
11420 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11421 Fset (Qecho_area_clear_hook
, Qnil
);
11423 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11424 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11425 Vlucid_menu_bar_dirty_flag
= Qnil
;
11427 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11428 doc
: /* List of menu bar items to move to the end of the menu bar.
11429 The elements of the list are event types that may have menu bar bindings. */);
11430 Vmenu_bar_final_items
= Qnil
;
11432 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11433 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11434 This is used internally by graphical displays that do not render
11435 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11436 Vtool_bar_separator_image_expression
= Qnil
;
11438 DEFVAR_KBOARD ("overriding-terminal-local-map",
11439 Voverriding_terminal_local_map
,
11440 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11441 This variable is intended to let commands such as `universal-argument'
11442 set up a different keymap for reading the next command.
11444 `overriding-terminal-local-map' has a separate binding for each
11445 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11447 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11448 doc
: /* Keymap that replaces (overrides) local keymaps.
11449 If this variable is non-nil, Emacs looks up key bindings in this
11450 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11451 buffer's local map. Hence, the only active keymaps would be
11452 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11453 order of precedence. */);
11454 Voverriding_local_map
= Qnil
;
11456 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11457 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11458 Otherwise, the menu bar continues to reflect the buffer's local map
11459 and the minor mode maps regardless of `overriding-local-map'. */);
11460 Voverriding_local_map_menu_flag
= Qnil
;
11462 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11463 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11464 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11466 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11467 doc
: /* Non-nil means generate motion events for mouse motion. */);
11469 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11470 doc
: /* Alist of system-specific X windows key symbols.
11471 Each element should have the form (N . SYMBOL) where N is the
11472 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11473 and SYMBOL is its name.
11475 `system-key-alist' has a separate binding for each terminal device.
11476 See Info node `(elisp)Multiple Terminals'. */);
11478 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11479 doc
: /* Keymap that translates key sequences to key sequences during input.
11480 This is used mainly for mapping key sequences into some preferred
11481 key events (symbols).
11483 The `read-key-sequence' function replaces any subsequence bound by
11484 `local-function-key-map' with its binding. More precisely, when the
11485 active keymaps have no binding for the current key sequence but
11486 `local-function-key-map' binds a suffix of the sequence to a vector or
11487 string, `read-key-sequence' replaces the matching suffix with its
11488 binding, and continues with the new sequence.
11490 If the binding is a function, it is called with one argument (the prompt)
11491 and its return value (a key sequence) is used.
11493 The events that come from bindings in `local-function-key-map' are not
11494 themselves looked up in `local-function-key-map'.
11496 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11497 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11498 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11499 typing `ESC O P x' would return [f1 x].
11501 `local-function-key-map' has a separate binding for each terminal
11502 device. See Info node `(elisp)Multiple Terminals'. If you need to
11503 define a binding on all terminals, change `function-key-map'
11504 instead. Initially, `local-function-key-map' is an empty keymap that
11505 has `function-key-map' as its parent on all terminal devices. */);
11507 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11508 doc
: /* Keymap that decodes input escape sequences.
11509 This is used mainly for mapping ASCII function key sequences into
11510 real Emacs function key events (symbols).
11512 The `read-key-sequence' function replaces any subsequence bound by
11513 `input-decode-map' with its binding. Contrary to `function-key-map',
11514 this map applies its rebinding regardless of the presence of an ordinary
11515 binding. So it is more like `key-translation-map' except that it applies
11516 before `function-key-map' rather than after.
11518 If the binding is a function, it is called with one argument (the prompt)
11519 and its return value (a key sequence) is used.
11521 The events that come from bindings in `input-decode-map' are not
11522 themselves looked up in `input-decode-map'. */);
11524 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11525 doc
: /* The parent keymap of all `local-function-key-map' instances.
11526 Function key definitions that apply to all terminal devices should go
11527 here. If a mapping is defined in both the current
11528 `local-function-key-map' binding and this variable, then the local
11529 definition will take precedence. */);
11530 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11532 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11533 doc
: /* Keymap of key translations that can override keymaps.
11534 This keymap works like `input-decode-map', but comes after `function-key-map'.
11535 Another difference is that it is global rather than terminal-local. */);
11536 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11538 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11539 doc
: /* List of deferred actions to be performed at a later time.
11540 The precise format isn't relevant here; we just check whether it is nil. */);
11541 Vdeferred_action_list
= Qnil
;
11543 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11544 doc
: /* Function to call to handle deferred actions, after each command.
11545 This function is called with no arguments after each command
11546 whenever `deferred-action-list' is non-nil. */);
11547 Vdeferred_action_function
= Qnil
;
11549 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11550 doc
: /* List of warnings to be displayed after this command.
11551 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11552 as per the args of `display-warning' (which see).
11553 If this variable is non-nil, `delayed-warnings-hook' will be run
11554 immediately after running `post-command-hook'. */);
11555 Vdelayed_warnings_list
= Qnil
;
11557 DEFVAR_LISP ("timer-list", Vtimer_list
,
11558 doc
: /* List of active absolute time timers in order of increasing time. */);
11559 Vtimer_list
= Qnil
;
11561 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11562 doc
: /* List of active idle-time timers in order of increasing time. */);
11563 Vtimer_idle_list
= Qnil
;
11565 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11566 doc
: /* If non-nil, the function that implements the current input method.
11567 It's called with one argument, a printing character that was just read.
11568 \(That means a character with code 040...0176.)
11569 Typically this function uses `read-event' to read additional events.
11570 When it does so, it should first bind `input-method-function' to nil
11571 so it will not be called recursively.
11573 The function should return a list of zero or more events
11574 to be used as input. If it wants to put back some events
11575 to be reconsidered, separately, by the input method,
11576 it can add them to the beginning of `unread-command-events'.
11578 The input method function can find in `input-method-previous-message'
11579 the previous echo area message.
11581 The input method function should refer to the variables
11582 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11583 for guidance on what to do. */);
11584 Vinput_method_function
= Qnil
;
11586 DEFVAR_LISP ("input-method-previous-message",
11587 Vinput_method_previous_message
,
11588 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11589 This variable exists because `read-event' clears the echo area
11590 before running the input method. It is nil if there was no message. */);
11591 Vinput_method_previous_message
= Qnil
;
11593 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11594 doc
: /* If non-nil, the function that implements the display of help.
11595 It's called with one argument, the help string to display. */);
11596 Vshow_help_function
= Qnil
;
11598 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11599 doc
: /* If non-nil, suppress point adjustment after executing a command.
11601 After a command is executed, if point is moved into a region that has
11602 special properties (e.g. composition, display), we adjust point to
11603 the boundary of the region. But, when a command sets this variable to
11604 non-nil, we suppress the point adjustment.
11606 This variable is set to nil before reading a command, and is checked
11607 just after executing the command. */);
11608 Vdisable_point_adjustment
= Qnil
;
11610 DEFVAR_LISP ("global-disable-point-adjustment",
11611 Vglobal_disable_point_adjustment
,
11612 doc
: /* If non-nil, always suppress point adjustment.
11614 The default value is nil, in which case, point adjustment are
11615 suppressed only after special commands that set
11616 `disable-point-adjustment' (which see) to non-nil. */);
11617 Vglobal_disable_point_adjustment
= Qnil
;
11619 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11620 doc
: /* How long to display an echo-area message when the minibuffer is active.
11621 If the value is not a number, such messages don't time out. */);
11622 Vminibuffer_message_timeout
= make_number (2);
11624 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11625 doc
: /* If non-nil, any keyboard input throws to this symbol.
11626 The value of that variable is passed to `quit-flag' and later causes a
11627 peculiar kind of quitting. */);
11628 Vthrow_on_input
= Qnil
;
11630 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11631 doc
: /* Function to output error messages.
11632 Called with three arguments:
11633 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11634 such as what `condition-case' would bind its variable to,
11635 - the context (a string which normally goes at the start of the message),
11636 - the Lisp function within which the error was signaled. */);
11637 Vcommand_error_function
= intern ("command-error-default-function");
11639 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11640 Venable_disabled_menus_and_buttons
,
11641 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11643 Help functions bind this to allow help on disabled menu items
11644 and tool-bar buttons. */);
11645 Venable_disabled_menus_and_buttons
= Qnil
;
11647 DEFVAR_LISP ("select-active-regions",
11648 Vselect_active_regions
,
11649 doc
: /* If non-nil, an active region automatically sets the primary selection.
11650 If the value is `only', only temporarily active regions (usually made
11651 by mouse-dragging or shift-selection) set the window selection.
11653 This takes effect only when Transient Mark mode is enabled. */);
11654 Vselect_active_regions
= Qt
;
11656 DEFVAR_LISP ("saved-region-selection",
11657 Vsaved_region_selection
,
11658 doc
: /* Contents of active region prior to buffer modification.
11659 If `select-active-regions' is non-nil, Emacs sets this to the
11660 text in the region before modifying the buffer. The next call to
11661 the function `deactivate-mark' uses this to set the window selection. */);
11662 Vsaved_region_selection
= Qnil
;
11664 DEFVAR_LISP ("selection-inhibit-update-commands",
11665 Vselection_inhibit_update_commands
,
11666 doc
: /* List of commands which should not update the selection.
11667 Normally, if `select-active-regions' is non-nil and the mark remains
11668 active after a command (i.e. the mark was not deactivated), the Emacs
11669 command loop sets the selection to the text in the region. However,
11670 if the command is in this list, the selection is not updated. */);
11671 Vselection_inhibit_update_commands
11672 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11674 DEFVAR_LISP ("debug-on-event",
11676 doc
: /* Enter debugger on this event. When Emacs
11677 receives the special event specified by this variable, it will try to
11678 break into the debugger as soon as possible instead of processing the
11679 event normally through `special-event-map'.
11681 Currently, the only supported values for this
11682 variable are `sigusr1' and `sigusr2'. */);
11683 Vdebug_on_event
= intern_c_string ("sigusr2");
11685 /* Create the initial keyboard. Qt means 'unset'. */
11686 initial_kboard
= allocate_kboard (Qt
);
11690 keys_of_keyboard (void)
11692 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11693 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11694 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11695 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11696 initial_define_key (meta_map
, 'x', "execute-extended-command");
11698 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11699 "handle-delete-frame");
11700 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11701 "ns-put-working-text");
11702 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11703 "ns-unput-working-text");
11704 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11705 current-prefix-arg, as is done in `handle-switch-frame'.
11706 But `handle-switch-frame is not run from the special-map.
11707 Commands from that map are run in a special way that automatically
11708 preserves the prefix-arg. Restoring the prefix arg here is not just
11709 redundant but harmful:
11711 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11712 - after the first prompt, the exit-minibuffer-hook is run which may
11713 iconify a frame and thus push a `iconify-frame' event.
11714 - after running exit-minibuffer-hook, current-prefix-arg is
11715 restored to the non-nil value it had before the prompt.
11716 - we enter the second prompt.
11717 current-prefix-arg is non-nil, prefix-arg is nil.
11718 - before running the first real event, we run the special iconify-frame
11719 event, but we pass the `special' arg to execute-command so
11720 current-prefix-arg and prefix-arg are left untouched.
11721 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11722 - the next key event will have a spuriously non-nil current-prefix-arg. */
11723 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11725 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11727 /* Handling it at such a low-level causes read_key_sequence to get
11728 * confused because it doesn't realize that the current_buffer was
11729 * changed by read_char.
11731 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11732 * "handle-select-window"); */
11733 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11734 "handle-save-session");
11737 /* Define a special event which is raised for dbus callback
11739 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11740 "dbus-handle-event");
11743 #ifdef USE_FILE_NOTIFY
11744 /* Define a special event which is raised for notification callback
11746 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11747 "file-notify-handle-event");
11748 #endif /* USE_FILE_NOTIFY */
11750 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11752 #if defined (WINDOWSNT)
11753 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11756 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11757 "handle-focus-in");
11758 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11759 "handle-focus-out");
11762 /* Mark the pointers in the kboard objects.
11763 Called by Fgarbage_collect. */
11765 mark_kboards (void)
11769 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11771 if (kb
->kbd_macro_buffer
)
11772 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11774 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11775 mark_object (KVAR (kb
, Vlast_command
));
11776 mark_object (KVAR (kb
, Vreal_last_command
));
11777 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11778 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11779 mark_object (KVAR (kb
, Vprefix_arg
));
11780 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11781 mark_object (KVAR (kb
, kbd_queue
));
11782 mark_object (KVAR (kb
, defining_kbd_macro
));
11783 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11784 mark_object (KVAR (kb
, Vsystem_key_alist
));
11785 mark_object (KVAR (kb
, system_key_syms
));
11786 mark_object (KVAR (kb
, Vwindow_system
));
11787 mark_object (KVAR (kb
, Vinput_decode_map
));
11788 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11789 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11790 mark_object (KVAR (kb
, echo_string
));
11793 struct input_event
*event
;
11794 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11796 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11797 event
= kbd_buffer
;
11798 /* These two special event types has no Lisp_Objects to mark. */
11799 if (event
->kind
!= SELECTION_REQUEST_EVENT
11800 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11802 mark_object (event
->x
);
11803 mark_object (event
->y
);
11804 mark_object (event
->frame_or_window
);
11805 mark_object (event
->arg
);