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
, sizeof keybuf
/ sizeof keybuf
[0],
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
, sizeof keybuf
/ sizeof keybuf
[0],
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
2305 Lisp_Object events
[MAX_ENCODED_BYTES
];
2310 = read_event_from_main_queue (end_time
, local_getcjmp
,
2313 /* w32_console already returns decoded events. It either reads
2314 Unicode characters from the Windows keyboard input, or
2315 converts characters encoded in the current codepage into
2316 Unicode. See w32inevt.c:key_event, near its end. */
2319 struct frame
*frame
= XFRAME (selected_frame
);
2320 struct terminal
*terminal
= frame
->terminal
;
2321 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2322 /* Don't apply decoding if we're just reading a raw event
2323 (e.g. reading bytes sent by the xterm to specify the position
2324 of a mouse click). */
2325 && (!EQ (prev_event
, Qt
))
2326 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2327 & CODING_REQUIRE_DECODING_MASK
)))
2328 return nextevt
; /* No decoding needed. */
2331 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2332 eassert (n
< MAX_ENCODED_BYTES
);
2333 events
[n
++] = nextevt
;
2334 if (NATNUMP (nextevt
)
2335 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2336 { /* An encoded byte sequence, let's try to decode it. */
2337 struct coding_system
*coding
2338 = TERMINAL_KEYBOARD_CODING (terminal
);
2339 unsigned char *src
= alloca (n
);
2341 for (i
= 0; i
< n
; i
++)
2342 src
[i
] = XINT (events
[i
]);
2344 for (i
= 0; i
< n
; i
++)
2346 coding
->destination
= alloca (n
* 4);
2347 coding
->dst_bytes
= n
* 4;
2348 decode_coding_c_string (coding
, src
, n
, Qnil
);
2349 eassert (coding
->produced_char
<= n
);
2350 if (coding
->produced_char
== 0)
2351 { /* The encoded sequence is incomplete. */
2352 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2353 continue; /* Read on! */
2357 const unsigned char *p
= coding
->destination
;
2358 eassert (coding
->carryover_bytes
== 0);
2360 while (n
< coding
->produced_char
)
2361 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2364 /* Now `events' should hold decoded events.
2365 Normally, n should be equal to 1, but better not rely on it.
2366 We can only return one event here, so return the first we
2367 had and keep the others (if any) for later. */
2369 Vunread_command_events
2370 = Fcons (events
[--n
], Vunread_command_events
);
2377 /* Read a character from the keyboard; call the redisplay if needed. */
2378 /* commandflag 0 means do not autosave, but do redisplay.
2379 -1 means do not redisplay, but do autosave.
2380 -2 means do neither.
2383 /* The argument MAP is a keymap for menu prompting.
2385 PREV_EVENT is the previous input event, or nil if we are reading
2386 the first event of a key sequence (or not reading a key sequence).
2387 If PREV_EVENT is t, that is a "magic" value that says
2388 not to run input methods, but in other respects to act as if
2389 not reading a key sequence.
2391 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2392 if we used a mouse menu to read the input, or false otherwise. If
2393 USED_MOUSE_MENU is null, don't dereference it.
2395 Value is -2 when we find input on another keyboard. A second call
2396 to read_char will read it.
2398 If END_TIME is non-null, it is a pointer to a struct timespec
2399 specifying the maximum time to wait until. If no input arrives by
2400 that time, stop waiting and return nil.
2402 Value is t if we showed a menu and the user rejected it. */
2405 read_char (int commandflag
, Lisp_Object map
,
2406 Lisp_Object prev_event
,
2407 bool *used_mouse_menu
, struct timespec
*end_time
)
2411 sys_jmp_buf local_getcjmp
;
2412 sys_jmp_buf save_jump
;
2413 Lisp_Object tem
, save
;
2414 volatile Lisp_Object previous_echo_area_message
;
2415 volatile Lisp_Object also_record
;
2416 volatile bool reread
;
2417 struct gcpro gcpro1
, gcpro2
;
2418 bool volatile polling_stopped_here
= 0;
2419 struct kboard
*orig_kboard
= current_kboard
;
2423 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2424 before_command_key_count
= this_command_key_count
;
2425 before_command_echo_length
= echo_length ();
2428 previous_echo_area_message
= Qnil
;
2430 GCPRO2 (c
, previous_echo_area_message
);
2435 if (CONSP (Vunread_post_input_method_events
))
2437 c
= XCAR (Vunread_post_input_method_events
);
2438 Vunread_post_input_method_events
2439 = XCDR (Vunread_post_input_method_events
);
2441 /* Undo what read_char_x_menu_prompt did when it unread
2442 additional keys returned by Fx_popup_menu. */
2444 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2452 if (CONSP (Vunread_command_events
))
2454 bool was_disabled
= 0;
2456 c
= XCAR (Vunread_command_events
);
2457 Vunread_command_events
= XCDR (Vunread_command_events
);
2461 /* Undo what sit-for did when it unread additional keys
2462 inside universal-argument. */
2465 && EQ (XCAR (c
), Qt
))
2471 /* Undo what read_char_x_menu_prompt did when it unread
2472 additional keys returned by Fx_popup_menu. */
2474 && EQ (XCDR (c
), Qdisabled
)
2475 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2481 /* If the queued event is something that used the mouse,
2482 set used_mouse_menu accordingly. */
2484 /* Also check was_disabled so last-nonmenu-event won't return
2485 a bad value when submenus are involved. (Bug#447) */
2486 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2487 *used_mouse_menu
= 1;
2489 goto reread_for_input_method
;
2492 if (CONSP (Vunread_input_method_events
))
2494 c
= XCAR (Vunread_input_method_events
);
2495 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2497 /* Undo what read_char_x_menu_prompt did when it unread
2498 additional keys returned by Fx_popup_menu. */
2500 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2504 goto reread_for_input_method
;
2507 this_command_key_count_reset
= 0;
2509 if (!NILP (Vexecuting_kbd_macro
))
2511 /* We set this to Qmacro; since that's not a frame, nobody will
2512 try to switch frames on us, and the selected window will
2515 Since this event came from a macro, it would be misleading to
2516 leave internal_last_event_frame set to wherever the last
2517 real event came from. Normally, a switch-frame event selects
2518 internal_last_event_frame after each command is read, but
2519 events read from a macro should never cause a new frame to be
2521 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2523 /* Exit the macro if we are at the end.
2524 Also, some things replace the macro with t
2525 to force an early exit. */
2526 if (EQ (Vexecuting_kbd_macro
, Qt
)
2527 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2533 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2534 if (STRINGP (Vexecuting_kbd_macro
)
2535 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2536 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2538 executing_kbd_macro_index
++;
2543 if (!NILP (unread_switch_frame
))
2545 c
= unread_switch_frame
;
2546 unread_switch_frame
= Qnil
;
2548 /* This event should make it into this_command_keys, and get echoed
2549 again, so we do not set `reread'. */
2553 /* If redisplay was requested. */
2554 if (commandflag
>= 0)
2556 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2558 /* If there is pending input, process any events which are not
2559 user-visible, such as X selection_request events. */
2561 || detect_input_pending_run_timers (0))
2562 swallow_events (0); /* May clear input_pending. */
2564 /* Redisplay if no pending input. */
2565 while (!input_pending
)
2567 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2568 redisplay_preserve_echo_area (5);
2573 /* Normal case: no input arrived during redisplay. */
2576 /* Input arrived and pre-empted redisplay.
2577 Process any events which are not user-visible. */
2579 /* If that cleared input_pending, try again to redisplay. */
2582 /* Prevent the redisplay we just did
2583 from messing up echoing of the input after the prompt. */
2584 if (commandflag
== 0 && echo_current
)
2585 echo_message_buffer
= echo_area_buffer
[0];
2589 /* Message turns off echoing unless more keystrokes turn it on again.
2591 The code in 20.x for the condition was
2593 1. echo_area_glyphs && *echo_area_glyphs
2594 2. && echo_area_glyphs != current_kboard->echobuf
2595 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2597 (1) means there's a current message displayed
2599 (2) means it's not the message from echoing from the current
2602 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2603 is set to a non-null value. This is done in read_char and it is
2604 set to echo_area_glyphs after a call to echo_char. That means
2605 ok_to_echo_at_next_pause is either null or
2606 current_kboard->echobuf with the appropriate current_kboard at
2609 So, condition (3) means in clear text ok_to_echo_at_next_pause
2610 must be either null, or the current message isn't from echoing at
2611 all, or it's from echoing from a different kboard than the
2614 if (/* There currently is something in the echo area. */
2615 !NILP (echo_area_buffer
[0])
2616 && (/* It's an echo from a different kboard. */
2617 echo_kboard
!= current_kboard
2618 /* Or we explicitly allow overwriting whatever there is. */
2619 || ok_to_echo_at_next_pause
== NULL
))
2624 /* Try reading a character via menu prompting in the minibuf.
2625 Try this before the sit-for, because the sit-for
2626 would do the wrong thing if we are supposed to do
2627 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2628 after a mouse event so don't try a minibuf menu. */
2630 if (KEYMAPP (map
) && INTERACTIVE
2631 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2632 /* Don't bring up a menu if we already have another event. */
2633 && NILP (Vunread_command_events
)
2634 && !detect_input_pending_run_timers (0))
2636 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2638 if (INTEGERP (c
) && XINT (c
) == -2)
2639 return c
; /* wrong_kboard_jmpbuf */
2645 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2646 We will do that below, temporarily for short sections of code,
2647 when appropriate. local_getcjmp must be in effect
2648 around any call to sit_for or kbd_buffer_get_event;
2649 it *must not* be in effect when we call redisplay. */
2651 jmpcount
= SPECPDL_INDEX ();
2652 if (sys_setjmp (local_getcjmp
))
2654 /* Handle quits while reading the keyboard. */
2655 /* We must have saved the outer value of getcjmp here,
2656 so restore it now. */
2657 restore_getcjmp (save_jump
);
2658 unbind_to (jmpcount
, Qnil
);
2659 XSETINT (c
, quit_char
);
2660 internal_last_event_frame
= selected_frame
;
2661 Vlast_event_frame
= internal_last_event_frame
;
2662 /* If we report the quit char as an event,
2663 don't do so more than once. */
2664 if (!NILP (Vinhibit_quit
))
2668 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2669 if (kb
!= current_kboard
)
2671 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2672 /* We shouldn't get here if we were in single-kboard mode! */
2677 while (CONSP (XCDR (last
)))
2679 if (!NILP (XCDR (last
)))
2683 kset_kbd_queue (kb
, list1 (c
));
2685 XSETCDR (last
, list1 (c
));
2686 kb
->kbd_queue_has_data
= 1;
2687 current_kboard
= kb
;
2688 /* This is going to exit from read_char
2689 so we had better get rid of this frame's stuff. */
2691 return make_number (-2); /* wrong_kboard_jmpbuf */
2697 /* Start idle timers if no time limit is supplied. We don't do it
2698 if a time limit is supplied to avoid an infinite recursion in the
2699 situation where an idle timer calls `sit-for'. */
2702 timer_start_idle ();
2704 /* If in middle of key sequence and minibuffer not active,
2705 start echoing if enough time elapses. */
2707 if (minibuf_level
== 0
2709 && !current_kboard
->immediate_echo
2710 && this_command_key_count
> 0
2712 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2713 && NILP (Fzerop (Vecho_keystrokes
))
2714 && (/* No message. */
2715 NILP (echo_area_buffer
[0])
2716 /* Or empty message. */
2717 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2718 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2719 /* Or already echoing from same kboard. */
2720 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2721 /* Or not echoing before and echoing allowed. */
2722 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2724 /* After a mouse event, start echoing right away.
2725 This is because we are probably about to display a menu,
2726 and we don't want to delay before doing so. */
2727 if (EVENT_HAS_PARAMETERS (prev_event
))
2733 save_getcjmp (save_jump
);
2734 restore_getcjmp (local_getcjmp
);
2735 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2736 restore_getcjmp (save_jump
);
2738 && ! CONSP (Vunread_command_events
))
2743 /* Maybe auto save due to number of keystrokes. */
2745 if (commandflag
!= 0 && commandflag
!= -2
2746 && auto_save_interval
> 0
2747 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2748 && !detect_input_pending_run_timers (0))
2750 Fdo_auto_save (Qnil
, Qnil
);
2751 /* Hooks can actually change some buffers in auto save. */
2755 /* Try reading using an X menu.
2756 This is never confused with reading using the minibuf
2757 because the recursive call of read_char in read_char_minibuf_menu_prompt
2758 does not pass on any keymaps. */
2760 if (KEYMAPP (map
) && INTERACTIVE
2761 && !NILP (prev_event
)
2762 && EVENT_HAS_PARAMETERS (prev_event
)
2763 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2764 && !EQ (XCAR (prev_event
), Qtool_bar
)
2765 /* Don't bring up a menu if we already have another event. */
2766 && NILP (Vunread_command_events
))
2768 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2770 /* Now that we have read an event, Emacs is not idle. */
2777 /* Maybe autosave and/or garbage collect due to idleness. */
2779 if (INTERACTIVE
&& NILP (c
))
2782 ptrdiff_t buffer_size
;
2784 /* Slow down auto saves logarithmically in size of current buffer,
2785 and garbage collect while we're at it. */
2786 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2787 last_non_minibuf_size
= Z
- BEG
;
2788 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2790 while (buffer_size
> 64)
2791 delay_level
++, buffer_size
-= buffer_size
>> 2;
2792 if (delay_level
< 4) delay_level
= 4;
2793 /* delay_level is 4 for files under around 50k, 7 at 100k,
2794 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2796 /* Auto save if enough time goes by without input. */
2797 if (commandflag
!= 0 && commandflag
!= -2
2798 && num_nonmacro_input_events
> last_auto_save
2799 && INTEGERP (Vauto_save_timeout
)
2800 && XINT (Vauto_save_timeout
) > 0)
2803 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2805 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2806 timeout
= delay_level
* timeout
/ 4;
2807 save_getcjmp (save_jump
);
2808 restore_getcjmp (local_getcjmp
);
2809 tem0
= sit_for (make_number (timeout
), 1, 1);
2810 restore_getcjmp (save_jump
);
2813 && ! CONSP (Vunread_command_events
))
2815 Fdo_auto_save (Qnil
, Qnil
);
2820 /* If there is still no input available, ask for GC. */
2821 if (!detect_input_pending_run_timers (0))
2825 /* Notify the caller if an autosave hook, or a timer, sentinel or
2826 filter in the sit_for calls above have changed the current
2827 kboard. This could happen if they use the minibuffer or start a
2828 recursive edit, like the fancy splash screen in server.el's
2829 filter. If this longjmp wasn't here, read_key_sequence would
2830 interpret the next key sequence using the wrong translation
2831 tables and function keymaps. */
2832 if (NILP (c
) && current_kboard
!= orig_kboard
)
2835 return make_number (-2); /* wrong_kboard_jmpbuf */
2838 /* If this has become non-nil here, it has been set by a timer
2839 or sentinel or filter. */
2840 if (CONSP (Vunread_command_events
))
2842 c
= XCAR (Vunread_command_events
);
2843 Vunread_command_events
= XCDR (Vunread_command_events
);
2846 /* Read something from current KBOARD's side queue, if possible. */
2850 if (current_kboard
->kbd_queue_has_data
)
2852 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2854 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2855 kset_kbd_queue (current_kboard
,
2856 XCDR (KVAR (current_kboard
, kbd_queue
)));
2857 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2858 current_kboard
->kbd_queue_has_data
= 0;
2859 input_pending
= readable_events (0);
2860 if (EVENT_HAS_PARAMETERS (c
)
2861 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2862 internal_last_event_frame
= XCAR (XCDR (c
));
2863 Vlast_event_frame
= internal_last_event_frame
;
2867 /* If current_kboard's side queue is empty check the other kboards.
2868 If one of them has data that we have not yet seen here,
2869 switch to it and process the data waiting for it.
2871 Note: if the events queued up for another kboard
2872 have already been seen here, and therefore are not a complete command,
2873 the kbd_queue_has_data field is 0, so we skip that kboard here.
2874 That's to avoid an infinite loop switching between kboards here. */
2875 if (NILP (c
) && !single_kboard
)
2878 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2879 if (kb
->kbd_queue_has_data
)
2881 current_kboard
= kb
;
2882 /* This is going to exit from read_char
2883 so we had better get rid of this frame's stuff. */
2885 return make_number (-2); /* wrong_kboard_jmpbuf */
2895 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2896 prev_event
, used_mouse_menu
);
2897 if (NILP(c
) && end_time
&&
2898 timespec_cmp (*end_time
, current_timespec ()) <= 0)
2903 if (EQ (c
, make_number (-2)))
2905 /* This is going to exit from read_char
2906 so we had better get rid of this frame's stuff. */
2920 if (commandflag
>= 0
2921 && !input_pending
&& !detect_input_pending_run_timers (0))
2927 /* Buffer switch events are only for internal wakeups
2928 so don't show them to the user.
2929 Also, don't record a key if we already did. */
2933 /* Process special events within read_char
2934 and loop around to read another event. */
2937 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2942 struct buffer
*prev_buffer
= current_buffer
;
2943 last_input_event
= c
;
2944 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2946 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2947 /* We stopped being idle for this event; undo that. This
2948 prevents automatic window selection (under
2949 mouse_autoselect_window from acting as a real input event, for
2950 example banishing the mouse under mouse-avoidance-mode. */
2951 timer_resume_idle ();
2953 if (current_buffer
!= prev_buffer
)
2955 /* The command may have changed the keymaps. Pretend there
2956 is input in another keyboard and return. This will
2957 recalculate keymaps. */
2958 c
= make_number (-2);
2965 /* Handle things that only apply to characters. */
2968 /* If kbd_buffer_get_event gave us an EOF, return that. */
2972 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2973 && UNSIGNED_CMP (XFASTINT (c
), <,
2974 SCHARS (KVAR (current_kboard
,
2975 Vkeyboard_translate_table
))))
2976 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2977 && UNSIGNED_CMP (XFASTINT (c
), <,
2978 ASIZE (KVAR (current_kboard
,
2979 Vkeyboard_translate_table
))))
2980 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2984 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2985 /* nil in keyboard-translate-table means no translation. */
2991 /* If this event is a mouse click in the menu bar,
2992 return just menu-bar for now. Modify the mouse click event
2993 so we won't do this twice, then queue it up. */
2994 if (EVENT_HAS_PARAMETERS (c
)
2996 && CONSP (EVENT_START (c
))
2997 && CONSP (XCDR (EVENT_START (c
))))
3001 posn
= POSN_POSN (EVENT_START (c
));
3002 /* Handle menu-bar events:
3003 insert the dummy prefix event `menu-bar'. */
3004 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
3006 /* Change menu-bar to (menu-bar) as the event "position". */
3007 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
3010 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
3015 /* Store these characters into recent_keys, the dribble file if any,
3016 and the keyboard macro being defined, if any. */
3018 if (! NILP (also_record
))
3019 record_char (also_record
);
3021 /* Wipe the echo area.
3022 But first, if we are about to use an input method,
3023 save the echo area contents for it to refer to. */
3025 && ! NILP (Vinput_method_function
)
3026 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3028 previous_echo_area_message
= Fcurrent_message ();
3029 Vinput_method_previous_message
= previous_echo_area_message
;
3032 /* Now wipe the echo area, except for help events which do their
3033 own stuff with the echo area. */
3035 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3036 && !(EQ (Qswitch_frame
, XCAR (c
)))
3037 /* Don't wipe echo area for select window events: These might
3038 get delayed via `mouse-autoselect-window' (Bug#11304). */
3039 && !(EQ (Qselect_window
, XCAR (c
)))))
3041 if (!NILP (echo_area_buffer
[0]))
3043 safe_run_hooks (Qecho_area_clear_hook
);
3044 clear_message (1, 0);
3048 reread_for_input_method
:
3050 /* Pass this to the input method, if appropriate. */
3052 && ! NILP (Vinput_method_function
)
3053 /* Don't run the input method within a key sequence,
3054 after the first event of the key sequence. */
3055 && NILP (prev_event
)
3056 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3059 ptrdiff_t key_count
;
3060 bool key_count_reset
;
3061 struct gcpro gcpro1
;
3062 ptrdiff_t count
= SPECPDL_INDEX ();
3064 /* Save the echo status. */
3065 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3066 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3067 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3068 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3071 if (before_command_restore_flag
)
3073 this_command_key_count
= before_command_key_count_1
;
3074 if (this_command_key_count
< this_single_command_key_start
)
3075 this_single_command_key_start
= this_command_key_count
;
3076 echo_truncate (before_command_echo_length_1
);
3077 before_command_restore_flag
= 0;
3081 /* Save the this_command_keys status. */
3082 key_count
= this_command_key_count
;
3083 key_count_reset
= this_command_key_count_reset
;
3086 keys
= Fcopy_sequence (this_command_keys
);
3091 /* Clear out this_command_keys. */
3092 this_command_key_count
= 0;
3093 this_command_key_count_reset
= 0;
3095 /* Now wipe the echo area. */
3096 if (!NILP (echo_area_buffer
[0]))
3097 safe_run_hooks (Qecho_area_clear_hook
);
3098 clear_message (1, 0);
3101 /* If we are not reading a key sequence,
3102 never use the echo area. */
3105 specbind (Qinput_method_use_echo_area
, Qt
);
3108 /* Call the input method. */
3109 tem
= call1 (Vinput_method_function
, c
);
3111 tem
= unbind_to (count
, tem
);
3113 /* Restore the saved echoing state
3114 and this_command_keys state. */
3115 this_command_key_count
= key_count
;
3116 this_command_key_count_reset
= key_count_reset
;
3118 this_command_keys
= keys
;
3121 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3122 kset_echo_string (current_kboard
, saved_echo_string
);
3123 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3124 if (saved_immediate_echo
)
3129 /* The input method can return no events. */
3132 /* Bring back the previous message, if any. */
3133 if (! NILP (previous_echo_area_message
))
3134 message_with_string ("%s", previous_echo_area_message
, 0);
3137 /* It returned one event or more. */
3139 Vunread_post_input_method_events
3140 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3145 /* Display help if not echoing. */
3146 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3148 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3149 Lisp_Object help
, object
, position
, window
, htem
;
3151 htem
= Fcdr (XCDR (c
));
3154 window
= Fcar (htem
);
3156 object
= Fcar (htem
);
3158 position
= Fcar (htem
);
3160 show_help_echo (help
, window
, object
, position
);
3162 /* We stopped being idle for this event; undo that. */
3164 timer_resume_idle ();
3168 if ((! reread
|| this_command_key_count
== 0
3169 || this_command_key_count_reset
)
3173 /* Don't echo mouse motion events. */
3174 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3175 && NILP (Fzerop (Vecho_keystrokes
))
3176 && ! (EVENT_HAS_PARAMETERS (c
)
3177 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3180 if (! NILP (also_record
))
3181 echo_char (also_record
);
3182 /* Once we reread a character, echoing can happen
3183 the next time we pause to read a new one. */
3184 ok_to_echo_at_next_pause
= current_kboard
;
3187 /* Record this character as part of the current key. */
3188 add_command_key (c
);
3189 if (! NILP (also_record
))
3190 add_command_key (also_record
);
3193 last_input_event
= c
;
3196 /* Process the help character specially if enabled. */
3197 if (!NILP (Vhelp_form
) && help_char_p (c
))
3199 ptrdiff_t count
= SPECPDL_INDEX ();
3201 help_form_saved_window_configs
3202 = Fcons (Fcurrent_window_configuration (Qnil
),
3203 help_form_saved_window_configs
);
3204 record_unwind_protect_void (read_char_help_form_unwind
);
3205 call0 (Qhelp_form_show
);
3210 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3211 if (EVENT_HAS_PARAMETERS (c
)
3212 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3213 XSETCAR (help_form_saved_window_configs
, Qnil
);
3215 while (BUFFERP (c
));
3216 /* Remove the help from the frame. */
3217 unbind_to (count
, Qnil
);
3220 if (EQ (c
, make_number (040)))
3224 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3225 while (BUFFERP (c
));
3234 /* Record a key that came from a mouse menu.
3235 Record it for echoing, for this-command-keys, and so on. */
3238 record_menu_key (Lisp_Object c
)
3240 /* Wipe the echo area. */
3241 clear_message (1, 0);
3246 before_command_key_count
= this_command_key_count
;
3247 before_command_echo_length
= echo_length ();
3250 /* Don't echo mouse motion events. */
3251 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3252 && NILP (Fzerop (Vecho_keystrokes
)))
3256 /* Once we reread a character, echoing can happen
3257 the next time we pause to read a new one. */
3258 ok_to_echo_at_next_pause
= 0;
3261 /* Record this character as part of the current key. */
3262 add_command_key (c
);
3264 /* Re-reading in the middle of a command. */
3265 last_input_event
= c
;
3269 /* Return true if should recognize C as "the help character". */
3272 help_char_p (Lisp_Object c
)
3276 if (EQ (c
, Vhelp_char
))
3278 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3279 if (EQ (c
, XCAR (tail
)))
3284 /* Record the input event C in various ways. */
3287 record_char (Lisp_Object c
)
3291 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3293 /* To avoid filling recent_keys with help-echo and mouse-movement
3294 events, we filter out repeated help-echo events, only store the
3295 first and last in a series of mouse-movement events, and don't
3296 store repeated help-echo events which are only separated by
3297 mouse-movement events. */
3299 Lisp_Object ev1
, ev2
, ev3
;
3302 if ((ix1
= recent_keys_index
- 1) < 0)
3303 ix1
= NUM_RECENT_KEYS
- 1;
3304 ev1
= AREF (recent_keys
, ix1
);
3306 if ((ix2
= ix1
- 1) < 0)
3307 ix2
= NUM_RECENT_KEYS
- 1;
3308 ev2
= AREF (recent_keys
, ix2
);
3310 if ((ix3
= ix2
- 1) < 0)
3311 ix3
= NUM_RECENT_KEYS
- 1;
3312 ev3
= AREF (recent_keys
, ix3
);
3314 if (EQ (XCAR (c
), Qhelp_echo
))
3316 /* Don't record `help-echo' in recent_keys unless it shows some help
3317 message, and a different help than the previously recorded
3319 Lisp_Object help
, last_help
;
3321 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3322 if (!STRINGP (help
))
3324 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3325 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3327 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3328 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3329 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3331 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3332 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3333 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3334 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3337 else if (EQ (XCAR (c
), Qmouse_movement
))
3339 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3340 So additional mouse movement events replace the last element. */
3341 Lisp_Object last_window
, window
;
3343 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3344 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3345 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3346 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3347 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3349 ASET (recent_keys
, ix1
, c
);
3355 store_kbd_macro_char (c
);
3359 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3360 ASET (recent_keys
, recent_keys_index
, c
);
3361 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3362 recent_keys_index
= 0;
3364 else if (recorded
< 0)
3366 /* We need to remove one or two events from recent_keys.
3367 To do this, we simply put nil at those events and move the
3368 recent_keys_index backwards over those events. Usually,
3369 users will never see those nil events, as they will be
3370 overwritten by the command keys entered to see recent_keys
3373 while (recorded
++ < 0 && total_keys
> 0)
3375 if (total_keys
< NUM_RECENT_KEYS
)
3377 if (--recent_keys_index
< 0)
3378 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3379 ASET (recent_keys
, recent_keys_index
, Qnil
);
3383 num_nonmacro_input_events
++;
3385 /* Write c to the dribble file. If c is a lispy event, write
3386 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3387 If you, dear reader, have a better idea, you've got the source. :-) */
3393 if (XUINT (c
) < 0x100)
3394 putc (XUINT (c
), dribble
);
3396 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3400 Lisp_Object dribblee
;
3402 /* If it's a structured event, take the event header. */
3403 dribblee
= EVENT_HEAD (c
);
3405 if (SYMBOLP (dribblee
))
3407 putc ('<', dribble
);
3408 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3409 SBYTES (SYMBOL_NAME (dribblee
)),
3411 putc ('>', dribble
);
3420 /* Copy out or in the info on where C-g should throw to.
3421 This is used when running Lisp code from within get_char,
3422 in case get_char is called recursively.
3423 See read_process_output. */
3426 save_getcjmp (sys_jmp_buf temp
)
3428 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3432 restore_getcjmp (sys_jmp_buf temp
)
3434 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3437 /* Low level keyboard/mouse input.
3438 kbd_buffer_store_event places events in kbd_buffer, and
3439 kbd_buffer_get_event retrieves them. */
3441 /* Return true if there are any events in the queue that read-char
3442 would return. If this returns false, a read-char would block. */
3444 readable_events (int flags
)
3446 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3449 /* If the buffer contains only FOCUS_IN_EVENT events, and
3450 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3451 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3453 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3454 #ifdef USE_TOOLKIT_SCROLL_BARS
3455 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3459 struct input_event
*event
;
3461 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3468 #ifdef USE_TOOLKIT_SCROLL_BARS
3469 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3471 event
->kind
== FOCUS_IN_EVENT
)
3472 #ifdef USE_TOOLKIT_SCROLL_BARS
3473 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3474 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3475 && event
->part
== scroll_bar_handle
3476 && event
->modifiers
== 0)
3481 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3484 while (event
!= kbd_store_ptr
);
3490 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3491 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3495 if (current_kboard
->kbd_queue_has_data
)
3501 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3502 if (kb
->kbd_queue_has_data
)
3508 /* Set this for debugging, to have a way to get out */
3509 int stop_character EXTERNALLY_VISIBLE
;
3512 event_to_kboard (struct input_event
*event
)
3514 /* Not applicable for these special events. */
3515 if (event
->kind
== SELECTION_REQUEST_EVENT
3516 || event
->kind
== SELECTION_CLEAR_EVENT
)
3520 Lisp_Object obj
= event
->frame_or_window
;
3521 /* There are some events that set this field to nil or string. */
3523 obj
= WINDOW_FRAME (XWINDOW (obj
));
3524 /* Also ignore dead frames here. */
3525 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3526 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3531 /* Return the number of slots occupied in kbd_buffer. */
3534 kbd_buffer_nr_stored (void)
3536 return kbd_fetch_ptr
== kbd_store_ptr
3538 : (kbd_fetch_ptr
< kbd_store_ptr
3539 ? kbd_store_ptr
- kbd_fetch_ptr
3540 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3541 + (kbd_store_ptr
- kbd_buffer
)));
3543 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3546 kbd_buffer_store_event (register struct input_event
*event
)
3548 kbd_buffer_store_event_hold (event
, 0);
3551 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3553 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3554 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3555 Else, if EVENT is a quit event, store the quit event
3556 in HOLD_QUIT, and return (thus ignoring further events).
3558 This is used to postpone the processing of the quit event until all
3559 subsequent input events have been parsed (and discarded). */
3562 kbd_buffer_store_event_hold (register struct input_event
*event
,
3563 struct input_event
*hold_quit
)
3565 if (event
->kind
== NO_EVENT
)
3568 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3571 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3573 register int c
= event
->code
& 0377;
3575 if (event
->modifiers
& ctrl_modifier
)
3576 c
= make_ctrl_char (c
);
3578 c
|= (event
->modifiers
3579 & (meta_modifier
| alt_modifier
3580 | hyper_modifier
| super_modifier
));
3584 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3585 struct input_event
*sp
;
3587 if (single_kboard
&& kb
!= current_kboard
)
3590 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3592 kb
->kbd_queue_has_data
= 1;
3593 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3595 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3598 if (event_to_kboard (sp
) == kb
)
3600 sp
->kind
= NO_EVENT
;
3601 sp
->frame_or_window
= Qnil
;
3610 *hold_quit
= *event
;
3614 /* If this results in a quit_char being returned to Emacs as
3615 input, set Vlast_event_frame properly. If this doesn't
3616 get returned to Emacs as an event, the next event read
3617 will set Vlast_event_frame again, so this is safe to do. */
3621 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3623 focus
= event
->frame_or_window
;
3624 internal_last_event_frame
= focus
;
3625 Vlast_event_frame
= focus
;
3628 handle_interrupt (0);
3632 if (c
&& c
== stop_character
)
3638 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3639 Just ignore the second one. */
3640 else if (event
->kind
== BUFFER_SWITCH_EVENT
3641 && kbd_fetch_ptr
!= kbd_store_ptr
3642 && ((kbd_store_ptr
== kbd_buffer
3643 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3644 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3647 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3648 kbd_store_ptr
= kbd_buffer
;
3650 /* Don't let the very last slot in the buffer become full,
3651 since that would make the two pointers equal,
3652 and that is indistinguishable from an empty buffer.
3653 Discard the event if it would fill the last slot. */
3654 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3656 *kbd_store_ptr
= *event
;
3659 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3661 /* Don't read keyboard input until we have processed kbd_buffer.
3662 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3663 hold_keyboard_input ();
3664 if (!noninteractive
)
3668 #endif /* subprocesses */
3671 /* If we're inside while-no-input, and this event qualifies
3672 as input, set quit-flag to cause an interrupt. */
3673 if (!NILP (Vthrow_on_input
)
3674 && event
->kind
!= FOCUS_IN_EVENT
3675 && event
->kind
!= HELP_EVENT
3676 && event
->kind
!= DEICONIFY_EVENT
)
3678 Vquit_flag
= Vthrow_on_input
;
3679 /* If we're inside a function that wants immediate quits,
3681 if (immediate_quit
&& NILP (Vinhibit_quit
))
3690 /* Put an input event back in the head of the event queue. */
3693 kbd_buffer_unget_event (register struct input_event
*event
)
3695 if (kbd_fetch_ptr
== kbd_buffer
)
3696 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3698 /* Don't let the very last slot in the buffer become full, */
3699 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3702 *kbd_fetch_ptr
= *event
;
3707 /* Generate a HELP_EVENT input_event and store it in the keyboard
3710 HELP is the help form.
3712 FRAME and WINDOW are the frame and window where the help is
3713 generated. OBJECT is the Lisp object where the help was found (a
3714 buffer, a string, an overlay, or nil if neither from a string nor
3715 from a buffer). POS is the position within OBJECT where the help
3719 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3720 Lisp_Object object
, ptrdiff_t pos
)
3722 struct input_event event
;
3726 event
.kind
= HELP_EVENT
;
3727 event
.frame_or_window
= frame
;
3729 event
.x
= WINDOWP (window
) ? window
: frame
;
3732 kbd_buffer_store_event (&event
);
3736 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3739 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3741 struct input_event event
;
3743 event
.kind
= HELP_EVENT
;
3744 event
.frame_or_window
= frame
;
3749 kbd_buffer_store_event (&event
);
3753 /* Discard any mouse events in the event buffer by setting them to
3756 discard_mouse_events (void)
3758 struct input_event
*sp
;
3759 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3761 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3764 if (sp
->kind
== MOUSE_CLICK_EVENT
3765 || sp
->kind
== WHEEL_EVENT
3766 || sp
->kind
== HORIZ_WHEEL_EVENT
3768 || sp
->kind
== GPM_CLICK_EVENT
3770 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3772 sp
->kind
= NO_EVENT
;
3778 /* Return true if there are any real events waiting in the event
3779 buffer, not counting `NO_EVENT's.
3781 Discard NO_EVENT events at the front of the input queue, possibly
3782 leaving the input queue empty if there are no real input events. */
3785 kbd_buffer_events_waiting (void)
3787 struct input_event
*sp
;
3789 for (sp
= kbd_fetch_ptr
;
3790 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3793 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3798 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3802 /* Clear input event EVENT. */
3805 clear_event (struct input_event
*event
)
3807 event
->kind
= NO_EVENT
;
3811 /* Read one event from the event buffer, waiting if necessary.
3812 The value is a Lisp object representing the event.
3813 The value is nil for an event that should be ignored,
3814 or that was handled here.
3815 We always read and discard one event. */
3818 kbd_buffer_get_event (KBOARD
**kbp
,
3819 bool *used_mouse_menu
,
3820 struct timespec
*end_time
)
3825 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3827 /* Start reading input again because we have processed enough to
3828 be able to accept new events again. */
3829 unhold_keyboard_input ();
3832 #endif /* subprocesses */
3834 #if !defined HAVE_DBUS && !defined USE_FILE_NOTIFY
3836 /* In case we are running as a daemon, only do this before
3837 detaching from the terminal. */
3838 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3842 *kbp
= current_kboard
;
3845 #endif /* !defined HAVE_DBUS && !defined USE_FILE_NOTIFY */
3847 /* Wait until there is input available. */
3850 /* Break loop if there's an unread command event. Needed in
3851 moused window autoselection which uses a timer to insert such
3853 if (CONSP (Vunread_command_events
))
3856 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3858 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3861 /* If the quit flag is set, then read_char will return
3862 quit_char, so that counts as "available input." */
3863 if (!NILP (Vquit_flag
))
3864 quit_throw_to_read_char (0);
3866 /* One way or another, wait until input is available; then, if
3867 interrupt handlers have not read it, read it now. */
3872 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3874 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3878 struct timespec now
= current_timespec ();
3879 if (timespec_cmp (*end_time
, now
) <= 0)
3880 return Qnil
; /* Finished waiting. */
3883 struct timespec duration
= timespec_sub (*end_time
, now
);
3884 wait_reading_process_output (min (duration
.tv_sec
,
3887 -1, 1, Qnil
, NULL
, 0);
3892 bool do_display
= true;
3894 if (FRAME_TERMCAP_P (SELECTED_FRAME ()))
3896 struct tty_display_info
*tty
= CURTTY ();
3898 /* When this TTY is displaying a menu, we must prevent
3899 any redisplay, because we modify the frame's glyph
3900 matrix behind the back of the display engine. */
3901 if (tty
->showing_menu
)
3905 wait_reading_process_output (0, 0, -1, do_display
, Qnil
, NULL
, 0);
3908 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3912 if (CONSP (Vunread_command_events
))
3915 first
= XCAR (Vunread_command_events
);
3916 Vunread_command_events
= XCDR (Vunread_command_events
);
3917 *kbp
= current_kboard
;
3921 /* At this point, we know that there is a readable event available
3922 somewhere. If the event queue is empty, then there must be a
3923 mouse movement enabled and available. */
3924 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3926 struct input_event
*event
;
3928 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3932 *kbp
= event_to_kboard (event
);
3934 *kbp
= current_kboard
; /* Better than returning null ptr? */
3938 /* These two kinds of events get special handling
3939 and don't actually appear to the command loop.
3940 We return nil for them. */
3941 if (event
->kind
== SELECTION_REQUEST_EVENT
3942 || event
->kind
== SELECTION_CLEAR_EVENT
)
3945 struct input_event copy
;
3947 /* Remove it from the buffer before processing it,
3948 since otherwise swallow_events will see it
3949 and process it again. */
3951 kbd_fetch_ptr
= event
+ 1;
3952 input_pending
= readable_events (0);
3953 x_handle_selection_event (©
);
3955 /* We're getting selection request events, but we don't have
3961 #if defined (HAVE_NS)
3962 else if (event
->kind
== NS_TEXT_EVENT
)
3964 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3965 obj
= list1 (intern ("ns-put-working-text"));
3967 obj
= list1 (intern ("ns-unput-working-text"));
3968 kbd_fetch_ptr
= event
+ 1;
3969 if (used_mouse_menu
)
3970 *used_mouse_menu
= 1;
3974 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3975 || defined (HAVE_NS)
3976 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3978 /* Make an event (delete-frame (FRAME)). */
3979 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3980 kbd_fetch_ptr
= event
+ 1;
3983 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3984 || defined (HAVE_NS)
3985 else if (event
->kind
== ICONIFY_EVENT
)
3987 /* Make an event (iconify-frame (FRAME)). */
3988 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3989 kbd_fetch_ptr
= event
+ 1;
3991 else if (event
->kind
== DEICONIFY_EVENT
)
3993 /* Make an event (make-frame-visible (FRAME)). */
3994 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3995 kbd_fetch_ptr
= event
+ 1;
3998 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
4000 /* The value doesn't matter here; only the type is tested. */
4001 XSETBUFFER (obj
, current_buffer
);
4002 kbd_fetch_ptr
= event
+ 1;
4004 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4005 || defined (HAVE_NS) || defined (USE_GTK)
4006 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
4008 kbd_fetch_ptr
= event
+ 1;
4009 input_pending
= readable_events (0);
4010 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
4011 x_activate_menubar (XFRAME (event
->frame_or_window
));
4015 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
4017 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
4018 obj
= list4 (Qlanguage_change
,
4019 event
->frame_or_window
,
4020 make_number (event
->code
),
4021 make_number (event
->modifiers
));
4022 kbd_fetch_ptr
= event
+ 1;
4025 #ifdef USE_FILE_NOTIFY
4026 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4028 #ifdef HAVE_W32NOTIFY
4029 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4030 obj
= list3 (Qfile_notify
,
4031 list3 (make_number (event
->code
),
4034 event
->frame_or_window
);
4036 obj
= make_lispy_event (event
);
4038 kbd_fetch_ptr
= event
+ 1;
4040 #endif /* USE_FILE_NOTIFY */
4041 else if (event
->kind
== SAVE_SESSION_EVENT
)
4043 obj
= list2 (Qsave_session
, event
->arg
);
4044 kbd_fetch_ptr
= event
+ 1;
4046 /* Just discard these, by returning nil.
4047 With MULTI_KBOARD, these events are used as placeholders
4048 when we need to randomly delete events from the queue.
4049 (They shouldn't otherwise be found in the buffer,
4050 but on some machines it appears they do show up
4051 even without MULTI_KBOARD.) */
4052 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4053 mouse events during a popup-menu call. */
4054 else if (event
->kind
== NO_EVENT
)
4055 kbd_fetch_ptr
= event
+ 1;
4056 else if (event
->kind
== HELP_EVENT
)
4058 Lisp_Object object
, position
, help
, frame
, window
;
4060 frame
= event
->frame_or_window
;
4061 object
= event
->arg
;
4062 position
= make_number (event
->code
);
4065 clear_event (event
);
4067 kbd_fetch_ptr
= event
+ 1;
4068 if (!WINDOWP (window
))
4070 obj
= Fcons (Qhelp_echo
,
4071 list5 (frame
, help
, window
, object
, position
));
4073 else if (event
->kind
== FOCUS_IN_EVENT
)
4075 /* Notification of a FocusIn event. The frame receiving the
4076 focus is in event->frame_or_window. Generate a
4077 switch-frame event if necessary. */
4078 Lisp_Object frame
, focus
;
4080 frame
= event
->frame_or_window
;
4081 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4090 !EQ (frame
, internal_last_event_frame
)
4091 && !EQ (frame
, selected_frame
))
4092 obj
= make_lispy_switch_frame (frame
);
4094 obj
= make_lispy_focus_in (frame
);
4096 internal_last_event_frame
= frame
;
4097 kbd_fetch_ptr
= event
+ 1;
4099 else if (event
->kind
== FOCUS_OUT_EVENT
)
4101 #ifdef HAVE_WINDOW_SYSTEM
4104 Lisp_Object frame
= event
->frame_or_window
;
4105 bool focused
= false;
4107 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4108 focused
= di
->x_highlight_frame
!= 0;
4111 obj
= make_lispy_focus_out (frame
);
4113 #endif /* HAVE_WINDOW_SYSTEM */
4115 kbd_fetch_ptr
= event
+ 1;
4118 else if (event
->kind
== DBUS_EVENT
)
4120 obj
= make_lispy_event (event
);
4121 kbd_fetch_ptr
= event
+ 1;
4124 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4126 obj
= make_lispy_event (event
);
4127 kbd_fetch_ptr
= event
+ 1;
4131 /* If this event is on a different frame, return a switch-frame this
4132 time, and leave the event in the queue for next time. */
4136 frame
= event
->frame_or_window
;
4138 frame
= XCAR (frame
);
4139 else if (WINDOWP (frame
))
4140 frame
= WINDOW_FRAME (XWINDOW (frame
));
4142 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4146 if (! EQ (frame
, internal_last_event_frame
)
4147 && !EQ (frame
, selected_frame
))
4148 obj
= make_lispy_switch_frame (frame
);
4149 internal_last_event_frame
= frame
;
4151 /* If we didn't decide to make a switch-frame event, go ahead
4152 and build a real event from the queue entry. */
4156 obj
= make_lispy_event (event
);
4158 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4159 || defined (HAVE_NS) || defined (USE_GTK)
4160 /* If this was a menu selection, then set the flag to inhibit
4161 writing to last_nonmenu_event. Don't do this if the event
4162 we're returning is (menu-bar), though; that indicates the
4163 beginning of the menu sequence, and we might as well leave
4164 that as the `event with parameters' for this selection. */
4166 && !EQ (event
->frame_or_window
, event
->arg
)
4167 && (event
->kind
== MENU_BAR_EVENT
4168 || event
->kind
== TOOL_BAR_EVENT
))
4169 *used_mouse_menu
= 1;
4172 /* Certain system events are non-key events. */
4174 && event
->kind
== NS_NONKEY_EVENT
)
4175 *used_mouse_menu
= 1;
4178 /* Wipe out this event, to catch bugs. */
4179 clear_event (event
);
4180 kbd_fetch_ptr
= event
+ 1;
4184 /* Try generating a mouse motion event. */
4185 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4187 struct frame
*f
= some_mouse_moved ();
4188 Lisp_Object bar_window
;
4189 enum scroll_bar_part part
;
4193 *kbp
= current_kboard
;
4194 /* Note that this uses F to determine which terminal to look at.
4195 If there is no valid info, it does not store anything
4196 so x remains nil. */
4199 /* XXX Can f or mouse_position_hook be NULL here? */
4200 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4201 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4206 /* Decide if we should generate a switch-frame event. Don't
4207 generate switch-frame events for motion outside of all Emacs
4213 frame
= FRAME_FOCUS_FRAME (f
);
4215 XSETFRAME (frame
, f
);
4217 if (! EQ (frame
, internal_last_event_frame
)
4218 && !EQ (frame
, selected_frame
))
4219 obj
= make_lispy_switch_frame (frame
);
4220 internal_last_event_frame
= frame
;
4223 /* If we didn't decide to make a switch-frame event, go ahead and
4224 return a mouse-motion event. */
4225 if (!NILP (x
) && NILP (obj
))
4226 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4229 /* We were promised by the above while loop that there was
4230 something for us to read! */
4233 input_pending
= readable_events (0);
4235 Vlast_event_frame
= internal_last_event_frame
;
4240 /* Process any non-user-visible events (currently X selection events),
4241 without reading any user-visible events. */
4244 process_special_events (void)
4246 struct input_event
*event
;
4248 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4250 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4253 if (event
== kbd_store_ptr
)
4257 /* If we find a stored X selection request, handle it now. */
4258 if (event
->kind
== SELECTION_REQUEST_EVENT
4259 || event
->kind
== SELECTION_CLEAR_EVENT
)
4263 /* Remove the event from the fifo buffer before processing;
4264 otherwise swallow_events called recursively could see it
4265 and process it again. To do this, we move the events
4266 between kbd_fetch_ptr and EVENT one slot to the right,
4269 struct input_event copy
= *event
;
4270 struct input_event
*beg
4271 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4272 ? kbd_buffer
: kbd_fetch_ptr
;
4275 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4276 else if (event
< beg
)
4278 if (event
> kbd_buffer
)
4279 memmove (kbd_buffer
+ 1, kbd_buffer
,
4280 (event
- kbd_buffer
) * sizeof (struct input_event
));
4281 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4282 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4283 memmove (beg
+ 1, beg
,
4284 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4285 * sizeof (struct input_event
));
4288 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4289 kbd_fetch_ptr
= kbd_buffer
+ 1;
4293 input_pending
= readable_events (0);
4294 x_handle_selection_event (©
);
4296 /* We're getting selection request events, but we don't have
4304 /* Process any events that are not user-visible, run timer events that
4305 are ripe, and return, without reading any user-visible events. */
4308 swallow_events (bool do_display
)
4310 unsigned old_timers_run
;
4312 process_special_events ();
4314 old_timers_run
= timers_run
;
4315 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4317 if (timers_run
!= old_timers_run
&& do_display
)
4318 redisplay_preserve_echo_area (7);
4321 /* Record the start of when Emacs is idle,
4322 for the sake of running idle-time timers. */
4325 timer_start_idle (void)
4327 /* If we are already in the idle state, do nothing. */
4328 if (timespec_valid_p (timer_idleness_start_time
))
4331 timer_idleness_start_time
= current_timespec ();
4332 timer_last_idleness_start_time
= timer_idleness_start_time
;
4334 /* Mark all idle-time timers as once again candidates for running. */
4335 call0 (intern ("internal-timer-start-idle"));
4338 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4341 timer_stop_idle (void)
4343 timer_idleness_start_time
= invalid_timespec ();
4346 /* Resume idle timer from last idle start time. */
4349 timer_resume_idle (void)
4351 if (timespec_valid_p (timer_idleness_start_time
))
4354 timer_idleness_start_time
= timer_last_idleness_start_time
;
4357 /* This is only for debugging. */
4358 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4360 /* List of elisp functions to call, delayed because they were generated in
4361 a context where Elisp could not be safely run (e.g. redisplay, signal,
4362 ...). Each element has the form (FUN . ARGS). */
4363 Lisp_Object pending_funcalls
;
4365 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4367 decode_timer (Lisp_Object timer
, struct timespec
*result
)
4369 Lisp_Object
*vector
;
4371 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4373 vector
= XVECTOR (timer
)->contents
;
4374 if (! NILP (vector
[0]))
4377 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4382 /* Check whether a timer has fired. To prevent larger problems we simply
4383 disregard elements that are not proper timers. Do not make a circular
4384 timer list for the time being.
4386 Returns the time to wait until the next timer fires. If a
4387 timer is triggering now, return zero.
4388 If no timer is active, return -1.
4390 If a timer is ripe, we run it, with quitting turned off.
4391 In that case we return 0 to indicate that a new timer_check_2 call
4394 static struct timespec
4395 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4397 struct timespec nexttime
;
4398 struct timespec now
;
4399 struct timespec idleness_now
;
4400 Lisp_Object chosen_timer
;
4401 struct gcpro gcpro1
;
4403 nexttime
= invalid_timespec ();
4405 chosen_timer
= Qnil
;
4406 GCPRO1 (chosen_timer
);
4408 /* First run the code that was delayed. */
4409 while (CONSP (pending_funcalls
))
4411 Lisp_Object funcall
= XCAR (pending_funcalls
);
4412 pending_funcalls
= XCDR (pending_funcalls
);
4413 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4416 if (CONSP (timers
) || CONSP (idle_timers
))
4418 now
= current_timespec ();
4419 idleness_now
= (timespec_valid_p (timer_idleness_start_time
)
4420 ? timespec_sub (now
, timer_idleness_start_time
)
4421 : make_timespec (0, 0));
4424 while (CONSP (timers
) || CONSP (idle_timers
))
4426 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4427 struct timespec timer_time
, idle_timer_time
;
4428 struct timespec difference
;
4429 struct timespec timer_difference
= invalid_timespec ();
4430 struct timespec idle_timer_difference
= invalid_timespec ();
4431 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4433 /* Set TIMER and TIMER_DIFFERENCE
4434 based on the next ordinary timer.
4435 TIMER_DIFFERENCE is the distance in time from NOW to when
4436 this timer becomes ripe (negative if it's already ripe).
4437 Skip past invalid timers and timers already handled. */
4440 timer
= XCAR (timers
);
4441 if (! decode_timer (timer
, &timer_time
))
4443 timers
= XCDR (timers
);
4447 timer_ripe
= timespec_cmp (timer_time
, now
) <= 0;
4448 timer_difference
= (timer_ripe
4449 ? timespec_sub (now
, timer_time
)
4450 : timespec_sub (timer_time
, now
));
4453 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4454 based on the next idle timer. */
4455 if (CONSP (idle_timers
))
4457 idle_timer
= XCAR (idle_timers
);
4458 if (! decode_timer (idle_timer
, &idle_timer_time
))
4460 idle_timers
= XCDR (idle_timers
);
4464 idle_timer_ripe
= timespec_cmp (idle_timer_time
, idleness_now
) <= 0;
4465 idle_timer_difference
4467 ? timespec_sub (idleness_now
, idle_timer_time
)
4468 : timespec_sub (idle_timer_time
, idleness_now
));
4471 /* Decide which timer is the next timer,
4472 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4473 Also step down the list where we found that timer. */
4475 if (timespec_valid_p (timer_difference
)
4476 && (! timespec_valid_p (idle_timer_difference
)
4477 || idle_timer_ripe
< timer_ripe
4478 || (idle_timer_ripe
== timer_ripe
4480 ? timespec_cmp (idle_timer_difference
,
4482 : timespec_cmp (timer_difference
,
4483 idle_timer_difference
))
4486 chosen_timer
= timer
;
4487 timers
= XCDR (timers
);
4488 difference
= timer_difference
;
4493 chosen_timer
= idle_timer
;
4494 idle_timers
= XCDR (idle_timers
);
4495 difference
= idle_timer_difference
;
4496 ripe
= idle_timer_ripe
;
4499 /* If timer is ripe, run it if it hasn't been run. */
4502 if (NILP (AREF (chosen_timer
, 0)))
4504 ptrdiff_t count
= SPECPDL_INDEX ();
4505 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4507 /* Mark the timer as triggered to prevent problems if the lisp
4508 code fails to reschedule it right. */
4509 ASET (chosen_timer
, 0, Qt
);
4511 specbind (Qinhibit_quit
, Qt
);
4513 call1 (Qtimer_event_handler
, chosen_timer
);
4514 Vdeactivate_mark
= old_deactivate_mark
;
4516 unbind_to (count
, Qnil
);
4518 /* Since we have handled the event,
4519 we don't need to tell the caller to wake up and do it. */
4520 /* But the caller must still wait for the next timer, so
4521 return 0 to indicate that. */
4524 nexttime
= make_timespec (0, 0);
4528 /* When we encounter a timer that is still waiting,
4529 return the amount of time to wait before it is ripe. */
4536 /* No timers are pending in the future. */
4537 /* Return 0 if we generated an event, and -1 if not. */
4543 /* Check whether a timer has fired. To prevent larger problems we simply
4544 disregard elements that are not proper timers. Do not make a circular
4545 timer list for the time being.
4547 Returns the time to wait until the next timer fires.
4548 If no timer is active, return an invalid value.
4550 As long as any timer is ripe, we run it. */
4555 struct timespec nexttime
;
4556 Lisp_Object timers
, idle_timers
;
4557 struct gcpro gcpro1
, gcpro2
;
4559 Lisp_Object tem
= Vinhibit_quit
;
4562 /* We use copies of the timers' lists to allow a timer to add itself
4563 again, without locking up Emacs if the newly added timer is
4564 already ripe when added. */
4566 /* Always consider the ordinary timers. */
4567 timers
= Fcopy_sequence (Vtimer_list
);
4568 /* Consider the idle timers only if Emacs is idle. */
4569 if (timespec_valid_p (timer_idleness_start_time
))
4570 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4574 Vinhibit_quit
= tem
;
4576 GCPRO2 (timers
, idle_timers
);
4580 nexttime
= timer_check_2 (timers
, idle_timers
);
4582 while (nexttime
.tv_sec
== 0 && nexttime
.tv_nsec
== 0);
4588 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4589 doc
: /* Return the current length of Emacs idleness, or nil.
4590 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4591 in the same style as (current-time).
4593 The value when Emacs is not idle is nil.
4595 PSEC is a multiple of the system clock resolution. */)
4598 if (timespec_valid_p (timer_idleness_start_time
))
4599 return make_lisp_time (timespec_sub (current_timespec (),
4600 timer_idleness_start_time
));
4605 /* Caches for modify_event_symbol. */
4606 static Lisp_Object accent_key_syms
;
4607 static Lisp_Object func_key_syms
;
4608 static Lisp_Object mouse_syms
;
4609 static Lisp_Object wheel_syms
;
4610 static Lisp_Object drag_n_drop_syms
;
4612 /* This is a list of keysym codes for special "accent" characters.
4613 It parallels lispy_accent_keys. */
4615 static const int lispy_accent_codes
[] =
4617 #ifdef XK_dead_circumflex
4622 #ifdef XK_dead_grave
4627 #ifdef XK_dead_tilde
4632 #ifdef XK_dead_diaeresis
4637 #ifdef XK_dead_macron
4642 #ifdef XK_dead_degree
4647 #ifdef XK_dead_acute
4652 #ifdef XK_dead_cedilla
4657 #ifdef XK_dead_breve
4662 #ifdef XK_dead_ogonek
4667 #ifdef XK_dead_caron
4672 #ifdef XK_dead_doubleacute
4673 XK_dead_doubleacute
,
4677 #ifdef XK_dead_abovedot
4682 #ifdef XK_dead_abovering
4692 #ifdef XK_dead_belowdot
4697 #ifdef XK_dead_voiced_sound
4698 XK_dead_voiced_sound
,
4702 #ifdef XK_dead_semivoiced_sound
4703 XK_dead_semivoiced_sound
,
4719 /* This is a list of Lisp names for special "accent" characters.
4720 It parallels lispy_accent_codes. */
4722 static const char *const lispy_accent_keys
[] =
4740 "dead-voiced-sound",
4741 "dead-semivoiced-sound",
4747 #define FUNCTION_KEY_OFFSET 0x0
4749 const char *const lispy_function_keys
[] =
4753 0, /* VK_LBUTTON 0x01 */
4754 0, /* VK_RBUTTON 0x02 */
4755 "cancel", /* VK_CANCEL 0x03 */
4756 0, /* VK_MBUTTON 0x04 */
4758 0, 0, 0, /* 0x05 .. 0x07 */
4760 "backspace", /* VK_BACK 0x08 */
4761 "tab", /* VK_TAB 0x09 */
4763 0, 0, /* 0x0A .. 0x0B */
4765 "clear", /* VK_CLEAR 0x0C */
4766 "return", /* VK_RETURN 0x0D */
4768 0, 0, /* 0x0E .. 0x0F */
4770 0, /* VK_SHIFT 0x10 */
4771 0, /* VK_CONTROL 0x11 */
4772 0, /* VK_MENU 0x12 */
4773 "pause", /* VK_PAUSE 0x13 */
4774 "capslock", /* VK_CAPITAL 0x14 */
4775 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4777 "junja", /* VK_JUNJA 0x17 */
4778 "final", /* VK_FINAL 0x18 */
4779 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4781 "escape", /* VK_ESCAPE 0x1B */
4782 "convert", /* VK_CONVERT 0x1C */
4783 "non-convert", /* VK_NONCONVERT 0x1D */
4784 "accept", /* VK_ACCEPT 0x1E */
4785 "mode-change", /* VK_MODECHANGE 0x1F */
4786 0, /* VK_SPACE 0x20 */
4787 "prior", /* VK_PRIOR 0x21 */
4788 "next", /* VK_NEXT 0x22 */
4789 "end", /* VK_END 0x23 */
4790 "home", /* VK_HOME 0x24 */
4791 "left", /* VK_LEFT 0x25 */
4792 "up", /* VK_UP 0x26 */
4793 "right", /* VK_RIGHT 0x27 */
4794 "down", /* VK_DOWN 0x28 */
4795 "select", /* VK_SELECT 0x29 */
4796 "print", /* VK_PRINT 0x2A */
4797 "execute", /* VK_EXECUTE 0x2B */
4798 "snapshot", /* VK_SNAPSHOT 0x2C */
4799 "insert", /* VK_INSERT 0x2D */
4800 "delete", /* VK_DELETE 0x2E */
4801 "help", /* VK_HELP 0x2F */
4803 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4805 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4807 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4809 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4811 0, 0, 0, 0, 0, 0, 0, 0, 0,
4812 0, 0, 0, 0, 0, 0, 0, 0, 0,
4813 0, 0, 0, 0, 0, 0, 0, 0,
4815 "lwindow", /* VK_LWIN 0x5B */
4816 "rwindow", /* VK_RWIN 0x5C */
4817 "apps", /* VK_APPS 0x5D */
4820 "kp-0", /* VK_NUMPAD0 0x60 */
4821 "kp-1", /* VK_NUMPAD1 0x61 */
4822 "kp-2", /* VK_NUMPAD2 0x62 */
4823 "kp-3", /* VK_NUMPAD3 0x63 */
4824 "kp-4", /* VK_NUMPAD4 0x64 */
4825 "kp-5", /* VK_NUMPAD5 0x65 */
4826 "kp-6", /* VK_NUMPAD6 0x66 */
4827 "kp-7", /* VK_NUMPAD7 0x67 */
4828 "kp-8", /* VK_NUMPAD8 0x68 */
4829 "kp-9", /* VK_NUMPAD9 0x69 */
4830 "kp-multiply", /* VK_MULTIPLY 0x6A */
4831 "kp-add", /* VK_ADD 0x6B */
4832 "kp-separator", /* VK_SEPARATOR 0x6C */
4833 "kp-subtract", /* VK_SUBTRACT 0x6D */
4834 "kp-decimal", /* VK_DECIMAL 0x6E */
4835 "kp-divide", /* VK_DIVIDE 0x6F */
4836 "f1", /* VK_F1 0x70 */
4837 "f2", /* VK_F2 0x71 */
4838 "f3", /* VK_F3 0x72 */
4839 "f4", /* VK_F4 0x73 */
4840 "f5", /* VK_F5 0x74 */
4841 "f6", /* VK_F6 0x75 */
4842 "f7", /* VK_F7 0x76 */
4843 "f8", /* VK_F8 0x77 */
4844 "f9", /* VK_F9 0x78 */
4845 "f10", /* VK_F10 0x79 */
4846 "f11", /* VK_F11 0x7A */
4847 "f12", /* VK_F12 0x7B */
4848 "f13", /* VK_F13 0x7C */
4849 "f14", /* VK_F14 0x7D */
4850 "f15", /* VK_F15 0x7E */
4851 "f16", /* VK_F16 0x7F */
4852 "f17", /* VK_F17 0x80 */
4853 "f18", /* VK_F18 0x81 */
4854 "f19", /* VK_F19 0x82 */
4855 "f20", /* VK_F20 0x83 */
4856 "f21", /* VK_F21 0x84 */
4857 "f22", /* VK_F22 0x85 */
4858 "f23", /* VK_F23 0x86 */
4859 "f24", /* VK_F24 0x87 */
4861 0, 0, 0, 0, /* 0x88 .. 0x8B */
4862 0, 0, 0, 0, /* 0x8C .. 0x8F */
4864 "kp-numlock", /* VK_NUMLOCK 0x90 */
4865 "scroll", /* VK_SCROLL 0x91 */
4866 /* Not sure where the following block comes from.
4867 Windows headers have NEC and Fujitsu specific keys in
4868 this block, but nothing generic. */
4869 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4870 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4871 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4872 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4873 "kp-end", /* VK_NUMPAD_END 0x96 */
4874 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4875 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4876 "kp-up", /* VK_NUMPAD_UP 0x99 */
4877 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4878 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4879 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4880 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4882 0, 0, /* 0x9E .. 0x9F */
4885 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4886 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4887 * No other API or message will distinguish left and right keys this way.
4892 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4893 to enable them selectively, and gives access to a few more functions.
4894 See lispy_multimedia_keys below. */
4895 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4896 0, 0, 0, /* 0xAD .. 0xAF Volume */
4897 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4898 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4900 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4901 0, 0, 0, 0, 0, 0, 0, 0, 0,
4903 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4904 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4905 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4908 "ax", /* VK_OEM_AX 0xE1 */
4909 0, /* VK_OEM_102 0xE2 */
4910 "ico-help", /* VK_ICO_HELP 0xE3 */
4911 "ico-00", /* VK_ICO_00 0xE4 */
4912 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4913 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4914 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4916 "reset", /* VK_OEM_RESET 0xE9 */
4917 "jump", /* VK_OEM_JUMP 0xEA */
4918 "oem-pa1", /* VK_OEM_PA1 0xEB */
4919 "oem-pa2", /* VK_OEM_PA2 0xEC */
4920 "oem-pa3", /* VK_OEM_PA3 0xED */
4921 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4922 "cusel", /* VK_OEM_CUSEL 0xEF */
4923 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4924 "finish", /* VK_OEM_FINISH 0xF1 */
4925 "copy", /* VK_OEM_COPY 0xF2 */
4926 "auto", /* VK_OEM_AUTO 0xF3 */
4927 "enlw", /* VK_OEM_ENLW 0xF4 */
4928 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4929 "attn", /* VK_ATTN 0xF6 */
4930 "crsel", /* VK_CRSEL 0xF7 */
4931 "exsel", /* VK_EXSEL 0xF8 */
4932 "ereof", /* VK_EREOF 0xF9 */
4933 "play", /* VK_PLAY 0xFA */
4934 "zoom", /* VK_ZOOM 0xFB */
4935 "noname", /* VK_NONAME 0xFC */
4936 "pa1", /* VK_PA1 0xFD */
4937 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4941 /* Some of these duplicate the "Media keys" on newer keyboards,
4942 but they are delivered to the application in a different way. */
4943 static const char *const lispy_multimedia_keys
[] =
4951 "browser-favorites",
4988 "toggle-dictate-command",
4994 "media-fast-forward",
4997 "media-channel-down"
5000 #else /* not HAVE_NTGUI */
5002 /* This should be dealt with in XTread_socket now, and that doesn't
5003 depend on the client system having the Kana syms defined. See also
5004 the XK_kana_A case below. */
5007 static const char *const lispy_kana_keys
[] =
5009 /* X Keysym value */
5010 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
5011 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
5012 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
5013 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5014 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5015 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5016 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5017 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5018 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5019 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5020 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5021 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5022 "kana-i", "kana-u", "kana-e", "kana-o",
5023 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5024 "prolongedsound", "kana-A", "kana-I", "kana-U",
5025 "kana-E", "kana-O", "kana-KA", "kana-KI",
5026 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5027 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5028 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5029 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5030 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5031 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5032 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5033 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5034 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5035 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5036 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5037 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5039 #endif /* XK_kana_A */
5042 #define FUNCTION_KEY_OFFSET 0xff00
5044 /* You'll notice that this table is arranged to be conveniently
5045 indexed by X Windows keysym values. */
5046 static const char *const lispy_function_keys
[] =
5048 /* X Keysym value */
5050 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5051 "backspace", "tab", "linefeed", "clear",
5053 0, 0, 0, "pause", /* 0xff10...1f */
5054 0, 0, 0, 0, 0, 0, 0, "escape",
5056 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5057 "romaji", "hiragana", "katakana", "hiragana-katakana",
5058 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5059 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5060 "eisu-toggle", /* 0xff30...3f */
5061 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5062 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5064 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5065 "down", "prior", "next", "end",
5066 "begin", 0, 0, 0, 0, 0, 0, 0,
5067 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5078 "break", /* 0xff6b */
5081 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5082 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5083 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5084 0, 0, 0, 0, 0, 0, 0, 0,
5085 "kp-tab", /* 0xff89 */
5087 "kp-enter", /* 0xff8d */
5089 "kp-f1", /* 0xff91 */
5093 "kp-home", /* 0xff95 */
5098 "kp-prior", /* kp-page-up */
5099 "kp-next", /* kp-page-down */
5105 0, 0, 0, 0, 0, 0, 0, 0, 0,
5106 "kp-multiply", /* 0xffaa */
5111 "kp-divide", /* 0xffaf */
5112 "kp-0", /* 0xffb0 */
5113 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5116 "kp-equal", /* 0xffbd */
5117 "f1", /* 0xffbe */ /* IsFunctionKey */
5119 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5120 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5121 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5122 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5123 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5124 0, 0, 0, 0, 0, 0, 0, 0,
5125 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5126 0, 0, 0, 0, 0, 0, 0, "delete"
5129 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5130 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5132 static const char *const iso_lispy_function_keys
[] =
5134 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5135 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5136 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5137 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5138 "iso-lefttab", /* 0xfe20 */
5139 "iso-move-line-up", "iso-move-line-down",
5140 "iso-partial-line-up", "iso-partial-line-down",
5141 "iso-partial-space-left", "iso-partial-space-right",
5142 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5143 "iso-release-margin-left", "iso-release-margin-right",
5144 "iso-release-both-margins",
5145 "iso-fast-cursor-left", "iso-fast-cursor-right",
5146 "iso-fast-cursor-up", "iso-fast-cursor-down",
5147 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5148 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5151 #endif /* not HAVE_NTGUI */
5153 static Lisp_Object Vlispy_mouse_stem
;
5155 static const char *const lispy_wheel_names
[] =
5157 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5160 /* drag-n-drop events are generated when a set of selected files are
5161 dragged from another application and dropped onto an Emacs window. */
5162 static const char *const lispy_drag_n_drop_names
[] =
5167 /* Scroll bar parts. */
5168 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5169 Lisp_Object Qup
, Qdown
, Qbottom
;
5170 static Lisp_Object Qend_scroll
;
5172 static Lisp_Object Qratio
;
5174 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5175 static Lisp_Object
*const scroll_bar_parts
[] = {
5176 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5177 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5180 /* A vector, indexed by button number, giving the down-going location
5181 of currently depressed buttons, both scroll bar and non-scroll bar.
5183 The elements have the form
5184 (BUTTON-NUMBER MODIFIER-MASK . REST)
5185 where REST is the cdr of a position as it would be reported in the event.
5187 The make_lispy_event function stores positions here to tell the
5188 difference between click and drag events, and to store the starting
5189 location to be included in drag events. */
5191 static Lisp_Object button_down_location
;
5193 /* Information about the most recent up-going button event: Which
5194 button, what location, and what time. */
5196 static int last_mouse_button
;
5197 static int last_mouse_x
;
5198 static int last_mouse_y
;
5199 static Time button_down_time
;
5201 /* The number of clicks in this multiple-click. */
5203 static int double_click_count
;
5205 /* X and Y are frame-relative coordinates for a click or wheel event.
5206 Return a Lisp-style event list. */
5209 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5212 enum window_part part
;
5213 Lisp_Object posn
= Qnil
;
5214 Lisp_Object extra_info
= Qnil
;
5215 /* Coordinate pixel positions to return. */
5216 int xret
= 0, yret
= 0;
5217 /* The window under frame pixel coordinates (x,y) */
5218 Lisp_Object window
= f
5219 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5222 if (WINDOWP (window
))
5224 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5225 struct window
*w
= XWINDOW (window
);
5226 Lisp_Object string_info
= Qnil
;
5227 ptrdiff_t textpos
= -1;
5228 int col
= -1, row
= -1;
5229 int dx
= -1, dy
= -1;
5230 int width
= -1, height
= -1;
5231 Lisp_Object object
= Qnil
;
5233 /* Pixel coordinates relative to the window corner. */
5234 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5235 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5237 /* For text area clicks, return X, Y relative to the corner of
5238 this text area. Note that dX, dY etc are set below, by
5239 buffer_posn_from_coords. */
5240 if (part
== ON_TEXT
)
5242 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5243 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5245 /* For mode line and header line clicks, return X, Y relative to
5246 the left window edge. Use mode_line_string to look for a
5247 string on the click position. */
5248 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5253 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5254 /* Note that mode_line_string takes COL, ROW as pixels and
5255 converts them to characters. */
5258 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5259 &object
, &dx
, &dy
, &width
, &height
);
5260 if (STRINGP (string
))
5261 string_info
= Fcons (string
, make_number (charpos
));
5262 textpos
= (w
== XWINDOW (selected_window
)
5263 && current_buffer
== XBUFFER (w
->contents
))
5264 ? PT
: marker_position (w
->pointm
);
5269 /* For fringes and margins, Y is relative to the area's (and the
5270 window's) top edge, while X is meaningless. */
5271 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5276 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5279 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5280 &object
, &dx
, &dy
, &width
, &height
);
5281 if (STRINGP (string
))
5282 string_info
= Fcons (string
, make_number (charpos
));
5283 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5285 else if (part
== ON_LEFT_FRINGE
)
5287 posn
= Qleft_fringe
;
5290 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5291 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5292 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5294 else if (part
== ON_RIGHT_FRINGE
)
5296 posn
= Qright_fringe
;
5299 - window_box_width (w
, LEFT_MARGIN_AREA
)
5300 - window_box_width (w
, TEXT_AREA
)
5301 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5302 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5304 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5306 else if (part
== ON_VERTICAL_BORDER
)
5308 posn
= Qvertical_line
;
5313 /* Nothing special for part == ON_SCROLL_BAR. */
5314 else if (part
== ON_RIGHT_DIVIDER
)
5316 posn
= Qright_divider
;
5317 width
= WINDOW_RIGHT_DIVIDER_WIDTH (w
);
5321 else if (part
== ON_BOTTOM_DIVIDER
)
5323 posn
= Qbottom_divider
;
5324 width
= WINDOW_BOTTOM_DIVIDER_WIDTH (w
);
5329 /* For clicks in the text area, fringes, or margins, call
5330 buffer_posn_from_coords to extract TEXTPOS, the buffer
5331 position nearest to the click. */
5334 Lisp_Object string2
, object2
= Qnil
;
5335 struct display_pos p
;
5337 int width2
, height2
;
5338 /* The pixel X coordinate passed to buffer_posn_from_coords
5339 is the X coordinate relative to the text area for
5340 text-area and right-margin clicks, zero otherwise. */
5342 = (part
== ON_TEXT
) ? xret
5343 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5344 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5348 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5349 &object2
, &dx2
, &dy2
,
5351 textpos
= CHARPOS (p
.pos
);
5352 if (col
< 0) col
= x2
;
5353 if (row
< 0) row
= y2
;
5354 if (dx
< 0) dx
= dx2
;
5355 if (dy
< 0) dy
= dy2
;
5356 if (width
< 0) width
= width2
;
5357 if (height
< 0) height
= height2
;
5361 posn
= make_number (textpos
);
5362 if (STRINGP (string2
))
5363 string_info
= Fcons (string2
,
5364 make_number (CHARPOS (p
.string_pos
)));
5370 #ifdef HAVE_WINDOW_SYSTEM
5371 if (IMAGEP (object
))
5373 Lisp_Object image_map
, hotspot
;
5374 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5376 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5378 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5379 posn
= XCAR (hotspot
);
5386 Fcons (make_number (dx
), make_number (dy
)),
5387 Fcons (make_number (width
), make_number (height
)));
5390 extra_info
= Fcons (string_info
,
5391 Fcons (make_number (textpos
),
5392 Fcons (Fcons (make_number (col
),
5397 XSETFRAME (window
, f
);
5401 return Fcons (window
,
5403 Fcons (Fcons (make_number (xret
),
5404 make_number (yret
)),
5405 Fcons (make_number (t
),
5409 /* Return non-zero if F is a GUI frame that uses some toolkit-managed
5410 menu bar. This really means that Emacs draws and manages the menu
5411 bar as part of its normal display, and therefore can compute its
5414 toolkit_menubar_in_use (struct frame
*f
)
5416 #if defined (USE_X_TOOLKIT) || defined (USE_GTK) || defined (HAVE_NS) || defined (HAVE_NTGUI)
5417 return !(!FRAME_WINDOW_P (f
));
5423 /* Given a struct input_event, build the lisp event which represents
5424 it. If EVENT is 0, build a mouse movement event from the mouse
5425 movement buffer, which should have a movement event in it.
5427 Note that events must be passed to this function in the order they
5428 are received; this function stores the location of button presses
5429 in order to build drag events when the button is released. */
5432 make_lispy_event (struct input_event
*event
)
5436 switch (event
->kind
)
5438 /* A simple keystroke. */
5439 case ASCII_KEYSTROKE_EVENT
:
5440 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5442 Lisp_Object lispy_c
;
5443 EMACS_INT c
= event
->code
;
5444 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5447 eassert (c
== event
->code
);
5448 /* Turn ASCII characters into control characters
5450 if (event
->modifiers
& ctrl_modifier
)
5452 c
= make_ctrl_char (c
);
5453 event
->modifiers
&= ~ctrl_modifier
;
5457 /* Add in the other modifier bits. The shift key was taken care
5458 of by the X code. */
5459 c
|= (event
->modifiers
5460 & (meta_modifier
| alt_modifier
5461 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5462 /* Distinguish Shift-SPC from SPC. */
5463 if ((event
->code
) == 040
5464 && event
->modifiers
& shift_modifier
)
5465 c
|= shift_modifier
;
5466 button_down_time
= 0;
5467 XSETFASTINT (lispy_c
, c
);
5472 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5473 except that they are non-key events (last-nonmenu-event is nil). */
5474 case NS_NONKEY_EVENT
:
5477 /* A function key. The symbol may need to have modifier prefixes
5479 case NON_ASCII_KEYSTROKE_EVENT
:
5480 button_down_time
= 0;
5482 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5483 if (event
->code
== lispy_accent_codes
[i
])
5484 return modify_event_symbol (i
,
5486 Qfunction_key
, Qnil
,
5487 lispy_accent_keys
, &accent_key_syms
,
5488 (sizeof (lispy_accent_keys
)
5489 / sizeof (lispy_accent_keys
[0])));
5493 if (event
->code
>= 0x400 && event
->code
< 0x500)
5494 return modify_event_symbol (event
->code
- 0x400,
5495 event
->modifiers
& ~shift_modifier
,
5496 Qfunction_key
, Qnil
,
5497 lispy_kana_keys
, &func_key_syms
,
5498 (sizeof (lispy_kana_keys
)
5499 / sizeof (lispy_kana_keys
[0])));
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 (sizeof (iso_lispy_function_keys
)
5511 / sizeof (iso_lispy_function_keys
[0])));
5514 /* Handle system-specific or unknown keysyms. */
5515 if (event
->code
& (1 << 28)
5516 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5517 || (event
->code
- FUNCTION_KEY_OFFSET
5518 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5519 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5521 /* We need to use an alist rather than a vector as the cache
5522 since we can't make a vector long enough. */
5523 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5524 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5525 return modify_event_symbol (event
->code
,
5528 KVAR (current_kboard
, Vsystem_key_alist
),
5529 0, &KVAR (current_kboard
, system_key_syms
),
5533 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5535 Qfunction_key
, Qnil
,
5536 lispy_function_keys
, &func_key_syms
,
5537 (sizeof (lispy_function_keys
)
5538 / sizeof (lispy_function_keys
[0])));
5541 case MULTIMEDIA_KEY_EVENT
:
5542 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5543 / sizeof (lispy_multimedia_keys
[0]))
5544 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5546 return modify_event_symbol (event
->code
, event
->modifiers
,
5547 Qfunction_key
, Qnil
,
5548 lispy_multimedia_keys
, &func_key_syms
,
5549 (sizeof (lispy_multimedia_keys
)
5550 / sizeof (lispy_multimedia_keys
[0])));
5555 /* A mouse click. Figure out where it is, decide whether it's
5556 a press, click or drag, and build the appropriate structure. */
5557 case MOUSE_CLICK_EVENT
:
5559 case GPM_CLICK_EVENT
:
5561 #ifndef USE_TOOLKIT_SCROLL_BARS
5562 case SCROLL_BAR_CLICK_EVENT
:
5565 int button
= event
->code
;
5567 Lisp_Object position
;
5568 Lisp_Object
*start_pos_ptr
;
5569 Lisp_Object start_pos
;
5573 /* Build the position as appropriate for this mouse click. */
5574 if (event
->kind
== MOUSE_CLICK_EVENT
5576 || event
->kind
== GPM_CLICK_EVENT
5580 struct frame
*f
= XFRAME (event
->frame_or_window
);
5583 /* Ignore mouse events that were made on frame that
5584 have been deleted. */
5585 if (! FRAME_LIVE_P (f
))
5588 /* EVENT->x and EVENT->y are frame-relative pixel
5589 coordinates at this place. Under old redisplay, COLUMN
5590 and ROW are set to frame relative glyph coordinates
5591 which are then used to determine whether this click is
5592 in a menu (non-toolkit version). */
5593 if (!toolkit_menubar_in_use (f
))
5595 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5596 &column
, &row
, NULL
, 1);
5598 /* In the non-toolkit version, clicks on the menu bar
5599 are ordinary button events in the event buffer.
5600 Distinguish them, and invoke the menu.
5602 (In the toolkit version, the toolkit handles the
5603 menu bar and Emacs doesn't know about it until
5604 after the user makes a selection.) */
5605 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5606 && (event
->modifiers
& down_modifier
))
5608 Lisp_Object items
, item
;
5610 /* Find the menu bar item under `column'. */
5612 items
= FRAME_MENU_BAR_ITEMS (f
);
5613 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5615 Lisp_Object pos
, string
;
5616 string
= AREF (items
, i
+ 1);
5617 pos
= AREF (items
, i
+ 3);
5620 if (column
>= XINT (pos
)
5621 && column
< XINT (pos
) + SCHARS (string
))
5623 item
= AREF (items
, i
);
5628 /* ELisp manual 2.4b says (x y) are window
5629 relative but code says they are
5631 position
= list4 (event
->frame_or_window
,
5633 Fcons (event
->x
, event
->y
),
5634 make_number (event
->timestamp
));
5636 return list2 (item
, position
);
5640 position
= make_lispy_position (f
, event
->x
, event
->y
,
5643 #ifndef USE_TOOLKIT_SCROLL_BARS
5646 /* It's a scrollbar click. */
5648 Lisp_Object portion_whole
;
5651 window
= event
->frame_or_window
;
5652 portion_whole
= Fcons (event
->x
, event
->y
);
5653 part
= *scroll_bar_parts
[(int) event
->part
];
5655 position
= list5 (window
, Qvertical_scroll_bar
,
5656 portion_whole
, make_number (event
->timestamp
),
5659 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5661 if (button
>= ASIZE (button_down_location
))
5663 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5664 button_down_location
= larger_vector (button_down_location
,
5666 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5669 start_pos_ptr
= aref_addr (button_down_location
, button
);
5670 start_pos
= *start_pos_ptr
;
5671 *start_pos_ptr
= Qnil
;
5674 /* On window-system frames, use the value of
5675 double-click-fuzz as is. On other frames, interpret it
5676 as a multiple of 1/8 characters. */
5680 if (WINDOWP (event
->frame_or_window
))
5681 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5682 else if (FRAMEP (event
->frame_or_window
))
5683 f
= XFRAME (event
->frame_or_window
);
5687 if (FRAME_WINDOW_P (f
))
5688 fuzz
= double_click_fuzz
;
5690 fuzz
= double_click_fuzz
/ 8;
5692 is_double
= (button
== last_mouse_button
5693 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5694 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5695 && button_down_time
!= 0
5696 && (EQ (Vdouble_click_time
, Qt
)
5697 || (NATNUMP (Vdouble_click_time
)
5698 && (event
->timestamp
- button_down_time
5699 < XFASTINT (Vdouble_click_time
)))));
5702 last_mouse_button
= button
;
5703 last_mouse_x
= XINT (event
->x
);
5704 last_mouse_y
= XINT (event
->y
);
5706 /* If this is a button press, squirrel away the location, so
5707 we can decide later whether it was a click or a drag. */
5708 if (event
->modifiers
& down_modifier
)
5712 double_click_count
++;
5713 event
->modifiers
|= ((double_click_count
> 2)
5718 double_click_count
= 1;
5719 button_down_time
= event
->timestamp
;
5720 *start_pos_ptr
= Fcopy_alist (position
);
5721 ignore_mouse_drag_p
= 0;
5724 /* Now we're releasing a button - check the co-ordinates to
5725 see if this was a click or a drag. */
5726 else if (event
->modifiers
& up_modifier
)
5728 /* If we did not see a down before this up, ignore the up.
5729 Probably this happened because the down event chose a
5730 menu item. It would be an annoyance to treat the
5731 release of the button that chose the menu item as a
5734 if (!CONSP (start_pos
))
5737 event
->modifiers
&= ~up_modifier
;
5740 Lisp_Object new_down
, down
;
5741 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5743 /* The third element of every position
5744 should be the (x,y) pair. */
5745 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5746 new_down
= Fcar (Fcdr (Fcdr (position
)));
5749 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5751 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5752 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5755 if (ignore_mouse_drag_p
)
5757 event
->modifiers
|= click_modifier
;
5758 ignore_mouse_drag_p
= 0;
5760 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5761 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5762 /* Maybe the mouse has moved a lot, caused scrolling, and
5763 eventually ended up at the same screen position (but
5764 not buffer position) in which case it is a drag, not
5766 /* FIXME: OTOH if the buffer position has changed
5767 because of a timer or process filter rather than
5768 because of mouse movement, it should be considered as
5769 a click. But mouse-drag-region completely ignores
5770 this case and it hasn't caused any real problem, so
5771 it's probably OK to ignore it as well. */
5772 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5773 /* Mouse hasn't moved (much). */
5774 event
->modifiers
|= click_modifier
;
5777 button_down_time
= 0;
5778 event
->modifiers
|= drag_modifier
;
5781 /* Don't check is_double; treat this as multiple
5782 if the down-event was multiple. */
5783 if (double_click_count
> 1)
5784 event
->modifiers
|= ((double_click_count
> 2)
5790 /* Every mouse event should either have the down_modifier or
5791 the up_modifier set. */
5795 /* Get the symbol we should use for the mouse click. */
5798 head
= modify_event_symbol (button
,
5800 Qmouse_click
, Vlispy_mouse_stem
,
5803 ASIZE (mouse_syms
));
5804 if (event
->modifiers
& drag_modifier
)
5805 return list3 (head
, start_pos
, position
);
5806 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5807 return list3 (head
, position
, make_number (double_click_count
));
5809 return list2 (head
, position
);
5814 case HORIZ_WHEEL_EVENT
:
5816 Lisp_Object position
;
5819 /* Build the position as appropriate for this mouse click. */
5820 struct frame
*f
= XFRAME (event
->frame_or_window
);
5822 /* Ignore wheel events that were made on frame that have been
5824 if (! FRAME_LIVE_P (f
))
5827 position
= make_lispy_position (f
, event
->x
, event
->y
,
5830 /* Set double or triple modifiers to indicate the wheel speed. */
5832 /* On window-system frames, use the value of
5833 double-click-fuzz as is. On other frames, interpret it
5834 as a multiple of 1/8 characters. */
5840 if (WINDOWP (event
->frame_or_window
))
5841 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5842 else if (FRAMEP (event
->frame_or_window
))
5843 fr
= XFRAME (event
->frame_or_window
);
5847 fuzz
= FRAME_WINDOW_P (fr
)
5848 ? double_click_fuzz
: double_click_fuzz
/ 8;
5850 if (event
->modifiers
& up_modifier
)
5852 /* Emit a wheel-up event. */
5853 event
->modifiers
&= ~up_modifier
;
5856 else if (event
->modifiers
& down_modifier
)
5858 /* Emit a wheel-down event. */
5859 event
->modifiers
&= ~down_modifier
;
5863 /* Every wheel event should either have the down_modifier or
5864 the up_modifier set. */
5867 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5870 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5871 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5872 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5873 && button_down_time
!= 0
5874 && (EQ (Vdouble_click_time
, Qt
)
5875 || (NATNUMP (Vdouble_click_time
)
5876 && (event
->timestamp
- button_down_time
5877 < XFASTINT (Vdouble_click_time
)))));
5880 double_click_count
++;
5881 event
->modifiers
|= ((double_click_count
> 2)
5887 double_click_count
= 1;
5888 event
->modifiers
|= click_modifier
;
5891 button_down_time
= event
->timestamp
;
5892 /* Use a negative value to distinguish wheel from mouse button. */
5893 last_mouse_button
= - (1 + symbol_num
);
5894 last_mouse_x
= XINT (event
->x
);
5895 last_mouse_y
= XINT (event
->y
);
5897 /* Get the symbol we should use for the wheel event. */
5898 head
= modify_event_symbol (symbol_num
,
5904 ASIZE (wheel_syms
));
5907 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5908 return list3 (head
, position
, make_number (double_click_count
));
5910 return list2 (head
, position
);
5914 #ifdef USE_TOOLKIT_SCROLL_BARS
5916 /* We don't have down and up events if using toolkit scroll bars,
5917 so make this always a click event. Store in the `part' of
5918 the Lisp event a symbol which maps to the following actions:
5920 `above_handle' page up
5921 `below_handle' page down
5925 `bottom' bottom of buffer
5926 `handle' thumb has been dragged.
5927 `end-scroll' end of interaction with scroll bar
5929 The incoming input_event contains in its `part' member an
5930 index of type `enum scroll_bar_part' which we can use as an
5931 index in scroll_bar_parts to get the appropriate symbol. */
5933 case SCROLL_BAR_CLICK_EVENT
:
5935 Lisp_Object position
, head
, window
, portion_whole
, part
;
5937 window
= event
->frame_or_window
;
5938 portion_whole
= Fcons (event
->x
, event
->y
);
5939 part
= *scroll_bar_parts
[(int) event
->part
];
5941 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5942 make_number (event
->timestamp
), part
);
5944 /* Always treat scroll bar events as clicks. */
5945 event
->modifiers
|= click_modifier
;
5946 event
->modifiers
&= ~up_modifier
;
5948 if (event
->code
>= ASIZE (mouse_syms
))
5949 mouse_syms
= larger_vector (mouse_syms
,
5950 event
->code
- ASIZE (mouse_syms
) + 1,
5953 /* Get the symbol we should use for the mouse click. */
5954 head
= modify_event_symbol (event
->code
,
5959 ASIZE (mouse_syms
));
5960 return list2 (head
, position
);
5963 #endif /* USE_TOOLKIT_SCROLL_BARS */
5965 case DRAG_N_DROP_EVENT
:
5968 Lisp_Object head
, position
;
5971 f
= XFRAME (event
->frame_or_window
);
5974 /* Ignore mouse events that were made on frames that
5975 have been deleted. */
5976 if (! FRAME_LIVE_P (f
))
5979 position
= make_lispy_position (f
, event
->x
, event
->y
,
5982 head
= modify_event_symbol (0, event
->modifiers
,
5984 lispy_drag_n_drop_names
,
5985 &drag_n_drop_syms
, 1);
5986 return list3 (head
, position
, files
);
5989 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5990 || defined (HAVE_NS) || defined (USE_GTK)
5991 case MENU_BAR_EVENT
:
5992 if (EQ (event
->arg
, event
->frame_or_window
))
5993 /* This is the prefix key. We translate this to
5994 `(menu_bar)' because the code in keyboard.c for menu
5995 events, which we use, relies on this. */
5996 return list1 (Qmenu_bar
);
6000 case SELECT_WINDOW_EVENT
:
6001 /* Make an event (select-window (WINDOW)). */
6002 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
6004 case TOOL_BAR_EVENT
:
6005 if (EQ (event
->arg
, event
->frame_or_window
))
6006 /* This is the prefix key. We translate this to
6007 `(tool_bar)' because the code in keyboard.c for tool bar
6008 events, which we use, relies on this. */
6009 return list1 (Qtool_bar
);
6010 else if (SYMBOLP (event
->arg
))
6011 return apply_modifiers (event
->modifiers
, event
->arg
);
6014 case USER_SIGNAL_EVENT
:
6015 /* A user signal. */
6017 char *name
= find_user_signal_name (event
->code
);
6020 return intern (name
);
6023 case SAVE_SESSION_EVENT
:
6024 return Qsave_session
;
6029 return Fcons (Qdbus_event
, event
->arg
);
6031 #endif /* HAVE_DBUS */
6033 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
6034 case FILE_NOTIFY_EVENT
:
6036 return Fcons (Qfile_notify
, event
->arg
);
6038 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6040 case CONFIG_CHANGED_EVENT
:
6041 return list3 (Qconfig_changed_event
,
6042 event
->arg
, event
->frame_or_window
);
6044 /* The 'kind' field of the event is something we don't recognize. */
6051 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6052 Lisp_Object x
, Lisp_Object y
, Time t
)
6054 /* Is it a scroll bar movement? */
6055 if (frame
&& ! NILP (bar_window
))
6057 Lisp_Object part_sym
;
6059 part_sym
= *scroll_bar_parts
[(int) part
];
6060 return list2 (Qscroll_bar_movement
,
6062 Qvertical_scroll_bar
,
6067 /* Or is it an ordinary mouse movement? */
6070 Lisp_Object position
;
6071 position
= make_lispy_position (frame
, x
, y
, t
);
6072 return list2 (Qmouse_movement
, position
);
6076 /* Construct a switch frame event. */
6078 make_lispy_switch_frame (Lisp_Object frame
)
6080 return list2 (Qswitch_frame
, frame
);
6084 make_lispy_focus_in (Lisp_Object frame
)
6086 return list2 (Qfocus_in
, frame
);
6089 #ifdef HAVE_WINDOW_SYSTEM
6092 make_lispy_focus_out (Lisp_Object frame
)
6094 return list2 (Qfocus_out
, frame
);
6097 #endif /* HAVE_WINDOW_SYSTEM */
6099 /* Manipulating modifiers. */
6101 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6103 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6104 SYMBOL's name of the end of the modifiers; the string from this
6105 position is the unmodified symbol name.
6107 This doesn't use any caches. */
6110 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6116 CHECK_SYMBOL (symbol
);
6119 name
= SYMBOL_NAME (symbol
);
6121 for (i
= 0; i
< SBYTES (name
) - 1; )
6123 ptrdiff_t this_mod_end
= 0;
6126 /* See if the name continues with a modifier word.
6127 Check that the word appears, but don't check what follows it.
6128 Set this_mod and this_mod_end to record what we find. */
6130 switch (SREF (name
, i
))
6132 #define SINGLE_LETTER_MOD(BIT) \
6133 (this_mod_end = i + 1, this_mod = BIT)
6136 SINGLE_LETTER_MOD (alt_modifier
);
6140 SINGLE_LETTER_MOD (ctrl_modifier
);
6144 SINGLE_LETTER_MOD (hyper_modifier
);
6148 SINGLE_LETTER_MOD (meta_modifier
);
6152 SINGLE_LETTER_MOD (shift_modifier
);
6156 SINGLE_LETTER_MOD (super_modifier
);
6159 #undef SINGLE_LETTER_MOD
6161 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6162 if (i + LEN + 1 <= SBYTES (name) \
6163 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6165 this_mod_end = i + LEN; \
6170 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6171 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6172 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6176 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6178 #undef MULTI_LETTER_MOD
6182 /* If we found no modifier, stop looking for them. */
6183 if (this_mod_end
== 0)
6186 /* Check there is a dash after the modifier, so that it
6187 really is a modifier. */
6188 if (this_mod_end
>= SBYTES (name
)
6189 || SREF (name
, this_mod_end
) != '-')
6192 /* This modifier is real; look for another. */
6193 modifiers
|= this_mod
;
6194 i
= this_mod_end
+ 1;
6197 /* Should we include the `click' modifier? */
6198 if (! (modifiers
& (down_modifier
| drag_modifier
6199 | double_modifier
| triple_modifier
))
6200 && i
+ 7 == SBYTES (name
)
6201 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6202 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6203 modifiers
|= click_modifier
;
6205 if (! (modifiers
& (double_modifier
| triple_modifier
))
6206 && i
+ 6 < SBYTES (name
)
6207 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6208 modifiers
|= click_modifier
;
6216 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6217 prepended to the string BASE[0..BASE_LEN-1].
6218 This doesn't use any caches. */
6220 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6222 /* Since BASE could contain nulls, we can't use intern here; we have
6223 to use Fintern, which expects a genuine Lisp_String, and keeps a
6225 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6231 /* Only the event queue may use the `up' modifier; it should always
6232 be turned into a click or drag event before presented to lisp code. */
6233 if (modifiers
& up_modifier
)
6236 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6237 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6238 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6239 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6240 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6241 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6242 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6243 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6244 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6245 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6246 /* The click modifier is denoted by the absence of other modifiers. */
6250 mod_len
= p
- new_mods
;
6254 Lisp_Object new_name
;
6256 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6257 mod_len
+ base_len_byte
);
6258 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6259 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6261 return Fintern (new_name
, Qnil
);
6266 static const char *const modifier_names
[] =
6268 "up", "down", "drag", "click", "double", "triple", 0, 0,
6269 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6270 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6272 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6274 static Lisp_Object modifier_symbols
;
6276 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6278 lispy_modifier_list (int modifiers
)
6280 Lisp_Object modifier_list
;
6283 modifier_list
= Qnil
;
6284 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6285 if (modifiers
& (1<<i
))
6286 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6289 return modifier_list
;
6293 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6294 where UNMODIFIED is the unmodified form of SYMBOL,
6295 MASK is the set of modifiers present in SYMBOL's name.
6296 This is similar to parse_modifiers_uncached, but uses the cache in
6297 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6298 Qevent_symbol_elements property. */
6300 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6303 parse_modifiers (Lisp_Object symbol
)
6305 Lisp_Object elements
;
6307 if (INTEGERP (symbol
))
6308 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6309 else if (!SYMBOLP (symbol
))
6312 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6313 if (CONSP (elements
))
6318 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6319 Lisp_Object unmodified
;
6322 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6323 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6326 if (modifiers
& ~INTMASK
)
6328 XSETFASTINT (mask
, modifiers
);
6329 elements
= list2 (unmodified
, mask
);
6331 /* Cache the parsing results on SYMBOL. */
6332 Fput (symbol
, Qevent_symbol_element_mask
,
6334 Fput (symbol
, Qevent_symbol_elements
,
6335 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6337 /* Since we know that SYMBOL is modifiers applied to unmodified,
6338 it would be nice to put that in unmodified's cache.
6339 But we can't, since we're not sure that parse_modifiers is
6346 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6347 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6348 doc
: /* Parse the event symbol. For internal use. */)
6349 (Lisp_Object symbol
)
6351 /* Fill the cache if needed. */
6352 parse_modifiers (symbol
);
6353 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6354 and use the Lispier representation stored on Qevent_symbol_elements
6356 return Fget (symbol
, Qevent_symbol_elements
);
6359 /* Apply the modifiers MODIFIERS to the symbol BASE.
6360 BASE must be unmodified.
6362 This is like apply_modifiers_uncached, but uses BASE's
6363 Qmodifier_cache property, if present. It also builds
6364 Qevent_symbol_elements properties, since it has that info anyway.
6366 apply_modifiers copies the value of BASE's Qevent_kind property to
6367 the modified symbol. */
6369 apply_modifiers (int modifiers
, Lisp_Object base
)
6371 Lisp_Object cache
, idx
, entry
, new_symbol
;
6373 /* Mask out upper bits. We don't know where this value's been. */
6374 modifiers
&= INTMASK
;
6376 if (INTEGERP (base
))
6377 return make_number (XINT (base
) | modifiers
);
6379 /* The click modifier never figures into cache indices. */
6380 cache
= Fget (base
, Qmodifier_cache
);
6381 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6382 entry
= assq_no_quit (idx
, cache
);
6385 new_symbol
= XCDR (entry
);
6388 /* We have to create the symbol ourselves. */
6389 new_symbol
= apply_modifiers_uncached (modifiers
,
6390 SSDATA (SYMBOL_NAME (base
)),
6391 SCHARS (SYMBOL_NAME (base
)),
6392 SBYTES (SYMBOL_NAME (base
)));
6394 /* Add the new symbol to the base's cache. */
6395 entry
= Fcons (idx
, new_symbol
);
6396 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6398 /* We have the parsing info now for free, so we could add it to
6400 XSETFASTINT (idx, modifiers);
6401 Fput (new_symbol, Qevent_symbol_element_mask,
6403 Fput (new_symbol, Qevent_symbol_elements,
6404 Fcons (base, lispy_modifier_list (modifiers)));
6405 Sadly, this is only correct if `base' is indeed a base event,
6406 which is not necessarily the case. -stef */
6409 /* Make sure this symbol is of the same kind as BASE.
6411 You'd think we could just set this once and for all when we
6412 intern the symbol above, but reorder_modifiers may call us when
6413 BASE's property isn't set right; we can't assume that just
6414 because it has a Qmodifier_cache property it must have its
6415 Qevent_kind set right as well. */
6416 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6420 kind
= Fget (base
, Qevent_kind
);
6422 Fput (new_symbol
, Qevent_kind
, kind
);
6429 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6430 return a symbol with the modifiers placed in the canonical order.
6431 Canonical order is alphabetical, except for down and drag, which
6432 always come last. The 'click' modifier is never written out.
6434 Fdefine_key calls this to make sure that (for example) C-M-foo
6435 and M-C-foo end up being equivalent in the keymap. */
6438 reorder_modifiers (Lisp_Object symbol
)
6440 /* It's hopefully okay to write the code this way, since everything
6441 will soon be in caches, and no consing will be done at all. */
6444 parsed
= parse_modifiers (symbol
);
6445 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6450 /* For handling events, we often want to produce a symbol whose name
6451 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6452 to some base, like the name of a function key or mouse button.
6453 modify_event_symbol produces symbols of this sort.
6455 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6456 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6459 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6460 into symbol names, or a string specifying a name stem used to
6461 construct a symbol name or the form `STEM-N', where N is the decimal
6462 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6463 non-nil; otherwise NAME_TABLE is used.
6465 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6466 persist between calls to modify_event_symbol that it can use to
6467 store a cache of the symbols it's generated for this NAME_TABLE
6468 before. The object stored there may be a vector or an alist.
6470 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6472 MODIFIERS is a set of modifier bits (as given in struct input_events)
6473 whose prefixes should be applied to the symbol name.
6475 SYMBOL_KIND is the value to be placed in the event_kind property of
6476 the returned symbol.
6478 The symbols we create are supposed to have an
6479 `event-symbol-elements' property, which lists the modifiers present
6480 in the symbol's name. */
6483 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6484 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6485 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6488 Lisp_Object symbol_int
;
6490 /* Get rid of the "vendor-specific" bit here. */
6491 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6493 /* Is this a request for a valid symbol? */
6494 if (symbol_num
< 0 || symbol_num
>= table_size
)
6497 if (CONSP (*symbol_table
))
6498 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6500 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6501 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6502 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6503 we've never used that symbol before. */
6506 if (! VECTORP (*symbol_table
)
6507 || ASIZE (*symbol_table
) != table_size
)
6511 XSETFASTINT (size
, table_size
);
6512 *symbol_table
= Fmake_vector (size
, Qnil
);
6515 value
= AREF (*symbol_table
, symbol_num
);
6518 /* Have we already used this symbol before? */
6521 /* No; let's create it. */
6522 if (CONSP (name_alist_or_stem
))
6523 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6524 else if (STRINGP (name_alist_or_stem
))
6527 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6528 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6530 buf
= SAFE_ALLOCA (len
);
6531 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6532 XINT (symbol_int
) + 1);
6533 value
= intern (buf
);
6536 else if (name_table
!= 0 && name_table
[symbol_num
])
6537 value
= intern (name_table
[symbol_num
]);
6539 #ifdef HAVE_WINDOW_SYSTEM
6542 char *name
= x_get_keysym_name (symbol_num
);
6544 value
= intern (name
);
6550 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6551 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6552 value
= intern (buf
);
6555 if (CONSP (*symbol_table
))
6556 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6558 ASET (*symbol_table
, symbol_num
, value
);
6560 /* Fill in the cache entries for this symbol; this also
6561 builds the Qevent_symbol_elements property, which the user
6563 apply_modifiers (modifiers
& click_modifier
, value
);
6564 Fput (value
, Qevent_kind
, symbol_kind
);
6567 /* Apply modifiers to that symbol. */
6568 return apply_modifiers (modifiers
, value
);
6571 /* Convert a list that represents an event type,
6572 such as (ctrl meta backspace), into the usual representation of that
6573 event type as a number or a symbol. */
6575 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6576 doc
: /* Convert the event description list EVENT-DESC to an event type.
6577 EVENT-DESC should contain one base event type (a character or symbol)
6578 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6579 drag, down, double or triple). The base must be last.
6580 The return value is an event type (a character or symbol) which
6581 has the same base event type and all the specified modifiers. */)
6582 (Lisp_Object event_desc
)
6590 while (CONSP (rest
))
6598 /* Given a symbol, see if it is a modifier name. */
6599 if (SYMBOLP (elt
) && CONSP (rest
))
6600 this = parse_solitary_modifier (elt
);
6604 else if (!NILP (base
))
6605 error ("Two bases given in one event");
6611 /* Let the symbol A refer to the character A. */
6612 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6613 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6615 if (INTEGERP (base
))
6617 /* Turn (shift a) into A. */
6618 if ((modifiers
& shift_modifier
) != 0
6619 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6621 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6622 modifiers
&= ~shift_modifier
;
6625 /* Turn (control a) into C-a. */
6626 if (modifiers
& ctrl_modifier
)
6627 return make_number ((modifiers
& ~ctrl_modifier
)
6628 | make_ctrl_char (XINT (base
)));
6630 return make_number (modifiers
| XINT (base
));
6632 else if (SYMBOLP (base
))
6633 return apply_modifiers (modifiers
, base
);
6635 error ("Invalid base event");
6638 /* Try to recognize SYMBOL as a modifier name.
6639 Return the modifier flag bit, or 0 if not recognized. */
6642 parse_solitary_modifier (Lisp_Object symbol
)
6644 Lisp_Object name
= SYMBOL_NAME (symbol
);
6646 switch (SREF (name
, 0))
6648 #define SINGLE_LETTER_MOD(BIT) \
6649 if (SBYTES (name) == 1) \
6652 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6653 if (LEN == SBYTES (name) \
6654 && ! memcmp (SDATA (name), NAME, LEN)) \
6658 SINGLE_LETTER_MOD (alt_modifier
);
6662 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6666 SINGLE_LETTER_MOD (ctrl_modifier
);
6670 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6671 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6675 SINGLE_LETTER_MOD (hyper_modifier
);
6679 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6683 SINGLE_LETTER_MOD (meta_modifier
);
6687 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6691 SINGLE_LETTER_MOD (shift_modifier
);
6695 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6696 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6697 SINGLE_LETTER_MOD (super_modifier
);
6701 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6702 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6703 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6707 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6710 #undef SINGLE_LETTER_MOD
6711 #undef MULTI_LETTER_MOD
6717 /* Return true if EVENT is a list whose elements are all integers or symbols.
6718 Such a list is not valid as an event,
6719 but it can be a Lucid-style event type list. */
6722 lucid_event_type_list_p (Lisp_Object object
)
6726 if (! CONSP (object
))
6729 if (EQ (XCAR (object
), Qhelp_echo
)
6730 || EQ (XCAR (object
), Qvertical_line
)
6731 || EQ (XCAR (object
), Qmode_line
)
6732 || EQ (XCAR (object
), Qheader_line
))
6735 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6739 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6746 /* Return true if terminal input chars are available.
6747 Also, store the return value into INPUT_PENDING.
6749 Serves the purpose of ioctl (0, FIONREAD, ...)
6750 but works even if FIONREAD does not exist.
6751 (In fact, this may actually read some input.)
6753 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6754 timer events that are ripe.
6755 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6756 events (FOCUS_IN_EVENT).
6757 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6758 movements and toolkit scroll bar thumb drags. */
6761 get_input_pending (int flags
)
6763 /* First of all, have we already counted some input? */
6764 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6766 /* If input is being read as it arrives, and we have none, there is none. */
6767 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6769 /* Try to read some input and see how much we get. */
6771 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6774 return input_pending
;
6777 /* Put a BUFFER_SWITCH_EVENT in the buffer
6778 so that read_key_sequence will notice the new current buffer. */
6781 record_asynch_buffer_change (void)
6783 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6784 The purpose of the event is to make read_key_sequence look up the
6785 keymaps again. If we aren't in read_key_sequence, we don't need one,
6786 and the event could cause trouble by messing up (input-pending-p).
6787 Note: Fwaiting_for_user_input_p always returns nil when async
6788 subprocesses aren't supported. */
6789 if (!NILP (Fwaiting_for_user_input_p ()))
6791 struct input_event event
;
6794 event
.kind
= BUFFER_SWITCH_EVENT
;
6795 event
.frame_or_window
= Qnil
;
6798 /* Make sure no interrupt happens while storing the event. */
6800 if (interrupt_input
)
6801 kbd_buffer_store_event (&event
);
6806 kbd_buffer_store_event (&event
);
6812 /* Read any terminal input already buffered up by the system
6813 into the kbd_buffer, but do not wait.
6815 Return the number of keyboard chars read, or -1 meaning
6816 this is a bad time to try to read input. */
6825 /* Store pending user signal events, if any. */
6826 store_user_signal_events ();
6828 /* Loop through the available terminals, and call their input hooks. */
6832 struct terminal
*next
= t
->next_terminal
;
6834 if (t
->read_socket_hook
)
6837 struct input_event hold_quit
;
6839 if (input_blocked_p ())
6841 pending_signals
= 1;
6845 EVENT_INIT (hold_quit
);
6846 hold_quit
.kind
= NO_EVENT
;
6848 /* No need for FIONREAD or fcntl; just say don't wait. */
6849 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6852 if (nr
== -1) /* Not OK to read input now. */
6856 else if (nr
== -2) /* Non-transient error. */
6858 /* The terminal device terminated; it should be closed. */
6860 /* Kill Emacs if this was our last terminal. */
6861 if (!terminal_list
->next_terminal
)
6862 /* Formerly simply reported no input, but that
6863 sometimes led to a failure of Emacs to terminate.
6864 SIGHUP seems appropriate if we can't reach the
6866 /* ??? Is it really right to send the signal just to
6867 this process rather than to the whole process
6868 group? Perhaps on systems with FIONREAD Emacs is
6869 alone in its group. */
6870 terminate_due_to_signal (SIGHUP
, 10);
6872 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6875 XSETTERMINAL (tmp
, t
);
6876 Fdelete_terminal (tmp
, Qnoelisp
);
6880 if (hold_quit
.kind
!= NO_EVENT
)
6881 kbd_buffer_store_event (&hold_quit
);
6890 frame_make_pointer_visible ();
6895 /* This is the tty way of reading available input.
6897 Note that each terminal device has its own `struct terminal' object,
6898 and so this function is called once for each individual termcap
6899 terminal. The first parameter indicates which terminal to read from. */
6902 tty_read_avail_input (struct terminal
*terminal
,
6903 struct input_event
*hold_quit
)
6905 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6906 the kbd_buffer can really hold. That may prevent loss
6907 of characters on some systems when input is stuffed at us. */
6908 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6910 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6913 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6915 if (kbd_on_hold_p () || buffer_free
<= 0)
6917 #endif /* subprocesses */
6919 if (!terminal
->name
) /* Don't read from a dead terminal. */
6922 if (terminal
->type
!= output_termcap
6923 && terminal
->type
!= output_msdos_raw
)
6926 /* XXX I think the following code should be moved to separate hook
6927 functions in system-dependent files. */
6929 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6930 code sets read_socket_hook to w32_console_read_socket instead! */
6932 #else /* not WINDOWSNT */
6933 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6937 return 0; /* The terminal is suspended. */
6940 n_to_read
= dos_keysns ();
6944 cbuf
[0] = dos_keyread ();
6947 #else /* not MSDOS */
6952 struct input_event gpm_hold_quit
;
6953 int gpm
, fd
= gpm_fd
;
6955 EVENT_INIT (gpm_hold_quit
);
6956 gpm_hold_quit
.kind
= NO_EVENT
;
6958 /* gpm==1 if event received.
6959 gpm==0 if the GPM daemon has closed the connection, in which case
6960 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6961 we save it in `fd' so close_gpm can remove it from the
6963 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6964 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6965 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6968 /* Presumably the GPM daemon has closed the connection. */
6970 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6971 kbd_buffer_store_event (&gpm_hold_quit
);
6975 #endif /* HAVE_GPM */
6977 /* Determine how many characters we should *try* to read. */
6978 #ifdef USABLE_FIONREAD
6979 /* Find out how much input is available. */
6980 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6982 if (! noninteractive
)
6983 return -2; /* Close this terminal. */
6989 if (n_to_read
> sizeof cbuf
)
6990 n_to_read
= sizeof cbuf
;
6991 #elif defined USG || defined CYGWIN
6992 /* Read some input if available, but don't wait. */
6993 n_to_read
= sizeof cbuf
;
6994 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6996 # error "Cannot read without possibly delaying"
7000 /* Don't read more than we can store. */
7001 if (n_to_read
> buffer_free
)
7002 n_to_read
= buffer_free
;
7003 #endif /* subprocesses */
7005 /* Now read; for one reason or another, this will not block.
7006 NREAD is set to the number of chars read. */
7009 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7010 /* POSIX infers that processes which are not in the session leader's
7011 process group won't get SIGHUPs at logout time. BSDI adheres to
7012 this part standard and returns -1 from read (0) with errno==EIO
7013 when the control tty is taken away.
7014 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7015 if (nread
== -1 && errno
== EIO
)
7016 return -2; /* Close this terminal. */
7017 #if defined (AIX) && defined (_BSD)
7018 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7019 This looks incorrect, but it isn't, because _BSD causes
7020 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7021 and that causes a value other than 0 when there is no input. */
7023 return -2; /* Close this terminal. */
7027 /* We used to retry the read if it was interrupted.
7028 But this does the wrong thing when O_NONBLOCK causes
7029 an EAGAIN error. Does anybody know of a situation
7030 where a retry is actually needed? */
7032 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7042 #ifndef USABLE_FIONREAD
7043 #if defined (USG) || defined (CYGWIN)
7044 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7045 #endif /* USG or CYGWIN */
7046 #endif /* no FIONREAD */
7051 #endif /* not MSDOS */
7052 #endif /* not WINDOWSNT */
7054 for (i
= 0; i
< nread
; i
++)
7056 struct input_event buf
;
7058 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7060 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7061 buf
.modifiers
= meta_modifier
;
7062 if (tty
->meta_key
!= 2)
7066 /* Set the frame corresponding to the active tty. Note that the
7067 value of selected_frame is not reliable here, redisplay tends
7068 to temporarily change it. */
7069 buf
.frame_or_window
= tty
->top_frame
;
7072 kbd_buffer_store_event (&buf
);
7073 /* Don't look at input that follows a C-g too closely.
7074 This reduces lossage due to autorepeat on C-g. */
7075 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7076 && buf
.code
== quit_char
)
7084 handle_async_input (void)
7089 int nread
= gobble_input ();
7090 /* -1 means it's not ok to read the input now.
7091 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7092 0 means there was no keyboard input available. */
7100 process_pending_signals (void)
7102 pending_signals
= 0;
7103 handle_async_input ();
7104 do_pending_atimers ();
7107 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7108 and reinvoke any pending signal if the level is now 0 and
7109 a fatal error is not already in progress. */
7112 unblock_input_to (int level
)
7114 interrupt_input_blocked
= level
;
7117 if (pending_signals
&& !fatal_error_in_progress
)
7118 process_pending_signals ();
7124 /* End critical section.
7126 If doing signal-driven input, and a signal came in when input was
7127 blocked, reinvoke the signal handler now to deal with it.
7129 It will also process queued input, if it was not read before.
7130 When a longer code sequence does not use block/unblock input
7131 at all, the whole input gathered up to the next call to
7132 unblock_input will be processed inside that call. */
7135 unblock_input (void)
7137 unblock_input_to (interrupt_input_blocked
- 1);
7140 /* Undo any number of BLOCK_INPUT calls,
7141 and also reinvoke any pending signal. */
7144 totally_unblock_input (void)
7146 unblock_input_to (0);
7152 handle_input_available_signal (int sig
)
7154 pending_signals
= 1;
7156 if (input_available_clear_time
)
7157 *input_available_clear_time
= make_timespec (0, 0);
7161 deliver_input_available_signal (int sig
)
7163 deliver_process_signal (sig
, handle_input_available_signal
);
7165 #endif /* USABLE_SIGIO */
7168 /* User signal events. */
7170 struct user_signal_info
7172 /* Signal number. */
7175 /* Name of the signal. */
7178 /* Number of pending signals. */
7181 struct user_signal_info
*next
;
7184 /* List of user signals. */
7185 static struct user_signal_info
*user_signals
= NULL
;
7188 add_user_signal (int sig
, const char *name
)
7190 struct sigaction action
;
7191 struct user_signal_info
*p
;
7193 for (p
= user_signals
; p
; p
= p
->next
)
7195 /* Already added. */
7198 p
= xmalloc (sizeof *p
);
7200 p
->name
= xstrdup (name
);
7202 p
->next
= user_signals
;
7205 emacs_sigaction_init (&action
, deliver_user_signal
);
7206 sigaction (sig
, &action
, 0);
7210 handle_user_signal (int sig
)
7212 struct user_signal_info
*p
;
7213 const char *special_event_name
= NULL
;
7215 if (SYMBOLP (Vdebug_on_event
))
7216 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7218 for (p
= user_signals
; p
; p
= p
->next
)
7221 if (special_event_name
7222 && strcmp (special_event_name
, p
->name
) == 0)
7224 /* Enter the debugger in many ways. */
7225 debug_on_next_call
= 1;
7228 Vinhibit_quit
= Qnil
;
7230 /* Eat the event. */
7236 if (interrupt_input
)
7237 handle_input_available_signal (sig
);
7241 /* Tell wait_reading_process_output that it needs to wake
7242 up and look around. */
7243 if (input_available_clear_time
)
7244 *input_available_clear_time
= make_timespec (0, 0);
7251 deliver_user_signal (int sig
)
7253 deliver_process_signal (sig
, handle_user_signal
);
7257 find_user_signal_name (int sig
)
7259 struct user_signal_info
*p
;
7261 for (p
= user_signals
; p
; p
= p
->next
)
7269 store_user_signal_events (void)
7271 struct user_signal_info
*p
;
7272 struct input_event buf
;
7273 bool buf_initialized
= 0;
7275 for (p
= user_signals
; p
; p
= p
->next
)
7276 if (p
->npending
> 0)
7278 if (! buf_initialized
)
7280 memset (&buf
, 0, sizeof buf
);
7281 buf
.kind
= USER_SIGNAL_EVENT
;
7282 buf
.frame_or_window
= selected_frame
;
7283 buf_initialized
= 1;
7289 kbd_buffer_store_event (&buf
);
7292 while (p
->npending
> 0);
7297 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7298 static Lisp_Object menu_bar_one_keymap_changed_items
;
7300 /* These variables hold the vector under construction within
7301 menu_bar_items and its subroutines, and the current index
7302 for storing into that vector. */
7303 static Lisp_Object menu_bar_items_vector
;
7304 static int menu_bar_items_index
;
7307 static const char* separator_names
[] = {
7312 "single-dashed-line",
7313 "double-dashed-line",
7315 "shadow-etched-out",
7316 "shadow-etched-in-dash",
7317 "shadow-etched-out-dash",
7318 "shadow-double-etched-in",
7319 "shadow-double-etched-out",
7320 "shadow-double-etched-in-dash",
7321 "shadow-double-etched-out-dash",
7325 /* Return true if LABEL specifies a separator. */
7328 menu_separator_name_p (const char *label
)
7332 else if (strlen (label
) > 3
7333 && memcmp (label
, "--", 2) == 0
7338 for (i
= 0; separator_names
[i
]; ++i
)
7339 if (strcmp (label
, separator_names
[i
]) == 0)
7344 /* It's a separator if it contains only dashes. */
7345 while (*label
== '-')
7347 return (*label
== 0);
7354 /* Return a vector of menu items for a menu bar, appropriate
7355 to the current buffer. Each item has three elements in the vector:
7358 OLD is an old vector we can optionally reuse, or nil. */
7361 menu_bar_items (Lisp_Object old
)
7363 /* The number of keymaps we're scanning right now, and the number of
7364 keymaps we have allocated space for. */
7367 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7368 in the current keymaps, or nil where it is not a prefix. */
7371 Lisp_Object def
, tail
;
7376 /* In order to build the menus, we need to call the keymap
7377 accessors. They all call QUIT. But this function is called
7378 during redisplay, during which a quit is fatal. So inhibit
7379 quitting while building the menus.
7380 We do this instead of specbind because (1) errors will clear it anyway
7381 and (2) this avoids risk of specpdl overflow. */
7382 oquit
= Vinhibit_quit
;
7386 menu_bar_items_vector
= old
;
7388 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7389 menu_bar_items_index
= 0;
7391 /* Build our list of keymaps.
7392 If we recognize a function key and replace its escape sequence in
7393 keybuf with its symbol, or if the sequence starts with a mouse
7394 click and we need to switch buffers, we jump back here to rebuild
7395 the initial keymaps from the current buffer. */
7399 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7400 if (!NILP (Voverriding_local_map_menu_flag
)
7401 && !NILP (Voverriding_local_map
))
7403 /* Yes, use them (if non-nil) as well as the global map. */
7404 maps
= alloca (3 * sizeof (maps
[0]));
7406 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7407 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7408 if (!NILP (Voverriding_local_map
))
7409 maps
[nmaps
++] = Voverriding_local_map
;
7413 /* No, so use major and minor mode keymaps and keymap property.
7414 Note that menu-bar bindings in the local-map and keymap
7415 properties may not work reliable, as they are only
7416 recognized when the menu-bar (or mode-line) is updated,
7417 which does not normally happen after every command. */
7420 nminor
= current_minor_maps (NULL
, &tmaps
);
7421 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7423 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7424 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7425 maps
[nmaps
++] = tem
;
7426 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7427 maps
[nmaps
++] = tem
;
7428 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7430 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7432 maps
[nmaps
++] = current_global_map
;
7435 /* Look up in each map the dummy prefix key `menu-bar'. */
7437 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7438 if (!NILP (maps
[mapno
]))
7440 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7444 menu_bar_one_keymap_changed_items
= Qnil
;
7445 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7449 /* Move to the end those items that should be at the end. */
7451 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7454 int end
= menu_bar_items_index
;
7456 for (i
= 0; i
< end
; i
+= 4)
7457 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7459 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7460 /* Move the item at index I to the end,
7461 shifting all the others forward. */
7462 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7463 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7464 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7465 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7467 memmove (aref_addr (menu_bar_items_vector
, i
),
7468 aref_addr (menu_bar_items_vector
, i
+ 4),
7469 (end
- i
- 4) * word_size
);
7470 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7471 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7472 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7473 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7478 /* Add nil, nil, nil, nil at the end. */
7480 int i
= menu_bar_items_index
;
7481 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7482 menu_bar_items_vector
=
7483 larger_vector (menu_bar_items_vector
, 4, -1);
7484 /* Add this item. */
7485 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7486 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7487 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7488 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7489 menu_bar_items_index
= i
;
7492 Vinhibit_quit
= oquit
;
7493 return menu_bar_items_vector
;
7496 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7497 If there's already an item for KEY, add this DEF to it. */
7499 Lisp_Object item_properties
;
7502 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7504 struct gcpro gcpro1
;
7509 if (EQ (item
, Qundefined
))
7511 /* If a map has an explicit `undefined' as definition,
7512 discard any previously made menu bar item. */
7514 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7515 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7517 if (menu_bar_items_index
> i
+ 4)
7518 memmove (aref_addr (menu_bar_items_vector
, i
),
7519 aref_addr (menu_bar_items_vector
, i
+ 4),
7520 (menu_bar_items_index
- i
- 4) * word_size
);
7521 menu_bar_items_index
-= 4;
7525 /* If this keymap has already contributed to this KEY,
7526 don't contribute to it a second time. */
7527 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7528 if (!NILP (tem
) || NILP (item
))
7531 menu_bar_one_keymap_changed_items
7532 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7534 /* We add to menu_bar_one_keymap_changed_items before doing the
7535 parse_menu_item, so that if it turns out it wasn't a menu item,
7536 it still correctly hides any further menu item. */
7538 parsed
= parse_menu_item (item
, 1);
7543 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7545 /* Find any existing item for this KEY. */
7546 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7547 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7550 /* If we did not find this KEY, add it at the end. */
7551 if (i
== menu_bar_items_index
)
7553 /* If vector is too small, get a bigger one. */
7554 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7555 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7556 /* Add this item. */
7557 ASET (menu_bar_items_vector
, i
, key
); i
++;
7558 ASET (menu_bar_items_vector
, i
,
7559 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7560 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7561 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7562 menu_bar_items_index
= i
;
7564 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7568 old
= AREF (menu_bar_items_vector
, i
+ 2);
7569 /* If the new and the old items are not both keymaps,
7570 the lookup will only find `item'. */
7571 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7572 ASET (menu_bar_items_vector
, i
+ 2, item
);
7576 /* This is used as the handler when calling menu_item_eval_property. */
7578 menu_item_eval_property_1 (Lisp_Object arg
)
7580 /* If we got a quit from within the menu computation,
7581 quit all the way out of it. This takes care of C-] in the debugger. */
7582 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7583 Fsignal (Qquit
, Qnil
);
7589 eval_dyn (Lisp_Object form
)
7591 return Feval (form
, Qnil
);
7594 /* Evaluate an expression and return the result (or nil if something
7595 went wrong). Used to evaluate dynamic parts of menu items. */
7597 menu_item_eval_property (Lisp_Object sexpr
)
7599 ptrdiff_t count
= SPECPDL_INDEX ();
7601 specbind (Qinhibit_redisplay
, Qt
);
7602 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7603 menu_item_eval_property_1
);
7604 return unbind_to (count
, val
);
7607 /* This function parses a menu item and leaves the result in the
7608 vector item_properties.
7609 ITEM is a key binding, a possible menu item.
7610 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7612 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7613 parse_menu_item returns true if the item is a menu item and false
7617 parse_menu_item (Lisp_Object item
, int inmenubar
)
7619 Lisp_Object def
, tem
, item_string
, start
;
7621 Lisp_Object keyhint
;
7630 /* Create item_properties vector if necessary. */
7631 if (NILP (item_properties
))
7633 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7635 /* Initialize optional entries. */
7636 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7637 ASET (item_properties
, i
, Qnil
);
7638 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7640 /* Save the item here to protect it from GC. */
7641 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7643 item_string
= XCAR (item
);
7647 if (STRINGP (item_string
))
7649 /* Old format menu item. */
7650 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7652 /* Maybe help string. */
7653 if (CONSP (item
) && STRINGP (XCAR (item
)))
7655 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7660 /* Maybe an obsolete key binding cache. */
7661 if (CONSP (item
) && CONSP (XCAR (item
))
7662 && (NILP (XCAR (XCAR (item
)))
7663 || VECTORP (XCAR (XCAR (item
)))))
7666 /* This is the real definition--the function to run. */
7667 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7669 /* Get enable property, if any. */
7672 tem
= Fget (item
, Qmenu_enable
);
7673 if (!NILP (Venable_disabled_menus_and_buttons
))
7674 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7675 else if (!NILP (tem
))
7676 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7679 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7681 /* New format menu item. */
7682 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7683 start
= XCDR (item
);
7686 /* We have a real binding. */
7687 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7689 item
= XCDR (start
);
7690 /* Is there an obsolete cache list with key equivalences. */
7691 if (CONSP (item
) && CONSP (XCAR (item
)))
7694 /* Parse properties. */
7695 while (CONSP (item
) && CONSP (XCDR (item
)))
7700 if (EQ (tem
, QCenable
))
7702 if (!NILP (Venable_disabled_menus_and_buttons
))
7703 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7705 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7707 else if (EQ (tem
, QCvisible
))
7709 /* If got a visible property and that evaluates to nil
7710 then ignore this item. */
7711 tem
= menu_item_eval_property (XCAR (item
));
7715 else if (EQ (tem
, QChelp
))
7716 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7717 else if (EQ (tem
, QCfilter
))
7719 else if (EQ (tem
, QCkey_sequence
))
7722 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7723 /* Be GC protected. Set keyhint to item instead of tem. */
7726 else if (EQ (tem
, QCkeys
))
7729 if (CONSP (tem
) || STRINGP (tem
))
7730 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7732 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7737 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7739 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7741 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7747 else if (inmenubar
|| !NILP (start
))
7751 return 0; /* not a menu item */
7753 /* If item string is not a string, evaluate it to get string.
7754 If we don't get a string, skip this item. */
7755 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7756 if (!(STRINGP (item_string
)))
7758 item_string
= menu_item_eval_property (item_string
);
7759 if (!STRINGP (item_string
))
7761 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7764 /* If got a filter apply it on definition. */
7765 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7768 def
= menu_item_eval_property (list2 (XCAR (filter
),
7769 list2 (Qquote
, def
)));
7771 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7774 /* Enable or disable selection of item. */
7775 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7778 tem
= menu_item_eval_property (tem
);
7779 if (inmenubar
&& NILP (tem
))
7780 return 0; /* Ignore disabled items in menu bar. */
7781 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7784 /* If we got no definition, this item is just unselectable text which
7785 is OK in a submenu but not in the menubar. */
7787 return (!inmenubar
);
7789 /* See if this is a separate pane or a submenu. */
7790 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7791 tem
= get_keymap (def
, 0, 1);
7792 /* For a subkeymap, just record its details and exit. */
7795 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7796 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7800 /* At the top level in the menu bar, do likewise for commands also.
7801 The menu bar does not display equivalent key bindings anyway.
7802 ITEM_PROPERTY_DEF is already set up properly. */
7806 { /* This is a command. See if there is an equivalent key binding. */
7807 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7809 /* The previous code preferred :key-sequence to :keys, so we
7810 preserve this behavior. */
7811 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7812 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7815 Lisp_Object prefix
= keyeq
;
7816 Lisp_Object keys
= Qnil
;
7820 def
= XCAR (prefix
);
7821 prefix
= XCDR (prefix
);
7824 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7826 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7828 keys
= XCAR (keyhint
);
7829 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7831 /* We have a suggested key. Is it bound to the command? */
7834 /* If the command is an alias for another
7835 (such as lmenu.el set it up), check if the
7836 original command matches the cached command. */
7838 && EQ (tem
, XSYMBOL (def
)->function
))))
7843 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7847 tem
= Fkey_description (keys
, Qnil
);
7850 if (STRINGP (XCAR (prefix
)))
7851 tem
= concat2 (XCAR (prefix
), tem
);
7852 if (STRINGP (XCDR (prefix
)))
7853 tem
= concat2 (tem
, XCDR (prefix
));
7855 keyeq
= concat2 (build_string (" "), tem
);
7856 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7862 /* If we have an equivalent key binding, use that. */
7863 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7866 /* Include this when menu help is implemented.
7867 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7868 if (!(NILP (tem) || STRINGP (tem)))
7870 tem = menu_item_eval_property (tem);
7873 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7877 /* Handle radio buttons or toggle boxes. */
7878 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7880 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7881 menu_item_eval_property (tem
));
7888 /***********************************************************************
7890 ***********************************************************************/
7892 /* A vector holding tool bar items while they are parsed in function
7893 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7896 static Lisp_Object tool_bar_items_vector
;
7898 /* A vector holding the result of parse_tool_bar_item. Layout is like
7899 the one for a single item in tool_bar_items_vector. */
7901 static Lisp_Object tool_bar_item_properties
;
7903 /* Next free index in tool_bar_items_vector. */
7905 static int ntool_bar_items
;
7907 /* The symbols `:image' and `:rtl'. */
7909 static Lisp_Object QCimage
;
7910 static Lisp_Object QCrtl
;
7912 /* Function prototypes. */
7914 static void init_tool_bar_items (Lisp_Object
);
7915 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7916 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7917 static void append_tool_bar_item (void);
7920 /* Return a vector of tool bar items for keymaps currently in effect.
7921 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7922 tool bar items found. */
7925 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7934 /* In order to build the menus, we need to call the keymap
7935 accessors. They all call QUIT. But this function is called
7936 during redisplay, during which a quit is fatal. So inhibit
7937 quitting while building the menus. We do this instead of
7938 specbind because (1) errors will clear it anyway and (2) this
7939 avoids risk of specpdl overflow. */
7940 oquit
= Vinhibit_quit
;
7943 /* Initialize tool_bar_items_vector and protect it from GC. */
7944 init_tool_bar_items (reuse
);
7946 /* Build list of keymaps in maps. Set nmaps to the number of maps
7949 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7950 if (!NILP (Voverriding_local_map_menu_flag
)
7951 && !NILP (Voverriding_local_map
))
7953 /* Yes, use them (if non-nil) as well as the global map. */
7954 maps
= alloca (3 * sizeof *maps
);
7956 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7957 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7958 if (!NILP (Voverriding_local_map
))
7959 maps
[nmaps
++] = Voverriding_local_map
;
7963 /* No, so use major and minor mode keymaps and keymap property.
7964 Note that tool-bar bindings in the local-map and keymap
7965 properties may not work reliable, as they are only
7966 recognized when the tool-bar (or mode-line) is updated,
7967 which does not normally happen after every command. */
7970 nminor
= current_minor_maps (NULL
, &tmaps
);
7971 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7973 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7974 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7975 maps
[nmaps
++] = tem
;
7976 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7977 maps
[nmaps
++] = tem
;
7978 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7980 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7983 /* Add global keymap at the end. */
7984 maps
[nmaps
++] = current_global_map
;
7986 /* Process maps in reverse order and look up in each map the prefix
7988 for (i
= nmaps
- 1; i
>= 0; --i
)
7989 if (!NILP (maps
[i
]))
7993 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7995 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7998 Vinhibit_quit
= oquit
;
7999 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
8000 return tool_bar_items_vector
;
8004 /* Process the definition of KEY which is DEF. */
8007 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8010 struct gcpro gcpro1
, gcpro2
;
8012 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8016 if (EQ (def
, Qundefined
))
8018 /* If a map has an explicit `undefined' as definition,
8019 discard any previously made item. */
8020 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8022 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8024 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8026 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8027 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8028 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8030 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8035 else if (parse_tool_bar_item (key
, def
))
8036 /* Append a new tool bar item to tool_bar_items_vector. Accept
8037 more than one definition for the same key. */
8038 append_tool_bar_item ();
8043 /* Access slot with index IDX of vector tool_bar_item_properties. */
8044 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8046 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8048 ASET (tool_bar_item_properties
, idx
, val
);
8052 /* Parse a tool bar item specification ITEM for key KEY and return the
8053 result in tool_bar_item_properties. Value is false if ITEM is
8056 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8058 CAPTION is the caption of the item, If it's not a string, it is
8059 evaluated to get a string.
8061 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8062 as binding are currently ignored.
8064 The following properties are recognized:
8068 FORM is evaluated and specifies whether the tool bar item is
8069 enabled or disabled.
8073 FORM is evaluated and specifies whether the tool bar item is visible.
8075 - `:filter FUNCTION'
8077 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8078 result is stored as the new binding.
8080 - `:button (TYPE SELECTED)'
8082 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8083 and specifies whether the button is selected (pressed) or not.
8087 IMAGES is either a single image specification or a vector of four
8088 image specifications. See enum tool_bar_item_images.
8090 - `:help HELP-STRING'.
8092 Gives a help string to display for the tool bar item.
8094 - `:label LABEL-STRING'.
8096 A text label to show with the tool bar button if labels are enabled. */
8099 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8101 Lisp_Object filter
= Qnil
;
8102 Lisp_Object caption
;
8104 bool have_label
= 0;
8106 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8107 Rule out items that aren't lists, don't start with
8108 `menu-item' or whose rest following `tool-bar-item' is not a
8113 /* As an exception, allow old-style menu separators. */
8114 if (STRINGP (XCAR (item
)))
8115 item
= list1 (XCAR (item
));
8116 else if (!EQ (XCAR (item
), Qmenu_item
)
8117 || (item
= XCDR (item
), !CONSP (item
)))
8120 /* Create tool_bar_item_properties vector if necessary. Reset it to
8122 if (VECTORP (tool_bar_item_properties
))
8124 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8128 tool_bar_item_properties
8129 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8132 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8133 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8135 /* Get the caption of the item. If the caption is not a string,
8136 evaluate it to get a string. If we don't get a string, skip this
8138 caption
= XCAR (item
);
8139 if (!STRINGP (caption
))
8141 caption
= menu_item_eval_property (caption
);
8142 if (!STRINGP (caption
))
8145 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8147 /* If the rest following the caption is not a list, the menu item is
8148 either a separator, or invalid. */
8152 if (menu_separator_name_p (SSDATA (caption
)))
8154 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8155 #if !defined (USE_GTK) && !defined (HAVE_NS)
8156 /* If we use build_desired_tool_bar_string to render the
8157 tool bar, the separator is rendered as an image. */
8158 set_prop (TOOL_BAR_ITEM_IMAGES
,
8159 (menu_item_eval_property
8160 (Vtool_bar_separator_image_expression
)));
8161 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8162 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8163 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8170 /* Store the binding. */
8171 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8174 /* Ignore cached key binding, if any. */
8175 if (CONSP (item
) && CONSP (XCAR (item
)))
8178 /* Process the rest of the properties. */
8179 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8181 Lisp_Object ikey
, value
;
8184 value
= XCAR (XCDR (item
));
8186 if (EQ (ikey
, QCenable
))
8188 /* `:enable FORM'. */
8189 if (!NILP (Venable_disabled_menus_and_buttons
))
8190 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8192 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8194 else if (EQ (ikey
, QCvisible
))
8196 /* `:visible FORM'. If got a visible property and that
8197 evaluates to nil then ignore this item. */
8198 if (NILP (menu_item_eval_property (value
)))
8201 else if (EQ (ikey
, QChelp
))
8202 /* `:help HELP-STRING'. */
8203 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8204 else if (EQ (ikey
, QCvert_only
))
8205 /* `:vert-only t/nil'. */
8206 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8207 else if (EQ (ikey
, QClabel
))
8209 const char *bad_label
= "!!?GARBLED ITEM?!!";
8210 /* `:label LABEL-STRING'. */
8211 set_prop (TOOL_BAR_ITEM_LABEL
,
8212 STRINGP (value
) ? value
: build_string (bad_label
));
8215 else if (EQ (ikey
, QCfilter
))
8216 /* ':filter FORM'. */
8218 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8220 /* `:button (TYPE . SELECTED)'. */
8221 Lisp_Object type
, selected
;
8223 type
= XCAR (value
);
8224 selected
= XCDR (value
);
8225 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8227 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8228 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8231 else if (EQ (ikey
, QCimage
)
8233 || (VECTORP (value
) && ASIZE (value
) == 4)))
8234 /* Value is either a single image specification or a vector
8235 of 4 such specifications for the different button states. */
8236 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8237 else if (EQ (ikey
, QCrtl
))
8239 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8245 /* Try to make one from caption and key. */
8246 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8247 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8248 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8249 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8251 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8252 char *buf
= xmalloc (max_lbl
+ 1);
8253 Lisp_Object new_lbl
;
8254 ptrdiff_t caption_len
= strlen (capt
);
8256 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8259 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8261 buf
[caption_len
] = '\0';
8265 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8269 strcpy (buf
, label
);
8271 for (j
= 0; buf
[j
] != '\0'; ++j
)
8279 new_lbl
= Fupcase_initials (build_string (label
));
8280 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8281 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8283 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8287 /* If got a filter apply it on binding. */
8289 set_prop (TOOL_BAR_ITEM_BINDING
,
8290 (menu_item_eval_property
8293 PROP (TOOL_BAR_ITEM_BINDING
))))));
8295 /* See if the binding is a keymap. Give up if it is. */
8296 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8299 /* Enable or disable selection of item. */
8300 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8301 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8302 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8304 /* Handle radio buttons or toggle boxes. */
8305 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8306 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8307 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8315 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8316 that can be reused. */
8319 init_tool_bar_items (Lisp_Object reuse
)
8321 if (VECTORP (reuse
))
8322 tool_bar_items_vector
= reuse
;
8324 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8325 ntool_bar_items
= 0;
8329 /* Append parsed tool bar item properties from
8330 tool_bar_item_properties */
8333 append_tool_bar_item (void)
8337 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8339 /* Enlarge tool_bar_items_vector if necessary. */
8341 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8343 /* Append entries from tool_bar_item_properties to the end of
8344 tool_bar_items_vector. */
8345 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8346 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8347 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8354 /* Read a character using menus based on the keymap MAP.
8355 Return nil if there are no menus in the maps.
8356 Return t if we displayed a menu but the user rejected it.
8358 PREV_EVENT is the previous input event, or nil if we are reading
8359 the first event of a key sequence.
8361 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8362 if we used a mouse menu to read the input, or false otherwise. If
8363 USED_MOUSE_MENU is null, don't dereference it.
8365 The prompting is done based on the prompt-string of the map
8366 and the strings associated with various map elements.
8368 This can be done with X menus or with menus put in the minibuf.
8369 These are done in different ways, depending on how the input will be read.
8370 Menus using X are done after auto-saving in read-char, getting the input
8371 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8372 and do auto-saving in the inner call of read_char. */
8375 read_char_x_menu_prompt (Lisp_Object map
,
8376 Lisp_Object prev_event
, bool *used_mouse_menu
)
8378 if (used_mouse_menu
)
8379 *used_mouse_menu
= 0;
8381 /* Use local over global Menu maps. */
8383 if (! menu_prompting
)
8386 /* If we got to this point via a mouse click,
8387 use a real menu for mouse selection. */
8388 if (EVENT_HAS_PARAMETERS (prev_event
)
8389 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8390 && !EQ (XCAR (prev_event
), Qtool_bar
))
8392 /* Display the menu and get the selection. */
8395 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8400 record_menu_key (XCAR (value
));
8402 /* If we got multiple events, unread all but
8404 There is no way to prevent those unread events
8405 from showing up later in last_nonmenu_event.
8406 So turn symbol and integer events into lists,
8407 to indicate that they came from a mouse menu,
8408 so that when present in last_nonmenu_event
8409 they won't confuse things. */
8410 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8412 record_menu_key (XCAR (tem
));
8413 if (SYMBOLP (XCAR (tem
))
8414 || INTEGERP (XCAR (tem
)))
8415 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8418 /* If we got more than one event, put all but the first
8419 onto this list to be read later.
8420 Return just the first event now. */
8421 Vunread_command_events
8422 = nconc2 (XCDR (value
), Vunread_command_events
);
8423 value
= XCAR (value
);
8425 else if (NILP (value
))
8427 if (used_mouse_menu
)
8428 *used_mouse_menu
= 1;
8435 read_char_minibuf_menu_prompt (int commandflag
,
8438 register Lisp_Object name
;
8440 /* FIXME: Use the minibuffer's frame width. */
8441 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8443 bool nobindings
= 1;
8444 Lisp_Object rest
, vector
;
8445 Lisp_Object prompt_strings
= Qnil
;
8449 if (! menu_prompting
)
8452 map
= get_keymap (map
, 0, 1);
8453 name
= Fkeymap_prompt (map
);
8455 /* If we don't have any menus, just read a character normally. */
8456 if (!STRINGP (name
))
8459 #define PUSH_C_STR(str, listvar) \
8460 listvar = Fcons (build_unibyte_string (str), listvar)
8462 /* Prompt string always starts with map's prompt, and a space. */
8463 prompt_strings
= Fcons (name
, prompt_strings
);
8464 PUSH_C_STR (": ", prompt_strings
);
8465 nlength
= SCHARS (name
) + 2;
8469 /* Present the documented bindings, a line at a time. */
8473 Lisp_Object menu_strings
= prompt_strings
;
8474 ptrdiff_t i
= nlength
;
8476 Lisp_Object orig_defn_macro
;
8478 /* Loop over elements of map. */
8483 /* FIXME: Use map_keymap to handle new keymap formats. */
8485 /* At end of map, wrap around if just starting,
8486 or end this line if already have something on it. */
8489 if (notfirst
|| nobindings
)
8495 /* Look at the next element of the map. */
8497 elt
= AREF (vector
, idx
);
8499 elt
= Fcar_safe (rest
);
8501 if (idx
< 0 && VECTORP (elt
))
8503 /* If we found a dense table in the keymap,
8504 advanced past it, but start scanning its contents. */
8505 rest
= Fcdr_safe (rest
);
8511 /* An ordinary element. */
8512 Lisp_Object event
, tem
;
8516 event
= Fcar_safe (elt
); /* alist */
8517 elt
= Fcdr_safe (elt
);
8521 XSETINT (event
, idx
); /* vector */
8524 /* Ignore the element if it has no prompt string. */
8525 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8527 /* True if the char to type matches the string. */
8529 Lisp_Object upcased_event
, downcased_event
;
8530 Lisp_Object desc
= Qnil
;
8532 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8534 upcased_event
= Fupcase (event
);
8535 downcased_event
= Fdowncase (event
);
8536 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8537 || XINT (downcased_event
) == SREF (s
, 0));
8539 desc
= Fsingle_key_description (event
, Qnil
);
8541 #if 0 /* It is redundant to list the equivalent key bindings because
8542 the prefix is what the user has already typed. */
8544 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8546 /* Insert equivalent keybinding. */
8547 s
= concat2 (s
, tem
);
8550 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8551 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8553 /* Insert button prefix. */
8554 Lisp_Object selected
8555 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8556 if (EQ (tem
, QCradio
))
8557 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8559 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8560 s
= concat2 (tem
, s
);
8564 /* If we have room for the prompt string, add it to this line.
8565 If this is the first on the line, always add it. */
8566 if ((SCHARS (s
) + i
+ 2
8567 + (char_matches
? 0 : SCHARS (desc
) + 3))
8571 ptrdiff_t thiswidth
;
8573 /* Punctuate between strings. */
8576 PUSH_C_STR (", ", menu_strings
);
8582 /* If the char to type doesn't match the string's
8583 first char, explicitly show what char to type. */
8586 /* Add as much of string as fits. */
8587 thiswidth
= min (SCHARS (desc
), width
- i
);
8589 = Fcons (Fsubstring (desc
, make_number (0),
8590 make_number (thiswidth
)),
8593 PUSH_C_STR (" = ", menu_strings
);
8597 /* Add as much of string as fits. */
8598 thiswidth
= min (SCHARS (s
), width
- i
);
8600 = Fcons (Fsubstring (s
, make_number (0),
8601 make_number (thiswidth
)),
8607 /* If this element does not fit, end the line now,
8608 and save the element for the next line. */
8609 PUSH_C_STR ("...", menu_strings
);
8614 /* Move past this element. */
8615 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8616 /* Handle reaching end of dense table. */
8621 rest
= Fcdr_safe (rest
);
8625 /* Prompt with that and read response. */
8626 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8628 /* Make believe it's not a keyboard macro in case the help char
8629 is pressed. Help characters are not recorded because menu prompting
8630 is not used on replay. */
8631 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8632 kset_defining_kbd_macro (current_kboard
, Qnil
);
8634 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8635 while (BUFFERP (obj
));
8636 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8638 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8641 if (! EQ (obj
, menu_prompt_more_char
)
8642 && (!INTEGERP (menu_prompt_more_char
)
8643 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8645 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8646 store_kbd_macro_char (obj
);
8649 /* Help char - go round again. */
8653 /* Reading key sequences. */
8656 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8658 return access_keymap (get_keymap (keymap
, 0, 1),
8663 active_maps (Lisp_Object first_event
)
8665 Lisp_Object position
8666 = CONSP (first_event
) ? CAR_SAFE (XCDR (first_event
)) : Qnil
;
8667 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8670 /* Structure used to keep track of partial application of key remapping
8671 such as Vfunction_key_map and Vkey_translation_map. */
8672 typedef struct keyremap
8674 /* This is the map originally specified for this use. */
8676 /* This is a submap reached by looking up, in PARENT,
8677 the events from START to END. */
8679 /* Positions [START, END) in the key sequence buffer
8680 are the key that we have scanned so far.
8681 Those events are the ones that we will replace
8682 if PARENT maps them into a key sequence. */
8686 /* Lookup KEY in MAP.
8687 MAP is a keymap mapping keys to key vectors or functions.
8688 If the mapping is a function and DO_FUNCALL is true,
8689 the function is called with PROMPT as parameter and its return
8690 value is used as the return value of this function (after checking
8691 that it is indeed a vector). */
8694 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8699 next
= access_keymap (map
, key
, 1, 0, 1);
8701 /* Handle a symbol whose function definition is a keymap
8703 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8704 && (ARRAYP (XSYMBOL (next
)->function
)
8705 || KEYMAPP (XSYMBOL (next
)->function
)))
8706 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8708 /* If the keymap gives a function, not an
8709 array, then call the function with one arg and use
8710 its value instead. */
8711 if (do_funcall
&& FUNCTIONP (next
))
8716 next
= call1 (next
, prompt
);
8717 /* If the function returned something invalid,
8718 barf--don't ignore it.
8719 (To ignore it safely, we would need to gcpro a bunch of
8720 other variables.) */
8721 if (! (NILP (next
) || VECTORP (next
) || STRINGP (next
)))
8722 error ("Function %s returns invalid key sequence",
8723 SSDATA (SYMBOL_NAME (tem
)));
8728 /* Do one step of the key remapping used for function-key-map and
8729 key-translation-map:
8730 KEYBUF is the buffer holding the input events.
8731 BUFSIZE is its maximum size.
8732 FKEY is a pointer to the keyremap structure to use.
8733 INPUT is the index of the last element in KEYBUF.
8734 DOIT if true says that the remapping can actually take place.
8735 DIFF is used to return the number of keys added/removed by the remapping.
8736 PARENT is the root of the keymap.
8737 PROMPT is the prompt to use if the remapping happens through a function.
8738 Return true if the remapping actually took place. */
8741 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8742 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8744 Lisp_Object next
, key
;
8746 key
= keybuf
[fkey
->end
++];
8748 if (KEYMAPP (fkey
->parent
))
8749 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8753 /* If keybuf[fkey->start..fkey->end] is bound in the
8754 map and we're in a position to do the key remapping, replace it with
8755 the binding and restart with fkey->start at the end. */
8756 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8758 int len
= XFASTINT (Flength (next
));
8761 *diff
= len
- (fkey
->end
- fkey
->start
);
8763 if (bufsize
- input
<= *diff
)
8764 error ("Key sequence too long");
8766 /* Shift the keys that follow fkey->end. */
8768 for (i
= fkey
->end
; i
< input
; i
++)
8769 keybuf
[i
+ *diff
] = keybuf
[i
];
8771 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8772 keybuf
[i
+ *diff
] = keybuf
[i
];
8773 /* Overwrite the old keys with the new ones. */
8774 for (i
= 0; i
< len
; i
++)
8775 keybuf
[fkey
->start
+ i
]
8776 = Faref (next
, make_number (i
));
8778 fkey
->start
= fkey
->end
+= *diff
;
8779 fkey
->map
= fkey
->parent
;
8784 fkey
->map
= get_keymap (next
, 0, 1);
8786 /* If we no longer have a bound suffix, try a new position for
8788 if (!CONSP (fkey
->map
))
8790 fkey
->end
= ++fkey
->start
;
8791 fkey
->map
= fkey
->parent
;
8797 test_undefined (Lisp_Object binding
)
8799 return (NILP (binding
)
8800 || EQ (binding
, Qundefined
)
8801 || (SYMBOLP (binding
)
8802 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8805 /* Read a sequence of keys that ends with a non prefix character,
8806 storing it in KEYBUF, a buffer of size BUFSIZE.
8808 Return the length of the key sequence stored.
8809 Return -1 if the user rejected a command menu.
8811 Echo starting immediately unless `prompt' is 0.
8813 If PREVENT_REDISPLAY is non-zero, avoid redisplay by calling
8814 read_char with a suitable COMMANDFLAG argument.
8816 Where a key sequence ends depends on the currently active keymaps.
8817 These include any minor mode keymaps active in the current buffer,
8818 the current buffer's local map, and the global map.
8820 If a key sequence has no other bindings, we check Vfunction_key_map
8821 to see if some trailing subsequence might be the beginning of a
8822 function key's sequence. If so, we try to read the whole function
8823 key, and substitute its symbolic name into the key sequence.
8825 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8826 `double-' events into similar click events, if that would make them
8827 bound. We try to turn `triple-' events first into `double-' events,
8830 If we get a mouse click in a mode line, vertical divider, or other
8831 non-text area, we treat the click as if it were prefixed by the
8832 symbol denoting that area - `mode-line', `vertical-line', or
8835 If the sequence starts with a mouse click, we read the key sequence
8836 with respect to the buffer clicked on, not the current buffer.
8838 If the user switches frames in the midst of a key sequence, we put
8839 off the switch-frame event until later; the next call to
8840 read_char will return it.
8842 If FIX_CURRENT_BUFFER, we restore current_buffer
8843 from the selected window's buffer. */
8846 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8847 bool dont_downcase_last
, bool can_return_switch_frame
,
8848 bool fix_current_buffer
, bool prevent_redisplay
)
8850 ptrdiff_t count
= SPECPDL_INDEX ();
8852 /* How many keys there are in the current key sequence. */
8855 /* The length of the echo buffer when we started reading, and
8856 the length of this_command_keys when we started reading. */
8857 ptrdiff_t echo_start
IF_LINT (= 0);
8858 ptrdiff_t keys_start
;
8860 Lisp_Object current_binding
= Qnil
;
8861 Lisp_Object first_event
= Qnil
;
8863 /* Index of the first key that has no binding.
8864 It is useless to try fkey.start larger than that. */
8867 /* If t < mock_input, then KEYBUF[t] should be read as the next
8870 We use this to recover after recognizing a function key. Once we
8871 realize that a suffix of the current key sequence is actually a
8872 function key's escape sequence, we replace the suffix with the
8873 function key's binding from Vfunction_key_map. Now keybuf
8874 contains a new and different key sequence, so the echo area,
8875 this_command_keys, and the submaps and defs arrays are wrong. In
8876 this situation, we set mock_input to t, set t to 0, and jump to
8877 restart_sequence; the loop will read keys from keybuf up until
8878 mock_input, thus rebuilding the state; and then it will resume
8879 reading characters from the keyboard. */
8882 /* If the sequence is unbound in submaps[], then
8883 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8884 and fkey.map is its binding.
8886 These might be > t, indicating that all function key scanning
8887 should hold off until t reaches them. We do this when we've just
8888 recognized a function key, to avoid searching for the function
8889 key's again in Vfunction_key_map. */
8892 /* Likewise, for key_translation_map and input-decode-map. */
8893 keyremap keytran
, indec
;
8895 /* True if we are trying to map a key by changing an upper-case
8896 letter to lower case, or a shifted function key to an unshifted
8898 bool shift_translated
= 0;
8900 /* If we receive a `switch-frame' or `select-window' event in the middle of
8901 a key sequence, we put it off for later.
8902 While we're reading, we keep the event here. */
8903 Lisp_Object delayed_switch_frame
;
8905 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8906 int original_uppercase_position
= -1;
8908 /* Gets around Microsoft compiler limitations. */
8911 struct buffer
*starting_buffer
;
8913 /* List of events for which a fake prefix key has been generated. */
8914 Lisp_Object fake_prefixed_keys
= Qnil
;
8916 struct gcpro gcpro1
;
8918 GCPRO1 (fake_prefixed_keys
);
8919 raw_keybuf_count
= 0;
8921 last_nonmenu_event
= Qnil
;
8923 delayed_switch_frame
= Qnil
;
8929 /* Install the string PROMPT as the beginning of the string
8930 of echoing, so that it serves as a prompt for the next
8932 kset_echo_string (current_kboard
, prompt
);
8933 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8936 else if (cursor_in_echo_area
8937 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8938 && NILP (Fzerop (Vecho_keystrokes
)))
8939 /* This doesn't put in a dash if the echo buffer is empty, so
8940 you don't always see a dash hanging out in the minibuffer. */
8944 /* Record the initial state of the echo area and this_command_keys;
8945 we will need to restore them if we replay a key sequence. */
8947 echo_start
= echo_length ();
8948 keys_start
= this_command_key_count
;
8949 this_single_command_key_start
= keys_start
;
8951 /* We jump here when we need to reinitialize fkey and keytran; this
8952 happens if we switch keyboards between rescans. */
8953 replay_entire_sequence
:
8955 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8956 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8957 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8958 indec
.start
= indec
.end
= 0;
8959 fkey
.start
= fkey
.end
= 0;
8960 keytran
.start
= keytran
.end
= 0;
8962 /* We jump here when the key sequence has been thoroughly changed, and
8963 we need to rescan it starting from the beginning. When we jump here,
8964 keybuf[0..mock_input] holds the sequence we should reread. */
8967 starting_buffer
= current_buffer
;
8968 first_unbound
= bufsize
+ 1;
8970 /* Build our list of keymaps.
8971 If we recognize a function key and replace its escape sequence in
8972 keybuf with its symbol, or if the sequence starts with a mouse
8973 click and we need to switch buffers, we jump back here to rebuild
8974 the initial keymaps from the current buffer. */
8975 current_binding
= active_maps (first_event
);
8977 /* Start from the beginning in keybuf. */
8980 /* These are no-ops the first time through, but if we restart, they
8981 revert the echo area and this_command_keys to their original state. */
8982 this_command_key_count
= keys_start
;
8983 if (INTERACTIVE
&& t
< mock_input
)
8984 echo_truncate (echo_start
);
8986 /* If the best binding for the current key sequence is a keymap, or
8987 we may be looking at a function key's escape sequence, keep on
8989 while (!NILP (current_binding
)
8990 /* Keep reading as long as there's a prefix binding. */
8991 ? KEYMAPP (current_binding
)
8992 /* Don't return in the middle of a possible function key sequence,
8993 if the only bindings we found were via case conversion.
8994 Thus, if ESC O a has a function-key-map translation
8995 and ESC o has a binding, don't return after ESC O,
8996 so that we can translate ESC O plus the next character. */
8997 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
9000 bool used_mouse_menu
= 0;
9002 /* Where the last real key started. If we need to throw away a
9003 key that has expanded into more than one element of keybuf
9004 (say, a mouse click on the mode line which is being treated
9005 as [mode-line (mouse-...)], then we backtrack to this point
9007 int last_real_key_start
;
9009 /* These variables are analogous to echo_start and keys_start;
9010 while those allow us to restart the entire key sequence,
9011 echo_local_start and keys_local_start allow us to throw away
9013 ptrdiff_t echo_local_start
IF_LINT (= 0);
9014 int keys_local_start
;
9015 Lisp_Object new_binding
;
9017 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9018 eassert (indec
.start
<= indec
.end
);
9019 eassert (fkey
.start
<= fkey
.end
);
9020 eassert (keytran
.start
<= keytran
.end
);
9021 /* key-translation-map is applied *after* function-key-map
9022 which is itself applied *after* input-decode-map. */
9023 eassert (fkey
.end
<= indec
.start
);
9024 eassert (keytran
.end
<= fkey
.start
);
9026 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9027 first_unbound
< keytran
.start
)
9028 { /* The prefix upto first_unbound has no binding and has
9029 no translation left to do either, so we know it's unbound.
9030 If we don't stop now, we risk staying here indefinitely
9031 (if the user keeps entering fkey or keytran prefixes
9032 like C-c ESC ESC ESC ESC ...) */
9034 for (i
= first_unbound
+ 1; i
< t
; i
++)
9035 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9036 mock_input
= t
- first_unbound
- 1;
9037 indec
.end
= indec
.start
-= first_unbound
+ 1;
9038 indec
.map
= indec
.parent
;
9039 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9040 fkey
.map
= fkey
.parent
;
9041 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9042 keytran
.map
= keytran
.parent
;
9043 goto replay_sequence
;
9047 error ("Key sequence too long");
9050 echo_local_start
= echo_length ();
9051 keys_local_start
= this_command_key_count
;
9054 /* These are no-ops, unless we throw away a keystroke below and
9055 jumped back up to replay_key; in that case, these restore the
9056 variables to their original state, allowing us to replay the
9058 if (INTERACTIVE
&& t
< mock_input
)
9059 echo_truncate (echo_local_start
);
9060 this_command_key_count
= keys_local_start
;
9062 /* By default, assume each event is "real". */
9063 last_real_key_start
= t
;
9065 /* Does mock_input indicate that we are re-reading a key sequence? */
9069 add_command_key (key
);
9070 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9071 && NILP (Fzerop (Vecho_keystrokes
))
9072 && current_kboard
->immediate_echo
)
9079 /* If not, we should actually read a character. */
9083 KBOARD
*interrupted_kboard
= current_kboard
;
9084 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9085 /* Calling read_char with COMMANDFLAG = -2 avoids
9086 redisplay in read_char and its subroutines. */
9087 key
= read_char (prevent_redisplay
? -2 : NILP (prompt
),
9088 current_binding
, last_nonmenu_event
,
9089 &used_mouse_menu
, NULL
);
9090 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9091 /* When switching to a new tty (with a new keyboard),
9092 read_char returns the new buffer, rather than -2
9093 (Bug#5095). This is because `terminal-init-xterm'
9094 calls read-char, which eats the wrong_kboard_jmpbuf
9095 return. Any better way to fix this? -- cyd */
9096 || (interrupted_kboard
!= current_kboard
))
9101 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9102 if (k
== interrupted_kboard
)
9107 /* Don't touch interrupted_kboard when it's been
9109 delayed_switch_frame
= Qnil
;
9110 goto replay_entire_sequence
;
9113 if (!NILP (delayed_switch_frame
))
9116 (interrupted_kboard
,
9117 Fcons (delayed_switch_frame
,
9118 KVAR (interrupted_kboard
, kbd_queue
)));
9119 delayed_switch_frame
= Qnil
;
9124 (interrupted_kboard
,
9125 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9127 /* If the side queue is non-empty, ensure it begins with a
9128 switch-frame, so we'll replay it in the right context. */
9129 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9130 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9131 !(EVENT_HAS_PARAMETERS (key
)
9132 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9136 XSETFRAME (frame
, interrupted_frame
);
9138 (interrupted_kboard
,
9139 Fcons (make_lispy_switch_frame (frame
),
9140 KVAR (interrupted_kboard
, kbd_queue
)));
9143 goto replay_entire_sequence
;
9147 /* read_char returns t when it shows a menu and the user rejects it.
9151 unbind_to (count
, Qnil
);
9156 /* read_char returns -1 at the end of a macro.
9157 Emacs 18 handles this by returning immediately with a
9158 zero, so that's what we'll do. */
9159 if (INTEGERP (key
) && XINT (key
) == -1)
9162 /* The Microsoft C compiler can't handle the goto that
9168 /* If the current buffer has been changed from under us, the
9169 keymap may have changed, so replay the sequence. */
9172 timer_resume_idle ();
9175 /* Reset the current buffer from the selected window
9176 in case something changed the former and not the latter.
9177 This is to be more consistent with the behavior
9178 of the command_loop_1. */
9179 if (fix_current_buffer
)
9181 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9183 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9185 Fset_buffer (XWINDOW (selected_window
)->contents
);
9188 goto replay_sequence
;
9191 /* If we have a quit that was typed in another frame, and
9192 quit_throw_to_read_char switched buffers,
9193 replay to get the right keymap. */
9195 && XINT (key
) == quit_char
9196 && current_buffer
!= starting_buffer
)
9199 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9204 goto replay_sequence
;
9209 if (EVENT_HAS_PARAMETERS (key
)
9210 /* Either a `switch-frame' or a `select-window' event. */
9211 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9213 /* If we're at the beginning of a key sequence, and the caller
9214 says it's okay, go ahead and return this event. If we're
9215 in the midst of a key sequence, delay it until the end. */
9216 if (t
> 0 || !can_return_switch_frame
)
9218 delayed_switch_frame
= key
;
9223 if (NILP (first_event
))
9226 /* Even if first_event does not specify a particular
9227 window/position, it's important to recompute the maps here
9228 since a long time might have passed since we entered
9229 read_key_sequence, and a timer (or process-filter or
9230 special-event-map, ...) might have switched the current buffer
9231 or the selected window from under us in the mean time. */
9232 if (fix_current_buffer
9233 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9235 Fset_buffer (XWINDOW (selected_window
)->contents
);
9236 current_binding
= active_maps (first_event
);
9240 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9244 /* Clicks in non-text areas get prefixed by the symbol
9245 in their CHAR-ADDRESS field. For example, a click on
9246 the mode line is prefixed by the symbol `mode-line'.
9248 Furthermore, key sequences beginning with mouse clicks
9249 are read using the keymaps of the buffer clicked on, not
9250 the current buffer. So we may have to switch the buffer
9253 When we turn one event into two events, we must make sure
9254 that neither of the two looks like the original--so that,
9255 if we replay the events, they won't be expanded again.
9256 If not for this, such reexpansion could happen either here
9257 or when user programs play with this-command-keys. */
9258 if (EVENT_HAS_PARAMETERS (key
))
9260 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9261 if (EQ (kind
, Qmouse_click
))
9263 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9264 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9267 || (!NILP (fake_prefixed_keys
)
9268 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9270 /* We're looking a second time at an event for which
9271 we generated a fake prefix key. Set
9272 last_real_key_start appropriately. */
9274 last_real_key_start
= t
- 1;
9277 if (last_real_key_start
== 0)
9279 /* Key sequences beginning with mouse clicks are
9280 read using the keymaps in the buffer clicked on,
9281 not the current buffer. If we're at the
9282 beginning of a key sequence, switch buffers. */
9283 if (WINDOWP (window
)
9284 && BUFFERP (XWINDOW (window
)->contents
)
9285 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9287 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9292 /* Arrange to go back to the original buffer once we're
9293 done reading the key sequence. Note that we can't
9294 use save_excursion_{save,restore} here, because they
9295 save point as well as the current buffer; we don't
9296 want to save point, because redisplay may change it,
9297 to accommodate a Fset_window_start or something. We
9298 don't want to do this at the top of the function,
9299 because we may get input from a subprocess which
9300 wants to change the selected window and stuff (say,
9302 record_unwind_current_buffer ();
9304 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9306 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9307 goto replay_sequence
;
9311 /* Expand mode-line and scroll-bar events into two events:
9312 use posn as a fake prefix key. */
9314 && (NILP (fake_prefixed_keys
)
9315 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9317 if (bufsize
- t
<= 1)
9318 error ("Key sequence too long");
9321 keybuf
[t
+ 1] = key
;
9324 /* Record that a fake prefix key has been generated
9325 for KEY. Don't modify the event; this would
9326 prevent proper action when the event is pushed
9327 back into unread-command-events. */
9328 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9332 else if (CONSP (XCDR (key
))
9333 && CONSP (EVENT_START (key
))
9334 && CONSP (XCDR (EVENT_START (key
))))
9338 posn
= POSN_POSN (EVENT_START (key
));
9339 /* Handle menu-bar events:
9340 insert the dummy prefix event `menu-bar'. */
9341 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9343 if (bufsize
- t
<= 1)
9344 error ("Key sequence too long");
9346 keybuf
[t
+ 1] = key
;
9348 /* Zap the position in key, so we know that we've
9349 expanded it, and don't try to do so again. */
9350 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9353 goto replay_sequence
;
9355 else if (CONSP (posn
))
9357 /* We're looking at the second event of a
9358 sequence which we expanded before. Set
9359 last_real_key_start appropriately. */
9360 if (last_real_key_start
== t
&& t
> 0)
9361 last_real_key_start
= t
- 1;
9366 /* We have finally decided that KEY is something we might want
9368 new_binding
= follow_key (current_binding
, key
);
9370 /* If KEY wasn't bound, we'll try some fallbacks. */
9371 if (!NILP (new_binding
))
9372 /* This is needed for the following scenario:
9373 event 0: a down-event that gets dropped by calling replay_key.
9374 event 1: some normal prefix like C-h.
9375 After event 0, first_unbound is 0, after event 1 indec.start,
9376 fkey.start, and keytran.start are all 1, so when we see that
9377 C-h is bound, we need to update first_unbound. */
9378 first_unbound
= max (t
+ 1, first_unbound
);
9383 /* Remember the position to put an upper bound on indec.start. */
9384 first_unbound
= min (t
, first_unbound
);
9386 head
= EVENT_HEAD (key
);
9387 if (help_char_p (head
) && t
> 0)
9389 read_key_sequence_cmd
= Vprefix_help_command
;
9391 last_nonmenu_event
= key
;
9392 /* The Microsoft C compiler can't handle the goto that
9400 Lisp_Object breakdown
;
9403 breakdown
= parse_modifiers (head
);
9404 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9405 /* Attempt to reduce an unbound mouse event to a simpler
9406 event that is bound:
9407 Drags reduce to clicks.
9408 Double-clicks reduce to clicks.
9409 Triple-clicks reduce to double-clicks, then to clicks.
9410 Down-clicks are eliminated.
9411 Double-downs reduce to downs, then are eliminated.
9412 Triple-downs reduce to double-downs, then to downs,
9413 then are eliminated. */
9414 if (modifiers
& (down_modifier
| drag_modifier
9415 | double_modifier
| triple_modifier
))
9417 while (modifiers
& (down_modifier
| drag_modifier
9418 | double_modifier
| triple_modifier
))
9420 Lisp_Object new_head
, new_click
;
9421 if (modifiers
& triple_modifier
)
9422 modifiers
^= (double_modifier
| triple_modifier
);
9423 else if (modifiers
& double_modifier
)
9424 modifiers
&= ~double_modifier
;
9425 else if (modifiers
& drag_modifier
)
9426 modifiers
&= ~drag_modifier
;
9429 /* Dispose of this `down' event by simply jumping
9430 back to replay_key, to get another event.
9432 Note that if this event came from mock input,
9433 then just jumping back to replay_key will just
9434 hand it to us again. So we have to wipe out any
9437 We could delete keybuf[t] and shift everything
9438 after that to the left by one spot, but we'd also
9439 have to fix up any variable that points into
9440 keybuf, and shifting isn't really necessary
9443 Adding prefixes for non-textual mouse clicks
9444 creates two characters of mock input, and both
9445 must be thrown away. If we're only looking at
9446 the prefix now, we can just jump back to
9447 replay_key. On the other hand, if we've already
9448 processed the prefix, and now the actual click
9449 itself is giving us trouble, then we've lost the
9450 state of the keymaps we want to backtrack to, and
9451 we need to replay the whole sequence to rebuild
9454 Beyond that, only function key expansion could
9455 create more than two keys, but that should never
9456 generate mouse events, so it's okay to zero
9457 mock_input in that case too.
9459 FIXME: The above paragraph seems just plain
9460 wrong, if you consider things like
9461 xterm-mouse-mode. -stef
9463 Isn't this just the most wonderful code ever? */
9465 /* If mock_input > t + 1, the above simplification
9466 will actually end up dropping keys on the floor.
9467 This is probably OK for now, but even
9468 if mock_input <= t + 1, we need to adjust indec,
9470 Typical case [header-line down-mouse-N]:
9471 mock_input = 2, t = 1, fkey.end = 1,
9472 last_real_key_start = 0. */
9473 if (indec
.end
> last_real_key_start
)
9475 indec
.end
= indec
.start
9476 = min (last_real_key_start
, indec
.start
);
9477 indec
.map
= indec
.parent
;
9478 if (fkey
.end
> last_real_key_start
)
9480 fkey
.end
= fkey
.start
9481 = min (last_real_key_start
, fkey
.start
);
9482 fkey
.map
= fkey
.parent
;
9483 if (keytran
.end
> last_real_key_start
)
9485 keytran
.end
= keytran
.start
9486 = min (last_real_key_start
, keytran
.start
);
9487 keytran
.map
= keytran
.parent
;
9491 if (t
== last_real_key_start
)
9498 mock_input
= last_real_key_start
;
9499 goto replay_sequence
;
9504 = apply_modifiers (modifiers
, XCAR (breakdown
));
9505 new_click
= list2 (new_head
, EVENT_START (key
));
9507 /* Look for a binding for this new key. */
9508 new_binding
= follow_key (current_binding
, new_click
);
9510 /* If that click is bound, go for it. */
9511 if (!NILP (new_binding
))
9513 current_binding
= new_binding
;
9517 /* Otherwise, we'll leave key set to the drag event. */
9522 current_binding
= new_binding
;
9525 /* Normally, last_nonmenu_event gets the previous key we read.
9526 But when a mouse popup menu is being used,
9527 we don't update last_nonmenu_event; it continues to hold the mouse
9528 event that preceded the first level of menu. */
9529 if (!used_mouse_menu
)
9530 last_nonmenu_event
= key
;
9532 /* Record what part of this_command_keys is the current key sequence. */
9533 this_single_command_key_start
= this_command_key_count
- t
;
9535 /* Look for this sequence in input-decode-map.
9536 Scan from indec.end until we find a bound suffix. */
9537 while (indec
.end
< t
)
9539 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9543 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9544 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9549 mock_input
= diff
+ max (t
, mock_input
);
9550 goto replay_sequence
;
9554 if (!KEYMAPP (current_binding
)
9555 && !test_undefined (current_binding
)
9556 && indec
.start
>= t
)
9557 /* There is a binding and it's not a prefix.
9558 (and it doesn't have any input-decode-map translation pending).
9559 There is thus no function-key in this sequence.
9560 Moving fkey.start is important in this case to allow keytran.start
9561 to go over the sequence before we return (since we keep the
9562 invariant that keytran.end <= fkey.start). */
9565 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9568 /* If the sequence is unbound, see if we can hang a function key
9569 off the end of it. */
9570 /* Continue scan from fkey.end until we find a bound suffix. */
9571 while (fkey
.end
< indec
.start
)
9573 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9577 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9578 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9579 max (t
, mock_input
),
9580 /* If there's a binding (i.e.
9581 first_binding >= nmaps) we don't want
9582 to apply this function-key-mapping. */
9584 && (test_undefined (current_binding
)),
9589 mock_input
= diff
+ max (t
, mock_input
);
9590 /* Adjust the input-decode-map counters. */
9592 indec
.start
+= diff
;
9594 goto replay_sequence
;
9598 /* Look for this sequence in key-translation-map.
9599 Scan from keytran.end until we find a bound suffix. */
9600 while (keytran
.end
< fkey
.start
)
9602 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9606 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9607 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9612 mock_input
= diff
+ max (t
, mock_input
);
9613 /* Adjust the function-key-map and input-decode-map counters. */
9615 indec
.start
+= diff
;
9619 goto replay_sequence
;
9623 /* If KEY is not defined in any of the keymaps,
9624 and cannot be part of a function key or translation,
9625 and is an upper case letter
9626 use the corresponding lower-case letter instead. */
9627 if (NILP (current_binding
)
9628 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9630 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9631 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9632 || (XINT (key
) & shift_modifier
)))
9634 Lisp_Object new_key
;
9636 original_uppercase
= key
;
9637 original_uppercase_position
= t
- 1;
9639 if (XINT (key
) & shift_modifier
)
9640 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9642 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9643 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9645 /* We have to do this unconditionally, regardless of whether
9646 the lower-case char is defined in the keymaps, because they
9647 might get translated through function-key-map. */
9648 keybuf
[t
- 1] = new_key
;
9649 mock_input
= max (t
, mock_input
);
9650 shift_translated
= 1;
9652 goto replay_sequence
;
9654 /* If KEY is not defined in any of the keymaps,
9655 and cannot be part of a function key or translation,
9656 and is a shifted function key,
9657 use the corresponding unshifted function key instead. */
9658 if (NILP (current_binding
)
9659 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9661 Lisp_Object breakdown
= parse_modifiers (key
);
9663 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9665 if (modifiers
& shift_modifier
9666 /* Treat uppercase keys as shifted. */
9668 && (KEY_TO_CHAR (key
)
9669 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9670 && uppercasep (KEY_TO_CHAR (key
))))
9673 = (modifiers
& shift_modifier
9674 ? apply_modifiers (modifiers
& ~shift_modifier
,
9676 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9678 original_uppercase
= key
;
9679 original_uppercase_position
= t
- 1;
9681 /* We have to do this unconditionally, regardless of whether
9682 the lower-case char is defined in the keymaps, because they
9683 might get translated through function-key-map. */
9684 keybuf
[t
- 1] = new_key
;
9685 mock_input
= max (t
, mock_input
);
9686 /* Reset fkey (and consequently keytran) to apply
9687 function-key-map on the result, so that S-backspace is
9688 correctly mapped to DEL (via backspace). OTOH,
9689 input-decode-map doesn't need to go through it again. */
9690 fkey
.start
= fkey
.end
= 0;
9691 keytran
.start
= keytran
.end
= 0;
9692 shift_translated
= 1;
9694 goto replay_sequence
;
9699 read_key_sequence_cmd
= current_binding
;
9700 read_key_sequence_remapped
9701 /* Remap command through active keymaps.
9702 Do the remapping here, before the unbind_to so it uses the keymaps
9703 of the appropriate buffer. */
9704 = SYMBOLP (read_key_sequence_cmd
)
9705 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9708 unread_switch_frame
= delayed_switch_frame
;
9709 unbind_to (count
, Qnil
);
9711 /* Don't downcase the last character if the caller says don't.
9712 Don't downcase it if the result is undefined, either. */
9713 if ((dont_downcase_last
|| NILP (current_binding
))
9715 && t
- 1 == original_uppercase_position
)
9717 keybuf
[t
- 1] = original_uppercase
;
9718 shift_translated
= 0;
9721 if (shift_translated
)
9722 Vthis_command_keys_shift_translated
= Qt
;
9724 /* Occasionally we fabricate events, perhaps by expanding something
9725 according to function-key-map, or by adding a prefix symbol to a
9726 mouse click in the scroll bar or modeline. In this cases, return
9727 the entire generated key sequence, even if we hit an unbound
9728 prefix or a definition before the end. This means that you will
9729 be able to push back the event properly, and also means that
9730 read-key-sequence will always return a logical unit.
9733 for (; t
< mock_input
; t
++)
9735 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9736 && NILP (Fzerop (Vecho_keystrokes
)))
9737 echo_char (keybuf
[t
]);
9738 add_command_key (keybuf
[t
]);
9746 read_key_sequence_vs (Lisp_Object prompt
, Lisp_Object continue_echo
,
9747 Lisp_Object dont_downcase_last
,
9748 Lisp_Object can_return_switch_frame
,
9749 Lisp_Object cmd_loop
, bool allow_string
)
9751 Lisp_Object keybuf
[30];
9753 struct gcpro gcpro1
;
9754 ptrdiff_t count
= SPECPDL_INDEX ();
9757 CHECK_STRING (prompt
);
9760 specbind (Qinput_method_exit_on_first_char
,
9761 (NILP (cmd_loop
) ? Qt
: Qnil
));
9762 specbind (Qinput_method_use_echo_area
,
9763 (NILP (cmd_loop
) ? Qt
: Qnil
));
9765 memset (keybuf
, 0, sizeof keybuf
);
9767 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9769 if (NILP (continue_echo
))
9771 this_command_key_count
= 0;
9772 this_command_key_count_reset
= 0;
9773 this_single_command_key_start
= 0;
9776 #ifdef HAVE_WINDOW_SYSTEM
9777 if (display_hourglass_p
)
9778 cancel_hourglass ();
9781 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9782 prompt
, ! NILP (dont_downcase_last
),
9783 ! NILP (can_return_switch_frame
), 0, 0);
9785 #if 0 /* The following is fine for code reading a key sequence and
9786 then proceeding with a lengthy computation, but it's not good
9787 for code reading keys in a loop, like an input method. */
9788 #ifdef HAVE_WINDOW_SYSTEM
9789 if (display_hourglass_p
)
9800 return unbind_to (count
,
9801 ((allow_string
? make_event_array
: Fvector
)
9805 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9806 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9807 The sequence is sufficient to specify a non-prefix command in the
9808 current local and global maps.
9810 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9811 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9812 as a continuation of the previous key.
9814 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9815 convert the last event to lower case. (Normally any upper case event
9816 is converted to lower case if the original event is undefined and the lower
9817 case equivalent is defined.) A non-nil value is appropriate for reading
9818 a key sequence to be defined.
9820 A C-g typed while in this function is treated like any other character,
9821 and `quit-flag' is not set.
9823 If the key sequence starts with a mouse click, then the sequence is read
9824 using the keymaps of the buffer of the window clicked in, not the buffer
9825 of the selected window as normal.
9827 `read-key-sequence' drops unbound button-down events, since you normally
9828 only care about the click or drag events which follow them. If a drag
9829 or multi-click event is unbound, but the corresponding click event would
9830 be bound, `read-key-sequence' turns the event into a click event at the
9831 drag's starting position. This means that you don't have to distinguish
9832 between click and drag, double, or triple events unless you want to.
9834 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9835 lines separating windows, and scroll bars with imaginary keys
9836 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9838 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9839 function will process a switch-frame event if the user switches frames
9840 before typing anything. If the user switches frames in the middle of a
9841 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9842 is nil, then the event will be put off until after the current key sequence.
9844 `read-key-sequence' checks `function-key-map' for function key
9845 sequences, where they wouldn't conflict with ordinary bindings. See
9846 `function-key-map' for more details.
9848 The optional fifth argument CMD-LOOP, if non-nil, means
9849 that this key sequence is being read by something that will
9850 read commands one after another. It should be nil if the caller
9851 will read just one key sequence. */)
9852 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9854 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9855 can_return_switch_frame
, cmd_loop
, true);
9858 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9859 Sread_key_sequence_vector
, 1, 5, 0,
9860 doc
: /* Like `read-key-sequence' but always return a vector. */)
9861 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9863 return read_key_sequence_vs (prompt
, continue_echo
, dont_downcase_last
,
9864 can_return_switch_frame
, cmd_loop
, false);
9867 /* Return true if input events are pending. */
9870 detect_input_pending (void)
9872 return input_pending
|| get_input_pending (0);
9875 /* Return true if input events other than mouse movements are
9879 detect_input_pending_ignore_squeezables (void)
9881 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9884 /* Return true if input events are pending, and run any pending timers. */
9887 detect_input_pending_run_timers (bool do_display
)
9889 unsigned old_timers_run
= timers_run
;
9892 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9894 if (old_timers_run
!= timers_run
&& do_display
)
9895 redisplay_preserve_echo_area (8);
9897 return input_pending
;
9900 /* This is called in some cases before a possible quit.
9901 It cases the next call to detect_input_pending to recompute input_pending.
9902 So calling this function unnecessarily can't do any harm. */
9905 clear_input_pending (void)
9910 /* Return true if there are pending requeued events.
9911 This isn't used yet. The hope is to make wait_reading_process_output
9912 call it, and return if it runs Lisp code that unreads something.
9913 The problem is, kbd_buffer_get_event needs to be fixed to know what
9914 to do in that case. It isn't trivial. */
9917 requeued_events_pending_p (void)
9919 return (!NILP (Vunread_command_events
));
9922 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 1, 0,
9923 doc
: /* Return t if command input is currently available with no wait.
9924 Actually, the value is nil only if we can be sure that no input is available;
9925 if there is a doubt, the value is t.
9927 If CHECK-TIMERS is non-nil, timers that are ready to run will do so. */)
9928 (Lisp_Object check_timers
)
9930 if (!NILP (Vunread_command_events
)
9931 || !NILP (Vunread_post_input_method_events
)
9932 || !NILP (Vunread_input_method_events
))
9935 /* Process non-user-visible events (Bug#10195). */
9936 process_special_events ();
9938 return (get_input_pending ((NILP (check_timers
)
9939 ? 0 : READABLE_EVENTS_DO_TIMERS_NOW
)
9940 | READABLE_EVENTS_FILTER_EVENTS
)
9944 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9945 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9948 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9951 if (total_keys
< NUM_RECENT_KEYS
)
9952 return Fvector (total_keys
, keys
);
9955 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9956 vcopy (val
, 0, keys
+ recent_keys_index
,
9957 NUM_RECENT_KEYS
- recent_keys_index
);
9958 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9959 keys
, recent_keys_index
);
9964 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
9965 doc
: /* Return the key sequence that invoked this command.
9966 However, if the command has called `read-key-sequence', it returns
9967 the last key sequence that has been read.
9968 The value is a string or a vector.
9970 See also `this-command-keys-vector'. */)
9973 return make_event_array (this_command_key_count
,
9974 XVECTOR (this_command_keys
)->contents
);
9977 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
9978 doc
: /* Return the key sequence that invoked this command, as a vector.
9979 However, if the command has called `read-key-sequence', it returns
9980 the last key sequence that has been read.
9982 See also `this-command-keys'. */)
9985 return Fvector (this_command_key_count
,
9986 XVECTOR (this_command_keys
)->contents
);
9989 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
9990 Sthis_single_command_keys
, 0, 0, 0,
9991 doc
: /* Return the key sequence that invoked this command.
9992 More generally, it returns the last key sequence read, either by
9993 the command loop or by `read-key-sequence'.
9994 Unlike `this-command-keys', this function's value
9995 does not include prefix arguments.
9996 The value is always a vector. */)
9999 return Fvector (this_command_key_count
10000 - this_single_command_key_start
,
10001 (XVECTOR (this_command_keys
)->contents
10002 + this_single_command_key_start
));
10005 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10006 Sthis_single_command_raw_keys
, 0, 0, 0,
10007 doc
: /* Return the raw events that were read for this command.
10008 More generally, it returns the last key sequence read, either by
10009 the command loop or by `read-key-sequence'.
10010 Unlike `this-single-command-keys', this function's value
10011 shows the events before all translations (except for input methods).
10012 The value is always a vector. */)
10015 return Fvector (raw_keybuf_count
, XVECTOR (raw_keybuf
)->contents
);
10018 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10019 Sreset_this_command_lengths
, 0, 0, 0,
10020 doc
: /* Make the unread events replace the last command and echo.
10021 Used in `universal-argument-other-key'.
10023 `universal-argument-other-key' rereads the event just typed.
10024 It then gets translated through `function-key-map'.
10025 The translated event has to replace the real events,
10026 both in the value of (this-command-keys) and in echoing.
10027 To achieve this, `universal-argument-other-key' calls
10028 `reset-this-command-lengths', which discards the record of reading
10029 these events the first time. */)
10032 this_command_key_count
= before_command_key_count
;
10033 if (this_command_key_count
< this_single_command_key_start
)
10034 this_single_command_key_start
= this_command_key_count
;
10036 echo_truncate (before_command_echo_length
);
10038 /* Cause whatever we put into unread-command-events
10039 to echo as if it were being freshly read from the keyboard. */
10040 this_command_key_count_reset
= 1;
10045 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10046 Sclear_this_command_keys
, 0, 1, 0,
10047 doc
: /* Clear out the vector that `this-command-keys' returns.
10048 Also clear the record of the last 100 events, unless optional arg
10049 KEEP-RECORD is non-nil. */)
10050 (Lisp_Object keep_record
)
10054 this_command_key_count
= 0;
10055 this_command_key_count_reset
= 0;
10057 if (NILP (keep_record
))
10059 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10060 ASET (recent_keys
, i
, Qnil
);
10062 recent_keys_index
= 0;
10067 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10068 doc
: /* Return the current depth in recursive edits. */)
10072 /* Wrap around reliably on integer overflow. */
10073 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10074 XSETINT (temp
, sum
);
10078 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10079 "FOpen dribble file: ",
10080 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10081 If FILE is nil, close any open dribble file.
10082 The file will be closed when Emacs exits.
10084 Be aware that this records ALL characters you type!
10085 This may include sensitive information such as passwords. */)
10098 Lisp_Object encfile
;
10100 file
= Fexpand_file_name (file
, Qnil
);
10101 encfile
= ENCODE_FILE (file
);
10102 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10103 if (fd
< 0 && errno
== EEXIST
&& unlink (SSDATA (encfile
)) == 0)
10104 fd
= emacs_open (SSDATA (encfile
), O_WRONLY
| O_CREAT
| O_EXCL
, 0600);
10105 dribble
= fd
< 0 ? 0 : fdopen (fd
, "w");
10107 report_file_error ("Opening dribble", file
);
10112 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10113 doc
: /* Discard the contents of the terminal input buffer.
10114 Also end any kbd macro being defined. */)
10117 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10119 /* Discard the last command from the macro. */
10120 Fcancel_kbd_macro_events ();
10124 Vunread_command_events
= Qnil
;
10126 discard_tty_input ();
10128 kbd_fetch_ptr
= kbd_store_ptr
;
10134 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10135 doc
: /* Stop Emacs and return to superior process. You can resume later.
10136 If `cannot-suspend' is non-nil, or if the system doesn't support job
10137 control, run a subshell instead.
10139 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10140 to be read as terminal input by Emacs's parent, after suspension.
10142 Before suspending, run the normal hook `suspend-hook'.
10143 After resumption run the normal hook `suspend-resume-hook'.
10145 Some operating systems cannot stop the Emacs process and resume it later.
10146 On such systems, Emacs starts a subshell instead of suspending. */)
10147 (Lisp_Object stuffstring
)
10149 ptrdiff_t count
= SPECPDL_INDEX ();
10150 int old_height
, old_width
;
10152 struct gcpro gcpro1
;
10155 if (tty_list
&& tty_list
->next
)
10156 error ("There are other tty frames open; close them before suspending Emacs");
10158 if (!NILP (stuffstring
))
10159 CHECK_STRING (stuffstring
);
10161 /* Run the functions in suspend-hook. */
10162 hook
= intern ("suspend-hook");
10163 Frun_hooks (1, &hook
);
10165 GCPRO1 (stuffstring
);
10166 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10167 reset_all_sys_modes ();
10168 /* sys_suspend can get an error if it tries to fork a subshell
10169 and the system resources aren't available for that. */
10170 record_unwind_protect_void (init_all_sys_modes
);
10171 stuff_buffered_input (stuffstring
);
10172 if (cannot_suspend
)
10176 unbind_to (count
, Qnil
);
10178 /* Check if terminal/window size has changed.
10179 Note that this is not useful when we are running directly
10180 with a window system; but suspend should be disabled in that case. */
10181 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10182 if (width
!= old_width
|| height
!= old_height
)
10183 change_frame_size (SELECTED_FRAME (), width
, height
, 0, 0, 0, 0);
10185 /* Run suspend-resume-hook. */
10186 hook
= intern ("suspend-resume-hook");
10187 Frun_hooks (1, &hook
);
10193 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10194 Then in any case stuff anything Emacs has read ahead and not used. */
10197 stuff_buffered_input (Lisp_Object stuffstring
)
10199 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10200 register unsigned char *p
;
10202 if (STRINGP (stuffstring
))
10204 register ptrdiff_t count
;
10206 p
= SDATA (stuffstring
);
10207 count
= SBYTES (stuffstring
);
10208 while (count
-- > 0)
10213 /* Anything we have read ahead, put back for the shell to read. */
10214 /* ?? What should this do when we have multiple keyboards??
10215 Should we ignore anything that was typed in at the "wrong" kboard?
10217 rms: we should stuff everything back into the kboard
10219 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10222 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10223 kbd_fetch_ptr
= kbd_buffer
;
10224 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10225 stuff_char (kbd_fetch_ptr
->code
);
10227 clear_event (kbd_fetch_ptr
);
10231 #endif /* SIGTSTP */
10235 set_waiting_for_input (struct timespec
*time_to_clear
)
10237 input_available_clear_time
= time_to_clear
;
10239 /* Tell handle_interrupt to throw back to read_char, */
10240 waiting_for_input
= 1;
10242 /* If handle_interrupt was called before and buffered a C-g,
10243 make it run again now, to avoid timing error. */
10244 if (!NILP (Vquit_flag
))
10245 quit_throw_to_read_char (0);
10249 clear_waiting_for_input (void)
10251 /* Tell handle_interrupt not to throw back to read_char, */
10252 waiting_for_input
= 0;
10253 input_available_clear_time
= 0;
10256 /* The SIGINT handler.
10258 If we have a frame on the controlling tty, we assume that the
10259 SIGINT was generated by C-g, so we call handle_interrupt.
10260 Otherwise, tell QUIT to kill Emacs. */
10263 handle_interrupt_signal (int sig
)
10265 /* See if we have an active terminal on our controlling tty. */
10266 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10269 /* If there are no frames there, let's pretend that we are a
10270 well-behaving UN*X program and quit. We must not call Lisp
10271 in a signal handler, so tell QUIT to exit when it is
10273 Vquit_flag
= Qkill_emacs
;
10277 /* Otherwise, the SIGINT was probably generated by C-g. */
10279 /* Set internal_last_event_frame to the top frame of the
10280 controlling tty, if we have a frame there. We disable the
10281 interrupt key on secondary ttys, so the SIGINT must have come
10282 from the controlling tty. */
10283 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10285 handle_interrupt (1);
10290 deliver_interrupt_signal (int sig
)
10292 deliver_process_signal (sig
, handle_interrupt_signal
);
10296 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10297 of the number of times C-g has been requested. If C-g is pressed
10298 enough times, then quit anyway. See bug#6585. */
10299 static int volatile force_quit_count
;
10301 /* This routine is called at interrupt level in response to C-g.
10303 It is called from the SIGINT handler or kbd_buffer_store_event.
10305 If `waiting_for_input' is non zero, then unless `echoing' is
10306 nonzero, immediately throw back to read_char.
10308 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10309 eval to throw, when it gets a chance. If quit-flag is already
10310 non-nil, it stops the job right away. */
10313 handle_interrupt (bool in_signal_handler
)
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. */
10328 sigemptyset (&blocked
);
10329 sigaddset (&blocked
, SIGINT
);
10330 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10334 reset_all_sys_modes ();
10338 * On systems which can suspend the current process and return to the original
10339 * shell, this command causes the user to end up back at the shell.
10340 * The "Auto-save" and "Abort" questions are not asked until
10341 * the user elects to return to emacs, at which point he can save the current
10342 * job and either dump core or continue.
10346 /* Perhaps should really fork an inferior shell?
10347 But that would not provide any way to get back
10348 to the original shell, ever. */
10349 printf ("No support for stopping a process on this operating system;\n");
10350 printf ("you can continue or abort.\n");
10351 #endif /* not SIGTSTP */
10353 /* We must remain inside the screen area when the internal terminal
10354 is used. Note that [Enter] is not echoed by dos. */
10355 cursor_to (SELECTED_FRAME (), 0, 0);
10357 /* It doesn't work to autosave while GC is in progress;
10358 the code used for auto-saving doesn't cope with the mark bit. */
10359 if (!gc_in_progress
)
10361 printf ("Auto-save? (y or n) ");
10363 if (((c
= getchar ()) & ~040) == 'Y')
10365 Fdo_auto_save (Qt
, Qnil
);
10367 printf ("\r\nAuto-save done");
10368 #else /* not MSDOS */
10369 printf ("Auto-save done\n");
10370 #endif /* not MSDOS */
10372 while (c
!= '\n') c
= getchar ();
10376 /* During GC, it must be safe to reenable quitting again. */
10377 Vinhibit_quit
= Qnil
;
10380 #endif /* not MSDOS */
10381 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10382 printf ("but will instead do a real quit after garbage collection ends\r\n");
10387 printf ("\r\nAbort? (y or n) ");
10388 #else /* not MSDOS */
10389 printf ("Abort (and dump core)? (y or n) ");
10390 #endif /* not MSDOS */
10392 if (((c
= getchar ()) & ~040) == 'Y')
10394 while (c
!= '\n') c
= getchar ();
10396 printf ("\r\nContinuing...\r\n");
10397 #else /* not MSDOS */
10398 printf ("Continuing...\n");
10399 #endif /* not MSDOS */
10401 init_all_sys_modes ();
10405 /* If executing a function that wants to be interrupted out of
10406 and the user has not deferred quitting by binding `inhibit-quit'
10407 then quit right away. */
10408 if (immediate_quit
&& NILP (Vinhibit_quit
))
10410 struct gl_state_s saved
;
10411 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10413 immediate_quit
= 0;
10414 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10416 GCPRO4 (saved
.object
, saved
.global_code
,
10417 saved
.current_syntax_table
, saved
.old_prop
);
10418 Fsignal (Qquit
, Qnil
);
10423 { /* Else request quit when it's safe. */
10424 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10425 force_quit_count
= count
;
10428 immediate_quit
= 1;
10429 Vinhibit_quit
= Qnil
;
10435 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10437 /* TODO: The longjmp in this call throws the NS event loop integration off,
10438 and it seems to do fine without this. Probably some attention
10439 needs to be paid to the setting of waiting_for_input in
10440 wait_reading_process_output() under HAVE_NS because of the call
10441 to ns_select there (needed because otherwise events aren't picked up
10442 outside of polling since we don't get SIGIO like X and we don't have a
10443 separate event loop thread like W32. */
10445 if (waiting_for_input
&& !echoing
)
10446 quit_throw_to_read_char (in_signal_handler
);
10450 /* Handle a C-g by making read_char return C-g. */
10453 quit_throw_to_read_char (bool from_signal
)
10455 /* When not called from a signal handler it is safe to call
10457 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10458 Fkill_emacs (Qnil
);
10460 /* Prevent another signal from doing this before we finish. */
10461 clear_waiting_for_input ();
10464 Vunread_command_events
= Qnil
;
10466 if (FRAMEP (internal_last_event_frame
)
10467 && !EQ (internal_last_event_frame
, selected_frame
))
10468 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10471 sys_longjmp (getcjmp
, 1);
10474 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10475 Sset_input_interrupt_mode
, 1, 1, 0,
10476 doc
: /* Set interrupt mode of reading keyboard input.
10477 If INTERRUPT is non-nil, Emacs will use input interrupts;
10478 otherwise Emacs uses CBREAK mode.
10480 See also `current-input-mode'. */)
10481 (Lisp_Object interrupt
)
10483 bool new_interrupt_input
;
10484 #ifdef USABLE_SIGIO
10485 #ifdef HAVE_X_WINDOWS
10486 if (x_display_list
!= NULL
)
10488 /* When using X, don't give the user a real choice,
10489 because we haven't implemented the mechanisms to support it. */
10490 new_interrupt_input
= 1;
10493 #endif /* HAVE_X_WINDOWS */
10494 new_interrupt_input
= !NILP (interrupt
);
10495 #else /* not USABLE_SIGIO */
10496 new_interrupt_input
= 0;
10497 #endif /* not USABLE_SIGIO */
10499 if (new_interrupt_input
!= interrupt_input
)
10501 #ifdef POLL_FOR_INPUT
10505 /* this causes startup screen to be restored and messes with the mouse */
10506 reset_all_sys_modes ();
10507 interrupt_input
= new_interrupt_input
;
10508 init_all_sys_modes ();
10510 interrupt_input
= new_interrupt_input
;
10513 #ifdef POLL_FOR_INPUT
10514 poll_suppress_count
= 1;
10521 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10522 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10523 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10524 C-q in key sequences.
10526 This setting only has an effect on tty terminals and only when
10527 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10529 See also `current-input-mode'. */)
10530 (Lisp_Object flow
, Lisp_Object terminal
)
10532 struct terminal
*t
= get_terminal (terminal
, 1);
10533 struct tty_display_info
*tty
;
10534 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10536 tty
= t
->display_info
.tty
;
10538 if (tty
->flow_control
!= !NILP (flow
))
10541 /* This causes startup screen to be restored and messes with the mouse. */
10542 reset_sys_modes (tty
);
10545 tty
->flow_control
= !NILP (flow
);
10548 init_sys_modes (tty
);
10554 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10555 doc
: /* Enable or disable 8-bit input on TERMINAL.
10556 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10557 bit as the Meta modifier.
10559 If META is nil, Emacs will ignore the top bit, on the assumption it is
10562 Otherwise, Emacs will accept and pass through 8-bit input without
10563 specially interpreting the top bit.
10565 This setting only has an effect on tty terminal devices.
10567 Optional parameter TERMINAL specifies the tty terminal device to use.
10568 It may be a terminal object, a frame, or nil for the terminal used by
10569 the currently selected frame.
10571 See also `current-input-mode'. */)
10572 (Lisp_Object meta
, Lisp_Object terminal
)
10574 struct terminal
*t
= get_terminal (terminal
, 1);
10575 struct tty_display_info
*tty
;
10578 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10580 tty
= t
->display_info
.tty
;
10584 else if (EQ (meta
, Qt
))
10589 if (tty
->meta_key
!= new_meta
)
10592 /* this causes startup screen to be restored and messes with the mouse */
10593 reset_sys_modes (tty
);
10596 tty
->meta_key
= new_meta
;
10599 init_sys_modes (tty
);
10605 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10606 doc
: /* Specify character used for quitting.
10607 QUIT must be an ASCII character.
10609 This function only has an effect on the controlling tty of the Emacs
10612 See also `current-input-mode'. */)
10615 struct terminal
*t
= get_named_tty ("/dev/tty");
10616 struct tty_display_info
*tty
;
10617 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10619 tty
= t
->display_info
.tty
;
10621 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10622 error ("QUIT must be an ASCII character");
10625 /* this causes startup screen to be restored and messes with the mouse */
10626 reset_sys_modes (tty
);
10629 /* Don't let this value be out of range. */
10630 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10633 init_sys_modes (tty
);
10639 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10640 doc
: /* Set mode of reading keyboard input.
10641 First arg INTERRUPT non-nil means use input interrupts;
10642 nil means use CBREAK mode.
10643 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10644 (no effect except in CBREAK mode).
10645 Third arg META t means accept 8-bit input (for a Meta key).
10646 META nil means ignore the top bit, on the assumption it is parity.
10647 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10648 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10649 See also `current-input-mode'. */)
10650 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10652 Fset_input_interrupt_mode (interrupt
);
10653 Fset_output_flow_control (flow
, Qnil
);
10654 Fset_input_meta_mode (meta
, Qnil
);
10656 Fset_quit_char (quit
);
10660 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10661 doc
: /* Return information about the way Emacs currently reads keyboard input.
10662 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10663 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10664 nil, Emacs is using CBREAK mode.
10665 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10666 terminal; this does not apply if Emacs uses interrupt-driven input.
10667 META is t if accepting 8-bit input with 8th bit as Meta flag.
10668 META nil means ignoring the top bit, on the assumption it is parity.
10669 META is neither t nor nil if accepting 8-bit input and using
10670 all 8 bits as the character code.
10671 QUIT is the character Emacs currently uses to quit.
10672 The elements of this list correspond to the arguments of
10673 `set-input-mode'. */)
10676 Lisp_Object val
[4];
10677 struct frame
*sf
= XFRAME (selected_frame
);
10679 val
[0] = interrupt_input
? Qt
: Qnil
;
10680 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10682 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10683 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10685 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10692 XSETFASTINT (val
[3], quit_char
);
10694 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10697 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10698 doc
: /* Return position information for pixel coordinates X and Y.
10699 By default, X and Y are relative to text area of the selected window.
10700 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10701 If optional fourth arg WHOLE is non-nil, X is relative to the left
10702 edge of the window.
10704 The return value is similar to a mouse click position:
10705 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10706 IMAGE (DX . DY) (WIDTH . HEIGHT))
10707 The `posn-' functions access elements of such lists. */)
10708 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10713 if (NILP (frame_or_window
))
10714 frame_or_window
= selected_window
;
10716 if (WINDOWP (frame_or_window
))
10718 struct window
*w
= decode_live_window (frame_or_window
);
10720 XSETINT (x
, (XINT (x
)
10721 + WINDOW_LEFT_EDGE_X (w
)
10723 ? window_box_left_offset (w
, TEXT_AREA
)
10725 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10726 frame_or_window
= w
->frame
;
10729 CHECK_LIVE_FRAME (frame_or_window
);
10731 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10734 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10735 doc
: /* Return position information for buffer POS in WINDOW.
10736 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10738 Return nil if position is not visible in window. Otherwise,
10739 the return value is similar to that returned by `event-start' for
10740 a mouse click at the upper left corner of the glyph corresponding
10741 to the given buffer position:
10742 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10743 IMAGE (DX . DY) (WIDTH . HEIGHT))
10744 The `posn-' functions access elements of such lists. */)
10745 (Lisp_Object pos
, Lisp_Object window
)
10750 window
= selected_window
;
10752 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10755 Lisp_Object x
= XCAR (tem
);
10756 Lisp_Object y
= XCAR (XCDR (tem
));
10758 /* Point invisible due to hscrolling? */
10761 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10767 /* Set up a new kboard object with reasonable initial values.
10768 TYPE is a window system for which this keyboard is used. */
10771 init_kboard (KBOARD
*kb
, Lisp_Object type
)
10773 kset_overriding_terminal_local_map (kb
, Qnil
);
10774 kset_last_command (kb
, Qnil
);
10775 kset_real_last_command (kb
, Qnil
);
10776 kset_keyboard_translate_table (kb
, Qnil
);
10777 kset_last_repeatable_command (kb
, Qnil
);
10778 kset_prefix_arg (kb
, Qnil
);
10779 kset_last_prefix_arg (kb
, Qnil
);
10780 kset_kbd_queue (kb
, Qnil
);
10781 kb
->kbd_queue_has_data
= 0;
10782 kb
->immediate_echo
= 0;
10783 kset_echo_string (kb
, Qnil
);
10784 kb
->echo_after_prompt
= -1;
10785 kb
->kbd_macro_buffer
= 0;
10786 kb
->kbd_macro_bufsize
= 0;
10787 kset_defining_kbd_macro (kb
, Qnil
);
10788 kset_last_kbd_macro (kb
, Qnil
);
10789 kb
->reference_count
= 0;
10790 kset_system_key_alist (kb
, Qnil
);
10791 kset_system_key_syms (kb
, Qnil
);
10792 kset_window_system (kb
, type
);
10793 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10794 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10795 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10796 kset_default_minibuffer_frame (kb
, Qnil
);
10799 /* Allocate and basically initialize keyboard
10800 object to use with window system TYPE. */
10803 allocate_kboard (Lisp_Object type
)
10805 KBOARD
*kb
= xmalloc (sizeof *kb
);
10807 init_kboard (kb
, type
);
10808 kb
->next_kboard
= all_kboards
;
10814 * Destroy the contents of a kboard object, but not the object itself.
10815 * We use this just before deleting it, or if we're going to initialize
10816 * it a second time.
10819 wipe_kboard (KBOARD
*kb
)
10821 xfree (kb
->kbd_macro_buffer
);
10824 /* Free KB and memory referenced from it. */
10827 delete_kboard (KBOARD
*kb
)
10831 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10834 *kbp
= kb
->next_kboard
;
10836 /* Prevent a dangling reference to KB. */
10837 if (kb
== current_kboard
10838 && FRAMEP (selected_frame
)
10839 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10841 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10843 if (current_kboard
== kb
)
10852 init_keyboard (void)
10854 /* This is correct before outermost invocation of the editor loop. */
10855 command_loop_level
= -1;
10856 immediate_quit
= 0;
10857 quit_char
= Ctl ('g');
10858 Vunread_command_events
= Qnil
;
10859 timer_idleness_start_time
= invalid_timespec ();
10861 recent_keys_index
= 0;
10862 kbd_fetch_ptr
= kbd_buffer
;
10863 kbd_store_ptr
= kbd_buffer
;
10864 do_mouse_tracking
= Qnil
;
10866 interrupt_input_blocked
= 0;
10867 pending_signals
= 0;
10869 /* This means that command_loop_1 won't try to select anything the first
10871 internal_last_event_frame
= Qnil
;
10872 Vlast_event_frame
= internal_last_event_frame
;
10874 current_kboard
= initial_kboard
;
10875 /* Re-initialize the keyboard again. */
10876 wipe_kboard (current_kboard
);
10877 /* A value of nil for Vwindow_system normally means a tty, but we also use
10878 it for the initial terminal since there is no window system there. */
10879 init_kboard (current_kboard
, Qnil
);
10881 if (!noninteractive
)
10883 /* Before multi-tty support, these handlers used to be installed
10884 only if the current session was a tty session. Now an Emacs
10885 session may have multiple display types, so we always handle
10886 SIGINT. There is special code in handle_interrupt_signal to exit
10887 Emacs on SIGINT when there are no termcap frames on the
10888 controlling terminal. */
10889 struct sigaction action
;
10890 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10891 sigaction (SIGINT
, &action
, 0);
10893 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10894 SIGQUIT and we can't tell which one it will give us. */
10895 sigaction (SIGQUIT
, &action
, 0);
10896 #endif /* not DOS_NT */
10898 #ifdef USABLE_SIGIO
10899 if (!noninteractive
)
10901 struct sigaction action
;
10902 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10903 sigaction (SIGIO
, &action
, 0);
10907 /* Use interrupt input by default, if it works and noninterrupt input
10908 has deficiencies. */
10910 #ifdef INTERRUPT_INPUT
10911 interrupt_input
= 1;
10913 interrupt_input
= 0;
10916 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10919 if (keyboard_init_hook
)
10920 (*keyboard_init_hook
) ();
10922 #ifdef POLL_FOR_INPUT
10924 poll_suppress_count
= 1;
10929 /* This type's only use is in syms_of_keyboard, to initialize the
10930 event header symbols and put properties on them. */
10931 struct event_head
{
10937 static const struct event_head head_table
[] = {
10938 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10939 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10940 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10941 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10942 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10943 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10944 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10945 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10946 /* `select-window' should be handled just like `switch-frame'
10947 in read_key_sequence. */
10948 {&Qselect_window
, "select-window", &Qswitch_frame
}
10952 syms_of_keyboard (void)
10954 pending_funcalls
= Qnil
;
10955 staticpro (&pending_funcalls
);
10957 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10958 staticpro (&Vlispy_mouse_stem
);
10961 DEFSYM (QCimage
, ":image");
10962 DEFSYM (Qhelp_echo
, "help-echo");
10963 DEFSYM (QCrtl
, ":rtl");
10965 staticpro (&item_properties
);
10966 item_properties
= Qnil
;
10968 staticpro (&tool_bar_item_properties
);
10969 tool_bar_item_properties
= Qnil
;
10970 staticpro (&tool_bar_items_vector
);
10971 tool_bar_items_vector
= Qnil
;
10973 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10974 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10975 DEFSYM (Qself_insert_command
, "self-insert-command");
10976 DEFSYM (Qforward_char
, "forward-char");
10977 DEFSYM (Qbackward_char
, "backward-char");
10978 DEFSYM (Qdisabled
, "disabled");
10979 DEFSYM (Qundefined
, "undefined");
10980 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10981 DEFSYM (Qpost_command_hook
, "post-command-hook");
10982 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
10983 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
10984 DEFSYM (Qfunction_key
, "function-key");
10985 DEFSYM (Qmouse_click
, "mouse-click");
10986 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
10987 DEFSYM (Qsave_session
, "save-session");
10988 DEFSYM (Qconfig_changed_event
, "config-changed-event");
10989 DEFSYM (Qmenu_enable
, "menu-enable");
10992 DEFSYM (Qlanguage_change
, "language-change");
10996 DEFSYM (Qdbus_event
, "dbus-event");
10999 #ifdef USE_FILE_NOTIFY
11000 DEFSYM (Qfile_notify
, "file-notify");
11001 #endif /* USE_FILE_NOTIFY */
11003 DEFSYM (QCenable
, ":enable");
11004 DEFSYM (QCvisible
, ":visible");
11005 DEFSYM (QChelp
, ":help");
11006 DEFSYM (QCfilter
, ":filter");
11007 DEFSYM (QCbutton
, ":button");
11008 DEFSYM (QCkeys
, ":keys");
11009 DEFSYM (QCkey_sequence
, ":key-sequence");
11010 DEFSYM (QCtoggle
, ":toggle");
11011 DEFSYM (QCradio
, ":radio");
11012 DEFSYM (QClabel
, ":label");
11013 DEFSYM (QCvert_only
, ":vert-only");
11015 DEFSYM (Qmode_line
, "mode-line");
11016 DEFSYM (Qvertical_line
, "vertical-line");
11017 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11018 DEFSYM (Qmenu_bar
, "menu-bar");
11019 DEFSYM (Qright_divider
, "right-divider");
11020 DEFSYM (Qbottom_divider
, "bottom-divider");
11022 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11024 DEFSYM (Qabove_handle
, "above-handle");
11025 DEFSYM (Qhandle
, "handle");
11026 DEFSYM (Qbelow_handle
, "below-handle");
11027 DEFSYM (Qup
, "up");
11028 DEFSYM (Qdown
, "down");
11029 DEFSYM (Qtop
, "top");
11030 DEFSYM (Qbottom
, "bottom");
11031 DEFSYM (Qend_scroll
, "end-scroll");
11032 DEFSYM (Qratio
, "ratio");
11034 DEFSYM (Qevent_kind
, "event-kind");
11035 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11036 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11037 DEFSYM (Qmodifier_cache
, "modifier-cache");
11039 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11040 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11042 DEFSYM (Qpolling_period
, "polling-period");
11044 DEFSYM (Qx_set_selection
, "x-set-selection");
11045 DEFSYM (QPRIMARY
, "PRIMARY");
11046 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11047 DEFSYM (Qhandle_select_window
, "handle-select-window");
11049 DEFSYM (Qinput_method_function
, "input-method-function");
11050 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11051 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11053 DEFSYM (Qhelp_form_show
, "help-form-show");
11055 DEFSYM (Qecho_keystrokes
, "echo-keystrokes");
11057 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11058 Fset (Qinput_method_use_echo_area
, Qnil
);
11062 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11064 for (i
= 0; i
< len
; i
++)
11066 const struct event_head
*p
= &head_table
[i
];
11067 *p
->var
= intern_c_string (p
->name
);
11068 staticpro (p
->var
);
11069 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11070 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11074 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11075 staticpro (&button_down_location
);
11076 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11077 staticpro (&mouse_syms
);
11078 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11079 / sizeof (lispy_wheel_names
[0])),
11081 staticpro (&wheel_syms
);
11085 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11087 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11088 for (i
= 0; i
< len
; i
++)
11089 if (modifier_names
[i
])
11090 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11091 staticpro (&modifier_symbols
);
11094 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11095 staticpro (&recent_keys
);
11097 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11098 staticpro (&this_command_keys
);
11100 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11101 staticpro (&raw_keybuf
);
11103 DEFSYM (Qcommand_execute
, "command-execute");
11105 accent_key_syms
= Qnil
;
11106 staticpro (&accent_key_syms
);
11108 func_key_syms
= Qnil
;
11109 staticpro (&func_key_syms
);
11111 drag_n_drop_syms
= Qnil
;
11112 staticpro (&drag_n_drop_syms
);
11114 unread_switch_frame
= Qnil
;
11115 staticpro (&unread_switch_frame
);
11117 internal_last_event_frame
= Qnil
;
11118 staticpro (&internal_last_event_frame
);
11120 read_key_sequence_cmd
= Qnil
;
11121 staticpro (&read_key_sequence_cmd
);
11122 read_key_sequence_remapped
= Qnil
;
11123 staticpro (&read_key_sequence_remapped
);
11125 menu_bar_one_keymap_changed_items
= Qnil
;
11126 staticpro (&menu_bar_one_keymap_changed_items
);
11128 menu_bar_items_vector
= Qnil
;
11129 staticpro (&menu_bar_items_vector
);
11131 help_form_saved_window_configs
= Qnil
;
11132 staticpro (&help_form_saved_window_configs
);
11134 defsubr (&Scurrent_idle_time
);
11135 defsubr (&Sevent_symbol_parse_modifiers
);
11136 defsubr (&Sevent_convert_list
);
11137 defsubr (&Sread_key_sequence
);
11138 defsubr (&Sread_key_sequence_vector
);
11139 defsubr (&Srecursive_edit
);
11140 defsubr (&Strack_mouse
);
11141 defsubr (&Sinput_pending_p
);
11142 defsubr (&Srecent_keys
);
11143 defsubr (&Sthis_command_keys
);
11144 defsubr (&Sthis_command_keys_vector
);
11145 defsubr (&Sthis_single_command_keys
);
11146 defsubr (&Sthis_single_command_raw_keys
);
11147 defsubr (&Sreset_this_command_lengths
);
11148 defsubr (&Sclear_this_command_keys
);
11149 defsubr (&Ssuspend_emacs
);
11150 defsubr (&Sabort_recursive_edit
);
11151 defsubr (&Sexit_recursive_edit
);
11152 defsubr (&Srecursion_depth
);
11153 defsubr (&Scommand_error_default_function
);
11154 defsubr (&Stop_level
);
11155 defsubr (&Sdiscard_input
);
11156 defsubr (&Sopen_dribble_file
);
11157 defsubr (&Sset_input_interrupt_mode
);
11158 defsubr (&Sset_output_flow_control
);
11159 defsubr (&Sset_input_meta_mode
);
11160 defsubr (&Sset_quit_char
);
11161 defsubr (&Sset_input_mode
);
11162 defsubr (&Scurrent_input_mode
);
11163 defsubr (&Sposn_at_point
);
11164 defsubr (&Sposn_at_x_y
);
11166 DEFVAR_LISP ("last-command-event", last_command_event
,
11167 doc
: /* Last input event that was part of a command. */);
11169 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11170 doc
: /* Last input event in a command, except for mouse menu events.
11171 Mouse menus give back keys that don't look like mouse events;
11172 this variable holds the actual mouse event that led to the menu,
11173 so that you can determine whether the command was run by mouse or not. */);
11175 DEFVAR_LISP ("last-input-event", last_input_event
,
11176 doc
: /* Last input event. */);
11178 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11179 doc
: /* List of events to be read as the command input.
11180 These events are processed first, before actual keyboard input.
11181 Events read from this list are not normally added to `this-command-keys',
11182 as they will already have been added once as they were read for the first time.
11183 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11184 Vunread_command_events
= Qnil
;
11186 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11187 doc
: /* List of events to be processed as input by input methods.
11188 These events are processed before `unread-command-events'
11189 and actual keyboard input, but are not given to `input-method-function'. */);
11190 Vunread_post_input_method_events
= Qnil
;
11192 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11193 doc
: /* List of events to be processed as input by input methods.
11194 These events are processed after `unread-command-events', but
11195 before actual keyboard input.
11196 If there's an active input method, the events are given to
11197 `input-method-function'. */);
11198 Vunread_input_method_events
= Qnil
;
11200 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11201 doc
: /* Meta-prefix character code.
11202 Meta-foo as command input turns into this character followed by foo. */);
11203 XSETINT (meta_prefix_char
, 033);
11205 DEFVAR_KBOARD ("last-command", Vlast_command
,
11206 doc
: /* The last command executed.
11207 Normally a symbol with a function definition, but can be whatever was found
11208 in the keymap, or whatever the variable `this-command' was set to by that
11211 The value `mode-exit' is special; it means that the previous command
11212 read an event that told it to exit, and it did so and unread that event.
11213 In other words, the present command is the event that made the previous
11216 The value `kill-region' is special; it means that the previous command
11217 was a kill command.
11219 `last-command' has a separate binding for each terminal device.
11220 See Info node `(elisp)Multiple Terminals'. */);
11222 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11223 doc
: /* Same as `last-command', but never altered by Lisp code.
11224 Taken from the previous value of `real-this-command'. */);
11226 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11227 doc
: /* Last command that may be repeated.
11228 The last command executed that was not bound to an input event.
11229 This is the command `repeat' will try to repeat.
11230 Taken from a previous value of `real-this-command'. */);
11232 DEFVAR_LISP ("this-command", Vthis_command
,
11233 doc
: /* The command now being executed.
11234 The command can set this variable; whatever is put here
11235 will be in `last-command' during the following command. */);
11236 Vthis_command
= Qnil
;
11238 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11239 doc
: /* This is like `this-command', except that commands should never modify it. */);
11240 Vreal_this_command
= Qnil
;
11242 DEFVAR_LISP ("this-command-keys-shift-translated",
11243 Vthis_command_keys_shift_translated
,
11244 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11245 Shift-translation occurs when there is no binding for the key sequence
11246 as entered, but a binding was found by changing an upper-case letter
11247 to lower-case, or a shifted function key to an unshifted one. */);
11248 Vthis_command_keys_shift_translated
= Qnil
;
11250 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11251 doc
: /* The command bound to the current key sequence before remapping.
11252 It equals `this-command' if the original command was not remapped through
11253 any of the active keymaps. Otherwise, the value of `this-command' is the
11254 result of looking up the original command in the active keymaps. */);
11255 Vthis_original_command
= Qnil
;
11257 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11258 doc
: /* Number of input events between auto-saves.
11259 Zero means disable autosaving due to number of characters typed. */);
11260 auto_save_interval
= 300;
11262 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11263 doc
: /* Number of seconds idle time before auto-save.
11264 Zero or nil means disable auto-saving due to idleness.
11265 After auto-saving due to this many seconds of idle time,
11266 Emacs also does a garbage collection if that seems to be warranted. */);
11267 XSETFASTINT (Vauto_save_timeout
, 30);
11269 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11270 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11271 The value may be integer or floating point.
11272 If the value is zero, don't echo at all. */);
11273 Vecho_keystrokes
= make_number (1);
11275 DEFVAR_INT ("polling-period", polling_period
,
11276 doc
: /* Interval between polling for input during Lisp execution.
11277 The reason for polling is to make C-g work to stop a running program.
11278 Polling is needed only when using X windows and SIGIO does not work.
11279 Polling is automatically disabled in all other cases. */);
11280 polling_period
= 2;
11282 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11283 doc
: /* Maximum time between mouse clicks to make a double-click.
11284 Measured in milliseconds. The value nil means disable double-click
11285 recognition; t means double-clicks have no time limit and are detected
11286 by position only. */);
11287 Vdouble_click_time
= make_number (500);
11289 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11290 doc
: /* Maximum mouse movement between clicks to make a double-click.
11291 On window-system frames, value is the number of pixels the mouse may have
11292 moved horizontally or vertically between two clicks to make a double-click.
11293 On non window-system frames, value is interpreted in units of 1/8 characters
11296 This variable is also the threshold for motion of the mouse
11297 to count as a drag. */);
11298 double_click_fuzz
= 3;
11300 DEFVAR_INT ("num-input-keys", num_input_keys
,
11301 doc
: /* Number of complete key sequences read as input so far.
11302 This includes key sequences read from keyboard macros.
11303 The number is effectively the number of interactive command invocations. */);
11304 num_input_keys
= 0;
11306 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11307 doc
: /* Number of input events read from the keyboard so far.
11308 This does not include events generated by keyboard macros. */);
11309 num_nonmacro_input_events
= 0;
11311 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11312 doc
: /* The frame in which the most recently read event occurred.
11313 If the last event came from a keyboard macro, this is set to `macro'. */);
11314 Vlast_event_frame
= Qnil
;
11316 /* This variable is set up in sysdep.c. */
11317 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11318 doc
: /* The ERASE character as set by the user with stty. */);
11320 DEFVAR_LISP ("help-char", Vhelp_char
,
11321 doc
: /* Character to recognize as meaning Help.
11322 When it is read, do `(eval help-form)', and display result if it's a string.
11323 If the value of `help-form' is nil, this char can be read normally. */);
11324 XSETINT (Vhelp_char
, Ctl ('H'));
11326 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11327 doc
: /* List of input events to recognize as meaning Help.
11328 These work just like the value of `help-char' (see that). */);
11329 Vhelp_event_list
= Qnil
;
11331 DEFVAR_LISP ("help-form", Vhelp_form
,
11332 doc
: /* Form to execute when character `help-char' is read.
11333 If the form returns a string, that string is displayed.
11334 If `help-form' is nil, the help char is not recognized. */);
11337 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11338 doc
: /* Command to run when `help-char' character follows a prefix key.
11339 This command is used only when there is no actual binding
11340 for that character after that prefix key. */);
11341 Vprefix_help_command
= Qnil
;
11343 DEFVAR_LISP ("top-level", Vtop_level
,
11344 doc
: /* Form to evaluate when Emacs starts up.
11345 Useful to set before you dump a modified Emacs. */);
11348 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11349 doc
: /* Translate table for local keyboard input, or nil.
11350 If non-nil, the value should be a char-table. Each character read
11351 from the keyboard is looked up in this char-table. If the value found
11352 there is non-nil, then it is used instead of the actual input character.
11354 The value can also be a string or vector, but this is considered obsolete.
11355 If it is a string or vector of length N, character codes N and up are left
11356 untranslated. In a vector, an element which is nil means "no translation".
11358 This is applied to the characters supplied to input methods, not their
11359 output. See also `translation-table-for-input'.
11361 This variable has a separate binding for each terminal.
11362 See Info node `(elisp)Multiple Terminals'. */);
11364 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11365 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11366 \(Even if the operating system has support for stopping a process.\) */);
11367 cannot_suspend
= 0;
11369 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11370 doc
: /* Non-nil means prompt with menus when appropriate.
11371 This is done when reading from a keymap that has a prompt string,
11372 for elements that have prompt strings.
11373 The menu is displayed on the screen
11374 if X menus were enabled at configuration
11375 time and the previous event was a mouse click prefix key.
11376 Otherwise, menu prompting uses the echo area. */);
11377 menu_prompting
= 1;
11379 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11380 doc
: /* Character to see next line of menu prompt.
11381 Type this character while in a menu prompt to rotate around the lines of it. */);
11382 XSETINT (menu_prompt_more_char
, ' ');
11384 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11385 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11386 Emacs applies the modifiers of the character stored here to each keyboard
11387 character it reads. For example, after evaluating the expression
11388 (setq extra-keyboard-modifiers ?\\C-x)
11389 all input characters will have the control modifier applied to them.
11391 Note that the character ?\\C-@, equivalent to the integer zero, does
11392 not count as a control character; rather, it counts as a character
11393 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11394 cancels any modification. */);
11395 extra_keyboard_modifiers
= 0;
11397 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11398 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11399 The command loop sets this to nil before each command,
11400 and tests the value when the command returns.
11401 Buffer modification stores t in this variable. */);
11402 Vdeactivate_mark
= Qnil
;
11403 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11405 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11406 doc
: /* Normal hook run before each command is executed.
11407 If an unhandled error happens in running this hook,
11408 the function in which the error occurred is unconditionally removed, since
11409 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11410 Vpre_command_hook
= Qnil
;
11412 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11413 doc
: /* Normal hook run after each command is executed.
11414 If an unhandled error happens in running this hook,
11415 the function in which the error occurred is unconditionally removed, since
11416 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11417 Vpost_command_hook
= Qnil
;
11420 DEFVAR_LISP ("echo-area-clear-hook", ...,
11421 doc
: /* Normal hook run when clearing the echo area. */);
11423 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11424 Fset (Qecho_area_clear_hook
, Qnil
);
11426 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11427 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11428 Vlucid_menu_bar_dirty_flag
= Qnil
;
11430 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11431 doc
: /* List of menu bar items to move to the end of the menu bar.
11432 The elements of the list are event types that may have menu bar bindings. */);
11433 Vmenu_bar_final_items
= Qnil
;
11435 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11436 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11437 This is used internally by graphical displays that do not render
11438 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11439 Vtool_bar_separator_image_expression
= Qnil
;
11441 DEFVAR_KBOARD ("overriding-terminal-local-map",
11442 Voverriding_terminal_local_map
,
11443 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11444 This variable is intended to let commands such as `universal-argument'
11445 set up a different keymap for reading the next command.
11447 `overriding-terminal-local-map' has a separate binding for each
11448 terminal device. See Info node `(elisp)Multiple Terminals'. */);
11450 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11451 doc
: /* Keymap that replaces (overrides) local keymaps.
11452 If this variable is non-nil, Emacs looks up key bindings in this
11453 keymap INSTEAD OF the keymap char property, minor mode maps, and the
11454 buffer's local map. Hence, the only active keymaps would be
11455 `overriding-terminal-local-map', this keymap, and `global-keymap', in
11456 order of precedence. */);
11457 Voverriding_local_map
= Qnil
;
11459 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11460 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11461 Otherwise, the menu bar continues to reflect the buffer's local map
11462 and the minor mode maps regardless of `overriding-local-map'. */);
11463 Voverriding_local_map_menu_flag
= Qnil
;
11465 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11466 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11467 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11469 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11470 doc
: /* Non-nil means generate motion events for mouse motion. */);
11472 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11473 doc
: /* Alist of system-specific X windows key symbols.
11474 Each element should have the form (N . SYMBOL) where N is the
11475 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11476 and SYMBOL is its name.
11478 `system-key-alist' has a separate binding for each terminal device.
11479 See Info node `(elisp)Multiple Terminals'. */);
11481 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11482 doc
: /* Keymap that translates key sequences to key sequences during input.
11483 This is used mainly for mapping key sequences into some preferred
11484 key events (symbols).
11486 The `read-key-sequence' function replaces any subsequence bound by
11487 `local-function-key-map' with its binding. More precisely, when the
11488 active keymaps have no binding for the current key sequence but
11489 `local-function-key-map' binds a suffix of the sequence to a vector or
11490 string, `read-key-sequence' replaces the matching suffix with its
11491 binding, and continues with the new sequence.
11493 If the binding is a function, it is called with one argument (the prompt)
11494 and its return value (a key sequence) is used.
11496 The events that come from bindings in `local-function-key-map' are not
11497 themselves looked up in `local-function-key-map'.
11499 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11500 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11501 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11502 typing `ESC O P x' would return [f1 x].
11504 `local-function-key-map' has a separate binding for each terminal
11505 device. See Info node `(elisp)Multiple Terminals'. If you need to
11506 define a binding on all terminals, change `function-key-map'
11507 instead. Initially, `local-function-key-map' is an empty keymap that
11508 has `function-key-map' as its parent on all terminal devices. */);
11510 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11511 doc
: /* Keymap that decodes input escape sequences.
11512 This is used mainly for mapping ASCII function key sequences into
11513 real Emacs function key events (symbols).
11515 The `read-key-sequence' function replaces any subsequence bound by
11516 `input-decode-map' with its binding. Contrary to `function-key-map',
11517 this map applies its rebinding regardless of the presence of an ordinary
11518 binding. So it is more like `key-translation-map' except that it applies
11519 before `function-key-map' rather than after.
11521 If the binding is a function, it is called with one argument (the prompt)
11522 and its return value (a key sequence) is used.
11524 The events that come from bindings in `input-decode-map' are not
11525 themselves looked up in `input-decode-map'. */);
11527 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11528 doc
: /* The parent keymap of all `local-function-key-map' instances.
11529 Function key definitions that apply to all terminal devices should go
11530 here. If a mapping is defined in both the current
11531 `local-function-key-map' binding and this variable, then the local
11532 definition will take precedence. */);
11533 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11535 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11536 doc
: /* Keymap of key translations that can override keymaps.
11537 This keymap works like `input-decode-map', but comes after `function-key-map'.
11538 Another difference is that it is global rather than terminal-local. */);
11539 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11541 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11542 doc
: /* List of deferred actions to be performed at a later time.
11543 The precise format isn't relevant here; we just check whether it is nil. */);
11544 Vdeferred_action_list
= Qnil
;
11546 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11547 doc
: /* Function to call to handle deferred actions, after each command.
11548 This function is called with no arguments after each command
11549 whenever `deferred-action-list' is non-nil. */);
11550 Vdeferred_action_function
= Qnil
;
11552 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11553 doc
: /* List of warnings to be displayed after this command.
11554 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11555 as per the args of `display-warning' (which see).
11556 If this variable is non-nil, `delayed-warnings-hook' will be run
11557 immediately after running `post-command-hook'. */);
11558 Vdelayed_warnings_list
= Qnil
;
11560 DEFVAR_LISP ("timer-list", Vtimer_list
,
11561 doc
: /* List of active absolute time timers in order of increasing time. */);
11562 Vtimer_list
= Qnil
;
11564 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11565 doc
: /* List of active idle-time timers in order of increasing time. */);
11566 Vtimer_idle_list
= Qnil
;
11568 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11569 doc
: /* If non-nil, the function that implements the current input method.
11570 It's called with one argument, a printing character that was just read.
11571 \(That means a character with code 040...0176.)
11572 Typically this function uses `read-event' to read additional events.
11573 When it does so, it should first bind `input-method-function' to nil
11574 so it will not be called recursively.
11576 The function should return a list of zero or more events
11577 to be used as input. If it wants to put back some events
11578 to be reconsidered, separately, by the input method,
11579 it can add them to the beginning of `unread-command-events'.
11581 The input method function can find in `input-method-previous-message'
11582 the previous echo area message.
11584 The input method function should refer to the variables
11585 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11586 for guidance on what to do. */);
11587 Vinput_method_function
= Qnil
;
11589 DEFVAR_LISP ("input-method-previous-message",
11590 Vinput_method_previous_message
,
11591 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11592 This variable exists because `read-event' clears the echo area
11593 before running the input method. It is nil if there was no message. */);
11594 Vinput_method_previous_message
= Qnil
;
11596 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11597 doc
: /* If non-nil, the function that implements the display of help.
11598 It's called with one argument, the help string to display. */);
11599 Vshow_help_function
= Qnil
;
11601 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11602 doc
: /* If non-nil, suppress point adjustment after executing a command.
11604 After a command is executed, if point is moved into a region that has
11605 special properties (e.g. composition, display), we adjust point to
11606 the boundary of the region. But, when a command sets this variable to
11607 non-nil, we suppress the point adjustment.
11609 This variable is set to nil before reading a command, and is checked
11610 just after executing the command. */);
11611 Vdisable_point_adjustment
= Qnil
;
11613 DEFVAR_LISP ("global-disable-point-adjustment",
11614 Vglobal_disable_point_adjustment
,
11615 doc
: /* If non-nil, always suppress point adjustment.
11617 The default value is nil, in which case, point adjustment are
11618 suppressed only after special commands that set
11619 `disable-point-adjustment' (which see) to non-nil. */);
11620 Vglobal_disable_point_adjustment
= Qnil
;
11622 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11623 doc
: /* How long to display an echo-area message when the minibuffer is active.
11624 If the value is not a number, such messages don't time out. */);
11625 Vminibuffer_message_timeout
= make_number (2);
11627 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11628 doc
: /* If non-nil, any keyboard input throws to this symbol.
11629 The value of that variable is passed to `quit-flag' and later causes a
11630 peculiar kind of quitting. */);
11631 Vthrow_on_input
= Qnil
;
11633 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11634 doc
: /* Function to output error messages.
11635 Called with three arguments:
11636 - the error data, a list of the form (SIGNALED-CONDITION . SIGNAL-DATA)
11637 such as what `condition-case' would bind its variable to,
11638 - the context (a string which normally goes at the start of the message),
11639 - the Lisp function within which the error was signaled. */);
11640 Vcommand_error_function
= intern ("command-error-default-function");
11642 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11643 Venable_disabled_menus_and_buttons
,
11644 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11646 Help functions bind this to allow help on disabled menu items
11647 and tool-bar buttons. */);
11648 Venable_disabled_menus_and_buttons
= Qnil
;
11650 DEFVAR_LISP ("select-active-regions",
11651 Vselect_active_regions
,
11652 doc
: /* If non-nil, an active region automatically sets the primary selection.
11653 If the value is `only', only temporarily active regions (usually made
11654 by mouse-dragging or shift-selection) set the window selection.
11656 This takes effect only when Transient Mark mode is enabled. */);
11657 Vselect_active_regions
= Qt
;
11659 DEFVAR_LISP ("saved-region-selection",
11660 Vsaved_region_selection
,
11661 doc
: /* Contents of active region prior to buffer modification.
11662 If `select-active-regions' is non-nil, Emacs sets this to the
11663 text in the region before modifying the buffer. The next call to
11664 the function `deactivate-mark' uses this to set the window selection. */);
11665 Vsaved_region_selection
= Qnil
;
11667 DEFVAR_LISP ("selection-inhibit-update-commands",
11668 Vselection_inhibit_update_commands
,
11669 doc
: /* List of commands which should not update the selection.
11670 Normally, if `select-active-regions' is non-nil and the mark remains
11671 active after a command (i.e. the mark was not deactivated), the Emacs
11672 command loop sets the selection to the text in the region. However,
11673 if the command is in this list, the selection is not updated. */);
11674 Vselection_inhibit_update_commands
11675 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11677 DEFVAR_LISP ("debug-on-event",
11679 doc
: /* Enter debugger on this event. When Emacs
11680 receives the special event specified by this variable, it will try to
11681 break into the debugger as soon as possible instead of processing the
11682 event normally through `special-event-map'.
11684 Currently, the only supported values for this
11685 variable are `sigusr1' and `sigusr2'. */);
11686 Vdebug_on_event
= intern_c_string ("sigusr2");
11688 /* Create the initial keyboard. Qt means 'unset'. */
11689 initial_kboard
= allocate_kboard (Qt
);
11693 keys_of_keyboard (void)
11695 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11696 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11697 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11698 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11699 initial_define_key (meta_map
, 'x', "execute-extended-command");
11701 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11702 "handle-delete-frame");
11703 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11704 "ns-put-working-text");
11705 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11706 "ns-unput-working-text");
11707 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11708 current-prefix-arg, as is done in `handle-switch-frame'.
11709 But `handle-switch-frame is not run from the special-map.
11710 Commands from that map are run in a special way that automatically
11711 preserves the prefix-arg. Restoring the prefix arg here is not just
11712 redundant but harmful:
11714 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11715 - after the first prompt, the exit-minibuffer-hook is run which may
11716 iconify a frame and thus push a `iconify-frame' event.
11717 - after running exit-minibuffer-hook, current-prefix-arg is
11718 restored to the non-nil value it had before the prompt.
11719 - we enter the second prompt.
11720 current-prefix-arg is non-nil, prefix-arg is nil.
11721 - before running the first real event, we run the special iconify-frame
11722 event, but we pass the `special' arg to execute-command so
11723 current-prefix-arg and prefix-arg are left untouched.
11724 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11725 - the next key event will have a spuriously non-nil current-prefix-arg. */
11726 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11728 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11730 /* Handling it at such a low-level causes read_key_sequence to get
11731 * confused because it doesn't realize that the current_buffer was
11732 * changed by read_char.
11734 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11735 * "handle-select-window"); */
11736 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11737 "handle-save-session");
11740 /* Define a special event which is raised for dbus callback
11742 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11743 "dbus-handle-event");
11746 #ifdef USE_FILE_NOTIFY
11747 /* Define a special event which is raised for notification callback
11749 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11750 "file-notify-handle-event");
11751 #endif /* USE_FILE_NOTIFY */
11753 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11755 #if defined (WINDOWSNT)
11756 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11759 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11760 "handle-focus-in");
11761 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11762 "handle-focus-out");
11765 /* Mark the pointers in the kboard objects.
11766 Called by Fgarbage_collect. */
11768 mark_kboards (void)
11772 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11774 if (kb
->kbd_macro_buffer
)
11775 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11777 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11778 mark_object (KVAR (kb
, Vlast_command
));
11779 mark_object (KVAR (kb
, Vreal_last_command
));
11780 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11781 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11782 mark_object (KVAR (kb
, Vprefix_arg
));
11783 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11784 mark_object (KVAR (kb
, kbd_queue
));
11785 mark_object (KVAR (kb
, defining_kbd_macro
));
11786 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11787 mark_object (KVAR (kb
, Vsystem_key_alist
));
11788 mark_object (KVAR (kb
, system_key_syms
));
11789 mark_object (KVAR (kb
, Vwindow_system
));
11790 mark_object (KVAR (kb
, Vinput_decode_map
));
11791 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11792 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11793 mark_object (KVAR (kb
, echo_string
));
11796 struct input_event
*event
;
11797 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11799 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11800 event
= kbd_buffer
;
11801 /* These two special event types has no Lisp_Objects to mark. */
11802 if (event
->kind
!= SELECTION_REQUEST_EVENT
11803 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11805 mark_object (event
->x
);
11806 mark_object (event
->y
);
11807 mark_object (event
->frame_or_window
);
11808 mark_object (event
->arg
);