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 buffer that was current when the last command was started. */
214 static Lisp_Object last_point_position_buffer
;
216 /* The window that was selected when the last command was started. */
217 static Lisp_Object last_point_position_window
;
219 /* The frame in which the last input event occurred, or Qmacro if the
220 last event came from a macro. We use this to determine when to
221 generate switch-frame events. This may be cleared by functions
222 like Fselect_frame, to make sure that a switch-frame event is
223 generated by the next character.
225 FIXME: This is modified by a signal handler so it should be volatile.
226 It's exported to Lisp, though, so it can't simply be marked
228 Lisp_Object internal_last_event_frame
;
230 /* The timestamp of the last input event we received from the X server.
231 X Windows wants this for selection ownership. */
232 Time last_event_timestamp
;
234 static Lisp_Object Qx_set_selection
, Qhandle_switch_frame
;
235 static Lisp_Object Qhandle_select_window
;
236 Lisp_Object QPRIMARY
;
238 static Lisp_Object Qself_insert_command
;
239 static Lisp_Object Qforward_char
;
240 static Lisp_Object Qbackward_char
;
241 Lisp_Object Qundefined
;
242 static Lisp_Object Qtimer_event_handler
;
244 /* read_key_sequence stores here the command definition of the
245 key sequence that it reads. */
246 static Lisp_Object read_key_sequence_cmd
;
247 static Lisp_Object read_key_sequence_remapped
;
249 static Lisp_Object Qinput_method_function
;
251 static Lisp_Object Qdeactivate_mark
;
253 Lisp_Object Qrecompute_lucid_menubar
, Qactivate_menubar_hook
;
255 static Lisp_Object Qecho_area_clear_hook
;
257 /* Hooks to run before and after each command. */
258 static Lisp_Object Qpre_command_hook
;
259 static Lisp_Object Qpost_command_hook
;
261 static Lisp_Object Qdeferred_action_function
;
263 static Lisp_Object Qdelayed_warnings_hook
;
265 static Lisp_Object Qinput_method_exit_on_first_char
;
266 static Lisp_Object Qinput_method_use_echo_area
;
268 static Lisp_Object Qhelp_form_show
;
270 /* File in which we write all commands we read. */
271 static FILE *dribble
;
273 /* Nonzero if input is available. */
276 /* Circular buffer for pre-read keyboard input. */
278 static struct input_event kbd_buffer
[KBD_BUFFER_SIZE
];
280 /* Pointer to next available character in kbd_buffer.
281 If kbd_fetch_ptr == kbd_store_ptr, the buffer is empty.
282 This may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the
283 next available char is in kbd_buffer[0]. */
284 static struct input_event
*kbd_fetch_ptr
;
286 /* Pointer to next place to store character in kbd_buffer. This
287 may be kbd_buffer + KBD_BUFFER_SIZE, meaning that the next
288 character should go in kbd_buffer[0]. */
289 static struct input_event
* volatile kbd_store_ptr
;
291 /* The above pair of variables forms a "queue empty" flag. When we
292 enqueue a non-hook event, we increment kbd_store_ptr. When we
293 dequeue a non-hook event, we increment kbd_fetch_ptr. We say that
294 there is input available if the two pointers are not equal.
296 Why not just have a flag set and cleared by the enqueuing and
297 dequeuing functions? Such a flag could be screwed up by interrupts
298 at inopportune times. */
300 /* Symbols to head events. */
301 static Lisp_Object Qmouse_movement
;
302 static Lisp_Object Qscroll_bar_movement
;
303 Lisp_Object Qswitch_frame
;
304 static Lisp_Object Qdelete_frame
;
305 static Lisp_Object Qiconify_frame
;
306 static Lisp_Object Qmake_frame_visible
;
307 static Lisp_Object Qselect_window
;
308 Lisp_Object Qhelp_echo
;
310 static Lisp_Object Qmouse_fixup_help_message
;
312 /* Symbols to denote kinds of events. */
313 static Lisp_Object Qfunction_key
;
314 Lisp_Object Qmouse_click
;
316 Lisp_Object Qlanguage_change
;
318 Lisp_Object Qfile_w32notify
;
321 static Lisp_Object Qdrag_n_drop
;
322 static Lisp_Object Qsave_session
;
324 static Lisp_Object Qdbus_event
;
327 static Lisp_Object Qfile_inotify
;
328 #endif /* HAVE_INOTIFY */
329 static Lisp_Object Qconfig_changed_event
;
331 /* Lisp_Object Qmouse_movement; - also an event header */
333 /* Properties of event headers. */
334 Lisp_Object Qevent_kind
;
335 static Lisp_Object Qevent_symbol_elements
;
337 /* Menu and tool bar item parts. */
338 static Lisp_Object Qmenu_enable
;
339 static Lisp_Object QCenable
, QCvisible
, QChelp
, QCkeys
, QCkey_sequence
;
340 Lisp_Object QCfilter
;
342 /* Non-nil disable property on a command means
343 do not execute it; call disabled-command-function's value instead. */
344 Lisp_Object QCtoggle
, QCradio
;
345 static Lisp_Object QCbutton
, QClabel
;
347 static Lisp_Object QCvert_only
;
349 /* An event header symbol HEAD may have a property named
350 Qevent_symbol_element_mask, which is of the form (BASE MODIFIERS);
351 BASE is the base, unmodified version of HEAD, and MODIFIERS is the
352 mask of modifiers applied to it. If present, this is used to help
353 speed up parse_modifiers. */
354 Lisp_Object Qevent_symbol_element_mask
;
356 /* An unmodified event header BASE may have a property named
357 Qmodifier_cache, which is an alist mapping modifier masks onto
358 modified versions of BASE. If present, this helps speed up
360 static Lisp_Object Qmodifier_cache
;
362 /* Symbols to use for parts of windows. */
363 Lisp_Object Qmode_line
;
364 Lisp_Object Qvertical_line
;
365 static Lisp_Object Qvertical_scroll_bar
;
366 Lisp_Object Qmenu_bar
;
368 static Lisp_Object
recursive_edit_unwind (Lisp_Object buffer
);
369 static Lisp_Object
command_loop (void);
370 static Lisp_Object Qextended_command_history
;
371 EMACS_TIME
timer_check (void);
373 static void echo_now (void);
374 static ptrdiff_t echo_length (void);
376 static Lisp_Object Qpolling_period
;
378 /* Incremented whenever a timer is run. */
381 /* Address (if not 0) of EMACS_TIME to zero out if a SIGIO interrupt
383 EMACS_TIME
*input_available_clear_time
;
385 /* True means use SIGIO interrupts; false means use CBREAK mode.
386 Default is true if INTERRUPT_INPUT is defined. */
387 bool interrupt_input
;
389 /* Nonzero while interrupts are temporarily deferred during redisplay. */
390 bool interrupts_deferred
;
392 /* If we support a window system, turn on the code to poll periodically
393 to detect C-g. It isn't actually used when doing interrupt input. */
394 #ifdef HAVE_WINDOW_SYSTEM
395 #define POLL_FOR_INPUT
398 /* The time when Emacs started being idle. */
400 static EMACS_TIME timer_idleness_start_time
;
402 /* After Emacs stops being idle, this saves the last value
403 of timer_idleness_start_time from when it was idle. */
405 static EMACS_TIME timer_last_idleness_start_time
;
408 /* Global variable declarations. */
410 /* Flags for readable_events. */
411 #define READABLE_EVENTS_DO_TIMERS_NOW (1 << 0)
412 #define READABLE_EVENTS_FILTER_EVENTS (1 << 1)
413 #define READABLE_EVENTS_IGNORE_SQUEEZABLES (1 << 2)
415 /* Function for init_keyboard to call with no args (if nonzero). */
416 static void (*keyboard_init_hook
) (void);
418 static bool get_input_pending (int);
419 static bool readable_events (int);
420 static Lisp_Object
read_char_x_menu_prompt (Lisp_Object
,
421 Lisp_Object
, bool *);
422 static Lisp_Object
read_char_minibuf_menu_prompt (int, Lisp_Object
);
423 static Lisp_Object
make_lispy_event (struct input_event
*);
424 static Lisp_Object
make_lispy_movement (struct frame
*, Lisp_Object
,
425 enum scroll_bar_part
,
426 Lisp_Object
, Lisp_Object
,
428 static Lisp_Object
modify_event_symbol (ptrdiff_t, int, Lisp_Object
,
429 Lisp_Object
, const char *const *,
430 Lisp_Object
*, ptrdiff_t);
431 static Lisp_Object
make_lispy_switch_frame (Lisp_Object
);
432 static bool help_char_p (Lisp_Object
);
433 static void save_getcjmp (sys_jmp_buf
);
434 static void restore_getcjmp (sys_jmp_buf
);
435 static Lisp_Object
apply_modifiers (int, Lisp_Object
);
436 static void clear_event (struct input_event
*);
437 static Lisp_Object
restore_kboard_configuration (Lisp_Object
);
439 static void deliver_input_available_signal (int signo
);
441 static void handle_interrupt (bool);
442 static _Noreturn
void quit_throw_to_read_char (bool);
443 static void process_special_events (void);
444 static void timer_start_idle (void);
445 static void timer_stop_idle (void);
446 static void timer_resume_idle (void);
447 static void deliver_user_signal (int);
448 static char *find_user_signal_name (int);
449 static void store_user_signal_events (void);
451 /* These setters are used only in this file, so they can be private. */
453 kset_echo_string (struct kboard
*kb
, Lisp_Object val
)
455 kb
->INTERNAL_FIELD (echo_string
) = val
;
458 kset_kbd_queue (struct kboard
*kb
, Lisp_Object val
)
460 kb
->INTERNAL_FIELD (kbd_queue
) = val
;
463 kset_keyboard_translate_table (struct kboard
*kb
, Lisp_Object val
)
465 kb
->INTERNAL_FIELD (Vkeyboard_translate_table
) = val
;
468 kset_last_prefix_arg (struct kboard
*kb
, Lisp_Object val
)
470 kb
->INTERNAL_FIELD (Vlast_prefix_arg
) = val
;
473 kset_last_repeatable_command (struct kboard
*kb
, Lisp_Object val
)
475 kb
->INTERNAL_FIELD (Vlast_repeatable_command
) = val
;
478 kset_local_function_key_map (struct kboard
*kb
, Lisp_Object val
)
480 kb
->INTERNAL_FIELD (Vlocal_function_key_map
) = val
;
483 kset_overriding_terminal_local_map (struct kboard
*kb
, Lisp_Object val
)
485 kb
->INTERNAL_FIELD (Voverriding_terminal_local_map
) = val
;
488 kset_real_last_command (struct kboard
*kb
, Lisp_Object val
)
490 kb
->INTERNAL_FIELD (Vreal_last_command
) = val
;
493 kset_system_key_syms (struct kboard
*kb
, Lisp_Object val
)
495 kb
->INTERNAL_FIELD (system_key_syms
) = val
;
499 /* Add C to the echo string, without echoing it immediately. C can be
500 a character, which is pretty-printed, or a symbol, whose name is
504 echo_add_key (Lisp_Object c
)
506 int size
= KEY_DESCRIPTION_SIZE
+ 100;
507 char *buffer
= alloca (size
);
509 Lisp_Object echo_string
;
511 echo_string
= KVAR (current_kboard
, echo_string
);
513 /* If someone has passed us a composite event, use its head symbol. */
517 ptr
= push_key_description (XINT (c
), ptr
);
518 else if (SYMBOLP (c
))
520 Lisp_Object name
= SYMBOL_NAME (c
);
521 int nbytes
= SBYTES (name
);
523 if (size
- (ptr
- buffer
) < nbytes
)
525 int offset
= ptr
- buffer
;
526 size
= max (2 * size
, size
+ nbytes
);
527 buffer
= alloca (size
);
528 ptr
= buffer
+ offset
;
531 ptr
+= copy_text (SDATA (name
), (unsigned char *) ptr
, nbytes
,
532 STRING_MULTIBYTE (name
), 1);
535 if ((NILP (echo_string
) || SCHARS (echo_string
) == 0)
538 const char *text
= " (Type ? for further options)";
539 int len
= strlen (text
);
541 if (size
- (ptr
- buffer
) < len
)
543 int offset
= ptr
- buffer
;
545 buffer
= alloca (size
);
546 ptr
= buffer
+ offset
;
549 memcpy (ptr
, text
, len
);
553 /* Replace a dash from echo_dash with a space, otherwise add a space
554 at the end as a separator between keys. */
555 if (STRINGP (echo_string
) && SCHARS (echo_string
) > 1)
557 Lisp_Object last_char
, prev_char
, idx
;
559 idx
= make_number (SCHARS (echo_string
) - 2);
560 prev_char
= Faref (echo_string
, idx
);
562 idx
= make_number (SCHARS (echo_string
) - 1);
563 last_char
= Faref (echo_string
, idx
);
565 /* We test PREV_CHAR to make sure this isn't the echoing of a
567 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
568 Faset (echo_string
, idx
, make_number (' '));
570 echo_string
= concat2 (echo_string
, build_string (" "));
572 else if (STRINGP (echo_string
) && SCHARS (echo_string
) > 0)
573 echo_string
= concat2 (echo_string
, build_string (" "));
577 concat2 (echo_string
, make_string (buffer
, ptr
- buffer
)));
580 /* Add C to the echo string, if echoing is going on. C can be a
581 character or a symbol. */
584 echo_char (Lisp_Object c
)
586 if (current_kboard
->immediate_echo
)
593 /* Temporarily add a dash to the end of the echo string if it's not
594 empty, so that it serves as a mini-prompt for the very next
600 /* Do nothing if not echoing at all. */
601 if (NILP (KVAR (current_kboard
, echo_string
)))
604 if (this_command_key_count
== 0)
607 if (!current_kboard
->immediate_echo
608 && SCHARS (KVAR (current_kboard
, echo_string
)) == 0)
611 /* Do nothing if we just printed a prompt. */
612 if (current_kboard
->echo_after_prompt
613 == SCHARS (KVAR (current_kboard
, echo_string
)))
616 /* Do nothing if we have already put a dash at the end. */
617 if (SCHARS (KVAR (current_kboard
, echo_string
)) > 1)
619 Lisp_Object last_char
, prev_char
, idx
;
621 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 2);
622 prev_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
624 idx
= make_number (SCHARS (KVAR (current_kboard
, echo_string
)) - 1);
625 last_char
= Faref (KVAR (current_kboard
, echo_string
), idx
);
627 if (XINT (last_char
) == '-' && XINT (prev_char
) != ' ')
631 /* Put a dash at the end of the buffer temporarily,
632 but make it go away when the next character is added. */
635 concat2 (KVAR (current_kboard
, echo_string
), build_string ("-")));
639 /* Display the current echo string, and begin echoing if not already
645 if (!current_kboard
->immediate_echo
)
648 current_kboard
->immediate_echo
= 1;
650 for (i
= 0; i
< this_command_key_count
; i
++)
654 /* Set before_command_echo_length to the value that would
655 have been saved before the start of this subcommand in
656 command_loop_1, if we had already been echoing then. */
657 if (i
== this_single_command_key_start
)
658 before_command_echo_length
= echo_length ();
660 c
= AREF (this_command_keys
, i
);
661 if (! (EVENT_HAS_PARAMETERS (c
)
662 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
666 /* Set before_command_echo_length to the value that would
667 have been saved before the start of this subcommand in
668 command_loop_1, if we had already been echoing then. */
669 if (this_command_key_count
== this_single_command_key_start
)
670 before_command_echo_length
= echo_length ();
672 /* Put a dash at the end to invite the user to type more. */
677 /* FIXME: Use call (Qmessage) so it can be advised (e.g. emacspeak). */
678 message3_nolog (KVAR (current_kboard
, echo_string
));
681 /* Record in what buffer we echoed, and from which kboard. */
682 echo_message_buffer
= echo_area_buffer
[0];
683 echo_kboard
= current_kboard
;
685 if (waiting_for_input
&& !NILP (Vquit_flag
))
686 quit_throw_to_read_char (0);
689 /* Turn off echoing, for the start of a new command. */
692 cancel_echoing (void)
694 current_kboard
->immediate_echo
= 0;
695 current_kboard
->echo_after_prompt
= -1;
696 kset_echo_string (current_kboard
, Qnil
);
697 ok_to_echo_at_next_pause
= NULL
;
699 echo_message_buffer
= Qnil
;
702 /* Return the length of the current echo string. */
707 return (STRINGP (KVAR (current_kboard
, echo_string
))
708 ? SCHARS (KVAR (current_kboard
, echo_string
))
712 /* Truncate the current echo message to its first LEN chars.
713 This and echo_char get used by read_key_sequence when the user
714 switches frames while entering a key sequence. */
717 echo_truncate (ptrdiff_t nchars
)
719 if (STRINGP (KVAR (current_kboard
, echo_string
)))
720 kset_echo_string (current_kboard
,
721 Fsubstring (KVAR (current_kboard
, echo_string
),
722 make_number (0), make_number (nchars
)));
723 truncate_echo_area (nchars
);
727 /* Functions for manipulating this_command_keys. */
729 add_command_key (Lisp_Object key
)
731 #if 0 /* Not needed after we made Freset_this_command_lengths
732 do the job immediately. */
733 /* If reset-this-command-length was called recently, obey it now.
734 See the doc string of that function for an explanation of why. */
735 if (before_command_restore_flag
)
737 this_command_key_count
= before_command_key_count_1
;
738 if (this_command_key_count
< this_single_command_key_start
)
739 this_single_command_key_start
= this_command_key_count
;
740 echo_truncate (before_command_echo_length_1
);
741 before_command_restore_flag
= 0;
745 if (this_command_key_count
>= ASIZE (this_command_keys
))
746 this_command_keys
= larger_vector (this_command_keys
, 1, -1);
748 ASET (this_command_keys
, this_command_key_count
, key
);
749 ++this_command_key_count
;
754 recursive_edit_1 (void)
756 ptrdiff_t count
= SPECPDL_INDEX ();
759 if (command_loop_level
> 0)
761 specbind (Qstandard_output
, Qt
);
762 specbind (Qstandard_input
, Qt
);
765 #ifdef HAVE_WINDOW_SYSTEM
766 /* The command loop has started an hourglass timer, so we have to
767 cancel it here, otherwise it will fire because the recursive edit
768 can take some time. Do not check for display_hourglass_p here,
769 because it could already be nil. */
773 /* This function may have been called from a debugger called from
774 within redisplay, for instance by Edebugging a function called
775 from fontification-functions. We want to allow redisplay in
776 the debugging session.
778 The recursive edit is left with a `(throw exit ...)'. The `exit'
779 tag is not caught anywhere in redisplay, i.e. when we leave the
780 recursive edit, the original redisplay leading to the recursive
781 edit will be unwound. The outcome should therefore be safe. */
782 specbind (Qinhibit_redisplay
, Qnil
);
785 val
= command_loop ();
787 Fsignal (Qquit
, Qnil
);
788 /* Handle throw from read_minibuf when using minibuffer
789 while it's active but we're in another window. */
791 xsignal1 (Qerror
, val
);
793 return unbind_to (count
, Qnil
);
796 /* When an auto-save happens, record the "time", and don't do again soon. */
799 record_auto_save (void)
801 last_auto_save
= num_nonmacro_input_events
;
804 /* Make an auto save happen as soon as possible at command level. */
808 force_auto_save_soon (void)
810 last_auto_save
= - auto_save_interval
- 1;
812 record_asynch_buffer_change ();
816 DEFUN ("recursive-edit", Frecursive_edit
, Srecursive_edit
, 0, 0, "",
817 doc
: /* Invoke the editor command loop recursively.
818 To get out of the recursive edit, a command can do `(throw 'exit nil)';
819 that tells this function to return.
820 Alternatively, `(throw 'exit t)' makes this function signal an error.
821 This function is called by the editor initialization to begin editing. */)
824 ptrdiff_t count
= SPECPDL_INDEX ();
827 /* If we enter while input is blocked, don't lock up here.
828 This may happen through the debugger during redisplay. */
829 if (input_blocked_p ())
832 command_loop_level
++;
833 update_mode_lines
= 1;
835 if (command_loop_level
836 && current_buffer
!= XBUFFER (XWINDOW (selected_window
)->buffer
))
837 buffer
= Fcurrent_buffer ();
841 /* If we leave recursive_edit_1 below with a `throw' for instance,
842 like it is done in the splash screen display, we have to
843 make sure that we restore single_kboard as command_loop_1
844 would have done if it were left normally. */
845 if (command_loop_level
> 0)
846 temporarily_switch_to_single_kboard (SELECTED_FRAME ());
847 record_unwind_protect (recursive_edit_unwind
, buffer
);
850 return unbind_to (count
, Qnil
);
854 recursive_edit_unwind (Lisp_Object buffer
)
856 if (BUFFERP (buffer
))
857 Fset_buffer (buffer
);
859 command_loop_level
--;
860 update_mode_lines
= 1;
865 #if 0 /* These two functions are now replaced with
866 temporarily_switch_to_single_kboard. */
870 #if 0 /* Theory: if there's anything in Vunread_command_events,
871 it will right away be read by read_key_sequence,
872 and then if we do switch KBOARDS, it will go into the side
873 queue then. So we don't need to do anything special here -- rms. */
874 if (CONSP (Vunread_command_events
))
876 current_kboard
->kbd_queue
877 = nconc2 (Vunread_command_events
, current_kboard
->kbd_queue
);
878 current_kboard
->kbd_queue_has_data
= 1;
880 Vunread_command_events
= Qnil
;
885 /* Switch to the single-kboard state, making current_kboard
886 the only KBOARD from which further input is accepted. */
889 single_kboard_state ()
895 /* If we're in single_kboard state for kboard KBOARD,
899 not_single_kboard_state (KBOARD
*kboard
)
901 if (kboard
== current_kboard
)
905 /* Maintain a stack of kboards, so other parts of Emacs
906 can switch temporarily to the kboard of a given frame
907 and then revert to the previous status. */
912 struct kboard_stack
*next
;
915 static struct kboard_stack
*kboard_stack
;
918 push_kboard (struct kboard
*k
)
920 struct kboard_stack
*p
= xmalloc (sizeof *p
);
922 p
->next
= kboard_stack
;
923 p
->kboard
= current_kboard
;
933 struct kboard_stack
*p
= kboard_stack
;
935 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
937 if (t
->kboard
== p
->kboard
)
939 current_kboard
= p
->kboard
;
946 /* The terminal we remembered has been deleted. */
947 current_kboard
= FRAME_KBOARD (SELECTED_FRAME ());
950 kboard_stack
= p
->next
;
954 /* Switch to single_kboard mode, making current_kboard the only KBOARD
955 from which further input is accepted. If F is non-nil, set its
956 KBOARD as the current keyboard.
958 This function uses record_unwind_protect to return to the previous
961 If Emacs is already in single_kboard mode, and F's keyboard is
962 locked, then this function will throw an error. */
965 temporarily_switch_to_single_kboard (struct frame
*f
)
967 bool was_locked
= single_kboard
;
970 if (f
!= NULL
&& FRAME_KBOARD (f
) != current_kboard
)
971 /* We can not switch keyboards while in single_kboard mode.
972 In rare cases, Lisp code may call `recursive-edit' (or
973 `read-minibuffer' or `y-or-n-p') after it switched to a
974 locked frame. For example, this is likely to happen
975 when server.el connects to a new terminal while Emacs is in
976 single_kboard mode. It is best to throw an error instead
977 of presenting the user with a frozen screen. */
978 error ("Terminal %d is locked, cannot read from it",
979 FRAME_TERMINAL (f
)->id
);
981 /* This call is unnecessary, but helps
982 `restore_kboard_configuration' discover if somebody changed
983 `current_kboard' behind our back. */
984 push_kboard (current_kboard
);
987 current_kboard
= FRAME_KBOARD (f
);
989 record_unwind_protect (restore_kboard_configuration
,
990 (was_locked
? Qt
: Qnil
));
993 #if 0 /* This function is not needed anymore. */
995 record_single_kboard_state ()
998 push_kboard (current_kboard
);
999 record_unwind_protect (restore_kboard_configuration
,
1000 (single_kboard
? Qt
: Qnil
));
1005 restore_kboard_configuration (Lisp_Object was_locked
)
1007 if (NILP (was_locked
))
1011 struct kboard
*prev
= current_kboard
;
1014 /* The pop should not change the kboard. */
1015 if (single_kboard
&& current_kboard
!= prev
)
1022 /* Handle errors that are not handled at inner levels
1023 by printing an error message and returning to the editor command loop. */
1026 cmd_error (Lisp_Object data
)
1028 Lisp_Object old_level
, old_length
;
1029 char macroerror
[sizeof "After..kbd macro iterations: "
1030 + INT_STRLEN_BOUND (EMACS_INT
)];
1032 #ifdef HAVE_WINDOW_SYSTEM
1033 if (display_hourglass_p
)
1034 cancel_hourglass ();
1037 if (!NILP (executing_kbd_macro
))
1039 if (executing_kbd_macro_iterations
== 1)
1040 sprintf (macroerror
, "After 1 kbd macro iteration: ");
1042 sprintf (macroerror
, "After %"pI
"d kbd macro iterations: ",
1043 executing_kbd_macro_iterations
);
1048 Vstandard_output
= Qt
;
1049 Vstandard_input
= Qt
;
1050 Vexecuting_kbd_macro
= Qnil
;
1051 executing_kbd_macro
= Qnil
;
1052 kset_prefix_arg (current_kboard
, Qnil
);
1053 kset_last_prefix_arg (current_kboard
, Qnil
);
1056 /* Avoid unquittable loop if data contains a circular list. */
1057 old_level
= Vprint_level
;
1058 old_length
= Vprint_length
;
1059 XSETFASTINT (Vprint_level
, 10);
1060 XSETFASTINT (Vprint_length
, 10);
1061 cmd_error_internal (data
, macroerror
);
1062 Vprint_level
= old_level
;
1063 Vprint_length
= old_length
;
1066 Vinhibit_quit
= Qnil
;
1068 return make_number (0);
1071 /* Take actions on handling an error. DATA is the data that describes
1074 CONTEXT is a C-string containing ASCII characters only which
1075 describes the context in which the error happened. If we need to
1076 generalize CONTEXT to allow multibyte characters, make it a Lisp
1080 cmd_error_internal (Lisp_Object data
, const char *context
)
1082 struct frame
*sf
= SELECTED_FRAME ();
1084 /* The immediate context is not interesting for Quits,
1085 since they are asynchronous. */
1086 if (EQ (XCAR (data
), Qquit
))
1087 Vsignaling_function
= Qnil
;
1092 /* Use user's specified output function if any. */
1093 if (!NILP (Vcommand_error_function
))
1094 call3 (Vcommand_error_function
, data
,
1095 context
? build_string (context
) : empty_unibyte_string
,
1096 Vsignaling_function
);
1097 /* If the window system or terminal frame hasn't been initialized
1098 yet, or we're not interactive, write the message to stderr and exit. */
1099 else if (!sf
->glyphs_initialized_p
1100 /* The initial frame is a special non-displaying frame. It
1101 will be current in daemon mode when there are no frames
1102 to display, and in non-daemon mode before the real frame
1103 has finished initializing. If an error is thrown in the
1104 latter case while creating the frame, then the frame
1105 will never be displayed, so the safest thing to do is
1106 write to stderr and quit. In daemon mode, there are
1107 many other potential errors that do not prevent frames
1108 from being created, so continuing as normal is better in
1110 || (!IS_DAEMON
&& FRAME_INITIAL_P (sf
))
1113 print_error_message (data
, Qexternal_debugging_output
,
1114 context
, Vsignaling_function
);
1115 Fterpri (Qexternal_debugging_output
);
1116 Fkill_emacs (make_number (-1));
1120 clear_message (1, 0);
1122 message_log_maybe_newline ();
1125 print_error_message (data
, Qt
, context
, Vsignaling_function
);
1128 Vsignaling_function
= Qnil
;
1131 static Lisp_Object
command_loop_2 (Lisp_Object
);
1132 static Lisp_Object
top_level_1 (Lisp_Object
);
1134 /* Entry to editor-command-loop.
1135 This level has the catches for exiting/returning to editor command loop.
1136 It returns nil to exit recursive edit, t to abort it. */
1141 if (command_loop_level
> 0 || minibuf_level
> 0)
1144 val
= internal_catch (Qexit
, command_loop_2
, Qnil
);
1145 executing_kbd_macro
= Qnil
;
1151 internal_catch (Qtop_level
, top_level_1
, Qnil
);
1152 internal_catch (Qtop_level
, command_loop_2
, Qnil
);
1153 executing_kbd_macro
= Qnil
;
1155 /* End of file in -batch run causes exit here. */
1161 /* Here we catch errors in execution of commands within the
1162 editing loop, and reenter the editing loop.
1163 When there is an error, cmd_error runs and returns a non-nil
1164 value to us. A value of nil means that command_loop_1 itself
1165 returned due to end of file (or end of kbd macro). */
1168 command_loop_2 (Lisp_Object ignore
)
1170 register Lisp_Object val
;
1173 val
= internal_condition_case (command_loop_1
, Qerror
, cmd_error
);
1174 while (!NILP (val
));
1182 return Feval (Vtop_level
, Qnil
);
1186 top_level_1 (Lisp_Object ignore
)
1188 /* On entry to the outer level, run the startup file */
1189 if (!NILP (Vtop_level
))
1190 internal_condition_case (top_level_2
, Qerror
, cmd_error
);
1191 else if (!NILP (Vpurify_flag
))
1192 message ("Bare impure Emacs (standard Lisp code not loaded)");
1194 message ("Bare Emacs (standard Lisp code not loaded)");
1198 DEFUN ("top-level", Ftop_level
, Stop_level
, 0, 0, "",
1199 doc
: /* Exit all recursive editing levels.
1200 This also exits all active minibuffers. */)
1203 #ifdef HAVE_WINDOW_SYSTEM
1204 if (display_hourglass_p
)
1205 cancel_hourglass ();
1208 /* Unblock input if we enter with input blocked. This may happen if
1209 redisplay traps e.g. during tool-bar update with input blocked. */
1210 totally_unblock_input ();
1212 Fthrow (Qtop_level
, Qnil
);
1215 static _Noreturn
void
1216 user_error (const char *msg
)
1218 xsignal1 (Quser_error
, build_string (msg
));
1222 DEFUN ("exit-recursive-edit", Fexit_recursive_edit
, Sexit_recursive_edit
, 0, 0, "",
1223 doc
: /* Exit from the innermost recursive edit or minibuffer. */)
1226 if (command_loop_level
> 0 || minibuf_level
> 0)
1227 Fthrow (Qexit
, Qnil
);
1229 user_error ("No recursive edit is in progress");
1233 DEFUN ("abort-recursive-edit", Fabort_recursive_edit
, Sabort_recursive_edit
, 0, 0, "",
1234 doc
: /* Abort the command that requested this recursive edit or minibuffer input. */)
1237 if (command_loop_level
> 0 || minibuf_level
> 0)
1240 user_error ("No recursive edit is in progress");
1243 /* Restore mouse tracking enablement. See Ftrack_mouse for the only use
1244 of this function. */
1247 tracking_off (Lisp_Object old_value
)
1249 do_mouse_tracking
= old_value
;
1250 if (NILP (old_value
))
1252 /* Redisplay may have been preempted because there was input
1253 available, and it assumes it will be called again after the
1254 input has been processed. If the only input available was
1255 the sort that we have just disabled, then we need to call
1257 if (!readable_events (READABLE_EVENTS_DO_TIMERS_NOW
))
1259 redisplay_preserve_echo_area (6);
1260 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
1266 DEFUN ("track-mouse", Ftrack_mouse
, Strack_mouse
, 0, UNEVALLED
, 0,
1267 doc
: /* Evaluate BODY with mouse movement events enabled.
1268 Within a `track-mouse' form, mouse motion generates input events that
1269 you can read with `read-event'.
1270 Normally, mouse motion is ignored.
1271 usage: (track-mouse BODY...) */)
1274 ptrdiff_t count
= SPECPDL_INDEX ();
1277 record_unwind_protect (tracking_off
, do_mouse_tracking
);
1279 do_mouse_tracking
= Qt
;
1281 val
= Fprogn (args
);
1282 return unbind_to (count
, val
);
1285 /* If mouse has moved on some frame, return one of those frames.
1289 If ignore_mouse_drag_p is non-zero, ignore (implicit) mouse movement
1290 after resizing the tool-bar window. */
1292 #if !defined HAVE_WINDOW_SYSTEM || defined USE_GTK || defined HAVE_NS
1295 bool ignore_mouse_drag_p
;
1298 some_mouse_moved (void)
1300 Lisp_Object tail
, frame
;
1302 if (ignore_mouse_drag_p
)
1304 /* ignore_mouse_drag_p = 0; */
1308 FOR_EACH_FRAME (tail
, frame
)
1310 if (XFRAME (frame
)->mouse_moved
)
1311 return XFRAME (frame
);
1318 /* This is the actual command reading loop,
1319 sans error-handling encapsulation. */
1321 static int read_key_sequence (Lisp_Object
*, int, Lisp_Object
,
1323 void safe_run_hooks (Lisp_Object
);
1324 static void adjust_point_for_property (ptrdiff_t, bool);
1326 /* Cancel hourglass from protect_unwind.
1328 #ifdef HAVE_WINDOW_SYSTEM
1330 cancel_hourglass_unwind (Lisp_Object arg
)
1332 cancel_hourglass ();
1337 /* The last boundary auto-added to buffer-undo-list. */
1338 Lisp_Object last_undo_boundary
;
1340 /* FIXME: This is wrong rather than test window-system, we should call
1341 a new set-selection, which will then dispatch to x-set-selection, or
1342 tty-set-selection, or w32-set-selection, ... */
1345 command_loop_1 (void)
1348 Lisp_Object keybuf
[30];
1350 EMACS_INT prev_modiff
= 0;
1351 struct buffer
*prev_buffer
= NULL
;
1352 bool already_adjusted
= 0;
1354 kset_prefix_arg (current_kboard
, Qnil
);
1355 kset_last_prefix_arg (current_kboard
, Qnil
);
1356 Vdeactivate_mark
= Qnil
;
1357 waiting_for_input
= 0;
1360 this_command_key_count
= 0;
1361 this_command_key_count_reset
= 0;
1362 this_single_command_key_start
= 0;
1364 if (NILP (Vmemory_full
))
1366 /* Make sure this hook runs after commands that get errors and
1367 throw to top level. */
1368 /* Note that the value cell will never directly contain nil
1369 if the symbol is a local variable. */
1370 if (!NILP (Vpost_command_hook
) && !NILP (Vrun_hooks
))
1371 safe_run_hooks (Qpost_command_hook
);
1373 /* If displaying a message, resize the echo area window to fit
1374 that message's size exactly. */
1375 if (!NILP (echo_area_buffer
[0]))
1376 resize_echo_area_exactly ();
1378 /* If there are warnings waiting, process them. */
1379 if (!NILP (Vdelayed_warnings_list
))
1380 safe_run_hooks (Qdelayed_warnings_hook
);
1382 if (!NILP (Vdeferred_action_list
))
1383 safe_run_hooks (Qdeferred_action_function
);
1386 /* Do this after running Vpost_command_hook, for consistency. */
1387 kset_last_command (current_kboard
, Vthis_command
);
1388 kset_real_last_command (current_kboard
, Vreal_this_command
);
1389 if (!CONSP (last_command_event
))
1390 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1394 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1397 /* Make sure the current window's buffer is selected. */
1398 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1400 /* Display any malloc warning that just came out. Use while because
1401 displaying one warning can cause another. */
1403 while (pending_malloc_warning
)
1404 display_malloc_warning ();
1406 Vdeactivate_mark
= Qnil
;
1408 /* Don't ignore mouse movements for more than a single command
1409 loop. (This flag is set in xdisp.c whenever the tool bar is
1410 resized, because the resize moves text up or down, and would
1411 generate false mouse drag events if we don't ignore them.) */
1412 ignore_mouse_drag_p
= 0;
1414 /* If minibuffer on and echo area in use,
1415 wait a short time and redraw minibuffer. */
1418 && !NILP (echo_area_buffer
[0])
1419 && EQ (minibuf_window
, echo_area_window
)
1420 && NUMBERP (Vminibuffer_message_timeout
))
1422 /* Bind inhibit-quit to t so that C-g gets read in
1423 rather than quitting back to the minibuffer. */
1424 ptrdiff_t count
= SPECPDL_INDEX ();
1425 specbind (Qinhibit_quit
, Qt
);
1427 sit_for (Vminibuffer_message_timeout
, 0, 2);
1429 /* Clear the echo area. */
1431 safe_run_hooks (Qecho_area_clear_hook
);
1433 unbind_to (count
, Qnil
);
1435 /* If a C-g came in before, treat it as input now. */
1436 if (!NILP (Vquit_flag
))
1439 Vunread_command_events
= Fcons (make_number (quit_char
), Qnil
);
1443 /* If it has changed current-menubar from previous value,
1444 really recompute the menubar from the value. */
1445 if (! NILP (Vlucid_menu_bar_dirty_flag
)
1446 && !NILP (Ffboundp (Qrecompute_lucid_menubar
)))
1447 call0 (Qrecompute_lucid_menubar
);
1449 before_command_key_count
= this_command_key_count
;
1450 before_command_echo_length
= echo_length ();
1452 Vthis_command
= Qnil
;
1453 Vreal_this_command
= Qnil
;
1454 Vthis_original_command
= Qnil
;
1455 Vthis_command_keys_shift_translated
= Qnil
;
1457 /* Read next key sequence; i gets its length. */
1458 i
= read_key_sequence (keybuf
, sizeof keybuf
/ sizeof keybuf
[0],
1461 /* A filter may have run while we were reading the input. */
1462 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
1464 set_buffer_internal (XBUFFER (XWINDOW (selected_window
)->buffer
));
1468 /* Now we have read a key sequence of length I,
1469 or else I is 0 and we found end of file. */
1471 if (i
== 0) /* End of file -- happens only in */
1472 return Qnil
; /* a kbd macro, at the end. */
1473 /* -1 means read_key_sequence got a menu that was rejected.
1474 Just loop around and read another command. */
1478 this_command_key_count
= 0;
1479 this_command_key_count_reset
= 0;
1480 this_single_command_key_start
= 0;
1484 last_command_event
= keybuf
[i
- 1];
1486 /* If the previous command tried to force a specific window-start,
1487 forget about that, in case this command moves point far away
1488 from that position. But also throw away beg_unchanged and
1489 end_unchanged information in that case, so that redisplay will
1490 update the whole window properly. */
1491 if (XWINDOW (selected_window
)->force_start
)
1494 XWINDOW (selected_window
)->force_start
= 0;
1495 b
= XBUFFER (XWINDOW (selected_window
)->buffer
);
1496 BUF_BEG_UNCHANGED (b
) = BUF_END_UNCHANGED (b
) = 0;
1499 cmd
= read_key_sequence_cmd
;
1500 if (!NILP (Vexecuting_kbd_macro
))
1502 if (!NILP (Vquit_flag
))
1504 Vexecuting_kbd_macro
= Qt
;
1505 QUIT
; /* Make some noise. */
1506 /* Will return since macro now empty. */
1510 /* Do redisplay processing after this command except in special
1511 cases identified below. */
1512 prev_buffer
= current_buffer
;
1513 prev_modiff
= MODIFF
;
1514 last_point_position
= PT
;
1515 last_point_position_window
= selected_window
;
1516 XSETBUFFER (last_point_position_buffer
, prev_buffer
);
1518 /* By default, we adjust point to a boundary of a region that
1519 has such a property that should be treated intangible
1520 (e.g. composition, display). But, some commands will set
1521 this variable differently. */
1522 Vdisable_point_adjustment
= Qnil
;
1524 /* Process filters and timers may have messed with deactivate-mark.
1525 reset it before we execute the command. */
1526 Vdeactivate_mark
= Qnil
;
1528 /* Remap command through active keymaps. */
1529 Vthis_original_command
= cmd
;
1530 if (!NILP (read_key_sequence_remapped
))
1531 cmd
= read_key_sequence_remapped
;
1533 /* Execute the command. */
1535 Vthis_command
= cmd
;
1536 Vreal_this_command
= cmd
;
1537 safe_run_hooks (Qpre_command_hook
);
1539 already_adjusted
= 0;
1541 if (NILP (Vthis_command
))
1543 /* nil means key is undefined. */
1544 Lisp_Object keys
= Fvector (i
, keybuf
);
1545 keys
= Fkey_description (keys
, Qnil
);
1547 message_with_string ("%s is undefined", keys
, 0);
1548 kset_defining_kbd_macro (current_kboard
, Qnil
);
1549 update_mode_lines
= 1;
1550 /* If this is a down-mouse event, don't reset prefix-arg;
1551 pass it to the command run by the up event. */
1552 if (EVENT_HAS_PARAMETERS (last_command_event
))
1554 Lisp_Object breakdown
1555 = parse_modifiers (EVENT_HEAD (last_command_event
));
1556 int modifiers
= XINT (XCAR (XCDR (breakdown
)));
1557 if (!(modifiers
& down_modifier
))
1558 kset_prefix_arg (current_kboard
, Qnil
);
1561 kset_prefix_arg (current_kboard
, Qnil
);
1565 /* Here for a command that isn't executed directly. */
1567 #ifdef HAVE_WINDOW_SYSTEM
1568 ptrdiff_t scount
= SPECPDL_INDEX ();
1570 if (display_hourglass_p
1571 && NILP (Vexecuting_kbd_macro
))
1573 record_unwind_protect (cancel_hourglass_unwind
, Qnil
);
1578 if (NILP (KVAR (current_kboard
, Vprefix_arg
))) /* FIXME: Why? --Stef */
1580 Lisp_Object undo
= BVAR (current_buffer
, undo_list
);
1583 = (EQ (undo
, BVAR (current_buffer
, undo_list
))
1584 ? Qnil
: BVAR (current_buffer
, undo_list
));
1586 Fcommand_execute (Vthis_command
, Qnil
, Qnil
, Qnil
);
1588 #ifdef HAVE_WINDOW_SYSTEM
1589 /* Do not check display_hourglass_p here, because
1590 Fcommand_execute could change it, but we should cancel
1591 hourglass cursor anyway.
1592 But don't cancel the hourglass within a macro
1593 just because a command in the macro finishes. */
1594 if (NILP (Vexecuting_kbd_macro
))
1595 unbind_to (scount
, Qnil
);
1598 kset_last_prefix_arg (current_kboard
, Vcurrent_prefix_arg
);
1600 safe_run_hooks (Qpost_command_hook
);
1602 /* If displaying a message, resize the echo area window to fit
1603 that message's size exactly. */
1604 if (!NILP (echo_area_buffer
[0]))
1605 resize_echo_area_exactly ();
1607 /* If there are warnings waiting, process them. */
1608 if (!NILP (Vdelayed_warnings_list
))
1609 safe_run_hooks (Qdelayed_warnings_hook
);
1611 safe_run_hooks (Qdeferred_action_function
);
1613 /* If there is a prefix argument,
1614 1) We don't want Vlast_command to be ``universal-argument''
1615 (that would be dumb), so don't set Vlast_command,
1616 2) we want to leave echoing on so that the prefix will be
1617 echoed as part of this key sequence, so don't call
1619 3) we want to leave this_command_key_count non-zero, so that
1620 read_char will realize that it is re-reading a character, and
1621 not echo it a second time.
1623 If the command didn't actually create a prefix arg,
1624 but is merely a frame event that is transparent to prefix args,
1625 then the above doesn't apply. */
1626 if (NILP (KVAR (current_kboard
, Vprefix_arg
))
1627 || CONSP (last_command_event
))
1629 kset_last_command (current_kboard
, Vthis_command
);
1630 kset_real_last_command (current_kboard
, Vreal_this_command
);
1631 if (!CONSP (last_command_event
))
1632 kset_last_repeatable_command (current_kboard
, Vreal_this_command
);
1634 this_command_key_count
= 0;
1635 this_command_key_count_reset
= 0;
1636 this_single_command_key_start
= 0;
1639 if (!NILP (BVAR (current_buffer
, mark_active
))
1640 && !NILP (Vrun_hooks
))
1642 /* In Emacs 22, setting transient-mark-mode to `only' was a
1643 way of turning it on for just one command. This usage is
1644 obsolete, but support it anyway. */
1645 if (EQ (Vtransient_mark_mode
, Qidentity
))
1646 Vtransient_mark_mode
= Qnil
;
1647 else if (EQ (Vtransient_mark_mode
, Qonly
))
1648 Vtransient_mark_mode
= Qidentity
;
1650 if (!NILP (Vdeactivate_mark
))
1651 /* If `select-active-regions' is non-nil, this call to
1652 `deactivate-mark' also sets the PRIMARY selection. */
1653 call0 (Qdeactivate_mark
);
1656 /* Even if not deactivating the mark, set PRIMARY if
1657 `select-active-regions' is non-nil. */
1658 if (!NILP (Fwindow_system (Qnil
))
1659 /* Even if mark_active is non-nil, the actual buffer
1660 marker may not have been set yet (Bug#7044). */
1661 && XMARKER (BVAR (current_buffer
, mark
))->buffer
1662 && (EQ (Vselect_active_regions
, Qonly
)
1663 ? EQ (CAR_SAFE (Vtransient_mark_mode
), Qonly
)
1664 : (!NILP (Vselect_active_regions
)
1665 && !NILP (Vtransient_mark_mode
)))
1666 && NILP (Fmemq (Vthis_command
,
1667 Vselection_inhibit_update_commands
)))
1670 XINT (Fmarker_position (BVAR (current_buffer
, mark
)));
1673 call2 (Qx_set_selection
, QPRIMARY
,
1674 make_buffer_string (beg
, end
, 0));
1676 call2 (Qx_set_selection
, QPRIMARY
,
1677 make_buffer_string (end
, beg
, 0));
1678 /* Don't set empty selections. */
1681 if (current_buffer
!= prev_buffer
|| MODIFF
!= prev_modiff
)
1683 Lisp_Object hook
= intern ("activate-mark-hook");
1684 Frun_hooks (1, &hook
);
1688 Vsaved_region_selection
= Qnil
;
1693 if (current_buffer
== prev_buffer
1694 && last_point_position
!= PT
1695 && NILP (Vdisable_point_adjustment
)
1696 && NILP (Vglobal_disable_point_adjustment
))
1698 if (last_point_position
> BEGV
1699 && last_point_position
< ZV
1700 && (composition_adjust_point (last_point_position
,
1701 last_point_position
)
1702 != last_point_position
))
1703 /* The last point was temporarily set within a grapheme
1704 cluster to prevent automatic composition. To recover
1705 the automatic composition, we must update the
1707 windows_or_buffers_changed
++;
1708 if (!already_adjusted
)
1709 adjust_point_for_property (last_point_position
,
1710 MODIFF
!= prev_modiff
);
1713 /* Install chars successfully executed in kbd macro. */
1715 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
))
1716 && NILP (KVAR (current_kboard
, Vprefix_arg
)))
1717 finalize_kbd_macro_chars ();
1721 /* Adjust point to a boundary of a region that has such a property
1722 that should be treated intangible. For the moment, we check
1723 `composition', `display' and `invisible' properties.
1724 LAST_PT is the last position of point. */
1727 adjust_point_for_property (ptrdiff_t last_pt
, bool modified
)
1730 Lisp_Object val
, overlay
, tmp
;
1731 /* When called after buffer modification, we should temporarily
1732 suppress the point adjustment for automatic composition so that a
1733 user can keep inserting another character at point or keep
1734 deleting characters around point. */
1735 bool check_composition
= ! modified
, check_display
= 1, check_invisible
= 1;
1736 ptrdiff_t orig_pt
= PT
;
1738 /* FIXME: cycling is probably not necessary because these properties
1739 can't be usefully combined anyway. */
1740 while (check_composition
|| check_display
|| check_invisible
)
1742 /* FIXME: check `intangible'. */
1743 if (check_composition
1744 && PT
> BEGV
&& PT
< ZV
1745 && (beg
= composition_adjust_point (last_pt
, PT
)) != PT
)
1748 check_display
= check_invisible
= 1;
1750 check_composition
= 0;
1752 && PT
> BEGV
&& PT
< ZV
1753 && !NILP (val
= get_char_property_and_overlay
1754 (make_number (PT
), Qdisplay
, Qnil
, &overlay
))
1755 && display_prop_intangible_p (val
, overlay
, PT
, PT_BYTE
)
1756 && (!OVERLAYP (overlay
)
1757 ? get_property_and_range (PT
, Qdisplay
, &val
, &beg
, &end
, Qnil
)
1758 : (beg
= OVERLAY_POSITION (OVERLAY_START (overlay
)),
1759 end
= OVERLAY_POSITION (OVERLAY_END (overlay
))))
1760 && (beg
< PT
/* && end > PT <- It's always the case. */
1761 || (beg
<= PT
&& STRINGP (val
) && SCHARS (val
) == 0)))
1764 SET_PT (PT
< last_pt
1765 ? (STRINGP (val
) && SCHARS (val
) == 0
1766 ? max (beg
- 1, BEGV
)
1769 check_composition
= check_invisible
= 1;
1772 if (check_invisible
&& PT
> BEGV
&& PT
< ZV
)
1778 /* Find boundaries `beg' and `end' of the invisible area, if any. */
1781 /* FIXME: We should stop if we find a spot between
1782 two runs of `invisible' where inserted text would
1783 be visible. This is important when we have two
1784 invisible boundaries that enclose an area: if the
1785 area is empty, we need this test in order to make
1786 it possible to place point in the middle rather
1787 than skip both boundaries. However, this code
1788 also stops anywhere in a non-sticky text-property,
1789 which breaks (e.g.) Org mode. */
1790 && (val
= get_pos_property (make_number (end
),
1792 TEXT_PROP_MEANS_INVISIBLE (val
))
1794 && !NILP (val
= get_char_property_and_overlay
1795 (make_number (end
), Qinvisible
, Qnil
, &overlay
))
1796 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1798 ellipsis
= ellipsis
|| inv
> 1
1799 || (OVERLAYP (overlay
)
1800 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1801 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1802 tmp
= Fnext_single_char_property_change
1803 (make_number (end
), Qinvisible
, Qnil
, Qnil
);
1804 end
= NATNUMP (tmp
) ? XFASTINT (tmp
) : ZV
;
1808 && (val
= get_pos_property (make_number (beg
),
1810 TEXT_PROP_MEANS_INVISIBLE (val
))
1812 && !NILP (val
= get_char_property_and_overlay
1813 (make_number (beg
- 1), Qinvisible
, Qnil
, &overlay
))
1814 && (inv
= TEXT_PROP_MEANS_INVISIBLE (val
)))
1816 ellipsis
= ellipsis
|| inv
> 1
1817 || (OVERLAYP (overlay
)
1818 && (!NILP (Foverlay_get (overlay
, Qafter_string
))
1819 || !NILP (Foverlay_get (overlay
, Qbefore_string
))));
1820 tmp
= Fprevious_single_char_property_change
1821 (make_number (beg
), Qinvisible
, Qnil
, Qnil
);
1822 beg
= NATNUMP (tmp
) ? XFASTINT (tmp
) : BEGV
;
1825 /* Move away from the inside area. */
1826 if (beg
< PT
&& end
> PT
)
1828 SET_PT ((orig_pt
== PT
&& (last_pt
< beg
|| last_pt
> end
))
1829 /* We haven't moved yet (so we don't need to fear
1830 infinite-looping) and we were outside the range
1831 before (so either end of the range still corresponds
1832 to a move in the right direction): pretend we moved
1833 less than we actually did, so that we still have
1834 more freedom below in choosing which end of the range
1836 ? (orig_pt
= -1, PT
< last_pt
? end
: beg
)
1837 /* We either have moved already or the last point
1838 was already in the range: we don't get to choose
1839 which end of the range we have to go to. */
1840 : (PT
< last_pt
? beg
: end
));
1841 check_composition
= check_display
= 1;
1843 #if 0 /* This assertion isn't correct, because SET_PT may end up setting
1844 the point to something other than its argument, due to
1845 point-motion hooks, intangibility, etc. */
1846 eassert (PT
== beg
|| PT
== end
);
1849 /* Pretend the area doesn't exist if the buffer is not
1851 if (!modified
&& !ellipsis
&& beg
< end
)
1853 if (last_pt
== beg
&& PT
== end
&& end
< ZV
)
1854 (check_composition
= check_display
= 1, SET_PT (end
+ 1));
1855 else if (last_pt
== end
&& PT
== beg
&& beg
> BEGV
)
1856 (check_composition
= check_display
= 1, SET_PT (beg
- 1));
1857 else if (PT
== ((PT
< last_pt
) ? beg
: end
))
1858 /* We've already moved as far as we can. Trying to go
1859 to the other end would mean moving backwards and thus
1860 could lead to an infinite loop. */
1862 else if (val
= get_pos_property (make_number (PT
),
1864 TEXT_PROP_MEANS_INVISIBLE (val
)
1865 && (val
= get_pos_property
1866 (make_number (PT
== beg
? end
: beg
),
1868 !TEXT_PROP_MEANS_INVISIBLE (val
)))
1869 (check_composition
= check_display
= 1,
1870 SET_PT (PT
== beg
? end
: beg
));
1873 check_invisible
= 0;
1877 /* Subroutine for safe_run_hooks: run the hook HOOK. */
1880 safe_run_hooks_1 (void)
1882 eassert (CONSP (Vinhibit_quit
));
1883 return call0 (XCDR (Vinhibit_quit
));
1886 /* Subroutine for safe_run_hooks: handle an error by clearing out the function
1890 safe_run_hooks_error (Lisp_Object error_data
)
1893 = CONSP (Vinhibit_quit
) ? XCAR (Vinhibit_quit
) : Vinhibit_quit
;
1894 Lisp_Object fun
= CONSP (Vinhibit_quit
) ? XCDR (Vinhibit_quit
) : Qnil
;
1895 Lisp_Object args
[4];
1896 args
[0] = build_string ("Error in %s (%s): %S");
1899 args
[3] = error_data
;
1905 Lisp_Object newval
= Qnil
;
1906 for (val
= find_symbol_value (hook
); CONSP (val
); val
= XCDR (val
))
1907 if (EQ (fun
, XCAR (val
)))
1910 newval
= Fcons (XCAR (val
), newval
);
1912 return Fset (hook
, Fnreverse (newval
));
1913 /* Not found in the local part of the hook. Let's look at the global
1916 for (val
= (NILP (Fdefault_boundp (hook
)) ? Qnil
1917 : Fdefault_value (hook
));
1918 CONSP (val
); val
= XCDR (val
))
1919 if (EQ (fun
, XCAR (val
)))
1922 newval
= Fcons (XCAR (val
), newval
);
1924 return Fset_default (hook
, Fnreverse (newval
));
1930 safe_run_hook_funcall (ptrdiff_t nargs
, Lisp_Object
*args
)
1932 eassert (nargs
== 1);
1933 if (CONSP (Vinhibit_quit
))
1934 XSETCDR (Vinhibit_quit
, args
[0]);
1936 Vinhibit_quit
= Fcons (Vinhibit_quit
, args
[0]);
1938 internal_condition_case (safe_run_hooks_1
, Qt
, safe_run_hooks_error
);
1942 /* If we get an error while running the hook, cause the hook variable
1943 to be nil. Also inhibit quits, so that C-g won't cause the hook
1944 to mysteriously evaporate. */
1947 safe_run_hooks (Lisp_Object hook
)
1949 /* FIXME: our `internal_condition_case' does not provide any way to pass data
1950 to its body or to its handlers other than via globals such as
1951 dynamically-bound variables ;-) */
1952 ptrdiff_t count
= SPECPDL_INDEX ();
1953 specbind (Qinhibit_quit
, hook
);
1955 run_hook_with_args (1, &hook
, safe_run_hook_funcall
);
1957 unbind_to (count
, Qnil
);
1961 /* Nonzero means polling for input is temporarily suppressed. */
1963 int poll_suppress_count
;
1966 #ifdef POLL_FOR_INPUT
1968 /* Asynchronous timer for polling. */
1970 static struct atimer
*poll_timer
;
1972 /* Poll for input, so that we catch a C-g if it comes in. This
1973 function is called from x_make_frame_visible, see comment
1977 poll_for_input_1 (void)
1979 if (! input_blocked_p ()
1980 && !waiting_for_input
)
1984 /* Timer callback function for poll_timer. TIMER is equal to
1988 poll_for_input (struct atimer
*timer
)
1990 if (poll_suppress_count
== 0)
1991 pending_signals
= 1;
1994 #endif /* POLL_FOR_INPUT */
1996 /* Begin signals to poll for input, if they are appropriate.
1997 This function is called unconditionally from various places. */
2000 start_polling (void)
2002 #ifdef POLL_FOR_INPUT
2003 /* XXX This condition was (read_socket_hook && !interrupt_input),
2004 but read_socket_hook is not global anymore. Let's pretend that
2006 if (!interrupt_input
)
2008 /* Turn alarm handling on unconditionally. It might have
2009 been turned off in process.c. */
2010 turn_on_atimers (1);
2012 /* If poll timer doesn't exist, are we need one with
2013 a different interval, start a new one. */
2014 if (poll_timer
== NULL
2015 || EMACS_SECS (poll_timer
->interval
) != polling_period
)
2017 time_t period
= max (1, min (polling_period
, TYPE_MAXIMUM (time_t)));
2018 EMACS_TIME interval
= make_emacs_time (period
, 0);
2021 cancel_atimer (poll_timer
);
2023 poll_timer
= start_atimer (ATIMER_CONTINUOUS
, interval
,
2024 poll_for_input
, NULL
);
2027 /* Let the timer's callback function poll for input
2028 if this becomes zero. */
2029 --poll_suppress_count
;
2034 /* True if we are using polling to handle input asynchronously. */
2037 input_polling_used (void)
2039 #ifdef POLL_FOR_INPUT
2040 /* XXX This condition was (read_socket_hook && !interrupt_input),
2041 but read_socket_hook is not global anymore. Let's pretend that
2043 return !interrupt_input
;
2049 /* Turn off polling. */
2054 #ifdef POLL_FOR_INPUT
2055 /* XXX This condition was (read_socket_hook && !interrupt_input),
2056 but read_socket_hook is not global anymore. Let's pretend that
2058 if (!interrupt_input
)
2059 ++poll_suppress_count
;
2063 /* Set the value of poll_suppress_count to COUNT
2064 and start or stop polling accordingly. */
2067 set_poll_suppress_count (int count
)
2069 #ifdef POLL_FOR_INPUT
2070 if (count
== 0 && poll_suppress_count
!= 0)
2072 poll_suppress_count
= 1;
2075 else if (count
!= 0 && poll_suppress_count
== 0)
2079 poll_suppress_count
= count
;
2083 /* Bind polling_period to a value at least N.
2084 But don't decrease it. */
2087 bind_polling_period (int n
)
2089 #ifdef POLL_FOR_INPUT
2090 EMACS_INT
new = polling_period
;
2095 stop_other_atimers (poll_timer
);
2097 specbind (Qpolling_period
, make_number (new));
2098 /* Start a new alarm with the new period. */
2103 /* Apply the control modifier to CHARACTER. */
2106 make_ctrl_char (int c
)
2108 /* Save the upper bits here. */
2109 int upper
= c
& ~0177;
2111 if (! ASCII_BYTE_P (c
))
2112 return c
|= ctrl_modifier
;
2116 /* Everything in the columns containing the upper-case letters
2117 denotes a control character. */
2118 if (c
>= 0100 && c
< 0140)
2122 /* Set the shift modifier for a control char
2123 made from a shifted letter. But only for letters! */
2124 if (oc
>= 'A' && oc
<= 'Z')
2125 c
|= shift_modifier
;
2128 /* The lower-case letters denote control characters too. */
2129 else if (c
>= 'a' && c
<= 'z')
2132 /* Include the bits for control and shift
2133 only if the basic ASCII code can't indicate them. */
2137 /* Replace the high bits. */
2138 c
|= (upper
& ~ctrl_modifier
);
2143 /* Display the help-echo property of the character after the mouse pointer.
2144 Either show it in the echo area, or call show-help-function to display
2145 it by other means (maybe in a tooltip).
2147 If HELP is nil, that means clear the previous help echo.
2149 If HELP is a string, display that string. If HELP is a function,
2150 call it with OBJECT and POS as arguments; the function should
2151 return a help string or nil for none. For all other types of HELP,
2152 evaluate it to obtain a string.
2154 WINDOW is the window in which the help was generated, if any.
2155 It is nil if not in a window.
2157 If OBJECT is a buffer, POS is the position in the buffer where the
2158 `help-echo' text property was found.
2160 If OBJECT is an overlay, that overlay has a `help-echo' property,
2161 and POS is the position in the overlay's buffer under the mouse.
2163 If OBJECT is a string (an overlay string or a string displayed with
2164 the `display' property). POS is the position in that string under
2167 Note: this function may only be called with HELP nil or a string
2168 from X code running asynchronously. */
2171 show_help_echo (Lisp_Object help
, Lisp_Object window
, Lisp_Object object
,
2174 if (!NILP (help
) && !STRINGP (help
))
2176 if (FUNCTIONP (help
))
2177 help
= safe_call (4, help
, window
, object
, pos
);
2179 help
= safe_eval (help
);
2181 if (!STRINGP (help
))
2185 if (!noninteractive
&& STRINGP (help
))
2187 /* The mouse-fixup-help-message Lisp function can call
2188 mouse_position_hook, which resets the mouse_moved flags.
2189 This causes trouble if we are trying to read a mouse motion
2190 event (i.e., if we are inside a `track-mouse' form), so we
2191 restore the mouse_moved flag. */
2192 FRAME_PTR f
= NILP (do_mouse_tracking
) ? NULL
: some_mouse_moved ();
2193 help
= call1 (Qmouse_fixup_help_message
, help
);
2198 if (STRINGP (help
) || NILP (help
))
2200 if (!NILP (Vshow_help_function
))
2201 call1 (Vshow_help_function
, help
);
2202 help_echo_showing_p
= STRINGP (help
);
2208 /* Input of single characters from keyboard */
2210 static Lisp_Object
kbd_buffer_get_event (KBOARD
**kbp
, bool *used_mouse_menu
,
2211 EMACS_TIME
*end_time
);
2212 static void record_char (Lisp_Object c
);
2214 static Lisp_Object help_form_saved_window_configs
;
2216 read_char_help_form_unwind (Lisp_Object arg
)
2218 Lisp_Object window_config
= XCAR (help_form_saved_window_configs
);
2219 help_form_saved_window_configs
= XCDR (help_form_saved_window_configs
);
2220 if (!NILP (window_config
))
2221 Fset_window_configuration (window_config
);
2225 #define STOP_POLLING \
2226 do { if (! polling_stopped_here) stop_polling (); \
2227 polling_stopped_here = 1; } while (0)
2229 #define RESUME_POLLING \
2230 do { if (polling_stopped_here) start_polling (); \
2231 polling_stopped_here = 0; } while (0)
2233 /* Read a character from the keyboard; call the redisplay if needed. */
2234 /* commandflag 0 means do not autosave, but do redisplay.
2235 -1 means do not redisplay, but do autosave.
2238 /* The arguments MAP is for menu prompting. MAP is a keymap.
2240 PREV_EVENT is the previous input event, or nil if we are reading
2241 the first event of a key sequence (or not reading a key sequence).
2242 If PREV_EVENT is t, that is a "magic" value that says
2243 not to run input methods, but in other respects to act as if
2244 not reading a key sequence.
2246 If USED_MOUSE_MENU is non-null, then set *USED_MOUSE_MENU to true
2247 if we used a mouse menu to read the input, or false otherwise. If
2248 USED_MOUSE_MENU is null, don't dereference it.
2250 Value is -2 when we find input on another keyboard. A second call
2251 to read_char will read it.
2253 If END_TIME is non-null, it is a pointer to an EMACS_TIME
2254 specifying the maximum time to wait until. If no input arrives by
2255 that time, stop waiting and return nil.
2257 Value is t if we showed a menu and the user rejected it. */
2260 read_char (int commandflag
, Lisp_Object map
,
2261 Lisp_Object prev_event
,
2262 bool *used_mouse_menu
, EMACS_TIME
*end_time
)
2266 sys_jmp_buf local_getcjmp
;
2267 sys_jmp_buf save_jump
;
2268 Lisp_Object tem
, save
;
2269 volatile Lisp_Object previous_echo_area_message
;
2270 volatile Lisp_Object also_record
;
2271 volatile bool reread
;
2272 struct gcpro gcpro1
, gcpro2
;
2273 bool volatile polling_stopped_here
= 0;
2274 struct kboard
*orig_kboard
= current_kboard
;
2278 #if 0 /* This was commented out as part of fixing echo for C-u left. */
2279 before_command_key_count
= this_command_key_count
;
2280 before_command_echo_length
= echo_length ();
2283 previous_echo_area_message
= Qnil
;
2285 GCPRO2 (c
, previous_echo_area_message
);
2290 if (CONSP (Vunread_post_input_method_events
))
2292 c
= XCAR (Vunread_post_input_method_events
);
2293 Vunread_post_input_method_events
2294 = XCDR (Vunread_post_input_method_events
);
2296 /* Undo what read_char_x_menu_prompt did when it unread
2297 additional keys returned by Fx_popup_menu. */
2299 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2307 if (CONSP (Vunread_command_events
))
2309 bool was_disabled
= 0;
2311 c
= XCAR (Vunread_command_events
);
2312 Vunread_command_events
= XCDR (Vunread_command_events
);
2316 /* Undo what sit-for did when it unread additional keys
2317 inside universal-argument. */
2320 && EQ (XCAR (c
), Qt
))
2326 /* Undo what read_char_x_menu_prompt did when it unread
2327 additional keys returned by Fx_popup_menu. */
2329 && EQ (XCDR (c
), Qdisabled
)
2330 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
))))
2336 /* If the queued event is something that used the mouse,
2337 set used_mouse_menu accordingly. */
2339 /* Also check was_disabled so last-nonmenu-event won't return
2340 a bad value when submenus are involved. (Bug#447) */
2341 && (EQ (c
, Qtool_bar
) || EQ (c
, Qmenu_bar
) || was_disabled
))
2342 *used_mouse_menu
= 1;
2344 goto reread_for_input_method
;
2347 if (CONSP (Vunread_input_method_events
))
2349 c
= XCAR (Vunread_input_method_events
);
2350 Vunread_input_method_events
= XCDR (Vunread_input_method_events
);
2352 /* Undo what read_char_x_menu_prompt did when it unread
2353 additional keys returned by Fx_popup_menu. */
2355 && (SYMBOLP (XCAR (c
)) || INTEGERP (XCAR (c
)))
2359 goto reread_for_input_method
;
2362 this_command_key_count_reset
= 0;
2364 if (!NILP (Vexecuting_kbd_macro
))
2366 /* We set this to Qmacro; since that's not a frame, nobody will
2367 try to switch frames on us, and the selected window will
2370 Since this event came from a macro, it would be misleading to
2371 leave internal_last_event_frame set to wherever the last
2372 real event came from. Normally, a switch-frame event selects
2373 internal_last_event_frame after each command is read, but
2374 events read from a macro should never cause a new frame to be
2376 Vlast_event_frame
= internal_last_event_frame
= Qmacro
;
2378 /* Exit the macro if we are at the end.
2379 Also, some things replace the macro with t
2380 to force an early exit. */
2381 if (EQ (Vexecuting_kbd_macro
, Qt
)
2382 || executing_kbd_macro_index
>= XFASTINT (Flength (Vexecuting_kbd_macro
)))
2388 c
= Faref (Vexecuting_kbd_macro
, make_number (executing_kbd_macro_index
));
2389 if (STRINGP (Vexecuting_kbd_macro
)
2390 && (XFASTINT (c
) & 0x80) && (XFASTINT (c
) <= 0xff))
2391 XSETFASTINT (c
, CHAR_META
| (XFASTINT (c
) & ~0x80));
2393 executing_kbd_macro_index
++;
2398 if (!NILP (unread_switch_frame
))
2400 c
= unread_switch_frame
;
2401 unread_switch_frame
= Qnil
;
2403 /* This event should make it into this_command_keys, and get echoed
2404 again, so we do not set `reread'. */
2408 /* If redisplay was requested. */
2409 if (commandflag
>= 0)
2411 bool echo_current
= EQ (echo_message_buffer
, echo_area_buffer
[0]);
2413 /* If there is pending input, process any events which are not
2414 user-visible, such as X selection_request events. */
2416 || detect_input_pending_run_timers (0))
2417 swallow_events (0); /* May clear input_pending. */
2419 /* Redisplay if no pending input. */
2420 while (!input_pending
)
2422 if (help_echo_showing_p
&& !EQ (selected_window
, minibuf_window
))
2423 redisplay_preserve_echo_area (5);
2428 /* Normal case: no input arrived during redisplay. */
2431 /* Input arrived and pre-empted redisplay.
2432 Process any events which are not user-visible. */
2434 /* If that cleared input_pending, try again to redisplay. */
2437 /* Prevent the redisplay we just did
2438 from messing up echoing of the input after the prompt. */
2439 if (commandflag
== 0 && echo_current
)
2440 echo_message_buffer
= echo_area_buffer
[0];
2444 /* Message turns off echoing unless more keystrokes turn it on again.
2446 The code in 20.x for the condition was
2448 1. echo_area_glyphs && *echo_area_glyphs
2449 2. && echo_area_glyphs != current_kboard->echobuf
2450 3. && ok_to_echo_at_next_pause != echo_area_glyphs
2452 (1) means there's a current message displayed
2454 (2) means it's not the message from echoing from the current
2457 (3) There's only one place in 20.x where ok_to_echo_at_next_pause
2458 is set to a non-null value. This is done in read_char and it is
2459 set to echo_area_glyphs after a call to echo_char. That means
2460 ok_to_echo_at_next_pause is either null or
2461 current_kboard->echobuf with the appropriate current_kboard at
2464 So, condition (3) means in clear text ok_to_echo_at_next_pause
2465 must be either null, or the current message isn't from echoing at
2466 all, or it's from echoing from a different kboard than the
2469 if (/* There currently is something in the echo area. */
2470 !NILP (echo_area_buffer
[0])
2471 && (/* And it's either not from echoing. */
2472 !EQ (echo_area_buffer
[0], echo_message_buffer
)
2473 /* Or it's an echo from a different kboard. */
2474 || echo_kboard
!= current_kboard
2475 /* Or we explicitly allow overwriting whatever there is. */
2476 || ok_to_echo_at_next_pause
== NULL
))
2481 /* Try reading a character via menu prompting in the minibuf.
2482 Try this before the sit-for, because the sit-for
2483 would do the wrong thing if we are supposed to do
2484 menu prompting. If EVENT_HAS_PARAMETERS then we are reading
2485 after a mouse event so don't try a minibuf menu. */
2487 if (KEYMAPP (map
) && INTERACTIVE
2488 && !NILP (prev_event
) && ! EVENT_HAS_PARAMETERS (prev_event
)
2489 /* Don't bring up a menu if we already have another event. */
2490 && NILP (Vunread_command_events
)
2491 && !detect_input_pending_run_timers (0))
2493 c
= read_char_minibuf_menu_prompt (commandflag
, map
);
2495 if (INTEGERP (c
) && XINT (c
) == -2)
2496 return c
; /* wrong_kboard_jmpbuf */
2502 /* Make a longjmp point for quits to use, but don't alter getcjmp just yet.
2503 We will do that below, temporarily for short sections of code,
2504 when appropriate. local_getcjmp must be in effect
2505 around any call to sit_for or kbd_buffer_get_event;
2506 it *must not* be in effect when we call redisplay. */
2508 jmpcount
= SPECPDL_INDEX ();
2509 if (sys_setjmp (local_getcjmp
))
2511 /* Handle quits while reading the keyboard. */
2512 /* We must have saved the outer value of getcjmp here,
2513 so restore it now. */
2514 restore_getcjmp (save_jump
);
2515 unbind_to (jmpcount
, Qnil
);
2516 XSETINT (c
, quit_char
);
2517 internal_last_event_frame
= selected_frame
;
2518 Vlast_event_frame
= internal_last_event_frame
;
2519 /* If we report the quit char as an event,
2520 don't do so more than once. */
2521 if (!NILP (Vinhibit_quit
))
2525 KBOARD
*kb
= FRAME_KBOARD (XFRAME (selected_frame
));
2526 if (kb
!= current_kboard
)
2528 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2529 /* We shouldn't get here if we were in single-kboard mode! */
2534 while (CONSP (XCDR (last
)))
2536 if (!NILP (XCDR (last
)))
2540 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2542 XSETCDR (last
, Fcons (c
, Qnil
));
2543 kb
->kbd_queue_has_data
= 1;
2544 current_kboard
= kb
;
2545 /* This is going to exit from read_char
2546 so we had better get rid of this frame's stuff. */
2548 return make_number (-2); /* wrong_kboard_jmpbuf */
2554 /* Start idle timers if no time limit is supplied. We don't do it
2555 if a time limit is supplied to avoid an infinite recursion in the
2556 situation where an idle timer calls `sit-for'. */
2559 timer_start_idle ();
2561 /* If in middle of key sequence and minibuffer not active,
2562 start echoing if enough time elapses. */
2564 if (minibuf_level
== 0
2566 && !current_kboard
->immediate_echo
2567 && this_command_key_count
> 0
2569 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
2570 && NILP (Fzerop (Vecho_keystrokes
))
2571 && (/* No message. */
2572 NILP (echo_area_buffer
[0])
2573 /* Or empty message. */
2574 || (BUF_BEG (XBUFFER (echo_area_buffer
[0]))
2575 == BUF_Z (XBUFFER (echo_area_buffer
[0])))
2576 /* Or already echoing from same kboard. */
2577 || (echo_kboard
&& ok_to_echo_at_next_pause
== echo_kboard
)
2578 /* Or not echoing before and echoing allowed. */
2579 || (!echo_kboard
&& ok_to_echo_at_next_pause
)))
2581 /* After a mouse event, start echoing right away.
2582 This is because we are probably about to display a menu,
2583 and we don't want to delay before doing so. */
2584 if (EVENT_HAS_PARAMETERS (prev_event
))
2590 save_getcjmp (save_jump
);
2591 restore_getcjmp (local_getcjmp
);
2592 tem0
= sit_for (Vecho_keystrokes
, 1, 1);
2593 restore_getcjmp (save_jump
);
2595 && ! CONSP (Vunread_command_events
))
2600 /* Maybe auto save due to number of keystrokes. */
2602 if (commandflag
!= 0
2603 && auto_save_interval
> 0
2604 && num_nonmacro_input_events
- last_auto_save
> max (auto_save_interval
, 20)
2605 && !detect_input_pending_run_timers (0))
2607 Fdo_auto_save (Qnil
, Qnil
);
2608 /* Hooks can actually change some buffers in auto save. */
2612 /* Try reading using an X menu.
2613 This is never confused with reading using the minibuf
2614 because the recursive call of read_char in read_char_minibuf_menu_prompt
2615 does not pass on any keymaps. */
2617 if (KEYMAPP (map
) && INTERACTIVE
2618 && !NILP (prev_event
)
2619 && EVENT_HAS_PARAMETERS (prev_event
)
2620 && !EQ (XCAR (prev_event
), Qmenu_bar
)
2621 && !EQ (XCAR (prev_event
), Qtool_bar
)
2622 /* Don't bring up a menu if we already have another event. */
2623 && NILP (Vunread_command_events
))
2625 c
= read_char_x_menu_prompt (map
, prev_event
, used_mouse_menu
);
2627 /* Now that we have read an event, Emacs is not idle. */
2634 /* Maybe autosave and/or garbage collect due to idleness. */
2636 if (INTERACTIVE
&& NILP (c
))
2639 ptrdiff_t buffer_size
;
2641 /* Slow down auto saves logarithmically in size of current buffer,
2642 and garbage collect while we're at it. */
2643 if (! MINI_WINDOW_P (XWINDOW (selected_window
)))
2644 last_non_minibuf_size
= Z
- BEG
;
2645 buffer_size
= (last_non_minibuf_size
>> 8) + 1;
2647 while (buffer_size
> 64)
2648 delay_level
++, buffer_size
-= buffer_size
>> 2;
2649 if (delay_level
< 4) delay_level
= 4;
2650 /* delay_level is 4 for files under around 50k, 7 at 100k,
2651 9 at 200k, 11 at 300k, and 12 at 500k. It is 15 at 1 meg. */
2653 /* Auto save if enough time goes by without input. */
2654 if (commandflag
!= 0
2655 && num_nonmacro_input_events
> last_auto_save
2656 && INTEGERP (Vauto_save_timeout
)
2657 && XINT (Vauto_save_timeout
) > 0)
2660 EMACS_INT timeout
= (delay_level
2661 * min (XFASTINT (Vauto_save_timeout
) / 4,
2662 MOST_POSITIVE_FIXNUM
/ delay_level
));
2663 save_getcjmp (save_jump
);
2664 restore_getcjmp (local_getcjmp
);
2665 tem0
= sit_for (make_number (timeout
), 1, 1);
2666 restore_getcjmp (save_jump
);
2669 && ! CONSP (Vunread_command_events
))
2671 Fdo_auto_save (Qnil
, Qnil
);
2676 /* If there is still no input available, ask for GC. */
2677 if (!detect_input_pending_run_timers (0))
2681 /* Notify the caller if an autosave hook, or a timer, sentinel or
2682 filter in the sit_for calls above have changed the current
2683 kboard. This could happen if they use the minibuffer or start a
2684 recursive edit, like the fancy splash screen in server.el's
2685 filter. If this longjmp wasn't here, read_key_sequence would
2686 interpret the next key sequence using the wrong translation
2687 tables and function keymaps. */
2688 if (NILP (c
) && current_kboard
!= orig_kboard
)
2691 return make_number (-2); /* wrong_kboard_jmpbuf */
2694 /* If this has become non-nil here, it has been set by a timer
2695 or sentinel or filter. */
2696 if (CONSP (Vunread_command_events
))
2698 c
= XCAR (Vunread_command_events
);
2699 Vunread_command_events
= XCDR (Vunread_command_events
);
2702 /* Read something from current KBOARD's side queue, if possible. */
2706 if (current_kboard
->kbd_queue_has_data
)
2708 if (!CONSP (KVAR (current_kboard
, kbd_queue
)))
2710 c
= XCAR (KVAR (current_kboard
, kbd_queue
));
2711 kset_kbd_queue (current_kboard
,
2712 XCDR (KVAR (current_kboard
, kbd_queue
)));
2713 if (NILP (KVAR (current_kboard
, kbd_queue
)))
2714 current_kboard
->kbd_queue_has_data
= 0;
2715 input_pending
= readable_events (0);
2716 if (EVENT_HAS_PARAMETERS (c
)
2717 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qswitch_frame
))
2718 internal_last_event_frame
= XCAR (XCDR (c
));
2719 Vlast_event_frame
= internal_last_event_frame
;
2723 /* If current_kboard's side queue is empty check the other kboards.
2724 If one of them has data that we have not yet seen here,
2725 switch to it and process the data waiting for it.
2727 Note: if the events queued up for another kboard
2728 have already been seen here, and therefore are not a complete command,
2729 the kbd_queue_has_data field is 0, so we skip that kboard here.
2730 That's to avoid an infinite loop switching between kboards here. */
2731 if (NILP (c
) && !single_kboard
)
2734 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
2735 if (kb
->kbd_queue_has_data
)
2737 current_kboard
= kb
;
2738 /* This is going to exit from read_char
2739 so we had better get rid of this frame's stuff. */
2741 return make_number (-2); /* wrong_kboard_jmpbuf */
2749 /* Finally, we read from the main queue,
2750 and if that gives us something we can't use yet, we put it on the
2751 appropriate side queue and try again. */
2755 KBOARD
*kb
IF_LINT (= NULL
);
2757 if (end_time
&& EMACS_TIME_LE (*end_time
, current_emacs_time ()))
2760 /* Actually read a character, waiting if necessary. */
2761 save_getcjmp (save_jump
);
2762 restore_getcjmp (local_getcjmp
);
2764 timer_start_idle ();
2765 c
= kbd_buffer_get_event (&kb
, used_mouse_menu
, end_time
);
2766 restore_getcjmp (save_jump
);
2768 if (! NILP (c
) && (kb
!= current_kboard
))
2770 Lisp_Object last
= KVAR (kb
, kbd_queue
);
2773 while (CONSP (XCDR (last
)))
2775 if (!NILP (XCDR (last
)))
2779 kset_kbd_queue (kb
, Fcons (c
, Qnil
));
2781 XSETCDR (last
, Fcons (c
, Qnil
));
2782 kb
->kbd_queue_has_data
= 1;
2786 current_kboard
= kb
;
2787 /* This is going to exit from read_char
2788 so we had better get rid of this frame's stuff. */
2790 return make_number (-2);
2794 /* Terminate Emacs in batch mode if at eof. */
2795 if (noninteractive
&& INTEGERP (c
) && XINT (c
) < 0)
2796 Fkill_emacs (make_number (1));
2800 /* Add in any extra modifiers, where appropriate. */
2801 if ((extra_keyboard_modifiers
& CHAR_CTL
)
2802 || ((extra_keyboard_modifiers
& 0177) < ' '
2803 && (extra_keyboard_modifiers
& 0177) != 0))
2804 XSETINT (c
, make_ctrl_char (XINT (c
)));
2806 /* Transfer any other modifier bits directly from
2807 extra_keyboard_modifiers to c. Ignore the actual character code
2808 in the low 16 bits of extra_keyboard_modifiers. */
2809 XSETINT (c
, XINT (c
) | (extra_keyboard_modifiers
& ~0xff7f & ~CHAR_CTL
));
2820 if (commandflag
>= 0
2821 && !input_pending
&& !detect_input_pending_run_timers (0))
2827 /* Buffer switch events are only for internal wakeups
2828 so don't show them to the user.
2829 Also, don't record a key if we already did. */
2833 /* Process special events within read_char
2834 and loop around to read another event. */
2837 tem
= access_keymap (get_keymap (Vspecial_event_map
, 0, 1), c
, 0, 0, 1);
2842 struct buffer
*prev_buffer
= current_buffer
;
2843 last_input_event
= c
;
2844 Fcommand_execute (tem
, Qnil
, Fvector (1, &last_input_event
), Qt
);
2846 if (CONSP (c
) && EQ (XCAR (c
), Qselect_window
) && !end_time
)
2847 /* We stopped being idle for this event; undo that. This
2848 prevents automatic window selection (under
2849 mouse_autoselect_window from acting as a real input event, for
2850 example banishing the mouse under mouse-avoidance-mode. */
2851 timer_resume_idle ();
2853 if (current_buffer
!= prev_buffer
)
2855 /* The command may have changed the keymaps. Pretend there
2856 is input in another keyboard and return. This will
2857 recalculate keymaps. */
2858 c
= make_number (-2);
2865 /* Handle things that only apply to characters. */
2868 /* If kbd_buffer_get_event gave us an EOF, return that. */
2872 if ((STRINGP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2873 && UNSIGNED_CMP (XFASTINT (c
), <,
2874 SCHARS (KVAR (current_kboard
,
2875 Vkeyboard_translate_table
))))
2876 || (VECTORP (KVAR (current_kboard
, Vkeyboard_translate_table
))
2877 && UNSIGNED_CMP (XFASTINT (c
), <,
2878 ASIZE (KVAR (current_kboard
,
2879 Vkeyboard_translate_table
))))
2880 || (CHAR_TABLE_P (KVAR (current_kboard
, Vkeyboard_translate_table
))
2884 d
= Faref (KVAR (current_kboard
, Vkeyboard_translate_table
), c
);
2885 /* nil in keyboard-translate-table means no translation. */
2891 /* If this event is a mouse click in the menu bar,
2892 return just menu-bar for now. Modify the mouse click event
2893 so we won't do this twice, then queue it up. */
2894 if (EVENT_HAS_PARAMETERS (c
)
2896 && CONSP (EVENT_START (c
))
2897 && CONSP (XCDR (EVENT_START (c
))))
2901 posn
= POSN_POSN (EVENT_START (c
));
2902 /* Handle menu-bar events:
2903 insert the dummy prefix event `menu-bar'. */
2904 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
2906 /* Change menu-bar to (menu-bar) as the event "position". */
2907 POSN_SET_POSN (EVENT_START (c
), Fcons (posn
, Qnil
));
2910 Vunread_command_events
= Fcons (c
, Vunread_command_events
);
2915 /* Store these characters into recent_keys, the dribble file if any,
2916 and the keyboard macro being defined, if any. */
2918 if (! NILP (also_record
))
2919 record_char (also_record
);
2921 /* Wipe the echo area.
2922 But first, if we are about to use an input method,
2923 save the echo area contents for it to refer to. */
2925 && ! NILP (Vinput_method_function
)
2926 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2928 previous_echo_area_message
= Fcurrent_message ();
2929 Vinput_method_previous_message
= previous_echo_area_message
;
2932 /* Now wipe the echo area, except for help events which do their
2933 own stuff with the echo area. */
2935 || (!(EQ (Qhelp_echo
, XCAR (c
)))
2936 && !(EQ (Qswitch_frame
, XCAR (c
)))
2937 /* Don't wipe echo area for select window events: These might
2938 get delayed via `mouse-autoselect-window' (Bug#11304). */
2939 && !(EQ (Qselect_window
, XCAR (c
)))))
2941 if (!NILP (echo_area_buffer
[0]))
2943 safe_run_hooks (Qecho_area_clear_hook
);
2944 clear_message (1, 0);
2948 reread_for_input_method
:
2950 /* Pass this to the input method, if appropriate. */
2952 && ! NILP (Vinput_method_function
)
2953 /* Don't run the input method within a key sequence,
2954 after the first event of the key sequence. */
2955 && NILP (prev_event
)
2956 && ' ' <= XINT (c
) && XINT (c
) < 256 && XINT (c
) != 127)
2959 ptrdiff_t key_count
;
2960 bool key_count_reset
;
2961 struct gcpro gcpro1
;
2962 ptrdiff_t count
= SPECPDL_INDEX ();
2964 /* Save the echo status. */
2965 bool saved_immediate_echo
= current_kboard
->immediate_echo
;
2966 struct kboard
*saved_ok_to_echo
= ok_to_echo_at_next_pause
;
2967 Lisp_Object saved_echo_string
= KVAR (current_kboard
, echo_string
);
2968 ptrdiff_t saved_echo_after_prompt
= current_kboard
->echo_after_prompt
;
2971 if (before_command_restore_flag
)
2973 this_command_key_count
= before_command_key_count_1
;
2974 if (this_command_key_count
< this_single_command_key_start
)
2975 this_single_command_key_start
= this_command_key_count
;
2976 echo_truncate (before_command_echo_length_1
);
2977 before_command_restore_flag
= 0;
2981 /* Save the this_command_keys status. */
2982 key_count
= this_command_key_count
;
2983 key_count_reset
= this_command_key_count_reset
;
2986 keys
= Fcopy_sequence (this_command_keys
);
2991 /* Clear out this_command_keys. */
2992 this_command_key_count
= 0;
2993 this_command_key_count_reset
= 0;
2995 /* Now wipe the echo area. */
2996 if (!NILP (echo_area_buffer
[0]))
2997 safe_run_hooks (Qecho_area_clear_hook
);
2998 clear_message (1, 0);
3001 /* If we are not reading a key sequence,
3002 never use the echo area. */
3005 specbind (Qinput_method_use_echo_area
, Qt
);
3008 /* Call the input method. */
3009 tem
= call1 (Vinput_method_function
, c
);
3011 tem
= unbind_to (count
, tem
);
3013 /* Restore the saved echoing state
3014 and this_command_keys state. */
3015 this_command_key_count
= key_count
;
3016 this_command_key_count_reset
= key_count_reset
;
3018 this_command_keys
= keys
;
3021 ok_to_echo_at_next_pause
= saved_ok_to_echo
;
3022 kset_echo_string (current_kboard
, saved_echo_string
);
3023 current_kboard
->echo_after_prompt
= saved_echo_after_prompt
;
3024 if (saved_immediate_echo
)
3029 /* The input method can return no events. */
3032 /* Bring back the previous message, if any. */
3033 if (! NILP (previous_echo_area_message
))
3034 message_with_string ("%s", previous_echo_area_message
, 0);
3037 /* It returned one event or more. */
3039 Vunread_post_input_method_events
3040 = nconc2 (XCDR (tem
), Vunread_post_input_method_events
);
3045 /* Display help if not echoing. */
3046 if (CONSP (c
) && EQ (XCAR (c
), Qhelp_echo
))
3048 /* (help-echo FRAME HELP WINDOW OBJECT POS). */
3049 Lisp_Object help
, object
, position
, window
, htem
;
3051 htem
= Fcdr (XCDR (c
));
3054 window
= Fcar (htem
);
3056 object
= Fcar (htem
);
3058 position
= Fcar (htem
);
3060 show_help_echo (help
, window
, object
, position
);
3062 /* We stopped being idle for this event; undo that. */
3064 timer_resume_idle ();
3068 if ((! reread
|| this_command_key_count
== 0
3069 || this_command_key_count_reset
)
3073 /* Don't echo mouse motion events. */
3074 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3075 && NILP (Fzerop (Vecho_keystrokes
))
3076 && ! (EVENT_HAS_PARAMETERS (c
)
3077 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_movement
)))
3080 if (! NILP (also_record
))
3081 echo_char (also_record
);
3082 /* Once we reread a character, echoing can happen
3083 the next time we pause to read a new one. */
3084 ok_to_echo_at_next_pause
= current_kboard
;
3087 /* Record this character as part of the current key. */
3088 add_command_key (c
);
3089 if (! NILP (also_record
))
3090 add_command_key (also_record
);
3093 last_input_event
= c
;
3096 /* Process the help character specially if enabled. */
3097 if (!NILP (Vhelp_form
) && help_char_p (c
))
3099 ptrdiff_t count
= SPECPDL_INDEX ();
3101 help_form_saved_window_configs
3102 = Fcons (Fcurrent_window_configuration (Qnil
),
3103 help_form_saved_window_configs
);
3104 record_unwind_protect (read_char_help_form_unwind
, Qnil
);
3105 call0 (Qhelp_form_show
);
3110 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3111 if (EVENT_HAS_PARAMETERS (c
)
3112 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (c
)), Qmouse_click
))
3113 XSETCAR (help_form_saved_window_configs
, Qnil
);
3115 while (BUFFERP (c
));
3116 /* Remove the help from the frame. */
3117 unbind_to (count
, Qnil
);
3120 if (EQ (c
, make_number (040)))
3124 c
= read_char (0, Qnil
, Qnil
, 0, NULL
);
3125 while (BUFFERP (c
));
3134 /* Record a key that came from a mouse menu.
3135 Record it for echoing, for this-command-keys, and so on. */
3138 record_menu_key (Lisp_Object c
)
3140 /* Wipe the echo area. */
3141 clear_message (1, 0);
3146 before_command_key_count
= this_command_key_count
;
3147 before_command_echo_length
= echo_length ();
3150 /* Don't echo mouse motion events. */
3151 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
3152 && NILP (Fzerop (Vecho_keystrokes
)))
3156 /* Once we reread a character, echoing can happen
3157 the next time we pause to read a new one. */
3158 ok_to_echo_at_next_pause
= 0;
3161 /* Record this character as part of the current key. */
3162 add_command_key (c
);
3164 /* Re-reading in the middle of a command */
3165 last_input_event
= c
;
3169 /* Return true if should recognize C as "the help character". */
3172 help_char_p (Lisp_Object c
)
3176 if (EQ (c
, Vhelp_char
))
3178 for (tail
= Vhelp_event_list
; CONSP (tail
); tail
= XCDR (tail
))
3179 if (EQ (c
, XCAR (tail
)))
3184 /* Record the input event C in various ways. */
3187 record_char (Lisp_Object c
)
3191 if (CONSP (c
) && (EQ (XCAR (c
), Qhelp_echo
) || EQ (XCAR (c
), Qmouse_movement
)))
3193 /* To avoid filling recent_keys with help-echo and mouse-movement
3194 events, we filter out repeated help-echo events, only store the
3195 first and last in a series of mouse-movement events, and don't
3196 store repeated help-echo events which are only separated by
3197 mouse-movement events. */
3199 Lisp_Object ev1
, ev2
, ev3
;
3202 if ((ix1
= recent_keys_index
- 1) < 0)
3203 ix1
= NUM_RECENT_KEYS
- 1;
3204 ev1
= AREF (recent_keys
, ix1
);
3206 if ((ix2
= ix1
- 1) < 0)
3207 ix2
= NUM_RECENT_KEYS
- 1;
3208 ev2
= AREF (recent_keys
, ix2
);
3210 if ((ix3
= ix2
- 1) < 0)
3211 ix3
= NUM_RECENT_KEYS
- 1;
3212 ev3
= AREF (recent_keys
, ix3
);
3214 if (EQ (XCAR (c
), Qhelp_echo
))
3216 /* Don't record `help-echo' in recent_keys unless it shows some help
3217 message, and a different help than the previously recorded
3219 Lisp_Object help
, last_help
;
3221 help
= Fcar_safe (Fcdr_safe (XCDR (c
)));
3222 if (!STRINGP (help
))
3224 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qhelp_echo
)
3225 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev1
))), EQ (last_help
, help
)))
3227 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3228 && CONSP (ev2
) && EQ (XCAR (ev2
), Qhelp_echo
)
3229 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev2
))), EQ (last_help
, help
)))
3231 else if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3232 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3233 && CONSP (ev3
) && EQ (XCAR (ev3
), Qhelp_echo
)
3234 && (last_help
= Fcar_safe (Fcdr_safe (XCDR (ev3
))), EQ (last_help
, help
)))
3237 else if (EQ (XCAR (c
), Qmouse_movement
))
3239 /* Only record one pair of `mouse-movement' on a window in recent_keys.
3240 So additional mouse movement events replace the last element. */
3241 Lisp_Object last_window
, window
;
3243 window
= Fcar_safe (Fcar_safe (XCDR (c
)));
3244 if (CONSP (ev1
) && EQ (XCAR (ev1
), Qmouse_movement
)
3245 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev1
))), EQ (last_window
, window
))
3246 && CONSP (ev2
) && EQ (XCAR (ev2
), Qmouse_movement
)
3247 && (last_window
= Fcar_safe (Fcar_safe (XCDR (ev2
))), EQ (last_window
, window
)))
3249 ASET (recent_keys
, ix1
, c
);
3255 store_kbd_macro_char (c
);
3259 total_keys
+= total_keys
< NUM_RECENT_KEYS
;
3260 ASET (recent_keys
, recent_keys_index
, c
);
3261 if (++recent_keys_index
>= NUM_RECENT_KEYS
)
3262 recent_keys_index
= 0;
3264 else if (recorded
< 0)
3266 /* We need to remove one or two events from recent_keys.
3267 To do this, we simply put nil at those events and move the
3268 recent_keys_index backwards over those events. Usually,
3269 users will never see those nil events, as they will be
3270 overwritten by the command keys entered to see recent_keys
3273 while (recorded
++ < 0 && total_keys
> 0)
3275 if (total_keys
< NUM_RECENT_KEYS
)
3277 if (--recent_keys_index
< 0)
3278 recent_keys_index
= NUM_RECENT_KEYS
- 1;
3279 ASET (recent_keys
, recent_keys_index
, Qnil
);
3283 num_nonmacro_input_events
++;
3285 /* Write c to the dribble file. If c is a lispy event, write
3286 the event's symbol to the dribble file, in <brackets>. Bleaugh.
3287 If you, dear reader, have a better idea, you've got the source. :-) */
3293 if (XUINT (c
) < 0x100)
3294 putc (XUINT (c
), dribble
);
3296 fprintf (dribble
, " 0x%"pI
"x", XUINT (c
));
3300 Lisp_Object dribblee
;
3302 /* If it's a structured event, take the event header. */
3303 dribblee
= EVENT_HEAD (c
);
3305 if (SYMBOLP (dribblee
))
3307 putc ('<', dribble
);
3308 fwrite (SDATA (SYMBOL_NAME (dribblee
)), sizeof (char),
3309 SBYTES (SYMBOL_NAME (dribblee
)),
3311 putc ('>', dribble
);
3320 /* Copy out or in the info on where C-g should throw to.
3321 This is used when running Lisp code from within get_char,
3322 in case get_char is called recursively.
3323 See read_process_output. */
3326 save_getcjmp (sys_jmp_buf temp
)
3328 memcpy (temp
, getcjmp
, sizeof getcjmp
);
3332 restore_getcjmp (sys_jmp_buf temp
)
3334 memcpy (getcjmp
, temp
, sizeof getcjmp
);
3337 /* Low level keyboard/mouse input.
3338 kbd_buffer_store_event places events in kbd_buffer, and
3339 kbd_buffer_get_event retrieves them. */
3341 /* Return true if there are any events in the queue that read-char
3342 would return. If this returns false, a read-char would block. */
3344 readable_events (int flags
)
3346 if (flags
& READABLE_EVENTS_DO_TIMERS_NOW
)
3349 /* If the buffer contains only FOCUS_IN_EVENT events, and
3350 READABLE_EVENTS_FILTER_EVENTS is set, report it as empty. */
3351 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3353 if (flags
& (READABLE_EVENTS_FILTER_EVENTS
3354 #ifdef USE_TOOLKIT_SCROLL_BARS
3355 | READABLE_EVENTS_IGNORE_SQUEEZABLES
3359 struct input_event
*event
;
3361 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3368 #ifdef USE_TOOLKIT_SCROLL_BARS
3369 (flags
& READABLE_EVENTS_FILTER_EVENTS
) &&
3371 event
->kind
== FOCUS_IN_EVENT
)
3372 #ifdef USE_TOOLKIT_SCROLL_BARS
3373 && !((flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3374 && event
->kind
== SCROLL_BAR_CLICK_EVENT
3375 && event
->part
== scroll_bar_handle
3376 && event
->modifiers
== 0)
3381 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3384 while (event
!= kbd_store_ptr
);
3390 if (!(flags
& READABLE_EVENTS_IGNORE_SQUEEZABLES
)
3391 && !NILP (do_mouse_tracking
) && some_mouse_moved ())
3395 if (current_kboard
->kbd_queue_has_data
)
3401 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
3402 if (kb
->kbd_queue_has_data
)
3408 /* Set this for debugging, to have a way to get out */
3409 int stop_character EXTERNALLY_VISIBLE
;
3412 event_to_kboard (struct input_event
*event
)
3414 /* Not applicable for these special events. */
3415 if (event
->kind
== SELECTION_REQUEST_EVENT
3416 || event
->kind
== SELECTION_CLEAR_EVENT
)
3420 Lisp_Object obj
= event
->frame_or_window
;
3421 /* There are some events that set this field to nil or string. */
3423 obj
= WINDOW_FRAME (XWINDOW (obj
));
3424 /* Also ignore dead frames here. */
3425 return ((FRAMEP (obj
) && FRAME_LIVE_P (XFRAME (obj
)))
3426 ? FRAME_KBOARD (XFRAME (obj
)) : NULL
);
3431 /* Return the number of slots occupied in kbd_buffer. */
3434 kbd_buffer_nr_stored (void)
3436 return kbd_fetch_ptr
== kbd_store_ptr
3438 : (kbd_fetch_ptr
< kbd_store_ptr
3439 ? kbd_store_ptr
- kbd_fetch_ptr
3440 : ((kbd_buffer
+ KBD_BUFFER_SIZE
) - kbd_fetch_ptr
3441 + (kbd_store_ptr
- kbd_buffer
)));
3443 #endif /* Store an event obtained at interrupt level into kbd_buffer, fifo */
3446 kbd_buffer_store_event (register struct input_event
*event
)
3448 kbd_buffer_store_event_hold (event
, 0);
3451 /* Store EVENT obtained at interrupt level into kbd_buffer, fifo.
3453 If HOLD_QUIT is 0, just stuff EVENT into the fifo.
3454 Else, if HOLD_QUIT.kind != NO_EVENT, discard EVENT.
3455 Else, if EVENT is a quit event, store the quit event
3456 in HOLD_QUIT, and return (thus ignoring further events).
3458 This is used to postpone the processing of the quit event until all
3459 subsequent input events have been parsed (and discarded). */
3462 kbd_buffer_store_event_hold (register struct input_event
*event
,
3463 struct input_event
*hold_quit
)
3465 if (event
->kind
== NO_EVENT
)
3468 if (hold_quit
&& hold_quit
->kind
!= NO_EVENT
)
3471 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
3473 register int c
= event
->code
& 0377;
3475 if (event
->modifiers
& ctrl_modifier
)
3476 c
= make_ctrl_char (c
);
3478 c
|= (event
->modifiers
3479 & (meta_modifier
| alt_modifier
3480 | hyper_modifier
| super_modifier
));
3484 KBOARD
*kb
= FRAME_KBOARD (XFRAME (event
->frame_or_window
));
3485 struct input_event
*sp
;
3487 if (single_kboard
&& kb
!= current_kboard
)
3490 (kb
, Fcons (make_lispy_switch_frame (event
->frame_or_window
),
3491 Fcons (make_number (c
), Qnil
)));
3492 kb
->kbd_queue_has_data
= 1;
3493 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3495 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3498 if (event_to_kboard (sp
) == kb
)
3500 sp
->kind
= NO_EVENT
;
3501 sp
->frame_or_window
= Qnil
;
3510 *hold_quit
= *event
;
3514 /* If this results in a quit_char being returned to Emacs as
3515 input, set Vlast_event_frame properly. If this doesn't
3516 get returned to Emacs as an event, the next event read
3517 will set Vlast_event_frame again, so this is safe to do. */
3521 focus
= FRAME_FOCUS_FRAME (XFRAME (event
->frame_or_window
));
3523 focus
= event
->frame_or_window
;
3524 internal_last_event_frame
= focus
;
3525 Vlast_event_frame
= focus
;
3528 last_event_timestamp
= event
->timestamp
;
3530 handle_interrupt (0);
3534 if (c
&& c
== stop_character
)
3540 /* Don't insert two BUFFER_SWITCH_EVENT's in a row.
3541 Just ignore the second one. */
3542 else if (event
->kind
== BUFFER_SWITCH_EVENT
3543 && kbd_fetch_ptr
!= kbd_store_ptr
3544 && ((kbd_store_ptr
== kbd_buffer
3545 ? kbd_buffer
+ KBD_BUFFER_SIZE
- 1
3546 : kbd_store_ptr
- 1)->kind
) == BUFFER_SWITCH_EVENT
)
3549 if (kbd_store_ptr
- kbd_buffer
== KBD_BUFFER_SIZE
)
3550 kbd_store_ptr
= kbd_buffer
;
3552 /* Don't let the very last slot in the buffer become full,
3553 since that would make the two pointers equal,
3554 and that is indistinguishable from an empty buffer.
3555 Discard the event if it would fill the last slot. */
3556 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3558 *kbd_store_ptr
= *event
;
3561 if (kbd_buffer_nr_stored () > KBD_BUFFER_SIZE
/2 && ! kbd_on_hold_p ())
3563 /* Don't read keyboard input until we have processed kbd_buffer.
3564 This happens when pasting text longer than KBD_BUFFER_SIZE/2. */
3565 hold_keyboard_input ();
3566 if (!noninteractive
)
3570 #endif /* subprocesses */
3573 /* If we're inside while-no-input, and this event qualifies
3574 as input, set quit-flag to cause an interrupt. */
3575 if (!NILP (Vthrow_on_input
)
3576 && event
->kind
!= FOCUS_IN_EVENT
3577 && event
->kind
!= HELP_EVENT
3578 && event
->kind
!= DEICONIFY_EVENT
)
3580 Vquit_flag
= Vthrow_on_input
;
3581 /* If we're inside a function that wants immediate quits,
3583 if (immediate_quit
&& NILP (Vinhibit_quit
))
3592 /* Put an input event back in the head of the event queue. */
3595 kbd_buffer_unget_event (register struct input_event
*event
)
3597 if (kbd_fetch_ptr
== kbd_buffer
)
3598 kbd_fetch_ptr
= kbd_buffer
+ KBD_BUFFER_SIZE
;
3600 /* Don't let the very last slot in the buffer become full, */
3601 if (kbd_fetch_ptr
- 1 != kbd_store_ptr
)
3604 *kbd_fetch_ptr
= *event
;
3609 /* Generate a HELP_EVENT input_event and store it in the keyboard
3612 HELP is the help form.
3614 FRAME and WINDOW are the frame and window where the help is
3615 generated. OBJECT is the Lisp object where the help was found (a
3616 buffer, a string, an overlay, or nil if neither from a string nor
3617 from a buffer). POS is the position within OBJECT where the help
3621 gen_help_event (Lisp_Object help
, Lisp_Object frame
, Lisp_Object window
,
3622 Lisp_Object object
, ptrdiff_t pos
)
3624 struct input_event event
;
3628 event
.kind
= HELP_EVENT
;
3629 event
.frame_or_window
= frame
;
3631 event
.x
= WINDOWP (window
) ? window
: frame
;
3634 kbd_buffer_store_event (&event
);
3638 /* Store HELP_EVENTs for HELP on FRAME in the input queue. */
3641 kbd_buffer_store_help_event (Lisp_Object frame
, Lisp_Object help
)
3643 struct input_event event
;
3645 event
.kind
= HELP_EVENT
;
3646 event
.frame_or_window
= frame
;
3651 kbd_buffer_store_event (&event
);
3655 /* Discard any mouse events in the event buffer by setting them to
3658 discard_mouse_events (void)
3660 struct input_event
*sp
;
3661 for (sp
= kbd_fetch_ptr
; sp
!= kbd_store_ptr
; sp
++)
3663 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3666 if (sp
->kind
== MOUSE_CLICK_EVENT
3667 || sp
->kind
== WHEEL_EVENT
3668 || sp
->kind
== HORIZ_WHEEL_EVENT
3670 || sp
->kind
== GPM_CLICK_EVENT
3672 || sp
->kind
== SCROLL_BAR_CLICK_EVENT
)
3674 sp
->kind
= NO_EVENT
;
3680 /* Return true if there are any real events waiting in the event
3681 buffer, not counting `NO_EVENT's.
3683 Discard NO_EVENT events at the front of the input queue, possibly
3684 leaving the input queue empty if there are no real input events. */
3687 kbd_buffer_events_waiting (void)
3689 struct input_event
*sp
;
3691 for (sp
= kbd_fetch_ptr
;
3692 sp
!= kbd_store_ptr
&& sp
->kind
== NO_EVENT
;
3695 if (sp
== kbd_buffer
+ KBD_BUFFER_SIZE
)
3700 return sp
!= kbd_store_ptr
&& sp
->kind
!= NO_EVENT
;
3704 /* Clear input event EVENT. */
3707 clear_event (struct input_event
*event
)
3709 event
->kind
= NO_EVENT
;
3713 /* Read one event from the event buffer, waiting if necessary.
3714 The value is a Lisp object representing the event.
3715 The value is nil for an event that should be ignored,
3716 or that was handled here.
3717 We always read and discard one event. */
3720 kbd_buffer_get_event (KBOARD
**kbp
,
3721 bool *used_mouse_menu
,
3722 EMACS_TIME
*end_time
)
3727 if (kbd_on_hold_p () && kbd_buffer_nr_stored () < KBD_BUFFER_SIZE
/4)
3729 /* Start reading input again because we have processed enough to
3730 be able to accept new events again. */
3731 unhold_keyboard_input ();
3734 #endif /* subprocesses */
3736 #ifndef HAVE_DBUS /* We want to read D-Bus events in batch mode. */
3738 /* In case we are running as a daemon, only do this before
3739 detaching from the terminal. */
3740 || (IS_DAEMON
&& daemon_pipe
[1] >= 0))
3744 *kbp
= current_kboard
;
3747 #endif /* ! HAVE_DBUS */
3749 /* Wait until there is input available. */
3752 /* Break loop if there's an unread command event. Needed in
3753 moused window autoselection which uses a timer to insert such
3755 if (CONSP (Vunread_command_events
))
3758 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3760 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3763 /* If the quit flag is set, then read_char will return
3764 quit_char, so that counts as "available input." */
3765 if (!NILP (Vquit_flag
))
3766 quit_throw_to_read_char (0);
3768 /* One way or another, wait until input is available; then, if
3769 interrupt handlers have not read it, read it now. */
3774 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3776 if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
3780 EMACS_TIME now
= current_emacs_time ();
3781 if (EMACS_TIME_LE (*end_time
, now
))
3782 return Qnil
; /* Finished waiting. */
3785 EMACS_TIME duration
= sub_emacs_time (*end_time
, now
);
3786 wait_reading_process_output (min (EMACS_SECS (duration
),
3788 EMACS_NSECS (duration
),
3789 -1, 1, Qnil
, NULL
, 0);
3793 wait_reading_process_output (0, 0, -1, 1, Qnil
, NULL
, 0);
3795 if (!interrupt_input
&& kbd_fetch_ptr
== kbd_store_ptr
)
3799 if (CONSP (Vunread_command_events
))
3802 first
= XCAR (Vunread_command_events
);
3803 Vunread_command_events
= XCDR (Vunread_command_events
);
3804 *kbp
= current_kboard
;
3808 /* At this point, we know that there is a readable event available
3809 somewhere. If the event queue is empty, then there must be a
3810 mouse movement enabled and available. */
3811 if (kbd_fetch_ptr
!= kbd_store_ptr
)
3813 struct input_event
*event
;
3815 event
= ((kbd_fetch_ptr
< kbd_buffer
+ KBD_BUFFER_SIZE
)
3819 last_event_timestamp
= event
->timestamp
;
3821 *kbp
= event_to_kboard (event
);
3823 *kbp
= current_kboard
; /* Better than returning null ptr? */
3827 /* These two kinds of events get special handling
3828 and don't actually appear to the command loop.
3829 We return nil for them. */
3830 if (event
->kind
== SELECTION_REQUEST_EVENT
3831 || event
->kind
== SELECTION_CLEAR_EVENT
)
3834 struct input_event copy
;
3836 /* Remove it from the buffer before processing it,
3837 since otherwise swallow_events will see it
3838 and process it again. */
3840 kbd_fetch_ptr
= event
+ 1;
3841 input_pending
= readable_events (0);
3842 x_handle_selection_event (©
);
3844 /* We're getting selection request events, but we don't have
3850 #if defined (HAVE_NS)
3851 else if (event
->kind
== NS_TEXT_EVENT
)
3853 if (event
->code
== KEY_NS_PUT_WORKING_TEXT
)
3854 obj
= Fcons (intern ("ns-put-working-text"), Qnil
);
3856 obj
= Fcons (intern ("ns-unput-working-text"), Qnil
);
3857 kbd_fetch_ptr
= event
+ 1;
3858 if (used_mouse_menu
)
3859 *used_mouse_menu
= 1;
3863 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3864 || defined (HAVE_NS)
3865 else if (event
->kind
== DELETE_WINDOW_EVENT
)
3867 /* Make an event (delete-frame (FRAME)). */
3868 obj
= Fcons (event
->frame_or_window
, Qnil
);
3869 obj
= Fcons (Qdelete_frame
, Fcons (obj
, Qnil
));
3870 kbd_fetch_ptr
= event
+ 1;
3873 #if defined (HAVE_X11) || defined (HAVE_NTGUI) \
3874 || defined (HAVE_NS)
3875 else if (event
->kind
== ICONIFY_EVENT
)
3877 /* Make an event (iconify-frame (FRAME)). */
3878 obj
= Fcons (event
->frame_or_window
, Qnil
);
3879 obj
= Fcons (Qiconify_frame
, Fcons (obj
, Qnil
));
3880 kbd_fetch_ptr
= event
+ 1;
3882 else if (event
->kind
== DEICONIFY_EVENT
)
3884 /* Make an event (make-frame-visible (FRAME)). */
3885 obj
= Fcons (event
->frame_or_window
, Qnil
);
3886 obj
= Fcons (Qmake_frame_visible
, Fcons (obj
, Qnil
));
3887 kbd_fetch_ptr
= event
+ 1;
3890 else if (event
->kind
== BUFFER_SWITCH_EVENT
)
3892 /* The value doesn't matter here; only the type is tested. */
3893 XSETBUFFER (obj
, current_buffer
);
3894 kbd_fetch_ptr
= event
+ 1;
3896 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
3897 || defined (HAVE_NS) || defined (USE_GTK)
3898 else if (event
->kind
== MENU_BAR_ACTIVATE_EVENT
)
3900 kbd_fetch_ptr
= event
+ 1;
3901 input_pending
= readable_events (0);
3902 if (FRAME_LIVE_P (XFRAME (event
->frame_or_window
)))
3903 x_activate_menubar (XFRAME (event
->frame_or_window
));
3907 else if (event
->kind
== LANGUAGE_CHANGE_EVENT
)
3909 /* Make an event (language-change (FRAME CODEPAGE LANGUAGE-ID)). */
3910 obj
= Fcons (Qlanguage_change
,
3911 list3 (event
->frame_or_window
,
3912 make_number (event
->code
),
3913 make_number (event
->modifiers
)));
3914 kbd_fetch_ptr
= event
+ 1;
3918 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3920 /* Make an event (file-notify (DESCRIPTOR ACTION FILE) CALLBACK). */
3921 obj
= Fcons (Qfile_w32notify
,
3922 list2 (list3 (make_number (event
->code
),
3925 event
->frame_or_window
));
3926 kbd_fetch_ptr
= event
+ 1;
3929 else if (event
->kind
== SAVE_SESSION_EVENT
)
3931 obj
= Fcons (Qsave_session
, Fcons (event
->arg
, Qnil
));
3932 kbd_fetch_ptr
= event
+ 1;
3934 /* Just discard these, by returning nil.
3935 With MULTI_KBOARD, these events are used as placeholders
3936 when we need to randomly delete events from the queue.
3937 (They shouldn't otherwise be found in the buffer,
3938 but on some machines it appears they do show up
3939 even without MULTI_KBOARD.) */
3940 /* On Windows NT/9X, NO_EVENT is used to delete extraneous
3941 mouse events during a popup-menu call. */
3942 else if (event
->kind
== NO_EVENT
)
3943 kbd_fetch_ptr
= event
+ 1;
3944 else if (event
->kind
== HELP_EVENT
)
3946 Lisp_Object object
, position
, help
, frame
, window
;
3948 frame
= event
->frame_or_window
;
3949 object
= event
->arg
;
3950 position
= make_number (event
->code
);
3953 clear_event (event
);
3955 kbd_fetch_ptr
= event
+ 1;
3956 if (!WINDOWP (window
))
3958 obj
= Fcons (Qhelp_echo
,
3959 list5 (frame
, help
, window
, object
, position
));
3961 else if (event
->kind
== FOCUS_IN_EVENT
)
3963 /* Notification of a FocusIn event. The frame receiving the
3964 focus is in event->frame_or_window. Generate a
3965 switch-frame event if necessary. */
3966 Lisp_Object frame
, focus
;
3968 frame
= event
->frame_or_window
;
3969 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
3973 if (!EQ (frame
, internal_last_event_frame
)
3974 && !EQ (frame
, selected_frame
))
3975 obj
= make_lispy_switch_frame (frame
);
3976 internal_last_event_frame
= frame
;
3977 kbd_fetch_ptr
= event
+ 1;
3980 else if (event
->kind
== DBUS_EVENT
)
3982 obj
= make_lispy_event (event
);
3983 kbd_fetch_ptr
= event
+ 1;
3987 else if (event
->kind
== FILE_NOTIFY_EVENT
)
3989 obj
= make_lispy_event (event
);
3990 kbd_fetch_ptr
= event
+ 1;
3993 else if (event
->kind
== CONFIG_CHANGED_EVENT
)
3995 obj
= make_lispy_event (event
);
3996 kbd_fetch_ptr
= event
+ 1;
4000 /* If this event is on a different frame, return a switch-frame this
4001 time, and leave the event in the queue for next time. */
4005 frame
= event
->frame_or_window
;
4007 frame
= XCAR (frame
);
4008 else if (WINDOWP (frame
))
4009 frame
= WINDOW_FRAME (XWINDOW (frame
));
4011 focus
= FRAME_FOCUS_FRAME (XFRAME (frame
));
4015 if (! EQ (frame
, internal_last_event_frame
)
4016 && !EQ (frame
, selected_frame
))
4017 obj
= make_lispy_switch_frame (frame
);
4018 internal_last_event_frame
= frame
;
4020 /* If we didn't decide to make a switch-frame event, go ahead
4021 and build a real event from the queue entry. */
4025 obj
= make_lispy_event (event
);
4027 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
4028 || defined (HAVE_NS) || defined (USE_GTK)
4029 /* If this was a menu selection, then set the flag to inhibit
4030 writing to last_nonmenu_event. Don't do this if the event
4031 we're returning is (menu-bar), though; that indicates the
4032 beginning of the menu sequence, and we might as well leave
4033 that as the `event with parameters' for this selection. */
4035 && !EQ (event
->frame_or_window
, event
->arg
)
4036 && (event
->kind
== MENU_BAR_EVENT
4037 || event
->kind
== TOOL_BAR_EVENT
))
4038 *used_mouse_menu
= 1;
4041 /* Certain system events are non-key events. */
4043 && event
->kind
== NS_NONKEY_EVENT
)
4044 *used_mouse_menu
= 1;
4047 /* Wipe out this event, to catch bugs. */
4048 clear_event (event
);
4049 kbd_fetch_ptr
= event
+ 1;
4053 /* Try generating a mouse motion event. */
4054 else if (!NILP (do_mouse_tracking
) && some_mouse_moved ())
4056 FRAME_PTR f
= some_mouse_moved ();
4057 Lisp_Object bar_window
;
4058 enum scroll_bar_part part
;
4062 *kbp
= current_kboard
;
4063 /* Note that this uses F to determine which terminal to look at.
4064 If there is no valid info, it does not store anything
4065 so x remains nil. */
4068 /* XXX Can f or mouse_position_hook be NULL here? */
4069 if (f
&& FRAME_TERMINAL (f
)->mouse_position_hook
)
4070 (*FRAME_TERMINAL (f
)->mouse_position_hook
) (&f
, 0, &bar_window
,
4075 /* Decide if we should generate a switch-frame event. Don't
4076 generate switch-frame events for motion outside of all Emacs
4082 frame
= FRAME_FOCUS_FRAME (f
);
4084 XSETFRAME (frame
, f
);
4086 if (! EQ (frame
, internal_last_event_frame
)
4087 && !EQ (frame
, selected_frame
))
4088 obj
= make_lispy_switch_frame (frame
);
4089 internal_last_event_frame
= frame
;
4092 /* If we didn't decide to make a switch-frame event, go ahead and
4093 return a mouse-motion event. */
4094 if (!NILP (x
) && NILP (obj
))
4095 obj
= make_lispy_movement (f
, bar_window
, part
, x
, y
, t
);
4098 /* We were promised by the above while loop that there was
4099 something for us to read! */
4102 input_pending
= readable_events (0);
4104 Vlast_event_frame
= internal_last_event_frame
;
4109 /* Process any non-user-visible events (currently X selection events),
4110 without reading any user-visible events. */
4113 process_special_events (void)
4115 struct input_event
*event
;
4117 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; ++event
)
4119 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4122 if (event
== kbd_store_ptr
)
4126 /* If we find a stored X selection request, handle it now. */
4127 if (event
->kind
== SELECTION_REQUEST_EVENT
4128 || event
->kind
== SELECTION_CLEAR_EVENT
)
4132 /* Remove the event from the fifo buffer before processing;
4133 otherwise swallow_events called recursively could see it
4134 and process it again. To do this, we move the events
4135 between kbd_fetch_ptr and EVENT one slot to the right,
4138 struct input_event copy
= *event
;
4139 struct input_event
*beg
4140 = (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4141 ? kbd_buffer
: kbd_fetch_ptr
;
4144 memmove (beg
+ 1, beg
, (event
- beg
) * sizeof (struct input_event
));
4145 else if (event
< beg
)
4147 if (event
> kbd_buffer
)
4148 memmove (kbd_buffer
+ 1, kbd_buffer
,
4149 (event
- kbd_buffer
) * sizeof (struct input_event
));
4150 *kbd_buffer
= *(kbd_buffer
+ KBD_BUFFER_SIZE
- 1);
4151 if (beg
< kbd_buffer
+ KBD_BUFFER_SIZE
- 1)
4152 memmove (beg
+ 1, beg
,
4153 (kbd_buffer
+ KBD_BUFFER_SIZE
- 1 - beg
)
4154 * sizeof (struct input_event
));
4157 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
4158 kbd_fetch_ptr
= kbd_buffer
+ 1;
4162 /* X wants last_event_timestamp for selection ownership. */
4163 last_event_timestamp
= copy
.timestamp
;
4164 input_pending
= readable_events (0);
4165 x_handle_selection_event (©
);
4167 /* We're getting selection request events, but we don't have
4175 /* Process any events that are not user-visible, run timer events that
4176 are ripe, and return, without reading any user-visible events. */
4179 swallow_events (bool do_display
)
4181 unsigned old_timers_run
;
4183 process_special_events ();
4185 old_timers_run
= timers_run
;
4186 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
4188 if (timers_run
!= old_timers_run
&& do_display
)
4189 redisplay_preserve_echo_area (7);
4192 /* Record the start of when Emacs is idle,
4193 for the sake of running idle-time timers. */
4196 timer_start_idle (void)
4200 /* If we are already in the idle state, do nothing. */
4201 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4204 timer_idleness_start_time
= current_emacs_time ();
4205 timer_last_idleness_start_time
= timer_idleness_start_time
;
4207 /* Mark all idle-time timers as once again candidates for running. */
4208 for (timers
= Vtimer_idle_list
; CONSP (timers
); timers
= XCDR (timers
))
4212 timer
= XCAR (timers
);
4214 if (!VECTORP (timer
) || ASIZE (timer
) != 9)
4216 ASET (timer
, 0, Qnil
);
4220 /* Record that Emacs is no longer idle, so stop running idle-time timers. */
4223 timer_stop_idle (void)
4225 timer_idleness_start_time
= invalid_emacs_time ();
4228 /* Resume idle timer from last idle start time. */
4231 timer_resume_idle (void)
4233 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4236 timer_idleness_start_time
= timer_last_idleness_start_time
;
4239 /* This is only for debugging. */
4240 struct input_event last_timer_event EXTERNALLY_VISIBLE
;
4242 /* List of elisp functions to call, delayed because they were generated in
4243 a context where Elisp could not be safely run (e.g. redisplay, signal,
4244 ...). Each element has the form (FUN . ARGS). */
4245 Lisp_Object pending_funcalls
;
4247 /* Return true if TIMER is a valid timer, placing its value into *RESULT. */
4249 decode_timer (Lisp_Object timer
, EMACS_TIME
*result
)
4251 Lisp_Object
*vector
;
4253 if (! (VECTORP (timer
) && ASIZE (timer
) == 9))
4255 vector
= XVECTOR (timer
)->contents
;
4256 if (! NILP (vector
[0]))
4259 return decode_time_components (vector
[1], vector
[2], vector
[3], vector
[8],
4264 /* Check whether a timer has fired. To prevent larger problems we simply
4265 disregard elements that are not proper timers. Do not make a circular
4266 timer list for the time being.
4268 Returns the time to wait until the next timer fires. If a
4269 timer is triggering now, return zero.
4270 If no timer is active, return -1.
4272 If a timer is ripe, we run it, with quitting turned off.
4273 In that case we return 0 to indicate that a new timer_check_2 call
4277 timer_check_2 (Lisp_Object timers
, Lisp_Object idle_timers
)
4279 EMACS_TIME nexttime
;
4281 EMACS_TIME idleness_now
;
4282 Lisp_Object chosen_timer
;
4283 struct gcpro gcpro1
;
4285 nexttime
= invalid_emacs_time ();
4287 chosen_timer
= Qnil
;
4288 GCPRO1 (chosen_timer
);
4290 /* First run the code that was delayed. */
4291 while (CONSP (pending_funcalls
))
4293 Lisp_Object funcall
= XCAR (pending_funcalls
);
4294 pending_funcalls
= XCDR (pending_funcalls
);
4295 safe_call2 (Qapply
, XCAR (funcall
), XCDR (funcall
));
4298 if (CONSP (timers
) || CONSP (idle_timers
))
4300 now
= current_emacs_time ();
4301 idleness_now
= (EMACS_TIME_VALID_P (timer_idleness_start_time
)
4302 ? sub_emacs_time (now
, timer_idleness_start_time
)
4303 : make_emacs_time (0, 0));
4306 while (CONSP (timers
) || CONSP (idle_timers
))
4308 Lisp_Object timer
= Qnil
, idle_timer
= Qnil
;
4309 EMACS_TIME timer_time
, idle_timer_time
;
4310 EMACS_TIME difference
;
4311 EMACS_TIME timer_difference
= invalid_emacs_time ();
4312 EMACS_TIME idle_timer_difference
= invalid_emacs_time ();
4313 bool ripe
, timer_ripe
= 0, idle_timer_ripe
= 0;
4315 /* Set TIMER and TIMER_DIFFERENCE
4316 based on the next ordinary timer.
4317 TIMER_DIFFERENCE is the distance in time from NOW to when
4318 this timer becomes ripe (negative if it's already ripe).
4319 Skip past invalid timers and timers already handled. */
4322 timer
= XCAR (timers
);
4323 if (! decode_timer (timer
, &timer_time
))
4325 timers
= XCDR (timers
);
4329 timer_ripe
= EMACS_TIME_LE (timer_time
, now
);
4330 timer_difference
= (timer_ripe
4331 ? sub_emacs_time (now
, timer_time
)
4332 : sub_emacs_time (timer_time
, now
));
4335 /* Likewise for IDLE_TIMER and IDLE_TIMER_DIFFERENCE
4336 based on the next idle timer. */
4337 if (CONSP (idle_timers
))
4339 idle_timer
= XCAR (idle_timers
);
4340 if (! decode_timer (idle_timer
, &idle_timer_time
))
4342 idle_timers
= XCDR (idle_timers
);
4346 idle_timer_ripe
= EMACS_TIME_LE (idle_timer_time
, idleness_now
);
4347 idle_timer_difference
=
4349 ? sub_emacs_time (idleness_now
, idle_timer_time
)
4350 : sub_emacs_time (idle_timer_time
, idleness_now
));
4353 /* Decide which timer is the next timer,
4354 and set CHOSEN_TIMER, DIFFERENCE, and RIPE accordingly.
4355 Also step down the list where we found that timer. */
4357 if (EMACS_TIME_VALID_P (timer_difference
)
4358 && (! EMACS_TIME_VALID_P (idle_timer_difference
)
4359 || idle_timer_ripe
< timer_ripe
4360 || (idle_timer_ripe
== timer_ripe
4362 ? EMACS_TIME_LT (idle_timer_difference
,
4364 : EMACS_TIME_LT (timer_difference
,
4365 idle_timer_difference
)))))
4367 chosen_timer
= timer
;
4368 timers
= XCDR (timers
);
4369 difference
= timer_difference
;
4374 chosen_timer
= idle_timer
;
4375 idle_timers
= XCDR (idle_timers
);
4376 difference
= idle_timer_difference
;
4377 ripe
= idle_timer_ripe
;
4380 /* If timer is ripe, run it if it hasn't been run. */
4383 if (NILP (AREF (chosen_timer
, 0)))
4385 ptrdiff_t count
= SPECPDL_INDEX ();
4386 Lisp_Object old_deactivate_mark
= Vdeactivate_mark
;
4388 /* Mark the timer as triggered to prevent problems if the lisp
4389 code fails to reschedule it right. */
4390 ASET (chosen_timer
, 0, Qt
);
4392 specbind (Qinhibit_quit
, Qt
);
4394 call1 (Qtimer_event_handler
, chosen_timer
);
4395 Vdeactivate_mark
= old_deactivate_mark
;
4397 unbind_to (count
, Qnil
);
4399 /* Since we have handled the event,
4400 we don't need to tell the caller to wake up and do it. */
4401 /* But the caller must still wait for the next timer, so
4402 return 0 to indicate that. */
4405 nexttime
= make_emacs_time (0, 0);
4409 /* When we encounter a timer that is still waiting,
4410 return the amount of time to wait before it is ripe. */
4417 /* No timers are pending in the future. */
4418 /* Return 0 if we generated an event, and -1 if not. */
4424 /* Check whether a timer has fired. To prevent larger problems we simply
4425 disregard elements that are not proper timers. Do not make a circular
4426 timer list for the time being.
4428 Returns the time to wait until the next timer fires.
4429 If no timer is active, return an invalid value.
4431 As long as any timer is ripe, we run it. */
4436 EMACS_TIME nexttime
;
4437 Lisp_Object timers
, idle_timers
;
4438 struct gcpro gcpro1
, gcpro2
;
4440 Lisp_Object tem
= Vinhibit_quit
;
4443 /* We use copies of the timers' lists to allow a timer to add itself
4444 again, without locking up Emacs if the newly added timer is
4445 already ripe when added. */
4447 /* Always consider the ordinary timers. */
4448 timers
= Fcopy_sequence (Vtimer_list
);
4449 /* Consider the idle timers only if Emacs is idle. */
4450 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4451 idle_timers
= Fcopy_sequence (Vtimer_idle_list
);
4455 Vinhibit_quit
= tem
;
4457 GCPRO2 (timers
, idle_timers
);
4461 nexttime
= timer_check_2 (timers
, idle_timers
);
4463 while (EMACS_SECS (nexttime
) == 0 && EMACS_NSECS (nexttime
) == 0);
4469 DEFUN ("current-idle-time", Fcurrent_idle_time
, Scurrent_idle_time
, 0, 0, 0,
4470 doc
: /* Return the current length of Emacs idleness, or nil.
4471 The value when Emacs is idle is a list of four integers (HIGH LOW USEC PSEC)
4472 in the same style as (current-time).
4474 The value when Emacs is not idle is nil.
4476 PSEC is a multiple of the system clock resolution. */)
4479 if (EMACS_TIME_VALID_P (timer_idleness_start_time
))
4480 return make_lisp_time (sub_emacs_time (current_emacs_time (),
4481 timer_idleness_start_time
));
4486 /* Caches for modify_event_symbol. */
4487 static Lisp_Object accent_key_syms
;
4488 static Lisp_Object func_key_syms
;
4489 static Lisp_Object mouse_syms
;
4490 static Lisp_Object wheel_syms
;
4491 static Lisp_Object drag_n_drop_syms
;
4493 /* This is a list of keysym codes for special "accent" characters.
4494 It parallels lispy_accent_keys. */
4496 static const int lispy_accent_codes
[] =
4498 #ifdef XK_dead_circumflex
4503 #ifdef XK_dead_grave
4508 #ifdef XK_dead_tilde
4513 #ifdef XK_dead_diaeresis
4518 #ifdef XK_dead_macron
4523 #ifdef XK_dead_degree
4528 #ifdef XK_dead_acute
4533 #ifdef XK_dead_cedilla
4538 #ifdef XK_dead_breve
4543 #ifdef XK_dead_ogonek
4548 #ifdef XK_dead_caron
4553 #ifdef XK_dead_doubleacute
4554 XK_dead_doubleacute
,
4558 #ifdef XK_dead_abovedot
4563 #ifdef XK_dead_abovering
4573 #ifdef XK_dead_belowdot
4578 #ifdef XK_dead_voiced_sound
4579 XK_dead_voiced_sound
,
4583 #ifdef XK_dead_semivoiced_sound
4584 XK_dead_semivoiced_sound
,
4600 /* This is a list of Lisp names for special "accent" characters.
4601 It parallels lispy_accent_codes. */
4603 static const char *const lispy_accent_keys
[] =
4621 "dead-voiced-sound",
4622 "dead-semivoiced-sound",
4628 #define FUNCTION_KEY_OFFSET 0x0
4630 const char *const lispy_function_keys
[] =
4634 0, /* VK_LBUTTON 0x01 */
4635 0, /* VK_RBUTTON 0x02 */
4636 "cancel", /* VK_CANCEL 0x03 */
4637 0, /* VK_MBUTTON 0x04 */
4639 0, 0, 0, /* 0x05 .. 0x07 */
4641 "backspace", /* VK_BACK 0x08 */
4642 "tab", /* VK_TAB 0x09 */
4644 0, 0, /* 0x0A .. 0x0B */
4646 "clear", /* VK_CLEAR 0x0C */
4647 "return", /* VK_RETURN 0x0D */
4649 0, 0, /* 0x0E .. 0x0F */
4651 0, /* VK_SHIFT 0x10 */
4652 0, /* VK_CONTROL 0x11 */
4653 0, /* VK_MENU 0x12 */
4654 "pause", /* VK_PAUSE 0x13 */
4655 "capslock", /* VK_CAPITAL 0x14 */
4656 "kana", /* VK_KANA/VK_HANGUL 0x15 */
4658 "junja", /* VK_JUNJA 0x17 */
4659 "final", /* VK_FINAL 0x18 */
4660 "kanji", /* VK_KANJI/VK_HANJA 0x19 */
4662 "escape", /* VK_ESCAPE 0x1B */
4663 "convert", /* VK_CONVERT 0x1C */
4664 "non-convert", /* VK_NONCONVERT 0x1D */
4665 "accept", /* VK_ACCEPT 0x1E */
4666 "mode-change", /* VK_MODECHANGE 0x1F */
4667 0, /* VK_SPACE 0x20 */
4668 "prior", /* VK_PRIOR 0x21 */
4669 "next", /* VK_NEXT 0x22 */
4670 "end", /* VK_END 0x23 */
4671 "home", /* VK_HOME 0x24 */
4672 "left", /* VK_LEFT 0x25 */
4673 "up", /* VK_UP 0x26 */
4674 "right", /* VK_RIGHT 0x27 */
4675 "down", /* VK_DOWN 0x28 */
4676 "select", /* VK_SELECT 0x29 */
4677 "print", /* VK_PRINT 0x2A */
4678 "execute", /* VK_EXECUTE 0x2B */
4679 "snapshot", /* VK_SNAPSHOT 0x2C */
4680 "insert", /* VK_INSERT 0x2D */
4681 "delete", /* VK_DELETE 0x2E */
4682 "help", /* VK_HELP 0x2F */
4684 /* VK_0 thru VK_9 are the same as ASCII '0' thru '9' (0x30 - 0x39) */
4686 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4688 0, 0, 0, 0, 0, 0, 0, /* 0x3A .. 0x40 */
4690 /* VK_A thru VK_Z are the same as ASCII 'A' thru 'Z' (0x41 - 0x5A) */
4692 0, 0, 0, 0, 0, 0, 0, 0, 0,
4693 0, 0, 0, 0, 0, 0, 0, 0, 0,
4694 0, 0, 0, 0, 0, 0, 0, 0,
4696 "lwindow", /* VK_LWIN 0x5B */
4697 "rwindow", /* VK_RWIN 0x5C */
4698 "apps", /* VK_APPS 0x5D */
4701 "kp-0", /* VK_NUMPAD0 0x60 */
4702 "kp-1", /* VK_NUMPAD1 0x61 */
4703 "kp-2", /* VK_NUMPAD2 0x62 */
4704 "kp-3", /* VK_NUMPAD3 0x63 */
4705 "kp-4", /* VK_NUMPAD4 0x64 */
4706 "kp-5", /* VK_NUMPAD5 0x65 */
4707 "kp-6", /* VK_NUMPAD6 0x66 */
4708 "kp-7", /* VK_NUMPAD7 0x67 */
4709 "kp-8", /* VK_NUMPAD8 0x68 */
4710 "kp-9", /* VK_NUMPAD9 0x69 */
4711 "kp-multiply", /* VK_MULTIPLY 0x6A */
4712 "kp-add", /* VK_ADD 0x6B */
4713 "kp-separator", /* VK_SEPARATOR 0x6C */
4714 "kp-subtract", /* VK_SUBTRACT 0x6D */
4715 "kp-decimal", /* VK_DECIMAL 0x6E */
4716 "kp-divide", /* VK_DIVIDE 0x6F */
4717 "f1", /* VK_F1 0x70 */
4718 "f2", /* VK_F2 0x71 */
4719 "f3", /* VK_F3 0x72 */
4720 "f4", /* VK_F4 0x73 */
4721 "f5", /* VK_F5 0x74 */
4722 "f6", /* VK_F6 0x75 */
4723 "f7", /* VK_F7 0x76 */
4724 "f8", /* VK_F8 0x77 */
4725 "f9", /* VK_F9 0x78 */
4726 "f10", /* VK_F10 0x79 */
4727 "f11", /* VK_F11 0x7A */
4728 "f12", /* VK_F12 0x7B */
4729 "f13", /* VK_F13 0x7C */
4730 "f14", /* VK_F14 0x7D */
4731 "f15", /* VK_F15 0x7E */
4732 "f16", /* VK_F16 0x7F */
4733 "f17", /* VK_F17 0x80 */
4734 "f18", /* VK_F18 0x81 */
4735 "f19", /* VK_F19 0x82 */
4736 "f20", /* VK_F20 0x83 */
4737 "f21", /* VK_F21 0x84 */
4738 "f22", /* VK_F22 0x85 */
4739 "f23", /* VK_F23 0x86 */
4740 "f24", /* VK_F24 0x87 */
4742 0, 0, 0, 0, /* 0x88 .. 0x8B */
4743 0, 0, 0, 0, /* 0x8C .. 0x8F */
4745 "kp-numlock", /* VK_NUMLOCK 0x90 */
4746 "scroll", /* VK_SCROLL 0x91 */
4747 /* Not sure where the following block comes from.
4748 Windows headers have NEC and Fujitsu specific keys in
4749 this block, but nothing generic. */
4750 "kp-space", /* VK_NUMPAD_CLEAR 0x92 */
4751 "kp-enter", /* VK_NUMPAD_ENTER 0x93 */
4752 "kp-prior", /* VK_NUMPAD_PRIOR 0x94 */
4753 "kp-next", /* VK_NUMPAD_NEXT 0x95 */
4754 "kp-end", /* VK_NUMPAD_END 0x96 */
4755 "kp-home", /* VK_NUMPAD_HOME 0x97 */
4756 "kp-left", /* VK_NUMPAD_LEFT 0x98 */
4757 "kp-up", /* VK_NUMPAD_UP 0x99 */
4758 "kp-right", /* VK_NUMPAD_RIGHT 0x9A */
4759 "kp-down", /* VK_NUMPAD_DOWN 0x9B */
4760 "kp-insert", /* VK_NUMPAD_INSERT 0x9C */
4761 "kp-delete", /* VK_NUMPAD_DELETE 0x9D */
4763 0, 0, /* 0x9E .. 0x9F */
4766 * VK_L* & VK_R* - left and right Alt, Ctrl and Shift virtual keys.
4767 * Used only as parameters to GetAsyncKeyState and GetKeyState.
4768 * No other API or message will distinguish left and right keys this way.
4773 /* Multimedia keys. These are handled as WM_APPCOMMAND, which allows us
4774 to enable them selectively, and gives access to a few more functions.
4775 See lispy_multimedia_keys below. */
4776 0, 0, 0, 0, 0, 0, 0, /* 0xA6 .. 0xAC Browser */
4777 0, 0, 0, /* 0xAD .. 0xAF Volume */
4778 0, 0, 0, 0, /* 0xB0 .. 0xB3 Media */
4779 0, 0, 0, 0, /* 0xB4 .. 0xB7 Apps */
4781 /* 0xB8 .. 0xC0 "OEM" keys - all seem to be punctuation. */
4782 0, 0, 0, 0, 0, 0, 0, 0, 0,
4784 /* 0xC1 - 0xDA unallocated, 0xDB-0xDF more OEM keys */
4785 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4786 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4789 "ax", /* VK_OEM_AX 0xE1 */
4790 0, /* VK_OEM_102 0xE2 */
4791 "ico-help", /* VK_ICO_HELP 0xE3 */
4792 "ico-00", /* VK_ICO_00 0xE4 */
4793 0, /* VK_PROCESSKEY 0xE5 - used by IME */
4794 "ico-clear", /* VK_ICO_CLEAR 0xE6 */
4795 0, /* VK_PACKET 0xE7 - used to pass Unicode chars */
4797 "reset", /* VK_OEM_RESET 0xE9 */
4798 "jump", /* VK_OEM_JUMP 0xEA */
4799 "oem-pa1", /* VK_OEM_PA1 0xEB */
4800 "oem-pa2", /* VK_OEM_PA2 0xEC */
4801 "oem-pa3", /* VK_OEM_PA3 0xED */
4802 "wsctrl", /* VK_OEM_WSCTRL 0xEE */
4803 "cusel", /* VK_OEM_CUSEL 0xEF */
4804 "oem-attn", /* VK_OEM_ATTN 0xF0 */
4805 "finish", /* VK_OEM_FINISH 0xF1 */
4806 "copy", /* VK_OEM_COPY 0xF2 */
4807 "auto", /* VK_OEM_AUTO 0xF3 */
4808 "enlw", /* VK_OEM_ENLW 0xF4 */
4809 "backtab", /* VK_OEM_BACKTAB 0xF5 */
4810 "attn", /* VK_ATTN 0xF6 */
4811 "crsel", /* VK_CRSEL 0xF7 */
4812 "exsel", /* VK_EXSEL 0xF8 */
4813 "ereof", /* VK_EREOF 0xF9 */
4814 "play", /* VK_PLAY 0xFA */
4815 "zoom", /* VK_ZOOM 0xFB */
4816 "noname", /* VK_NONAME 0xFC */
4817 "pa1", /* VK_PA1 0xFD */
4818 "oem_clear", /* VK_OEM_CLEAR 0xFE */
4822 /* Some of these duplicate the "Media keys" on newer keyboards,
4823 but they are delivered to the application in a different way. */
4824 static const char *const lispy_multimedia_keys
[] =
4832 "browser-favorites",
4869 "toggle-dictate-command",
4875 "media-fast-forward",
4878 "media-channel-down"
4881 #else /* not HAVE_NTGUI */
4883 /* This should be dealt with in XTread_socket now, and that doesn't
4884 depend on the client system having the Kana syms defined. See also
4885 the XK_kana_A case below. */
4888 static const char *const lispy_kana_keys
[] =
4890 /* X Keysym value */
4891 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x400 .. 0x40f */
4892 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x410 .. 0x41f */
4893 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x420 .. 0x42f */
4894 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x430 .. 0x43f */
4895 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x440 .. 0x44f */
4896 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x450 .. 0x45f */
4897 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x460 .. 0x46f */
4898 0,0,0,0,0,0,0,0,0,0,0,0,0,0,"overline",0,
4899 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x480 .. 0x48f */
4900 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x490 .. 0x49f */
4901 0, "kana-fullstop", "kana-openingbracket", "kana-closingbracket",
4902 "kana-comma", "kana-conjunctive", "kana-WO", "kana-a",
4903 "kana-i", "kana-u", "kana-e", "kana-o",
4904 "kana-ya", "kana-yu", "kana-yo", "kana-tsu",
4905 "prolongedsound", "kana-A", "kana-I", "kana-U",
4906 "kana-E", "kana-O", "kana-KA", "kana-KI",
4907 "kana-KU", "kana-KE", "kana-KO", "kana-SA",
4908 "kana-SHI", "kana-SU", "kana-SE", "kana-SO",
4909 "kana-TA", "kana-CHI", "kana-TSU", "kana-TE",
4910 "kana-TO", "kana-NA", "kana-NI", "kana-NU",
4911 "kana-NE", "kana-NO", "kana-HA", "kana-HI",
4912 "kana-FU", "kana-HE", "kana-HO", "kana-MA",
4913 "kana-MI", "kana-MU", "kana-ME", "kana-MO",
4914 "kana-YA", "kana-YU", "kana-YO", "kana-RA",
4915 "kana-RI", "kana-RU", "kana-RE", "kana-RO",
4916 "kana-WA", "kana-N", "voicedsound", "semivoicedsound",
4917 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4e0 .. 0x4ef */
4918 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, /* 0x4f0 .. 0x4ff */
4920 #endif /* XK_kana_A */
4923 #define FUNCTION_KEY_OFFSET 0xff00
4925 /* You'll notice that this table is arranged to be conveniently
4926 indexed by X Windows keysym values. */
4927 static const char *const lispy_function_keys
[] =
4929 /* X Keysym value */
4931 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff00...0f */
4932 "backspace", "tab", "linefeed", "clear",
4934 0, 0, 0, "pause", /* 0xff10...1f */
4935 0, 0, 0, 0, 0, 0, 0, "escape",
4937 0, "kanji", "muhenkan", "henkan", /* 0xff20...2f */
4938 "romaji", "hiragana", "katakana", "hiragana-katakana",
4939 "zenkaku", "hankaku", "zenkaku-hankaku", "touroku",
4940 "massyo", "kana-lock", "kana-shift", "eisu-shift",
4941 "eisu-toggle", /* 0xff30...3f */
4942 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
4943 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, /* 0xff40...4f */
4945 "home", "left", "up", "right", /* 0xff50 */ /* IsCursorKey */
4946 "down", "prior", "next", "end",
4947 "begin", 0, 0, 0, 0, 0, 0, 0,
4948 "select", /* 0xff60 */ /* IsMiscFunctionKey */
4959 "break", /* 0xff6b */
4962 0, 0, 0, 0, "backtab", 0, 0, 0, /* 0xff70... */
4963 0, 0, 0, 0, 0, 0, 0, "kp-numlock", /* 0xff78... */
4964 "kp-space", /* 0xff80 */ /* IsKeypadKey */
4965 0, 0, 0, 0, 0, 0, 0, 0,
4966 "kp-tab", /* 0xff89 */
4968 "kp-enter", /* 0xff8d */
4970 "kp-f1", /* 0xff91 */
4974 "kp-home", /* 0xff95 */
4979 "kp-prior", /* kp-page-up */
4980 "kp-next", /* kp-page-down */
4986 0, 0, 0, 0, 0, 0, 0, 0, 0,
4987 "kp-multiply", /* 0xffaa */
4992 "kp-divide", /* 0xffaf */
4993 "kp-0", /* 0xffb0 */
4994 "kp-1", "kp-2", "kp-3", "kp-4", "kp-5", "kp-6", "kp-7", "kp-8", "kp-9",
4997 "kp-equal", /* 0xffbd */
4998 "f1", /* 0xffbe */ /* IsFunctionKey */
5000 "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", /* 0xffc0 */
5001 "f11", "f12", "f13", "f14", "f15", "f16", "f17", "f18",
5002 "f19", "f20", "f21", "f22", "f23", "f24", "f25", "f26", /* 0xffd0 */
5003 "f27", "f28", "f29", "f30", "f31", "f32", "f33", "f34",
5004 "f35", 0, 0, 0, 0, 0, 0, 0, /* 0xffe0 */
5005 0, 0, 0, 0, 0, 0, 0, 0,
5006 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfff0 */
5007 0, 0, 0, 0, 0, 0, 0, "delete"
5010 /* ISO 9995 Function and Modifier Keys; the first byte is 0xFE. */
5011 #define ISO_FUNCTION_KEY_OFFSET 0xfe00
5013 static const char *const iso_lispy_function_keys
[] =
5015 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe00 */
5016 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe08 */
5017 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe10 */
5018 0, 0, 0, 0, 0, 0, 0, 0, /* 0xfe18 */
5019 "iso-lefttab", /* 0xfe20 */
5020 "iso-move-line-up", "iso-move-line-down",
5021 "iso-partial-line-up", "iso-partial-line-down",
5022 "iso-partial-space-left", "iso-partial-space-right",
5023 "iso-set-margin-left", "iso-set-margin-right", /* 0xffe27, 28 */
5024 "iso-release-margin-left", "iso-release-margin-right",
5025 "iso-release-both-margins",
5026 "iso-fast-cursor-left", "iso-fast-cursor-right",
5027 "iso-fast-cursor-up", "iso-fast-cursor-down",
5028 "iso-continuous-underline", "iso-discontinuous-underline", /* 0xfe30, 31 */
5029 "iso-emphasize", "iso-center-object", "iso-enter", /* ... 0xfe34 */
5032 #endif /* not HAVE_NTGUI */
5034 static Lisp_Object Vlispy_mouse_stem
;
5036 static const char *const lispy_wheel_names
[] =
5038 "wheel-up", "wheel-down", "wheel-left", "wheel-right"
5041 /* drag-n-drop events are generated when a set of selected files are
5042 dragged from another application and dropped onto an Emacs window. */
5043 static const char *const lispy_drag_n_drop_names
[] =
5048 /* Scroll bar parts. */
5049 static Lisp_Object Qabove_handle
, Qhandle
, Qbelow_handle
;
5050 Lisp_Object Qup
, Qdown
, Qbottom
;
5051 static Lisp_Object Qend_scroll
;
5053 static Lisp_Object Qratio
;
5055 /* An array of scroll bar parts, indexed by an enum scroll_bar_part value. */
5056 static Lisp_Object
*const scroll_bar_parts
[] = {
5057 &Qabove_handle
, &Qhandle
, &Qbelow_handle
,
5058 &Qup
, &Qdown
, &Qtop
, &Qbottom
, &Qend_scroll
, &Qratio
5061 /* A vector, indexed by button number, giving the down-going location
5062 of currently depressed buttons, both scroll bar and non-scroll bar.
5064 The elements have the form
5065 (BUTTON-NUMBER MODIFIER-MASK . REST)
5066 where REST is the cdr of a position as it would be reported in the event.
5068 The make_lispy_event function stores positions here to tell the
5069 difference between click and drag events, and to store the starting
5070 location to be included in drag events. */
5072 static Lisp_Object button_down_location
;
5074 /* Information about the most recent up-going button event: Which
5075 button, what location, and what time. */
5077 static int last_mouse_button
;
5078 static int last_mouse_x
;
5079 static int last_mouse_y
;
5080 static Time button_down_time
;
5082 /* The number of clicks in this multiple-click. */
5084 static int double_click_count
;
5086 /* X and Y are frame-relative coordinates for a click or wheel event.
5087 Return a Lisp-style event list. */
5090 make_lispy_position (struct frame
*f
, Lisp_Object x
, Lisp_Object y
,
5093 enum window_part part
;
5094 Lisp_Object posn
= Qnil
;
5095 Lisp_Object extra_info
= Qnil
;
5096 /* Coordinate pixel positions to return. */
5097 int xret
= 0, yret
= 0;
5098 /* The window under frame pixel coordinates (x,y) */
5099 Lisp_Object window
= f
5100 ? window_from_coordinates (f
, XINT (x
), XINT (y
), &part
, 0)
5103 if (WINDOWP (window
))
5105 /* It's a click in window WINDOW at frame coordinates (X,Y) */
5106 struct window
*w
= XWINDOW (window
);
5107 Lisp_Object string_info
= Qnil
;
5108 ptrdiff_t textpos
= -1;
5109 int col
= -1, row
= -1;
5110 int dx
= -1, dy
= -1;
5111 int width
= -1, height
= -1;
5112 Lisp_Object object
= Qnil
;
5114 /* Pixel coordinates relative to the window corner. */
5115 int wx
= XINT (x
) - WINDOW_LEFT_EDGE_X (w
);
5116 int wy
= XINT (y
) - WINDOW_TOP_EDGE_Y (w
);
5118 /* For text area clicks, return X, Y relative to the corner of
5119 this text area. Note that dX, dY etc are set below, by
5120 buffer_posn_from_coords. */
5121 if (part
== ON_TEXT
)
5123 xret
= XINT (x
) - window_box_left (w
, TEXT_AREA
);
5124 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5126 /* For mode line and header line clicks, return X, Y relative to
5127 the left window edge. Use mode_line_string to look for a
5128 string on the click position. */
5129 else if (part
== ON_MODE_LINE
|| part
== ON_HEADER_LINE
)
5134 posn
= (part
== ON_MODE_LINE
) ? Qmode_line
: Qheader_line
;
5135 /* Note that mode_line_string takes COL, ROW as pixels and
5136 converts them to characters. */
5139 string
= mode_line_string (w
, part
, &col
, &row
, &charpos
,
5140 &object
, &dx
, &dy
, &width
, &height
);
5141 if (STRINGP (string
))
5142 string_info
= Fcons (string
, make_number (charpos
));
5143 textpos
= (w
== XWINDOW (selected_window
)
5144 && current_buffer
== XBUFFER (w
->buffer
))
5145 ? PT
: marker_position (w
->pointm
);
5150 /* For fringes and margins, Y is relative to the area's (and the
5151 window's) top edge, while X is meaningless. */
5152 else if (part
== ON_LEFT_MARGIN
|| part
== ON_RIGHT_MARGIN
)
5157 posn
= (part
== ON_LEFT_MARGIN
) ? Qleft_margin
: Qright_margin
;
5160 string
= marginal_area_string (w
, part
, &col
, &row
, &charpos
,
5161 &object
, &dx
, &dy
, &width
, &height
);
5162 if (STRINGP (string
))
5163 string_info
= Fcons (string
, make_number (charpos
));
5164 yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5166 else if (part
== ON_LEFT_FRINGE
)
5168 posn
= Qleft_fringe
;
5171 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5172 ? 0 : window_box_width (w
, LEFT_MARGIN_AREA
));
5173 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5175 else if (part
== ON_RIGHT_FRINGE
)
5177 posn
= Qright_fringe
;
5180 - window_box_width (w
, LEFT_MARGIN_AREA
)
5181 - window_box_width (w
, TEXT_AREA
)
5182 - (WINDOW_HAS_FRINGES_OUTSIDE_MARGINS (w
)
5183 ? window_box_width (w
, RIGHT_MARGIN_AREA
)
5185 dy
= yret
= wy
- WINDOW_HEADER_LINE_HEIGHT (w
);
5187 else if (part
== ON_VERTICAL_BORDER
)
5189 posn
= Qvertical_line
;
5194 /* Nothing special for part == ON_SCROLL_BAR. */
5196 /* For clicks in the text area, fringes, or margins, call
5197 buffer_posn_from_coords to extract TEXTPOS, the buffer
5198 position nearest to the click. */
5201 Lisp_Object string2
, object2
= Qnil
;
5202 struct display_pos p
;
5204 int width2
, height2
;
5205 /* The pixel X coordinate passed to buffer_posn_from_coords
5206 is the X coordinate relative to the text area for
5207 text-area and right-margin clicks, zero otherwise. */
5209 = (part
== ON_TEXT
) ? xret
5210 : (part
== ON_RIGHT_FRINGE
|| part
== ON_RIGHT_MARGIN
)
5211 ? (XINT (x
) - window_box_left (w
, TEXT_AREA
))
5215 string2
= buffer_posn_from_coords (w
, &x2
, &y2
, &p
,
5216 &object2
, &dx2
, &dy2
,
5218 textpos
= CHARPOS (p
.pos
);
5219 if (col
< 0) col
= x2
;
5220 if (row
< 0) row
= y2
;
5221 if (dx
< 0) dx
= dx2
;
5222 if (dy
< 0) dy
= dy2
;
5223 if (width
< 0) width
= width2
;
5224 if (height
< 0) height
= height2
;
5228 posn
= make_number (textpos
);
5229 if (STRINGP (string2
))
5230 string_info
= Fcons (string2
,
5231 make_number (CHARPOS (p
.string_pos
)));
5237 #ifdef HAVE_WINDOW_SYSTEM
5238 if (IMAGEP (object
))
5240 Lisp_Object image_map
, hotspot
;
5241 if ((image_map
= Fplist_get (XCDR (object
), QCmap
),
5243 && (hotspot
= find_hot_spot (image_map
, dx
, dy
),
5245 && (hotspot
= XCDR (hotspot
), CONSP (hotspot
)))
5246 posn
= XCAR (hotspot
);
5253 Fcons (make_number (dx
), make_number (dy
)),
5254 Fcons (make_number (width
), make_number (height
)));
5257 extra_info
= Fcons (string_info
,
5258 Fcons (make_number (textpos
),
5259 Fcons (Fcons (make_number (col
),
5264 XSETFRAME (window
, f
);
5268 return Fcons (window
,
5270 Fcons (Fcons (make_number (xret
),
5271 make_number (yret
)),
5272 Fcons (make_number (t
),
5276 /* Given a struct input_event, build the lisp event which represents
5277 it. If EVENT is 0, build a mouse movement event from the mouse
5278 movement buffer, which should have a movement event in it.
5280 Note that events must be passed to this function in the order they
5281 are received; this function stores the location of button presses
5282 in order to build drag events when the button is released. */
5285 make_lispy_event (struct input_event
*event
)
5289 switch (event
->kind
)
5291 /* A simple keystroke. */
5292 case ASCII_KEYSTROKE_EVENT
:
5293 case MULTIBYTE_CHAR_KEYSTROKE_EVENT
:
5295 Lisp_Object lispy_c
;
5296 EMACS_INT c
= event
->code
;
5297 if (event
->kind
== ASCII_KEYSTROKE_EVENT
)
5300 eassert (c
== event
->code
);
5301 /* Turn ASCII characters into control characters
5303 if (event
->modifiers
& ctrl_modifier
)
5305 c
= make_ctrl_char (c
);
5306 event
->modifiers
&= ~ctrl_modifier
;
5310 /* Add in the other modifier bits. The shift key was taken care
5311 of by the X code. */
5312 c
|= (event
->modifiers
5313 & (meta_modifier
| alt_modifier
5314 | hyper_modifier
| super_modifier
| ctrl_modifier
));
5315 /* Distinguish Shift-SPC from SPC. */
5316 if ((event
->code
) == 040
5317 && event
->modifiers
& shift_modifier
)
5318 c
|= shift_modifier
;
5319 button_down_time
= 0;
5320 XSETFASTINT (lispy_c
, c
);
5325 /* NS_NONKEY_EVENTs are just like NON_ASCII_KEYSTROKE_EVENTs,
5326 except that they are non-key events (last-nonmenu-event is nil). */
5327 case NS_NONKEY_EVENT
:
5330 /* A function key. The symbol may need to have modifier prefixes
5332 case NON_ASCII_KEYSTROKE_EVENT
:
5333 button_down_time
= 0;
5335 for (i
= 0; i
< sizeof (lispy_accent_codes
) / sizeof (int); i
++)
5336 if (event
->code
== lispy_accent_codes
[i
])
5337 return modify_event_symbol (i
,
5339 Qfunction_key
, Qnil
,
5340 lispy_accent_keys
, &accent_key_syms
,
5341 (sizeof (lispy_accent_keys
)
5342 / sizeof (lispy_accent_keys
[0])));
5346 if (event
->code
>= 0x400 && event
->code
< 0x500)
5347 return modify_event_symbol (event
->code
- 0x400,
5348 event
->modifiers
& ~shift_modifier
,
5349 Qfunction_key
, Qnil
,
5350 lispy_kana_keys
, &func_key_syms
,
5351 (sizeof (lispy_kana_keys
)
5352 / sizeof (lispy_kana_keys
[0])));
5353 #endif /* XK_kana_A */
5356 #ifdef ISO_FUNCTION_KEY_OFFSET
5357 if (event
->code
< FUNCTION_KEY_OFFSET
5358 && event
->code
>= ISO_FUNCTION_KEY_OFFSET
)
5359 return modify_event_symbol (event
->code
- ISO_FUNCTION_KEY_OFFSET
,
5361 Qfunction_key
, Qnil
,
5362 iso_lispy_function_keys
, &func_key_syms
,
5363 (sizeof (iso_lispy_function_keys
)
5364 / sizeof (iso_lispy_function_keys
[0])));
5367 /* Handle system-specific or unknown keysyms. */
5368 if (event
->code
& (1 << 28)
5369 || event
->code
- FUNCTION_KEY_OFFSET
< 0
5370 || (event
->code
- FUNCTION_KEY_OFFSET
5371 >= sizeof lispy_function_keys
/ sizeof *lispy_function_keys
)
5372 || !lispy_function_keys
[event
->code
- FUNCTION_KEY_OFFSET
])
5374 /* We need to use an alist rather than a vector as the cache
5375 since we can't make a vector long enough. */
5376 if (NILP (KVAR (current_kboard
, system_key_syms
)))
5377 kset_system_key_syms (current_kboard
, Fcons (Qnil
, Qnil
));
5378 return modify_event_symbol (event
->code
,
5381 KVAR (current_kboard
, Vsystem_key_alist
),
5382 0, &KVAR (current_kboard
, system_key_syms
),
5386 return modify_event_symbol (event
->code
- FUNCTION_KEY_OFFSET
,
5388 Qfunction_key
, Qnil
,
5389 lispy_function_keys
, &func_key_syms
,
5390 (sizeof (lispy_function_keys
)
5391 / sizeof (lispy_function_keys
[0])));
5394 case MULTIMEDIA_KEY_EVENT
:
5395 if (event
->code
< (sizeof (lispy_multimedia_keys
)
5396 / sizeof (lispy_multimedia_keys
[0]))
5397 && event
->code
> 0 && lispy_multimedia_keys
[event
->code
])
5399 return modify_event_symbol (event
->code
, event
->modifiers
,
5400 Qfunction_key
, Qnil
,
5401 lispy_multimedia_keys
, &func_key_syms
,
5402 (sizeof (lispy_multimedia_keys
)
5403 / sizeof (lispy_multimedia_keys
[0])));
5408 /* A mouse click. Figure out where it is, decide whether it's
5409 a press, click or drag, and build the appropriate structure. */
5410 case MOUSE_CLICK_EVENT
:
5411 #ifndef USE_TOOLKIT_SCROLL_BARS
5412 case SCROLL_BAR_CLICK_EVENT
:
5415 int button
= event
->code
;
5417 Lisp_Object position
;
5418 Lisp_Object
*start_pos_ptr
;
5419 Lisp_Object start_pos
;
5423 /* Build the position as appropriate for this mouse click. */
5424 if (event
->kind
== MOUSE_CLICK_EVENT
)
5426 struct frame
*f
= XFRAME (event
->frame_or_window
);
5427 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5431 /* Ignore mouse events that were made on frame that
5432 have been deleted. */
5433 if (! FRAME_LIVE_P (f
))
5436 #if ! defined (USE_X_TOOLKIT) && ! defined (USE_GTK) && ! defined (HAVE_NS)
5437 /* EVENT->x and EVENT->y are frame-relative pixel
5438 coordinates at this place. Under old redisplay, COLUMN
5439 and ROW are set to frame relative glyph coordinates
5440 which are then used to determine whether this click is
5441 in a menu (non-toolkit version). */
5442 pixel_to_glyph_coords (f
, XINT (event
->x
), XINT (event
->y
),
5443 &column
, &row
, NULL
, 1);
5445 /* In the non-toolkit version, clicks on the menu bar
5446 are ordinary button events in the event buffer.
5447 Distinguish them, and invoke the menu.
5449 (In the toolkit version, the toolkit handles the menu bar
5450 and Emacs doesn't know about it until after the user
5451 makes a selection.) */
5452 if (row
>= 0 && row
< FRAME_MENU_BAR_LINES (f
)
5453 && (event
->modifiers
& down_modifier
))
5455 Lisp_Object items
, item
;
5457 /* Find the menu bar item under `column'. */
5459 items
= FRAME_MENU_BAR_ITEMS (f
);
5460 for (i
= 0; i
< ASIZE (items
); i
+= 4)
5462 Lisp_Object pos
, string
;
5463 string
= AREF (items
, i
+ 1);
5464 pos
= AREF (items
, i
+ 3);
5467 if (column
>= XINT (pos
)
5468 && column
< XINT (pos
) + SCHARS (string
))
5470 item
= AREF (items
, i
);
5475 /* ELisp manual 2.4b says (x y) are window relative but
5476 code says they are frame-relative. */
5478 = Fcons (event
->frame_or_window
,
5480 Fcons (Fcons (event
->x
, event
->y
),
5481 Fcons (make_number (event
->timestamp
),
5484 return Fcons (item
, Fcons (position
, Qnil
));
5486 #endif /* not USE_X_TOOLKIT && not USE_GTK && not HAVE_NS */
5488 position
= make_lispy_position (f
, event
->x
, event
->y
,
5491 #ifndef USE_TOOLKIT_SCROLL_BARS
5494 /* It's a scrollbar click. */
5496 Lisp_Object portion_whole
;
5499 window
= event
->frame_or_window
;
5500 portion_whole
= Fcons (event
->x
, event
->y
);
5501 part
= *scroll_bar_parts
[(int) event
->part
];
5505 Fcons (Qvertical_scroll_bar
,
5506 Fcons (portion_whole
,
5507 Fcons (make_number (event
->timestamp
),
5508 Fcons (part
, Qnil
)))));
5510 #endif /* not USE_TOOLKIT_SCROLL_BARS */
5512 if (button
>= ASIZE (button_down_location
))
5514 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5515 button_down_location
= larger_vector (button_down_location
,
5517 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5520 start_pos_ptr
= aref_addr (button_down_location
, button
);
5521 start_pos
= *start_pos_ptr
;
5522 *start_pos_ptr
= Qnil
;
5525 /* On window-system frames, use the value of
5526 double-click-fuzz as is. On other frames, interpret it
5527 as a multiple of 1/8 characters. */
5531 if (WINDOWP (event
->frame_or_window
))
5532 f
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5533 else if (FRAMEP (event
->frame_or_window
))
5534 f
= XFRAME (event
->frame_or_window
);
5538 if (FRAME_WINDOW_P (f
))
5539 fuzz
= double_click_fuzz
;
5541 fuzz
= double_click_fuzz
/ 8;
5543 is_double
= (button
== last_mouse_button
5544 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5545 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5546 && button_down_time
!= 0
5547 && (EQ (Vdouble_click_time
, Qt
)
5548 || (NATNUMP (Vdouble_click_time
)
5549 && (event
->timestamp
- button_down_time
5550 < XFASTINT (Vdouble_click_time
)))));
5553 last_mouse_button
= button
;
5554 last_mouse_x
= XINT (event
->x
);
5555 last_mouse_y
= XINT (event
->y
);
5557 /* If this is a button press, squirrel away the location, so
5558 we can decide later whether it was a click or a drag. */
5559 if (event
->modifiers
& down_modifier
)
5563 double_click_count
++;
5564 event
->modifiers
|= ((double_click_count
> 2)
5569 double_click_count
= 1;
5570 button_down_time
= event
->timestamp
;
5571 *start_pos_ptr
= Fcopy_alist (position
);
5572 ignore_mouse_drag_p
= 0;
5575 /* Now we're releasing a button - check the co-ordinates to
5576 see if this was a click or a drag. */
5577 else if (event
->modifiers
& up_modifier
)
5579 /* If we did not see a down before this up, ignore the up.
5580 Probably this happened because the down event chose a
5581 menu item. It would be an annoyance to treat the
5582 release of the button that chose the menu item as a
5585 if (!CONSP (start_pos
))
5588 event
->modifiers
&= ~up_modifier
;
5591 Lisp_Object new_down
, down
;
5592 EMACS_INT xdiff
= double_click_fuzz
, ydiff
= double_click_fuzz
;
5594 /* The third element of every position
5595 should be the (x,y) pair. */
5596 down
= Fcar (Fcdr (Fcdr (start_pos
)));
5597 new_down
= Fcar (Fcdr (Fcdr (position
)));
5600 && INTEGERP (XCAR (down
)) && INTEGERP (XCDR (down
)))
5602 xdiff
= XINT (XCAR (new_down
)) - XINT (XCAR (down
));
5603 ydiff
= XINT (XCDR (new_down
)) - XINT (XCDR (down
));
5606 if (ignore_mouse_drag_p
)
5608 event
->modifiers
|= click_modifier
;
5609 ignore_mouse_drag_p
= 0;
5611 else if (xdiff
< double_click_fuzz
&& xdiff
> - double_click_fuzz
5612 && ydiff
< double_click_fuzz
&& ydiff
> - double_click_fuzz
5613 /* Maybe the mouse has moved a lot, caused scrolling, and
5614 eventually ended up at the same screen position (but
5615 not buffer position) in which case it is a drag, not
5617 /* FIXME: OTOH if the buffer position has changed
5618 because of a timer or process filter rather than
5619 because of mouse movement, it should be considered as
5620 a click. But mouse-drag-region completely ignores
5621 this case and it hasn't caused any real problem, so
5622 it's probably OK to ignore it as well. */
5623 && EQ (Fcar (Fcdr (start_pos
)), Fcar (Fcdr (position
))))
5624 /* Mouse hasn't moved (much). */
5625 event
->modifiers
|= click_modifier
;
5628 button_down_time
= 0;
5629 event
->modifiers
|= drag_modifier
;
5632 /* Don't check is_double; treat this as multiple
5633 if the down-event was multiple. */
5634 if (double_click_count
> 1)
5635 event
->modifiers
|= ((double_click_count
> 2)
5641 /* Every mouse event should either have the down_modifier or
5642 the up_modifier set. */
5646 /* Get the symbol we should use for the mouse click. */
5649 head
= modify_event_symbol (button
,
5651 Qmouse_click
, Vlispy_mouse_stem
,
5654 ASIZE (mouse_syms
));
5655 if (event
->modifiers
& drag_modifier
)
5660 else if (event
->modifiers
& (double_modifier
| triple_modifier
))
5663 Fcons (make_number (double_click_count
),
5673 case HORIZ_WHEEL_EVENT
:
5675 Lisp_Object position
;
5678 /* Build the position as appropriate for this mouse click. */
5679 struct frame
*f
= XFRAME (event
->frame_or_window
);
5681 /* Ignore wheel events that were made on frame that have been
5683 if (! FRAME_LIVE_P (f
))
5686 position
= make_lispy_position (f
, event
->x
, event
->y
,
5689 /* Set double or triple modifiers to indicate the wheel speed. */
5691 /* On window-system frames, use the value of
5692 double-click-fuzz as is. On other frames, interpret it
5693 as a multiple of 1/8 characters. */
5699 if (WINDOWP (event
->frame_or_window
))
5700 fr
= XFRAME (XWINDOW (event
->frame_or_window
)->frame
);
5701 else if (FRAMEP (event
->frame_or_window
))
5702 fr
= XFRAME (event
->frame_or_window
);
5706 fuzz
= FRAME_WINDOW_P (fr
)
5707 ? double_click_fuzz
: double_click_fuzz
/ 8;
5709 if (event
->modifiers
& up_modifier
)
5711 /* Emit a wheel-up event. */
5712 event
->modifiers
&= ~up_modifier
;
5715 else if (event
->modifiers
& down_modifier
)
5717 /* Emit a wheel-down event. */
5718 event
->modifiers
&= ~down_modifier
;
5722 /* Every wheel event should either have the down_modifier or
5723 the up_modifier set. */
5726 if (event
->kind
== HORIZ_WHEEL_EVENT
)
5729 is_double
= (last_mouse_button
== - (1 + symbol_num
)
5730 && (eabs (XINT (event
->x
) - last_mouse_x
) <= fuzz
)
5731 && (eabs (XINT (event
->y
) - last_mouse_y
) <= fuzz
)
5732 && button_down_time
!= 0
5733 && (EQ (Vdouble_click_time
, Qt
)
5734 || (NATNUMP (Vdouble_click_time
)
5735 && (event
->timestamp
- button_down_time
5736 < XFASTINT (Vdouble_click_time
)))));
5739 double_click_count
++;
5740 event
->modifiers
|= ((double_click_count
> 2)
5746 double_click_count
= 1;
5747 event
->modifiers
|= click_modifier
;
5750 button_down_time
= event
->timestamp
;
5751 /* Use a negative value to distinguish wheel from mouse button. */
5752 last_mouse_button
= - (1 + symbol_num
);
5753 last_mouse_x
= XINT (event
->x
);
5754 last_mouse_y
= XINT (event
->y
);
5756 /* Get the symbol we should use for the wheel event. */
5757 head
= modify_event_symbol (symbol_num
,
5763 ASIZE (wheel_syms
));
5766 if (event
->modifiers
& (double_modifier
| triple_modifier
))
5769 Fcons (make_number (double_click_count
),
5778 #ifdef USE_TOOLKIT_SCROLL_BARS
5780 /* We don't have down and up events if using toolkit scroll bars,
5781 so make this always a click event. Store in the `part' of
5782 the Lisp event a symbol which maps to the following actions:
5784 `above_handle' page up
5785 `below_handle' page down
5789 `bottom' bottom of buffer
5790 `handle' thumb has been dragged.
5791 `end-scroll' end of interaction with scroll bar
5793 The incoming input_event contains in its `part' member an
5794 index of type `enum scroll_bar_part' which we can use as an
5795 index in scroll_bar_parts to get the appropriate symbol. */
5797 case SCROLL_BAR_CLICK_EVENT
:
5799 Lisp_Object position
, head
, window
, portion_whole
, part
;
5801 window
= event
->frame_or_window
;
5802 portion_whole
= Fcons (event
->x
, event
->y
);
5803 part
= *scroll_bar_parts
[(int) event
->part
];
5807 Fcons (Qvertical_scroll_bar
,
5808 Fcons (portion_whole
,
5809 Fcons (make_number (event
->timestamp
),
5810 Fcons (part
, Qnil
)))));
5812 /* Always treat scroll bar events as clicks. */
5813 event
->modifiers
|= click_modifier
;
5814 event
->modifiers
&= ~up_modifier
;
5816 if (event
->code
>= ASIZE (mouse_syms
))
5817 mouse_syms
= larger_vector (mouse_syms
,
5818 event
->code
- ASIZE (mouse_syms
) + 1,
5821 /* Get the symbol we should use for the mouse click. */
5822 head
= modify_event_symbol (event
->code
,
5827 ASIZE (mouse_syms
));
5828 return Fcons (head
, Fcons (position
, Qnil
));
5831 #endif /* USE_TOOLKIT_SCROLL_BARS */
5833 case DRAG_N_DROP_EVENT
:
5836 Lisp_Object head
, position
;
5839 f
= XFRAME (event
->frame_or_window
);
5842 /* Ignore mouse events that were made on frames that
5843 have been deleted. */
5844 if (! FRAME_LIVE_P (f
))
5847 position
= make_lispy_position (f
, event
->x
, event
->y
,
5850 head
= modify_event_symbol (0, event
->modifiers
,
5852 lispy_drag_n_drop_names
,
5853 &drag_n_drop_syms
, 1);
5860 #if defined (USE_X_TOOLKIT) || defined (HAVE_NTGUI) \
5861 || defined (HAVE_NS) || defined (USE_GTK)
5862 case MENU_BAR_EVENT
:
5863 if (EQ (event
->arg
, event
->frame_or_window
))
5864 /* This is the prefix key. We translate this to
5865 `(menu_bar)' because the code in keyboard.c for menu
5866 events, which we use, relies on this. */
5867 return Fcons (Qmenu_bar
, Qnil
);
5871 case SELECT_WINDOW_EVENT
:
5872 /* Make an event (select-window (WINDOW)). */
5873 return Fcons (Qselect_window
,
5874 Fcons (Fcons (event
->frame_or_window
, Qnil
),
5877 case TOOL_BAR_EVENT
:
5878 if (EQ (event
->arg
, event
->frame_or_window
))
5879 /* This is the prefix key. We translate this to
5880 `(tool_bar)' because the code in keyboard.c for tool bar
5881 events, which we use, relies on this. */
5882 return Fcons (Qtool_bar
, Qnil
);
5883 else if (SYMBOLP (event
->arg
))
5884 return apply_modifiers (event
->modifiers
, event
->arg
);
5887 case USER_SIGNAL_EVENT
:
5888 /* A user signal. */
5890 char *name
= find_user_signal_name (event
->code
);
5893 return intern (name
);
5896 case SAVE_SESSION_EVENT
:
5897 return Qsave_session
;
5902 return Fcons (Qdbus_event
, event
->arg
);
5904 #endif /* HAVE_DBUS */
5907 case FILE_NOTIFY_EVENT
:
5909 return Fcons (Qfile_inotify
, event
->arg
);
5911 #endif /* HAVE_INOTIFY */
5913 case CONFIG_CHANGED_EVENT
:
5914 return Fcons (Qconfig_changed_event
,
5916 Fcons (event
->frame_or_window
, Qnil
)));
5918 case GPM_CLICK_EVENT
:
5920 FRAME_PTR f
= XFRAME (event
->frame_or_window
);
5921 Lisp_Object head
, position
;
5922 Lisp_Object
*start_pos_ptr
;
5923 Lisp_Object start_pos
;
5924 int button
= event
->code
;
5926 if (button
>= ASIZE (button_down_location
))
5928 ptrdiff_t incr
= button
- ASIZE (button_down_location
) + 1;
5929 button_down_location
= larger_vector (button_down_location
,
5931 mouse_syms
= larger_vector (mouse_syms
, incr
, -1);
5934 start_pos_ptr
= aref_addr (button_down_location
, button
);
5935 start_pos
= *start_pos_ptr
;
5937 position
= make_lispy_position (f
, event
->x
, event
->y
,
5940 if (event
->modifiers
& down_modifier
)
5941 *start_pos_ptr
= Fcopy_alist (position
);
5942 else if (event
->modifiers
& (up_modifier
| drag_modifier
))
5944 if (!CONSP (start_pos
))
5946 event
->modifiers
&= ~up_modifier
;
5949 head
= modify_event_symbol (button
,
5951 Qmouse_click
, Vlispy_mouse_stem
,
5954 ASIZE (mouse_syms
));
5956 if (event
->modifiers
& drag_modifier
)
5961 else if (event
->modifiers
& double_modifier
)
5964 Fcons (make_number (2),
5966 else if (event
->modifiers
& triple_modifier
)
5969 Fcons (make_number (3),
5976 #endif /* HAVE_GPM */
5978 /* The 'kind' field of the event is something we don't recognize. */
5985 make_lispy_movement (FRAME_PTR frame
, Lisp_Object bar_window
, enum scroll_bar_part part
,
5986 Lisp_Object x
, Lisp_Object y
, Time t
)
5988 /* Is it a scroll bar movement? */
5989 if (frame
&& ! NILP (bar_window
))
5991 Lisp_Object part_sym
;
5993 part_sym
= *scroll_bar_parts
[(int) part
];
5994 return Fcons (Qscroll_bar_movement
,
5995 Fcons (list5 (bar_window
,
5996 Qvertical_scroll_bar
,
6002 /* Or is it an ordinary mouse movement? */
6005 Lisp_Object position
;
6006 position
= make_lispy_position (frame
, x
, y
, t
);
6007 return list2 (Qmouse_movement
, position
);
6011 /* Construct a switch frame event. */
6013 make_lispy_switch_frame (Lisp_Object frame
)
6015 return Fcons (Qswitch_frame
, Fcons (frame
, Qnil
));
6018 /* Manipulating modifiers. */
6020 /* Parse the name of SYMBOL, and return the set of modifiers it contains.
6022 If MODIFIER_END is non-zero, set *MODIFIER_END to the position in
6023 SYMBOL's name of the end of the modifiers; the string from this
6024 position is the unmodified symbol name.
6026 This doesn't use any caches. */
6029 parse_modifiers_uncached (Lisp_Object symbol
, ptrdiff_t *modifier_end
)
6035 CHECK_SYMBOL (symbol
);
6038 name
= SYMBOL_NAME (symbol
);
6040 for (i
= 0; i
< SBYTES (name
) - 1; )
6042 ptrdiff_t this_mod_end
= 0;
6045 /* See if the name continues with a modifier word.
6046 Check that the word appears, but don't check what follows it.
6047 Set this_mod and this_mod_end to record what we find. */
6049 switch (SREF (name
, i
))
6051 #define SINGLE_LETTER_MOD(BIT) \
6052 (this_mod_end = i + 1, this_mod = BIT)
6055 SINGLE_LETTER_MOD (alt_modifier
);
6059 SINGLE_LETTER_MOD (ctrl_modifier
);
6063 SINGLE_LETTER_MOD (hyper_modifier
);
6067 SINGLE_LETTER_MOD (meta_modifier
);
6071 SINGLE_LETTER_MOD (shift_modifier
);
6075 SINGLE_LETTER_MOD (super_modifier
);
6078 #undef SINGLE_LETTER_MOD
6080 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6081 if (i + LEN + 1 <= SBYTES (name) \
6082 && ! memcmp (SDATA (name) + i, NAME, LEN)) \
6084 this_mod_end = i + LEN; \
6089 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6090 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6091 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6095 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6097 #undef MULTI_LETTER_MOD
6101 /* If we found no modifier, stop looking for them. */
6102 if (this_mod_end
== 0)
6105 /* Check there is a dash after the modifier, so that it
6106 really is a modifier. */
6107 if (this_mod_end
>= SBYTES (name
)
6108 || SREF (name
, this_mod_end
) != '-')
6111 /* This modifier is real; look for another. */
6112 modifiers
|= this_mod
;
6113 i
= this_mod_end
+ 1;
6116 /* Should we include the `click' modifier? */
6117 if (! (modifiers
& (down_modifier
| drag_modifier
6118 | double_modifier
| triple_modifier
))
6119 && i
+ 7 == SBYTES (name
)
6120 && memcmp (SDATA (name
) + i
, "mouse-", 6) == 0
6121 && ('0' <= SREF (name
, i
+ 6) && SREF (name
, i
+ 6) <= '9'))
6122 modifiers
|= click_modifier
;
6124 if (! (modifiers
& (double_modifier
| triple_modifier
))
6125 && i
+ 6 < SBYTES (name
)
6126 && memcmp (SDATA (name
) + i
, "wheel-", 6) == 0)
6127 modifiers
|= click_modifier
;
6135 /* Return a symbol whose name is the modifier prefixes for MODIFIERS
6136 prepended to the string BASE[0..BASE_LEN-1].
6137 This doesn't use any caches. */
6139 apply_modifiers_uncached (int modifiers
, char *base
, int base_len
, int base_len_byte
)
6141 /* Since BASE could contain nulls, we can't use intern here; we have
6142 to use Fintern, which expects a genuine Lisp_String, and keeps a
6144 char new_mods
[sizeof "A-C-H-M-S-s-down-drag-double-triple-"];
6150 /* Only the event queue may use the `up' modifier; it should always
6151 be turned into a click or drag event before presented to lisp code. */
6152 if (modifiers
& up_modifier
)
6155 if (modifiers
& alt_modifier
) { *p
++ = 'A'; *p
++ = '-'; }
6156 if (modifiers
& ctrl_modifier
) { *p
++ = 'C'; *p
++ = '-'; }
6157 if (modifiers
& hyper_modifier
) { *p
++ = 'H'; *p
++ = '-'; }
6158 if (modifiers
& meta_modifier
) { *p
++ = 'M'; *p
++ = '-'; }
6159 if (modifiers
& shift_modifier
) { *p
++ = 'S'; *p
++ = '-'; }
6160 if (modifiers
& super_modifier
) { *p
++ = 's'; *p
++ = '-'; }
6161 if (modifiers
& double_modifier
) { strcpy (p
, "double-"); p
+= 7; }
6162 if (modifiers
& triple_modifier
) { strcpy (p
, "triple-"); p
+= 7; }
6163 if (modifiers
& down_modifier
) { strcpy (p
, "down-"); p
+= 5; }
6164 if (modifiers
& drag_modifier
) { strcpy (p
, "drag-"); p
+= 5; }
6165 /* The click modifier is denoted by the absence of other modifiers. */
6169 mod_len
= p
- new_mods
;
6173 Lisp_Object new_name
;
6175 new_name
= make_uninit_multibyte_string (mod_len
+ base_len
,
6176 mod_len
+ base_len_byte
);
6177 memcpy (SDATA (new_name
), new_mods
, mod_len
);
6178 memcpy (SDATA (new_name
) + mod_len
, base
, base_len_byte
);
6180 return Fintern (new_name
, Qnil
);
6185 static const char *const modifier_names
[] =
6187 "up", "down", "drag", "click", "double", "triple", 0, 0,
6188 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
6189 0, 0, "alt", "super", "hyper", "shift", "control", "meta"
6191 #define NUM_MOD_NAMES (sizeof (modifier_names) / sizeof (modifier_names[0]))
6193 static Lisp_Object modifier_symbols
;
6195 /* Return the list of modifier symbols corresponding to the mask MODIFIERS. */
6197 lispy_modifier_list (int modifiers
)
6199 Lisp_Object modifier_list
;
6202 modifier_list
= Qnil
;
6203 for (i
= 0; (1<<i
) <= modifiers
&& i
< NUM_MOD_NAMES
; i
++)
6204 if (modifiers
& (1<<i
))
6205 modifier_list
= Fcons (AREF (modifier_symbols
, i
),
6208 return modifier_list
;
6212 /* Parse the modifiers on SYMBOL, and return a list like (UNMODIFIED MASK),
6213 where UNMODIFIED is the unmodified form of SYMBOL,
6214 MASK is the set of modifiers present in SYMBOL's name.
6215 This is similar to parse_modifiers_uncached, but uses the cache in
6216 SYMBOL's Qevent_symbol_element_mask property, and maintains the
6217 Qevent_symbol_elements property. */
6219 #define KEY_TO_CHAR(k) (XINT (k) & ((1 << CHARACTERBITS) - 1))
6222 parse_modifiers (Lisp_Object symbol
)
6224 Lisp_Object elements
;
6226 if (INTEGERP (symbol
))
6227 return (Fcons (make_number (KEY_TO_CHAR (symbol
)),
6228 Fcons (make_number (XINT (symbol
) & CHAR_MODIFIER_MASK
),
6230 else if (!SYMBOLP (symbol
))
6233 elements
= Fget (symbol
, Qevent_symbol_element_mask
);
6234 if (CONSP (elements
))
6239 int modifiers
= parse_modifiers_uncached (symbol
, &end
);
6240 Lisp_Object unmodified
;
6243 unmodified
= Fintern (make_string (SSDATA (SYMBOL_NAME (symbol
)) + end
,
6244 SBYTES (SYMBOL_NAME (symbol
)) - end
),
6247 if (modifiers
& ~INTMASK
)
6249 XSETFASTINT (mask
, modifiers
);
6250 elements
= Fcons (unmodified
, Fcons (mask
, Qnil
));
6252 /* Cache the parsing results on SYMBOL. */
6253 Fput (symbol
, Qevent_symbol_element_mask
,
6255 Fput (symbol
, Qevent_symbol_elements
,
6256 Fcons (unmodified
, lispy_modifier_list (modifiers
)));
6258 /* Since we know that SYMBOL is modifiers applied to unmodified,
6259 it would be nice to put that in unmodified's cache.
6260 But we can't, since we're not sure that parse_modifiers is
6267 DEFUN ("internal-event-symbol-parse-modifiers", Fevent_symbol_parse_modifiers
,
6268 Sevent_symbol_parse_modifiers
, 1, 1, 0,
6269 doc
: /* Parse the event symbol. For internal use. */)
6270 (Lisp_Object symbol
)
6272 /* Fill the cache if needed. */
6273 parse_modifiers (symbol
);
6274 /* Ignore the result (which is stored on Qevent_symbol_element_mask)
6275 and use the Lispier representation stored on Qevent_symbol_elements
6277 return Fget (symbol
, Qevent_symbol_elements
);
6280 /* Apply the modifiers MODIFIERS to the symbol BASE.
6281 BASE must be unmodified.
6283 This is like apply_modifiers_uncached, but uses BASE's
6284 Qmodifier_cache property, if present. It also builds
6285 Qevent_symbol_elements properties, since it has that info anyway.
6287 apply_modifiers copies the value of BASE's Qevent_kind property to
6288 the modified symbol. */
6290 apply_modifiers (int modifiers
, Lisp_Object base
)
6292 Lisp_Object cache
, idx
, entry
, new_symbol
;
6294 /* Mask out upper bits. We don't know where this value's been. */
6295 modifiers
&= INTMASK
;
6297 if (INTEGERP (base
))
6298 return make_number (XINT (base
) | modifiers
);
6300 /* The click modifier never figures into cache indices. */
6301 cache
= Fget (base
, Qmodifier_cache
);
6302 XSETFASTINT (idx
, (modifiers
& ~click_modifier
));
6303 entry
= assq_no_quit (idx
, cache
);
6306 new_symbol
= XCDR (entry
);
6309 /* We have to create the symbol ourselves. */
6310 new_symbol
= apply_modifiers_uncached (modifiers
,
6311 SSDATA (SYMBOL_NAME (base
)),
6312 SCHARS (SYMBOL_NAME (base
)),
6313 SBYTES (SYMBOL_NAME (base
)));
6315 /* Add the new symbol to the base's cache. */
6316 entry
= Fcons (idx
, new_symbol
);
6317 Fput (base
, Qmodifier_cache
, Fcons (entry
, cache
));
6319 /* We have the parsing info now for free, so we could add it to
6321 XSETFASTINT (idx, modifiers);
6322 Fput (new_symbol, Qevent_symbol_element_mask,
6323 Fcons (base, Fcons (idx, Qnil)));
6324 Fput (new_symbol, Qevent_symbol_elements,
6325 Fcons (base, lispy_modifier_list (modifiers)));
6326 Sadly, this is only correct if `base' is indeed a base event,
6327 which is not necessarily the case. -stef */
6330 /* Make sure this symbol is of the same kind as BASE.
6332 You'd think we could just set this once and for all when we
6333 intern the symbol above, but reorder_modifiers may call us when
6334 BASE's property isn't set right; we can't assume that just
6335 because it has a Qmodifier_cache property it must have its
6336 Qevent_kind set right as well. */
6337 if (NILP (Fget (new_symbol
, Qevent_kind
)))
6341 kind
= Fget (base
, Qevent_kind
);
6343 Fput (new_symbol
, Qevent_kind
, kind
);
6350 /* Given a symbol whose name begins with modifiers ("C-", "M-", etc),
6351 return a symbol with the modifiers placed in the canonical order.
6352 Canonical order is alphabetical, except for down and drag, which
6353 always come last. The 'click' modifier is never written out.
6355 Fdefine_key calls this to make sure that (for example) C-M-foo
6356 and M-C-foo end up being equivalent in the keymap. */
6359 reorder_modifiers (Lisp_Object symbol
)
6361 /* It's hopefully okay to write the code this way, since everything
6362 will soon be in caches, and no consing will be done at all. */
6365 parsed
= parse_modifiers (symbol
);
6366 return apply_modifiers (XFASTINT (XCAR (XCDR (parsed
))),
6371 /* For handling events, we often want to produce a symbol whose name
6372 is a series of modifier key prefixes ("M-", "C-", etcetera) attached
6373 to some base, like the name of a function key or mouse button.
6374 modify_event_symbol produces symbols of this sort.
6376 NAME_TABLE should point to an array of strings, such that NAME_TABLE[i]
6377 is the name of the i'th symbol. TABLE_SIZE is the number of elements
6380 Alternatively, NAME_ALIST_OR_STEM is either an alist mapping codes
6381 into symbol names, or a string specifying a name stem used to
6382 construct a symbol name or the form `STEM-N', where N is the decimal
6383 representation of SYMBOL_NUM. NAME_ALIST_OR_STEM is used if it is
6384 non-nil; otherwise NAME_TABLE is used.
6386 SYMBOL_TABLE should be a pointer to a Lisp_Object whose value will
6387 persist between calls to modify_event_symbol that it can use to
6388 store a cache of the symbols it's generated for this NAME_TABLE
6389 before. The object stored there may be a vector or an alist.
6391 SYMBOL_NUM is the number of the base name we want from NAME_TABLE.
6393 MODIFIERS is a set of modifier bits (as given in struct input_events)
6394 whose prefixes should be applied to the symbol name.
6396 SYMBOL_KIND is the value to be placed in the event_kind property of
6397 the returned symbol.
6399 The symbols we create are supposed to have an
6400 `event-symbol-elements' property, which lists the modifiers present
6401 in the symbol's name. */
6404 modify_event_symbol (ptrdiff_t symbol_num
, int modifiers
, Lisp_Object symbol_kind
,
6405 Lisp_Object name_alist_or_stem
, const char *const *name_table
,
6406 Lisp_Object
*symbol_table
, ptrdiff_t table_size
)
6409 Lisp_Object symbol_int
;
6411 /* Get rid of the "vendor-specific" bit here. */
6412 XSETINT (symbol_int
, symbol_num
& 0xffffff);
6414 /* Is this a request for a valid symbol? */
6415 if (symbol_num
< 0 || symbol_num
>= table_size
)
6418 if (CONSP (*symbol_table
))
6419 value
= Fcdr (assq_no_quit (symbol_int
, *symbol_table
));
6421 /* If *symbol_table doesn't seem to be initialized properly, fix that.
6422 *symbol_table should be a lisp vector TABLE_SIZE elements long,
6423 where the Nth element is the symbol for NAME_TABLE[N], or nil if
6424 we've never used that symbol before. */
6427 if (! VECTORP (*symbol_table
)
6428 || ASIZE (*symbol_table
) != table_size
)
6432 XSETFASTINT (size
, table_size
);
6433 *symbol_table
= Fmake_vector (size
, Qnil
);
6436 value
= AREF (*symbol_table
, symbol_num
);
6439 /* Have we already used this symbol before? */
6442 /* No; let's create it. */
6443 if (CONSP (name_alist_or_stem
))
6444 value
= Fcdr_safe (Fassq (symbol_int
, name_alist_or_stem
));
6445 else if (STRINGP (name_alist_or_stem
))
6448 ptrdiff_t len
= (SBYTES (name_alist_or_stem
)
6449 + sizeof "-" + INT_STRLEN_BOUND (EMACS_INT
));
6451 buf
= SAFE_ALLOCA (len
);
6452 esprintf (buf
, "%s-%"pI
"d", SDATA (name_alist_or_stem
),
6453 XINT (symbol_int
) + 1);
6454 value
= intern (buf
);
6457 else if (name_table
!= 0 && name_table
[symbol_num
])
6458 value
= intern (name_table
[symbol_num
]);
6460 #ifdef HAVE_WINDOW_SYSTEM
6463 char *name
= x_get_keysym_name (symbol_num
);
6465 value
= intern (name
);
6471 char buf
[sizeof "key-" + INT_STRLEN_BOUND (EMACS_INT
)];
6472 sprintf (buf
, "key-%"pD
"d", symbol_num
);
6473 value
= intern (buf
);
6476 if (CONSP (*symbol_table
))
6477 *symbol_table
= Fcons (Fcons (symbol_int
, value
), *symbol_table
);
6479 ASET (*symbol_table
, symbol_num
, value
);
6481 /* Fill in the cache entries for this symbol; this also
6482 builds the Qevent_symbol_elements property, which the user
6484 apply_modifiers (modifiers
& click_modifier
, value
);
6485 Fput (value
, Qevent_kind
, symbol_kind
);
6488 /* Apply modifiers to that symbol. */
6489 return apply_modifiers (modifiers
, value
);
6492 /* Convert a list that represents an event type,
6493 such as (ctrl meta backspace), into the usual representation of that
6494 event type as a number or a symbol. */
6496 DEFUN ("event-convert-list", Fevent_convert_list
, Sevent_convert_list
, 1, 1, 0,
6497 doc
: /* Convert the event description list EVENT-DESC to an event type.
6498 EVENT-DESC should contain one base event type (a character or symbol)
6499 and zero or more modifier names (control, meta, hyper, super, shift, alt,
6500 drag, down, double or triple). The base must be last.
6501 The return value is an event type (a character or symbol) which
6502 has the same base event type and all the specified modifiers. */)
6503 (Lisp_Object event_desc
)
6511 while (CONSP (rest
))
6519 /* Given a symbol, see if it is a modifier name. */
6520 if (SYMBOLP (elt
) && CONSP (rest
))
6521 this = parse_solitary_modifier (elt
);
6525 else if (!NILP (base
))
6526 error ("Two bases given in one event");
6532 /* Let the symbol A refer to the character A. */
6533 if (SYMBOLP (base
) && SCHARS (SYMBOL_NAME (base
)) == 1)
6534 XSETINT (base
, SREF (SYMBOL_NAME (base
), 0));
6536 if (INTEGERP (base
))
6538 /* Turn (shift a) into A. */
6539 if ((modifiers
& shift_modifier
) != 0
6540 && (XINT (base
) >= 'a' && XINT (base
) <= 'z'))
6542 XSETINT (base
, XINT (base
) - ('a' - 'A'));
6543 modifiers
&= ~shift_modifier
;
6546 /* Turn (control a) into C-a. */
6547 if (modifiers
& ctrl_modifier
)
6548 return make_number ((modifiers
& ~ctrl_modifier
)
6549 | make_ctrl_char (XINT (base
)));
6551 return make_number (modifiers
| XINT (base
));
6553 else if (SYMBOLP (base
))
6554 return apply_modifiers (modifiers
, base
);
6557 error ("Invalid base event");
6562 /* Try to recognize SYMBOL as a modifier name.
6563 Return the modifier flag bit, or 0 if not recognized. */
6566 parse_solitary_modifier (Lisp_Object symbol
)
6568 Lisp_Object name
= SYMBOL_NAME (symbol
);
6570 switch (SREF (name
, 0))
6572 #define SINGLE_LETTER_MOD(BIT) \
6573 if (SBYTES (name) == 1) \
6576 #define MULTI_LETTER_MOD(BIT, NAME, LEN) \
6577 if (LEN == SBYTES (name) \
6578 && ! memcmp (SDATA (name), NAME, LEN)) \
6582 SINGLE_LETTER_MOD (alt_modifier
);
6586 MULTI_LETTER_MOD (alt_modifier
, "alt", 3);
6590 SINGLE_LETTER_MOD (ctrl_modifier
);
6594 MULTI_LETTER_MOD (ctrl_modifier
, "ctrl", 4);
6595 MULTI_LETTER_MOD (ctrl_modifier
, "control", 7);
6599 SINGLE_LETTER_MOD (hyper_modifier
);
6603 MULTI_LETTER_MOD (hyper_modifier
, "hyper", 5);
6607 SINGLE_LETTER_MOD (meta_modifier
);
6611 MULTI_LETTER_MOD (meta_modifier
, "meta", 4);
6615 SINGLE_LETTER_MOD (shift_modifier
);
6619 MULTI_LETTER_MOD (shift_modifier
, "shift", 5);
6620 MULTI_LETTER_MOD (super_modifier
, "super", 5);
6621 SINGLE_LETTER_MOD (super_modifier
);
6625 MULTI_LETTER_MOD (drag_modifier
, "drag", 4);
6626 MULTI_LETTER_MOD (down_modifier
, "down", 4);
6627 MULTI_LETTER_MOD (double_modifier
, "double", 6);
6631 MULTI_LETTER_MOD (triple_modifier
, "triple", 6);
6634 #undef SINGLE_LETTER_MOD
6635 #undef MULTI_LETTER_MOD
6641 /* Return true if EVENT is a list whose elements are all integers or symbols.
6642 Such a list is not valid as an event,
6643 but it can be a Lucid-style event type list. */
6646 lucid_event_type_list_p (Lisp_Object object
)
6650 if (! CONSP (object
))
6653 if (EQ (XCAR (object
), Qhelp_echo
)
6654 || EQ (XCAR (object
), Qvertical_line
)
6655 || EQ (XCAR (object
), Qmode_line
)
6656 || EQ (XCAR (object
), Qheader_line
))
6659 for (tail
= object
; CONSP (tail
); tail
= XCDR (tail
))
6663 if (! (INTEGERP (elt
) || SYMBOLP (elt
)))
6670 /* Return true if terminal input chars are available.
6671 Also, store the return value into INPUT_PENDING.
6673 Serves the purpose of ioctl (0, FIONREAD, ...)
6674 but works even if FIONREAD does not exist.
6675 (In fact, this may actually read some input.)
6677 If READABLE_EVENTS_DO_TIMERS_NOW is set in FLAGS, actually run
6678 timer events that are ripe.
6679 If READABLE_EVENTS_FILTER_EVENTS is set in FLAGS, ignore internal
6680 events (FOCUS_IN_EVENT).
6681 If READABLE_EVENTS_IGNORE_SQUEEZABLES is set in FLAGS, ignore mouse
6682 movements and toolkit scroll bar thumb drags. */
6685 get_input_pending (int flags
)
6687 /* First of all, have we already counted some input? */
6688 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6690 /* If input is being read as it arrives, and we have none, there is none. */
6691 if (!input_pending
&& (!interrupt_input
|| interrupts_deferred
))
6693 /* Try to read some input and see how much we get. */
6695 input_pending
= (!NILP (Vquit_flag
) || readable_events (flags
));
6698 return input_pending
;
6701 /* Put a BUFFER_SWITCH_EVENT in the buffer
6702 so that read_key_sequence will notice the new current buffer. */
6705 record_asynch_buffer_change (void)
6707 /* We don't need a buffer-switch event unless Emacs is waiting for input.
6708 The purpose of the event is to make read_key_sequence look up the
6709 keymaps again. If we aren't in read_key_sequence, we don't need one,
6710 and the event could cause trouble by messing up (input-pending-p).
6711 Note: Fwaiting_for_user_input_p always returns nil when async
6712 subprocesses aren't supported. */
6713 if (!NILP (Fwaiting_for_user_input_p ()))
6715 struct input_event event
;
6718 event
.kind
= BUFFER_SWITCH_EVENT
;
6719 event
.frame_or_window
= Qnil
;
6722 /* Make sure no interrupt happens while storing the event. */
6724 if (interrupt_input
)
6725 kbd_buffer_store_event (&event
);
6730 kbd_buffer_store_event (&event
);
6736 /* Read any terminal input already buffered up by the system
6737 into the kbd_buffer, but do not wait.
6739 Return the number of keyboard chars read, or -1 meaning
6740 this is a bad time to try to read input. */
6749 /* Store pending user signal events, if any. */
6750 store_user_signal_events ();
6752 /* Loop through the available terminals, and call their input hooks. */
6756 struct terminal
*next
= t
->next_terminal
;
6758 if (t
->read_socket_hook
)
6761 struct input_event hold_quit
;
6763 if (input_blocked_p ())
6765 pending_signals
= 1;
6769 EVENT_INIT (hold_quit
);
6770 hold_quit
.kind
= NO_EVENT
;
6772 /* No need for FIONREAD or fcntl; just say don't wait. */
6773 while (0 < (nr
= (*t
->read_socket_hook
) (t
, &hold_quit
)))
6776 if (nr
== -1) /* Not OK to read input now. */
6780 else if (nr
== -2) /* Non-transient error. */
6782 /* The terminal device terminated; it should be closed. */
6784 /* Kill Emacs if this was our last terminal. */
6785 if (!terminal_list
->next_terminal
)
6786 /* Formerly simply reported no input, but that
6787 sometimes led to a failure of Emacs to terminate.
6788 SIGHUP seems appropriate if we can't reach the
6790 /* ??? Is it really right to send the signal just to
6791 this process rather than to the whole process
6792 group? Perhaps on systems with FIONREAD Emacs is
6793 alone in its group. */
6794 terminate_due_to_signal (SIGHUP
, 10);
6796 /* XXX Is calling delete_terminal safe here? It calls delete_frame. */
6799 XSETTERMINAL (tmp
, t
);
6800 Fdelete_terminal (tmp
, Qnoelisp
);
6804 if (hold_quit
.kind
!= NO_EVENT
)
6805 kbd_buffer_store_event (&hold_quit
);
6814 frame_make_pointer_visible ();
6820 decode_keyboard_code (struct tty_display_info
*tty
,
6821 struct coding_system
*coding
,
6822 unsigned char *buf
, int nbytes
)
6824 unsigned char *src
= buf
;
6825 const unsigned char *p
;
6830 if (tty
->meta_key
!= 2)
6831 for (i
= 0; i
< nbytes
; i
++)
6833 if (coding
->carryover_bytes
> 0)
6835 src
= alloca (coding
->carryover_bytes
+ nbytes
);
6836 memcpy (src
, coding
->carryover
, coding
->carryover_bytes
);
6837 memcpy (src
+ coding
->carryover_bytes
, buf
, nbytes
);
6838 nbytes
+= coding
->carryover_bytes
;
6840 coding
->destination
= alloca (nbytes
* 4);
6841 coding
->dst_bytes
= nbytes
* 4;
6842 decode_coding_c_string (coding
, src
, nbytes
, Qnil
);
6843 if (coding
->produced_char
== 0)
6845 for (i
= 0, p
= coding
->destination
; i
< coding
->produced_char
; i
++)
6847 struct input_event event_buf
;
6849 EVENT_INIT (event_buf
);
6850 event_buf
.code
= STRING_CHAR_ADVANCE (p
);
6852 (ASCII_CHAR_P (event_buf
.code
)
6853 ? ASCII_KEYSTROKE_EVENT
: MULTIBYTE_CHAR_KEYSTROKE_EVENT
);
6854 /* See the comment in tty_read_avail_input. */
6855 event_buf
.frame_or_window
= tty
->top_frame
;
6856 event_buf
.arg
= Qnil
;
6857 kbd_buffer_store_event (&event_buf
);
6861 /* This is the tty way of reading available input.
6863 Note that each terminal device has its own `struct terminal' object,
6864 and so this function is called once for each individual termcap
6865 terminal. The first parameter indicates which terminal to read from. */
6868 tty_read_avail_input (struct terminal
*terminal
,
6869 struct input_event
*hold_quit
)
6871 /* Using KBD_BUFFER_SIZE - 1 here avoids reading more than
6872 the kbd_buffer can really hold. That may prevent loss
6873 of characters on some systems when input is stuffed at us. */
6874 unsigned char cbuf
[KBD_BUFFER_SIZE
- 1];
6876 struct tty_display_info
*tty
= terminal
->display_info
.tty
;
6879 int buffer_free
= KBD_BUFFER_SIZE
- kbd_buffer_nr_stored () - 1;
6881 if (kbd_on_hold_p () || buffer_free
<= 0)
6883 #endif /* subprocesses */
6885 if (!terminal
->name
) /* Don't read from a dead terminal. */
6888 if (terminal
->type
!= output_termcap
6889 && terminal
->type
!= output_msdos_raw
)
6892 /* XXX I think the following code should be moved to separate hook
6893 functions in system-dependent files. */
6896 #else /* not WINDOWSNT */
6897 if (! tty
->term_initted
) /* In case we get called during bootstrap. */
6901 return 0; /* The terminal is suspended. */
6904 n_to_read
= dos_keysns ();
6908 cbuf
[0] = dos_keyread ();
6911 #else /* not MSDOS */
6916 struct input_event gpm_hold_quit
;
6917 int gpm
, fd
= gpm_fd
;
6919 EVENT_INIT (gpm_hold_quit
);
6920 gpm_hold_quit
.kind
= NO_EVENT
;
6922 /* gpm==1 if event received.
6923 gpm==0 if the GPM daemon has closed the connection, in which case
6924 Gpm_GetEvent closes gpm_fd and clears it to -1, which is why
6925 we save it in `fd' so close_gpm can remove it from the
6927 gpm==-1 if a protocol error or EWOULDBLOCK; the latter is normal. */
6928 while (gpm
= Gpm_GetEvent (&event
), gpm
== 1) {
6929 nread
+= handle_one_term_event (tty
, &event
, &gpm_hold_quit
);
6932 /* Presumably the GPM daemon has closed the connection. */
6934 if (gpm_hold_quit
.kind
!= NO_EVENT
)
6935 kbd_buffer_store_event (&gpm_hold_quit
);
6939 #endif /* HAVE_GPM */
6941 /* Determine how many characters we should *try* to read. */
6942 #ifdef USABLE_FIONREAD
6943 /* Find out how much input is available. */
6944 if (ioctl (fileno (tty
->input
), FIONREAD
, &n_to_read
) < 0)
6946 if (! noninteractive
)
6947 return -2; /* Close this terminal. */
6953 if (n_to_read
> sizeof cbuf
)
6954 n_to_read
= sizeof cbuf
;
6955 #elif defined USG || defined CYGWIN
6956 /* Read some input if available, but don't wait. */
6957 n_to_read
= sizeof cbuf
;
6958 fcntl (fileno (tty
->input
), F_SETFL
, O_NONBLOCK
);
6960 # error "Cannot read without possibly delaying"
6964 /* Don't read more than we can store. */
6965 if (n_to_read
> buffer_free
)
6966 n_to_read
= buffer_free
;
6967 #endif /* subprocesses */
6969 /* Now read; for one reason or another, this will not block.
6970 NREAD is set to the number of chars read. */
6973 nread
= emacs_read (fileno (tty
->input
), (char *) cbuf
, n_to_read
);
6974 /* POSIX infers that processes which are not in the session leader's
6975 process group won't get SIGHUP's at logout time. BSDI adheres to
6976 this part standard and returns -1 from read (0) with errno==EIO
6977 when the control tty is taken away.
6978 Jeffrey Honig <jch@bsdi.com> says this is generally safe. */
6979 if (nread
== -1 && errno
== EIO
)
6980 return -2; /* Close this terminal. */
6981 #if defined (AIX) && defined (_BSD)
6982 /* The kernel sometimes fails to deliver SIGHUP for ptys.
6983 This looks incorrect, but it isn't, because _BSD causes
6984 O_NDELAY to be defined in fcntl.h as O_NONBLOCK,
6985 and that causes a value other than 0 when there is no input. */
6987 return -2; /* Close this terminal. */
6991 /* We used to retry the read if it was interrupted.
6992 But this does the wrong thing when O_NONBLOCK causes
6993 an EAGAIN error. Does anybody know of a situation
6994 where a retry is actually needed? */
6996 nread
< 0 && (errno
== EAGAIN
|| errno
== EFAULT
7006 #ifndef USABLE_FIONREAD
7007 #if defined (USG) || defined (CYGWIN)
7008 fcntl (fileno (tty
->input
), F_SETFL
, 0);
7009 #endif /* USG or CYGWIN */
7010 #endif /* no FIONREAD */
7015 #endif /* not MSDOS */
7016 #endif /* not WINDOWSNT */
7018 if (TERMINAL_KEYBOARD_CODING (terminal
)->common_flags
7019 & CODING_REQUIRE_DECODING_MASK
)
7021 struct coding_system
*coding
= TERMINAL_KEYBOARD_CODING (terminal
);
7024 /* Decode the key sequence except for those with meta
7026 for (i
= from
= 0; ; i
++)
7027 if (i
== nread
|| (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80)))
7029 struct input_event buf
;
7031 decode_keyboard_code (tty
, coding
, cbuf
+ from
, i
- from
);
7036 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7037 buf
.modifiers
= meta_modifier
;
7038 buf
.code
= cbuf
[i
] & ~0x80;
7039 /* See the comment below. */
7040 buf
.frame_or_window
= tty
->top_frame
;
7042 kbd_buffer_store_event (&buf
);
7048 for (i
= 0; i
< nread
; i
++)
7050 struct input_event buf
;
7052 buf
.kind
= ASCII_KEYSTROKE_EVENT
;
7054 if (tty
->meta_key
== 1 && (cbuf
[i
] & 0x80))
7055 buf
.modifiers
= meta_modifier
;
7056 if (tty
->meta_key
!= 2)
7060 /* Set the frame corresponding to the active tty. Note that the
7061 value of selected_frame is not reliable here, redisplay tends
7062 to temporarily change it. */
7063 buf
.frame_or_window
= tty
->top_frame
;
7066 kbd_buffer_store_event (&buf
);
7067 /* Don't look at input that follows a C-g too closely.
7068 This reduces lossage due to autorepeat on C-g. */
7069 if (buf
.kind
== ASCII_KEYSTROKE_EVENT
7070 && buf
.code
== quit_char
)
7078 handle_async_input (void)
7083 int nread
= gobble_input ();
7084 /* -1 means it's not ok to read the input now.
7085 UNBLOCK_INPUT will read it later; now, avoid infinite loop.
7086 0 means there was no keyboard input available. */
7094 process_pending_signals (void)
7096 pending_signals
= 0;
7097 handle_async_input ();
7098 do_pending_atimers ();
7101 /* Undo any number of BLOCK_INPUT calls down to level LEVEL,
7102 and also (if the level is now 0) reinvoke any pending signal. */
7105 unblock_input_to (int level
)
7107 interrupt_input_blocked
= level
;
7110 if (pending_signals
)
7111 process_pending_signals ();
7117 /* End critical section.
7119 If doing signal-driven input, and a signal came in when input was
7120 blocked, reinvoke the signal handler now to deal with it. */
7123 unblock_input (void)
7125 unblock_input_to (interrupt_input_blocked
- 1);
7128 /* Undo any number of BLOCK_INPUT calls,
7129 and also reinvoke any pending signal. */
7132 totally_unblock_input (void)
7134 unblock_input_to (0);
7140 handle_input_available_signal (int sig
)
7142 pending_signals
= 1;
7144 if (input_available_clear_time
)
7145 *input_available_clear_time
= make_emacs_time (0, 0);
7149 deliver_input_available_signal (int sig
)
7151 deliver_process_signal (sig
, handle_input_available_signal
);
7153 #endif /* USABLE_SIGIO */
7156 /* User signal events. */
7158 struct user_signal_info
7160 /* Signal number. */
7163 /* Name of the signal. */
7166 /* Number of pending signals. */
7169 struct user_signal_info
*next
;
7172 /* List of user signals. */
7173 static struct user_signal_info
*user_signals
= NULL
;
7176 add_user_signal (int sig
, const char *name
)
7178 struct sigaction action
;
7179 struct user_signal_info
*p
;
7181 for (p
= user_signals
; p
; p
= p
->next
)
7183 /* Already added. */
7186 p
= xmalloc (sizeof *p
);
7188 p
->name
= xstrdup (name
);
7190 p
->next
= user_signals
;
7193 emacs_sigaction_init (&action
, deliver_user_signal
);
7194 sigaction (sig
, &action
, 0);
7198 handle_user_signal (int sig
)
7200 struct user_signal_info
*p
;
7201 const char *special_event_name
= NULL
;
7203 if (SYMBOLP (Vdebug_on_event
))
7204 special_event_name
= SSDATA (SYMBOL_NAME (Vdebug_on_event
));
7206 for (p
= user_signals
; p
; p
= p
->next
)
7209 if (special_event_name
7210 && strcmp (special_event_name
, p
->name
) == 0)
7212 /* Enter the debugger in many ways. */
7213 debug_on_next_call
= 1;
7216 Vinhibit_quit
= Qnil
;
7218 /* Eat the event. */
7224 if (interrupt_input
)
7225 handle_input_available_signal (sig
);
7229 /* Tell wait_reading_process_output that it needs to wake
7230 up and look around. */
7231 if (input_available_clear_time
)
7232 *input_available_clear_time
= make_emacs_time (0, 0);
7239 deliver_user_signal (int sig
)
7241 deliver_process_signal (sig
, handle_user_signal
);
7245 find_user_signal_name (int sig
)
7247 struct user_signal_info
*p
;
7249 for (p
= user_signals
; p
; p
= p
->next
)
7257 store_user_signal_events (void)
7259 struct user_signal_info
*p
;
7260 struct input_event buf
;
7261 bool buf_initialized
= 0;
7263 for (p
= user_signals
; p
; p
= p
->next
)
7264 if (p
->npending
> 0)
7266 if (! buf_initialized
)
7268 memset (&buf
, 0, sizeof buf
);
7269 buf
.kind
= USER_SIGNAL_EVENT
;
7270 buf
.frame_or_window
= selected_frame
;
7271 buf_initialized
= 1;
7277 kbd_buffer_store_event (&buf
);
7280 while (p
->npending
> 0);
7285 static void menu_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7286 static Lisp_Object menu_bar_one_keymap_changed_items
;
7288 /* These variables hold the vector under construction within
7289 menu_bar_items and its subroutines, and the current index
7290 for storing into that vector. */
7291 static Lisp_Object menu_bar_items_vector
;
7292 static int menu_bar_items_index
;
7295 static const char* separator_names
[] = {
7300 "single-dashed-line",
7301 "double-dashed-line",
7303 "shadow-etched-out",
7304 "shadow-etched-in-dash",
7305 "shadow-etched-out-dash",
7306 "shadow-double-etched-in",
7307 "shadow-double-etched-out",
7308 "shadow-double-etched-in-dash",
7309 "shadow-double-etched-out-dash",
7313 /* Return true if LABEL specifies a separator. */
7316 menu_separator_name_p (const char *label
)
7320 else if (strlen (label
) > 3
7321 && memcmp (label
, "--", 2) == 0
7326 for (i
= 0; separator_names
[i
]; ++i
)
7327 if (strcmp (label
, separator_names
[i
]) == 0)
7332 /* It's a separator if it contains only dashes. */
7333 while (*label
== '-')
7335 return (*label
== 0);
7342 /* Return a vector of menu items for a menu bar, appropriate
7343 to the current buffer. Each item has three elements in the vector:
7346 OLD is an old vector we can optionally reuse, or nil. */
7349 menu_bar_items (Lisp_Object old
)
7351 /* The number of keymaps we're scanning right now, and the number of
7352 keymaps we have allocated space for. */
7355 /* maps[0..nmaps-1] are the prefix definitions of KEYBUF[0..t-1]
7356 in the current keymaps, or nil where it is not a prefix. */
7359 Lisp_Object def
, tail
;
7364 /* In order to build the menus, we need to call the keymap
7365 accessors. They all call QUIT. But this function is called
7366 during redisplay, during which a quit is fatal. So inhibit
7367 quitting while building the menus.
7368 We do this instead of specbind because (1) errors will clear it anyway
7369 and (2) this avoids risk of specpdl overflow. */
7370 oquit
= Vinhibit_quit
;
7374 menu_bar_items_vector
= old
;
7376 menu_bar_items_vector
= Fmake_vector (make_number (24), Qnil
);
7377 menu_bar_items_index
= 0;
7379 /* Build our list of keymaps.
7380 If we recognize a function key and replace its escape sequence in
7381 keybuf with its symbol, or if the sequence starts with a mouse
7382 click and we need to switch buffers, we jump back here to rebuild
7383 the initial keymaps from the current buffer. */
7387 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7388 if (!NILP (Voverriding_local_map_menu_flag
))
7390 /* Yes, use them (if non-nil) as well as the global map. */
7391 maps
= alloca (3 * sizeof (maps
[0]));
7393 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7394 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7395 if (!NILP (Voverriding_local_map
))
7396 maps
[nmaps
++] = Voverriding_local_map
;
7400 /* No, so use major and minor mode keymaps and keymap property.
7401 Note that menu-bar bindings in the local-map and keymap
7402 properties may not work reliable, as they are only
7403 recognized when the menu-bar (or mode-line) is updated,
7404 which does not normally happen after every command. */
7407 nminor
= current_minor_maps (NULL
, &tmaps
);
7408 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7410 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7411 maps
[nmaps
++] = tem
;
7412 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7414 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7416 maps
[nmaps
++] = current_global_map
;
7419 /* Look up in each map the dummy prefix key `menu-bar'. */
7421 for (mapno
= nmaps
- 1; mapno
>= 0; mapno
--)
7422 if (!NILP (maps
[mapno
]))
7424 def
= get_keymap (access_keymap (maps
[mapno
], Qmenu_bar
, 1, 0, 1),
7428 menu_bar_one_keymap_changed_items
= Qnil
;
7429 map_keymap_canonical (def
, menu_bar_item
, Qnil
, NULL
);
7433 /* Move to the end those items that should be at the end. */
7435 for (tail
= Vmenu_bar_final_items
; CONSP (tail
); tail
= XCDR (tail
))
7438 int end
= menu_bar_items_index
;
7440 for (i
= 0; i
< end
; i
+= 4)
7441 if (EQ (XCAR (tail
), AREF (menu_bar_items_vector
, i
)))
7443 Lisp_Object tem0
, tem1
, tem2
, tem3
;
7444 /* Move the item at index I to the end,
7445 shifting all the others forward. */
7446 tem0
= AREF (menu_bar_items_vector
, i
+ 0);
7447 tem1
= AREF (menu_bar_items_vector
, i
+ 1);
7448 tem2
= AREF (menu_bar_items_vector
, i
+ 2);
7449 tem3
= AREF (menu_bar_items_vector
, i
+ 3);
7451 memmove (aref_addr (menu_bar_items_vector
, i
),
7452 aref_addr (menu_bar_items_vector
, i
+ 4),
7453 (end
- i
- 4) * word_size
);
7454 ASET (menu_bar_items_vector
, end
- 4, tem0
);
7455 ASET (menu_bar_items_vector
, end
- 3, tem1
);
7456 ASET (menu_bar_items_vector
, end
- 2, tem2
);
7457 ASET (menu_bar_items_vector
, end
- 1, tem3
);
7462 /* Add nil, nil, nil, nil at the end. */
7464 int i
= menu_bar_items_index
;
7465 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7466 menu_bar_items_vector
=
7467 larger_vector (menu_bar_items_vector
, 4, -1);
7468 /* Add this item. */
7469 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7470 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7471 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7472 ASET (menu_bar_items_vector
, i
, Qnil
); i
++;
7473 menu_bar_items_index
= i
;
7476 Vinhibit_quit
= oquit
;
7477 return menu_bar_items_vector
;
7480 /* Add one item to menu_bar_items_vector, for KEY, ITEM_STRING and DEF.
7481 If there's already an item for KEY, add this DEF to it. */
7483 Lisp_Object item_properties
;
7486 menu_bar_item (Lisp_Object key
, Lisp_Object item
, Lisp_Object dummy1
, void *dummy2
)
7488 struct gcpro gcpro1
;
7493 if (EQ (item
, Qundefined
))
7495 /* If a map has an explicit `undefined' as definition,
7496 discard any previously made menu bar item. */
7498 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7499 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7501 if (menu_bar_items_index
> i
+ 4)
7502 memmove (aref_addr (menu_bar_items_vector
, i
),
7503 aref_addr (menu_bar_items_vector
, i
+ 4),
7504 (menu_bar_items_index
- i
- 4) * word_size
);
7505 menu_bar_items_index
-= 4;
7509 /* If this keymap has already contributed to this KEY,
7510 don't contribute to it a second time. */
7511 tem
= Fmemq (key
, menu_bar_one_keymap_changed_items
);
7512 if (!NILP (tem
) || NILP (item
))
7515 menu_bar_one_keymap_changed_items
7516 = Fcons (key
, menu_bar_one_keymap_changed_items
);
7518 /* We add to menu_bar_one_keymap_changed_items before doing the
7519 parse_menu_item, so that if it turns out it wasn't a menu item,
7520 it still correctly hides any further menu item. */
7522 parsed
= parse_menu_item (item
, 1);
7527 item
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7529 /* Find any existing item for this KEY. */
7530 for (i
= 0; i
< menu_bar_items_index
; i
+= 4)
7531 if (EQ (key
, AREF (menu_bar_items_vector
, i
)))
7534 /* If we did not find this KEY, add it at the end. */
7535 if (i
== menu_bar_items_index
)
7537 /* If vector is too small, get a bigger one. */
7538 if (i
+ 4 > ASIZE (menu_bar_items_vector
))
7539 menu_bar_items_vector
= larger_vector (menu_bar_items_vector
, 4, -1);
7540 /* Add this item. */
7541 ASET (menu_bar_items_vector
, i
, key
); i
++;
7542 ASET (menu_bar_items_vector
, i
,
7543 AREF (item_properties
, ITEM_PROPERTY_NAME
)); i
++;
7544 ASET (menu_bar_items_vector
, i
, Fcons (item
, Qnil
)); i
++;
7545 ASET (menu_bar_items_vector
, i
, make_number (0)); i
++;
7546 menu_bar_items_index
= i
;
7548 /* We did find an item for this KEY. Add ITEM to its list of maps. */
7552 old
= AREF (menu_bar_items_vector
, i
+ 2);
7553 /* If the new and the old items are not both keymaps,
7554 the lookup will only find `item'. */
7555 item
= Fcons (item
, KEYMAPP (item
) && KEYMAPP (XCAR (old
)) ? old
: Qnil
);
7556 ASET (menu_bar_items_vector
, i
+ 2, item
);
7560 /* This is used as the handler when calling menu_item_eval_property. */
7562 menu_item_eval_property_1 (Lisp_Object arg
)
7564 /* If we got a quit from within the menu computation,
7565 quit all the way out of it. This takes care of C-] in the debugger. */
7566 if (CONSP (arg
) && EQ (XCAR (arg
), Qquit
))
7567 Fsignal (Qquit
, Qnil
);
7573 eval_dyn (Lisp_Object form
)
7575 return Feval (form
, Qnil
);
7578 /* Evaluate an expression and return the result (or nil if something
7579 went wrong). Used to evaluate dynamic parts of menu items. */
7581 menu_item_eval_property (Lisp_Object sexpr
)
7583 ptrdiff_t count
= SPECPDL_INDEX ();
7585 specbind (Qinhibit_redisplay
, Qt
);
7586 val
= internal_condition_case_1 (eval_dyn
, sexpr
, Qerror
,
7587 menu_item_eval_property_1
);
7588 return unbind_to (count
, val
);
7591 /* This function parses a menu item and leaves the result in the
7592 vector item_properties.
7593 ITEM is a key binding, a possible menu item.
7594 INMENUBAR is > 0 when this is considered for an entry in a menu bar
7596 INMENUBAR is < 0 when this is considered for an entry in a keyboard menu.
7597 parse_menu_item returns true if the item is a menu item and false
7601 parse_menu_item (Lisp_Object item
, int inmenubar
)
7603 Lisp_Object def
, tem
, item_string
, start
;
7605 Lisp_Object keyhint
;
7614 /* Create item_properties vector if necessary. */
7615 if (NILP (item_properties
))
7617 = Fmake_vector (make_number (ITEM_PROPERTY_ENABLE
+ 1), Qnil
);
7619 /* Initialize optional entries. */
7620 for (i
= ITEM_PROPERTY_DEF
; i
< ITEM_PROPERTY_ENABLE
; i
++)
7621 ASET (item_properties
, i
, Qnil
);
7622 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7624 /* Save the item here to protect it from GC. */
7625 ASET (item_properties
, ITEM_PROPERTY_ITEM
, item
);
7627 item_string
= XCAR (item
);
7631 if (STRINGP (item_string
))
7633 /* Old format menu item. */
7634 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7636 /* Maybe help string. */
7637 if (CONSP (item
) && STRINGP (XCAR (item
)))
7639 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7644 /* Maybe an obsolete key binding cache. */
7645 if (CONSP (item
) && CONSP (XCAR (item
))
7646 && (NILP (XCAR (XCAR (item
)))
7647 || VECTORP (XCAR (XCAR (item
)))))
7650 /* This is the real definition--the function to run. */
7651 ASET (item_properties
, ITEM_PROPERTY_DEF
, item
);
7653 /* Get enable property, if any. */
7656 tem
= Fget (item
, Qmenu_enable
);
7657 if (!NILP (Venable_disabled_menus_and_buttons
))
7658 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7659 else if (!NILP (tem
))
7660 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7663 else if (EQ (item_string
, Qmenu_item
) && CONSP (item
))
7665 /* New format menu item. */
7666 ASET (item_properties
, ITEM_PROPERTY_NAME
, XCAR (item
));
7667 start
= XCDR (item
);
7670 /* We have a real binding. */
7671 ASET (item_properties
, ITEM_PROPERTY_DEF
, XCAR (start
));
7673 item
= XCDR (start
);
7674 /* Is there an obsolete cache list with key equivalences. */
7675 if (CONSP (item
) && CONSP (XCAR (item
)))
7678 /* Parse properties. */
7679 while (CONSP (item
) && CONSP (XCDR (item
)))
7684 if (EQ (tem
, QCenable
))
7686 if (!NILP (Venable_disabled_menus_and_buttons
))
7687 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, Qt
);
7689 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, XCAR (item
));
7691 else if (EQ (tem
, QCvisible
))
7693 /* If got a visible property and that evaluates to nil
7694 then ignore this item. */
7695 tem
= menu_item_eval_property (XCAR (item
));
7699 else if (EQ (tem
, QChelp
))
7700 ASET (item_properties
, ITEM_PROPERTY_HELP
, XCAR (item
));
7701 else if (EQ (tem
, QCfilter
))
7703 else if (EQ (tem
, QCkey_sequence
))
7706 if (SYMBOLP (tem
) || STRINGP (tem
) || VECTORP (tem
))
7707 /* Be GC protected. Set keyhint to item instead of tem. */
7710 else if (EQ (tem
, QCkeys
))
7713 if (CONSP (tem
) || STRINGP (tem
))
7714 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, tem
);
7716 else if (EQ (tem
, QCbutton
) && CONSP (XCAR (item
)))
7721 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
7723 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7725 ASET (item_properties
, ITEM_PROPERTY_TYPE
, type
);
7731 else if (inmenubar
|| !NILP (start
))
7735 return 0; /* not a menu item */
7737 /* If item string is not a string, evaluate it to get string.
7738 If we don't get a string, skip this item. */
7739 item_string
= AREF (item_properties
, ITEM_PROPERTY_NAME
);
7740 if (!(STRINGP (item_string
)))
7742 item_string
= menu_item_eval_property (item_string
);
7743 if (!STRINGP (item_string
))
7745 ASET (item_properties
, ITEM_PROPERTY_NAME
, item_string
);
7748 /* If got a filter apply it on definition. */
7749 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7752 def
= menu_item_eval_property (list2 (XCAR (filter
),
7753 list2 (Qquote
, def
)));
7755 ASET (item_properties
, ITEM_PROPERTY_DEF
, def
);
7758 /* Enable or disable selection of item. */
7759 tem
= AREF (item_properties
, ITEM_PROPERTY_ENABLE
);
7762 tem
= menu_item_eval_property (tem
);
7763 if (inmenubar
&& NILP (tem
))
7764 return 0; /* Ignore disabled items in menu bar. */
7765 ASET (item_properties
, ITEM_PROPERTY_ENABLE
, tem
);
7768 /* If we got no definition, this item is just unselectable text which
7769 is OK in a submenu but not in the menubar. */
7771 return (!inmenubar
);
7773 /* See if this is a separate pane or a submenu. */
7774 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7775 tem
= get_keymap (def
, 0, 1);
7776 /* For a subkeymap, just record its details and exit. */
7779 ASET (item_properties
, ITEM_PROPERTY_MAP
, tem
);
7780 ASET (item_properties
, ITEM_PROPERTY_DEF
, tem
);
7784 /* At the top level in the menu bar, do likewise for commands also.
7785 The menu bar does not display equivalent key bindings anyway.
7786 ITEM_PROPERTY_DEF is already set up properly. */
7790 { /* This is a command. See if there is an equivalent key binding. */
7791 Lisp_Object keyeq
= AREF (item_properties
, ITEM_PROPERTY_KEYEQ
);
7793 /* The previous code preferred :key-sequence to :keys, so we
7794 preserve this behavior. */
7795 if (STRINGP (keyeq
) && !CONSP (keyhint
))
7796 keyeq
= concat2 (build_string (" "), Fsubstitute_command_keys (keyeq
));
7799 Lisp_Object prefix
= keyeq
;
7800 Lisp_Object keys
= Qnil
;
7804 def
= XCAR (prefix
);
7805 prefix
= XCDR (prefix
);
7808 def
= AREF (item_properties
, ITEM_PROPERTY_DEF
);
7810 if (CONSP (keyhint
) && !NILP (XCAR (keyhint
)))
7812 keys
= XCAR (keyhint
);
7813 tem
= Fkey_binding (keys
, Qnil
, Qnil
, Qnil
);
7815 /* We have a suggested key. Is it bound to the command? */
7818 /* If the command is an alias for another
7819 (such as lmenu.el set it up), check if the
7820 original command matches the cached command. */
7822 && EQ (tem
, XSYMBOL (def
)->function
))))
7827 keys
= Fwhere_is_internal (def
, Qnil
, Qt
, Qnil
, Qnil
);
7831 tem
= Fkey_description (keys
, Qnil
);
7834 if (STRINGP (XCAR (prefix
)))
7835 tem
= concat2 (XCAR (prefix
), tem
);
7836 if (STRINGP (XCDR (prefix
)))
7837 tem
= concat2 (tem
, XCDR (prefix
));
7839 keyeq
= concat2 (build_string (" "), tem
);
7840 /* keyeq = concat3(build_string(" ("),tem,build_string(")")); */
7846 /* If we have an equivalent key binding, use that. */
7847 ASET (item_properties
, ITEM_PROPERTY_KEYEQ
, keyeq
);
7850 /* Include this when menu help is implemented.
7851 tem = XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP];
7852 if (!(NILP (tem) || STRINGP (tem)))
7854 tem = menu_item_eval_property (tem);
7857 XVECTOR (item_properties)->contents[ITEM_PROPERTY_HELP] = tem;
7861 /* Handle radio buttons or toggle boxes. */
7862 tem
= AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
7864 ASET (item_properties
, ITEM_PROPERTY_SELECTED
,
7865 menu_item_eval_property (tem
));
7872 /***********************************************************************
7874 ***********************************************************************/
7876 /* A vector holding tool bar items while they are parsed in function
7877 tool_bar_items. Each item occupies TOOL_BAR_ITEM_NSCLOTS elements
7880 static Lisp_Object tool_bar_items_vector
;
7882 /* A vector holding the result of parse_tool_bar_item. Layout is like
7883 the one for a single item in tool_bar_items_vector. */
7885 static Lisp_Object tool_bar_item_properties
;
7887 /* Next free index in tool_bar_items_vector. */
7889 static int ntool_bar_items
;
7891 /* The symbols `:image' and `:rtl'. */
7893 static Lisp_Object QCimage
;
7894 static Lisp_Object QCrtl
;
7896 /* Function prototypes. */
7898 static void init_tool_bar_items (Lisp_Object
);
7899 static void process_tool_bar_item (Lisp_Object
, Lisp_Object
, Lisp_Object
, void*);
7900 static bool parse_tool_bar_item (Lisp_Object
, Lisp_Object
);
7901 static void append_tool_bar_item (void);
7904 /* Return a vector of tool bar items for keymaps currently in effect.
7905 Reuse vector REUSE if non-nil. Return in *NITEMS the number of
7906 tool bar items found. */
7909 tool_bar_items (Lisp_Object reuse
, int *nitems
)
7918 /* In order to build the menus, we need to call the keymap
7919 accessors. They all call QUIT. But this function is called
7920 during redisplay, during which a quit is fatal. So inhibit
7921 quitting while building the menus. We do this instead of
7922 specbind because (1) errors will clear it anyway and (2) this
7923 avoids risk of specpdl overflow. */
7924 oquit
= Vinhibit_quit
;
7927 /* Initialize tool_bar_items_vector and protect it from GC. */
7928 init_tool_bar_items (reuse
);
7930 /* Build list of keymaps in maps. Set nmaps to the number of maps
7933 /* Should overriding-terminal-local-map and overriding-local-map apply? */
7934 if (!NILP (Voverriding_local_map_menu_flag
))
7936 /* Yes, use them (if non-nil) as well as the global map. */
7937 maps
= alloca (3 * sizeof *maps
);
7939 if (!NILP (KVAR (current_kboard
, Voverriding_terminal_local_map
)))
7940 maps
[nmaps
++] = KVAR (current_kboard
, Voverriding_terminal_local_map
);
7941 if (!NILP (Voverriding_local_map
))
7942 maps
[nmaps
++] = Voverriding_local_map
;
7946 /* No, so use major and minor mode keymaps and keymap property.
7947 Note that tool-bar bindings in the local-map and keymap
7948 properties may not work reliable, as they are only
7949 recognized when the tool-bar (or mode-line) is updated,
7950 which does not normally happen after every command. */
7953 nminor
= current_minor_maps (NULL
, &tmaps
);
7954 maps
= alloca ((nminor
+ 3) * sizeof *maps
);
7956 if (tem
= get_local_map (PT
, current_buffer
, Qkeymap
), !NILP (tem
))
7957 maps
[nmaps
++] = tem
;
7958 memcpy (maps
+ nmaps
, tmaps
, nminor
* sizeof (maps
[0]));
7960 maps
[nmaps
++] = get_local_map (PT
, current_buffer
, Qlocal_map
);
7963 /* Add global keymap at the end. */
7964 maps
[nmaps
++] = current_global_map
;
7966 /* Process maps in reverse order and look up in each map the prefix
7968 for (i
= nmaps
- 1; i
>= 0; --i
)
7969 if (!NILP (maps
[i
]))
7973 keymap
= get_keymap (access_keymap (maps
[i
], Qtool_bar
, 1, 0, 1), 0, 1);
7975 map_keymap (keymap
, process_tool_bar_item
, Qnil
, NULL
, 1);
7978 Vinhibit_quit
= oquit
;
7979 *nitems
= ntool_bar_items
/ TOOL_BAR_ITEM_NSLOTS
;
7980 return tool_bar_items_vector
;
7984 /* Process the definition of KEY which is DEF. */
7987 process_tool_bar_item (Lisp_Object key
, Lisp_Object def
, Lisp_Object data
, void *args
)
7990 struct gcpro gcpro1
, gcpro2
;
7992 /* Protect KEY and DEF from GC because parse_tool_bar_item may call
7996 if (EQ (def
, Qundefined
))
7998 /* If a map has an explicit `undefined' as definition,
7999 discard any previously made item. */
8000 for (i
= 0; i
< ntool_bar_items
; i
+= TOOL_BAR_ITEM_NSLOTS
)
8002 Lisp_Object
*v
= XVECTOR (tool_bar_items_vector
)->contents
+ i
;
8004 if (EQ (key
, v
[TOOL_BAR_ITEM_KEY
]))
8006 if (ntool_bar_items
> i
+ TOOL_BAR_ITEM_NSLOTS
)
8007 memmove (v
, v
+ TOOL_BAR_ITEM_NSLOTS
,
8008 ((ntool_bar_items
- i
- TOOL_BAR_ITEM_NSLOTS
)
8010 ntool_bar_items
-= TOOL_BAR_ITEM_NSLOTS
;
8015 else if (parse_tool_bar_item (key
, def
))
8016 /* Append a new tool bar item to tool_bar_items_vector. Accept
8017 more than one definition for the same key. */
8018 append_tool_bar_item ();
8023 /* Access slot with index IDX of vector tool_bar_item_properties. */
8024 #define PROP(IDX) AREF (tool_bar_item_properties, (IDX))
8026 set_prop (ptrdiff_t idx
, Lisp_Object val
)
8028 ASET (tool_bar_item_properties
, idx
, val
);
8032 /* Parse a tool bar item specification ITEM for key KEY and return the
8033 result in tool_bar_item_properties. Value is false if ITEM is
8036 ITEM is a list `(menu-item CAPTION BINDING PROPS...)'.
8038 CAPTION is the caption of the item, If it's not a string, it is
8039 evaluated to get a string.
8041 BINDING is the tool bar item's binding. Tool-bar items with keymaps
8042 as binding are currently ignored.
8044 The following properties are recognized:
8048 FORM is evaluated and specifies whether the tool bar item is
8049 enabled or disabled.
8053 FORM is evaluated and specifies whether the tool bar item is visible.
8055 - `:filter FUNCTION'
8057 FUNCTION is invoked with one parameter `(quote BINDING)'. Its
8058 result is stored as the new binding.
8060 - `:button (TYPE SELECTED)'
8062 TYPE must be one of `:radio' or `:toggle'. SELECTED is evaluated
8063 and specifies whether the button is selected (pressed) or not.
8067 IMAGES is either a single image specification or a vector of four
8068 image specifications. See enum tool_bar_item_images.
8070 - `:help HELP-STRING'.
8072 Gives a help string to display for the tool bar item.
8074 - `:label LABEL-STRING'.
8076 A text label to show with the tool bar button if labels are enabled. */
8079 parse_tool_bar_item (Lisp_Object key
, Lisp_Object item
)
8081 Lisp_Object filter
= Qnil
;
8082 Lisp_Object caption
;
8084 bool have_label
= 0;
8086 /* Definition looks like `(menu-item CAPTION BINDING PROPS...)'.
8087 Rule out items that aren't lists, don't start with
8088 `menu-item' or whose rest following `tool-bar-item' is not a
8093 /* As an exception, allow old-style menu separators. */
8094 if (STRINGP (XCAR (item
)))
8095 item
= Fcons (XCAR (item
), Qnil
);
8096 else if (!EQ (XCAR (item
), Qmenu_item
)
8097 || (item
= XCDR (item
), !CONSP (item
)))
8100 /* Create tool_bar_item_properties vector if necessary. Reset it to
8102 if (VECTORP (tool_bar_item_properties
))
8104 for (i
= 0; i
< TOOL_BAR_ITEM_NSLOTS
; ++i
)
8108 tool_bar_item_properties
8109 = Fmake_vector (make_number (TOOL_BAR_ITEM_NSLOTS
), Qnil
);
8112 set_prop (TOOL_BAR_ITEM_KEY
, key
);
8113 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8115 /* Get the caption of the item. If the caption is not a string,
8116 evaluate it to get a string. If we don't get a string, skip this
8118 caption
= XCAR (item
);
8119 if (!STRINGP (caption
))
8121 caption
= menu_item_eval_property (caption
);
8122 if (!STRINGP (caption
))
8125 set_prop (TOOL_BAR_ITEM_CAPTION
, caption
);
8127 /* If the rest following the caption is not a list, the menu item is
8128 either a separator, or invalid. */
8132 if (menu_separator_name_p (SSDATA (caption
)))
8134 set_prop (TOOL_BAR_ITEM_TYPE
, Qt
);
8135 #if !defined (USE_GTK) && !defined (HAVE_NS)
8136 /* If we use build_desired_tool_bar_string to render the
8137 tool bar, the separator is rendered as an image. */
8138 PROP (TOOL_BAR_ITEM_IMAGES
)
8139 = menu_item_eval_property (Vtool_bar_separator_image_expression
);
8140 PROP (TOOL_BAR_ITEM_ENABLED_P
) = Qnil
;
8141 PROP (TOOL_BAR_ITEM_SELECTED_P
) = Qnil
;
8142 PROP (TOOL_BAR_ITEM_CAPTION
) = Qnil
;
8149 /* Store the binding. */
8150 set_prop (TOOL_BAR_ITEM_BINDING
, XCAR (item
));
8153 /* Ignore cached key binding, if any. */
8154 if (CONSP (item
) && CONSP (XCAR (item
)))
8157 /* Process the rest of the properties. */
8158 for (; CONSP (item
) && CONSP (XCDR (item
)); item
= XCDR (XCDR (item
)))
8160 Lisp_Object ikey
, value
;
8163 value
= XCAR (XCDR (item
));
8165 if (EQ (ikey
, QCenable
))
8167 /* `:enable FORM'. */
8168 if (!NILP (Venable_disabled_menus_and_buttons
))
8169 set_prop (TOOL_BAR_ITEM_ENABLED_P
, Qt
);
8171 set_prop (TOOL_BAR_ITEM_ENABLED_P
, value
);
8173 else if (EQ (ikey
, QCvisible
))
8175 /* `:visible FORM'. If got a visible property and that
8176 evaluates to nil then ignore this item. */
8177 if (NILP (menu_item_eval_property (value
)))
8180 else if (EQ (ikey
, QChelp
))
8181 /* `:help HELP-STRING'. */
8182 set_prop (TOOL_BAR_ITEM_HELP
, value
);
8183 else if (EQ (ikey
, QCvert_only
))
8184 /* `:vert-only t/nil'. */
8185 set_prop (TOOL_BAR_ITEM_VERT_ONLY
, value
);
8186 else if (EQ (ikey
, QClabel
))
8188 const char *bad_label
= "!!?GARBLED ITEM?!!";
8189 /* `:label LABEL-STRING'. */
8190 set_prop (TOOL_BAR_ITEM_LABEL
,
8191 STRINGP (value
) ? value
: build_string (bad_label
));
8194 else if (EQ (ikey
, QCfilter
))
8195 /* ':filter FORM'. */
8197 else if (EQ (ikey
, QCbutton
) && CONSP (value
))
8199 /* `:button (TYPE . SELECTED)'. */
8200 Lisp_Object type
, selected
;
8202 type
= XCAR (value
);
8203 selected
= XCDR (value
);
8204 if (EQ (type
, QCtoggle
) || EQ (type
, QCradio
))
8206 set_prop (TOOL_BAR_ITEM_SELECTED_P
, selected
);
8207 set_prop (TOOL_BAR_ITEM_TYPE
, type
);
8210 else if (EQ (ikey
, QCimage
)
8212 || (VECTORP (value
) && ASIZE (value
) == 4)))
8213 /* Value is either a single image specification or a vector
8214 of 4 such specifications for the different button states. */
8215 set_prop (TOOL_BAR_ITEM_IMAGES
, value
);
8216 else if (EQ (ikey
, QCrtl
))
8218 set_prop (TOOL_BAR_ITEM_RTL_IMAGE
, value
);
8224 /* Try to make one from caption and key. */
8225 Lisp_Object tkey
= PROP (TOOL_BAR_ITEM_KEY
);
8226 Lisp_Object tcapt
= PROP (TOOL_BAR_ITEM_CAPTION
);
8227 const char *label
= SYMBOLP (tkey
) ? SSDATA (SYMBOL_NAME (tkey
)) : "";
8228 const char *capt
= STRINGP (tcapt
) ? SSDATA (tcapt
) : "";
8230 2 * max (0, min (tool_bar_max_label_size
, STRING_BYTES_BOUND
/ 2));
8231 char *buf
= xmalloc (max_lbl
+ 1);
8232 Lisp_Object new_lbl
;
8233 ptrdiff_t caption_len
= strlen (capt
);
8235 if (caption_len
<= max_lbl
&& capt
[0] != '\0')
8238 while (caption_len
> 0 && buf
[caption_len
- 1] == '.')
8240 buf
[caption_len
] = '\0';
8244 if (strlen (label
) <= max_lbl
&& label
[0] != '\0')
8248 strcpy (buf
, label
);
8250 for (j
= 0; buf
[j
] != '\0'; ++j
)
8258 new_lbl
= Fupcase_initials (build_string (label
));
8259 if (SCHARS (new_lbl
) <= tool_bar_max_label_size
)
8260 set_prop (TOOL_BAR_ITEM_LABEL
, new_lbl
);
8262 set_prop (TOOL_BAR_ITEM_LABEL
, empty_unibyte_string
);
8266 /* If got a filter apply it on binding. */
8268 set_prop (TOOL_BAR_ITEM_BINDING
,
8269 (menu_item_eval_property
8272 PROP (TOOL_BAR_ITEM_BINDING
))))));
8274 /* See if the binding is a keymap. Give up if it is. */
8275 if (CONSP (get_keymap (PROP (TOOL_BAR_ITEM_BINDING
), 0, 1)))
8278 /* Enable or disable selection of item. */
8279 if (!EQ (PROP (TOOL_BAR_ITEM_ENABLED_P
), Qt
))
8280 set_prop (TOOL_BAR_ITEM_ENABLED_P
,
8281 menu_item_eval_property (PROP (TOOL_BAR_ITEM_ENABLED_P
)));
8283 /* Handle radio buttons or toggle boxes. */
8284 if (!NILP (PROP (TOOL_BAR_ITEM_SELECTED_P
)))
8285 set_prop (TOOL_BAR_ITEM_SELECTED_P
,
8286 menu_item_eval_property (PROP (TOOL_BAR_ITEM_SELECTED_P
)));
8294 /* Initialize tool_bar_items_vector. REUSE, if non-nil, is a vector
8295 that can be reused. */
8298 init_tool_bar_items (Lisp_Object reuse
)
8300 if (VECTORP (reuse
))
8301 tool_bar_items_vector
= reuse
;
8303 tool_bar_items_vector
= Fmake_vector (make_number (64), Qnil
);
8304 ntool_bar_items
= 0;
8308 /* Append parsed tool bar item properties from
8309 tool_bar_item_properties */
8312 append_tool_bar_item (void)
8316 - (ASIZE (tool_bar_items_vector
) - TOOL_BAR_ITEM_NSLOTS
));
8318 /* Enlarge tool_bar_items_vector if necessary. */
8320 tool_bar_items_vector
8321 = larger_vector (tool_bar_items_vector
, incr
, -1);
8323 /* Append entries from tool_bar_item_properties to the end of
8324 tool_bar_items_vector. */
8325 vcopy (tool_bar_items_vector
, ntool_bar_items
,
8326 XVECTOR (tool_bar_item_properties
)->contents
, TOOL_BAR_ITEM_NSLOTS
);
8327 ntool_bar_items
+= TOOL_BAR_ITEM_NSLOTS
;
8334 /* Read a character using menus based on the keymap MAP.
8335 Return nil if there are no menus in the maps.
8336 Return t if we displayed a menu but the user rejected it.
8338 PREV_EVENT is the previous input event, or nil if we are reading
8339 the first event of a key sequence.
8341 If USED_MOUSE_MENU is non-null, set *USED_MOUSE_MENU to true
8342 if we used a mouse menu to read the input, or false otherwise. If
8343 USED_MOUSE_MENU is null, don't dereference it.
8345 The prompting is done based on the prompt-string of the map
8346 and the strings associated with various map elements.
8348 This can be done with X menus or with menus put in the minibuf.
8349 These are done in different ways, depending on how the input will be read.
8350 Menus using X are done after auto-saving in read-char, getting the input
8351 event from Fx_popup_menu; menus using the minibuf use read_char recursively
8352 and do auto-saving in the inner call of read_char. */
8355 read_char_x_menu_prompt (Lisp_Object map
,
8356 Lisp_Object prev_event
, bool *used_mouse_menu
)
8358 if (used_mouse_menu
)
8359 *used_mouse_menu
= 0;
8361 /* Use local over global Menu maps. */
8363 if (! menu_prompting
)
8367 /* If we got to this point via a mouse click,
8368 use a real menu for mouse selection. */
8369 if (EVENT_HAS_PARAMETERS (prev_event
)
8370 && !EQ (XCAR (prev_event
), Qmenu_bar
)
8371 && !EQ (XCAR (prev_event
), Qtool_bar
))
8373 /* Display the menu and get the selection. */
8376 value
= Fx_popup_menu (prev_event
, get_keymap (map
, 0, 1));
8381 record_menu_key (XCAR (value
));
8383 /* If we got multiple events, unread all but
8385 There is no way to prevent those unread events
8386 from showing up later in last_nonmenu_event.
8387 So turn symbol and integer events into lists,
8388 to indicate that they came from a mouse menu,
8389 so that when present in last_nonmenu_event
8390 they won't confuse things. */
8391 for (tem
= XCDR (value
); CONSP (tem
); tem
= XCDR (tem
))
8393 record_menu_key (XCAR (tem
));
8394 if (SYMBOLP (XCAR (tem
))
8395 || INTEGERP (XCAR (tem
)))
8396 XSETCAR (tem
, Fcons (XCAR (tem
), Qdisabled
));
8399 /* If we got more than one event, put all but the first
8400 onto this list to be read later.
8401 Return just the first event now. */
8402 Vunread_command_events
8403 = nconc2 (XCDR (value
), Vunread_command_events
);
8404 value
= XCAR (value
);
8406 else if (NILP (value
))
8408 if (used_mouse_menu
)
8409 *used_mouse_menu
= 1;
8412 #endif /* HAVE_MENUS */
8417 read_char_minibuf_menu_prompt (int commandflag
,
8420 register Lisp_Object name
;
8422 /* FIXME: Use the minibuffer's frame width. */
8423 ptrdiff_t width
= FRAME_COLS (SELECTED_FRAME ()) - 4;
8425 bool nobindings
= 1;
8426 Lisp_Object rest
, vector
;
8427 Lisp_Object prompt_strings
= Qnil
;
8431 if (! menu_prompting
)
8434 map
= get_keymap (map
, 0, 1);
8435 name
= Fkeymap_prompt (map
);
8437 /* If we don't have any menus, just read a character normally. */
8438 if (!STRINGP (name
))
8441 #define PUSH_C_STR(str, listvar) \
8442 listvar = Fcons (make_unibyte_string (str, strlen (str)), listvar)
8444 /* Prompt string always starts with map's prompt, and a space. */
8445 prompt_strings
= Fcons (name
, prompt_strings
);
8446 PUSH_C_STR (": ", prompt_strings
);
8447 nlength
= SCHARS (name
) + 2;
8451 /* Present the documented bindings, a line at a time. */
8455 Lisp_Object menu_strings
= prompt_strings
;
8456 ptrdiff_t i
= nlength
;
8458 Lisp_Object orig_defn_macro
;
8460 /* Loop over elements of map. */
8465 /* FIXME: Use map_keymap to handle new keymap formats. */
8467 /* At end of map, wrap around if just starting,
8468 or end this line if already have something on it. */
8471 if (notfirst
|| nobindings
)
8477 /* Look at the next element of the map. */
8479 elt
= AREF (vector
, idx
);
8481 elt
= Fcar_safe (rest
);
8483 if (idx
< 0 && VECTORP (elt
))
8485 /* If we found a dense table in the keymap,
8486 advanced past it, but start scanning its contents. */
8487 rest
= Fcdr_safe (rest
);
8493 /* An ordinary element. */
8494 Lisp_Object event
, tem
;
8498 event
= Fcar_safe (elt
); /* alist */
8499 elt
= Fcdr_safe (elt
);
8503 XSETINT (event
, idx
); /* vector */
8506 /* Ignore the element if it has no prompt string. */
8507 if (INTEGERP (event
) && parse_menu_item (elt
, -1))
8509 /* True if the char to type matches the string. */
8511 Lisp_Object upcased_event
, downcased_event
;
8512 Lisp_Object desc
= Qnil
;
8514 = AREF (item_properties
, ITEM_PROPERTY_NAME
);
8516 upcased_event
= Fupcase (event
);
8517 downcased_event
= Fdowncase (event
);
8518 char_matches
= (XINT (upcased_event
) == SREF (s
, 0)
8519 || XINT (downcased_event
) == SREF (s
, 0));
8521 desc
= Fsingle_key_description (event
, Qnil
);
8523 #if 0 /* It is redundant to list the equivalent key bindings because
8524 the prefix is what the user has already typed. */
8526 = XVECTOR (item_properties
)->contents
[ITEM_PROPERTY_KEYEQ
];
8528 /* Insert equivalent keybinding. */
8529 s
= concat2 (s
, tem
);
8532 = AREF (item_properties
, ITEM_PROPERTY_TYPE
);
8533 if (EQ (tem
, QCradio
) || EQ (tem
, QCtoggle
))
8535 /* Insert button prefix. */
8536 Lisp_Object selected
8537 = AREF (item_properties
, ITEM_PROPERTY_SELECTED
);
8538 if (EQ (tem
, QCradio
))
8539 tem
= build_string (NILP (selected
) ? "(*) " : "( ) ");
8541 tem
= build_string (NILP (selected
) ? "[X] " : "[ ] ");
8542 s
= concat2 (tem
, s
);
8546 /* If we have room for the prompt string, add it to this line.
8547 If this is the first on the line, always add it. */
8548 if ((SCHARS (s
) + i
+ 2
8549 + (char_matches
? 0 : SCHARS (desc
) + 3))
8553 ptrdiff_t thiswidth
;
8555 /* Punctuate between strings. */
8558 PUSH_C_STR (", ", menu_strings
);
8564 /* If the char to type doesn't match the string's
8565 first char, explicitly show what char to type. */
8568 /* Add as much of string as fits. */
8569 thiswidth
= min (SCHARS (desc
), width
- i
);
8571 = Fcons (Fsubstring (desc
, make_number (0),
8572 make_number (thiswidth
)),
8575 PUSH_C_STR (" = ", menu_strings
);
8579 /* Add as much of string as fits. */
8580 thiswidth
= min (SCHARS (s
), width
- i
);
8582 = Fcons (Fsubstring (s
, make_number (0),
8583 make_number (thiswidth
)),
8589 /* If this element does not fit, end the line now,
8590 and save the element for the next line. */
8591 PUSH_C_STR ("...", menu_strings
);
8596 /* Move past this element. */
8597 if (idx
>= 0 && idx
+ 1 >= ASIZE (vector
))
8598 /* Handle reaching end of dense table. */
8603 rest
= Fcdr_safe (rest
);
8607 /* Prompt with that and read response. */
8608 message3_nolog (apply1 (intern ("concat"), Fnreverse (menu_strings
)));
8610 /* Make believe it's not a keyboard macro in case the help char
8611 is pressed. Help characters are not recorded because menu prompting
8612 is not used on replay. */
8613 orig_defn_macro
= KVAR (current_kboard
, defining_kbd_macro
);
8614 kset_defining_kbd_macro (current_kboard
, Qnil
);
8616 obj
= read_char (commandflag
, Qnil
, Qt
, 0, NULL
);
8617 while (BUFFERP (obj
));
8618 kset_defining_kbd_macro (current_kboard
, orig_defn_macro
);
8620 if (!INTEGERP (obj
) || XINT (obj
) == -2)
8623 if (! EQ (obj
, menu_prompt_more_char
)
8624 && (!INTEGERP (menu_prompt_more_char
)
8625 || ! EQ (obj
, make_number (Ctl (XINT (menu_prompt_more_char
))))))
8627 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
8628 store_kbd_macro_char (obj
);
8631 /* Help char - go round again. */
8635 /* Reading key sequences. */
8638 follow_key (Lisp_Object keymap
, Lisp_Object key
)
8640 return access_keymap (get_keymap (keymap
, 0, 1),
8645 active_maps (Lisp_Object first_event
)
8647 Lisp_Object position
= INTEGERP (first_event
) ? Qnil
: first_event
;
8648 return Fcons (Qkeymap
, Fcurrent_active_maps (Qt
, position
));
8651 /* Structure used to keep track of partial application of key remapping
8652 such as Vfunction_key_map and Vkey_translation_map. */
8653 typedef struct keyremap
8655 /* This is the map originally specified for this use. */
8657 /* This is a submap reached by looking up, in PARENT,
8658 the events from START to END. */
8660 /* Positions [START, END) in the key sequence buffer
8661 are the key that we have scanned so far.
8662 Those events are the ones that we will replace
8663 if PARENT maps them into a key sequence. */
8667 /* Lookup KEY in MAP.
8668 MAP is a keymap mapping keys to key vectors or functions.
8669 If the mapping is a function and DO_FUNCALL is true,
8670 the function is called with PROMPT as parameter and its return
8671 value is used as the return value of this function (after checking
8672 that it is indeed a vector). */
8675 access_keymap_keyremap (Lisp_Object map
, Lisp_Object key
, Lisp_Object prompt
,
8680 next
= access_keymap (map
, key
, 1, 0, 1);
8682 /* Handle a symbol whose function definition is a keymap
8684 if (SYMBOLP (next
) && !NILP (Ffboundp (next
))
8685 && (ARRAYP (XSYMBOL (next
)->function
)
8686 || KEYMAPP (XSYMBOL (next
)->function
)))
8687 next
= Fautoload_do_load (XSYMBOL (next
)->function
, next
, Qnil
);
8689 /* If the keymap gives a function, not an
8690 array, then call the function with one arg and use
8691 its value instead. */
8692 if (do_funcall
&& FUNCTIONP (next
))
8697 next
= call1 (next
, prompt
);
8698 /* If the function returned something invalid,
8699 barf--don't ignore it.
8700 (To ignore it safely, we would need to gcpro a bunch of
8701 other variables.) */
8702 if (! (VECTORP (next
) || STRINGP (next
)))
8703 error ("Function %s returns invalid key sequence",
8704 SSDATA (SYMBOL_NAME (tem
)));
8709 /* Do one step of the key remapping used for function-key-map and
8710 key-translation-map:
8711 KEYBUF is the buffer holding the input events.
8712 BUFSIZE is its maximum size.
8713 FKEY is a pointer to the keyremap structure to use.
8714 INPUT is the index of the last element in KEYBUF.
8715 DOIT if true says that the remapping can actually take place.
8716 DIFF is used to return the number of keys added/removed by the remapping.
8717 PARENT is the root of the keymap.
8718 PROMPT is the prompt to use if the remapping happens through a function.
8719 Return true if the remapping actually took place. */
8722 keyremap_step (Lisp_Object
*keybuf
, int bufsize
, volatile keyremap
*fkey
,
8723 int input
, bool doit
, int *diff
, Lisp_Object prompt
)
8725 Lisp_Object next
, key
;
8727 key
= keybuf
[fkey
->end
++];
8729 if (KEYMAPP (fkey
->parent
))
8730 next
= access_keymap_keyremap (fkey
->map
, key
, prompt
, doit
);
8734 /* If keybuf[fkey->start..fkey->end] is bound in the
8735 map and we're in a position to do the key remapping, replace it with
8736 the binding and restart with fkey->start at the end. */
8737 if ((VECTORP (next
) || STRINGP (next
)) && doit
)
8739 int len
= XFASTINT (Flength (next
));
8742 *diff
= len
- (fkey
->end
- fkey
->start
);
8744 if (bufsize
- input
<= *diff
)
8745 error ("Key sequence too long");
8747 /* Shift the keys that follow fkey->end. */
8749 for (i
= fkey
->end
; i
< input
; i
++)
8750 keybuf
[i
+ *diff
] = keybuf
[i
];
8752 for (i
= input
- 1; i
>= fkey
->end
; i
--)
8753 keybuf
[i
+ *diff
] = keybuf
[i
];
8754 /* Overwrite the old keys with the new ones. */
8755 for (i
= 0; i
< len
; i
++)
8756 keybuf
[fkey
->start
+ i
]
8757 = Faref (next
, make_number (i
));
8759 fkey
->start
= fkey
->end
+= *diff
;
8760 fkey
->map
= fkey
->parent
;
8765 fkey
->map
= get_keymap (next
, 0, 1);
8767 /* If we no longer have a bound suffix, try a new position for
8769 if (!CONSP (fkey
->map
))
8771 fkey
->end
= ++fkey
->start
;
8772 fkey
->map
= fkey
->parent
;
8778 test_undefined (Lisp_Object binding
)
8780 return (NILP (binding
)
8781 || EQ (binding
, Qundefined
)
8782 || (SYMBOLP (binding
)
8783 && EQ (Fcommand_remapping (binding
, Qnil
, Qnil
), Qundefined
)));
8786 /* Read a sequence of keys that ends with a non prefix character,
8787 storing it in KEYBUF, a buffer of size BUFSIZE.
8789 Return the length of the key sequence stored.
8790 Return -1 if the user rejected a command menu.
8792 Echo starting immediately unless `prompt' is 0.
8794 Where a key sequence ends depends on the currently active keymaps.
8795 These include any minor mode keymaps active in the current buffer,
8796 the current buffer's local map, and the global map.
8798 If a key sequence has no other bindings, we check Vfunction_key_map
8799 to see if some trailing subsequence might be the beginning of a
8800 function key's sequence. If so, we try to read the whole function
8801 key, and substitute its symbolic name into the key sequence.
8803 We ignore unbound `down-' mouse clicks. We turn unbound `drag-' and
8804 `double-' events into similar click events, if that would make them
8805 bound. We try to turn `triple-' events first into `double-' events,
8808 If we get a mouse click in a mode line, vertical divider, or other
8809 non-text area, we treat the click as if it were prefixed by the
8810 symbol denoting that area - `mode-line', `vertical-line', or
8813 If the sequence starts with a mouse click, we read the key sequence
8814 with respect to the buffer clicked on, not the current buffer.
8816 If the user switches frames in the midst of a key sequence, we put
8817 off the switch-frame event until later; the next call to
8818 read_char will return it.
8820 If FIX_CURRENT_BUFFER, we restore current_buffer
8821 from the selected window's buffer. */
8824 read_key_sequence (Lisp_Object
*keybuf
, int bufsize
, Lisp_Object prompt
,
8825 bool dont_downcase_last
, bool can_return_switch_frame
,
8826 bool fix_current_buffer
)
8828 ptrdiff_t count
= SPECPDL_INDEX ();
8830 /* How many keys there are in the current key sequence. */
8833 /* The length of the echo buffer when we started reading, and
8834 the length of this_command_keys when we started reading. */
8835 ptrdiff_t echo_start
IF_LINT (= 0);
8836 ptrdiff_t keys_start
;
8838 Lisp_Object current_binding
= Qnil
;
8839 Lisp_Object first_event
= Qnil
;
8841 /* Index of the first key that has no binding.
8842 It is useless to try fkey.start larger than that. */
8845 /* If t < mock_input, then KEYBUF[t] should be read as the next
8848 We use this to recover after recognizing a function key. Once we
8849 realize that a suffix of the current key sequence is actually a
8850 function key's escape sequence, we replace the suffix with the
8851 function key's binding from Vfunction_key_map. Now keybuf
8852 contains a new and different key sequence, so the echo area,
8853 this_command_keys, and the submaps and defs arrays are wrong. In
8854 this situation, we set mock_input to t, set t to 0, and jump to
8855 restart_sequence; the loop will read keys from keybuf up until
8856 mock_input, thus rebuilding the state; and then it will resume
8857 reading characters from the keyboard. */
8860 /* If the sequence is unbound in submaps[], then
8861 keybuf[fkey.start..fkey.end-1] is a prefix in Vfunction_key_map,
8862 and fkey.map is its binding.
8864 These might be > t, indicating that all function key scanning
8865 should hold off until t reaches them. We do this when we've just
8866 recognized a function key, to avoid searching for the function
8867 key's again in Vfunction_key_map. */
8870 /* Likewise, for key_translation_map and input-decode-map. */
8871 keyremap keytran
, indec
;
8873 /* True if we are trying to map a key by changing an upper-case
8874 letter to lower case, or a shifted function key to an unshifted
8876 bool shift_translated
= 0;
8878 /* If we receive a `switch-frame' or `select-window' event in the middle of
8879 a key sequence, we put it off for later.
8880 While we're reading, we keep the event here. */
8881 Lisp_Object delayed_switch_frame
;
8883 Lisp_Object original_uppercase
IF_LINT (= Qnil
);
8884 int original_uppercase_position
= -1;
8886 /* Gets around Microsoft compiler limitations. */
8889 struct buffer
*starting_buffer
;
8891 /* List of events for which a fake prefix key has been generated. */
8892 Lisp_Object fake_prefixed_keys
= Qnil
;
8894 struct gcpro gcpro1
;
8896 GCPRO1 (fake_prefixed_keys
);
8897 raw_keybuf_count
= 0;
8899 last_nonmenu_event
= Qnil
;
8901 delayed_switch_frame
= Qnil
;
8907 /* Install the string STR as the beginning of the string of
8908 echoing, so that it serves as a prompt for the next
8910 kset_echo_string (current_kboard
, prompt
);
8911 current_kboard
->echo_after_prompt
= SCHARS (prompt
);
8914 else if (cursor_in_echo_area
8915 && (FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
8916 && NILP (Fzerop (Vecho_keystrokes
)))
8917 /* This doesn't put in a dash if the echo buffer is empty, so
8918 you don't always see a dash hanging out in the minibuffer. */
8922 /* Record the initial state of the echo area and this_command_keys;
8923 we will need to restore them if we replay a key sequence. */
8925 echo_start
= echo_length ();
8926 keys_start
= this_command_key_count
;
8927 this_single_command_key_start
= keys_start
;
8929 /* We jump here when we need to reinitialize fkey and keytran; this
8930 happens if we switch keyboards between rescans. */
8931 replay_entire_sequence
:
8933 indec
.map
= indec
.parent
= KVAR (current_kboard
, Vinput_decode_map
);
8934 fkey
.map
= fkey
.parent
= KVAR (current_kboard
, Vlocal_function_key_map
);
8935 keytran
.map
= keytran
.parent
= Vkey_translation_map
;
8936 indec
.start
= indec
.end
= 0;
8937 fkey
.start
= fkey
.end
= 0;
8938 keytran
.start
= keytran
.end
= 0;
8940 /* We jump here when the key sequence has been thoroughly changed, and
8941 we need to rescan it starting from the beginning. When we jump here,
8942 keybuf[0..mock_input] holds the sequence we should reread. */
8945 starting_buffer
= current_buffer
;
8946 first_unbound
= bufsize
+ 1;
8948 /* Build our list of keymaps.
8949 If we recognize a function key and replace its escape sequence in
8950 keybuf with its symbol, or if the sequence starts with a mouse
8951 click and we need to switch buffers, we jump back here to rebuild
8952 the initial keymaps from the current buffer. */
8953 current_binding
= active_maps (first_event
);
8955 /* Start from the beginning in keybuf. */
8958 /* These are no-ops the first time through, but if we restart, they
8959 revert the echo area and this_command_keys to their original state. */
8960 this_command_key_count
= keys_start
;
8961 if (INTERACTIVE
&& t
< mock_input
)
8962 echo_truncate (echo_start
);
8964 /* If the best binding for the current key sequence is a keymap, or
8965 we may be looking at a function key's escape sequence, keep on
8967 while (!NILP (current_binding
)
8968 /* Keep reading as long as there's a prefix binding. */
8969 ? KEYMAPP (current_binding
)
8970 /* Don't return in the middle of a possible function key sequence,
8971 if the only bindings we found were via case conversion.
8972 Thus, if ESC O a has a function-key-map translation
8973 and ESC o has a binding, don't return after ESC O,
8974 so that we can translate ESC O plus the next character. */
8975 : (/* indec.start < t || fkey.start < t || */ keytran
.start
< t
))
8978 bool used_mouse_menu
= 0;
8980 /* Where the last real key started. If we need to throw away a
8981 key that has expanded into more than one element of keybuf
8982 (say, a mouse click on the mode line which is being treated
8983 as [mode-line (mouse-...)], then we backtrack to this point
8985 int last_real_key_start
;
8987 /* These variables are analogous to echo_start and keys_start;
8988 while those allow us to restart the entire key sequence,
8989 echo_local_start and keys_local_start allow us to throw away
8991 ptrdiff_t echo_local_start
IF_LINT (= 0);
8992 int keys_local_start
;
8993 Lisp_Object new_binding
;
8995 eassert (indec
.end
== t
|| (indec
.end
> t
&& indec
.end
<= mock_input
));
8996 eassert (indec
.start
<= indec
.end
);
8997 eassert (fkey
.start
<= fkey
.end
);
8998 eassert (keytran
.start
<= keytran
.end
);
8999 /* key-translation-map is applied *after* function-key-map
9000 which is itself applied *after* input-decode-map. */
9001 eassert (fkey
.end
<= indec
.start
);
9002 eassert (keytran
.end
<= fkey
.start
);
9004 if (/* first_unbound < indec.start && first_unbound < fkey.start && */
9005 first_unbound
< keytran
.start
)
9006 { /* The prefix upto first_unbound has no binding and has
9007 no translation left to do either, so we know it's unbound.
9008 If we don't stop now, we risk staying here indefinitely
9009 (if the user keeps entering fkey or keytran prefixes
9010 like C-c ESC ESC ESC ESC ...) */
9012 for (i
= first_unbound
+ 1; i
< t
; i
++)
9013 keybuf
[i
- first_unbound
- 1] = keybuf
[i
];
9014 mock_input
= t
- first_unbound
- 1;
9015 indec
.end
= indec
.start
-= first_unbound
+ 1;
9016 indec
.map
= indec
.parent
;
9017 fkey
.end
= fkey
.start
-= first_unbound
+ 1;
9018 fkey
.map
= fkey
.parent
;
9019 keytran
.end
= keytran
.start
-= first_unbound
+ 1;
9020 keytran
.map
= keytran
.parent
;
9021 goto replay_sequence
;
9025 error ("Key sequence too long");
9028 echo_local_start
= echo_length ();
9029 keys_local_start
= this_command_key_count
;
9032 /* These are no-ops, unless we throw away a keystroke below and
9033 jumped back up to replay_key; in that case, these restore the
9034 variables to their original state, allowing us to replay the
9036 if (INTERACTIVE
&& t
< mock_input
)
9037 echo_truncate (echo_local_start
);
9038 this_command_key_count
= keys_local_start
;
9040 /* By default, assume each event is "real". */
9041 last_real_key_start
= t
;
9043 /* Does mock_input indicate that we are re-reading a key sequence? */
9047 add_command_key (key
);
9048 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9049 && NILP (Fzerop (Vecho_keystrokes
))
9050 && current_kboard
->immediate_echo
)
9057 /* If not, we should actually read a character. */
9061 KBOARD
*interrupted_kboard
= current_kboard
;
9062 struct frame
*interrupted_frame
= SELECTED_FRAME ();
9063 key
= read_char (NILP (prompt
),
9064 current_binding
, last_nonmenu_event
,
9065 &used_mouse_menu
, NULL
);
9066 if ((INTEGERP (key
) && XINT (key
) == -2) /* wrong_kboard_jmpbuf */
9067 /* When switching to a new tty (with a new keyboard),
9068 read_char returns the new buffer, rather than -2
9069 (Bug#5095). This is because `terminal-init-xterm'
9070 calls read-char, which eats the wrong_kboard_jmpbuf
9071 return. Any better way to fix this? -- cyd */
9072 || (interrupted_kboard
!= current_kboard
))
9077 for (k
= all_kboards
; k
; k
= k
->next_kboard
)
9078 if (k
== interrupted_kboard
)
9083 /* Don't touch interrupted_kboard when it's been
9085 delayed_switch_frame
= Qnil
;
9086 goto replay_entire_sequence
;
9089 if (!NILP (delayed_switch_frame
))
9092 (interrupted_kboard
,
9093 Fcons (delayed_switch_frame
,
9094 KVAR (interrupted_kboard
, kbd_queue
)));
9095 delayed_switch_frame
= Qnil
;
9100 (interrupted_kboard
,
9101 Fcons (keybuf
[--t
], KVAR (interrupted_kboard
, kbd_queue
)));
9103 /* If the side queue is non-empty, ensure it begins with a
9104 switch-frame, so we'll replay it in the right context. */
9105 if (CONSP (KVAR (interrupted_kboard
, kbd_queue
))
9106 && (key
= XCAR (KVAR (interrupted_kboard
, kbd_queue
)),
9107 !(EVENT_HAS_PARAMETERS (key
)
9108 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)),
9112 XSETFRAME (frame
, interrupted_frame
);
9114 (interrupted_kboard
,
9115 Fcons (make_lispy_switch_frame (frame
),
9116 KVAR (interrupted_kboard
, kbd_queue
)));
9119 goto replay_entire_sequence
;
9123 /* read_char returns t when it shows a menu and the user rejects it.
9127 unbind_to (count
, Qnil
);
9132 /* read_char returns -1 at the end of a macro.
9133 Emacs 18 handles this by returning immediately with a
9134 zero, so that's what we'll do. */
9135 if (INTEGERP (key
) && XINT (key
) == -1)
9138 /* The Microsoft C compiler can't handle the goto that
9144 /* If the current buffer has been changed from under us, the
9145 keymap may have changed, so replay the sequence. */
9148 timer_resume_idle ();
9151 /* Reset the current buffer from the selected window
9152 in case something changed the former and not the latter.
9153 This is to be more consistent with the behavior
9154 of the command_loop_1. */
9155 if (fix_current_buffer
)
9157 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9159 if (XBUFFER (XWINDOW (selected_window
)->buffer
)
9161 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9164 goto replay_sequence
;
9167 /* If we have a quit that was typed in another frame, and
9168 quit_throw_to_read_char switched buffers,
9169 replay to get the right keymap. */
9171 && XINT (key
) == quit_char
9172 && current_buffer
!= starting_buffer
)
9175 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9180 goto replay_sequence
;
9185 if (EVENT_HAS_PARAMETERS (key
)
9186 /* Either a `switch-frame' or a `select-window' event. */
9187 && EQ (EVENT_HEAD_KIND (EVENT_HEAD (key
)), Qswitch_frame
))
9189 /* If we're at the beginning of a key sequence, and the caller
9190 says it's okay, go ahead and return this event. If we're
9191 in the midst of a key sequence, delay it until the end. */
9192 if (t
> 0 || !can_return_switch_frame
)
9194 delayed_switch_frame
= key
;
9199 if (NILP (first_event
))
9202 /* Even if first_event does not specify a particular
9203 window/position, it's important to recompute the maps here
9204 since a long time might have passed since we entered
9205 read_key_sequence, and a timer (or process-filter or
9206 special-event-map, ...) might have switched the current buffer
9207 or the selected window from under us in the mean time. */
9208 if (fix_current_buffer
9209 && (XBUFFER (XWINDOW (selected_window
)->buffer
)
9211 Fset_buffer (XWINDOW (selected_window
)->buffer
);
9212 current_binding
= active_maps (first_event
);
9216 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9220 /* Clicks in non-text areas get prefixed by the symbol
9221 in their CHAR-ADDRESS field. For example, a click on
9222 the mode line is prefixed by the symbol `mode-line'.
9224 Furthermore, key sequences beginning with mouse clicks
9225 are read using the keymaps of the buffer clicked on, not
9226 the current buffer. So we may have to switch the buffer
9229 When we turn one event into two events, we must make sure
9230 that neither of the two looks like the original--so that,
9231 if we replay the events, they won't be expanded again.
9232 If not for this, such reexpansion could happen either here
9233 or when user programs play with this-command-keys. */
9234 if (EVENT_HAS_PARAMETERS (key
))
9236 Lisp_Object kind
= EVENT_HEAD_KIND (EVENT_HEAD (key
));
9237 if (EQ (kind
, Qmouse_click
))
9239 Lisp_Object window
= POSN_WINDOW (EVENT_START (key
));
9240 Lisp_Object posn
= POSN_POSN (EVENT_START (key
));
9243 || (!NILP (fake_prefixed_keys
)
9244 && !NILP (Fmemq (key
, fake_prefixed_keys
))))
9246 /* We're looking a second time at an event for which
9247 we generated a fake prefix key. Set
9248 last_real_key_start appropriately. */
9250 last_real_key_start
= t
- 1;
9253 if (last_real_key_start
== 0)
9255 /* Key sequences beginning with mouse clicks are
9256 read using the keymaps in the buffer clicked on,
9257 not the current buffer. If we're at the
9258 beginning of a key sequence, switch buffers. */
9259 if (WINDOWP (window
)
9260 && BUFFERP (XWINDOW (window
)->buffer
)
9261 && XBUFFER (XWINDOW (window
)->buffer
) != current_buffer
)
9263 ASET (raw_keybuf
, raw_keybuf_count
, key
);
9268 /* Arrange to go back to the original buffer once we're
9269 done reading the key sequence. Note that we can't
9270 use save_excursion_{save,restore} here, because they
9271 save point as well as the current buffer; we don't
9272 want to save point, because redisplay may change it,
9273 to accommodate a Fset_window_start or something. We
9274 don't want to do this at the top of the function,
9275 because we may get input from a subprocess which
9276 wants to change the selected window and stuff (say,
9278 record_unwind_current_buffer ();
9280 if (! FRAME_LIVE_P (XFRAME (selected_frame
)))
9282 set_buffer_internal (XBUFFER (XWINDOW (window
)->buffer
));
9283 goto replay_sequence
;
9287 /* Expand mode-line and scroll-bar events into two events:
9288 use posn as a fake prefix key. */
9290 && (NILP (fake_prefixed_keys
)
9291 || NILP (Fmemq (key
, fake_prefixed_keys
))))
9293 if (bufsize
- t
<= 1)
9294 error ("Key sequence too long");
9297 keybuf
[t
+ 1] = key
;
9300 /* Record that a fake prefix key has been generated
9301 for KEY. Don't modify the event; this would
9302 prevent proper action when the event is pushed
9303 back into unread-command-events. */
9304 fake_prefixed_keys
= Fcons (key
, fake_prefixed_keys
);
9308 else if (CONSP (XCDR (key
))
9309 && CONSP (EVENT_START (key
))
9310 && CONSP (XCDR (EVENT_START (key
))))
9314 posn
= POSN_POSN (EVENT_START (key
));
9315 /* Handle menu-bar events:
9316 insert the dummy prefix event `menu-bar'. */
9317 if (EQ (posn
, Qmenu_bar
) || EQ (posn
, Qtool_bar
))
9319 if (bufsize
- t
<= 1)
9320 error ("Key sequence too long");
9322 keybuf
[t
+ 1] = key
;
9324 /* Zap the position in key, so we know that we've
9325 expanded it, and don't try to do so again. */
9326 POSN_SET_POSN (EVENT_START (key
),
9327 Fcons (posn
, Qnil
));
9330 goto replay_sequence
;
9332 else if (CONSP (posn
))
9334 /* We're looking at the second event of a
9335 sequence which we expanded before. Set
9336 last_real_key_start appropriately. */
9337 if (last_real_key_start
== t
&& t
> 0)
9338 last_real_key_start
= t
- 1;
9343 /* We have finally decided that KEY is something we might want
9345 new_binding
= follow_key (current_binding
, key
);
9347 /* If KEY wasn't bound, we'll try some fallbacks. */
9348 if (!NILP (new_binding
))
9349 /* This is needed for the following scenario:
9350 event 0: a down-event that gets dropped by calling replay_key.
9351 event 1: some normal prefix like C-h.
9352 After event 0, first_unbound is 0, after event 1 indec.start,
9353 fkey.start, and keytran.start are all 1, so when we see that
9354 C-h is bound, we need to update first_unbound. */
9355 first_unbound
= max (t
+ 1, first_unbound
);
9360 /* Remember the position to put an upper bound on indec.start. */
9361 first_unbound
= min (t
, first_unbound
);
9363 head
= EVENT_HEAD (key
);
9364 if (help_char_p (head
) && t
> 0)
9366 read_key_sequence_cmd
= Vprefix_help_command
;
9368 last_nonmenu_event
= key
;
9369 /* The Microsoft C compiler can't handle the goto that
9377 Lisp_Object breakdown
;
9380 breakdown
= parse_modifiers (head
);
9381 modifiers
= XINT (XCAR (XCDR (breakdown
)));
9382 /* Attempt to reduce an unbound mouse event to a simpler
9383 event that is bound:
9384 Drags reduce to clicks.
9385 Double-clicks reduce to clicks.
9386 Triple-clicks reduce to double-clicks, then to clicks.
9387 Down-clicks are eliminated.
9388 Double-downs reduce to downs, then are eliminated.
9389 Triple-downs reduce to double-downs, then to downs,
9390 then are eliminated. */
9391 if (modifiers
& (down_modifier
| drag_modifier
9392 | double_modifier
| triple_modifier
))
9394 while (modifiers
& (down_modifier
| drag_modifier
9395 | double_modifier
| triple_modifier
))
9397 Lisp_Object new_head
, new_click
;
9398 if (modifiers
& triple_modifier
)
9399 modifiers
^= (double_modifier
| triple_modifier
);
9400 else if (modifiers
& double_modifier
)
9401 modifiers
&= ~double_modifier
;
9402 else if (modifiers
& drag_modifier
)
9403 modifiers
&= ~drag_modifier
;
9406 /* Dispose of this `down' event by simply jumping
9407 back to replay_key, to get another event.
9409 Note that if this event came from mock input,
9410 then just jumping back to replay_key will just
9411 hand it to us again. So we have to wipe out any
9414 We could delete keybuf[t] and shift everything
9415 after that to the left by one spot, but we'd also
9416 have to fix up any variable that points into
9417 keybuf, and shifting isn't really necessary
9420 Adding prefixes for non-textual mouse clicks
9421 creates two characters of mock input, and both
9422 must be thrown away. If we're only looking at
9423 the prefix now, we can just jump back to
9424 replay_key. On the other hand, if we've already
9425 processed the prefix, and now the actual click
9426 itself is giving us trouble, then we've lost the
9427 state of the keymaps we want to backtrack to, and
9428 we need to replay the whole sequence to rebuild
9431 Beyond that, only function key expansion could
9432 create more than two keys, but that should never
9433 generate mouse events, so it's okay to zero
9434 mock_input in that case too.
9436 FIXME: The above paragraph seems just plain
9437 wrong, if you consider things like
9438 xterm-mouse-mode. -stef
9440 Isn't this just the most wonderful code ever? */
9442 /* If mock_input > t + 1, the above simplification
9443 will actually end up dropping keys on the floor.
9444 This is probably OK for now, but even
9445 if mock_input <= t + 1, we need to adjust indec,
9447 Typical case [header-line down-mouse-N]:
9448 mock_input = 2, t = 1, fkey.end = 1,
9449 last_real_key_start = 0. */
9450 if (indec
.end
> last_real_key_start
)
9452 indec
.end
= indec
.start
9453 = min (last_real_key_start
, indec
.start
);
9454 indec
.map
= indec
.parent
;
9455 if (fkey
.end
> last_real_key_start
)
9457 fkey
.end
= fkey
.start
9458 = min (last_real_key_start
, fkey
.start
);
9459 fkey
.map
= fkey
.parent
;
9460 if (keytran
.end
> last_real_key_start
)
9462 keytran
.end
= keytran
.start
9463 = min (last_real_key_start
, keytran
.start
);
9464 keytran
.map
= keytran
.parent
;
9468 if (t
== last_real_key_start
)
9475 mock_input
= last_real_key_start
;
9476 goto replay_sequence
;
9481 = apply_modifiers (modifiers
, XCAR (breakdown
));
9483 = Fcons (new_head
, Fcons (EVENT_START (key
), Qnil
));
9485 /* Look for a binding for this new key. */
9486 new_binding
= follow_key (current_binding
, new_click
);
9488 /* If that click is bound, go for it. */
9489 if (!NILP (new_binding
))
9491 current_binding
= new_binding
;
9495 /* Otherwise, we'll leave key set to the drag event. */
9500 current_binding
= new_binding
;
9503 /* Normally, last_nonmenu_event gets the previous key we read.
9504 But when a mouse popup menu is being used,
9505 we don't update last_nonmenu_event; it continues to hold the mouse
9506 event that preceded the first level of menu. */
9507 if (!used_mouse_menu
)
9508 last_nonmenu_event
= key
;
9510 /* Record what part of this_command_keys is the current key sequence. */
9511 this_single_command_key_start
= this_command_key_count
- t
;
9513 /* Look for this sequence in input-decode-map.
9514 Scan from indec.end until we find a bound suffix. */
9515 while (indec
.end
< t
)
9517 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9521 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9522 done
= keyremap_step (keybuf
, bufsize
, &indec
, max (t
, mock_input
),
9527 mock_input
= diff
+ max (t
, mock_input
);
9528 goto replay_sequence
;
9532 if (!KEYMAPP (current_binding
)
9533 && !test_undefined (current_binding
)
9534 && indec
.start
>= t
)
9535 /* There is a binding and it's not a prefix.
9536 (and it doesn't have any input-decode-map translation pending).
9537 There is thus no function-key in this sequence.
9538 Moving fkey.start is important in this case to allow keytran.start
9539 to go over the sequence before we return (since we keep the
9540 invariant that keytran.end <= fkey.start). */
9543 (fkey
.start
= fkey
.end
= t
, fkey
.map
= fkey
.parent
);
9546 /* If the sequence is unbound, see if we can hang a function key
9547 off the end of it. */
9548 /* Continue scan from fkey.end until we find a bound suffix. */
9549 while (fkey
.end
< indec
.start
)
9551 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9555 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9556 done
= keyremap_step (keybuf
, bufsize
, &fkey
,
9557 max (t
, mock_input
),
9558 /* If there's a binding (i.e.
9559 first_binding >= nmaps) we don't want
9560 to apply this function-key-mapping. */
9562 && (test_undefined (current_binding
)),
9567 mock_input
= diff
+ max (t
, mock_input
);
9568 /* Adjust the input-decode-map counters. */
9570 indec
.start
+= diff
;
9572 goto replay_sequence
;
9576 /* Look for this sequence in key-translation-map.
9577 Scan from keytran.end until we find a bound suffix. */
9578 while (keytran
.end
< fkey
.start
)
9580 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
9584 GCPRO4 (indec
.map
, fkey
.map
, keytran
.map
, delayed_switch_frame
);
9585 done
= keyremap_step (keybuf
, bufsize
, &keytran
, max (t
, mock_input
),
9590 mock_input
= diff
+ max (t
, mock_input
);
9591 /* Adjust the function-key-map and input-decode-map counters. */
9593 indec
.start
+= diff
;
9597 goto replay_sequence
;
9601 /* If KEY is not defined in any of the keymaps,
9602 and cannot be part of a function key or translation,
9603 and is an upper case letter
9604 use the corresponding lower-case letter instead. */
9605 if (NILP (current_binding
)
9606 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
9608 && ((CHARACTERP (make_number (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9609 && uppercasep (XINT (key
) & ~CHAR_MODIFIER_MASK
))
9610 || (XINT (key
) & shift_modifier
)))
9612 Lisp_Object new_key
;
9614 original_uppercase
= key
;
9615 original_uppercase_position
= t
- 1;
9617 if (XINT (key
) & shift_modifier
)
9618 XSETINT (new_key
, XINT (key
) & ~shift_modifier
);
9620 XSETINT (new_key
, (downcase (XINT (key
) & ~CHAR_MODIFIER_MASK
)
9621 | (XINT (key
) & CHAR_MODIFIER_MASK
)));
9623 /* We have to do this unconditionally, regardless of whether
9624 the lower-case char is defined in the keymaps, because they
9625 might get translated through function-key-map. */
9626 keybuf
[t
- 1] = new_key
;
9627 mock_input
= max (t
, mock_input
);
9628 shift_translated
= 1;
9630 goto replay_sequence
;
9632 /* If KEY is not defined in any of the keymaps,
9633 and cannot be part of a function key or translation,
9634 and is a shifted function key,
9635 use the corresponding unshifted function key instead. */
9636 if (NILP (current_binding
)
9637 && /* indec.start >= t && fkey.start >= t && */ keytran
.start
>= t
)
9639 Lisp_Object breakdown
= parse_modifiers (key
);
9641 = CONSP (breakdown
) ? (XINT (XCAR (XCDR (breakdown
)))) : 0;
9643 if (modifiers
& shift_modifier
9644 /* Treat uppercase keys as shifted. */
9646 && (KEY_TO_CHAR (key
)
9647 < XCHAR_TABLE (BVAR (current_buffer
, downcase_table
))->header
.size
)
9648 && uppercasep (KEY_TO_CHAR (key
))))
9651 = (modifiers
& shift_modifier
9652 ? apply_modifiers (modifiers
& ~shift_modifier
,
9654 : make_number (downcase (KEY_TO_CHAR (key
)) | modifiers
));
9656 original_uppercase
= key
;
9657 original_uppercase_position
= t
- 1;
9659 /* We have to do this unconditionally, regardless of whether
9660 the lower-case char is defined in the keymaps, because they
9661 might get translated through function-key-map. */
9662 keybuf
[t
- 1] = new_key
;
9663 mock_input
= max (t
, mock_input
);
9664 /* Reset fkey (and consequently keytran) to apply
9665 function-key-map on the result, so that S-backspace is
9666 correctly mapped to DEL (via backspace). OTOH,
9667 input-decode-map doesn't need to go through it again. */
9668 fkey
.start
= fkey
.end
= 0;
9669 keytran
.start
= keytran
.end
= 0;
9670 shift_translated
= 1;
9672 goto replay_sequence
;
9677 read_key_sequence_cmd
= current_binding
;
9678 read_key_sequence_remapped
9679 /* Remap command through active keymaps.
9680 Do the remapping here, before the unbind_to so it uses the keymaps
9681 of the appropriate buffer. */
9682 = SYMBOLP (read_key_sequence_cmd
)
9683 ? Fcommand_remapping (read_key_sequence_cmd
, Qnil
, Qnil
)
9686 unread_switch_frame
= delayed_switch_frame
;
9687 unbind_to (count
, Qnil
);
9689 /* Don't downcase the last character if the caller says don't.
9690 Don't downcase it if the result is undefined, either. */
9691 if ((dont_downcase_last
|| NILP (current_binding
))
9693 && t
- 1 == original_uppercase_position
)
9695 keybuf
[t
- 1] = original_uppercase
;
9696 shift_translated
= 0;
9699 if (shift_translated
)
9700 Vthis_command_keys_shift_translated
= Qt
;
9702 /* Occasionally we fabricate events, perhaps by expanding something
9703 according to function-key-map, or by adding a prefix symbol to a
9704 mouse click in the scroll bar or modeline. In this cases, return
9705 the entire generated key sequence, even if we hit an unbound
9706 prefix or a definition before the end. This means that you will
9707 be able to push back the event properly, and also means that
9708 read-key-sequence will always return a logical unit.
9711 for (; t
< mock_input
; t
++)
9713 if ((FLOATP (Vecho_keystrokes
) || INTEGERP (Vecho_keystrokes
))
9714 && NILP (Fzerop (Vecho_keystrokes
)))
9715 echo_char (keybuf
[t
]);
9716 add_command_key (keybuf
[t
]);
9723 DEFUN ("read-key-sequence", Fread_key_sequence
, Sread_key_sequence
, 1, 5, 0,
9724 doc
: /* Read a sequence of keystrokes and return as a string or vector.
9725 The sequence is sufficient to specify a non-prefix command in the
9726 current local and global maps.
9728 First arg PROMPT is a prompt string. If nil, do not prompt specially.
9729 Second (optional) arg CONTINUE-ECHO, if non-nil, means this key echos
9730 as a continuation of the previous key.
9732 The third (optional) arg DONT-DOWNCASE-LAST, if non-nil, means do not
9733 convert the last event to lower case. (Normally any upper case event
9734 is converted to lower case if the original event is undefined and the lower
9735 case equivalent is defined.) A non-nil value is appropriate for reading
9736 a key sequence to be defined.
9738 A C-g typed while in this function is treated like any other character,
9739 and `quit-flag' is not set.
9741 If the key sequence starts with a mouse click, then the sequence is read
9742 using the keymaps of the buffer of the window clicked in, not the buffer
9743 of the selected window as normal.
9745 `read-key-sequence' drops unbound button-down events, since you normally
9746 only care about the click or drag events which follow them. If a drag
9747 or multi-click event is unbound, but the corresponding click event would
9748 be bound, `read-key-sequence' turns the event into a click event at the
9749 drag's starting position. This means that you don't have to distinguish
9750 between click and drag, double, or triple events unless you want to.
9752 `read-key-sequence' prefixes mouse events on mode lines, the vertical
9753 lines separating windows, and scroll bars with imaginary keys
9754 `mode-line', `vertical-line', and `vertical-scroll-bar'.
9756 Optional fourth argument CAN-RETURN-SWITCH-FRAME non-nil means that this
9757 function will process a switch-frame event if the user switches frames
9758 before typing anything. If the user switches frames in the middle of a
9759 key sequence, or at the start of the sequence but CAN-RETURN-SWITCH-FRAME
9760 is nil, then the event will be put off until after the current key sequence.
9762 `read-key-sequence' checks `function-key-map' for function key
9763 sequences, where they wouldn't conflict with ordinary bindings. See
9764 `function-key-map' for more details.
9766 The optional fifth argument CMD-LOOP, if non-nil, means
9767 that this key sequence is being read by something that will
9768 read commands one after another. It should be nil if the caller
9769 will read just one key sequence. */)
9770 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9772 Lisp_Object keybuf
[30];
9774 struct gcpro gcpro1
;
9775 ptrdiff_t count
= SPECPDL_INDEX ();
9778 CHECK_STRING (prompt
);
9781 specbind (Qinput_method_exit_on_first_char
,
9782 (NILP (cmd_loop
) ? Qt
: Qnil
));
9783 specbind (Qinput_method_use_echo_area
,
9784 (NILP (cmd_loop
) ? Qt
: Qnil
));
9786 memset (keybuf
, 0, sizeof keybuf
);
9788 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9790 if (NILP (continue_echo
))
9792 this_command_key_count
= 0;
9793 this_command_key_count_reset
= 0;
9794 this_single_command_key_start
= 0;
9797 #ifdef HAVE_WINDOW_SYSTEM
9798 if (display_hourglass_p
)
9799 cancel_hourglass ();
9802 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9803 prompt
, ! NILP (dont_downcase_last
),
9804 ! NILP (can_return_switch_frame
), 0);
9806 #if 0 /* The following is fine for code reading a key sequence and
9807 then proceeding with a lengthy computation, but it's not good
9808 for code reading keys in a loop, like an input method. */
9809 #ifdef HAVE_WINDOW_SYSTEM
9810 if (display_hourglass_p
)
9821 return unbind_to (count
, make_event_array (i
, keybuf
));
9824 DEFUN ("read-key-sequence-vector", Fread_key_sequence_vector
,
9825 Sread_key_sequence_vector
, 1, 5, 0,
9826 doc
: /* Like `read-key-sequence' but always return a vector. */)
9827 (Lisp_Object prompt
, Lisp_Object continue_echo
, Lisp_Object dont_downcase_last
, Lisp_Object can_return_switch_frame
, Lisp_Object cmd_loop
)
9829 Lisp_Object keybuf
[30];
9831 struct gcpro gcpro1
;
9832 ptrdiff_t count
= SPECPDL_INDEX ();
9835 CHECK_STRING (prompt
);
9838 specbind (Qinput_method_exit_on_first_char
,
9839 (NILP (cmd_loop
) ? Qt
: Qnil
));
9840 specbind (Qinput_method_use_echo_area
,
9841 (NILP (cmd_loop
) ? Qt
: Qnil
));
9843 memset (keybuf
, 0, sizeof keybuf
);
9845 gcpro1
.nvars
= (sizeof keybuf
/ sizeof (keybuf
[0]));
9847 if (NILP (continue_echo
))
9849 this_command_key_count
= 0;
9850 this_command_key_count_reset
= 0;
9851 this_single_command_key_start
= 0;
9854 #ifdef HAVE_WINDOW_SYSTEM
9855 if (display_hourglass_p
)
9856 cancel_hourglass ();
9859 i
= read_key_sequence (keybuf
, (sizeof keybuf
/ sizeof (keybuf
[0])),
9860 prompt
, ! NILP (dont_downcase_last
),
9861 ! NILP (can_return_switch_frame
), 0);
9863 #ifdef HAVE_WINDOW_SYSTEM
9864 if (display_hourglass_p
)
9874 return unbind_to (count
, Fvector (i
, keybuf
));
9877 DEFUN ("command-execute", Fcommand_execute
, Scommand_execute
, 1, 4, 0,
9878 doc
: /* Execute CMD as an editor command.
9879 CMD must be a symbol that satisfies the `commandp' predicate.
9880 Optional second arg RECORD-FLAG non-nil
9881 means unconditionally put this command in the variable `command-history'.
9882 Otherwise, that is done only if an arg is read using the minibuffer.
9883 The argument KEYS specifies the value to use instead of (this-command-keys)
9884 when reading the arguments; if it is nil, (this-command-keys) is used.
9885 The argument SPECIAL, if non-nil, means that this command is executing
9886 a special event, so ignore the prefix argument and don't clear it. */)
9887 (Lisp_Object cmd
, Lisp_Object record_flag
, Lisp_Object keys
, Lisp_Object special
)
9889 register Lisp_Object final
;
9890 register Lisp_Object tem
;
9891 Lisp_Object prefixarg
;
9893 debug_on_next_call
= 0;
9897 prefixarg
= KVAR (current_kboard
, Vprefix_arg
);
9898 Vcurrent_prefix_arg
= prefixarg
;
9899 kset_prefix_arg (current_kboard
, Qnil
);
9906 tem
= Fget (cmd
, Qdisabled
);
9909 tem
= Fsymbol_value (Qdisabled_command_function
);
9911 return Frun_hooks (1, &Qdisabled_command_function
);
9917 final
= Findirect_function (cmd
, Qnil
);
9919 if (CONSP (final
) && (tem
= Fcar (final
), EQ (tem
, Qautoload
)))
9921 struct gcpro gcpro1
, gcpro2
;
9923 GCPRO2 (cmd
, prefixarg
);
9924 Fautoload_do_load (final
, cmd
, Qnil
);
9931 if (STRINGP (final
) || VECTORP (final
))
9933 /* If requested, place the macro in the command history. For
9934 other sorts of commands, call-interactively takes care of
9936 if (!NILP (record_flag
))
9939 = Fcons (Fcons (Qexecute_kbd_macro
,
9940 Fcons (final
, Fcons (prefixarg
, Qnil
))),
9943 /* Don't keep command history around forever. */
9944 if (NUMBERP (Vhistory_length
) && XINT (Vhistory_length
) > 0)
9946 tem
= Fnthcdr (Vhistory_length
, Vcommand_history
);
9948 XSETCDR (tem
, Qnil
);
9952 return Fexecute_kbd_macro (final
, prefixarg
, Qnil
);
9955 if (CONSP (final
) || SUBRP (final
) || COMPILEDP (final
))
9956 /* Don't call Fcall_interactively directly because we want to make
9957 sure the backtrace has an entry for `call-interactively'.
9958 For the same reason, pass `cmd' rather than `final'. */
9959 return call3 (Qcall_interactively
, cmd
, record_flag
, keys
);
9966 /* Return true if input events are pending. */
9969 detect_input_pending (void)
9971 return input_pending
|| get_input_pending (0);
9974 /* Return true if input events other than mouse movements are
9978 detect_input_pending_ignore_squeezables (void)
9980 return input_pending
|| get_input_pending (READABLE_EVENTS_IGNORE_SQUEEZABLES
);
9983 /* Return true if input events are pending, and run any pending timers. */
9986 detect_input_pending_run_timers (bool do_display
)
9988 unsigned old_timers_run
= timers_run
;
9991 get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
);
9993 if (old_timers_run
!= timers_run
&& do_display
)
9995 redisplay_preserve_echo_area (8);
9996 /* The following fixes a bug when using lazy-lock with
9997 lazy-lock-defer-on-the-fly set to t, i.e. when fontifying
9998 from an idle timer function. The symptom of the bug is that
9999 the cursor sometimes doesn't become visible until the next X
10000 event is processed. --gerd. */
10002 Lisp_Object tail
, frame
;
10003 FOR_EACH_FRAME (tail
, frame
)
10004 if (FRAME_RIF (XFRAME (frame
)))
10005 FRAME_RIF (XFRAME (frame
))->flush_display (XFRAME (frame
));
10009 return input_pending
;
10012 /* This is called in some cases before a possible quit.
10013 It cases the next call to detect_input_pending to recompute input_pending.
10014 So calling this function unnecessarily can't do any harm. */
10017 clear_input_pending (void)
10022 /* Return true if there are pending requeued events.
10023 This isn't used yet. The hope is to make wait_reading_process_output
10024 call it, and return if it runs Lisp code that unreads something.
10025 The problem is, kbd_buffer_get_event needs to be fixed to know what
10026 to do in that case. It isn't trivial. */
10029 requeued_events_pending_p (void)
10031 return (!NILP (Vunread_command_events
));
10035 DEFUN ("input-pending-p", Finput_pending_p
, Sinput_pending_p
, 0, 0, 0,
10036 doc
: /* Return t if command input is currently available with no wait.
10037 Actually, the value is nil only if we can be sure that no input is available;
10038 if there is a doubt, the value is t. */)
10041 if (!NILP (Vunread_command_events
)
10042 || !NILP (Vunread_post_input_method_events
)
10043 || !NILP (Vunread_input_method_events
))
10046 /* Process non-user-visible events (Bug#10195). */
10047 process_special_events ();
10049 return (get_input_pending (READABLE_EVENTS_DO_TIMERS_NOW
10050 | READABLE_EVENTS_FILTER_EVENTS
)
10054 DEFUN ("recent-keys", Frecent_keys
, Srecent_keys
, 0, 0, 0,
10055 doc
: /* Return vector of last 300 events, not counting those from keyboard macros. */)
10058 Lisp_Object
*keys
= XVECTOR (recent_keys
)->contents
;
10061 if (total_keys
< NUM_RECENT_KEYS
)
10062 return Fvector (total_keys
, keys
);
10065 val
= Fvector (NUM_RECENT_KEYS
, keys
);
10066 vcopy (val
, 0, keys
+ recent_keys_index
,
10067 NUM_RECENT_KEYS
- recent_keys_index
);
10068 vcopy (val
, NUM_RECENT_KEYS
- recent_keys_index
,
10069 keys
, recent_keys_index
);
10074 DEFUN ("this-command-keys", Fthis_command_keys
, Sthis_command_keys
, 0, 0, 0,
10075 doc
: /* Return the key sequence that invoked this command.
10076 However, if the command has called `read-key-sequence', it returns
10077 the last key sequence that has been read.
10078 The value is a string or a vector.
10080 See also `this-command-keys-vector'. */)
10083 return make_event_array (this_command_key_count
,
10084 XVECTOR (this_command_keys
)->contents
);
10087 DEFUN ("this-command-keys-vector", Fthis_command_keys_vector
, Sthis_command_keys_vector
, 0, 0, 0,
10088 doc
: /* Return the key sequence that invoked this command, as a vector.
10089 However, if the command has called `read-key-sequence', it returns
10090 the last key sequence that has been read.
10092 See also `this-command-keys'. */)
10095 return Fvector (this_command_key_count
,
10096 XVECTOR (this_command_keys
)->contents
);
10099 DEFUN ("this-single-command-keys", Fthis_single_command_keys
,
10100 Sthis_single_command_keys
, 0, 0, 0,
10101 doc
: /* Return the key sequence that invoked this command.
10102 More generally, it returns the last key sequence read, either by
10103 the command loop or by `read-key-sequence'.
10104 Unlike `this-command-keys', this function's value
10105 does not include prefix arguments.
10106 The value is always a vector. */)
10109 return Fvector (this_command_key_count
10110 - this_single_command_key_start
,
10111 (XVECTOR (this_command_keys
)->contents
10112 + this_single_command_key_start
));
10115 DEFUN ("this-single-command-raw-keys", Fthis_single_command_raw_keys
,
10116 Sthis_single_command_raw_keys
, 0, 0, 0,
10117 doc
: /* Return the raw events that were read for this command.
10118 More generally, it returns the last key sequence read, either by
10119 the command loop or by `read-key-sequence'.
10120 Unlike `this-single-command-keys', this function's value
10121 shows the events before all translations (except for input methods).
10122 The value is always a vector. */)
10125 return Fvector (raw_keybuf_count
,
10126 (XVECTOR (raw_keybuf
)->contents
));
10129 DEFUN ("reset-this-command-lengths", Freset_this_command_lengths
,
10130 Sreset_this_command_lengths
, 0, 0, 0,
10131 doc
: /* Make the unread events replace the last command and echo.
10132 Used in `universal-argument-other-key'.
10134 `universal-argument-other-key' rereads the event just typed.
10135 It then gets translated through `function-key-map'.
10136 The translated event has to replace the real events,
10137 both in the value of (this-command-keys) and in echoing.
10138 To achieve this, `universal-argument-other-key' calls
10139 `reset-this-command-lengths', which discards the record of reading
10140 these events the first time. */)
10143 this_command_key_count
= before_command_key_count
;
10144 if (this_command_key_count
< this_single_command_key_start
)
10145 this_single_command_key_start
= this_command_key_count
;
10147 echo_truncate (before_command_echo_length
);
10149 /* Cause whatever we put into unread-command-events
10150 to echo as if it were being freshly read from the keyboard. */
10151 this_command_key_count_reset
= 1;
10156 DEFUN ("clear-this-command-keys", Fclear_this_command_keys
,
10157 Sclear_this_command_keys
, 0, 1, 0,
10158 doc
: /* Clear out the vector that `this-command-keys' returns.
10159 Also clear the record of the last 100 events, unless optional arg
10160 KEEP-RECORD is non-nil. */)
10161 (Lisp_Object keep_record
)
10165 this_command_key_count
= 0;
10166 this_command_key_count_reset
= 0;
10168 if (NILP (keep_record
))
10170 for (i
= 0; i
< ASIZE (recent_keys
); ++i
)
10171 ASET (recent_keys
, i
, Qnil
);
10173 recent_keys_index
= 0;
10178 DEFUN ("recursion-depth", Frecursion_depth
, Srecursion_depth
, 0, 0, 0,
10179 doc
: /* Return the current depth in recursive edits. */)
10183 /* Wrap around reliably on integer overflow. */
10184 EMACS_INT sum
= (command_loop_level
& INTMASK
) + (minibuf_level
& INTMASK
);
10185 XSETINT (temp
, sum
);
10189 DEFUN ("open-dribble-file", Fopen_dribble_file
, Sopen_dribble_file
, 1, 1,
10190 "FOpen dribble file: ",
10191 doc
: /* Start writing all keyboard characters to a dribble file called FILE.
10192 If FILE is nil, close any open dribble file.
10193 The file will be closed when Emacs exits. */)
10205 file
= Fexpand_file_name (file
, Qnil
);
10206 dribble
= fopen (SSDATA (file
), "w");
10208 report_file_error ("Opening dribble", Fcons (file
, Qnil
));
10213 DEFUN ("discard-input", Fdiscard_input
, Sdiscard_input
, 0, 0, 0,
10214 doc
: /* Discard the contents of the terminal input buffer.
10215 Also end any kbd macro being defined. */)
10218 if (!NILP (KVAR (current_kboard
, defining_kbd_macro
)))
10220 /* Discard the last command from the macro. */
10221 Fcancel_kbd_macro_events ();
10225 update_mode_lines
++;
10227 Vunread_command_events
= Qnil
;
10229 discard_tty_input ();
10231 kbd_fetch_ptr
= kbd_store_ptr
;
10237 DEFUN ("suspend-emacs", Fsuspend_emacs
, Ssuspend_emacs
, 0, 1, "",
10238 doc
: /* Stop Emacs and return to superior process. You can resume later.
10239 If `cannot-suspend' is non-nil, or if the system doesn't support job
10240 control, run a subshell instead.
10242 If optional arg STUFFSTRING is non-nil, its characters are stuffed
10243 to be read as terminal input by Emacs's parent, after suspension.
10245 Before suspending, run the normal hook `suspend-hook'.
10246 After resumption run the normal hook `suspend-resume-hook'.
10248 Some operating systems cannot stop the Emacs process and resume it later.
10249 On such systems, Emacs starts a subshell instead of suspending. */)
10250 (Lisp_Object stuffstring
)
10252 ptrdiff_t count
= SPECPDL_INDEX ();
10253 int old_height
, old_width
;
10255 struct gcpro gcpro1
;
10258 if (tty_list
&& tty_list
->next
)
10259 error ("There are other tty frames open; close them before suspending Emacs");
10261 if (!NILP (stuffstring
))
10262 CHECK_STRING (stuffstring
);
10264 /* Run the functions in suspend-hook. */
10265 hook
= intern ("suspend-hook");
10266 Frun_hooks (1, &hook
);
10268 GCPRO1 (stuffstring
);
10269 get_tty_size (fileno (CURTTY ()->input
), &old_width
, &old_height
);
10270 reset_all_sys_modes ();
10271 /* sys_suspend can get an error if it tries to fork a subshell
10272 and the system resources aren't available for that. */
10273 record_unwind_protect ((Lisp_Object (*) (Lisp_Object
)) init_all_sys_modes
,
10275 stuff_buffered_input (stuffstring
);
10276 if (cannot_suspend
)
10280 unbind_to (count
, Qnil
);
10282 /* Check if terminal/window size has changed.
10283 Note that this is not useful when we are running directly
10284 with a window system; but suspend should be disabled in that case. */
10285 get_tty_size (fileno (CURTTY ()->input
), &width
, &height
);
10286 if (width
!= old_width
|| height
!= old_height
)
10287 change_frame_size (SELECTED_FRAME (), height
, width
, 0, 0, 0);
10289 /* Run suspend-resume-hook. */
10290 hook
= intern ("suspend-resume-hook");
10291 Frun_hooks (1, &hook
);
10297 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
10298 Then in any case stuff anything Emacs has read ahead and not used. */
10301 stuff_buffered_input (Lisp_Object stuffstring
)
10303 #ifdef SIGTSTP /* stuff_char is defined if SIGTSTP. */
10304 register unsigned char *p
;
10306 if (STRINGP (stuffstring
))
10308 register ptrdiff_t count
;
10310 p
= SDATA (stuffstring
);
10311 count
= SBYTES (stuffstring
);
10312 while (count
-- > 0)
10317 /* Anything we have read ahead, put back for the shell to read. */
10318 /* ?? What should this do when we have multiple keyboards??
10319 Should we ignore anything that was typed in at the "wrong" kboard?
10321 rms: we should stuff everything back into the kboard
10323 for (; kbd_fetch_ptr
!= kbd_store_ptr
; kbd_fetch_ptr
++)
10326 if (kbd_fetch_ptr
== kbd_buffer
+ KBD_BUFFER_SIZE
)
10327 kbd_fetch_ptr
= kbd_buffer
;
10328 if (kbd_fetch_ptr
->kind
== ASCII_KEYSTROKE_EVENT
)
10329 stuff_char (kbd_fetch_ptr
->code
);
10331 clear_event (kbd_fetch_ptr
);
10335 #endif /* SIGTSTP */
10339 set_waiting_for_input (EMACS_TIME
*time_to_clear
)
10341 input_available_clear_time
= time_to_clear
;
10343 /* Tell handle_interrupt to throw back to read_char, */
10344 waiting_for_input
= 1;
10346 /* If handle_interrupt was called before and buffered a C-g,
10347 make it run again now, to avoid timing error. */
10348 if (!NILP (Vquit_flag
))
10349 quit_throw_to_read_char (0);
10353 clear_waiting_for_input (void)
10355 /* Tell handle_interrupt not to throw back to read_char, */
10356 waiting_for_input
= 0;
10357 input_available_clear_time
= 0;
10360 /* The SIGINT handler.
10362 If we have a frame on the controlling tty, we assume that the
10363 SIGINT was generated by C-g, so we call handle_interrupt.
10364 Otherwise, tell QUIT to kill Emacs. */
10367 handle_interrupt_signal (int sig
)
10369 /* See if we have an active terminal on our controlling tty. */
10370 struct terminal
*terminal
= get_named_tty ("/dev/tty");
10373 /* If there are no frames there, let's pretend that we are a
10374 well-behaving UN*X program and quit. We must not call Lisp
10375 in a signal handler, so tell QUIT to exit when it is
10377 Vquit_flag
= Qkill_emacs
;
10381 /* Otherwise, the SIGINT was probably generated by C-g. */
10383 /* Set internal_last_event_frame to the top frame of the
10384 controlling tty, if we have a frame there. We disable the
10385 interrupt key on secondary ttys, so the SIGINT must have come
10386 from the controlling tty. */
10387 internal_last_event_frame
= terminal
->display_info
.tty
->top_frame
;
10389 handle_interrupt (1);
10394 deliver_interrupt_signal (int sig
)
10396 deliver_process_signal (sig
, handle_interrupt_signal
);
10400 /* If Emacs is stuck because `inhibit-quit' is true, then keep track
10401 of the number of times C-g has been requested. If C-g is pressed
10402 enough times, then quit anyway. See bug#6585. */
10403 static int volatile force_quit_count
;
10405 /* This routine is called at interrupt level in response to C-g.
10407 It is called from the SIGINT handler or kbd_buffer_store_event.
10409 If `waiting_for_input' is non zero, then unless `echoing' is
10410 nonzero, immediately throw back to read_char.
10412 Otherwise it sets the Lisp variable quit-flag not-nil. This causes
10413 eval to throw, when it gets a chance. If quit-flag is already
10414 non-nil, it stops the job right away. */
10417 handle_interrupt (bool in_signal_handler
)
10423 /* XXX This code needs to be revised for multi-tty support. */
10424 if (!NILP (Vquit_flag
) && get_named_tty ("/dev/tty"))
10426 if (! in_signal_handler
)
10428 /* If SIGINT isn't blocked, don't let us be interrupted by
10429 a SIGINT. It might be harmful due to non-reentrancy
10430 in I/O functions. */
10432 sigemptyset (&blocked
);
10433 sigaddset (&blocked
, SIGINT
);
10434 pthread_sigmask (SIG_BLOCK
, &blocked
, 0);
10438 reset_all_sys_modes ();
10442 * On systems which can suspend the current process and return to the original
10443 * shell, this command causes the user to end up back at the shell.
10444 * The "Auto-save" and "Abort" questions are not asked until
10445 * the user elects to return to emacs, at which point he can save the current
10446 * job and either dump core or continue.
10450 /* Perhaps should really fork an inferior shell?
10451 But that would not provide any way to get back
10452 to the original shell, ever. */
10453 printf ("No support for stopping a process on this operating system;\n");
10454 printf ("you can continue or abort.\n");
10455 #endif /* not SIGTSTP */
10457 /* We must remain inside the screen area when the internal terminal
10458 is used. Note that [Enter] is not echoed by dos. */
10459 cursor_to (SELECTED_FRAME (), 0, 0);
10461 /* It doesn't work to autosave while GC is in progress;
10462 the code used for auto-saving doesn't cope with the mark bit. */
10463 if (!gc_in_progress
)
10465 printf ("Auto-save? (y or n) ");
10467 if (((c
= getchar ()) & ~040) == 'Y')
10469 Fdo_auto_save (Qt
, Qnil
);
10471 printf ("\r\nAuto-save done");
10472 #else /* not MSDOS */
10473 printf ("Auto-save done\n");
10474 #endif /* not MSDOS */
10476 while (c
!= '\n') c
= getchar ();
10480 /* During GC, it must be safe to reenable quitting again. */
10481 Vinhibit_quit
= Qnil
;
10484 #endif /* not MSDOS */
10485 printf ("Garbage collection in progress; cannot auto-save now\r\n");
10486 printf ("but will instead do a real quit after garbage collection ends\r\n");
10491 printf ("\r\nAbort? (y or n) ");
10492 #else /* not MSDOS */
10493 printf ("Abort (and dump core)? (y or n) ");
10494 #endif /* not MSDOS */
10496 if (((c
= getchar ()) & ~040) == 'Y')
10498 while (c
!= '\n') c
= getchar ();
10500 printf ("\r\nContinuing...\r\n");
10501 #else /* not MSDOS */
10502 printf ("Continuing...\n");
10503 #endif /* not MSDOS */
10505 init_all_sys_modes ();
10509 /* If executing a function that wants to be interrupted out of
10510 and the user has not deferred quitting by binding `inhibit-quit'
10511 then quit right away. */
10512 if (immediate_quit
&& NILP (Vinhibit_quit
))
10514 struct gl_state_s saved
;
10515 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
10517 immediate_quit
= 0;
10518 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10520 GCPRO4 (saved
.object
, saved
.global_code
,
10521 saved
.current_syntax_table
, saved
.old_prop
);
10522 Fsignal (Qquit
, Qnil
);
10527 { /* Else request quit when it's safe. */
10528 int count
= NILP (Vquit_flag
) ? 1 : force_quit_count
+ 1;
10529 force_quit_count
= count
;
10532 immediate_quit
= 1;
10533 Vinhibit_quit
= Qnil
;
10539 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
10541 /* TODO: The longjmp in this call throws the NS event loop integration off,
10542 and it seems to do fine without this. Probably some attention
10543 needs to be paid to the setting of waiting_for_input in
10544 wait_reading_process_output() under HAVE_NS because of the call
10545 to ns_select there (needed because otherwise events aren't picked up
10546 outside of polling since we don't get SIGIO like X and we don't have a
10547 separate event loop thread like W32. */
10549 if (waiting_for_input
&& !echoing
)
10550 quit_throw_to_read_char (in_signal_handler
);
10554 /* Handle a C-g by making read_char return C-g. */
10557 quit_throw_to_read_char (bool from_signal
)
10559 /* When not called from a signal handler it is safe to call
10561 if (!from_signal
&& EQ (Vquit_flag
, Qkill_emacs
))
10562 Fkill_emacs (Qnil
);
10564 /* Prevent another signal from doing this before we finish. */
10565 clear_waiting_for_input ();
10568 Vunread_command_events
= Qnil
;
10570 if (FRAMEP (internal_last_event_frame
)
10571 && !EQ (internal_last_event_frame
, selected_frame
))
10572 do_switch_frame (make_lispy_switch_frame (internal_last_event_frame
),
10575 sys_longjmp (getcjmp
, 1);
10578 DEFUN ("set-input-interrupt-mode", Fset_input_interrupt_mode
,
10579 Sset_input_interrupt_mode
, 1, 1, 0,
10580 doc
: /* Set interrupt mode of reading keyboard input.
10581 If INTERRUPT is non-nil, Emacs will use input interrupts;
10582 otherwise Emacs uses CBREAK mode.
10584 See also `current-input-mode'. */)
10585 (Lisp_Object interrupt
)
10587 bool new_interrupt_input
;
10588 #ifdef USABLE_SIGIO
10589 #ifdef HAVE_X_WINDOWS
10590 if (x_display_list
!= NULL
)
10592 /* When using X, don't give the user a real choice,
10593 because we haven't implemented the mechanisms to support it. */
10594 new_interrupt_input
= 1;
10597 #endif /* HAVE_X_WINDOWS */
10598 new_interrupt_input
= !NILP (interrupt
);
10599 #else /* not USABLE_SIGIO */
10600 new_interrupt_input
= 0;
10601 #endif /* not USABLE_SIGIO */
10603 if (new_interrupt_input
!= interrupt_input
)
10605 #ifdef POLL_FOR_INPUT
10609 /* this causes startup screen to be restored and messes with the mouse */
10610 reset_all_sys_modes ();
10611 interrupt_input
= new_interrupt_input
;
10612 init_all_sys_modes ();
10614 interrupt_input
= new_interrupt_input
;
10617 #ifdef POLL_FOR_INPUT
10618 poll_suppress_count
= 1;
10625 DEFUN ("set-output-flow-control", Fset_output_flow_control
, Sset_output_flow_control
, 1, 2, 0,
10626 doc
: /* Enable or disable ^S/^Q flow control for output to TERMINAL.
10627 If FLOW is non-nil, flow control is enabled and you cannot use C-s or
10628 C-q in key sequences.
10630 This setting only has an effect on tty terminals and only when
10631 Emacs reads input in CBREAK mode; see `set-input-interrupt-mode'.
10633 See also `current-input-mode'. */)
10634 (Lisp_Object flow
, Lisp_Object terminal
)
10636 struct terminal
*t
= get_terminal (terminal
, 1);
10637 struct tty_display_info
*tty
;
10638 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10640 tty
= t
->display_info
.tty
;
10642 if (tty
->flow_control
!= !NILP (flow
))
10645 /* this causes startup screen to be restored and messes with the mouse */
10646 reset_sys_modes (tty
);
10649 tty
->flow_control
= !NILP (flow
);
10652 init_sys_modes (tty
);
10658 DEFUN ("set-input-meta-mode", Fset_input_meta_mode
, Sset_input_meta_mode
, 1, 2, 0,
10659 doc
: /* Enable or disable 8-bit input on TERMINAL.
10660 If META is t, Emacs will accept 8-bit input, and interpret the 8th
10661 bit as the Meta modifier.
10663 If META is nil, Emacs will ignore the top bit, on the assumption it is
10666 Otherwise, Emacs will accept and pass through 8-bit input without
10667 specially interpreting the top bit.
10669 This setting only has an effect on tty terminal devices.
10671 Optional parameter TERMINAL specifies the tty terminal device to use.
10672 It may be a terminal object, a frame, or nil for the terminal used by
10673 the currently selected frame.
10675 See also `current-input-mode'. */)
10676 (Lisp_Object meta
, Lisp_Object terminal
)
10678 struct terminal
*t
= get_terminal (terminal
, 1);
10679 struct tty_display_info
*tty
;
10682 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10684 tty
= t
->display_info
.tty
;
10688 else if (EQ (meta
, Qt
))
10693 if (tty
->meta_key
!= new_meta
)
10696 /* this causes startup screen to be restored and messes with the mouse */
10697 reset_sys_modes (tty
);
10700 tty
->meta_key
= new_meta
;
10703 init_sys_modes (tty
);
10709 DEFUN ("set-quit-char", Fset_quit_char
, Sset_quit_char
, 1, 1, 0,
10710 doc
: /* Specify character used for quitting.
10711 QUIT must be an ASCII character.
10713 This function only has an effect on the controlling tty of the Emacs
10716 See also `current-input-mode'. */)
10719 struct terminal
*t
= get_named_tty ("/dev/tty");
10720 struct tty_display_info
*tty
;
10721 if (t
== NULL
|| (t
->type
!= output_termcap
&& t
->type
!= output_msdos_raw
))
10723 tty
= t
->display_info
.tty
;
10725 if (NILP (quit
) || !INTEGERP (quit
) || XINT (quit
) < 0 || XINT (quit
) > 0400)
10726 error ("QUIT must be an ASCII character");
10729 /* this causes startup screen to be restored and messes with the mouse */
10730 reset_sys_modes (tty
);
10733 /* Don't let this value be out of range. */
10734 quit_char
= XINT (quit
) & (tty
->meta_key
== 0 ? 0177 : 0377);
10737 init_sys_modes (tty
);
10743 DEFUN ("set-input-mode", Fset_input_mode
, Sset_input_mode
, 3, 4, 0,
10744 doc
: /* Set mode of reading keyboard input.
10745 First arg INTERRUPT non-nil means use input interrupts;
10746 nil means use CBREAK mode.
10747 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
10748 (no effect except in CBREAK mode).
10749 Third arg META t means accept 8-bit input (for a Meta key).
10750 META nil means ignore the top bit, on the assumption it is parity.
10751 Otherwise, accept 8-bit input and don't use the top bit for Meta.
10752 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
10753 See also `current-input-mode'. */)
10754 (Lisp_Object interrupt
, Lisp_Object flow
, Lisp_Object meta
, Lisp_Object quit
)
10756 Fset_input_interrupt_mode (interrupt
);
10757 Fset_output_flow_control (flow
, Qnil
);
10758 Fset_input_meta_mode (meta
, Qnil
);
10760 Fset_quit_char (quit
);
10764 DEFUN ("current-input-mode", Fcurrent_input_mode
, Scurrent_input_mode
, 0, 0, 0,
10765 doc
: /* Return information about the way Emacs currently reads keyboard input.
10766 The value is a list of the form (INTERRUPT FLOW META QUIT), where
10767 INTERRUPT is non-nil if Emacs is using interrupt-driven input; if
10768 nil, Emacs is using CBREAK mode.
10769 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
10770 terminal; this does not apply if Emacs uses interrupt-driven input.
10771 META is t if accepting 8-bit input with 8th bit as Meta flag.
10772 META nil means ignoring the top bit, on the assumption it is parity.
10773 META is neither t nor nil if accepting 8-bit input and using
10774 all 8 bits as the character code.
10775 QUIT is the character Emacs currently uses to quit.
10776 The elements of this list correspond to the arguments of
10777 `set-input-mode'. */)
10780 Lisp_Object val
[4];
10781 struct frame
*sf
= XFRAME (selected_frame
);
10783 val
[0] = interrupt_input
? Qt
: Qnil
;
10784 if (FRAME_TERMCAP_P (sf
) || FRAME_MSDOS_P (sf
))
10786 val
[1] = FRAME_TTY (sf
)->flow_control
? Qt
: Qnil
;
10787 val
[2] = (FRAME_TTY (sf
)->meta_key
== 2
10789 : (CURTTY ()->meta_key
== 1 ? Qt
: Qnil
));
10796 XSETFASTINT (val
[3], quit_char
);
10798 return Flist (sizeof (val
) / sizeof (val
[0]), val
);
10801 DEFUN ("posn-at-x-y", Fposn_at_x_y
, Sposn_at_x_y
, 2, 4, 0,
10802 doc
: /* Return position information for pixel coordinates X and Y.
10803 By default, X and Y are relative to text area of the selected window.
10804 Optional third arg FRAME-OR-WINDOW non-nil specifies frame or window.
10805 If optional fourth arg WHOLE is non-nil, X is relative to the left
10806 edge of the window.
10808 The return value is similar to a mouse click position:
10809 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10810 IMAGE (DX . DY) (WIDTH . HEIGHT))
10811 The `posn-' functions access elements of such lists. */)
10812 (Lisp_Object x
, Lisp_Object y
, Lisp_Object frame_or_window
, Lisp_Object whole
)
10817 if (NILP (frame_or_window
))
10818 frame_or_window
= selected_window
;
10820 if (WINDOWP (frame_or_window
))
10822 struct window
*w
= decode_live_window (frame_or_window
);
10824 XSETINT (x
, (XINT (x
)
10825 + WINDOW_LEFT_EDGE_X (w
)
10827 ? window_box_left_offset (w
, TEXT_AREA
)
10829 XSETINT (y
, WINDOW_TO_FRAME_PIXEL_Y (w
, XINT (y
)));
10830 frame_or_window
= w
->frame
;
10833 CHECK_LIVE_FRAME (frame_or_window
);
10835 return make_lispy_position (XFRAME (frame_or_window
), x
, y
, 0);
10838 DEFUN ("posn-at-point", Fposn_at_point
, Sposn_at_point
, 0, 2, 0,
10839 doc
: /* Return position information for buffer POS in WINDOW.
10840 POS defaults to point in WINDOW; WINDOW defaults to the selected window.
10842 Return nil if position is not visible in window. Otherwise,
10843 the return value is similar to that returned by `event-start' for
10844 a mouse click at the upper left corner of the glyph corresponding
10845 to the given buffer position:
10846 (WINDOW AREA-OR-POS (X . Y) TIMESTAMP OBJECT POS (COL . ROW)
10847 IMAGE (DX . DY) (WIDTH . HEIGHT))
10848 The `posn-' functions access elements of such lists. */)
10849 (Lisp_Object pos
, Lisp_Object window
)
10854 window
= selected_window
;
10856 tem
= Fpos_visible_in_window_p (pos
, window
, Qt
);
10859 Lisp_Object x
= XCAR (tem
);
10860 Lisp_Object y
= XCAR (XCDR (tem
));
10862 /* Point invisible due to hscrolling? */
10865 tem
= Fposn_at_x_y (x
, y
, window
, Qnil
);
10873 * Set up a new kboard object with reasonable initial values.
10876 init_kboard (KBOARD
*kb
)
10878 kset_overriding_terminal_local_map (kb
, Qnil
);
10879 kset_last_command (kb
, Qnil
);
10880 kset_real_last_command (kb
, Qnil
);
10881 kset_keyboard_translate_table (kb
, Qnil
);
10882 kset_last_repeatable_command (kb
, Qnil
);
10883 kset_prefix_arg (kb
, Qnil
);
10884 kset_last_prefix_arg (kb
, Qnil
);
10885 kset_kbd_queue (kb
, Qnil
);
10886 kb
->kbd_queue_has_data
= 0;
10887 kb
->immediate_echo
= 0;
10888 kset_echo_string (kb
, Qnil
);
10889 kb
->echo_after_prompt
= -1;
10890 kb
->kbd_macro_buffer
= 0;
10891 kb
->kbd_macro_bufsize
= 0;
10892 kset_defining_kbd_macro (kb
, Qnil
);
10893 kset_last_kbd_macro (kb
, Qnil
);
10894 kb
->reference_count
= 0;
10895 kset_system_key_alist (kb
, Qnil
);
10896 kset_system_key_syms (kb
, Qnil
);
10897 kset_window_system (kb
, Qt
); /* Unset. */
10898 kset_input_decode_map (kb
, Fmake_sparse_keymap (Qnil
));
10899 kset_local_function_key_map (kb
, Fmake_sparse_keymap (Qnil
));
10900 Fset_keymap_parent (KVAR (kb
, Vlocal_function_key_map
), Vfunction_key_map
);
10901 kset_default_minibuffer_frame (kb
, Qnil
);
10905 * Destroy the contents of a kboard object, but not the object itself.
10906 * We use this just before deleting it, or if we're going to initialize
10907 * it a second time.
10910 wipe_kboard (KBOARD
*kb
)
10912 xfree (kb
->kbd_macro_buffer
);
10915 /* Free KB and memory referenced from it. */
10918 delete_kboard (KBOARD
*kb
)
10922 for (kbp
= &all_kboards
; *kbp
!= kb
; kbp
= &(*kbp
)->next_kboard
)
10925 *kbp
= kb
->next_kboard
;
10927 /* Prevent a dangling reference to KB. */
10928 if (kb
== current_kboard
10929 && FRAMEP (selected_frame
)
10930 && FRAME_LIVE_P (XFRAME (selected_frame
)))
10932 current_kboard
= FRAME_KBOARD (XFRAME (selected_frame
));
10934 if (current_kboard
== kb
)
10943 init_keyboard (void)
10945 /* This is correct before outermost invocation of the editor loop. */
10946 command_loop_level
= -1;
10947 immediate_quit
= 0;
10948 quit_char
= Ctl ('g');
10949 Vunread_command_events
= Qnil
;
10950 timer_idleness_start_time
= invalid_emacs_time ();
10952 recent_keys_index
= 0;
10953 kbd_fetch_ptr
= kbd_buffer
;
10954 kbd_store_ptr
= kbd_buffer
;
10955 do_mouse_tracking
= Qnil
;
10957 interrupt_input_blocked
= 0;
10958 pending_signals
= 0;
10960 /* This means that command_loop_1 won't try to select anything the first
10962 internal_last_event_frame
= Qnil
;
10963 Vlast_event_frame
= internal_last_event_frame
;
10965 current_kboard
= initial_kboard
;
10966 /* Re-initialize the keyboard again. */
10967 wipe_kboard (current_kboard
);
10968 init_kboard (current_kboard
);
10969 /* A value of nil for Vwindow_system normally means a tty, but we also use
10970 it for the initial terminal since there is no window system there. */
10971 kset_window_system (current_kboard
, Qnil
);
10973 if (!noninteractive
)
10975 /* Before multi-tty support, these handlers used to be installed
10976 only if the current session was a tty session. Now an Emacs
10977 session may have multiple display types, so we always handle
10978 SIGINT. There is special code in handle_interrupt_signal to exit
10979 Emacs on SIGINT when there are no termcap frames on the
10980 controlling terminal. */
10981 struct sigaction action
;
10982 emacs_sigaction_init (&action
, deliver_interrupt_signal
);
10983 sigaction (SIGINT
, &action
, 0);
10985 /* For systems with SysV TERMIO, C-g is set up for both SIGINT and
10986 SIGQUIT and we can't tell which one it will give us. */
10987 sigaction (SIGQUIT
, &action
, 0);
10988 #endif /* not DOS_NT */
10990 #ifdef USABLE_SIGIO
10991 if (!noninteractive
)
10993 struct sigaction action
;
10994 emacs_sigaction_init (&action
, deliver_input_available_signal
);
10995 sigaction (SIGIO
, &action
, 0);
10999 /* Use interrupt input by default, if it works and noninterrupt input
11000 has deficiencies. */
11002 #ifdef INTERRUPT_INPUT
11003 interrupt_input
= 1;
11005 interrupt_input
= 0;
11008 pthread_sigmask (SIG_SETMASK
, &empty_mask
, 0);
11011 if (keyboard_init_hook
)
11012 (*keyboard_init_hook
) ();
11014 #ifdef POLL_FOR_INPUT
11016 poll_suppress_count
= 1;
11021 /* This type's only use is in syms_of_keyboard, to initialize the
11022 event header symbols and put properties on them. */
11023 struct event_head
{
11029 static const struct event_head head_table
[] = {
11030 {&Qmouse_movement
, "mouse-movement", &Qmouse_movement
},
11031 {&Qscroll_bar_movement
, "scroll-bar-movement", &Qmouse_movement
},
11032 {&Qswitch_frame
, "switch-frame", &Qswitch_frame
},
11033 {&Qdelete_frame
, "delete-frame", &Qdelete_frame
},
11034 {&Qiconify_frame
, "iconify-frame", &Qiconify_frame
},
11035 {&Qmake_frame_visible
, "make-frame-visible", &Qmake_frame_visible
},
11036 /* `select-window' should be handled just like `switch-frame'
11037 in read_key_sequence. */
11038 {&Qselect_window
, "select-window", &Qswitch_frame
}
11042 syms_of_keyboard (void)
11044 pending_funcalls
= Qnil
;
11045 staticpro (&pending_funcalls
);
11047 Vlispy_mouse_stem
= build_pure_c_string ("mouse");
11048 staticpro (&Vlispy_mouse_stem
);
11051 DEFSYM (QCimage
, ":image");
11052 DEFSYM (Qhelp_echo
, "help-echo");
11053 DEFSYM (QCrtl
, ":rtl");
11055 staticpro (&item_properties
);
11056 item_properties
= Qnil
;
11058 staticpro (&tool_bar_item_properties
);
11059 tool_bar_item_properties
= Qnil
;
11060 staticpro (&tool_bar_items_vector
);
11061 tool_bar_items_vector
= Qnil
;
11063 DEFSYM (Qtimer_event_handler
, "timer-event-handler");
11064 DEFSYM (Qdisabled_command_function
, "disabled-command-function");
11065 DEFSYM (Qself_insert_command
, "self-insert-command");
11066 DEFSYM (Qforward_char
, "forward-char");
11067 DEFSYM (Qbackward_char
, "backward-char");
11068 DEFSYM (Qdisabled
, "disabled");
11069 DEFSYM (Qundefined
, "undefined");
11070 DEFSYM (Qpre_command_hook
, "pre-command-hook");
11071 DEFSYM (Qpost_command_hook
, "post-command-hook");
11072 DEFSYM (Qdeferred_action_function
, "deferred-action-function");
11073 DEFSYM (Qdelayed_warnings_hook
, "delayed-warnings-hook");
11074 DEFSYM (Qfunction_key
, "function-key");
11075 DEFSYM (Qmouse_click
, "mouse-click");
11076 DEFSYM (Qdrag_n_drop
, "drag-n-drop");
11077 DEFSYM (Qsave_session
, "save-session");
11078 DEFSYM (Qconfig_changed_event
, "config-changed-event");
11079 DEFSYM (Qmenu_enable
, "menu-enable");
11082 DEFSYM (Qlanguage_change
, "language-change");
11086 DEFSYM (Qfile_w32notify
, "file-w32notify");
11090 DEFSYM (Qdbus_event
, "dbus-event");
11093 #ifdef HAVE_INOTIFY
11094 DEFSYM (Qfile_inotify
, "file-inotify");
11095 #endif /* HAVE_INOTIFY */
11097 DEFSYM (QCenable
, ":enable");
11098 DEFSYM (QCvisible
, ":visible");
11099 DEFSYM (QChelp
, ":help");
11100 DEFSYM (QCfilter
, ":filter");
11101 DEFSYM (QCbutton
, ":button");
11102 DEFSYM (QCkeys
, ":keys");
11103 DEFSYM (QCkey_sequence
, ":key-sequence");
11104 DEFSYM (QCtoggle
, ":toggle");
11105 DEFSYM (QCradio
, ":radio");
11106 DEFSYM (QClabel
, ":label");
11107 DEFSYM (QCvert_only
, ":vert-only");
11109 DEFSYM (Qmode_line
, "mode-line");
11110 DEFSYM (Qvertical_line
, "vertical-line");
11111 DEFSYM (Qvertical_scroll_bar
, "vertical-scroll-bar");
11112 DEFSYM (Qmenu_bar
, "menu-bar");
11114 DEFSYM (Qmouse_fixup_help_message
, "mouse-fixup-help-message");
11116 DEFSYM (Qabove_handle
, "above-handle");
11117 DEFSYM (Qhandle
, "handle");
11118 DEFSYM (Qbelow_handle
, "below-handle");
11119 DEFSYM (Qup
, "up");
11120 DEFSYM (Qdown
, "down");
11121 DEFSYM (Qtop
, "top");
11122 DEFSYM (Qbottom
, "bottom");
11123 DEFSYM (Qend_scroll
, "end-scroll");
11124 DEFSYM (Qratio
, "ratio");
11126 DEFSYM (Qevent_kind
, "event-kind");
11127 DEFSYM (Qevent_symbol_elements
, "event-symbol-elements");
11128 DEFSYM (Qevent_symbol_element_mask
, "event-symbol-element-mask");
11129 DEFSYM (Qmodifier_cache
, "modifier-cache");
11131 DEFSYM (Qrecompute_lucid_menubar
, "recompute-lucid-menubar");
11132 DEFSYM (Qactivate_menubar_hook
, "activate-menubar-hook");
11134 DEFSYM (Qpolling_period
, "polling-period");
11136 DEFSYM (Qx_set_selection
, "x-set-selection");
11137 DEFSYM (QPRIMARY
, "PRIMARY");
11138 DEFSYM (Qhandle_switch_frame
, "handle-switch-frame");
11139 DEFSYM (Qhandle_select_window
, "handle-select-window");
11141 DEFSYM (Qinput_method_function
, "input-method-function");
11142 DEFSYM (Qinput_method_exit_on_first_char
, "input-method-exit-on-first-char");
11143 DEFSYM (Qinput_method_use_echo_area
, "input-method-use-echo-area");
11145 DEFSYM (Qhelp_form_show
, "help-form-show");
11147 Fset (Qinput_method_exit_on_first_char
, Qnil
);
11148 Fset (Qinput_method_use_echo_area
, Qnil
);
11150 last_point_position_buffer
= Qnil
;
11151 last_point_position_window
= Qnil
;
11155 int len
= sizeof (head_table
) / sizeof (head_table
[0]);
11157 for (i
= 0; i
< len
; i
++)
11159 const struct event_head
*p
= &head_table
[i
];
11160 *p
->var
= intern_c_string (p
->name
);
11161 staticpro (p
->var
);
11162 Fput (*p
->var
, Qevent_kind
, *p
->kind
);
11163 Fput (*p
->var
, Qevent_symbol_elements
, Fcons (*p
->var
, Qnil
));
11167 button_down_location
= Fmake_vector (make_number (5), Qnil
);
11168 staticpro (&button_down_location
);
11169 mouse_syms
= Fmake_vector (make_number (5), Qnil
);
11170 staticpro (&mouse_syms
);
11171 wheel_syms
= Fmake_vector (make_number (sizeof (lispy_wheel_names
)
11172 / sizeof (lispy_wheel_names
[0])),
11174 staticpro (&wheel_syms
);
11178 int len
= sizeof (modifier_names
) / sizeof (modifier_names
[0]);
11180 modifier_symbols
= Fmake_vector (make_number (len
), Qnil
);
11181 for (i
= 0; i
< len
; i
++)
11182 if (modifier_names
[i
])
11183 ASET (modifier_symbols
, i
, intern_c_string (modifier_names
[i
]));
11184 staticpro (&modifier_symbols
);
11187 recent_keys
= Fmake_vector (make_number (NUM_RECENT_KEYS
), Qnil
);
11188 staticpro (&recent_keys
);
11190 this_command_keys
= Fmake_vector (make_number (40), Qnil
);
11191 staticpro (&this_command_keys
);
11193 raw_keybuf
= Fmake_vector (make_number (30), Qnil
);
11194 staticpro (&raw_keybuf
);
11196 DEFSYM (Qextended_command_history
, "extended-command-history");
11197 Fset (Qextended_command_history
, Qnil
);
11199 accent_key_syms
= Qnil
;
11200 staticpro (&accent_key_syms
);
11202 func_key_syms
= Qnil
;
11203 staticpro (&func_key_syms
);
11205 drag_n_drop_syms
= Qnil
;
11206 staticpro (&drag_n_drop_syms
);
11208 unread_switch_frame
= Qnil
;
11209 staticpro (&unread_switch_frame
);
11211 internal_last_event_frame
= Qnil
;
11212 staticpro (&internal_last_event_frame
);
11214 read_key_sequence_cmd
= Qnil
;
11215 staticpro (&read_key_sequence_cmd
);
11216 read_key_sequence_remapped
= Qnil
;
11217 staticpro (&read_key_sequence_remapped
);
11219 menu_bar_one_keymap_changed_items
= Qnil
;
11220 staticpro (&menu_bar_one_keymap_changed_items
);
11222 menu_bar_items_vector
= Qnil
;
11223 staticpro (&menu_bar_items_vector
);
11225 help_form_saved_window_configs
= Qnil
;
11226 staticpro (&help_form_saved_window_configs
);
11228 defsubr (&Scurrent_idle_time
);
11229 defsubr (&Sevent_symbol_parse_modifiers
);
11230 defsubr (&Sevent_convert_list
);
11231 defsubr (&Sread_key_sequence
);
11232 defsubr (&Sread_key_sequence_vector
);
11233 defsubr (&Srecursive_edit
);
11234 defsubr (&Strack_mouse
);
11235 defsubr (&Sinput_pending_p
);
11236 defsubr (&Scommand_execute
);
11237 defsubr (&Srecent_keys
);
11238 defsubr (&Sthis_command_keys
);
11239 defsubr (&Sthis_command_keys_vector
);
11240 defsubr (&Sthis_single_command_keys
);
11241 defsubr (&Sthis_single_command_raw_keys
);
11242 defsubr (&Sreset_this_command_lengths
);
11243 defsubr (&Sclear_this_command_keys
);
11244 defsubr (&Ssuspend_emacs
);
11245 defsubr (&Sabort_recursive_edit
);
11246 defsubr (&Sexit_recursive_edit
);
11247 defsubr (&Srecursion_depth
);
11248 defsubr (&Stop_level
);
11249 defsubr (&Sdiscard_input
);
11250 defsubr (&Sopen_dribble_file
);
11251 defsubr (&Sset_input_interrupt_mode
);
11252 defsubr (&Sset_output_flow_control
);
11253 defsubr (&Sset_input_meta_mode
);
11254 defsubr (&Sset_quit_char
);
11255 defsubr (&Sset_input_mode
);
11256 defsubr (&Scurrent_input_mode
);
11257 defsubr (&Sposn_at_point
);
11258 defsubr (&Sposn_at_x_y
);
11260 DEFVAR_LISP ("last-command-event", last_command_event
,
11261 doc
: /* Last input event that was part of a command. */);
11263 DEFVAR_LISP ("last-nonmenu-event", last_nonmenu_event
,
11264 doc
: /* Last input event in a command, except for mouse menu events.
11265 Mouse menus give back keys that don't look like mouse events;
11266 this variable holds the actual mouse event that led to the menu,
11267 so that you can determine whether the command was run by mouse or not. */);
11269 DEFVAR_LISP ("last-input-event", last_input_event
,
11270 doc
: /* Last input event. */);
11272 DEFVAR_LISP ("unread-command-events", Vunread_command_events
,
11273 doc
: /* List of events to be read as the command input.
11274 These events are processed first, before actual keyboard input.
11275 Events read from this list are not normally added to `this-command-keys',
11276 as they will already have been added once as they were read for the first time.
11277 An element of the form (t . EVENT) forces EVENT to be added to that list. */);
11278 Vunread_command_events
= Qnil
;
11280 DEFVAR_LISP ("unread-post-input-method-events", Vunread_post_input_method_events
,
11281 doc
: /* List of events to be processed as input by input methods.
11282 These events are processed before `unread-command-events'
11283 and actual keyboard input, but are not given to `input-method-function'. */);
11284 Vunread_post_input_method_events
= Qnil
;
11286 DEFVAR_LISP ("unread-input-method-events", Vunread_input_method_events
,
11287 doc
: /* List of events to be processed as input by input methods.
11288 These events are processed after `unread-command-events', but
11289 before actual keyboard input.
11290 If there's an active input method, the events are given to
11291 `input-method-function'. */);
11292 Vunread_input_method_events
= Qnil
;
11294 DEFVAR_LISP ("meta-prefix-char", meta_prefix_char
,
11295 doc
: /* Meta-prefix character code.
11296 Meta-foo as command input turns into this character followed by foo. */);
11297 XSETINT (meta_prefix_char
, 033);
11299 DEFVAR_KBOARD ("last-command", Vlast_command
,
11300 doc
: /* The last command executed.
11301 Normally a symbol with a function definition, but can be whatever was found
11302 in the keymap, or whatever the variable `this-command' was set to by that
11305 The value `mode-exit' is special; it means that the previous command
11306 read an event that told it to exit, and it did so and unread that event.
11307 In other words, the present command is the event that made the previous
11310 The value `kill-region' is special; it means that the previous command
11311 was a kill command.
11313 `last-command' has a separate binding for each terminal device.
11314 See Info node `(elisp)Multiple Terminals'. */);
11316 DEFVAR_KBOARD ("real-last-command", Vreal_last_command
,
11317 doc
: /* Same as `last-command', but never altered by Lisp code.
11318 Taken from the previous value of `real-this-command'. */);
11320 DEFVAR_KBOARD ("last-repeatable-command", Vlast_repeatable_command
,
11321 doc
: /* Last command that may be repeated.
11322 The last command executed that was not bound to an input event.
11323 This is the command `repeat' will try to repeat.
11324 Taken from a previous value of `real-this-command'. */);
11326 DEFVAR_LISP ("this-command", Vthis_command
,
11327 doc
: /* The command now being executed.
11328 The command can set this variable; whatever is put here
11329 will be in `last-command' during the following command. */);
11330 Vthis_command
= Qnil
;
11332 DEFVAR_LISP ("real-this-command", Vreal_this_command
,
11333 doc
: /* This is like `this-command', except that commands should never modify it. */);
11334 Vreal_this_command
= Qnil
;
11336 DEFVAR_LISP ("this-command-keys-shift-translated",
11337 Vthis_command_keys_shift_translated
,
11338 doc
: /* Non-nil if the key sequence activating this command was shift-translated.
11339 Shift-translation occurs when there is no binding for the key sequence
11340 as entered, but a binding was found by changing an upper-case letter
11341 to lower-case, or a shifted function key to an unshifted one. */);
11342 Vthis_command_keys_shift_translated
= Qnil
;
11344 DEFVAR_LISP ("this-original-command", Vthis_original_command
,
11345 doc
: /* The command bound to the current key sequence before remapping.
11346 It equals `this-command' if the original command was not remapped through
11347 any of the active keymaps. Otherwise, the value of `this-command' is the
11348 result of looking up the original command in the active keymaps. */);
11349 Vthis_original_command
= Qnil
;
11351 DEFVAR_INT ("auto-save-interval", auto_save_interval
,
11352 doc
: /* Number of input events between auto-saves.
11353 Zero means disable autosaving due to number of characters typed. */);
11354 auto_save_interval
= 300;
11356 DEFVAR_LISP ("auto-save-timeout", Vauto_save_timeout
,
11357 doc
: /* Number of seconds idle time before auto-save.
11358 Zero or nil means disable auto-saving due to idleness.
11359 After auto-saving due to this many seconds of idle time,
11360 Emacs also does a garbage collection if that seems to be warranted. */);
11361 XSETFASTINT (Vauto_save_timeout
, 30);
11363 DEFVAR_LISP ("echo-keystrokes", Vecho_keystrokes
,
11364 doc
: /* Nonzero means echo unfinished commands after this many seconds of pause.
11365 The value may be integer or floating point.
11366 If the value is zero, don't echo at all. */);
11367 Vecho_keystrokes
= make_number (1);
11369 DEFVAR_INT ("polling-period", polling_period
,
11370 doc
: /* Interval between polling for input during Lisp execution.
11371 The reason for polling is to make C-g work to stop a running program.
11372 Polling is needed only when using X windows and SIGIO does not work.
11373 Polling is automatically disabled in all other cases. */);
11374 polling_period
= 2;
11376 DEFVAR_LISP ("double-click-time", Vdouble_click_time
,
11377 doc
: /* Maximum time between mouse clicks to make a double-click.
11378 Measured in milliseconds. The value nil means disable double-click
11379 recognition; t means double-clicks have no time limit and are detected
11380 by position only. */);
11381 Vdouble_click_time
= make_number (500);
11383 DEFVAR_INT ("double-click-fuzz", double_click_fuzz
,
11384 doc
: /* Maximum mouse movement between clicks to make a double-click.
11385 On window-system frames, value is the number of pixels the mouse may have
11386 moved horizontally or vertically between two clicks to make a double-click.
11387 On non window-system frames, value is interpreted in units of 1/8 characters
11390 This variable is also the threshold for motion of the mouse
11391 to count as a drag. */);
11392 double_click_fuzz
= 3;
11394 DEFVAR_INT ("num-input-keys", num_input_keys
,
11395 doc
: /* Number of complete key sequences read as input so far.
11396 This includes key sequences read from keyboard macros.
11397 The number is effectively the number of interactive command invocations. */);
11398 num_input_keys
= 0;
11400 DEFVAR_INT ("num-nonmacro-input-events", num_nonmacro_input_events
,
11401 doc
: /* Number of input events read from the keyboard so far.
11402 This does not include events generated by keyboard macros. */);
11403 num_nonmacro_input_events
= 0;
11405 DEFVAR_LISP ("last-event-frame", Vlast_event_frame
,
11406 doc
: /* The frame in which the most recently read event occurred.
11407 If the last event came from a keyboard macro, this is set to `macro'. */);
11408 Vlast_event_frame
= Qnil
;
11410 /* This variable is set up in sysdep.c. */
11411 DEFVAR_LISP ("tty-erase-char", Vtty_erase_char
,
11412 doc
: /* The ERASE character as set by the user with stty. */);
11414 DEFVAR_LISP ("help-char", Vhelp_char
,
11415 doc
: /* Character to recognize as meaning Help.
11416 When it is read, do `(eval help-form)', and display result if it's a string.
11417 If the value of `help-form' is nil, this char can be read normally. */);
11418 XSETINT (Vhelp_char
, Ctl ('H'));
11420 DEFVAR_LISP ("help-event-list", Vhelp_event_list
,
11421 doc
: /* List of input events to recognize as meaning Help.
11422 These work just like the value of `help-char' (see that). */);
11423 Vhelp_event_list
= Qnil
;
11425 DEFVAR_LISP ("help-form", Vhelp_form
,
11426 doc
: /* Form to execute when character `help-char' is read.
11427 If the form returns a string, that string is displayed.
11428 If `help-form' is nil, the help char is not recognized. */);
11431 DEFVAR_LISP ("prefix-help-command", Vprefix_help_command
,
11432 doc
: /* Command to run when `help-char' character follows a prefix key.
11433 This command is used only when there is no actual binding
11434 for that character after that prefix key. */);
11435 Vprefix_help_command
= Qnil
;
11437 DEFVAR_LISP ("top-level", Vtop_level
,
11438 doc
: /* Form to evaluate when Emacs starts up.
11439 Useful to set before you dump a modified Emacs. */);
11442 DEFVAR_KBOARD ("keyboard-translate-table", Vkeyboard_translate_table
,
11443 doc
: /* Translate table for local keyboard input, or nil.
11444 If non-nil, the value should be a char-table. Each character read
11445 from the keyboard is looked up in this char-table. If the value found
11446 there is non-nil, then it is used instead of the actual input character.
11448 The value can also be a string or vector, but this is considered obsolete.
11449 If it is a string or vector of length N, character codes N and up are left
11450 untranslated. In a vector, an element which is nil means "no translation".
11452 This is applied to the characters supplied to input methods, not their
11453 output. See also `translation-table-for-input'.
11455 This variable has a separate binding for each terminal.
11456 See Info node `(elisp)Multiple Terminals'. */);
11458 DEFVAR_BOOL ("cannot-suspend", cannot_suspend
,
11459 doc
: /* Non-nil means to always spawn a subshell instead of suspending.
11460 \(Even if the operating system has support for stopping a process.\) */);
11461 cannot_suspend
= 0;
11463 DEFVAR_BOOL ("menu-prompting", menu_prompting
,
11464 doc
: /* Non-nil means prompt with menus when appropriate.
11465 This is done when reading from a keymap that has a prompt string,
11466 for elements that have prompt strings.
11467 The menu is displayed on the screen
11468 if X menus were enabled at configuration
11469 time and the previous event was a mouse click prefix key.
11470 Otherwise, menu prompting uses the echo area. */);
11471 menu_prompting
= 1;
11473 DEFVAR_LISP ("menu-prompt-more-char", menu_prompt_more_char
,
11474 doc
: /* Character to see next line of menu prompt.
11475 Type this character while in a menu prompt to rotate around the lines of it. */);
11476 XSETINT (menu_prompt_more_char
, ' ');
11478 DEFVAR_INT ("extra-keyboard-modifiers", extra_keyboard_modifiers
,
11479 doc
: /* A mask of additional modifier keys to use with every keyboard character.
11480 Emacs applies the modifiers of the character stored here to each keyboard
11481 character it reads. For example, after evaluating the expression
11482 (setq extra-keyboard-modifiers ?\\C-x)
11483 all input characters will have the control modifier applied to them.
11485 Note that the character ?\\C-@, equivalent to the integer zero, does
11486 not count as a control character; rather, it counts as a character
11487 with no modifiers; thus, setting `extra-keyboard-modifiers' to zero
11488 cancels any modification. */);
11489 extra_keyboard_modifiers
= 0;
11491 DEFVAR_LISP ("deactivate-mark", Vdeactivate_mark
,
11492 doc
: /* If an editing command sets this to t, deactivate the mark afterward.
11493 The command loop sets this to nil before each command,
11494 and tests the value when the command returns.
11495 Buffer modification stores t in this variable. */);
11496 Vdeactivate_mark
= Qnil
;
11497 DEFSYM (Qdeactivate_mark
, "deactivate-mark");
11499 DEFVAR_LISP ("pre-command-hook", Vpre_command_hook
,
11500 doc
: /* Normal hook run before each command is executed.
11501 If an unhandled error happens in running this hook,
11502 the function in which the error occurred is unconditionally removed, since
11503 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11504 Vpre_command_hook
= Qnil
;
11506 DEFVAR_LISP ("post-command-hook", Vpost_command_hook
,
11507 doc
: /* Normal hook run after each command is executed.
11508 If an unhandled error happens in running this hook,
11509 the function in which the error occurred is unconditionally removed, since
11510 otherwise the error might happen repeatedly and make Emacs nonfunctional. */);
11511 Vpost_command_hook
= Qnil
;
11514 DEFVAR_LISP ("echo-area-clear-hook", ...,
11515 doc
: /* Normal hook run when clearing the echo area. */);
11517 DEFSYM (Qecho_area_clear_hook
, "echo-area-clear-hook");
11518 Fset (Qecho_area_clear_hook
, Qnil
);
11520 DEFVAR_LISP ("lucid-menu-bar-dirty-flag", Vlucid_menu_bar_dirty_flag
,
11521 doc
: /* Non-nil means menu bar, specified Lucid style, needs to be recomputed. */);
11522 Vlucid_menu_bar_dirty_flag
= Qnil
;
11524 DEFVAR_LISP ("menu-bar-final-items", Vmenu_bar_final_items
,
11525 doc
: /* List of menu bar items to move to the end of the menu bar.
11526 The elements of the list are event types that may have menu bar bindings. */);
11527 Vmenu_bar_final_items
= Qnil
;
11529 DEFVAR_LISP ("tool-bar-separator-image-expression", Vtool_bar_separator_image_expression
,
11530 doc
: /* Expression evaluating to the image spec for a tool-bar separator.
11531 This is used internally by graphical displays that do not render
11532 tool-bar separators natively. Otherwise it is unused (e.g. on GTK). */);
11533 Vtool_bar_separator_image_expression
= Qnil
;
11535 DEFVAR_KBOARD ("overriding-terminal-local-map",
11536 Voverriding_terminal_local_map
,
11537 doc
: /* Per-terminal keymap that overrides all other local keymaps.
11538 If this variable is non-nil, it is used as a keymap instead of the
11539 buffer's local map, and the minor mode keymaps and text property keymaps.
11540 It also replaces `overriding-local-map'.
11542 This variable is intended to let commands such as `universal-argument'
11543 set up a different keymap for reading the next command.
11545 `overriding-terminal-local-map' has a separate binding for each
11547 See Info node `(elisp)Multiple Terminals'. */);
11549 DEFVAR_LISP ("overriding-local-map", Voverriding_local_map
,
11550 doc
: /* Keymap that overrides all other local keymaps.
11551 If this variable is non-nil, it is used as a keymap--replacing the
11552 buffer's local map, the minor mode keymaps, and char property keymaps. */);
11553 Voverriding_local_map
= Qnil
;
11555 DEFVAR_LISP ("overriding-local-map-menu-flag", Voverriding_local_map_menu_flag
,
11556 doc
: /* Non-nil means `overriding-local-map' applies to the menu bar.
11557 Otherwise, the menu bar continues to reflect the buffer's local map
11558 and the minor mode maps regardless of `overriding-local-map'. */);
11559 Voverriding_local_map_menu_flag
= Qnil
;
11561 DEFVAR_LISP ("special-event-map", Vspecial_event_map
,
11562 doc
: /* Keymap defining bindings for special events to execute at low level. */);
11563 Vspecial_event_map
= Fcons (intern_c_string ("keymap"), Qnil
);
11565 DEFVAR_LISP ("track-mouse", do_mouse_tracking
,
11566 doc
: /* Non-nil means generate motion events for mouse motion. */);
11568 DEFVAR_KBOARD ("system-key-alist", Vsystem_key_alist
,
11569 doc
: /* Alist of system-specific X windows key symbols.
11570 Each element should have the form (N . SYMBOL) where N is the
11571 numeric keysym code (sans the \"system-specific\" bit 1<<28)
11572 and SYMBOL is its name.
11574 `system-key-alist' has a separate binding for each terminal device.
11575 See Info node `(elisp)Multiple Terminals'. */);
11577 DEFVAR_KBOARD ("local-function-key-map", Vlocal_function_key_map
,
11578 doc
: /* Keymap that translates key sequences to key sequences during input.
11579 This is used mainly for mapping key sequences into some preferred
11580 key events (symbols).
11582 The `read-key-sequence' function replaces any subsequence bound by
11583 `local-function-key-map' with its binding. More precisely, when the
11584 active keymaps have no binding for the current key sequence but
11585 `local-function-key-map' binds a suffix of the sequence to a vector or
11586 string, `read-key-sequence' replaces the matching suffix with its
11587 binding, and continues with the new sequence.
11589 If the binding is a function, it is called with one argument (the prompt)
11590 and its return value (a key sequence) is used.
11592 The events that come from bindings in `local-function-key-map' are not
11593 themselves looked up in `local-function-key-map'.
11595 For example, suppose `local-function-key-map' binds `ESC O P' to [f1].
11596 Typing `ESC O P' to `read-key-sequence' would return [f1]. Typing
11597 `C-x ESC O P' would return [?\\C-x f1]. If [f1] were a prefix key,
11598 typing `ESC O P x' would return [f1 x].
11600 `local-function-key-map' has a separate binding for each terminal
11601 device. See Info node `(elisp)Multiple Terminals'. If you need to
11602 define a binding on all terminals, change `function-key-map'
11603 instead. Initially, `local-function-key-map' is an empty keymap that
11604 has `function-key-map' as its parent on all terminal devices. */);
11606 DEFVAR_KBOARD ("input-decode-map", Vinput_decode_map
,
11607 doc
: /* Keymap that decodes input escape sequences.
11608 This is used mainly for mapping ASCII function key sequences into
11609 real Emacs function key events (symbols).
11611 The `read-key-sequence' function replaces any subsequence bound by
11612 `input-decode-map' with its binding. Contrary to `function-key-map',
11613 this map applies its rebinding regardless of the presence of an ordinary
11614 binding. So it is more like `key-translation-map' except that it applies
11615 before `function-key-map' rather than after.
11617 If the binding is a function, it is called with one argument (the prompt)
11618 and its return value (a key sequence) is used.
11620 The events that come from bindings in `input-decode-map' are not
11621 themselves looked up in `input-decode-map'. */);
11623 DEFVAR_LISP ("function-key-map", Vfunction_key_map
,
11624 doc
: /* The parent keymap of all `local-function-key-map' instances.
11625 Function key definitions that apply to all terminal devices should go
11626 here. If a mapping is defined in both the current
11627 `local-function-key-map' binding and this variable, then the local
11628 definition will take precedence. */);
11629 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
11631 DEFVAR_LISP ("key-translation-map", Vkey_translation_map
,
11632 doc
: /* Keymap of key translations that can override keymaps.
11633 This keymap works like `function-key-map', but comes after that,
11634 and its non-prefix bindings override ordinary bindings. */);
11635 Vkey_translation_map
= Fmake_sparse_keymap (Qnil
);
11637 DEFVAR_LISP ("deferred-action-list", Vdeferred_action_list
,
11638 doc
: /* List of deferred actions to be performed at a later time.
11639 The precise format isn't relevant here; we just check whether it is nil. */);
11640 Vdeferred_action_list
= Qnil
;
11642 DEFVAR_LISP ("deferred-action-function", Vdeferred_action_function
,
11643 doc
: /* Function to call to handle deferred actions, after each command.
11644 This function is called with no arguments after each command
11645 whenever `deferred-action-list' is non-nil. */);
11646 Vdeferred_action_function
= Qnil
;
11648 DEFVAR_LISP ("delayed-warnings-list", Vdelayed_warnings_list
,
11649 doc
: /* List of warnings to be displayed after this command.
11650 Each element must be a list (TYPE MESSAGE [LEVEL [BUFFER-NAME]]),
11651 as per the args of `display-warning' (which see).
11652 If this variable is non-nil, `delayed-warnings-hook' will be run
11653 immediately after running `post-command-hook'. */);
11654 Vdelayed_warnings_list
= Qnil
;
11656 DEFVAR_LISP ("timer-list", Vtimer_list
,
11657 doc
: /* List of active absolute time timers in order of increasing time. */);
11658 Vtimer_list
= Qnil
;
11660 DEFVAR_LISP ("timer-idle-list", Vtimer_idle_list
,
11661 doc
: /* List of active idle-time timers in order of increasing time. */);
11662 Vtimer_idle_list
= Qnil
;
11664 DEFVAR_LISP ("input-method-function", Vinput_method_function
,
11665 doc
: /* If non-nil, the function that implements the current input method.
11666 It's called with one argument, a printing character that was just read.
11667 \(That means a character with code 040...0176.)
11668 Typically this function uses `read-event' to read additional events.
11669 When it does so, it should first bind `input-method-function' to nil
11670 so it will not be called recursively.
11672 The function should return a list of zero or more events
11673 to be used as input. If it wants to put back some events
11674 to be reconsidered, separately, by the input method,
11675 it can add them to the beginning of `unread-command-events'.
11677 The input method function can find in `input-method-previous-message'
11678 the previous echo area message.
11680 The input method function should refer to the variables
11681 `input-method-use-echo-area' and `input-method-exit-on-first-char'
11682 for guidance on what to do. */);
11683 Vinput_method_function
= Qnil
;
11685 DEFVAR_LISP ("input-method-previous-message",
11686 Vinput_method_previous_message
,
11687 doc
: /* When `input-method-function' is called, hold the previous echo area message.
11688 This variable exists because `read-event' clears the echo area
11689 before running the input method. It is nil if there was no message. */);
11690 Vinput_method_previous_message
= Qnil
;
11692 DEFVAR_LISP ("show-help-function", Vshow_help_function
,
11693 doc
: /* If non-nil, the function that implements the display of help.
11694 It's called with one argument, the help string to display. */);
11695 Vshow_help_function
= Qnil
;
11697 DEFVAR_LISP ("disable-point-adjustment", Vdisable_point_adjustment
,
11698 doc
: /* If non-nil, suppress point adjustment after executing a command.
11700 After a command is executed, if point is moved into a region that has
11701 special properties (e.g. composition, display), we adjust point to
11702 the boundary of the region. But, when a command sets this variable to
11703 non-nil, we suppress the point adjustment.
11705 This variable is set to nil before reading a command, and is checked
11706 just after executing the command. */);
11707 Vdisable_point_adjustment
= Qnil
;
11709 DEFVAR_LISP ("global-disable-point-adjustment",
11710 Vglobal_disable_point_adjustment
,
11711 doc
: /* If non-nil, always suppress point adjustment.
11713 The default value is nil, in which case, point adjustment are
11714 suppressed only after special commands that set
11715 `disable-point-adjustment' (which see) to non-nil. */);
11716 Vglobal_disable_point_adjustment
= Qnil
;
11718 DEFVAR_LISP ("minibuffer-message-timeout", Vminibuffer_message_timeout
,
11719 doc
: /* How long to display an echo-area message when the minibuffer is active.
11720 If the value is not a number, such messages don't time out. */);
11721 Vminibuffer_message_timeout
= make_number (2);
11723 DEFVAR_LISP ("throw-on-input", Vthrow_on_input
,
11724 doc
: /* If non-nil, any keyboard input throws to this symbol.
11725 The value of that variable is passed to `quit-flag' and later causes a
11726 peculiar kind of quitting. */);
11727 Vthrow_on_input
= Qnil
;
11729 DEFVAR_LISP ("command-error-function", Vcommand_error_function
,
11730 doc
: /* If non-nil, function to output error messages.
11731 The arguments are the error data, a list of the form
11732 (SIGNALED-CONDITIONS . SIGNAL-DATA)
11733 such as just as `condition-case' would bind its variable to,
11734 the context (a string which normally goes at the start of the message),
11735 and the Lisp function within which the error was signaled. */);
11736 Vcommand_error_function
= Qnil
;
11738 DEFVAR_LISP ("enable-disabled-menus-and-buttons",
11739 Venable_disabled_menus_and_buttons
,
11740 doc
: /* If non-nil, don't ignore events produced by disabled menu items and tool-bar.
11742 Help functions bind this to allow help on disabled menu items
11743 and tool-bar buttons. */);
11744 Venable_disabled_menus_and_buttons
= Qnil
;
11746 DEFVAR_LISP ("select-active-regions",
11747 Vselect_active_regions
,
11748 doc
: /* If non-nil, an active region automatically sets the primary selection.
11749 If the value is `only', only temporarily active regions (usually made
11750 by mouse-dragging or shift-selection) set the window selection.
11752 This takes effect only when Transient Mark mode is enabled. */);
11753 Vselect_active_regions
= Qt
;
11755 DEFVAR_LISP ("saved-region-selection",
11756 Vsaved_region_selection
,
11757 doc
: /* Contents of active region prior to buffer modification.
11758 If `select-active-regions' is non-nil, Emacs sets this to the
11759 text in the region before modifying the buffer. The next call to
11760 the function `deactivate-mark' uses this to set the window selection. */);
11761 Vsaved_region_selection
= Qnil
;
11763 DEFVAR_LISP ("selection-inhibit-update-commands",
11764 Vselection_inhibit_update_commands
,
11765 doc
: /* List of commands which should not update the selection.
11766 Normally, if `select-active-regions' is non-nil and the mark remains
11767 active after a command (i.e. the mark was not deactivated), the Emacs
11768 command loop sets the selection to the text in the region. However,
11769 if the command is in this list, the selection is not updated. */);
11770 Vselection_inhibit_update_commands
11771 = list2 (Qhandle_switch_frame
, Qhandle_select_window
);
11773 DEFVAR_LISP ("debug-on-event",
11775 doc
: /* Enter debugger on this event. When Emacs
11776 receives the special event specified by this variable, it will try to
11777 break into the debugger as soon as possible instead of processing the
11778 event normally through `special-event-map'.
11780 Currently, the only supported values for this
11781 variable are `sigusr1' and `sigusr2'. */);
11782 Vdebug_on_event
= intern_c_string ("sigusr2");
11784 /* Create the initial keyboard. */
11785 initial_kboard
= xmalloc (sizeof *initial_kboard
);
11786 init_kboard (initial_kboard
);
11787 /* Vwindow_system is left at t for now. */
11788 initial_kboard
->next_kboard
= all_kboards
;
11789 all_kboards
= initial_kboard
;
11793 keys_of_keyboard (void)
11795 initial_define_key (global_map
, Ctl ('Z'), "suspend-emacs");
11796 initial_define_key (control_x_map
, Ctl ('Z'), "suspend-emacs");
11797 initial_define_key (meta_map
, Ctl ('C'), "exit-recursive-edit");
11798 initial_define_key (global_map
, Ctl (']'), "abort-recursive-edit");
11799 initial_define_key (meta_map
, 'x', "execute-extended-command");
11801 initial_define_lispy_key (Vspecial_event_map
, "delete-frame",
11802 "handle-delete-frame");
11803 initial_define_lispy_key (Vspecial_event_map
, "ns-put-working-text",
11804 "ns-put-working-text");
11805 initial_define_lispy_key (Vspecial_event_map
, "ns-unput-working-text",
11806 "ns-unput-working-text");
11807 /* Here we used to use `ignore-event' which would simple set prefix-arg to
11808 current-prefix-arg, as is done in `handle-switch-frame'.
11809 But `handle-switch-frame is not run from the special-map.
11810 Commands from that map are run in a special way that automatically
11811 preserves the prefix-arg. Restoring the prefix arg here is not just
11812 redundant but harmful:
11814 - current-prefix-arg is set to non-nil, prefix-arg is set to nil.
11815 - after the first prompt, the exit-minibuffer-hook is run which may
11816 iconify a frame and thus push a `iconify-frame' event.
11817 - after running exit-minibuffer-hook, current-prefix-arg is
11818 restored to the non-nil value it had before the prompt.
11819 - we enter the second prompt.
11820 current-prefix-arg is non-nil, prefix-arg is nil.
11821 - before running the first real event, we run the special iconify-frame
11822 event, but we pass the `special' arg to execute-command so
11823 current-prefix-arg and prefix-arg are left untouched.
11824 - here we foolishly copy the non-nil current-prefix-arg to prefix-arg.
11825 - the next key event will have a spuriously non-nil current-prefix-arg. */
11826 initial_define_lispy_key (Vspecial_event_map
, "iconify-frame",
11828 initial_define_lispy_key (Vspecial_event_map
, "make-frame-visible",
11830 /* Handling it at such a low-level causes read_key_sequence to get
11831 * confused because it doesn't realize that the current_buffer was
11832 * changed by read_char.
11834 * initial_define_lispy_key (Vspecial_event_map, "select-window",
11835 * "handle-select-window"); */
11836 initial_define_lispy_key (Vspecial_event_map
, "save-session",
11837 "handle-save-session");
11840 /* Define a special event which is raised for dbus callback
11842 initial_define_lispy_key (Vspecial_event_map
, "dbus-event",
11843 "dbus-handle-event");
11846 #ifdef HAVE_INOTIFY
11847 /* Define a special event which is raised for inotify callback
11849 initial_define_lispy_key (Vspecial_event_map
, "file-inotify",
11850 "inotify-handle-event");
11851 #endif /* HAVE_INOTIFY */
11853 initial_define_lispy_key (Vspecial_event_map
, "config-changed-event",
11855 #if defined (WINDOWSNT)
11856 initial_define_lispy_key (Vspecial_event_map
, "language-change",
11858 initial_define_lispy_key (Vspecial_event_map
, "file-w32notify",
11859 "w32notify-handle-event");
11863 /* Mark the pointers in the kboard objects.
11864 Called by Fgarbage_collect. */
11866 mark_kboards (void)
11870 for (kb
= all_kboards
; kb
; kb
= kb
->next_kboard
)
11872 if (kb
->kbd_macro_buffer
)
11873 for (p
= kb
->kbd_macro_buffer
; p
< kb
->kbd_macro_ptr
; p
++)
11875 mark_object (KVAR (kb
, Voverriding_terminal_local_map
));
11876 mark_object (KVAR (kb
, Vlast_command
));
11877 mark_object (KVAR (kb
, Vreal_last_command
));
11878 mark_object (KVAR (kb
, Vkeyboard_translate_table
));
11879 mark_object (KVAR (kb
, Vlast_repeatable_command
));
11880 mark_object (KVAR (kb
, Vprefix_arg
));
11881 mark_object (KVAR (kb
, Vlast_prefix_arg
));
11882 mark_object (KVAR (kb
, kbd_queue
));
11883 mark_object (KVAR (kb
, defining_kbd_macro
));
11884 mark_object (KVAR (kb
, Vlast_kbd_macro
));
11885 mark_object (KVAR (kb
, Vsystem_key_alist
));
11886 mark_object (KVAR (kb
, system_key_syms
));
11887 mark_object (KVAR (kb
, Vwindow_system
));
11888 mark_object (KVAR (kb
, Vinput_decode_map
));
11889 mark_object (KVAR (kb
, Vlocal_function_key_map
));
11890 mark_object (KVAR (kb
, Vdefault_minibuffer_frame
));
11891 mark_object (KVAR (kb
, echo_string
));
11894 struct input_event
*event
;
11895 for (event
= kbd_fetch_ptr
; event
!= kbd_store_ptr
; event
++)
11897 if (event
== kbd_buffer
+ KBD_BUFFER_SIZE
)
11898 event
= kbd_buffer
;
11899 /* These two special event types has no Lisp_Objects to mark. */
11900 if (event
->kind
!= SELECTION_REQUEST_EVENT
11901 && event
->kind
!= SELECTION_CLEAR_EVENT
)
11903 mark_object (event
->x
);
11904 mark_object (event
->y
);
11905 mark_object (event
->frame_or_window
);
11906 mark_object (event
->arg
);