1 /* Keyboard and mouse input; editor command loop.
3 Copyright (C) 1985-1989, 1993-1997, 1999-2013 Free Software Foundation,
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
11 (at your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
23 #define BLOCKINPUT_INLINE EXTERN_INLINE
24 #define KEYBOARD_INLINE EXTERN_INLINE
32 #include "termhooks.h"
37 #include "character.h"
40 #include "dispextern.h"
42 #include "intervals.h"
44 #include "blockinput.h"
58 #include <sys/ioctl.h>
59 #endif /* not MSDOS */
61 #if defined USABLE_FIONREAD && defined USG5_4
62 # include <sys/filio.h>
65 #include "syssignal.h"
67 #include <sys/types.h>
71 #ifdef HAVE_WINDOW_SYSTEM
73 #endif /* HAVE_WINDOW_SYSTEM */
75 /* Variables for blockinput.h: */
77 /* Positive if interrupt input is blocked right now. */
78 volatile int interrupt_input_blocked
;
80 /* True means an input interrupt or alarm signal has arrived.
81 The QUIT macro checks this. */
82 volatile bool pending_signals
;
84 #define KBD_BUFFER_SIZE 4096
86 KBOARD
*initial_kboard
;
87 KBOARD
*current_kboard
;
90 /* True in the single-kboard state, false in the any-kboard state. */
91 static bool single_kboard
;
93 /* Non-nil disable property on a command means
94 do not execute it; call disabled-command-function's value instead. */
95 Lisp_Object Qdisabled
;
96 static Lisp_Object Qdisabled_command_function
;
98 #define NUM_RECENT_KEYS (300)
100 /* Index for storing next element into recent_keys. */
101 static int recent_keys_index
;
103 /* Total number of elements stored into recent_keys. */
104 static int total_keys
;
106 /* This vector holds the last NUM_RECENT_KEYS keystrokes. */
107 static Lisp_Object recent_keys
;
109 /* Vector holding the key sequence that invoked the current command.
110 It is reused for each command, and it may be longer than the current
111 sequence; this_command_key_count indicates how many elements
112 actually mean something.
113 It's easier to staticpro a single Lisp_Object than an array. */
114 Lisp_Object this_command_keys
;
115 ptrdiff_t this_command_key_count
;
117 /* True after calling Freset_this_command_lengths.
118 Usually it is false. */
119 static bool this_command_key_count_reset
;
121 /* This vector is used as a buffer to record the events that were actually read
122 by read_key_sequence. */
123 static Lisp_Object raw_keybuf
;
124 static int raw_keybuf_count
;
126 #define GROW_RAW_KEYBUF \
127 if (raw_keybuf_count == ASIZE (raw_keybuf)) \
128 raw_keybuf = larger_vector (raw_keybuf, 1, -1)
130 /* Number of elements of this_command_keys
131 that precede this key sequence. */
132 static ptrdiff_t this_single_command_key_start
;
134 /* Record values of this_command_key_count and echo_length ()
135 before this command was read. */
136 static ptrdiff_t before_command_key_count
;
137 static ptrdiff_t before_command_echo_length
;
139 /* For longjmp to where kbd input is being done. */
141 static sys_jmp_buf getcjmp
;
143 /* True while doing kbd input. */
144 bool waiting_for_input
;
146 /* True while displaying for echoing. Delays C-g throwing. */
150 /* Non-null means we can start echoing at the next input pause even
151 though there is something in the echo area. */
153 static struct kboard
*ok_to_echo_at_next_pause
;
155 /* The kboard last echoing, or null for none. Reset to 0 in
156 cancel_echoing. If non-null, and a current echo area message
157 exists, and echo_message_buffer is eq to the current message
158 buffer, we know that the message comes from echo_kboard. */
160 struct kboard
*echo_kboard
;
162 /* The buffer used for echoing. Set in echo_now, reset in
165 Lisp_Object echo_message_buffer
;
167 /* True means C-g should cause immediate error-signal. */
170 /* Character that causes a quit. Normally C-g.
172 If we are running on an ordinary terminal, this must be an ordinary
173 ASCII char, since we want to make it our interrupt character.
175 If we are not running on an ordinary terminal, it still needs to be
176 an ordinary ASCII char. This character needs to be recognized in
177 the input interrupt handler. At this point, the keystroke is
178 represented as a struct input_event, while the desired quit
179 character is specified as a lispy event. The mapping from struct
180 input_events to lispy events cannot run in an interrupt handler,
181 and the reverse mapping is difficult for anything but ASCII
184 FOR THESE ELABORATE AND UNSATISFYING REASONS, quit_char must be an
188 /* Current depth in recursive edits. */
189 EMACS_INT command_loop_level
;
191 /* If not Qnil, this is a switch-frame event which we decided to put
192 off until the end of a key sequence. This should be read as the
193 next command input, after any unread_command_events.
195 read_key_sequence uses this to delay switch-frame events until the
196 end of the key sequence; Fread_char uses it to put off switch-frame
197 events until a non-ASCII event is acceptable as input. */
198 Lisp_Object unread_switch_frame
;
200 /* Last size recorded for a current buffer which is not a minibuffer. */
201 static ptrdiff_t last_non_minibuf_size
;
203 /* Total number of times read_char has returned, modulo UINTMAX_MAX + 1. */
204 uintmax_t num_input_events
;
206 /* Value of num_nonmacro_input_events as of last auto save. */
208 static EMACS_INT last_auto_save
;
210 /* The value of point when the last command was started. */
211 static ptrdiff_t last_point_position
;
213 /* The frame in which the last input event occurred, or Qmacro if the
214 last event came from a macro. We use this to determine when to
215 generate switch-frame events. This may be cleared by functions
216 like Fselect_frame, to make sure that a switch-frame event is
217 generated by the next character.
219 FIXME: This is modified by a signal handler so it should be volatile.
220 It's exported to Lisp, though, so it can't simply be marked
222 Lisp_Object internal_last_event_frame
;
224 /* The timestamp of the last input event we received from the X server.
225 X Windows wants this for selection ownership. */
226 Time last_event_timestamp
;
228 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
229 static Lisp_Object Qhandle_select_window
;
230 Lisp_Object QPRIMARY
;
232 static Lisp_Object Qself_insert_command
;
233 static Lisp_Object Qforward_char
;
234 static Lisp_Object Qbackward_char
;
235 Lisp_Object Qundefined
;
236 static Lisp_Object Qtimer_event_handler
;
238 /* read_key_sequence stores here the command definition of the
239 key sequence that it reads. */
240 static Lisp_Object read_key_sequence_cmd
;
241 static Lisp_Object read_key_sequence_remapped
;
243 static Lisp_Object Qinput_method_function
;
245 static Lisp_Object Qdeactivate_mark
;
247 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
249 static Lisp_Object Qecho_area_clear_hook
;
251 /* Hooks to run before and after each command. */
252 static Lisp_Object Qpre_command_hook
;
253 static Lisp_Object Qpost_command_hook
;
255 static Lisp_Object Qdeferred_action_function
;
257 static Lisp_Object Qdelayed_warnings_hook
;
259 static Lisp_Object Qinput_method_exit_on_first_char
;
260 static Lisp_Object Qinput_method_use_echo_area
;
262 static Lisp_Object Qhelp_form_show
;
264 /* File in which we write all commands we read. */
265 static FILE *dribble
;
267 /* Nonzero if input is available. */
270 /* Circular buffer for pre-read keyboard input. */
272 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
274 /* Pointer to next available character in kbd_buffer.
275 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
276 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
277 next available char is in kbd_buffer[0]. */
278 static struct input_event
*kbd_fetch_ptr
;
280 /* Pointer to next place to store character in kbd_buffer. This
281 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
282 character should go in kbd_buffer[0]. */
283 static struct input_event
* volatile kbd_store_ptr
;
285 /* The above pair of variables forms a "queue empty" flag. When we
286 enqueue a non-hook event, we increment kbd_store_ptr. When we
287 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
288 there is input available if the two pointers are not equal.
290 Why not just have a flag set and cleared by the enqueuing and
291 dequeuing functions? Such a flag could be screwed up by interrupts
292 at inopportune times. */
294 /* Symbols to head events. */
295 static Lisp_Object Qmouse_movement
;
296 static Lisp_Object Qscroll_bar_movement
;
297 Lisp_Object Qswitch_frame
;
298 static Lisp_Object Qfocus_in
, Qfocus_out
;
299 static Lisp_Object Qdelete_frame
;
300 static Lisp_Object Qiconify_frame
;
301 static Lisp_Object Qmake_frame_visible
;
302 static Lisp_Object Qselect_window
;
303 Lisp_Object Qhelp_echo
;
305 static Lisp_Object Qmouse_fixup_help_message
;
307 /* Symbols to denote kinds of events. */
308 static Lisp_Object Qfunction_key
;
309 Lisp_Object Qmouse_click
;
311 Lisp_Object Qlanguage_change
;
313 static Lisp_Object Qdrag_n_drop
;
314 static Lisp_Object Qsave_session
;
316 static Lisp_Object Qdbus_event
;
319 Lisp_Object Qxwidget_event
;
321 #ifdef USE_FILE_NOTIFY
322 static Lisp_Object Qfile_notify
;
323 #endif /* USE_FILE_NOTIFY */
324 static Lisp_Object Qconfig_changed_event
;
326 /* Lisp_Object Qmouse_movement; - also an event header */
328 /* Properties of event headers. */
329 Lisp_Object Qevent_kind
;
330 static Lisp_Object Qevent_symbol_elements
;
332 /* Menu and tool bar item parts. */
333 static Lisp_Object Qmenu_enable
;
334 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
335 Lisp_Object QCfilter
;
337 /* Non-nil disable property on a command means
338 do not execute it; call disabled-command-function's value instead. */
339 Lisp_Object QCtoggle
, QCradio
;
340 static Lisp_Object QCbutton
, QClabel
;
342 static Lisp_Object QCvert_only
;
344 /* An event header symbol HEAD may have a property named
345 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
346 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
347 mask of modifiers applied to it. If present, this is used to help
348 speed up parse_modifiers. */
349 Lisp_Object Qevent_symbol_element_mask
;
351 /* An unmodified event header BASE may have a property named
352 Qmodifier_cache, which is an alist mapping modifier masks onto
353 modified versions of BASE. If present, this helps speed up
355 static Lisp_Object Qmodifier_cache
;
357 /* Symbols to use for parts of windows. */
358 Lisp_Object Qmode_line
;
359 Lisp_Object Qvertical_line
;
360 static Lisp_Object Qvertical_scroll_bar
;
361 Lisp_Object Qmenu_bar
;
363 static void recursive_edit_unwind (Lisp_Object buffer
);
364 static Lisp_Object
command_loop (void);
365 static Lisp_Object Qcommand_execute
;
366 EMACS_TIME
timer_check (void);
368 static void echo_now (void);
369 static ptrdiff_t echo_length (void);
371 static Lisp_Object Qpolling_period
;
373 /* Incremented whenever a timer is run. */
376 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
378 EMACS_TIME
*input_available_clear_time
;
380 /* True means use SIGIO interrupts; false means use CBREAK mode.
381 Default is true if INTERRUPT_INPUT is defined. */
382 bool interrupt_input
;
384 /* Nonzero while interrupts are temporarily deferred during redisplay. */
385 bool interrupts_deferred
;
387 /* If we support a window system, turn on the code to poll periodically
388 to detect C-g. It isn't actually used when doing interrupt input. */
389 #ifdef HAVE_WINDOW_SYSTEM
390 #define POLL_FOR_INPUT
393 /* The time when Emacs started being idle. */
395 static EMACS_TIME timer_idleness_start_time
;
397 /* After Emacs stops being idle, this saves the last value
398 of timer_idleness_start_time from when it was idle. */
400 static EMACS_TIME timer_last_idleness_start_time
;
403 /* Global variable declarations. */
405 /* Flags for readable_events. */
406 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
407 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
408 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
410 /* Function for init_keyboard to call with no args (if nonzero). */
411 static void (*keyboard_init_hook
) (void);
413 static bool get_input_pending (int);
414 static bool readable_events (int);
415 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
416 Lisp_Object
, bool *);
417 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
418 static Lisp_Object
make_lispy_event (struct input_event
*);
419 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
420 enum scroll_bar_part
,
421 Lisp_Object
, Lisp_Object
,
423 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
424 Lisp_Object
, const char *const *,
425 Lisp_Object
*, ptrdiff_t);
426 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
427 static Lisp_Object
make_lispy_focus_in (Lisp_Object
);
428 static Lisp_Object
make_lispy_focus_out (Lisp_Object
);
429 static bool help_char_p (Lisp_Object
);
430 static void save_getcjmp (sys_jmp_buf
);
431 static void restore_getcjmp (sys_jmp_buf
);
432 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
433 static void clear_event (struct input_event
*);
434 static void restore_kboard_configuration (int);
436 static void deliver_input_available_signal (int signo
);
438 static void handle_interrupt (bool);
439 static _Noreturn
void quit_throw_to_read_char (bool);
440 static void process_special_events (void);
441 static void timer_start_idle (void);
442 static void timer_stop_idle (void);
443 static void timer_resume_idle (void);
444 static void deliver_user_signal (int);
445 static char *find_user_signal_name (int);
446 static void store_user_signal_events (void);
448 /* These setters are used only in this file, so they can be private. */
450 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
452 kb
->INTERNAL_FIELD (echo_string
) = val
;
455 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
457 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
460 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
462 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
465 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
467 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
470 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
472 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
475 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
477 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
480 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
482 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
485 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
487 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
490 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
492 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
496 /* Add C to the echo string, without echoing it immediately. C can be
497 a character, which is pretty-printed, or a symbol, whose name is
501 echo_add_key (Lisp_Object c
)
503 int size
= KEY_DESCRIPTION_SIZE
+ 100;
504 char *buffer
= alloca (size
);
506 Lisp_Object echo_string
;
508 echo_string
= KVAR (current_kboard
, echo_string
);
510 /* If someone has passed us a composite event, use its head symbol. */
514 ptr
= push_key_description (XINT (c
), ptr
);
515 else if (SYMBOLP (c
))
517 Lisp_Object name
= SYMBOL_NAME (c
);
518 int nbytes
= SBYTES (name
);
520 if (size
- (ptr
- buffer
) < nbytes
)
522 int offset
= ptr
- buffer
;
523 size
= max (2 * size
, size
+ nbytes
);
524 buffer
= alloca (size
);
525 ptr
= buffer
+ offset
;
528 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
529 STRING_MULTIBYTE (name
), 1);
532 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
535 const char *text
= " (Type ? for further options)";
536 int len
= strlen (text
);
538 if (size
- (ptr
- buffer
) < len
)
540 int offset
= ptr
- buffer
;
542 buffer
= alloca (size
);
543 ptr
= buffer
+ offset
;
546 memcpy (ptr
, text
, len
);
550 /* Replace a dash from echo_dash with a space, otherwise add a space
551 at the end as a separator between keys. */
552 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
554 Lisp_Object last_char
, prev_char
, idx
;
556 idx
= make_number (SCHARS (echo_string
) - 2);
557 prev_char
= Faref (echo_string
, idx
);
559 idx
= make_number (SCHARS (echo_string
) - 1);
560 last_char
= Faref (echo_string
, idx
);
562 /* We test PREV_CHAR to make sure this isn't the echoing of a
564 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
565 Faset (echo_string
, idx
, make_number (' '));
567 echo_string
= concat2 (echo_string
, build_string (" "));
569 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
570 echo_string
= concat2 (echo_string
, build_string (" "));
574 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
577 /* Add C to the echo string, if echoing is going on. C can be a
578 character or a symbol. */
581 echo_char (Lisp_Object c
)
583 if (current_kboard
->immediate_echo
)
590 /* Temporarily add a dash to the end of the echo string if it's not
591 empty, so that it serves as a mini-prompt for the very next
597 /* Do nothing if not echoing at all. */
598 if (NILP (KVAR (current_kboard
, echo_string
)))
601 if (this_command_key_count
== 0)
604 if (!current_kboard
->immediate_echo
605 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
608 /* Do nothing if we just printed a prompt. */
609 if (current_kboard
->echo_after_prompt
610 == SCHARS (KVAR (current_kboard
, echo_string
)))
613 /* Do nothing if we have already put a dash at the end. */
614 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
616 Lisp_Object last_char
, prev_char
, idx
;
618 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
619 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
621 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
622 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
624 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
628 /* Put a dash at the end of the buffer temporarily,
629 but make it go away when the next character is added. */
632 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
636 /* Display the current echo string, and begin echoing if not already
642 if (!current_kboard
->immediate_echo
)
645 current_kboard
->immediate_echo
= 1;
647 for (i
= 0; i
< this_command_key_count
; i
++)
651 /* Set before_command_echo_length to the value that would
652 have been saved before the start of this subcommand in
653 command_loop_1, if we had already been echoing then. */
654 if (i
== this_single_command_key_start
)
655 before_command_echo_length
= echo_length ();
657 c
= AREF (this_command_keys
, i
);
658 if (! (EVENT_HAS_PARAMETERS (c
)
659 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
663 /* Set before_command_echo_length to the value that would
664 have been saved before the start of this subcommand in
665 command_loop_1, if we had already been echoing then. */
666 if (this_command_key_count
== this_single_command_key_start
)
667 before_command_echo_length
= echo_length ();
669 /* Put a dash at the end to invite the user to type more. */
674 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
675 message3_nolog (KVAR (current_kboard
, echo_string
));
678 /* Record in what buffer we echoed, and from which kboard. */
679 echo_message_buffer
= echo_area_buffer
[0];
680 echo_kboard
= current_kboard
;
682 if (waiting_for_input
&& !NILP (Vquit_flag
))
683 quit_throw_to_read_char (0);
686 /* Turn off echoing, for the start of a new command. */
689 cancel_echoing (void)
691 current_kboard
->immediate_echo
= 0;
692 current_kboard
->echo_after_prompt
= -1;
693 kset_echo_string (current_kboard
, Qnil
);
694 ok_to_echo_at_next_pause
= NULL
;
696 echo_message_buffer
= Qnil
;
699 /* Return the length of the current echo string. */
704 return (STRINGP (KVAR (current_kboard
, echo_string
))
705 ? SCHARS (KVAR (current_kboard
, echo_string
))
709 /* Truncate the current echo message to its first LEN chars.
710 This and echo_char get used by read_key_sequence when the user
711 switches frames while entering a key sequence. */
714 echo_truncate (ptrdiff_t nchars
)
716 if (STRINGP (KVAR (current_kboard
, echo_string
)))
717 kset_echo_string (current_kboard
,
718 Fsubstring (KVAR (current_kboard
, echo_string
),
719 make_number (0), make_number (nchars
)));
720 truncate_echo_area (nchars
);
724 /* Functions for manipulating this_command_keys. */
726 add_command_key (Lisp_Object key
)
728 #if 0 /* Not needed after we made Freset_this_command_lengths
729 do the job immediately. */
730 /* If reset-this-command-length was called recently, obey it now.
731 See the doc string of that function for an explanation of why. */
732 if (before_command_restore_flag
)
734 this_command_key_count
= before_command_key_count_1
;
735 if (this_command_key_count
< this_single_command_key_start
)
736 this_single_command_key_start
= this_command_key_count
;
737 echo_truncate (before_command_echo_length_1
);
738 before_command_restore_flag
= 0;
742 if (this_command_key_count
>= ASIZE (this_command_keys
))
743 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
745 ASET (this_command_keys
, this_command_key_count
, key
);
746 ++this_command_key_count
;
751 recursive_edit_1 (void)
753 ptrdiff_t count
= SPECPDL_INDEX ();
756 if (command_loop_level
> 0)
758 specbind (Qstandard_output
, Qt
);
759 specbind (Qstandard_input
, Qt
);
762 #ifdef HAVE_WINDOW_SYSTEM
763 /* The command loop has started an hourglass timer, so we have to
764 cancel it here, otherwise it will fire because the recursive edit
765 can take some time. Do not check for display_hourglass_p here,
766 because it could already be nil. */
770 /* This function may have been called from a debugger called from
771 within redisplay, for instance by Edebugging a function called
772 from fontification-functions. We want to allow redisplay in
773 the debugging session.
775 The recursive edit is left with a `(throw exit ...)'. The `exit'
776 tag is not caught anywhere in redisplay, i.e. when we leave the
777 recursive edit, the original redisplay leading to the recursive
778 edit will be unwound. The outcome should therefore be safe. */
779 specbind (Qinhibit_redisplay
, Qnil
);
782 val
= command_loop ();
784 Fsignal (Qquit
, Qnil
);
785 /* Handle throw from read_minibuf when using minibuffer
786 while it's active but we're in another window. */
788 xsignal1 (Qerror
, val
);
790 return unbind_to (count
, Qnil
);
793 /* When an auto-save happens, record the "time", and don't do again soon. */
796 record_auto_save (void)
798 last_auto_save
= num_nonmacro_input_events
;
801 /* Make an auto save happen as soon as possible at command level. */
805 force_auto_save_soon (void)
807 last_auto_save
= - auto_save_interval
- 1;
809 record_asynch_buffer_change ();
813 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
814 doc
: /* Invoke the editor command loop recursively.
815 To get out of the recursive edit, a command can do `(throw 'exit nil)';
816 that tells this function to return.
817 Alternatively, `(throw 'exit t)' makes this function signal an error.
818 This function is called by the editor initialization to begin editing. */)
821 ptrdiff_t count
= SPECPDL_INDEX ();
824 /* If we enter while input is blocked, don't lock up here.
825 This may happen through the debugger during redisplay. */
826 if (input_blocked_p ())
829 command_loop_level
++;
830 update_mode_lines
= 1;
832 if (command_loop_level
833 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->contents
))
834 buffer
= Fcurrent_buffer ();
838 /* If we leave recursive_edit_1 below with a `throw' for instance,
839 like it is done in the splash screen display, we have to
840 make sure that we restore single_kboard as command_loop_1
841 would have done if it were left normally. */
842 if (command_loop_level
> 0)
843 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
844 record_unwind_protect (recursive_edit_unwind
, buffer
);
847 return unbind_to (count
, Qnil
);
851 recursive_edit_unwind (Lisp_Object buffer
)
853 if (BUFFERP (buffer
))
854 Fset_buffer (buffer
);
856 command_loop_level
--;
857 update_mode_lines
= 1;
861 #if 0 /* These two functions are now replaced with
862 temporarily_switch_to_single_kboard. */
866 #if 0 /* Theory: if there's anything in Vunread_command_events,
867 it will right away be read by read_key_sequence,
868 and then if we do switch KBOARDS, it will go into the side
869 queue then. So we don't need to do anything special here -- rms. */
870 if (CONSP (Vunread_command_events
))
872 current_kboard
->kbd_queue
873 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
874 current_kboard
->kbd_queue_has_data
= 1;
876 Vunread_command_events
= Qnil
;
881 /* Switch to the single-kboard state, making current_kboard
882 the only KBOARD from which further input is accepted. */
885 single_kboard_state ()
891 /* If we're in single_kboard state for kboard KBOARD,
895 not_single_kboard_state (KBOARD
*kboard
)
897 if (kboard
== current_kboard
)
901 /* Maintain a stack of kboards, so other parts of Emacs
902 can switch temporarily to the kboard of a given frame
903 and then revert to the previous status. */
908 struct kboard_stack
*next
;
911 static struct kboard_stack
*kboard_stack
;
914 push_kboard (struct kboard
*k
)
916 struct kboard_stack
*p
= xmalloc (sizeof *p
);
918 p
->next
= kboard_stack
;
919 p
->kboard
= current_kboard
;
929 struct kboard_stack
*p
= kboard_stack
;
931 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
933 if (t
->kboard
== p
->kboard
)
935 current_kboard
= p
->kboard
;
942 /* The terminal we remembered has been deleted. */
943 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
946 kboard_stack
= p
->next
;
950 /* Switch to single_kboard mode, making current_kboard the only KBOARD
951 from which further input is accepted. If F is non-nil, set its
952 KBOARD as the current keyboard.
954 This function uses record_unwind_protect_int to return to the previous
957 If Emacs is already in single_kboard mode, and F's keyboard is
958 locked, then this function will throw an error. */
961 temporarily_switch_to_single_kboard (struct frame
*f
)
963 bool was_locked
= single_kboard
;
966 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
967 /* We can not switch keyboards while in single_kboard mode.
968 In rare cases, Lisp code may call `recursive-edit' (or
969 `read-minibuffer' or `y-or-n-p') after it switched to a
970 locked frame. For example, this is likely to happen
971 when server.el connects to a new terminal while Emacs is in
972 single_kboard mode. It is best to throw an error instead
973 of presenting the user with a frozen screen. */
974 error ("Terminal %d is locked, cannot read from it",
975 FRAME_TERMINAL (f
)->id
);
977 /* This call is unnecessary, but helps
978 `restore_kboard_configuration' discover if somebody changed
979 `current_kboard' behind our back. */
980 push_kboard (current_kboard
);
983 current_kboard
= FRAME_KBOARD (f
);
985 record_unwind_protect_int (restore_kboard_configuration
, was_locked
);
988 #if 0 /* This function is not needed anymore. */
990 record_single_kboard_state ()
993 push_kboard (current_kboard
);
994 record_unwind_protect_int (restore_kboard_configuration
, single_kboard
);
999 restore_kboard_configuration (int was_locked
)
1001 single_kboard
= was_locked
;
1004 struct kboard
*prev
= current_kboard
;
1006 /* The pop should not change the kboard. */
1007 if (single_kboard
&& current_kboard
!= prev
)
1013 /* Handle errors that are not handled at inner levels
1014 by printing an error message and returning to the editor command loop. */
1017 cmd_error (Lisp_Object data
)
1019 Lisp_Object old_level
, old_length
;
1020 char macroerror
[sizeof "After..kbd macro iterations: "
1021 + INT_STRLEN_BOUND (EMACS_INT
)];
1023 #ifdef HAVE_WINDOW_SYSTEM
1024 if (display_hourglass_p
)
1025 cancel_hourglass ();
1028 if (!NILP (executing_kbd_macro
))
1030 if (executing_kbd_macro_iterations
== 1)
1031 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1033 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1034 executing_kbd_macro_iterations
);
1039 Vstandard_output
= Qt
;
1040 Vstandard_input
= Qt
;
1041 Vexecuting_kbd_macro
= Qnil
;
1042 executing_kbd_macro
= Qnil
;
1043 kset_prefix_arg (current_kboard
, Qnil
);
1044 kset_last_prefix_arg (current_kboard
, Qnil
);
1047 /* Avoid unquittable loop if data contains a circular list. */
1048 old_level
= Vprint_level
;
1049 old_length
= Vprint_length
;
1050 XSETFASTINT (Vprint_level
, 10);
1051 XSETFASTINT (Vprint_length
, 10);
1052 cmd_error_internal (data
, macroerror
);
1053 Vprint_level
= old_level
;
1054 Vprint_length
= old_length
;
1057 Vinhibit_quit
= Qnil
;
1059 return make_number (0);
1062 /* Take actions on handling an error. DATA is the data that describes
1065 CONTEXT is a C-string containing ASCII characters only which
1066 describes the context in which the error happened. If we need to
1067 generalize CONTEXT to allow multibyte characters, make it a Lisp
1071 cmd_error_internal (Lisp_Object data
, const char *context
)
1073 struct frame
*sf
= SELECTED_FRAME ();
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
);
1088 /* If the window system or terminal frame hasn't been initialized
1089 yet, or we're not interactive, write the message to stderr and exit. */
1090 else if (!sf
->glyphs_initialized_p
1091 /* The initial frame is a special non-displaying frame. It
1092 will be current in daemon mode when there are no frames
1093 to display, and in non-daemon mode before the real frame
1094 has finished initializing. If an error is thrown in the
1095 latter case while creating the frame, then the frame
1096 will never be displayed, so the safest thing to do is
1097 write to stderr and quit. In daemon mode, there are
1098 many other potential errors that do not prevent frames
1099 from being created, so continuing as normal is better in
1101 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1104 print_error_message (data
, Qexternal_debugging_output
,
1105 context
, Vsignaling_function
);
1106 Fterpri (Qexternal_debugging_output
);
1107 Fkill_emacs (make_number (-1));
1111 clear_message (1, 0);
1113 message_log_maybe_newline ();
1116 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1119 Vsignaling_function
= Qnil
;
1122 static Lisp_Object
command_loop_2 (Lisp_Object
);
1123 static Lisp_Object
top_level_1 (Lisp_Object
);
1125 /* Entry to editor-command-loop.
1126 This level has the catches for exiting/returning to editor command loop.
1127 It returns nil to exit recursive edit, t to abort it. */
1132 if (command_loop_level
> 0 || minibuf_level
> 0)
1135 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1136 executing_kbd_macro
= Qnil
;
1142 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1143 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1144 executing_kbd_macro
= Qnil
;
1146 /* End of file in -batch run causes exit here. */
1152 /* Here we catch errors in execution of commands within the
1153 editing loop, and reenter the editing loop.
1154 When there is an error, cmd_error runs and returns a non-nil
1155 value to us. A value of nil means that command_loop_1 itself
1156 returned due to end of file (or end of kbd macro). */
1159 command_loop_2 (Lisp_Object ignore
)
1161 register Lisp_Object val
;
1164 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1165 while (!NILP (val
));
1173 return Feval (Vtop_level
, Qnil
);
1177 top_level_1 (Lisp_Object ignore
)
1179 /* On entry to the outer level, run the startup file. */
1180 if (!NILP (Vtop_level
))
1181 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1182 else if (!NILP (Vpurify_flag
))
1183 message1 ("Bare impure Emacs (standard Lisp code not loaded)");
1185 message1 ("Bare Emacs (standard Lisp code not loaded)");
1189 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1190 doc
: /* Exit all recursive editing levels.
1191 This also exits all active minibuffers. */)
1194 #ifdef HAVE_WINDOW_SYSTEM
1195 if (display_hourglass_p
)
1196 cancel_hourglass ();
1199 /* Unblock input if we enter with input blocked. This may happen if
1200 redisplay traps e.g. during tool-bar update with input blocked. */
1201 totally_unblock_input ();
1203 Fthrow (Qtop_level
, Qnil
);
1206 static _Noreturn
void
1207 user_error (const char *msg
)
1209 xsignal1 (Quser_error
, build_string (msg
));
1213 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1214 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1217 if (command_loop_level
> 0 || minibuf_level
> 0)
1218 Fthrow (Qexit
, Qnil
);
1220 user_error ("No recursive edit is in progress");
1224 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1225 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1228 if (command_loop_level
> 0 || minibuf_level
> 0)
1231 user_error ("No recursive edit is in progress");
1234 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1235 of this function. */
1238 tracking_off (Lisp_Object old_value
)
1240 do_mouse_tracking
= old_value
;
1241 if (NILP (old_value
))
1243 /* Redisplay may have been preempted because there was input
1244 available, and it assumes it will be called again after the
1245 input has been processed. If the only input available was
1246 the sort that we have just disabled, then we need to call
1248 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1250 redisplay_preserve_echo_area (6);
1251 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1256 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1257 doc
: /* Evaluate BODY with mouse movement events enabled.
1258 Within a `track-mouse' form, mouse motion generates input events that
1259 you can read with `read-event'.
1260 Normally, mouse motion is ignored.
1261 usage: (track-mouse BODY...) */)
1264 ptrdiff_t count
= SPECPDL_INDEX ();
1267 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1269 do_mouse_tracking
= Qt
;
1271 val
= Fprogn (args
);
1272 return unbind_to (count
, val
);
1275 /* If mouse has moved on some frame, return one of those frames.
1279 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1280 after resizing the tool-bar window. */
1282 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1285 bool ignore_mouse_drag_p
;
1287 static struct frame
*
1288 some_mouse_moved (void)
1290 Lisp_Object tail
, frame
;
1292 if (ignore_mouse_drag_p
)
1294 /* ignore_mouse_drag_p = 0; */
1298 FOR_EACH_FRAME (tail
, frame
)
1300 if (XFRAME (frame
)->mouse_moved
)
1301 return XFRAME (frame
);
1308 /* This is the actual command reading loop,
1309 sans error-handling encapsulation. */
1311 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1313 void safe_run_hooks (Lisp_Object
);
1314 static void adjust_point_for_property (ptrdiff_t, bool);
1316 /* The last boundary auto-added to buffer-undo-list. */
1317 Lisp_Object last_undo_boundary
;
1319 /* FIXME: This is wrong rather than test window-system, we should call
1320 a new set-selection, which will then dispatch to x-set-selection, or
1321 tty-set-selection, or w32-set-selection, ... */
1324 command_loop_1 (void)
1327 Lisp_Object keybuf
[30];
1329 EMACS_INT prev_modiff
= 0;
1330 struct buffer
*prev_buffer
= NULL
;
1331 bool already_adjusted
= 0;
1333 kset_prefix_arg (current_kboard
, Qnil
);
1334 kset_last_prefix_arg (current_kboard
, Qnil
);
1335 Vdeactivate_mark
= Qnil
;
1336 waiting_for_input
= 0;
1339 this_command_key_count
= 0;
1340 this_command_key_count_reset
= 0;
1341 this_single_command_key_start
= 0;
1343 if (NILP (Vmemory_full
))
1345 /* Make sure this hook runs after commands that get errors and
1346 throw to top level. */
1347 /* Note that the value cell will never directly contain nil
1348 if the symbol is a local variable. */
1349 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1350 safe_run_hooks (Qpost_command_hook
);
1352 /* If displaying a message, resize the echo area window to fit
1353 that message's size exactly. */
1354 if (!NILP (echo_area_buffer
[0]))
1355 resize_echo_area_exactly ();
1357 /* If there are warnings waiting, process them. */
1358 if (!NILP (Vdelayed_warnings_list
))
1359 safe_run_hooks (Qdelayed_warnings_hook
);
1361 if (!NILP (Vdeferred_action_list
))
1362 safe_run_hooks (Qdeferred_action_function
);
1365 /* Do this after running Vpost_command_hook, for consistency. */
1366 kset_last_command (current_kboard
, Vthis_command
);
1367 kset_real_last_command (current_kboard
, Vreal_this_command
);
1368 if (!CONSP (last_command_event
))
1369 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1373 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1376 /* Make sure the current window's buffer is selected. */
1377 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1379 /* Display any malloc warning that just came out. Use while because
1380 displaying one warning can cause another. */
1382 while (pending_malloc_warning
)
1383 display_malloc_warning ();
1385 Vdeactivate_mark
= Qnil
;
1387 /* Don't ignore mouse movements for more than a single command
1388 loop. (This flag is set in xdisp.c whenever the tool bar is
1389 resized, because the resize moves text up or down, and would
1390 generate false mouse drag events if we don't ignore them.) */
1391 ignore_mouse_drag_p
= 0;
1393 /* If minibuffer on and echo area in use,
1394 wait a short time and redraw minibuffer. */
1397 && !NILP (echo_area_buffer
[0])
1398 && EQ (minibuf_window
, echo_area_window
)
1399 && NUMBERP (Vminibuffer_message_timeout
))
1401 /* Bind inhibit-quit to t so that C-g gets read in
1402 rather than quitting back to the minibuffer. */
1403 ptrdiff_t count
= SPECPDL_INDEX ();
1404 specbind (Qinhibit_quit
, Qt
);
1406 sit_for (Vminibuffer_message_timeout
, 0, 2);
1408 /* Clear the echo area. */
1410 safe_run_hooks (Qecho_area_clear_hook
);
1412 unbind_to (count
, Qnil
);
1414 /* If a C-g came in before, treat it as input now. */
1415 if (!NILP (Vquit_flag
))
1418 Vunread_command_events
= list1 (make_number (quit_char
));
1422 /* If it has changed current-menubar from previous value,
1423 really recompute the menubar from the value. */
1424 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1425 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1426 call0 (Qrecompute_lucid_menubar
);
1428 before_command_key_count
= this_command_key_count
;
1429 before_command_echo_length
= echo_length ();
1431 Vthis_command
= Qnil
;
1432 Vreal_this_command
= Qnil
;
1433 Vthis_original_command
= Qnil
;
1434 Vthis_command_keys_shift_translated
= Qnil
;
1436 /* Read next key sequence; i gets its length. */
1437 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1440 /* A filter may have run while we were reading the input. */
1441 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1443 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->contents
));
1447 /* Now we have read a key sequence of length I,
1448 or else I is 0 and we found end of file. */
1450 if (i
== 0) /* End of file -- happens only in */
1451 return Qnil
; /* a kbd macro, at the end. */
1452 /* -1 means read_key_sequence got a menu that was rejected.
1453 Just loop around and read another command. */
1457 this_command_key_count
= 0;
1458 this_command_key_count_reset
= 0;
1459 this_single_command_key_start
= 0;
1463 last_command_event
= keybuf
[i
- 1];
1465 /* If the previous command tried to force a specific window-start,
1466 forget about that, in case this command moves point far away
1467 from that position. But also throw away beg_unchanged and
1468 end_unchanged information in that case, so that redisplay will
1469 update the whole window properly. */
1470 if (XWINDOW (selected_window
)->force_start
)
1473 XWINDOW (selected_window
)->force_start
= 0;
1474 b
= XBUFFER (XWINDOW (selected_window
)->contents
);
1475 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1478 cmd
= read_key_sequence_cmd
;
1479 if (!NILP (Vexecuting_kbd_macro
))
1481 if (!NILP (Vquit_flag
))
1483 Vexecuting_kbd_macro
= Qt
;
1484 QUIT
; /* Make some noise. */
1485 /* Will return since macro now empty. */
1489 /* Do redisplay processing after this command except in special
1490 cases identified below. */
1491 prev_buffer
= current_buffer
;
1492 prev_modiff
= MODIFF
;
1493 last_point_position
= PT
;
1495 /* By default, we adjust point to a boundary of a region that
1496 has such a property that should be treated intangible
1497 (e.g. composition, display). But, some commands will set
1498 this variable differently. */
1499 Vdisable_point_adjustment
= Qnil
;
1501 /* Process filters and timers may have messed with deactivate-mark.
1502 reset it before we execute the command. */
1503 Vdeactivate_mark
= Qnil
;
1505 /* Remap command through active keymaps. */
1506 Vthis_original_command
= cmd
;
1507 if (!NILP (read_key_sequence_remapped
))
1508 cmd
= read_key_sequence_remapped
;
1510 /* Execute the command. */
1512 Vthis_command
= cmd
;
1513 Vreal_this_command
= cmd
;
1514 safe_run_hooks (Qpre_command_hook
);
1516 already_adjusted
= 0;
1518 if (NILP (Vthis_command
))
1520 /* nil means key is undefined. */
1521 Lisp_Object keys
= Fvector (i
, keybuf
);
1522 keys
= Fkey_description (keys
, Qnil
);
1524 message_with_string ("%s is undefined", keys
, 0);
1525 kset_defining_kbd_macro (current_kboard
, Qnil
);
1526 update_mode_lines
= 1;
1527 /* If this is a down-mouse event, don't reset prefix-arg;
1528 pass it to the command run by the up event. */
1529 if (EVENT_HAS_PARAMETERS (last_command_event
))
1531 Lisp_Object breakdown
1532 = parse_modifiers (EVENT_HEAD (last_command_event
));
1533 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1534 if (!(modifiers
& down_modifier
))
1535 kset_prefix_arg (current_kboard
, Qnil
);
1538 kset_prefix_arg (current_kboard
, Qnil
);
1542 /* Here for a command that isn't executed directly. */
1544 #ifdef HAVE_WINDOW_SYSTEM
1545 ptrdiff_t scount
= SPECPDL_INDEX ();
1547 if (display_hourglass_p
1548 && NILP (Vexecuting_kbd_macro
))
1550 record_unwind_protect_void (cancel_hourglass
);
1555 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1557 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1560 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1561 ? Qnil
: BVAR (current_buffer
, undo_list
));
1563 call1 (Qcommand_execute
, Vthis_command
);
1565 #ifdef HAVE_WINDOW_SYSTEM
1566 /* Do not check display_hourglass_p here, because
1567 `command-execute' could change it, but we should cancel
1568 hourglass cursor anyway.
1569 But don't cancel the hourglass within a macro
1570 just because a command in the macro finishes. */
1571 if (NILP (Vexecuting_kbd_macro
))
1572 unbind_to (scount
, Qnil
);
1575 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1577 safe_run_hooks (Qpost_command_hook
);
1579 /* If displaying a message, resize the echo area window to fit
1580 that message's size exactly. */
1581 if (!NILP (echo_area_buffer
[0]))
1582 resize_echo_area_exactly ();
1584 /* If there are warnings waiting, process them. */
1585 if (!NILP (Vdelayed_warnings_list
))
1586 safe_run_hooks (Qdelayed_warnings_hook
);
1588 safe_run_hooks (Qdeferred_action_function
);
1590 /* If there is a prefix argument,
1591 1) We don't want Vlast_command to be ``universal-argument''
1592 (that would be dumb), so don't set Vlast_command,
1593 2) we want to leave echoing on so that the prefix will be
1594 echoed as part of this key sequence, so don't call
1596 3) we want to leave this_command_key_count non-zero, so that
1597 read_char will realize that it is re-reading a character, and
1598 not echo it a second time.
1600 If the command didn't actually create a prefix arg,
1601 but is merely a frame event that is transparent to prefix args,
1602 then the above doesn't apply. */
1603 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1604 || CONSP (last_command_event
))
1606 kset_last_command (current_kboard
, Vthis_command
);
1607 kset_real_last_command (current_kboard
, Vreal_this_command
);
1608 if (!CONSP (last_command_event
))
1609 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1611 this_command_key_count
= 0;
1612 this_command_key_count_reset
= 0;
1613 this_single_command_key_start
= 0;
1616 if (!NILP (BVAR (current_buffer
, mark_active
))
1617 && !NILP (Vrun_hooks
))
1619 /* In Emacs 22, setting transient-mark-mode to `only' was a
1620 way of turning it on for just one command. This usage is
1621 obsolete, but support it anyway. */
1622 if (EQ (Vtransient_mark_mode
, Qidentity
))
1623 Vtransient_mark_mode
= Qnil
;
1624 else if (EQ (Vtransient_mark_mode
, Qonly
))
1625 Vtransient_mark_mode
= Qidentity
;
1627 if (!NILP (Vdeactivate_mark
))
1628 /* If `select-active-regions' is non-nil, this call to
1629 `deactivate-mark' also sets the PRIMARY selection. */
1630 call0 (Qdeactivate_mark
);
1633 /* Even if not deactivating the mark, set PRIMARY if
1634 `select-active-regions' is non-nil. */
1635 if (!NILP (Fwindow_system (Qnil
))
1636 /* Even if mark_active is non-nil, the actual buffer
1637 marker may not have been set yet (Bug#7044). */
1638 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1639 && (EQ (Vselect_active_regions
, Qonly
)
1640 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1641 : (!NILP (Vselect_active_regions
)
1642 && !NILP (Vtransient_mark_mode
)))
1643 && NILP (Fmemq (Vthis_command
,
1644 Vselection_inhibit_update_commands
)))
1647 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1650 call2 (Qx_set_selection
, QPRIMARY
,
1651 make_buffer_string (beg
, end
, 0));
1653 call2 (Qx_set_selection
, QPRIMARY
,
1654 make_buffer_string (end
, beg
, 0));
1655 /* Don't set empty selections. */
1658 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1660 Lisp_Object hook
= intern ("activate-mark-hook");
1661 Frun_hooks (1, &hook
);
1665 Vsaved_region_selection
= Qnil
;
1670 if (current_buffer
== prev_buffer
1671 && last_point_position
!= PT
1672 && NILP (Vdisable_point_adjustment
)
1673 && NILP (Vglobal_disable_point_adjustment
))
1675 if (last_point_position
> BEGV
1676 && last_point_position
< ZV
1677 && (composition_adjust_point (last_point_position
,
1678 last_point_position
)
1679 != last_point_position
))
1680 /* The last point was temporarily set within a grapheme
1681 cluster to prevent automatic composition. To recover
1682 the automatic composition, we must update the
1684 windows_or_buffers_changed
++;
1685 if (!already_adjusted
)
1686 adjust_point_for_property (last_point_position
,
1687 MODIFF
!= prev_modiff
);
1690 /* Install chars successfully executed in kbd macro. */
1692 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1693 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1694 finalize_kbd_macro_chars ();
1698 /* Adjust point to a boundary of a region that has such a property
1699 that should be treated intangible. For the moment, we check
1700 `composition', `display' and `invisible' properties.
1701 LAST_PT is the last position of point. */
1704 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1707 Lisp_Object val
, overlay
, tmp
;
1708 /* When called after buffer modification, we should temporarily
1709 suppress the point adjustment for automatic composition so that a
1710 user can keep inserting another character at point or keep
1711 deleting characters around point. */
1712 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1713 ptrdiff_t orig_pt
= PT
;
1715 /* FIXME: cycling is probably not necessary because these properties
1716 can't be usefully combined anyway. */
1717 while (check_composition
|| check_display
|| check_invisible
)
1719 /* FIXME: check `intangible'. */
1720 if (check_composition
1721 && PT
> BEGV
&& PT
< ZV
1722 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1725 check_display
= check_invisible
= 1;
1727 check_composition
= 0;
1729 && PT
> BEGV
&& PT
< ZV
1730 && !NILP (val
= get_char_property_and_overlay
1731 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1732 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1733 && (!OVERLAYP (overlay
)
1734 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1735 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1736 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1737 && (beg
< PT
/* && end > PT <- It's always the case. */
1738 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1741 SET_PT (PT
< last_pt
1742 ? (STRINGP (val
) && SCHARS (val
) == 0
1743 ? max (beg
- 1, BEGV
)
1746 check_composition
= check_invisible
= 1;
1749 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1755 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1758 /* FIXME: We should stop if we find a spot between
1759 two runs of `invisible' where inserted text would
1760 be visible. This is important when we have two
1761 invisible boundaries that enclose an area: if the
1762 area is empty, we need this test in order to make
1763 it possible to place point in the middle rather
1764 than skip both boundaries. However, this code
1765 also stops anywhere in a non-sticky text-property,
1766 which breaks (e.g.) Org mode. */
1767 && (val
= get_pos_property (make_number (end
),
1769 TEXT_PROP_MEANS_INVISIBLE (val
))
1771 && !NILP (val
= get_char_property_and_overlay
1772 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1773 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1775 ellipsis
= ellipsis
|| inv
> 1
1776 || (OVERLAYP (overlay
)
1777 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1778 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1779 tmp
= Fnext_single_char_property_change
1780 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1781 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1785 && (val
= get_pos_property (make_number (beg
),
1787 TEXT_PROP_MEANS_INVISIBLE (val
))
1789 && !NILP (val
= get_char_property_and_overlay
1790 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1791 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1793 ellipsis
= ellipsis
|| inv
> 1
1794 || (OVERLAYP (overlay
)
1795 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1796 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1797 tmp
= Fprevious_single_char_property_change
1798 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1799 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1802 /* Move away from the inside area. */
1803 if (beg
< PT
&& end
> PT
)
1805 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1806 /* We haven't moved yet (so we don't need to fear
1807 infinite-looping) and we were outside the range
1808 before (so either end of the range still corresponds
1809 to a move in the right direction): pretend we moved
1810 less than we actually did, so that we still have
1811 more freedom below in choosing which end of the range
1813 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1814 /* We either have moved already or the last point
1815 was already in the range: we don't get to choose
1816 which end of the range we have to go to. */
1817 : (PT
< last_pt
? beg
: end
));
1818 check_composition
= check_display
= 1;
1820 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1821 the point to something other than its argument, due to
1822 point-motion hooks, intangibility, etc. */
1823 eassert (PT
== beg
|| PT
== end
);
1826 /* Pretend the area doesn't exist if the buffer is not
1828 if (!modified
&& !ellipsis
&& beg
< end
)
1830 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1831 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1832 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1833 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1834 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1835 /* We've already moved as far as we can. Trying to go
1836 to the other end would mean moving backwards and thus
1837 could lead to an infinite loop. */
1839 else if (val
= get_pos_property (make_number (PT
),
1841 TEXT_PROP_MEANS_INVISIBLE (val
)
1842 && (val
= get_pos_property
1843 (make_number (PT
== beg
? end
: beg
),
1845 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1846 (check_composition
= check_display
= 1,
1847 SET_PT (PT
== beg
? end
: beg
));
1850 check_invisible
= 0;
1854 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1857 safe_run_hooks_1 (void)
1859 eassert (CONSP (Vinhibit_quit
));
1860 return call0 (XCDR (Vinhibit_quit
));
1863 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1867 safe_run_hooks_error (Lisp_Object error_data
)
1870 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1871 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1872 Lisp_Object args
[4];
1873 args
[0] = build_string ("Error in %s (%S): %S");
1876 args
[3] = error_data
;
1882 Lisp_Object newval
= Qnil
;
1883 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1884 if (EQ (fun
, XCAR (val
)))
1887 newval
= Fcons (XCAR (val
), newval
);
1889 return Fset (hook
, Fnreverse (newval
));
1890 /* Not found in the local part of the hook. Let's look at the global
1893 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1894 : Fdefault_value (hook
));
1895 CONSP (val
); val
= XCDR (val
))
1896 if (EQ (fun
, XCAR (val
)))
1899 newval
= Fcons (XCAR (val
), newval
);
1901 return Fset_default (hook
, Fnreverse (newval
));
1907 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1909 eassert (nargs
== 1);
1910 if (CONSP (Vinhibit_quit
))
1911 XSETCDR (Vinhibit_quit
, args
[0]);
1913 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1915 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1919 /* If we get an error while running the hook, cause the hook variable
1920 to be nil. Also inhibit quits, so that C-g won't cause the hook
1921 to mysteriously evaporate. */
1924 safe_run_hooks (Lisp_Object hook
)
1926 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1927 to its body or to its handlers other than via globals such as
1928 dynamically-bound variables ;-) */
1929 ptrdiff_t count
= SPECPDL_INDEX ();
1930 specbind (Qinhibit_quit
, hook
);
1932 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1934 unbind_to (count
, Qnil
);
1938 /* Nonzero means polling for input is temporarily suppressed. */
1940 int poll_suppress_count
;
1943 #ifdef POLL_FOR_INPUT
1945 /* Asynchronous timer for polling. */
1947 static struct atimer
*poll_timer
;
1949 /* Poll for input, so that we catch a C-g if it comes in. This
1950 function is called from x_make_frame_visible, see comment
1954 poll_for_input_1 (void)
1956 if (! input_blocked_p ()
1957 && !waiting_for_input
)
1961 /* Timer callback function for poll_timer. TIMER is equal to
1965 poll_for_input (struct atimer
*timer
)
1967 if (poll_suppress_count
== 0)
1968 pending_signals
= 1;
1971 #endif /* POLL_FOR_INPUT */
1973 /* Begin signals to poll for input, if they are appropriate.
1974 This function is called unconditionally from various places. */
1977 start_polling (void)
1979 #ifdef POLL_FOR_INPUT
1980 /* XXX This condition was (read_socket_hook && !interrupt_input),
1981 but read_socket_hook is not global anymore. Let's pretend that
1983 if (!interrupt_input
)
1985 /* Turn alarm handling on unconditionally. It might have
1986 been turned off in process.c. */
1987 turn_on_atimers (1);
1989 /* If poll timer doesn't exist, are we need one with
1990 a different interval, start a new one. */
1991 if (poll_timer
== NULL
1992 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
1994 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
1995 EMACS_TIME interval
= make_emacs_time (period
, 0);
1998 cancel_atimer (poll_timer
);
2000 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2001 poll_for_input
, NULL
);
2004 /* Let the timer's callback function poll for input
2005 if this becomes zero. */
2006 --poll_suppress_count
;
2011 /* True if we are using polling to handle input asynchronously. */
2014 input_polling_used (void)
2016 #ifdef POLL_FOR_INPUT
2017 /* XXX This condition was (read_socket_hook && !interrupt_input),
2018 but read_socket_hook is not global anymore. Let's pretend that
2020 return !interrupt_input
;
2026 /* Turn off polling. */
2031 #ifdef POLL_FOR_INPUT
2032 /* XXX This condition was (read_socket_hook && !interrupt_input),
2033 but read_socket_hook is not global anymore. Let's pretend that
2035 if (!interrupt_input
)
2036 ++poll_suppress_count
;
2040 /* Set the value of poll_suppress_count to COUNT
2041 and start or stop polling accordingly. */
2044 set_poll_suppress_count (int count
)
2046 #ifdef POLL_FOR_INPUT
2047 if (count
== 0 && poll_suppress_count
!= 0)
2049 poll_suppress_count
= 1;
2052 else if (count
!= 0 && poll_suppress_count
== 0)
2056 poll_suppress_count
= count
;
2060 /* Bind polling_period to a value at least N.
2061 But don't decrease it. */
2064 bind_polling_period (int n
)
2066 #ifdef POLL_FOR_INPUT
2067 EMACS_INT
new = polling_period
;
2072 stop_other_atimers (poll_timer
);
2074 specbind (Qpolling_period
, make_number (new));
2075 /* Start a new alarm with the new period. */
2080 /* Apply the control modifier to CHARACTER. */
2083 make_ctrl_char (int c
)
2085 /* Save the upper bits here. */
2086 int upper
= c
& ~0177;
2088 if (! ASCII_BYTE_P (c
))
2089 return c
|= ctrl_modifier
;
2093 /* Everything in the columns containing the upper-case letters
2094 denotes a control character. */
2095 if (c
>= 0100 && c
< 0140)
2099 /* Set the shift modifier for a control char
2100 made from a shifted letter. But only for letters! */
2101 if (oc
>= 'A' && oc
<= 'Z')
2102 c
|= shift_modifier
;
2105 /* The lower-case letters denote control characters too. */
2106 else if (c
>= 'a' && c
<= 'z')
2109 /* Include the bits for control and shift
2110 only if the basic ASCII code can't indicate them. */
2114 /* Replace the high bits. */
2115 c
|= (upper
& ~ctrl_modifier
);
2120 /* Display the help-echo property of the character after the mouse pointer.
2121 Either show it in the echo area, or call show-help-function to display
2122 it by other means (maybe in a tooltip).
2124 If HELP is nil, that means clear the previous help echo.
2126 If HELP is a string, display that string. If HELP is a function,
2127 call it with OBJECT and POS as arguments; the function should
2128 return a help string or nil for none. For all other types of HELP,
2129 evaluate it to obtain a string.
2131 WINDOW is the window in which the help was generated, if any.
2132 It is nil if not in a window.
2134 If OBJECT is a buffer, POS is the position in the buffer where the
2135 `help-echo' text property was found.
2137 If OBJECT is an overlay, that overlay has a `help-echo' property,
2138 and POS is the position in the overlay's buffer under the mouse.
2140 If OBJECT is a string (an overlay string or a string displayed with
2141 the `display' property). POS is the position in that string under
2144 Note: this function may only be called with HELP nil or a string
2145 from X code running asynchronously. */
2148 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2151 if (!NILP (help
) && !STRINGP (help
))
2153 if (FUNCTIONP (help
))
2154 help
= safe_call (4, help
, window
, object
, pos
);
2156 help
= safe_eval (help
);
2158 if (!STRINGP (help
))
2162 if (!noninteractive
&& STRINGP (help
))
2164 /* The mouse-fixup-help-message Lisp function can call
2165 mouse_position_hook, which resets the mouse_moved flags.
2166 This causes trouble if we are trying to read a mouse motion
2167 event (i.e., if we are inside a `track-mouse' form), so we
2168 restore the mouse_moved flag. */
2169 struct frame
*f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2170 help
= call1 (Qmouse_fixup_help_message
, help
);
2175 if (STRINGP (help
) || NILP (help
))
2177 if (!NILP (Vshow_help_function
))
2178 call1 (Vshow_help_function
, help
);
2179 help_echo_showing_p
= STRINGP (help
);
2185 /* Input of single characters from keyboard */
2187 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2188 EMACS_TIME
*end_time
);
2189 static void record_char (Lisp_Object c
);
2191 static Lisp_Object help_form_saved_window_configs
;
2193 read_char_help_form_unwind (void)
2195 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2196 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2197 if (!NILP (window_config
))
2198 Fset_window_configuration (window_config
);
2201 #define STOP_POLLING \
2202 do { if (! polling_stopped_here) stop_polling (); \
2203 polling_stopped_here = 1; } while (0)
2205 #define RESUME_POLLING \
2206 do { if (polling_stopped_here) start_polling (); \
2207 polling_stopped_here = 0; } while (0)
2210 read_event_from_main_queue (EMACS_TIME
*end_time
,
2211 sys_jmp_buf local_getcjmp
,
2212 bool *used_mouse_menu
)
2214 Lisp_Object c
= Qnil
;
2215 sys_jmp_buf save_jump
;
2216 KBOARD
*kb
IF_LINT (= NULL
);
2220 /* Read from the main queue, and if that gives us something we can't use yet,
2221 we put it on the appropriate side queue and try again. */
2223 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2226 /* Actually read a character, waiting if necessary. */
2227 save_getcjmp (save_jump
);
2228 restore_getcjmp (local_getcjmp
);
2230 timer_start_idle ();
2231 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2232 restore_getcjmp (save_jump
);
2234 if (! NILP (c
) && (kb
!= current_kboard
))
2236 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2239 while (CONSP (XCDR (last
)))
2241 if (!NILP (XCDR (last
)))
2245 kset_kbd_queue (kb
, list1 (c
));
2247 XSETCDR (last
, list1 (c
));
2248 kb
->kbd_queue_has_data
= 1;
2252 current_kboard
= kb
;
2253 /* This is going to exit from read_char
2254 so we had better get rid of this frame's stuff. */
2255 return make_number (-2);
2258 /* Terminate Emacs in batch mode if at eof. */
2259 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2260 Fkill_emacs (make_number (1));
2264 /* Add in any extra modifiers, where appropriate. */
2265 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2266 || ((extra_keyboard_modifiers
& 0177) < ' '
2267 && (extra_keyboard_modifiers
& 0177) != 0))
2268 XSETINT (c
, make_ctrl_char (XINT (c
)));
2270 /* Transfer any other modifier bits directly from
2271 extra_keyboard_modifiers to c. Ignore the actual character code
2272 in the low 16 bits of extra_keyboard_modifiers. */
2273 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2281 /* Like `read_event_from_main_queue' but applies keyboard-coding-system
2284 read_decoded_event_from_main_queue (EMACS_TIME
*end_time
,
2285 sys_jmp_buf local_getcjmp
,
2286 Lisp_Object prev_event
,
2287 bool *used_mouse_menu
)
2289 #define MAX_ENCODED_BYTES 16
2290 Lisp_Object events
[MAX_ENCODED_BYTES
];
2295 = read_event_from_main_queue (end_time
, local_getcjmp
,
2298 /* w32_console already returns decoded events. It either reads
2299 Unicode characters from the Windows keyboard input, or
2300 converts characters encoded in the current codepage into
2301 Unicode. See w32inevt.c:key_event, near its end. */
2304 struct frame
*frame
= XFRAME (selected_frame
);
2305 struct terminal
*terminal
= frame
->terminal
;
2306 if (!((FRAME_TERMCAP_P (frame
) || FRAME_MSDOS_P (frame
))
2307 /* Don't apply decoding if we're just reading a raw event
2308 (e.g. reading bytes sent by the xterm to specify the position
2309 of a mouse click). */
2310 && (!EQ (prev_event
, Qt
))
2311 && (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
2312 & CODING_REQUIRE_DECODING_MASK
)))
2313 return nextevt
; /* No decoding needed. */
2316 int meta_key
= terminal
->display_info
.tty
->meta_key
;
2317 eassert (n
< MAX_ENCODED_BYTES
);
2318 events
[n
++] = nextevt
;
2319 if (NATNUMP (nextevt
)
2320 && XINT (nextevt
) < (meta_key
== 1 ? 0x80 : 0x100))
2321 { /* An encoded byte sequence, let's try to decode it. */
2322 struct coding_system
*coding
2323 = TERMINAL_KEYBOARD_CODING (terminal
);
2324 unsigned char *src
= alloca (n
);
2326 for (i
= 0; i
< n
; i
++)
2327 src
[i
] = XINT (events
[i
]);
2329 for (i
= 0; i
< n
; i
++)
2331 coding
->destination
= alloca (n
* 4);
2332 coding
->dst_bytes
= n
* 4;
2333 decode_coding_c_string (coding
, src
, n
, Qnil
);
2334 eassert (coding
->produced_char
<= n
);
2335 if (coding
->produced_char
== 0)
2336 { /* The encoded sequence is incomplete. */
2337 if (n
< MAX_ENCODED_BYTES
) /* Avoid buffer overflow. */
2338 continue; /* Read on! */
2342 const unsigned char *p
= coding
->destination
;
2343 eassert (coding
->carryover_bytes
== 0);
2345 while (n
< coding
->produced_char
)
2346 events
[n
++] = make_number (STRING_CHAR_ADVANCE (p
));
2349 /* Now `events' should hold decoded events.
2350 Normally, n should be equal to 1, but better not rely on it.
2351 We can only return one event here, so return the first we
2352 had and keep the others (if any) for later. */
2354 Vunread_command_events
2355 = Fcons (events
[--n
], Vunread_command_events
);
2362 /* Read a character from the keyboard; call the redisplay if needed. */
2363 /* commandflag 0 means do not autosave, but do redisplay.
2364 -1 means do not redisplay, but do autosave.
2367 /* The arguments MAP is for menu prompting. MAP is a keymap.
2369 PREV_EVENT is the previous input event, or nil if we are reading
2370 the first event of a key sequence (or not reading a key sequence).
2371 If PREV_EVENT is t, that is a "magic" value that says
2372 not to run input methods, but in other respects to act as if
2373 not reading a key sequence.
2375 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2376 if we used a mouse menu to read the input, or false otherwise. If
2377 USED_MOUSE_MENU is null, don't dereference it.
2379 Value is -2 when we find input on another keyboard. A second call
2380 to read_char will read it.
2382 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2383 specifying the maximum time to wait until. If no input arrives by
2384 that time, stop waiting and return nil.
2386 Value is t if we showed a menu and the user rejected it. */
2389 read_char (int commandflag
, Lisp_Object map
,
2390 Lisp_Object prev_event
,
2391 bool *used_mouse_menu
, EMACS_TIME
*end_time
)
2395 sys_jmp_buf local_getcjmp
;
2396 sys_jmp_buf save_jump
;
2397 Lisp_Object tem
, save
;
2398 volatile Lisp_Object previous_echo_area_message
;
2399 volatile Lisp_Object also_record
;
2400 volatile bool reread
;
2401 struct gcpro gcpro1
, gcpro2
;
2402 bool volatile polling_stopped_here
= 0;
2403 struct kboard
*orig_kboard
= current_kboard
;
2407 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2408 before_command_key_count
= this_command_key_count
;
2409 before_command_echo_length
= echo_length ();
2412 previous_echo_area_message
= Qnil
;
2414 GCPRO2 (c
, previous_echo_area_message
);
2419 if (CONSP (Vunread_post_input_method_events
))
2421 c
= XCAR (Vunread_post_input_method_events
);
2422 Vunread_post_input_method_events
2423 = XCDR (Vunread_post_input_method_events
);
2425 /* Undo what read_char_x_menu_prompt did when it unread
2426 additional keys returned by Fx_popup_menu. */
2428 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2436 if (CONSP (Vunread_command_events
))
2438 bool was_disabled
= 0;
2440 c
= XCAR (Vunread_command_events
);
2441 Vunread_command_events
= XCDR (Vunread_command_events
);
2445 /* Undo what sit-for did when it unread additional keys
2446 inside universal-argument. */
2449 && EQ (XCAR (c
), Qt
))
2455 /* Undo what read_char_x_menu_prompt did when it unread
2456 additional keys returned by Fx_popup_menu. */
2458 && EQ (XCDR (c
), Qdisabled
)
2459 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2465 /* If the queued event is something that used the mouse,
2466 set used_mouse_menu accordingly. */
2468 /* Also check was_disabled so last-nonmenu-event won't return
2469 a bad value when submenus are involved. (Bug#447) */
2470 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2471 *used_mouse_menu
= 1;
2473 goto reread_for_input_method
;
2476 if (CONSP (Vunread_input_method_events
))
2478 c
= XCAR (Vunread_input_method_events
);
2479 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2481 /* Undo what read_char_x_menu_prompt did when it unread
2482 additional keys returned by Fx_popup_menu. */
2484 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2488 goto reread_for_input_method
;
2491 this_command_key_count_reset
= 0;
2493 if (!NILP (Vexecuting_kbd_macro
))
2495 /* We set this to Qmacro; since that's not a frame, nobody will
2496 try to switch frames on us, and the selected window will
2499 Since this event came from a macro, it would be misleading to
2500 leave internal_last_event_frame set to wherever the last
2501 real event came from. Normally, a switch-frame event selects
2502 internal_last_event_frame after each command is read, but
2503 events read from a macro should never cause a new frame to be
2505 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2507 /* Exit the macro if we are at the end.
2508 Also, some things replace the macro with t
2509 to force an early exit. */
2510 if (EQ (Vexecuting_kbd_macro
, Qt
)
2511 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2517 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2518 if (STRINGP (Vexecuting_kbd_macro
)
2519 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2520 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2522 executing_kbd_macro_index
++;
2527 if (!NILP (unread_switch_frame
))
2529 c
= unread_switch_frame
;
2530 unread_switch_frame
= Qnil
;
2532 /* This event should make it into this_command_keys, and get echoed
2533 again, so we do not set `reread'. */
2537 /* If redisplay was requested. */
2538 if (commandflag
>= 0)
2540 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2542 /* If there is pending input, process any events which are not
2543 user-visible, such as X selection_request events. */
2545 || detect_input_pending_run_timers (0))
2546 swallow_events (0); /* May clear input_pending. */
2548 /* Redisplay if no pending input. */
2549 while (!input_pending
)
2551 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2552 redisplay_preserve_echo_area (5);
2557 /* Normal case: no input arrived during redisplay. */
2560 /* Input arrived and pre-empted redisplay.
2561 Process any events which are not user-visible. */
2563 /* If that cleared input_pending, try again to redisplay. */
2566 /* Prevent the redisplay we just did
2567 from messing up echoing of the input after the prompt. */
2568 if (commandflag
== 0 && echo_current
)
2569 echo_message_buffer
= echo_area_buffer
[0];
2573 /* Message turns off echoing unless more keystrokes turn it on again.
2575 The code in 20.x for the condition was
2577 1. echo_area_glyphs && *echo_area_glyphs
2578 2. && echo_area_glyphs != current_kboard->echobuf
2579 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2581 (1) means there's a current message displayed
2583 (2) means it's not the message from echoing from the current
2586 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2587 is set to a non-null value. This is done in read_char and it is
2588 set to echo_area_glyphs after a call to echo_char. That means
2589 ok_to_echo_at_next_pause is either null or
2590 current_kboard->echobuf with the appropriate current_kboard at
2593 So, condition (3) means in clear text ok_to_echo_at_next_pause
2594 must be either null, or the current message isn't from echoing at
2595 all, or it's from echoing from a different kboard than the
2598 if (/* There currently is something in the echo area. */
2599 !NILP (echo_area_buffer
[0])
2600 && (/* And it's either not from echoing. */
2601 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2602 /* Or it's an echo from a different kboard. */
2603 || echo_kboard
!= current_kboard
2604 /* Or we explicitly allow overwriting whatever there is. */
2605 || ok_to_echo_at_next_pause
== NULL
))
2610 /* Try reading a character via menu prompting in the minibuf.
2611 Try this before the sit-for, because the sit-for
2612 would do the wrong thing if we are supposed to do
2613 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2614 after a mouse event so don't try a minibuf menu. */
2616 if (KEYMAPP (map
) && INTERACTIVE
2617 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2618 /* Don't bring up a menu if we already have another event. */
2619 && NILP (Vunread_command_events
)
2620 && !detect_input_pending_run_timers (0))
2622 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2624 if (INTEGERP (c
) && XINT (c
) == -2)
2625 return c
; /* wrong_kboard_jmpbuf */
2631 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2632 We will do that below, temporarily for short sections of code,
2633 when appropriate. local_getcjmp must be in effect
2634 around any call to sit_for or kbd_buffer_get_event;
2635 it *must not* be in effect when we call redisplay. */
2637 jmpcount
= SPECPDL_INDEX ();
2638 if (sys_setjmp (local_getcjmp
))
2640 /* Handle quits while reading the keyboard. */
2641 /* We must have saved the outer value of getcjmp here,
2642 so restore it now. */
2643 restore_getcjmp (save_jump
);
2644 unbind_to (jmpcount
, Qnil
);
2645 XSETINT (c
, quit_char
);
2646 internal_last_event_frame
= selected_frame
;
2647 Vlast_event_frame
= internal_last_event_frame
;
2648 /* If we report the quit char as an event,
2649 don't do so more than once. */
2650 if (!NILP (Vinhibit_quit
))
2654 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2655 if (kb
!= current_kboard
)
2657 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2658 /* We shouldn't get here if we were in single-kboard mode! */
2663 while (CONSP (XCDR (last
)))
2665 if (!NILP (XCDR (last
)))
2669 kset_kbd_queue (kb
, list1 (c
));
2671 XSETCDR (last
, list1 (c
));
2672 kb
->kbd_queue_has_data
= 1;
2673 current_kboard
= kb
;
2674 /* This is going to exit from read_char
2675 so we had better get rid of this frame's stuff. */
2677 return make_number (-2); /* wrong_kboard_jmpbuf */
2683 /* Start idle timers if no time limit is supplied. We don't do it
2684 if a time limit is supplied to avoid an infinite recursion in the
2685 situation where an idle timer calls `sit-for'. */
2688 timer_start_idle ();
2690 /* If in middle of key sequence and minibuffer not active,
2691 start echoing if enough time elapses. */
2693 if (minibuf_level
== 0
2695 && !current_kboard
->immediate_echo
2696 && this_command_key_count
> 0
2698 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2699 && NILP (Fzerop (Vecho_keystrokes
))
2700 && (/* No message. */
2701 NILP (echo_area_buffer
[0])
2702 /* Or empty message. */
2703 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2704 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2705 /* Or already echoing from same kboard. */
2706 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2707 /* Or not echoing before and echoing allowed. */
2708 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2710 /* After a mouse event, start echoing right away.
2711 This is because we are probably about to display a menu,
2712 and we don't want to delay before doing so. */
2713 if (EVENT_HAS_PARAMETERS (prev_event
))
2719 save_getcjmp (save_jump
);
2720 restore_getcjmp (local_getcjmp
);
2721 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2722 restore_getcjmp (save_jump
);
2724 && ! CONSP (Vunread_command_events
))
2729 /* Maybe auto save due to number of keystrokes. */
2731 if (commandflag
!= 0
2732 && auto_save_interval
> 0
2733 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2734 && !detect_input_pending_run_timers (0))
2736 Fdo_auto_save (Qnil
, Qnil
);
2737 /* Hooks can actually change some buffers in auto save. */
2741 /* Try reading using an X menu.
2742 This is never confused with reading using the minibuf
2743 because the recursive call of read_char in read_char_minibuf_menu_prompt
2744 does not pass on any keymaps. */
2746 if (KEYMAPP (map
) && INTERACTIVE
2747 && !NILP (prev_event
)
2748 && EVENT_HAS_PARAMETERS (prev_event
)
2749 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2750 && !EQ (XCAR (prev_event
), Qtool_bar
)
2751 /* Don't bring up a menu if we already have another event. */
2752 && NILP (Vunread_command_events
))
2754 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2756 /* Now that we have read an event, Emacs is not idle. */
2763 /* Maybe autosave and/or garbage collect due to idleness. */
2765 if (INTERACTIVE
&& NILP (c
))
2768 ptrdiff_t buffer_size
;
2770 /* Slow down auto saves logarithmically in size of current buffer,
2771 and garbage collect while we're at it. */
2772 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2773 last_non_minibuf_size
= Z
- BEG
;
2774 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2776 while (buffer_size
> 64)
2777 delay_level
++, buffer_size
-= buffer_size
>> 2;
2778 if (delay_level
< 4) delay_level
= 4;
2779 /* delay_level is 4 for files under around 50k, 7 at 100k,
2780 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2782 /* Auto save if enough time goes by without input. */
2783 if (commandflag
!= 0
2784 && num_nonmacro_input_events
> last_auto_save
2785 && INTEGERP (Vauto_save_timeout
)
2786 && XINT (Vauto_save_timeout
) > 0)
2789 EMACS_INT timeout
= XFASTINT (Vauto_save_timeout
);
2791 timeout
= min (timeout
, MOST_POSITIVE_FIXNUM
/ delay_level
* 4);
2792 timeout
= delay_level
* timeout
/ 4;
2793 save_getcjmp (save_jump
);
2794 restore_getcjmp (local_getcjmp
);
2795 tem0
= sit_for (make_number (timeout
), 1, 1);
2796 restore_getcjmp (save_jump
);
2799 && ! CONSP (Vunread_command_events
))
2801 Fdo_auto_save (Qnil
, Qnil
);
2806 /* If there is still no input available, ask for GC. */
2807 if (!detect_input_pending_run_timers (0))
2811 /* Notify the caller if an autosave hook, or a timer, sentinel or
2812 filter in the sit_for calls above have changed the current
2813 kboard. This could happen if they use the minibuffer or start a
2814 recursive edit, like the fancy splash screen in server.el's
2815 filter. If this longjmp wasn't here, read_key_sequence would
2816 interpret the next key sequence using the wrong translation
2817 tables and function keymaps. */
2818 if (NILP (c
) && current_kboard
!= orig_kboard
)
2821 return make_number (-2); /* wrong_kboard_jmpbuf */
2824 /* If this has become non-nil here, it has been set by a timer
2825 or sentinel or filter. */
2826 if (CONSP (Vunread_command_events
))
2828 c
= XCAR (Vunread_command_events
);
2829 Vunread_command_events
= XCDR (Vunread_command_events
);
2832 /* Read something from current KBOARD's side queue, if possible. */
2836 if (current_kboard
->kbd_queue_has_data
)
2838 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2840 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2841 kset_kbd_queue (current_kboard
,
2842 XCDR (KVAR (current_kboard
, kbd_queue
)));
2843 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2844 current_kboard
->kbd_queue_has_data
= 0;
2845 input_pending
= readable_events (0);
2846 if (EVENT_HAS_PARAMETERS (c
)
2847 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2848 internal_last_event_frame
= XCAR (XCDR (c
));
2849 Vlast_event_frame
= internal_last_event_frame
;
2853 /* If current_kboard's side queue is empty check the other kboards.
2854 If one of them has data that we have not yet seen here,
2855 switch to it and process the data waiting for it.
2857 Note: if the events queued up for another kboard
2858 have already been seen here, and therefore are not a complete command,
2859 the kbd_queue_has_data field is 0, so we skip that kboard here.
2860 That's to avoid an infinite loop switching between kboards here. */
2861 if (NILP (c
) && !single_kboard
)
2864 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2865 if (kb
->kbd_queue_has_data
)
2867 current_kboard
= kb
;
2868 /* This is going to exit from read_char
2869 so we had better get rid of this frame's stuff. */
2871 return make_number (-2); /* wrong_kboard_jmpbuf */
2881 c
= read_decoded_event_from_main_queue (end_time
, local_getcjmp
,
2882 prev_event
, used_mouse_menu
);
2883 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2885 if (EQ (c
, make_number (-2)))
2887 /* This is going to exit from read_char
2888 so we had better get rid of this frame's stuff. */
2902 if (commandflag
>= 0
2903 && !input_pending
&& !detect_input_pending_run_timers (0))
2909 /* Buffer switch events are only for internal wakeups
2910 so don't show them to the user.
2911 Also, don't record a key if we already did. */
2915 /* Process special events within read_char
2916 and loop around to read another event. */
2919 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2924 struct buffer
*prev_buffer
= current_buffer
;
2925 last_input_event
= c
;
2926 call4 (Qcommand_execute
, tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2928 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2929 /* We stopped being idle for this event; undo that. This
2930 prevents automatic window selection (under
2931 mouse_autoselect_window from acting as a real input event, for
2932 example banishing the mouse under mouse-avoidance-mode. */
2933 timer_resume_idle ();
2935 if (current_buffer
!= prev_buffer
)
2937 /* The command may have changed the keymaps. Pretend there
2938 is input in another keyboard and return. This will
2939 recalculate keymaps. */
2940 c
= make_number (-2);
2947 /* Handle things that only apply to characters. */
2950 /* If kbd_buffer_get_event gave us an EOF, return that. */
2954 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2955 && UNSIGNED_CMP (XFASTINT (c
), <,
2956 SCHARS (KVAR (current_kboard
,
2957 Vkeyboard_translate_table
))))
2958 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2959 && UNSIGNED_CMP (XFASTINT (c
), <,
2960 ASIZE (KVAR (current_kboard
,
2961 Vkeyboard_translate_table
))))
2962 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2966 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2967 /* nil in keyboard-translate-table means no translation. */
2973 /* If this event is a mouse click in the menu bar,
2974 return just menu-bar for now. Modify the mouse click event
2975 so we won't do this twice, then queue it up. */
2976 if (EVENT_HAS_PARAMETERS (c
)
2978 && CONSP (EVENT_START (c
))
2979 && CONSP (XCDR (EVENT_START (c
))))
2983 posn
= POSN_POSN (EVENT_START (c
));
2984 /* Handle menu-bar events:
2985 insert the dummy prefix event `menu-bar'. */
2986 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2988 /* Change menu-bar to (menu-bar) as the event "position". */
2989 POSN_SET_POSN (EVENT_START (c
), list1 (posn
));
2992 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2997 /* Store these characters into recent_keys, the dribble file if any,
2998 and the keyboard macro being defined, if any. */
3000 if (! NILP (also_record
))
3001 record_char (also_record
);
3003 /* Wipe the echo area.
3004 But first, if we are about to use an input method,
3005 save the echo area contents for it to refer to. */
3007 && ! NILP (Vinput_method_function
)
3008 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3010 previous_echo_area_message
= Fcurrent_message ();
3011 Vinput_method_previous_message
= previous_echo_area_message
;
3014 /* Now wipe the echo area, except for help events which do their
3015 own stuff with the echo area. */
3017 || (!(EQ (Qhelp_echo
, XCAR (c
)))
3018 && !(EQ (Qswitch_frame
, XCAR (c
)))
3019 /* Don't wipe echo area for select window events: These might
3020 get delayed via `mouse-autoselect-window' (Bug#11304). */
3021 && !(EQ (Qselect_window
, XCAR (c
)))))
3023 if (!NILP (echo_area_buffer
[0]))
3025 safe_run_hooks (Qecho_area_clear_hook
);
3026 clear_message (1, 0);
3030 reread_for_input_method
:
3032 /* Pass this to the input method, if appropriate. */
3034 && ! NILP (Vinput_method_function
)
3035 /* Don't run the input method within a key sequence,
3036 after the first event of the key sequence. */
3037 && NILP (prev_event
)
3038 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
3041 ptrdiff_t key_count
;
3042 bool key_count_reset
;
3043 struct gcpro gcpro1
;
3044 ptrdiff_t count
= SPECPDL_INDEX ();
3046 /* Save the echo status. */
3047 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
3048 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
3049 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
3050 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
3053 if (before_command_restore_flag
)
3055 this_command_key_count
= before_command_key_count_1
;
3056 if (this_command_key_count
< this_single_command_key_start
)
3057 this_single_command_key_start
= this_command_key_count
;
3058 echo_truncate (before_command_echo_length_1
);
3059 before_command_restore_flag
= 0;
3063 /* Save the this_command_keys status. */
3064 key_count
= this_command_key_count
;
3065 key_count_reset
= this_command_key_count_reset
;
3068 keys
= Fcopy_sequence (this_command_keys
);
3073 /* Clear out this_command_keys. */
3074 this_command_key_count
= 0;
3075 this_command_key_count_reset
= 0;
3077 /* Now wipe the echo area. */
3078 if (!NILP (echo_area_buffer
[0]))
3079 safe_run_hooks (Qecho_area_clear_hook
);
3080 clear_message (1, 0);
3083 /* If we are not reading a key sequence,
3084 never use the echo area. */
3087 specbind (Qinput_method_use_echo_area
, Qt
);
3090 /* Call the input method. */
3091 tem
= call1 (Vinput_method_function
, c
);
3093 tem
= unbind_to (count
, tem
);
3095 /* Restore the saved echoing state
3096 and this_command_keys state. */
3097 this_command_key_count
= key_count
;
3098 this_command_key_count_reset
= key_count_reset
;
3100 this_command_keys
= keys
;
3103 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3104 kset_echo_string (current_kboard
, saved_echo_string
);
3105 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3106 if (saved_immediate_echo
)
3111 /* The input method can return no events. */
3114 /* Bring back the previous message, if any. */
3115 if (! NILP (previous_echo_area_message
))
3116 message_with_string ("%s", previous_echo_area_message
, 0);
3119 /* It returned one event or more. */
3121 Vunread_post_input_method_events
3122 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3127 /* Display help if not echoing. */
3128 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3130 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3131 Lisp_Object help
, object
, position
, window
, htem
;
3133 htem
= Fcdr (XCDR (c
));
3136 window
= Fcar (htem
);
3138 object
= Fcar (htem
);
3140 position
= Fcar (htem
);
3142 show_help_echo (help
, window
, object
, position
);
3144 /* We stopped being idle for this event; undo that. */
3146 timer_resume_idle ();
3150 if ((! reread
|| this_command_key_count
== 0
3151 || this_command_key_count_reset
)
3155 /* Don't echo mouse motion events. */
3156 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3157 && NILP (Fzerop (Vecho_keystrokes
))
3158 && ! (EVENT_HAS_PARAMETERS (c
)
3159 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3162 if (! NILP (also_record
))
3163 echo_char (also_record
);
3164 /* Once we reread a character, echoing can happen
3165 the next time we pause to read a new one. */
3166 ok_to_echo_at_next_pause
= current_kboard
;
3169 /* Record this character as part of the current key. */
3170 add_command_key (c
);
3171 if (! NILP (also_record
))
3172 add_command_key (also_record
);
3175 last_input_event
= c
;
3178 /* Process the help character specially if enabled. */
3179 if (!NILP (Vhelp_form
) && help_char_p (c
))
3181 ptrdiff_t count
= SPECPDL_INDEX ();
3183 help_form_saved_window_configs
3184 = Fcons (Fcurrent_window_configuration (Qnil
),
3185 help_form_saved_window_configs
);
3186 record_unwind_protect_void (read_char_help_form_unwind
);
3187 call0 (Qhelp_form_show
);
3192 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3193 if (EVENT_HAS_PARAMETERS (c
)
3194 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3195 XSETCAR (help_form_saved_window_configs
, Qnil
);
3197 while (BUFFERP (c
));
3198 /* Remove the help from the frame. */
3199 unbind_to (count
, Qnil
);
3202 if (EQ (c
, make_number (040)))
3206 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3207 while (BUFFERP (c
));
3216 /* Record a key that came from a mouse menu.
3217 Record it for echoing, for this-command-keys, and so on. */
3220 record_menu_key (Lisp_Object c
)
3222 /* Wipe the echo area. */
3223 clear_message (1, 0);
3228 before_command_key_count
= this_command_key_count
;
3229 before_command_echo_length
= echo_length ();
3232 /* Don't echo mouse motion events. */
3233 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3234 && NILP (Fzerop (Vecho_keystrokes
)))
3238 /* Once we reread a character, echoing can happen
3239 the next time we pause to read a new one. */
3240 ok_to_echo_at_next_pause
= 0;
3243 /* Record this character as part of the current key. */
3244 add_command_key (c
);
3246 /* Re-reading in the middle of a command */
3247 last_input_event
= c
;
3251 /* Return true if should recognize C as "the help character". */
3254 help_char_p (Lisp_Object c
)
3258 if (EQ (c
, Vhelp_char
))
3260 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3261 if (EQ (c
, XCAR (tail
)))
3266 /* Record the input event C in various ways. */
3269 record_char (Lisp_Object c
)
3273 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3275 /* To avoid filling recent_keys with help-echo and mouse-movement
3276 events, we filter out repeated help-echo events, only store the
3277 first and last in a series of mouse-movement events, and don't
3278 store repeated help-echo events which are only separated by
3279 mouse-movement events. */
3281 Lisp_Object ev1
, ev2
, ev3
;
3284 if ((ix1
= recent_keys_index
- 1) < 0)
3285 ix1
= NUM_RECENT_KEYS
- 1;
3286 ev1
= AREF (recent_keys
, ix1
);
3288 if ((ix2
= ix1
- 1) < 0)
3289 ix2
= NUM_RECENT_KEYS
- 1;
3290 ev2
= AREF (recent_keys
, ix2
);
3292 if ((ix3
= ix2
- 1) < 0)
3293 ix3
= NUM_RECENT_KEYS
- 1;
3294 ev3
= AREF (recent_keys
, ix3
);
3296 if (EQ (XCAR (c
), Qhelp_echo
))
3298 /* Don't record `help-echo' in recent_keys unless it shows some help
3299 message, and a different help than the previously recorded
3301 Lisp_Object help
, last_help
;
3303 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3304 if (!STRINGP (help
))
3306 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3307 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3309 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3310 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3311 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3313 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3314 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3315 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3316 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3319 else if (EQ (XCAR (c
), Qmouse_movement
))
3321 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3322 So additional mouse movement events replace the last element. */
3323 Lisp_Object last_window
, window
;
3325 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3326 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3327 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3328 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3329 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3331 ASET (recent_keys
, ix1
, c
);
3337 store_kbd_macro_char (c
);
3341 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3342 ASET (recent_keys
, recent_keys_index
, c
);
3343 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3344 recent_keys_index
= 0;
3346 else if (recorded
< 0)
3348 /* We need to remove one or two events from recent_keys.
3349 To do this, we simply put nil at those events and move the
3350 recent_keys_index backwards over those events. Usually,
3351 users will never see those nil events, as they will be
3352 overwritten by the command keys entered to see recent_keys
3355 while (recorded
++ < 0 && total_keys
> 0)
3357 if (total_keys
< NUM_RECENT_KEYS
)
3359 if (--recent_keys_index
< 0)
3360 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3361 ASET (recent_keys
, recent_keys_index
, Qnil
);
3365 num_nonmacro_input_events
++;
3367 /* Write c to the dribble file. If c is a lispy event, write
3368 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3369 If you, dear reader, have a better idea, you've got the source. :-) */
3375 if (XUINT (c
) < 0x100)
3376 putc (XUINT (c
), dribble
);
3378 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3382 Lisp_Object dribblee
;
3384 /* If it's a structured event, take the event header. */
3385 dribblee
= EVENT_HEAD (c
);
3387 if (SYMBOLP (dribblee
))
3389 putc ('<', dribble
);
3390 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3391 SBYTES (SYMBOL_NAME (dribblee
)),
3393 putc ('>', dribble
);
3402 /* Copy out or in the info on where C-g should throw to.
3403 This is used when running Lisp code from within get_char,
3404 in case get_char is called recursively.
3405 See read_process_output. */
3408 save_getcjmp (sys_jmp_buf temp
)
3410 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3414 restore_getcjmp (sys_jmp_buf temp
)
3416 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3419 /* Low level keyboard/mouse input.
3420 kbd_buffer_store_event places events in kbd_buffer, and
3421 kbd_buffer_get_event retrieves them. */
3423 /* Return true if there are any events in the queue that read-char
3424 would return. If this returns false, a read-char would block. */
3426 readable_events (int flags
)
3428 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3431 /* If the buffer contains only FOCUS_IN_EVENT events, and
3432 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3433 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3435 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3436 #ifdef USE_TOOLKIT_SCROLL_BARS
3437 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3441 struct input_event
*event
;
3443 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3450 #ifdef USE_TOOLKIT_SCROLL_BARS
3451 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3453 event
->kind
== FOCUS_IN_EVENT
)
3454 #ifdef USE_TOOLKIT_SCROLL_BARS
3455 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3456 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3457 && event
->part
== scroll_bar_handle
3458 && event
->modifiers
== 0)
3463 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3466 while (event
!= kbd_store_ptr
);
3472 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3473 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3477 if (current_kboard
->kbd_queue_has_data
)
3483 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3484 if (kb
->kbd_queue_has_data
)
3490 /* Set this for debugging, to have a way to get out */
3491 int stop_character EXTERNALLY_VISIBLE
;
3494 event_to_kboard (struct input_event
*event
)
3496 /* Not applicable for these special events. */
3497 if (event
->kind
== SELECTION_REQUEST_EVENT
3498 || event
->kind
== SELECTION_CLEAR_EVENT
)
3502 Lisp_Object obj
= event
->frame_or_window
;
3503 /* There are some events that set this field to nil or string. */
3505 obj
= WINDOW_FRAME (XWINDOW (obj
));
3506 /* Also ignore dead frames here. */
3507 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3508 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3513 /* Return the number of slots occupied in kbd_buffer. */
3516 kbd_buffer_nr_stored (void)
3518 return kbd_fetch_ptr
== kbd_store_ptr
3520 : (kbd_fetch_ptr
< kbd_store_ptr
3521 ? kbd_store_ptr
- kbd_fetch_ptr
3522 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3523 + (kbd_store_ptr
- kbd_buffer
)));
3525 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3528 kbd_buffer_store_event (register struct input_event
*event
)
3530 kbd_buffer_store_event_hold (event
, 0);
3533 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3535 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3536 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3537 Else, if EVENT is a quit event, store the quit event
3538 in HOLD_QUIT, and return (thus ignoring further events).
3540 This is used to postpone the processing of the quit event until all
3541 subsequent input events have been parsed (and discarded). */
3544 kbd_buffer_store_event_hold (register struct input_event
*event
,
3545 struct input_event
*hold_quit
)
3547 if (event
->kind
== NO_EVENT
)
3550 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3553 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3555 register int c
= event
->code
& 0377;
3557 if (event
->modifiers
& ctrl_modifier
)
3558 c
= make_ctrl_char (c
);
3560 c
|= (event
->modifiers
3561 & (meta_modifier
| alt_modifier
3562 | hyper_modifier
| super_modifier
));
3566 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3567 struct input_event
*sp
;
3569 if (single_kboard
&& kb
!= current_kboard
)
3572 (kb
, list2 (make_lispy_switch_frame (event
->frame_or_window
),
3574 kb
->kbd_queue_has_data
= 1;
3575 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3577 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3580 if (event_to_kboard (sp
) == kb
)
3582 sp
->kind
= NO_EVENT
;
3583 sp
->frame_or_window
= Qnil
;
3592 *hold_quit
= *event
;
3596 /* If this results in a quit_char being returned to Emacs as
3597 input, set Vlast_event_frame properly. If this doesn't
3598 get returned to Emacs as an event, the next event read
3599 will set Vlast_event_frame again, so this is safe to do. */
3603 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3605 focus
= event
->frame_or_window
;
3606 internal_last_event_frame
= focus
;
3607 Vlast_event_frame
= focus
;
3610 last_event_timestamp
= event
->timestamp
;
3612 handle_interrupt (0);
3616 if (c
&& c
== stop_character
)
3622 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3623 Just ignore the second one. */
3624 else if (event
->kind
== BUFFER_SWITCH_EVENT
3625 && kbd_fetch_ptr
!= kbd_store_ptr
3626 && ((kbd_store_ptr
== kbd_buffer
3627 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3628 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3631 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3632 kbd_store_ptr
= kbd_buffer
;
3634 /* Don't let the very last slot in the buffer become full,
3635 since that would make the two pointers equal,
3636 and that is indistinguishable from an empty buffer.
3637 Discard the event if it would fill the last slot. */
3638 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3640 *kbd_store_ptr
= *event
;
3643 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3645 /* Don't read keyboard input until we have processed kbd_buffer.
3646 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3647 hold_keyboard_input ();
3648 if (!noninteractive
)
3652 #endif /* subprocesses */
3655 /* If we're inside while-no-input, and this event qualifies
3656 as input, set quit-flag to cause an interrupt. */
3657 if (!NILP (Vthrow_on_input
)
3658 && event
->kind
!= FOCUS_IN_EVENT
3659 && event
->kind
!= HELP_EVENT
3660 && event
->kind
!= DEICONIFY_EVENT
)
3662 Vquit_flag
= Vthrow_on_input
;
3663 /* If we're inside a function that wants immediate quits,
3665 if (immediate_quit
&& NILP (Vinhibit_quit
))
3674 /* Put an input event back in the head of the event queue. */
3677 kbd_buffer_unget_event (register struct input_event
*event
)
3679 if (kbd_fetch_ptr
== kbd_buffer
)
3680 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3682 /* Don't let the very last slot in the buffer become full, */
3683 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3686 *kbd_fetch_ptr
= *event
;
3691 /* Generate a HELP_EVENT input_event and store it in the keyboard
3694 HELP is the help form.
3696 FRAME and WINDOW are the frame and window where the help is
3697 generated. OBJECT is the Lisp object where the help was found (a
3698 buffer, a string, an overlay, or nil if neither from a string nor
3699 from a buffer). POS is the position within OBJECT where the help
3703 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3704 Lisp_Object object
, ptrdiff_t pos
)
3706 struct input_event event
;
3710 event
.kind
= HELP_EVENT
;
3711 event
.frame_or_window
= frame
;
3713 event
.x
= WINDOWP (window
) ? window
: frame
;
3716 kbd_buffer_store_event (&event
);
3720 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3723 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3725 struct input_event event
;
3727 event
.kind
= HELP_EVENT
;
3728 event
.frame_or_window
= frame
;
3733 kbd_buffer_store_event (&event
);
3737 /* Discard any mouse events in the event buffer by setting them to
3740 discard_mouse_events (void)
3742 struct input_event
*sp
;
3743 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3745 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3748 if (sp
->kind
== MOUSE_CLICK_EVENT
3749 || sp
->kind
== WHEEL_EVENT
3750 || sp
->kind
== HORIZ_WHEEL_EVENT
3752 || sp
->kind
== GPM_CLICK_EVENT
3754 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3756 sp
->kind
= NO_EVENT
;
3762 /* Return true if there are any real events waiting in the event
3763 buffer, not counting `NO_EVENT's.
3765 Discard NO_EVENT events at the front of the input queue, possibly
3766 leaving the input queue empty if there are no real input events. */
3769 kbd_buffer_events_waiting (void)
3771 struct input_event
*sp
;
3773 for (sp
= kbd_fetch_ptr
;
3774 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3777 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3782 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3786 /* Clear input event EVENT. */
3789 clear_event (struct input_event
*event
)
3791 event
->kind
= NO_EVENT
;
3795 /* Read one event from the event buffer, waiting if necessary.
3796 The value is a Lisp object representing the event.
3797 The value is nil for an event that should be ignored,
3798 or that was handled here.
3799 We always read and discard one event. */
3802 kbd_buffer_get_event (KBOARD
**kbp
,
3803 bool *used_mouse_menu
,
3804 EMACS_TIME
*end_time
)
3809 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3811 /* Start reading input again because we have processed enough to
3812 be able to accept new events again. */
3813 unhold_keyboard_input ();
3816 #endif /* subprocesses */
3818 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3820 /* In case we are running as a daemon, only do this before
3821 detaching from the terminal. */
3822 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3826 *kbp
= current_kboard
;
3829 #endif /* ! HAVE_DBUS */
3831 /* Wait until there is input available. */
3834 /* Break loop if there's an unread command event. Needed in
3835 moused window autoselection which uses a timer to insert such
3837 if (CONSP (Vunread_command_events
))
3840 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3842 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3845 /* If the quit flag is set, then read_char will return
3846 quit_char, so that counts as "available input." */
3847 if (!NILP (Vquit_flag
))
3848 quit_throw_to_read_char (0);
3850 /* One way or another, wait until input is available; then, if
3851 interrupt handlers have not read it, read it now. */
3856 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3858 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3862 EMACS_TIME now
= current_emacs_time ();
3863 if (EMACS_TIME_LE (*end_time
, now
))
3864 return Qnil
; /* Finished waiting. */
3867 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3868 wait_reading_process_output (min (EMACS_SECS (duration
),
3870 EMACS_NSECS (duration
),
3871 -1, 1, Qnil
, NULL
, 0);
3875 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3877 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3881 if (CONSP (Vunread_command_events
))
3884 first
= XCAR (Vunread_command_events
);
3885 Vunread_command_events
= XCDR (Vunread_command_events
);
3886 *kbp
= current_kboard
;
3890 /* At this point, we know that there is a readable event available
3891 somewhere. If the event queue is empty, then there must be a
3892 mouse movement enabled and available. */
3893 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3895 struct input_event
*event
;
3897 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3901 last_event_timestamp
= event
->timestamp
;
3903 *kbp
= event_to_kboard (event
);
3905 *kbp
= current_kboard
; /* Better than returning null ptr? */
3909 /* These two kinds of events get special handling
3910 and don't actually appear to the command loop.
3911 We return nil for them. */
3912 if (event
->kind
== SELECTION_REQUEST_EVENT
3913 || event
->kind
== SELECTION_CLEAR_EVENT
)
3916 struct input_event copy
;
3918 /* Remove it from the buffer before processing it,
3919 since otherwise swallow_events will see it
3920 and process it again. */
3922 kbd_fetch_ptr
= event
+ 1;
3923 input_pending
= readable_events (0);
3924 x_handle_selection_event (©
);
3926 /* We're getting selection request events, but we don't have
3932 #if defined (HAVE_NS)
3933 else if (event
->kind
== NS_TEXT_EVENT
)
3935 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3936 obj
= list1 (intern ("ns-put-working-text"));
3938 obj
= list1 (intern ("ns-unput-working-text"));
3939 kbd_fetch_ptr
= event
+ 1;
3940 if (used_mouse_menu
)
3941 *used_mouse_menu
= 1;
3945 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3946 || defined (HAVE_NS)
3947 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3949 /* Make an event (delete-frame (FRAME)). */
3950 obj
= list2 (Qdelete_frame
, list1 (event
->frame_or_window
));
3951 kbd_fetch_ptr
= event
+ 1;
3954 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3955 || defined (HAVE_NS)
3956 else if (event
->kind
== ICONIFY_EVENT
)
3958 /* Make an event (iconify-frame (FRAME)). */
3959 obj
= list2 (Qiconify_frame
, list1 (event
->frame_or_window
));
3960 kbd_fetch_ptr
= event
+ 1;
3962 else if (event
->kind
== DEICONIFY_EVENT
)
3964 /* Make an event (make-frame-visible (FRAME)). */
3965 obj
= list2 (Qmake_frame_visible
, list1 (event
->frame_or_window
));
3966 kbd_fetch_ptr
= event
+ 1;
3969 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3971 /* The value doesn't matter here; only the type is tested. */
3972 XSETBUFFER (obj
, current_buffer
);
3973 kbd_fetch_ptr
= event
+ 1;
3975 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3976 || defined (HAVE_NS) || defined (USE_GTK)
3977 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3979 kbd_fetch_ptr
= event
+ 1;
3980 input_pending
= readable_events (0);
3981 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3982 x_activate_menubar (XFRAME (event
->frame_or_window
));
3986 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3988 /* Make an event (language-change FRAME CODEPAGE LANGUAGE-ID). */
3989 obj
= list4 (Qlanguage_change
,
3990 event
->frame_or_window
,
3991 make_number (event
->code
),
3992 make_number (event
->modifiers
));
3993 kbd_fetch_ptr
= event
+ 1;
3996 #ifdef USE_FILE_NOTIFY
3997 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3999 #ifdef HAVE_W32NOTIFY
4000 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
4001 obj
= list3 (Qfile_notify
,
4002 list3 (make_number (event
->code
),
4005 event
->frame_or_window
);
4007 obj
= make_lispy_event (event
);
4009 kbd_fetch_ptr
= event
+ 1;
4011 #endif /* USE_FILE_NOTIFY */
4012 else if (event
->kind
== SAVE_SESSION_EVENT
)
4014 obj
= list2 (Qsave_session
, event
->arg
);
4015 kbd_fetch_ptr
= event
+ 1;
4017 /* Just discard these, by returning nil.
4018 With MULTI_KBOARD, these events are used as placeholders
4019 when we need to randomly delete events from the queue.
4020 (They shouldn't otherwise be found in the buffer,
4021 but on some machines it appears they do show up
4022 even without MULTI_KBOARD.) */
4023 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
4024 mouse events during a popup-menu call. */
4025 else if (event
->kind
== NO_EVENT
)
4026 kbd_fetch_ptr
= event
+ 1;
4027 else if (event
->kind
== HELP_EVENT
)
4029 Lisp_Object object
, position
, help
, frame
, window
;
4031 frame
= event
->frame_or_window
;
4032 object
= event
->arg
;
4033 position
= make_number (event
->code
);
4036 clear_event (event
);
4038 kbd_fetch_ptr
= event
+ 1;
4039 if (!WINDOWP (window
))
4041 obj
= Fcons (Qhelp_echo
,
4042 list5 (frame
, help
, window
, object
, position
));
4044 else if (event
->kind
== FOCUS_IN_EVENT
)
4046 /* Notification of a FocusIn event. The frame receiving the
4047 focus is in event->frame_or_window. Generate a
4048 switch-frame event if necessary. */
4049 Lisp_Object frame
, focus
;
4051 frame
= event
->frame_or_window
;
4052 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4061 !EQ (frame
, internal_last_event_frame
)
4062 && !EQ (frame
, selected_frame
))
4063 obj
= make_lispy_switch_frame (frame
);
4065 obj
= make_lispy_focus_in (frame
);
4067 internal_last_event_frame
= frame
;
4068 kbd_fetch_ptr
= event
+ 1;
4070 else if (event
->kind
== FOCUS_OUT_EVENT
)
4072 #ifdef HAVE_WINDOW_SYSTEM
4075 Lisp_Object frame
= event
->frame_or_window
;
4076 bool focused
= false;
4078 for (di
= x_display_list
; di
&& ! focused
; di
= di
->next
)
4079 focused
= di
->x_highlight_frame
!= 0;
4082 obj
= make_lispy_focus_out (frame
);
4084 #endif /* HAVE_WINDOW_SYSTEM */
4086 kbd_fetch_ptr
= event
+ 1;
4089 else if (event
->kind
== DBUS_EVENT
)
4091 obj
= make_lispy_event (event
);
4092 kbd_fetch_ptr
= event
+ 1;
4095 #ifdef HAVE_XWIDGETS
4096 else if (event
->kind
== XWIDGET_EVENT
)
4098 obj
= make_lispy_event (event
);
4099 kbd_fetch_ptr
= event
+ 1;
4103 else if (event
->kind
== FILE_NOTIFY_EVENT
)
4105 obj
= make_lispy_event (event
);
4106 kbd_fetch_ptr
= event
+ 1;
4109 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
4111 obj
= make_lispy_event (event
);
4112 kbd_fetch_ptr
= event
+ 1;
4116 /* If this event is on a different frame, return a switch-frame this
4117 time, and leave the event in the queue for next time. */
4121 frame
= event
->frame_or_window
;
4123 frame
= XCAR (frame
);
4124 else if (WINDOWP (frame
))
4125 frame
= WINDOW_FRAME (XWINDOW (frame
));
4127 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4131 if (! EQ (frame
, internal_last_event_frame
)
4132 && !EQ (frame
, selected_frame
))
4133 obj
= make_lispy_switch_frame (frame
);
4134 internal_last_event_frame
= frame
;
4136 /* If we didn't decide to make a switch-frame event, go ahead
4137 and build a real event from the queue entry. */
4141 obj
= make_lispy_event (event
);
4143 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4144 || defined (HAVE_NS) || defined (USE_GTK)
4145 /* If this was a menu selection, then set the flag to inhibit
4146 writing to last_nonmenu_event. Don't do this if the event
4147 we're returning is (menu-bar), though; that indicates the
4148 beginning of the menu sequence, and we might as well leave
4149 that as the `event with parameters' for this selection. */
4151 && !EQ (event
->frame_or_window
, event
->arg
)
4152 && (event
->kind
== MENU_BAR_EVENT
4153 || event
->kind
== TOOL_BAR_EVENT
))
4154 *used_mouse_menu
= 1;
4157 /* Certain system events are non-key events. */
4159 && event
->kind
== NS_NONKEY_EVENT
)
4160 *used_mouse_menu
= 1;
4163 /* Wipe out this event, to catch bugs. */
4164 clear_event (event
);
4165 kbd_fetch_ptr
= event
+ 1;
4169 /* Try generating a mouse motion event. */
4170 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4172 struct frame
*f
= some_mouse_moved ();
4173 Lisp_Object bar_window
;
4174 enum scroll_bar_part part
;
4178 *kbp
= current_kboard
;
4179 /* Note that this uses F to determine which terminal to look at.
4180 If there is no valid info, it does not store anything
4181 so x remains nil. */
4184 /* XXX Can f or mouse_position_hook be NULL here? */
4185 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4186 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4191 /* Decide if we should generate a switch-frame event. Don't
4192 generate switch-frame events for motion outside of all Emacs
4198 frame
= FRAME_FOCUS_FRAME (f
);
4200 XSETFRAME (frame
, f
);
4202 if (! EQ (frame
, internal_last_event_frame
)
4203 && !EQ (frame
, selected_frame
))
4204 obj
= make_lispy_switch_frame (frame
);
4205 internal_last_event_frame
= frame
;
4208 /* If we didn't decide to make a switch-frame event, go ahead and
4209 return a mouse-motion event. */
4210 if (!NILP (x
) && NILP (obj
))
4211 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4214 /* We were promised by the above while loop that there was
4215 something for us to read! */
4218 input_pending
= readable_events (0);
4220 Vlast_event_frame
= internal_last_event_frame
;
4225 /* Process any non-user-visible events (currently X selection events),
4226 without reading any user-visible events. */
4229 process_special_events (void)
4231 struct input_event
*event
;
4233 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4235 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4238 if (event
== kbd_store_ptr
)
4242 /* If we find a stored X selection request, handle it now. */
4243 if (event
->kind
== SELECTION_REQUEST_EVENT
4244 || event
->kind
== SELECTION_CLEAR_EVENT
)
4248 /* Remove the event from the fifo buffer before processing;
4249 otherwise swallow_events called recursively could see it
4250 and process it again. To do this, we move the events
4251 between kbd_fetch_ptr and EVENT one slot to the right,
4254 struct input_event copy
= *event
;
4255 struct input_event
*beg
4256 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4257 ? kbd_buffer
: kbd_fetch_ptr
;
4260 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4261 else if (event
< beg
)
4263 if (event
> kbd_buffer
)
4264 memmove (kbd_buffer
+ 1, kbd_buffer
,
4265 (event
- kbd_buffer
) * sizeof (struct input_event
));
4266 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4267 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4268 memmove (beg
+ 1, beg
,
4269 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4270 * sizeof (struct input_event
));
4273 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4274 kbd_fetch_ptr
= kbd_buffer
+ 1;
4278 /* X wants last_event_timestamp for selection ownership. */
4279 last_event_timestamp
= copy
.timestamp
;
4280 input_pending
= readable_events (0);
4281 x_handle_selection_event (©
);
4283 /* We're getting selection request events, but we don't have
4291 /* Process any events that are not user-visible, run timer events that
4292 are ripe, and return, without reading any user-visible events. */
4295 swallow_events (bool do_display
)
4297 unsigned old_timers_run
;
4299 process_special_events ();
4301 old_timers_run
= timers_run
;
4302 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4304 if (timers_run
!= old_timers_run
&& do_display
)
4305 redisplay_preserve_echo_area (7);
4308 /* Record the start of when Emacs is idle,
4309 for the sake of running idle-time timers. */
4312 timer_start_idle (void)
4314 /* If we are already in the idle state, do nothing. */
4315 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4318 timer_idleness_start_time
= current_emacs_time ();
4319 timer_last_idleness_start_time
= timer_idleness_start_time
;
4321 /* Mark all idle-time timers as once again candidates for running. */
4322 call0 (intern ("internal-timer-start-idle"));
4325 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4328 timer_stop_idle (void)
4330 timer_idleness_start_time
= invalid_emacs_time ();
4333 /* Resume idle timer from last idle start time. */
4336 timer_resume_idle (void)
4338 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4341 timer_idleness_start_time
= timer_last_idleness_start_time
;
4344 /* This is only for debugging. */
4345 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4347 /* List of elisp functions to call, delayed because they were generated in
4348 a context where Elisp could not be safely run (e.g. redisplay, signal,
4349 ...). Each element has the form (FUN . ARGS). */
4350 Lisp_Object pending_funcalls
;
4352 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4354 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4356 Lisp_Object
*vector
;
4358 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4360 vector
= XVECTOR (timer
)->contents
;
4361 if (! NILP (vector
[0]))
4364 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4369 /* Check whether a timer has fired. To prevent larger problems we simply
4370 disregard elements that are not proper timers. Do not make a circular
4371 timer list for the time being.
4373 Returns the time to wait until the next timer fires. If a
4374 timer is triggering now, return zero.
4375 If no timer is active, return -1.
4377 If a timer is ripe, we run it, with quitting turned off.
4378 In that case we return 0 to indicate that a new timer_check_2 call
4382 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4384 EMACS_TIME nexttime
;
4386 EMACS_TIME idleness_now
;
4387 Lisp_Object chosen_timer
;
4388 struct gcpro gcpro1
;
4390 nexttime
= invalid_emacs_time ();
4392 chosen_timer
= Qnil
;
4393 GCPRO1 (chosen_timer
);
4395 /* First run the code that was delayed. */
4396 while (CONSP (pending_funcalls
))
4398 Lisp_Object funcall
= XCAR (pending_funcalls
);
4399 pending_funcalls
= XCDR (pending_funcalls
);
4400 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4403 if (CONSP (timers
) || CONSP (idle_timers
))
4405 now
= current_emacs_time ();
4406 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4407 ? sub_emacs_time (now
, timer_idleness_start_time
)
4408 : make_emacs_time (0, 0));
4411 while (CONSP (timers
) || CONSP (idle_timers
))
4413 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4414 EMACS_TIME timer_time
, idle_timer_time
;
4415 EMACS_TIME difference
;
4416 EMACS_TIME timer_difference
= invalid_emacs_time ();
4417 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4418 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4420 /* Set TIMER and TIMER_DIFFERENCE
4421 based on the next ordinary timer.
4422 TIMER_DIFFERENCE is the distance in time from NOW to when
4423 this timer becomes ripe (negative if it's already ripe).
4424 Skip past invalid timers and timers already handled. */
4427 timer
= XCAR (timers
);
4428 if (! decode_timer (timer
, &timer_time
))
4430 timers
= XCDR (timers
);
4434 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4435 timer_difference
= (timer_ripe
4436 ? sub_emacs_time (now
, timer_time
)
4437 : sub_emacs_time (timer_time
, now
));
4440 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4441 based on the next idle timer. */
4442 if (CONSP (idle_timers
))
4444 idle_timer
= XCAR (idle_timers
);
4445 if (! decode_timer (idle_timer
, &idle_timer_time
))
4447 idle_timers
= XCDR (idle_timers
);
4451 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4452 idle_timer_difference
4454 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4455 : sub_emacs_time (idle_timer_time
, idleness_now
));
4458 /* Decide which timer is the next timer,
4459 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4460 Also step down the list where we found that timer. */
4462 if (EMACS_TIME_VALID_P (timer_difference
)
4463 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4464 || idle_timer_ripe
< timer_ripe
4465 || (idle_timer_ripe
== timer_ripe
4467 ? EMACS_TIME_LT (idle_timer_difference
,
4469 : EMACS_TIME_LT (timer_difference
,
4470 idle_timer_difference
)))))
4472 chosen_timer
= timer
;
4473 timers
= XCDR (timers
);
4474 difference
= timer_difference
;
4479 chosen_timer
= idle_timer
;
4480 idle_timers
= XCDR (idle_timers
);
4481 difference
= idle_timer_difference
;
4482 ripe
= idle_timer_ripe
;
4485 /* If timer is ripe, run it if it hasn't been run. */
4488 if (NILP (AREF (chosen_timer
, 0)))
4490 ptrdiff_t count
= SPECPDL_INDEX ();
4491 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4493 /* Mark the timer as triggered to prevent problems if the lisp
4494 code fails to reschedule it right. */
4495 ASET (chosen_timer
, 0, Qt
);
4497 specbind (Qinhibit_quit
, Qt
);
4499 call1 (Qtimer_event_handler
, chosen_timer
);
4500 Vdeactivate_mark
= old_deactivate_mark
;
4502 unbind_to (count
, Qnil
);
4504 /* Since we have handled the event,
4505 we don't need to tell the caller to wake up and do it. */
4506 /* But the caller must still wait for the next timer, so
4507 return 0 to indicate that. */
4510 nexttime
= make_emacs_time (0, 0);
4514 /* When we encounter a timer that is still waiting,
4515 return the amount of time to wait before it is ripe. */
4522 /* No timers are pending in the future. */
4523 /* Return 0 if we generated an event, and -1 if not. */
4529 /* Check whether a timer has fired. To prevent larger problems we simply
4530 disregard elements that are not proper timers. Do not make a circular
4531 timer list for the time being.
4533 Returns the time to wait until the next timer fires.
4534 If no timer is active, return an invalid value.
4536 As long as any timer is ripe, we run it. */
4541 EMACS_TIME nexttime
;
4542 Lisp_Object timers
, idle_timers
;
4543 struct gcpro gcpro1
, gcpro2
;
4545 Lisp_Object tem
= Vinhibit_quit
;
4548 /* We use copies of the timers' lists to allow a timer to add itself
4549 again, without locking up Emacs if the newly added timer is
4550 already ripe when added. */
4552 /* Always consider the ordinary timers. */
4553 timers
= Fcopy_sequence (Vtimer_list
);
4554 /* Consider the idle timers only if Emacs is idle. */
4555 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4556 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4560 Vinhibit_quit
= tem
;
4562 GCPRO2 (timers
, idle_timers
);
4566 nexttime
= timer_check_2 (timers
, idle_timers
);
4568 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4574 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4575 doc
: /* Return the current length of Emacs idleness, or nil.
4576 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4577 in the same style as (current-time).
4579 The value when Emacs is not idle is nil.
4581 PSEC is a multiple of the system clock resolution. */)
4584 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4585 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4586 timer_idleness_start_time
));
4591 /* Caches for modify_event_symbol. */
4592 static Lisp_Object accent_key_syms
;
4593 static Lisp_Object func_key_syms
;
4594 static Lisp_Object mouse_syms
;
4595 static Lisp_Object wheel_syms
;
4596 static Lisp_Object drag_n_drop_syms
;
4598 /* This is a list of keysym codes for special "accent" characters.
4599 It parallels lispy_accent_keys. */
4601 static const int lispy_accent_codes
[] =
4603 #ifdef XK_dead_circumflex
4608 #ifdef XK_dead_grave
4613 #ifdef XK_dead_tilde
4618 #ifdef XK_dead_diaeresis
4623 #ifdef XK_dead_macron
4628 #ifdef XK_dead_degree
4633 #ifdef XK_dead_acute
4638 #ifdef XK_dead_cedilla
4643 #ifdef XK_dead_breve
4648 #ifdef XK_dead_ogonek
4653 #ifdef XK_dead_caron
4658 #ifdef XK_dead_doubleacute
4659 XK_dead_doubleacute
,
4663 #ifdef XK_dead_abovedot
4668 #ifdef XK_dead_abovering
4678 #ifdef XK_dead_belowdot
4683 #ifdef XK_dead_voiced_sound
4684 XK_dead_voiced_sound
,
4688 #ifdef XK_dead_semivoiced_sound
4689 XK_dead_semivoiced_sound
,
4705 /* This is a list of Lisp names for special "accent" characters.
4706 It parallels lispy_accent_codes. */
4708 static const char *const lispy_accent_keys
[] =
4726 "dead-voiced-sound",
4727 "dead-semivoiced-sound",
4733 #define FUNCTION_KEY_OFFSET 0x0
4735 const char *const lispy_function_keys
[] =
4739 0, /* VK_LBUTTON 0x01 */
4740 0, /* VK_RBUTTON 0x02 */
4741 "cancel", /* VK_CANCEL 0x03 */
4742 0, /* VK_MBUTTON 0x04 */
4744 0, 0, 0, /* 0x05 .. 0x07 */
4746 "backspace", /* VK_BACK 0x08 */
4747 "tab", /* VK_TAB 0x09 */
4749 0, 0, /* 0x0A .. 0x0B */
4751 "clear", /* VK_CLEAR 0x0C */
4752 "return", /* VK_RETURN 0x0D */
4754 0, 0, /* 0x0E .. 0x0F */
4756 0, /* VK_SHIFT 0x10 */
4757 0, /* VK_CONTROL 0x11 */
4758 0, /* VK_MENU 0x12 */
4759 "pause", /* VK_PAUSE 0x13 */
4760 "capslock", /* VK_CAPITAL 0x14 */
4761 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4763 "junja", /* VK_JUNJA 0x17 */
4764 "final", /* VK_FINAL 0x18 */
4765 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4767 "escape", /* VK_ESCAPE 0x1B */
4768 "convert", /* VK_CONVERT 0x1C */
4769 "non-convert", /* VK_NONCONVERT 0x1D */
4770 "accept", /* VK_ACCEPT 0x1E */
4771 "mode-change", /* VK_MODECHANGE 0x1F */
4772 0, /* VK_SPACE 0x20 */
4773 "prior", /* VK_PRIOR 0x21 */
4774 "next", /* VK_NEXT 0x22 */
4775 "end", /* VK_END 0x23 */
4776 "home", /* VK_HOME 0x24 */
4777 "left", /* VK_LEFT 0x25 */
4778 "up", /* VK_UP 0x26 */
4779 "right", /* VK_RIGHT 0x27 */
4780 "down", /* VK_DOWN 0x28 */
4781 "select", /* VK_SELECT 0x29 */
4782 "print", /* VK_PRINT 0x2A */
4783 "execute", /* VK_EXECUTE 0x2B */
4784 "snapshot", /* VK_SNAPSHOT 0x2C */
4785 "insert", /* VK_INSERT 0x2D */
4786 "delete", /* VK_DELETE 0x2E */
4787 "help", /* VK_HELP 0x2F */
4789 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4791 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4793 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4795 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4797 0, 0, 0, 0, 0, 0, 0, 0, 0,
4798 0, 0, 0, 0, 0, 0, 0, 0, 0,
4799 0, 0, 0, 0, 0, 0, 0, 0,
4801 "lwindow", /* VK_LWIN 0x5B */
4802 "rwindow", /* VK_RWIN 0x5C */
4803 "apps", /* VK_APPS 0x5D */
4806 "kp-0", /* VK_NUMPAD0 0x60 */
4807 "kp-1", /* VK_NUMPAD1 0x61 */
4808 "kp-2", /* VK_NUMPAD2 0x62 */
4809 "kp-3", /* VK_NUMPAD3 0x63 */
4810 "kp-4", /* VK_NUMPAD4 0x64 */
4811 "kp-5", /* VK_NUMPAD5 0x65 */
4812 "kp-6", /* VK_NUMPAD6 0x66 */
4813 "kp-7", /* VK_NUMPAD7 0x67 */
4814 "kp-8", /* VK_NUMPAD8 0x68 */
4815 "kp-9", /* VK_NUMPAD9 0x69 */
4816 "kp-multiply", /* VK_MULTIPLY 0x6A */
4817 "kp-add", /* VK_ADD 0x6B */
4818 "kp-separator", /* VK_SEPARATOR 0x6C */
4819 "kp-subtract", /* VK_SUBTRACT 0x6D */
4820 "kp-decimal", /* VK_DECIMAL 0x6E */
4821 "kp-divide", /* VK_DIVIDE 0x6F */
4822 "f1", /* VK_F1 0x70 */
4823 "f2", /* VK_F2 0x71 */
4824 "f3", /* VK_F3 0x72 */
4825 "f4", /* VK_F4 0x73 */
4826 "f5", /* VK_F5 0x74 */
4827 "f6", /* VK_F6 0x75 */
4828 "f7", /* VK_F7 0x76 */
4829 "f8", /* VK_F8 0x77 */
4830 "f9", /* VK_F9 0x78 */
4831 "f10", /* VK_F10 0x79 */
4832 "f11", /* VK_F11 0x7A */
4833 "f12", /* VK_F12 0x7B */
4834 "f13", /* VK_F13 0x7C */
4835 "f14", /* VK_F14 0x7D */
4836 "f15", /* VK_F15 0x7E */
4837 "f16", /* VK_F16 0x7F */
4838 "f17", /* VK_F17 0x80 */
4839 "f18", /* VK_F18 0x81 */
4840 "f19", /* VK_F19 0x82 */
4841 "f20", /* VK_F20 0x83 */
4842 "f21", /* VK_F21 0x84 */
4843 "f22", /* VK_F22 0x85 */
4844 "f23", /* VK_F23 0x86 */
4845 "f24", /* VK_F24 0x87 */
4847 0, 0, 0, 0, /* 0x88 .. 0x8B */
4848 0, 0, 0, 0, /* 0x8C .. 0x8F */
4850 "kp-numlock", /* VK_NUMLOCK 0x90 */
4851 "scroll", /* VK_SCROLL 0x91 */
4852 /* Not sure where the following block comes from.
4853 Windows headers have NEC and Fujitsu specific keys in
4854 this block, but nothing generic. */
4855 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4856 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4857 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4858 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4859 "kp-end", /* VK_NUMPAD_END 0x96 */
4860 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4861 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4862 "kp-up", /* VK_NUMPAD_UP 0x99 */
4863 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4864 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4865 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4866 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4868 0, 0, /* 0x9E .. 0x9F */
4871 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4872 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4873 * No other API or message will distinguish left and right keys this way.
4878 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4879 to enable them selectively, and gives access to a few more functions.
4880 See lispy_multimedia_keys below. */
4881 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4882 0, 0, 0, /* 0xAD .. 0xAF Volume */
4883 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4884 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4886 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4887 0, 0, 0, 0, 0, 0, 0, 0, 0,
4889 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4890 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4891 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4894 "ax", /* VK_OEM_AX 0xE1 */
4895 0, /* VK_OEM_102 0xE2 */
4896 "ico-help", /* VK_ICO_HELP 0xE3 */
4897 "ico-00", /* VK_ICO_00 0xE4 */
4898 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4899 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4900 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4902 "reset", /* VK_OEM_RESET 0xE9 */
4903 "jump", /* VK_OEM_JUMP 0xEA */
4904 "oem-pa1", /* VK_OEM_PA1 0xEB */
4905 "oem-pa2", /* VK_OEM_PA2 0xEC */
4906 "oem-pa3", /* VK_OEM_PA3 0xED */
4907 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4908 "cusel", /* VK_OEM_CUSEL 0xEF */
4909 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4910 "finish", /* VK_OEM_FINISH 0xF1 */
4911 "copy", /* VK_OEM_COPY 0xF2 */
4912 "auto", /* VK_OEM_AUTO 0xF3 */
4913 "enlw", /* VK_OEM_ENLW 0xF4 */
4914 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4915 "attn", /* VK_ATTN 0xF6 */
4916 "crsel", /* VK_CRSEL 0xF7 */
4917 "exsel", /* VK_EXSEL 0xF8 */
4918 "ereof", /* VK_EREOF 0xF9 */
4919 "play", /* VK_PLAY 0xFA */
4920 "zoom", /* VK_ZOOM 0xFB */
4921 "noname", /* VK_NONAME 0xFC */
4922 "pa1", /* VK_PA1 0xFD */
4923 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4927 /* Some of these duplicate the "Media keys" on newer keyboards,
4928 but they are delivered to the application in a different way. */
4929 static const char *const lispy_multimedia_keys
[] =
4937 "browser-favorites",
4974 "toggle-dictate-command",
4980 "media-fast-forward",
4983 "media-channel-down"
4986 #else /* not HAVE_NTGUI */
4988 /* This should be dealt with in XTread_socket now, and that doesn't
4989 depend on the client system having the Kana syms defined. See also
4990 the XK_kana_A case below. */
4993 static const char *const lispy_kana_keys
[] =
4995 /* X Keysym value */
4996 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4997 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4998 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4999 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
5000 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
5001 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
5002 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
5003 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
5004 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
5005 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
5006 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
5007 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
5008 "kana-i", "kana-u", "kana-e", "kana-o",
5009 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
5010 "prolongedsound", "kana-A", "kana-I", "kana-U",
5011 "kana-E", "kana-O", "kana-KA", "kana-KI",
5012 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
5013 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
5014 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
5015 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
5016 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
5017 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
5018 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
5019 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
5020 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
5021 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
5022 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
5023 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
5025 #endif /* XK_kana_A */
5028 #define FUNCTION_KEY_OFFSET 0xff00
5030 /* You'll notice that this table is arranged to be conveniently
5031 indexed by X Windows keysym values. */
5032 static const char *const lispy_function_keys
[] =
5034 /* X Keysym value */
5036 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
5037 "backspace", "tab", "linefeed", "clear",
5039 0, 0, 0, "pause", /* 0xff10...1f */
5040 0, 0, 0, 0, 0, 0, 0, "escape",
5042 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
5043 "romaji", "hiragana", "katakana", "hiragana-katakana",
5044 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
5045 "massyo", "kana-lock", "kana-shift", "eisu-shift",
5046 "eisu-toggle", /* 0xff30...3f */
5047 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
5048 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
5050 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
5051 "down", "prior", "next", "end",
5052 "begin", 0, 0, 0, 0, 0, 0, 0,
5053 "select", /* 0xff60 */ /* IsMiscFunctionKey */
5064 "break", /* 0xff6b */
5067 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
5068 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
5069 "kp-space", /* 0xff80 */ /* IsKeypadKey */
5070 0, 0, 0, 0, 0, 0, 0, 0,
5071 "kp-tab", /* 0xff89 */
5073 "kp-enter", /* 0xff8d */
5075 "kp-f1", /* 0xff91 */
5079 "kp-home", /* 0xff95 */
5084 "kp-prior", /* kp-page-up */
5085 "kp-next", /* kp-page-down */
5091 0, 0, 0, 0, 0, 0, 0, 0, 0,
5092 "kp-multiply", /* 0xffaa */
5097 "kp-divide", /* 0xffaf */
5098 "kp-0", /* 0xffb0 */
5099 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
5102 "kp-equal", /* 0xffbd */
5103 "f1", /* 0xffbe */ /* IsFunctionKey */
5105 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5106 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5107 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5108 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5109 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5110 0, 0, 0, 0, 0, 0, 0, 0,
5111 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5112 0, 0, 0, 0, 0, 0, 0, "delete"
5115 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5116 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5118 static const char *const iso_lispy_function_keys
[] =
5120 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5121 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5122 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5123 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5124 "iso-lefttab", /* 0xfe20 */
5125 "iso-move-line-up", "iso-move-line-down",
5126 "iso-partial-line-up", "iso-partial-line-down",
5127 "iso-partial-space-left", "iso-partial-space-right",
5128 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5129 "iso-release-margin-left", "iso-release-margin-right",
5130 "iso-release-both-margins",
5131 "iso-fast-cursor-left", "iso-fast-cursor-right",
5132 "iso-fast-cursor-up", "iso-fast-cursor-down",
5133 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5134 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5137 #endif /* not HAVE_NTGUI */
5139 static Lisp_Object Vlispy_mouse_stem
;
5141 static const char *const lispy_wheel_names
[] =
5143 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5146 /* drag-n-drop events are generated when a set of selected files are
5147 dragged from another application and dropped onto an Emacs window. */
5148 static const char *const lispy_drag_n_drop_names
[] =
5153 /* Scroll bar parts. */
5154 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5155 Lisp_Object Qup
, Qdown
, Qbottom
;
5156 static Lisp_Object Qend_scroll
;
5158 static Lisp_Object Qratio
;
5160 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5161 static Lisp_Object
*const scroll_bar_parts
[] = {
5162 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5163 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5166 /* A vector, indexed by button number, giving the down-going location
5167 of currently depressed buttons, both scroll bar and non-scroll bar.
5169 The elements have the form
5170 (BUTTON-NUMBER MODIFIER-MASK . REST)
5171 where REST is the cdr of a position as it would be reported in the event.
5173 The make_lispy_event function stores positions here to tell the
5174 difference between click and drag events, and to store the starting
5175 location to be included in drag events. */
5177 static Lisp_Object button_down_location
;
5179 /* Information about the most recent up-going button event: Which
5180 button, what location, and what time. */
5182 static int last_mouse_button
;
5183 static int last_mouse_x
;
5184 static int last_mouse_y
;
5185 static Time button_down_time
;
5187 /* The number of clicks in this multiple-click. */
5189 static int double_click_count
;
5191 /* X and Y are frame-relative coordinates for a click or wheel event.
5192 Return a Lisp-style event list. */
5195 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5198 enum window_part part
;
5199 Lisp_Object posn
= Qnil
;
5200 Lisp_Object extra_info
= Qnil
;
5201 /* Coordinate pixel positions to return. */
5202 int xret
= 0, yret
= 0;
5203 /* The window under frame pixel coordinates (x,y) */
5204 Lisp_Object window
= f
5205 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5208 if (WINDOWP (window
))
5210 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5211 struct window
*w
= XWINDOW (window
);
5212 Lisp_Object string_info
= Qnil
;
5213 ptrdiff_t textpos
= -1;
5214 int col
= -1, row
= -1;
5215 int dx
= -1, dy
= -1;
5216 int width
= -1, height
= -1;
5217 Lisp_Object object
= Qnil
;
5219 /* Pixel coordinates relative to the window corner. */
5220 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5221 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5223 /* For text area clicks, return X, Y relative to the corner of
5224 this text area. Note that dX, dY etc are set below, by
5225 buffer_posn_from_coords. */
5226 if (part
== ON_TEXT
)
5228 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5229 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5231 /* For mode line and header line clicks, return X, Y relative to
5232 the left window edge. Use mode_line_string to look for a
5233 string on the click position. */
5234 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5239 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5240 /* Note that mode_line_string takes COL, ROW as pixels and
5241 converts them to characters. */
5244 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5245 &object
, &dx
, &dy
, &width
, &height
);
5246 if (STRINGP (string
))
5247 string_info
= Fcons (string
, make_number (charpos
));
5248 textpos
= (w
== XWINDOW (selected_window
)
5249 && current_buffer
== XBUFFER (w
->contents
))
5250 ? PT
: marker_position (w
->pointm
);
5255 /* For fringes and margins, Y is relative to the area's (and the
5256 window's) top edge, while X is meaningless. */
5257 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5262 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5265 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5266 &object
, &dx
, &dy
, &width
, &height
);
5267 if (STRINGP (string
))
5268 string_info
= Fcons (string
, make_number (charpos
));
5269 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5271 else if (part
== ON_LEFT_FRINGE
)
5273 posn
= Qleft_fringe
;
5276 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5277 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5278 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5280 else if (part
== ON_RIGHT_FRINGE
)
5282 posn
= Qright_fringe
;
5285 - window_box_width (w
, LEFT_MARGIN_AREA
)
5286 - window_box_width (w
, TEXT_AREA
)
5287 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5288 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5290 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5292 else if (part
== ON_VERTICAL_BORDER
)
5294 posn
= Qvertical_line
;
5299 /* Nothing special for part == ON_SCROLL_BAR. */
5301 /* For clicks in the text area, fringes, or margins, call
5302 buffer_posn_from_coords to extract TEXTPOS, the buffer
5303 position nearest to the click. */
5306 Lisp_Object string2
, object2
= Qnil
;
5307 struct display_pos p
;
5309 int width2
, height2
;
5310 /* The pixel X coordinate passed to buffer_posn_from_coords
5311 is the X coordinate relative to the text area for
5312 text-area and right-margin clicks, zero otherwise. */
5314 = (part
== ON_TEXT
) ? xret
5315 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5316 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5320 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5321 &object2
, &dx2
, &dy2
,
5323 textpos
= CHARPOS (p
.pos
);
5324 if (col
< 0) col
= x2
;
5325 if (row
< 0) row
= y2
;
5326 if (dx
< 0) dx
= dx2
;
5327 if (dy
< 0) dy
= dy2
;
5328 if (width
< 0) width
= width2
;
5329 if (height
< 0) height
= height2
;
5333 posn
= make_number (textpos
);
5334 if (STRINGP (string2
))
5335 string_info
= Fcons (string2
,
5336 make_number (CHARPOS (p
.string_pos
)));
5342 #ifdef HAVE_WINDOW_SYSTEM
5343 if (IMAGEP (object
))
5345 Lisp_Object image_map
, hotspot
;
5346 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5348 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5350 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5351 posn
= XCAR (hotspot
);
5358 Fcons (make_number (dx
), make_number (dy
)),
5359 Fcons (make_number (width
), make_number (height
)));
5362 extra_info
= Fcons (string_info
,
5363 Fcons (make_number (textpos
),
5364 Fcons (Fcons (make_number (col
),
5369 XSETFRAME (window
, f
);
5373 return Fcons (window
,
5375 Fcons (Fcons (make_number (xret
),
5376 make_number (yret
)),
5377 Fcons (make_number (t
),
5381 /* Given a struct input_event, build the lisp event which represents
5382 it. If EVENT is 0, build a mouse movement event from the mouse
5383 movement buffer, which should have a movement event in it.
5385 Note that events must be passed to this function in the order they
5386 are received; this function stores the location of button presses
5387 in order to build drag events when the button is released. */
5390 make_lispy_event (struct input_event
*event
)
5394 switch (event
->kind
)
5396 /* A simple keystroke. */
5397 case ASCII_KEYSTROKE_EVENT
:
5398 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5400 Lisp_Object lispy_c
;
5401 EMACS_INT c
= event
->code
;
5402 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5405 eassert (c
== event
->code
);
5406 /* Turn ASCII characters into control characters
5408 if (event
->modifiers
& ctrl_modifier
)
5410 c
= make_ctrl_char (c
);
5411 event
->modifiers
&= ~ctrl_modifier
;
5415 /* Add in the other modifier bits. The shift key was taken care
5416 of by the X code. */
5417 c
|= (event
->modifiers
5418 & (meta_modifier
| alt_modifier
5419 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5420 /* Distinguish Shift-SPC from SPC. */
5421 if ((event
->code
) == 040
5422 && event
->modifiers
& shift_modifier
)
5423 c
|= shift_modifier
;
5424 button_down_time
= 0;
5425 XSETFASTINT (lispy_c
, c
);
5430 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5431 except that they are non-key events (last-nonmenu-event is nil). */
5432 case NS_NONKEY_EVENT
:
5435 /* A function key. The symbol may need to have modifier prefixes
5437 case NON_ASCII_KEYSTROKE_EVENT
:
5438 button_down_time
= 0;
5440 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5441 if (event
->code
== lispy_accent_codes
[i
])
5442 return modify_event_symbol (i
,
5444 Qfunction_key
, Qnil
,
5445 lispy_accent_keys
, &accent_key_syms
,
5446 (sizeof (lispy_accent_keys
)
5447 / sizeof (lispy_accent_keys
[0])));
5451 if (event
->code
>= 0x400 && event
->code
< 0x500)
5452 return modify_event_symbol (event
->code
- 0x400,
5453 event
->modifiers
& ~shift_modifier
,
5454 Qfunction_key
, Qnil
,
5455 lispy_kana_keys
, &func_key_syms
,
5456 (sizeof (lispy_kana_keys
)
5457 / sizeof (lispy_kana_keys
[0])));
5458 #endif /* XK_kana_A */
5461 #ifdef ISO_FUNCTION_KEY_OFFSET
5462 if (event
->code
< FUNCTION_KEY_OFFSET
5463 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5464 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5466 Qfunction_key
, Qnil
,
5467 iso_lispy_function_keys
, &func_key_syms
,
5468 (sizeof (iso_lispy_function_keys
)
5469 / sizeof (iso_lispy_function_keys
[0])));
5472 /* Handle system-specific or unknown keysyms. */
5473 if (event
->code
& (1 << 28)
5474 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5475 || (event
->code
- FUNCTION_KEY_OFFSET
5476 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5477 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5479 /* We need to use an alist rather than a vector as the cache
5480 since we can't make a vector long enough. */
5481 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5482 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5483 return modify_event_symbol (event
->code
,
5486 KVAR (current_kboard
, Vsystem_key_alist
),
5487 0, &KVAR (current_kboard
, system_key_syms
),
5491 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5493 Qfunction_key
, Qnil
,
5494 lispy_function_keys
, &func_key_syms
,
5495 (sizeof (lispy_function_keys
)
5496 / sizeof (lispy_function_keys
[0])));
5499 case MULTIMEDIA_KEY_EVENT
:
5500 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5501 / sizeof (lispy_multimedia_keys
[0]))
5502 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5504 return modify_event_symbol (event
->code
, event
->modifiers
,
5505 Qfunction_key
, Qnil
,
5506 lispy_multimedia_keys
, &func_key_syms
,
5507 (sizeof (lispy_multimedia_keys
)
5508 / sizeof (lispy_multimedia_keys
[0])));
5513 /* A mouse click. Figure out where it is, decide whether it's
5514 a press, click or drag, and build the appropriate structure. */
5515 case MOUSE_CLICK_EVENT
:
5516 #ifndef USE_TOOLKIT_SCROLL_BARS
5517 case SCROLL_BAR_CLICK_EVENT
:
5520 int button
= event
->code
;
5522 Lisp_Object position
;
5523 Lisp_Object
*start_pos_ptr
;
5524 Lisp_Object start_pos
;
5528 /* Build the position as appropriate for this mouse click. */
5529 if (event
->kind
== MOUSE_CLICK_EVENT
)
5531 struct frame
*f
= XFRAME (event
->frame_or_window
);
5532 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5536 /* Ignore mouse events that were made on frame that
5537 have been deleted. */
5538 if (! FRAME_LIVE_P (f
))
5541 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5542 /* EVENT->x and EVENT->y are frame-relative pixel
5543 coordinates at this place. Under old redisplay, COLUMN
5544 and ROW are set to frame relative glyph coordinates
5545 which are then used to determine whether this click is
5546 in a menu (non-toolkit version). */
5547 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5548 &column
, &row
, NULL
, 1);
5550 /* In the non-toolkit version, clicks on the menu bar
5551 are ordinary button events in the event buffer.
5552 Distinguish them, and invoke the menu.
5554 (In the toolkit version, the toolkit handles the menu bar
5555 and Emacs doesn't know about it until after the user
5556 makes a selection.) */
5557 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5558 && (event
->modifiers
& down_modifier
))
5560 Lisp_Object items
, item
;
5562 /* Find the menu bar item under `column'. */
5564 items
= FRAME_MENU_BAR_ITEMS (f
);
5565 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5567 Lisp_Object pos
, string
;
5568 string
= AREF (items
, i
+ 1);
5569 pos
= AREF (items
, i
+ 3);
5572 if (column
>= XINT (pos
)
5573 && column
< XINT (pos
) + SCHARS (string
))
5575 item
= AREF (items
, i
);
5580 /* ELisp manual 2.4b says (x y) are window relative but
5581 code says they are frame-relative. */
5582 position
= list4 (event
->frame_or_window
,
5584 Fcons (event
->x
, event
->y
),
5585 make_number (event
->timestamp
));
5587 return list2 (item
, position
);
5589 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5591 position
= make_lispy_position (f
, event
->x
, event
->y
,
5594 #ifndef USE_TOOLKIT_SCROLL_BARS
5597 /* It's a scrollbar click. */
5599 Lisp_Object portion_whole
;
5602 window
= event
->frame_or_window
;
5603 portion_whole
= Fcons (event
->x
, event
->y
);
5604 part
= *scroll_bar_parts
[(int) event
->part
];
5606 position
= list5 (window
, Qvertical_scroll_bar
,
5607 portion_whole
, make_number (event
->timestamp
),
5610 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5612 if (button
>= ASIZE (button_down_location
))
5614 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5615 button_down_location
= larger_vector (button_down_location
,
5617 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5620 start_pos_ptr
= aref_addr (button_down_location
, button
);
5621 start_pos
= *start_pos_ptr
;
5622 *start_pos_ptr
= Qnil
;
5625 /* On window-system frames, use the value of
5626 double-click-fuzz as is. On other frames, interpret it
5627 as a multiple of 1/8 characters. */
5631 if (WINDOWP (event
->frame_or_window
))
5632 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5633 else if (FRAMEP (event
->frame_or_window
))
5634 f
= XFRAME (event
->frame_or_window
);
5638 if (FRAME_WINDOW_P (f
))
5639 fuzz
= double_click_fuzz
;
5641 fuzz
= double_click_fuzz
/ 8;
5643 is_double
= (button
== last_mouse_button
5644 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5645 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5646 && button_down_time
!= 0
5647 && (EQ (Vdouble_click_time
, Qt
)
5648 || (NATNUMP (Vdouble_click_time
)
5649 && (event
->timestamp
- button_down_time
5650 < XFASTINT (Vdouble_click_time
)))));
5653 last_mouse_button
= button
;
5654 last_mouse_x
= XINT (event
->x
);
5655 last_mouse_y
= XINT (event
->y
);
5657 /* If this is a button press, squirrel away the location, so
5658 we can decide later whether it was a click or a drag. */
5659 if (event
->modifiers
& down_modifier
)
5663 double_click_count
++;
5664 event
->modifiers
|= ((double_click_count
> 2)
5669 double_click_count
= 1;
5670 button_down_time
= event
->timestamp
;
5671 *start_pos_ptr
= Fcopy_alist (position
);
5672 ignore_mouse_drag_p
= 0;
5675 /* Now we're releasing a button - check the co-ordinates to
5676 see if this was a click or a drag. */
5677 else if (event
->modifiers
& up_modifier
)
5679 /* If we did not see a down before this up, ignore the up.
5680 Probably this happened because the down event chose a
5681 menu item. It would be an annoyance to treat the
5682 release of the button that chose the menu item as a
5685 if (!CONSP (start_pos
))
5688 event
->modifiers
&= ~up_modifier
;
5691 Lisp_Object new_down
, down
;
5692 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5694 /* The third element of every position
5695 should be the (x,y) pair. */
5696 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5697 new_down
= Fcar (Fcdr (Fcdr (position
)));
5700 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5702 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5703 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5706 if (ignore_mouse_drag_p
)
5708 event
->modifiers
|= click_modifier
;
5709 ignore_mouse_drag_p
= 0;
5711 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5712 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5713 /* Maybe the mouse has moved a lot, caused scrolling, and
5714 eventually ended up at the same screen position (but
5715 not buffer position) in which case it is a drag, not
5717 /* FIXME: OTOH if the buffer position has changed
5718 because of a timer or process filter rather than
5719 because of mouse movement, it should be considered as
5720 a click. But mouse-drag-region completely ignores
5721 this case and it hasn't caused any real problem, so
5722 it's probably OK to ignore it as well. */
5723 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5724 /* Mouse hasn't moved (much). */
5725 event
->modifiers
|= click_modifier
;
5728 button_down_time
= 0;
5729 event
->modifiers
|= drag_modifier
;
5732 /* Don't check is_double; treat this as multiple
5733 if the down-event was multiple. */
5734 if (double_click_count
> 1)
5735 event
->modifiers
|= ((double_click_count
> 2)
5741 /* Every mouse event should either have the down_modifier or
5742 the up_modifier set. */
5746 /* Get the symbol we should use for the mouse click. */
5749 head
= modify_event_symbol (button
,
5751 Qmouse_click
, Vlispy_mouse_stem
,
5754 ASIZE (mouse_syms
));
5755 if (event
->modifiers
& drag_modifier
)
5756 return list3 (head
, start_pos
, position
);
5757 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5758 return list3 (head
, position
, make_number (double_click_count
));
5760 return list2 (head
, position
);
5765 case HORIZ_WHEEL_EVENT
:
5767 Lisp_Object position
;
5770 /* Build the position as appropriate for this mouse click. */
5771 struct frame
*f
= XFRAME (event
->frame_or_window
);
5773 /* Ignore wheel events that were made on frame that have been
5775 if (! FRAME_LIVE_P (f
))
5778 position
= make_lispy_position (f
, event
->x
, event
->y
,
5781 /* Set double or triple modifiers to indicate the wheel speed. */
5783 /* On window-system frames, use the value of
5784 double-click-fuzz as is. On other frames, interpret it
5785 as a multiple of 1/8 characters. */
5791 if (WINDOWP (event
->frame_or_window
))
5792 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5793 else if (FRAMEP (event
->frame_or_window
))
5794 fr
= XFRAME (event
->frame_or_window
);
5798 fuzz
= FRAME_WINDOW_P (fr
)
5799 ? double_click_fuzz
: double_click_fuzz
/ 8;
5801 if (event
->modifiers
& up_modifier
)
5803 /* Emit a wheel-up event. */
5804 event
->modifiers
&= ~up_modifier
;
5807 else if (event
->modifiers
& down_modifier
)
5809 /* Emit a wheel-down event. */
5810 event
->modifiers
&= ~down_modifier
;
5814 /* Every wheel event should either have the down_modifier or
5815 the up_modifier set. */
5818 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5821 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5822 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5823 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5824 && button_down_time
!= 0
5825 && (EQ (Vdouble_click_time
, Qt
)
5826 || (NATNUMP (Vdouble_click_time
)
5827 && (event
->timestamp
- button_down_time
5828 < XFASTINT (Vdouble_click_time
)))));
5831 double_click_count
++;
5832 event
->modifiers
|= ((double_click_count
> 2)
5838 double_click_count
= 1;
5839 event
->modifiers
|= click_modifier
;
5842 button_down_time
= event
->timestamp
;
5843 /* Use a negative value to distinguish wheel from mouse button. */
5844 last_mouse_button
= - (1 + symbol_num
);
5845 last_mouse_x
= XINT (event
->x
);
5846 last_mouse_y
= XINT (event
->y
);
5848 /* Get the symbol we should use for the wheel event. */
5849 head
= modify_event_symbol (symbol_num
,
5855 ASIZE (wheel_syms
));
5858 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5859 return list3 (head
, position
, make_number (double_click_count
));
5861 return list2 (head
, position
);
5865 #ifdef USE_TOOLKIT_SCROLL_BARS
5867 /* We don't have down and up events if using toolkit scroll bars,
5868 so make this always a click event. Store in the `part' of
5869 the Lisp event a symbol which maps to the following actions:
5871 `above_handle' page up
5872 `below_handle' page down
5876 `bottom' bottom of buffer
5877 `handle' thumb has been dragged.
5878 `end-scroll' end of interaction with scroll bar
5880 The incoming input_event contains in its `part' member an
5881 index of type `enum scroll_bar_part' which we can use as an
5882 index in scroll_bar_parts to get the appropriate symbol. */
5884 case SCROLL_BAR_CLICK_EVENT
:
5886 Lisp_Object position
, head
, window
, portion_whole
, part
;
5888 window
= event
->frame_or_window
;
5889 portion_whole
= Fcons (event
->x
, event
->y
);
5890 part
= *scroll_bar_parts
[(int) event
->part
];
5892 position
= list5 (window
, Qvertical_scroll_bar
, portion_whole
,
5893 make_number (event
->timestamp
), part
);
5895 /* Always treat scroll bar events as clicks. */
5896 event
->modifiers
|= click_modifier
;
5897 event
->modifiers
&= ~up_modifier
;
5899 if (event
->code
>= ASIZE (mouse_syms
))
5900 mouse_syms
= larger_vector (mouse_syms
,
5901 event
->code
- ASIZE (mouse_syms
) + 1,
5904 /* Get the symbol we should use for the mouse click. */
5905 head
= modify_event_symbol (event
->code
,
5910 ASIZE (mouse_syms
));
5911 return list2 (head
, position
);
5914 #endif /* USE_TOOLKIT_SCROLL_BARS */
5916 case DRAG_N_DROP_EVENT
:
5919 Lisp_Object head
, position
;
5922 f
= XFRAME (event
->frame_or_window
);
5925 /* Ignore mouse events that were made on frames that
5926 have been deleted. */
5927 if (! FRAME_LIVE_P (f
))
5930 position
= make_lispy_position (f
, event
->x
, event
->y
,
5933 head
= modify_event_symbol (0, event
->modifiers
,
5935 lispy_drag_n_drop_names
,
5936 &drag_n_drop_syms
, 1);
5937 return list3 (head
, position
, files
);
5940 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5941 || defined (HAVE_NS) || defined (USE_GTK)
5942 case MENU_BAR_EVENT
:
5943 if (EQ (event
->arg
, event
->frame_or_window
))
5944 /* This is the prefix key. We translate this to
5945 `(menu_bar)' because the code in keyboard.c for menu
5946 events, which we use, relies on this. */
5947 return list1 (Qmenu_bar
);
5951 case SELECT_WINDOW_EVENT
:
5952 /* Make an event (select-window (WINDOW)). */
5953 return list2 (Qselect_window
, list1 (event
->frame_or_window
));
5955 case TOOL_BAR_EVENT
:
5956 if (EQ (event
->arg
, event
->frame_or_window
))
5957 /* This is the prefix key. We translate this to
5958 `(tool_bar)' because the code in keyboard.c for tool bar
5959 events, which we use, relies on this. */
5960 return list1 (Qtool_bar
);
5961 else if (SYMBOLP (event
->arg
))
5962 return apply_modifiers (event
->modifiers
, event
->arg
);
5965 case USER_SIGNAL_EVENT
:
5966 /* A user signal. */
5968 char *name
= find_user_signal_name (event
->code
);
5971 return intern (name
);
5974 case SAVE_SESSION_EVENT
:
5975 return Qsave_session
;
5980 return Fcons (Qdbus_event
, event
->arg
);
5982 #endif /* HAVE_DBUS */
5984 #ifdef HAVE_XWIDGETS
5987 printf("cool, an xwidget event arrived in make_lispy_event!\n");
5988 return Fcons (Qxwidget_event
,event
->arg
);
5990 #endif /* HAVE_XWIDGETS */
5993 #if defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY
5994 case FILE_NOTIFY_EVENT
:
5996 return Fcons (Qfile_notify
, event
->arg
);
5998 #endif /* defined HAVE_GFILENOTIFY || defined HAVE_INOTIFY */
6000 case CONFIG_CHANGED_EVENT
:
6001 return list3 (Qconfig_changed_event
,
6002 event
->arg
, event
->frame_or_window
);
6004 case GPM_CLICK_EVENT
:
6006 struct frame
*f
= XFRAME (event
->frame_or_window
);
6007 Lisp_Object head
, position
;
6008 Lisp_Object
*start_pos_ptr
;
6009 Lisp_Object start_pos
;
6010 int button
= event
->code
;
6012 if (button
>= ASIZE (button_down_location
))
6014 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
6015 button_down_location
= larger_vector (button_down_location
,
6017 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
6020 start_pos_ptr
= aref_addr (button_down_location
, button
);
6021 start_pos
= *start_pos_ptr
;
6023 position
= make_lispy_position (f
, event
->x
, event
->y
,
6026 if (event
->modifiers
& down_modifier
)
6027 *start_pos_ptr
= Fcopy_alist (position
);
6028 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
6030 if (!CONSP (start_pos
))
6032 event
->modifiers
&= ~up_modifier
;
6035 head
= modify_event_symbol (button
,
6037 Qmouse_click
, Vlispy_mouse_stem
,
6040 ASIZE (mouse_syms
));
6042 if (event
->modifiers
& drag_modifier
)
6043 return list3 (head
, start_pos
, position
);
6044 else if (event
->modifiers
& double_modifier
)
6045 return list3 (head
, position
, make_number (2));
6046 else if (event
->modifiers
& triple_modifier
)
6047 return list3 (head
, position
, make_number (3));
6049 return list2 (head
, position
);
6051 #endif /* HAVE_GPM */
6053 /* The 'kind' field of the event is something we don't recognize. */
6060 make_lispy_movement (struct frame
*frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
6061 Lisp_Object x
, Lisp_Object y
, Time t
)
6063 /* Is it a scroll bar movement? */
6064 if (frame
&& ! NILP (bar_window
))
6066 Lisp_Object part_sym
;
6068 part_sym
= *scroll_bar_parts
[(int) part
];
6069 return list2 (Qscroll_bar_movement
,
6071 Qvertical_scroll_bar
,
6076 /* Or is it an ordinary mouse movement? */
6079 Lisp_Object position
;
6080 position
= make_lispy_position (frame
, x
, y
, t
);
6081 return list2 (Qmouse_movement
, position
);
6085 /* Construct a switch frame event. */
6087 make_lispy_switch_frame (Lisp_Object frame
)
6089 return list2 (Qswitch_frame
, frame
);
6093 make_lispy_focus_in (Lisp_Object frame
)
6095 return list2 (Qfocus_in
, frame
);
6098 make_lispy_focus_out (Lisp_Object frame
)
6100 return list2 (Qfocus_out
, frame
);
6103 /* Manipulating modifiers. */
6105 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6107 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6108 SYMBOL's name of the end of the modifiers; the string from this
6109 position is the unmodified symbol name.
6111 This doesn't use any caches. */
6114 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6120 CHECK_SYMBOL (symbol
);
6123 name
= SYMBOL_NAME (symbol
);
6125 for (i
= 0; i
< SBYTES (name
) - 1; )
6127 ptrdiff_t this_mod_end
= 0;
6130 /* See if the name continues with a modifier word.
6131 Check that the word appears, but don't check what follows it.
6132 Set this_mod and this_mod_end to record what we find. */
6134 switch (SREF (name
, i
))
6136 #define SINGLE_LETTER_MOD(BIT) \
6137 (this_mod_end = i + 1, this_mod = BIT)
6140 SINGLE_LETTER_MOD (alt_modifier
);
6144 SINGLE_LETTER_MOD (ctrl_modifier
);
6148 SINGLE_LETTER_MOD (hyper_modifier
);
6152 SINGLE_LETTER_MOD (meta_modifier
);
6156 SINGLE_LETTER_MOD (shift_modifier
);
6160 SINGLE_LETTER_MOD (super_modifier
);
6163 #undef SINGLE_LETTER_MOD
6165 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6166 if (i + LEN + 1 <= SBYTES (name) \
6167 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6169 this_mod_end = i + LEN; \
6174 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6175 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6176 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6180 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6182 #undef MULTI_LETTER_MOD
6186 /* If we found no modifier, stop looking for them. */
6187 if (this_mod_end
== 0)
6190 /* Check there is a dash after the modifier, so that it
6191 really is a modifier. */
6192 if (this_mod_end
>= SBYTES (name
)
6193 || SREF (name
, this_mod_end
) != '-')
6196 /* This modifier is real; look for another. */
6197 modifiers
|= this_mod
;
6198 i
= this_mod_end
+ 1;
6201 /* Should we include the `click' modifier? */
6202 if (! (modifiers
& (down_modifier
| drag_modifier
6203 | double_modifier
| triple_modifier
))
6204 && i
+ 7 == SBYTES (name
)
6205 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6206 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6207 modifiers
|= click_modifier
;
6209 if (! (modifiers
& (double_modifier
| triple_modifier
))
6210 && i
+ 6 < SBYTES (name
)
6211 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6212 modifiers
|= click_modifier
;
6220 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6221 prepended to the string BASE[0..BASE_LEN-1].
6222 This doesn't use any caches. */
6224 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6226 /* Since BASE could contain nulls, we can't use intern here; we have
6227 to use Fintern, which expects a genuine Lisp_String, and keeps a
6229 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6235 /* Only the event queue may use the `up' modifier; it should always
6236 be turned into a click or drag event before presented to lisp code. */
6237 if (modifiers
& up_modifier
)
6240 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6241 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6242 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6243 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6244 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6245 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6246 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6247 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6248 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6249 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6250 /* The click modifier is denoted by the absence of other modifiers. */
6254 mod_len
= p
- new_mods
;
6258 Lisp_Object new_name
;
6260 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6261 mod_len
+ base_len_byte
);
6262 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6263 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6265 return Fintern (new_name
, Qnil
);
6270 static const char *const modifier_names
[] =
6272 "up", "down", "drag", "click", "double", "triple", 0, 0,
6273 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6274 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6276 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6278 static Lisp_Object modifier_symbols
;
6280 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6282 lispy_modifier_list (int modifiers
)
6284 Lisp_Object modifier_list
;
6287 modifier_list
= Qnil
;
6288 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6289 if (modifiers
& (1<<i
))
6290 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6293 return modifier_list
;
6297 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6298 where UNMODIFIED is the unmodified form of SYMBOL,
6299 MASK is the set of modifiers present in SYMBOL's name.
6300 This is similar to parse_modifiers_uncached, but uses the cache in
6301 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6302 Qevent_symbol_elements property. */
6304 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6307 parse_modifiers (Lisp_Object symbol
)
6309 Lisp_Object elements
;
6311 if (INTEGERP (symbol
))
6312 return list2i (KEY_TO_CHAR (symbol
), XINT (symbol
) & CHAR_MODIFIER_MASK
);
6313 else if (!SYMBOLP (symbol
))
6316 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6317 if (CONSP (elements
))
6322 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6323 Lisp_Object unmodified
;
6326 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6327 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6330 if (modifiers
& ~INTMASK
)
6332 XSETFASTINT (mask
, modifiers
);
6333 elements
= list2 (unmodified
, mask
);
6335 /* Cache the parsing results on SYMBOL. */
6336 Fput (symbol
, Qevent_symbol_element_mask
,
6338 Fput (symbol
, Qevent_symbol_elements
,
6339 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6341 /* Since we know that SYMBOL is modifiers applied to unmodified,
6342 it would be nice to put that in unmodified's cache.
6343 But we can't, since we're not sure that parse_modifiers is
6350 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6351 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6352 doc
: /* Parse the event symbol. For internal use. */)
6353 (Lisp_Object symbol
)
6355 /* Fill the cache if needed. */
6356 parse_modifiers (symbol
);
6357 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6358 and use the Lispier representation stored on Qevent_symbol_elements
6360 return Fget (symbol
, Qevent_symbol_elements
);
6363 /* Apply the modifiers MODIFIERS to the symbol BASE.
6364 BASE must be unmodified.
6366 This is like apply_modifiers_uncached, but uses BASE's
6367 Qmodifier_cache property, if present. It also builds
6368 Qevent_symbol_elements properties, since it has that info anyway.
6370 apply_modifiers copies the value of BASE's Qevent_kind property to
6371 the modified symbol. */
6373 apply_modifiers (int modifiers
, Lisp_Object base
)
6375 Lisp_Object cache
, idx
, entry
, new_symbol
;
6377 /* Mask out upper bits. We don't know where this value's been. */
6378 modifiers
&= INTMASK
;
6380 if (INTEGERP (base
))
6381 return make_number (XINT (base
) | modifiers
);
6383 /* The click modifier never figures into cache indices. */
6384 cache
= Fget (base
, Qmodifier_cache
);
6385 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6386 entry
= assq_no_quit (idx
, cache
);
6389 new_symbol
= XCDR (entry
);
6392 /* We have to create the symbol ourselves. */
6393 new_symbol
= apply_modifiers_uncached (modifiers
,
6394 SSDATA (SYMBOL_NAME (base
)),
6395 SCHARS (SYMBOL_NAME (base
)),
6396 SBYTES (SYMBOL_NAME (base
)));
6398 /* Add the new symbol to the base's cache. */
6399 entry
= Fcons (idx
, new_symbol
);
6400 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6402 /* We have the parsing info now for free, so we could add it to
6404 XSETFASTINT (idx, modifiers);
6405 Fput (new_symbol, Qevent_symbol_element_mask,
6407 Fput (new_symbol, Qevent_symbol_elements,
6408 Fcons (base, lispy_modifier_list (modifiers)));
6409 Sadly, this is only correct if `base' is indeed a base event,
6410 which is not necessarily the case. -stef */
6413 /* Make sure this symbol is of the same kind as BASE.
6415 You'd think we could just set this once and for all when we
6416 intern the symbol above, but reorder_modifiers may call us when
6417 BASE's property isn't set right; we can't assume that just
6418 because it has a Qmodifier_cache property it must have its
6419 Qevent_kind set right as well. */
6420 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6424 kind
= Fget (base
, Qevent_kind
);
6426 Fput (new_symbol
, Qevent_kind
, kind
);
6433 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6434 return a symbol with the modifiers placed in the canonical order.
6435 Canonical order is alphabetical, except for down and drag, which
6436 always come last. The 'click' modifier is never written out.
6438 Fdefine_key calls this to make sure that (for example) C-M-foo
6439 and M-C-foo end up being equivalent in the keymap. */
6442 reorder_modifiers (Lisp_Object symbol
)
6444 /* It's hopefully okay to write the code this way, since everything
6445 will soon be in caches, and no consing will be done at all. */
6448 parsed
= parse_modifiers (symbol
);
6449 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6454 /* For handling events, we often want to produce a symbol whose name
6455 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6456 to some base, like the name of a function key or mouse button.
6457 modify_event_symbol produces symbols of this sort.
6459 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6460 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6463 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6464 into symbol names, or a string specifying a name stem used to
6465 construct a symbol name or the form `STEM-N', where N is the decimal
6466 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6467 non-nil; otherwise NAME_TABLE is used.
6469 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6470 persist between calls to modify_event_symbol that it can use to
6471 store a cache of the symbols it's generated for this NAME_TABLE
6472 before. The object stored there may be a vector or an alist.
6474 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6476 MODIFIERS is a set of modifier bits (as given in struct input_events)
6477 whose prefixes should be applied to the symbol name.
6479 SYMBOL_KIND is the value to be placed in the event_kind property of
6480 the returned symbol.
6482 The symbols we create are supposed to have an
6483 `event-symbol-elements' property, which lists the modifiers present
6484 in the symbol's name. */
6487 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6488 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6489 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6492 Lisp_Object symbol_int
;
6494 /* Get rid of the "vendor-specific" bit here. */
6495 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6497 /* Is this a request for a valid symbol? */
6498 if (symbol_num
< 0 || symbol_num
>= table_size
)
6501 if (CONSP (*symbol_table
))
6502 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6504 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6505 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6506 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6507 we've never used that symbol before. */
6510 if (! VECTORP (*symbol_table
)
6511 || ASIZE (*symbol_table
) != table_size
)
6515 XSETFASTINT (size
, table_size
);
6516 *symbol_table
= Fmake_vector (size
, Qnil
);
6519 value
= AREF (*symbol_table
, symbol_num
);
6522 /* Have we already used this symbol before? */
6525 /* No; let's create it. */
6526 if (CONSP (name_alist_or_stem
))
6527 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6528 else if (STRINGP (name_alist_or_stem
))
6531 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6532 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6534 buf
= SAFE_ALLOCA (len
);
6535 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6536 XINT (symbol_int
) + 1);
6537 value
= intern (buf
);
6540 else if (name_table
!= 0 && name_table
[symbol_num
])
6541 value
= intern (name_table
[symbol_num
]);
6543 #ifdef HAVE_WINDOW_SYSTEM
6546 char *name
= x_get_keysym_name (symbol_num
);
6548 value
= intern (name
);
6554 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6555 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6556 value
= intern (buf
);
6559 if (CONSP (*symbol_table
))
6560 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6562 ASET (*symbol_table
, symbol_num
, value
);
6564 /* Fill in the cache entries for this symbol; this also
6565 builds the Qevent_symbol_elements property, which the user
6567 apply_modifiers (modifiers
& click_modifier
, value
);
6568 Fput (value
, Qevent_kind
, symbol_kind
);
6571 /* Apply modifiers to that symbol. */
6572 return apply_modifiers (modifiers
, value
);
6575 /* Convert a list that represents an event type,
6576 such as (ctrl meta backspace), into the usual representation of that
6577 event type as a number or a symbol. */
6579 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6580 doc
: /* Convert the event description list EVENT-DESC to an event type.
6581 EVENT-DESC should contain one base event type (a character or symbol)
6582 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6583 drag, down, double or triple). The base must be last.
6584 The return value is an event type (a character or symbol) which
6585 has the same base event type and all the specified modifiers. */)
6586 (Lisp_Object event_desc
)
6594 while (CONSP (rest
))
6602 /* Given a symbol, see if it is a modifier name. */
6603 if (SYMBOLP (elt
) && CONSP (rest
))
6604 this = parse_solitary_modifier (elt
);
6608 else if (!NILP (base
))
6609 error ("Two bases given in one event");
6615 /* Let the symbol A refer to the character A. */
6616 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6617 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6619 if (INTEGERP (base
))
6621 /* Turn (shift a) into A. */
6622 if ((modifiers
& shift_modifier
) != 0
6623 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6625 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6626 modifiers
&= ~shift_modifier
;
6629 /* Turn (control a) into C-a. */
6630 if (modifiers
& ctrl_modifier
)
6631 return make_number ((modifiers
& ~ctrl_modifier
)
6632 | make_ctrl_char (XINT (base
)));
6634 return make_number (modifiers
| XINT (base
));
6636 else if (SYMBOLP (base
))
6637 return apply_modifiers (modifiers
, base
);
6639 error ("Invalid base event");
6642 /* Try to recognize SYMBOL as a modifier name.
6643 Return the modifier flag bit, or 0 if not recognized. */
6646 parse_solitary_modifier (Lisp_Object symbol
)
6648 Lisp_Object name
= SYMBOL_NAME (symbol
);
6650 switch (SREF (name
, 0))
6652 #define SINGLE_LETTER_MOD(BIT) \
6653 if (SBYTES (name) == 1) \
6656 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6657 if (LEN == SBYTES (name) \
6658 && ! memcmp (SDATA (name), NAME, LEN)) \
6662 SINGLE_LETTER_MOD (alt_modifier
);
6666 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6670 SINGLE_LETTER_MOD (ctrl_modifier
);
6674 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6675 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6679 SINGLE_LETTER_MOD (hyper_modifier
);
6683 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6687 SINGLE_LETTER_MOD (meta_modifier
);
6691 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6695 SINGLE_LETTER_MOD (shift_modifier
);
6699 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6700 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6701 SINGLE_LETTER_MOD (super_modifier
);
6705 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6706 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6707 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6711 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6714 #undef SINGLE_LETTER_MOD
6715 #undef MULTI_LETTER_MOD
6721 /* Return true if EVENT is a list whose elements are all integers or symbols.
6722 Such a list is not valid as an event,
6723 but it can be a Lucid-style event type list. */
6726 lucid_event_type_list_p (Lisp_Object object
)
6730 if (! CONSP (object
))
6733 if (EQ (XCAR (object
), Qhelp_echo
)
6734 || EQ (XCAR (object
), Qvertical_line
)
6735 || EQ (XCAR (object
), Qmode_line
)
6736 || EQ (XCAR (object
), Qheader_line
))
6739 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6743 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6750 /* Return true if terminal input chars are available.
6751 Also, store the return value into INPUT_PENDING.
6753 Serves the purpose of ioctl (0, FIONREAD, ...)
6754 but works even if FIONREAD does not exist.
6755 (In fact, this may actually read some input.)
6757 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6758 timer events that are ripe.
6759 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6760 events (FOCUS_IN_EVENT).
6761 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6762 movements and toolkit scroll bar thumb drags. */
6765 get_input_pending (int flags
)
6767 /* First of all, have we already counted some input? */
6768 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6770 /* If input is being read as it arrives, and we have none, there is none. */
6771 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6773 /* Try to read some input and see how much we get. */
6775 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6778 return input_pending
;
6781 /* Put a BUFFER_SWITCH_EVENT in the buffer
6782 so that read_key_sequence will notice the new current buffer. */
6785 record_asynch_buffer_change (void)
6787 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6788 The purpose of the event is to make read_key_sequence look up the
6789 keymaps again. If we aren't in read_key_sequence, we don't need one,
6790 and the event could cause trouble by messing up (input-pending-p).
6791 Note: Fwaiting_for_user_input_p always returns nil when async
6792 subprocesses aren't supported. */
6793 if (!NILP (Fwaiting_for_user_input_p ()))
6795 struct input_event event
;
6798 event
.kind
= BUFFER_SWITCH_EVENT
;
6799 event
.frame_or_window
= Qnil
;
6802 /* Make sure no interrupt happens while storing the event. */
6804 if (interrupt_input
)
6805 kbd_buffer_store_event (&event
);
6810 kbd_buffer_store_event (&event
);
6816 /* Read any terminal input already buffered up by the system
6817 into the kbd_buffer, but do not wait.
6819 Return the number of keyboard chars read, or -1 meaning
6820 this is a bad time to try to read input. */
6829 /* Store pending user signal events, if any. */
6830 store_user_signal_events ();
6832 /* Loop through the available terminals, and call their input hooks. */
6836 struct terminal
*next
= t
->next_terminal
;
6838 if (t
->read_socket_hook
)
6841 struct input_event hold_quit
;
6843 if (input_blocked_p ())
6845 pending_signals
= 1;
6849 EVENT_INIT (hold_quit
);
6850 hold_quit
.kind
= NO_EVENT
;
6852 /* No need for FIONREAD or fcntl; just say don't wait. */
6853 while ((nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)) > 0)
6856 if (nr
== -1) /* Not OK to read input now. */
6860 else if (nr
== -2) /* Non-transient error. */
6862 /* The terminal device terminated; it should be closed. */
6864 /* Kill Emacs if this was our last terminal. */
6865 if (!terminal_list
->next_terminal
)
6866 /* Formerly simply reported no input, but that
6867 sometimes led to a failure of Emacs to terminate.
6868 SIGHUP seems appropriate if we can't reach the
6870 /* ??? Is it really right to send the signal just to
6871 this process rather than to the whole process
6872 group? Perhaps on systems with FIONREAD Emacs is
6873 alone in its group. */
6874 terminate_due_to_signal (SIGHUP
, 10);
6876 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6879 XSETTERMINAL (tmp
, t
);
6880 Fdelete_terminal (tmp
, Qnoelisp
);
6884 if (hold_quit
.kind
!= NO_EVENT
)
6885 kbd_buffer_store_event (&hold_quit
);
6894 frame_make_pointer_visible ();
6899 /* This is the tty way of reading available input.
6901 Note that each terminal device has its own `struct terminal' object,
6902 and so this function is called once for each individual termcap
6903 terminal. The first parameter indicates which terminal to read from. */
6906 tty_read_avail_input (struct terminal
*terminal
,
6907 struct input_event
*hold_quit
)
6909 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6910 the kbd_buffer can really hold. That may prevent loss
6911 of characters on some systems when input is stuffed at us. */
6912 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6914 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6917 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6919 if (kbd_on_hold_p () || buffer_free
<= 0)
6921 #endif /* subprocesses */
6923 if (!terminal
->name
) /* Don't read from a dead terminal. */
6926 if (terminal
->type
!= output_termcap
6927 && terminal
->type
!= output_msdos_raw
)
6930 /* XXX I think the following code should be moved to separate hook
6931 functions in system-dependent files. */
6933 /* FIXME: AFAIK, tty_read_avail_input is not used under w32 since the non-GUI
6934 code sets read_socket_hook to w32_console_read_socket instead! */
6936 #else /* not WINDOWSNT */
6937 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6941 return 0; /* The terminal is suspended. */
6944 n_to_read
= dos_keysns ();
6948 cbuf
[0] = dos_keyread ();
6951 #else /* not MSDOS */
6956 struct input_event gpm_hold_quit
;
6957 int gpm
, fd
= gpm_fd
;
6959 EVENT_INIT (gpm_hold_quit
);
6960 gpm_hold_quit
.kind
= NO_EVENT
;
6962 /* gpm==1 if event received.
6963 gpm==0 if the GPM daemon has closed the connection, in which case
6964 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6965 we save it in `fd' so close_gpm can remove it from the
6967 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6968 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6969 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6972 /* Presumably the GPM daemon has closed the connection. */
6974 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6975 kbd_buffer_store_event (&gpm_hold_quit
);
6979 #endif /* HAVE_GPM */
6981 /* Determine how many characters we should *try* to read. */
6982 #ifdef USABLE_FIONREAD
6983 /* Find out how much input is available. */
6984 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6986 if (! noninteractive
)
6987 return -2; /* Close this terminal. */
6993 if (n_to_read
> sizeof cbuf
)
6994 n_to_read
= sizeof cbuf
;
6995 #elif defined USG || defined CYGWIN
6996 /* Read some input if available, but don't wait. */
6997 n_to_read
= sizeof cbuf
;
6998 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
7000 # error "Cannot read without possibly delaying"
7004 /* Don't read more than we can store. */
7005 if (n_to_read
> buffer_free
)
7006 n_to_read
= buffer_free
;
7007 #endif /* subprocesses */
7009 /* Now read; for one reason or another, this will not block.
7010 NREAD is set to the number of chars read. */
7013 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
7014 /* POSIX infers that processes which are not in the session leader's
7015 process group won't get SIGHUPs at logout time. BSDI adheres to
7016 this part standard and returns -1 from read (0) with errno==EIO
7017 when the control tty is taken away.
7018 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
7019 if (nread
== -1 && errno
== EIO
)
7020 return -2; /* Close this terminal. */
7021 #if defined (AIX) && defined (_BSD)
7022 /* The kernel sometimes fails to deliver SIGHUP for ptys.
7023 This looks incorrect, but it isn't, because _BSD causes
7024 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
7025 and that causes a value other than 0 when there is no input. */
7027 return -2; /* Close this terminal. */
7031 /* We used to retry the read if it was interrupted.
7032 But this does the wrong thing when O_NONBLOCK causes
7033 an EAGAIN error. Does anybody know of a situation
7034 where a retry is actually needed? */
7036 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7046 #ifndef USABLE_FIONREAD
7047 #if defined (USG) || defined (CYGWIN)
7048 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7049 #endif /* USG or CYGWIN */
7050 #endif /* no FIONREAD */
7055 #endif /* not MSDOS */
7056 #endif /* not WINDOWSNT */
7058 for (i
= 0; i
< nread
; i
++)
7060 struct input_event buf
;
7062 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7064 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7065 buf
.modifiers
= meta_modifier
;
7066 if (tty
->meta_key
!= 2)
7070 /* Set the frame corresponding to the active tty. Note that the
7071 value of selected_frame is not reliable here, redisplay tends
7072 to temporarily change it. */
7073 buf
.frame_or_window
= tty
->top_frame
;
7076 kbd_buffer_store_event (&buf
);
7077 /* Don't look at input that follows a C-g too closely.
7078 This reduces lossage due to autorepeat on C-g. */
7079 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7080 && buf
.code
== quit_char
)
7088 handle_async_input (void)
7093 int nread
= gobble_input ();
7094 /* -1 means it's not ok to read the input now.
7095 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7096 0 means there was no keyboard input available. */
7104 process_pending_signals (void)
7106 pending_signals
= 0;
7107 handle_async_input ();
7108 do_pending_atimers ();
7111 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7112 and also (if the level is now 0) reinvoke any pending signal. */
7115 unblock_input_to (int level
)
7117 interrupt_input_blocked
= level
;
7120 if (pending_signals
)
7121 process_pending_signals ();
7127 /* End critical section.
7129 If doing signal-driven input, and a signal came in when input was
7130 blocked, reinvoke the signal handler now to deal with it. */
7133 unblock_input (void)
7135 unblock_input_to (interrupt_input_blocked
- 1);
7138 /* Undo any number of BLOCK_INPUT calls,
7139 and also reinvoke any pending signal. */
7142 totally_unblock_input (void)
7144 unblock_input_to (0);
7150 handle_input_available_signal (int sig
)
7152 pending_signals
= 1;
7154 if (input_available_clear_time
)
7155 *input_available_clear_time
= make_emacs_time (0, 0);
7159 deliver_input_available_signal (int sig
)
7161 deliver_process_signal (sig
, handle_input_available_signal
);
7163 #endif /* USABLE_SIGIO */
7166 /* User signal events. */
7168 struct user_signal_info
7170 /* Signal number. */
7173 /* Name of the signal. */
7176 /* Number of pending signals. */
7179 struct user_signal_info
*next
;
7182 /* List of user signals. */
7183 static struct user_signal_info
*user_signals
= NULL
;
7186 add_user_signal (int sig
, const char *name
)
7188 struct sigaction action
;
7189 struct user_signal_info
*p
;
7191 for (p
= user_signals
; p
; p
= p
->next
)
7193 /* Already added. */
7196 p
= xmalloc (sizeof *p
);
7198 p
->name
= xstrdup (name
);
7200 p
->next
= user_signals
;
7203 emacs_sigaction_init (&action
, deliver_user_signal
);
7204 sigaction (sig
, &action
, 0);
7208 handle_user_signal (int sig
)
7210 struct user_signal_info
*p
;
7211 const char *special_event_name
= NULL
;
7213 if (SYMBOLP (Vdebug_on_event
))
7214 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7216 for (p
= user_signals
; p
; p
= p
->next
)
7219 if (special_event_name
7220 && strcmp (special_event_name
, p
->name
) == 0)
7222 /* Enter the debugger in many ways. */
7223 debug_on_next_call
= 1;
7226 Vinhibit_quit
= Qnil
;
7228 /* Eat the event. */
7234 if (interrupt_input
)
7235 handle_input_available_signal (sig
);
7239 /* Tell wait_reading_process_output that it needs to wake
7240 up and look around. */
7241 if (input_available_clear_time
)
7242 *input_available_clear_time
= make_emacs_time (0, 0);
7249 deliver_user_signal (int sig
)
7251 deliver_process_signal (sig
, handle_user_signal
);
7255 find_user_signal_name (int sig
)
7257 struct user_signal_info
*p
;
7259 for (p
= user_signals
; p
; p
= p
->next
)
7267 store_user_signal_events (void)
7269 struct user_signal_info
*p
;
7270 struct input_event buf
;
7271 bool buf_initialized
= 0;
7273 for (p
= user_signals
; p
; p
= p
->next
)
7274 if (p
->npending
> 0)
7276 if (! buf_initialized
)
7278 memset (&buf
, 0, sizeof buf
);
7279 buf
.kind
= USER_SIGNAL_EVENT
;
7280 buf
.frame_or_window
= selected_frame
;
7281 buf_initialized
= 1;
7287 kbd_buffer_store_event (&buf
);
7290 while (p
->npending
> 0);
7295 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7296 static Lisp_Object menu_bar_one_keymap_changed_items
;
7298 /* These variables hold the vector under construction within
7299 menu_bar_items and its subroutines, and the current index
7300 for storing into that vector. */
7301 static Lisp_Object menu_bar_items_vector
;
7302 static int menu_bar_items_index
;
7305 static const char* separator_names
[] = {
7310 "single-dashed-line",
7311 "double-dashed-line",
7313 "shadow-etched-out",
7314 "shadow-etched-in-dash",
7315 "shadow-etched-out-dash",
7316 "shadow-double-etched-in",
7317 "shadow-double-etched-out",
7318 "shadow-double-etched-in-dash",
7319 "shadow-double-etched-out-dash",
7323 /* Return true if LABEL specifies a separator. */
7326 menu_separator_name_p (const char *label
)
7330 else if (strlen (label
) > 3
7331 && memcmp (label
, "--", 2) == 0
7336 for (i
= 0; separator_names
[i
]; ++i
)
7337 if (strcmp (label
, separator_names
[i
]) == 0)
7342 /* It's a separator if it contains only dashes. */
7343 while (*label
== '-')
7345 return (*label
== 0);
7352 /* Return a vector of menu items for a menu bar, appropriate
7353 to the current buffer. Each item has three elements in the vector:
7356 OLD is an old vector we can optionally reuse, or nil. */
7359 menu_bar_items (Lisp_Object old
)
7361 /* The number of keymaps we're scanning right now, and the number of
7362 keymaps we have allocated space for. */
7365 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7366 in the current keymaps, or nil where it is not a prefix. */
7369 Lisp_Object def
, tail
;
7374 /* In order to build the menus, we need to call the keymap
7375 accessors. They all call QUIT. But this function is called
7376 during redisplay, during which a quit is fatal. So inhibit
7377 quitting while building the menus.
7378 We do this instead of specbind because (1) errors will clear it anyway
7379 and (2) this avoids risk of specpdl overflow. */
7380 oquit
= Vinhibit_quit
;
7384 menu_bar_items_vector
= old
;
7386 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7387 menu_bar_items_index
= 0;
7389 /* Build our list of keymaps.
7390 If we recognize a function key and replace its escape sequence in
7391 keybuf with its symbol, or if the sequence starts with a mouse
7392 click and we need to switch buffers, we jump back here to rebuild
7393 the initial keymaps from the current buffer. */
7397 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7398 if (!NILP (Voverriding_local_map_menu_flag
)
7399 && !NILP (Voverriding_local_map
))
7401 /* Yes, use them (if non-nil) as well as the global map. */
7402 maps
= alloca (3 * sizeof (maps
[0]));
7404 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7405 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7406 if (!NILP (Voverriding_local_map
))
7407 maps
[nmaps
++] = Voverriding_local_map
;
7411 /* No, so use major and minor mode keymaps and keymap property.
7412 Note that menu-bar bindings in the local-map and keymap
7413 properties may not work reliable, as they are only
7414 recognized when the menu-bar (or mode-line) is updated,
7415 which does not normally happen after every command. */
7418 nminor
= current_minor_maps (NULL
, &tmaps
);
7419 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7421 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7422 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7423 maps
[nmaps
++] = tem
;
7424 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7425 maps
[nmaps
++] = tem
;
7426 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7428 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7430 maps
[nmaps
++] = current_global_map
;
7433 /* Look up in each map the dummy prefix key `menu-bar'. */
7435 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7436 if (!NILP (maps
[mapno
]))
7438 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7442 menu_bar_one_keymap_changed_items
= Qnil
;
7443 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7447 /* Move to the end those items that should be at the end. */
7449 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7452 int end
= menu_bar_items_index
;
7454 for (i
= 0; i
< end
; i
+= 4)
7455 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7457 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7458 /* Move the item at index I to the end,
7459 shifting all the others forward. */
7460 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7461 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7462 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7463 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7465 memmove (aref_addr (menu_bar_items_vector
, i
),
7466 aref_addr (menu_bar_items_vector
, i
+ 4),
7467 (end
- i
- 4) * word_size
);
7468 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7469 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7470 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7471 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7476 /* Add nil, nil, nil, nil at the end. */
7478 int i
= menu_bar_items_index
;
7479 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7480 menu_bar_items_vector
=
7481 larger_vector (menu_bar_items_vector
, 4, -1);
7482 /* Add this item. */
7483 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7484 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7485 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7486 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7487 menu_bar_items_index
= i
;
7490 Vinhibit_quit
= oquit
;
7491 return menu_bar_items_vector
;
7494 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7495 If there's already an item for KEY, add this DEF to it. */
7497 Lisp_Object item_properties
;
7500 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7502 struct gcpro gcpro1
;
7507 if (EQ (item
, Qundefined
))
7509 /* If a map has an explicit `undefined' as definition,
7510 discard any previously made menu bar item. */
7512 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7513 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7515 if (menu_bar_items_index
> i
+ 4)
7516 memmove (aref_addr (menu_bar_items_vector
, i
),
7517 aref_addr (menu_bar_items_vector
, i
+ 4),
7518 (menu_bar_items_index
- i
- 4) * word_size
);
7519 menu_bar_items_index
-= 4;
7523 /* If this keymap has already contributed to this KEY,
7524 don't contribute to it a second time. */
7525 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7526 if (!NILP (tem
) || NILP (item
))
7529 menu_bar_one_keymap_changed_items
7530 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7532 /* We add to menu_bar_one_keymap_changed_items before doing the
7533 parse_menu_item, so that if it turns out it wasn't a menu item,
7534 it still correctly hides any further menu item. */
7536 parsed
= parse_menu_item (item
, 1);
7541 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7543 /* Find any existing item for this KEY. */
7544 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7545 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7548 /* If we did not find this KEY, add it at the end. */
7549 if (i
== menu_bar_items_index
)
7551 /* If vector is too small, get a bigger one. */
7552 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7553 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7554 /* Add this item. */
7555 ASET (menu_bar_items_vector
, i
, key
); i
++;
7556 ASET (menu_bar_items_vector
, i
,
7557 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7558 ASET (menu_bar_items_vector
, i
, list1 (item
)); i
++;
7559 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7560 menu_bar_items_index
= i
;
7562 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7566 old
= AREF (menu_bar_items_vector
, i
+ 2);
7567 /* If the new and the old items are not both keymaps,
7568 the lookup will only find `item'. */
7569 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7570 ASET (menu_bar_items_vector
, i
+ 2, item
);
7574 /* This is used as the handler when calling menu_item_eval_property. */
7576 menu_item_eval_property_1 (Lisp_Object arg
)
7578 /* If we got a quit from within the menu computation,
7579 quit all the way out of it. This takes care of C-] in the debugger. */
7580 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7581 Fsignal (Qquit
, Qnil
);
7587 eval_dyn (Lisp_Object form
)
7589 return Feval (form
, Qnil
);
7592 /* Evaluate an expression and return the result (or nil if something
7593 went wrong). Used to evaluate dynamic parts of menu items. */
7595 menu_item_eval_property (Lisp_Object sexpr
)
7597 ptrdiff_t count
= SPECPDL_INDEX ();
7599 specbind (Qinhibit_redisplay
, Qt
);
7600 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7601 menu_item_eval_property_1
);
7602 return unbind_to (count
, val
);
7605 /* This function parses a menu item and leaves the result in the
7606 vector item_properties.
7607 ITEM is a key binding, a possible menu item.
7608 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7610 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7611 parse_menu_item returns true if the item is a menu item and false
7615 parse_menu_item (Lisp_Object item
, int inmenubar
)
7617 Lisp_Object def
, tem
, item_string
, start
;
7619 Lisp_Object keyhint
;
7628 /* Create item_properties vector if necessary. */
7629 if (NILP (item_properties
))
7631 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7633 /* Initialize optional entries. */
7634 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7635 ASET (item_properties
, i
, Qnil
);
7636 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7638 /* Save the item here to protect it from GC. */
7639 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7641 item_string
= XCAR (item
);
7645 if (STRINGP (item_string
))
7647 /* Old format menu item. */
7648 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7650 /* Maybe help string. */
7651 if (CONSP (item
) && STRINGP (XCAR (item
)))
7653 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7658 /* Maybe an obsolete key binding cache. */
7659 if (CONSP (item
) && CONSP (XCAR (item
))
7660 && (NILP (XCAR (XCAR (item
)))
7661 || VECTORP (XCAR (XCAR (item
)))))
7664 /* This is the real definition--the function to run. */
7665 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7667 /* Get enable property, if any. */
7670 tem
= Fget (item
, Qmenu_enable
);
7671 if (!NILP (Venable_disabled_menus_and_buttons
))
7672 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7673 else if (!NILP (tem
))
7674 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7677 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7679 /* New format menu item. */
7680 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7681 start
= XCDR (item
);
7684 /* We have a real binding. */
7685 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7687 item
= XCDR (start
);
7688 /* Is there an obsolete cache list with key equivalences. */
7689 if (CONSP (item
) && CONSP (XCAR (item
)))
7692 /* Parse properties. */
7693 while (CONSP (item
) && CONSP (XCDR (item
)))
7698 if (EQ (tem
, QCenable
))
7700 if (!NILP (Venable_disabled_menus_and_buttons
))
7701 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7703 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7705 else if (EQ (tem
, QCvisible
))
7707 /* If got a visible property and that evaluates to nil
7708 then ignore this item. */
7709 tem
= menu_item_eval_property (XCAR (item
));
7713 else if (EQ (tem
, QChelp
))
7714 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7715 else if (EQ (tem
, QCfilter
))
7717 else if (EQ (tem
, QCkey_sequence
))
7720 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7721 /* Be GC protected. Set keyhint to item instead of tem. */
7724 else if (EQ (tem
, QCkeys
))
7727 if (CONSP (tem
) || STRINGP (tem
))
7728 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7730 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7735 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7737 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7739 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7745 else if (inmenubar
|| !NILP (start
))
7749 return 0; /* not a menu item */
7751 /* If item string is not a string, evaluate it to get string.
7752 If we don't get a string, skip this item. */
7753 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7754 if (!(STRINGP (item_string
)))
7756 item_string
= menu_item_eval_property (item_string
);
7757 if (!STRINGP (item_string
))
7759 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7762 /* If got a filter apply it on definition. */
7763 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7766 def
= menu_item_eval_property (list2 (XCAR (filter
),
7767 list2 (Qquote
, def
)));
7769 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7772 /* Enable or disable selection of item. */
7773 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7776 tem
= menu_item_eval_property (tem
);
7777 if (inmenubar
&& NILP (tem
))
7778 return 0; /* Ignore disabled items in menu bar. */
7779 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7782 /* If we got no definition, this item is just unselectable text which
7783 is OK in a submenu but not in the menubar. */
7785 return (!inmenubar
);
7787 /* See if this is a separate pane or a submenu. */
7788 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7789 tem
= get_keymap (def
, 0, 1);
7790 /* For a subkeymap, just record its details and exit. */
7793 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7794 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7798 /* At the top level in the menu bar, do likewise for commands also.
7799 The menu bar does not display equivalent key bindings anyway.
7800 ITEM_PROPERTY_DEF is already set up properly. */
7804 { /* This is a command. See if there is an equivalent key binding. */
7805 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7807 /* The previous code preferred :key-sequence to :keys, so we
7808 preserve this behavior. */
7809 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7810 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7813 Lisp_Object prefix
= keyeq
;
7814 Lisp_Object keys
= Qnil
;
7818 def
= XCAR (prefix
);
7819 prefix
= XCDR (prefix
);
7822 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7824 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7826 keys
= XCAR (keyhint
);
7827 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7829 /* We have a suggested key. Is it bound to the command? */
7832 /* If the command is an alias for another
7833 (such as lmenu.el set it up), check if the
7834 original command matches the cached command. */
7836 && EQ (tem
, XSYMBOL (def
)->function
))))
7841 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7845 tem
= Fkey_description (keys
, Qnil
);
7848 if (STRINGP (XCAR (prefix
)))
7849 tem
= concat2 (XCAR (prefix
), tem
);
7850 if (STRINGP (XCDR (prefix
)))
7851 tem
= concat2 (tem
, XCDR (prefix
));
7853 keyeq
= concat2 (build_string (" "), tem
);
7854 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7860 /* If we have an equivalent key binding, use that. */
7861 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7864 /* Include this when menu help is implemented.
7865 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7866 if (!(NILP (tem) || STRINGP (tem)))
7868 tem = menu_item_eval_property (tem);
7871 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7875 /* Handle radio buttons or toggle boxes. */
7876 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7878 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7879 menu_item_eval_property (tem
));
7886 /***********************************************************************
7888 ***********************************************************************/
7890 /* A vector holding tool bar items while they are parsed in function
7891 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7894 static Lisp_Object tool_bar_items_vector
;
7896 /* A vector holding the result of parse_tool_bar_item. Layout is like
7897 the one for a single item in tool_bar_items_vector. */
7899 static Lisp_Object tool_bar_item_properties
;
7901 /* Next free index in tool_bar_items_vector. */
7903 static int ntool_bar_items
;
7905 /* The symbols `:image' and `:rtl'. */
7907 static Lisp_Object QCimage
;
7908 static Lisp_Object QCrtl
;
7910 /* Function prototypes. */
7912 static void init_tool_bar_items (Lisp_Object
);
7913 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7914 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7915 static void append_tool_bar_item (void);
7918 /* Return a vector of tool bar items for keymaps currently in effect.
7919 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7920 tool bar items found. */
7923 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7932 /* In order to build the menus, we need to call the keymap
7933 accessors. They all call QUIT. But this function is called
7934 during redisplay, during which a quit is fatal. So inhibit
7935 quitting while building the menus. We do this instead of
7936 specbind because (1) errors will clear it anyway and (2) this
7937 avoids risk of specpdl overflow. */
7938 oquit
= Vinhibit_quit
;
7941 /* Initialize tool_bar_items_vector and protect it from GC. */
7942 init_tool_bar_items (reuse
);
7944 /* Build list of keymaps in maps. Set nmaps to the number of maps
7947 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7948 if (!NILP (Voverriding_local_map_menu_flag
)
7949 && !NILP (Voverriding_local_map
))
7951 /* Yes, use them (if non-nil) as well as the global map. */
7952 maps
= alloca (3 * sizeof *maps
);
7954 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7955 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7956 if (!NILP (Voverriding_local_map
))
7957 maps
[nmaps
++] = Voverriding_local_map
;
7961 /* No, so use major and minor mode keymaps and keymap property.
7962 Note that tool-bar bindings in the local-map and keymap
7963 properties may not work reliable, as they are only
7964 recognized when the tool-bar (or mode-line) is updated,
7965 which does not normally happen after every command. */
7968 nminor
= current_minor_maps (NULL
, &tmaps
);
7969 maps
= alloca ((nminor
+ 4) * sizeof *maps
);
7971 tem
= KVAR (current_kboard
, Voverriding_terminal_local_map
);
7972 if (!NILP (tem
) && !NILP (Voverriding_local_map_menu_flag
))
7973 maps
[nmaps
++] = tem
;
7974 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7975 maps
[nmaps
++] = tem
;
7976 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7978 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7981 /* Add global keymap at the end. */
7982 maps
[nmaps
++] = current_global_map
;
7984 /* Process maps in reverse order and look up in each map the prefix
7986 for (i
= nmaps
- 1; i
>= 0; --i
)
7987 if (!NILP (maps
[i
]))
7991 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7993 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7996 Vinhibit_quit
= oquit
;
7997 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7998 return tool_bar_items_vector
;
8002 /* Process the definition of KEY which is DEF. */
8005 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
8008 struct gcpro gcpro1
, gcpro2
;
8010 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
8014 if (EQ (def
, Qundefined
))
8016 /* If a map has an explicit `undefined' as definition,
8017 discard any previously made item. */
8018 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8020 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8022 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8024 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8025 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8026 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8028 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8033 else if (parse_tool_bar_item (key
, def
))
8034 /* Append a new tool bar item to tool_bar_items_vector. Accept
8035 more than one definition for the same key. */
8036 append_tool_bar_item ();
8041 /* Access slot with index IDX of vector tool_bar_item_properties. */
8042 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8044 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8046 ASET (tool_bar_item_properties
, idx
, val
);
8050 /* Parse a tool bar item specification ITEM for key KEY and return the
8051 result in tool_bar_item_properties. Value is false if ITEM is
8054 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8056 CAPTION is the caption of the item, If it's not a string, it is
8057 evaluated to get a string.
8059 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8060 as binding are currently ignored.
8062 The following properties are recognized:
8066 FORM is evaluated and specifies whether the tool bar item is
8067 enabled or disabled.
8071 FORM is evaluated and specifies whether the tool bar item is visible.
8073 - `:filter FUNCTION'
8075 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8076 result is stored as the new binding.
8078 - `:button (TYPE SELECTED)'
8080 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8081 and specifies whether the button is selected (pressed) or not.
8085 IMAGES is either a single image specification or a vector of four
8086 image specifications. See enum tool_bar_item_images.
8088 - `:help HELP-STRING'.
8090 Gives a help string to display for the tool bar item.
8092 - `:label LABEL-STRING'.
8094 A text label to show with the tool bar button if labels are enabled. */
8097 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8099 Lisp_Object filter
= Qnil
;
8100 Lisp_Object caption
;
8102 bool have_label
= 0;
8104 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8105 Rule out items that aren't lists, don't start with
8106 `menu-item' or whose rest following `tool-bar-item' is not a
8111 /* As an exception, allow old-style menu separators. */
8112 if (STRINGP (XCAR (item
)))
8113 item
= list1 (XCAR (item
));
8114 else if (!EQ (XCAR (item
), Qmenu_item
)
8115 || (item
= XCDR (item
), !CONSP (item
)))
8118 /* Create tool_bar_item_properties vector if necessary. Reset it to
8120 if (VECTORP (tool_bar_item_properties
))
8122 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8126 tool_bar_item_properties
8127 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8130 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8131 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8133 /* Get the caption of the item. If the caption is not a string,
8134 evaluate it to get a string. If we don't get a string, skip this
8136 caption
= XCAR (item
);
8137 if (!STRINGP (caption
))
8139 caption
= menu_item_eval_property (caption
);
8140 if (!STRINGP (caption
))
8143 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8145 /* If the rest following the caption is not a list, the menu item is
8146 either a separator, or invalid. */
8150 if (menu_separator_name_p (SSDATA (caption
)))
8152 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8153 #if !defined (USE_GTK) && !defined (HAVE_NS)
8154 /* If we use build_desired_tool_bar_string to render the
8155 tool bar, the separator is rendered as an image. */
8156 set_prop (TOOL_BAR_ITEM_IMAGES
,
8157 (menu_item_eval_property
8158 (Vtool_bar_separator_image_expression
)));
8159 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qnil
);
8160 set_prop (TOOL_BAR_ITEM_SELECTED_P
, Qnil
);
8161 set_prop (TOOL_BAR_ITEM_CAPTION
, Qnil
);
8168 /* Store the binding. */
8169 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8172 /* Ignore cached key binding, if any. */
8173 if (CONSP (item
) && CONSP (XCAR (item
)))
8176 /* Process the rest of the properties. */
8177 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8179 Lisp_Object ikey
, value
;
8182 value
= XCAR (XCDR (item
));
8184 if (EQ (ikey
, QCenable
))
8186 /* `:enable FORM'. */
8187 if (!NILP (Venable_disabled_menus_and_buttons
))
8188 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8190 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8192 else if (EQ (ikey
, QCvisible
))
8194 /* `:visible FORM'. If got a visible property and that
8195 evaluates to nil then ignore this item. */
8196 if (NILP (menu_item_eval_property (value
)))
8199 else if (EQ (ikey
, QChelp
))
8200 /* `:help HELP-STRING'. */
8201 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8202 else if (EQ (ikey
, QCvert_only
))
8203 /* `:vert-only t/nil'. */
8204 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8205 else if (EQ (ikey
, QClabel
))
8207 const char *bad_label
= "!!?GARBLED ITEM?!!";
8208 /* `:label LABEL-STRING'. */
8209 set_prop (TOOL_BAR_ITEM_LABEL
,
8210 STRINGP (value
) ? value
: build_string (bad_label
));
8213 else if (EQ (ikey
, QCfilter
))
8214 /* ':filter FORM'. */
8216 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8218 /* `:button (TYPE . SELECTED)'. */
8219 Lisp_Object type
, selected
;
8221 type
= XCAR (value
);
8222 selected
= XCDR (value
);
8223 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8225 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8226 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8229 else if (EQ (ikey
, QCimage
)
8231 || (VECTORP (value
) && ASIZE (value
) == 4)))
8232 /* Value is either a single image specification or a vector
8233 of 4 such specifications for the different button states. */
8234 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8235 else if (EQ (ikey
, QCrtl
))
8237 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8243 /* Try to make one from caption and key. */
8244 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8245 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8246 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8247 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8249 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8250 char *buf
= xmalloc (max_lbl
+ 1);
8251 Lisp_Object new_lbl
;
8252 ptrdiff_t caption_len
= strlen (capt
);
8254 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8257 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8259 buf
[caption_len
] = '\0';
8263 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8267 strcpy (buf
, label
);
8269 for (j
= 0; buf
[j
] != '\0'; ++j
)
8277 new_lbl
= Fupcase_initials (build_string (label
));
8278 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8279 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8281 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8285 /* If got a filter apply it on binding. */
8287 set_prop (TOOL_BAR_ITEM_BINDING
,
8288 (menu_item_eval_property
8291 PROP (TOOL_BAR_ITEM_BINDING
))))));
8293 /* See if the binding is a keymap. Give up if it is. */
8294 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8297 /* Enable or disable selection of item. */
8298 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8299 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8300 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8302 /* Handle radio buttons or toggle boxes. */
8303 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8304 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8305 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8313 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8314 that can be reused. */
8317 init_tool_bar_items (Lisp_Object reuse
)
8319 if (VECTORP (reuse
))
8320 tool_bar_items_vector
= reuse
;
8322 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8323 ntool_bar_items
= 0;
8327 /* Append parsed tool bar item properties from
8328 tool_bar_item_properties */
8331 append_tool_bar_item (void)
8335 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8337 /* Enlarge tool_bar_items_vector if necessary. */
8339 tool_bar_items_vector
= larger_vector (tool_bar_items_vector
, incr
, -1);
8341 /* Append entries from tool_bar_item_properties to the end of
8342 tool_bar_items_vector. */
8343 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8344 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8345 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8352 /* Read a character using menus based on the keymap MAP.
8353 Return nil if there are no menus in the maps.
8354 Return t if we displayed a menu but the user rejected it.
8356 PREV_EVENT is the previous input event, or nil if we are reading
8357 the first event of a key sequence.
8359 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8360 if we used a mouse menu to read the input, or false otherwise. If
8361 USED_MOUSE_MENU is null, don't dereference it.
8363 The prompting is done based on the prompt-string of the map
8364 and the strings associated with various map elements.
8366 This can be done with X menus or with menus put in the minibuf.
8367 These are done in different ways, depending on how the input will be read.
8368 Menus using X are done after auto-saving in read-char, getting the input
8369 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8370 and do auto-saving in the inner call of read_char. */
8373 read_char_x_menu_prompt (Lisp_Object map
,
8374 Lisp_Object prev_event
, bool *used_mouse_menu
)
8376 if (used_mouse_menu
)
8377 *used_mouse_menu
= 0;
8379 /* Use local over global Menu maps. */
8381 if (! menu_prompting
)
8385 /* If we got to this point via a mouse click,
8386 use a real menu for mouse selection. */
8387 if (EVENT_HAS_PARAMETERS (prev_event
)
8388 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8389 && !EQ (XCAR (prev_event
), Qtool_bar
))
8391 /* Display the menu and get the selection. */
8394 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8399 record_menu_key (XCAR (value
));
8401 /* If we got multiple events, unread all but
8403 There is no way to prevent those unread events
8404 from showing up later in last_nonmenu_event.
8405 So turn symbol and integer events into lists,
8406 to indicate that they came from a mouse menu,
8407 so that when present in last_nonmenu_event
8408 they won't confuse things. */
8409 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8411 record_menu_key (XCAR (tem
));
8412 if (SYMBOLP (XCAR (tem
))
8413 || INTEGERP (XCAR (tem
)))
8414 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8417 /* If we got more than one event, put all but the first
8418 onto this list to be read later.
8419 Return just the first event now. */
8420 Vunread_command_events
8421 = nconc2 (XCDR (value
), Vunread_command_events
);
8422 value
= XCAR (value
);
8424 else if (NILP (value
))
8426 if (used_mouse_menu
)
8427 *used_mouse_menu
= 1;
8430 #endif /* HAVE_MENUS */
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 Where a key sequence ends depends on the currently active keymaps.
8814 These include any minor mode keymaps active in the current buffer,
8815 the current buffer's local map, and the global map.
8817 If a key sequence has no other bindings, we check Vfunction_key_map
8818 to see if some trailing subsequence might be the beginning of a
8819 function key's sequence. If so, we try to read the whole function
8820 key, and substitute its symbolic name into the key sequence.
8822 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8823 `double-' events into similar click events, if that would make them
8824 bound. We try to turn `triple-' events first into `double-' events,
8827 If we get a mouse click in a mode line, vertical divider, or other
8828 non-text area, we treat the click as if it were prefixed by the
8829 symbol denoting that area - `mode-line', `vertical-line', or
8832 If the sequence starts with a mouse click, we read the key sequence
8833 with respect to the buffer clicked on, not the current buffer.
8835 If the user switches frames in the midst of a key sequence, we put
8836 off the switch-frame event until later; the next call to
8837 read_char will return it.
8839 If FIX_CURRENT_BUFFER, we restore current_buffer
8840 from the selected window's buffer. */
8843 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8844 bool dont_downcase_last
, bool can_return_switch_frame
,
8845 bool fix_current_buffer
)
8847 ptrdiff_t count
= SPECPDL_INDEX ();
8849 /* How many keys there are in the current key sequence. */
8852 /* The length of the echo buffer when we started reading, and
8853 the length of this_command_keys when we started reading. */
8854 ptrdiff_t echo_start
IF_LINT (= 0);
8855 ptrdiff_t keys_start
;
8857 Lisp_Object current_binding
= Qnil
;
8858 Lisp_Object first_event
= Qnil
;
8860 /* Index of the first key that has no binding.
8861 It is useless to try fkey.start larger than that. */
8864 /* If t < mock_input, then KEYBUF[t] should be read as the next
8867 We use this to recover after recognizing a function key. Once we
8868 realize that a suffix of the current key sequence is actually a
8869 function key's escape sequence, we replace the suffix with the
8870 function key's binding from Vfunction_key_map. Now keybuf
8871 contains a new and different key sequence, so the echo area,
8872 this_command_keys, and the submaps and defs arrays are wrong. In
8873 this situation, we set mock_input to t, set t to 0, and jump to
8874 restart_sequence; the loop will read keys from keybuf up until
8875 mock_input, thus rebuilding the state; and then it will resume
8876 reading characters from the keyboard. */
8879 /* If the sequence is unbound in submaps[], then
8880 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8881 and fkey.map is its binding.
8883 These might be > t, indicating that all function key scanning
8884 should hold off until t reaches them. We do this when we've just
8885 recognized a function key, to avoid searching for the function
8886 key's again in Vfunction_key_map. */
8889 /* Likewise, for key_translation_map and input-decode-map. */
8890 keyremap keytran
, indec
;
8892 /* True if we are trying to map a key by changing an upper-case
8893 letter to lower case, or a shifted function key to an unshifted
8895 bool shift_translated
= 0;
8897 /* If we receive a `switch-frame' or `select-window' event in the middle of
8898 a key sequence, we put it off for later.
8899 While we're reading, we keep the event here. */
8900 Lisp_Object delayed_switch_frame
;
8902 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8903 int original_uppercase_position
= -1;
8905 /* Gets around Microsoft compiler limitations. */
8908 struct buffer
*starting_buffer
;
8910 /* List of events for which a fake prefix key has been generated. */
8911 Lisp_Object fake_prefixed_keys
= Qnil
;
8913 struct gcpro gcpro1
;
8915 GCPRO1 (fake_prefixed_keys
);
8916 raw_keybuf_count
= 0;
8918 last_nonmenu_event
= Qnil
;
8920 delayed_switch_frame
= Qnil
;
8926 /* Install the string STR as the beginning of the string of
8927 echoing, so that it serves as a prompt for the next
8929 kset_echo_string (current_kboard
, prompt
);
8930 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8933 else if (cursor_in_echo_area
8934 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8935 && NILP (Fzerop (Vecho_keystrokes
)))
8936 /* This doesn't put in a dash if the echo buffer is empty, so
8937 you don't always see a dash hanging out in the minibuffer. */
8941 /* Record the initial state of the echo area and this_command_keys;
8942 we will need to restore them if we replay a key sequence. */
8944 echo_start
= echo_length ();
8945 keys_start
= this_command_key_count
;
8946 this_single_command_key_start
= keys_start
;
8948 /* We jump here when we need to reinitialize fkey and keytran; this
8949 happens if we switch keyboards between rescans. */
8950 replay_entire_sequence
:
8952 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8953 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8954 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8955 indec
.start
= indec
.end
= 0;
8956 fkey
.start
= fkey
.end
= 0;
8957 keytran
.start
= keytran
.end
= 0;
8959 /* We jump here when the key sequence has been thoroughly changed, and
8960 we need to rescan it starting from the beginning. When we jump here,
8961 keybuf[0..mock_input] holds the sequence we should reread. */
8964 starting_buffer
= current_buffer
;
8965 first_unbound
= bufsize
+ 1;
8967 /* Build our list of keymaps.
8968 If we recognize a function key and replace its escape sequence in
8969 keybuf with its symbol, or if the sequence starts with a mouse
8970 click and we need to switch buffers, we jump back here to rebuild
8971 the initial keymaps from the current buffer. */
8972 current_binding
= active_maps (first_event
);
8974 /* Start from the beginning in keybuf. */
8977 /* These are no-ops the first time through, but if we restart, they
8978 revert the echo area and this_command_keys to their original state. */
8979 this_command_key_count
= keys_start
;
8980 if (INTERACTIVE
&& t
< mock_input
)
8981 echo_truncate (echo_start
);
8983 /* If the best binding for the current key sequence is a keymap, or
8984 we may be looking at a function key's escape sequence, keep on
8986 while (!NILP (current_binding
)
8987 /* Keep reading as long as there's a prefix binding. */
8988 ? KEYMAPP (current_binding
)
8989 /* Don't return in the middle of a possible function key sequence,
8990 if the only bindings we found were via case conversion.
8991 Thus, if ESC O a has a function-key-map translation
8992 and ESC o has a binding, don't return after ESC O,
8993 so that we can translate ESC O plus the next character. */
8994 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8997 bool used_mouse_menu
= 0;
8999 /* Where the last real key started. If we need to throw away a
9000 key that has expanded into more than one element of keybuf
9001 (say, a mouse click on the mode line which is being treated
9002 as [mode-line (mouse-...)], then we backtrack to this point
9004 int last_real_key_start
;
9006 /* These variables are analogous to echo_start and keys_start;
9007 while those allow us to restart the entire key sequence,
9008 echo_local_start and keys_local_start allow us to throw away
9010 ptrdiff_t echo_local_start
IF_LINT (= 0);
9011 int keys_local_start
;
9012 Lisp_Object new_binding
;
9014 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
9015 eassert (indec
.start
<= indec
.end
);
9016 eassert (fkey
.start
<= fkey
.end
);
9017 eassert (keytran
.start
<= keytran
.end
);
9018 /* key-translation-map is applied *after* function-key-map
9019 which is itself applied *after* input-decode-map. */
9020 eassert (fkey
.end
<= indec
.start
);
9021 eassert (keytran
.end
<= fkey
.start
);
9023 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9024 first_unbound
< keytran
.start
)
9025 { /* The prefix upto first_unbound has no binding and has
9026 no translation left to do either, so we know it's unbound.
9027 If we don't stop now, we risk staying here indefinitely
9028 (if the user keeps entering fkey or keytran prefixes
9029 like C-c ESC ESC ESC ESC ...) */
9031 for (i
= first_unbound
+ 1; i
< t
; i
++)
9032 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9033 mock_input
= t
- first_unbound
- 1;
9034 indec
.end
= indec
.start
-= first_unbound
+ 1;
9035 indec
.map
= indec
.parent
;
9036 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9037 fkey
.map
= fkey
.parent
;
9038 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9039 keytran
.map
= keytran
.parent
;
9040 goto replay_sequence
;
9044 error ("Key sequence too long");
9047 echo_local_start
= echo_length ();
9048 keys_local_start
= this_command_key_count
;
9051 /* These are no-ops, unless we throw away a keystroke below and
9052 jumped back up to replay_key; in that case, these restore the
9053 variables to their original state, allowing us to replay the
9055 if (INTERACTIVE
&& t
< mock_input
)
9056 echo_truncate (echo_local_start
);
9057 this_command_key_count
= keys_local_start
;
9059 /* By default, assume each event is "real". */
9060 last_real_key_start
= t
;
9062 /* Does mock_input indicate that we are re-reading a key sequence? */
9066 add_command_key (key
);
9067 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9068 && NILP (Fzerop (Vecho_keystrokes
))
9069 && current_kboard
->immediate_echo
)
9076 /* If not, we should actually read a character. */
9080 KBOARD
*interrupted_kboard
= current_kboard
;
9081 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9082 key
= read_char (NILP (prompt
),
9083 current_binding
, last_nonmenu_event
,
9084 &used_mouse_menu
, NULL
);
9085 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9086 /* When switching to a new tty (with a new keyboard),
9087 read_char returns the new buffer, rather than -2
9088 (Bug#5095). This is because `terminal-init-xterm'
9089 calls read-char, which eats the wrong_kboard_jmpbuf
9090 return. Any better way to fix this? -- cyd */
9091 || (interrupted_kboard
!= current_kboard
))
9096 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9097 if (k
== interrupted_kboard
)
9102 /* Don't touch interrupted_kboard when it's been
9104 delayed_switch_frame
= Qnil
;
9105 goto replay_entire_sequence
;
9108 if (!NILP (delayed_switch_frame
))
9111 (interrupted_kboard
,
9112 Fcons (delayed_switch_frame
,
9113 KVAR (interrupted_kboard
, kbd_queue
)));
9114 delayed_switch_frame
= Qnil
;
9119 (interrupted_kboard
,
9120 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9122 /* If the side queue is non-empty, ensure it begins with a
9123 switch-frame, so we'll replay it in the right context. */
9124 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9125 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9126 !(EVENT_HAS_PARAMETERS (key
)
9127 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9131 XSETFRAME (frame
, interrupted_frame
);
9133 (interrupted_kboard
,
9134 Fcons (make_lispy_switch_frame (frame
),
9135 KVAR (interrupted_kboard
, kbd_queue
)));
9138 goto replay_entire_sequence
;
9142 /* read_char returns t when it shows a menu and the user rejects it.
9146 unbind_to (count
, Qnil
);
9151 /* read_char returns -1 at the end of a macro.
9152 Emacs 18 handles this by returning immediately with a
9153 zero, so that's what we'll do. */
9154 if (INTEGERP (key
) && XINT (key
) == -1)
9157 /* The Microsoft C compiler can't handle the goto that
9163 /* If the current buffer has been changed from under us, the
9164 keymap may have changed, so replay the sequence. */
9167 timer_resume_idle ();
9170 /* Reset the current buffer from the selected window
9171 in case something changed the former and not the latter.
9172 This is to be more consistent with the behavior
9173 of the command_loop_1. */
9174 if (fix_current_buffer
)
9176 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9178 if (XBUFFER (XWINDOW (selected_window
)->contents
)
9180 Fset_buffer (XWINDOW (selected_window
)->contents
);
9183 goto replay_sequence
;
9186 /* If we have a quit that was typed in another frame, and
9187 quit_throw_to_read_char switched buffers,
9188 replay to get the right keymap. */
9190 && XINT (key
) == quit_char
9191 && current_buffer
!= starting_buffer
)
9194 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9199 goto replay_sequence
;
9204 if (EVENT_HAS_PARAMETERS (key
)
9205 /* Either a `switch-frame' or a `select-window' event. */
9206 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9208 /* If we're at the beginning of a key sequence, and the caller
9209 says it's okay, go ahead and return this event. If we're
9210 in the midst of a key sequence, delay it until the end. */
9211 if (t
> 0 || !can_return_switch_frame
)
9213 delayed_switch_frame
= key
;
9218 if (NILP (first_event
))
9221 /* Even if first_event does not specify a particular
9222 window/position, it's important to recompute the maps here
9223 since a long time might have passed since we entered
9224 read_key_sequence, and a timer (or process-filter or
9225 special-event-map, ...) might have switched the current buffer
9226 or the selected window from under us in the mean time. */
9227 if (fix_current_buffer
9228 && (XBUFFER (XWINDOW (selected_window
)->contents
)
9230 Fset_buffer (XWINDOW (selected_window
)->contents
);
9231 current_binding
= active_maps (first_event
);
9235 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9239 /* Clicks in non-text areas get prefixed by the symbol
9240 in their CHAR-ADDRESS field. For example, a click on
9241 the mode line is prefixed by the symbol `mode-line'.
9243 Furthermore, key sequences beginning with mouse clicks
9244 are read using the keymaps of the buffer clicked on, not
9245 the current buffer. So we may have to switch the buffer
9248 When we turn one event into two events, we must make sure
9249 that neither of the two looks like the original--so that,
9250 if we replay the events, they won't be expanded again.
9251 If not for this, such reexpansion could happen either here
9252 or when user programs play with this-command-keys. */
9253 if (EVENT_HAS_PARAMETERS (key
))
9255 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9256 if (EQ (kind
, Qmouse_click
))
9258 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9259 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9262 || (!NILP (fake_prefixed_keys
)
9263 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9265 /* We're looking a second time at an event for which
9266 we generated a fake prefix key. Set
9267 last_real_key_start appropriately. */
9269 last_real_key_start
= t
- 1;
9272 if (last_real_key_start
== 0)
9274 /* Key sequences beginning with mouse clicks are
9275 read using the keymaps in the buffer clicked on,
9276 not the current buffer. If we're at the
9277 beginning of a key sequence, switch buffers. */
9278 if (WINDOWP (window
)
9279 && BUFFERP (XWINDOW (window
)->contents
)
9280 && XBUFFER (XWINDOW (window
)->contents
) != current_buffer
)
9282 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9287 /* Arrange to go back to the original buffer once we're
9288 done reading the key sequence. Note that we can't
9289 use save_excursion_{save,restore} here, because they
9290 save point as well as the current buffer; we don't
9291 want to save point, because redisplay may change it,
9292 to accommodate a Fset_window_start or something. We
9293 don't want to do this at the top of the function,
9294 because we may get input from a subprocess which
9295 wants to change the selected window and stuff (say,
9297 record_unwind_current_buffer ();
9299 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9301 set_buffer_internal (XBUFFER (XWINDOW (window
)->contents
));
9302 goto replay_sequence
;
9306 /* Expand mode-line and scroll-bar events into two events:
9307 use posn as a fake prefix key. */
9309 && (NILP (fake_prefixed_keys
)
9310 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9312 if (bufsize
- t
<= 1)
9313 error ("Key sequence too long");
9316 keybuf
[t
+ 1] = key
;
9319 /* Record that a fake prefix key has been generated
9320 for KEY. Don't modify the event; this would
9321 prevent proper action when the event is pushed
9322 back into unread-command-events. */
9323 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9327 else if (CONSP (XCDR (key
))
9328 && CONSP (EVENT_START (key
))
9329 && CONSP (XCDR (EVENT_START (key
))))
9333 posn
= POSN_POSN (EVENT_START (key
));
9334 /* Handle menu-bar events:
9335 insert the dummy prefix event `menu-bar'. */
9336 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9338 if (bufsize
- t
<= 1)
9339 error ("Key sequence too long");
9341 keybuf
[t
+ 1] = key
;
9343 /* Zap the position in key, so we know that we've
9344 expanded it, and don't try to do so again. */
9345 POSN_SET_POSN (EVENT_START (key
), list1 (posn
));
9348 goto replay_sequence
;
9350 else if (CONSP (posn
))
9352 /* We're looking at the second event of a
9353 sequence which we expanded before. Set
9354 last_real_key_start appropriately. */
9355 if (last_real_key_start
== t
&& t
> 0)
9356 last_real_key_start
= t
- 1;
9361 /* We have finally decided that KEY is something we might want
9363 new_binding
= follow_key (current_binding
, key
);
9365 /* If KEY wasn't bound, we'll try some fallbacks. */
9366 if (!NILP (new_binding
))
9367 /* This is needed for the following scenario:
9368 event 0: a down-event that gets dropped by calling replay_key.
9369 event 1: some normal prefix like C-h.
9370 After event 0, first_unbound is 0, after event 1 indec.start,
9371 fkey.start, and keytran.start are all 1, so when we see that
9372 C-h is bound, we need to update first_unbound. */
9373 first_unbound
= max (t
+ 1, first_unbound
);
9378 /* Remember the position to put an upper bound on indec.start. */
9379 first_unbound
= min (t
, first_unbound
);
9381 head
= EVENT_HEAD (key
);
9382 if (help_char_p (head
) && t
> 0)
9384 read_key_sequence_cmd
= Vprefix_help_command
;
9386 last_nonmenu_event
= key
;
9387 /* The Microsoft C compiler can't handle the goto that
9395 Lisp_Object breakdown
;
9398 breakdown
= parse_modifiers (head
);
9399 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9400 /* Attempt to reduce an unbound mouse event to a simpler
9401 event that is bound:
9402 Drags reduce to clicks.
9403 Double-clicks reduce to clicks.
9404 Triple-clicks reduce to double-clicks, then to clicks.
9405 Down-clicks are eliminated.
9406 Double-downs reduce to downs, then are eliminated.
9407 Triple-downs reduce to double-downs, then to downs,
9408 then are eliminated. */
9409 if (modifiers
& (down_modifier
| drag_modifier
9410 | double_modifier
| triple_modifier
))
9412 while (modifiers
& (down_modifier
| drag_modifier
9413 | double_modifier
| triple_modifier
))
9415 Lisp_Object new_head
, new_click
;
9416 if (modifiers
& triple_modifier
)
9417 modifiers
^= (double_modifier
| triple_modifier
);
9418 else if (modifiers
& double_modifier
)
9419 modifiers
&= ~double_modifier
;
9420 else if (modifiers
& drag_modifier
)
9421 modifiers
&= ~drag_modifier
;
9424 /* Dispose of this `down' event by simply jumping
9425 back to replay_key, to get another event.
9427 Note that if this event came from mock input,
9428 then just jumping back to replay_key will just
9429 hand it to us again. So we have to wipe out any
9432 We could delete keybuf[t] and shift everything
9433 after that to the left by one spot, but we'd also
9434 have to fix up any variable that points into
9435 keybuf, and shifting isn't really necessary
9438 Adding prefixes for non-textual mouse clicks
9439 creates two characters of mock input, and both
9440 must be thrown away. If we're only looking at
9441 the prefix now, we can just jump back to
9442 replay_key. On the other hand, if we've already
9443 processed the prefix, and now the actual click
9444 itself is giving us trouble, then we've lost the
9445 state of the keymaps we want to backtrack to, and
9446 we need to replay the whole sequence to rebuild
9449 Beyond that, only function key expansion could
9450 create more than two keys, but that should never
9451 generate mouse events, so it's okay to zero
9452 mock_input in that case too.
9454 FIXME: The above paragraph seems just plain
9455 wrong, if you consider things like
9456 xterm-mouse-mode. -stef
9458 Isn't this just the most wonderful code ever? */
9460 /* If mock_input > t + 1, the above simplification
9461 will actually end up dropping keys on the floor.
9462 This is probably OK for now, but even
9463 if mock_input <= t + 1, we need to adjust indec,
9465 Typical case [header-line down-mouse-N]:
9466 mock_input = 2, t = 1, fkey.end = 1,
9467 last_real_key_start = 0. */
9468 if (indec
.end
> last_real_key_start
)
9470 indec
.end
= indec
.start
9471 = min (last_real_key_start
, indec
.start
);
9472 indec
.map
= indec
.parent
;
9473 if (fkey
.end
> last_real_key_start
)
9475 fkey
.end
= fkey
.start
9476 = min (last_real_key_start
, fkey
.start
);
9477 fkey
.map
= fkey
.parent
;
9478 if (keytran
.end
> last_real_key_start
)
9480 keytran
.end
= keytran
.start
9481 = min (last_real_key_start
, keytran
.start
);
9482 keytran
.map
= keytran
.parent
;
9486 if (t
== last_real_key_start
)
9493 mock_input
= last_real_key_start
;
9494 goto replay_sequence
;
9499 = apply_modifiers (modifiers
, XCAR (breakdown
));
9500 new_click
= list2 (new_head
, EVENT_START (key
));
9502 /* Look for a binding for this new key. */
9503 new_binding
= follow_key (current_binding
, new_click
);
9505 /* If that click is bound, go for it. */
9506 if (!NILP (new_binding
))
9508 current_binding
= new_binding
;
9512 /* Otherwise, we'll leave key set to the drag event. */
9517 current_binding
= new_binding
;
9520 /* Normally, last_nonmenu_event gets the previous key we read.
9521 But when a mouse popup menu is being used,
9522 we don't update last_nonmenu_event; it continues to hold the mouse
9523 event that preceded the first level of menu. */
9524 if (!used_mouse_menu
)
9525 last_nonmenu_event
= key
;
9527 /* Record what part of this_command_keys is the current key sequence. */
9528 this_single_command_key_start
= this_command_key_count
- t
;
9530 /* Look for this sequence in input-decode-map.
9531 Scan from indec.end until we find a bound suffix. */
9532 while (indec
.end
< t
)
9534 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9538 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9539 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9544 mock_input
= diff
+ max (t
, mock_input
);
9545 goto replay_sequence
;
9549 if (!KEYMAPP (current_binding
)
9550 && !test_undefined (current_binding
)
9551 && indec
.start
>= t
)
9552 /* There is a binding and it's not a prefix.
9553 (and it doesn't have any input-decode-map translation pending).
9554 There is thus no function-key in this sequence.
9555 Moving fkey.start is important in this case to allow keytran.start
9556 to go over the sequence before we return (since we keep the
9557 invariant that keytran.end <= fkey.start). */
9560 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9563 /* If the sequence is unbound, see if we can hang a function key
9564 off the end of it. */
9565 /* Continue scan from fkey.end until we find a bound suffix. */
9566 while (fkey
.end
< indec
.start
)
9568 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9572 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9573 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9574 max (t
, mock_input
),
9575 /* If there's a binding (i.e.
9576 first_binding >= nmaps) we don't want
9577 to apply this function-key-mapping. */
9579 && (test_undefined (current_binding
)),
9584 mock_input
= diff
+ max (t
, mock_input
);
9585 /* Adjust the input-decode-map counters. */
9587 indec
.start
+= diff
;
9589 goto replay_sequence
;
9593 /* Look for this sequence in key-translation-map.
9594 Scan from keytran.end until we find a bound suffix. */
9595 while (keytran
.end
< fkey
.start
)
9597 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9601 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9602 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9607 mock_input
= diff
+ max (t
, mock_input
);
9608 /* Adjust the function-key-map and input-decode-map counters. */
9610 indec
.start
+= diff
;
9614 goto replay_sequence
;
9618 /* If KEY is not defined in any of the keymaps,
9619 and cannot be part of a function key or translation,
9620 and is an upper case letter
9621 use the corresponding lower-case letter instead. */
9622 if (NILP (current_binding
)
9623 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9625 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9626 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9627 || (XINT (key
) & shift_modifier
)))
9629 Lisp_Object new_key
;
9631 original_uppercase
= key
;
9632 original_uppercase_position
= t
- 1;
9634 if (XINT (key
) & shift_modifier
)
9635 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9637 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9638 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9640 /* We have to do this unconditionally, regardless of whether
9641 the lower-case char is defined in the keymaps, because they
9642 might get translated through function-key-map. */
9643 keybuf
[t
- 1] = new_key
;
9644 mock_input
= max (t
, mock_input
);
9645 shift_translated
= 1;
9647 goto replay_sequence
;
9649 /* If KEY is not defined in any of the keymaps,
9650 and cannot be part of a function key or translation,
9651 and is a shifted function key,
9652 use the corresponding unshifted function key instead. */
9653 if (NILP (current_binding
)
9654 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9656 Lisp_Object breakdown
= parse_modifiers (key
);
9658 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9660 if (modifiers
& shift_modifier
9661 /* Treat uppercase keys as shifted. */
9663 && (KEY_TO_CHAR (key
)
9664 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9665 && uppercasep (KEY_TO_CHAR (key
))))
9668 = (modifiers
& shift_modifier
9669 ? apply_modifiers (modifiers
& ~shift_modifier
,
9671 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9673 original_uppercase
= key
;
9674 original_uppercase_position
= t
- 1;
9676 /* We have to do this unconditionally, regardless of whether
9677 the lower-case char is defined in the keymaps, because they
9678 might get translated through function-key-map. */
9679 keybuf
[t
- 1] = new_key
;
9680 mock_input
= max (t
, mock_input
);
9681 /* Reset fkey (and consequently keytran) to apply
9682 function-key-map on the result, so that S-backspace is
9683 correctly mapped to DEL (via backspace). OTOH,
9684 input-decode-map doesn't need to go through it again. */
9685 fkey
.start
= fkey
.end
= 0;
9686 keytran
.start
= keytran
.end
= 0;
9687 shift_translated
= 1;
9689 goto replay_sequence
;
9694 read_key_sequence_cmd
= current_binding
;
9695 read_key_sequence_remapped
9696 /* Remap command through active keymaps.
9697 Do the remapping here, before the unbind_to so it uses the keymaps
9698 of the appropriate buffer. */
9699 = SYMBOLP (read_key_sequence_cmd
)
9700 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9703 unread_switch_frame
= delayed_switch_frame
;
9704 unbind_to (count
, Qnil
);
9706 /* Don't downcase the last character if the caller says don't.
9707 Don't downcase it if the result is undefined, either. */
9708 if ((dont_downcase_last
|| NILP (current_binding
))
9710 && t
- 1 == original_uppercase_position
)
9712 keybuf
[t
- 1] = original_uppercase
;
9713 shift_translated
= 0;
9716 if (shift_translated
)
9717 Vthis_command_keys_shift_translated
= Qt
;
9719 /* Occasionally we fabricate events, perhaps by expanding something
9720 according to function-key-map, or by adding a prefix symbol to a
9721 mouse click in the scroll bar or modeline. In this cases, return
9722 the entire generated key sequence, even if we hit an unbound
9723 prefix or a definition before the end. This means that you will
9724 be able to push back the event properly, and also means that
9725 read-key-sequence will always return a logical unit.
9728 for (; t
< mock_input
; t
++)
9730 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9731 && NILP (Fzerop (Vecho_keystrokes
)))
9732 echo_char (keybuf
[t
]);
9733 add_command_key (keybuf
[t
]);
9740 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9741 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9742 The sequence is sufficient to specify a non-prefix command in the
9743 current local and global maps.
9745 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9746 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9747 as a continuation of the previous key.
9749 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9750 convert the last event to lower case. (Normally any upper case event
9751 is converted to lower case if the original event is undefined and the lower
9752 case equivalent is defined.) A non-nil value is appropriate for reading
9753 a key sequence to be defined.
9755 A C-g typed while in this function is treated like any other character,
9756 and `quit-flag' is not set.
9758 If the key sequence starts with a mouse click, then the sequence is read
9759 using the keymaps of the buffer of the window clicked in, not the buffer
9760 of the selected window as normal.
9762 `read-key-sequence' drops unbound button-down events, since you normally
9763 only care about the click or drag events which follow them. If a drag
9764 or multi-click event is unbound, but the corresponding click event would
9765 be bound, `read-key-sequence' turns the event into a click event at the
9766 drag's starting position. This means that you don't have to distinguish
9767 between click and drag, double, or triple events unless you want to.
9769 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9770 lines separating windows, and scroll bars with imaginary keys
9771 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9773 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9774 function will process a switch-frame event if the user switches frames
9775 before typing anything. If the user switches frames in the middle of a
9776 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9777 is nil, then the event will be put off until after the current key sequence.
9779 `read-key-sequence' checks `function-key-map' for function key
9780 sequences, where they wouldn't conflict with ordinary bindings. See
9781 `function-key-map' for more details.
9783 The optional fifth argument CMD-LOOP, if non-nil, means
9784 that this key sequence is being read by something that will
9785 read commands one after another. It should be nil if the caller
9786 will read just one key sequence. */)
9787 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9789 Lisp_Object keybuf
[30];
9791 struct gcpro gcpro1
;
9792 ptrdiff_t count
= SPECPDL_INDEX ();
9795 CHECK_STRING (prompt
);
9798 specbind (Qinput_method_exit_on_first_char
,
9799 (NILP (cmd_loop
) ? Qt
: Qnil
));
9800 specbind (Qinput_method_use_echo_area
,
9801 (NILP (cmd_loop
) ? Qt
: Qnil
));
9803 memset (keybuf
, 0, sizeof keybuf
);
9805 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9807 if (NILP (continue_echo
))
9809 this_command_key_count
= 0;
9810 this_command_key_count_reset
= 0;
9811 this_single_command_key_start
= 0;
9814 #ifdef HAVE_WINDOW_SYSTEM
9815 if (display_hourglass_p
)
9816 cancel_hourglass ();
9819 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9820 prompt
, ! NILP (dont_downcase_last
),
9821 ! NILP (can_return_switch_frame
), 0);
9823 #if 0 /* The following is fine for code reading a key sequence and
9824 then proceeding with a lengthy computation, but it's not good
9825 for code reading keys in a loop, like an input method. */
9826 #ifdef HAVE_WINDOW_SYSTEM
9827 if (display_hourglass_p
)
9838 return unbind_to (count
, make_event_array (i
, keybuf
));
9841 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9842 Sread_key_sequence_vector
, 1, 5, 0,
9843 doc
: /* Like `read-key-sequence' but always return a vector. */)
9844 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9846 Lisp_Object keybuf
[30];
9848 struct gcpro gcpro1
;
9849 ptrdiff_t count
= SPECPDL_INDEX ();
9852 CHECK_STRING (prompt
);
9855 specbind (Qinput_method_exit_on_first_char
,
9856 (NILP (cmd_loop
) ? Qt
: Qnil
));
9857 specbind (Qinput_method_use_echo_area
,
9858 (NILP (cmd_loop
) ? Qt
: Qnil
));
9860 memset (keybuf
, 0, sizeof keybuf
);
9862 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9864 if (NILP (continue_echo
))
9866 this_command_key_count
= 0;
9867 this_command_key_count_reset
= 0;
9868 this_single_command_key_start
= 0;
9871 #ifdef HAVE_WINDOW_SYSTEM
9872 if (display_hourglass_p
)
9873 cancel_hourglass ();
9876 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9877 prompt
, ! NILP (dont_downcase_last
),
9878 ! NILP (can_return_switch_frame
), 0);
9880 #ifdef HAVE_WINDOW_SYSTEM
9881 if (display_hourglass_p
)
9891 return unbind_to (count
, Fvector (i
, keybuf
));
9894 /* Return true if input events are pending. */
9897 detect_input_pending (void)
9899 return input_pending
|| get_input_pending (0);
9902 /* Return true if input events other than mouse movements are
9906 detect_input_pending_ignore_squeezables (void)
9908 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9911 /* Return true if input events are pending, and run any pending timers. */
9914 detect_input_pending_run_timers (bool do_display
)
9916 unsigned old_timers_run
= timers_run
;
9919 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9921 if (old_timers_run
!= timers_run
&& do_display
)
9923 redisplay_preserve_echo_area (8);
9924 /* The following fixes a bug when using lazy-lock with
9925 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9926 from an idle timer function. The symptom of the bug is that
9927 the cursor sometimes doesn't become visible until the next X
9928 event is processed. --gerd. */
9930 Lisp_Object tail
, frame
;
9931 FOR_EACH_FRAME (tail
, frame
)
9932 if (FRAME_RIF (XFRAME (frame
)))
9933 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
9937 return input_pending
;
9940 /* This is called in some cases before a possible quit.
9941 It cases the next call to detect_input_pending to recompute input_pending.
9942 So calling this function unnecessarily can't do any harm. */
9945 clear_input_pending (void)
9950 /* Return true if there are pending requeued events.
9951 This isn't used yet. The hope is to make wait_reading_process_output
9952 call it, and return if it runs Lisp code that unreads something.
9953 The problem is, kbd_buffer_get_event needs to be fixed to know what
9954 to do in that case. It isn't trivial. */
9957 requeued_events_pending_p (void)
9959 return (!NILP (Vunread_command_events
));
9963 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
9964 doc
: /* Return t if command input is currently available with no wait.
9965 Actually, the value is nil only if we can be sure that no input is available;
9966 if there is a doubt, the value is t. */)
9969 if (!NILP (Vunread_command_events
)
9970 || !NILP (Vunread_post_input_method_events
)
9971 || !NILP (Vunread_input_method_events
))
9974 /* Process non-user-visible events (Bug#10195). */
9975 process_special_events ();
9977 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
9978 | READABLE_EVENTS_FILTER_EVENTS
)
9982 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
9983 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
9986 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
9989 if (total_keys
< NUM_RECENT_KEYS
)
9990 return Fvector (total_keys
, keys
);
9993 val
= Fvector (NUM_RECENT_KEYS
, keys
);
9994 vcopy (val
, 0, keys
+ recent_keys_index
,
9995 NUM_RECENT_KEYS
- recent_keys_index
);
9996 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
9997 keys
, recent_keys_index
);
10002 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10003 doc
: /* Return the key sequence that invoked this command.
10004 However, if the command has called `read-key-sequence', it returns
10005 the last key sequence that has been read.
10006 The value is a string or a vector.
10008 See also `this-command-keys-vector'. */)
10011 return make_event_array (this_command_key_count
,
10012 XVECTOR (this_command_keys
)->contents
);
10015 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10016 doc
: /* Return the key sequence that invoked this command, as a vector.
10017 However, if the command has called `read-key-sequence', it returns
10018 the last key sequence that has been read.
10020 See also `this-command-keys'. */)
10023 return Fvector (this_command_key_count
,
10024 XVECTOR (this_command_keys
)->contents
);
10027 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10028 Sthis_single_command_keys
, 0, 0, 0,
10029 doc
: /* Return the key sequence that invoked this command.
10030 More generally, it returns the last key sequence read, either by
10031 the command loop or by `read-key-sequence'.
10032 Unlike `this-command-keys', this function's value
10033 does not include prefix arguments.
10034 The value is always a vector. */)
10037 return Fvector (this_command_key_count
10038 - this_single_command_key_start
,
10039 (XVECTOR (this_command_keys
)->contents
10040 + this_single_command_key_start
));
10043 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10044 Sthis_single_command_raw_keys
, 0, 0, 0,
10045 doc
: /* Return the raw events that were read for this command.
10046 More generally, it returns the last key sequence read, either by
10047 the command loop or by `read-key-sequence'.
10048 Unlike `this-single-command-keys', this function's value
10049 shows the events before all translations (except for input methods).
10050 The value is always a vector. */)
10053 return Fvector (raw_keybuf_count
,
10054 (XVECTOR (raw_keybuf
)->contents
));
10057 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10058 Sreset_this_command_lengths
, 0, 0, 0,
10059 doc
: /* Make the unread events replace the last command and echo.
10060 Used in `universal-argument-other-key'.
10062 `universal-argument-other-key' rereads the event just typed.
10063 It then gets translated through `function-key-map'.
10064 The translated event has to replace the real events,
10065 both in the value of (this-command-keys) and in echoing.
10066 To achieve this, `universal-argument-other-key' calls
10067 `reset-this-command-lengths', which discards the record of reading
10068 these events the first time. */)
10071 this_command_key_count
= before_command_key_count
;
10072 if (this_command_key_count
< this_single_command_key_start
)
10073 this_single_command_key_start
= this_command_key_count
;
10075 echo_truncate (before_command_echo_length
);
10077 /* Cause whatever we put into unread-command-events
10078 to echo as if it were being freshly read from the keyboard. */
10079 this_command_key_count_reset
= 1;
10084 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10085 Sclear_this_command_keys
, 0, 1, 0,
10086 doc
: /* Clear out the vector that `this-command-keys' returns.
10087 Also clear the record of the last 100 events, unless optional arg
10088 KEEP-RECORD is non-nil. */)
10089 (Lisp_Object keep_record
)
10093 this_command_key_count
= 0;
10094 this_command_key_count_reset
= 0;
10096 if (NILP (keep_record
))
10098 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10099 ASET (recent_keys
, i
, Qnil
);
10101 recent_keys_index
= 0;
10106 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10107 doc
: /* Return the current depth in recursive edits. */)
10111 /* Wrap around reliably on integer overflow. */
10112 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10113 XSETINT (temp
, sum
);
10117 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10118 "FOpen dribble file: ",
10119 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10120 If FILE is nil, close any open dribble file.
10121 The file will be closed when Emacs exits. */)
10133 file
= Fexpand_file_name (file
, Qnil
);
10134 dribble
= emacs_fopen (SSDATA (file
), "w");
10136 report_file_error ("Opening dribble", file
);
10141 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10142 doc
: /* Discard the contents of the terminal input buffer.
10143 Also end any kbd macro being defined. */)
10146 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10148 /* Discard the last command from the macro. */
10149 Fcancel_kbd_macro_events ();
10153 Vunread_command_events
= Qnil
;
10155 discard_tty_input ();
10157 kbd_fetch_ptr
= kbd_store_ptr
;
10163 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10164 doc
: /* Stop Emacs and return to superior process. You can resume later.
10165 If `cannot-suspend' is non-nil, or if the system doesn't support job
10166 control, run a subshell instead.
10168 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10169 to be read as terminal input by Emacs's parent, after suspension.
10171 Before suspending, run the normal hook `suspend-hook'.
10172 After resumption run the normal hook `suspend-resume-hook'.
10174 Some operating systems cannot stop the Emacs process and resume it later.
10175 On such systems, Emacs starts a subshell instead of suspending. */)
10176 (Lisp_Object stuffstring
)
10178 ptrdiff_t count
= SPECPDL_INDEX ();
10179 int old_height
, old_width
;
10181 struct gcpro gcpro1
;
10184 if (tty_list
&& tty_list
->next
)
10185 error ("There are other tty frames open; close them before suspending Emacs");
10187 if (!NILP (stuffstring
))
10188 CHECK_STRING (stuffstring
);
10190 /* Run the functions in suspend-hook. */
10191 hook
= intern ("suspend-hook");
10192 Frun_hooks (1, &hook
);
10194 GCPRO1 (stuffstring
);
10195 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10196 reset_all_sys_modes ();
10197 /* sys_suspend can get an error if it tries to fork a subshell
10198 and the system resources aren't available for that. */
10199 record_unwind_protect_void (init_all_sys_modes
);
10200 stuff_buffered_input (stuffstring
);
10201 if (cannot_suspend
)
10205 unbind_to (count
, Qnil
);
10207 /* Check if terminal/window size has changed.
10208 Note that this is not useful when we are running directly
10209 with a window system; but suspend should be disabled in that case. */
10210 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10211 if (width
!= old_width
|| height
!= old_height
)
10212 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10214 /* Run suspend-resume-hook. */
10215 hook
= intern ("suspend-resume-hook");
10216 Frun_hooks (1, &hook
);
10222 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10223 Then in any case stuff anything Emacs has read ahead and not used. */
10226 stuff_buffered_input (Lisp_Object stuffstring
)
10228 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10229 register unsigned char *p
;
10231 if (STRINGP (stuffstring
))
10233 register ptrdiff_t count
;
10235 p
= SDATA (stuffstring
);
10236 count
= SBYTES (stuffstring
);
10237 while (count
-- > 0)
10242 /* Anything we have read ahead, put back for the shell to read. */
10243 /* ?? What should this do when we have multiple keyboards??
10244 Should we ignore anything that was typed in at the "wrong" kboard?
10246 rms: we should stuff everything back into the kboard
10248 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10251 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10252 kbd_fetch_ptr
= kbd_buffer
;
10253 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10254 stuff_char (kbd_fetch_ptr
->code
);
10256 clear_event (kbd_fetch_ptr
);
10260 #endif /* SIGTSTP */
10264 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10266 input_available_clear_time
= time_to_clear
;
10268 /* Tell handle_interrupt to throw back to read_char, */
10269 waiting_for_input
= 1;
10271 /* If handle_interrupt was called before and buffered a C-g,
10272 make it run again now, to avoid timing error. */
10273 if (!NILP (Vquit_flag
))
10274 quit_throw_to_read_char (0);
10278 clear_waiting_for_input (void)
10280 /* Tell handle_interrupt not to throw back to read_char, */
10281 waiting_for_input
= 0;
10282 input_available_clear_time
= 0;
10285 /* The SIGINT handler.
10287 If we have a frame on the controlling tty, we assume that the
10288 SIGINT was generated by C-g, so we call handle_interrupt.
10289 Otherwise, tell QUIT to kill Emacs. */
10292 handle_interrupt_signal (int sig
)
10294 /* See if we have an active terminal on our controlling tty. */
10295 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10298 /* If there are no frames there, let's pretend that we are a
10299 well-behaving UN*X program and quit. We must not call Lisp
10300 in a signal handler, so tell QUIT to exit when it is
10302 Vquit_flag
= Qkill_emacs
;
10306 /* Otherwise, the SIGINT was probably generated by C-g. */
10308 /* Set internal_last_event_frame to the top frame of the
10309 controlling tty, if we have a frame there. We disable the
10310 interrupt key on secondary ttys, so the SIGINT must have come
10311 from the controlling tty. */
10312 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10314 handle_interrupt (1);
10319 deliver_interrupt_signal (int sig
)
10321 deliver_process_signal (sig
, handle_interrupt_signal
);
10325 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10326 of the number of times C-g has been requested. If C-g is pressed
10327 enough times, then quit anyway. See bug#6585. */
10328 static int volatile force_quit_count
;
10330 /* This routine is called at interrupt level in response to C-g.
10332 It is called from the SIGINT handler or kbd_buffer_store_event.
10334 If `waiting_for_input' is non zero, then unless `echoing' is
10335 nonzero, immediately throw back to read_char.
10337 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10338 eval to throw, when it gets a chance. If quit-flag is already
10339 non-nil, it stops the job right away. */
10342 handle_interrupt (bool in_signal_handler
)
10348 /* XXX This code needs to be revised for multi-tty support. */
10349 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10351 if (! in_signal_handler
)
10353 /* If SIGINT isn't blocked, don't let us be interrupted by
10354 a SIGINT. It might be harmful due to non-reentrancy
10355 in I/O functions. */
10357 sigemptyset (&blocked
);
10358 sigaddset (&blocked
, SIGINT
);
10359 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10363 reset_all_sys_modes ();
10367 * On systems which can suspend the current process and return to the original
10368 * shell, this command causes the user to end up back at the shell.
10369 * The "Auto-save" and "Abort" questions are not asked until
10370 * the user elects to return to emacs, at which point he can save the current
10371 * job and either dump core or continue.
10375 /* Perhaps should really fork an inferior shell?
10376 But that would not provide any way to get back
10377 to the original shell, ever. */
10378 printf ("No support for stopping a process on this operating system;\n");
10379 printf ("you can continue or abort.\n");
10380 #endif /* not SIGTSTP */
10382 /* We must remain inside the screen area when the internal terminal
10383 is used. Note that [Enter] is not echoed by dos. */
10384 cursor_to (SELECTED_FRAME (), 0, 0);
10386 /* It doesn't work to autosave while GC is in progress;
10387 the code used for auto-saving doesn't cope with the mark bit. */
10388 if (!gc_in_progress
)
10390 printf ("Auto-save? (y or n) ");
10392 if (((c
= getchar ()) & ~040) == 'Y')
10394 Fdo_auto_save (Qt
, Qnil
);
10396 printf ("\r\nAuto-save done");
10397 #else /* not MSDOS */
10398 printf ("Auto-save done\n");
10399 #endif /* not MSDOS */
10401 while (c
!= '\n') c
= getchar ();
10405 /* During GC, it must be safe to reenable quitting again. */
10406 Vinhibit_quit
= Qnil
;
10409 #endif /* not MSDOS */
10410 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10411 printf ("but will instead do a real quit after garbage collection ends\r\n");
10416 printf ("\r\nAbort? (y or n) ");
10417 #else /* not MSDOS */
10418 printf ("Abort (and dump core)? (y or n) ");
10419 #endif /* not MSDOS */
10421 if (((c
= getchar ()) & ~040) == 'Y')
10423 while (c
!= '\n') c
= getchar ();
10425 printf ("\r\nContinuing...\r\n");
10426 #else /* not MSDOS */
10427 printf ("Continuing...\n");
10428 #endif /* not MSDOS */
10430 init_all_sys_modes ();
10434 /* If executing a function that wants to be interrupted out of
10435 and the user has not deferred quitting by binding `inhibit-quit'
10436 then quit right away. */
10437 if (immediate_quit
&& NILP (Vinhibit_quit
))
10439 struct gl_state_s saved
;
10440 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10442 immediate_quit
= 0;
10443 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10445 GCPRO4 (saved
.object
, saved
.global_code
,
10446 saved
.current_syntax_table
, saved
.old_prop
);
10447 Fsignal (Qquit
, Qnil
);
10452 { /* Else request quit when it's safe. */
10453 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10454 force_quit_count
= count
;
10457 immediate_quit
= 1;
10458 Vinhibit_quit
= Qnil
;
10464 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10466 /* TODO: The longjmp in this call throws the NS event loop integration off,
10467 and it seems to do fine without this. Probably some attention
10468 needs to be paid to the setting of waiting_for_input in
10469 wait_reading_process_output() under HAVE_NS because of the call
10470 to ns_select there (needed because otherwise events aren't picked up
10471 outside of polling since we don't get SIGIO like X and we don't have a
10472 separate event loop thread like W32. */
10474 if (waiting_for_input
&& !echoing
)
10475 quit_throw_to_read_char (in_signal_handler
);
10479 /* Handle a C-g by making read_char return C-g. */
10482 quit_throw_to_read_char (bool from_signal
)
10484 /* When not called from a signal handler it is safe to call
10486 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10487 Fkill_emacs (Qnil
);
10489 /* Prevent another signal from doing this before we finish. */
10490 clear_waiting_for_input ();
10493 Vunread_command_events
= Qnil
;
10495 if (FRAMEP (internal_last_event_frame
)
10496 && !EQ (internal_last_event_frame
, selected_frame
))
10497 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10500 sys_longjmp (getcjmp
, 1);
10503 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10504 Sset_input_interrupt_mode
, 1, 1, 0,
10505 doc
: /* Set interrupt mode of reading keyboard input.
10506 If INTERRUPT is non-nil, Emacs will use input interrupts;
10507 otherwise Emacs uses CBREAK mode.
10509 See also `current-input-mode'. */)
10510 (Lisp_Object interrupt
)
10512 bool new_interrupt_input
;
10513 #ifdef USABLE_SIGIO
10514 #ifdef HAVE_X_WINDOWS
10515 if (x_display_list
!= NULL
)
10517 /* When using X, don't give the user a real choice,
10518 because we haven't implemented the mechanisms to support it. */
10519 new_interrupt_input
= 1;
10522 #endif /* HAVE_X_WINDOWS */
10523 new_interrupt_input
= !NILP (interrupt
);
10524 #else /* not USABLE_SIGIO */
10525 new_interrupt_input
= 0;
10526 #endif /* not USABLE_SIGIO */
10528 if (new_interrupt_input
!= interrupt_input
)
10530 #ifdef POLL_FOR_INPUT
10534 /* this causes startup screen to be restored and messes with the mouse */
10535 reset_all_sys_modes ();
10536 interrupt_input
= new_interrupt_input
;
10537 init_all_sys_modes ();
10539 interrupt_input
= new_interrupt_input
;
10542 #ifdef POLL_FOR_INPUT
10543 poll_suppress_count
= 1;
10550 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10551 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10552 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10553 C-q in key sequences.
10555 This setting only has an effect on tty terminals and only when
10556 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10558 See also `current-input-mode'. */)
10559 (Lisp_Object flow
, Lisp_Object terminal
)
10561 struct terminal
*t
= get_terminal (terminal
, 1);
10562 struct tty_display_info
*tty
;
10563 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10565 tty
= t
->display_info
.tty
;
10567 if (tty
->flow_control
!= !NILP (flow
))
10570 /* This causes startup screen to be restored and messes with the mouse. */
10571 reset_sys_modes (tty
);
10574 tty
->flow_control
= !NILP (flow
);
10577 init_sys_modes (tty
);
10583 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10584 doc
: /* Enable or disable 8-bit input on TERMINAL.
10585 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10586 bit as the Meta modifier.
10588 If META is nil, Emacs will ignore the top bit, on the assumption it is
10591 Otherwise, Emacs will accept and pass through 8-bit input without
10592 specially interpreting the top bit.
10594 This setting only has an effect on tty terminal devices.
10596 Optional parameter TERMINAL specifies the tty terminal device to use.
10597 It may be a terminal object, a frame, or nil for the terminal used by
10598 the currently selected frame.
10600 See also `current-input-mode'. */)
10601 (Lisp_Object meta
, Lisp_Object terminal
)
10603 struct terminal
*t
= get_terminal (terminal
, 1);
10604 struct tty_display_info
*tty
;
10607 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10609 tty
= t
->display_info
.tty
;
10613 else if (EQ (meta
, Qt
))
10618 if (tty
->meta_key
!= new_meta
)
10621 /* this causes startup screen to be restored and messes with the mouse */
10622 reset_sys_modes (tty
);
10625 tty
->meta_key
= new_meta
;
10628 init_sys_modes (tty
);
10634 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10635 doc
: /* Specify character used for quitting.
10636 QUIT must be an ASCII character.
10638 This function only has an effect on the controlling tty of the Emacs
10641 See also `current-input-mode'. */)
10644 struct terminal
*t
= get_named_tty ("/dev/tty");
10645 struct tty_display_info
*tty
;
10646 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10648 tty
= t
->display_info
.tty
;
10650 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10651 error ("QUIT must be an ASCII character");
10654 /* this causes startup screen to be restored and messes with the mouse */
10655 reset_sys_modes (tty
);
10658 /* Don't let this value be out of range. */
10659 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10662 init_sys_modes (tty
);
10668 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10669 doc
: /* Set mode of reading keyboard input.
10670 First arg INTERRUPT non-nil means use input interrupts;
10671 nil means use CBREAK mode.
10672 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10673 (no effect except in CBREAK mode).
10674 Third arg META t means accept 8-bit input (for a Meta key).
10675 META nil means ignore the top bit, on the assumption it is parity.
10676 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10677 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10678 See also `current-input-mode'. */)
10679 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10681 Fset_input_interrupt_mode (interrupt
);
10682 Fset_output_flow_control (flow
, Qnil
);
10683 Fset_input_meta_mode (meta
, Qnil
);
10685 Fset_quit_char (quit
);
10689 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10690 doc
: /* Return information about the way Emacs currently reads keyboard input.
10691 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10692 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10693 nil, Emacs is using CBREAK mode.
10694 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10695 terminal; this does not apply if Emacs uses interrupt-driven input.
10696 META is t if accepting 8-bit input with 8th bit as Meta flag.
10697 META nil means ignoring the top bit, on the assumption it is parity.
10698 META is neither t nor nil if accepting 8-bit input and using
10699 all 8 bits as the character code.
10700 QUIT is the character Emacs currently uses to quit.
10701 The elements of this list correspond to the arguments of
10702 `set-input-mode'. */)
10705 Lisp_Object val
[4];
10706 struct frame
*sf
= XFRAME (selected_frame
);
10708 val
[0] = interrupt_input
? Qt
: Qnil
;
10709 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10711 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10712 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10714 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10721 XSETFASTINT (val
[3], quit_char
);
10723 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10726 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10727 doc
: /* Return position information for pixel coordinates X and Y.
10728 By default, X and Y are relative to text area of the selected window.
10729 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10730 If optional fourth arg WHOLE is non-nil, X is relative to the left
10731 edge of the window.
10733 The return value is similar to a mouse click position:
10734 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10735 IMAGE (DX . DY) (WIDTH . HEIGHT))
10736 The `posn-' functions access elements of such lists. */)
10737 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10742 if (NILP (frame_or_window
))
10743 frame_or_window
= selected_window
;
10745 if (WINDOWP (frame_or_window
))
10747 struct window
*w
= decode_live_window (frame_or_window
);
10749 XSETINT (x
, (XINT (x
)
10750 + WINDOW_LEFT_EDGE_X (w
)
10752 ? window_box_left_offset (w
, TEXT_AREA
)
10754 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10755 frame_or_window
= w
->frame
;
10758 CHECK_LIVE_FRAME (frame_or_window
);
10760 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10763 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10764 doc
: /* Return position information for buffer POS in WINDOW.
10765 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10767 Return nil if position is not visible in window. Otherwise,
10768 the return value is similar to that returned by `event-start' for
10769 a mouse click at the upper left corner of the glyph corresponding
10770 to the given buffer position:
10771 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10772 IMAGE (DX . DY) (WIDTH . HEIGHT))
10773 The `posn-' functions access elements of such lists. */)
10774 (Lisp_Object pos
, Lisp_Object window
)
10779 window
= selected_window
;
10781 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10784 Lisp_Object x
= XCAR (tem
);
10785 Lisp_Object y
= XCAR (XCDR (tem
));
10787 /* Point invisible due to hscrolling? */
10790 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10798 * Set up a new kboard object with reasonable initial values.
10801 init_kboard (KBOARD
*kb
)
10803 kset_overriding_terminal_local_map (kb
, Qnil
);
10804 kset_last_command (kb
, Qnil
);
10805 kset_real_last_command (kb
, Qnil
);
10806 kset_keyboard_translate_table (kb
, Qnil
);
10807 kset_last_repeatable_command (kb
, Qnil
);
10808 kset_prefix_arg (kb
, Qnil
);
10809 kset_last_prefix_arg (kb
, Qnil
);
10810 kset_kbd_queue (kb
, Qnil
);
10811 kb
->kbd_queue_has_data
= 0;
10812 kb
->immediate_echo
= 0;
10813 kset_echo_string (kb
, Qnil
);
10814 kb
->echo_after_prompt
= -1;
10815 kb
->kbd_macro_buffer
= 0;
10816 kb
->kbd_macro_bufsize
= 0;
10817 kset_defining_kbd_macro (kb
, Qnil
);
10818 kset_last_kbd_macro (kb
, Qnil
);
10819 kb
->reference_count
= 0;
10820 kset_system_key_alist (kb
, Qnil
);
10821 kset_system_key_syms (kb
, Qnil
);
10822 kset_window_system (kb
, Qt
); /* Unset. */
10823 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10824 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10825 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10826 kset_default_minibuffer_frame (kb
, Qnil
);
10830 * Destroy the contents of a kboard object, but not the object itself.
10831 * We use this just before deleting it, or if we're going to initialize
10832 * it a second time.
10835 wipe_kboard (KBOARD
*kb
)
10837 xfree (kb
->kbd_macro_buffer
);
10840 /* Free KB and memory referenced from it. */
10843 delete_kboard (KBOARD
*kb
)
10847 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10850 *kbp
= kb
->next_kboard
;
10852 /* Prevent a dangling reference to KB. */
10853 if (kb
== current_kboard
10854 && FRAMEP (selected_frame
)
10855 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10857 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10859 if (current_kboard
== kb
)
10868 init_keyboard (void)
10870 /* This is correct before outermost invocation of the editor loop. */
10871 command_loop_level
= -1;
10872 immediate_quit
= 0;
10873 quit_char
= Ctl ('g');
10874 Vunread_command_events
= Qnil
;
10875 timer_idleness_start_time
= invalid_emacs_time ();
10877 recent_keys_index
= 0;
10878 kbd_fetch_ptr
= kbd_buffer
;
10879 kbd_store_ptr
= kbd_buffer
;
10880 do_mouse_tracking
= Qnil
;
10882 interrupt_input_blocked
= 0;
10883 pending_signals
= 0;
10885 /* This means that command_loop_1 won't try to select anything the first
10887 internal_last_event_frame
= Qnil
;
10888 Vlast_event_frame
= internal_last_event_frame
;
10890 current_kboard
= initial_kboard
;
10891 /* Re-initialize the keyboard again. */
10892 wipe_kboard (current_kboard
);
10893 init_kboard (current_kboard
);
10894 /* A value of nil for Vwindow_system normally means a tty, but we also use
10895 it for the initial terminal since there is no window system there. */
10896 kset_window_system (current_kboard
, Qnil
);
10898 if (!noninteractive
)
10900 /* Before multi-tty support, these handlers used to be installed
10901 only if the current session was a tty session. Now an Emacs
10902 session may have multiple display types, so we always handle
10903 SIGINT. There is special code in handle_interrupt_signal to exit
10904 Emacs on SIGINT when there are no termcap frames on the
10905 controlling terminal. */
10906 struct sigaction action
;
10907 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10908 sigaction (SIGINT
, &action
, 0);
10910 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10911 SIGQUIT and we can't tell which one it will give us. */
10912 sigaction (SIGQUIT
, &action
, 0);
10913 #endif /* not DOS_NT */
10915 #ifdef USABLE_SIGIO
10916 if (!noninteractive
)
10918 struct sigaction action
;
10919 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10920 sigaction (SIGIO
, &action
, 0);
10924 /* Use interrupt input by default, if it works and noninterrupt input
10925 has deficiencies. */
10927 #ifdef INTERRUPT_INPUT
10928 interrupt_input
= 1;
10930 interrupt_input
= 0;
10933 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10936 if (keyboard_init_hook
)
10937 (*keyboard_init_hook
) ();
10939 #ifdef POLL_FOR_INPUT
10941 poll_suppress_count
= 1;
10946 /* This type's only use is in syms_of_keyboard, to initialize the
10947 event header symbols and put properties on them. */
10948 struct event_head
{
10954 static const struct event_head head_table
[] = {
10955 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
10956 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
10957 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
10958 {&Qfocus_in
, "focus-in", &Qfocus_in
},
10959 {&Qfocus_out
, "focus-out", &Qfocus_out
},
10960 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
10961 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
10962 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
10963 /* `select-window' should be handled just like `switch-frame'
10964 in read_key_sequence. */
10965 {&Qselect_window
, "select-window", &Qswitch_frame
}
10969 syms_of_keyboard (void)
10971 pending_funcalls
= Qnil
;
10972 staticpro (&pending_funcalls
);
10974 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
10975 staticpro (&Vlispy_mouse_stem
);
10978 DEFSYM (QCimage
, ":image");
10979 DEFSYM (Qhelp_echo
, "help-echo");
10980 DEFSYM (QCrtl
, ":rtl");
10982 staticpro (&item_properties
);
10983 item_properties
= Qnil
;
10985 staticpro (&tool_bar_item_properties
);
10986 tool_bar_item_properties
= Qnil
;
10987 staticpro (&tool_bar_items_vector
);
10988 tool_bar_items_vector
= Qnil
;
10990 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
10991 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
10992 DEFSYM (Qself_insert_command
, "self-insert-command");
10993 DEFSYM (Qforward_char
, "forward-char");
10994 DEFSYM (Qbackward_char
, "backward-char");
10995 DEFSYM (Qdisabled
, "disabled");
10996 DEFSYM (Qundefined
, "undefined");
10997 DEFSYM (Qpre_command_hook
, "pre-command-hook");
10998 DEFSYM (Qpost_command_hook
, "post-command-hook");
10999 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11000 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11001 DEFSYM (Qfunction_key
, "function-key");
11002 DEFSYM (Qmouse_click
, "mouse-click");
11003 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11004 DEFSYM (Qsave_session
, "save-session");
11005 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11006 DEFSYM (Qmenu_enable
, "menu-enable");
11009 DEFSYM (Qlanguage_change
, "language-change");
11013 DEFSYM (Qdbus_event
, "dbus-event");
11016 #ifdef HAVE_XWIDGETS
11017 Qxwidget_event
= intern ("xwidget-event");
11018 staticpro (&Qxwidget_event
);
11019 #endif /* HAVE_XWIDGETS */
11020 #ifdef USE_FILE_NOTIFY
11021 DEFSYM (Qfile_notify
, "file-notify");
11022 #endif /* USE_FILE_NOTIFY */
11024 DEFSYM (QCenable
, ":enable");
11025 DEFSYM (QCvisible
, ":visible");
11026 DEFSYM (QChelp
, ":help");
11027 DEFSYM (QCfilter
, ":filter");
11028 DEFSYM (QCbutton
, ":button");
11029 DEFSYM (QCkeys
, ":keys");
11030 DEFSYM (QCkey_sequence
, ":key-sequence");
11031 DEFSYM (QCtoggle
, ":toggle");
11032 DEFSYM (QCradio
, ":radio");
11033 DEFSYM (QClabel
, ":label");
11034 DEFSYM (QCvert_only
, ":vert-only");
11036 DEFSYM (Qmode_line
, "mode-line");
11037 DEFSYM (Qvertical_line
, "vertical-line");
11038 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11039 DEFSYM (Qmenu_bar
, "menu-bar");
11041 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11043 DEFSYM (Qabove_handle
, "above-handle");
11044 DEFSYM (Qhandle
, "handle");
11045 DEFSYM (Qbelow_handle
, "below-handle");
11046 DEFSYM (Qup
, "up");
11047 DEFSYM (Qdown
, "down");
11048 DEFSYM (Qtop
, "top");
11049 DEFSYM (Qbottom
, "bottom");
11050 DEFSYM (Qend_scroll
, "end-scroll");
11051 DEFSYM (Qratio
, "ratio");
11053 DEFSYM (Qevent_kind
, "event-kind");
11054 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11055 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11056 DEFSYM (Qmodifier_cache
, "modifier-cache");
11058 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11059 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11061 DEFSYM (Qpolling_period
, "polling-period");
11063 DEFSYM (Qx_set_selection
, "x-set-selection");
11064 DEFSYM (QPRIMARY
, "PRIMARY");
11065 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11066 DEFSYM (Qhandle_select_window
, "handle-select-window");
11068 DEFSYM (Qinput_method_function
, "input-method-function");
11069 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11070 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11072 DEFSYM (Qhelp_form_show
, "help-form-show");
11074 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11075 Fset (Qinput_method_use_echo_area
, Qnil
);
11079 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11081 for (i
= 0; i
< len
; i
++)
11083 const struct event_head
*p
= &head_table
[i
];
11084 *p
->var
= intern_c_string (p
->name
);
11085 staticpro (p
->var
);
11086 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11087 Fput (*p
->var
, Qevent_symbol_elements
, list1 (*p
->var
));
11091 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11092 staticpro (&button_down_location
);
11093 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11094 staticpro (&mouse_syms
);
11095 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11096 / sizeof (lispy_wheel_names
[0])),
11098 staticpro (&wheel_syms
);
11102 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11104 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11105 for (i
= 0; i
< len
; i
++)
11106 if (modifier_names
[i
])
11107 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11108 staticpro (&modifier_symbols
);
11111 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11112 staticpro (&recent_keys
);
11114 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11115 staticpro (&this_command_keys
);
11117 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11118 staticpro (&raw_keybuf
);
11120 DEFSYM (Qcommand_execute
, "command-execute");
11122 accent_key_syms
= Qnil
;
11123 staticpro (&accent_key_syms
);
11125 func_key_syms
= Qnil
;
11126 staticpro (&func_key_syms
);
11128 drag_n_drop_syms
= Qnil
;
11129 staticpro (&drag_n_drop_syms
);
11131 unread_switch_frame
= Qnil
;
11132 staticpro (&unread_switch_frame
);
11134 internal_last_event_frame
= Qnil
;
11135 staticpro (&internal_last_event_frame
);
11137 read_key_sequence_cmd
= Qnil
;
11138 staticpro (&read_key_sequence_cmd
);
11139 read_key_sequence_remapped
= Qnil
;
11140 staticpro (&read_key_sequence_remapped
);
11142 menu_bar_one_keymap_changed_items
= Qnil
;
11143 staticpro (&menu_bar_one_keymap_changed_items
);
11145 menu_bar_items_vector
= Qnil
;
11146 staticpro (&menu_bar_items_vector
);
11148 help_form_saved_window_configs
= Qnil
;
11149 staticpro (&help_form_saved_window_configs
);
11151 defsubr (&Scurrent_idle_time
);
11152 defsubr (&Sevent_symbol_parse_modifiers
);
11153 defsubr (&Sevent_convert_list
);
11154 defsubr (&Sread_key_sequence
);
11155 defsubr (&Sread_key_sequence_vector
);
11156 defsubr (&Srecursive_edit
);
11157 defsubr (&Strack_mouse
);
11158 defsubr (&Sinput_pending_p
);
11159 defsubr (&Srecent_keys
);
11160 defsubr (&Sthis_command_keys
);
11161 defsubr (&Sthis_command_keys_vector
);
11162 defsubr (&Sthis_single_command_keys
);
11163 defsubr (&Sthis_single_command_raw_keys
);
11164 defsubr (&Sreset_this_command_lengths
);
11165 defsubr (&Sclear_this_command_keys
);
11166 defsubr (&Ssuspend_emacs
);
11167 defsubr (&Sabort_recursive_edit
);
11168 defsubr (&Sexit_recursive_edit
);
11169 defsubr (&Srecursion_depth
);
11170 defsubr (&Stop_level
);
11171 defsubr (&Sdiscard_input
);
11172 defsubr (&Sopen_dribble_file
);
11173 defsubr (&Sset_input_interrupt_mode
);
11174 defsubr (&Sset_output_flow_control
);
11175 defsubr (&Sset_input_meta_mode
);
11176 defsubr (&Sset_quit_char
);
11177 defsubr (&Sset_input_mode
);
11178 defsubr (&Scurrent_input_mode
);
11179 defsubr (&Sposn_at_point
);
11180 defsubr (&Sposn_at_x_y
);
11182 DEFVAR_LISP ("last-command-event", last_command_event
,
11183 doc
: /* Last input event that was part of a command. */);
11185 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11186 doc
: /* Last input event in a command, except for mouse menu events.
11187 Mouse menus give back keys that don't look like mouse events;
11188 this variable holds the actual mouse event that led to the menu,
11189 so that you can determine whether the command was run by mouse or not. */);
11191 DEFVAR_LISP ("last-input-event", last_input_event
,
11192 doc
: /* Last input event. */);
11194 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11195 doc
: /* List of events to be read as the command input.
11196 These events are processed first, before actual keyboard input.
11197 Events read from this list are not normally added to `this-command-keys',
11198 as they will already have been added once as they were read for the first time.
11199 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11200 Vunread_command_events
= Qnil
;
11202 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11203 doc
: /* List of events to be processed as input by input methods.
11204 These events are processed before `unread-command-events'
11205 and actual keyboard input, but are not given to `input-method-function'. */);
11206 Vunread_post_input_method_events
= Qnil
;
11208 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11209 doc
: /* List of events to be processed as input by input methods.
11210 These events are processed after `unread-command-events', but
11211 before actual keyboard input.
11212 If there's an active input method, the events are given to
11213 `input-method-function'. */);
11214 Vunread_input_method_events
= Qnil
;
11216 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11217 doc
: /* Meta-prefix character code.
11218 Meta-foo as command input turns into this character followed by foo. */);
11219 XSETINT (meta_prefix_char
, 033);
11221 DEFVAR_KBOARD ("last-command", Vlast_command
,
11222 doc
: /* The last command executed.
11223 Normally a symbol with a function definition, but can be whatever was found
11224 in the keymap, or whatever the variable `this-command' was set to by that
11227 The value `mode-exit' is special; it means that the previous command
11228 read an event that told it to exit, and it did so and unread that event.
11229 In other words, the present command is the event that made the previous
11232 The value `kill-region' is special; it means that the previous command
11233 was a kill command.
11235 `last-command' has a separate binding for each terminal device.
11236 See Info node `(elisp)Multiple Terminals'. */);
11238 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11239 doc
: /* Same as `last-command', but never altered by Lisp code.
11240 Taken from the previous value of `real-this-command'. */);
11242 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11243 doc
: /* Last command that may be repeated.
11244 The last command executed that was not bound to an input event.
11245 This is the command `repeat' will try to repeat.
11246 Taken from a previous value of `real-this-command'. */);
11248 DEFVAR_LISP ("this-command", Vthis_command
,
11249 doc
: /* The command now being executed.
11250 The command can set this variable; whatever is put here
11251 will be in `last-command' during the following command. */);
11252 Vthis_command
= Qnil
;
11254 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11255 doc
: /* This is like `this-command', except that commands should never modify it. */);
11256 Vreal_this_command
= Qnil
;
11258 DEFVAR_LISP ("this-command-keys-shift-translated",
11259 Vthis_command_keys_shift_translated
,
11260 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11261 Shift-translation occurs when there is no binding for the key sequence
11262 as entered, but a binding was found by changing an upper-case letter
11263 to lower-case, or a shifted function key to an unshifted one. */);
11264 Vthis_command_keys_shift_translated
= Qnil
;
11266 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11267 doc
: /* The command bound to the current key sequence before remapping.
11268 It equals `this-command' if the original command was not remapped through
11269 any of the active keymaps. Otherwise, the value of `this-command' is the
11270 result of looking up the original command in the active keymaps. */);
11271 Vthis_original_command
= Qnil
;
11273 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11274 doc
: /* Number of input events between auto-saves.
11275 Zero means disable autosaving due to number of characters typed. */);
11276 auto_save_interval
= 300;
11278 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11279 doc
: /* Number of seconds idle time before auto-save.
11280 Zero or nil means disable auto-saving due to idleness.
11281 After auto-saving due to this many seconds of idle time,
11282 Emacs also does a garbage collection if that seems to be warranted. */);
11283 XSETFASTINT (Vauto_save_timeout
, 30);
11285 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11286 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11287 The value may be integer or floating point.
11288 If the value is zero, don't echo at all. */);
11289 Vecho_keystrokes
= make_number (1);
11291 DEFVAR_INT ("polling-period", polling_period
,
11292 doc
: /* Interval between polling for input during Lisp execution.
11293 The reason for polling is to make C-g work to stop a running program.
11294 Polling is needed only when using X windows and SIGIO does not work.
11295 Polling is automatically disabled in all other cases. */);
11296 polling_period
= 2;
11298 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11299 doc
: /* Maximum time between mouse clicks to make a double-click.
11300 Measured in milliseconds. The value nil means disable double-click
11301 recognition; t means double-clicks have no time limit and are detected
11302 by position only. */);
11303 Vdouble_click_time
= make_number (500);
11305 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11306 doc
: /* Maximum mouse movement between clicks to make a double-click.
11307 On window-system frames, value is the number of pixels the mouse may have
11308 moved horizontally or vertically between two clicks to make a double-click.
11309 On non window-system frames, value is interpreted in units of 1/8 characters
11312 This variable is also the threshold for motion of the mouse
11313 to count as a drag. */);
11314 double_click_fuzz
= 3;
11316 DEFVAR_INT ("num-input-keys", num_input_keys
,
11317 doc
: /* Number of complete key sequences read as input so far.
11318 This includes key sequences read from keyboard macros.
11319 The number is effectively the number of interactive command invocations. */);
11320 num_input_keys
= 0;
11322 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11323 doc
: /* Number of input events read from the keyboard so far.
11324 This does not include events generated by keyboard macros. */);
11325 num_nonmacro_input_events
= 0;
11327 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11328 doc
: /* The frame in which the most recently read event occurred.
11329 If the last event came from a keyboard macro, this is set to `macro'. */);
11330 Vlast_event_frame
= Qnil
;
11332 /* This variable is set up in sysdep.c. */
11333 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11334 doc
: /* The ERASE character as set by the user with stty. */);
11336 DEFVAR_LISP ("help-char", Vhelp_char
,
11337 doc
: /* Character to recognize as meaning Help.
11338 When it is read, do `(eval help-form)', and display result if it's a string.
11339 If the value of `help-form' is nil, this char can be read normally. */);
11340 XSETINT (Vhelp_char
, Ctl ('H'));
11342 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11343 doc
: /* List of input events to recognize as meaning Help.
11344 These work just like the value of `help-char' (see that). */);
11345 Vhelp_event_list
= Qnil
;
11347 DEFVAR_LISP ("help-form", Vhelp_form
,
11348 doc
: /* Form to execute when character `help-char' is read.
11349 If the form returns a string, that string is displayed.
11350 If `help-form' is nil, the help char is not recognized. */);
11353 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11354 doc
: /* Command to run when `help-char' character follows a prefix key.
11355 This command is used only when there is no actual binding
11356 for that character after that prefix key. */);
11357 Vprefix_help_command
= Qnil
;
11359 DEFVAR_LISP ("top-level", Vtop_level
,
11360 doc
: /* Form to evaluate when Emacs starts up.
11361 Useful to set before you dump a modified Emacs. */);
11364 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11365 doc
: /* Translate table for local keyboard input, or nil.
11366 If non-nil, the value should be a char-table. Each character read
11367 from the keyboard is looked up in this char-table. If the value found
11368 there is non-nil, then it is used instead of the actual input character.
11370 The value can also be a string or vector, but this is considered obsolete.
11371 If it is a string or vector of length N, character codes N and up are left
11372 untranslated. In a vector, an element which is nil means "no translation".
11374 This is applied to the characters supplied to input methods, not their
11375 output. See also `translation-table-for-input'.
11377 This variable has a separate binding for each terminal.
11378 See Info node `(elisp)Multiple Terminals'. */);
11380 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11381 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11382 \(Even if the operating system has support for stopping a process.\) */);
11383 cannot_suspend
= 0;
11385 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11386 doc
: /* Non-nil means prompt with menus when appropriate.
11387 This is done when reading from a keymap that has a prompt string,
11388 for elements that have prompt strings.
11389 The menu is displayed on the screen
11390 if X menus were enabled at configuration
11391 time and the previous event was a mouse click prefix key.
11392 Otherwise, menu prompting uses the echo area. */);
11393 menu_prompting
= 1;
11395 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11396 doc
: /* Character to see next line of menu prompt.
11397 Type this character while in a menu prompt to rotate around the lines of it. */);
11398 XSETINT (menu_prompt_more_char
, ' ');
11400 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11401 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11402 Emacs applies the modifiers of the character stored here to each keyboard
11403 character it reads. For example, after evaluating the expression
11404 (setq extra-keyboard-modifiers ?\\C-x)
11405 all input characters will have the control modifier applied to them.
11407 Note that the character ?\\C-@, equivalent to the integer zero, does
11408 not count as a control character; rather, it counts as a character
11409 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11410 cancels any modification. */);
11411 extra_keyboard_modifiers
= 0;
11413 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11414 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11415 The command loop sets this to nil before each command,
11416 and tests the value when the command returns.
11417 Buffer modification stores t in this variable. */);
11418 Vdeactivate_mark
= Qnil
;
11419 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11421 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11422 doc
: /* Normal hook run before each command is executed.
11423 If an unhandled error happens in running this hook,
11424 the function in which the error occurred is unconditionally removed, since
11425 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11426 Vpre_command_hook
= Qnil
;
11428 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11429 doc
: /* Normal hook run after each command is executed.
11430 If an unhandled error happens in running this hook,
11431 the function in which the error occurred is unconditionally removed, since
11432 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11433 Vpost_command_hook
= Qnil
;
11436 DEFVAR_LISP ("echo-area-clear-hook", ...,
11437 doc
: /* Normal hook run when clearing the echo area. */);
11439 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11440 Fset (Qecho_area_clear_hook
, Qnil
);
11442 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11443 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11444 Vlucid_menu_bar_dirty_flag
= Qnil
;
11446 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11447 doc
: /* List of menu bar items to move to the end of the menu bar.
11448 The elements of the list are event types that may have menu bar bindings. */);
11449 Vmenu_bar_final_items
= Qnil
;
11451 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11452 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11453 This is used internally by graphical displays that do not render
11454 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11455 Vtool_bar_separator_image_expression
= Qnil
;
11457 DEFVAR_KBOARD ("overriding-terminal-local-map",
11458 Voverriding_terminal_local_map
,
11459 doc
: /* Per-terminal keymap that takes precedence over all other keymaps.
11461 This variable is intended to let commands such as `universal-argument'
11462 set up a different keymap for reading the next command.
11464 `overriding-terminal-local-map' has a separate binding for each
11466 See Info node `(elisp)Multiple Terminals'. */);
11468 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11469 doc
: /* Keymap that overrides almost all other local keymaps.
11470 If this variable is non-nil, it is used as a keymap--replacing the
11471 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11472 Voverriding_local_map
= Qnil
;
11474 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11475 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11476 Otherwise, the menu bar continues to reflect the buffer's local map
11477 and the minor mode maps regardless of `overriding-local-map'. */);
11478 Voverriding_local_map_menu_flag
= Qnil
;
11480 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11481 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11482 Vspecial_event_map
= list1 (intern_c_string ("keymap"));
11484 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11485 doc
: /* Non-nil means generate motion events for mouse motion. */);
11487 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11488 doc
: /* Alist of system-specific X windows key symbols.
11489 Each element should have the form (N . SYMBOL) where N is the
11490 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11491 and SYMBOL is its name.
11493 `system-key-alist' has a separate binding for each terminal device.
11494 See Info node `(elisp)Multiple Terminals'. */);
11496 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11497 doc
: /* Keymap that translates key sequences to key sequences during input.
11498 This is used mainly for mapping key sequences into some preferred
11499 key events (symbols).
11501 The `read-key-sequence' function replaces any subsequence bound by
11502 `local-function-key-map' with its binding. More precisely, when the
11503 active keymaps have no binding for the current key sequence but
11504 `local-function-key-map' binds a suffix of the sequence to a vector or
11505 string, `read-key-sequence' replaces the matching suffix with its
11506 binding, and continues with the new sequence.
11508 If the binding is a function, it is called with one argument (the prompt)
11509 and its return value (a key sequence) is used.
11511 The events that come from bindings in `local-function-key-map' are not
11512 themselves looked up in `local-function-key-map'.
11514 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11515 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11516 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11517 typing `ESC O P x' would return [f1 x].
11519 `local-function-key-map' has a separate binding for each terminal
11520 device. See Info node `(elisp)Multiple Terminals'. If you need to
11521 define a binding on all terminals, change `function-key-map'
11522 instead. Initially, `local-function-key-map' is an empty keymap that
11523 has `function-key-map' as its parent on all terminal devices. */);
11525 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11526 doc
: /* Keymap that decodes input escape sequences.
11527 This is used mainly for mapping ASCII function key sequences into
11528 real Emacs function key events (symbols).
11530 The `read-key-sequence' function replaces any subsequence bound by
11531 `input-decode-map' with its binding. Contrary to `function-key-map',
11532 this map applies its rebinding regardless of the presence of an ordinary
11533 binding. So it is more like `key-translation-map' except that it applies
11534 before `function-key-map' rather than after.
11536 If the binding is a function, it is called with one argument (the prompt)
11537 and its return value (a key sequence) is used.
11539 The events that come from bindings in `input-decode-map' are not
11540 themselves looked up in `input-decode-map'. */);
11542 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11543 doc
: /* The parent keymap of all `local-function-key-map' instances.
11544 Function key definitions that apply to all terminal devices should go
11545 here. If a mapping is defined in both the current
11546 `local-function-key-map' binding and this variable, then the local
11547 definition will take precedence. */);
11548 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11550 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11551 doc
: /* Keymap of key translations that can override keymaps.
11552 This keymap works like `input-decode-map', but comes after `function-key-map'.
11553 Another difference is that it is global rather than terminal-local. */);
11554 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11556 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11557 doc
: /* List of deferred actions to be performed at a later time.
11558 The precise format isn't relevant here; we just check whether it is nil. */);
11559 Vdeferred_action_list
= Qnil
;
11561 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11562 doc
: /* Function to call to handle deferred actions, after each command.
11563 This function is called with no arguments after each command
11564 whenever `deferred-action-list' is non-nil. */);
11565 Vdeferred_action_function
= Qnil
;
11567 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11568 doc
: /* List of warnings to be displayed after this command.
11569 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11570 as per the args of `display-warning' (which see).
11571 If this variable is non-nil, `delayed-warnings-hook' will be run
11572 immediately after running `post-command-hook'. */);
11573 Vdelayed_warnings_list
= Qnil
;
11575 DEFVAR_LISP ("timer-list", Vtimer_list
,
11576 doc
: /* List of active absolute time timers in order of increasing time. */);
11577 Vtimer_list
= Qnil
;
11579 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11580 doc
: /* List of active idle-time timers in order of increasing time. */);
11581 Vtimer_idle_list
= Qnil
;
11583 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11584 doc
: /* If non-nil, the function that implements the current input method.
11585 It's called with one argument, a printing character that was just read.
11586 \(That means a character with code 040...0176.)
11587 Typically this function uses `read-event' to read additional events.
11588 When it does so, it should first bind `input-method-function' to nil
11589 so it will not be called recursively.
11591 The function should return a list of zero or more events
11592 to be used as input. If it wants to put back some events
11593 to be reconsidered, separately, by the input method,
11594 it can add them to the beginning of `unread-command-events'.
11596 The input method function can find in `input-method-previous-message'
11597 the previous echo area message.
11599 The input method function should refer to the variables
11600 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11601 for guidance on what to do. */);
11602 Vinput_method_function
= Qnil
;
11604 DEFVAR_LISP ("input-method-previous-message",
11605 Vinput_method_previous_message
,
11606 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11607 This variable exists because `read-event' clears the echo area
11608 before running the input method. It is nil if there was no message. */);
11609 Vinput_method_previous_message
= Qnil
;
11611 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11612 doc
: /* If non-nil, the function that implements the display of help.
11613 It's called with one argument, the help string to display. */);
11614 Vshow_help_function
= Qnil
;
11616 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11617 doc
: /* If non-nil, suppress point adjustment after executing a command.
11619 After a command is executed, if point is moved into a region that has
11620 special properties (e.g. composition, display), we adjust point to
11621 the boundary of the region. But, when a command sets this variable to
11622 non-nil, we suppress the point adjustment.
11624 This variable is set to nil before reading a command, and is checked
11625 just after executing the command. */);
11626 Vdisable_point_adjustment
= Qnil
;
11628 DEFVAR_LISP ("global-disable-point-adjustment",
11629 Vglobal_disable_point_adjustment
,
11630 doc
: /* If non-nil, always suppress point adjustment.
11632 The default value is nil, in which case, point adjustment are
11633 suppressed only after special commands that set
11634 `disable-point-adjustment' (which see) to non-nil. */);
11635 Vglobal_disable_point_adjustment
= Qnil
;
11637 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11638 doc
: /* How long to display an echo-area message when the minibuffer is active.
11639 If the value is not a number, such messages don't time out. */);
11640 Vminibuffer_message_timeout
= make_number (2);
11642 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11643 doc
: /* If non-nil, any keyboard input throws to this symbol.
11644 The value of that variable is passed to `quit-flag' and later causes a
11645 peculiar kind of quitting. */);
11646 Vthrow_on_input
= Qnil
;
11648 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11649 doc
: /* If non-nil, function to output error messages.
11650 The arguments are the error data, a list of the form
11651 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11652 such as just as `condition-case' would bind its variable to,
11653 the context (a string which normally goes at the start of the message),
11654 and the Lisp function within which the error was signaled. */);
11655 Vcommand_error_function
= Qnil
;
11657 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11658 Venable_disabled_menus_and_buttons
,
11659 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11661 Help functions bind this to allow help on disabled menu items
11662 and tool-bar buttons. */);
11663 Venable_disabled_menus_and_buttons
= Qnil
;
11665 DEFVAR_LISP ("select-active-regions",
11666 Vselect_active_regions
,
11667 doc
: /* If non-nil, an active region automatically sets the primary selection.
11668 If the value is `only', only temporarily active regions (usually made
11669 by mouse-dragging or shift-selection) set the window selection.
11671 This takes effect only when Transient Mark mode is enabled. */);
11672 Vselect_active_regions
= Qt
;
11674 DEFVAR_LISP ("saved-region-selection",
11675 Vsaved_region_selection
,
11676 doc
: /* Contents of active region prior to buffer modification.
11677 If `select-active-regions' is non-nil, Emacs sets this to the
11678 text in the region before modifying the buffer. The next call to
11679 the function `deactivate-mark' uses this to set the window selection. */);
11680 Vsaved_region_selection
= Qnil
;
11682 DEFVAR_LISP ("selection-inhibit-update-commands",
11683 Vselection_inhibit_update_commands
,
11684 doc
: /* List of commands which should not update the selection.
11685 Normally, if `select-active-regions' is non-nil and the mark remains
11686 active after a command (i.e. the mark was not deactivated), the Emacs
11687 command loop sets the selection to the text in the region. However,
11688 if the command is in this list, the selection is not updated. */);
11689 Vselection_inhibit_update_commands
11690 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11692 DEFVAR_LISP ("debug-on-event",
11694 doc
: /* Enter debugger on this event. When Emacs
11695 receives the special event specified by this variable, it will try to
11696 break into the debugger as soon as possible instead of processing the
11697 event normally through `special-event-map'.
11699 Currently, the only supported values for this
11700 variable are `sigusr1' and `sigusr2'. */);
11701 Vdebug_on_event
= intern_c_string ("sigusr2");
11703 /* Create the initial keyboard. */
11704 initial_kboard
= xmalloc (sizeof *initial_kboard
);
11705 init_kboard (initial_kboard
);
11706 /* Vwindow_system is left at t for now. */
11707 initial_kboard
->next_kboard
= all_kboards
;
11708 all_kboards
= initial_kboard
;
11712 keys_of_keyboard (void)
11714 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11715 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11716 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11717 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11718 initial_define_key (meta_map
, 'x', "execute-extended-command");
11720 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11721 "handle-delete-frame");
11722 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11723 "ns-put-working-text");
11724 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11725 "ns-unput-working-text");
11726 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11727 current-prefix-arg, as is done in `handle-switch-frame'.
11728 But `handle-switch-frame is not run from the special-map.
11729 Commands from that map are run in a special way that automatically
11730 preserves the prefix-arg. Restoring the prefix arg here is not just
11731 redundant but harmful:
11733 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11734 - after the first prompt, the exit-minibuffer-hook is run which may
11735 iconify a frame and thus push a `iconify-frame' event.
11736 - after running exit-minibuffer-hook, current-prefix-arg is
11737 restored to the non-nil value it had before the prompt.
11738 - we enter the second prompt.
11739 current-prefix-arg is non-nil, prefix-arg is nil.
11740 - before running the first real event, we run the special iconify-frame
11741 event, but we pass the `special' arg to execute-command so
11742 current-prefix-arg and prefix-arg are left untouched.
11743 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11744 - the next key event will have a spuriously non-nil current-prefix-arg. */
11745 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11747 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11749 /* Handling it at such a low-level causes read_key_sequence to get
11750 * confused because it doesn't realize that the current_buffer was
11751 * changed by read_char.
11753 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11754 * "handle-select-window"); */
11755 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11756 "handle-save-session");
11759 /* Define a special event which is raised for dbus callback
11761 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11762 "dbus-handle-event");
11765 #ifdef USE_FILE_NOTIFY
11766 /* Define a special event which is raised for notification callback
11768 initial_define_lispy_key (Vspecial_event_map
, "file-notify",
11769 "file-notify-handle-event");
11770 #endif /* USE_FILE_NOTIFY */
11772 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11774 #if defined (WINDOWSNT)
11775 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11778 initial_define_lispy_key (Vspecial_event_map
, "focus-in",
11779 "handle-focus-in");
11780 initial_define_lispy_key (Vspecial_event_map
, "focus-out",
11781 "handle-focus-out");
11784 /* Mark the pointers in the kboard objects.
11785 Called by Fgarbage_collect. */
11787 mark_kboards (void)
11791 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11793 if (kb
->kbd_macro_buffer
)
11794 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11796 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11797 mark_object (KVAR (kb
, Vlast_command
));
11798 mark_object (KVAR (kb
, Vreal_last_command
));
11799 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11800 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11801 mark_object (KVAR (kb
, Vprefix_arg
));
11802 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11803 mark_object (KVAR (kb
, kbd_queue
));
11804 mark_object (KVAR (kb
, defining_kbd_macro
));
11805 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11806 mark_object (KVAR (kb
, Vsystem_key_alist
));
11807 mark_object (KVAR (kb
, system_key_syms
));
11808 mark_object (KVAR (kb
, Vwindow_system
));
11809 mark_object (KVAR (kb
, Vinput_decode_map
));
11810 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11811 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11812 mark_object (KVAR (kb
, echo_string
));
11815 struct input_event
*event
;
11816 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11818 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11819 event
= kbd_buffer
;
11820 /* These two special event types has no Lisp_Objects to mark. */
11821 if (event
->kind
!= SELECTION_REQUEST_EVENT
11822 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11824 mark_object (event
->x
);
11825 mark_object (event
->y
);
11826 mark_object (event
->frame_or_window
);
11827 mark_object (event
->arg
);